]> 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
Some compile fixes.
[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
33d6fd3b 711 ClassName = property(GetClassName,doc="See `GetClassName`")
2131d850 712_core_.Object_swigregister(Object)
d55e5bfc 713_wxPySetDictionary = _core_._wxPySetDictionary
d55e5bfc
RD		 714cvar = _core_.cvar
715EmptyString = cvar.EmptyString
716
717#---------------------------------------------------------------------------
718
719BITMAP_TYPE_INVALID = _core_.BITMAP_TYPE_INVALID
720BITMAP_TYPE_BMP = _core_.BITMAP_TYPE_BMP
721BITMAP_TYPE_ICO = _core_.BITMAP_TYPE_ICO
722BITMAP_TYPE_CUR = _core_.BITMAP_TYPE_CUR
723BITMAP_TYPE_XBM = _core_.BITMAP_TYPE_XBM
724BITMAP_TYPE_XBM_DATA = _core_.BITMAP_TYPE_XBM_DATA
725BITMAP_TYPE_XPM = _core_.BITMAP_TYPE_XPM
726BITMAP_TYPE_XPM_DATA = _core_.BITMAP_TYPE_XPM_DATA
727BITMAP_TYPE_TIF = _core_.BITMAP_TYPE_TIF
728BITMAP_TYPE_GIF = _core_.BITMAP_TYPE_GIF
729BITMAP_TYPE_PNG = _core_.BITMAP_TYPE_PNG
730BITMAP_TYPE_JPEG = _core_.BITMAP_TYPE_JPEG
731BITMAP_TYPE_PNM = _core_.BITMAP_TYPE_PNM
732BITMAP_TYPE_PCX = _core_.BITMAP_TYPE_PCX
733BITMAP_TYPE_PICT = _core_.BITMAP_TYPE_PICT
734BITMAP_TYPE_ICON = _core_.BITMAP_TYPE_ICON
735BITMAP_TYPE_ANI = _core_.BITMAP_TYPE_ANI
736BITMAP_TYPE_IFF = _core_.BITMAP_TYPE_IFF
737BITMAP_TYPE_MACCURSOR = _core_.BITMAP_TYPE_MACCURSOR
738BITMAP_TYPE_ANY = _core_.BITMAP_TYPE_ANY
739CURSOR_NONE = _core_.CURSOR_NONE
740CURSOR_ARROW = _core_.CURSOR_ARROW
741CURSOR_RIGHT_ARROW = _core_.CURSOR_RIGHT_ARROW
742CURSOR_BULLSEYE = _core_.CURSOR_BULLSEYE
743CURSOR_CHAR = _core_.CURSOR_CHAR
744CURSOR_CROSS = _core_.CURSOR_CROSS
745CURSOR_HAND = _core_.CURSOR_HAND
746CURSOR_IBEAM = _core_.CURSOR_IBEAM
747CURSOR_LEFT_BUTTON = _core_.CURSOR_LEFT_BUTTON
748CURSOR_MAGNIFIER = _core_.CURSOR_MAGNIFIER
749CURSOR_MIDDLE_BUTTON = _core_.CURSOR_MIDDLE_BUTTON
750CURSOR_NO_ENTRY = _core_.CURSOR_NO_ENTRY
751CURSOR_PAINT_BRUSH = _core_.CURSOR_PAINT_BRUSH
752CURSOR_PENCIL = _core_.CURSOR_PENCIL
753CURSOR_POINT_LEFT = _core_.CURSOR_POINT_LEFT
754CURSOR_POINT_RIGHT = _core_.CURSOR_POINT_RIGHT
755CURSOR_QUESTION_ARROW = _core_.CURSOR_QUESTION_ARROW
756CURSOR_RIGHT_BUTTON = _core_.CURSOR_RIGHT_BUTTON
757CURSOR_SIZENESW = _core_.CURSOR_SIZENESW
758CURSOR_SIZENS = _core_.CURSOR_SIZENS
759CURSOR_SIZENWSE = _core_.CURSOR_SIZENWSE
760CURSOR_SIZEWE = _core_.CURSOR_SIZEWE
761CURSOR_SIZING = _core_.CURSOR_SIZING
762CURSOR_SPRAYCAN = _core_.CURSOR_SPRAYCAN
763CURSOR_WAIT = _core_.CURSOR_WAIT
764CURSOR_WATCH = _core_.CURSOR_WATCH
765CURSOR_BLANK = _core_.CURSOR_BLANK
766CURSOR_DEFAULT = _core_.CURSOR_DEFAULT
767CURSOR_COPY_ARROW = _core_.CURSOR_COPY_ARROW
768CURSOR_ARROWWAIT = _core_.CURSOR_ARROWWAIT
769CURSOR_MAX = _core_.CURSOR_MAX
770#---------------------------------------------------------------------------
771
772class Size(object):
773 """
79fccf9d 774 wx.Size is a useful data structure used to represent the size of
554f62e9
RD		 775 something. It simply contains integer width and height
776 properties. In most places in wxPython where a wx.Size is
093d3ff1 777 expected a (width, height) tuple can be used instead.
d55e5bfc 778 """
554f62e9
RD		 779 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
780 __repr__ = _swig_repr
d55e5bfc
RD		 781 width = property(_core_.Size_width_get, _core_.Size_width_set)
782 height = property(_core_.Size_height_get, _core_.Size_height_set)
783 x = width; y = height
554f62e9 784 def __init__(self, *args, **kwargs):
d55e5bfc
RD		 785 """
786 __init__(self, int w=0, int h=0) -> Size
787
788 Creates a size object.
789 """
554f62e9
RD		 790 _core_.Size_swiginit(self,_core_.new_Size(*args, **kwargs))
791 __swig_destroy__ = _core_.delete_Size
792 __del__ = lambda self : None;
d55e5bfc
RD		 793 def __eq__(*args, **kwargs):
794 """
e9d6f3a4 795 __eq__(self, PyObject other) -> bool
d55e5bfc
RD		 796
797 Test for equality of wx.Size objects.
798 """
799 return _core_.Size___eq__(*args, **kwargs)
800
801 def __ne__(*args, **kwargs):
802 """
e9d6f3a4 803 __ne__(self, PyObject other) -> bool
d55e5bfc 804
e9d6f3a4 805 Test for inequality of wx.Size objects.
d55e5bfc
RD		 806 """
807 return _core_.Size___ne__(*args, **kwargs)
808
809 def __add__(*args, **kwargs):
810 """
811 __add__(self, Size sz) -> Size
812
813 Add sz's proprties to this and return the result.
814 """
815 return _core_.Size___add__(*args, **kwargs)
816
817 def __sub__(*args, **kwargs):
818 """
819 __sub__(self, Size sz) -> Size
820
821 Subtract sz's properties from this and return the result.
822 """
823 return _core_.Size___sub__(*args, **kwargs)
824
825 def IncTo(*args, **kwargs):
826 """
827 IncTo(self, Size sz)
828
829 Increments this object so that both of its dimensions are not less
830 than the corresponding dimensions of the size.
831 """
832 return _core_.Size_IncTo(*args, **kwargs)
833
834 def DecTo(*args, **kwargs):
835 """
836 DecTo(self, Size sz)
837
838 Decrements this object so that both of its dimensions are not greater
839 than the corresponding dimensions of the size.
840 """
841 return _core_.Size_DecTo(*args, **kwargs)
842
f5263701
RD		 843 def IncBy(*args, **kwargs):
844 """IncBy(self, int dx, int dy)"""
845 return _core_.Size_IncBy(*args, **kwargs)
846
847 def DecBy(*args, **kwargs):
848 """DecBy(self, int dx, int dy)"""
849 return _core_.Size_DecBy(*args, **kwargs)
850
1eeb270e
RD		 851 def Scale(*args, **kwargs):
852 """
853 Scale(self, float xscale, float yscale)
854
855 Scales the dimensions of this object by the given factors.
856 """
857 return _core_.Size_Scale(*args, **kwargs)
858
d55e5bfc
RD		 859 def Set(*args, **kwargs):
860 """
861 Set(self, int w, int h)
862
863 Set both width and height.
864 """
865 return _core_.Size_Set(*args, **kwargs)
866
867 def SetWidth(*args, **kwargs):
868 """SetWidth(self, int w)"""
869 return _core_.Size_SetWidth(*args, **kwargs)
870
871 def SetHeight(*args, **kwargs):
872 """SetHeight(self, int h)"""
873 return _core_.Size_SetHeight(*args, **kwargs)
874
875 def GetWidth(*args, **kwargs):
876 """GetWidth(self) -> int"""
877 return _core_.Size_GetWidth(*args, **kwargs)
878
879 def GetHeight(*args, **kwargs):
880 """GetHeight(self) -> int"""
881 return _core_.Size_GetHeight(*args, **kwargs)
882
883 def IsFullySpecified(*args, **kwargs):
884 """
885 IsFullySpecified(self) -> bool
886
887 Returns True if both components of the size are non-default values.
888 """
889 return _core_.Size_IsFullySpecified(*args, **kwargs)
890
891 def SetDefaults(*args, **kwargs):
892 """
893 SetDefaults(self, Size size)
894
79fccf9d
RD		 895 Combine this size with the other one replacing the default components
896 of this object (i.e. equal to -1) with those of the other.
d55e5bfc
RD		 897 """
898 return _core_.Size_SetDefaults(*args, **kwargs)
899
900 def Get(*args, **kwargs):
901 """
902 Get() -> (width,height)
903
904 Returns the width and height properties as a tuple.
905 """
906 return _core_.Size_Get(*args, **kwargs)
907
79fccf9d 908 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD		 909 def __str__(self): return str(self.Get())
910 def __repr__(self): return 'wx.Size'+str(self.Get())
911 def __len__(self): return len(self.Get())
912 def __getitem__(self, index): return self.Get()[index]
913 def __setitem__(self, index, val):
914 if index == 0: self.width = val
915 elif index == 1: self.height = val
916 else: raise IndexError
917 def __nonzero__(self): return self.Get() != (0,0)
918 __safe_for_unpickling__ = True
919 def __reduce__(self): return (wx.Size, self.Get())
920
2131d850 921_core_.Size_swigregister(Size)
d55e5bfc
RD		 922
923#---------------------------------------------------------------------------
924
925class RealPoint(object):
926 """
79fccf9d
RD		 927 A data structure for representing a point or position with floating
928 point x and y properties. In wxPython most places that expect a
929 wx.RealPoint can also accept a (x,y) tuple.
d55e5bfc 930 """
554f62e9
RD		 931 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
932 __repr__ = _swig_repr
d55e5bfc
RD		 933 x = property(_core_.RealPoint_x_get, _core_.RealPoint_x_set)
934 y = property(_core_.RealPoint_y_get, _core_.RealPoint_y_set)
554f62e9 935 def __init__(self, *args, **kwargs):
d55e5bfc
RD		 936 """
937 __init__(self, double x=0.0, double y=0.0) -> RealPoint
938
939 Create a wx.RealPoint object
940 """
554f62e9
RD		 941 _core_.RealPoint_swiginit(self,_core_.new_RealPoint(*args, **kwargs))
942 __swig_destroy__ = _core_.delete_RealPoint
943 __del__ = lambda self : None;
d55e5bfc
RD		 944 def __eq__(*args, **kwargs):
945 """
e9d6f3a4 946 __eq__(self, PyObject other) -> bool
d55e5bfc
RD		 947
948 Test for equality of wx.RealPoint objects.
949 """
950 return _core_.RealPoint___eq__(*args, **kwargs)
951
952 def __ne__(*args, **kwargs):
953 """
e9d6f3a4 954 __ne__(self, PyObject other) -> bool
d55e5bfc
RD		 955
956 Test for inequality of wx.RealPoint objects.
957 """
958 return _core_.RealPoint___ne__(*args, **kwargs)
959
960 def __add__(*args, **kwargs):
961 """
962 __add__(self, RealPoint pt) -> RealPoint
963
964 Add pt's proprties to this and return the result.
965 """
966 return _core_.RealPoint___add__(*args, **kwargs)
967
968 def __sub__(*args, **kwargs):
969 """
970 __sub__(self, RealPoint pt) -> RealPoint
971
972 Subtract pt's proprties from this and return the result
973 """
974 return _core_.RealPoint___sub__(*args, **kwargs)
975
976 def Set(*args, **kwargs):
977 """
978 Set(self, double x, double y)
979
980 Set both the x and y properties
981 """
982 return _core_.RealPoint_Set(*args, **kwargs)
983
984 def Get(*args, **kwargs):
985 """
986 Get() -> (x,y)
987
988 Return the x and y properties as a tuple.
989 """
990 return _core_.RealPoint_Get(*args, **kwargs)
991
79fccf9d 992 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD		 993 def __str__(self): return str(self.Get())
994 def __repr__(self): return 'wx.RealPoint'+str(self.Get())
995 def __len__(self): return len(self.Get())
996 def __getitem__(self, index): return self.Get()[index]
997 def __setitem__(self, index, val):
998 if index == 0: self.x = val
999 elif index == 1: self.y = val
1000 else: raise IndexError
1001 def __nonzero__(self): return self.Get() != (0.0, 0.0)
1002 __safe_for_unpickling__ = True
1003 def __reduce__(self): return (wx.RealPoint, self.Get())
1004
2131d850 1005_core_.RealPoint_swigregister(RealPoint)
d55e5bfc
RD		 1006
1007#---------------------------------------------------------------------------
1008
1009class Point(object):
1010 """
79fccf9d
RD		 1011 A data structure for representing a point or position with integer x
1012 and y properties. Most places in wxPython that expect a wx.Point can
1013 also accept a (x,y) tuple.
d55e5bfc 1014 """
554f62e9
RD		 1015 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1016 __repr__ = _swig_repr
d55e5bfc
RD		 1017 x = property(_core_.Point_x_get, _core_.Point_x_set)
1018 y = property(_core_.Point_y_get, _core_.Point_y_set)
554f62e9 1019 def __init__(self, *args, **kwargs):
d55e5bfc
RD		 1020 """
1021 __init__(self, int x=0, int y=0) -> Point
1022
1023 Create a wx.Point object
1024 """
554f62e9
RD		 1025 _core_.Point_swiginit(self,_core_.new_Point(*args, **kwargs))
1026 __swig_destroy__ = _core_.delete_Point
1027 __del__ = lambda self : None;
d55e5bfc
RD		 1028 def __eq__(*args, **kwargs):
1029 """
e9d6f3a4 1030 __eq__(self, PyObject other) -> bool
d55e5bfc
RD		 1031
1032 Test for equality of wx.Point objects.
1033 """
1034 return _core_.Point___eq__(*args, **kwargs)
1035
1036 def __ne__(*args, **kwargs):
1037 """
e9d6f3a4 1038 __ne__(self, PyObject other) -> bool
d55e5bfc
RD		 1039
1040 Test for inequality of wx.Point objects.
1041 """
1042 return _core_.Point___ne__(*args, **kwargs)
1043
1044 def __add__(*args, **kwargs):
1045 """
1046 __add__(self, Point pt) -> Point
1047
1048 Add pt's proprties to this and return the result.
1049 """
1050 return _core_.Point___add__(*args, **kwargs)
1051
1052 def __sub__(*args, **kwargs):
1053 """
1054 __sub__(self, Point pt) -> Point
1055
1056 Subtract pt's proprties from this and return the result
1057 """
1058 return _core_.Point___sub__(*args, **kwargs)
1059
1060 def __iadd__(*args, **kwargs):
1061 """
1062 __iadd__(self, Point pt) -> Point
1063
1064 Add pt to this object.
1065 """
1066 return _core_.Point___iadd__(*args, **kwargs)
1067
1068 def __isub__(*args, **kwargs):
1069 """
1070 __isub__(self, Point pt) -> Point
1071
1072 Subtract pt from this object.
1073 """
1074 return _core_.Point___isub__(*args, **kwargs)
1075
1076 def Set(*args, **kwargs):
1077 """
1078 Set(self, long x, long y)
1079
1080 Set both the x and y properties
1081 """
1082 return _core_.Point_Set(*args, **kwargs)
1083
1084 def Get(*args, **kwargs):
1085 """
1086 Get() -> (x,y)
1087
1088 Return the x and y properties as a tuple.
1089 """
1090 return _core_.Point_Get(*args, **kwargs)
1091
79fccf9d 1092 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD		 1093 def __str__(self): return str(self.Get())
1094 def __repr__(self): return 'wx.Point'+str(self.Get())
1095 def __len__(self): return len(self.Get())
1096 def __getitem__(self, index): return self.Get()[index]
1097 def __setitem__(self, index, val):
1098 if index == 0: self.x = val
1099 elif index == 1: self.y = val
1100 else: raise IndexError
1101 def __nonzero__(self): return self.Get() != (0,0)
1102 __safe_for_unpickling__ = True
1103 def __reduce__(self): return (wx.Point, self.Get())
1104
2131d850 1105_core_.Point_swigregister(Point)
d55e5bfc
RD		 1106
1107#---------------------------------------------------------------------------
1108
1109class Rect(object):
1110 """
79fccf9d
RD		 1111 A class for representing and manipulating rectangles. It has x, y,
1112 width and height properties. In wxPython most palces that expect a
1113 wx.Rect can also accept a (x,y,width,height) tuple.
d55e5bfc 1114 """
554f62e9
RD		 1115 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1116 __repr__ = _swig_repr
1117 def __init__(self, *args, **kwargs):
d55e5bfc
RD		 1118 """
1119 __init__(self, int x=0, int y=0, int width=0, int height=0) -> Rect
1120
1121 Create a new Rect object.
1122 """
554f62e9
RD		 1123 _core_.Rect_swiginit(self,_core_.new_Rect(*args, **kwargs))
1124 __swig_destroy__ = _core_.delete_Rect
1125 __del__ = lambda self : None;
d55e5bfc
RD		 1126 def GetX(*args, **kwargs):
1127 """GetX(self) -> int"""
1128 return _core_.Rect_GetX(*args, **kwargs)
1129
1130 def SetX(*args, **kwargs):
1131 """SetX(self, int x)"""
1132 return _core_.Rect_SetX(*args, **kwargs)
1133
1134 def GetY(*args, **kwargs):
1135 """GetY(self) -> int"""
1136 return _core_.Rect_GetY(*args, **kwargs)
1137
1138 def SetY(*args, **kwargs):
1139 """SetY(self, int y)"""
1140 return _core_.Rect_SetY(*args, **kwargs)
1141
1142 def GetWidth(*args, **kwargs):
1143 """GetWidth(self) -> int"""
1144 return _core_.Rect_GetWidth(*args, **kwargs)
1145
1146 def SetWidth(*args, **kwargs):
1147 """SetWidth(self, int w)"""
1148 return _core_.Rect_SetWidth(*args, **kwargs)
1149
1150 def GetHeight(*args, **kwargs):
1151 """GetHeight(self) -> int"""
1152 return _core_.Rect_GetHeight(*args, **kwargs)
1153
1154 def SetHeight(*args, **kwargs):
1155 """SetHeight(self, int h)"""
1156 return _core_.Rect_SetHeight(*args, **kwargs)
1157
1158 def GetPosition(*args, **kwargs):
1159 """GetPosition(self) -> Point"""
1160 return _core_.Rect_GetPosition(*args, **kwargs)
1161
1162 def SetPosition(*args, **kwargs):
1163 """SetPosition(self, Point p)"""
1164 return _core_.Rect_SetPosition(*args, **kwargs)
1165
1166 def GetSize(*args, **kwargs):
1167 """GetSize(self) -> Size"""
1168 return _core_.Rect_GetSize(*args, **kwargs)
1169
1170 def SetSize(*args, **kwargs):
1171 """SetSize(self, Size s)"""
1172 return _core_.Rect_SetSize(*args, **kwargs)
1173
aff4cc5c
RD		 1174 def IsEmpty(*args, **kwargs):
1175 """IsEmpty(self) -> bool"""
1176 return _core_.Rect_IsEmpty(*args, **kwargs)
1177
d55e5bfc
RD		 1178 def GetTopLeft(*args, **kwargs):
1179 """GetTopLeft(self) -> Point"""
1180 return _core_.Rect_GetTopLeft(*args, **kwargs)
1181
1182 def SetTopLeft(*args, **kwargs):
1183 """SetTopLeft(self, Point p)"""
1184 return _core_.Rect_SetTopLeft(*args, **kwargs)
1185
1186 def GetBottomRight(*args, **kwargs):
1187 """GetBottomRight(self) -> Point"""
1188 return _core_.Rect_GetBottomRight(*args, **kwargs)
1189
1190 def SetBottomRight(*args, **kwargs):
1191 """SetBottomRight(self, Point p)"""
1192 return _core_.Rect_SetBottomRight(*args, **kwargs)
1193
5acb46e0
RD		 1194 def GetTopRight(*args, **kwargs):
1195 """GetTopRight(self) -> Point"""
1196 return _core_.Rect_GetTopRight(*args, **kwargs)
1197
1198 def SetTopRight(*args, **kwargs):
1199 """SetTopRight(self, Point p)"""
1200 return _core_.Rect_SetTopRight(*args, **kwargs)
1201
1202 def GetBottomLeft(*args, **kwargs):
1203 """GetBottomLeft(self) -> Point"""
1204 return _core_.Rect_GetBottomLeft(*args, **kwargs)
1205
1206 def SetBottomLeft(*args, **kwargs):
1207 """SetBottomLeft(self, Point p)"""
1208 return _core_.Rect_SetBottomLeft(*args, **kwargs)
1209
d55e5bfc
RD		 1210 def GetLeft(*args, **kwargs):
1211 """GetLeft(self) -> int"""
1212 return _core_.Rect_GetLeft(*args, **kwargs)
1213
1214 def GetTop(*args, **kwargs):
1215 """GetTop(self) -> int"""
1216 return _core_.Rect_GetTop(*args, **kwargs)
1217
1218 def GetBottom(*args, **kwargs):
1219 """GetBottom(self) -> int"""
1220 return _core_.Rect_GetBottom(*args, **kwargs)
1221
1222 def GetRight(*args, **kwargs):
1223 """GetRight(self) -> int"""
1224 return _core_.Rect_GetRight(*args, **kwargs)
1225
1226 def SetLeft(*args, **kwargs):
1227 """SetLeft(self, int left)"""
1228 return _core_.Rect_SetLeft(*args, **kwargs)
1229
1230 def SetRight(*args, **kwargs):
1231 """SetRight(self, int right)"""
1232 return _core_.Rect_SetRight(*args, **kwargs)
1233
1234 def SetTop(*args, **kwargs):
1235 """SetTop(self, int top)"""
1236 return _core_.Rect_SetTop(*args, **kwargs)
1237
1238 def SetBottom(*args, **kwargs):
1239 """SetBottom(self, int bottom)"""
1240 return _core_.Rect_SetBottom(*args, **kwargs)
1241
1242 position = property(GetPosition, SetPosition)
1243 size = property(GetSize, SetSize)
1244 left = property(GetLeft, SetLeft)
1245 right = property(GetRight, SetRight)
1246 top = property(GetTop, SetTop)
1247 bottom = property(GetBottom, SetBottom)
1248
1249 def Inflate(*args, **kwargs):
1250 """
1251 Inflate(self, int dx, int dy) -> Rect
1252
091fdbfa
RD		 1253 Increases the size of the rectangle.
1254
1255 The left border is moved farther left and the right border is moved
1256 farther right by ``dx``. The upper border is moved farther up and the
1257 bottom border is moved farther down by ``dy``. (Note the the width and
1258 height of the rectangle thus change by ``2*dx`` and ``2*dy``,
1259 respectively.) If one or both of ``dx`` and ``dy`` are negative, the
1260 opposite happens: the rectangle size decreases in the respective
1261 direction.
1262
1263 The change is made to the rectangle inplace, if instead you need a
1264 copy that is inflated, preserving the original then make the copy
1265 first::
1266
1267 copy = wx.Rect(*original)
1268 copy.Inflate(10,15)
1269
1270
d55e5bfc
RD		 1271 """
1272 return _core_.Rect_Inflate(*args, **kwargs)
1273
1274 def Deflate(*args, **kwargs):
1275 """
1276 Deflate(self, int dx, int dy) -> Rect
1277
091fdbfa
RD		 1278 Decrease the rectangle size. This method is the opposite of `Inflate`
1279 in that Deflate(a,b) is equivalent to Inflate(-a,-b). Please refer to
1280 `Inflate` for a full description.
d55e5bfc
RD		 1281 """
1282 return _core_.Rect_Deflate(*args, **kwargs)
1283
1284 def OffsetXY(*args, **kwargs):
1285 """
1286 OffsetXY(self, int dx, int dy)
1287
79fccf9d
RD		 1288 Moves the rectangle by the specified offset. If dx is positive, the
1289 rectangle is moved to the right, if dy is positive, it is moved to the
1290 bottom, otherwise it is moved to the left or top respectively.
d55e5bfc
RD		 1291 """
1292 return _core_.Rect_OffsetXY(*args, **kwargs)
1293
1294 def Offset(*args, **kwargs):
1295 """
1296 Offset(self, Point pt)
1297
b1fcee84 1298 Same as `OffsetXY` but uses dx,dy from Point
d55e5bfc
RD		 1299 """
1300 return _core_.Rect_Offset(*args, **kwargs)
1301
1302 def Intersect(*args, **kwargs):
1303 """
1304 Intersect(self, Rect rect) -> Rect
1305
b519803b 1306 Returns the intersectsion of this rectangle and rect.
d55e5bfc
RD		 1307 """
1308 return _core_.Rect_Intersect(*args, **kwargs)
1309
b519803b
RD		 1310 def Union(*args, **kwargs):
1311 """
1312 Union(self, Rect rect) -> Rect
1313
1314 Returns the union of this rectangle and rect.
1315 """
1316 return _core_.Rect_Union(*args, **kwargs)
1317
d55e5bfc
RD		 1318 def __add__(*args, **kwargs):
1319 """
1320 __add__(self, Rect rect) -> Rect
1321
1322 Add the properties of rect to this rectangle and return the result.
1323 """
1324 return _core_.Rect___add__(*args, **kwargs)
1325
1326 def __iadd__(*args, **kwargs):
1327 """
1328 __iadd__(self, Rect rect) -> Rect
1329
1330 Add the properties of rect to this rectangle, updating this rectangle.
1331 """
1332 return _core_.Rect___iadd__(*args, **kwargs)
1333
1334 def __eq__(*args, **kwargs):
1335 """
e9d6f3a4 1336 __eq__(self, PyObject other) -> bool
d55e5bfc 1337
e9d6f3a4 1338 Test for equality of wx.Rect objects.
d55e5bfc
RD		 1339 """
1340 return _core_.Rect___eq__(*args, **kwargs)
1341
1342 def __ne__(*args, **kwargs):
1343 """
e9d6f3a4 1344 __ne__(self, PyObject other) -> bool
d55e5bfc 1345
e9d6f3a4 1346 Test for inequality of wx.Rect objects.
d55e5bfc
RD		 1347 """
1348 return _core_.Rect___ne__(*args, **kwargs)
1349
33d6fd3b 1350 def ContainsXY(*args, **kwargs):
d55e5bfc 1351 """
33d6fd3b 1352 ContainsXY(self, int x, int y) -> bool
d55e5bfc 1353
33d6fd3b 1354 Return True if the point is inside the rect.
d55e5bfc 1355 """
33d6fd3b 1356 return _core_.Rect_ContainsXY(*args, **kwargs)
d55e5bfc 1357
33d6fd3b 1358 def Contains(*args, **kwargs):
d55e5bfc 1359 """
33d6fd3b 1360 Contains(self, Point pt) -> bool
d55e5bfc 1361
33d6fd3b 1362 Return True if the point is inside the rect.
d55e5bfc 1363 """
33d6fd3b 1364 return _core_.Rect_Contains(*args, **kwargs)
d55e5bfc 1365
33d6fd3b 1366 def ContainsRect(*args, **kwargs):
fc46b7f3 1367 """
33d6fd3b 1368 ContainsRect(self, Rect rect) -> bool
fc46b7f3
RD		 1369
1370 Returns ``True`` if the given rectangle is completely inside this
1371 rectangle or touches its boundary.
1372 """
33d6fd3b
RD		 1373 return _core_.Rect_ContainsRect(*args, **kwargs)
1374
72ef6efb
RD		 1375 #Inside = wx._deprecated(Contains, "Use `Contains` instead.")
1376 #InsideXY = wx._deprecated(ContainsXY, "Use `ContainsXY` instead.")
1377 #InsideRect = wx._deprecated(ContainsRect, "Use `ContainsRect` instead.")
1378 Inside = Contains
1379 InsideXY = ContainsXY
1380 InsideRect = ContainsRect
fc46b7f3 1381
d55e5bfc
RD		 1382 def Intersects(*args, **kwargs):
1383 """
1384 Intersects(self, Rect rect) -> bool
1385
1386 Returns True if the rectangles have a non empty intersection.
1387 """
1388 return _core_.Rect_Intersects(*args, **kwargs)
1389
b1fcee84
RD		 1390 def CenterIn(*args, **kwargs):
1391 """
1392 CenterIn(self, Rect r, int dir=BOTH) -> Rect
1393
1394 Center this rectangle within the one passed to the method, which is
1395 usually, but not necessarily, the larger one.
1396 """
1397 return _core_.Rect_CenterIn(*args, **kwargs)
1398
1399 CentreIn = CenterIn
d55e5bfc
RD		 1400 x = property(_core_.Rect_x_get, _core_.Rect_x_set)
1401 y = property(_core_.Rect_y_get, _core_.Rect_y_set)
1402 width = property(_core_.Rect_width_get, _core_.Rect_width_set)
1403 height = property(_core_.Rect_height_get, _core_.Rect_height_set)
1404 def Set(*args, **kwargs):
1405 """
1406 Set(self, int x=0, int y=0, int width=0, int height=0)
1407
1408 Set all rectangle properties.
1409 """
1410 return _core_.Rect_Set(*args, **kwargs)
1411
1412 def Get(*args, **kwargs):
1413 """
1414 Get() -> (x,y,width,height)
1415
1416 Return the rectangle properties as a tuple.
1417 """
1418 return _core_.Rect_Get(*args, **kwargs)
1419
79fccf9d 1420 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD		 1421 def __str__(self): return str(self.Get())
1422 def __repr__(self): return 'wx.Rect'+str(self.Get())
1423 def __len__(self): return len(self.Get())
1424 def __getitem__(self, index): return self.Get()[index]
1425 def __setitem__(self, index, val):
1426 if index == 0: self.x = val
1427 elif index == 1: self.y = val
1428 elif index == 2: self.width = val
1429 elif index == 3: self.height = val
1430 else: raise IndexError
1431 def __nonzero__(self): return self.Get() != (0,0,0,0)
1432 __safe_for_unpickling__ = True
1433 def __reduce__(self): return (wx.Rect, self.Get())
1434
33d6fd3b
RD		 1435 Bottom = property(GetBottom,SetBottom,doc="See `GetBottom` and `SetBottom`")
1436 BottomRight = property(GetBottomRight,SetBottomRight,doc="See `GetBottomRight` and `SetBottomRight`")
5acb46e0 1437 BottomLeft = property(GetBottomLeft,SetBottomLeft,doc="See `GetBottomLeft` and `SetBottomLeft`")
33d6fd3b
RD		 1438 Height = property(GetHeight,SetHeight,doc="See `GetHeight` and `SetHeight`")
1439 Left = property(GetLeft,SetLeft,doc="See `GetLeft` and `SetLeft`")
1440 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
1441 Right = property(GetRight,SetRight,doc="See `GetRight` and `SetRight`")
1442 Size = property(GetSize,SetSize,doc="See `GetSize` and `SetSize`")
1443 Top = property(GetTop,SetTop,doc="See `GetTop` and `SetTop`")
1444 TopLeft = property(GetTopLeft,SetTopLeft,doc="See `GetTopLeft` and `SetTopLeft`")
5acb46e0 1445 TopRight = property(GetTopRight,SetTopRight,doc="See `GetTopRight` and `SetTopRight`")
33d6fd3b
RD		 1446 Width = property(GetWidth,SetWidth,doc="See `GetWidth` and `SetWidth`")
1447 X = property(GetX,SetX,doc="See `GetX` and `SetX`")
1448 Y = property(GetY,SetY,doc="See `GetY` and `SetY`")
1449 Empty = property(IsEmpty,doc="See `IsEmpty`")
2131d850 1450_core_.Rect_swigregister(Rect)
d55e5bfc
RD		 1451
1452def RectPP(*args, **kwargs):
1453 """
1454 RectPP(Point topLeft, Point bottomRight) -> Rect
1455
1456 Create a new Rect object from Points representing two corners.
1457 """
1458 val = _core_.new_RectPP(*args, **kwargs)
d55e5bfc
RD		 1459 return val
1460
1461def RectPS(*args, **kwargs):
1462 """
1463 RectPS(Point pos, Size size) -> Rect
1464
1465 Create a new Rect from a position and size.
1466 """
1467 val = _core_.new_RectPS(*args, **kwargs)
d55e5bfc
RD		 1468 return val
1469
c1cb24a4
RD		 1470def RectS(*args, **kwargs):
1471 """
1472 RectS(Size size) -> Rect
1473
1474 Create a new Rect from a size only.
1475 """
1476 val = _core_.new_RectS(*args, **kwargs)
c1cb24a4
RD		 1477 return val
1478
d55e5bfc
RD		 1479
1480def IntersectRect(*args, **kwargs):
554f62e9 1481 """
d55e5bfc
RD		 1482 IntersectRect(Rect r1, Rect r2) -> Rect
1483
1484 Calculate and return the intersection of r1 and r2.
1485 """
554f62e9 1486 return _core_.IntersectRect(*args, **kwargs)
d55e5bfc
RD		 1487#---------------------------------------------------------------------------
1488
1489class Point2D(object):
79fccf9d
RD		 1490 """
1491 wx.Point2Ds represent a point or a vector in a 2d coordinate system
1492 with floating point values.
1493 """
554f62e9
RD		 1494 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1495 __repr__ = _swig_repr
1496 def __init__(self, *args, **kwargs):
d55e5bfc
RD		 1497 """
1498 __init__(self, double x=0.0, double y=0.0) -> Point2D
1499
1500 Create a w.Point2D object.
1501 """
554f62e9 1502 _core_.Point2D_swiginit(self,_core_.new_Point2D(*args, **kwargs))
b39fe951
RD		 1503 __swig_destroy__ = _core_.delete_Point2D
1504 __del__ = lambda self : None;
d55e5bfc 1505 def GetFloor(*args, **kwargs):
a8eff060
RD		 1506 """
1507 GetFloor() -> (x,y)
1508
1509 Convert to integer
1510 """
d55e5bfc
RD		 1511 return _core_.Point2D_GetFloor(*args, **kwargs)
1512
1513 def GetRounded(*args, **kwargs):
a8eff060
RD		 1514 """
1515 GetRounded() -> (x,y)
1516
1517 Convert to integer
1518 """
d55e5bfc
RD		 1519 return _core_.Point2D_GetRounded(*args, **kwargs)
1520
1521 def GetVectorLength(*args, **kwargs):
1522 """GetVectorLength(self) -> double"""
1523 return _core_.Point2D_GetVectorLength(*args, **kwargs)
1524
1525 def GetVectorAngle(*args, **kwargs):
1526 """GetVectorAngle(self) -> double"""
1527 return _core_.Point2D_GetVectorAngle(*args, **kwargs)
1528
1529 def SetVectorLength(*args, **kwargs):
1530 """SetVectorLength(self, double length)"""
1531 return _core_.Point2D_SetVectorLength(*args, **kwargs)
1532
1533 def SetVectorAngle(*args, **kwargs):
1534 """SetVectorAngle(self, double degrees)"""
1535 return _core_.Point2D_SetVectorAngle(*args, **kwargs)
1536
1537 def SetPolarCoordinates(self, angle, length):
1538 self.SetVectorLength(length)
1539 self.SetVectorAngle(angle)
1540 def Normalize(self):
1541 self.SetVectorLength(1.0)
1542
1543 def GetDistance(*args, **kwargs):
1544 """GetDistance(self, Point2D pt) -> double"""
1545 return _core_.Point2D_GetDistance(*args, **kwargs)
1546
1547 def GetDistanceSquare(*args, **kwargs):
1548 """GetDistanceSquare(self, Point2D pt) -> double"""
1549 return _core_.Point2D_GetDistanceSquare(*args, **kwargs)
1550
1551 def GetDotProduct(*args, **kwargs):
1552 """GetDotProduct(self, Point2D vec) -> double"""
1553 return _core_.Point2D_GetDotProduct(*args, **kwargs)
1554
1555 def GetCrossProduct(*args, **kwargs):
1556 """GetCrossProduct(self, Point2D vec) -> double"""
1557 return _core_.Point2D_GetCrossProduct(*args, **kwargs)
1558
1559 def __neg__(*args, **kwargs):
1560 """
1561 __neg__(self) -> Point2D
1562
1563 the reflection of this point
1564 """
1565 return _core_.Point2D___neg__(*args, **kwargs)
1566
1567 def __iadd__(*args, **kwargs):
1568 """__iadd__(self, Point2D pt) -> Point2D"""
1569 return _core_.Point2D___iadd__(*args, **kwargs)
1570
1571 def __isub__(*args, **kwargs):
1572 """__isub__(self, Point2D pt) -> Point2D"""
1573 return _core_.Point2D___isub__(*args, **kwargs)
1574
1575 def __imul__(*args, **kwargs):
1576 """__imul__(self, Point2D pt) -> Point2D"""
1577 return _core_.Point2D___imul__(*args, **kwargs)
1578
1579 def __idiv__(*args, **kwargs):
1580 """__idiv__(self, Point2D pt) -> Point2D"""
1581 return _core_.Point2D___idiv__(*args, **kwargs)
1582
1583 def __eq__(*args, **kwargs):
1584 """
e9d6f3a4 1585 __eq__(self, PyObject other) -> bool
d55e5bfc 1586
e9d6f3a4 1587 Test for equality of wx.Point2D objects.
d55e5bfc
RD		 1588 """
1589 return _core_.Point2D___eq__(*args, **kwargs)
1590
1591 def __ne__(*args, **kwargs):
1592 """
e9d6f3a4 1593 __ne__(self, PyObject other) -> bool
d55e5bfc 1594
e9d6f3a4 1595 Test for inequality of wx.Point2D objects.
d55e5bfc
RD		 1596 """
1597 return _core_.Point2D___ne__(*args, **kwargs)
1598
1599 x = property(_core_.Point2D_x_get, _core_.Point2D_x_set)
1600 y = property(_core_.Point2D_y_get, _core_.Point2D_y_set)
1601 def Set(*args, **kwargs):
1602 """Set(self, double x=0, double y=0)"""
1603 return _core_.Point2D_Set(*args, **kwargs)
1604
1605 def Get(*args, **kwargs):
1606 """
1607 Get() -> (x,y)
1608
1609 Return x and y properties as a tuple.
1610 """
1611 return _core_.Point2D_Get(*args, **kwargs)
1612
79fccf9d 1613 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD		 1614 def __str__(self): return str(self.Get())
1615 def __repr__(self): return 'wx.Point2D'+str(self.Get())
1616 def __len__(self): return len(self.Get())
1617 def __getitem__(self, index): return self.Get()[index]
1618 def __setitem__(self, index, val):
1619 if index == 0: self.x = val
1620 elif index == 1: self.y = val
1621 else: raise IndexError
1622 def __nonzero__(self): return self.Get() != (0.0, 0.0)
1623 __safe_for_unpickling__ = True
1624 def __reduce__(self): return (wx.Point2D, self.Get())
1625
33d6fd3b
RD		 1626 Floor = property(GetFloor,doc="See `GetFloor`")
1627 Rounded = property(GetRounded,doc="See `GetRounded`")
1628 VectorAngle = property(GetVectorAngle,SetVectorAngle,doc="See `GetVectorAngle` and `SetVectorAngle`")
1629 VectorLength = property(GetVectorLength,SetVectorLength,doc="See `GetVectorLength` and `SetVectorLength`")
2131d850 1630_core_.Point2D_swigregister(Point2D)
d55e5bfc
RD		 1631
1632def Point2DCopy(*args, **kwargs):
1633 """
1634 Point2DCopy(Point2D pt) -> Point2D
1635
1636 Create a w.Point2D object.
1637 """
1638 val = _core_.new_Point2DCopy(*args, **kwargs)
d55e5bfc
RD		 1639 return val
1640
1641def Point2DFromPoint(*args, **kwargs):
1642 """
1643 Point2DFromPoint(Point pt) -> Point2D
1644
1645 Create a w.Point2D object.
1646 """
1647 val = _core_.new_Point2DFromPoint(*args, **kwargs)
d55e5bfc
RD		 1648 return val
1649
1650#---------------------------------------------------------------------------
1651
70d7cb34
RD		 1652Inside = _core_.Inside
1653OutLeft = _core_.OutLeft
1654OutRight = _core_.OutRight
1655OutTop = _core_.OutTop
1656OutBottom = _core_.OutBottom
1657class Rect2D(object):
1658 """
1659 wx.Rect2D is a rectangle, with position and size, in a 2D coordinate system
1660 with floating point component values.
1661 """
1662 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1663 __repr__ = _swig_repr
1664 def __init__(self, *args, **kwargs):
1665 """
1666 __init__(self, wxDouble x=0.0, wxDouble y=0.0, wxDouble w=0.0, wxDouble h=0.0) -> Rect2D
1667
1668 wx.Rect2D is a rectangle, with position and size, in a 2D coordinate system
1669 with floating point component values.
1670 """
1671 _core_.Rect2D_swiginit(self,_core_.new_Rect2D(*args, **kwargs))
1672 __swig_destroy__ = _core_.delete_Rect2D
1673 __del__ = lambda self : None;
1674 def GetPosition(*args, **kwargs):
1675 """GetPosition(self) -> Point2D"""
1676 return _core_.Rect2D_GetPosition(*args, **kwargs)
1677
1678 def GetSize(*args, **kwargs):
1679 """GetSize(self) -> Size"""
1680 return _core_.Rect2D_GetSize(*args, **kwargs)
1681
1682 def GetLeft(*args, **kwargs):
1683 """GetLeft(self) -> wxDouble"""
1684 return _core_.Rect2D_GetLeft(*args, **kwargs)
1685
1686 def SetLeft(*args, **kwargs):
1687 """SetLeft(self, wxDouble n)"""
1688 return _core_.Rect2D_SetLeft(*args, **kwargs)
1689
1690 def MoveLeftTo(*args, **kwargs):
1691 """MoveLeftTo(self, wxDouble n)"""
1692 return _core_.Rect2D_MoveLeftTo(*args, **kwargs)
1693
1694 def GetTop(*args, **kwargs):
1695 """GetTop(self) -> wxDouble"""
1696 return _core_.Rect2D_GetTop(*args, **kwargs)
1697
1698 def SetTop(*args, **kwargs):
1699 """SetTop(self, wxDouble n)"""
1700 return _core_.Rect2D_SetTop(*args, **kwargs)
1701
1702 def MoveTopTo(*args, **kwargs):
1703 """MoveTopTo(self, wxDouble n)"""
1704 return _core_.Rect2D_MoveTopTo(*args, **kwargs)
1705
1706 def GetBottom(*args, **kwargs):
1707 """GetBottom(self) -> wxDouble"""
1708 return _core_.Rect2D_GetBottom(*args, **kwargs)
1709
1710 def SetBottom(*args, **kwargs):
1711 """SetBottom(self, wxDouble n)"""
1712 return _core_.Rect2D_SetBottom(*args, **kwargs)
1713
1714 def MoveBottomTo(*args, **kwargs):
1715 """MoveBottomTo(self, wxDouble n)"""
1716 return _core_.Rect2D_MoveBottomTo(*args, **kwargs)
1717
1718 def GetRight(*args, **kwargs):
1719 """GetRight(self) -> wxDouble"""
1720 return _core_.Rect2D_GetRight(*args, **kwargs)
1721
1722 def SetRight(*args, **kwargs):
1723 """SetRight(self, wxDouble n)"""
1724 return _core_.Rect2D_SetRight(*args, **kwargs)
1725
1726 def MoveRightTo(*args, **kwargs):
1727 """MoveRightTo(self, wxDouble n)"""
1728 return _core_.Rect2D_MoveRightTo(*args, **kwargs)
1729
1730 def GetLeftTop(*args, **kwargs):
1731 """GetLeftTop(self) -> Point2D"""
1732 return _core_.Rect2D_GetLeftTop(*args, **kwargs)
1733
1734 def SetLeftTop(*args, **kwargs):
1735 """SetLeftTop(self, Point2D pt)"""
1736 return _core_.Rect2D_SetLeftTop(*args, **kwargs)
1737
1738 def MoveLeftTopTo(*args, **kwargs):
1739 """MoveLeftTopTo(self, Point2D pt)"""
1740 return _core_.Rect2D_MoveLeftTopTo(*args, **kwargs)
1741
1742 def GetLeftBottom(*args, **kwargs):
1743 """GetLeftBottom(self) -> Point2D"""
1744 return _core_.Rect2D_GetLeftBottom(*args, **kwargs)
1745
1746 def SetLeftBottom(*args, **kwargs):
1747 """SetLeftBottom(self, Point2D pt)"""
1748 return _core_.Rect2D_SetLeftBottom(*args, **kwargs)
1749
1750 def MoveLeftBottomTo(*args, **kwargs):
1751 """MoveLeftBottomTo(self, Point2D pt)"""
1752 return _core_.Rect2D_MoveLeftBottomTo(*args, **kwargs)
1753
1754 def GetRightTop(*args, **kwargs):
1755 """GetRightTop(self) -> Point2D"""
1756 return _core_.Rect2D_GetRightTop(*args, **kwargs)
1757
1758 def SetRightTop(*args, **kwargs):
1759 """SetRightTop(self, Point2D pt)"""
1760 return _core_.Rect2D_SetRightTop(*args, **kwargs)
1761
1762 def MoveRightTopTo(*args, **kwargs):
1763 """MoveRightTopTo(self, Point2D pt)"""
1764 return _core_.Rect2D_MoveRightTopTo(*args, **kwargs)
1765
1766 def GetRightBottom(*args, **kwargs):
1767 """GetRightBottom(self) -> Point2D"""
1768 return _core_.Rect2D_GetRightBottom(*args, **kwargs)
1769
1770 def SetRightBottom(*args, **kwargs):
1771 """SetRightBottom(self, Point2D pt)"""
1772 return _core_.Rect2D_SetRightBottom(*args, **kwargs)
1773
1774 def MoveRightBottomTo(*args, **kwargs):
1775 """MoveRightBottomTo(self, Point2D pt)"""
1776 return _core_.Rect2D_MoveRightBottomTo(*args, **kwargs)
1777
1778 def GetCentre(*args, **kwargs):
1779 """GetCentre(self) -> Point2D"""
1780 return _core_.Rect2D_GetCentre(*args, **kwargs)
1781
1782 def SetCentre(*args, **kwargs):
1783 """SetCentre(self, Point2D pt)"""
1784 return _core_.Rect2D_SetCentre(*args, **kwargs)
1785
1786 def MoveCentreTo(*args, **kwargs):
1787 """MoveCentreTo(self, Point2D pt)"""
1788 return _core_.Rect2D_MoveCentreTo(*args, **kwargs)
1789
1790 def GetOutcode(*args, **kwargs):
1791 """GetOutcode(self, Point2D pt) -> int"""
1792 return _core_.Rect2D_GetOutcode(*args, **kwargs)
1793
1794 def Contains(*args, **kwargs):
1795 """Contains(self, Point2D pt) -> bool"""
1796 return _core_.Rect2D_Contains(*args, **kwargs)
1797
1798 def ContainsRect(*args, **kwargs):
1799 """ContainsRect(self, Rect2D rect) -> bool"""
1800 return _core_.Rect2D_ContainsRect(*args, **kwargs)
1801
1802 def IsEmpty(*args, **kwargs):
1803 """IsEmpty(self) -> bool"""
1804 return _core_.Rect2D_IsEmpty(*args, **kwargs)
1805
1806 def HaveEqualSize(*args, **kwargs):
1807 """HaveEqualSize(self, Rect2D rect) -> bool"""
1808 return _core_.Rect2D_HaveEqualSize(*args, **kwargs)
1809
1810 def Inset(*args):
1811 """
1812 Inset(self, wxDouble x, wxDouble y)
1813 Inset(self, wxDouble left, wxDouble top, wxDouble right, wxDouble bottom)
1814 """
1815 return _core_.Rect2D_Inset(*args)
1816
1817 def Offset(*args, **kwargs):
1818 """Offset(self, Point2D pt)"""
1819 return _core_.Rect2D_Offset(*args, **kwargs)
1820
1821 def ConstrainTo(*args, **kwargs):
1822 """ConstrainTo(self, Rect2D rect)"""
1823 return _core_.Rect2D_ConstrainTo(*args, **kwargs)
1824
1825 def Interpolate(*args, **kwargs):
1826 """Interpolate(self, int widthfactor, int heightfactor) -> Point2D"""
1827 return _core_.Rect2D_Interpolate(*args, **kwargs)
1828
1829 def Intersect(*args, **kwargs):
1830 """Intersect(self, Rect2D otherRect)"""
1831 return _core_.Rect2D_Intersect(*args, **kwargs)
1832
1833 def CreateIntersection(*args, **kwargs):
1834 """CreateIntersection(self, Rect2D otherRect) -> Rect2D"""
1835 return _core_.Rect2D_CreateIntersection(*args, **kwargs)
1836
1837 def Intersects(*args, **kwargs):
1838 """Intersects(self, Rect2D rect) -> bool"""
1839 return _core_.Rect2D_Intersects(*args, **kwargs)
1840
1841 def Union(*args, **kwargs):
1842 """Union(self, Rect2D otherRect)"""
1843 return _core_.Rect2D_Union(*args, **kwargs)
1844
1845 def CreateUnion(*args, **kwargs):
1846 """CreateUnion(self, Rect2D otherRect) -> Rect2D"""
1847 return _core_.Rect2D_CreateUnion(*args, **kwargs)
1848
1849 def Scale(*args):
1850 """
1851 Scale(self, wxDouble f)
1852 Scale(self, int num, int denum)
1853 """
1854 return _core_.Rect2D_Scale(*args)
1855
1856 def __eq__(*args, **kwargs):
1857 """
1858 __eq__(self, PyObject other) -> bool
1859
1860 Test for equality of wx.Rect2D objects.
1861 """
1862 return _core_.Rect2D___eq__(*args, **kwargs)
1863
1864 def __ne__(*args, **kwargs):
1865 """
1866 __ne__(self, PyObject other) -> bool
1867
1868 Test for inequality of wx.Rect2D objects.
1869 """
1870 return _core_.Rect2D___ne__(*args, **kwargs)
1871
1872 x = property(_core_.Rect2D_x_get, _core_.Rect2D_x_set)
1873 y = property(_core_.Rect2D_y_get, _core_.Rect2D_y_set)
1874 width = property(_core_.Rect2D_width_get, _core_.Rect2D_width_set)
1875 height = property(_core_.Rect2D_height_get, _core_.Rect2D_height_set)
1876 def Set(*args, **kwargs):
1877 """Set(self, wxDouble x=0, wxDouble y=0, wxDouble width=0, wxDouble height=0)"""
1878 return _core_.Rect2D_Set(*args, **kwargs)
1879
1880 def Get(*args, **kwargs):
1881 """
1882 Get() -> (x,y, width, height)
1883
1884 Return x, y, width and height y properties as a tuple.
1885 """
1886 return _core_.Rect2D_Get(*args, **kwargs)
1887
1888 def __str__(self): return str(self.Get())
1889 def __repr__(self): return 'wx.Rect2D'+str(self.Get())
1890 def __len__(self): return len(self.Get())
1891 def __getitem__(self, index): return self.Get()[index]
1892 def __setitem__(self, index, val):
1893 if index == 0: self.x = val
1894 elif index == 1: self.y = val
1895 elif index == 2: self.width = val
1896 elif index == 3: self.height = val
1897 else: raise IndexError
1898 def __nonzero__(self): return self.Get() != (0.0, 0.0, 0.0, 0.0)
1899 __safe_for_unpickling__ = True
1900 def __reduce__(self): return (wx.Rect2D, self.Get())
1901
1902_core_.Rect2D_swigregister(Rect2D)
1903
1904#---------------------------------------------------------------------------
1905
d55e5bfc
RD		 1906FromStart = _core_.FromStart
1907FromCurrent = _core_.FromCurrent
1908FromEnd = _core_.FromEnd
1909class InputStream(object):
093d3ff1 1910 """Proxy of C++ InputStream class"""
554f62e9
RD		 1911 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1912 __repr__ = _swig_repr
1913 def __init__(self, *args, **kwargs):
d55e5bfc 1914 """__init__(self, PyObject p) -> InputStream"""
554f62e9
RD		 1915 _core_.InputStream_swiginit(self,_core_.new_InputStream(*args, **kwargs))
1916 __swig_destroy__ = _core_.delete_InputStream
1917 __del__ = lambda self : None;
d55e5bfc
RD		 1918 def close(*args, **kwargs):
1919 """close(self)"""
1920 return _core_.InputStream_close(*args, **kwargs)
1921
1922 def flush(*args, **kwargs):
1923 """flush(self)"""
1924 return _core_.InputStream_flush(*args, **kwargs)
1925
1926 def eof(*args, **kwargs):
1927 """eof(self) -> bool"""
1928 return _core_.InputStream_eof(*args, **kwargs)
1929
1930 def read(*args, **kwargs):
1931 """read(self, int size=-1) -> PyObject"""
1932 return _core_.InputStream_read(*args, **kwargs)
1933
1934 def readline(*args, **kwargs):
1935 """readline(self, int size=-1) -> PyObject"""
1936 return _core_.InputStream_readline(*args, **kwargs)
1937
1938 def readlines(*args, **kwargs):
1939 """readlines(self, int sizehint=-1) -> PyObject"""
1940 return _core_.InputStream_readlines(*args, **kwargs)
1941
1942 def seek(*args, **kwargs):
1943 """seek(self, int offset, int whence=0)"""
1944 return _core_.InputStream_seek(*args, **kwargs)
1945
1946 def tell(*args, **kwargs):
1947 """tell(self) -> int"""
1948 return _core_.InputStream_tell(*args, **kwargs)
1949
1950 def Peek(*args, **kwargs):
1951 """Peek(self) -> char"""
1952 return _core_.InputStream_Peek(*args, **kwargs)
1953
1954 def GetC(*args, **kwargs):
1955 """GetC(self) -> char"""
1956 return _core_.InputStream_GetC(*args, **kwargs)
1957
1958 def LastRead(*args, **kwargs):
1959 """LastRead(self) -> size_t"""
1960 return _core_.InputStream_LastRead(*args, **kwargs)
1961
1962 def CanRead(*args, **kwargs):
1963 """CanRead(self) -> bool"""
1964 return _core_.InputStream_CanRead(*args, **kwargs)
1965
1966 def Eof(*args, **kwargs):
1967 """Eof(self) -> bool"""
1968 return _core_.InputStream_Eof(*args, **kwargs)
1969
1970 def Ungetch(*args, **kwargs):
1971 """Ungetch(self, char c) -> bool"""
1972 return _core_.InputStream_Ungetch(*args, **kwargs)
1973
1974 def SeekI(*args, **kwargs):
1975 """SeekI(self, long pos, int mode=FromStart) -> long"""
1976 return _core_.InputStream_SeekI(*args, **kwargs)
1977
1978 def TellI(*args, **kwargs):
1979 """TellI(self) -> long"""
1980 return _core_.InputStream_TellI(*args, **kwargs)
1981
2131d850 1982_core_.InputStream_swigregister(InputStream)
d55e5bfc
RD		 1983DefaultPosition = cvar.DefaultPosition
1984DefaultSize = cvar.DefaultSize
1985
1986class OutputStream(object):
093d3ff1 1987 """Proxy of C++ OutputStream class"""
554f62e9
RD		 1988 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1989 def __init__(self): raise AttributeError, "No constructor defined"
1990 __repr__ = _swig_repr
d55e5bfc
RD		 1991 def write(*args, **kwargs):
1992 """write(self, PyObject obj)"""
1993 return _core_.OutputStream_write(*args, **kwargs)
1994
554f62e9
RD		 1995 def LastWrite(*args, **kwargs):
1996 """LastWrite(self) -> size_t"""
1997 return _core_.OutputStream_LastWrite(*args, **kwargs)
d55e5bfc 1998
2131d850 1999_core_.OutputStream_swigregister(OutputStream)
d55e5bfc
RD		 2000
2001#---------------------------------------------------------------------------
2002
2003class FSFile(Object):
093d3ff1 2004 """Proxy of C++ FSFile class"""
554f62e9
RD		 2005 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2006 __repr__ = _swig_repr
2007 def __init__(self, *args, **kwargs):
d55e5bfc
RD		 2008 """
2009 __init__(self, InputStream stream, String loc, String mimetype, String anchor,
2010 DateTime modif) -> FSFile
2011 """
554f62e9 2012 _core_.FSFile_swiginit(self,_core_.new_FSFile(*args, **kwargs))
554f62e9
RD		 2013 __swig_destroy__ = _core_.delete_FSFile
2014 __del__ = lambda self : None;
d55e5bfc
RD		 2015 def GetStream(*args, **kwargs):
2016 """GetStream(self) -> InputStream"""
2017 return _core_.FSFile_GetStream(*args, **kwargs)
2018
97ab0f6a
RD		 2019 def DetachStream(*args, **kwargs):
2020 """DetachStream(self)"""
2021 return _core_.FSFile_DetachStream(*args, **kwargs)
2022
d55e5bfc
RD		 2023 def GetMimeType(*args, **kwargs):
2024 """GetMimeType(self) -> String"""
2025 return _core_.FSFile_GetMimeType(*args, **kwargs)
2026
2027 def GetLocation(*args, **kwargs):
2028 """GetLocation(self) -> String"""
2029 return _core_.FSFile_GetLocation(*args, **kwargs)
2030
2031 def GetAnchor(*args, **kwargs):
2032 """GetAnchor(self) -> String"""
2033 return _core_.FSFile_GetAnchor(*args, **kwargs)
2034
2035 def GetModificationTime(*args, **kwargs):
2036 """GetModificationTime(self) -> DateTime"""
2037 return _core_.FSFile_GetModificationTime(*args, **kwargs)
2038
97ab0f6a
RD		 2039 Anchor = property(GetAnchor,doc="See `GetAnchor`")
2040 Location = property(GetLocation,doc="See `GetLocation`")
2041 MimeType = property(GetMimeType,doc="See `GetMimeType`")
2042 ModificationTime = property(GetModificationTime,doc="See `GetModificationTime`")
2043 Stream = property(GetStream,doc="See `GetStream`")
2131d850 2044_core_.FSFile_swigregister(FSFile)
d55e5bfc
RD		 2045
2046class CPPFileSystemHandler(object):
093d3ff1 2047 """Proxy of C++ CPPFileSystemHandler class"""
554f62e9
RD		 2048 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2049 def __init__(self): raise AttributeError, "No constructor defined"
2050 __repr__ = _swig_repr
50f151d7
RD		 2051 __swig_destroy__ = _core_.delete_CPPFileSystemHandler
2052 __del__ = lambda self : None;
2131d850 2053_core_.CPPFileSystemHandler_swigregister(CPPFileSystemHandler)
d55e5bfc
RD		 2054
2055class FileSystemHandler(CPPFileSystemHandler):
093d3ff1 2056 """Proxy of C++ FileSystemHandler class"""
554f62e9
RD		 2057 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2058 __repr__ = _swig_repr
2059 def __init__(self, *args, **kwargs):
d55e5bfc 2060 """__init__(self) -> FileSystemHandler"""
554f62e9 2061 _core_.FileSystemHandler_swiginit(self,_core_.new_FileSystemHandler(*args, **kwargs))
d55e5bfc
RD		 2062 self._setCallbackInfo(self, FileSystemHandler)
2063
2064 def _setCallbackInfo(*args, **kwargs):
2065 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
2066 return _core_.FileSystemHandler__setCallbackInfo(*args, **kwargs)
2067
2068 def CanOpen(*args, **kwargs):
2069 """CanOpen(self, String location) -> bool"""
2070 return _core_.FileSystemHandler_CanOpen(*args, **kwargs)
2071
2072 def OpenFile(*args, **kwargs):
2073 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
2074 return _core_.FileSystemHandler_OpenFile(*args, **kwargs)
2075
2076 def FindFirst(*args, **kwargs):
2077 """FindFirst(self, String spec, int flags=0) -> String"""
2078 return _core_.FileSystemHandler_FindFirst(*args, **kwargs)
2079
2080 def FindNext(*args, **kwargs):
2081 """FindNext(self) -> String"""
2082 return _core_.FileSystemHandler_FindNext(*args, **kwargs)
2083
2084 def GetProtocol(*args, **kwargs):
2085 """GetProtocol(self, String location) -> String"""
2086 return _core_.FileSystemHandler_GetProtocol(*args, **kwargs)
2087
2088 def GetLeftLocation(*args, **kwargs):
2089 """GetLeftLocation(self, String location) -> String"""
2090 return _core_.FileSystemHandler_GetLeftLocation(*args, **kwargs)
2091
2092 def GetAnchor(*args, **kwargs):
2093 """GetAnchor(self, String location) -> String"""
2094 return _core_.FileSystemHandler_GetAnchor(*args, **kwargs)
2095
2096 def GetRightLocation(*args, **kwargs):
2097 """GetRightLocation(self, String location) -> String"""
2098 return _core_.FileSystemHandler_GetRightLocation(*args, **kwargs)
2099
2100 def GetMimeTypeFromExt(*args, **kwargs):
2101 """GetMimeTypeFromExt(self, String location) -> String"""
2102 return _core_.FileSystemHandler_GetMimeTypeFromExt(*args, **kwargs)
2103
97ab0f6a
RD		 2104 Anchor = property(GetAnchor,doc="See `GetAnchor`")
2105 LeftLocation = property(GetLeftLocation,doc="See `GetLeftLocation`")
2106 MimeTypeFromExt = property(GetMimeTypeFromExt,doc="See `GetMimeTypeFromExt`")
2107 Protocol = property(GetProtocol,doc="See `GetProtocol`")
2108 RightLocation = property(GetRightLocation,doc="See `GetRightLocation`")
2131d850 2109_core_.FileSystemHandler_swigregister(FileSystemHandler)
d55e5bfc
RD		 2110
2111class FileSystem(Object):
093d3ff1 2112 """Proxy of C++ FileSystem class"""
554f62e9
RD		 2113 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2114 __repr__ = _swig_repr
2115 def __init__(self, *args, **kwargs):
d55e5bfc 2116 """__init__(self) -> FileSystem"""
554f62e9
RD		 2117 _core_.FileSystem_swiginit(self,_core_.new_FileSystem(*args, **kwargs))
2118 __swig_destroy__ = _core_.delete_FileSystem
2119 __del__ = lambda self : None;
d55e5bfc
RD		 2120 def ChangePathTo(*args, **kwargs):
2121 """ChangePathTo(self, String location, bool is_dir=False)"""
2122 return _core_.FileSystem_ChangePathTo(*args, **kwargs)
2123
2124 def GetPath(*args, **kwargs):
2125 """GetPath(self) -> String"""
2126 return _core_.FileSystem_GetPath(*args, **kwargs)
2127
2128 def OpenFile(*args, **kwargs):
2129 """OpenFile(self, String location) -> FSFile"""
2130 return _core_.FileSystem_OpenFile(*args, **kwargs)
2131
2132 def FindFirst(*args, **kwargs):
2133 """FindFirst(self, String spec, int flags=0) -> String"""
2134 return _core_.FileSystem_FindFirst(*args, **kwargs)
2135
2136 def FindNext(*args, **kwargs):
2137 """FindNext(self) -> String"""
2138 return _core_.FileSystem_FindNext(*args, **kwargs)
2139
2140 def AddHandler(*args, **kwargs):
c24da6d6 2141 """AddHandler(CPPFileSystemHandler handler)"""
d55e5bfc
RD		 2142 return _core_.FileSystem_AddHandler(*args, **kwargs)
2143
2144 AddHandler = staticmethod(AddHandler)
97ab0f6a
RD		 2145 def RemoveHandler(*args, **kwargs):
2146 """RemoveHandler(CPPFileSystemHandler handler) -> CPPFileSystemHandler"""
2147 return _core_.FileSystem_RemoveHandler(*args, **kwargs)
2148
2149 RemoveHandler = staticmethod(RemoveHandler)
d55e5bfc 2150 def CleanUpHandlers(*args, **kwargs):
c24da6d6 2151 """CleanUpHandlers()"""
d55e5bfc
RD		 2152 return _core_.FileSystem_CleanUpHandlers(*args, **kwargs)
2153
2154 CleanUpHandlers = staticmethod(CleanUpHandlers)
2155 def FileNameToURL(*args, **kwargs):
c24da6d6 2156 """FileNameToURL(String filename) -> String"""
d55e5bfc
RD		 2157 return _core_.FileSystem_FileNameToURL(*args, **kwargs)
2158
2159 FileNameToURL = staticmethod(FileNameToURL)
ae8162c8
RD		 2160 def URLToFileName(*args, **kwargs):
2161 """URLToFileName(String url) -> String"""
2162 return _core_.FileSystem_URLToFileName(*args, **kwargs)
2163
2164 URLToFileName = staticmethod(URLToFileName)
97ab0f6a 2165 Path = property(GetPath,doc="See `GetPath`")
2131d850 2166_core_.FileSystem_swigregister(FileSystem)
d55e5bfc
RD		 2167
2168def FileSystem_AddHandler(*args, **kwargs):
554f62e9
RD		 2169 """FileSystem_AddHandler(CPPFileSystemHandler handler)"""
2170 return _core_.FileSystem_AddHandler(*args, **kwargs)
d55e5bfc 2171
97ab0f6a
RD		 2172def FileSystem_RemoveHandler(*args, **kwargs):
2173 """FileSystem_RemoveHandler(CPPFileSystemHandler handler) -> CPPFileSystemHandler"""
2174 return _core_.FileSystem_RemoveHandler(*args, **kwargs)
2175
554f62e9
RD		 2176def FileSystem_CleanUpHandlers(*args):
2177 """FileSystem_CleanUpHandlers()"""
2178 return _core_.FileSystem_CleanUpHandlers(*args)
d55e5bfc
RD		 2179
2180def FileSystem_FileNameToURL(*args, **kwargs):
554f62e9
RD		 2181 """FileSystem_FileNameToURL(String filename) -> String"""
2182 return _core_.FileSystem_FileNameToURL(*args, **kwargs)
d55e5bfc 2183
d55e5bfc 2184def FileSystem_URLToFileName(*args, **kwargs):
554f62e9
RD		 2185 """FileSystem_URLToFileName(String url) -> String"""
2186 return _core_.FileSystem_URLToFileName(*args, **kwargs)
ae8162c8 2187
d55e5bfc 2188class InternetFSHandler(CPPFileSystemHandler):
093d3ff1 2189 """Proxy of C++ InternetFSHandler class"""
554f62e9
RD		 2190 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2191 __repr__ = _swig_repr
2192 def __init__(self, *args, **kwargs):
d55e5bfc 2193 """__init__(self) -> InternetFSHandler"""
554f62e9 2194 _core_.InternetFSHandler_swiginit(self,_core_.new_InternetFSHandler(*args, **kwargs))
d55e5bfc
RD		 2195 def CanOpen(*args, **kwargs):
2196 """CanOpen(self, String location) -> bool"""
2197 return _core_.InternetFSHandler_CanOpen(*args, **kwargs)
2198
2199 def OpenFile(*args, **kwargs):
2200 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
2201 return _core_.InternetFSHandler_OpenFile(*args, **kwargs)
2202
2131d850 2203_core_.InternetFSHandler_swigregister(InternetFSHandler)
d55e5bfc
RD		 2204
2205class ZipFSHandler(CPPFileSystemHandler):
093d3ff1 2206 """Proxy of C++ ZipFSHandler class"""
554f62e9
RD		 2207 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2208 __repr__ = _swig_repr
2209 def __init__(self, *args, **kwargs):
d55e5bfc 2210 """__init__(self) -> ZipFSHandler"""
554f62e9 2211 _core_.ZipFSHandler_swiginit(self,_core_.new_ZipFSHandler(*args, **kwargs))
d55e5bfc
RD		 2212 def CanOpen(*args, **kwargs):
2213 """CanOpen(self, String location) -> bool"""
2214 return _core_.ZipFSHandler_CanOpen(*args, **kwargs)
2215
2216 def OpenFile(*args, **kwargs):
2217 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
2218 return _core_.ZipFSHandler_OpenFile(*args, **kwargs)
2219
2220 def FindFirst(*args, **kwargs):
2221 """FindFirst(self, String spec, int flags=0) -> String"""
2222 return _core_.ZipFSHandler_FindFirst(*args, **kwargs)
2223
2224 def FindNext(*args, **kwargs):
2225 """FindNext(self) -> String"""
2226 return _core_.ZipFSHandler_FindNext(*args, **kwargs)
2227
2131d850 2228_core_.ZipFSHandler_swigregister(ZipFSHandler)
d55e5bfc
RD		 2229
2230
2231def __wxMemoryFSHandler_AddFile_wxImage(*args, **kwargs):
554f62e9
RD		 2232 """__wxMemoryFSHandler_AddFile_wxImage(String filename, Image image, long type)"""
2233 return _core_.__wxMemoryFSHandler_AddFile_wxImage(*args, **kwargs)
d55e5bfc
RD		 2234
2235def __wxMemoryFSHandler_AddFile_wxBitmap(*args, **kwargs):
554f62e9
RD		 2236 """__wxMemoryFSHandler_AddFile_wxBitmap(String filename, Bitmap bitmap, long type)"""
2237 return _core_.__wxMemoryFSHandler_AddFile_wxBitmap(*args, **kwargs)
d55e5bfc
RD		 2238
2239def __wxMemoryFSHandler_AddFile_Data(*args, **kwargs):
554f62e9
RD		 2240 """__wxMemoryFSHandler_AddFile_Data(String filename, PyObject data)"""
2241 return _core_.__wxMemoryFSHandler_AddFile_Data(*args, **kwargs)
ae8162c8
RD		 2242def MemoryFSHandler_AddFile(filename, dataItem, imgType=-1):
2243 """
2244 Add 'file' to the memory filesystem. The dataItem parameter can
2245 either be a `wx.Bitmap`, `wx.Image` or a string that can contain
2246 arbitrary data. If a bitmap or image is used then the imgType
2247 parameter should specify what kind of image file it should be
2248 written as, wx.BITMAP_TYPE_PNG, etc.
2249 """
2250 if isinstance(dataItem, wx.Image):
2251 __wxMemoryFSHandler_AddFile_wxImage(filename, dataItem, imgType)
2252 elif isinstance(dataItem, wx.Bitmap):
2253 __wxMemoryFSHandler_AddFile_wxBitmap(filename, dataItem, imgType)
2254 elif type(dataItem) == str:
2255 __wxMemoryFSHandler_AddFile_Data(filename, dataItem)
2256 else:
2257 raise TypeError, 'wx.Image, wx.Bitmap or string expected'
d55e5bfc
RD		 2258
2259class MemoryFSHandler(CPPFileSystemHandler):
093d3ff1 2260 """Proxy of C++ MemoryFSHandler class"""
554f62e9
RD		 2261 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2262 __repr__ = _swig_repr
2263 def __init__(self, *args, **kwargs):
d55e5bfc 2264 """__init__(self) -> MemoryFSHandler"""
554f62e9 2265 _core_.MemoryFSHandler_swiginit(self,_core_.new_MemoryFSHandler(*args, **kwargs))
d55e5bfc 2266 def RemoveFile(*args, **kwargs):
c24da6d6 2267 """RemoveFile(String filename)"""
d55e5bfc
RD		 2268 return _core_.MemoryFSHandler_RemoveFile(*args, **kwargs)
2269
2270 RemoveFile = staticmethod(RemoveFile)
2271 AddFile = staticmethod(MemoryFSHandler_AddFile)
2272 def CanOpen(*args, **kwargs):
2273 """CanOpen(self, String location) -> bool"""
2274 return _core_.MemoryFSHandler_CanOpen(*args, **kwargs)
2275
2276 def OpenFile(*args, **kwargs):
2277 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
2278 return _core_.MemoryFSHandler_OpenFile(*args, **kwargs)
2279
2280 def FindFirst(*args, **kwargs):
2281 """FindFirst(self, String spec, int flags=0) -> String"""
2282 return _core_.MemoryFSHandler_FindFirst(*args, **kwargs)
2283
2284 def FindNext(*args, **kwargs):
2285 """FindNext(self) -> String"""
2286 return _core_.MemoryFSHandler_FindNext(*args, **kwargs)
2287
2131d850 2288_core_.MemoryFSHandler_swigregister(MemoryFSHandler)
d55e5bfc
RD		 2289
2290def MemoryFSHandler_RemoveFile(*args, **kwargs):
554f62e9
RD		 2291 """MemoryFSHandler_RemoveFile(String filename)"""
2292 return _core_.MemoryFSHandler_RemoveFile(*args, **kwargs)
d55e5bfc 2293
57133d5c
RD		 2294IMAGE_ALPHA_TRANSPARENT = _core_.IMAGE_ALPHA_TRANSPARENT
2295IMAGE_ALPHA_THRESHOLD = _core_.IMAGE_ALPHA_THRESHOLD
2296IMAGE_ALPHA_OPAQUE = _core_.IMAGE_ALPHA_OPAQUE
f5263701
RD		 2297IMAGE_QUALITY_NORMAL = _core_.IMAGE_QUALITY_NORMAL
2298IMAGE_QUALITY_HIGH = _core_.IMAGE_QUALITY_HIGH
d55e5bfc
RD		 2299#---------------------------------------------------------------------------
2300
2301class ImageHandler(Object):
27fb7603
RD		 2302 """
2303 This is the base class for implementing image file loading/saving, and
2304 image creation from data. It is used within `wx.Image` and is not
2305 normally seen by the application.
2306 """
554f62e9
RD		 2307 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2308 def __init__(self): raise AttributeError, "No constructor defined"
2309 __repr__ = _swig_repr
d55e5bfc
RD		 2310 def GetName(*args, **kwargs):
2311 """GetName(self) -> String"""
2312 return _core_.ImageHandler_GetName(*args, **kwargs)
2313
2314 def GetExtension(*args, **kwargs):
2315 """GetExtension(self) -> String"""
2316 return _core_.ImageHandler_GetExtension(*args, **kwargs)
2317
2318 def GetType(*args, **kwargs):
2319 """GetType(self) -> long"""
2320 return _core_.ImageHandler_GetType(*args, **kwargs)
2321
2322 def GetMimeType(*args, **kwargs):
2323 """GetMimeType(self) -> String"""
2324 return _core_.ImageHandler_GetMimeType(*args, **kwargs)
2325
2326 def CanRead(*args, **kwargs):
2327 """CanRead(self, String name) -> bool"""
2328 return _core_.ImageHandler_CanRead(*args, **kwargs)
2329
b02396e8
RD		 2330 def CanReadStream(*args, **kwargs):
2331 """CanReadStream(self, InputStream stream) -> bool"""
2332 return _core_.ImageHandler_CanReadStream(*args, **kwargs)
2333
d55e5bfc
RD		 2334 def SetName(*args, **kwargs):
2335 """SetName(self, String name)"""
2336 return _core_.ImageHandler_SetName(*args, **kwargs)
2337
2338 def SetExtension(*args, **kwargs):
2339 """SetExtension(self, String extension)"""
2340 return _core_.ImageHandler_SetExtension(*args, **kwargs)
2341
2342 def SetType(*args, **kwargs):
2343 """SetType(self, long type)"""
2344 return _core_.ImageHandler_SetType(*args, **kwargs)
2345
2346 def SetMimeType(*args, **kwargs):
2347 """SetMimeType(self, String mimetype)"""
2348 return _core_.ImageHandler_SetMimeType(*args, **kwargs)
2349
97ab0f6a
RD		 2350 Extension = property(GetExtension,SetExtension,doc="See `GetExtension` and `SetExtension`")
2351 MimeType = property(GetMimeType,SetMimeType,doc="See `GetMimeType` and `SetMimeType`")
2352 Name = property(GetName,SetName,doc="See `GetName` and `SetName`")
2353 Type = property(GetType,SetType,doc="See `GetType` and `SetType`")
2131d850 2354_core_.ImageHandler_swigregister(ImageHandler)
d55e5bfc 2355
9d7dfdff
RD		 2356class PyImageHandler(ImageHandler):
2357 """
2358 This is the base class for implementing image file loading/saving, and
2359 image creation from data, all written in Python. To create a custom
2360 image handler derive a new class from wx.PyImageHandler and provide
2361 the following methods::
2362
2363 def DoCanRead(self, stream) --> bool
2364 '''Check if this handler can read the image on the stream'''
2365
2366 def LoadFile(self, image, stream, verbose, index) --> bool
2367 '''Load image data from the stream and load it into image.'''
2368
2369 def SaveFile(self, image, stream, verbose) --> bool
2370 '''Save the iamge data in image to the stream using
2371 this handler's image file format.'''
2372
2373 def GetImageCount(self, stream) --> int
2374 '''If this image format can hold more than one image,
2375 how many does the image on the stream have?'''
2376
2377 To activate your handler create an instance of it and pass it to
2378 `wx.Image_AddHandler`. Be sure to call `SetName`, `SetType`, and
2379 `SetExtension` from your constructor.
2380
2381 """
554f62e9
RD		 2382 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2383 __repr__ = _swig_repr
2384 def __init__(self, *args, **kwargs):
9d7dfdff
RD		 2385 """
2386 __init__(self) -> PyImageHandler
2387
2388 This is the base class for implementing image file loading/saving, and
2389 image creation from data, all written in Python. To create a custom
2390 image handler derive a new class from wx.PyImageHandler and provide
2391 the following methods::
2392
2393 def DoCanRead(self, stream) --> bool
2394 '''Check if this handler can read the image on the stream'''
2395
2396 def LoadFile(self, image, stream, verbose, index) --> bool
2397 '''Load image data from the stream and load it into image.'''
2398
2399 def SaveFile(self, image, stream, verbose) --> bool
2400 '''Save the iamge data in image to the stream using
2401 this handler's image file format.'''
2402
2403 def GetImageCount(self, stream) --> int
2404 '''If this image format can hold more than one image,
2405 how many does the image on the stream have?'''
2406
2407 To activate your handler create an instance of it and pass it to
2408 `wx.Image_AddHandler`. Be sure to call `SetName`, `SetType`, and
2409 `SetExtension` from your constructor.
2410
2411 """
554f62e9 2412 _core_.PyImageHandler_swiginit(self,_core_.new_PyImageHandler(*args, **kwargs))
9d7dfdff
RD		 2413 self._SetSelf(self)
2414
2415 def _SetSelf(*args, **kwargs):
2416 """_SetSelf(self, PyObject self)"""
2417 return _core_.PyImageHandler__SetSelf(*args, **kwargs)
2418
2131d850 2419_core_.PyImageHandler_swigregister(PyImageHandler)
9d7dfdff 2420
d55e5bfc 2421class ImageHistogram(object):
093d3ff1 2422 """Proxy of C++ ImageHistogram class"""
554f62e9
RD		 2423 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2424 __repr__ = _swig_repr
2425 def __init__(self, *args, **kwargs):
d55e5bfc 2426 """__init__(self) -> ImageHistogram"""
554f62e9 2427 _core_.ImageHistogram_swiginit(self,_core_.new_ImageHistogram(*args, **kwargs))
d55e5bfc
RD		 2428 def MakeKey(*args, **kwargs):
2429 """
7a27cf7c 2430 MakeKey(byte r, byte g, byte b) -> unsigned long
d55e5bfc
RD		 2431
2432 Get the key in the histogram for the given RGB values
2433 """
2434 return _core_.ImageHistogram_MakeKey(*args, **kwargs)
2435
2436 MakeKey = staticmethod(MakeKey)
2437 def FindFirstUnusedColour(*args, **kwargs):
a8eff060
RD		 2438 """
2439 FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)
2440
2441 Find first colour that is not used in the image and has higher RGB
2442 values than startR, startG, startB. Returns a tuple consisting of a
2443 success flag and rgb values.
2444 """
d55e5bfc
RD		 2445 return _core_.ImageHistogram_FindFirstUnusedColour(*args, **kwargs)
2446
f1cbd8fa
RD		 2447 def GetCount(*args, **kwargs):
2448 """
2449 GetCount(self, unsigned long key) -> unsigned long
2450
2451 Returns the pixel count for the given key. Use `MakeKey` to create a
2452 key value from a RGB tripple.
2453 """
2454 return _core_.ImageHistogram_GetCount(*args, **kwargs)
2455
2456 def GetCountRGB(*args, **kwargs):
2457 """
7a27cf7c 2458 GetCountRGB(self, byte r, byte g, byte b) -> unsigned long
f1cbd8fa
RD		 2459
2460 Returns the pixel count for the given RGB values.
2461 """
2462 return _core_.ImageHistogram_GetCountRGB(*args, **kwargs)
2463
2464 def GetCountColour(*args, **kwargs):
2465 """
2466 GetCountColour(self, Colour colour) -> unsigned long
2467
2468 Returns the pixel count for the given `wx.Colour` value.
2469 """
2470 return _core_.ImageHistogram_GetCountColour(*args, **kwargs)
2471
2131d850 2472_core_.ImageHistogram_swigregister(ImageHistogram)
d55e5bfc
RD		 2473
2474def ImageHistogram_MakeKey(*args, **kwargs):
554f62e9 2475 """
7a27cf7c 2476 ImageHistogram_MakeKey(byte r, byte g, byte b) -> unsigned long
d55e5bfc
RD		 2477
2478 Get the key in the histogram for the given RGB values
2479 """
554f62e9 2480 return _core_.ImageHistogram_MakeKey(*args, **kwargs)
d55e5bfc 2481
2f91e3df 2482class Image_RGBValue(object):
9d7dfdff
RD		 2483 """
2484 An object that contains values for red, green and blue which represent
2485 the value of a color. It is used by `wx.Image.HSVtoRGB` and
2486 `wx.Image.RGBtoHSV`, which converts between HSV color space and RGB
2487 color space.
2488 """
554f62e9
RD		 2489 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2490 __repr__ = _swig_repr
2491 def __init__(self, *args, **kwargs):
9d7dfdff
RD		 2492 """
2493 __init__(self, byte r=0, byte g=0, byte b=0) -> Image_RGBValue
2494
2495 Constructor.
2496 """
554f62e9 2497 _core_.Image_RGBValue_swiginit(self,_core_.new_Image_RGBValue(*args, **kwargs))
2f91e3df
KO		 2498 red = property(_core_.Image_RGBValue_red_get, _core_.Image_RGBValue_red_set)
2499 green = property(_core_.Image_RGBValue_green_get, _core_.Image_RGBValue_green_set)
2500 blue = property(_core_.Image_RGBValue_blue_get, _core_.Image_RGBValue_blue_set)
2131d850 2501_core_.Image_RGBValue_swigregister(Image_RGBValue)
2f91e3df
KO		 2502
2503class Image_HSVValue(object):
9d7dfdff
RD		 2504 """
2505 An object that contains values for hue, saturation and value which
2506 represent the value of a color. It is used by `wx.Image.HSVtoRGB` and
2507 `wx.Image.RGBtoHSV`, which +converts between HSV color space and RGB
2508 color space.
2509 """
554f62e9
RD		 2510 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2511 __repr__ = _swig_repr
2512 def __init__(self, *args, **kwargs):
9d7dfdff
RD		 2513 """
2514 __init__(self, double h=0.0, double s=0.0, double v=0.0) -> Image_HSVValue
2515
2516 Constructor.
2517 """
554f62e9 2518 _core_.Image_HSVValue_swiginit(self,_core_.new_Image_HSVValue(*args, **kwargs))
2f91e3df
KO		 2519 hue = property(_core_.Image_HSVValue_hue_get, _core_.Image_HSVValue_hue_set)
2520 saturation = property(_core_.Image_HSVValue_saturation_get, _core_.Image_HSVValue_saturation_set)
2521 value = property(_core_.Image_HSVValue_value_get, _core_.Image_HSVValue_value_set)
2131d850 2522_core_.Image_HSVValue_swigregister(Image_HSVValue)
2f91e3df 2523
d55e5bfc 2524class Image(Object):
7a27cf7c
RD		 2525 """
2526 A platform-independent image class. An image can be created from
2527 data, or using `wx.Bitmap.ConvertToImage`, or loaded from a file in a
2528 variety of formats. Functions are available to set and get image
2529 bits, so it can be used for basic image manipulation.
2530
2531 A wx.Image cannot be drawn directly to a `wx.DC`. Instead, a
2532 platform-specific `wx.Bitmap` object must be created from it using the
2533 `wx.BitmapFromImage` constructor. This bitmap can then be drawn in a
2534 device context, using `wx.DC.DrawBitmap`.
2535
2536 One colour value of the image may be used as a mask colour which will
2537 lead to the automatic creation of a `wx.Mask` object associated to the
2538 bitmap object.
2539
2540 wx.Image supports alpha channel data, that is in addition to a byte
2541 for the red, green and blue colour components for each pixel it also
2542 stores a byte representing the pixel opacity. An alpha value of 0
2543 corresponds to a transparent pixel (null opacity) while a value of 255
2544 means that the pixel is 100% opaque.
2545
2546 Unlike RGB data, not all images have an alpha channel and before using
2547 `GetAlpha` you should check if this image contains an alpha channel
2548 with `HasAlpha`. Note that currently only images loaded from PNG files
2549 with transparency information will have an alpha channel.
2550 """
554f62e9
RD		 2551 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2552 __repr__ = _swig_repr
2553 def __init__(self, *args, **kwargs):
7a27cf7c
RD		 2554 """
2555 __init__(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> Image
2556
2557 Loads an image from a file.
2558 """
554f62e9
RD		 2559 _core_.Image_swiginit(self,_core_.new_Image(*args, **kwargs))
2560 __swig_destroy__ = _core_.delete_Image
2561 __del__ = lambda self : None;
d55e5bfc 2562 def Create(*args, **kwargs):
7a27cf7c
RD		 2563 """
2564 Create(self, int width, int height, bool clear=True)
2565
2566 Creates a fresh image. If clear is ``True``, the new image will be
2567 initialized to black. Otherwise, the image data will be uninitialized.
2568 """
d55e5bfc
RD		 2569 return _core_.Image_Create(*args, **kwargs)
2570
2571 def Destroy(*args, **kwargs):
2572 """
2573 Destroy(self)
2574
7a27cf7c 2575 Destroys the image data.
d55e5bfc 2576 """
b39fe951
RD		 2577 args[0].this.own(False)
2578 return _core_.Image_Destroy(*args, **kwargs)
d55e5bfc
RD		 2579
2580 def Scale(*args, **kwargs):
7a27cf7c 2581 """
f5263701 2582 Scale(self, int width, int height, int quality=IMAGE_QUALITY_NORMAL) -> Image
7a27cf7c
RD		 2583
2584 Returns a scaled version of the image. This is also useful for scaling
2585 bitmaps in general as the only other way to scale bitmaps is to blit a
f5263701
RD		 2586 `wx.MemoryDC` into another `wx.MemoryDC`. The ``quality`` parameter
2587 specifies what method to use for resampling the image. It can be
2588 either wx.IMAGE_QUALITY_NORMAL, which uses the normal default scaling
2589 method of pixel replication, or wx.IMAGE_QUALITY_HIGH which uses
2590 bicubic and box averaging resampling methods for upsampling and
2591 downsampling respectively.
7a27cf7c 2592 """
d55e5bfc
RD		 2593 return _core_.Image_Scale(*args, **kwargs)
2594
f5263701
RD		 2595 def ResampleBox(*args, **kwargs):
2596 """ResampleBox(self, int width, int height) -> Image"""
2597 return _core_.Image_ResampleBox(*args, **kwargs)
2598
2599 def ResampleBicubic(*args, **kwargs):
2600 """ResampleBicubic(self, int width, int height) -> Image"""
2601 return _core_.Image_ResampleBicubic(*args, **kwargs)
2602
2603 def Blur(*args, **kwargs):
2604 """
2605 Blur(self, int radius) -> Image
2606
2607 Blurs the image in both horizontal and vertical directions by the
2608 specified pixel ``radius``. This should not be used when using a
2609 single mask colour for transparency.
2610 """
2611 return _core_.Image_Blur(*args, **kwargs)
2612
2613 def BlurHorizontal(*args, **kwargs):
2614 """
2615 BlurHorizontal(self, int radius) -> Image
2616
2617 Blurs the image in the horizontal direction only. This should not be
2618 used when using a single mask colour for transparency.
2619
2620 """
2621 return _core_.Image_BlurHorizontal(*args, **kwargs)
2622
2623 def BlurVertical(*args, **kwargs):
2624 """
2625 BlurVertical(self, int radius) -> Image
2626
2627 Blurs the image in the vertical direction only. This should not be
2628 used when using a single mask colour for transparency.
2629 """
2630 return _core_.Image_BlurVertical(*args, **kwargs)
2631
d55e5bfc 2632 def ShrinkBy(*args, **kwargs):
7a27cf7c
RD		 2633 """
2634 ShrinkBy(self, int xFactor, int yFactor) -> Image
2635
2636 Return a version of the image scaled smaller by the given factors.
2637 """
d55e5bfc
RD		 2638 return _core_.Image_ShrinkBy(*args, **kwargs)
2639
2640 def Rescale(*args, **kwargs):
7a27cf7c 2641 """
f5263701 2642 Rescale(self, int width, int height, int quality=IMAGE_QUALITY_NORMAL) -> Image
7a27cf7c
RD		 2643
2644 Changes the size of the image in-place by scaling it: after a call to
2645 this function, the image will have the given width and height.
2646
2647 Returns the (modified) image itself.
2648 """
d55e5bfc
RD		 2649 return _core_.Image_Rescale(*args, **kwargs)
2650
aff4cc5c 2651 def Resize(*args, **kwargs):
7a27cf7c
RD		 2652 """
2653 Resize(self, Size size, Point pos, int r=-1, int g=-1, int b=-1) -> Image
2654
2655 Changes the size of the image in-place without scaling it, by adding
2656 either a border with the given colour or cropping as necessary. The
2657 image is pasted into a new image with the given size and background
2658 colour at the position pos relative to the upper left of the new
2659 image. If red = green = blue = -1 then use either the current mask
2660 colour if set or find, use, and set a suitable mask colour for any
2661 newly exposed areas.
2662
2663 Returns the (modified) image itself.
2664 """
aff4cc5c
RD		 2665 return _core_.Image_Resize(*args, **kwargs)
2666
d55e5bfc 2667 def SetRGB(*args, **kwargs):
7a27cf7c
RD		 2668 """
2669 SetRGB(self, int x, int y, byte r, byte g, byte b)
2670
2671 Sets the pixel at the given coordinate. This routine performs
2672 bounds-checks for the coordinate so it can be considered a safe way to
2673 manipulate the data, but in some cases this might be too slow so that
2674 the data will have to be set directly. In that case you will have to
2675 get access to the image data using the `GetData` method.
2676 """
d55e5bfc
RD		 2677 return _core_.Image_SetRGB(*args, **kwargs)
2678
aff4cc5c 2679 def SetRGBRect(*args, **kwargs):
7a27cf7c
RD		 2680 """
2681 SetRGBRect(self, Rect rect, byte r, byte g, byte b)
2682
2683 Sets the colour of the pixels within the given rectangle. This routine
2684 performs bounds-checks for the rectangle so it can be considered a
2685 safe way to manipulate the data.
2686 """
aff4cc5c
RD		 2687 return _core_.Image_SetRGBRect(*args, **kwargs)
2688
d55e5bfc 2689 def GetRed(*args, **kwargs):
7a27cf7c
RD		 2690 """
2691 GetRed(self, int x, int y) -> byte
2692
2693 Returns the red intensity at the given coordinate.
2694 """
d55e5bfc
RD		 2695 return _core_.Image_GetRed(*args, **kwargs)
2696
2697 def GetGreen(*args, **kwargs):
7a27cf7c
RD		 2698 """
2699 GetGreen(self, int x, int y) -> byte
2700
2701 Returns the green intensity at the given coordinate.
2702 """
d55e5bfc
RD		 2703 return _core_.Image_GetGreen(*args, **kwargs)
2704
2705 def GetBlue(*args, **kwargs):
7a27cf7c
RD		 2706 """
2707 GetBlue(self, int x, int y) -> byte
2708
2709 Returns the blue intensity at the given coordinate.
2710 """
d55e5bfc
RD		 2711 return _core_.Image_GetBlue(*args, **kwargs)
2712
2713 def SetAlpha(*args, **kwargs):
7a27cf7c
RD		 2714 """
2715 SetAlpha(self, int x, int y, byte alpha)
2716
2717 Sets the alpha value for the given pixel. This function should only be
2718 called if the image has alpha channel data, use `HasAlpha` to check
2719 for this.
2720 """
d55e5bfc
RD		 2721 return _core_.Image_SetAlpha(*args, **kwargs)
2722
2723 def GetAlpha(*args, **kwargs):
7a27cf7c
RD		 2724 """
2725 GetAlpha(self, int x, int y) -> byte
2726
2727 Returns the alpha value for the given pixel. This function may only be
2728 called for the images with alpha channel, use `HasAlpha` to check for
2729 this.
2730
2731 The returned value is the *opacity* of the image, i.e. the value of 0
2732 corresponds to the fully transparent pixels while the value of 255 to
2733 the fully opaque pixels.
2734 """
d55e5bfc
RD		 2735 return _core_.Image_GetAlpha(*args, **kwargs)
2736
2737 def HasAlpha(*args, **kwargs):
7a27cf7c
RD		 2738 """
2739 HasAlpha(self) -> bool
2740
2741 Returns true if this image has alpha channel, false otherwise.
2742 """
d55e5bfc
RD		 2743 return _core_.Image_HasAlpha(*args, **kwargs)
2744
68350608
RD		 2745 def InitAlpha(*args, **kwargs):
2746 """
2747 InitAlpha(self)
2748
2749 Initializes the image alpha channel data. It is an error to call it if
2750 the image already has alpha data. If it doesn't, alpha data will be by
2751 default initialized to all pixels being fully opaque. But if the image
2752 has a a mask colour, all mask pixels will be completely transparent.
2753 """
2754 return _core_.Image_InitAlpha(*args, **kwargs)
2755
57133d5c
RD		 2756 def IsTransparent(*args, **kwargs):
2757 """
7a27cf7c 2758 IsTransparent(self, int x, int y, byte threshold=IMAGE_ALPHA_THRESHOLD) -> bool
57133d5c 2759
7a27cf7c
RD		 2760 Returns ``True`` if this pixel is masked or has an alpha value less
2761 than the spcified threshold.
57133d5c
RD		 2762 """
2763 return _core_.Image_IsTransparent(*args, **kwargs)
2764
d55e5bfc 2765 def FindFirstUnusedColour(*args, **kwargs):
a8eff060
RD		 2766 """
2767 FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)
2768
2769 Find first colour that is not used in the image and has higher RGB
2770 values than startR, startG, startB. Returns a tuple consisting of a
2771 success flag and rgb values.
2772 """
d55e5bfc
RD		 2773 return _core_.Image_FindFirstUnusedColour(*args, **kwargs)
2774
4cf4100f
RD		 2775 def ConvertAlphaToMask(*args, **kwargs):
2776 """
57133d5c 2777 ConvertAlphaToMask(self, byte threshold=IMAGE_ALPHA_THRESHOLD) -> bool
4cf4100f 2778
7a27cf7c
RD		 2779 If the image has alpha channel, this method converts it to mask. All
2780 pixels with alpha value less than ``threshold`` are replaced with the
2781 mask colour and the alpha channel is removed. The mask colour is
2782 chosen automatically using `FindFirstUnusedColour`.
4cf4100f
RD		 2783
2784 If the image image doesn't have alpha channel, ConvertAlphaToMask does
2785 nothing.
2786 """
2787 return _core_.Image_ConvertAlphaToMask(*args, **kwargs)
2788
8fb0e70a
RD		 2789 def ConvertColourToAlpha(*args, **kwargs):
2790 """
7a27cf7c 2791 ConvertColourToAlpha(self, byte r, byte g, byte b) -> bool
8fb0e70a
RD		 2792
2793 This method converts an image where the original alpha information is
2794 only available as a shades of a colour (actually shades of grey)
2795 typically when you draw anti-aliased text into a bitmap. The DC
2796 drawing routines draw grey values on the black background although
2797 they actually mean to draw white with differnt alpha values. This
2798 method reverses it, assuming a black (!) background and white text.
2799 The method will then fill up the whole image with the colour given.
2800 """
2801 return _core_.Image_ConvertColourToAlpha(*args, **kwargs)
2802
d55e5bfc 2803 def SetMaskFromImage(*args, **kwargs):
7a27cf7c
RD		 2804 """
2805 SetMaskFromImage(self, Image mask, byte mr, byte mg, byte mb) -> bool
2806
2807 Sets the image's mask so that the pixels that have RGB value of
2808 ``(mr,mg,mb)`` in ``mask`` will be masked in this image. This is done
2809 by first finding an unused colour in the image, setting this colour as
2810 the mask colour and then using this colour to draw all pixels in the
2811 image who corresponding pixel in mask has given RGB value.
2812
2813 Returns ``False`` if ``mask`` does not have same dimensions as the
2814 image or if there is no unused colour left. Returns ``True`` if the
2815 mask was successfully applied.
2816
2817 Note that this method involves computing the histogram, which is
2818 computationally intensive operation.
2819 """
d55e5bfc
RD		 2820 return _core_.Image_SetMaskFromImage(*args, **kwargs)
2821
2822 def CanRead(*args, **kwargs):
7a27cf7c
RD		 2823 """
2824 CanRead(String filename) -> bool
2825
2826 Returns True if the image handlers can read this file.
2827 """
d55e5bfc
RD		 2828 return _core_.Image_CanRead(*args, **kwargs)
2829
2830 CanRead = staticmethod(CanRead)
2831 def GetImageCount(*args, **kwargs):
7a27cf7c
RD		 2832 """
2833 GetImageCount(String filename, long type=BITMAP_TYPE_ANY) -> int
2834
2835 If the image file contains more than one image and the image handler
2836 is capable of retrieving these individually, this function will return
2837 the number of available images.
2838 """
d55e5bfc
RD		 2839 return _core_.Image_GetImageCount(*args, **kwargs)
2840
2841 GetImageCount = staticmethod(GetImageCount)
2842 def LoadFile(*args, **kwargs):
7a27cf7c
RD		 2843 """
2844 LoadFile(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> bool
2845
2846 Loads an image from a file. If no handler type is provided, the
2847 library will try to autodetect the format.
2848 """
d55e5bfc
RD		 2849 return _core_.Image_LoadFile(*args, **kwargs)
2850
2851 def LoadMimeFile(*args, **kwargs):
7a27cf7c
RD		 2852 """
2853 LoadMimeFile(self, String name, String mimetype, int index=-1) -> bool
2854
2855 Loads an image from a file, specifying the image type with a MIME type
2856 string.
2857 """
d55e5bfc
RD		 2858 return _core_.Image_LoadMimeFile(*args, **kwargs)
2859
2860 def SaveFile(*args, **kwargs):
7a27cf7c
RD		 2861 """
2862 SaveFile(self, String name, int type) -> bool
2863
2864 Saves an image in the named file.
2865 """
d55e5bfc
RD		 2866 return _core_.Image_SaveFile(*args, **kwargs)
2867
2868 def SaveMimeFile(*args, **kwargs):
7a27cf7c
RD		 2869 """
2870 SaveMimeFile(self, String name, String mimetype) -> bool
2871
2872 Saves an image in the named file.
2873 """
d55e5bfc
RD		 2874 return _core_.Image_SaveMimeFile(*args, **kwargs)
2875
2876 def CanReadStream(*args, **kwargs):
7a27cf7c
RD		 2877 """
2878 CanReadStream(InputStream stream) -> bool
2879
2880 Returns True if the image handlers can read an image file from the
2881 data currently on the input stream, or a readable Python file-like
2882 object.
2883 """
d55e5bfc
RD		 2884 return _core_.Image_CanReadStream(*args, **kwargs)
2885
2886 CanReadStream = staticmethod(CanReadStream)
2887 def LoadStream(*args, **kwargs):
7a27cf7c
RD		 2888 """
2889 LoadStream(self, InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> bool
2890
2891 Loads an image from an input stream or a readable Python file-like
2892 object. If no handler type is provided, the library will try to
2893 autodetect the format.
2894 """
d55e5bfc
RD		 2895 return _core_.Image_LoadStream(*args, **kwargs)
2896
2897 def LoadMimeStream(*args, **kwargs):
7a27cf7c
RD		 2898 """
2899 LoadMimeStream(self, InputStream stream, String mimetype, int index=-1) -> bool
2900
2901 Loads an image from an input stream or a readable Python file-like
2902 object, using a MIME type string to specify the image file format.
2903 """
d55e5bfc
RD		 2904 return _core_.Image_LoadMimeStream(*args, **kwargs)
2905
b39fe951 2906 def IsOk(*args, **kwargs):
7a27cf7c 2907 """
b39fe951 2908 IsOk(self) -> bool
7a27cf7c
RD		 2909
2910 Returns true if image data is present.
2911 """
b39fe951 2912 return _core_.Image_IsOk(*args, **kwargs)
d55e5bfc 2913
b39fe951 2914 Ok = IsOk
d55e5bfc 2915 def GetWidth(*args, **kwargs):
7a27cf7c
RD		 2916 """
2917 GetWidth(self) -> int
2918
2919 Gets the width of the image in pixels.
2920 """
d55e5bfc
RD		 2921 return _core_.Image_GetWidth(*args, **kwargs)
2922
2923 def GetHeight(*args, **kwargs):
7a27cf7c
RD		 2924 """
2925 GetHeight(self) -> int
2926
2927 Gets the height of the image in pixels.
2928 """
d55e5bfc
RD		 2929 return _core_.Image_GetHeight(*args, **kwargs)
2930
2931 def GetSize(*args, **kwargs):
7a27cf7c
RD		 2932 """
2933 GetSize(self) -> Size
2934
2935 Returns the size of the image in pixels.
2936 """
d55e5bfc
RD		 2937 return _core_.Image_GetSize(*args, **kwargs)
2938
2939 def GetSubImage(*args, **kwargs):
7a27cf7c
RD		 2940 """
2941 GetSubImage(self, Rect rect) -> Image
2942
2943 Returns a sub image of the current one as long as the rect belongs
2944 entirely to the image.
2945 """
d55e5bfc
RD		 2946 return _core_.Image_GetSubImage(*args, **kwargs)
2947
aff4cc5c 2948 def Size(*args, **kwargs):
7a27cf7c
RD		 2949 """
2950 Size(self, Size size, Point pos, int r=-1, int g=-1, int b=-1) -> Image
2951
2952 Returns a resized version of this image without scaling it by adding
2953 either a border with the given colour or cropping as necessary. The
2954 image is pasted into a new image with the given size and background
2955 colour at the position ``pos`` relative to the upper left of the new
2956 image. If red = green = blue = -1 then use either the current mask
2957 colour if set or find, use, and set a suitable mask colour for any
2958 newly exposed areas.
2959 """
aff4cc5c
RD		 2960 return _core_.Image_Size(*args, **kwargs)
2961
d55e5bfc 2962 def Copy(*args, **kwargs):
7a27cf7c
RD		 2963 """
2964 Copy(self) -> Image
2965
2966 Returns an identical copy of the image.
2967 """
d55e5bfc
RD		 2968 return _core_.Image_Copy(*args, **kwargs)
2969
2970 def Paste(*args, **kwargs):
7a27cf7c
RD		 2971 """
2972 Paste(self, Image image, int x, int y)
2973
2974 Pastes ``image`` into this instance and takes care of the mask colour
2975 and any out of bounds problems.
2976 """
d55e5bfc
RD		 2977 return _core_.Image_Paste(*args, **kwargs)
2978
2979 def GetData(*args, **kwargs):
ea939623
RD		 2980 """
2981 GetData(self) -> PyObject
2982
2983 Returns a string containing a copy of the RGB bytes of the image.
2984 """
d55e5bfc
RD		 2985 return _core_.Image_GetData(*args, **kwargs)
2986
2987 def SetData(*args, **kwargs):
ea939623
RD		 2988 """
2989 SetData(self, buffer data)
2990
2991 Resets the Image's RGB data from a buffer of RGB bytes. Accepts
2992 either a string or a buffer object holding the data and the length of
2993 the data must be width*height*3.
2994 """
d55e5bfc
RD		 2995 return _core_.Image_SetData(*args, **kwargs)
2996
2997 def GetDataBuffer(*args, **kwargs):
ea939623
RD		 2998 """
2999 GetDataBuffer(self) -> PyObject
3000
3001 Returns a writable Python buffer object that is pointing at the RGB
7a27cf7c
RD		 3002 image data buffer inside the wx.Image. You need to ensure that you do
3003 not use this buffer object after the image has been destroyed.
ea939623 3004 """
d55e5bfc
RD		 3005 return _core_.Image_GetDataBuffer(*args, **kwargs)
3006
3007 def SetDataBuffer(*args, **kwargs):
ea939623
RD		 3008 """
3009 SetDataBuffer(self, buffer data)
3010
3011 Sets the internal image data pointer to point at a Python buffer
7a27cf7c
RD		 3012 object. This can save making an extra copy of the data but you must
3013 ensure that the buffer object lives longer than the wx.Image does.
ea939623 3014 """
d55e5bfc
RD		 3015 return _core_.Image_SetDataBuffer(*args, **kwargs)
3016
3017 def GetAlphaData(*args, **kwargs):
ea939623
RD		 3018 """
3019 GetAlphaData(self) -> PyObject
3020
3021 Returns a string containing a copy of the alpha bytes of the image.
3022 """
d55e5bfc
RD		 3023 return _core_.Image_GetAlphaData(*args, **kwargs)
3024
3025 def SetAlphaData(*args, **kwargs):
ea939623
RD		 3026 """
3027 SetAlphaData(self, buffer alpha)
3028
3029 Resets the Image's alpha data from a buffer of bytes. Accepts either
3030 a string or a buffer object holding the data and the length of the
3031 data must be width*height.
3032 """
d55e5bfc
RD		 3033 return _core_.Image_SetAlphaData(*args, **kwargs)
3034
3035 def GetAlphaBuffer(*args, **kwargs):
fc46b7f3
RD		 3036 """
3037 GetAlphaBuffer(self) -> PyObject
3038
3039 Returns a writable Python buffer object that is pointing at the Alpha
3040 data buffer inside the wx.Image. You need to ensure that you do not
3041 use this buffer object after the image has been destroyed.
3042 """
d55e5bfc
RD		 3043 return _core_.Image_GetAlphaBuffer(*args, **kwargs)
3044
3045 def SetAlphaBuffer(*args, **kwargs):
fc46b7f3
RD		 3046 """
3047 SetAlphaBuffer(self, buffer alpha)
3048
3049 Sets the internal image alpha pointer to point at a Python buffer
3050 object. This can save making an extra copy of the data but you must
3051 ensure that the buffer object lives as long as the wx.Image does.
3052 """
d55e5bfc
RD		 3053 return _core_.Image_SetAlphaBuffer(*args, **kwargs)
3054
3055 def SetMaskColour(*args, **kwargs):
7a27cf7c
RD		 3056 """
3057 SetMaskColour(self, byte r, byte g, byte b)
3058
3059 Sets the mask colour for this image (and tells the image to use the
3060 mask).
3061 """
d55e5bfc
RD		 3062 return _core_.Image_SetMaskColour(*args, **kwargs)
3063
aff4cc5c
RD		 3064 def GetOrFindMaskColour(*args, **kwargs):
3065 """
3066 GetOrFindMaskColour() -> (r,g,b)
3067
3068 Get the current mask colour or find a suitable colour.
3069 """
3070 return _core_.Image_GetOrFindMaskColour(*args, **kwargs)
3071
d55e5bfc 3072 def GetMaskRed(*args, **kwargs):
7a27cf7c
RD		 3073 """
3074 GetMaskRed(self) -> byte
3075
3076 Gets the red component of the mask colour.
3077 """
d55e5bfc
RD		 3078 return _core_.Image_GetMaskRed(*args, **kwargs)
3079
3080 def GetMaskGreen(*args, **kwargs):
7a27cf7c
RD		 3081 """
3082 GetMaskGreen(self) -> byte
3083
3084 Gets the green component of the mask colour.
3085 """
d55e5bfc
RD		 3086 return _core_.Image_GetMaskGreen(*args, **kwargs)
3087
3088 def GetMaskBlue(*args, **kwargs):
7a27cf7c
RD		 3089 """
3090 GetMaskBlue(self) -> byte
3091
3092 Gets the blue component of the mask colour.
3093 """
d55e5bfc
RD		 3094 return _core_.Image_GetMaskBlue(*args, **kwargs)
3095
3096 def SetMask(*args, **kwargs):
7a27cf7c
RD		 3097 """
3098 SetMask(self, bool mask=True)
3099
3100 Specifies whether there is a mask or not. The area of the mask is
3101 determined by the current mask colour.
3102 """
d55e5bfc
RD		 3103 return _core_.Image_SetMask(*args, **kwargs)
3104
3105 def HasMask(*args, **kwargs):
7a27cf7c
RD		 3106 """
3107 HasMask(self) -> bool
3108
3109 Returns ``True`` if there is a mask active, ``False`` otherwise.
3110 """
d55e5bfc
RD		 3111 return _core_.Image_HasMask(*args, **kwargs)
3112
3113 def Rotate(*args, **kwargs):
3114 """
3115 Rotate(self, double angle, Point centre_of_rotation, bool interpolating=True,
3116 Point offset_after_rotation=None) -> Image
7a27cf7c
RD		 3117
3118 Rotates the image about the given point, by ``angle`` radians. Passing
3119 ``True`` to ``interpolating`` results in better image quality, but is
3120 slower. If the image has a mask, then the mask colour is used for the
3121 uncovered pixels in the rotated image background. Otherwise, black
3122 will be used as the fill colour.
3123
3124 Returns the rotated image, leaving this image intact.
d55e5bfc
RD		 3125 """
3126 return _core_.Image_Rotate(*args, **kwargs)
3127
3128 def Rotate90(*args, **kwargs):
7a27cf7c
RD		 3129 """
3130 Rotate90(self, bool clockwise=True) -> Image
3131
3132 Returns a copy of the image rotated 90 degrees in the direction
3133 indicated by ``clockwise``.
3134 """
d55e5bfc
RD		 3135 return _core_.Image_Rotate90(*args, **kwargs)
3136
3137 def Mirror(*args, **kwargs):
7a27cf7c
RD		 3138 """
3139 Mirror(self, bool horizontally=True) -> Image
3140
3141 Returns a mirrored copy of the image. The parameter ``horizontally``
3142 indicates the orientation.
3143 """
d55e5bfc
RD		 3144 return _core_.Image_Mirror(*args, **kwargs)
3145
3146 def Replace(*args, **kwargs):
3147 """
7a27cf7c
RD		 3148 Replace(self, byte r1, byte g1, byte b1, byte r2, byte g2, byte b2)
3149
3150 Replaces the colour specified by ``(r1,g1,b1)`` by the colour
3151 ``(r2,g2,b2)``.
d55e5bfc
RD		 3152 """
3153 return _core_.Image_Replace(*args, **kwargs)
3154
7449af73
RD		 3155 def ConvertToGreyscale(*args, **kwargs):
3156 """
3157 ConvertToGreyscale(self, double lr=0.299, double lg=0.587, double lb=0.114) -> Image
3158
3159 Convert to greyscale image. Uses the luminance component (Y) of the
3160 image. The luma value (YUV) is calculated using (R * lr) + (G * lg) + (B * lb),
3161 defaults to ITU-T BT.601
3162 """
3163 return _core_.Image_ConvertToGreyscale(*args, **kwargs)
3164
d55e5bfc 3165 def ConvertToMono(*args, **kwargs):
7a27cf7c
RD		 3166 """
3167 ConvertToMono(self, byte r, byte g, byte b) -> Image
3168
3169 Returns monochromatic version of the image. The returned image has
3170 white colour where the original has ``(r,g,b)`` colour and black
3171 colour everywhere else.
3172 """
d55e5bfc
RD		 3173 return _core_.Image_ConvertToMono(*args, **kwargs)
3174
3175 def SetOption(*args, **kwargs):
7a27cf7c
RD		 3176 """
3177 SetOption(self, String name, String value)
3178
3179 Sets an image handler defined option. For example, when saving as a
3180 JPEG file, the option ``wx.IMAGE_OPTION_QUALITY`` is used, which is a
3181 number between 0 and 100 (0 is terrible, 100 is very good).
3182 """
d55e5bfc
RD		 3183 return _core_.Image_SetOption(*args, **kwargs)
3184
3185 def SetOptionInt(*args, **kwargs):
7a27cf7c
RD		 3186 """
3187 SetOptionInt(self, String name, int value)
3188
3189 Sets an image option as an integer.
3190 """
d55e5bfc
RD		 3191 return _core_.Image_SetOptionInt(*args, **kwargs)
3192
3193 def GetOption(*args, **kwargs):
7a27cf7c
RD		 3194 """
3195 GetOption(self, String name) -> String
3196
3197 Gets the value of an image handler option.
3198 """
d55e5bfc
RD		 3199 return _core_.Image_GetOption(*args, **kwargs)
3200
3201 def GetOptionInt(*args, **kwargs):
7a27cf7c
RD		 3202 """
3203 GetOptionInt(self, String name) -> int
3204
3205 Gets the value of an image handler option as an integer. If the given
3206 option is not present, the function returns 0.
3207 """
d55e5bfc
RD		 3208 return _core_.Image_GetOptionInt(*args, **kwargs)
3209
3210 def HasOption(*args, **kwargs):
7a27cf7c
RD		 3211 """
3212 HasOption(self, String name) -> bool
3213
3214 Returns true if the given option is present.
3215 """
d55e5bfc
RD		 3216 return _core_.Image_HasOption(*args, **kwargs)
3217
3218 def CountColours(*args, **kwargs):
3219 """CountColours(self, unsigned long stopafter=(unsigned long) -1) -> unsigned long"""
3220 return _core_.Image_CountColours(*args, **kwargs)
3221
3222 def ComputeHistogram(*args, **kwargs):
3223 """ComputeHistogram(self, ImageHistogram h) -> unsigned long"""
3224 return _core_.Image_ComputeHistogram(*args, **kwargs)
3225
3226 def AddHandler(*args, **kwargs):
c24da6d6 3227 """AddHandler(ImageHandler handler)"""
d55e5bfc
RD		 3228 return _core_.Image_AddHandler(*args, **kwargs)
3229
3230 AddHandler = staticmethod(AddHandler)
3231 def InsertHandler(*args, **kwargs):
c24da6d6 3232 """InsertHandler(ImageHandler handler)"""
d55e5bfc
RD		 3233 return _core_.Image_InsertHandler(*args, **kwargs)
3234
3235 InsertHandler = staticmethod(InsertHandler)
3236 def RemoveHandler(*args, **kwargs):
c24da6d6 3237 """RemoveHandler(String name) -> bool"""
d55e5bfc
RD		 3238 return _core_.Image_RemoveHandler(*args, **kwargs)
3239
3240 RemoveHandler = staticmethod(RemoveHandler)
554f62e9
RD		 3241 def GetHandlers(*args, **kwargs):
3242 """GetHandlers() -> PyObject"""
3243 return _core_.Image_GetHandlers(*args, **kwargs)
3244
3245 GetHandlers = staticmethod(GetHandlers)
d55e5bfc 3246 def GetImageExtWildcard(*args, **kwargs):
7a27cf7c
RD		 3247 """
3248 GetImageExtWildcard() -> String
3249
3250 Iterates all registered wxImageHandler objects, and returns a string
3251 containing file extension masks suitable for passing to file open/save
3252 dialog boxes.
3253 """
d55e5bfc
RD		 3254 return _core_.Image_GetImageExtWildcard(*args, **kwargs)
3255
3256 GetImageExtWildcard = staticmethod(GetImageExtWildcard)
3257 def ConvertToBitmap(*args, **kwargs):
1fbf26be 3258 """ConvertToBitmap(self, int depth=-1) -> Bitmap"""
d55e5bfc
RD		 3259 return _core_.Image_ConvertToBitmap(*args, **kwargs)
3260
3261 def ConvertToMonoBitmap(*args, **kwargs):
7a27cf7c 3262 """ConvertToMonoBitmap(self, byte red, byte green, byte blue) -> Bitmap"""
d55e5bfc
RD		 3263 return _core_.Image_ConvertToMonoBitmap(*args, **kwargs)
3264
2f91e3df
KO		 3265 def RotateHue(*args, **kwargs):
3266 """
3267 RotateHue(self, double angle)
3268
3269 Rotates the hue of each pixel of the image. Hue is a double in the
3270 range -1.0..1.0 where -1.0 is -360 degrees and 1.0 is 360 degrees
3271 """
3272 return _core_.Image_RotateHue(*args, **kwargs)
3273
3274 def RGBtoHSV(*args, **kwargs):
9d7dfdff
RD		 3275 """
3276 RGBtoHSV(Image_RGBValue rgb) -> Image_HSVValue
3277
3278 Converts a color in RGB color space to HSV color space.
3279 """
2f91e3df
KO		 3280 return _core_.Image_RGBtoHSV(*args, **kwargs)
3281
3282 RGBtoHSV = staticmethod(RGBtoHSV)
3283 def HSVtoRGB(*args, **kwargs):
9d7dfdff
RD		 3284 """
3285 HSVtoRGB(Image_HSVValue hsv) -> Image_RGBValue
3286
3287 Converts a color in HSV color space to RGB color space.
3288 """
2f91e3df
KO		 3289 return _core_.Image_HSVtoRGB(*args, **kwargs)
3290
3291 HSVtoRGB = staticmethod(HSVtoRGB)
b39fe951 3292 def __nonzero__(self): return self.IsOk()
97ab0f6a
RD		 3293 AlphaBuffer = property(GetAlphaBuffer,SetAlphaBuffer,doc="See `GetAlphaBuffer` and `SetAlphaBuffer`")
3294 AlphaData = property(GetAlphaData,SetAlphaData,doc="See `GetAlphaData` and `SetAlphaData`")
3295 Data = property(GetData,SetData,doc="See `GetData` and `SetData`")
3296 DataBuffer = property(GetDataBuffer,SetDataBuffer,doc="See `GetDataBuffer` and `SetDataBuffer`")
3297 Height = property(GetHeight,doc="See `GetHeight`")
3298 MaskBlue = property(GetMaskBlue,doc="See `GetMaskBlue`")
3299 MaskGreen = property(GetMaskGreen,doc="See `GetMaskGreen`")
3300 MaskRed = property(GetMaskRed,doc="See `GetMaskRed`")
97ab0f6a 3301 Width = property(GetWidth,doc="See `GetWidth`")
2131d850 3302_core_.Image_swigregister(Image)
d55e5bfc
RD		 3303
3304def ImageFromMime(*args, **kwargs):
7a27cf7c
RD		 3305 """
3306 ImageFromMime(String name, String mimetype, int index=-1) -> Image
3307
3308 Loads an image from a file, using a MIME type string (such as
3309 'image/jpeg') to specify image type.
3310 """
d55e5bfc 3311 val = _core_.new_ImageFromMime(*args, **kwargs)
d55e5bfc
RD		 3312 return val
3313
3314def ImageFromStream(*args, **kwargs):
7a27cf7c
RD		 3315 """
3316 ImageFromStream(InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> Image
3317
3318 Loads an image from an input stream, or any readable Python file-like
3319 object.
3320 """
d55e5bfc 3321 val = _core_.new_ImageFromStream(*args, **kwargs)
d55e5bfc
RD		 3322 return val
3323
3324def ImageFromStreamMime(*args, **kwargs):
7a27cf7c
RD		 3325 """
3326 ImageFromStreamMime(InputStream stream, String mimetype, int index=-1) -> Image
3327
3328 Loads an image from an input stream, or any readable Python file-like
3329 object, specifying the image format with a MIME type string.
3330 """
d55e5bfc 3331 val = _core_.new_ImageFromStreamMime(*args, **kwargs)
d55e5bfc
RD		 3332 return val
3333
c24da6d6 3334def EmptyImage(*args, **kwargs):
ea939623
RD		 3335 """
3336 EmptyImage(int width=0, int height=0, bool clear=True) -> Image
3337
3338 Construct an empty image of a given size, optionally setting all
3339 pixels to black.
3340 """
c24da6d6 3341 val = _core_.new_EmptyImage(*args, **kwargs)
d55e5bfc
RD		 3342 return val
3343
3344def ImageFromBitmap(*args, **kwargs):
ea939623
RD		 3345 """
3346 ImageFromBitmap(Bitmap bitmap) -> Image
3347
3348 Construct an Image from a `wx.Bitmap`.
3349 """
d55e5bfc 3350 val = _core_.new_ImageFromBitmap(*args, **kwargs)
d55e5bfc
RD		 3351 return val
3352
3353def ImageFromData(*args, **kwargs):
ea939623
RD		 3354 """
3355 ImageFromData(int width, int height, buffer data) -> Image
3356
3357 Construct an Image from a buffer of RGB bytes. Accepts either a
3358 string or a buffer object holding the data and the length of the data
3359 must be width*height*3.
3360 """
d55e5bfc 3361 val = _core_.new_ImageFromData(*args, **kwargs)
d55e5bfc
RD		 3362 return val
3363
c9c2cf70 3364def ImageFromDataWithAlpha(*args, **kwargs):
ea939623
RD		 3365 """
3366 ImageFromDataWithAlpha(int width, int height, buffer data, buffer alpha) -> Image
3367
3368 Construct an Image from a buffer of RGB bytes with an Alpha channel.
3369 Accepts either a string or a buffer object holding the data and the
7a27cf7c
RD		 3370 length of the data must be width*height*3 bytes, and the length of the
3371 alpha data must be width*height bytes.
ea939623 3372 """
c9c2cf70 3373 val = _core_.new_ImageFromDataWithAlpha(*args, **kwargs)
c9c2cf70
RD		 3374 return val
3375
d55e5bfc 3376def Image_CanRead(*args, **kwargs):
554f62e9 3377 """
7a27cf7c
RD		 3378 Image_CanRead(String filename) -> bool
3379
3380 Returns True if the image handlers can read this file.
3381 """
554f62e9 3382 return _core_.Image_CanRead(*args, **kwargs)
d55e5bfc
RD		 3383
3384def Image_GetImageCount(*args, **kwargs):
554f62e9 3385 """
7a27cf7c
RD		 3386 Image_GetImageCount(String filename, long type=BITMAP_TYPE_ANY) -> int
3387
3388 If the image file contains more than one image and the image handler
3389 is capable of retrieving these individually, this function will return
3390 the number of available images.
3391 """
554f62e9 3392 return _core_.Image_GetImageCount(*args, **kwargs)
d55e5bfc
RD		 3393
3394def Image_CanReadStream(*args, **kwargs):
554f62e9 3395 """
7a27cf7c
RD		 3396 Image_CanReadStream(InputStream stream) -> bool
3397
3398 Returns True if the image handlers can read an image file from the
3399 data currently on the input stream, or a readable Python file-like
3400 object.
3401 """
554f62e9 3402 return _core_.Image_CanReadStream(*args, **kwargs)
d55e5bfc
RD		 3403
3404def Image_AddHandler(*args, **kwargs):
554f62e9
RD		 3405 """Image_AddHandler(ImageHandler handler)"""
3406 return _core_.Image_AddHandler(*args, **kwargs)
d55e5bfc
RD		 3407
3408def Image_InsertHandler(*args, **kwargs):
554f62e9
RD		 3409 """Image_InsertHandler(ImageHandler handler)"""
3410 return _core_.Image_InsertHandler(*args, **kwargs)
d55e5bfc
RD		 3411
3412def Image_RemoveHandler(*args, **kwargs):
554f62e9
RD		 3413 """Image_RemoveHandler(String name) -> bool"""
3414 return _core_.Image_RemoveHandler(*args, **kwargs)
d55e5bfc 3415
554f62e9
RD		 3416def Image_GetHandlers(*args):
3417 """Image_GetHandlers() -> PyObject"""
3418 return _core_.Image_GetHandlers(*args)
3419
3420def Image_GetImageExtWildcard(*args):
3421 """
7a27cf7c
RD		 3422 Image_GetImageExtWildcard() -> String
3423
3424 Iterates all registered wxImageHandler objects, and returns a string
3425 containing file extension masks suitable for passing to file open/save
3426 dialog boxes.
3427 """
554f62e9 3428 return _core_.Image_GetImageExtWildcard(*args)
d55e5bfc 3429
2f91e3df 3430def Image_RGBtoHSV(*args, **kwargs):
554f62e9 3431 """
9d7dfdff
RD		 3432 Image_RGBtoHSV(Image_RGBValue rgb) -> Image_HSVValue
3433
3434 Converts a color in RGB color space to HSV color space.
3435 """
554f62e9 3436 return _core_.Image_RGBtoHSV(*args, **kwargs)
2f91e3df
KO		 3437
3438def Image_HSVtoRGB(*args, **kwargs):
554f62e9 3439 """
9d7dfdff
RD		 3440 Image_HSVtoRGB(Image_HSVValue hsv) -> Image_RGBValue
3441
3442 Converts a color in HSV color space to RGB color space.
3443 """
554f62e9 3444 return _core_.Image_HSVtoRGB(*args, **kwargs)
2f91e3df 3445
fc46b7f3
RD		 3446
3447def _ImageFromBuffer(*args, **kwargs):
3448 """_ImageFromBuffer(int width, int height, buffer data, buffer alpha=None) -> Image"""
3449 return _core_._ImageFromBuffer(*args, **kwargs)
3450def ImageFromBuffer(width, height, dataBuffer, alphaBuffer=None):
3451 """
3452 Creates a `wx.Image` from the data in dataBuffer. The dataBuffer
eec1c382
RD		 3453 parameter must be a Python object that implements the buffer interface,
3454 such as a string, array, etc. The dataBuffer object is expected to
3455 contain a series of RGB bytes and be width*height*3 bytes long. A buffer
3456 object can optionally be supplied for the image's alpha channel data, and
3457 it is expected to be width*height bytes long.
fc46b7f3
RD		 3458
3459 The wx.Image will be created with its data and alpha pointers initialized
3460 to the memory address pointed to by the buffer objects, thus saving the
3461 time needed to copy the image data from the buffer object to the wx.Image.
3462 While this has advantages, it also has the shoot-yourself-in-the-foot
3463 risks associated with sharing a C pointer between two objects.
3464
3465 To help alleviate the risk a reference to the data and alpha buffer
3466 objects are kept with the wx.Image, so that they won't get deleted until
3467 after the wx.Image is deleted. However please be aware that it is not
3468 guaranteed that an object won't move its memory buffer to a new location
3469 when it needs to resize its contents. If that happens then the wx.Image
3470 will end up referring to an invalid memory location and could cause the
3471 application to crash. Therefore care should be taken to not manipulate
3472 the objects used for the data and alpha buffers in a way that would cause
3473 them to change size.
3474 """
fc46b7f3
RD		 3475 image = _core_._ImageFromBuffer(width, height, dataBuffer, alphaBuffer)
3476 image._buffer = dataBuffer
3477 image._alpha = alphaBuffer
3478 return image
3479
a07a67e6
RD		 3480def InitAllImageHandlers():
3481 """
3482 The former functionality of InitAllImageHanders is now done internal to
3483 the _core_ extension module and so this function has become a simple NOP.
3484 """
3485 pass
d55e5bfc 3486
d55e5bfc
RD		 3487IMAGE_RESOLUTION_INCHES = _core_.IMAGE_RESOLUTION_INCHES
3488IMAGE_RESOLUTION_CM = _core_.IMAGE_RESOLUTION_CM
b9d6a5f3
RD		 3489PNG_TYPE_COLOUR = _core_.PNG_TYPE_COLOUR
3490PNG_TYPE_GREY = _core_.PNG_TYPE_GREY
3491PNG_TYPE_GREY_RED = _core_.PNG_TYPE_GREY_RED
d55e5bfc
RD		 3492BMP_24BPP = _core_.BMP_24BPP
3493BMP_8BPP = _core_.BMP_8BPP
3494BMP_8BPP_GREY = _core_.BMP_8BPP_GREY
3495BMP_8BPP_GRAY = _core_.BMP_8BPP_GRAY
3496BMP_8BPP_RED = _core_.BMP_8BPP_RED
3497BMP_8BPP_PALETTE = _core_.BMP_8BPP_PALETTE
3498BMP_4BPP = _core_.BMP_4BPP
3499BMP_1BPP = _core_.BMP_1BPP
3500BMP_1BPP_BW = _core_.BMP_1BPP_BW
3501class BMPHandler(ImageHandler):
27fb7603 3502 """A `wx.ImageHandler` for \*.bmp bitmap files."""
554f62e9
RD		 3503 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3504 __repr__ = _swig_repr
3505 def __init__(self, *args, **kwargs):
27fb7603
RD		 3506 """
3507 __init__(self) -> BMPHandler
3508
3509 A `wx.ImageHandler` for \*.bmp bitmap files.
3510 """
554f62e9 3511 _core_.BMPHandler_swiginit(self,_core_.new_BMPHandler(*args, **kwargs))
2131d850 3512_core_.BMPHandler_swigregister(BMPHandler)
d55e5bfc 3513NullImage = cvar.NullImage
68350608 3514IMAGE_OPTION_FILENAME = cvar.IMAGE_OPTION_FILENAME
d55e5bfc
RD		 3515IMAGE_OPTION_BMP_FORMAT = cvar.IMAGE_OPTION_BMP_FORMAT
3516IMAGE_OPTION_CUR_HOTSPOT_X = cvar.IMAGE_OPTION_CUR_HOTSPOT_X
3517IMAGE_OPTION_CUR_HOTSPOT_Y = cvar.IMAGE_OPTION_CUR_HOTSPOT_Y
3518IMAGE_OPTION_RESOLUTION = cvar.IMAGE_OPTION_RESOLUTION
68350608
RD		 3519IMAGE_OPTION_RESOLUTIONX = cvar.IMAGE_OPTION_RESOLUTIONX
3520IMAGE_OPTION_RESOLUTIONY = cvar.IMAGE_OPTION_RESOLUTIONY
d55e5bfc 3521IMAGE_OPTION_RESOLUTIONUNIT = cvar.IMAGE_OPTION_RESOLUTIONUNIT
24d7cbea 3522IMAGE_OPTION_QUALITY = cvar.IMAGE_OPTION_QUALITY
68350608
RD		 3523IMAGE_OPTION_BITSPERSAMPLE = cvar.IMAGE_OPTION_BITSPERSAMPLE
3524IMAGE_OPTION_SAMPLESPERPIXEL = cvar.IMAGE_OPTION_SAMPLESPERPIXEL
3525IMAGE_OPTION_COMPRESSION = cvar.IMAGE_OPTION_COMPRESSION
3526IMAGE_OPTION_IMAGEDESCRIPTOR = cvar.IMAGE_OPTION_IMAGEDESCRIPTOR
b9d6a5f3
RD		 3527IMAGE_OPTION_PNG_FORMAT = cvar.IMAGE_OPTION_PNG_FORMAT
3528IMAGE_OPTION_PNG_BITDEPTH = cvar.IMAGE_OPTION_PNG_BITDEPTH
d55e5bfc
RD		 3529
3530class ICOHandler(BMPHandler):
27fb7603 3531 """A `wx.ImageHandler` for \*.ico icon files."""
554f62e9
RD		 3532 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3533 __repr__ = _swig_repr
3534 def __init__(self, *args, **kwargs):
27fb7603
RD		 3535 """
3536 __init__(self) -> ICOHandler
3537
3538 A `wx.ImageHandler` for \*.ico icon files.
3539 """
554f62e9 3540 _core_.ICOHandler_swiginit(self,_core_.new_ICOHandler(*args, **kwargs))
2131d850 3541_core_.ICOHandler_swigregister(ICOHandler)
d55e5bfc
RD		 3542
3543class CURHandler(ICOHandler):
27fb7603 3544 """A `wx.ImageHandler` for \*.cur cursor files."""
554f62e9
RD		 3545 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3546 __repr__ = _swig_repr
3547 def __init__(self, *args, **kwargs):
27fb7603
RD		 3548 """
3549 __init__(self) -> CURHandler
3550
3551 A `wx.ImageHandler` for \*.cur cursor files.
3552 """
554f62e9 3553 _core_.CURHandler_swiginit(self,_core_.new_CURHandler(*args, **kwargs))
2131d850 3554_core_.CURHandler_swigregister(CURHandler)
d55e5bfc
RD		 3555
3556class ANIHandler(CURHandler):
27fb7603 3557 """A `wx.ImageHandler` for \*.ani animated cursor files."""
554f62e9
RD		 3558 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3559 __repr__ = _swig_repr
3560 def __init__(self, *args, **kwargs):
27fb7603
RD		 3561 """
3562 __init__(self) -> ANIHandler
3563
3564 A `wx.ImageHandler` for \*.ani animated cursor files.
3565 """
554f62e9 3566 _core_.ANIHandler_swiginit(self,_core_.new_ANIHandler(*args, **kwargs))
2131d850 3567_core_.ANIHandler_swigregister(ANIHandler)
d55e5bfc
RD		 3568
3569class PNGHandler(ImageHandler):
27fb7603 3570 """A `wx.ImageHandler` for PNG image files."""
554f62e9
RD		 3571 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3572 __repr__ = _swig_repr
3573 def __init__(self, *args, **kwargs):
27fb7603
RD		 3574 """
3575 __init__(self) -> PNGHandler
3576
3577 A `wx.ImageHandler` for PNG image files.
3578 """
554f62e9 3579 _core_.PNGHandler_swiginit(self,_core_.new_PNGHandler(*args, **kwargs))
2131d850 3580_core_.PNGHandler_swigregister(PNGHandler)
d55e5bfc
RD		 3581
3582class GIFHandler(ImageHandler):
27fb7603 3583 """A `wx.ImageHandler` for GIF image files."""
554f62e9
RD		 3584 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3585 __repr__ = _swig_repr
3586 def __init__(self, *args, **kwargs):
27fb7603
RD		 3587 """
3588 __init__(self) -> GIFHandler
3589
3590 A `wx.ImageHandler` for GIF image files.
3591 """
554f62e9 3592 _core_.GIFHandler_swiginit(self,_core_.new_GIFHandler(*args, **kwargs))
2131d850 3593_core_.GIFHandler_swigregister(GIFHandler)
d55e5bfc
RD		 3594
3595class PCXHandler(ImageHandler):
27fb7603 3596 """A `wx.ImageHandler` for PCX imager files."""
554f62e9
RD		 3597 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3598 __repr__ = _swig_repr
3599 def __init__(self, *args, **kwargs):
27fb7603
RD		 3600 """
3601 __init__(self) -> PCXHandler
3602
3603 A `wx.ImageHandler` for PCX imager files.
3604 """
554f62e9 3605 _core_.PCXHandler_swiginit(self,_core_.new_PCXHandler(*args, **kwargs))
2131d850 3606_core_.PCXHandler_swigregister(PCXHandler)
d55e5bfc
RD		 3607
3608class JPEGHandler(ImageHandler):
27fb7603 3609 """A `wx.ImageHandler` for JPEG/JPG image files."""
554f62e9
RD		 3610 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3611 __repr__ = _swig_repr
3612 def __init__(self, *args, **kwargs):
27fb7603
RD		 3613 """
3614 __init__(self) -> JPEGHandler
3615
3616 A `wx.ImageHandler` for JPEG/JPG image files.
3617 """
554f62e9 3618 _core_.JPEGHandler_swiginit(self,_core_.new_JPEGHandler(*args, **kwargs))
2131d850 3619_core_.JPEGHandler_swigregister(JPEGHandler)
d55e5bfc
RD		 3620
3621class PNMHandler(ImageHandler):
27fb7603 3622 """A `wx.ImageHandler` for PNM image files."""
554f62e9
RD		 3623 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3624 __repr__ = _swig_repr
3625 def __init__(self, *args, **kwargs):
27fb7603
RD		 3626 """
3627 __init__(self) -> PNMHandler
3628
3629 A `wx.ImageHandler` for PNM image files.
3630 """
554f62e9 3631 _core_.PNMHandler_swiginit(self,_core_.new_PNMHandler(*args, **kwargs))
2131d850 3632_core_.PNMHandler_swigregister(PNMHandler)
d55e5bfc
RD		 3633
3634class XPMHandler(ImageHandler):
27fb7603 3635 """A `wx.ImageHandler` for XPM image."""
554f62e9
RD		 3636 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3637 __repr__ = _swig_repr
3638 def __init__(self, *args, **kwargs):
27fb7603
RD		 3639 """
3640 __init__(self) -> XPMHandler
3641
3642 A `wx.ImageHandler` for XPM image.
3643 """
554f62e9 3644 _core_.XPMHandler_swiginit(self,_core_.new_XPMHandler(*args, **kwargs))
2131d850 3645_core_.XPMHandler_swigregister(XPMHandler)
d55e5bfc
RD		 3646
3647class TIFFHandler(ImageHandler):
27fb7603 3648 """A `wx.ImageHandler` for TIFF image files."""
554f62e9
RD		 3649 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3650 __repr__ = _swig_repr
3651 def __init__(self, *args, **kwargs):
27fb7603
RD		 3652 """
3653 __init__(self) -> TIFFHandler
3654
3655 A `wx.ImageHandler` for TIFF image files.
3656 """
554f62e9 3657 _core_.TIFFHandler_swiginit(self,_core_.new_TIFFHandler(*args, **kwargs))
2131d850 3658_core_.TIFFHandler_swigregister(TIFFHandler)
d55e5bfc 3659
c0de73ae
RD		 3660QUANTIZE_INCLUDE_WINDOWS_COLOURS = _core_.QUANTIZE_INCLUDE_WINDOWS_COLOURS
3661QUANTIZE_FILL_DESTINATION_IMAGE = _core_.QUANTIZE_FILL_DESTINATION_IMAGE
3662class Quantize(object):
3663 """Performs quantization, or colour reduction, on a wxImage."""
554f62e9
RD		 3664 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3665 def __init__(self): raise AttributeError, "No constructor defined"
3666 __repr__ = _swig_repr
c0de73ae
RD		 3667 def Quantize(*args, **kwargs):
3668 """
3669 Quantize(Image src, Image dest, int desiredNoColours=236, int flags=wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE) -> bool
3670
3671 Reduce the colours in the source image and put the result into the
3672 destination image, setting the palette in the destination if
3673 needed. Both images may be the same, to overwrite the source image.
3674 """
3675 return _core_.Quantize_Quantize(*args, **kwargs)
3676
3677 Quantize = staticmethod(Quantize)
2131d850 3678_core_.Quantize_swigregister(Quantize)
c0de73ae
RD		 3679
3680def Quantize_Quantize(*args, **kwargs):
554f62e9 3681 """
c0de73ae
RD		 3682 Quantize_Quantize(Image src, Image dest, int desiredNoColours=236, int flags=wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE) -> bool
3683
3684 Reduce the colours in the source image and put the result into the
3685 destination image, setting the palette in the destination if
3686 needed. Both images may be the same, to overwrite the source image.
3687 """
554f62e9 3688 return _core_.Quantize_Quantize(*args, **kwargs)
c0de73ae 3689
d55e5bfc
RD		 3690#---------------------------------------------------------------------------
3691
3692class EvtHandler(Object):
093d3ff1 3693 """Proxy of C++ EvtHandler class"""
554f62e9
RD		 3694 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3695 __repr__ = _swig_repr
3696 def __init__(self, *args, **kwargs):
d55e5bfc 3697 """__init__(self) -> EvtHandler"""
554f62e9 3698 _core_.EvtHandler_swiginit(self,_core_.new_EvtHandler(*args, **kwargs))
d49bdf34
RD		 3699 self._setOORInfo(self)
3700
d55e5bfc
RD		 3701 def GetNextHandler(*args, **kwargs):
3702 """GetNextHandler(self) -> EvtHandler"""
3703 return _core_.EvtHandler_GetNextHandler(*args, **kwargs)
3704
3705 def GetPreviousHandler(*args, **kwargs):
3706 """GetPreviousHandler(self) -> EvtHandler"""
3707 return _core_.EvtHandler_GetPreviousHandler(*args, **kwargs)
3708
3709 def SetNextHandler(*args, **kwargs):
3710 """SetNextHandler(self, EvtHandler handler)"""
3711 return _core_.EvtHandler_SetNextHandler(*args, **kwargs)
3712
3713 def SetPreviousHandler(*args, **kwargs):
3714 """SetPreviousHandler(self, EvtHandler handler)"""
3715 return _core_.EvtHandler_SetPreviousHandler(*args, **kwargs)
3716
3717 def GetEvtHandlerEnabled(*args, **kwargs):
3718 """GetEvtHandlerEnabled(self) -> bool"""
3719 return _core_.EvtHandler_GetEvtHandlerEnabled(*args, **kwargs)
3720
3721 def SetEvtHandlerEnabled(*args, **kwargs):
3722 """SetEvtHandlerEnabled(self, bool enabled)"""
3723 return _core_.EvtHandler_SetEvtHandlerEnabled(*args, **kwargs)
3724
3725 def ProcessEvent(*args, **kwargs):
3726 """ProcessEvent(self, Event event) -> bool"""
3727 return _core_.EvtHandler_ProcessEvent(*args, **kwargs)
3728
3729 def AddPendingEvent(*args, **kwargs):
3730 """AddPendingEvent(self, Event event)"""
3731 return _core_.EvtHandler_AddPendingEvent(*args, **kwargs)
3732
3733 def ProcessPendingEvents(*args, **kwargs):
3734 """ProcessPendingEvents(self)"""
3735 return _core_.EvtHandler_ProcessPendingEvents(*args, **kwargs)
3736
b39fe951
RD		 3737 def AllowReentrance(*args, **kwargs):
3738 """AllowReentrance(self, bool allow=True)"""
3739 return _core_.EvtHandler_AllowReentrance(*args, **kwargs)
3740
3741 def IsReentranceAllowed(*args, **kwargs):
3742 """IsReentranceAllowed(self) -> bool"""
3743 return _core_.EvtHandler_IsReentranceAllowed(*args, **kwargs)
3744
3745 def IsEventHandlingInProgress(*args, **kwargs):
3746 """IsEventHandlingInProgress(self) -> bool"""
3747 return _core_.EvtHandler_IsEventHandlingInProgress(*args, **kwargs)
3748
d55e5bfc
RD		 3749 def Connect(*args, **kwargs):
3750 """Connect(self, int id, int lastId, int eventType, PyObject func)"""
3751 return _core_.EvtHandler_Connect(*args, **kwargs)
3752
3753 def Disconnect(*args, **kwargs):
f460c29d 3754 """Disconnect(self, int id, int lastId=-1, EventType eventType=wxEVT_NULL) -> bool"""
d55e5bfc
RD		 3755 return _core_.EvtHandler_Disconnect(*args, **kwargs)
3756
3757 def _setOORInfo(*args, **kwargs):
093d3ff1 3758 """_setOORInfo(self, PyObject _self, bool incref=True)"""
7e08d4ef
RD		 3759 val = _core_.EvtHandler__setOORInfo(*args, **kwargs)
3760 args[0].thisown = 0
3761 return val
d55e5bfc
RD		 3762
3763 def Bind(self, event, handler, source=None, id=wx.ID_ANY, id2=wx.ID_ANY):
3764 """
3765 Bind an event to an event handler.
3766
caef1a4d
RD		 3767 :param event: One of the EVT_* objects that specifies the
3768 type of event to bind,
d55e5bfc 3769
caef1a4d
RD		 3770 :param handler: A callable object to be invoked when the
3771 event is delivered to self. Pass None to
3772 disconnect an event handler.
d55e5bfc 3773
caef1a4d
RD		 3774 :param source: Sometimes the event originates from a
3775 different window than self, but you still
3776 want to catch it in self. (For example, a
3777 button event delivered to a frame.) By
3778 passing the source of the event, the event
3779 handling system is able to differentiate
3780 between the same event type from different
3781 controls.
d55e5bfc 3782
caef1a4d
RD		 3783 :param id: Used to spcify the event source by ID instead
3784 of instance.
3785
3786 :param id2: Used when it is desirable to bind a handler
3787 to a range of IDs, such as with EVT_MENU_RANGE.
d55e5bfc
RD		 3788 """
3789 if source is not None:
3790 id = source.GetId()
3791 event.Bind(self, id, id2, handler)
3792
c24da6d6
RD		 3793 def Unbind(self, event, source=None, id=wx.ID_ANY, id2=wx.ID_ANY):
3794 """
3795 Disconencts the event handler binding for event from self.
3796 Returns True if successful.
3797 """
3798 if source is not None:
3799 id = source.GetId()
3800 return event.Unbind(self, id, id2)
d55e5bfc 3801
97ab0f6a
RD		 3802 EvtHandlerEnabled = property(GetEvtHandlerEnabled,SetEvtHandlerEnabled,doc="See `GetEvtHandlerEnabled` and `SetEvtHandlerEnabled`")
3803 NextHandler = property(GetNextHandler,SetNextHandler,doc="See `GetNextHandler` and `SetNextHandler`")
3804 PreviousHandler = property(GetPreviousHandler,SetPreviousHandler,doc="See `GetPreviousHandler` and `SetPreviousHandler`")
2131d850 3805_core_.EvtHandler_swigregister(EvtHandler)
d55e5bfc
RD		 3806
3807#---------------------------------------------------------------------------
3808
3809class PyEventBinder(object):
3810 """
3811 Instances of this class are used to bind specific events to event
3812 handlers.
3813 """
3814 def __init__(self, evtType, expectedIDs=0):
3815 if expectedIDs not in [0, 1, 2]:
3816 raise ValueError, "Invalid number of expectedIDs"
3817 self.expectedIDs = expectedIDs
3818
3819 if type(evtType) == list or type(evtType) == tuple:
3820 self.evtType = evtType
3821 else:
3822 self.evtType = [evtType]
3823
3824
3825 def Bind(self, target, id1, id2, function):
3826 """Bind this set of event types to target."""
3827 for et in self.evtType:
3828 target.Connect(id1, id2, et, function)
3829
c24da6d6
RD		 3830
3831 def Unbind(self, target, id1, id2):
3832 """Remove an event binding."""
3833 success = 0
3834 for et in self.evtType:
3835 success += target.Disconnect(id1, id2, et)
3836 return success != 0
3837
d55e5bfc
RD		 3838
3839 def __call__(self, *args):
3840 """
3841 For backwards compatibility with the old EVT_* functions.
3842 Should be called with either (window, func), (window, ID,
3843 func) or (window, ID1, ID2, func) parameters depending on the
3844 type of the event.
3845 """
3846 assert len(args) == 2 + self.expectedIDs
3847 id1 = wx.ID_ANY
3848 id2 = wx.ID_ANY
3849 target = args[0]
3850 if self.expectedIDs == 0:
3851 func = args[1]
3852 elif self.expectedIDs == 1:
3853 id1 = args[1]
3854 func = args[2]
3855 elif self.expectedIDs == 2:
3856 id1 = args[1]
3857 id2 = args[2]
3858 func = args[3]
3859 else:
3860 raise ValueError, "Unexpected number of IDs"
3861
3862 self.Bind(target, id1, id2, func)
3863
3864
3865# These two are square pegs that don't fit the PyEventBinder hole...
3866def EVT_COMMAND(win, id, cmd, func):
3867 win.Connect(id, -1, cmd, func)
3868def EVT_COMMAND_RANGE(win, id1, id2, cmd, func):
3869 win.Connect(id1, id2, cmd, func)
3870
3871
3872#---------------------------------------------------------------------------
3873
3874#---------------------------------------------------------------------------
3875
3876EVENT_PROPAGATE_NONE = _core_.EVENT_PROPAGATE_NONE
3877EVENT_PROPAGATE_MAX = _core_.EVENT_PROPAGATE_MAX
3878
554f62e9 3879def NewEventType(*args):
f460c29d 3880 """NewEventType() -> EventType"""
554f62e9 3881 return _core_.NewEventType(*args)
d55e5bfc
RD		 3882wxEVT_NULL = _core_.wxEVT_NULL
3883wxEVT_FIRST = _core_.wxEVT_FIRST
3884wxEVT_USER_FIRST = _core_.wxEVT_USER_FIRST
3885wxEVT_COMMAND_BUTTON_CLICKED = _core_.wxEVT_COMMAND_BUTTON_CLICKED
3886wxEVT_COMMAND_CHECKBOX_CLICKED = _core_.wxEVT_COMMAND_CHECKBOX_CLICKED
3887wxEVT_COMMAND_CHOICE_SELECTED = _core_.wxEVT_COMMAND_CHOICE_SELECTED
3888wxEVT_COMMAND_LISTBOX_SELECTED = _core_.wxEVT_COMMAND_LISTBOX_SELECTED
3889wxEVT_COMMAND_LISTBOX_DOUBLECLICKED = _core_.wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
3890wxEVT_COMMAND_CHECKLISTBOX_TOGGLED = _core_.wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
3891wxEVT_COMMAND_MENU_SELECTED = _core_.wxEVT_COMMAND_MENU_SELECTED
3892wxEVT_COMMAND_TOOL_CLICKED = _core_.wxEVT_COMMAND_TOOL_CLICKED
3893wxEVT_COMMAND_SLIDER_UPDATED = _core_.wxEVT_COMMAND_SLIDER_UPDATED
3894wxEVT_COMMAND_RADIOBOX_SELECTED = _core_.wxEVT_COMMAND_RADIOBOX_SELECTED
3895wxEVT_COMMAND_RADIOBUTTON_SELECTED = _core_.wxEVT_COMMAND_RADIOBUTTON_SELECTED
3896wxEVT_COMMAND_SCROLLBAR_UPDATED = _core_.wxEVT_COMMAND_SCROLLBAR_UPDATED
3897wxEVT_COMMAND_VLBOX_SELECTED = _core_.wxEVT_COMMAND_VLBOX_SELECTED
3898wxEVT_COMMAND_COMBOBOX_SELECTED = _core_.wxEVT_COMMAND_COMBOBOX_SELECTED
3899wxEVT_COMMAND_TOOL_RCLICKED = _core_.wxEVT_COMMAND_TOOL_RCLICKED
3900wxEVT_COMMAND_TOOL_ENTER = _core_.wxEVT_COMMAND_TOOL_ENTER
3901wxEVT_LEFT_DOWN = _core_.wxEVT_LEFT_DOWN
3902wxEVT_LEFT_UP = _core_.wxEVT_LEFT_UP
3903wxEVT_MIDDLE_DOWN = _core_.wxEVT_MIDDLE_DOWN
3904wxEVT_MIDDLE_UP = _core_.wxEVT_MIDDLE_UP
3905wxEVT_RIGHT_DOWN = _core_.wxEVT_RIGHT_DOWN
3906wxEVT_RIGHT_UP = _core_.wxEVT_RIGHT_UP
3907wxEVT_MOTION = _core_.wxEVT_MOTION
3908wxEVT_ENTER_WINDOW = _core_.wxEVT_ENTER_WINDOW
3909wxEVT_LEAVE_WINDOW = _core_.wxEVT_LEAVE_WINDOW
3910wxEVT_LEFT_DCLICK = _core_.wxEVT_LEFT_DCLICK
3911wxEVT_MIDDLE_DCLICK = _core_.wxEVT_MIDDLE_DCLICK
3912wxEVT_RIGHT_DCLICK = _core_.wxEVT_RIGHT_DCLICK
3913wxEVT_SET_FOCUS = _core_.wxEVT_SET_FOCUS
3914wxEVT_KILL_FOCUS = _core_.wxEVT_KILL_FOCUS
3915wxEVT_CHILD_FOCUS = _core_.wxEVT_CHILD_FOCUS
3916wxEVT_MOUSEWHEEL = _core_.wxEVT_MOUSEWHEEL
3917wxEVT_NC_LEFT_DOWN = _core_.wxEVT_NC_LEFT_DOWN
3918wxEVT_NC_LEFT_UP = _core_.wxEVT_NC_LEFT_UP
3919wxEVT_NC_MIDDLE_DOWN = _core_.wxEVT_NC_MIDDLE_DOWN
3920wxEVT_NC_MIDDLE_UP = _core_.wxEVT_NC_MIDDLE_UP
3921wxEVT_NC_RIGHT_DOWN = _core_.wxEVT_NC_RIGHT_DOWN
3922wxEVT_NC_RIGHT_UP = _core_.wxEVT_NC_RIGHT_UP
3923wxEVT_NC_MOTION = _core_.wxEVT_NC_MOTION
3924wxEVT_NC_ENTER_WINDOW = _core_.wxEVT_NC_ENTER_WINDOW
3925wxEVT_NC_LEAVE_WINDOW = _core_.wxEVT_NC_LEAVE_WINDOW
3926wxEVT_NC_LEFT_DCLICK = _core_.wxEVT_NC_LEFT_DCLICK
3927wxEVT_NC_MIDDLE_DCLICK = _core_.wxEVT_NC_MIDDLE_DCLICK
3928wxEVT_NC_RIGHT_DCLICK = _core_.wxEVT_NC_RIGHT_DCLICK
3929wxEVT_CHAR = _core_.wxEVT_CHAR
3930wxEVT_CHAR_HOOK = _core_.wxEVT_CHAR_HOOK
3931wxEVT_NAVIGATION_KEY = _core_.wxEVT_NAVIGATION_KEY
3932wxEVT_KEY_DOWN = _core_.wxEVT_KEY_DOWN
3933wxEVT_KEY_UP = _core_.wxEVT_KEY_UP
3934wxEVT_HOTKEY = _core_.wxEVT_HOTKEY
3935wxEVT_SET_CURSOR = _core_.wxEVT_SET_CURSOR
3936wxEVT_SCROLL_TOP = _core_.wxEVT_SCROLL_TOP
3937wxEVT_SCROLL_BOTTOM = _core_.wxEVT_SCROLL_BOTTOM
3938wxEVT_SCROLL_LINEUP = _core_.wxEVT_SCROLL_LINEUP
3939wxEVT_SCROLL_LINEDOWN = _core_.wxEVT_SCROLL_LINEDOWN
3940wxEVT_SCROLL_PAGEUP = _core_.wxEVT_SCROLL_PAGEUP
3941wxEVT_SCROLL_PAGEDOWN = _core_.wxEVT_SCROLL_PAGEDOWN
3942wxEVT_SCROLL_THUMBTRACK = _core_.wxEVT_SCROLL_THUMBTRACK
3943wxEVT_SCROLL_THUMBRELEASE = _core_.wxEVT_SCROLL_THUMBRELEASE
db67f999
RD		 3944wxEVT_SCROLL_CHANGED = _core_.wxEVT_SCROLL_CHANGED
3945wxEVT_SCROLL_ENDSCROLL = wxEVT_SCROLL_CHANGED
d55e5bfc
RD		 3946wxEVT_SCROLLWIN_TOP = _core_.wxEVT_SCROLLWIN_TOP
3947wxEVT_SCROLLWIN_BOTTOM = _core_.wxEVT_SCROLLWIN_BOTTOM
3948wxEVT_SCROLLWIN_LINEUP = _core_.wxEVT_SCROLLWIN_LINEUP
3949wxEVT_SCROLLWIN_LINEDOWN = _core_.wxEVT_SCROLLWIN_LINEDOWN
3950wxEVT_SCROLLWIN_PAGEUP = _core_.wxEVT_SCROLLWIN_PAGEUP
3951wxEVT_SCROLLWIN_PAGEDOWN = _core_.wxEVT_SCROLLWIN_PAGEDOWN
3952wxEVT_SCROLLWIN_THUMBTRACK = _core_.wxEVT_SCROLLWIN_THUMBTRACK
3953wxEVT_SCROLLWIN_THUMBRELEASE = _core_.wxEVT_SCROLLWIN_THUMBRELEASE
3954wxEVT_SIZE = _core_.wxEVT_SIZE
3955wxEVT_MOVE = _core_.wxEVT_MOVE
3956wxEVT_CLOSE_WINDOW = _core_.wxEVT_CLOSE_WINDOW
3957wxEVT_END_SESSION = _core_.wxEVT_END_SESSION
3958wxEVT_QUERY_END_SESSION = _core_.wxEVT_QUERY_END_SESSION
3959wxEVT_ACTIVATE_APP = _core_.wxEVT_ACTIVATE_APP
d55e5bfc
RD		 3960wxEVT_ACTIVATE = _core_.wxEVT_ACTIVATE
3961wxEVT_CREATE = _core_.wxEVT_CREATE
3962wxEVT_DESTROY = _core_.wxEVT_DESTROY
3963wxEVT_SHOW = _core_.wxEVT_SHOW
3964wxEVT_ICONIZE = _core_.wxEVT_ICONIZE
3965wxEVT_MAXIMIZE = _core_.wxEVT_MAXIMIZE
3966wxEVT_MOUSE_CAPTURE_CHANGED = _core_.wxEVT_MOUSE_CAPTURE_CHANGED
0f83f5da 3967wxEVT_MOUSE_CAPTURE_LOST = _core_.wxEVT_MOUSE_CAPTURE_LOST
d55e5bfc
RD		 3968wxEVT_PAINT = _core_.wxEVT_PAINT
3969wxEVT_ERASE_BACKGROUND = _core_.wxEVT_ERASE_BACKGROUND
3970wxEVT_NC_PAINT = _core_.wxEVT_NC_PAINT
3971wxEVT_PAINT_ICON = _core_.wxEVT_PAINT_ICON
3972wxEVT_MENU_OPEN = _core_.wxEVT_MENU_OPEN
3973wxEVT_MENU_CLOSE = _core_.wxEVT_MENU_CLOSE
3974wxEVT_MENU_HIGHLIGHT = _core_.wxEVT_MENU_HIGHLIGHT
3975wxEVT_CONTEXT_MENU = _core_.wxEVT_CONTEXT_MENU
3976wxEVT_SYS_COLOUR_CHANGED = _core_.wxEVT_SYS_COLOUR_CHANGED
3977wxEVT_DISPLAY_CHANGED = _core_.wxEVT_DISPLAY_CHANGED
3978wxEVT_SETTING_CHANGED = _core_.wxEVT_SETTING_CHANGED
3979wxEVT_QUERY_NEW_PALETTE = _core_.wxEVT_QUERY_NEW_PALETTE
3980wxEVT_PALETTE_CHANGED = _core_.wxEVT_PALETTE_CHANGED
3981wxEVT_DROP_FILES = _core_.wxEVT_DROP_FILES
3982wxEVT_DRAW_ITEM = _core_.wxEVT_DRAW_ITEM
3983wxEVT_MEASURE_ITEM = _core_.wxEVT_MEASURE_ITEM
3984wxEVT_COMPARE_ITEM = _core_.wxEVT_COMPARE_ITEM
3985wxEVT_INIT_DIALOG = _core_.wxEVT_INIT_DIALOG
3986wxEVT_IDLE = _core_.wxEVT_IDLE
3987wxEVT_UPDATE_UI = _core_.wxEVT_UPDATE_UI
3988wxEVT_SIZING = _core_.wxEVT_SIZING
3989wxEVT_MOVING = _core_.wxEVT_MOVING
88c6b281 3990wxEVT_HIBERNATE = _core_.wxEVT_HIBERNATE
2131d850
RD		 3991wxEVT_COMMAND_TEXT_COPY = _core_.wxEVT_COMMAND_TEXT_COPY
3992wxEVT_COMMAND_TEXT_CUT = _core_.wxEVT_COMMAND_TEXT_CUT
3993wxEVT_COMMAND_TEXT_PASTE = _core_.wxEVT_COMMAND_TEXT_PASTE
d55e5bfc
RD		 3994wxEVT_COMMAND_LEFT_CLICK = _core_.wxEVT_COMMAND_LEFT_CLICK
3995wxEVT_COMMAND_LEFT_DCLICK = _core_.wxEVT_COMMAND_LEFT_DCLICK
3996wxEVT_COMMAND_RIGHT_CLICK = _core_.wxEVT_COMMAND_RIGHT_CLICK
3997wxEVT_COMMAND_RIGHT_DCLICK = _core_.wxEVT_COMMAND_RIGHT_DCLICK
3998wxEVT_COMMAND_SET_FOCUS = _core_.wxEVT_COMMAND_SET_FOCUS
3999wxEVT_COMMAND_KILL_FOCUS = _core_.wxEVT_COMMAND_KILL_FOCUS
4000wxEVT_COMMAND_ENTER = _core_.wxEVT_COMMAND_ENTER
4001#
4002# Create some event binders
4003EVT_SIZE = wx.PyEventBinder( wxEVT_SIZE )
4004EVT_SIZING = wx.PyEventBinder( wxEVT_SIZING )
4005EVT_MOVE = wx.PyEventBinder( wxEVT_MOVE )
4006EVT_MOVING = wx.PyEventBinder( wxEVT_MOVING )
4007EVT_CLOSE = wx.PyEventBinder( wxEVT_CLOSE_WINDOW )
4008EVT_END_SESSION = wx.PyEventBinder( wxEVT_END_SESSION )
4009EVT_QUERY_END_SESSION = wx.PyEventBinder( wxEVT_QUERY_END_SESSION )
4010EVT_PAINT = wx.PyEventBinder( wxEVT_PAINT )
4011EVT_NC_PAINT = wx.PyEventBinder( wxEVT_NC_PAINT )
4012EVT_ERASE_BACKGROUND = wx.PyEventBinder( wxEVT_ERASE_BACKGROUND )
4013EVT_CHAR = wx.PyEventBinder( wxEVT_CHAR )
4014EVT_KEY_DOWN = wx.PyEventBinder( wxEVT_KEY_DOWN )
4015EVT_KEY_UP = wx.PyEventBinder( wxEVT_KEY_UP )
704eda0c 4016EVT_HOTKEY = wx.PyEventBinder( wxEVT_HOTKEY, 1)
d55e5bfc
RD		 4017EVT_CHAR_HOOK = wx.PyEventBinder( wxEVT_CHAR_HOOK )
4018EVT_MENU_OPEN = wx.PyEventBinder( wxEVT_MENU_OPEN )
4019EVT_MENU_CLOSE = wx.PyEventBinder( wxEVT_MENU_CLOSE )
4020EVT_MENU_HIGHLIGHT = wx.PyEventBinder( wxEVT_MENU_HIGHLIGHT, 1)
4021EVT_MENU_HIGHLIGHT_ALL = wx.PyEventBinder( wxEVT_MENU_HIGHLIGHT )
4022EVT_SET_FOCUS = wx.PyEventBinder( wxEVT_SET_FOCUS )
4023EVT_KILL_FOCUS = wx.PyEventBinder( wxEVT_KILL_FOCUS )
4024EVT_CHILD_FOCUS = wx.PyEventBinder( wxEVT_CHILD_FOCUS )
4025EVT_ACTIVATE = wx.PyEventBinder( wxEVT_ACTIVATE )
4026EVT_ACTIVATE_APP = wx.PyEventBinder( wxEVT_ACTIVATE_APP )
704eda0c 4027EVT_HIBERNATE = wx.PyEventBinder( wxEVT_HIBERNATE )
d55e5bfc
RD		 4028EVT_END_SESSION = wx.PyEventBinder( wxEVT_END_SESSION )
4029EVT_QUERY_END_SESSION = wx.PyEventBinder( wxEVT_QUERY_END_SESSION )
4030EVT_DROP_FILES = wx.PyEventBinder( wxEVT_DROP_FILES )
4031EVT_INIT_DIALOG = wx.PyEventBinder( wxEVT_INIT_DIALOG )
4032EVT_SYS_COLOUR_CHANGED = wx.PyEventBinder( wxEVT_SYS_COLOUR_CHANGED )
4033EVT_DISPLAY_CHANGED = wx.PyEventBinder( wxEVT_DISPLAY_CHANGED )
4034EVT_SHOW = wx.PyEventBinder( wxEVT_SHOW )
4035EVT_MAXIMIZE = wx.PyEventBinder( wxEVT_MAXIMIZE )
4036EVT_ICONIZE = wx.PyEventBinder( wxEVT_ICONIZE )
4037EVT_NAVIGATION_KEY = wx.PyEventBinder( wxEVT_NAVIGATION_KEY )
4038EVT_PALETTE_CHANGED = wx.PyEventBinder( wxEVT_PALETTE_CHANGED )
4039EVT_QUERY_NEW_PALETTE = wx.PyEventBinder( wxEVT_QUERY_NEW_PALETTE )
4040EVT_WINDOW_CREATE = wx.PyEventBinder( wxEVT_CREATE )
4041EVT_WINDOW_DESTROY = wx.PyEventBinder( wxEVT_DESTROY )
4042EVT_SET_CURSOR = wx.PyEventBinder( wxEVT_SET_CURSOR )
4043EVT_MOUSE_CAPTURE_CHANGED = wx.PyEventBinder( wxEVT_MOUSE_CAPTURE_CHANGED )
0f83f5da 4044EVT_MOUSE_CAPTURE_LOST = wx.PyEventBinder( wxEVT_MOUSE_CAPTURE_LOST )
d55e5bfc
RD		 4045
4046EVT_LEFT_DOWN = wx.PyEventBinder( wxEVT_LEFT_DOWN )
4047EVT_LEFT_UP = wx.PyEventBinder( wxEVT_LEFT_UP )
4048EVT_MIDDLE_DOWN = wx.PyEventBinder( wxEVT_MIDDLE_DOWN )
4049EVT_MIDDLE_UP = wx.PyEventBinder( wxEVT_MIDDLE_UP )
4050EVT_RIGHT_DOWN = wx.PyEventBinder( wxEVT_RIGHT_DOWN )
4051EVT_RIGHT_UP = wx.PyEventBinder( wxEVT_RIGHT_UP )
4052EVT_MOTION = wx.PyEventBinder( wxEVT_MOTION )
4053EVT_LEFT_DCLICK = wx.PyEventBinder( wxEVT_LEFT_DCLICK )
4054EVT_MIDDLE_DCLICK = wx.PyEventBinder( wxEVT_MIDDLE_DCLICK )
4055EVT_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_RIGHT_DCLICK )
4056EVT_LEAVE_WINDOW = wx.PyEventBinder( wxEVT_LEAVE_WINDOW )
4057EVT_ENTER_WINDOW = wx.PyEventBinder( wxEVT_ENTER_WINDOW )
4058EVT_MOUSEWHEEL = wx.PyEventBinder( wxEVT_MOUSEWHEEL )
4059
4060EVT_MOUSE_EVENTS = wx.PyEventBinder([ wxEVT_LEFT_DOWN,
4061 wxEVT_LEFT_UP,
4062 wxEVT_MIDDLE_DOWN,
4063 wxEVT_MIDDLE_UP,
4064 wxEVT_RIGHT_DOWN,
4065 wxEVT_RIGHT_UP,
4066 wxEVT_MOTION,
4067 wxEVT_LEFT_DCLICK,
4068 wxEVT_MIDDLE_DCLICK,
4069 wxEVT_RIGHT_DCLICK,
4070 wxEVT_ENTER_WINDOW,
4071 wxEVT_LEAVE_WINDOW,
4072 wxEVT_MOUSEWHEEL
4073 ])
4074
4075
4076# Scrolling from wxWindow (sent to wxScrolledWindow)
704eda0c 4077EVT_SCROLLWIN = wx.PyEventBinder([ wxEVT_SCROLLWIN_TOP,
d55e5bfc
RD		 4078 wxEVT_SCROLLWIN_BOTTOM,
4079 wxEVT_SCROLLWIN_LINEUP,
4080 wxEVT_SCROLLWIN_LINEDOWN,
704eda0c 4081 wxEVT_SCROLLWIN_PAGEUP,
d55e5bfc
RD		 4082 wxEVT_SCROLLWIN_PAGEDOWN,
4083 wxEVT_SCROLLWIN_THUMBTRACK,
4084 wxEVT_SCROLLWIN_THUMBRELEASE,
4085 ])
4086
4087EVT_SCROLLWIN_TOP = wx.PyEventBinder( wxEVT_SCROLLWIN_TOP )
4088EVT_SCROLLWIN_BOTTOM = wx.PyEventBinder( wxEVT_SCROLLWIN_BOTTOM )
4089EVT_SCROLLWIN_LINEUP = wx.PyEventBinder( wxEVT_SCROLLWIN_LINEUP )
4090EVT_SCROLLWIN_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLLWIN_LINEDOWN )
4091EVT_SCROLLWIN_PAGEUP = wx.PyEventBinder( wxEVT_SCROLLWIN_PAGEUP )
4092EVT_SCROLLWIN_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLLWIN_PAGEDOWN )
4093EVT_SCROLLWIN_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLLWIN_THUMBTRACK )
4094EVT_SCROLLWIN_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLLWIN_THUMBRELEASE )
4095
27fb7603 4096# Scrolling from wx.Slider and wx.ScrollBar
704eda0c
RD		 4097EVT_SCROLL = wx.PyEventBinder([ wxEVT_SCROLL_TOP,
4098 wxEVT_SCROLL_BOTTOM,
4099 wxEVT_SCROLL_LINEUP,
4100 wxEVT_SCROLL_LINEDOWN,
4101 wxEVT_SCROLL_PAGEUP,
4102 wxEVT_SCROLL_PAGEDOWN,
4103 wxEVT_SCROLL_THUMBTRACK,
4104 wxEVT_SCROLL_THUMBRELEASE,
db67f999 4105 wxEVT_SCROLL_CHANGED,
d55e5bfc
RD		 4106 ])
4107
4108EVT_SCROLL_TOP = wx.PyEventBinder( wxEVT_SCROLL_TOP )
4109EVT_SCROLL_BOTTOM = wx.PyEventBinder( wxEVT_SCROLL_BOTTOM )
4110EVT_SCROLL_LINEUP = wx.PyEventBinder( wxEVT_SCROLL_LINEUP )
4111EVT_SCROLL_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLL_LINEDOWN )
4112EVT_SCROLL_PAGEUP = wx.PyEventBinder( wxEVT_SCROLL_PAGEUP )
4113EVT_SCROLL_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLL_PAGEDOWN )
4114EVT_SCROLL_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLL_THUMBTRACK )
4115EVT_SCROLL_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE )
db67f999
RD		 4116EVT_SCROLL_CHANGED = wx.PyEventBinder( wxEVT_SCROLL_CHANGED )
4117EVT_SCROLL_ENDSCROLL = EVT_SCROLL_CHANGED
704eda0c 4118
27fb7603 4119# Scrolling from wx.Slider and wx.ScrollBar, with an id
704eda0c
RD		 4120EVT_COMMAND_SCROLL = wx.PyEventBinder([ wxEVT_SCROLL_TOP,
4121 wxEVT_SCROLL_BOTTOM,
4122 wxEVT_SCROLL_LINEUP,
4123 wxEVT_SCROLL_LINEDOWN,
4124 wxEVT_SCROLL_PAGEUP,
4125 wxEVT_SCROLL_PAGEDOWN,
4126 wxEVT_SCROLL_THUMBTRACK,
d55e5bfc 4127 wxEVT_SCROLL_THUMBRELEASE,
db67f999 4128 wxEVT_SCROLL_CHANGED,
d55e5bfc
RD		 4129 ], 1)
4130
4131EVT_COMMAND_SCROLL_TOP = wx.PyEventBinder( wxEVT_SCROLL_TOP, 1)
4132EVT_COMMAND_SCROLL_BOTTOM = wx.PyEventBinder( wxEVT_SCROLL_BOTTOM, 1)
4133EVT_COMMAND_SCROLL_LINEUP = wx.PyEventBinder( wxEVT_SCROLL_LINEUP, 1)
4134EVT_COMMAND_SCROLL_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLL_LINEDOWN, 1)
4135EVT_COMMAND_SCROLL_PAGEUP = wx.PyEventBinder( wxEVT_SCROLL_PAGEUP, 1)
4136EVT_COMMAND_SCROLL_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLL_PAGEDOWN, 1)
4137EVT_COMMAND_SCROLL_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLL_THUMBTRACK, 1)
4138EVT_COMMAND_SCROLL_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE, 1)
db67f999
RD		 4139EVT_COMMAND_SCROLL_CHANGED = wx.PyEventBinder( wxEVT_SCROLL_CHANGED, 1)
4140EVT_COMMAND_SCROLL_ENDSCROLL = EVT_COMMAND_SCROLL_CHANGED
d55e5bfc
RD		 4141
4142EVT_BUTTON = wx.PyEventBinder( wxEVT_COMMAND_BUTTON_CLICKED, 1)
4143EVT_CHECKBOX = wx.PyEventBinder( wxEVT_COMMAND_CHECKBOX_CLICKED, 1)
4144EVT_CHOICE = wx.PyEventBinder( wxEVT_COMMAND_CHOICE_SELECTED, 1)
4145EVT_LISTBOX = wx.PyEventBinder( wxEVT_COMMAND_LISTBOX_SELECTED, 1)
4146EVT_LISTBOX_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, 1)
4147EVT_MENU = wx.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED, 1)
4148EVT_MENU_RANGE = wx.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED, 2)
4149EVT_SLIDER = wx.PyEventBinder( wxEVT_COMMAND_SLIDER_UPDATED, 1)
4150EVT_RADIOBOX = wx.PyEventBinder( wxEVT_COMMAND_RADIOBOX_SELECTED, 1)
4151EVT_RADIOBUTTON = wx.PyEventBinder( wxEVT_COMMAND_RADIOBUTTON_SELECTED, 1)
4152
4153EVT_SCROLLBAR = wx.PyEventBinder( wxEVT_COMMAND_SCROLLBAR_UPDATED, 1)
4154EVT_VLBOX = wx.PyEventBinder( wxEVT_COMMAND_VLBOX_SELECTED, 1)
4155EVT_COMBOBOX = wx.PyEventBinder( wxEVT_COMMAND_COMBOBOX_SELECTED, 1)
4156EVT_TOOL = wx.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED, 1)
4157EVT_TOOL_RANGE = wx.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED, 2)
4158EVT_TOOL_RCLICKED = wx.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED, 1)
4159EVT_TOOL_RCLICKED_RANGE = wx.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED, 2)
4160EVT_TOOL_ENTER = wx.PyEventBinder( wxEVT_COMMAND_TOOL_ENTER, 1)
4161EVT_CHECKLISTBOX = wx.PyEventBinder( wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, 1)
4162
4163
4164EVT_COMMAND_LEFT_CLICK = wx.PyEventBinder( wxEVT_COMMAND_LEFT_CLICK, 1)
4165EVT_COMMAND_LEFT_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_LEFT_DCLICK, 1)
4166EVT_COMMAND_RIGHT_CLICK = wx.PyEventBinder( wxEVT_COMMAND_RIGHT_CLICK, 1)
4167EVT_COMMAND_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_RIGHT_DCLICK, 1)
4168EVT_COMMAND_SET_FOCUS = wx.PyEventBinder( wxEVT_COMMAND_SET_FOCUS, 1)
4169EVT_COMMAND_KILL_FOCUS = wx.PyEventBinder( wxEVT_COMMAND_KILL_FOCUS, 1)
4170EVT_COMMAND_ENTER = wx.PyEventBinder( wxEVT_COMMAND_ENTER, 1)
4171
4172EVT_IDLE = wx.PyEventBinder( wxEVT_IDLE )
4173
4174EVT_UPDATE_UI = wx.PyEventBinder( wxEVT_UPDATE_UI, 1)
4175EVT_UPDATE_UI_RANGE = wx.PyEventBinder( wxEVT_UPDATE_UI, 2)
4176
4177EVT_CONTEXT_MENU = wx.PyEventBinder( wxEVT_CONTEXT_MENU )
4178
2131d850
RD		 4179EVT_TEXT_CUT = wx.PyEventBinder( wxEVT_COMMAND_TEXT_CUT )
4180EVT_TEXT_COPY = wx.PyEventBinder( wxEVT_COMMAND_TEXT_COPY )
4181EVT_TEXT_PASTE = wx.PyEventBinder( wxEVT_COMMAND_TEXT_PASTE )
d55e5bfc
RD		 4182
4183
4184#---------------------------------------------------------------------------
4185
4186class Event(Object):
27fb7603
RD		 4187 """
4188 An event is a structure holding information about an event passed to a
4189 callback or member function. wx.Event is an abstract base class for
4190 other event classes
4191 """
554f62e9
RD		 4192 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4193 def __init__(self): raise AttributeError, "No constructor defined"
4194 __repr__ = _swig_repr
4195 __swig_destroy__ = _core_.delete_Event
4196 __del__ = lambda self : None;
d55e5bfc 4197 def SetEventType(*args, **kwargs):
27fb7603 4198 """
f460c29d 4199 SetEventType(self, EventType typ)
27fb7603
RD		 4200
4201 Sets the specific type of the event.
4202 """
d55e5bfc
RD		 4203 return _core_.Event_SetEventType(*args, **kwargs)
4204
4205 def GetEventType(*args, **kwargs):
27fb7603 4206 """
f460c29d 4207 GetEventType(self) -> EventType
27fb7603
RD		 4208
4209 Returns the identifier of the given event type, such as
4210 ``wxEVT_COMMAND_BUTTON_CLICKED``.
4211 """
d55e5bfc
RD		 4212 return _core_.Event_GetEventType(*args, **kwargs)
4213
4214 def GetEventObject(*args, **kwargs):
27fb7603
RD		 4215 """
4216 GetEventObject(self) -> Object
4217
4218 Returns the object (usually a window) associated with the event, if
4219 any.
4220 """
d55e5bfc
RD		 4221 return _core_.Event_GetEventObject(*args, **kwargs)
4222
4223 def SetEventObject(*args, **kwargs):
27fb7603
RD		 4224 """
4225 SetEventObject(self, Object obj)
4226
4227 Sets the originating object, or in other words, obj is normally the
4228 object that is sending the event.
4229 """
d55e5bfc
RD		 4230 return _core_.Event_SetEventObject(*args, **kwargs)
4231
4232 def GetTimestamp(*args, **kwargs):
4233 """GetTimestamp(self) -> long"""
4234 return _core_.Event_GetTimestamp(*args, **kwargs)
4235
4236 def SetTimestamp(*args, **kwargs):
4237 """SetTimestamp(self, long ts=0)"""
4238 return _core_.Event_SetTimestamp(*args, **kwargs)
4239
4240 def GetId(*args, **kwargs):
27fb7603
RD		 4241 """
4242 GetId(self) -> int
4243
4244 Returns the identifier associated with this event, such as a button
4245 command id.
4246 """
d55e5bfc
RD		 4247 return _core_.Event_GetId(*args, **kwargs)
4248
4249 def SetId(*args, **kwargs):
27fb7603
RD		 4250 """
4251 SetId(self, int Id)
4252
4253 Set's the ID for the event. This is usually the ID of the window that
4254 is sending the event, but it can also be a command id from a menu
4255 item, etc.
4256 """
d55e5bfc
RD		 4257 return _core_.Event_SetId(*args, **kwargs)
4258
4259 def IsCommandEvent(*args, **kwargs):
27fb7603
RD		 4260 """
4261 IsCommandEvent(self) -> bool
4262
4263 Returns true if the event is or is derived from `wx.CommandEvent` else
4264 it returns false. Note: Exists only for optimization purposes.
4265 """
d55e5bfc
RD		 4266 return _core_.Event_IsCommandEvent(*args, **kwargs)
4267
4268 def Skip(*args, **kwargs):
51b83b37
RD		 4269 """
4270 Skip(self, bool skip=True)
4271
6b449b19
RD		 4272 This method can be used inside an event handler to control whether
4273 further event handlers bound to this event will be called after the
4274 current one returns. Without Skip() (or equivalently if Skip(False) is
4275 used), the event will not be processed any more. If Skip(True) is
4276 called, the event processing system continues searching for a further
4277 handler function for this event, even though it has been processed
4278 already in the current handler.
51b83b37 4279 """
d55e5bfc
RD		 4280 return _core_.Event_Skip(*args, **kwargs)
4281
4282 def GetSkipped(*args, **kwargs):
27fb7603
RD		 4283 """
4284 GetSkipped(self) -> bool
4285
4286 Returns true if the event handler should be skipped, false otherwise.
4287 :see: `Skip`
4288 """
d55e5bfc
RD		 4289 return _core_.Event_GetSkipped(*args, **kwargs)
4290
4291 def ShouldPropagate(*args, **kwargs):
27fb7603
RD		 4292 """
4293 ShouldPropagate(self) -> bool
4294
4295 Test if this event should be propagated to the parent window or not,
4296 i.e. if the propagation level is currently greater than 0.
4297 """
d55e5bfc
RD		 4298 return _core_.Event_ShouldPropagate(*args, **kwargs)
4299
4300 def StopPropagation(*args, **kwargs):
27fb7603
RD		 4301 """
4302 StopPropagation(self) -> int
4303
4304 Stop the event from propagating to its parent window. Returns the old
4305 propagation level value which may be later passed to
4306 `ResumePropagation` to allow propagating the event again.
4307 """
d55e5bfc
RD		 4308 return _core_.Event_StopPropagation(*args, **kwargs)
4309
4310 def ResumePropagation(*args, **kwargs):
27fb7603
RD		 4311 """
4312 ResumePropagation(self, int propagationLevel)
4313
4314 Resume the event propagation by restoring the propagation level. (For
4315 example, you can use the value returned by an earlier call to
4316 `StopPropagation`.)
4317
4318 """
d55e5bfc
RD		 4319 return _core_.Event_ResumePropagation(*args, **kwargs)
4320
4321 def Clone(*args, **kwargs):
4322 """Clone(self) -> Event"""
4323 return _core_.Event_Clone(*args, **kwargs)
4324
97ab0f6a
RD		 4325 EventObject = property(GetEventObject,SetEventObject,doc="See `GetEventObject` and `SetEventObject`")
4326 EventType = property(GetEventType,SetEventType,doc="See `GetEventType` and `SetEventType`")
4327 Id = property(GetId,SetId,doc="See `GetId` and `SetId`")
4328 Skipped = property(GetSkipped,doc="See `GetSkipped`")
4329 Timestamp = property(GetTimestamp,SetTimestamp,doc="See `GetTimestamp` and `SetTimestamp`")
2131d850 4330_core_.Event_swigregister(Event)
d55e5bfc
RD		 4331
4332#---------------------------------------------------------------------------
4333
4334class PropagationDisabler(object):
27fb7603
RD		 4335 """
4336 Helper class to temporarily change an event not to propagate. Simply
4337 create an instance of this class and then whe it is destroyed the
4338 propogation of the event will be restored.
4339 """
554f62e9
RD		 4340 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4341 __repr__ = _swig_repr
4342 def __init__(self, *args, **kwargs):
27fb7603
RD		 4343 """
4344 __init__(self, Event event) -> PropagationDisabler
4345
4346 Helper class to temporarily change an event not to propagate. Simply
4347 create an instance of this class and then whe it is destroyed the
4348 propogation of the event will be restored.
4349 """
554f62e9
RD		 4350 _core_.PropagationDisabler_swiginit(self,_core_.new_PropagationDisabler(*args, **kwargs))
4351 __swig_destroy__ = _core_.delete_PropagationDisabler
4352 __del__ = lambda self : None;
2131d850 4353_core_.PropagationDisabler_swigregister(PropagationDisabler)
d55e5bfc
RD		 4354
4355class PropagateOnce(object):
27fb7603
RD		 4356 """
4357 A helper class that will temporarily lower propagation level of an
4358 event. Simply create an instance of this class and then whe it is
4359 destroyed the propogation of the event will be restored.
4360 """
554f62e9
RD		 4361 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4362 __repr__ = _swig_repr
4363 def __init__(self, *args, **kwargs):
27fb7603
RD		 4364 """
4365 __init__(self, Event event) -> PropagateOnce
4366
4367 A helper class that will temporarily lower propagation level of an
4368 event. Simply create an instance of this class and then whe it is
4369 destroyed the propogation of the event will be restored.
4370 """
554f62e9
RD		 4371 _core_.PropagateOnce_swiginit(self,_core_.new_PropagateOnce(*args, **kwargs))
4372 __swig_destroy__ = _core_.delete_PropagateOnce
4373 __del__ = lambda self : None;
2131d850 4374_core_.PropagateOnce_swigregister(PropagateOnce)
d55e5bfc
RD		 4375
4376#---------------------------------------------------------------------------
4377
4378class CommandEvent(Event):
27fb7603
RD		 4379 """
4380 This event class contains information about command events, which
4381 originate from a variety of simple controls, as well as menus and
4382 toolbars.
4383 """
554f62e9
RD		 4384 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4385 __repr__ = _swig_repr
4386 def __init__(self, *args, **kwargs):
27fb7603 4387 """
f460c29d 4388 __init__(self, EventType commandType=wxEVT_NULL, int winid=0) -> CommandEvent
27fb7603
RD		 4389
4390 This event class contains information about command events, which
4391 originate from a variety of simple controls, as well as menus and
4392 toolbars.
4393 """
554f62e9 4394 _core_.CommandEvent_swiginit(self,_core_.new_CommandEvent(*args, **kwargs))
d55e5bfc 4395 def GetSelection(*args, **kwargs):
27fb7603
RD		 4396 """
4397 GetSelection(self) -> int
4398
4399 Returns item index for a listbox or choice selection event (not valid
4400 for a deselection).
4401 """
d55e5bfc
RD		 4402 return _core_.CommandEvent_GetSelection(*args, **kwargs)
4403
4404 def SetString(*args, **kwargs):
4405 """SetString(self, String s)"""
4406 return _core_.CommandEvent_SetString(*args, **kwargs)
4407
4408 def GetString(*args, **kwargs):
27fb7603
RD		 4409 """
4410 GetString(self) -> String
4411
4412 Returns item string for a listbox or choice selection event (not valid
4413 for a deselection).
4414 """
d55e5bfc
RD		 4415 return _core_.CommandEvent_GetString(*args, **kwargs)
4416
4417 def IsChecked(*args, **kwargs):
27fb7603
RD		 4418 """
4419 IsChecked(self) -> bool
4420
4421 This method can be used with checkbox and menu events: for the
4422 checkboxes, the method returns true for a selection event and false
4423 for a deselection one. For the menu events, this method indicates if
4424 the menu item just has become checked or unchecked (and thus only
4425 makes sense for checkable menu items).
4426 """
d55e5bfc
RD		 4427 return _core_.CommandEvent_IsChecked(*args, **kwargs)
4428
4429 Checked = IsChecked
4430 def IsSelection(*args, **kwargs):
27fb7603
RD		 4431 """
4432 IsSelection(self) -> bool
4433
4434 For a listbox or similar event, returns true if it is a selection,
4435 false if it is a deselection.
4436 """
d55e5bfc
RD		 4437 return _core_.CommandEvent_IsSelection(*args, **kwargs)
4438
4439 def SetExtraLong(*args, **kwargs):
4440 """SetExtraLong(self, long extraLong)"""
4441 return _core_.CommandEvent_SetExtraLong(*args, **kwargs)
4442
4443 def GetExtraLong(*args, **kwargs):
27fb7603
RD		 4444 """
4445 GetExtraLong(self) -> long
4446
5ba5649b
RD		 4447 Returns extra information dependant on the event objects type. If the
4448 event comes from a listbox selection, it is a boolean determining
4449 whether the event was a selection (true) or a deselection (false). A
4450 listbox deselection only occurs for multiple-selection boxes, and in
4451 this case the index and string values are indeterminate and the
4452 listbox must be examined by the application.
27fb7603 4453 """
d55e5bfc
RD		 4454 return _core_.CommandEvent_GetExtraLong(*args, **kwargs)
4455
4456 def SetInt(*args, **kwargs):
4457 """SetInt(self, int i)"""
4458 return _core_.CommandEvent_SetInt(*args, **kwargs)
4459
4460 def GetInt(*args, **kwargs):
27fb7603 4461 """
f460c29d 4462 GetInt(self) -> int
27fb7603 4463
5ba5649b
RD		 4464 Returns the integer identifier corresponding to a listbox, choice or
4465 radiobox selection (only if the event was a selection, not a
4466 deselection), or a boolean value representing the value of a checkbox.
27fb7603 4467 """
d55e5bfc
RD		 4468 return _core_.CommandEvent_GetInt(*args, **kwargs)
4469
554f62e9
RD		 4470 def GetClientData(*args, **kwargs):
4471 """
4472 GetClientData(self) -> PyObject
4473
4474 Returns the client data object for a listbox or choice selection event, (if any.)
4475 """
4476 return _core_.CommandEvent_GetClientData(*args, **kwargs)
4477
4478 def SetClientData(*args, **kwargs):
4479 """
4480 SetClientData(self, PyObject clientData)
4481
4482 Associate the given client data with the item at position n.
4483 """
4484 return _core_.CommandEvent_SetClientData(*args, **kwargs)
4485
4486 GetClientObject = GetClientData
4487 SetClientObject = SetClientData
4488
d55e5bfc
RD		 4489 def Clone(*args, **kwargs):
4490 """Clone(self) -> Event"""
4491 return _core_.CommandEvent_Clone(*args, **kwargs)
4492
226118fc
RD		 4493 ClientData = property(GetClientData,SetClientData,doc="See `GetClientData` and `SetClientData`")
4494 ClientObject = property(GetClientObject,SetClientObject,doc="See `GetClientObject` and `SetClientObject`")
4495 ExtraLong = property(GetExtraLong,SetExtraLong,doc="See `GetExtraLong` and `SetExtraLong`")
4496 Int = property(GetInt,SetInt,doc="See `GetInt` and `SetInt`")
4497 Selection = property(GetSelection,doc="See `GetSelection`")
4498 String = property(GetString,SetString,doc="See `GetString` and `SetString`")
2131d850 4499_core_.CommandEvent_swigregister(CommandEvent)
d55e5bfc
RD		 4500
4501#---------------------------------------------------------------------------
4502
4503class NotifyEvent(CommandEvent):
27fb7603
RD		 4504 """
4505 An instance of this class (or one of its derived classes) is sent from
4506 a control when the control's state is being changed and the control
4507 allows that change to be prevented from happening. The event handler
4508 can call `Veto` or `Allow` to tell the control what to do.
4509 """
554f62e9
RD		 4510 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4511 __repr__ = _swig_repr
4512 def __init__(self, *args, **kwargs):
27fb7603 4513 """
f460c29d 4514 __init__(self, EventType commandType=wxEVT_NULL, int winid=0) -> NotifyEvent
27fb7603
RD		 4515
4516 An instance of this class (or one of its derived classes) is sent from
4517 a control when the control's state is being changed and the control
4518 allows that change to be prevented from happening. The event handler
4519 can call `Veto` or `Allow` to tell the control what to do.
4520 """
554f62e9 4521 _core_.NotifyEvent_swiginit(self,_core_.new_NotifyEvent(*args, **kwargs))
d55e5bfc 4522 def Veto(*args, **kwargs):
27fb7603
RD		 4523 """
4524 Veto(self)
4525
4526 Prevents the change announced by this event from happening.
4527
4528 It is in general a good idea to notify the user about the reasons for
4529 vetoing the change because otherwise the applications behaviour (which
4530 just refuses to do what the user wants) might be quite surprising.
4531 """
d55e5bfc
RD		 4532 return _core_.NotifyEvent_Veto(*args, **kwargs)
4533
4534 def Allow(*args, **kwargs):
27fb7603
RD		 4535 """
4536 Allow(self)
4537
4538 This is the opposite of `Veto`: it explicitly allows the event to be
4539 processed. For most events it is not necessary to call this method as
4540 the events are allowed anyhow but some are forbidden by default (this
4541 will be mentioned in the corresponding event description).
4542 """
d55e5bfc
RD		 4543 return _core_.NotifyEvent_Allow(*args, **kwargs)
4544
4545 def IsAllowed(*args, **kwargs):
27fb7603
RD		 4546 """
4547 IsAllowed(self) -> bool
4548
4549 Returns true if the change is allowed (`Veto` hasn't been called) or
4550 false otherwise (if it was).
4551 """
d55e5bfc
RD		 4552 return _core_.NotifyEvent_IsAllowed(*args, **kwargs)
4553
2131d850 4554_core_.NotifyEvent_swigregister(NotifyEvent)
d55e5bfc
RD		 4555
4556#---------------------------------------------------------------------------
4557
4558class ScrollEvent(CommandEvent):
27fb7603
RD		 4559 """
4560 A scroll event holds information about events sent from stand-alone
4561 scrollbars and sliders. Note that scrolled windows do not send
4562 instnaces of this event class, but send the `wx.ScrollWinEvent`
4563 instead.
4564 """
554f62e9
RD		 4565 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4566 __repr__ = _swig_repr
4567 def __init__(self, *args, **kwargs):
d55e5bfc 4568 """
f460c29d 4569 __init__(self, EventType commandType=wxEVT_NULL, int winid=0, int pos=0,
d55e5bfc
RD		 4570 int orient=0) -> ScrollEvent
4571 """
554f62e9 4572 _core_.ScrollEvent_swiginit(self,_core_.new_ScrollEvent(*args, **kwargs))
d55e5bfc 4573 def GetOrientation(*args, **kwargs):
27fb7603
RD		 4574 """
4575 GetOrientation(self) -> int
4576
4577 Returns wx.HORIZONTAL or wx.VERTICAL, depending on the orientation of
4578 the scrollbar.
4579 """
d55e5bfc
RD		 4580 return _core_.ScrollEvent_GetOrientation(*args, **kwargs)
4581
4582 def GetPosition(*args, **kwargs):
27fb7603
RD		 4583 """
4584 GetPosition(self) -> int
4585
4586 Returns the position of the scrollbar.
4587 """
d55e5bfc
RD		 4588 return _core_.ScrollEvent_GetPosition(*args, **kwargs)
4589
4590 def SetOrientation(*args, **kwargs):
4591 """SetOrientation(self, int orient)"""
4592 return _core_.ScrollEvent_SetOrientation(*args, **kwargs)
4593
4594 def SetPosition(*args, **kwargs):
4595 """SetPosition(self, int pos)"""
4596 return _core_.ScrollEvent_SetPosition(*args, **kwargs)
4597
33d6fd3b
RD		 4598 Orientation = property(GetOrientation,SetOrientation,doc="See `GetOrientation` and `SetOrientation`")
4599 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
2131d850 4600_core_.ScrollEvent_swigregister(ScrollEvent)
d55e5bfc
RD		 4601
4602#---------------------------------------------------------------------------
4603
4604class ScrollWinEvent(Event):
27fb7603
RD		 4605 """
4606 A wx.ScrollWinEvent holds information about scrolling and is sent from
4607 scrolling windows.
4608 """
554f62e9
RD		 4609 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4610 __repr__ = _swig_repr
4611 def __init__(self, *args, **kwargs):
27fb7603 4612 """
f460c29d 4613 __init__(self, EventType commandType=wxEVT_NULL, int pos=0, int orient=0) -> ScrollWinEvent
27fb7603
RD		 4614
4615 A wx.ScrollWinEvent holds information about scrolling and is sent from
4616 scrolling windows.
4617 """
554f62e9 4618 _core_.ScrollWinEvent_swiginit(self,_core_.new_ScrollWinEvent(*args, **kwargs))
d55e5bfc 4619 def GetOrientation(*args, **kwargs):
27fb7603
RD		 4620 """
4621 GetOrientation(self) -> int
4622
4623 Returns wx.HORIZONTAL or wx.VERTICAL, depending on the orientation of
4624 the scrollbar.
4625 """
d55e5bfc
RD		 4626 return _core_.ScrollWinEvent_GetOrientation(*args, **kwargs)
4627
4628 def GetPosition(*args, **kwargs):
27fb7603
RD		 4629 """
4630 GetPosition(self) -> int
4631
4632 Returns the position of the scrollbar for the thumb track and release
4633 events. Note that this field can't be used for the other events, you
4634 need to query the window itself for the current position in that case.
4635 """
d55e5bfc
RD		 4636 return _core_.ScrollWinEvent_GetPosition(*args, **kwargs)
4637
4638 def SetOrientation(*args, **kwargs):
4639 """SetOrientation(self, int orient)"""
4640 return _core_.ScrollWinEvent_SetOrientation(*args, **kwargs)
4641
4642 def SetPosition(*args, **kwargs):
4643 """SetPosition(self, int pos)"""
4644 return _core_.ScrollWinEvent_SetPosition(*args, **kwargs)
4645
33d6fd3b
RD		 4646 Orientation = property(GetOrientation,SetOrientation,doc="See `GetOrientation` and `SetOrientation`")
4647 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
2131d850 4648_core_.ScrollWinEvent_swigregister(ScrollWinEvent)
d55e5bfc
RD		 4649
4650#---------------------------------------------------------------------------
4651
4652MOUSE_BTN_ANY = _core_.MOUSE_BTN_ANY
4653MOUSE_BTN_NONE = _core_.MOUSE_BTN_NONE
4654MOUSE_BTN_LEFT = _core_.MOUSE_BTN_LEFT
4655MOUSE_BTN_MIDDLE = _core_.MOUSE_BTN_MIDDLE
4656MOUSE_BTN_RIGHT = _core_.MOUSE_BTN_RIGHT
4657class MouseEvent(Event):
27fb7603
RD		 4658 """
4659 This event class contains information about the events generated by
4660 the mouse: they include mouse buttons press and release events and
4661 mouse move events.
4662
4663 All mouse events involving the buttons use ``wx.MOUSE_BTN_LEFT`` for
4664 the left mouse button, ``wx.MOUSE_BTN_MIDDLE`` for the middle one and
4665 ``wx.MOUSE_BTN_RIGHT`` for the right one. Note that not all mice have
4666 a middle button so a portable application should avoid relying on the
4667 events from it.
4668
4669 Note the difference between methods like `LeftDown` and `LeftIsDown`:
4670 the former returns true when the event corresponds to the left mouse
4671 button click while the latter returns true if the left mouse button is
4672 currently being pressed. For example, when the user is dragging the
4673 mouse you can use `LeftIsDown` to test whether the left mouse button
4674 is (still) depressed. Also, by convention, if `LeftDown` returns true,
4675 `LeftIsDown` will also return true in wxWidgets whatever the
4676 underlying GUI behaviour is (which is platform-dependent). The same
4677 applies, of course, to other mouse buttons as well.
4678 """
554f62e9
RD		 4679 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4680 __repr__ = _swig_repr
4681 def __init__(self, *args, **kwargs):
27fb7603 4682 """
f460c29d 4683 __init__(self, EventType mouseType=wxEVT_NULL) -> MouseEvent
27fb7603
RD		 4684
4685 Constructs a wx.MouseEvent. Valid event types are:
4686
4687 * wxEVT_ENTER_WINDOW
4688 * wxEVT_LEAVE_WINDOW
4689 * wxEVT_LEFT_DOWN
4690 * wxEVT_LEFT_UP
4691 * wxEVT_LEFT_DCLICK
4692 * wxEVT_MIDDLE_DOWN
4693 * wxEVT_MIDDLE_UP
4694 * wxEVT_MIDDLE_DCLICK
4695 * wxEVT_RIGHT_DOWN
4696 * wxEVT_RIGHT_UP
4697 * wxEVT_RIGHT_DCLICK
4698 * wxEVT_MOTION
4699 * wxEVT_MOUSEWHEEL
4700 """
554f62e9 4701 _core_.MouseEvent_swiginit(self,_core_.new_MouseEvent(*args, **kwargs))
d55e5bfc 4702 def IsButton(*args, **kwargs):
27fb7603
RD		 4703 """
4704 IsButton(self) -> bool
4705
4706 Returns true if the event was a mouse button event (not necessarily a
4707 button down event - that may be tested using `ButtonDown`).
4708 """
d55e5bfc
RD		 4709 return _core_.MouseEvent_IsButton(*args, **kwargs)
4710
4711 def ButtonDown(*args, **kwargs):
27fb7603
RD		 4712 """
4713 ButtonDown(self, int but=MOUSE_BTN_ANY) -> bool
4714
5ba5649b
RD		 4715 If the argument is omitted, this returns true if the event was any
4716 mouse button down event. Otherwise the argument specifies which
4717 button-down event shold be checked for (see `Button` for the possible
4718 values).
27fb7603 4719 """
d55e5bfc
RD		 4720 return _core_.MouseEvent_ButtonDown(*args, **kwargs)
4721
4722 def ButtonDClick(*args, **kwargs):
27fb7603
RD		 4723 """
4724 ButtonDClick(self, int but=MOUSE_BTN_ANY) -> bool
4725
4726 If the argument is omitted, this returns true if the event was any
4727 mouse double click event. Otherwise the argument specifies which
4728 double click event to check for (see `Button` for the possible
4729 values).
4730 """
d55e5bfc
RD		 4731 return _core_.MouseEvent_ButtonDClick(*args, **kwargs)
4732
4733 def ButtonUp(*args, **kwargs):
27fb7603
RD		 4734 """
4735 ButtonUp(self, int but=MOUSE_BTN_ANY) -> bool
4736
4737 If the argument is omitted, this returns true if the event was any
5ba5649b
RD		 4738 mouse button up event. Otherwise the argument specifies which button
4739 up event to check for (see `Button` for the possible values).
27fb7603 4740 """
d55e5bfc
RD		 4741 return _core_.MouseEvent_ButtonUp(*args, **kwargs)
4742
4743 def Button(*args, **kwargs):
27fb7603
RD		 4744 """
4745 Button(self, int button) -> bool
4746
4747 Returns true if the identified mouse button is changing state. Valid
4748 values of button are:
4749
4750 ==================== =====================================
4751 wx.MOUSE_BTN_LEFT check if left button was pressed
4752 wx.MOUSE_BTN_MIDDLE check if middle button was pressed
4753 wx.MOUSE_BTN_RIGHT check if right button was pressed
4754 wx.MOUSE_BTN_ANY check if any button was pressed
4755 ==================== =====================================
4756
4757 """
d55e5bfc
RD		 4758 return _core_.MouseEvent_Button(*args, **kwargs)
4759
4760 def ButtonIsDown(*args, **kwargs):
4761 """ButtonIsDown(self, int but) -> bool"""
4762 return _core_.MouseEvent_ButtonIsDown(*args, **kwargs)
4763
4764 def GetButton(*args, **kwargs):
27fb7603
RD		 4765 """
4766 GetButton(self) -> int
4767
4768 Returns the mouse button which generated this event or
4769 wx.MOUSE_BTN_NONE if no button is involved (for mouse move, enter or
4770 leave event, for example). Otherwise wx.MOUSE_BTN_LEFT is returned for
4771 the left button down, up and double click events, wx.MOUSE_BTN_MIDDLE
4772 and wx.MOUSE_BTN_RIGHT for the same events for the middle and the
4773 right buttons respectively.
4774 """
d55e5bfc
RD		 4775 return _core_.MouseEvent_GetButton(*args, **kwargs)
4776
4777 def ControlDown(*args, **kwargs):
27fb7603
RD		 4778 """
4779 ControlDown(self) -> bool
4780
4781 Returns true if the control key was down at the time of the event.
4782 """
d55e5bfc
RD		 4783 return _core_.MouseEvent_ControlDown(*args, **kwargs)
4784
4785 def MetaDown(*args, **kwargs):
27fb7603
RD		 4786 """
4787 MetaDown(self) -> bool
4788
4789 Returns true if the Meta key was down at the time of the event.
4790 """
d55e5bfc
RD		 4791 return _core_.MouseEvent_MetaDown(*args, **kwargs)
4792
4793 def AltDown(*args, **kwargs):
27fb7603
RD		 4794 """
4795 AltDown(self) -> bool
4796
4797 Returns true if the Alt key was down at the time of the event.
4798 """
d55e5bfc
RD		 4799 return _core_.MouseEvent_AltDown(*args, **kwargs)
4800
4801 def ShiftDown(*args, **kwargs):
27fb7603
RD		 4802 """
4803 ShiftDown(self) -> bool
4804
4805 Returns true if the Shift key was down at the time of the event.
4806 """
d55e5bfc
RD		 4807 return _core_.MouseEvent_ShiftDown(*args, **kwargs)
4808
412d302d
RD		 4809 def CmdDown(*args, **kwargs):
4810 """
4811 CmdDown(self) -> bool
4812
4813 "Cmd" is a pseudo key which is the same as Control for PC and Unix
4814 platforms but the special "Apple" (a.k.a as "Command") key on
5ba5649b 4815 Macs. It often makes sense to use it instead of, say, `ControlDown`
412d302d 4816 because Cmd key is used for the same thing under Mac as Ctrl
27fb7603 4817 elsewhere. The Ctrl key still exists, it's just not used for this
412d302d
RD		 4818 purpose. So for non-Mac platforms this is the same as `ControlDown`
4819 and Macs this is the same as `MetaDown`.
4820 """
4821 return _core_.MouseEvent_CmdDown(*args, **kwargs)
4822
d55e5bfc 4823 def LeftDown(*args, **kwargs):
27fb7603
RD		 4824 """
4825 LeftDown(self) -> bool
4826
4827 Returns true if the left mouse button state changed to down.
4828 """
d55e5bfc
RD		 4829 return _core_.MouseEvent_LeftDown(*args, **kwargs)
4830
4831 def MiddleDown(*args, **kwargs):
27fb7603
RD		 4832 """
4833 MiddleDown(self) -> bool
4834
4835 Returns true if the middle mouse button state changed to down.
4836 """
d55e5bfc
RD		 4837 return _core_.MouseEvent_MiddleDown(*args, **kwargs)
4838
4839 def RightDown(*args, **kwargs):
27fb7603
RD		 4840 """
4841 RightDown(self) -> bool
4842
4843 Returns true if the right mouse button state changed to down.
4844 """
d55e5bfc
RD		 4845 return _core_.MouseEvent_RightDown(*args, **kwargs)
4846
4847 def LeftUp(*args, **kwargs):
27fb7603
RD		 4848 """
4849 LeftUp(self) -> bool
4850
4851 Returns true if the left mouse button state changed to up.
4852 """
d55e5bfc
RD		 4853 return _core_.MouseEvent_LeftUp(*args, **kwargs)
4854
4855 def MiddleUp(*args, **kwargs):
27fb7603
RD		 4856 """
4857 MiddleUp(self) -> bool
4858
4859 Returns true if the middle mouse button state changed to up.
4860 """
d55e5bfc
RD		 4861 return _core_.MouseEvent_MiddleUp(*args, **kwargs)
4862
4863 def RightUp(*args, **kwargs):
27fb7603
RD		 4864 """
4865 RightUp(self) -> bool
4866
4867 Returns true if the right mouse button state changed to up.
4868 """
d55e5bfc
RD		 4869 return _core_.MouseEvent_RightUp(*args, **kwargs)
4870
4871 def LeftDClick(*args, **kwargs):
27fb7603
RD		 4872 """
4873 LeftDClick(self) -> bool
4874
4875 Returns true if the event was a left button double click.
4876 """
d55e5bfc
RD		 4877 return _core_.MouseEvent_LeftDClick(*args, **kwargs)
4878
4879 def MiddleDClick(*args, **kwargs):
27fb7603
RD		 4880 """
4881 MiddleDClick(self) -> bool
4882
4883 Returns true if the event was a middle button double click.
4884 """
d55e5bfc
RD		 4885 return _core_.MouseEvent_MiddleDClick(*args, **kwargs)
4886
4887 def RightDClick(*args, **kwargs):
27fb7603
RD		 4888 """
4889 RightDClick(self) -> bool
4890
4891 Returns true if the event was a right button double click.
4892 """
d55e5bfc
RD		 4893 return _core_.MouseEvent_RightDClick(*args, **kwargs)
4894
4895 def LeftIsDown(*args, **kwargs):
27fb7603
RD		 4896 """
4897 LeftIsDown(self) -> bool
4898
4899 Returns true if the left mouse button is currently down, independent
4900 of the current event type.
4901
4902 Please notice that it is not the same as LeftDown which returns true
4903 if the left mouse button was just pressed. Rather, it describes the
4904 state of the mouse button before the event happened.
4905
4906 This event is usually used in the mouse event handlers which process
4907 "move mouse" messages to determine whether the user is (still)
4908 dragging the mouse.
4909 """
d55e5bfc
RD		 4910 return _core_.MouseEvent_LeftIsDown(*args, **kwargs)
4911
4912 def MiddleIsDown(*args, **kwargs):
27fb7603
RD		 4913 """
4914 MiddleIsDown(self) -> bool
4915
4916 Returns true if the middle mouse button is currently down, independent
4917 of the current event type.
4918 """
d55e5bfc
RD		 4919 return _core_.MouseEvent_MiddleIsDown(*args, **kwargs)
4920
4921 def RightIsDown(*args, **kwargs):
27fb7603
RD		 4922 """
4923 RightIsDown(self) -> bool
4924
4925 Returns true if the right mouse button is currently down, independent
4926 of the current event type.
4927 """
d55e5bfc
RD		 4928 return _core_.MouseEvent_RightIsDown(*args, **kwargs)
4929
4930 def Dragging(*args, **kwargs):
27fb7603
RD		 4931 """
4932 Dragging(self) -> bool
4933
4934 Returns true if this was a dragging event (motion while a button is
4935 depressed).
4936 """
d55e5bfc
RD		 4937 return _core_.MouseEvent_Dragging(*args, **kwargs)
4938
4939 def Moving(*args, **kwargs):
27fb7603
RD		 4940 """
4941 Moving(self) -> bool
4942
4943 Returns true if this was a motion event and no mouse buttons were
4944 pressed. If any mouse button is held pressed, then this method returns
4945 false and Dragging returns true.
4946 """
d55e5bfc
RD		 4947 return _core_.MouseEvent_Moving(*args, **kwargs)
4948
4949 def Entering(*args, **kwargs):
27fb7603
RD		 4950 """
4951 Entering(self) -> bool
4952
4953 Returns true if the mouse was entering the window.
4954 """
d55e5bfc
RD		 4955 return _core_.MouseEvent_Entering(*args, **kwargs)
4956
4957 def Leaving(*args, **kwargs):
27fb7603
RD		 4958 """
4959 Leaving(self) -> bool
4960
4961 Returns true if the mouse was leaving the window.
4962 """
d55e5bfc
RD		 4963 return _core_.MouseEvent_Leaving(*args, **kwargs)
4964
4965 def GetPosition(*args, **kwargs):
4966 """
4967 GetPosition(self) -> Point
4968
27fb7603
RD		 4969 Returns the pixel position of the mouse in window coordinates when the
4970 event happened.
d55e5bfc
RD		 4971 """
4972 return _core_.MouseEvent_GetPosition(*args, **kwargs)
4973
4974 def GetPositionTuple(*args, **kwargs):
4975 """
4976 GetPositionTuple() -> (x,y)
4977
27fb7603
RD		 4978 Returns the pixel position of the mouse in window coordinates when the
4979 event happened.
d55e5bfc
RD		 4980 """
4981 return _core_.MouseEvent_GetPositionTuple(*args, **kwargs)
4982
4983 def GetLogicalPosition(*args, **kwargs):
27fb7603
RD		 4984 """
4985 GetLogicalPosition(self, DC dc) -> Point
4986
4987 Returns the logical mouse position in pixels (i.e. translated
4988 according to the translation set for the DC, which usually indicates
4989 that the window has been scrolled).
4990 """
d55e5bfc
RD		 4991 return _core_.MouseEvent_GetLogicalPosition(*args, **kwargs)
4992
4993 def GetX(*args, **kwargs):
27fb7603
RD		 4994 """
4995 GetX(self) -> int
4996
4997 Returns X coordinate of the physical mouse event position.
4998 """
d55e5bfc
RD		 4999 return _core_.MouseEvent_GetX(*args, **kwargs)
5000
5001 def GetY(*args, **kwargs):
27fb7603
RD		 5002 """
5003 GetY(self) -> int
5004
5005 Returns Y coordinate of the physical mouse event position.
5006 """
d55e5bfc
RD		 5007 return _core_.MouseEvent_GetY(*args, **kwargs)
5008
5009 def GetWheelRotation(*args, **kwargs):
27fb7603
RD		 5010 """
5011 GetWheelRotation(self) -> int
5012
5013 Get wheel rotation, positive or negative indicates direction of
5014 rotation. Current devices all send an event when rotation is equal to
5015 +/-WheelDelta, but this allows for finer resolution devices to be
5016 created in the future. Because of this you shouldn't assume that one
5017 event is equal to 1 line or whatever, but you should be able to either
5018 do partial line scrolling or wait until +/-WheelDelta rotation values
5019 have been accumulated before scrolling.
5020 """
d55e5bfc
RD		 5021 return _core_.MouseEvent_GetWheelRotation(*args, **kwargs)
5022
5023 def GetWheelDelta(*args, **kwargs):
27fb7603
RD		 5024 """
5025 GetWheelDelta(self) -> int
5026
5027 Get wheel delta, normally 120. This is the threshold for action to be
5028 taken, and one such action (for example, scrolling one increment)
5029 should occur for each delta.
5030 """
d55e5bfc
RD		 5031 return _core_.MouseEvent_GetWheelDelta(*args, **kwargs)
5032
5033 def GetLinesPerAction(*args, **kwargs):
27fb7603
RD		 5034 """
5035 GetLinesPerAction(self) -> int
5036
5037 Returns the configured number of lines (or whatever) to be scrolled
5038 per wheel action. Defaults to three.
5039 """
d55e5bfc
RD		 5040 return _core_.MouseEvent_GetLinesPerAction(*args, **kwargs)
5041
5042 def IsPageScroll(*args, **kwargs):
27fb7603
RD		 5043 """
5044 IsPageScroll(self) -> bool
5045
5046 Returns true if the system has been setup to do page scrolling with
5047 the mouse wheel instead of line scrolling.
5048 """
d55e5bfc
RD		 5049 return _core_.MouseEvent_IsPageScroll(*args, **kwargs)
5050
5051 m_x = property(_core_.MouseEvent_m_x_get, _core_.MouseEvent_m_x_set)
5052 m_y = property(_core_.MouseEvent_m_y_get, _core_.MouseEvent_m_y_set)
5053 m_leftDown = property(_core_.MouseEvent_m_leftDown_get, _core_.MouseEvent_m_leftDown_set)
5054 m_middleDown = property(_core_.MouseEvent_m_middleDown_get, _core_.MouseEvent_m_middleDown_set)
5055 m_rightDown = property(_core_.MouseEvent_m_rightDown_get, _core_.MouseEvent_m_rightDown_set)
5056 m_controlDown = property(_core_.MouseEvent_m_controlDown_get, _core_.MouseEvent_m_controlDown_set)
5057 m_shiftDown = property(_core_.MouseEvent_m_shiftDown_get, _core_.MouseEvent_m_shiftDown_set)
5058 m_altDown = property(_core_.MouseEvent_m_altDown_get, _core_.MouseEvent_m_altDown_set)
5059 m_metaDown = property(_core_.MouseEvent_m_metaDown_get, _core_.MouseEvent_m_metaDown_set)
5060 m_wheelRotation = property(_core_.MouseEvent_m_wheelRotation_get, _core_.MouseEvent_m_wheelRotation_set)
5061 m_wheelDelta = property(_core_.MouseEvent_m_wheelDelta_get, _core_.MouseEvent_m_wheelDelta_set)
5062 m_linesPerAction = property(_core_.MouseEvent_m_linesPerAction_get, _core_.MouseEvent_m_linesPerAction_set)
57332a5a
RD		 5063 Button = property(GetButton,doc="See `GetButton`")
5064 LinesPerAction = property(GetLinesPerAction,doc="See `GetLinesPerAction`")
5065 LogicalPosition = property(GetLogicalPosition,doc="See `GetLogicalPosition`")
5066 Position = property(GetPosition,doc="See `GetPosition`")
5067 WheelDelta = property(GetWheelDelta,doc="See `GetWheelDelta`")
5068 WheelRotation = property(GetWheelRotation,doc="See `GetWheelRotation`")
5069 X = property(GetX,doc="See `GetX`")
5070 Y = property(GetY,doc="See `GetY`")
2131d850 5071_core_.MouseEvent_swigregister(MouseEvent)
d55e5bfc
RD		 5072
5073#---------------------------------------------------------------------------
5074
5075class SetCursorEvent(Event):
5ba5649b
RD		 5076 """
5077 A SetCursorEvent is generated when the mouse cursor is about to be set
5078 as a result of mouse motion. This event gives the application the
5079 chance to perform specific mouse cursor processing based on the
5080 current position of the mouse within the window. Use the `SetCursor`
5081 method to specify the cursor you want to be displayed.
5082 """
554f62e9
RD		 5083 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5084 __repr__ = _swig_repr
5085 def __init__(self, *args, **kwargs):
5ba5649b
RD		 5086 """
5087 __init__(self, int x=0, int y=0) -> SetCursorEvent
5088
5089 Construct a new `wx.SetCursorEvent`.
5090 """
554f62e9 5091 _core_.SetCursorEvent_swiginit(self,_core_.new_SetCursorEvent(*args, **kwargs))
d55e5bfc 5092 def GetX(*args, **kwargs):
5ba5649b
RD		 5093 """
5094 GetX(self) -> int
5095
5096 Returns the X coordinate of the mouse in client coordinates.
5097 """
d55e5bfc
RD		 5098 return _core_.SetCursorEvent_GetX(*args, **kwargs)
5099
5100 def GetY(*args, **kwargs):
5ba5649b
RD		 5101 """
5102 GetY(self) -> int
5103
5104 Returns the Y coordinate of the mouse in client coordinates.
5105 """
d55e5bfc
RD		 5106 return _core_.SetCursorEvent_GetY(*args, **kwargs)
5107
5108 def SetCursor(*args, **kwargs):
5ba5649b
RD		 5109 """
5110 SetCursor(self, Cursor cursor)
5111
5112 Sets the cursor associated with this event.
5113 """
d55e5bfc
RD		 5114 return _core_.SetCursorEvent_SetCursor(*args, **kwargs)
5115
5116 def GetCursor(*args, **kwargs):
5ba5649b
RD		 5117 """
5118 GetCursor(self) -> Cursor
5119
5120 Returns a reference to the cursor specified by this event.
5121 """
d55e5bfc
RD		 5122 return _core_.SetCursorEvent_GetCursor(*args, **kwargs)
5123
5124 def HasCursor(*args, **kwargs):
5ba5649b
RD		 5125 """
5126 HasCursor(self) -> bool
5127
5128 Returns true if the cursor specified by this event is a valid cursor.
5129 """
d55e5bfc
RD		 5130 return _core_.SetCursorEvent_HasCursor(*args, **kwargs)
5131
33d6fd3b
RD		 5132 Cursor = property(GetCursor,SetCursor,doc="See `GetCursor` and `SetCursor`")
5133 X = property(GetX,doc="See `GetX`")
5134 Y = property(GetY,doc="See `GetY`")
2131d850 5135_core_.SetCursorEvent_swigregister(SetCursorEvent)
d55e5bfc
RD		 5136
5137#---------------------------------------------------------------------------
5138
5139class KeyEvent(Event):
5ba5649b
RD		 5140 """
5141 This event class contains information about keypress and character
5142 events. These events are only sent to the widget that currently has
5143 the keyboard focus.
5144
5145 Notice that there are three different kinds of keyboard events in
5146 wxWidgets: key down and up events and char events. The difference
5147 between the first two is clear - the first corresponds to a key press
5148 and the second to a key release - otherwise they are identical. Just
5149 note that if the key is maintained in a pressed state you will
5150 typically get a lot of (automatically generated) down events but only
5151 one up so it is wrong to assume that there is one up event
5152 corresponding to each down one.
5153
5154 Both key events provide untranslated key codes while the char event
5155 carries the translated one. The untranslated code for alphanumeric
5156 keys is always an upper case value. For the other keys it is one of
5157 WXK_XXX values from the keycodes table. The translated key is, in
5158 general, the character the user expects to appear as the result of the
5159 key combination when typing the text into a text entry zone, for
5160 example.
5161
5162 A few examples to clarify this (all assume that CAPS LOCK is unpressed
5163 and the standard US keyboard): when the 'A' key is pressed, the key
5164 down event key code is equal to ASCII A == 65. But the char event key
5165 code is ASCII a == 97. On the other hand, if you press both SHIFT and
5166 'A' keys simultaneously , the key code in key down event will still be
5167 just 'A' while the char event key code parameter will now be 'A' as
5168 well.
5169
5170 Although in this simple case it is clear that the correct key code
5171 could be found in the key down event handler by checking the value
5172 returned by `ShiftDown`, in general you should use EVT_CHAR for this
5173 as for non alphanumeric keys or non-US keyboard layouts the
5174 translation is keyboard-layout dependent and can only be done properly
5175 by the system itself.
5176
5177 Another kind of translation is done when the control key is pressed:
5178 for example, for CTRL-A key press the key down event still carries the
5179 same key code 'A' as usual but the char event will have key code of 1,
5180 the ASCII value of this key combination.
5181
5182 You may discover how the other keys on your system behave
5183 interactively by running the KeyEvents sample in the wxPython demo and
5184 pressing some keys while the blue box at the top has the keyboard
5185 focus.
5186
5187 **Note**: If a key down event is caught and the event handler does not
5188 call event.Skip() then the coresponding char event will not
5189 happen. This is by design and enables the programs that handle both
5190 types of events to be a bit simpler.
5191
5192 **Note for Windows programmers**: The key and char events in wxWidgets
5193 are similar to but slightly different from Windows WM_KEYDOWN and
5194 WM_CHAR events. In particular, Alt-x combination will generate a char
5195 event in wxWidgets (unless it is used as an accelerator).
5196
5197 **Tip**: be sure to call event.Skip() for events that you don't
5198 process in key event function, otherwise menu shortcuts may cease to
5199 work under Windows.
5200
5201 """
554f62e9
RD		 5202 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5203 __repr__ = _swig_repr
5204 def __init__(self, *args, **kwargs):
5ba5649b 5205 """
f460c29d 5206 __init__(self, EventType eventType=wxEVT_NULL) -> KeyEvent
5ba5649b
RD		 5207
5208 Construct a new `wx.KeyEvent`. Valid event types are:
5209 *
5210 """
554f62e9 5211 _core_.KeyEvent_swiginit(self,_core_.new_KeyEvent(*args, **kwargs))
b1fcee84
RD		 5212 def GetModifiers(*args, **kwargs):
5213 """
5214 GetModifiers(self) -> int
5215
5216 Returns a bitmask of the current modifier settings. Can be used to
5217 check if the key event has exactly the given modifiers without having
5218 to explicitly check that the other modifiers are not down. For
5219 example::
5220
5221 if event.GetModifers() == wx.MOD_CONTROL:
5222 DoSomething()
5223
5224 """
5225 return _core_.KeyEvent_GetModifiers(*args, **kwargs)
5226
d55e5bfc 5227 def ControlDown(*args, **kwargs):
5ba5649b
RD		 5228 """
5229 ControlDown(self) -> bool
5230
5231 Returns ``True`` if the Control key was down at the time of the event.
5232 """
d55e5bfc
RD		 5233 return _core_.KeyEvent_ControlDown(*args, **kwargs)
5234
5235 def MetaDown(*args, **kwargs):
5ba5649b
RD		 5236 """
5237 MetaDown(self) -> bool
5238
5239 Returns ``True`` if the Meta key was down at the time of the event.
5240 """
d55e5bfc
RD		 5241 return _core_.KeyEvent_MetaDown(*args, **kwargs)
5242
5243 def AltDown(*args, **kwargs):
5ba5649b
RD		 5244 """
5245 AltDown(self) -> bool
5246
5247 Returns ``True`` if the Alt key was down at the time of the event.
5248 """
d55e5bfc
RD		 5249 return _core_.KeyEvent_AltDown(*args, **kwargs)
5250
5251 def ShiftDown(*args, **kwargs):
5ba5649b
RD		 5252 """
5253 ShiftDown(self) -> bool
5254
5255 Returns ``True`` if the Shift key was down at the time of the event.
5256 """
d55e5bfc
RD		 5257 return _core_.KeyEvent_ShiftDown(*args, **kwargs)
5258
412d302d
RD		 5259 def CmdDown(*args, **kwargs):
5260 """
5261 CmdDown(self) -> bool
5262
5263 "Cmd" is a pseudo key which is the same as Control for PC and Unix
5264 platforms but the special "Apple" (a.k.a as "Command") key on
5ba5649b 5265 Macs. It makes often sense to use it instead of, say, `ControlDown`
412d302d
RD		 5266 because Cmd key is used for the same thing under Mac as Ctrl
5267 elsewhere. The Ctrl still exists, it's just not used for this
5268 purpose. So for non-Mac platforms this is the same as `ControlDown`
5269 and Macs this is the same as `MetaDown`.
5270 """
5271 return _core_.KeyEvent_CmdDown(*args, **kwargs)
5272
d55e5bfc 5273 def HasModifiers(*args, **kwargs):
5ba5649b
RD		 5274 """
5275 HasModifiers(self) -> bool
5276
5277 Returns true if either CTRL or ALT keys was down at the time of the
5278 key event. Note that this function does not take into account neither
5279 SHIFT nor META key states (the reason for ignoring the latter is that
5280 it is common for NUMLOCK key to be configured as META under X but the
5281 key presses even while NUMLOCK is on should be still processed
5282 normally).
5283 """
d55e5bfc
RD		 5284 return _core_.KeyEvent_HasModifiers(*args, **kwargs)
5285
5286 def GetKeyCode(*args, **kwargs):
5ba5649b
RD		 5287 """
5288 GetKeyCode(self) -> int
5289
5290 Returns the virtual key code. ASCII events return normal ASCII values,
5291 while non-ASCII events return values such as WXK_LEFT for the left
5292 cursor key. See `wx.KeyEvent` for a full list of the virtual key
5293 codes.
5294
5295 Note that in Unicode build, the returned value is meaningful only if
5296 the user entered a character that can be represented in current
5297 locale's default charset. You can obtain the corresponding Unicode
5298 character using `GetUnicodeKey`.
5299 """
d55e5bfc
RD		 5300 return _core_.KeyEvent_GetKeyCode(*args, **kwargs)
5301
19272049 5302 def GetUnicodeKey(*args, **kwargs):
5ba5649b
RD		 5303 """
5304 GetUnicodeKey(self) -> int
5305
5306 Returns the Unicode character corresponding to this key event. This
5307 function is only meaningfule in a Unicode build of wxPython.
5308 """
19272049 5309 return _core_.KeyEvent_GetUnicodeKey(*args, **kwargs)
d55e5bfc 5310
19272049 5311 GetUniChar = GetUnicodeKey
b850e7f3
RD		 5312 def SetUnicodeKey(*args, **kwargs):
5313 """
5314 SetUnicodeKey(self, int uniChar)
5315
5316 Set the Unicode value of the key event, but only if this is a Unicode
5317 build of wxPython.
5318 """
5319 return _core_.KeyEvent_SetUnicodeKey(*args, **kwargs)
5320
d55e5bfc 5321 def GetRawKeyCode(*args, **kwargs):
5ba5649b
RD		 5322 """
5323 GetRawKeyCode(self) -> unsigned int
5324
5325 Returns the raw key code for this event. This is a platform-dependent
5326 scan code which should only be used in advanced
5327 applications. Currently the raw key codes are not supported by all
5328 ports.
5329 """
d55e5bfc
RD		 5330 return _core_.KeyEvent_GetRawKeyCode(*args, **kwargs)
5331
5332 def GetRawKeyFlags(*args, **kwargs):
5ba5649b
RD		 5333 """
5334 GetRawKeyFlags(self) -> unsigned int
5335
5336 Returns the low level key flags for this event. The flags are
5337 platform-dependent and should only be used in advanced applications.
5338 Currently the raw key flags are not supported by all ports.
5339 """
d55e5bfc
RD		 5340 return _core_.KeyEvent_GetRawKeyFlags(*args, **kwargs)
5341
5342 def GetPosition(*args, **kwargs):
5343 """
5344 GetPosition(self) -> Point
5345
5ba5649b 5346 Find the position of the event, if applicable.
d55e5bfc
RD		 5347 """
5348 return _core_.KeyEvent_GetPosition(*args, **kwargs)
5349
5350 def GetPositionTuple(*args, **kwargs):
5351 """
5352 GetPositionTuple() -> (x,y)
5353
5ba5649b 5354 Find the position of the event, if applicable.
d55e5bfc
RD		 5355 """
5356 return _core_.KeyEvent_GetPositionTuple(*args, **kwargs)
5357
5358 def GetX(*args, **kwargs):
5ba5649b
RD		 5359 """
5360 GetX(self) -> int
5361
5362 Returns the X position (in client coordinates) of the event, if
5363 applicable.
5364 """
d55e5bfc
RD		 5365 return _core_.KeyEvent_GetX(*args, **kwargs)
5366
5367 def GetY(*args, **kwargs):
5ba5649b
RD		 5368 """
5369 GetY(self) -> int
5370
5371 Returns the Y position (in client coordinates) of the event, if
5372 applicable.
5373 """
d55e5bfc
RD		 5374 return _core_.KeyEvent_GetY(*args, **kwargs)
5375
5376 m_x = property(_core_.KeyEvent_m_x_get, _core_.KeyEvent_m_x_set)
5377 m_y = property(_core_.KeyEvent_m_y_get, _core_.KeyEvent_m_y_set)
5378 m_keyCode = property(_core_.KeyEvent_m_keyCode_get, _core_.KeyEvent_m_keyCode_set)
5379 m_controlDown = property(_core_.KeyEvent_m_controlDown_get, _core_.KeyEvent_m_controlDown_set)
5380 m_shiftDown = property(_core_.KeyEvent_m_shiftDown_get, _core_.KeyEvent_m_shiftDown_set)
5381 m_altDown = property(_core_.KeyEvent_m_altDown_get, _core_.KeyEvent_m_altDown_set)
5382 m_metaDown = property(_core_.KeyEvent_m_metaDown_get, _core_.KeyEvent_m_metaDown_set)
5383 m_scanCode = property(_core_.KeyEvent_m_scanCode_get, _core_.KeyEvent_m_scanCode_set)
5384 m_rawCode = property(_core_.KeyEvent_m_rawCode_get, _core_.KeyEvent_m_rawCode_set)
5385 m_rawFlags = property(_core_.KeyEvent_m_rawFlags_get, _core_.KeyEvent_m_rawFlags_set)
97ab0f6a
RD		 5386 KeyCode = property(GetKeyCode,doc="See `GetKeyCode`")
5387 Modifiers = property(GetModifiers,doc="See `GetModifiers`")
5388 Position = property(GetPosition,doc="See `GetPosition`")
5389 RawKeyCode = property(GetRawKeyCode,doc="See `GetRawKeyCode`")
5390 RawKeyFlags = property(GetRawKeyFlags,doc="See `GetRawKeyFlags`")
5391 UnicodeKey = property(GetUnicodeKey,SetUnicodeKey,doc="See `GetUnicodeKey` and `SetUnicodeKey`")
5392 X = property(GetX,doc="See `GetX`")
5393 Y = property(GetY,doc="See `GetY`")
2131d850 5394_core_.KeyEvent_swigregister(KeyEvent)
d55e5bfc
RD		 5395
5396#---------------------------------------------------------------------------
5397
5398class SizeEvent(Event):
5ba5649b
RD		 5399 """
5400 A size event holds information about size change events. The EVT_SIZE
5401 handler function will be called when the window it is bound to has
5402 been resized.
5403
5404 Note that the size passed is of the whole window: call
5405 `wx.Window.GetClientSize` for the area which may be used by the
5406 application.
5407
5408 When a window is resized, usually only a small part of the window is
5409 damaged and and that area is all that is in the update region for the
5410 next paint event. However, if your drawing depends on the size of the
5411 window, you may need to clear the DC explicitly and repaint the whole
5412 window. In which case, you may need to call `wx.Window.Refresh` to
5413 invalidate the entire window.
5414
5415 """
554f62e9
RD		 5416 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5417 __repr__ = _swig_repr
5418 def __init__(self, *args, **kwargs):
5ba5649b
RD		 5419 """
5420 __init__(self, Size sz=DefaultSize, int winid=0) -> SizeEvent
5421
5422 Construct a new ``wx.SizeEvent``.
5423 """
554f62e9 5424 _core_.SizeEvent_swiginit(self,_core_.new_SizeEvent(*args, **kwargs))
d55e5bfc 5425 def GetSize(*args, **kwargs):
5ba5649b
RD		 5426 """
5427 GetSize(self) -> Size
5428
5429 Returns the entire size of the window generating the size change
5430 event.
5431 """
d55e5bfc
RD		 5432 return _core_.SizeEvent_GetSize(*args, **kwargs)
5433
5434 def GetRect(*args, **kwargs):
5435 """GetRect(self) -> Rect"""
5436 return _core_.SizeEvent_GetRect(*args, **kwargs)
5437
5438 def SetRect(*args, **kwargs):
5439 """SetRect(self, Rect rect)"""
5440 return _core_.SizeEvent_SetRect(*args, **kwargs)
5441
5442 def SetSize(*args, **kwargs):
5443 """SetSize(self, Size size)"""
5444 return _core_.SizeEvent_SetSize(*args, **kwargs)
5445
5446 m_size = property(_core_.SizeEvent_m_size_get, _core_.SizeEvent_m_size_set)
5447 m_rect = property(_core_.SizeEvent_m_rect_get, _core_.SizeEvent_m_rect_set)
33d6fd3b
RD		 5448 Rect = property(GetRect,SetRect,doc="See `GetRect` and `SetRect`")
5449 Size = property(GetSize,SetSize,doc="See `GetSize` and `SetSize`")
2131d850 5450_core_.SizeEvent_swigregister(SizeEvent)
d55e5bfc
RD		 5451
5452#---------------------------------------------------------------------------
5453
5454class MoveEvent(Event):
5ba5649b
RD		 5455 """
5456 This event object is sent for EVT_MOVE event bindings when a window is
5457 moved to a new position.
5458 """
554f62e9
RD		 5459 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5460 __repr__ = _swig_repr
5461 def __init__(self, *args, **kwargs):
5ba5649b
RD		 5462 """
5463 __init__(self, Point pos=DefaultPosition, int winid=0) -> MoveEvent
5464
5465 Constructor.
5466 """
554f62e9 5467 _core_.MoveEvent_swiginit(self,_core_.new_MoveEvent(*args, **kwargs))
d55e5bfc 5468 def GetPosition(*args, **kwargs):
5ba5649b
RD		 5469 """
5470 GetPosition(self) -> Point
5471
5472 Returns the position of the window generating the move change event.
5473 """
d55e5bfc
RD		 5474 return _core_.MoveEvent_GetPosition(*args, **kwargs)
5475
5476 def GetRect(*args, **kwargs):
5477 """GetRect(self) -> Rect"""
5478 return _core_.MoveEvent_GetRect(*args, **kwargs)
5479
5480 def SetRect(*args, **kwargs):
5481 """SetRect(self, Rect rect)"""
5482 return _core_.MoveEvent_SetRect(*args, **kwargs)
5483
5484 def SetPosition(*args, **kwargs):
5485 """SetPosition(self, Point pos)"""
5486 return _core_.MoveEvent_SetPosition(*args, **kwargs)
5487
fef4c27a
RD		 5488 m_pos = property(GetPosition, SetPosition)
5489 m_rect = property(GetRect, SetRect)
5490
57332a5a
RD		 5491 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
5492 Rect = property(GetRect,SetRect,doc="See `GetRect` and `SetRect`")
2131d850 5493_core_.MoveEvent_swigregister(MoveEvent)
d55e5bfc
RD		 5494
5495#---------------------------------------------------------------------------
5496
5497class PaintEvent(Event):
5ba5649b
RD		 5498 """
5499 A paint event is sent when a window's contents needs to be repainted.
5500 Note that in an EVT_PAINT handler the application must *always* create
5501 a `wx.PaintDC` object, even if you do not use it. Otherwise MS
5502 Windows assumes that the window has not been painted yet and will send
5503 the event again, causing endless refreshes.
5504
5505 You can optimize painting by retrieving the rectangles that have been
5506 damaged using `wx.Window.GetUpdateRegion` and/or `wx.RegionIterator`,
5507 and only repainting these rectangles. The rectangles are in terms of
5508 the client area, and are unscrolled, so you will need to do some
5509 calculations using the current view position to obtain logical,
5510 scrolled units.
5511
5512 """
554f62e9
RD		 5513 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5514 __repr__ = _swig_repr
5515 def __init__(self, *args, **kwargs):
d55e5bfc 5516 """__init__(self, int Id=0) -> PaintEvent"""
554f62e9 5517 _core_.PaintEvent_swiginit(self,_core_.new_PaintEvent(*args, **kwargs))
2131d850 5518_core_.PaintEvent_swigregister(PaintEvent)
d55e5bfc
RD		 5519
5520class NcPaintEvent(Event):
093d3ff1 5521 """Proxy of C++ NcPaintEvent class"""
554f62e9
RD		 5522 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5523 __repr__ = _swig_repr
5524 def __init__(self, *args, **kwargs):
d55e5bfc 5525 """__init__(self, int winid=0) -> NcPaintEvent"""
554f62e9 5526 _core_.NcPaintEvent_swiginit(self,_core_.new_NcPaintEvent(*args, **kwargs))
2131d850 5527_core_.NcPaintEvent_swigregister(NcPaintEvent)
d55e5bfc
RD		 5528
5529#---------------------------------------------------------------------------
5530
5531class EraseEvent(Event):
5ba5649b
RD		 5532 """
5533 An erase event is sent whenever the background of a window needs to be
5534 repainted. To intercept this event use the EVT_ERASE_BACKGROUND event
5535 binder. On some platforms, such as GTK+, this event is simulated
5536 (simply generated just before the paint event) and may cause flicker.
5537
5538 To paint a custom background use the `GetDC` method and use the returned
5539 device context if it is not ``None``, otherwise create a temporary
5540 `wx.ClientDC` and draw on that.
5541
5542 """
554f62e9
RD		 5543 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5544 __repr__ = _swig_repr
5545 def __init__(self, *args, **kwargs):
5ba5649b
RD		 5546 """
5547 __init__(self, int Id=0, DC dc=None) -> EraseEvent
5548
5549 Constructor
5550 """
554f62e9 5551 _core_.EraseEvent_swiginit(self,_core_.new_EraseEvent(*args, **kwargs))
d55e5bfc 5552 def GetDC(*args, **kwargs):
5ba5649b
RD		 5553 """
5554 GetDC(self) -> DC
5555
5556 Returns the device context the event handler should draw upon. If
5557 ``None`` is returned then create a temporary `wx.ClientDC` and use
5558 that instead.
5559 """
d55e5bfc
RD		 5560 return _core_.EraseEvent_GetDC(*args, **kwargs)
5561
97ab0f6a 5562 DC = property(GetDC,doc="See `GetDC`")
2131d850 5563_core_.EraseEvent_swigregister(EraseEvent)
d55e5bfc
RD		 5564
5565#---------------------------------------------------------------------------
5566
5567class FocusEvent(Event):
5ba5649b
RD		 5568 """
5569 A focus event is sent when a window's focus changes. The window losing
5570 focus receives an EVT_KILL_FOCUS event while the window gaining it
5571 gets an EVT_SET_FOCUS event.
5572
5573 Notice that the set focus event happens both when the user gives focus
5574 to the window (whether using the mouse or keyboard) and when it is
5575 done from the program itself using `wx.Window.SetFocus`.
5576
5577 """
554f62e9
RD		 5578 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5579 __repr__ = _swig_repr
5580 def __init__(self, *args, **kwargs):
5ba5649b 5581 """
f460c29d 5582 __init__(self, EventType type=wxEVT_NULL, int winid=0) -> FocusEvent
5ba5649b
RD		 5583
5584 Constructor
5585 """
554f62e9 5586 _core_.FocusEvent_swiginit(self,_core_.new_FocusEvent(*args, **kwargs))
d55e5bfc 5587 def GetWindow(*args, **kwargs):
5ba5649b
RD		 5588 """
5589 GetWindow(self) -> Window
5590
5591 Returns the other window associated with this event, that is the
5592 window which had the focus before for the EVT_SET_FOCUS event and the
5593 window which is going to receive focus for the wxEVT_KILL_FOCUS event.
5594
5595 Warning: the window returned may be None!
5596 """
d55e5bfc
RD		 5597 return _core_.FocusEvent_GetWindow(*args, **kwargs)
5598
5599 def SetWindow(*args, **kwargs):
5600 """SetWindow(self, Window win)"""
5601 return _core_.FocusEvent_SetWindow(*args, **kwargs)
5602
97ab0f6a 5603 Window = property(GetWindow,SetWindow,doc="See `GetWindow` and `SetWindow`")
2131d850 5604_core_.FocusEvent_swigregister(FocusEvent)
d55e5bfc
RD		 5605
5606#---------------------------------------------------------------------------
5607
5608class ChildFocusEvent(CommandEvent):
5ba5649b 5609 """
33d6fd3b
RD		 5610 A child focus event is sent to a (parent-)window when one of its child
5611 windows gains focus, so that the window could restore the focus back
5612 to its corresponding child if it loses it now and regains later.
5613
5614 Notice that child window is the direct child of the window receiving
5615 the event, and so may not be the actual widget recieving focus if it
5616 is further down the containment heirarchy. Use `wx.Window.FindFocus`
5617 to get the widget that is actually receiving focus.
5ba5649b 5618 """
554f62e9
RD		 5619 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5620 __repr__ = _swig_repr
5621 def __init__(self, *args, **kwargs):
5ba5649b
RD		 5622 """
5623 __init__(self, Window win=None) -> ChildFocusEvent
5624
5625 Constructor
5626 """
554f62e9 5627 _core_.ChildFocusEvent_swiginit(self,_core_.new_ChildFocusEvent(*args, **kwargs))
d55e5bfc 5628 def GetWindow(*args, **kwargs):
5ba5649b
RD		 5629 """
5630 GetWindow(self) -> Window
5631
33d6fd3b
RD		 5632 The window, or (grand)parent of the window which has just received the
5633 focus.
5ba5649b 5634 """
d55e5bfc
RD		 5635 return _core_.ChildFocusEvent_GetWindow(*args, **kwargs)
5636
226118fc 5637 Window = property(GetWindow,doc="See `GetWindow`")
2131d850 5638_core_.ChildFocusEvent_swigregister(ChildFocusEvent)
d55e5bfc
RD		 5639
5640#---------------------------------------------------------------------------
5641
5642class ActivateEvent(Event):
5ba5649b
RD		 5643 """
5644 An activate event is sent when a top-level window or the entire
5645 application is being activated or deactivated.
5646
5647 A top-level window (a dialog or frame) receives an activate event when
5648 is being activated or deactivated. This is indicated visually by the
5649 title bar changing colour, and a subwindow gaining the keyboard focus.
5650 An application is activated or deactivated when one of its frames
5651 becomes activated, or a frame becomes inactivate resulting in all
5652 application frames being inactive.
5653
5654 Please note that usually you should call event.Skip() in your handlers
5655 for these events so the default handlers will still be called, as not
5656 doing so can result in strange effects.
5657
5658 """
554f62e9
RD		 5659 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5660 __repr__ = _swig_repr
5661 def __init__(self, *args, **kwargs):
5ba5649b 5662 """
f460c29d 5663 __init__(self, EventType type=wxEVT_NULL, bool active=True, int Id=0) -> ActivateEvent
5ba5649b
RD		 5664
5665 Constructor
5666 """
554f62e9 5667 _core_.ActivateEvent_swiginit(self,_core_.new_ActivateEvent(*args, **kwargs))
d55e5bfc 5668 def GetActive(*args, **kwargs):
5ba5649b
RD		 5669 """
5670 GetActive(self) -> bool
5671
5672 Returns true if the application or window is being activated, false
5673 otherwise.
5674 """
d55e5bfc
RD		 5675 return _core_.ActivateEvent_GetActive(*args, **kwargs)
5676
226118fc 5677 Active = property(GetActive,doc="See `GetActive`")
2131d850 5678_core_.ActivateEvent_swigregister(ActivateEvent)
d55e5bfc
RD		 5679
5680#---------------------------------------------------------------------------
5681
5682class InitDialogEvent(Event):
5ba5649b
RD		 5683 """
5684 A wx.InitDialogEvent is sent as a dialog is being initialised, or for
5685 any window when `wx.Window.InitDialog` is called. Handlers for this
5686 event can transfer data to the window, or anything else that should be
5687 done before the user begins editing the form. The default handler
5688 calls `wx.Window.TransferDataToWindow`.
5689 """
554f62e9
RD		 5690 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5691 __repr__ = _swig_repr
5692 def __init__(self, *args, **kwargs):
5ba5649b
RD		 5693 """
5694 __init__(self, int Id=0) -> InitDialogEvent
5695
5696 Constructor
5697 """
554f62e9 5698 _core_.InitDialogEvent_swiginit(self,_core_.new_InitDialogEvent(*args, **kwargs))
2131d850 5699_core_.InitDialogEvent_swigregister(InitDialogEvent)
d55e5bfc
RD		 5700
5701#---------------------------------------------------------------------------
5702
5703class MenuEvent(Event):
5ba5649b
RD		 5704 """
5705 This class is used for a variety of menu-related events. Note that
5706 these do not include menu command events, which are handled by sending
5707 `wx.CommandEvent` objects.
5708
5709 The default handler for wx.EVT_MENU_HIGHLIGHT displays menu item help
5710 text in the first field of the status bar.
5711 """
554f62e9
RD		 5712 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5713 __repr__ = _swig_repr
5714 def __init__(self, *args, **kwargs):
5ba5649b 5715 """
f460c29d 5716 __init__(self, EventType type=wxEVT_NULL, int winid=0, Menu menu=None) -> MenuEvent
5ba5649b
RD		 5717
5718 Constructor
5719 """
554f62e9 5720 _core_.MenuEvent_swiginit(self,_core_.new_MenuEvent(*args, **kwargs))
d55e5bfc 5721 def GetMenuId(*args, **kwargs):
5ba5649b
RD		 5722 """
5723 GetMenuId(self) -> int
5724
5725 Returns the menu identifier associated with the event. This method
5726 should be only used with the HIGHLIGHT events.
5727 """
d55e5bfc
RD		 5728 return _core_.MenuEvent_GetMenuId(*args, **kwargs)
5729
5730 def IsPopup(*args, **kwargs):
5ba5649b
RD		 5731 """
5732 IsPopup(self) -> bool
5733
5734 Returns ``True`` if the menu which is being opened or closed is a
5735 popup menu, ``False`` if it is a normal one. This method should only
5736 be used with the OPEN and CLOSE events.
5737 """
d55e5bfc
RD		 5738 return _core_.MenuEvent_IsPopup(*args, **kwargs)
5739
5740 def GetMenu(*args, **kwargs):
5ba5649b
RD		 5741 """
5742 GetMenu(self) -> Menu
5743
5744 Returns the menu which is being opened or closed. This method should
5745 only be used with the OPEN and CLOSE events.
5746 """
d55e5bfc
RD		 5747 return _core_.MenuEvent_GetMenu(*args, **kwargs)
5748
57332a5a
RD		 5749 Menu = property(GetMenu,doc="See `GetMenu`")
5750 MenuId = property(GetMenuId,doc="See `GetMenuId`")
2131d850 5751_core_.MenuEvent_swigregister(MenuEvent)
d55e5bfc
RD		 5752
5753#---------------------------------------------------------------------------
5754
5755class CloseEvent(Event):
5ba5649b
RD		 5756 """
5757 This event class contains information about window and session close
5758 events.
5759
5760 The handler function for EVT_CLOSE is called when the user has tried
5761 to close a a frame or dialog box using the window manager controls or
5762 the system menu. It can also be invoked by the application itself
5763 programmatically, for example by calling the `wx.Window.Close`
5764 function.
5765
5766 You should check whether the application is forcing the deletion of
5767 the window using `CanVeto`. If it returns ``False``, you must destroy
5768 the window using `wx.Window.Destroy`. If the return value is ``True``,
5769 it is up to you whether you respond by destroying the window or not.
5770 For example you may wish to display a message dialog prompting to save
5771 files or to cancel the close.
5772
5773 If you don't destroy the window, you should call `Veto` to let the
5774 calling code know that you did not destroy the window. This allows the
5775 `wx.Window.Close` function to return ``True`` or ``False`` depending
5776 on whether the close instruction was honored or not.
5777 """
554f62e9
RD		 5778 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5779 __repr__ = _swig_repr
5780 def __init__(self, *args, **kwargs):
5ba5649b 5781 """
f460c29d 5782 __init__(self, EventType type=wxEVT_NULL, int winid=0) -> CloseEvent
5ba5649b
RD		 5783
5784 Constructor.
5785 """
554f62e9 5786 _core_.CloseEvent_swiginit(self,_core_.new_CloseEvent(*args, **kwargs))
d55e5bfc 5787 def SetLoggingOff(*args, **kwargs):
5ba5649b
RD		 5788 """
5789 SetLoggingOff(self, bool logOff)
5790
5791 Sets the 'logging off' flag.
5792 """
d55e5bfc
RD		 5793 return _core_.CloseEvent_SetLoggingOff(*args, **kwargs)
5794
5795 def GetLoggingOff(*args, **kwargs):
5ba5649b
RD		 5796 """
5797 GetLoggingOff(self) -> bool
5798
034e3677
RD		 5799 Returns ``True`` if the user is logging off or ``False`` if the
5800 system is shutting down. This method can only be called for end
5801 session and query end session events, it doesn't make sense for close
5802 window event.
5ba5649b 5803 """
d55e5bfc
RD		 5804 return _core_.CloseEvent_GetLoggingOff(*args, **kwargs)
5805
5806 def Veto(*args, **kwargs):
5ba5649b
RD		 5807 """
5808 Veto(self, bool veto=True)
5809
5810 Call this from your event handler to veto a system shutdown or to
5811 signal to the calling application that a window close did not happen.
5812
5813 You can only veto a shutdown or close if `CanVeto` returns true.
5814 """
d55e5bfc
RD		 5815 return _core_.CloseEvent_Veto(*args, **kwargs)
5816
5ba5649b
RD		 5817 def GetVeto(*args, **kwargs):
5818 """GetVeto(self) -> bool"""
5819 return _core_.CloseEvent_GetVeto(*args, **kwargs)
5820
d55e5bfc 5821 def SetCanVeto(*args, **kwargs):
5ba5649b
RD		 5822 """
5823 SetCanVeto(self, bool canVeto)
5824
5825 Sets the 'can veto' flag.
5826 """
d55e5bfc
RD		 5827 return _core_.CloseEvent_SetCanVeto(*args, **kwargs)
5828
5829 def CanVeto(*args, **kwargs):
5ba5649b
RD		 5830 """
5831 CanVeto(self) -> bool
d55e5bfc 5832
5ba5649b
RD		 5833 Returns true if you can veto a system shutdown or a window close
5834 event. Vetoing a window close event is not possible if the calling
5835 code wishes to force the application to exit, and so this function
5836 must be called to check this.
5837 """
5838 return _core_.CloseEvent_CanVeto(*args, **kwargs)
d55e5bfc 5839
226118fc 5840 LoggingOff = property(GetLoggingOff,SetLoggingOff,doc="See `GetLoggingOff` and `SetLoggingOff`")
2131d850 5841_core_.CloseEvent_swigregister(CloseEvent)
d55e5bfc
RD		 5842
5843#---------------------------------------------------------------------------
5844
5845class ShowEvent(Event):
5ba5649b 5846 """An EVT_SHOW event is sent when a window is shown or hidden."""
554f62e9
RD		 5847 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5848 __repr__ = _swig_repr
5849 def __init__(self, *args, **kwargs):
5ba5649b
RD		 5850 """
5851 __init__(self, int winid=0, bool show=False) -> ShowEvent
5852
5853 An EVT_SHOW event is sent when a window is shown or hidden.
5854 """
554f62e9 5855 _core_.ShowEvent_swiginit(self,_core_.new_ShowEvent(*args, **kwargs))
d55e5bfc
RD		 5856 def SetShow(*args, **kwargs):
5857 """SetShow(self, bool show)"""
5858 return _core_.ShowEvent_SetShow(*args, **kwargs)
5859
5860 def GetShow(*args, **kwargs):
5861 """GetShow(self) -> bool"""
5862 return _core_.ShowEvent_GetShow(*args, **kwargs)
5863
33d6fd3b 5864 Show = property(GetShow,SetShow,doc="See `GetShow` and `SetShow`")
2131d850 5865_core_.ShowEvent_swigregister(ShowEvent)
d55e5bfc
RD		 5866
5867#---------------------------------------------------------------------------
5868
5869class IconizeEvent(Event):
5ba5649b
RD		 5870 """
5871 An EVT_ICONIZE event is sent when a frame is iconized (minimized) or
5872 restored.
5873 """
554f62e9
RD		 5874 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5875 __repr__ = _swig_repr
5876 def __init__(self, *args, **kwargs):
5ba5649b
RD		 5877 """
5878 __init__(self, int id=0, bool iconized=True) -> IconizeEvent
5879
5880 An EVT_ICONIZE event is sent when a frame is iconized (minimized) or
5881 restored.
5882 """
554f62e9 5883 _core_.IconizeEvent_swiginit(self,_core_.new_IconizeEvent(*args, **kwargs))
d55e5bfc 5884 def Iconized(*args, **kwargs):
5ba5649b
RD		 5885 """
5886 Iconized(self) -> bool
5887
5888 Returns ``True`` if the frame has been iconized, ``False`` if it has
5889 been restored.
5890 """
d55e5bfc
RD		 5891 return _core_.IconizeEvent_Iconized(*args, **kwargs)
5892
2131d850 5893_core_.IconizeEvent_swigregister(IconizeEvent)
d55e5bfc
RD		 5894
5895#---------------------------------------------------------------------------
5896
5897class MaximizeEvent(Event):
5ba5649b 5898 """An EVT_MAXIMIZE event is sent when a frame is maximized or restored."""
554f62e9
RD		 5899 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5900 __repr__ = _swig_repr
5901 def __init__(self, *args, **kwargs):
5ba5649b
RD		 5902 """
5903 __init__(self, int id=0) -> MaximizeEvent
5904
5905 An EVT_MAXIMIZE event is sent when a frame is maximized or restored.
5906 """
554f62e9 5907 _core_.MaximizeEvent_swiginit(self,_core_.new_MaximizeEvent(*args, **kwargs))
2131d850 5908_core_.MaximizeEvent_swigregister(MaximizeEvent)
d55e5bfc
RD		 5909
5910#---------------------------------------------------------------------------
5911
5912class DropFilesEvent(Event):
5ba5649b
RD		 5913 """
5914 This class is used for drop files events, that is, when files have
5915 been dropped onto the window. This functionality is only available
5916 under Windows. The window must have previously been enabled for
5917 dropping by calling `wx.Window.DragAcceptFiles`.
5918
5919 Important note: this is a separate implementation to the more general
5920 drag and drop implementation using `wx.FileDropTarget`, and etc. This
5921 implementation uses the older, Windows message-based approach of
5922 dropping files.
5923
5924 Use wx.EVT_DROP_FILES to bind an event handler to receive file drop
5925 events.
5926
5927 """
554f62e9
RD		 5928 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5929 def __init__(self): raise AttributeError, "No constructor defined"
5930 __repr__ = _swig_repr
d55e5bfc 5931 def GetPosition(*args, **kwargs):
5ba5649b
RD		 5932 """
5933 GetPosition(self) -> Point
5934
5935 Returns the position at which the files were dropped.
5936 """
d55e5bfc
RD		 5937 return _core_.DropFilesEvent_GetPosition(*args, **kwargs)
5938
5939 def GetNumberOfFiles(*args, **kwargs):
5ba5649b
RD		 5940 """
5941 GetNumberOfFiles(self) -> int
5942
5943 Returns the number of files dropped.
5944 """
d55e5bfc
RD		 5945 return _core_.DropFilesEvent_GetNumberOfFiles(*args, **kwargs)
5946
5947 def GetFiles(*args, **kwargs):
5ba5649b
RD		 5948 """
5949 GetFiles(self) -> PyObject
5950
5951 Returns a list of the filenames that were dropped.
5952 """
d55e5bfc
RD		 5953 return _core_.DropFilesEvent_GetFiles(*args, **kwargs)
5954
226118fc
RD		 5955 Files = property(GetFiles,doc="See `GetFiles`")
5956 NumberOfFiles = property(GetNumberOfFiles,doc="See `GetNumberOfFiles`")
5957 Position = property(GetPosition,doc="See `GetPosition`")
2131d850 5958_core_.DropFilesEvent_swigregister(DropFilesEvent)
d55e5bfc
RD		 5959
5960#---------------------------------------------------------------------------
5961
5962UPDATE_UI_PROCESS_ALL = _core_.UPDATE_UI_PROCESS_ALL
5963UPDATE_UI_PROCESS_SPECIFIED = _core_.UPDATE_UI_PROCESS_SPECIFIED
5964class UpdateUIEvent(CommandEvent):
5ba5649b
RD		 5965 """
5966 This class is used for EVT_UPDATE_UI pseudo-events which are sent by
5967 wxWidgets to give an application the chance to update various user
5968 interface elements.
5969
5970 Without update UI events, an application has to work hard to
5971 check/uncheck, enable/disable, and set the text for elements such as
5972 menu items and toolbar buttons. The code for doing this has to be
5973 mixed up with the code that is invoked when an action is invoked for a
5974 menu item or button.
5975
5976 With update UI events, you define an event handler to look at the
5977 state of the application and change UI elements accordingly. wxWidgets
5978 will call your handler functions in idle time, so you don't have to
5979 worry where to call this code. In addition to being a clearer and more
5980 declarative method, it also means you don't have to worry whether
5981 you're updating a toolbar or menubar identifier. The same handler can
5982 update a menu item and toolbar button, if the ID values are the same.
5983
5984 Instead of directly manipulating the menu or button, you call
5985 functions in the event object, such as `Check`. wxWidgets will
5986 determine whether such a call has been made, and which UI element to
5987 update.
5988
5989 These events will work for popup menus as well as menubars. Just
5990 before a menu is popped up, `wx.Menu.UpdateUI` is called to process
5991 any UI events for the window that owns the menu.
5992
5993 If you find that the overhead of UI update processing is affecting
5994 your application, you can do one or both of the following:
5995
5996 1. Call `wx.UpdateUIEvent.SetMode` with a value of
5997 wx.UPDATE_UI_PROCESS_SPECIFIED, and set the extra style
5998 wx.WS_EX_PROCESS_UPDATE_EVENTS for every window that should
5999 receive update events. No other windows will receive update
6000 events.
6001
6002 2. Call `wx.UpdateUIEvent.SetUpdateInterval` with a millisecond
6003 value to set the delay between updates. You may need to call
6004 `wx.Window.UpdateWindowUI` at critical points, for example when
6005 a dialog is about to be shown, in case the user sees a slight
6006 delay before windows are updated.
6007
6008 Note that although events are sent in idle time, defining a EVT_IDLE
6009 handler for a window does not affect this because the events are sent
6010 from an internal idle handler.
6011
6012 wxWidgets tries to optimize update events on some platforms. On
6013 Windows and GTK+, events for menubar items are only sent when the menu
6014 is about to be shown, and not in idle time.
6015
6016 """
554f62e9
RD		 6017 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6018 __repr__ = _swig_repr
6019 def __init__(self, *args, **kwargs):
5ba5649b
RD		 6020 """
6021 __init__(self, int commandId=0) -> UpdateUIEvent
6022
6023 Constructor
6024 """
554f62e9 6025 _core_.UpdateUIEvent_swiginit(self,_core_.new_UpdateUIEvent(*args, **kwargs))
d55e5bfc 6026 def GetChecked(*args, **kwargs):
5ba5649b
RD		 6027 """
6028 GetChecked(self) -> bool
6029
6030 Returns ``True`` if the UI element should be checked.
6031 """
d55e5bfc
RD		 6032 return _core_.UpdateUIEvent_GetChecked(*args, **kwargs)
6033
6034 def GetEnabled(*args, **kwargs):
5ba5649b
RD		 6035 """
6036 GetEnabled(self) -> bool
6037
6038 Returns ``True`` if the UI element should be enabled.
6039 """
d55e5bfc
RD		 6040 return _core_.UpdateUIEvent_GetEnabled(*args, **kwargs)
6041
554f62e9
RD		 6042 def GetShown(*args, **kwargs):
6043 """
6044 GetShown(self) -> bool
6045
6046 Returns ``True`` if the UI element should be shown.
6047 """
6048 return _core_.UpdateUIEvent_GetShown(*args, **kwargs)
6049
d55e5bfc 6050 def GetText(*args, **kwargs):
5ba5649b
RD		 6051 """
6052 GetText(self) -> String
6053
6054 Returns the text that should be set for the UI element.
6055 """
d55e5bfc
RD		 6056 return _core_.UpdateUIEvent_GetText(*args, **kwargs)
6057
6058 def GetSetText(*args, **kwargs):
5ba5649b
RD		 6059 """
6060 GetSetText(self) -> bool
6061
6062 Returns ``True`` if the application has called `SetText`. For
6063 wxWidgets internal use only.
6064 """
d55e5bfc
RD		 6065 return _core_.UpdateUIEvent_GetSetText(*args, **kwargs)
6066
6067 def GetSetChecked(*args, **kwargs):
5ba5649b
RD		 6068 """
6069 GetSetChecked(self) -> bool
6070
6071 Returns ``True`` if the application has called `Check`. For wxWidgets
6072 internal use only.
6073 """
d55e5bfc
RD		 6074 return _core_.UpdateUIEvent_GetSetChecked(*args, **kwargs)
6075
6076 def GetSetEnabled(*args, **kwargs):
5ba5649b
RD		 6077 """
6078 GetSetEnabled(self) -> bool
6079
6080 Returns ``True`` if the application has called `Enable`. For wxWidgets
6081 internal use only.
6082 """
d55e5bfc
RD		 6083 return _core_.UpdateUIEvent_GetSetEnabled(*args, **kwargs)
6084
554f62e9
RD		 6085 def GetSetShown(*args, **kwargs):
6086 """
6087 GetSetShown(self) -> bool
6088
6089 Returns ``True`` if the application has called `Show`. For wxWidgets
6090 internal use only.
6091 """
6092 return _core_.UpdateUIEvent_GetSetShown(*args, **kwargs)
6093
d55e5bfc 6094 def Check(*args, **kwargs):
5ba5649b
RD		 6095 """
6096 Check(self, bool check)
6097
6098 Check or uncheck the UI element.
6099 """
d55e5bfc
RD		 6100 return _core_.UpdateUIEvent_Check(*args, **kwargs)
6101
6102 def Enable(*args, **kwargs):
5ba5649b
RD		 6103 """
6104 Enable(self, bool enable)
6105
6106 Enable or disable the UI element.
6107 """
d55e5bfc
RD		 6108 return _core_.UpdateUIEvent_Enable(*args, **kwargs)
6109
554f62e9
RD		 6110 def Show(*args, **kwargs):
6111 """
6112 Show(self, bool show)
6113
6114 Show or hide the UI element.
6115 """
6116 return _core_.UpdateUIEvent_Show(*args, **kwargs)
6117
d55e5bfc 6118 def SetText(*args, **kwargs):
5ba5649b
RD		 6119 """
6120 SetText(self, String text)
6121
6122 Sets the text for this UI element.
6123 """
d55e5bfc
RD		 6124 return _core_.UpdateUIEvent_SetText(*args, **kwargs)
6125
6126 def SetUpdateInterval(*args, **kwargs):
5ba5649b
RD		 6127 """
6128 SetUpdateInterval(long updateInterval)
6129
6130 Sets the interval between updates in milliseconds. Set to -1 to
6131 disable updates, or to 0 to update as frequently as possible. The
6132 default is 0.
6133
6134 Use this to reduce the overhead of UI update events if your
6135 application has a lot of windows. If you set the value to -1 or
6136 greater than 0, you may also need to call `wx.Window.UpdateWindowUI`
6137 at appropriate points in your application, such as when a dialog is
6138 about to be shown.
6139 """
d55e5bfc
RD		 6140 return _core_.UpdateUIEvent_SetUpdateInterval(*args, **kwargs)
6141
6142 SetUpdateInterval = staticmethod(SetUpdateInterval)
6143 def GetUpdateInterval(*args, **kwargs):
5ba5649b
RD		 6144 """
6145 GetUpdateInterval() -> long
6146
6147 Returns the current interval between updates in milliseconds. -1
6148 disables updates, 0 updates as frequently as possible.
6149 """
d55e5bfc
RD		 6150 return _core_.UpdateUIEvent_GetUpdateInterval(*args, **kwargs)
6151
6152 GetUpdateInterval = staticmethod(GetUpdateInterval)
6153 def CanUpdate(*args, **kwargs):
5ba5649b
RD		 6154 """
6155 CanUpdate(Window win) -> bool
6156
6157 Returns ``True`` if it is appropriate to update (send UI update events
6158 to) this window.
6159
6160 This function looks at the mode used (see `wx.UpdateUIEvent.SetMode`),
6161 the wx.WS_EX_PROCESS_UPDATE_EVENTS flag in window, the time update
6162 events were last sent in idle time, and the update interval, to
6163 determine whether events should be sent to this window now. By default
6164 this will always return true because the update mode is initially
6165 wx.UPDATE_UI_PROCESS_ALL and the interval is set to 0; so update
6166 events will be sent as often as possible. You can reduce the frequency
6167 that events are sent by changing the mode and/or setting an update
6168 interval.
6169
6170 """
d55e5bfc
RD		 6171 return _core_.UpdateUIEvent_CanUpdate(*args, **kwargs)
6172
6173 CanUpdate = staticmethod(CanUpdate)
6174 def ResetUpdateTime(*args, **kwargs):
5ba5649b
RD		 6175 """
6176 ResetUpdateTime()
6177
6178 Used internally to reset the last-updated time to the current time. It
6179 is assumed that update events are normally sent in idle time, so this
6180 is called at the end of idle processing.
6181 """
d55e5bfc
RD		 6182 return _core_.UpdateUIEvent_ResetUpdateTime(*args, **kwargs)
6183
6184 ResetUpdateTime = staticmethod(ResetUpdateTime)
6185 def SetMode(*args, **kwargs):
5ba5649b
RD		 6186 """
6187 SetMode(int mode)
6188
6189 Specify how wxWidgets will send update events: to all windows, or only
6190 to those which specify that they will process the events.
6191
6192 The mode may be one of the following values:
6193
6194 ============================= ==========================================
6195 wxUPDATE_UI_PROCESS_ALL Send UI update events to all windows. This
6196 is the default setting.
6197 wxUPDATE_UI_PROCESS_SPECIFIED Send UI update events only to windows that
6198 have the wx.WS_EX_PROCESS_UI_UPDATES extra
6199 style set.
6200 ============================= ==========================================
6201
6202 """
d55e5bfc
RD		 6203 return _core_.UpdateUIEvent_SetMode(*args, **kwargs)
6204
6205 SetMode = staticmethod(SetMode)
6206 def GetMode(*args, **kwargs):
5ba5649b
RD		 6207 """
6208 GetMode() -> int
6209
6210 Returns a value specifying how wxWidgets will send update events: to
6211 all windows, or only to those which specify that they will process the
6212 events.
6213 """
d55e5bfc
RD		 6214 return _core_.UpdateUIEvent_GetMode(*args, **kwargs)
6215
6216 GetMode = staticmethod(GetMode)
dba7934c
RD		 6217 Checked = property(GetChecked,Check,doc="See `GetChecked`")
6218 Enabled = property(GetEnabled,Enable,doc="See `GetEnabled`")
6219 Shown = property(GetShown,Show,doc="See `GetShown`")
6220 Text = property(GetText,SetText,doc="See `GetText` and `SetText`")
2131d850 6221_core_.UpdateUIEvent_swigregister(UpdateUIEvent)
d55e5bfc
RD		 6222
6223def UpdateUIEvent_SetUpdateInterval(*args, **kwargs):
554f62e9 6224 """
5ba5649b
RD		 6225 UpdateUIEvent_SetUpdateInterval(long updateInterval)
6226
6227 Sets the interval between updates in milliseconds. Set to -1 to
6228 disable updates, or to 0 to update as frequently as possible. The
6229 default is 0.
6230
6231 Use this to reduce the overhead of UI update events if your
6232 application has a lot of windows. If you set the value to -1 or
6233 greater than 0, you may also need to call `wx.Window.UpdateWindowUI`
6234 at appropriate points in your application, such as when a dialog is
6235 about to be shown.
6236 """
554f62e9 6237 return _core_.UpdateUIEvent_SetUpdateInterval(*args, **kwargs)
d55e5bfc 6238
554f62e9
RD		 6239def UpdateUIEvent_GetUpdateInterval(*args):
6240 """
5ba5649b
RD		 6241 UpdateUIEvent_GetUpdateInterval() -> long
6242
6243 Returns the current interval between updates in milliseconds. -1
6244 disables updates, 0 updates as frequently as possible.
6245 """
554f62e9 6246 return _core_.UpdateUIEvent_GetUpdateInterval(*args)
d55e5bfc
RD		 6247
6248def UpdateUIEvent_CanUpdate(*args, **kwargs):
554f62e9 6249 """
5ba5649b
RD		 6250 UpdateUIEvent_CanUpdate(Window win) -> bool
6251
6252 Returns ``True`` if it is appropriate to update (send UI update events
6253 to) this window.
6254
6255 This function looks at the mode used (see `wx.UpdateUIEvent.SetMode`),
6256 the wx.WS_EX_PROCESS_UPDATE_EVENTS flag in window, the time update
6257 events were last sent in idle time, and the update interval, to
6258 determine whether events should be sent to this window now. By default
6259 this will always return true because the update mode is initially
6260 wx.UPDATE_UI_PROCESS_ALL and the interval is set to 0; so update
6261 events will be sent as often as possible. You can reduce the frequency
6262 that events are sent by changing the mode and/or setting an update
6263 interval.
6264
6265 """
554f62e9 6266 return _core_.UpdateUIEvent_CanUpdate(*args, **kwargs)
d55e5bfc 6267
554f62e9
RD		 6268def UpdateUIEvent_ResetUpdateTime(*args):
6269 """
5ba5649b
RD		 6270 UpdateUIEvent_ResetUpdateTime()
6271
6272 Used internally to reset the last-updated time to the current time. It
6273 is assumed that update events are normally sent in idle time, so this
6274 is called at the end of idle processing.
6275 """
554f62e9 6276 return _core_.UpdateUIEvent_ResetUpdateTime(*args)
d55e5bfc
RD		 6277
6278def UpdateUIEvent_SetMode(*args, **kwargs):
554f62e9 6279 """
5ba5649b
RD		 6280 UpdateUIEvent_SetMode(int mode)
6281
6282 Specify how wxWidgets will send update events: to all windows, or only
6283 to those which specify that they will process the events.
6284
6285 The mode may be one of the following values:
6286
6287 ============================= ==========================================
6288 wxUPDATE_UI_PROCESS_ALL Send UI update events to all windows. This
6289 is the default setting.
6290 wxUPDATE_UI_PROCESS_SPECIFIED Send UI update events only to windows that
6291 have the wx.WS_EX_PROCESS_UI_UPDATES extra
6292 style set.
6293 ============================= ==========================================
6294
6295 """
554f62e9 6296 return _core_.UpdateUIEvent_SetMode(*args, **kwargs)
d55e5bfc 6297
554f62e9
RD		 6298def UpdateUIEvent_GetMode(*args):
6299 """
5ba5649b
RD		 6300 UpdateUIEvent_GetMode() -> int
6301
6302 Returns a value specifying how wxWidgets will send update events: to
6303 all windows, or only to those which specify that they will process the
6304 events.
6305 """
554f62e9 6306 return _core_.UpdateUIEvent_GetMode(*args)
d55e5bfc
RD		 6307
6308#---------------------------------------------------------------------------
6309
6310class SysColourChangedEvent(Event):
5ba5649b
RD		 6311 """
6312 This class is used for EVT_SYS_COLOUR_CHANGED, which are generated
6313 when the user changes the colour settings using the control
6314 panel. This is only applicable under Windows.
6315
6316 The default event handler for this event propagates the event to child
6317 windows, since Windows only sends the events to top-level windows. If
6318 intercepting this event for a top-level window, remember to call
6319 `Skip` so the the base class handler will still be executed, or to
6320 pass the event on to the window's children explicitly.
6321
6322 """
554f62e9
RD		 6323 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6324 __repr__ = _swig_repr
6325 def __init__(self, *args, **kwargs):
5ba5649b
RD		 6326 """
6327 __init__(self) -> SysColourChangedEvent
6328
6329 Constructor
6330 """
554f62e9 6331 _core_.SysColourChangedEvent_swiginit(self,_core_.new_SysColourChangedEvent(*args, **kwargs))
2131d850 6332_core_.SysColourChangedEvent_swigregister(SysColourChangedEvent)
d55e5bfc
RD		 6333
6334#---------------------------------------------------------------------------
6335
6336class MouseCaptureChangedEvent(Event):
5ba5649b
RD		 6337 """
6338 An mouse capture changed event (EVT_MOUSE_CAPTURE_CHANGED) is sent to
6339 a window that loses its mouse capture. This is called even if
6340 `wx.Window.ReleaseMouse` was called by the application code. Handling
6341 this event allows an application to cater for unexpected capture
6342 releases which might otherwise confuse mouse handling code.
6343
6344 This event is implemented under Windows only.
6345 """
554f62e9
RD		 6346 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6347 __repr__ = _swig_repr
6348 def __init__(self, *args, **kwargs):
5ba5649b
RD		 6349 """
6350 __init__(self, int winid=0, Window gainedCapture=None) -> MouseCaptureChangedEvent
6351
6352 Constructor
6353 """
554f62e9 6354 _core_.MouseCaptureChangedEvent_swiginit(self,_core_.new_MouseCaptureChangedEvent(*args, **kwargs))
d55e5bfc 6355 def GetCapturedWindow(*args, **kwargs):
5ba5649b
RD		 6356 """
6357 GetCapturedWindow(self) -> Window
6358
6359 Returns the window that gained the capture, or ``None`` if it was a
6360 non-wxWidgets window.
6361 """
d55e5bfc
RD		 6362 return _core_.MouseCaptureChangedEvent_GetCapturedWindow(*args, **kwargs)
6363
57332a5a 6364 CapturedWindow = property(GetCapturedWindow,doc="See `GetCapturedWindow`")
2131d850 6365_core_.MouseCaptureChangedEvent_swigregister(MouseCaptureChangedEvent)
d55e5bfc
RD		 6366
6367#---------------------------------------------------------------------------
6368
0f83f5da
RD		 6369class MouseCaptureLostEvent(Event):
6370 """
6371 A mouse capture lost event is sent to a window that obtained mouse
6372 capture, which was subsequently loss due to "external" event, for
6373 example when a dialog box is shown or if another application captures
6374 the mouse.
6375
6376 If this happens, this event is sent to all windows that are on the
6377 capture stack (i.e. a window that called `wx.Window.CaptureMouse`, but
6378 didn't call `wx.Window.ReleaseMouse` yet). The event is *not* sent
6379 if the capture changes because of a call to CaptureMouse or
6380 ReleaseMouse.
6381
6382 This event is currently emitted under Windows only.
6383
6384 """
6385 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6386 __repr__ = _swig_repr
6387 def __init__(self, *args, **kwargs):
6388 """
6389 __init__(self, int winid=0) -> MouseCaptureLostEvent
6390
6391 A mouse capture lost event is sent to a window that obtained mouse
6392 capture, which was subsequently loss due to "external" event, for
6393 example when a dialog box is shown or if another application captures
6394 the mouse.
6395
6396 If this happens, this event is sent to all windows that are on the
6397 capture stack (i.e. a window that called `wx.Window.CaptureMouse`, but
6398 didn't call `wx.Window.ReleaseMouse` yet). The event is *not* sent
6399 if the capture changes because of a call to CaptureMouse or
6400 ReleaseMouse.
6401
6402 This event is currently emitted under Windows only.
6403
6404 """
6405 _core_.MouseCaptureLostEvent_swiginit(self,_core_.new_MouseCaptureLostEvent(*args, **kwargs))
6406_core_.MouseCaptureLostEvent_swigregister(MouseCaptureLostEvent)
6407
6408#---------------------------------------------------------------------------
6409
d55e5bfc 6410class DisplayChangedEvent(Event):
5ba5649b
RD		 6411 """
6412 An EVT_DISPLAY_CHANGED event is sent to all windows when the display
6413 resolution has changed.
6414
6415 This event is implemented under Windows only.
6416 """
554f62e9
RD		 6417 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6418 __repr__ = _swig_repr
6419 def __init__(self, *args, **kwargs):
d55e5bfc 6420 """__init__(self) -> DisplayChangedEvent"""
554f62e9 6421 _core_.DisplayChangedEvent_swiginit(self,_core_.new_DisplayChangedEvent(*args, **kwargs))
2131d850 6422_core_.DisplayChangedEvent_swigregister(DisplayChangedEvent)
d55e5bfc
RD		 6423
6424#---------------------------------------------------------------------------
6425
6426class PaletteChangedEvent(Event):
5ba5649b
RD		 6427 """
6428 An EVT_PALETTE_CHANGED event is sent when the system palette has
6429 changed, thereby giving each window a chance to redo their own to
6430 match.
6431
6432 This event is implemented under Windows only.
6433 """
554f62e9
RD		 6434 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6435 __repr__ = _swig_repr
6436 def __init__(self, *args, **kwargs):
5ba5649b
RD		 6437 """
6438 __init__(self, int id=0) -> PaletteChangedEvent
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 6446 _core_.PaletteChangedEvent_swiginit(self,_core_.new_PaletteChangedEvent(*args, **kwargs))
d55e5bfc
RD		 6447 def SetChangedWindow(*args, **kwargs):
6448 """SetChangedWindow(self, Window win)"""
6449 return _core_.PaletteChangedEvent_SetChangedWindow(*args, **kwargs)
6450
6451 def GetChangedWindow(*args, **kwargs):
6452 """GetChangedWindow(self) -> Window"""
6453 return _core_.PaletteChangedEvent_GetChangedWindow(*args, **kwargs)
6454
33d6fd3b 6455 ChangedWindow = property(GetChangedWindow,SetChangedWindow,doc="See `GetChangedWindow` and `SetChangedWindow`")
2131d850 6456_core_.PaletteChangedEvent_swigregister(PaletteChangedEvent)
d55e5bfc
RD		 6457
6458#---------------------------------------------------------------------------
6459
6460class QueryNewPaletteEvent(Event):
5ba5649b
RD		 6461 """
6462 An EVT_QUERY_NEW_PALETE event indicates the window is getting keyboard
6463 focus and should re-do its palette.
6464
6465 This event is implemented under Windows only.
6466 """
554f62e9
RD		 6467 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6468 __repr__ = _swig_repr
6469 def __init__(self, *args, **kwargs):
5ba5649b
RD		 6470 """
6471 __init__(self, int winid=0) -> QueryNewPaletteEvent
6472
6473 Constructor.
6474 """
554f62e9 6475 _core_.QueryNewPaletteEvent_swiginit(self,_core_.new_QueryNewPaletteEvent(*args, **kwargs))
d55e5bfc 6476 def SetPaletteRealized(*args, **kwargs):
5ba5649b
RD		 6477 """
6478 SetPaletteRealized(self, bool realized)
6479
6480 App should set this if it changes the palette.
6481 """
d55e5bfc
RD		 6482 return _core_.QueryNewPaletteEvent_SetPaletteRealized(*args, **kwargs)
6483
6484 def GetPaletteRealized(*args, **kwargs):
6485 """GetPaletteRealized(self) -> bool"""
6486 return _core_.QueryNewPaletteEvent_GetPaletteRealized(*args, **kwargs)
6487
33d6fd3b 6488 PaletteRealized = property(GetPaletteRealized,SetPaletteRealized,doc="See `GetPaletteRealized` and `SetPaletteRealized`")
2131d850 6489_core_.QueryNewPaletteEvent_swigregister(QueryNewPaletteEvent)
d55e5bfc
RD		 6490
6491#---------------------------------------------------------------------------
6492
6493class NavigationKeyEvent(Event):
5ba5649b
RD		 6494 """
6495 EVT_NAVIGATION_KEY events are used to control moving the focus between
6496 widgets, otherwise known as tab-traversal. You woudl normally not
6497 catch navigation events in applications as there are already
6498 appropriate handlers in `wx.Dialog` and `wx.Panel`, but you may find
6499 it useful to send navigation events in certain situations to change
6500 the focus in certain ways, although it's probably easier to just call
6501 `wx.Window.Navigate`.
6502 """
554f62e9
RD		 6503 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6504 __repr__ = _swig_repr
6505 def __init__(self, *args, **kwargs):
d55e5bfc 6506 """__init__(self) -> NavigationKeyEvent"""
554f62e9 6507 _core_.NavigationKeyEvent_swiginit(self,_core_.new_NavigationKeyEvent(*args, **kwargs))
d55e5bfc 6508 def GetDirection(*args, **kwargs):
5ba5649b
RD		 6509 """
6510 GetDirection(self) -> bool
6511
6512 Returns ``True`` if the direction is forward, ``False`` otherwise.
6513 """
d55e5bfc
RD		 6514 return _core_.NavigationKeyEvent_GetDirection(*args, **kwargs)
6515
6516 def SetDirection(*args, **kwargs):
5ba5649b
RD		 6517 """
6518 SetDirection(self, bool forward)
6519
6520 Specify the direction that the navigation should take. Usually the
6521 difference between using Tab and Shift-Tab.
6522 """
d55e5bfc
RD		 6523 return _core_.NavigationKeyEvent_SetDirection(*args, **kwargs)
6524
6525 def IsWindowChange(*args, **kwargs):
5ba5649b
RD		 6526 """
6527 IsWindowChange(self) -> bool
6528
6529 Returns ``True`` if window change is allowed.
6530 """
d55e5bfc
RD		 6531 return _core_.NavigationKeyEvent_IsWindowChange(*args, **kwargs)
6532
6533 def SetWindowChange(*args, **kwargs):
5ba5649b
RD		 6534 """
6535 SetWindowChange(self, bool ischange)
6536
6537 Specify if the navigation should be able to change parent windows.
6538 For example, changing notebook pages, etc. This is usually implemented
6539 by using Control-Tab.
6540 """
d55e5bfc
RD		 6541 return _core_.NavigationKeyEvent_SetWindowChange(*args, **kwargs)
6542
68350608 6543 def IsFromTab(*args, **kwargs):
5ba5649b
RD		 6544 """
6545 IsFromTab(self) -> bool
6546
6547 Returns ``True`` if the navigation event is originated from the Tab
6548 key.
6549 """
68350608
RD		 6550 return _core_.NavigationKeyEvent_IsFromTab(*args, **kwargs)
6551
6552 def SetFromTab(*args, **kwargs):
5ba5649b
RD		 6553 """
6554 SetFromTab(self, bool bIs)
6555
6556 Set to true under MSW if the event was generated using the tab key.
6557 This is required for proper navogation over radio buttons.
6558 """
68350608
RD		 6559 return _core_.NavigationKeyEvent_SetFromTab(*args, **kwargs)
6560
908b74cd 6561 def SetFlags(*args, **kwargs):
5ba5649b
RD		 6562 """
6563 SetFlags(self, long flags)
6564
6565 Set the navigation flags to a combination of the following:
6566
6567 * wx.NavigationKeyEvent.IsBackward
6568 * wx.NavigationKeyEvent.IsForward
6569 * wx.NavigationKeyEvent.WinChange
6570 * wx.NavigationKeyEvent.FromTab
6571
6572 """
908b74cd
RD		 6573 return _core_.NavigationKeyEvent_SetFlags(*args, **kwargs)
6574
d55e5bfc 6575 def GetCurrentFocus(*args, **kwargs):
5ba5649b
RD		 6576 """
6577 GetCurrentFocus(self) -> Window
6578
6579 Returns the child window which currenty has the focus. May be
6580 ``None``.
6581 """
d55e5bfc
RD		 6582 return _core_.NavigationKeyEvent_GetCurrentFocus(*args, **kwargs)
6583
6584 def SetCurrentFocus(*args, **kwargs):
5ba5649b
RD		 6585 """
6586 SetCurrentFocus(self, Window win)
6587
6588 Set the window that has the focus.
6589 """
d55e5bfc
RD		 6590 return _core_.NavigationKeyEvent_SetCurrentFocus(*args, **kwargs)
6591
b0f7404b 6592 IsBackward = _core_.NavigationKeyEvent_IsBackward
908b74cd
RD		 6593 IsForward = _core_.NavigationKeyEvent_IsForward
6594 WinChange = _core_.NavigationKeyEvent_WinChange
68350608 6595 FromTab = _core_.NavigationKeyEvent_FromTab
57332a5a
RD		 6596 CurrentFocus = property(GetCurrentFocus,SetCurrentFocus,doc="See `GetCurrentFocus` and `SetCurrentFocus`")
6597 Direction = property(GetDirection,SetDirection,doc="See `GetDirection` and `SetDirection`")
2131d850 6598_core_.NavigationKeyEvent_swigregister(NavigationKeyEvent)
d55e5bfc
RD		 6599
6600#---------------------------------------------------------------------------
6601
6602class WindowCreateEvent(CommandEvent):
5ba5649b
RD		 6603 """
6604 The EVT_WINDOW_CREATE event is sent as soon as the window object (the
6605 underlying GUI object) exists.
6606 """
554f62e9
RD		 6607 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6608 __repr__ = _swig_repr
6609 def __init__(self, *args, **kwargs):
5ba5649b
RD		 6610 """
6611 __init__(self, Window win=None) -> WindowCreateEvent
6612
6613 The EVT_WINDOW_CREATE event is sent as soon as the window object (the
6614 underlying GUI object) exists.
6615 """
554f62e9 6616 _core_.WindowCreateEvent_swiginit(self,_core_.new_WindowCreateEvent(*args, **kwargs))
d55e5bfc 6617 def GetWindow(*args, **kwargs):
5ba5649b
RD		 6618 """
6619 GetWindow(self) -> Window
6620
6621 Returns the window that this event refers to.
6622 """
d55e5bfc
RD		 6623 return _core_.WindowCreateEvent_GetWindow(*args, **kwargs)
6624
dba7934c 6625 Window = property(GetWindow,doc="See `GetWindow`")
2131d850 6626_core_.WindowCreateEvent_swigregister(WindowCreateEvent)
d55e5bfc
RD		 6627
6628class WindowDestroyEvent(CommandEvent):
5ba5649b 6629 """
9d7dfdff
RD		 6630 The EVT_WINDOW_DESTROY event is sent from the `wx.Window` destructor
6631 when the GUI window is destroyed.
6632
6633 When a class derived from `wx.Window` is destroyed its destructor will
6634 have already run by the time this event is sent. Therefore this event
6635 will not usually be received at all by the window itself. Since it is
6636 received after the destructor has run, an object should not try to
6637 handle its own wx.WindowDestroyEvent, but it can be used to get
6638 notification of the destruction of another window.
5ba5649b 6639 """
554f62e9
RD		 6640 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6641 __repr__ = _swig_repr
6642 def __init__(self, *args, **kwargs):
5ba5649b
RD		 6643 """
6644 __init__(self, Window win=None) -> WindowDestroyEvent
6645
9d7dfdff
RD		 6646 The EVT_WINDOW_DESTROY event is sent from the `wx.Window` destructor
6647 when the GUI window is destroyed.
6648
6649 When a class derived from `wx.Window` is destroyed its destructor will
6650 have already run by the time this event is sent. Therefore this event
6651 will not usually be received at all by the window itself. Since it is
6652 received after the destructor has run, an object should not try to
6653 handle its own wx.WindowDestroyEvent, but it can be used to get
6654 notification of the destruction of another window.
5ba5649b 6655 """
554f62e9 6656 _core_.WindowDestroyEvent_swiginit(self,_core_.new_WindowDestroyEvent(*args, **kwargs))
d55e5bfc 6657 def GetWindow(*args, **kwargs):
5ba5649b
RD		 6658 """
6659 GetWindow(self) -> Window
6660
6661 Returns the window that this event refers to.
6662 """
d55e5bfc
RD		 6663 return _core_.WindowDestroyEvent_GetWindow(*args, **kwargs)
6664
dba7934c 6665 Window = property(GetWindow,doc="See `GetWindow`")
2131d850 6666_core_.WindowDestroyEvent_swigregister(WindowDestroyEvent)
d55e5bfc
RD		 6667
6668#---------------------------------------------------------------------------
6669
6670class ContextMenuEvent(CommandEvent):
5ba5649b
RD		 6671 """
6672 This class is used for context menu events (EVT_CONTECT_MENU,) sent to
6673 give the application a chance to show a context (popup) menu.
6674 """
554f62e9
RD		 6675 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6676 __repr__ = _swig_repr
6677 def __init__(self, *args, **kwargs):
5ba5649b 6678 """
f460c29d 6679 __init__(self, EventType type=wxEVT_NULL, int winid=0, Point pt=DefaultPosition) -> ContextMenuEvent
5ba5649b
RD		 6680
6681 Constructor.
6682 """
554f62e9 6683 _core_.ContextMenuEvent_swiginit(self,_core_.new_ContextMenuEvent(*args, **kwargs))
d55e5bfc 6684 def GetPosition(*args, **kwargs):
5ba5649b
RD		 6685 """
6686 GetPosition(self) -> Point
6687
6688 Returns the position (in screen coordinants) at which the menu should
6689 be shown.
6690 """
d55e5bfc
RD		 6691 return _core_.ContextMenuEvent_GetPosition(*args, **kwargs)
6692
6693 def SetPosition(*args, **kwargs):
5ba5649b
RD		 6694 """
6695 SetPosition(self, Point pos)
6696
6697 Sets the position at which the menu should be shown.
6698 """
d55e5bfc
RD		 6699 return _core_.ContextMenuEvent_SetPosition(*args, **kwargs)
6700
226118fc 6701 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
2131d850 6702_core_.ContextMenuEvent_swigregister(ContextMenuEvent)
d55e5bfc
RD		 6703
6704#---------------------------------------------------------------------------
6705
6706IDLE_PROCESS_ALL = _core_.IDLE_PROCESS_ALL
6707IDLE_PROCESS_SPECIFIED = _core_.IDLE_PROCESS_SPECIFIED
6708class IdleEvent(Event):
5ba5649b
RD		 6709 """
6710 This class is used for EVT_IDLE events, which are generated and sent
6711 when the application *becomes* idle. In other words, the when the
6712 event queue becomes empty then idle events are sent to all windows (by
6713 default) and as long as none of them call `RequestMore` then there are
6714 no more idle events until after the system event queue has some normal
6715 events and then becomes empty again.
6716
6717 By default, idle events are sent to all windows. If this is causing a
6718 significant overhead in your application, you can call
6719 `wx.IdleEvent.SetMode` with the value wx.IDLE_PROCESS_SPECIFIED, and
6720 set the wx.WS_EX_PROCESS_IDLE extra window style for every window
6721 which should receive idle events. Then idle events will only be sent
6722 to those windows and not to any others.
6723 """
554f62e9
RD		 6724 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6725 __repr__ = _swig_repr
6726 def __init__(self, *args, **kwargs):
5ba5649b
RD		 6727 """
6728 __init__(self) -> IdleEvent
6729
6730 Constructor
6731 """
554f62e9 6732 _core_.IdleEvent_swiginit(self,_core_.new_IdleEvent(*args, **kwargs))
d55e5bfc 6733 def RequestMore(*args, **kwargs):
5ba5649b
RD		 6734 """
6735 RequestMore(self, bool needMore=True)
6736
6737 Tells wxWidgets that more processing is required. This function can be
6738 called by an EVT_IDLE handler for a window to indicate that the
6739 application should forward the EVT_IDLE event once more to the
6740 application windows. If no window calls this function during its
6741 EVT_IDLE handler, then the application will remain in a passive event
6742 loop until a new event is posted to the application by the windowing
6743 system.
6744 """
d55e5bfc
RD		 6745 return _core_.IdleEvent_RequestMore(*args, **kwargs)
6746
6747 def MoreRequested(*args, **kwargs):
5ba5649b
RD		 6748 """
6749 MoreRequested(self) -> bool
6750
6751 Returns ``True`` if the OnIdle function processing this event
6752 requested more processing time.
6753 """
d55e5bfc
RD		 6754 return _core_.IdleEvent_MoreRequested(*args, **kwargs)
6755
6756 def SetMode(*args, **kwargs):
5ba5649b
RD		 6757 """
6758 SetMode(int mode)
6759
6760 Static method for specifying how wxWidgets will send idle events: to
6761 all windows, or only to those which specify that they will process the
6762 events.
6763
6764 The mode can be one of the following values:
6765
6766 ========================= ========================================
6767 wx.IDLE_PROCESS_ALL Send idle events to all windows
6768 wx.IDLE_PROCESS_SPECIFIED Send idle events only to windows that have
6769 the wx.WS_EX_PROCESS_IDLE extra style
6770 flag set.
6771 ========================= ========================================
6772
6773 """
d55e5bfc
RD		 6774 return _core_.IdleEvent_SetMode(*args, **kwargs)
6775
6776 SetMode = staticmethod(SetMode)
6777 def GetMode(*args, **kwargs):
5ba5649b
RD		 6778 """
6779 GetMode() -> int
6780
6781 Static method returning a value specifying how wxWidgets will send
6782 idle events: to all windows, or only to those which specify that they
6783 will process the events.
6784 """
d55e5bfc
RD		 6785 return _core_.IdleEvent_GetMode(*args, **kwargs)
6786
6787 GetMode = staticmethod(GetMode)
6788 def CanSend(*args, **kwargs):
5ba5649b
RD		 6789 """
6790 CanSend(Window win) -> bool
6791
6792 Returns ``True`` if it is appropriate to send idle events to this
6793 window.
6794
6795 This function looks at the mode used (see `wx.IdleEvent.SetMode`), and
6796 the wx.WS_EX_PROCESS_IDLE style in window to determine whether idle
6797 events should be sent to this window now. By default this will always
6798 return ``True`` because the update mode is initially
6799 wx.IDLE_PROCESS_ALL. You can change the mode to only send idle events
6800 to windows with the wx.WS_EX_PROCESS_IDLE extra window style set.
6801 """
d55e5bfc
RD		 6802 return _core_.IdleEvent_CanSend(*args, **kwargs)
6803
6804 CanSend = staticmethod(CanSend)
2131d850 6805_core_.IdleEvent_swigregister(IdleEvent)
d55e5bfc
RD		 6806
6807def IdleEvent_SetMode(*args, **kwargs):
554f62e9 6808 """
5ba5649b
RD		 6809 IdleEvent_SetMode(int mode)
6810
6811 Static method for specifying how wxWidgets will send idle events: to
6812 all windows, or only to those which specify that they will process the
6813 events.
6814
6815 The mode can be one of the following values:
6816
6817 ========================= ========================================
6818 wx.IDLE_PROCESS_ALL Send idle events to all windows
6819 wx.IDLE_PROCESS_SPECIFIED Send idle events only to windows that have
6820 the wx.WS_EX_PROCESS_IDLE extra style
6821 flag set.
6822 ========================= ========================================
6823
6824 """
554f62e9 6825 return _core_.IdleEvent_SetMode(*args, **kwargs)
d55e5bfc 6826
554f62e9
RD		 6827def IdleEvent_GetMode(*args):
6828 """
5ba5649b
RD		 6829 IdleEvent_GetMode() -> int
6830
6831 Static method returning a value specifying how wxWidgets will send
6832 idle events: to all windows, or only to those which specify that they
6833 will process the events.
6834 """
554f62e9 6835 return _core_.IdleEvent_GetMode(*args)
d55e5bfc
RD		 6836
6837def IdleEvent_CanSend(*args, **kwargs):
554f62e9 6838 """
5ba5649b
RD		 6839 IdleEvent_CanSend(Window win) -> bool
6840
6841 Returns ``True`` if it is appropriate to send idle events to this
6842 window.
6843
6844 This function looks at the mode used (see `wx.IdleEvent.SetMode`), and
6845 the wx.WS_EX_PROCESS_IDLE style in window to determine whether idle
6846 events should be sent to this window now. By default this will always
6847 return ``True`` because the update mode is initially
6848 wx.IDLE_PROCESS_ALL. You can change the mode to only send idle events
6849 to windows with the wx.WS_EX_PROCESS_IDLE extra window style set.
6850 """
554f62e9 6851 return _core_.IdleEvent_CanSend(*args, **kwargs)
d55e5bfc
RD		 6852
6853#---------------------------------------------------------------------------
6854
2131d850
RD		 6855class ClipboardTextEvent(CommandEvent):
6856 """
6857 A Clipboard Text event is sent when a window intercepts a text
6858 copy/cut/paste message, i.e. the user has cut/copied/pasted data
6859 from/into a text control via ctrl-C/X/V, ctrl/shift-del/insert, a
6860 popup menu command, etc. NOTE : under windows these events are *NOT*
6861 generated automatically for a Rich Edit text control.
6862 """
6863 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6864 __repr__ = _swig_repr
6865 def __init__(self, *args, **kwargs):
6866 """
6867 __init__(self, EventType type=wxEVT_NULL, int winid=0) -> ClipboardTextEvent
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 _core_.ClipboardTextEvent_swiginit(self,_core_.new_ClipboardTextEvent(*args, **kwargs))
6876_core_.ClipboardTextEvent_swigregister(ClipboardTextEvent)
6877
6878#---------------------------------------------------------------------------
6879
d55e5bfc 6880class PyEvent(Event):
5ba5649b
RD		 6881 """
6882 wx.PyEvent can be used as a base class for implementing custom event
6883 types in Python. You should derived from this class instead of
6884 `wx.Event` because this class is Python-aware and is able to transport
6885 its Python bits safely through the wxWidgets event system and have
6886 them still be there when the event handler is invoked.
6887
6888 :see: `wx.PyCommandEvent`
6889
6890 """
554f62e9
RD		 6891 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6892 __repr__ = _swig_repr
6893 def __init__(self, *args, **kwargs):
f460c29d 6894 """__init__(self, int winid=0, EventType eventType=wxEVT_NULL) -> PyEvent"""
554f62e9 6895 _core_.PyEvent_swiginit(self,_core_.new_PyEvent(*args, **kwargs))
5ba5649b 6896 self._SetSelf(self)
d55e5bfc 6897
554f62e9
RD		 6898 __swig_destroy__ = _core_.delete_PyEvent
6899 __del__ = lambda self : None;
5ba5649b
RD		 6900 def _SetSelf(*args, **kwargs):
6901 """_SetSelf(self, PyObject self)"""
6902 return _core_.PyEvent__SetSelf(*args, **kwargs)
d55e5bfc 6903
5ba5649b
RD		 6904 def _GetSelf(*args, **kwargs):
6905 """_GetSelf(self) -> PyObject"""
6906 return _core_.PyEvent__GetSelf(*args, **kwargs)
d55e5bfc 6907
2131d850 6908_core_.PyEvent_swigregister(PyEvent)
d55e5bfc
RD		 6909
6910class PyCommandEvent(CommandEvent):
5ba5649b
RD		 6911 """
6912 wx.PyCommandEvent can be used as a base class for implementing custom
6913 event types in Python, where the event shoudl travel up to parent
6914 windows looking for a handler. You should derived from this class
6915 instead of `wx.CommandEvent` because this class is Python-aware and is
6916 able to transport its Python bits safely through the wxWidgets event
6917 system and have them still be there when the event handler is invoked.
6918
6919 :see: `wx.PyEvent`
6920
6921 """
554f62e9
RD		 6922 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6923 __repr__ = _swig_repr
6924 def __init__(self, *args, **kwargs):
f460c29d 6925 """__init__(self, EventType eventType=wxEVT_NULL, int id=0) -> PyCommandEvent"""
554f62e9 6926 _core_.PyCommandEvent_swiginit(self,_core_.new_PyCommandEvent(*args, **kwargs))
5ba5649b 6927 self._SetSelf(self)
d55e5bfc 6928
554f62e9
RD		 6929 __swig_destroy__ = _core_.delete_PyCommandEvent
6930 __del__ = lambda self : None;
5ba5649b
RD		 6931 def _SetSelf(*args, **kwargs):
6932 """_SetSelf(self, PyObject self)"""
6933 return _core_.PyCommandEvent__SetSelf(*args, **kwargs)
d55e5bfc 6934
5ba5649b
RD		 6935 def _GetSelf(*args, **kwargs):
6936 """_GetSelf(self) -> PyObject"""
6937 return _core_.PyCommandEvent__GetSelf(*args, **kwargs)
d55e5bfc 6938
2131d850 6939_core_.PyCommandEvent_swigregister(PyCommandEvent)
d55e5bfc 6940
53aa7709 6941class DateEvent(CommandEvent):
5ba5649b
RD		 6942 """
6943 This event class holds information about a date change event and is
6944 used together with `wx.DatePickerCtrl`. It also serves as a base class
6945 for `wx.calendar.CalendarEvent`. Bind these event types with
6946 EVT_DATE_CHANGED.
6947 """
554f62e9
RD		 6948 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6949 __repr__ = _swig_repr
6950 def __init__(self, *args, **kwargs):
f460c29d 6951 """__init__(self, Window win, DateTime dt, EventType type) -> DateEvent"""
554f62e9 6952 _core_.DateEvent_swiginit(self,_core_.new_DateEvent(*args, **kwargs))
53aa7709 6953 def GetDate(*args, **kwargs):
5ba5649b
RD		 6954 """
6955 GetDate(self) -> DateTime
6956
6957 Returns the date.
6958 """
53aa7709
RD		 6959 return _core_.DateEvent_GetDate(*args, **kwargs)
6960
6961 def SetDate(*args, **kwargs):
5ba5649b
RD		 6962 """
6963 SetDate(self, DateTime date)
6964
6965 Sets the date carried by the event, normally only used by the library
6966 internally.
6967 """
53aa7709
RD		 6968 return _core_.DateEvent_SetDate(*args, **kwargs)
6969
226118fc 6970 Date = property(GetDate,SetDate,doc="See `GetDate` and `SetDate`")
2131d850 6971_core_.DateEvent_swigregister(DateEvent)
53aa7709
RD		 6972
6973wxEVT_DATE_CHANGED = _core_.wxEVT_DATE_CHANGED
6974EVT_DATE_CHANGED = wx.PyEventBinder( wxEVT_DATE_CHANGED, 1 )
6975
d55e5bfc
RD		 6976#---------------------------------------------------------------------------
6977
6978PYAPP_ASSERT_SUPPRESS = _core_.PYAPP_ASSERT_SUPPRESS
6979PYAPP_ASSERT_EXCEPTION = _core_.PYAPP_ASSERT_EXCEPTION
6980PYAPP_ASSERT_DIALOG = _core_.PYAPP_ASSERT_DIALOG
6981PYAPP_ASSERT_LOG = _core_.PYAPP_ASSERT_LOG
6982PRINT_WINDOWS = _core_.PRINT_WINDOWS
6983PRINT_POSTSCRIPT = _core_.PRINT_POSTSCRIPT
6984class PyApp(EvtHandler):
c24da6d6
RD		 6985 """
6986 The ``wx.PyApp`` class is an *implementation detail*, please use the
6987 `wx.App` class (or some other derived class) instead.
6988 """
554f62e9
RD		 6989 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6990 __repr__ = _swig_repr
6991 def __init__(self, *args, **kwargs):
d55e5bfc
RD		 6992 """
6993 __init__(self) -> PyApp
6994
6995 Create a new application object, starting the bootstrap process.
6996 """
554f62e9 6997 _core_.PyApp_swiginit(self,_core_.new_PyApp(*args, **kwargs))
70b7a5fe
RD		 6998 self._setCallbackInfo(self, PyApp, False)
6999 self._setOORInfo(self, False)
d55e5bfc 7000
554f62e9
RD		 7001 __swig_destroy__ = _core_.delete_PyApp
7002 __del__ = lambda self : None;
d55e5bfc 7003 def _setCallbackInfo(*args, **kwargs):
70b7a5fe 7004 """_setCallbackInfo(self, PyObject self, PyObject _class, bool incref)"""
d55e5bfc
RD		 7005 return _core_.PyApp__setCallbackInfo(*args, **kwargs)
7006
7007 def GetAppName(*args, **kwargs):
7008 """
7009 GetAppName(self) -> String
7010
7011 Get the application name.
7012 """
7013 return _core_.PyApp_GetAppName(*args, **kwargs)
7014
7015 def SetAppName(*args, **kwargs):
7016 """
7017 SetAppName(self, String name)
7018
c24da6d6
RD		 7019 Set the application name. This value may be used automatically by
7020 `wx.Config` and such.
d55e5bfc
RD		 7021 """
7022 return _core_.PyApp_SetAppName(*args, **kwargs)
7023
7024 def GetClassName(*args, **kwargs):
7025 """
7026 GetClassName(self) -> String
7027
7028 Get the application's class name.
7029 """
7030 return _core_.PyApp_GetClassName(*args, **kwargs)
7031
7032 def SetClassName(*args, **kwargs):
7033 """
7034 SetClassName(self, String name)
7035
c24da6d6
RD		 7036 Set the application's class name. This value may be used for
7037 X-resources if applicable for the platform
d55e5bfc
RD		 7038 """
7039 return _core_.PyApp_SetClassName(*args, **kwargs)
7040
7041 def GetVendorName(*args, **kwargs):
7042 """
7043 GetVendorName(self) -> String
7044
7045 Get the application's vendor name.
7046 """
7047 return _core_.PyApp_GetVendorName(*args, **kwargs)
7048
7049 def SetVendorName(*args, **kwargs):
7050 """
7051 SetVendorName(self, String name)
7052
c24da6d6
RD		 7053 Set the application's vendor name. This value may be used
7054 automatically by `wx.Config` and such.
d55e5bfc
RD		 7055 """
7056 return _core_.PyApp_SetVendorName(*args, **kwargs)
7057
7058 def GetTraits(*args, **kwargs):
7059 """
7060 GetTraits(self) -> wxAppTraits
7061
c24da6d6
RD		 7062 Return (and create if necessary) the app traits object to which we
7063 delegate for everything which either should be configurable by the
7064 user (then he can change the default behaviour simply by overriding
7065 CreateTraits() and returning his own traits object) or which is
7066 GUI/console dependent as then wx.AppTraits allows us to abstract the
7067 differences behind the common facade.
7068
7069 :todo: Add support for overriding CreateAppTraits in wxPython.
d55e5bfc
RD		 7070 """
7071 return _core_.PyApp_GetTraits(*args, **kwargs)
7072
7073 def ProcessPendingEvents(*args, **kwargs):
7074 """
7075 ProcessPendingEvents(self)
7076
c24da6d6
RD		 7077 Process all events in the Pending Events list -- it is necessary to
7078 call this function to process posted events. This normally happens
7079 during each event loop iteration.
d55e5bfc
RD		 7080 """
7081 return _core_.PyApp_ProcessPendingEvents(*args, **kwargs)
7082
7083 def Yield(*args, **kwargs):
7084 """
7085 Yield(self, bool onlyIfNeeded=False) -> bool
7086
c24da6d6
RD		 7087 Process all currently pending events right now, instead of waiting
7088 until return to the event loop. It is an error to call ``Yield``
7089 recursively unless the value of ``onlyIfNeeded`` is True.
d55e5bfc 7090
c24da6d6 7091 :warning: This function is dangerous as it can lead to unexpected
79fccf9d
RD		 7092 reentrancies (i.e. when called from an event handler it may
7093 result in calling the same event handler again), use with
7094 extreme care or, better, don't use at all!
d55e5bfc 7095
c24da6d6 7096 :see: `wx.Yield`, `wx.YieldIfNeeded`, `wx.SafeYield`
79fccf9d 7097
d55e5bfc
RD		 7098 """
7099 return _core_.PyApp_Yield(*args, **kwargs)
7100
7101 def WakeUpIdle(*args, **kwargs):
7102 """
7103 WakeUpIdle(self)
7104
c24da6d6
RD		 7105 Make sure that idle events are sent again.
7106 :see: `wx.WakeUpIdle`
d55e5bfc
RD		 7107 """
7108 return _core_.PyApp_WakeUpIdle(*args, **kwargs)
7109
84f85550
RD		 7110 def IsMainLoopRunning(*args, **kwargs):
7111 """
7112 IsMainLoopRunning() -> bool
7113
7114 Returns True if we're running the main loop, i.e. if the events can
7115 currently be dispatched.
7116 """
7117 return _core_.PyApp_IsMainLoopRunning(*args, **kwargs)
7118
7119 IsMainLoopRunning = staticmethod(IsMainLoopRunning)
d55e5bfc
RD		 7120 def MainLoop(*args, **kwargs):
7121 """
7122 MainLoop(self) -> int
7123
c24da6d6
RD		 7124 Execute the main GUI loop, the function doesn't normally return until
7125 all top level windows have been closed and destroyed.
d55e5bfc
RD		 7126 """
7127 return _core_.PyApp_MainLoop(*args, **kwargs)
7128
7129 def Exit(*args, **kwargs):
7130 """
7131 Exit(self)
7132
7133 Exit the main loop thus terminating the application.
c24da6d6 7134 :see: `wx.Exit`
d55e5bfc
RD		 7135 """
7136 return _core_.PyApp_Exit(*args, **kwargs)
7137
97ab0f6a
RD		 7138 def GetLayoutDirection(*args, **kwargs):
7139 """
994453b8 7140 GetLayoutDirection(self) -> int
97ab0f6a
RD		 7141
7142 Return the layout direction for the current locale.
7143 """
7144 return _core_.PyApp_GetLayoutDirection(*args, **kwargs)
7145
d55e5bfc
RD		 7146 def ExitMainLoop(*args, **kwargs):
7147 """
7148 ExitMainLoop(self)
7149
c24da6d6
RD		 7150 Exit the main GUI loop during the next iteration of the main
7151 loop, (i.e. it does not stop the program immediately!)
d55e5bfc
RD		 7152 """
7153 return _core_.PyApp_ExitMainLoop(*args, **kwargs)
7154
7155 def Pending(*args, **kwargs):
7156 """
7157 Pending(self) -> bool
7158
7159 Returns True if there are unprocessed events in the event queue.
7160 """
7161 return _core_.PyApp_Pending(*args, **kwargs)
7162
7163 def Dispatch(*args, **kwargs):
7164 """
7165 Dispatch(self) -> bool
7166
7167 Process the first event in the event queue (blocks until an event
7168 appears if there are none currently)
7169 """
7170 return _core_.PyApp_Dispatch(*args, **kwargs)
7171
7172 def ProcessIdle(*args, **kwargs):
7173 """
7174 ProcessIdle(self) -> bool
7175
c24da6d6
RD		 7176 Called from the MainLoop when the application becomes idle (there are
7177 no pending events) and sends a `wx.IdleEvent` to all interested
7178 parties. Returns True if more idle events are needed, False if not.
d55e5bfc
RD		 7179 """
7180 return _core_.PyApp_ProcessIdle(*args, **kwargs)
7181
7182 def SendIdleEvents(*args, **kwargs):
7183 """
7184 SendIdleEvents(self, Window win, IdleEvent event) -> bool
7185
c24da6d6
RD		 7186 Send idle event to window and all subwindows. Returns True if more
7187 idle time is requested.
d55e5bfc
RD		 7188 """
7189 return _core_.PyApp_SendIdleEvents(*args, **kwargs)
7190
7191 def IsActive(*args, **kwargs):
7192 """
7193 IsActive(self) -> bool
7194
7195 Return True if our app has focus.
7196 """
7197 return _core_.PyApp_IsActive(*args, **kwargs)
7198
7199 def SetTopWindow(*args, **kwargs):
7200 """
7201 SetTopWindow(self, Window win)
7202
c24da6d6 7203 Set the *main* top level window
d55e5bfc
RD		 7204 """
7205 return _core_.PyApp_SetTopWindow(*args, **kwargs)
7206
7207 def GetTopWindow(*args, **kwargs):
7208 """
7209 GetTopWindow(self) -> Window
7210
c24da6d6
RD		 7211 Return the *main* top level window (if it hadn't been set previously
7212 with SetTopWindow(), will return just some top level window and, if
7213 there not any, will return None)
d55e5bfc
RD		 7214 """
7215 return _core_.PyApp_GetTopWindow(*args, **kwargs)
7216
7217 def SetExitOnFrameDelete(*args, **kwargs):
7218 """
7219 SetExitOnFrameDelete(self, bool flag)
7220
c24da6d6
RD		 7221 Control the exit behaviour: by default, the program will exit the main
7222 loop (and so, usually, terminate) when the last top-level program
7223 window is deleted. Beware that if you disable this behaviour (with
7224 SetExitOnFrameDelete(False)), you'll have to call ExitMainLoop()
7225 explicitly from somewhere.
d55e5bfc
RD		 7226 """
7227 return _core_.PyApp_SetExitOnFrameDelete(*args, **kwargs)
7228
7229 def GetExitOnFrameDelete(*args, **kwargs):
7230 """
7231 GetExitOnFrameDelete(self) -> bool
7232
7233 Get the current exit behaviour setting.
7234 """
7235 return _core_.PyApp_GetExitOnFrameDelete(*args, **kwargs)
7236
7237 def SetUseBestVisual(*args, **kwargs):
7238 """
7239 SetUseBestVisual(self, bool flag)
7240
c24da6d6
RD		 7241 Set whether the app should try to use the best available visual on
7242 systems where more than one is available, (Sun, SGI, XFree86 4, etc.)
d55e5bfc
RD		 7243 """
7244 return _core_.PyApp_SetUseBestVisual(*args, **kwargs)
7245
7246 def GetUseBestVisual(*args, **kwargs):
7247 """
7248 GetUseBestVisual(self) -> bool
7249
7250 Get current UseBestVisual setting.
7251 """
7252 return _core_.PyApp_GetUseBestVisual(*args, **kwargs)
7253
7254 def SetPrintMode(*args, **kwargs):
7255 """SetPrintMode(self, int mode)"""
7256 return _core_.PyApp_SetPrintMode(*args, **kwargs)
7257
7258 def GetPrintMode(*args, **kwargs):
7259 """GetPrintMode(self) -> int"""
7260 return _core_.PyApp_GetPrintMode(*args, **kwargs)
7261
7262 def SetAssertMode(*args, **kwargs):
7263 """
7264 SetAssertMode(self, int mode)
7265
79fccf9d 7266 Set the OnAssert behaviour for debug and hybrid builds.
d55e5bfc
RD		 7267 """
7268 return _core_.PyApp_SetAssertMode(*args, **kwargs)
7269
7270 def GetAssertMode(*args, **kwargs):
7271 """
7272 GetAssertMode(self) -> int
7273
7274 Get the current OnAssert behaviour setting.
7275 """
7276 return _core_.PyApp_GetAssertMode(*args, **kwargs)
7277
7278 def GetMacSupportPCMenuShortcuts(*args, **kwargs):
c24da6d6 7279 """GetMacSupportPCMenuShortcuts() -> bool"""
d55e5bfc
RD		 7280 return _core_.PyApp_GetMacSupportPCMenuShortcuts(*args, **kwargs)
7281
7282 GetMacSupportPCMenuShortcuts = staticmethod(GetMacSupportPCMenuShortcuts)
7283 def GetMacAboutMenuItemId(*args, **kwargs):
c24da6d6 7284 """GetMacAboutMenuItemId() -> long"""
d55e5bfc
RD		 7285 return _core_.PyApp_GetMacAboutMenuItemId(*args, **kwargs)
7286
7287 GetMacAboutMenuItemId = staticmethod(GetMacAboutMenuItemId)
7288 def GetMacPreferencesMenuItemId(*args, **kwargs):
c24da6d6 7289 """GetMacPreferencesMenuItemId() -> long"""
d55e5bfc
RD		 7290 return _core_.PyApp_GetMacPreferencesMenuItemId(*args, **kwargs)
7291
7292 GetMacPreferencesMenuItemId = staticmethod(GetMacPreferencesMenuItemId)
7293 def GetMacExitMenuItemId(*args, **kwargs):
c24da6d6 7294 """GetMacExitMenuItemId() -> long"""
d55e5bfc
RD		 7295 return _core_.PyApp_GetMacExitMenuItemId(*args, **kwargs)
7296
7297 GetMacExitMenuItemId = staticmethod(GetMacExitMenuItemId)
7298 def GetMacHelpMenuTitleName(*args, **kwargs):
c24da6d6 7299 """GetMacHelpMenuTitleName() -> String"""
d55e5bfc
RD		 7300 return _core_.PyApp_GetMacHelpMenuTitleName(*args, **kwargs)
7301
7302 GetMacHelpMenuTitleName = staticmethod(GetMacHelpMenuTitleName)
7303 def SetMacSupportPCMenuShortcuts(*args, **kwargs):
c24da6d6 7304 """SetMacSupportPCMenuShortcuts(bool val)"""
d55e5bfc
RD		 7305 return _core_.PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs)
7306
7307 SetMacSupportPCMenuShortcuts = staticmethod(SetMacSupportPCMenuShortcuts)
7308 def SetMacAboutMenuItemId(*args, **kwargs):
c24da6d6 7309 """SetMacAboutMenuItemId(long val)"""
d55e5bfc
RD		 7310 return _core_.PyApp_SetMacAboutMenuItemId(*args, **kwargs)
7311
7312 SetMacAboutMenuItemId = staticmethod(SetMacAboutMenuItemId)
7313 def SetMacPreferencesMenuItemId(*args, **kwargs):
c24da6d6 7314 """SetMacPreferencesMenuItemId(long val)"""
d55e5bfc
RD		 7315 return _core_.PyApp_SetMacPreferencesMenuItemId(*args, **kwargs)
7316
7317 SetMacPreferencesMenuItemId = staticmethod(SetMacPreferencesMenuItemId)
7318 def SetMacExitMenuItemId(*args, **kwargs):
c24da6d6 7319 """SetMacExitMenuItemId(long val)"""
d55e5bfc
RD		 7320 return _core_.PyApp_SetMacExitMenuItemId(*args, **kwargs)
7321
7322 SetMacExitMenuItemId = staticmethod(SetMacExitMenuItemId)
7323 def SetMacHelpMenuTitleName(*args, **kwargs):
c24da6d6 7324 """SetMacHelpMenuTitleName(String val)"""
d55e5bfc
RD		 7325 return _core_.PyApp_SetMacHelpMenuTitleName(*args, **kwargs)
7326
7327 SetMacHelpMenuTitleName = staticmethod(SetMacHelpMenuTitleName)
7328 def _BootstrapApp(*args, **kwargs):
7329 """
7330 _BootstrapApp(self)
7331
7332 For internal use only
7333 """
7334 return _core_.PyApp__BootstrapApp(*args, **kwargs)
7335
7336 def GetComCtl32Version(*args, **kwargs):
7337 """
c24da6d6 7338 GetComCtl32Version() -> int
d55e5bfc 7339
c24da6d6
RD		 7340 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
7341 it wasn't found at all. Raises an exception on non-Windows platforms.
d55e5bfc
RD		 7342 """
7343 return _core_.PyApp_GetComCtl32Version(*args, **kwargs)
7344
7345 GetComCtl32Version = staticmethod(GetComCtl32Version)
33d6fd3b 7346 def IsDisplayAvailable(*args, **kwargs):
fc46b7f3 7347 """
33d6fd3b 7348 IsDisplayAvailable() -> bool
fc46b7f3
RD		 7349
7350 Tests if it is possible to create a GUI in the current environment.
7351 This will mean different things on the different platforms.
7352
7353 * On X Windows systems this function will return ``False`` if it is
7354 not able to open a connection to the X display, which can happen
7355 if $DISPLAY is not set, or is not set correctly.
7356
7357 * On Mac OS X a ``False`` return value will mean that wx is not
7358 able to access the window manager, which can happen if logged in
7359 remotely or if running from the normal version of python instead
7360 of the framework version, (i.e., pythonw.)
7361
7362 * On MS Windows...
7363
7364 """
33d6fd3b
RD		 7365 return _core_.PyApp_IsDisplayAvailable(*args, **kwargs)
7366
7367 IsDisplayAvailable = staticmethod(IsDisplayAvailable)
7368 AppName = property(GetAppName,SetAppName,doc="See `GetAppName` and `SetAppName`")
7369 AssertMode = property(GetAssertMode,SetAssertMode,doc="See `GetAssertMode` and `SetAssertMode`")
7370 ClassName = property(GetClassName,SetClassName,doc="See `GetClassName` and `SetClassName`")
7371 ExitOnFrameDelete = property(GetExitOnFrameDelete,SetExitOnFrameDelete,doc="See `GetExitOnFrameDelete` and `SetExitOnFrameDelete`")
7372 LayoutDirection = property(GetLayoutDirection,doc="See `GetLayoutDirection`")
7373 PrintMode = property(GetPrintMode,SetPrintMode,doc="See `GetPrintMode` and `SetPrintMode`")
7374 TopWindow = property(GetTopWindow,SetTopWindow,doc="See `GetTopWindow` and `SetTopWindow`")
7375 Traits = property(GetTraits,doc="See `GetTraits`")
7376 UseBestVisual = property(GetUseBestVisual,SetUseBestVisual,doc="See `GetUseBestVisual` and `SetUseBestVisual`")
7377 VendorName = property(GetVendorName,SetVendorName,doc="See `GetVendorName` and `SetVendorName`")
7378 Active = property(IsActive)
2131d850 7379_core_.PyApp_swigregister(PyApp)
d55e5bfc 7380
554f62e9
RD		 7381def PyApp_IsMainLoopRunning(*args):
7382 """
84f85550
RD		 7383 PyApp_IsMainLoopRunning() -> bool
7384
7385 Returns True if we're running the main loop, i.e. if the events can
7386 currently be dispatched.
7387 """
554f62e9 7388 return _core_.PyApp_IsMainLoopRunning(*args)
84f85550 7389
554f62e9
RD		 7390def PyApp_GetMacSupportPCMenuShortcuts(*args):
7391 """PyApp_GetMacSupportPCMenuShortcuts() -> bool"""
7392 return _core_.PyApp_GetMacSupportPCMenuShortcuts(*args)
d55e5bfc 7393
554f62e9
RD		 7394def PyApp_GetMacAboutMenuItemId(*args):
7395 """PyApp_GetMacAboutMenuItemId() -> long"""
7396 return _core_.PyApp_GetMacAboutMenuItemId(*args)
d55e5bfc 7397
554f62e9
RD		 7398def PyApp_GetMacPreferencesMenuItemId(*args):
7399 """PyApp_GetMacPreferencesMenuItemId() -> long"""
7400 return _core_.PyApp_GetMacPreferencesMenuItemId(*args)
d55e5bfc 7401
554f62e9
RD		 7402def PyApp_GetMacExitMenuItemId(*args):
7403 """PyApp_GetMacExitMenuItemId() -> long"""
7404 return _core_.PyApp_GetMacExitMenuItemId(*args)
d55e5bfc 7405
554f62e9
RD		 7406def PyApp_GetMacHelpMenuTitleName(*args):
7407 """PyApp_GetMacHelpMenuTitleName() -> String"""
7408 return _core_.PyApp_GetMacHelpMenuTitleName(*args)
d55e5bfc
RD		 7409
7410def PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs):
554f62e9
RD		 7411 """PyApp_SetMacSupportPCMenuShortcuts(bool val)"""
7412 return _core_.PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs)
d55e5bfc
RD		 7413
7414def PyApp_SetMacAboutMenuItemId(*args, **kwargs):
554f62e9
RD		 7415 """PyApp_SetMacAboutMenuItemId(long val)"""
7416 return _core_.PyApp_SetMacAboutMenuItemId(*args, **kwargs)
d55e5bfc
RD		 7417
7418def PyApp_SetMacPreferencesMenuItemId(*args, **kwargs):
554f62e9
RD		 7419 """PyApp_SetMacPreferencesMenuItemId(long val)"""
7420 return _core_.PyApp_SetMacPreferencesMenuItemId(*args, **kwargs)
d55e5bfc
RD		 7421
7422def PyApp_SetMacExitMenuItemId(*args, **kwargs):
554f62e9
RD		 7423 """PyApp_SetMacExitMenuItemId(long val)"""
7424 return _core_.PyApp_SetMacExitMenuItemId(*args, **kwargs)
d55e5bfc
RD		 7425
7426def PyApp_SetMacHelpMenuTitleName(*args, **kwargs):
554f62e9
RD		 7427 """PyApp_SetMacHelpMenuTitleName(String val)"""
7428 return _core_.PyApp_SetMacHelpMenuTitleName(*args, **kwargs)
d55e5bfc 7429
554f62e9
RD		 7430def PyApp_GetComCtl32Version(*args):
7431 """
d55e5bfc
RD		 7432 PyApp_GetComCtl32Version() -> int
7433
c24da6d6
RD		 7434 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
7435 it wasn't found at all. Raises an exception on non-Windows platforms.
d55e5bfc 7436 """
554f62e9 7437 return _core_.PyApp_GetComCtl32Version(*args)
d55e5bfc 7438
33d6fd3b 7439def PyApp_IsDisplayAvailable(*args):
fc46b7f3 7440 """
33d6fd3b 7441 PyApp_IsDisplayAvailable() -> bool
fc46b7f3
RD		 7442
7443 Tests if it is possible to create a GUI in the current environment.
7444 This will mean different things on the different platforms.
7445
7446 * On X Windows systems this function will return ``False`` if it is
7447 not able to open a connection to the X display, which can happen
7448 if $DISPLAY is not set, or is not set correctly.
7449
7450 * On Mac OS X a ``False`` return value will mean that wx is not
7451 able to access the window manager, which can happen if logged in
7452 remotely or if running from the normal version of python instead
7453 of the framework version, (i.e., pythonw.)
7454
7455 * On MS Windows...
7456
7457 """
33d6fd3b 7458 return _core_.PyApp_IsDisplayAvailable(*args)
fc46b7f3 7459
d55e5bfc
RD		 7460#---------------------------------------------------------------------------
7461
7462
554f62e9
RD		 7463def Exit(*args):
7464 """
d55e5bfc
RD		 7465 Exit()
7466
7467 Force an exit of the application. Convenience for wx.GetApp().Exit()
7468 """
554f62e9 7469 return _core_.Exit(*args)
d55e5bfc 7470
554f62e9
RD		 7471def Yield(*args):
7472 """
d55e5bfc
RD		 7473 Yield() -> bool
7474
7475 Yield to other apps/messages. Convenience for wx.GetApp().Yield()
7476 """
554f62e9 7477 return _core_.Yield(*args)
d55e5bfc 7478
554f62e9
RD		 7479def YieldIfNeeded(*args):
7480 """
d55e5bfc
RD		 7481 YieldIfNeeded() -> bool
7482
7483 Yield to other apps/messages. Convenience for wx.GetApp().Yield(True)
7484 """
554f62e9 7485 return _core_.YieldIfNeeded(*args)
d55e5bfc
RD		 7486
7487def SafeYield(*args, **kwargs):
554f62e9 7488 """
d55e5bfc
RD		 7489 SafeYield(Window win=None, bool onlyIfNeeded=False) -> bool
7490
c24da6d6
RD		 7491 This function is similar to `wx.Yield`, except that it disables the
7492 user input to all program windows before calling `wx.Yield` and
7493 re-enables it again afterwards. If ``win`` is not None, this window
7494 will remain enabled, allowing the implementation of some limited user
7495 interaction.
d55e5bfc 7496
c24da6d6 7497 :Returns: the result of the call to `wx.Yield`.
d55e5bfc 7498 """
554f62e9 7499 return _core_.SafeYield(*args, **kwargs)
d55e5bfc 7500
554f62e9
RD		 7501def WakeUpIdle(*args):
7502 """
d55e5bfc
RD		 7503 WakeUpIdle()
7504
c24da6d6
RD		 7505 Cause the message queue to become empty again, so idle events will be
7506 sent.
d55e5bfc 7507 """
554f62e9 7508 return _core_.WakeUpIdle(*args)
d55e5bfc
RD		 7509
7510def PostEvent(*args, **kwargs):
554f62e9 7511 """
d55e5bfc
RD		 7512 PostEvent(EvtHandler dest, Event event)
7513
c24da6d6
RD		 7514 Send an event to a window or other wx.EvtHandler to be processed
7515 later.
d55e5bfc 7516 """
554f62e9 7517 return _core_.PostEvent(*args, **kwargs)
d55e5bfc 7518
554f62e9
RD		 7519def App_CleanUp(*args):
7520 """
d55e5bfc
RD		 7521 App_CleanUp()
7522
79fccf9d 7523 For internal use only, it is used to cleanup after wxWidgets when
c24da6d6 7524 Python shuts down.
d55e5bfc 7525 """
554f62e9 7526 return _core_.App_CleanUp(*args)
d55e5bfc 7527
554f62e9
RD		 7528def GetApp(*args):
7529 """
d55e5bfc
RD		 7530 GetApp() -> PyApp
7531
7532 Return a reference to the current wx.App object.
7533 """
554f62e9 7534 return _core_.GetApp(*args)
5cbf236d
RD		 7535
7536def SetDefaultPyEncoding(*args, **kwargs):
554f62e9 7537 """
5cbf236d
RD		 7538 SetDefaultPyEncoding(string encoding)
7539
7540 Sets the encoding that wxPython will use when it needs to convert a
7541 Python string or unicode object to or from a wxString.
62d32a5f
RD		 7542
7543 The default encoding is the value of ``locale.getdefaultlocale()[1]``
7544 but please be aware that the default encoding within the same locale
7545 may be slightly different on different platforms. For example, please
7546 see http://www.alanwood.net/demos/charsetdiffs.html for differences
7547 between the common latin/roman encodings.
5cbf236d 7548 """
554f62e9 7549 return _core_.SetDefaultPyEncoding(*args, **kwargs)
5cbf236d 7550
554f62e9
RD		 7551def GetDefaultPyEncoding(*args):
7552 """
5cbf236d
RD		 7553 GetDefaultPyEncoding() -> string
7554
7555 Gets the current encoding that wxPython will use when it needs to
7556 convert a Python string or unicode object to or from a wxString.
7557 """
554f62e9 7558 return _core_.GetDefaultPyEncoding(*args)
d55e5bfc
RD		 7559#----------------------------------------------------------------------
7560
7561class PyOnDemandOutputWindow:
7562 """
7563 A class that can be used for redirecting Python's stdout and
7564 stderr streams. It will do nothing until something is wrriten to
7565 the stream at which point it will create a Frame with a text area
7566 and write the text there.
7567 """
7568 def __init__(self, title = "wxPython: stdout/stderr"):
7569 self.frame = None
7570 self.title = title
412d302d
RD		 7571 self.pos = wx.DefaultPosition
7572 self.size = (450, 300)
d55e5bfc
RD		 7573 self.parent = None
7574
7575 def SetParent(self, parent):
7576 """Set the window to be used as the popup Frame's parent."""
7577 self.parent = parent
7578
7579
7580 def CreateOutputWindow(self, st):
412d302d
RD		 7581 self.frame = wx.Frame(self.parent, -1, self.title, self.pos, self.size,
7582 style=wx.DEFAULT_FRAME_STYLE)
d55e5bfc 7583 self.text = wx.TextCtrl(self.frame, -1, "",
412d302d 7584 style=wx.TE_MULTILINE|wx.TE_READONLY)
d55e5bfc 7585 self.text.AppendText(st)
d55e5bfc 7586 self.frame.Show(True)
2131d850 7587 self.frame.Bind(wx.EVT_CLOSE, self.OnCloseWindow)
d55e5bfc
RD		 7588
7589
7590 def OnCloseWindow(self, event):
7591 if self.frame is not None:
7592 self.frame.Destroy()
7593 self.frame = None
7594 self.text = None
7595
7596
7597 # These methods provide the file-like output behaviour.
7598 def write(self, text):
7599 """
7600 Create the output window if needed and write the string to it.
7601 If not called in the context of the gui thread then uses
7602 CallAfter to do the work there.
7603 """
7604 if self.frame is None:
7605 if not wx.Thread_IsMain():
7606 wx.CallAfter(self.CreateOutputWindow, text)
7607 else:
7608 self.CreateOutputWindow(text)
7609 else:
7610 if not wx.Thread_IsMain():
7611 wx.CallAfter(self.text.AppendText, text)
7612 else:
7613 self.text.AppendText(text)
7614
7615
7616 def close(self):
7617 if self.frame is not None:
7618 wx.CallAfter(self.frame.Close)
7619
7620
19272049
RD		 7621 def flush(self):
7622 pass
7623
7624
d55e5bfc
RD		 7625
7626#----------------------------------------------------------------------
7627
7628_defRedirect = (wx.Platform == '__WXMSW__' or wx.Platform == '__WXMAC__')
fc46b7f3 7629
d55e5bfc
RD		 7630class App(wx.PyApp):
7631 """
c24da6d6
RD		 7632 The ``wx.App`` class represents the application and is used to:
7633
7634 * bootstrap the wxPython system and initialize the underlying
7635 gui toolkit
7636 * set and get application-wide properties
7637 * implement the windowing system main message or event loop,
7638 and to dispatch events to window instances
7639 * etc.
7640
7641 Every application must have a ``wx.App`` instance, and all
7642 creation of UI objects should be delayed until after the
7643 ``wx.App`` object has been created in order to ensure that the gui
7644 platform and wxWidgets have been fully initialized.
7645
7646 Normally you would derive from this class and implement an
7647 ``OnInit`` method that creates a frame and then calls
7648 ``self.SetTopWindow(frame)``.
7649
7650 :see: `wx.PySimpleApp` for a simpler app class that can be used
79fccf9d 7651 directly.
d55e5bfc 7652 """
c24da6d6 7653
d55e5bfc
RD		 7654 outputWindowClass = PyOnDemandOutputWindow
7655
c24da6d6
RD		 7656 def __init__(self, redirect=_defRedirect, filename=None,
7657 useBestVisual=False, clearSigInt=True):
7658 """
7659 Construct a ``wx.App`` object.
7660
7661 :param redirect: Should ``sys.stdout`` and ``sys.stderr`` be
7662 redirected? Defaults to True on Windows and Mac, False
7663 otherwise. If `filename` is None then output will be
7664 redirected to a window that pops up as needed. (You can
7665 control what kind of window is created for the output by
7666 resetting the class variable ``outputWindowClass`` to a
7667 class of your choosing.)
7668
7669 :param filename: The name of a file to redirect output to, if
7670 redirect is True.
7671
7672 :param useBestVisual: Should the app try to use the best
7673 available visual provided by the system (only relevant on
7674 systems that have more than one visual.) This parameter
7675 must be used instead of calling `SetUseBestVisual` later
7676 on because it must be set before the underlying GUI
7677 toolkit is initialized.
7678
7679 :param clearSigInt: Should SIGINT be cleared? This allows the
7680 app to terminate upon a Ctrl-C in the console like other
7681 GUI apps will.
7682
7683 :note: You should override OnInit to do applicaition
7684 initialization to ensure that the system, toolkit and
7685 wxWidgets are fully initialized.
7686 """
fc46b7f3 7687
d55e5bfc
RD		 7688 wx.PyApp.__init__(self)
7689
fc46b7f3 7690 # make sure we can create a GUI
33d6fd3b 7691 if not self.IsDisplayAvailable():
fc46b7f3
RD		 7692
7693 if wx.Platform == "__WXMAC__":
7694 msg = """This program needs access to the screen.
7695Please run with 'pythonw', not 'python', and only when you are logged
7696in on the main display of your Mac."""
7697
7698 elif wx.Platform == "__WXGTK__":
7699 msg ="Unable to access the X Display, is $DISPLAY set properly?"
d55e5bfc 7700
fc46b7f3
RD		 7701 else:
7702 msg = "Unable to create GUI"
7703 # TODO: more description is needed for wxMSW...
7704
7705 raise SystemExit(msg)
7706
d55e5bfc
RD		 7707 # This has to be done before OnInit
7708 self.SetUseBestVisual(useBestVisual)
7709
7710 # Set the default handler for SIGINT. This fixes a problem
7711 # where if Ctrl-C is pressed in the console that started this
7712 # app then it will not appear to do anything, (not even send
7713 # KeyboardInterrupt???) but will later segfault on exit. By
7714 # setting the default handler then the app will exit, as
7715 # expected (depending on platform.)
c24da6d6
RD		 7716 if clearSigInt:
7717 try:
7718 import signal
7719 signal.signal(signal.SIGINT, signal.SIG_DFL)
7720 except:
7721 pass
d55e5bfc
RD		 7722
7723 # Save and redirect the stdio to a window?
7724 self.stdioWin = None
7725 self.saveStdio = (_sys.stdout, _sys.stderr)
7726 if redirect:
7727 self.RedirectStdio(filename)
7728
8fb0e70a
RD		 7729 # Use Python's install prefix as the default
7730 wx.StandardPaths.Get().SetInstallPrefix(_sys.prefix)
7731
d55e5bfc
RD		 7732 # This finishes the initialization of wxWindows and then calls
7733 # the OnInit that should be present in the derived class
7734 self._BootstrapApp()
7735
7736
f460c29d
RD		 7737 def OnPreInit(self):
7738 """
7739 Things that must be done after _BootstrapApp has done its
7740 thing, but would be nice if they were already done by the time
7741 that OnInit is called.
7742 """
7743 wx.StockGDI._initStockObjects()
7744
7745
66af7a75
RD		 7746 def __del__(self, destroy=wx.PyApp.__del__):
7747 self.RestoreStdio() # Just in case the MainLoop was overridden
7748 destroy(self)
d55e5bfc 7749
70b7a5fe 7750 def Destroy(self):
b39fe951 7751 self.this.own(False)
70b7a5fe 7752 wx.PyApp.Destroy(self)
d55e5bfc
RD		 7753
7754 def SetTopWindow(self, frame):
7755 """Set the \"main\" top level window"""
7756 if self.stdioWin:
7757 self.stdioWin.SetParent(frame)
7758 wx.PyApp.SetTopWindow(self, frame)
7759
7760
7761 def MainLoop(self):
7762 """Execute the main GUI event loop"""
7763 wx.PyApp.MainLoop(self)
7764 self.RestoreStdio()
7765
7766
7767 def RedirectStdio(self, filename=None):
7768 """Redirect sys.stdout and sys.stderr to a file or a popup window."""
7769 if filename:
7770 _sys.stdout = _sys.stderr = open(filename, 'a')
7771 else:
7772 self.stdioWin = self.outputWindowClass()
7773 _sys.stdout = _sys.stderr = self.stdioWin
7774
7775
7776 def RestoreStdio(self):
66af7a75
RD		 7777 try:
7778 _sys.stdout, _sys.stderr = self.saveStdio
7779 except:
7780 pass
d55e5bfc
RD		 7781
7782
412d302d
RD		 7783 def SetOutputWindowAttributes(self, title=None, pos=None, size=None):
7784 """
7785 Set the title, position and/or size of the output window if
f5b96ee1
RD		 7786 the stdio has been redirected. This should be called before
7787 any output would cause the output window to be created.
412d302d
RD		 7788 """
7789 if self.stdioWin:
7790 if title is not None:
7791 self.stdioWin.title = title
7792 if pos is not None:
7793 self.stdioWin.pos = pos
7794 if size is not None:
7795 self.stdioWin.size = size
7796
7797
7798
d55e5bfc 7799
c24da6d6 7800# change from wx.PyApp_XX to wx.App_XX
d55e5bfc
RD		 7801App_GetMacSupportPCMenuShortcuts = _core_.PyApp_GetMacSupportPCMenuShortcuts
7802App_GetMacAboutMenuItemId = _core_.PyApp_GetMacAboutMenuItemId
7803App_GetMacPreferencesMenuItemId = _core_.PyApp_GetMacPreferencesMenuItemId
7804App_GetMacExitMenuItemId = _core_.PyApp_GetMacExitMenuItemId
7805App_GetMacHelpMenuTitleName = _core_.PyApp_GetMacHelpMenuTitleName
7806App_SetMacSupportPCMenuShortcuts = _core_.PyApp_SetMacSupportPCMenuShortcuts
7807App_SetMacAboutMenuItemId = _core_.PyApp_SetMacAboutMenuItemId
7808App_SetMacPreferencesMenuItemId = _core_.PyApp_SetMacPreferencesMenuItemId
7809App_SetMacExitMenuItemId = _core_.PyApp_SetMacExitMenuItemId
7810App_SetMacHelpMenuTitleName = _core_.PyApp_SetMacHelpMenuTitleName
7811App_GetComCtl32Version = _core_.PyApp_GetComCtl32Version
7812
7813#----------------------------------------------------------------------------
7814
7815class PySimpleApp(wx.App):
7816 """
7817 A simple application class. You can just create one of these and
7818 then then make your top level windows later, and not have to worry
c24da6d6 7819 about OnInit. For example::
d55e5bfc 7820
c24da6d6
RD		 7821 app = wx.PySimpleApp()
7822 frame = wx.Frame(None, title='Hello World')
7823 frame.Show()
7824 app.MainLoop()
7825
7826 :see: `wx.App`
7827 """
7828
7829 def __init__(self, redirect=False, filename=None,
7830 useBestVisual=False, clearSigInt=True):
7831 """
7832 :see: `wx.App.__init__`
7833 """
7834 wx.App.__init__(self, redirect, filename, useBestVisual, clearSigInt)
d55e5bfc
RD		 7835
7836 def OnInit(self):
d55e5bfc
RD		 7837 return True
7838
7839
c24da6d6 7840
d55e5bfc
RD		 7841# Is anybody using this one?
7842class PyWidgetTester(wx.App):
7843 def __init__(self, size = (250, 100)):
7844 self.size = size
7845 wx.App.__init__(self, 0)
7846
7847 def OnInit(self):
7848 self.frame = wx.Frame(None, -1, "Widget Tester", pos=(0,0), size=self.size)
7849 self.SetTopWindow(self.frame)
7850 return True
7851
c24da6d6
RD		 7852 def SetWidget(self, widgetClass, *args, **kwargs):
7853 w = widgetClass(self.frame, *args, **kwargs)
d55e5bfc
RD		 7854 self.frame.Show(True)
7855
7856#----------------------------------------------------------------------------
7857# DO NOT hold any other references to this object. This is how we
c24da6d6 7858# know when to cleanup system resources that wxWidgets is holding. When
d55e5bfc 7859# the sys module is unloaded, the refcount on sys.__wxPythonCleanup
c24da6d6 7860# goes to zero and it calls the wx.App_CleanUp function.
d55e5bfc
RD		 7861
7862class __wxPyCleanup:
7863 def __init__(self):
7864 self.cleanup = _core_.App_CleanUp
7865 def __del__(self):
7866 self.cleanup()
7867
7868_sys.__wxPythonCleanup = __wxPyCleanup()
7869
7870## # another possible solution, but it gets called too early...
c24da6d6
RD		 7871## import atexit
7872## atexit.register(_core_.wxApp_CleanUp)
d55e5bfc
RD		 7873
7874
7875#----------------------------------------------------------------------------
7876
7877#---------------------------------------------------------------------------
7878
ae8162c8 7879class EventLoop(object):
093d3ff1 7880 """Proxy of C++ EventLoop class"""
554f62e9
RD		 7881 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7882 __repr__ = _swig_repr
7883 def __init__(self, *args, **kwargs):
ae8162c8 7884 """__init__(self) -> EventLoop"""
554f62e9
RD		 7885 _core_.EventLoop_swiginit(self,_core_.new_EventLoop(*args, **kwargs))
7886 __swig_destroy__ = _core_.delete_EventLoop
7887 __del__ = lambda self : None;
ae8162c8
RD		 7888 def Run(*args, **kwargs):
7889 """Run(self) -> int"""
7890 return _core_.EventLoop_Run(*args, **kwargs)
7891
7892 def Exit(*args, **kwargs):
7893 """Exit(self, int rc=0)"""
7894 return _core_.EventLoop_Exit(*args, **kwargs)
7895
7896 def Pending(*args, **kwargs):
7897 """Pending(self) -> bool"""
7898 return _core_.EventLoop_Pending(*args, **kwargs)
7899
7900 def Dispatch(*args, **kwargs):
7901 """Dispatch(self) -> bool"""
7902 return _core_.EventLoop_Dispatch(*args, **kwargs)
7903
7904 def IsRunning(*args, **kwargs):
7905 """IsRunning(self) -> bool"""
7906 return _core_.EventLoop_IsRunning(*args, **kwargs)
7907
7908 def GetActive(*args, **kwargs):
7909 """GetActive() -> EventLoop"""
7910 return _core_.EventLoop_GetActive(*args, **kwargs)
7911
7912 GetActive = staticmethod(GetActive)
7913 def SetActive(*args, **kwargs):
7914 """SetActive(EventLoop loop)"""
7915 return _core_.EventLoop_SetActive(*args, **kwargs)
7916
7917 SetActive = staticmethod(SetActive)
2131d850 7918_core_.EventLoop_swigregister(EventLoop)
ae8162c8 7919
554f62e9
RD		 7920def EventLoop_GetActive(*args):
7921 """EventLoop_GetActive() -> EventLoop"""
7922 return _core_.EventLoop_GetActive(*args)
ae8162c8
RD		 7923
7924def EventLoop_SetActive(*args, **kwargs):
554f62e9
RD		 7925 """EventLoop_SetActive(EventLoop loop)"""
7926 return _core_.EventLoop_SetActive(*args, **kwargs)
ae8162c8 7927
7449af73
RD		 7928class EventLoopActivator(object):
7929 """Proxy of C++ EventLoopActivator class"""
554f62e9
RD		 7930 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7931 __repr__ = _swig_repr
7932 def __init__(self, *args, **kwargs):
7449af73 7933 """__init__(self, EventLoop evtLoop) -> EventLoopActivator"""
554f62e9
RD		 7934 _core_.EventLoopActivator_swiginit(self,_core_.new_EventLoopActivator(*args, **kwargs))
7935 __swig_destroy__ = _core_.delete_EventLoopActivator
7936 __del__ = lambda self : None;
2131d850 7937_core_.EventLoopActivator_swigregister(EventLoopActivator)
7449af73 7938
ae8162c8
RD		 7939#---------------------------------------------------------------------------
7940
eec1c382
RD		 7941ACCEL_ALT = _core_.ACCEL_ALT
7942ACCEL_CTRL = _core_.ACCEL_CTRL
7943ACCEL_SHIFT = _core_.ACCEL_SHIFT
7944ACCEL_NORMAL = _core_.ACCEL_NORMAL
7945ACCEL_CMD = _core_.ACCEL_CMD
d55e5bfc 7946class AcceleratorEntry(object):
c24da6d6
RD		 7947 """
7948 A class used to define items in an `wx.AcceleratorTable`. wxPython
7949 programs can choose to use wx.AcceleratorEntry objects, but using a
7950 list of 3-tuple of integers (flags, keyCode, cmdID) usually works just
79fccf9d 7951 as well. See `__init__` for of the tuple values.
c24da6d6
RD		 7952
7953 :see: `wx.AcceleratorTable`
7954 """
554f62e9
RD		 7955 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7956 __repr__ = _swig_repr
7957 def __init__(self, *args, **kwargs):
c24da6d6
RD		 7958 """
7959 __init__(self, int flags=0, int keyCode=0, int cmdID=0) -> AcceleratorEntry
7960
7961 Construct a wx.AcceleratorEntry.
c24da6d6 7962 """
554f62e9
RD		 7963 _core_.AcceleratorEntry_swiginit(self,_core_.new_AcceleratorEntry(*args, **kwargs))
7964 __swig_destroy__ = _core_.delete_AcceleratorEntry
7965 __del__ = lambda self : None;
d55e5bfc 7966 def Set(*args, **kwargs):
c24da6d6
RD		 7967 """
7968 Set(self, int flags, int keyCode, int cmd)
d55e5bfc 7969
c24da6d6
RD		 7970 (Re)set the attributes of a wx.AcceleratorEntry.
7971 :see `__init__`
7972 """
7973 return _core_.AcceleratorEntry_Set(*args, **kwargs)
d55e5bfc 7974
97ab0f6a
RD		 7975 def Create(*args, **kwargs):
7976 """
7977 Create(String str) -> AcceleratorEntry
7978
7979 Create accelerator corresponding to the specified string, or None if
7980 it coulnd't be parsed.
7981 """
7982 return _core_.AcceleratorEntry_Create(*args, **kwargs)
7983
7984 Create = staticmethod(Create)
d55e5bfc 7985 def GetFlags(*args, **kwargs):
c24da6d6
RD		 7986 """
7987 GetFlags(self) -> int
7988
7989 Get the AcceleratorEntry's flags.
7990 """
d55e5bfc
RD		 7991 return _core_.AcceleratorEntry_GetFlags(*args, **kwargs)
7992
7993 def GetKeyCode(*args, **kwargs):
c24da6d6
RD		 7994 """
7995 GetKeyCode(self) -> int
7996
7997 Get the AcceleratorEntry's keycode.
7998 """
d55e5bfc
RD		 7999 return _core_.AcceleratorEntry_GetKeyCode(*args, **kwargs)
8000
8001 def GetCommand(*args, **kwargs):
c24da6d6
RD		 8002 """
8003 GetCommand(self) -> int
8004
8005 Get the AcceleratorEntry's command ID.
8006 """
d55e5bfc
RD		 8007 return _core_.AcceleratorEntry_GetCommand(*args, **kwargs)
8008
97ab0f6a
RD		 8009 def IsOk(*args, **kwargs):
8010 """IsOk(self) -> bool"""
8011 return _core_.AcceleratorEntry_IsOk(*args, **kwargs)
8012
8013 def ToString(*args, **kwargs):
8014 """
8015 ToString(self) -> String
8016
8017 Returns a string representation for the this accelerator. The string
8018 is formatted using the <flags>-<keycode> format where <flags> maybe a
8019 hyphen-separed list of "shift|alt|ctrl"
8020
8021 """
8022 return _core_.AcceleratorEntry_ToString(*args, **kwargs)
8023
8024 def FromString(*args, **kwargs):
8025 """
8026 FromString(self, String str) -> bool
8027
8028 Returns true if the given string correctly initialized this object.
8029 """
8030 return _core_.AcceleratorEntry_FromString(*args, **kwargs)
8031
226118fc
RD		 8032 Command = property(GetCommand,doc="See `GetCommand`")
8033 Flags = property(GetFlags,doc="See `GetFlags`")
8034 KeyCode = property(GetKeyCode,doc="See `GetKeyCode`")
2131d850 8035_core_.AcceleratorEntry_swigregister(AcceleratorEntry)
d55e5bfc 8036
97ab0f6a
RD		 8037def AcceleratorEntry_Create(*args, **kwargs):
8038 """
8039 AcceleratorEntry_Create(String str) -> AcceleratorEntry
8040
8041 Create accelerator corresponding to the specified string, or None if
8042 it coulnd't be parsed.
8043 """
8044 return _core_.AcceleratorEntry_Create(*args, **kwargs)
8045
d55e5bfc 8046class AcceleratorTable(Object):
c24da6d6
RD		 8047 """
8048 An accelerator table allows the application to specify a table of
8049 keyboard shortcuts for menus or other commands. On Windows, menu or
8050 button commands are supported; on GTK, only menu commands are
8051 supported.
c24da6d6 8052 """
554f62e9
RD		 8053 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
8054 __repr__ = _swig_repr
8055 def __init__(self, *args, **kwargs):
d55e5bfc
RD		 8056 """
8057 __init__(entries) -> AcceleratorTable
8058
c24da6d6
RD		 8059 Construct an AcceleratorTable from a list of `wx.AcceleratorEntry`
8060 items or or of 3-tuples (flags, keyCode, cmdID)
8061
8062 :see: `wx.AcceleratorEntry`
d55e5bfc 8063 """
554f62e9
RD		 8064 _core_.AcceleratorTable_swiginit(self,_core_.new_AcceleratorTable(*args, **kwargs))
8065 __swig_destroy__ = _core_.delete_AcceleratorTable
8066 __del__ = lambda self : None;
b39fe951
RD		 8067 def IsOk(*args, **kwargs):
8068 """IsOk(self) -> bool"""
8069 return _core_.AcceleratorTable_IsOk(*args, **kwargs)
d55e5bfc 8070
b39fe951 8071 Ok = IsOk
2131d850 8072_core_.AcceleratorTable_swigregister(AcceleratorTable)
d55e5bfc
RD		 8073
8074
8075def GetAccelFromString(*args, **kwargs):
554f62e9
RD		 8076 """GetAccelFromString(String label) -> AcceleratorEntry"""
8077 return _core_.GetAccelFromString(*args, **kwargs)
d55e5bfc
RD		 8078#---------------------------------------------------------------------------
8079
8080class VisualAttributes(object):
8081 """struct containing all the visual attributes of a control"""
554f62e9
RD		 8082 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
8083 __repr__ = _swig_repr
8084 def __init__(self, *args, **kwargs):
d55e5bfc
RD		 8085 """
8086 __init__(self) -> VisualAttributes
8087
8088 struct containing all the visual attributes of a control
8089 """
554f62e9
RD		 8090 _core_.VisualAttributes_swiginit(self,_core_.new_VisualAttributes(*args, **kwargs))
8091 __swig_destroy__ = _core_.delete_VisualAttributes
8092 __del__ = lambda self : None;
d55e5bfc
RD		 8093 font = property(_core_.VisualAttributes_font_get, _core_.VisualAttributes_font_set)
8094 colFg = property(_core_.VisualAttributes_colFg_get, _core_.VisualAttributes_colFg_set)
8095 colBg = property(_core_.VisualAttributes_colBg_get, _core_.VisualAttributes_colBg_set)
2131d850 8096_core_.VisualAttributes_swigregister(VisualAttributes)
d55e5bfc
RD		 8097NullAcceleratorTable = cvar.NullAcceleratorTable
8098PanelNameStr = cvar.PanelNameStr
8099
8100WINDOW_VARIANT_NORMAL = _core_.WINDOW_VARIANT_NORMAL
8101WINDOW_VARIANT_SMALL = _core_.WINDOW_VARIANT_SMALL
8102WINDOW_VARIANT_MINI = _core_.WINDOW_VARIANT_MINI
8103WINDOW_VARIANT_LARGE = _core_.WINDOW_VARIANT_LARGE
8104WINDOW_VARIANT_MAX = _core_.WINDOW_VARIANT_MAX
8105class Window(EvtHandler):
8106 """
8107 wx.Window is the base class for all windows and represents any visible
8108 object on the screen. All controls, top level windows and so on are
8109 wx.Windows. Sizers and device contexts are not however, as they don't
8110 appear on screen themselves.
8111
8112 """
554f62e9
RD		 8113 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
8114 __repr__ = _swig_repr
8115 def __init__(self, *args, **kwargs):
d55e5bfc
RD		 8116 """
8117 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
8118 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> Window
8119
8120 Construct and show a generic Window.
8121 """
554f62e9 8122 _core_.Window_swiginit(self,_core_.new_Window(*args, **kwargs))
d55e5bfc
RD		 8123 self._setOORInfo(self)
8124
8125 def Create(*args, **kwargs):
8126 """
8127 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
8128 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> bool
8129
8130 Create the GUI part of the Window for 2-phase creation mode.
8131 """
8132 return _core_.Window_Create(*args, **kwargs)
8133
8134 def Close(*args, **kwargs):
8135 """
8136 Close(self, bool force=False) -> bool
8137
8138 This function simply generates a EVT_CLOSE event whose handler usually
8139 tries to close the window. It doesn't close the window itself,
8140 however. If force is False (the default) then the window's close
8141 handler will be allowed to veto the destruction of the window.
d55e5bfc
RD		 8142 """
8143 return _core_.Window_Close(*args, **kwargs)
8144
8145 def Destroy(*args, **kwargs):
8146 """
8147 Destroy(self) -> bool
8148
8149 Destroys the window safely. Frames and dialogs are not destroyed
8150 immediately when this function is called -- they are added to a list
8151 of windows to be deleted on idle time, when all the window's events
8152 have been processed. This prevents problems with events being sent to
8153 non-existent windows.
8154
8155 Returns True if the window has either been successfully deleted, or it
8156 has been added to the list of windows pending real deletion.
8157 """
b39fe951
RD		 8158 args[0].this.own(False)
8159 return _core_.Window_Destroy(*args, **kwargs)
d55e5bfc
RD		 8160
8161 def DestroyChildren(*args, **kwargs):
8162 """
8163 DestroyChildren(self) -> bool
8164
79fccf9d
RD		 8165 Destroys all children of a window. Called automatically by the
8166 destructor.
d55e5bfc
RD		 8167 """
8168 return _core_.Window_DestroyChildren(*args, **kwargs)
8169
8170 def IsBeingDeleted(*args, **kwargs):
8171 """
8172 IsBeingDeleted(self) -> bool
8173
8174 Is the window in the process of being deleted?
8175 """
8176 return _core_.Window_IsBeingDeleted(*args, **kwargs)
8177
d55e5bfc
RD		 8178 def SetLabel(*args, **kwargs):
8179 """
8180 SetLabel(self, String label)
8181
8182 Set the text which the window shows in its label if applicable.
8183 """
8184 return _core_.Window_SetLabel(*args, **kwargs)
8185
8186 def GetLabel(*args, **kwargs):
8187 """
8188 GetLabel(self) -> String
8189
79fccf9d
RD		 8190 Generic way of getting a label from any window, for identification
8191 purposes. The interpretation of this function differs from class to
8192 class. For frames and dialogs, the value returned is the title. For
8193 buttons or static text controls, it is the button text. This function
8194 can be useful for meta-programs such as testing tools or special-needs
8195 access programs)which need to identify windows by name.
d55e5bfc
RD		 8196 """
8197 return _core_.Window_GetLabel(*args, **kwargs)
8198
8199 def SetName(*args, **kwargs):
8200 """
8201 SetName(self, String name)
8202
79fccf9d
RD		 8203 Sets the window's name. The window name is used for ressource setting
8204 in X, it is not the same as the window title/label
d55e5bfc
RD		 8205 """
8206 return _core_.Window_SetName(*args, **kwargs)
8207
8208 def GetName(*args, **kwargs):
8209 """
8210 GetName(self) -> String
8211
79fccf9d
RD		 8212 Returns the windows name. This name is not guaranteed to be unique;
8213 it is up to the programmer to supply an appropriate name in the window
8214 constructor or via wx.Window.SetName.
d55e5bfc
RD		 8215 """
8216 return _core_.Window_GetName(*args, **kwargs)
8217
8218 def SetWindowVariant(*args, **kwargs):
8219 """
8220 SetWindowVariant(self, int variant)
8221
79fccf9d
RD		 8222 Sets the variant of the window/font size to use for this window, if
8223 the platform supports variants, for example, wxMac.
d55e5bfc
RD		 8224 """
8225 return _core_.Window_SetWindowVariant(*args, **kwargs)
8226
8227 def GetWindowVariant(*args, **kwargs):
8228 """GetWindowVariant(self) -> int"""
8229 return _core_.Window_GetWindowVariant(*args, **kwargs)
8230
8231 def SetId(*args, **kwargs):
8232 """
8233 SetId(self, int winid)
8234
8235 Sets the identifier of the window. Each window has an integer
8236 identifier. If the application has not provided one, an identifier
8237 will be generated. Normally, the identifier should be provided on
8238 creation and should not be modified subsequently.
8239 """
8240 return _core_.Window_SetId(*args, **kwargs)
8241
8242 def GetId(*args, **kwargs):
8243 """
8244 GetId(self) -> int
8245
8246 Returns the identifier of the window. Each window has an integer
8247 identifier. If the application has not provided one (or the default Id
8248 -1 is used) then an unique identifier with a negative value will be
8249 generated.
8250 """
8251 return _core_.Window_GetId(*args, **kwargs)
8252
8253 def NewControlId(*args, **kwargs):
8254 """
c24da6d6 8255 NewControlId() -> int
d55e5bfc
RD		 8256
8257 Generate a control id for the controls which were not given one.
8258 """
8259 return _core_.Window_NewControlId(*args, **kwargs)
8260
8261 NewControlId = staticmethod(NewControlId)
8262 def NextControlId(*args, **kwargs):
8263 """
c24da6d6 8264 NextControlId(int winid) -> int
d55e5bfc
RD		 8265
8266 Get the id of the control following the one with the given
79fccf9d 8267 autogenerated) id
d55e5bfc
RD		 8268 """
8269 return _core_.Window_NextControlId(*args, **kwargs)
8270
8271 NextControlId = staticmethod(NextControlId)
8272 def PrevControlId(*args, **kwargs):
8273 """
c24da6d6 8274 PrevControlId(int winid) -> int
d55e5bfc
RD		 8275
8276 Get the id of the control preceding the one with the given
79fccf9d 8277 autogenerated) id
d55e5bfc
RD		 8278 """
8279 return _core_.Window_PrevControlId(*args, **kwargs)
8280
8281 PrevControlId = staticmethod(PrevControlId)
97ab0f6a
RD		 8282 def GetLayoutDirection(*args, **kwargs):
8283 """
994453b8 8284 GetLayoutDirection(self) -> int
97ab0f6a
RD		 8285
8286 Get the layout direction (LTR or RTL) for this window. Returns
8287 ``wx.Layout_Default`` if layout direction is not supported.
8288 """
8289 return _core_.Window_GetLayoutDirection(*args, **kwargs)
8290
8291 def SetLayoutDirection(*args, **kwargs):
8292 """
994453b8 8293 SetLayoutDirection(self, int dir)
97ab0f6a
RD		 8294
8295 Set the layout direction (LTR or RTL) for this window.
8296 """
8297 return _core_.Window_SetLayoutDirection(*args, **kwargs)
8298
8299 def AdjustForLayoutDirection(*args, **kwargs):
8300 """
8301 AdjustForLayoutDirection(self, int x, int width, int widthTotal) -> int
8302
8303 Mirror coordinates for RTL layout if this window uses it and if the
8304 mirroring is not done automatically like Win32.
8305 """
8306 return _core_.Window_AdjustForLayoutDirection(*args, **kwargs)
8307
d55e5bfc
RD		 8308 def SetSize(*args, **kwargs):
8309 """
8310 SetSize(self, Size size)
8311
8312 Sets the size of the window in pixels.
8313 """
8314 return _core_.Window_SetSize(*args, **kwargs)
8315
8316 def SetDimensions(*args, **kwargs):
8317 """
8318 SetDimensions(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)
8319
8320 Sets the position and size of the window in pixels. The sizeFlags
8321 parameter indicates the interpretation of the other params if they are
62d32a5f
RD		 8322 equal to -1.
8323
8324 ======================== ======================================
8325 wx.SIZE_AUTO A -1 indicates that a class-specific
8326 default should be used.
8327 wx.SIZE_USE_EXISTING Axisting dimensions should be used if
8328 -1 values are supplied.
8329 wxSIZE_ALLOW_MINUS_ONE Allow dimensions of -1 and less to be
8330 interpreted as real dimensions, not
8331 default values.
8332 ======================== ======================================
8333
d55e5bfc
RD		 8334 """
8335 return _core_.Window_SetDimensions(*args, **kwargs)
8336
8337 def SetRect(*args, **kwargs):
8338 """
8339 SetRect(self, Rect rect, int sizeFlags=SIZE_AUTO)
8340
8341 Sets the position and size of the window in pixels using a wx.Rect.
8342 """
8343 return _core_.Window_SetRect(*args, **kwargs)
8344
8345 def SetSizeWH(*args, **kwargs):
8346 """
8347 SetSizeWH(self, int width, int height)
8348
8349 Sets the size of the window in pixels.
8350 """
8351 return _core_.Window_SetSizeWH(*args, **kwargs)
8352
8353 def Move(*args, **kwargs):
8354 """
8355 Move(self, Point pt, int flags=SIZE_USE_EXISTING)
8356
8357 Moves the window to the given position.
8358 """
8359 return _core_.Window_Move(*args, **kwargs)
8360
8361 SetPosition = Move
8362 def MoveXY(*args, **kwargs):
8363 """
8364 MoveXY(self, int x, int y, int flags=SIZE_USE_EXISTING)
8365
8366 Moves the window to the given position.
8367 """
8368 return _core_.Window_MoveXY(*args, **kwargs)
8369
f8167d6e
RD		 8370 def SetBestFittingSize(*args, **kwargs):
8371 """
8372 SetBestFittingSize(self, Size size=DefaultSize)
8373
8374 A 'Smart' SetSize that will fill in default size components with the
8375 window's *best size* values. Also set's the minsize for use with sizers.
8376 """
8377 return _core_.Window_SetBestFittingSize(*args, **kwargs)
8378
d55e5bfc
RD		 8379 def Raise(*args, **kwargs):
8380 """
8381 Raise(self)
8382
9d7dfdff
RD		 8383 Raises the window to the top of the window hierarchy. In current
8384 version of wxWidgets this works both for manage and child windows.
d55e5bfc
RD		 8385 """
8386 return _core_.Window_Raise(*args, **kwargs)
8387
8388 def Lower(*args, **kwargs):
8389 """
8390 Lower(self)
8391
9d7dfdff
RD		 8392 Lowers the window to the bottom of the window hierarchy. In current
8393 version of wxWidgets this works both for manage and child windows.
d55e5bfc
RD		 8394 """
8395 return _core_.Window_Lower(*args, **kwargs)
8396
8397 def SetClientSize(*args, **kwargs):
8398 """
8399 SetClientSize(self, Size size)
8400
8401 This sets the size of the window client area in pixels. Using this
8402 function to size a window tends to be more device-independent than
8403 wx.Window.SetSize, since the application need not worry about what
8404 dimensions the border or title bar have when trying to fit the window
8405 around panel items, for example.
8406 """
8407 return _core_.Window_SetClientSize(*args, **kwargs)
8408
8409 def SetClientSizeWH(*args, **kwargs):
8410 """
8411 SetClientSizeWH(self, int width, int height)
8412
8413 This sets the size of the window client area in pixels. Using this
8414 function to size a window tends to be more device-independent than
8415 wx.Window.SetSize, since the application need not worry about what
8416 dimensions the border or title bar have when trying to fit the window
8417 around panel items, for example.
8418 """
8419 return _core_.Window_SetClientSizeWH(*args, **kwargs)
8420
8421 def SetClientRect(*args, **kwargs):
8422 """
8423 SetClientRect(self, Rect rect)
8424
8425 This sets the size of the window client area in pixels. Using this
8426 function to size a window tends to be more device-independent than
8427 wx.Window.SetSize, since the application need not worry about what
8428 dimensions the border or title bar have when trying to fit the window
8429 around panel items, for example.
8430 """
8431 return _core_.Window_SetClientRect(*args, **kwargs)
8432
8433 def GetPosition(*args, **kwargs):
8434 """
8435 GetPosition(self) -> Point
8436
1c71765a
RD		 8437 Get the window's position. Notice that the position is in client
8438 coordinates for child windows and screen coordinates for the top level
8439 ones, use `GetScreenPosition` if you need screen coordinates for all
8440 kinds of windows.
d55e5bfc
RD		 8441 """
8442 return _core_.Window_GetPosition(*args, **kwargs)
8443
8444 def GetPositionTuple(*args, **kwargs):
8445 """
8446 GetPositionTuple() -> (x,y)
8447
1c71765a
RD		 8448 Get the window's position. Notice that the position is in client
8449 coordinates for child windows and screen coordinates for the top level
8450 ones, use `GetScreenPosition` if you need screen coordinates for all
8451 kinds of windows.
d55e5bfc
RD		 8452 """
8453 return _core_.Window_GetPositionTuple(*args, **kwargs)
8454
1c71765a
RD		 8455 def GetScreenPosition(*args, **kwargs):
8456 """
8457 GetScreenPosition(self) -> Point
8458
8459 Get the position of the window in screen coordinantes.
8460 """
8461 return _core_.Window_GetScreenPosition(*args, **kwargs)
8462
8463 def GetScreenPositionTuple(*args, **kwargs):
8464 """
8465 GetScreenPositionTuple() -> (x,y)
8466
8467 Get the position of the window in screen coordinantes.
8468 """
8469 return _core_.Window_GetScreenPositionTuple(*args, **kwargs)
8470
8471 def GetScreenRect(*args, **kwargs):
8472 """
8473 GetScreenRect(self) -> Rect
8474
8475 Returns the size and position of the window in screen coordinantes as
8476 a `wx.Rect` object.
8477 """
8478 return _core_.Window_GetScreenRect(*args, **kwargs)
8479
d55e5bfc
RD		 8480 def GetSize(*args, **kwargs):
8481 """
8482 GetSize(self) -> Size
8483
8484 Get the window size.
8485 """
8486 return _core_.Window_GetSize(*args, **kwargs)
8487
8488 def GetSizeTuple(*args, **kwargs):
8489 """
8490 GetSizeTuple() -> (width, height)
8491
8492 Get the window size.
8493 """
8494 return _core_.Window_GetSizeTuple(*args, **kwargs)
8495
8496 def GetRect(*args, **kwargs):
8497 """
8498 GetRect(self) -> Rect
8499
1c71765a 8500 Returns the size and position of the window as a `wx.Rect` object.
d55e5bfc
RD		 8501 """
8502 return _core_.Window_GetRect(*args, **kwargs)
8503
8504 def GetClientSize(*args, **kwargs):
8505 """
8506 GetClientSize(self) -> Size
8507
8508 This gets the size of the window's 'client area' in pixels. The client
8509 area is the area which may be drawn on by the programmer, excluding
8510 title bar, border, scrollbars, etc.
8511 """
8512 return _core_.Window_GetClientSize(*args, **kwargs)
8513
8514 def GetClientSizeTuple(*args, **kwargs):
8515 """
8516 GetClientSizeTuple() -> (width, height)
8517
8518 This gets the size of the window's 'client area' in pixels. The client
8519 area is the area which may be drawn on by the programmer, excluding
8520 title bar, border, scrollbars, etc.
8521 """
8522 return _core_.Window_GetClientSizeTuple(*args, **kwargs)
8523
8524 def GetClientAreaOrigin(*args, **kwargs):
8525 """
8526 GetClientAreaOrigin(self) -> Point
8527
8528 Get the origin of the client area of the window relative to the
8529 window's top left corner (the client area may be shifted because of
8530 the borders, scrollbars, other decorations...)
8531 """
8532 return _core_.Window_GetClientAreaOrigin(*args, **kwargs)
8533
8534 def GetClientRect(*args, **kwargs):
8535 """
8536 GetClientRect(self) -> Rect
8537
629f3c1b 8538 Get the client area position and size as a `wx.Rect` object.
d55e5bfc
RD		 8539 """
8540 return _core_.Window_GetClientRect(*args, **kwargs)
8541
8542 def GetBestSize(*args, **kwargs):
8543 """
8544 GetBestSize(self) -> Size
8545
248ed943 8546 This function returns the best acceptable minimal size for the
79fccf9d
RD		 8547 window, if applicable. For example, for a static text control, it will
8548 be the minimal size such that the control label is not truncated. For
8549 windows containing subwindows (suzh aswx.Panel), the size returned by
8550 this function will be the same as the size the window would have had
8551 after calling Fit.
d55e5bfc
RD		 8552 """
8553 return _core_.Window_GetBestSize(*args, **kwargs)
8554
8555 def GetBestSizeTuple(*args, **kwargs):
8556 """
8557 GetBestSizeTuple() -> (width, height)
8558
248ed943 8559 This function returns the best acceptable minimal size for the
79fccf9d
RD		 8560 window, if applicable. For example, for a static text control, it will
8561 be the minimal size such that the control label is not truncated. For
8562 windows containing subwindows (suzh aswx.Panel), the size returned by
8563 this function will be the same as the size the window would have had
8564 after calling Fit.
d55e5bfc
RD		 8565 """
8566 return _core_.Window_GetBestSizeTuple(*args, **kwargs)
8567
a001823c
RD		 8568 def InvalidateBestSize(*args, **kwargs):
8569 """
8570 InvalidateBestSize(self)
8571
8572 Reset the cached best size value so it will be recalculated the next
8573 time it is needed.
8574 """
8575 return _core_.Window_InvalidateBestSize(*args, **kwargs)
8576
e2813725
RD		 8577 def CacheBestSize(*args, **kwargs):
8578 """
8579 CacheBestSize(self, Size size)
8580
8581 Cache the best size so it doesn't need to be calculated again, (at least until
8582 some properties of the window change.)
8583 """
8584 return _core_.Window_CacheBestSize(*args, **kwargs)
8585
a001823c
RD		 8586 def GetBestFittingSize(*args, **kwargs):
8587 """
8588 GetBestFittingSize(self) -> Size
8589
8590 This function will merge the window's best size into the window's
8591 minimum size, giving priority to the min size components, and returns
8592 the results.
8593
8594 """
8595 return _core_.Window_GetBestFittingSize(*args, **kwargs)
8596
d55e5bfc
RD		 8597 def GetAdjustedBestSize(*args, **kwargs):
8598 """
8599 GetAdjustedBestSize(self) -> Size
8600
8601 This method is similar to GetBestSize, except in one
8602 thing. GetBestSize should return the minimum untruncated size of the
8603 window, while this method will return the largest of BestSize and any
8604 user specified minimum size. ie. it is the minimum size the window
8605 should currently be drawn at, not the minimal size it can possibly
8606 tolerate.
8607 """
8608 return _core_.Window_GetAdjustedBestSize(*args, **kwargs)
8609
8610 def Center(*args, **kwargs):
8611 """
8612 Center(self, int direction=BOTH)
8613
8614 Centers the window. The parameter specifies the direction for
8615 cetering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may
8616 also include wx.CENTER_ON_SCREEN flag if you want to center the window
8617 on the entire screen and not on its parent window. If it is a
8618 top-level window and has no parent then it will always be centered
8619 relative to the screen.
8620 """
8621 return _core_.Window_Center(*args, **kwargs)
8622
8623 Centre = Center
d55e5bfc
RD		 8624 def CenterOnParent(*args, **kwargs):
8625 """
8626 CenterOnParent(self, int dir=BOTH)
8627
8628 Center with respect to the the parent window
8629 """
8630 return _core_.Window_CenterOnParent(*args, **kwargs)
8631
8632 CentreOnParent = CenterOnParent
8633 def Fit(*args, **kwargs):
8634 """
8635 Fit(self)
8636
8637 Sizes the window so that it fits around its subwindows. This function
8638 won't do anything if there are no subwindows and will only really work
8639 correctly if sizers are used for the subwindows layout. Also, if the
8640 window has exactly one subwindow it is better (faster and the result
8641 is more precise as Fit adds some margin to account for fuzziness of
8642 its calculations) to call window.SetClientSize(child.GetSize())
8643 instead of calling Fit.
8644 """
8645 return _core_.Window_Fit(*args, **kwargs)
8646
8647 def FitInside(*args, **kwargs):
8648 """
8649 FitInside(self)
8650
8651 Similar to Fit, but sizes the interior (virtual) size of a
8652 window. Mainly useful with scrolled windows to reset scrollbars after
8653 sizing changes that do not trigger a size event, and/or scrolled
8654 windows without an interior sizer. This function similarly won't do
8655 anything if there are no subwindows.
8656 """
8657 return _core_.Window_FitInside(*args, **kwargs)
8658
03837c5c 8659 def SetSizeHints(*args, **kwargs):
d55e5bfc
RD		 8660 """
8661 SetSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1,
8662 int incH=-1)
d55e5bfc
RD		 8663
8664 Allows specification of minimum and maximum window sizes, and window
8665 size increments. If a pair of values is not set (or set to -1), the
8666 default values will be used. If this function is called, the user
908b74cd
RD		 8667 will not be able to size the window outside the given bounds (if it is
8668 a top-level window.) Sizers will also inspect the minimum window size
8669 and will use that value if set when calculating layout.
8670
8671 The resizing increments are only significant under Motif or Xt.
d55e5bfc 8672 """
03837c5c 8673 return _core_.Window_SetSizeHints(*args, **kwargs)
d55e5bfc 8674
03837c5c
RD		 8675 def SetSizeHintsSz(*args, **kwargs):
8676 """
8677 SetSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize, Size incSize=DefaultSize)
8678
8679 Allows specification of minimum and maximum window sizes, and window
8680 size increments. If a pair of values is not set (or set to -1), the
8681 default values will be used. If this function is called, the user
8682 will not be able to size the window outside the given bounds (if it is
8683 a top-level window.) Sizers will also inspect the minimum window size
8684 and will use that value if set when calculating layout.
8685
8686 The resizing increments are only significant under Motif or Xt.
8687 """
8688 return _core_.Window_SetSizeHintsSz(*args, **kwargs)
8689
8690 def SetVirtualSizeHints(*args, **kwargs):
d55e5bfc 8691 """
908b74cd 8692 SetVirtualSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1)
d55e5bfc
RD		 8693
8694 Allows specification of minimum and maximum virtual window sizes. If a
8695 pair of values is not set (or set to -1), the default values will be
8696 used. If this function is called, the user will not be able to size
8697 the virtual area of the window outside the given bounds.
8698 """
03837c5c
RD		 8699 return _core_.Window_SetVirtualSizeHints(*args, **kwargs)
8700
8701 def SetVirtualSizeHintsSz(*args, **kwargs):
8702 """
8703 SetVirtualSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize)
8704
8705 Allows specification of minimum and maximum virtual window sizes. If a
8706 pair of values is not set (or set to -1), the default values will be
8707 used. If this function is called, the user will not be able to size
8708 the virtual area of the window outside the given bounds.
8709 """
8710 return _core_.Window_SetVirtualSizeHintsSz(*args, **kwargs)
d55e5bfc 8711
908b74cd
RD		 8712 def GetMaxSize(*args, **kwargs):
8713 """GetMaxSize(self) -> Size"""
8714 return _core_.Window_GetMaxSize(*args, **kwargs)
8715
8716 def GetMinSize(*args, **kwargs):
8717 """GetMinSize(self) -> Size"""
8718 return _core_.Window_GetMinSize(*args, **kwargs)
8719
8720 def SetMinSize(*args, **kwargs):
8721 """
8722 SetMinSize(self, Size minSize)
8723
8724 A more convenient method than `SetSizeHints` for setting just the
8725 min size.
8726 """
8727 return _core_.Window_SetMinSize(*args, **kwargs)
8728
8729 def SetMaxSize(*args, **kwargs):
8730 """
8731 SetMaxSize(self, Size maxSize)
8732
8733 A more convenient method than `SetSizeHints` for setting just the
8734 max size.
8735 """
8736 return _core_.Window_SetMaxSize(*args, **kwargs)
8737
d55e5bfc
RD		 8738 def GetMinWidth(*args, **kwargs):
8739 """GetMinWidth(self) -> int"""
8740 return _core_.Window_GetMinWidth(*args, **kwargs)
8741
8742 def GetMinHeight(*args, **kwargs):
8743 """GetMinHeight(self) -> int"""
8744 return _core_.Window_GetMinHeight(*args, **kwargs)
8745
8746 def GetMaxWidth(*args, **kwargs):
8747 """GetMaxWidth(self) -> int"""
8748 return _core_.Window_GetMaxWidth(*args, **kwargs)
8749
8750 def GetMaxHeight(*args, **kwargs):
8751 """GetMaxHeight(self) -> int"""
8752 return _core_.Window_GetMaxHeight(*args, **kwargs)
8753
d55e5bfc
RD		 8754 def SetVirtualSize(*args, **kwargs):
8755 """
8756 SetVirtualSize(self, Size size)
8757
8758 Set the the virtual size of a window in pixels. For most windows this
8759 is just the client area of the window, but for some like scrolled
8760 windows it is more or less independent of the screen window size.
8761 """
8762 return _core_.Window_SetVirtualSize(*args, **kwargs)
8763
8764 def SetVirtualSizeWH(*args, **kwargs):
8765 """
8766 SetVirtualSizeWH(self, int w, int h)
8767
8768 Set the the virtual size of a window in pixels. For most windows this
8769 is just the client area of the window, but for some like scrolled
8770 windows it is more or less independent of the screen window size.
8771 """
8772 return _core_.Window_SetVirtualSizeWH(*args, **kwargs)
8773
8774 def GetVirtualSize(*args, **kwargs):
8775 """
8776 GetVirtualSize(self) -> Size
8777
8778 Get the the virtual size of the window in pixels. For most windows
8779 this is just the client area of the window, but for some like scrolled
8780 windows it is more or less independent of the screen window size.
8781 """
8782 return _core_.Window_GetVirtualSize(*args, **kwargs)
8783
8784 def GetVirtualSizeTuple(*args, **kwargs):
8785 """
8786 GetVirtualSizeTuple() -> (width, height)
8787
8788 Get the the virtual size of the window in pixels. For most windows
8789 this is just the client area of the window, but for some like scrolled
8790 windows it is more or less independent of the screen window size.
8791 """
8792 return _core_.Window_GetVirtualSizeTuple(*args, **kwargs)
8793
8794 def GetBestVirtualSize(*args, **kwargs):
8795 """
8796 GetBestVirtualSize(self) -> Size
8797
8798 Return the largest of ClientSize and BestSize (as determined by a
8799 sizer, interior children, or other means)
8800 """
8801 return _core_.Window_GetBestVirtualSize(*args, **kwargs)
8802
8803 def Show(*args, **kwargs):
8804 """
8805 Show(self, bool show=True) -> bool
8806
8807 Shows or hides the window. You may need to call Raise for a top level
8808 window if you want to bring it to top, although this is not needed if
8809 Show is called immediately after the frame creation. Returns True if
8810 the window has been shown or hidden or False if nothing was done
8811 because it already was in the requested state.
8812 """
8813 return _core_.Window_Show(*args, **kwargs)
8814
8815 def Hide(*args, **kwargs):
8816 """
8817 Hide(self) -> bool
8818
8819 Equivalent to calling Show(False).
8820 """
8821 return _core_.Window_Hide(*args, **kwargs)
8822
8823 def Enable(*args, **kwargs):
8824 """
8825 Enable(self, bool enable=True) -> bool
8826
8827 Enable or disable the window for user input. Note that when a parent
8828 window is disabled, all of its children are disabled as well and they
8829 are reenabled again when the parent is. Returns true if the window
8830 has been enabled or disabled, false if nothing was done, i.e. if the
8831 window had already been in the specified state.
8832 """
8833 return _core_.Window_Enable(*args, **kwargs)
8834
8835 def Disable(*args, **kwargs):
8836 """
8837 Disable(self) -> bool
8838
8839 Disables the window, same as Enable(false).
8840 """
8841 return _core_.Window_Disable(*args, **kwargs)
8842
8843 def IsShown(*args, **kwargs):
8844 """
8845 IsShown(self) -> bool
8846
8847 Returns true if the window is shown, false if it has been hidden.
8848 """
8849 return _core_.Window_IsShown(*args, **kwargs)
8850
8851 def IsEnabled(*args, **kwargs):
8852 """
8853 IsEnabled(self) -> bool
8854
8855 Returns true if the window is enabled for input, false otherwise.
8856 """
8857 return _core_.Window_IsEnabled(*args, **kwargs)
8858
33d6fd3b
RD		 8859 def IsShownOnScreen(*args, **kwargs):
8860 """
8861 IsShownOnScreen(self) -> bool
8862
8863 Returns ``True`` if the window is physically visible on the screen,
8864 i.e. it is shown and all its parents up to the toplevel window are
8865 shown as well.
8866 """
8867 return _core_.Window_IsShownOnScreen(*args, **kwargs)
8868
d55e5bfc
RD		 8869 def SetWindowStyleFlag(*args, **kwargs):
8870 """
8871 SetWindowStyleFlag(self, long style)
8872
79fccf9d
RD		 8873 Sets the style of the window. Please note that some styles cannot be
8874 changed after the window creation and that Refresh() might need to be
8875 called after changing the others for the change to take place
8876 immediately.
d55e5bfc
RD		 8877 """
8878 return _core_.Window_SetWindowStyleFlag(*args, **kwargs)
8879
8880 def GetWindowStyleFlag(*args, **kwargs):
8881 """
8882 GetWindowStyleFlag(self) -> long
8883
8884 Gets the window style that was passed to the constructor or Create
8885 method.
8886 """
8887 return _core_.Window_GetWindowStyleFlag(*args, **kwargs)
8888
8889 SetWindowStyle = SetWindowStyleFlag; GetWindowStyle = GetWindowStyleFlag
8890 def HasFlag(*args, **kwargs):
8891 """
8892 HasFlag(self, int flag) -> bool
8893
8894 Test if the given style is set for this window.
8895 """
8896 return _core_.Window_HasFlag(*args, **kwargs)
8897
8898 def IsRetained(*args, **kwargs):
8899 """
8900 IsRetained(self) -> bool
8901
8902 Returns true if the window is retained, false otherwise. Retained
8903 windows are only available on X platforms.
8904 """
8905 return _core_.Window_IsRetained(*args, **kwargs)
8906
8907 def SetExtraStyle(*args, **kwargs):
8908 """
8909 SetExtraStyle(self, long exStyle)
8910
8911 Sets the extra style bits for the window. Extra styles are the less
8912 often used style bits which can't be set with the constructor or with
8913 SetWindowStyleFlag()
8914 """
8915 return _core_.Window_SetExtraStyle(*args, **kwargs)
8916
8917 def GetExtraStyle(*args, **kwargs):
8918 """
8919 GetExtraStyle(self) -> long
8920
8921 Returns the extra style bits for the window.
8922 """
8923 return _core_.Window_GetExtraStyle(*args, **kwargs)
8924
8925 def MakeModal(*args, **kwargs):
8926 """
8927 MakeModal(self, bool modal=True)
8928
8929 Disables all other windows in the application so that the user can
8930 only interact with this window. Passing False will reverse this
8931 effect.
8932 """
8933 return _core_.Window_MakeModal(*args, **kwargs)
8934
8935 def SetThemeEnabled(*args, **kwargs):
8936 """
8937 SetThemeEnabled(self, bool enableTheme)
8938
8939 This function tells a window if it should use the system's "theme"
8940 code to draw the windows' background instead if its own background
8941 drawing code. This will only have an effect on platforms that support
8942 the notion of themes in user defined windows. One such platform is
8943 GTK+ where windows can have (very colourful) backgrounds defined by a
8944 user's selected theme.
8945
8946 Dialogs, notebook pages and the status bar have this flag set to true
8947 by default so that the default look and feel is simulated best.
8948 """
8949 return _core_.Window_SetThemeEnabled(*args, **kwargs)
8950
8951 def GetThemeEnabled(*args, **kwargs):
8952 """
8953 GetThemeEnabled(self) -> bool
8954
8955 Return the themeEnabled flag.
8956 """
8957 return _core_.Window_GetThemeEnabled(*args, **kwargs)
8958
8959 def SetFocus(*args, **kwargs):
8960 """
8961 SetFocus(self)
8962
8963 Set's the focus to this window, allowing it to receive keyboard input.
8964 """
8965 return _core_.Window_SetFocus(*args, **kwargs)
8966
8967 def SetFocusFromKbd(*args, **kwargs):
8968 """
8969 SetFocusFromKbd(self)
8970
8971 Set focus to this window as the result of a keyboard action. Normally
8972 only called internally.
8973 """
8974 return _core_.Window_SetFocusFromKbd(*args, **kwargs)
8975
8976 def FindFocus(*args, **kwargs):
8977 """
c24da6d6 8978 FindFocus() -> Window
d55e5bfc
RD		 8979
8980 Returns the window or control that currently has the keyboard focus,
8981 or None.
8982 """
8983 return _core_.Window_FindFocus(*args, **kwargs)
8984
8985 FindFocus = staticmethod(FindFocus)
8986 def AcceptsFocus(*args, **kwargs):
8987 """
8988 AcceptsFocus(self) -> bool
8989
8990 Can this window have focus?
8991 """
8992 return _core_.Window_AcceptsFocus(*args, **kwargs)
8993
8994 def AcceptsFocusFromKeyboard(*args, **kwargs):
8995 """
8996 AcceptsFocusFromKeyboard(self) -> bool
8997
8998 Can this window be given focus by keyboard navigation? if not, the
8999 only way to give it focus (provided it accepts it at all) is to click
9000 it.
9001 """
9002 return _core_.Window_AcceptsFocusFromKeyboard(*args, **kwargs)
9003
908b74cd
RD		 9004 def Navigate(*args, **kwargs):
9005 """
9006 Navigate(self, int flags=NavigationKeyEvent.IsForward) -> bool
9007
a8eff060
RD		 9008 Does keyboard navigation from this window to another, by sending a
9009 `wx.NavigationKeyEvent`.
908b74cd
RD		 9010 """
9011 return _core_.Window_Navigate(*args, **kwargs)
9012
bf26d883
RD		 9013 def MoveAfterInTabOrder(*args, **kwargs):
9014 """
9015 MoveAfterInTabOrder(self, Window win)
9016
9017 Moves this window in the tab navigation order after the specified
9018 sibling window. This means that when the user presses the TAB key on
9019 that other window, the focus switches to this window.
9020
9021 The default tab order is the same as creation order. This function
9022 and `MoveBeforeInTabOrder` allow to change it after creating all the
9023 windows.
9024
9025 """
9026 return _core_.Window_MoveAfterInTabOrder(*args, **kwargs)
9027
9028 def MoveBeforeInTabOrder(*args, **kwargs):
9029 """
9030 MoveBeforeInTabOrder(self, Window win)
9031
9032 Same as `MoveAfterInTabOrder` except that it inserts this window just
9033 before win instead of putting it right after it.
9034 """
9035 return _core_.Window_MoveBeforeInTabOrder(*args, **kwargs)
9036
d55e5bfc
RD		 9037 def GetChildren(*args, **kwargs):
9038 """
9039 GetChildren(self) -> PyObject
9040
9041 Returns a list of the window's children. NOTE: Currently this is a
9042 copy of the child window list maintained by the window, so the return
9043 value of this function is only valid as long as the window's children
9044 do not change.
9045 """
9046 return _core_.Window_GetChildren(*args, **kwargs)
9047
9048 def GetParent(*args, **kwargs):
9049 """
9050 GetParent(self) -> Window
9051
9052 Returns the parent window of this window, or None if there isn't one.
9053 """
9054 return _core_.Window_GetParent(*args, **kwargs)
9055
9056 def GetGrandParent(*args, **kwargs):
9057 """
9058 GetGrandParent(self) -> Window
9059
79fccf9d
RD		 9060 Returns the parent of the parent of this window, or None if there
9061 isn't one.
d55e5bfc
RD		 9062 """
9063 return _core_.Window_GetGrandParent(*args, **kwargs)
9064
9065 def IsTopLevel(*args, **kwargs):
9066 """
9067 IsTopLevel(self) -> bool
9068
9069 Returns true if the given window is a top-level one. Currently all
9070 frames and dialogs are always considered to be top-level windows (even
9071 if they have a parent window).
9072 """
9073 return _core_.Window_IsTopLevel(*args, **kwargs)
9074
9075 def Reparent(*args, **kwargs):
9076 """
9077 Reparent(self, Window newParent) -> bool
9078
9079 Reparents the window, i.e the window will be removed from its current
9080 parent window (e.g. a non-standard toolbar in a wxFrame) and then
9081 re-inserted into another. Available on Windows and GTK. Returns True
9082 if the parent was changed, False otherwise (error or newParent ==
9083 oldParent)
9084 """
9085 return _core_.Window_Reparent(*args, **kwargs)
9086
9087 def AddChild(*args, **kwargs):
9088 """
9089 AddChild(self, Window child)
9090
9091 Adds a child window. This is called automatically by window creation
9092 functions so should not be required by the application programmer.
9093 """
9094 return _core_.Window_AddChild(*args, **kwargs)
9095
9096 def RemoveChild(*args, **kwargs):
9097 """
9098 RemoveChild(self, Window child)
9099
9100 Removes a child window. This is called automatically by window
9101 deletion functions so should not be required by the application
9102 programmer.
9103 """
9104 return _core_.Window_RemoveChild(*args, **kwargs)
9105
704eda0c
RD		 9106 def SetDoubleBuffered(*args, **kwargs):
9107 """
9108 SetDoubleBuffered(self, bool on)
9109
9110 Currently wxGTK2 only.
9111 """
9112 return _core_.Window_SetDoubleBuffered(*args, **kwargs)
9113
d55e5bfc
RD		 9114 def FindWindowById(*args, **kwargs):
9115 """
9116 FindWindowById(self, long winid) -> Window
9117
9118 Find a chld of this window by window ID
9119 """
9120 return _core_.Window_FindWindowById(*args, **kwargs)
9121
9122 def FindWindowByName(*args, **kwargs):
9123 """
9124 FindWindowByName(self, String name) -> Window
9125
9126 Find a child of this window by name
9127 """
9128 return _core_.Window_FindWindowByName(*args, **kwargs)
9129
9130 def GetEventHandler(*args, **kwargs):
9131 """
9132 GetEventHandler(self) -> EvtHandler
9133
9134 Returns the event handler for this window. By default, the window is
9135 its own event handler.
9136 """
9137 return _core_.Window_GetEventHandler(*args, **kwargs)
9138
9139 def SetEventHandler(*args, **kwargs):
9140 """
9141 SetEventHandler(self, EvtHandler handler)
9142
9143 Sets the event handler for this window. An event handler is an object
d49bdf34
RD		 9144 that is capable of processing the events sent to a window. (In other
9145 words, is able to dispatch the events to handler function.) By
9146 default, the window is its own event handler, but an application may
9147 wish to substitute another, for example to allow central
9148 implementation of event-handling for a variety of different window
9149 classes.
d55e5bfc 9150
79fccf9d 9151 It is usually better to use `wx.Window.PushEventHandler` since this sets
d55e5bfc 9152 up a chain of event handlers, where an event not handled by one event
d49bdf34 9153 handler is handed off to the next one in the chain.
d55e5bfc
RD		 9154 """
9155 return _core_.Window_SetEventHandler(*args, **kwargs)
9156
9157 def PushEventHandler(*args, **kwargs):
9158 """
9159 PushEventHandler(self, EvtHandler handler)
9160
9161 Pushes this event handler onto the event handler stack for the window.
9162 An event handler is an object that is capable of processing the events
d49bdf34
RD		 9163 sent to a window. (In other words, is able to dispatch the events to
9164 handler function.) By default, the window is its own event handler,
9165 but an application may wish to substitute another, for example to
9166 allow central implementation of event-handling for a variety of
9167 different window classes.
d55e5bfc
RD		 9168
9169 wx.Window.PushEventHandler allows an application to set up a chain of
9170 event handlers, where an event not handled by one event handler is
d49bdf34
RD		 9171 handed to the next one in the chain. Use `wx.Window.PopEventHandler`
9172 to remove the event handler. Ownership of the handler is *not* given
9173 to the window, so you should be sure to pop the handler before the
9174 window is destroyed and either let PopEventHandler destroy it, or call
9175 its Destroy method yourself.
d55e5bfc
RD		 9176 """
9177 return _core_.Window_PushEventHandler(*args, **kwargs)
9178
9179 def PopEventHandler(*args, **kwargs):
9180 """
9181 PopEventHandler(self, bool deleteHandler=False) -> EvtHandler
9182
9183 Removes and returns the top-most event handler on the event handler
9184 stack. If deleteHandler is True then the wx.EvtHandler object will be
d49bdf34 9185 destroyed after it is popped, and ``None`` will be returned instead.
d55e5bfc
RD		 9186 """
9187 return _core_.Window_PopEventHandler(*args, **kwargs)
9188
9189 def RemoveEventHandler(*args, **kwargs):
9190 """
9191 RemoveEventHandler(self, EvtHandler handler) -> bool
9192
79fccf9d 9193 Find the given handler in the event handler chain and remove (but not
d49bdf34 9194 delete) it from the event handler chain, returns True if it was found
79fccf9d
RD		 9195 and False otherwise (this also results in an assert failure so this
9196 function should only be called when the handler is supposed to be
9197 there.)
d55e5bfc
RD		 9198 """
9199 return _core_.Window_RemoveEventHandler(*args, **kwargs)
9200
9201 def SetValidator(*args, **kwargs):
9202 """
9203 SetValidator(self, Validator validator)
9204
9205 Deletes the current validator (if any) and sets the window validator,
9206 having called wx.Validator.Clone to create a new validator of this
9207 type.
9208 """
9209 return _core_.Window_SetValidator(*args, **kwargs)
9210
9211 def GetValidator(*args, **kwargs):
9212 """
9213 GetValidator(self) -> Validator
9214
9215 Returns a pointer to the current validator for the window, or None if
9216 there is none.
9217 """
9218 return _core_.Window_GetValidator(*args, **kwargs)
9219
9220 def Validate(*args, **kwargs):
9221 """
9222 Validate(self) -> bool
9223
9224 Validates the current values of the child controls using their
79fccf9d
RD		 9225 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
9226 style flag set, the method will also call Validate() of all child
9227 windows. Returns false if any of the validations failed.
d55e5bfc
RD		 9228 """
9229 return _core_.Window_Validate(*args, **kwargs)
9230
9231 def TransferDataToWindow(*args, **kwargs):
9232 """
9233 TransferDataToWindow(self) -> bool
9234
79fccf9d
RD		 9235 Transfers values to child controls from data areas specified by their
9236 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
9237 style flag set, the method will also call TransferDataToWindow() of
9238 all child windows.
d55e5bfc
RD		 9239 """
9240 return _core_.Window_TransferDataToWindow(*args, **kwargs)
9241
9242 def TransferDataFromWindow(*args, **kwargs):
9243 """
9244 TransferDataFromWindow(self) -> bool
9245
79fccf9d
RD		 9246 Transfers values from child controls to data areas specified by their
9247 validators. Returns false if a transfer failed. If the window has
9248 wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will
9249 also call TransferDataFromWindow() of all child windows.
d55e5bfc
RD		 9250 """
9251 return _core_.Window_TransferDataFromWindow(*args, **kwargs)
9252
9253 def InitDialog(*args, **kwargs):
9254 """
9255 InitDialog(self)
9256
79fccf9d
RD		 9257 Sends an EVT_INIT_DIALOG event, whose handler usually transfers data
9258 to the dialog via validators.
d55e5bfc
RD		 9259 """
9260 return _core_.Window_InitDialog(*args, **kwargs)
9261
9262 def SetAcceleratorTable(*args, **kwargs):
9263 """
9264 SetAcceleratorTable(self, AcceleratorTable accel)
9265
9266 Sets the accelerator table for this window.
9267 """
9268 return _core_.Window_SetAcceleratorTable(*args, **kwargs)
9269
9270 def GetAcceleratorTable(*args, **kwargs):
9271 """
9272 GetAcceleratorTable(self) -> AcceleratorTable
9273
9274 Gets the accelerator table for this window.
9275 """
9276 return _core_.Window_GetAcceleratorTable(*args, **kwargs)
9277
9278 def RegisterHotKey(*args, **kwargs):
9279 """
9280 RegisterHotKey(self, int hotkeyId, int modifiers, int keycode) -> bool
9281
9282 Registers a system wide hotkey. Every time the user presses the hotkey
9283 registered here, this window will receive a hotkey event. It will
9284 receive the event even if the application is in the background and
9285 does not have the input focus because the user is working with some
9286 other application. To bind an event handler function to this hotkey
9287 use EVT_HOTKEY with an id equal to hotkeyId. Returns True if the
9288 hotkey was registered successfully.
9289 """
9290 return _core_.Window_RegisterHotKey(*args, **kwargs)
9291
9292 def UnregisterHotKey(*args, **kwargs):
9293 """
9294 UnregisterHotKey(self, int hotkeyId) -> bool
9295
9296 Unregisters a system wide hotkey.
9297 """
9298 return _core_.Window_UnregisterHotKey(*args, **kwargs)
9299
9300 def ConvertDialogPointToPixels(*args, **kwargs):
9301 """
9302 ConvertDialogPointToPixels(self, Point pt) -> Point
9303
9304 Converts a point or size from dialog units to pixels. Dialog units
9305 are used for maintaining a dialog's proportions even if the font
9306 changes. For the x dimension, the dialog units are multiplied by the
9307 average character width and then divided by 4. For the y dimension,
9308 the dialog units are multiplied by the average character height and
9309 then divided by 8.
9310 """
9311 return _core_.Window_ConvertDialogPointToPixels(*args, **kwargs)
9312
9313 def ConvertDialogSizeToPixels(*args, **kwargs):
9314 """
9315 ConvertDialogSizeToPixels(self, Size sz) -> Size
9316
9317 Converts a point or size from dialog units to pixels. Dialog units
9318 are used for maintaining a dialog's proportions even if the font
9319 changes. For the x dimension, the dialog units are multiplied by the
9320 average character width and then divided by 4. For the y dimension,
9321 the dialog units are multiplied by the average character height and
9322 then divided by 8.
9323 """
9324 return _core_.Window_ConvertDialogSizeToPixels(*args, **kwargs)
9325
9326 def DLG_PNT(*args, **kwargs):
9327 """
9328 DLG_PNT(self, Point pt) -> Point
9329
9330 Converts a point or size from dialog units to pixels. Dialog units
9331 are used for maintaining a dialog's proportions even if the font
9332 changes. For the x dimension, the dialog units are multiplied by the
9333 average character width and then divided by 4. For the y dimension,
9334 the dialog units are multiplied by the average character height and
9335 then divided by 8.
9336 """
9337 return _core_.Window_DLG_PNT(*args, **kwargs)
9338
9339 def DLG_SZE(*args, **kwargs):
9340 """
9341 DLG_SZE(self, Size sz) -> Size
9342
9343 Converts a point or size from dialog units to pixels. Dialog units
9344 are used for maintaining a dialog's proportions even if the font
9345 changes. For the x dimension, the dialog units are multiplied by the
9346 average character width and then divided by 4. For the y dimension,
9347 the dialog units are multiplied by the average character height and
9348 then divided by 8.
9349 """
9350 return _core_.Window_DLG_SZE(*args, **kwargs)
9351
9352 def ConvertPixelPointToDialog(*args, **kwargs):
9353 """ConvertPixelPointToDialog(self, Point pt) -> Point"""
9354 return _core_.Window_ConvertPixelPointToDialog(*args, **kwargs)
9355
9356 def ConvertPixelSizeToDialog(*args, **kwargs):
9357 """ConvertPixelSizeToDialog(self, Size sz) -> Size"""
9358 return _core_.Window_ConvertPixelSizeToDialog(*args, **kwargs)
9359
9360 def WarpPointer(*args, **kwargs):
9361 """
9362 WarpPointer(self, int x, int y)
9363
9364 Moves the pointer to the given position on the window.
9365
9366 NOTE: This function is not supported under Mac because Apple Human
9367 Interface Guidelines forbid moving the mouse cursor programmatically.
9368 """
9369 return _core_.Window_WarpPointer(*args, **kwargs)
9370
9371 def CaptureMouse(*args, **kwargs):
9372 """
9373 CaptureMouse(self)
9374
9375 Directs all mouse input to this window. Call wx.Window.ReleaseMouse to
9376 release the capture.
9377
9378 Note that wxWindows maintains the stack of windows having captured the
9379 mouse and when the mouse is released the capture returns to the window
9380 which had had captured it previously and it is only really released if
9381 there were no previous window. In particular, this means that you must
0f83f5da
RD		 9382 release the mouse as many times as you capture it, unless the window
9383 receives the `wx.MouseCaptureLostEvent` event.
9384
9385 Any application which captures the mouse in the beginning of some
9386 operation *must* handle `wx.MouseCaptureLostEvent` and cancel this
9387 operation when it receives the event. The event handler must not
9388 recapture mouse.
d55e5bfc
RD		 9389 """
9390 return _core_.Window_CaptureMouse(*args, **kwargs)
9391
9392 def ReleaseMouse(*args, **kwargs):
9393 """
9394 ReleaseMouse(self)
9395
9396 Releases mouse input captured with wx.Window.CaptureMouse.
9397 """
9398 return _core_.Window_ReleaseMouse(*args, **kwargs)
9399
9400 def GetCapture(*args, **kwargs):
9401 """
c24da6d6 9402 GetCapture() -> Window
d55e5bfc
RD		 9403
9404 Returns the window which currently captures the mouse or None
9405 """
9406 return _core_.Window_GetCapture(*args, **kwargs)
9407
9408 GetCapture = staticmethod(GetCapture)
9409 def HasCapture(*args, **kwargs):
9410 """
9411 HasCapture(self) -> bool
9412
9413 Returns true if this window has the current mouse capture.
9414 """
9415 return _core_.Window_HasCapture(*args, **kwargs)
9416
9417 def Refresh(*args, **kwargs):
9418 """
9419 Refresh(self, bool eraseBackground=True, Rect rect=None)
9420
9421 Mark the specified rectangle (or the whole window) as "dirty" so it
9422 will be repainted. Causes an EVT_PAINT event to be generated and sent
9423 to the window.
9424 """
9425 return _core_.Window_Refresh(*args, **kwargs)
9426
9427 def RefreshRect(*args, **kwargs):
9428 """
fef4c27a 9429 RefreshRect(self, Rect rect, bool eraseBackground=True)
d55e5bfc
RD		 9430
9431 Redraws the contents of the given rectangle: the area inside it will
9432 be repainted. This is the same as Refresh but has a nicer syntax.
9433 """
9434 return _core_.Window_RefreshRect(*args, **kwargs)
9435
9436 def Update(*args, **kwargs):
9437 """
9438 Update(self)
9439
9440 Calling this method immediately repaints the invalidated area of the
9441 window instead of waiting for the EVT_PAINT event to happen, (normally
9442 this would usually only happen when the flow of control returns to the
9443 event loop.) Notice that this function doesn't refresh the window and
9b940138 9444 does nothing if the window has been already repainted. Use `Refresh`
d55e5bfc
RD		 9445 first if you want to immediately redraw the window (or some portion of
9446 it) unconditionally.
9447 """
9448 return _core_.Window_Update(*args, **kwargs)
9449
9450 def ClearBackground(*args, **kwargs):
9451 """
9452 ClearBackground(self)
9453
9454 Clears the window by filling it with the current background
9455 colour. Does not cause an erase background event to be generated.
9456 """
9457 return _core_.Window_ClearBackground(*args, **kwargs)
9458
9459 def Freeze(*args, **kwargs):
9460 """
9461 Freeze(self)
9462
79fccf9d
RD		 9463 Freezes the window or, in other words, prevents any updates from
9464 taking place on screen, the window is not redrawn at all. Thaw must be
9465 called to reenable window redrawing. Calls to Freeze/Thaw may be
9466 nested, with the actual Thaw being delayed until all the nesting has
9467 been undone.
d55e5bfc
RD		 9468
9469 This method is useful for visual appearance optimization (for example,
9470 it is a good idea to use it before inserting large amount of text into
9471 a wxTextCtrl under wxGTK) but is not implemented on all platforms nor
9472 for all controls so it is mostly just a hint to wxWindows and not a
9473 mandatory directive.
9474 """
9475 return _core_.Window_Freeze(*args, **kwargs)
9476
33d6fd3b
RD		 9477 def IsFrozen(*args, **kwargs):
9478 """
9479 IsFrozen(self) -> bool
9480
9481 Returns ``True`` if the window has been frozen and not thawed yet.
9482
9483 :see: `Freeze` and `Thaw`
9484 """
9485 return _core_.Window_IsFrozen(*args, **kwargs)
9486
d55e5bfc
RD		 9487 def Thaw(*args, **kwargs):
9488 """
9489 Thaw(self)
9490
9491 Reenables window updating after a previous call to Freeze. Calls to
79fccf9d
RD		 9492 Freeze/Thaw may be nested, so Thaw must be called the same number of
9493 times that Freeze was before the window will be updated.
d55e5bfc
RD		 9494 """
9495 return _core_.Window_Thaw(*args, **kwargs)
9496
9497 def PrepareDC(*args, **kwargs):
9498 """
9499 PrepareDC(self, DC dc)
9500
9501 Call this function to prepare the device context for drawing a
9502 scrolled image. It sets the device origin according to the current
9503 scroll position.
9504 """
9505 return _core_.Window_PrepareDC(*args, **kwargs)
9506
b39fe951
RD		 9507 def IsDoubleBuffered(*args, **kwargs):
9508 """
9509 IsDoubleBuffered(self) -> bool
9510
9511 Returns ``True`` if the window contents is double-buffered by the
9512 system, i.e. if any drawing done on the window is really done on a
9513 temporary backing surface and transferred to the screen all at once
9514 later.
9515 """
9516 return _core_.Window_IsDoubleBuffered(*args, **kwargs)
9517
d55e5bfc
RD		 9518 def GetUpdateRegion(*args, **kwargs):
9519 """
9520 GetUpdateRegion(self) -> Region
9521
9522 Returns the region specifying which parts of the window have been
9523 damaged. Should only be called within an EVT_PAINT handler.
9524 """
9525 return _core_.Window_GetUpdateRegion(*args, **kwargs)
9526
9527 def GetUpdateClientRect(*args, **kwargs):
9528 """
9529 GetUpdateClientRect(self) -> Rect
9530
9531 Get the update rectangle region bounding box in client coords.
9532 """
9533 return _core_.Window_GetUpdateClientRect(*args, **kwargs)
9534
9535 def IsExposed(*args, **kwargs):
9536 """
9537 IsExposed(self, int x, int y, int w=1, int h=1) -> bool
9538
9539 Returns true if the given point or rectangle area has been exposed
9540 since the last repaint. Call this in an paint event handler to
9541 optimize redrawing by only redrawing those areas, which have been
9542 exposed.
9543 """
9544 return _core_.Window_IsExposed(*args, **kwargs)
9545
9546 def IsExposedPoint(*args, **kwargs):
9547 """
9548 IsExposedPoint(self, Point pt) -> bool
9549
9550 Returns true if the given point or rectangle area has been exposed
9551 since the last repaint. Call this in an paint event handler to
9552 optimize redrawing by only redrawing those areas, which have been
9553 exposed.
9554 """
9555 return _core_.Window_IsExposedPoint(*args, **kwargs)
9556
9557 def IsExposedRect(*args, **kwargs):
9558 """
9559 IsExposedRect(self, Rect rect) -> bool
9560
9561 Returns true if the given point or rectangle area has been exposed
9562 since the last repaint. Call this in an paint event handler to
9563 optimize redrawing by only redrawing those areas, which have been
9564 exposed.
9565 """
9566 return _core_.Window_IsExposedRect(*args, **kwargs)
9567
9568 def GetDefaultAttributes(*args, **kwargs):
9569 """
9570 GetDefaultAttributes(self) -> VisualAttributes
9571
79fccf9d
RD		 9572 Get the default attributes for an instance of this class. This is
9573 useful if you want to use the same font or colour in your own control
9574 as in a standard control -- which is a much better idea than hard
9575 coding specific colours or fonts which might look completely out of
caef1a4d 9576 place on the user's system, especially if it uses themes.
d55e5bfc
RD		 9577 """
9578 return _core_.Window_GetDefaultAttributes(*args, **kwargs)
9579
9580 def GetClassDefaultAttributes(*args, **kwargs):
9581 """
c24da6d6 9582 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
d55e5bfc 9583
79fccf9d
RD		 9584 Get the default attributes for this class. This is useful if you want
9585 to use the same font or colour in your own control as in a standard
9586 control -- which is a much better idea than hard coding specific
caef1a4d
RD		 9587 colours or fonts which might look completely out of place on the
9588 user's system, especially if it uses themes.
d55e5bfc
RD		 9589
9590 The variant parameter is only relevant under Mac currently and is
79fccf9d 9591 ignore under other platforms. Under Mac, it will change the size of
caef1a4d
RD		 9592 the returned font. See `wx.Window.SetWindowVariant` for more about
9593 this.
d55e5bfc
RD		 9594 """
9595 return _core_.Window_GetClassDefaultAttributes(*args, **kwargs)
9596
9597 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
9598 def SetBackgroundColour(*args, **kwargs):
9599 """
9600 SetBackgroundColour(self, Colour colour) -> bool
9601
9602 Sets the background colour of the window. Returns True if the colour
9603 was changed. The background colour is usually painted by the default
9604 EVT_ERASE_BACKGROUND event handler function under Windows and
f8167d6e
RD		 9605 automatically under GTK. Using `wx.NullColour` will reset the window
9606 to the default background colour.
d55e5bfc 9607
caef1a4d 9608 Note that setting the background colour may not cause an immediate
f8167d6e 9609 refresh, so you may wish to call `ClearBackground` or `Refresh` after
d55e5bfc
RD		 9610 calling this function.
9611
f8167d6e
RD		 9612 Using this function will disable attempts to use themes for this
9613 window, if the system supports them. Use with care since usually the
9614 themes represent the appearance chosen by the user to be used for all
9615 applications on the system.
d55e5bfc
RD		 9616 """
9617 return _core_.Window_SetBackgroundColour(*args, **kwargs)
9618
412d302d
RD		 9619 def SetOwnBackgroundColour(*args, **kwargs):
9620 """SetOwnBackgroundColour(self, Colour colour)"""
9621 return _core_.Window_SetOwnBackgroundColour(*args, **kwargs)
d55e5bfc
RD		 9622
9623 def SetForegroundColour(*args, **kwargs):
9624 """
9625 SetForegroundColour(self, Colour colour) -> bool
9626
9627 Sets the foreground colour of the window. Returns True is the colour
9628 was changed. The interpretation of foreground colour is dependent on
9629 the window class; it may be the text colour or other colour, or it may
9630 not be used at all.
9631 """
9632 return _core_.Window_SetForegroundColour(*args, **kwargs)
9633
fa47d7a7
VS		 9634 def SetOwnForegroundColour(*args, **kwargs):
9635 """SetOwnForegroundColour(self, Colour colour)"""
9636 return _core_.Window_SetOwnForegroundColour(*args, **kwargs)
d55e5bfc
RD		 9637
9638 def GetBackgroundColour(*args, **kwargs):
9639 """
9640 GetBackgroundColour(self) -> Colour
9641
9642 Returns the background colour of the window.
9643 """
9644 return _core_.Window_GetBackgroundColour(*args, **kwargs)
9645
9646 def GetForegroundColour(*args, **kwargs):
9647 """
9648 GetForegroundColour(self) -> Colour
9649
9650 Returns the foreground colour of the window. The interpretation of
9651 foreground colour is dependent on the window class; it may be the text
9652 colour or other colour, or it may not be used at all.
9653 """
9654 return _core_.Window_GetForegroundColour(*args, **kwargs)
9655
dcb8fc74
RD		 9656 def InheritsBackgroundColour(*args, **kwargs):
9657 """InheritsBackgroundColour(self) -> bool"""
9658 return _core_.Window_InheritsBackgroundColour(*args, **kwargs)
9659
9660 def UseBgCol(*args, **kwargs):
9661 """UseBgCol(self) -> bool"""
9662 return _core_.Window_UseBgCol(*args, **kwargs)
9663
0f63ec68
RD		 9664 def SetBackgroundStyle(*args, **kwargs):
9665 """
9666 SetBackgroundStyle(self, int style) -> bool
9667
9668 Returns the background style of the window. The background style
9669 indicates how the background of the window is drawn.
9670
9671 ====================== ========================================
9672 wx.BG_STYLE_SYSTEM The background colour or pattern should
9673 be determined by the system
9674 wx.BG_STYLE_COLOUR The background should be a solid colour
9675 wx.BG_STYLE_CUSTOM The background will be implemented by the
9676 application.
9677 ====================== ========================================
9678
9679 On GTK+, use of wx.BG_STYLE_CUSTOM allows the flicker-free drawing of
9680 a custom background, such as a tiled bitmap. Currently the style has
9681 no effect on other platforms.
9682
9683 :see: `GetBackgroundStyle`, `SetBackgroundColour`
9684 """
9685 return _core_.Window_SetBackgroundStyle(*args, **kwargs)
9686
9687 def GetBackgroundStyle(*args, **kwargs):
9688 """
9689 GetBackgroundStyle(self) -> int
9690
9691 Returns the background style of the window.
9692
9693 :see: `SetBackgroundStyle`
9694 """
9695 return _core_.Window_GetBackgroundStyle(*args, **kwargs)
9696
51b83b37
RD		 9697 def HasTransparentBackground(*args, **kwargs):
9698 """
9699 HasTransparentBackground(self) -> bool
9700
9701 Returns True if this window's background is transparent (as, for
9702 example, for `wx.StaticText`) and should show the parent window's
9703 background.
9704
9705 This method is mostly used internally by the library itself and you
9706 normally shouldn't have to call it. You may, however, have to override
9707 it in your custom control classes to ensure that background is painted
9708 correctly.
9709 """
9710 return _core_.Window_HasTransparentBackground(*args, **kwargs)
9711
d55e5bfc
RD		 9712 def SetCursor(*args, **kwargs):
9713 """
9714 SetCursor(self, Cursor cursor) -> bool
9715
9716 Sets the window's cursor. Notice that the window cursor also sets it
9717 for the children of the window implicitly.
9718
9719 The cursor may be wx.NullCursor in which case the window cursor will
9720 be reset back to default.
9721 """
9722 return _core_.Window_SetCursor(*args, **kwargs)
9723
9724 def GetCursor(*args, **kwargs):
9725 """
9726 GetCursor(self) -> Cursor
9727
9728 Return the cursor associated with this window.
9729 """
9730 return _core_.Window_GetCursor(*args, **kwargs)
9731
9732 def SetFont(*args, **kwargs):
9733 """
9734 SetFont(self, Font font) -> bool
9735
9736 Sets the font for this window.
9737 """
9738 return _core_.Window_SetFont(*args, **kwargs)
9739
fa47d7a7
VS		 9740 def SetOwnFont(*args, **kwargs):
9741 """SetOwnFont(self, Font font)"""
9742 return _core_.Window_SetOwnFont(*args, **kwargs)
d55e5bfc
RD		 9743
9744 def GetFont(*args, **kwargs):
9745 """
9746 GetFont(self) -> Font
9747
9748 Returns the default font used for this window.
9749 """
9750 return _core_.Window_GetFont(*args, **kwargs)
9751
9752 def SetCaret(*args, **kwargs):
9753 """
9754 SetCaret(self, Caret caret)
9755
9756 Sets the caret associated with the window.
9757 """
9758 return _core_.Window_SetCaret(*args, **kwargs)
9759
9760 def GetCaret(*args, **kwargs):
9761 """
9762 GetCaret(self) -> Caret
9763
9764 Returns the caret associated with the window.
9765 """
9766 return _core_.Window_GetCaret(*args, **kwargs)
9767
9768 def GetCharHeight(*args, **kwargs):
9769 """
9770 GetCharHeight(self) -> int
9771
9772 Get the (average) character size for the current font.
9773 """
9774 return _core_.Window_GetCharHeight(*args, **kwargs)
9775
9776 def GetCharWidth(*args, **kwargs):
9777 """
9778 GetCharWidth(self) -> int
9779
9780 Get the (average) character size for the current font.
9781 """
9782 return _core_.Window_GetCharWidth(*args, **kwargs)
9783
9784 def GetTextExtent(*args, **kwargs):
a8eff060
RD		 9785 """
9786 GetTextExtent(String string) -> (width, height)
9787
9788 Get the width and height of the text using the current font.
9789 """
d55e5bfc
RD		 9790 return _core_.Window_GetTextExtent(*args, **kwargs)
9791
9792 def GetFullTextExtent(*args, **kwargs):
9793 """
9794 GetFullTextExtent(String string, Font font=None) ->
9795 (width, height, descent, externalLeading)
9796
9797 Get the width, height, decent and leading of the text using the
9798 current or specified font.
9799 """
9800 return _core_.Window_GetFullTextExtent(*args, **kwargs)
9801
9802 def ClientToScreenXY(*args, **kwargs):
9803 """
9804 ClientToScreenXY(int x, int y) -> (x,y)
9805
9806 Converts to screen coordinates from coordinates relative to this window.
9807 """
9808 return _core_.Window_ClientToScreenXY(*args, **kwargs)
9809
9810 def ScreenToClientXY(*args, **kwargs):
9811 """
9812 ScreenToClientXY(int x, int y) -> (x,y)
9813
9814 Converts from screen to client window coordinates.
9815 """
9816 return _core_.Window_ScreenToClientXY(*args, **kwargs)
9817
9818 def ClientToScreen(*args, **kwargs):
9819 """
9820 ClientToScreen(self, Point pt) -> Point
9821
9822 Converts to screen coordinates from coordinates relative to this window.
9823 """
9824 return _core_.Window_ClientToScreen(*args, **kwargs)
9825
9826 def ScreenToClient(*args, **kwargs):
9827 """
9828 ScreenToClient(self, Point pt) -> Point
9829
9830 Converts from screen to client window coordinates.
9831 """
9832 return _core_.Window_ScreenToClient(*args, **kwargs)
9833
9834 def HitTestXY(*args, **kwargs):
9835 """
9836 HitTestXY(self, int x, int y) -> int
9837
9838 Test where the given (in client coords) point lies
9839 """
9840 return _core_.Window_HitTestXY(*args, **kwargs)
9841
9842 def HitTest(*args, **kwargs):
9843 """
9844 HitTest(self, Point pt) -> int
9845
9846 Test where the given (in client coords) point lies
9847 """
9848 return _core_.Window_HitTest(*args, **kwargs)
9849
9850 def GetBorder(*args):
9851 """
9852 GetBorder(self, long flags) -> int
9853 GetBorder(self) -> int
9854
9855 Get border for the flags of this window
9856 """
9857 return _core_.Window_GetBorder(*args)
9858
9859 def UpdateWindowUI(*args, **kwargs):
9860 """
9861 UpdateWindowUI(self, long flags=UPDATE_UI_NONE)
9862
9863 This function sends EVT_UPDATE_UI events to the window. The particular
9864 implementation depends on the window; for example a wx.ToolBar will
9865 send an update UI event for each toolbar button, and a wx.Frame will
9866 send an update UI event for each menubar menu item. You can call this
9867 function from your application to ensure that your UI is up-to-date at
9868 a particular point in time (as far as your EVT_UPDATE_UI handlers are
9869 concerned). This may be necessary if you have called
5ba5649b 9870 `wx.UpdateUIEvent.SetMode` or `wx.UpdateUIEvent.SetUpdateInterval` to
d55e5bfc
RD		 9871 limit the overhead that wxWindows incurs by sending update UI events
9872 in idle time.
d55e5bfc
RD		 9873 """
9874 return _core_.Window_UpdateWindowUI(*args, **kwargs)
9875
9876 def PopupMenuXY(*args, **kwargs):
9877 """
7a0b95b0 9878 PopupMenuXY(self, Menu menu, int x=-1, int y=-1) -> bool
d55e5bfc 9879
7a0b95b0
RD		 9880 Pops up the given menu at the specified coordinates, relative to this window,
9881 and returns control when the user has dismissed the menu. If a menu item is
9882 selected, the corresponding menu event is generated and will be processed as
9883 usual. If the default position is given then the current position of the
9884 mouse cursor will be used.
d55e5bfc
RD		 9885 """
9886 return _core_.Window_PopupMenuXY(*args, **kwargs)
9887
9888 def PopupMenu(*args, **kwargs):
9889 """
7a0b95b0 9890 PopupMenu(self, Menu menu, Point pos=DefaultPosition) -> bool
d55e5bfc 9891
7a0b95b0
RD		 9892 Pops up the given menu at the specified coordinates, relative to this window,
9893 and returns control when the user has dismissed the menu. If a menu item is
9894 selected, the corresponding menu event is generated and will be processed as
9895 usual. If the default position is given then the current position of the
9896 mouse cursor will be used.
d55e5bfc
RD		 9897 """
9898 return _core_.Window_PopupMenu(*args, **kwargs)
9899
1eeb270e
RD		 9900 def HasMultiplePages(*args, **kwargs):
9901 """HasMultiplePages(self) -> bool"""
9902 return _core_.Window_HasMultiplePages(*args, **kwargs)
9903
d55e5bfc
RD		 9904 def GetHandle(*args, **kwargs):
9905 """
9906 GetHandle(self) -> long
9907
9908 Returns the platform-specific handle (as a long integer) of the
9909 physical window. Currently on wxMac it returns the handle of the
9910 toplevel parent of the window.
9911 """
9912 return _core_.Window_GetHandle(*args, **kwargs)
9913
629e65c2
RD		 9914 def AssociateHandle(*args, **kwargs):
9915 """
9916 AssociateHandle(self, long handle)
9917
9918 Associate the window with a new native handle
9919 """
9920 return _core_.Window_AssociateHandle(*args, **kwargs)
9921
9922 def DissociateHandle(*args, **kwargs):
9923 """
9924 DissociateHandle(self)
9925
9926 Dissociate the current native handle from the window
9927 """
9928 return _core_.Window_DissociateHandle(*args, **kwargs)
9929
d55e5bfc
RD		 9930 def OnPaint(*args, **kwargs):
9931 """OnPaint(self, PaintEvent event)"""
9932 return _core_.Window_OnPaint(*args, **kwargs)
9933
9934 def HasScrollbar(*args, **kwargs):
9935 """
9936 HasScrollbar(self, int orient) -> bool
9937
9938 Does the window have the scrollbar for this orientation?
9939 """
9940 return _core_.Window_HasScrollbar(*args, **kwargs)
9941
9942 def SetScrollbar(*args, **kwargs):
9943 """
79fccf9d 9944 SetScrollbar(self, int orientation, int position, int thumbSize, int range,
d55e5bfc
RD		 9945 bool refresh=True)
9946
9947 Sets the scrollbar properties of a built-in scrollbar.
d55e5bfc
RD		 9948 """
9949 return _core_.Window_SetScrollbar(*args, **kwargs)
9950
9951 def SetScrollPos(*args, **kwargs):
9952 """
9953 SetScrollPos(self, int orientation, int pos, bool refresh=True)
9954
9955 Sets the position of one of the built-in scrollbars.
9956 """
9957 return _core_.Window_SetScrollPos(*args, **kwargs)
9958
9959 def GetScrollPos(*args, **kwargs):
9960 """
9961 GetScrollPos(self, int orientation) -> int
9962
9963 Returns the built-in scrollbar position.
9964 """
9965 return _core_.Window_GetScrollPos(*args, **kwargs)
9966
9967 def GetScrollThumb(*args, **kwargs):
9968 """
9969 GetScrollThumb(self, int orientation) -> int
9970
9971 Returns the built-in scrollbar thumb size.
9972 """
9973 return _core_.Window_GetScrollThumb(*args, **kwargs)
9974
9975 def GetScrollRange(*args, **kwargs):
9976 """
9977 GetScrollRange(self, int orientation) -> int
9978
9979 Returns the built-in scrollbar range.
9980 """
9981 return _core_.Window_GetScrollRange(*args, **kwargs)
9982
9983 def ScrollWindow(*args, **kwargs):
9984 """
9985 ScrollWindow(self, int dx, int dy, Rect rect=None)
9986
9987 Physically scrolls the pixels in the window and move child windows
9988 accordingly. Use this function to optimise your scrolling
9989 implementations, to minimise the area that must be redrawn. Note that
9990 it is rarely required to call this function from a user program.
d55e5bfc
RD		 9991 """
9992 return _core_.Window_ScrollWindow(*args, **kwargs)
9993
9994 def ScrollLines(*args, **kwargs):
9995 """
9996 ScrollLines(self, int lines) -> bool
9997
9998 If the platform and window class supports it, scrolls the window by
9999 the given number of lines down, if lines is positive, or up if lines
10000 is negative. Returns True if the window was scrolled, False if it was
10001 already on top/bottom and nothing was done.
10002 """
10003 return _core_.Window_ScrollLines(*args, **kwargs)
10004
10005 def ScrollPages(*args, **kwargs):
10006 """
10007 ScrollPages(self, int pages) -> bool
10008
79fccf9d 10009 If the platform and window class supports it, scrolls the window by
d55e5bfc
RD		 10010 the given number of pages down, if pages is positive, or up if pages
10011 is negative. Returns True if the window was scrolled, False if it was
10012 already on top/bottom and nothing was done.
10013 """
10014 return _core_.Window_ScrollPages(*args, **kwargs)
10015
10016 def LineUp(*args, **kwargs):
10017 """
10018 LineUp(self) -> bool
10019
10020 This is just a wrapper for ScrollLines(-1).
10021 """
10022 return _core_.Window_LineUp(*args, **kwargs)
10023
10024 def LineDown(*args, **kwargs):
10025 """
10026 LineDown(self) -> bool
10027
10028 This is just a wrapper for ScrollLines(1).
10029 """
10030 return _core_.Window_LineDown(*args, **kwargs)
10031
10032 def PageUp(*args, **kwargs):
10033 """
10034 PageUp(self) -> bool
10035
10036 This is just a wrapper for ScrollPages(-1).
10037 """
10038 return _core_.Window_PageUp(*args, **kwargs)
10039
10040 def PageDown(*args, **kwargs):
10041 """
10042 PageDown(self) -> bool
10043
10044 This is just a wrapper for ScrollPages(1).
10045 """
10046 return _core_.Window_PageDown(*args, **kwargs)
10047
10048 def SetHelpText(*args, **kwargs):
10049 """
10050 SetHelpText(self, String text)
10051
10052 Sets the help text to be used as context-sensitive help for this
10053 window. Note that the text is actually stored by the current
f52cbe90 10054 `wx.HelpProvider` implementation, and not in the window object itself.
d55e5bfc
RD		 10055 """
10056 return _core_.Window_SetHelpText(*args, **kwargs)
10057
10058 def SetHelpTextForId(*args, **kwargs):
10059 """
10060 SetHelpTextForId(self, String text)
10061
10062 Associate this help text with all windows with the same id as this
10063 one.
10064 """
10065 return _core_.Window_SetHelpTextForId(*args, **kwargs)
10066
b850e7f3
RD		 10067 def GetHelpTextAtPoint(*args, **kwargs):
10068 """
10069 GetHelpTextAtPoint(self, Point pt, wxHelpEvent::Origin origin) -> String
10070
10071 Get the help string associated with the given position in this window.
10072
10073 Notice that pt may be invalid if event origin is keyboard or unknown
10074 and this method should return the global window help text then
10075
10076 """
10077 return _core_.Window_GetHelpTextAtPoint(*args, **kwargs)
10078
d55e5bfc
RD		 10079 def GetHelpText(*args, **kwargs):
10080 """
10081 GetHelpText(self) -> String
10082
10083 Gets the help text to be used as context-sensitive help for this
10084 window. Note that the text is actually stored by the current
f52cbe90 10085 `wx.HelpProvider` implementation, and not in the window object itself.
d55e5bfc
RD		 10086 """
10087 return _core_.Window_GetHelpText(*args, **kwargs)
10088
10089 def SetToolTipString(*args, **kwargs):
10090 """
10091 SetToolTipString(self, String tip)
10092
10093 Attach a tooltip to the window.
10094 """
10095 return _core_.Window_SetToolTipString(*args, **kwargs)
10096
10097 def SetToolTip(*args, **kwargs):
10098 """
10099 SetToolTip(self, ToolTip tip)
10100
10101 Attach a tooltip to the window.
10102 """
10103 return _core_.Window_SetToolTip(*args, **kwargs)
10104
10105 def GetToolTip(*args, **kwargs):
10106 """
10107 GetToolTip(self) -> ToolTip
10108
10109 get the associated tooltip or None if none
10110 """
10111 return _core_.Window_GetToolTip(*args, **kwargs)
10112
10113 def SetDropTarget(*args, **kwargs):
10114 """
10115 SetDropTarget(self, DropTarget dropTarget)
10116
10117 Associates a drop target with this window. If the window already has
10118 a drop target, it is deleted.
10119 """
10120 return _core_.Window_SetDropTarget(*args, **kwargs)
10121
10122 def GetDropTarget(*args, **kwargs):
10123 """
10124 GetDropTarget(self) -> DropTarget
10125
10126 Returns the associated drop target, which may be None.
10127 """
10128 return _core_.Window_GetDropTarget(*args, **kwargs)
10129
10130 def DragAcceptFiles(*args, **kwargs):
10131 """
10132 DragAcceptFiles(self, bool accept)
10133
10134 Enables or disables eligibility for drop file events, EVT_DROP_FILES.
5ba5649b 10135 Only functional on Windows.
d55e5bfc
RD		 10136 """
10137 return _core_.Window_DragAcceptFiles(*args, **kwargs)
10138
10139 def SetConstraints(*args, **kwargs):
10140 """
10141 SetConstraints(self, LayoutConstraints constraints)
10142
10143 Sets the window to have the given layout constraints. If an existing
10144 layout constraints object is already owned by the window, it will be
10145 deleted. Pass None to disassociate and delete the window's current
10146 constraints.
10147
10148 You must call SetAutoLayout to tell a window to use the constraints
10149 automatically in its default EVT_SIZE handler; otherwise, you must
10150 handle EVT_SIZE yourself and call Layout() explicitly. When setting
10151 both a wx.LayoutConstraints and a wx.Sizer, only the sizer will have
10152 effect.
10153 """
10154 return _core_.Window_SetConstraints(*args, **kwargs)
10155
10156 def GetConstraints(*args, **kwargs):
10157 """
10158 GetConstraints(self) -> LayoutConstraints
10159
10160 Returns a pointer to the window's layout constraints, or None if there
10161 are none.
10162 """
10163 return _core_.Window_GetConstraints(*args, **kwargs)
10164
10165 def SetAutoLayout(*args, **kwargs):
10166 """
10167 SetAutoLayout(self, bool autoLayout)
10168
10169 Determines whether the Layout function will be called automatically
b1fcee84
RD		 10170 when the window is resized. lease note that this only happens for the
10171 windows usually used to contain children, namely `wx.Panel` and
10172 `wx.TopLevelWindow` (and the classes deriving from them).
10173
10174 This method is called implicitly by `SetSizer` but if you use
10175 `SetConstraints` you should call it manually or otherwise the window
10176 layout won't be correctly updated when its size changes.
d55e5bfc
RD		 10177 """
10178 return _core_.Window_SetAutoLayout(*args, **kwargs)
10179
10180 def GetAutoLayout(*args, **kwargs):
10181 """
10182 GetAutoLayout(self) -> bool
10183
10184 Returns the current autoLayout setting
10185 """
10186 return _core_.Window_GetAutoLayout(*args, **kwargs)
10187
10188 def Layout(*args, **kwargs):
10189 """
10190 Layout(self) -> bool
10191
10192 Invokes the constraint-based layout algorithm or the sizer-based
10193 algorithm for this window. See SetAutoLayout: when auto layout is on,
10194 this function gets called automatically by the default EVT_SIZE
10195 handler when the window is resized.
10196 """
10197 return _core_.Window_Layout(*args, **kwargs)
10198
10199 def SetSizer(*args, **kwargs):
10200 """
10201 SetSizer(self, Sizer sizer, bool deleteOld=True)
10202
10203 Sets the window to have the given layout sizer. The window will then
10204 own the object, and will take care of its deletion. If an existing
10205 layout sizer object is already owned by the window, it will be deleted
10206 if the deleteOld parameter is true. Note that this function will also
10207 call SetAutoLayout implicitly with a True parameter if the sizer is
ae8162c8 10208 non-None, and False otherwise.
d55e5bfc
RD		 10209 """
10210 return _core_.Window_SetSizer(*args, **kwargs)
10211
10212 def SetSizerAndFit(*args, **kwargs):
10213 """
10214 SetSizerAndFit(self, Sizer sizer, bool deleteOld=True)
10215
10216 The same as SetSizer, except it also sets the size hints for the
10217 window based on the sizer's minimum size.
10218 """
10219 return _core_.Window_SetSizerAndFit(*args, **kwargs)
10220
10221 def GetSizer(*args, **kwargs):
10222 """
10223 GetSizer(self) -> Sizer
10224
10225 Return the sizer associated with the window by a previous call to
10226 SetSizer or None if there isn't one.
10227 """
10228 return _core_.Window_GetSizer(*args, **kwargs)
10229
10230 def SetContainingSizer(*args, **kwargs):
10231 """
10232 SetContainingSizer(self, Sizer sizer)
10233
10234 This normally does not need to be called by application code. It is
10235 called internally when a window is added to a sizer, and is used so
10236 the window can remove itself from the sizer when it is destroyed.
10237 """
10238 return _core_.Window_SetContainingSizer(*args, **kwargs)
10239
10240 def GetContainingSizer(*args, **kwargs):
10241 """
10242 GetContainingSizer(self) -> Sizer
10243
10244 Return the sizer that this window is a member of, if any, otherwise None.
10245 """
10246 return _core_.Window_GetContainingSizer(*args, **kwargs)
10247
10248 def InheritAttributes(*args, **kwargs):
10249 """
10250 InheritAttributes(self)
10251
79fccf9d
RD		 10252 This function is (or should be, in case of custom controls) called
10253 during window creation to intelligently set up the window visual
10254 attributes, that is the font and the foreground and background
10255 colours.
10256
10257 By 'intelligently' the following is meant: by default, all windows use
10258 their own default attributes. However if some of the parent's
10259 attributes are explicitly changed (that is, using SetFont and not
fa47d7a7 10260 SetOwnFont) and if the corresponding attribute hadn't been
79fccf9d
RD		 10261 explicitly set for this window itself, then this window takes the same
10262 value as used by the parent. In addition, if the window overrides
10263 ShouldInheritColours to return false, the colours will not be changed
10264 no matter what and only the font might.
10265
ec9b55ca
RD		 10266 This rather complicated logic is necessary in order to accommodate the
10267 different usage scenarios. The most common one is when all default
79fccf9d
RD		 10268 attributes are used and in this case, nothing should be inherited as
10269 in modern GUIs different controls use different fonts (and colours)
10270 than their siblings so they can't inherit the same value from the
10271 parent. However it was also deemed desirable to allow to simply change
10272 the attributes of all children at once by just changing the font or
10273 colour of their common parent, hence in this case we do inherit the
10274 parents attributes.
10275
d55e5bfc
RD		 10276 """
10277 return _core_.Window_InheritAttributes(*args, **kwargs)
10278
10279 def ShouldInheritColours(*args, **kwargs):
10280 """
10281 ShouldInheritColours(self) -> bool
10282
10283 Return true from here to allow the colours of this window to be
79fccf9d
RD		 10284 changed by InheritAttributes, returning false forbids inheriting them
10285 from the parent window.
d55e5bfc 10286
79fccf9d
RD		 10287 The base class version returns false, but this method is overridden in
10288 wxControl where it returns true.
d55e5bfc
RD		 10289 """
10290 return _core_.Window_ShouldInheritColours(*args, **kwargs)
10291
fc46b7f3
RD		 10292 def CanSetTransparent(*args, **kwargs):
10293 """
10294 CanSetTransparent(self) -> bool
10295
10296 Returns ``True`` if the platform supports setting the transparency for
10297 this window. Note that this method will err on the side of caution,
10298 so it is possible that this will return ``False`` when it is in fact
10299 possible to set the transparency.
10300
10301 NOTE: On X-windows systems the X server must have the composite
10302 extension loaded, and there must be a composite manager program (such
10303 as xcompmgr) running.
10304 """
10305 return _core_.Window_CanSetTransparent(*args, **kwargs)
10306
10307 def SetTransparent(*args, **kwargs):
10308 """
10309 SetTransparent(self, byte alpha) -> bool
10310
10311 Attempt to set the transparency of this window to the ``alpha`` value,
10312 returns True on success. The ``alpha`` value is an integer in the
10313 range of 0 to 255, where 0 is fully transparent and 255 is fully
10314 opaque.
10315 """
10316 return _core_.Window_SetTransparent(*args, **kwargs)
10317
d55e5bfc
RD		 10318 def PostCreate(self, pre):
10319 """
10320 Phase 3 of the 2-phase create <wink!>
10321 Call this method after precreating the window with the 2-phase create method.
10322 """
10323 self.this = pre.this
10324 self.thisown = pre.thisown
10325 pre.thisown = 0
10326 if hasattr(self, '_setOORInfo'):
10327 self._setOORInfo(self)
10328 if hasattr(self, '_setCallbackInfo'):
10329 self._setCallbackInfo(self, self.__class__)
10330
7e08d4ef 10331 def SendSizeEvent(self):
0ef86618 10332 self.GetEventHandler().ProcessEvent(wx.SizeEvent((-1,-1)))
7e08d4ef 10333
226118fc
RD		 10334 AcceleratorTable = property(GetAcceleratorTable,SetAcceleratorTable,doc="See `GetAcceleratorTable` and `SetAcceleratorTable`")
10335 AdjustedBestSize = property(GetAdjustedBestSize,doc="See `GetAdjustedBestSize`")
10336 AutoLayout = property(GetAutoLayout,SetAutoLayout,doc="See `GetAutoLayout` and `SetAutoLayout`")
10337 BackgroundColour = property(GetBackgroundColour,SetBackgroundColour,doc="See `GetBackgroundColour` and `SetBackgroundColour`")
10338 BackgroundStyle = property(GetBackgroundStyle,SetBackgroundStyle,doc="See `GetBackgroundStyle` and `SetBackgroundStyle`")
10339 BestFittingSize = property(GetBestFittingSize,SetBestFittingSize,doc="See `GetBestFittingSize` and `SetBestFittingSize`")
10340 BestSize = property(GetBestSize,doc="See `GetBestSize`")
10341 BestVirtualSize = property(GetBestVirtualSize,doc="See `GetBestVirtualSize`")
10342 Border = property(GetBorder,doc="See `GetBorder`")
10343 Caret = property(GetCaret,SetCaret,doc="See `GetCaret` and `SetCaret`")
10344 CharHeight = property(GetCharHeight,doc="See `GetCharHeight`")
10345 CharWidth = property(GetCharWidth,doc="See `GetCharWidth`")
10346 Children = property(GetChildren,doc="See `GetChildren`")
10347 ClientAreaOrigin = property(GetClientAreaOrigin,doc="See `GetClientAreaOrigin`")
10348 ClientRect = property(GetClientRect,SetClientRect,doc="See `GetClientRect` and `SetClientRect`")
10349 ClientSize = property(GetClientSize,SetClientSize,doc="See `GetClientSize` and `SetClientSize`")
10350 Constraints = property(GetConstraints,SetConstraints,doc="See `GetConstraints` and `SetConstraints`")
10351 ContainingSizer = property(GetContainingSizer,SetContainingSizer,doc="See `GetContainingSizer` and `SetContainingSizer`")
10352 Cursor = property(GetCursor,SetCursor,doc="See `GetCursor` and `SetCursor`")
10353 DefaultAttributes = property(GetDefaultAttributes,doc="See `GetDefaultAttributes`")
10354 DropTarget = property(GetDropTarget,SetDropTarget,doc="See `GetDropTarget` and `SetDropTarget`")
10355 EventHandler = property(GetEventHandler,SetEventHandler,doc="See `GetEventHandler` and `SetEventHandler`")
10356 ExtraStyle = property(GetExtraStyle,SetExtraStyle,doc="See `GetExtraStyle` and `SetExtraStyle`")
10357 Font = property(GetFont,SetFont,doc="See `GetFont` and `SetFont`")
10358 ForegroundColour = property(GetForegroundColour,SetForegroundColour,doc="See `GetForegroundColour` and `SetForegroundColour`")
226118fc
RD		 10359 GrandParent = property(GetGrandParent,doc="See `GetGrandParent`")
10360 Handle = property(GetHandle,doc="See `GetHandle`")
10361 HelpText = property(GetHelpText,SetHelpText,doc="See `GetHelpText` and `SetHelpText`")
226118fc
RD		 10362 Id = property(GetId,SetId,doc="See `GetId` and `SetId`")
10363 Label = property(GetLabel,SetLabel,doc="See `GetLabel` and `SetLabel`")
994453b8 10364 LayoutDirection = property(GetLayoutDirection,SetLayoutDirection,doc="See `GetLayoutDirection` and `SetLayoutDirection`")
226118fc
RD		 10365 MaxHeight = property(GetMaxHeight,doc="See `GetMaxHeight`")
10366 MaxSize = property(GetMaxSize,SetMaxSize,doc="See `GetMaxSize` and `SetMaxSize`")
10367 MaxWidth = property(GetMaxWidth,doc="See `GetMaxWidth`")
10368 MinHeight = property(GetMinHeight,doc="See `GetMinHeight`")
10369 MinSize = property(GetMinSize,SetMinSize,doc="See `GetMinSize` and `SetMinSize`")
10370 MinWidth = property(GetMinWidth,doc="See `GetMinWidth`")
10371 Name = property(GetName,SetName,doc="See `GetName` and `SetName`")
10372 Parent = property(GetParent,doc="See `GetParent`")
10373 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
10374 Rect = property(GetRect,SetRect,doc="See `GetRect` and `SetRect`")
10375 ScreenPosition = property(GetScreenPosition,doc="See `GetScreenPosition`")
10376 ScreenRect = property(GetScreenRect,doc="See `GetScreenRect`")
226118fc
RD		 10377 Size = property(GetSize,SetSize,doc="See `GetSize` and `SetSize`")
10378 Sizer = property(GetSizer,SetSizer,doc="See `GetSizer` and `SetSizer`")
226118fc
RD		 10379 ThemeEnabled = property(GetThemeEnabled,SetThemeEnabled,doc="See `GetThemeEnabled` and `SetThemeEnabled`")
10380 ToolTip = property(GetToolTip,SetToolTip,doc="See `GetToolTip` and `SetToolTip`")
10381 UpdateClientRect = property(GetUpdateClientRect,doc="See `GetUpdateClientRect`")
10382 UpdateRegion = property(GetUpdateRegion,doc="See `GetUpdateRegion`")
10383 Validator = property(GetValidator,SetValidator,doc="See `GetValidator` and `SetValidator`")
10384 VirtualSize = property(GetVirtualSize,SetVirtualSize,doc="See `GetVirtualSize` and `SetVirtualSize`")
10385 WindowStyle = property(GetWindowStyle,SetWindowStyle,doc="See `GetWindowStyle` and `SetWindowStyle`")
10386 WindowStyleFlag = property(GetWindowStyleFlag,SetWindowStyleFlag,doc="See `GetWindowStyleFlag` and `SetWindowStyleFlag`")
10387 WindowVariant = property(GetWindowVariant,SetWindowVariant,doc="See `GetWindowVariant` and `SetWindowVariant`")
97ab0f6a
RD		 10388 Shown = property(IsShown,Show,doc="See `IsShown` and `Show`")
10389 Enabled = property(IsEnabled,Enable,doc="See `IsEnabled` and `Enable`")
10390 TopLevel = property(IsTopLevel,doc="See `IsTopLevel`")
2131d850 10391_core_.Window_swigregister(Window)
d55e5bfc
RD		 10392
10393def PreWindow(*args, **kwargs):
10394 """
10395 PreWindow() -> Window
10396
10397 Precreate a Window for 2-phase creation.
10398 """
10399 val = _core_.new_PreWindow(*args, **kwargs)
d55e5bfc
RD		 10400 return val
10401
554f62e9
RD		 10402def Window_NewControlId(*args):
10403 """
d55e5bfc
RD		 10404 Window_NewControlId() -> int
10405
10406 Generate a control id for the controls which were not given one.
10407 """
554f62e9 10408 return _core_.Window_NewControlId(*args)
d55e5bfc
RD		 10409
10410def Window_NextControlId(*args, **kwargs):
554f62e9 10411 """
d55e5bfc
RD		 10412 Window_NextControlId(int winid) -> int
10413
10414 Get the id of the control following the one with the given
79fccf9d 10415 autogenerated) id
d55e5bfc 10416 """
554f62e9 10417 return _core_.Window_NextControlId(*args, **kwargs)
d55e5bfc
RD		 10418
10419def Window_PrevControlId(*args, **kwargs):
554f62e9 10420 """
d55e5bfc
RD		 10421 Window_PrevControlId(int winid) -> int
10422
10423 Get the id of the control preceding the one with the given
79fccf9d 10424 autogenerated) id
d55e5bfc 10425 """
554f62e9 10426 return _core_.Window_PrevControlId(*args, **kwargs)
d55e5bfc 10427
554f62e9
RD		 10428def Window_FindFocus(*args):
10429 """
d55e5bfc
RD		 10430 Window_FindFocus() -> Window
10431
10432 Returns the window or control that currently has the keyboard focus,
10433 or None.
10434 """
554f62e9 10435 return _core_.Window_FindFocus(*args)
d55e5bfc 10436
554f62e9
RD		 10437def Window_GetCapture(*args):
10438 """
d55e5bfc
RD		 10439 Window_GetCapture() -> Window
10440
10441 Returns the window which currently captures the mouse or None
10442 """
554f62e9 10443 return _core_.Window_GetCapture(*args)
d55e5bfc
RD		 10444
10445def Window_GetClassDefaultAttributes(*args, **kwargs):
554f62e9 10446 """
d55e5bfc
RD		 10447 Window_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
10448
79fccf9d
RD		 10449 Get the default attributes for this class. This is useful if you want
10450 to use the same font or colour in your own control as in a standard
10451 control -- which is a much better idea than hard coding specific
caef1a4d
RD		 10452 colours or fonts which might look completely out of place on the
10453 user's system, especially if it uses themes.
d55e5bfc
RD		 10454
10455 The variant parameter is only relevant under Mac currently and is
79fccf9d 10456 ignore under other platforms. Under Mac, it will change the size of
caef1a4d
RD		 10457 the returned font. See `wx.Window.SetWindowVariant` for more about
10458 this.
d55e5bfc 10459 """
554f62e9 10460 return _core_.Window_GetClassDefaultAttributes(*args, **kwargs)
d55e5bfc
RD		 10461
10462def DLG_PNT(win, point_or_x, y=None):
10463 """
10464 Convenience function for converting a Point or (x,y) in
10465 dialog units to pixel units.
10466 """
10467 if y is None:
10468 return win.ConvertDialogPointToPixels(point_or_x)
10469 else:
10470 return win.ConvertDialogPointToPixels(wx.Point(point_or_x, y))
10471
10472def DLG_SZE(win, size_width, height=None):
10473 """
10474 Convenience function for converting a Size or (w,h) in
10475 dialog units to pixel units.
10476 """
10477 if height is None:
10478 return win.ConvertDialogSizeToPixels(size_width)
10479 else:
10480 return win.ConvertDialogSizeToPixels(wx.Size(size_width, height))
10481
10482
10483def FindWindowById(*args, **kwargs):
554f62e9 10484 """
d55e5bfc
RD		 10485 FindWindowById(long id, Window parent=None) -> Window
10486
10487 Find the first window in the application with the given id. If parent
10488 is None, the search will start from all top-level frames and dialog
10489 boxes; if non-None, the search will be limited to the given window
10490 hierarchy. The search is recursive in both cases.
10491 """
554f62e9 10492 return _core_.FindWindowById(*args, **kwargs)
d55e5bfc
RD		 10493
10494def FindWindowByName(*args, **kwargs):
554f62e9 10495 """
d55e5bfc
RD		 10496 FindWindowByName(String name, Window parent=None) -> Window
10497
10498 Find a window by its name (as given in a window constructor or Create
10499 function call). If parent is None, the search will start from all
10500 top-level frames and dialog boxes; if non-None, the search will be
10501 limited to the given window hierarchy. The search is recursive in both
10502 cases.
10503
10504 If no window with such name is found, wx.FindWindowByLabel is called.
10505 """
554f62e9 10506 return _core_.FindWindowByName(*args, **kwargs)
d55e5bfc
RD		 10507
10508def FindWindowByLabel(*args, **kwargs):
554f62e9 10509 """
d55e5bfc
RD		 10510 FindWindowByLabel(String label, Window parent=None) -> Window
10511
10512 Find a window by its label. Depending on the type of window, the label
10513 may be a window title or panel item label. If parent is None, the
10514 search will start from all top-level frames and dialog boxes; if
10515 non-None, the search will be limited to the given window
10516 hierarchy. The search is recursive in both cases.
10517 """
554f62e9 10518 return _core_.FindWindowByLabel(*args, **kwargs)
d55e5bfc
RD		 10519
10520def Window_FromHWND(*args, **kwargs):
554f62e9
RD		 10521 """Window_FromHWND(Window parent, unsigned long _hWnd) -> Window"""
10522 return _core_.Window_FromHWND(*args, **kwargs)
3215336e 10523
554f62e9
RD		 10524def GetTopLevelWindows(*args):
10525 """
3215336e
RD		 10526 GetTopLevelWindows() -> PyObject
10527
10528 Returns a list of the the application's top-level windows, (frames,
10529 dialogs, etc.) NOTE: Currently this is a copy of the list maintained
10530 by wxWidgets, and so it is only valid as long as no top-level windows
10531 are closed or new top-level windows are created.
10532
10533 """
554f62e9 10534 return _core_.GetTopLevelWindows(*args)
d55e5bfc
RD		 10535#---------------------------------------------------------------------------
10536
10537class Validator(EvtHandler):
093d3ff1 10538 """Proxy of C++ Validator class"""
554f62e9
RD		 10539 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10540 __repr__ = _swig_repr
10541 def __init__(self, *args, **kwargs):
d55e5bfc 10542 """__init__(self) -> Validator"""
554f62e9 10543 _core_.Validator_swiginit(self,_core_.new_Validator(*args, **kwargs))
d55e5bfc
RD		 10544 self._setOORInfo(self)
10545
10546 def Clone(*args, **kwargs):
10547 """Clone(self) -> Validator"""
10548 return _core_.Validator_Clone(*args, **kwargs)
10549
10550 def Validate(*args, **kwargs):
10551 """Validate(self, Window parent) -> bool"""
10552 return _core_.Validator_Validate(*args, **kwargs)
10553
10554 def TransferToWindow(*args, **kwargs):
10555 """TransferToWindow(self) -> bool"""
10556 return _core_.Validator_TransferToWindow(*args, **kwargs)
10557
10558 def TransferFromWindow(*args, **kwargs):
10559 """TransferFromWindow(self) -> bool"""
10560 return _core_.Validator_TransferFromWindow(*args, **kwargs)
10561
10562 def GetWindow(*args, **kwargs):
10563 """GetWindow(self) -> Window"""
10564 return _core_.Validator_GetWindow(*args, **kwargs)
10565
10566 def SetWindow(*args, **kwargs):
10567 """SetWindow(self, Window window)"""
10568 return _core_.Validator_SetWindow(*args, **kwargs)
10569
10570 def IsSilent(*args, **kwargs):
c24da6d6 10571 """IsSilent() -> bool"""
d55e5bfc
RD		 10572 return _core_.Validator_IsSilent(*args, **kwargs)
10573
10574 IsSilent = staticmethod(IsSilent)
10575 def SetBellOnError(*args, **kwargs):
c24da6d6 10576 """SetBellOnError(int doIt=True)"""
d55e5bfc
RD		 10577 return _core_.Validator_SetBellOnError(*args, **kwargs)
10578
10579 SetBellOnError = staticmethod(SetBellOnError)
dba7934c 10580 Window = property(GetWindow,SetWindow,doc="See `GetWindow` and `SetWindow`")
2131d850 10581_core_.Validator_swigregister(Validator)
d55e5bfc 10582
554f62e9
RD		 10583def Validator_IsSilent(*args):
10584 """Validator_IsSilent() -> bool"""
10585 return _core_.Validator_IsSilent(*args)
d55e5bfc
RD		 10586
10587def Validator_SetBellOnError(*args, **kwargs):
554f62e9
RD		 10588 """Validator_SetBellOnError(int doIt=True)"""
10589 return _core_.Validator_SetBellOnError(*args, **kwargs)
d55e5bfc
RD		 10590
10591class PyValidator(Validator):
093d3ff1 10592 """Proxy of C++ PyValidator class"""
554f62e9
RD		 10593 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10594 __repr__ = _swig_repr
10595 def __init__(self, *args, **kwargs):
d55e5bfc 10596 """__init__(self) -> PyValidator"""
554f62e9 10597 _core_.PyValidator_swiginit(self,_core_.new_PyValidator(*args, **kwargs))
d55e5bfc
RD		 10598
10599 self._setCallbackInfo(self, PyValidator, 1)
10600 self._setOORInfo(self)
10601
10602 def _setCallbackInfo(*args, **kwargs):
10603 """_setCallbackInfo(self, PyObject self, PyObject _class, int incref=True)"""
10604 return _core_.PyValidator__setCallbackInfo(*args, **kwargs)
10605
2131d850 10606_core_.PyValidator_swigregister(PyValidator)
d55e5bfc
RD		 10607
10608#---------------------------------------------------------------------------
10609
10610class Menu(EvtHandler):
093d3ff1 10611 """Proxy of C++ Menu class"""
554f62e9
RD		 10612 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10613 __repr__ = _swig_repr
10614 def __init__(self, *args, **kwargs):
d55e5bfc 10615 """__init__(self, String title=EmptyString, long style=0) -> Menu"""
554f62e9 10616 _core_.Menu_swiginit(self,_core_.new_Menu(*args, **kwargs))
d55e5bfc
RD		 10617 self._setOORInfo(self)
10618
10619 def Append(*args, **kwargs):
97ab0f6a
RD		 10620 """
10621 Append(self, int id, String text=EmptyString, String help=EmptyString,
10622 int kind=ITEM_NORMAL) -> MenuItem
10623 """
d55e5bfc
RD		 10624 return _core_.Menu_Append(*args, **kwargs)
10625
10626 def AppendSeparator(*args, **kwargs):
10627 """AppendSeparator(self) -> MenuItem"""
10628 return _core_.Menu_AppendSeparator(*args, **kwargs)
10629
10630 def AppendCheckItem(*args, **kwargs):
10631 """AppendCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10632 return _core_.Menu_AppendCheckItem(*args, **kwargs)
10633
10634 def AppendRadioItem(*args, **kwargs):
10635 """AppendRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10636 return _core_.Menu_AppendRadioItem(*args, **kwargs)
10637
10638 def AppendMenu(*args, **kwargs):
10639 """AppendMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
10640 return _core_.Menu_AppendMenu(*args, **kwargs)
10641
50efceee
RD		 10642 def AppendSubMenu(*args, **kwargs):
10643 """AppendSubMenu(self, Menu submenu, String text, String help=EmptyString) -> MenuItem"""
10644 return _core_.Menu_AppendSubMenu(*args, **kwargs)
10645
d55e5bfc
RD		 10646 def AppendItem(*args, **kwargs):
10647 """AppendItem(self, MenuItem item) -> MenuItem"""
10648 return _core_.Menu_AppendItem(*args, **kwargs)
10649
d55e5bfc
RD		 10650 def InsertItem(*args, **kwargs):
10651 """InsertItem(self, size_t pos, MenuItem item) -> MenuItem"""
10652 return _core_.Menu_InsertItem(*args, **kwargs)
10653
554f62e9
RD		 10654 def PrependItem(*args, **kwargs):
10655 """PrependItem(self, MenuItem item) -> MenuItem"""
10656 return _core_.Menu_PrependItem(*args, **kwargs)
10657
10658 def Break(*args, **kwargs):
10659 """Break(self)"""
10660 return _core_.Menu_Break(*args, **kwargs)
10661
d55e5bfc
RD		 10662 def Insert(*args, **kwargs):
10663 """
97ab0f6a 10664 Insert(self, size_t pos, int id, String text=EmptyString, String help=EmptyString,
d55e5bfc
RD		 10665 int kind=ITEM_NORMAL) -> MenuItem
10666 """
10667 return _core_.Menu_Insert(*args, **kwargs)
10668
10669 def InsertSeparator(*args, **kwargs):
10670 """InsertSeparator(self, size_t pos) -> MenuItem"""
10671 return _core_.Menu_InsertSeparator(*args, **kwargs)
10672
10673 def InsertCheckItem(*args, **kwargs):
10674 """InsertCheckItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
10675 return _core_.Menu_InsertCheckItem(*args, **kwargs)
10676
10677 def InsertRadioItem(*args, **kwargs):
10678 """InsertRadioItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
10679 return _core_.Menu_InsertRadioItem(*args, **kwargs)
10680
10681 def InsertMenu(*args, **kwargs):
10682 """InsertMenu(self, size_t pos, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
10683 return _core_.Menu_InsertMenu(*args, **kwargs)
10684
d55e5bfc 10685 def Prepend(*args, **kwargs):
97ab0f6a
RD		 10686 """
10687 Prepend(self, int id, String text=EmptyString, String help=EmptyString,
10688 int kind=ITEM_NORMAL) -> MenuItem
10689 """
d55e5bfc
RD		 10690 return _core_.Menu_Prepend(*args, **kwargs)
10691
10692 def PrependSeparator(*args, **kwargs):
10693 """PrependSeparator(self) -> MenuItem"""
10694 return _core_.Menu_PrependSeparator(*args, **kwargs)
10695
10696 def PrependCheckItem(*args, **kwargs):
10697 """PrependCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10698 return _core_.Menu_PrependCheckItem(*args, **kwargs)
10699
10700 def PrependRadioItem(*args, **kwargs):
10701 """PrependRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10702 return _core_.Menu_PrependRadioItem(*args, **kwargs)
10703
10704 def PrependMenu(*args, **kwargs):
10705 """PrependMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
10706 return _core_.Menu_PrependMenu(*args, **kwargs)
10707
10708 def Remove(*args, **kwargs):
10709 """Remove(self, int id) -> MenuItem"""
10710 return _core_.Menu_Remove(*args, **kwargs)
10711
10712 def RemoveItem(*args, **kwargs):
10713 """RemoveItem(self, MenuItem item) -> MenuItem"""
10714 return _core_.Menu_RemoveItem(*args, **kwargs)
10715
10716 def Delete(*args, **kwargs):
10717 """Delete(self, int id) -> bool"""
10718 return _core_.Menu_Delete(*args, **kwargs)
10719
10720 def DeleteItem(*args, **kwargs):
10721 """DeleteItem(self, MenuItem item) -> bool"""
10722 return _core_.Menu_DeleteItem(*args, **kwargs)
10723
10724 def Destroy(*args, **kwargs):
10725 """
10726 Destroy(self)
10727
10728 Deletes the C++ object this Python object is a proxy for.
10729 """
b39fe951
RD		 10730 args[0].this.own(False)
10731 return _core_.Menu_Destroy(*args, **kwargs)
d55e5bfc
RD		 10732
10733 def DestroyId(*args, **kwargs):
b39fe951
RD		 10734 """DestroyId(self, int id) -> bool"""
10735 return _core_.Menu_DestroyId(*args, **kwargs)
d55e5bfc
RD		 10736
10737 def DestroyItem(*args, **kwargs):
b39fe951
RD		 10738 """DestroyItem(self, MenuItem item) -> bool"""
10739 return _core_.Menu_DestroyItem(*args, **kwargs)
d55e5bfc
RD		 10740
10741 def GetMenuItemCount(*args, **kwargs):
10742 """GetMenuItemCount(self) -> size_t"""
10743 return _core_.Menu_GetMenuItemCount(*args, **kwargs)
10744
10745 def GetMenuItems(*args, **kwargs):
10746 """GetMenuItems(self) -> PyObject"""
10747 return _core_.Menu_GetMenuItems(*args, **kwargs)
10748
10749 def FindItem(*args, **kwargs):
10750 """FindItem(self, String item) -> int"""
10751 return _core_.Menu_FindItem(*args, **kwargs)
10752
10753 def FindItemById(*args, **kwargs):
10754 """FindItemById(self, int id) -> MenuItem"""
10755 return _core_.Menu_FindItemById(*args, **kwargs)
10756
10757 def FindItemByPosition(*args, **kwargs):
10758 """FindItemByPosition(self, size_t position) -> MenuItem"""
10759 return _core_.Menu_FindItemByPosition(*args, **kwargs)
10760
10761 def Enable(*args, **kwargs):
10762 """Enable(self, int id, bool enable)"""
10763 return _core_.Menu_Enable(*args, **kwargs)
10764
10765 def IsEnabled(*args, **kwargs):
10766 """IsEnabled(self, int id) -> bool"""
10767 return _core_.Menu_IsEnabled(*args, **kwargs)
10768
10769 def Check(*args, **kwargs):
10770 """Check(self, int id, bool check)"""
10771 return _core_.Menu_Check(*args, **kwargs)
10772
10773 def IsChecked(*args, **kwargs):
10774 """IsChecked(self, int id) -> bool"""
10775 return _core_.Menu_IsChecked(*args, **kwargs)
10776
10777 def SetLabel(*args, **kwargs):
10778 """SetLabel(self, int id, String label)"""
10779 return _core_.Menu_SetLabel(*args, **kwargs)
10780
10781 def GetLabel(*args, **kwargs):
10782 """GetLabel(self, int id) -> String"""
10783 return _core_.Menu_GetLabel(*args, **kwargs)
10784
10785 def SetHelpString(*args, **kwargs):
10786 """SetHelpString(self, int id, String helpString)"""
10787 return _core_.Menu_SetHelpString(*args, **kwargs)
10788
10789 def GetHelpString(*args, **kwargs):
10790 """GetHelpString(self, int id) -> String"""
10791 return _core_.Menu_GetHelpString(*args, **kwargs)
10792
10793 def SetTitle(*args, **kwargs):
10794 """SetTitle(self, String title)"""
10795 return _core_.Menu_SetTitle(*args, **kwargs)
10796
10797 def GetTitle(*args, **kwargs):
10798 """GetTitle(self) -> String"""
10799 return _core_.Menu_GetTitle(*args, **kwargs)
10800
10801 def SetEventHandler(*args, **kwargs):
10802 """SetEventHandler(self, EvtHandler handler)"""
10803 return _core_.Menu_SetEventHandler(*args, **kwargs)
10804
10805 def GetEventHandler(*args, **kwargs):
10806 """GetEventHandler(self) -> EvtHandler"""
10807 return _core_.Menu_GetEventHandler(*args, **kwargs)
10808
10809 def SetInvokingWindow(*args, **kwargs):
10810 """SetInvokingWindow(self, Window win)"""
10811 return _core_.Menu_SetInvokingWindow(*args, **kwargs)
10812
10813 def GetInvokingWindow(*args, **kwargs):
10814 """GetInvokingWindow(self) -> Window"""
10815 return _core_.Menu_GetInvokingWindow(*args, **kwargs)
10816
10817 def GetStyle(*args, **kwargs):
10818 """GetStyle(self) -> long"""
10819 return _core_.Menu_GetStyle(*args, **kwargs)
10820
10821 def UpdateUI(*args, **kwargs):
10822 """UpdateUI(self, EvtHandler source=None)"""
10823 return _core_.Menu_UpdateUI(*args, **kwargs)
10824
10825 def GetMenuBar(*args, **kwargs):
10826 """GetMenuBar(self) -> MenuBar"""
10827 return _core_.Menu_GetMenuBar(*args, **kwargs)
10828
10829 def Attach(*args, **kwargs):
10830 """Attach(self, wxMenuBarBase menubar)"""
10831 return _core_.Menu_Attach(*args, **kwargs)
10832
10833 def Detach(*args, **kwargs):
10834 """Detach(self)"""
10835 return _core_.Menu_Detach(*args, **kwargs)
10836
10837 def IsAttached(*args, **kwargs):
10838 """IsAttached(self) -> bool"""
10839 return _core_.Menu_IsAttached(*args, **kwargs)
10840
10841 def SetParent(*args, **kwargs):
10842 """SetParent(self, Menu parent)"""
10843 return _core_.Menu_SetParent(*args, **kwargs)
10844
10845 def GetParent(*args, **kwargs):
10846 """GetParent(self) -> Menu"""
10847 return _core_.Menu_GetParent(*args, **kwargs)
10848
57332a5a
RD		 10849 EventHandler = property(GetEventHandler,SetEventHandler,doc="See `GetEventHandler` and `SetEventHandler`")
10850 HelpString = property(GetHelpString,SetHelpString,doc="See `GetHelpString` and `SetHelpString`")
10851 InvokingWindow = property(GetInvokingWindow,SetInvokingWindow,doc="See `GetInvokingWindow` and `SetInvokingWindow`")
10852 MenuBar = property(GetMenuBar,doc="See `GetMenuBar`")
10853 MenuItemCount = property(GetMenuItemCount,doc="See `GetMenuItemCount`")
10854 MenuItems = property(GetMenuItems,doc="See `GetMenuItems`")
10855 Parent = property(GetParent,SetParent,doc="See `GetParent` and `SetParent`")
10856 Style = property(GetStyle,doc="See `GetStyle`")
10857 Title = property(GetTitle,SetTitle,doc="See `GetTitle` and `SetTitle`")
2131d850 10858_core_.Menu_swigregister(Menu)
d55e5bfc
RD		 10859DefaultValidator = cvar.DefaultValidator
10860
10861#---------------------------------------------------------------------------
10862
10863class MenuBar(Window):
093d3ff1 10864 """Proxy of C++ MenuBar class"""
554f62e9
RD		 10865 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10866 __repr__ = _swig_repr
10867 def __init__(self, *args, **kwargs):
d55e5bfc 10868 """__init__(self, long style=0) -> MenuBar"""
554f62e9 10869 _core_.MenuBar_swiginit(self,_core_.new_MenuBar(*args, **kwargs))
d55e5bfc
RD		 10870 self._setOORInfo(self)
10871
10872 def Append(*args, **kwargs):
10873 """Append(self, Menu menu, String title) -> bool"""
10874 return _core_.MenuBar_Append(*args, **kwargs)
10875
10876 def Insert(*args, **kwargs):
10877 """Insert(self, size_t pos, Menu menu, String title) -> bool"""
10878 return _core_.MenuBar_Insert(*args, **kwargs)
10879
10880 def GetMenuCount(*args, **kwargs):
10881 """GetMenuCount(self) -> size_t"""
10882 return _core_.MenuBar_GetMenuCount(*args, **kwargs)
10883
10884 def GetMenu(*args, **kwargs):
10885 """GetMenu(self, size_t pos) -> Menu"""
10886 return _core_.MenuBar_GetMenu(*args, **kwargs)
10887
10888 def Replace(*args, **kwargs):
10889 """Replace(self, size_t pos, Menu menu, String title) -> Menu"""
10890 return _core_.MenuBar_Replace(*args, **kwargs)
10891
10892 def Remove(*args, **kwargs):
10893 """Remove(self, size_t pos) -> Menu"""
10894 return _core_.MenuBar_Remove(*args, **kwargs)
10895
10896 def EnableTop(*args, **kwargs):
10897 """EnableTop(self, size_t pos, bool enable)"""
10898 return _core_.MenuBar_EnableTop(*args, **kwargs)
10899
10900 def IsEnabledTop(*args, **kwargs):
10901 """IsEnabledTop(self, size_t pos) -> bool"""
10902 return _core_.MenuBar_IsEnabledTop(*args, **kwargs)
10903
10904 def SetLabelTop(*args, **kwargs):
10905 """SetLabelTop(self, size_t pos, String label)"""
10906 return _core_.MenuBar_SetLabelTop(*args, **kwargs)
10907
10908 def GetLabelTop(*args, **kwargs):
10909 """GetLabelTop(self, size_t pos) -> String"""
10910 return _core_.MenuBar_GetLabelTop(*args, **kwargs)
10911
10912 def FindMenuItem(*args, **kwargs):
10913 """FindMenuItem(self, String menu, String item) -> int"""
10914 return _core_.MenuBar_FindMenuItem(*args, **kwargs)
10915
10916 def FindItemById(*args, **kwargs):
10917 """FindItemById(self, int id) -> MenuItem"""
10918 return _core_.MenuBar_FindItemById(*args, **kwargs)
10919
10920 def FindMenu(*args, **kwargs):
10921 """FindMenu(self, String title) -> int"""
10922 return _core_.MenuBar_FindMenu(*args, **kwargs)
10923
10924 def Enable(*args, **kwargs):
10925 """Enable(self, int id, bool enable)"""
10926 return _core_.MenuBar_Enable(*args, **kwargs)
10927
10928 def Check(*args, **kwargs):
10929 """Check(self, int id, bool check)"""
10930 return _core_.MenuBar_Check(*args, **kwargs)
10931
10932 def IsChecked(*args, **kwargs):
10933 """IsChecked(self, int id) -> bool"""
10934 return _core_.MenuBar_IsChecked(*args, **kwargs)
10935
10936 def IsEnabled(*args, **kwargs):
10937 """IsEnabled(self, int id) -> bool"""
10938 return _core_.MenuBar_IsEnabled(*args, **kwargs)
10939
10940 def SetLabel(*args, **kwargs):
10941 """SetLabel(self, int id, String label)"""
10942 return _core_.MenuBar_SetLabel(*args, **kwargs)
10943
10944 def GetLabel(*args, **kwargs):
10945 """GetLabel(self, int id) -> String"""
10946 return _core_.MenuBar_GetLabel(*args, **kwargs)
10947
10948 def SetHelpString(*args, **kwargs):
10949 """SetHelpString(self, int id, String helpString)"""
10950 return _core_.MenuBar_SetHelpString(*args, **kwargs)
10951
10952 def GetHelpString(*args, **kwargs):
10953 """GetHelpString(self, int id) -> String"""
10954 return _core_.MenuBar_GetHelpString(*args, **kwargs)
10955
10956 def GetFrame(*args, **kwargs):
10957 """GetFrame(self) -> wxFrame"""
10958 return _core_.MenuBar_GetFrame(*args, **kwargs)
10959
10960 def IsAttached(*args, **kwargs):
10961 """IsAttached(self) -> bool"""
10962 return _core_.MenuBar_IsAttached(*args, **kwargs)
10963
10964 def Attach(*args, **kwargs):
10965 """Attach(self, wxFrame frame)"""
10966 return _core_.MenuBar_Attach(*args, **kwargs)
10967
10968 def Detach(*args, **kwargs):
10969 """Detach(self)"""
10970 return _core_.MenuBar_Detach(*args, **kwargs)
10971
587d0f36
RD		 10972 def UpdateMenus(*args, **kwargs):
10973 """UpdateMenus(self)"""
10974 return _core_.MenuBar_UpdateMenus(*args, **kwargs)
10975
db67f999
RD		 10976 def SetAutoWindowMenu(*args, **kwargs):
10977 """SetAutoWindowMenu(bool enable)"""
10978 return _core_.MenuBar_SetAutoWindowMenu(*args, **kwargs)
10979
10980 SetAutoWindowMenu = staticmethod(SetAutoWindowMenu)
10981 def GetAutoWindowMenu(*args, **kwargs):
10982 """GetAutoWindowMenu() -> bool"""
10983 return _core_.MenuBar_GetAutoWindowMenu(*args, **kwargs)
10984
10985 GetAutoWindowMenu = staticmethod(GetAutoWindowMenu)
97ab0f6a
RD		 10986 def GetMenus(self):
10987 """Return a list of (menu, label) items for the menus in the MenuBar. """
10988 return [(self.GetMenu(i), self.GetLabelTop(i))
10989 for i in range(self.GetMenuCount())]
10990
10991 def SetMenus(self, items):
10992 """Clear and add new menus to the MenuBar from a list of (menu, label) items. """
10993 for i in range(self.GetMenuCount()-1, -1, -1):
10994 self.Remove(i)
10995 for m, l in items:
10996 self.Append(m, l)
10997
57332a5a
RD		 10998 Frame = property(GetFrame,doc="See `GetFrame`")
10999 Menu = property(GetMenu,doc="See `GetMenu`")
11000 MenuCount = property(GetMenuCount,doc="See `GetMenuCount`")
11001 Menus = property(GetMenus,SetMenus,doc="See `GetMenus` and `SetMenus`")
2131d850 11002_core_.MenuBar_swigregister(MenuBar)
d55e5bfc 11003
db67f999 11004def MenuBar_SetAutoWindowMenu(*args, **kwargs):
554f62e9
RD		 11005 """MenuBar_SetAutoWindowMenu(bool enable)"""
11006 return _core_.MenuBar_SetAutoWindowMenu(*args, **kwargs)
db67f999 11007
554f62e9
RD		 11008def MenuBar_GetAutoWindowMenu(*args):
11009 """MenuBar_GetAutoWindowMenu() -> bool"""
11010 return _core_.MenuBar_GetAutoWindowMenu(*args)
db67f999 11011
d55e5bfc
RD		 11012#---------------------------------------------------------------------------
11013
11014class MenuItem(Object):
093d3ff1 11015 """Proxy of C++ MenuItem class"""
554f62e9
RD		 11016 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11017 __repr__ = _swig_repr
11018 def __init__(self, *args, **kwargs):
d55e5bfc
RD		 11019 """
11020 __init__(self, Menu parentMenu=None, int id=ID_ANY, String text=EmptyString,
11021 String help=EmptyString, int kind=ITEM_NORMAL,
11022 Menu subMenu=None) -> MenuItem
11023 """
554f62e9
RD		 11024 _core_.MenuItem_swiginit(self,_core_.new_MenuItem(*args, **kwargs))
11025 __swig_destroy__ = _core_.delete_MenuItem
11026 __del__ = lambda self : None;
d55e5bfc
RD		 11027 def GetMenu(*args, **kwargs):
11028 """GetMenu(self) -> Menu"""
11029 return _core_.MenuItem_GetMenu(*args, **kwargs)
11030
11031 def SetMenu(*args, **kwargs):
11032 """SetMenu(self, Menu menu)"""
11033 return _core_.MenuItem_SetMenu(*args, **kwargs)
11034
11035 def SetId(*args, **kwargs):
11036 """SetId(self, int id)"""
11037 return _core_.MenuItem_SetId(*args, **kwargs)
11038
11039 def GetId(*args, **kwargs):
11040 """GetId(self) -> int"""
11041 return _core_.MenuItem_GetId(*args, **kwargs)
11042
11043 def IsSeparator(*args, **kwargs):
11044 """IsSeparator(self) -> bool"""
11045 return _core_.MenuItem_IsSeparator(*args, **kwargs)
11046
11047 def SetText(*args, **kwargs):
11048 """SetText(self, String str)"""
11049 return _core_.MenuItem_SetText(*args, **kwargs)
11050
11051 def GetLabel(*args, **kwargs):
11052 """GetLabel(self) -> String"""
11053 return _core_.MenuItem_GetLabel(*args, **kwargs)
11054
11055 def GetText(*args, **kwargs):
11056 """GetText(self) -> String"""
11057 return _core_.MenuItem_GetText(*args, **kwargs)
11058
11059 def GetLabelFromText(*args, **kwargs):
c24da6d6 11060 """GetLabelFromText(String text) -> String"""
d55e5bfc
RD		 11061 return _core_.MenuItem_GetLabelFromText(*args, **kwargs)
11062
11063 GetLabelFromText = staticmethod(GetLabelFromText)
11064 def GetKind(*args, **kwargs):
11065 """GetKind(self) -> int"""
11066 return _core_.MenuItem_GetKind(*args, **kwargs)
11067
11068 def SetKind(*args, **kwargs):
11069 """SetKind(self, int kind)"""
11070 return _core_.MenuItem_SetKind(*args, **kwargs)
11071
11072 def SetCheckable(*args, **kwargs):
11073 """SetCheckable(self, bool checkable)"""
11074 return _core_.MenuItem_SetCheckable(*args, **kwargs)
11075
11076 def IsCheckable(*args, **kwargs):
11077 """IsCheckable(self) -> bool"""
11078 return _core_.MenuItem_IsCheckable(*args, **kwargs)
11079
11080 def IsSubMenu(*args, **kwargs):
11081 """IsSubMenu(self) -> bool"""
11082 return _core_.MenuItem_IsSubMenu(*args, **kwargs)
11083
11084 def SetSubMenu(*args, **kwargs):
11085 """SetSubMenu(self, Menu menu)"""
11086 return _core_.MenuItem_SetSubMenu(*args, **kwargs)
11087
11088 def GetSubMenu(*args, **kwargs):
11089 """GetSubMenu(self) -> Menu"""
11090 return _core_.MenuItem_GetSubMenu(*args, **kwargs)
11091
11092 def Enable(*args, **kwargs):
11093 """Enable(self, bool enable=True)"""
11094 return _core_.MenuItem_Enable(*args, **kwargs)
11095
11096 def IsEnabled(*args, **kwargs):
11097 """IsEnabled(self) -> bool"""
11098 return _core_.MenuItem_IsEnabled(*args, **kwargs)
11099
11100 def Check(*args, **kwargs):
11101 """Check(self, bool check=True)"""
11102 return _core_.MenuItem_Check(*args, **kwargs)
11103
11104 def IsChecked(*args, **kwargs):
11105 """IsChecked(self) -> bool"""
11106 return _core_.MenuItem_IsChecked(*args, **kwargs)
11107
11108 def Toggle(*args, **kwargs):
11109 """Toggle(self)"""
11110 return _core_.MenuItem_Toggle(*args, **kwargs)
11111
11112 def SetHelp(*args, **kwargs):
11113 """SetHelp(self, String str)"""
11114 return _core_.MenuItem_SetHelp(*args, **kwargs)
11115
11116 def GetHelp(*args, **kwargs):
11117 """GetHelp(self) -> String"""
11118 return _core_.MenuItem_GetHelp(*args, **kwargs)
11119
11120 def GetAccel(*args, **kwargs):
11121 """GetAccel(self) -> AcceleratorEntry"""
11122 return _core_.MenuItem_GetAccel(*args, **kwargs)
11123
11124 def SetAccel(*args, **kwargs):
11125 """SetAccel(self, AcceleratorEntry accel)"""
11126 return _core_.MenuItem_SetAccel(*args, **kwargs)
11127
7449af73
RD		 11128 def SetBitmap(*args, **kwargs):
11129 """SetBitmap(self, Bitmap bitmap)"""
11130 return _core_.MenuItem_SetBitmap(*args, **kwargs)
11131
11132 def GetBitmap(*args, **kwargs):
11133 """GetBitmap(self) -> Bitmap"""
11134 return _core_.MenuItem_GetBitmap(*args, **kwargs)
11135
d55e5bfc
RD		 11136 def SetFont(*args, **kwargs):
11137 """SetFont(self, Font font)"""
11138 return _core_.MenuItem_SetFont(*args, **kwargs)
11139
11140 def GetFont(*args, **kwargs):
11141 """GetFont(self) -> Font"""
11142 return _core_.MenuItem_GetFont(*args, **kwargs)
11143
11144 def SetTextColour(*args, **kwargs):
11145 """SetTextColour(self, Colour colText)"""
11146 return _core_.MenuItem_SetTextColour(*args, **kwargs)
11147
11148 def GetTextColour(*args, **kwargs):
11149 """GetTextColour(self) -> Colour"""
11150 return _core_.MenuItem_GetTextColour(*args, **kwargs)
11151
11152 def SetBackgroundColour(*args, **kwargs):
11153 """SetBackgroundColour(self, Colour colBack)"""
11154 return _core_.MenuItem_SetBackgroundColour(*args, **kwargs)
11155
11156 def GetBackgroundColour(*args, **kwargs):
11157 """GetBackgroundColour(self) -> Colour"""
11158 return _core_.MenuItem_GetBackgroundColour(*args, **kwargs)
11159
11160 def SetBitmaps(*args, **kwargs):
11161 """SetBitmaps(self, Bitmap bmpChecked, Bitmap bmpUnchecked=wxNullBitmap)"""
11162 return _core_.MenuItem_SetBitmaps(*args, **kwargs)
11163
11164 def SetDisabledBitmap(*args, **kwargs):
11165 """SetDisabledBitmap(self, Bitmap bmpDisabled)"""
11166 return _core_.MenuItem_SetDisabledBitmap(*args, **kwargs)
11167
11168 def GetDisabledBitmap(*args, **kwargs):
11169 """GetDisabledBitmap(self) -> Bitmap"""
11170 return _core_.MenuItem_GetDisabledBitmap(*args, **kwargs)
11171
11172 def SetMarginWidth(*args, **kwargs):
11173 """SetMarginWidth(self, int nWidth)"""
11174 return _core_.MenuItem_SetMarginWidth(*args, **kwargs)
11175
11176 def GetMarginWidth(*args, **kwargs):
11177 """GetMarginWidth(self) -> int"""
11178 return _core_.MenuItem_GetMarginWidth(*args, **kwargs)
11179
11180 def GetDefaultMarginWidth(*args, **kwargs):
c24da6d6 11181 """GetDefaultMarginWidth() -> int"""
d55e5bfc
RD		 11182 return _core_.MenuItem_GetDefaultMarginWidth(*args, **kwargs)
11183
11184 GetDefaultMarginWidth = staticmethod(GetDefaultMarginWidth)
11185 def IsOwnerDrawn(*args, **kwargs):
11186 """IsOwnerDrawn(self) -> bool"""
11187 return _core_.MenuItem_IsOwnerDrawn(*args, **kwargs)
11188
11189 def SetOwnerDrawn(*args, **kwargs):
11190 """SetOwnerDrawn(self, bool ownerDrawn=True)"""
11191 return _core_.MenuItem_SetOwnerDrawn(*args, **kwargs)
11192
11193 def ResetOwnerDrawn(*args, **kwargs):
11194 """ResetOwnerDrawn(self)"""
11195 return _core_.MenuItem_ResetOwnerDrawn(*args, **kwargs)
11196
57332a5a
RD		 11197 Accel = property(GetAccel,SetAccel,doc="See `GetAccel` and `SetAccel`")
11198 BackgroundColour = property(GetBackgroundColour,SetBackgroundColour,doc="See `GetBackgroundColour` and `SetBackgroundColour`")
11199 Bitmap = property(GetBitmap,SetBitmap,doc="See `GetBitmap` and `SetBitmap`")
11200 DisabledBitmap = property(GetDisabledBitmap,SetDisabledBitmap,doc="See `GetDisabledBitmap` and `SetDisabledBitmap`")
11201 Font = property(GetFont,SetFont,doc="See `GetFont` and `SetFont`")
11202 Help = property(GetHelp,SetHelp,doc="See `GetHelp` and `SetHelp`")
11203 Id = property(GetId,SetId,doc="See `GetId` and `SetId`")
11204 Kind = property(GetKind,SetKind,doc="See `GetKind` and `SetKind`")
11205 Label = property(GetLabel,doc="See `GetLabel`")
11206 MarginWidth = property(GetMarginWidth,SetMarginWidth,doc="See `GetMarginWidth` and `SetMarginWidth`")
11207 Menu = property(GetMenu,SetMenu,doc="See `GetMenu` and `SetMenu`")
11208 SubMenu = property(GetSubMenu,SetSubMenu,doc="See `GetSubMenu` and `SetSubMenu`")
11209 Text = property(GetText,SetText,doc="See `GetText` and `SetText`")
11210 TextColour = property(GetTextColour,SetTextColour,doc="See `GetTextColour` and `SetTextColour`")
2131d850 11211_core_.MenuItem_swigregister(MenuItem)
d55e5bfc
RD		 11212
11213def MenuItem_GetLabelFromText(*args, **kwargs):
554f62e9
RD		 11214 """MenuItem_GetLabelFromText(String text) -> String"""
11215 return _core_.MenuItem_GetLabelFromText(*args, **kwargs)
d55e5bfc 11216
554f62e9
RD		 11217def MenuItem_GetDefaultMarginWidth(*args):
11218 """MenuItem_GetDefaultMarginWidth() -> int"""
11219 return _core_.MenuItem_GetDefaultMarginWidth(*args)
d55e5bfc
RD		 11220
11221#---------------------------------------------------------------------------
11222
11223class Control(Window):
11224 """
11225 This is the base class for a control or 'widget'.
11226
79fccf9d
RD		 11227 A control is generally a small window which processes user input
11228 and/or displays one or more item of data.
d55e5bfc 11229 """
554f62e9
RD		 11230 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11231 __repr__ = _swig_repr
11232 def __init__(self, *args, **kwargs):
d55e5bfc 11233 """
248ed943
RD		 11234 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
11235 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
d55e5bfc
RD		 11236 String name=ControlNameStr) -> Control
11237
79fccf9d
RD		 11238 Create a Control. Normally you should only call this from a subclass'
11239 __init__ as a plain old wx.Control is not very useful.
d55e5bfc 11240 """
554f62e9 11241 _core_.Control_swiginit(self,_core_.new_Control(*args, **kwargs))
d55e5bfc
RD		 11242 self._setOORInfo(self)
11243
11244 def Create(*args, **kwargs):
11245 """
248ed943
RD		 11246 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
11247 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
d55e5bfc
RD		 11248 String name=ControlNameStr) -> bool
11249
11250 Do the 2nd phase and create the GUI control.
11251 """
11252 return _core_.Control_Create(*args, **kwargs)
11253
1eeb270e
RD		 11254 def GetAlignment(*args, **kwargs):
11255 """
11256 GetAlignment(self) -> int
11257
11258 Get the control alignment (left/right/centre, top/bottom/centre)
11259 """
11260 return _core_.Control_GetAlignment(*args, **kwargs)
11261
0f83f5da 11262 def GetLabelText(*args, **kwargs):
1eeb270e 11263 """
1eeb270e
RD		 11264 GetLabelText(self) -> String
11265
11266 Get just the text of the label, without mnemonic characters ('&')
11267 """
0f83f5da 11268 return _core_.Control_GetLabelText(*args, **kwargs)
1eeb270e 11269
d55e5bfc
RD		 11270 def Command(*args, **kwargs):
11271 """
11272 Command(self, CommandEvent event)
11273
79fccf9d
RD		 11274 Simulates the effect of the user issuing a command to the item.
11275
11276 :see: `wx.CommandEvent`
11277
d55e5bfc
RD		 11278 """
11279 return _core_.Control_Command(*args, **kwargs)
11280
a001823c 11281 def GetClassDefaultAttributes(*args, **kwargs):
f8167d6e 11282 """
a001823c 11283 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
f8167d6e 11284
a001823c
RD		 11285 Get the default attributes for this class. This is useful if you want
11286 to use the same font or colour in your own control as in a standard
11287 control -- which is a much better idea than hard coding specific
11288 colours or fonts which might look completely out of place on the
11289 user's system, especially if it uses themes.
f8167d6e 11290
a001823c
RD		 11291 The variant parameter is only relevant under Mac currently and is
11292 ignore under other platforms. Under Mac, it will change the size of
11293 the returned font. See `wx.Window.SetWindowVariant` for more about
11294 this.
f8167d6e 11295 """
d55e5bfc
RD		 11296 return _core_.Control_GetClassDefaultAttributes(*args, **kwargs)
11297
11298 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
226118fc 11299 Alignment = property(GetAlignment,doc="See `GetAlignment`")
226118fc 11300 LabelText = property(GetLabelText,doc="See `GetLabelText`")
2131d850 11301_core_.Control_swigregister(Control)
d55e5bfc
RD		 11302ControlNameStr = cvar.ControlNameStr
11303
11304def PreControl(*args, **kwargs):
11305 """
11306 PreControl() -> Control
11307
11308 Precreate a Control control for 2-phase creation
11309 """
11310 val = _core_.new_PreControl(*args, **kwargs)
d55e5bfc
RD		 11311 return val
11312
11313def Control_GetClassDefaultAttributes(*args, **kwargs):
554f62e9 11314 """
a001823c
RD		 11315 Control_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
11316
11317 Get the default attributes for this class. This is useful if you want
11318 to use the same font or colour in your own control as in a standard
11319 control -- which is a much better idea than hard coding specific
11320 colours or fonts which might look completely out of place on the
11321 user's system, especially if it uses themes.
11322
11323 The variant parameter is only relevant under Mac currently and is
11324 ignore under other platforms. Under Mac, it will change the size of
11325 the returned font. See `wx.Window.SetWindowVariant` for more about
11326 this.
11327 """
554f62e9 11328 return _core_.Control_GetClassDefaultAttributes(*args, **kwargs)
d55e5bfc
RD		 11329
11330#---------------------------------------------------------------------------
11331
11332class ItemContainer(object):
11333 """
53aa7709
RD		 11334 The wx.ItemContainer class defines an interface which is implemented
11335 by all controls which have string subitems, each of which may be
11336 selected, such as `wx.ListBox`, `wx.CheckListBox`, `wx.Choice` as well
11337 as `wx.ComboBox` which implements an extended interface deriving from
79fccf9d 11338 this one.
d55e5bfc 11339
79fccf9d
RD		 11340 It defines the methods for accessing the control's items and although
11341 each of the derived classes implements them differently, they still
11342 all conform to the same interface.
d55e5bfc 11343
79fccf9d
RD		 11344 The items in a wx.ItemContainer have (non empty) string labels and,
11345 optionally, client data associated with them.
d55e5bfc
RD		 11346
11347 """
554f62e9
RD		 11348 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11349 def __init__(self): raise AttributeError, "No constructor defined"
11350 __repr__ = _swig_repr
d55e5bfc
RD		 11351 def Append(*args, **kwargs):
11352 """
11353 Append(self, String item, PyObject clientData=None) -> int
11354
79fccf9d
RD		 11355 Adds the item to the control, associating the given data with the item
11356 if not None. The return value is the index of the newly added item
11357 which may be different from the last one if the control is sorted (e.g.
11358 has wx.LB_SORT or wx.CB_SORT style).
d55e5bfc
RD		 11359 """
11360 return _core_.ItemContainer_Append(*args, **kwargs)
11361
11362 def AppendItems(*args, **kwargs):
11363 """
f5b96ee1 11364 AppendItems(self, List strings)
d55e5bfc 11365
79fccf9d
RD		 11366 Apend several items at once to the control. Notice that calling this
11367 method may be much faster than appending the items one by one if you
11368 need to add a lot of items.
d55e5bfc
RD		 11369 """
11370 return _core_.ItemContainer_AppendItems(*args, **kwargs)
11371
11372 def Insert(*args, **kwargs):
11373 """
50f151d7 11374 Insert(self, String item, unsigned int pos, PyObject clientData=None) -> int
d55e5bfc 11375
79fccf9d 11376 Insert an item into the control before the item at the ``pos`` index,
d55e5bfc
RD		 11377 optionally associating some data object with the item.
11378 """
11379 return _core_.ItemContainer_Insert(*args, **kwargs)
11380
11381 def Clear(*args, **kwargs):
11382 """
11383 Clear(self)
11384
11385 Removes all items from the control.
11386 """
11387 return _core_.ItemContainer_Clear(*args, **kwargs)
11388
11389 def Delete(*args, **kwargs):
11390 """
50f151d7 11391 Delete(self, unsigned int n)
d55e5bfc 11392
79fccf9d
RD		 11393 Deletes the item at the zero-based index 'n' from the control. Note
11394 that it is an error (signalled by a `wx.PyAssertionError` exception if
11395 enabled) to remove an item with the index negative or greater or equal
11396 than the number of items in the control.
d55e5bfc
RD		 11397 """
11398 return _core_.ItemContainer_Delete(*args, **kwargs)
11399
53aa7709
RD		 11400 def GetClientData(*args, **kwargs):
11401 """
50f151d7 11402 GetClientData(self, unsigned int n) -> PyObject
53aa7709
RD		 11403
11404 Returns the client data associated with the given item, (if any.)
11405 """
11406 return _core_.ItemContainer_GetClientData(*args, **kwargs)
11407
11408 def SetClientData(*args, **kwargs):
11409 """
50f151d7 11410 SetClientData(self, unsigned int n, PyObject clientData)
53aa7709
RD		 11411
11412 Associate the given client data with the item at position n.
11413 """
11414 return _core_.ItemContainer_SetClientData(*args, **kwargs)
11415
d55e5bfc
RD		 11416 def GetCount(*args, **kwargs):
11417 """
50f151d7 11418 GetCount(self) -> unsigned int
d55e5bfc
RD		 11419
11420 Returns the number of items in the control.
11421 """
11422 return _core_.ItemContainer_GetCount(*args, **kwargs)
11423
11424 def IsEmpty(*args, **kwargs):
11425 """
11426 IsEmpty(self) -> bool
11427
11428 Returns True if the control is empty or False if it has some items.
11429 """
11430 return _core_.ItemContainer_IsEmpty(*args, **kwargs)
11431
11432 def GetString(*args, **kwargs):
11433 """
50f151d7 11434 GetString(self, unsigned int n) -> String
d55e5bfc
RD		 11435
11436 Returns the label of the item with the given index.
11437 """
11438 return _core_.ItemContainer_GetString(*args, **kwargs)
11439
11440 def GetStrings(*args, **kwargs):
11441 """GetStrings(self) -> wxArrayString"""
11442 return _core_.ItemContainer_GetStrings(*args, **kwargs)
11443
11444 def SetString(*args, **kwargs):
11445 """
50f151d7 11446 SetString(self, unsigned int n, String s)
d55e5bfc
RD		 11447
11448 Sets the label for the given item.
11449 """
11450 return _core_.ItemContainer_SetString(*args, **kwargs)
11451
11452 def FindString(*args, **kwargs):
11453 """
11454 FindString(self, String s) -> int
11455
11456 Finds an item whose label matches the given string. Returns the
79fccf9d
RD		 11457 zero-based position of the item, or ``wx.NOT_FOUND`` if the string was not
11458 found.
d55e5bfc
RD		 11459 """
11460 return _core_.ItemContainer_FindString(*args, **kwargs)
11461
53aa7709 11462 def SetSelection(*args, **kwargs):
d55e5bfc 11463 """
53aa7709 11464 SetSelection(self, int n)
d55e5bfc
RD		 11465
11466 Sets the item at index 'n' to be the selected item.
11467 """
53aa7709 11468 return _core_.ItemContainer_SetSelection(*args, **kwargs)
d55e5bfc 11469
d55e5bfc
RD		 11470 def GetSelection(*args, **kwargs):
11471 """
11472 GetSelection(self) -> int
11473
79fccf9d
RD		 11474 Returns the index of the selected item or ``wx.NOT_FOUND`` if no item
11475 is selected.
d55e5bfc
RD		 11476 """
11477 return _core_.ItemContainer_GetSelection(*args, **kwargs)
11478
53aa7709
RD		 11479 def SetStringSelection(*args, **kwargs):
11480 """SetStringSelection(self, String s) -> bool"""
11481 return _core_.ItemContainer_SetStringSelection(*args, **kwargs)
11482
d55e5bfc
RD		 11483 def GetStringSelection(*args, **kwargs):
11484 """
11485 GetStringSelection(self) -> String
11486
79fccf9d
RD		 11487 Returns the label of the selected item or an empty string if no item
11488 is selected.
d55e5bfc
RD		 11489 """
11490 return _core_.ItemContainer_GetStringSelection(*args, **kwargs)
11491
53aa7709 11492 def Select(*args, **kwargs):
d55e5bfc 11493 """
53aa7709 11494 Select(self, int n)
d55e5bfc 11495
53aa7709
RD		 11496 This is the same as `SetSelection` and exists only because it is
11497 slightly more natural for controls which support multiple selection.
d55e5bfc 11498 """
53aa7709 11499 return _core_.ItemContainer_Select(*args, **kwargs)
d55e5bfc 11500
97ab0f6a
RD		 11501 def GetItems(self):
11502 """Return a list of the strings in the control"""
11503 return [self.GetString(i) for i in xrange(self.GetCount())]
11504
11505 def SetItems(self, items):
11506 """Clear and set the strings in the control from a list"""
11507 self.Clear()
11508 for i in items:
11509 self.Append(i)
11510
11511 Count = property(GetCount,doc="See `GetCount`")
11512 Items = property(GetItems,SetItems,doc="See `GetItems` and `SetItems`")
11513 Selection = property(GetSelection,SetSelection,doc="See `GetSelection` and `SetSelection`")
11514 StringSelection = property(GetStringSelection,SetStringSelection,doc="See `GetStringSelection` and `SetStringSelection`")
11515 Strings = property(GetStrings,doc="See `GetStrings`")
2131d850 11516_core_.ItemContainer_swigregister(ItemContainer)
d55e5bfc
RD		 11517
11518#---------------------------------------------------------------------------
11519
11520class ControlWithItems(Control,ItemContainer):
11521 """
79fccf9d
RD		 11522 wx.ControlWithItems combines the ``wx.ItemContainer`` class with the
11523 wx.Control class, and is used for the base class of various controls
11524 that have items.
d55e5bfc 11525 """
554f62e9
RD		 11526 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11527 def __init__(self): raise AttributeError, "No constructor defined"
11528 __repr__ = _swig_repr
2131d850 11529_core_.ControlWithItems_swigregister(ControlWithItems)
d55e5bfc
RD		 11530
11531#---------------------------------------------------------------------------
11532
11533class SizerItem(Object):
248ed943
RD		 11534 """
11535 The wx.SizerItem class is used to track the position, size and other
f460c29d
RD		 11536 attributes of each item managed by a `wx.Sizer`. It is not usually
11537 necessary to use this class because the sizer elements can also be
11538 identified by their positions or window or sizer references but
11539 sometimes it may be more convenient to use wx.SizerItem directly.
11540 Also, custom classes derived from `wx.PySizer` will probably need to
11541 use the collection of wx.SizerItems held by wx.Sizer when calculating
11542 layout.
248ed943
RD		 11543
11544 :see: `wx.Sizer`, `wx.GBSizerItem`
11545 """
554f62e9
RD		 11546 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11547 __repr__ = _swig_repr
11548 def __init__(self, *args, **kwargs):
248ed943
RD		 11549 """
11550 __init__(self) -> SizerItem
11551
11552 Constructs an empty wx.SizerItem. Either a window, sizer or spacer
11553 size will need to be set before this item can be used in a Sizer.
11554
11555 You will probably never need to create a wx.SizerItem directly as they
11556 are created automatically when the sizer's Add, Insert or Prepend
11557 methods are called.
11558
11559 :see: `wx.SizerItemSpacer`, `wx.SizerItemWindow`, `wx.SizerItemSizer`
11560 """
554f62e9
RD		 11561 _core_.SizerItem_swiginit(self,_core_.new_SizerItem(*args, **kwargs))
11562 __swig_destroy__ = _core_.delete_SizerItem
11563 __del__ = lambda self : None;
d55e5bfc 11564 def DeleteWindows(*args, **kwargs):
248ed943
RD		 11565 """
11566 DeleteWindows(self)
11567
11568 Destroy the window or the windows in a subsizer, depending on the type
11569 of item.
11570 """
d55e5bfc
RD		 11571 return _core_.SizerItem_DeleteWindows(*args, **kwargs)
11572
11573 def DetachSizer(*args, **kwargs):
248ed943
RD		 11574 """
11575 DetachSizer(self)
11576
11577 Enable deleting the SizerItem without destroying the contained sizer.
11578 """
d55e5bfc
RD		 11579 return _core_.SizerItem_DetachSizer(*args, **kwargs)
11580
11581 def GetSize(*args, **kwargs):
248ed943
RD		 11582 """
11583 GetSize(self) -> Size
11584
11585 Get the current size of the item, as set in the last Layout.
11586 """
d55e5bfc
RD		 11587 return _core_.SizerItem_GetSize(*args, **kwargs)
11588
11589 def CalcMin(*args, **kwargs):
248ed943
RD		 11590 """
11591 CalcMin(self) -> Size
11592
11593 Calculates the minimum desired size for the item, including any space
11594 needed by borders.
11595 """
d55e5bfc
RD		 11596 return _core_.SizerItem_CalcMin(*args, **kwargs)
11597
11598 def SetDimension(*args, **kwargs):
248ed943
RD		 11599 """
11600 SetDimension(self, Point pos, Size size)
11601
11602 Set the position and size of the space allocated for this item by the
11603 sizer, and adjust the position and size of the item (window or
11604 subsizer) to be within that space taking alignment and borders into
11605 account.
11606 """
d55e5bfc
RD		 11607 return _core_.SizerItem_SetDimension(*args, **kwargs)
11608
11609 def GetMinSize(*args, **kwargs):
248ed943
RD		 11610 """
11611 GetMinSize(self) -> Size
11612
11613 Get the minimum size needed for the item.
11614 """
d55e5bfc
RD		 11615 return _core_.SizerItem_GetMinSize(*args, **kwargs)
11616
a001823c
RD		 11617 def GetMinSizeWithBorder(*args, **kwargs):
11618 """
11619 GetMinSizeWithBorder(self) -> Size
11620
11621 Get the minimum size needed for the item with space for the borders
11622 added, if needed.
11623 """
11624 return _core_.SizerItem_GetMinSizeWithBorder(*args, **kwargs)
11625
d55e5bfc
RD		 11626 def SetInitSize(*args, **kwargs):
11627 """SetInitSize(self, int x, int y)"""
11628 return _core_.SizerItem_SetInitSize(*args, **kwargs)
11629
11630 def SetRatioWH(*args, **kwargs):
248ed943
RD		 11631 """
11632 SetRatioWH(self, int width, int height)
11633
11634 Set the ratio item attribute.
11635 """
d55e5bfc
RD		 11636 return _core_.SizerItem_SetRatioWH(*args, **kwargs)
11637
11638 def SetRatioSize(*args, **kwargs):
248ed943
RD		 11639 """
11640 SetRatioSize(self, Size size)
11641
11642 Set the ratio item attribute.
11643 """
d55e5bfc
RD		 11644 return _core_.SizerItem_SetRatioSize(*args, **kwargs)
11645
11646 def SetRatio(*args, **kwargs):
248ed943
RD		 11647 """
11648 SetRatio(self, float ratio)
11649
11650 Set the ratio item attribute.
11651 """
d55e5bfc
RD		 11652 return _core_.SizerItem_SetRatio(*args, **kwargs)
11653
11654 def GetRatio(*args, **kwargs):
248ed943
RD		 11655 """
11656 GetRatio(self) -> float
11657
11658 Set the ratio item attribute.
11659 """
d55e5bfc
RD		 11660 return _core_.SizerItem_GetRatio(*args, **kwargs)
11661
c1cb24a4
RD		 11662 def GetRect(*args, **kwargs):
11663 """
11664 GetRect(self) -> Rect
11665
11666 Returns the rectangle that the sizer item should occupy
11667 """
11668 return _core_.SizerItem_GetRect(*args, **kwargs)
11669
d55e5bfc 11670 def IsWindow(*args, **kwargs):
248ed943
RD		 11671 """
11672 IsWindow(self) -> bool
11673
11674 Is this sizer item a window?
11675 """
d55e5bfc
RD		 11676 return _core_.SizerItem_IsWindow(*args, **kwargs)
11677
11678 def IsSizer(*args, **kwargs):
248ed943
RD		 11679 """
11680 IsSizer(self) -> bool
11681
11682 Is this sizer item a subsizer?
11683 """
d55e5bfc
RD		 11684 return _core_.SizerItem_IsSizer(*args, **kwargs)
11685
11686 def IsSpacer(*args, **kwargs):
248ed943
RD		 11687 """
11688 IsSpacer(self) -> bool
11689
11690 Is this sizer item a spacer?
11691 """
d55e5bfc
RD		 11692 return _core_.SizerItem_IsSpacer(*args, **kwargs)
11693
11694 def SetProportion(*args, **kwargs):
248ed943
RD		 11695 """
11696 SetProportion(self, int proportion)
11697
11698 Set the proportion value for this item.
11699 """
d55e5bfc
RD		 11700 return _core_.SizerItem_SetProportion(*args, **kwargs)
11701
11702 def GetProportion(*args, **kwargs):
248ed943
RD		 11703 """
11704 GetProportion(self) -> int
11705
11706 Get the proportion value for this item.
11707 """
d55e5bfc
RD		 11708 return _core_.SizerItem_GetProportion(*args, **kwargs)
11709
248ed943
RD		 11710 SetOption = wx._deprecated(SetProportion, "Please use `SetProportion` instead.")
11711 GetOption = wx._deprecated(GetProportion, "Please use `GetProportion` instead.")
d55e5bfc 11712 def SetFlag(*args, **kwargs):
248ed943
RD		 11713 """
11714 SetFlag(self, int flag)
11715
11716 Set the flag value for this item.
11717 """
d55e5bfc
RD		 11718 return _core_.SizerItem_SetFlag(*args, **kwargs)
11719
11720 def GetFlag(*args, **kwargs):
248ed943
RD		 11721 """
11722 GetFlag(self) -> int
11723
11724 Get the flag value for this item.
11725 """
d55e5bfc
RD		 11726 return _core_.SizerItem_GetFlag(*args, **kwargs)
11727
11728 def SetBorder(*args, **kwargs):
248ed943
RD		 11729 """
11730 SetBorder(self, int border)
11731
11732 Set the border value for this item.
11733 """
d55e5bfc
RD		 11734 return _core_.SizerItem_SetBorder(*args, **kwargs)
11735
11736 def GetBorder(*args, **kwargs):
248ed943
RD		 11737 """
11738 GetBorder(self) -> int
11739
11740 Get the border value for this item.
11741 """
d55e5bfc
RD		 11742 return _core_.SizerItem_GetBorder(*args, **kwargs)
11743
11744 def GetWindow(*args, **kwargs):
248ed943
RD		 11745 """
11746 GetWindow(self) -> Window
11747
11748 Get the window (if any) that is managed by this sizer item.
11749 """
d55e5bfc
RD		 11750 return _core_.SizerItem_GetWindow(*args, **kwargs)
11751
11752 def SetWindow(*args, **kwargs):
248ed943
RD		 11753 """
11754 SetWindow(self, Window window)
11755
11756 Set the window to be managed by this sizer item.
11757 """
d55e5bfc
RD		 11758 return _core_.SizerItem_SetWindow(*args, **kwargs)
11759
11760 def GetSizer(*args, **kwargs):
248ed943
RD		 11761 """
11762 GetSizer(self) -> Sizer
11763
11764 Get the subsizer (if any) that is managed by this sizer item.
11765 """
d55e5bfc
RD		 11766 return _core_.SizerItem_GetSizer(*args, **kwargs)
11767
11768 def SetSizer(*args, **kwargs):
248ed943
RD		 11769 """
11770 SetSizer(self, Sizer sizer)
11771
11772 Set the subsizer to be managed by this sizer item.
11773 """
d55e5bfc
RD		 11774 return _core_.SizerItem_SetSizer(*args, **kwargs)
11775
11776 def GetSpacer(*args, **kwargs):
248ed943
RD		 11777 """
11778 GetSpacer(self) -> Size
11779
11780 Get the size of the spacer managed by this sizer item.
11781 """
d55e5bfc
RD		 11782 return _core_.SizerItem_GetSpacer(*args, **kwargs)
11783
11784 def SetSpacer(*args, **kwargs):
248ed943
RD		 11785 """
11786 SetSpacer(self, Size size)
11787
11788 Set the size of the spacer to be managed by this sizer item.
11789 """
d55e5bfc
RD		 11790 return _core_.SizerItem_SetSpacer(*args, **kwargs)
11791
11792 def Show(*args, **kwargs):
248ed943
RD		 11793 """
11794 Show(self, bool show)
11795
11796 Set the show item attribute, which sizers use to determine if the item
11797 is to be made part of the layout or not. If the item is tracking a
11798 window then it is shown or hidden as needed.
11799 """
d55e5bfc
RD		 11800 return _core_.SizerItem_Show(*args, **kwargs)
11801
11802 def IsShown(*args, **kwargs):
248ed943
RD		 11803 """
11804 IsShown(self) -> bool
11805
11806 Is the item to be shown in the layout?
11807 """
d55e5bfc
RD		 11808 return _core_.SizerItem_IsShown(*args, **kwargs)
11809
11810 def GetPosition(*args, **kwargs):
248ed943
RD		 11811 """
11812 GetPosition(self) -> Point
11813
11814 Returns the current position of the item, as set in the last Layout.
11815 """
d55e5bfc
RD		 11816 return _core_.SizerItem_GetPosition(*args, **kwargs)
11817
11818 def GetUserData(*args, **kwargs):
248ed943
RD		 11819 """
11820 GetUserData(self) -> PyObject
11821
11822 Returns the userData associated with this sizer item, or None if there
11823 isn't any.
11824 """
d55e5bfc
RD		 11825 return _core_.SizerItem_GetUserData(*args, **kwargs)
11826
7449af73
RD		 11827 def SetUserData(*args, **kwargs):
11828 """
11829 SetUserData(self, PyObject userData)
11830
11831 Associate a Python object with this sizer item.
11832 """
11833 return _core_.SizerItem_SetUserData(*args, **kwargs)
11834
33d6fd3b
RD		 11835 Border = property(GetBorder,SetBorder,doc="See `GetBorder` and `SetBorder`")
11836 Flag = property(GetFlag,SetFlag,doc="See `GetFlag` and `SetFlag`")
11837 MinSize = property(GetMinSize,doc="See `GetMinSize`")
11838 MinSizeWithBorder = property(GetMinSizeWithBorder,doc="See `GetMinSizeWithBorder`")
11839 Position = property(GetPosition,doc="See `GetPosition`")
11840 Proportion = property(GetProportion,SetProportion,doc="See `GetProportion` and `SetProportion`")
11841 Ratio = property(GetRatio,SetRatio,doc="See `GetRatio` and `SetRatio`")
11842 Rect = property(GetRect,doc="See `GetRect`")
11843 Size = property(GetSize,doc="See `GetSize`")
11844 Sizer = property(GetSizer,SetSizer,doc="See `GetSizer` and `SetSizer`")
11845 Spacer = property(GetSpacer,SetSpacer,doc="See `GetSpacer` and `SetSpacer`")
11846 UserData = property(GetUserData,SetUserData,doc="See `GetUserData` and `SetUserData`")
11847 Window = property(GetWindow,SetWindow,doc="See `GetWindow` and `SetWindow`")
2131d850 11848_core_.SizerItem_swigregister(SizerItem)
d55e5bfc 11849
248ed943 11850def SizerItemWindow(*args, **kwargs):
d55e5bfc 11851 """
248ed943
RD		 11852 SizerItemWindow(Window window, int proportion, int flag, int border,
11853 PyObject userData=None) -> SizerItem
11854
11855 Constructs a `wx.SizerItem` for tracking a window.
d55e5bfc 11856 """
248ed943 11857 val = _core_.new_SizerItemWindow(*args, **kwargs)
d55e5bfc
RD		 11858 return val
11859
248ed943 11860def SizerItemSpacer(*args, **kwargs):
d55e5bfc 11861 """
248ed943
RD		 11862 SizerItemSpacer(int width, int height, int proportion, int flag, int border,
11863 PyObject userData=None) -> SizerItem
11864
11865 Constructs a `wx.SizerItem` for tracking a spacer.
d55e5bfc 11866 """
248ed943 11867 val = _core_.new_SizerItemSpacer(*args, **kwargs)
d55e5bfc
RD		 11868 return val
11869
11870def SizerItemSizer(*args, **kwargs):
11871 """
11872 SizerItemSizer(Sizer sizer, int proportion, int flag, int border,
248ed943
RD		 11873 PyObject userData=None) -> SizerItem
11874
11875 Constructs a `wx.SizerItem` for tracking a subsizer
d55e5bfc
RD		 11876 """
11877 val = _core_.new_SizerItemSizer(*args, **kwargs)
d55e5bfc
RD		 11878 return val
11879
11880class Sizer(Object):
248ed943
RD		 11881 """
11882 wx.Sizer is the abstract base class used for laying out subwindows in
11883 a window. You cannot use wx.Sizer directly; instead, you will have to
11884 use one of the sizer classes derived from it such as `wx.BoxSizer`,
1d5ee749
RD		 11885 `wx.StaticBoxSizer`, `wx.GridSizer`, `wx.FlexGridSizer` and
11886 `wx.GridBagSizer`.
248ed943
RD		 11887
11888 The concept implemented by sizers in wxWidgets is closely related to
11889 layout tools in other GUI toolkits, such as Java's AWT, the GTK
11890 toolkit or the Qt toolkit. It is based upon the idea of the individual
11891 subwindows reporting their minimal required size and their ability to
11892 get stretched if the size of the parent window has changed. This will
11893 most often mean that the programmer does not set the original size of
11894 a dialog in the beginning, rather the dialog will assigned a sizer and
11895 this sizer will be queried about the recommended size. The sizer in
11896 turn will query its children, which can be normal windows or contorls,
11897 empty space or other sizers, so that a hierarchy of sizers can be
11898 constructed. Note that wxSizer does not derive from wxWindow and thus
11899 do not interfere with tab ordering and requires very little resources
11900 compared to a real window on screen.
11901
11902 What makes sizers so well fitted for use in wxWidgets is the fact that
11903 every control reports its own minimal size and the algorithm can
11904 handle differences in font sizes or different window (dialog item)
11905 sizes on different platforms without problems. If for example the
11906 standard font as well as the overall design of Mac widgets requires
11907 more space than on Windows, then the initial size of a dialog using a
11908 sizer will automatically be bigger on Mac than on Windows.
11909 """
554f62e9
RD		 11910 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11911 def __init__(self): raise AttributeError, "No constructor defined"
11912 __repr__ = _swig_repr
11913 __swig_destroy__ = _core_.delete_Sizer
11914 __del__ = lambda self : None;
d55e5bfc
RD		 11915 def _setOORInfo(*args, **kwargs):
11916 """_setOORInfo(self, PyObject _self)"""
11917 return _core_.Sizer__setOORInfo(*args, **kwargs)
11918
11919 def Add(*args, **kwargs):
11920 """
248ed943 11921 Add(self, item, int proportion=0, int flag=0, int border=0,
c1cb24a4 11922 PyObject userData=None) -> wx.SizerItem
248ed943
RD		 11923
11924 Appends a child item to the sizer.
d55e5bfc
RD		 11925 """
11926 return _core_.Sizer_Add(*args, **kwargs)
11927
11928 def Insert(*args, **kwargs):
11929 """
248ed943 11930 Insert(self, int before, item, int proportion=0, int flag=0, int border=0,
c1cb24a4 11931 PyObject userData=None) -> wx.SizerItem
248ed943
RD		 11932
11933 Inserts a new item into the list of items managed by this sizer before
11934 the item at index *before*. See `Add` for a description of the parameters.
d55e5bfc
RD		 11935 """
11936 return _core_.Sizer_Insert(*args, **kwargs)
11937
11938 def Prepend(*args, **kwargs):
11939 """
248ed943 11940 Prepend(self, item, int proportion=0, int flag=0, int border=0,
c1cb24a4 11941 PyObject userData=None) -> wx.SizerItem
248ed943
RD		 11942
11943 Adds a new item to the begining of the list of sizer items managed by
11944 this sizer. See `Add` for a description of the parameters.
d55e5bfc
RD		 11945 """
11946 return _core_.Sizer_Prepend(*args, **kwargs)
11947
11948 def Remove(*args, **kwargs):
248ed943
RD		 11949 """
11950 Remove(self, item) -> bool
11951
11952 Removes an item from the sizer and destroys it. This method does not
11953 cause any layout or resizing to take place, call `Layout` to update
11954 the layout on screen after removing a child from the sizer. The
11955 *item* parameter can be either a window, a sizer, or the zero-based
11956 index of an item to remove. Returns True if the child item was found
11957 and removed.
11958 """
d55e5bfc
RD		 11959 return _core_.Sizer_Remove(*args, **kwargs)
11960
1a6bba1e 11961 def Detach(*args, **kwargs):
248ed943
RD		 11962 """
11963 Detach(self, item) -> bool
11964
11965 Detaches an item from the sizer without destroying it. This method
11966 does not cause any layout or resizing to take place, call `Layout` to
11967 do so. The *item* parameter can be either a window, a sizer, or the
11968 zero-based index of the item to be detached. Returns True if the child item
11969 was found and detached.
11970 """
1a6bba1e
RD		 11971 return _core_.Sizer_Detach(*args, **kwargs)
11972
c1cb24a4
RD		 11973 def GetItem(*args, **kwargs):
11974 """
11975 GetItem(self, item) -> wx.SizerItem
11976
11977 Returns the `wx.SizerItem` which holds the *item* given. The *item*
11978 parameter can be either a window, a sizer, or the zero-based index of
4d170c95 11979 the item to be found.
c1cb24a4
RD		 11980 """
11981 return _core_.Sizer_GetItem(*args, **kwargs)
11982
d55e5bfc
RD		 11983 def _SetItemMinSize(*args, **kwargs):
11984 """_SetItemMinSize(self, PyObject item, Size size)"""
11985 return _core_.Sizer__SetItemMinSize(*args, **kwargs)
11986
97ab0f6a
RD		 11987 def _ReplaceWin(*args, **kwargs):
11988 """_ReplaceWin(self, Window oldwin, Window newwin, bool recursive=False) -> bool"""
11989 return _core_.Sizer__ReplaceWin(*args, **kwargs)
11990
11991 def _ReplaceSizer(*args, **kwargs):
11992 """_ReplaceSizer(self, Sizer oldsz, Sizer newsz, bool recursive=False) -> bool"""
11993 return _core_.Sizer__ReplaceSizer(*args, **kwargs)
11994
11995 def _ReplaceItem(*args, **kwargs):
11996 """_ReplaceItem(self, size_t index, SizerItem newitem) -> bool"""
11997 return _core_.Sizer__ReplaceItem(*args, **kwargs)
11998
11999 def Replace(self, olditem, item, recursive=False):
12000 """
12001 Detaches the given ``olditem`` from the sizer and replaces it with
12002 ``item`` which can be a window, sizer, or `wx.SizerItem`. The
12003 detached child is destroyed only if it is not a window, (because
12004 windows are owned by their parent, not the sizer.) The
12005 ``recursive`` parameter can be used to search for the given
12006 element recursivly in subsizers.
12007
12008 This method does not cause any layout or resizing to take place,
12009 call `Layout` to do so.
12010
12011 Returns ``True`` if the child item was found and removed.
12012 """
12013 if isinstance(olditem, wx.Window):
12014 return self._ReplaceWin(olditem, item, recursive)
12015 elif isinstnace(olditem, wx.Sizer):
12016 return self._ReplaceSizer(olditem, item, recursive)
12017 elif isinstnace(olditem, int):
12018 return self._ReplaceItem(olditem, item)
12019 else:
12020 raise TypeError("Expected Window, Sizer, or integer for first parameter.")
12021
12022 def SetContainingWindow(*args, **kwargs):
12023 """
12024 SetContainingWindow(self, Window window)
12025
12026 Set (or unset) the window this sizer is used in.
12027 """
12028 return _core_.Sizer_SetContainingWindow(*args, **kwargs)
12029
12030 def GetContainingWindow(*args, **kwargs):
12031 """
12032 GetContainingWindow(self) -> Window
12033
12034 Get the window this sizer is used in.
12035 """
12036 return _core_.Sizer_GetContainingWindow(*args, **kwargs)
12037
248ed943
RD		 12038 def SetItemMinSize(self, item, *args):
12039 """
12040 SetItemMinSize(self, item, Size size)
12041
12042 Sets the minimum size that will be allocated for an item in the sizer.
12043 The *item* parameter can be either a window, a sizer, or the
12044 zero-based index of the item. If a window or sizer is given then it
12045 will be searched for recursivly in subsizers if neccessary.
12046 """
12047 if len(args) == 2:
12048 # for backward compatibility accept separate width,height args too
12049 return self._SetItemMinSize(item, args)
12050 else:
12051 return self._SetItemMinSize(item, args[0])
12052
d55e5bfc 12053 def AddItem(*args, **kwargs):
248ed943
RD		 12054 """
12055 AddItem(self, SizerItem item)
12056
12057 Adds a `wx.SizerItem` to the sizer.
12058 """
d55e5bfc
RD		 12059 return _core_.Sizer_AddItem(*args, **kwargs)
12060
12061 def InsertItem(*args, **kwargs):
248ed943
RD		 12062 """
12063 InsertItem(self, int index, SizerItem item)
12064
12065 Inserts a `wx.SizerItem` to the sizer at the position given by *index*.
12066 """
d55e5bfc
RD		 12067 return _core_.Sizer_InsertItem(*args, **kwargs)
12068
12069 def PrependItem(*args, **kwargs):
248ed943
RD		 12070 """
12071 PrependItem(self, SizerItem item)
12072
12073 Prepends a `wx.SizerItem` to the sizer.
12074 """
d55e5bfc
RD		 12075 return _core_.Sizer_PrependItem(*args, **kwargs)
12076
248ed943 12077 def AddMany(self, items):
c24da6d6
RD		 12078 """
12079 AddMany is a convenience method for adding several items
12080 to a sizer at one time. Simply pass it a list of tuples,
12081 where each tuple consists of the parameters that you
12082 would normally pass to the `Add` method.
12083 """
248ed943
RD		 12084 for item in items:
12085 if type(item) != type(()) or (len(item) == 2 and type(item[0]) == type(1)):
12086 item = (item, )
12087 self.Add(*item)
d55e5bfc 12088
0d2c9713
RD		 12089 def AddSpacer(self, *args, **kw):
12090 """AddSpacer(int size) --> SizerItem
12091
12092 Add a spacer that is (size,size) pixels.
12093 """
12094 if args and type(args[0]) == int:
12095 return self.Add( (args[0],args[0] ), 0)
12096 else: # otherwise stay compatible with old AddSpacer
12097 return self.Add(*args, **kw)
12098 def PrependSpacer(self, *args, **kw):
12099 """PrependSpacer(int size) --> SizerItem
12100
12101 Prepend a spacer that is (size, size) pixels."""
12102 if args and type(args[0]) == int:
12103 return self.Prepend( (args[0],args[0] ), 0)
12104 else: # otherwise stay compatible with old PrependSpacer
12105 return self.Prepend(*args, **kw)
12106 def InsertSpacer(self, index, *args, **kw):
12107 """InsertSpacer(int index, int size) --> SizerItem
12108
12109 Insert a spacer at position index that is (size, size) pixels."""
12110 if args and type(args[0]) == int:
12111 return self.Insert( index, (args[0],args[0] ), 0)
12112 else: # otherwise stay compatible with old InsertSpacer
12113 return self.Insert(index, *args, **kw)
12114
12115
12116 def AddStretchSpacer(self, prop=1):
12117 """AddStretchSpacer(int prop=1) --> SizerItem
12118
12119 Add a stretchable spacer."""
12120 return self.Add((0,0), prop)
12121 def PrependStretchSpacer(self, prop=1):
12122 """PrependStretchSpacer(int prop=1) --> SizerItem
12123
12124 Prepend a stretchable spacer."""
12125 return self.Prepend((0,0), prop)
12126 def InsertStretchSpacer(self, index, prop=1):
12127 """InsertStretchSpacer(int index, int prop=1) --> SizerItem
12128
12129 Insert a stretchable spacer."""
12130 return self.Insert(index, (0,0), prop)
12131
12132
d55e5bfc 12133 # for backwards compatibility only, please do not use in new code
b9d6a5f3
RD		 12134 def AddWindow(self, *args, **kw):
12135 """Compatibility alias for `Add`."""
12136 return self.Add(*args, **kw)
12137 def AddSizer(self, *args, **kw):
12138 """Compatibility alias for `Add`."""
12139 return self.Add(*args, **kw)
b9d6a5f3
RD		 12140
12141 def PrependWindow(self, *args, **kw):
12142 """Compatibility alias for `Prepend`."""
12143 return self.Prepend(*args, **kw)
12144 def PrependSizer(self, *args, **kw):
12145 """Compatibility alias for `Prepend`."""
12146 return self.Prepend(*args, **kw)
b9d6a5f3
RD		 12147
12148 def InsertWindow(self, *args, **kw):
12149 """Compatibility alias for `Insert`."""
12150 return self.Insert(*args, **kw)
12151 def InsertSizer(self, *args, **kw):
12152 """Compatibility alias for `Insert`."""
b9d6a5f3
RD		 12153 return self.Insert(*args, **kw)
12154
12155 def RemoveWindow(self, *args, **kw):
12156 """Compatibility alias for `Remove`."""
12157 return self.Remove(*args, **kw)
12158 def RemoveSizer(self, *args, **kw):
12159 """Compatibility alias for `Remove`."""
12160 return self.Remove(*args, **kw)
12161 def RemovePos(self, *args, **kw):
12162 """Compatibility alias for `Remove`."""
12163 return self.Remove(*args, **kw)
d55e5bfc
RD		 12164
12165
d55e5bfc 12166 def SetDimension(*args, **kwargs):
248ed943
RD		 12167 """
12168 SetDimension(self, int x, int y, int width, int height)
12169
12170 Call this to force the sizer to take the given dimension and thus
12171 force the items owned by the sizer to resize themselves according to
12172 the rules defined by the parameter in the `Add`, `Insert` or `Prepend`
12173 methods.
12174 """
d55e5bfc
RD		 12175 return _core_.Sizer_SetDimension(*args, **kwargs)
12176
12177 def SetMinSize(*args, **kwargs):
248ed943
RD		 12178 """
12179 SetMinSize(self, Size size)
12180
12181 Call this to give the sizer a minimal size. Normally, the sizer will
12182 calculate its minimal size based purely on how much space its children
12183 need. After calling this method `GetMinSize` will return either the
12184 minimal size as requested by its children or the minimal size set
12185 here, depending on which is bigger.
12186 """
d55e5bfc
RD		 12187 return _core_.Sizer_SetMinSize(*args, **kwargs)
12188
12189 def GetSize(*args, **kwargs):
248ed943
RD		 12190 """
12191 GetSize(self) -> Size
12192
12193 Returns the current size of the space managed by the sizer.
12194 """
d55e5bfc
RD		 12195 return _core_.Sizer_GetSize(*args, **kwargs)
12196
12197 def GetPosition(*args, **kwargs):
248ed943
RD		 12198 """
12199 GetPosition(self) -> Point
12200
12201 Returns the current position of the sizer's managed space.
12202 """
d55e5bfc
RD		 12203 return _core_.Sizer_GetPosition(*args, **kwargs)
12204
12205 def GetMinSize(*args, **kwargs):
248ed943
RD		 12206 """
12207 GetMinSize(self) -> Size
12208
12209 Returns the minimal size of the sizer. This is either the combined
12210 minimal size of all the children and their borders or the minimal size
12211 set by SetMinSize, depending on which is bigger.
12212 """
d55e5bfc
RD		 12213 return _core_.Sizer_GetMinSize(*args, **kwargs)
12214
12215 def GetSizeTuple(self):
1a6bba1e 12216 return self.GetSize().Get()
d55e5bfc 12217 def GetPositionTuple(self):
1a6bba1e 12218 return self.GetPosition().Get()
d55e5bfc 12219 def GetMinSizeTuple(self):
1a6bba1e 12220 return self.GetMinSize().Get()
d55e5bfc
RD		 12221
12222 def RecalcSizes(*args, **kwargs):
248ed943
RD		 12223 """
12224 RecalcSizes(self)
12225
12226 Using the sizes calculated by `CalcMin` reposition and resize all the
12227 items managed by this sizer. You should not need to call this directly as
12228 it is called by `Layout`.
12229 """
d55e5bfc
RD		 12230 return _core_.Sizer_RecalcSizes(*args, **kwargs)
12231
12232 def CalcMin(*args, **kwargs):
248ed943
RD		 12233 """
12234 CalcMin(self) -> Size
12235
12236 This method is where the sizer will do the actual calculation of its
12237 children's minimal sizes. You should not need to call this directly as
12238 it is called by `Layout`.
12239 """
d55e5bfc
RD		 12240 return _core_.Sizer_CalcMin(*args, **kwargs)
12241
12242 def Layout(*args, **kwargs):
248ed943
RD		 12243 """
12244 Layout(self)
12245
12246 This method will force the recalculation and layout of the items
12247 controlled by the sizer using the current space allocated to the
12248 sizer. Normally this is called automatically from the owning window's
12249 EVT_SIZE handler, but it is also useful to call it from user code when
12250 one of the items in a sizer change size, or items are added or
12251 removed.
12252 """
d55e5bfc
RD		 12253 return _core_.Sizer_Layout(*args, **kwargs)
12254
12255 def Fit(*args, **kwargs):
248ed943
RD		 12256 """
12257 Fit(self, Window window) -> Size
12258
12259 Tell the sizer to resize the *window* to match the sizer's minimal
12260 size. This is commonly done in the constructor of the window itself in
12261 order to set its initial size to match the needs of the children as
12262 determined by the sizer. Returns the new size.
12263
12264 For a top level window this is the total window size, not the client size.
12265 """
d55e5bfc
RD		 12266 return _core_.Sizer_Fit(*args, **kwargs)
12267
12268 def FitInside(*args, **kwargs):
248ed943
RD		 12269 """
12270 FitInside(self, Window window)
12271
12272 Tell the sizer to resize the *virtual size* of the *window* to match the
12273 sizer's minimal size. This will not alter the on screen size of the
12274 window, but may cause the addition/removal/alteration of scrollbars
12275 required to view the virtual area in windows which manage it.
12276
12277 :see: `wx.ScrolledWindow.SetScrollbars`, `SetVirtualSizeHints`
12278
12279 """
d55e5bfc
RD		 12280 return _core_.Sizer_FitInside(*args, **kwargs)
12281
12282 def SetSizeHints(*args, **kwargs):
248ed943
RD		 12283 """
12284 SetSizeHints(self, Window window)
12285
12286 Tell the sizer to set (and `Fit`) the minimal size of the *window* to
12287 match the sizer's minimal size. This is commonly done in the
12288 constructor of the window itself if the window is resizable (as are
12289 many dialogs under Unix and frames on probably all platforms) in order
12290 to prevent the window from being sized smaller than the minimal size
12291 required by the sizer.
12292 """
d55e5bfc
RD		 12293 return _core_.Sizer_SetSizeHints(*args, **kwargs)
12294
12295 def SetVirtualSizeHints(*args, **kwargs):
248ed943
RD		 12296 """
12297 SetVirtualSizeHints(self, Window window)
12298
12299 Tell the sizer to set the minimal size of the window virtual area to
12300 match the sizer's minimal size. For windows with managed scrollbars
12301 this will set them appropriately.
12302
12303 :see: `wx.ScrolledWindow.SetScrollbars`
12304
12305 """
d55e5bfc
RD		 12306 return _core_.Sizer_SetVirtualSizeHints(*args, **kwargs)
12307
12308 def Clear(*args, **kwargs):
248ed943
RD		 12309 """
12310 Clear(self, bool deleteWindows=False)
12311
12312 Clear all items from the sizer, optionally destroying the window items
12313 as well.
12314 """
d55e5bfc
RD		 12315 return _core_.Sizer_Clear(*args, **kwargs)
12316
12317 def DeleteWindows(*args, **kwargs):
248ed943
RD		 12318 """
12319 DeleteWindows(self)
12320
12321 Destroy all windows managed by the sizer.
12322 """
d55e5bfc
RD		 12323 return _core_.Sizer_DeleteWindows(*args, **kwargs)
12324
12325 def GetChildren(*args, **kwargs):
248ed943 12326 """
51b83b37 12327 GetChildren(self) -> list
248ed943
RD		 12328
12329 Returns a list of all the `wx.SizerItem` objects managed by the sizer.
12330 """
d55e5bfc
RD		 12331 return _core_.Sizer_GetChildren(*args, **kwargs)
12332
12333 def Show(*args, **kwargs):
248ed943 12334 """
ae8162c8 12335 Show(self, item, bool show=True, bool recursive=false) -> bool
d55e5bfc 12336
248ed943
RD		 12337 Shows or hides an item managed by the sizer. To make a sizer item
12338 disappear or reappear, use Show followed by `Layout`. The *item*
12339 parameter can be either a window, a sizer, or the zero-based index of
629e65c2
RD		 12340 the item. Use the recursive parameter to show or hide an item in a
12341 subsizer. Returns True if the item was found.
248ed943
RD		 12342 """
12343 return _core_.Sizer_Show(*args, **kwargs)
d55e5bfc
RD		 12344
12345 def IsShown(*args, **kwargs):
248ed943
RD		 12346 """
12347 IsShown(self, item)
12348
b1fcee84 12349 Determines if the item is currently shown. To make a sizer
248ed943
RD		 12350 item disappear or reappear, use Show followed by `Layout`. The *item*
12351 parameter can be either a window, a sizer, or the zero-based index of
12352 the item.
12353 """
d55e5bfc
RD		 12354 return _core_.Sizer_IsShown(*args, **kwargs)
12355
629e65c2 12356 def Hide(self, item, recursive=False):
248ed943 12357 """
27fb7603 12358 A convenience method for `Show` (item, False, recursive).
248ed943 12359 """
06759a38 12360 return self.Show(item, False, recursive)
248ed943 12361
d55e5bfc 12362 def ShowItems(*args, **kwargs):
248ed943
RD		 12363 """
12364 ShowItems(self, bool show)
12365
84f85550 12366 Recursively call `wx.SizerItem.Show` on all sizer items.
248ed943 12367 """
d55e5bfc
RD		 12368 return _core_.Sizer_ShowItems(*args, **kwargs)
12369
33d6fd3b
RD		 12370 Children = property(GetChildren,doc="See `GetChildren`")
12371 ContainingWindow = property(GetContainingWindow,SetContainingWindow,doc="See `GetContainingWindow` and `SetContainingWindow`")
12372 MinSize = property(GetMinSize,SetMinSize,doc="See `GetMinSize` and `SetMinSize`")
12373 Position = property(GetPosition,doc="See `GetPosition`")
12374 Size = property(GetSize,doc="See `GetSize`")
2131d850 12375_core_.Sizer_swigregister(Sizer)
d55e5bfc
RD		 12376
12377class PySizer(Sizer):
248ed943
RD		 12378 """
12379 wx.PySizer is a special version of `wx.Sizer` that has been
12380 instrumented to allow the C++ virtual methods to be overloaded in
12381 Python derived classes. You would derive from this class if you are
12382 wanting to implement a custom sizer in Python code. Simply implement
12383 `CalcMin` and `RecalcSizes` in the derived class and you're all set.
12384 For example::
12385
12386 class MySizer(wx.PySizer):
12387 def __init__(self):
12388 wx.PySizer.__init__(self)
12389
12390 def CalcMin(self):
12391 for item in self.GetChildren():
12392 # calculate the total minimum width and height needed
12393 # by all items in the sizer according to this sizer's
12394 # layout algorithm.
12395 ...
12396 return wx.Size(width, height)
12397
12398 def RecalcSizes(self):
12399 # find the space allotted to this sizer
12400 pos = self.GetPosition()
12401 size = self.GetSize()
12402 for item in self.GetChildren():
12403 # Recalculate (if necessary) the position and size of
12404 # each item and then call item.SetDimension to do the
12405 # actual positioning and sizing of the items within the
12406 # space alloted to this sizer.
12407 ...
12408 item.SetDimension(itemPos, itemSize)
12409
12410
12411 When `Layout` is called it first calls `CalcMin` followed by
12412 `RecalcSizes` so you can optimize a bit by saving the results of
62d32a5f 12413 `CalcMin` and reusing them in `RecalcSizes`.
248ed943
RD		 12414
12415 :see: `wx.SizerItem`, `wx.Sizer.GetChildren`
12416
12417
12418 """
554f62e9
RD		 12419 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12420 __repr__ = _swig_repr
12421 def __init__(self, *args, **kwargs):
248ed943
RD		 12422 """
12423 __init__(self) -> PySizer
12424
12425 Creates a wx.PySizer. Must be called from the __init__ in the derived
12426 class.
12427 """
554f62e9 12428 _core_.PySizer_swiginit(self,_core_.new_PySizer(*args, **kwargs))
d55e5bfc
RD		 12429 self._setCallbackInfo(self, PySizer);self._setOORInfo(self)
12430
12431 def _setCallbackInfo(*args, **kwargs):
12432 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
12433 return _core_.PySizer__setCallbackInfo(*args, **kwargs)
12434
2131d850 12435_core_.PySizer_swigregister(PySizer)
d55e5bfc
RD		 12436
12437#---------------------------------------------------------------------------
12438
12439class BoxSizer(Sizer):
248ed943
RD		 12440 """
12441 The basic idea behind a box sizer is that windows will most often be
12442 laid out in rather simple basic geometry, typically in a row or a
12443 column or nested hierarchies of either. A wx.BoxSizer will lay out
12444 its items in a simple row or column, depending on the orientation
12445 parameter passed to the constructor.
12446 """
554f62e9
RD		 12447 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12448 __repr__ = _swig_repr
12449 def __init__(self, *args, **kwargs):
248ed943
RD		 12450 """
12451 __init__(self, int orient=HORIZONTAL) -> BoxSizer
12452
12453 Constructor for a wx.BoxSizer. *orient* may be one of ``wx.VERTICAL``
12454 or ``wx.HORIZONTAL`` for creating either a column sizer or a row
12455 sizer.
12456 """
554f62e9 12457 _core_.BoxSizer_swiginit(self,_core_.new_BoxSizer(*args, **kwargs))
d55e5bfc
RD		 12458 self._setOORInfo(self)
12459
12460 def GetOrientation(*args, **kwargs):
248ed943
RD		 12461 """
12462 GetOrientation(self) -> int
12463
12464 Returns the current orientation of the sizer.
12465 """
d55e5bfc
RD		 12466 return _core_.BoxSizer_GetOrientation(*args, **kwargs)
12467
12468 def SetOrientation(*args, **kwargs):
248ed943
RD		 12469 """
12470 SetOrientation(self, int orient)
d55e5bfc 12471
248ed943
RD		 12472 Resets the orientation of the sizer.
12473 """
12474 return _core_.BoxSizer_SetOrientation(*args, **kwargs)
d55e5bfc 12475
226118fc 12476 Orientation = property(GetOrientation,SetOrientation,doc="See `GetOrientation` and `SetOrientation`")
2131d850 12477_core_.BoxSizer_swigregister(BoxSizer)
d55e5bfc
RD		 12478
12479#---------------------------------------------------------------------------
12480
12481class StaticBoxSizer(BoxSizer):
248ed943
RD		 12482 """
12483 wx.StaticBoxSizer derives from and functions identically to the
12484 `wx.BoxSizer` and adds a `wx.StaticBox` around the items that the sizer
12485 manages. Note that this static box must be created separately and
12486 passed to the sizer constructor.
12487 """
554f62e9
RD		 12488 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12489 __repr__ = _swig_repr
12490 def __init__(self, *args, **kwargs):
248ed943
RD		 12491 """
12492 __init__(self, StaticBox box, int orient=HORIZONTAL) -> StaticBoxSizer
12493
12494 Constructor. It takes an associated static box and the orientation
12495 *orient* as parameters - orient can be either of ``wx.VERTICAL`` or
12496 ``wx.HORIZONTAL``.
12497 """
554f62e9 12498 _core_.StaticBoxSizer_swiginit(self,_core_.new_StaticBoxSizer(*args, **kwargs))
d55e5bfc
RD		 12499 self._setOORInfo(self)
12500
12501 def GetStaticBox(*args, **kwargs):
248ed943
RD		 12502 """
12503 GetStaticBox(self) -> StaticBox
d55e5bfc 12504
248ed943
RD		 12505 Returns the static box associated with this sizer.
12506 """
12507 return _core_.StaticBoxSizer_GetStaticBox(*args, **kwargs)
d55e5bfc 12508
33d6fd3b 12509 StaticBox = property(GetStaticBox,doc="See `GetStaticBox`")
2131d850 12510_core_.StaticBoxSizer_swigregister(StaticBoxSizer)
d55e5bfc
RD		 12511
12512#---------------------------------------------------------------------------
12513
12514class GridSizer(Sizer):
248ed943
RD		 12515 """
12516 A grid sizer is a sizer which lays out its children in a
12517 two-dimensional table with all cells having the same size. In other
12518 words, the width of each cell within the grid is the width of the
12519 widest item added to the sizer and the height of each grid cell is the
12520 height of the tallest item. An optional vertical and/or horizontal
12521 gap between items can also be specified (in pixels.)
12522
12523 Items are placed in the cells of the grid in the order they are added,
12524 in row-major order. In other words, the first row is filled first,
12525 then the second, and so on until all items have been added. (If
12526 neccessary, additional rows will be added as items are added.) If you
12527 need to have greater control over the cells that items are placed in
12528 then use the `wx.GridBagSizer`.
12529
12530 """
554f62e9
RD		 12531 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12532 __repr__ = _swig_repr
12533 def __init__(self, *args, **kwargs):
248ed943
RD		 12534 """
12535 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> GridSizer
12536
12537 Constructor for a wx.GridSizer. *rows* and *cols* determine the number
12538 of columns and rows in the sizer - if either of the parameters is
12539 zero, it will be calculated to from the total number of children in
12540 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
12541 define extra space between all children.
12542 """
554f62e9 12543 _core_.GridSizer_swiginit(self,_core_.new_GridSizer(*args, **kwargs))
d55e5bfc
RD		 12544 self._setOORInfo(self)
12545
d55e5bfc 12546 def SetCols(*args, **kwargs):
248ed943
RD		 12547 """
12548 SetCols(self, int cols)
12549
12550 Sets the number of columns in the sizer.
12551 """
d55e5bfc
RD		 12552 return _core_.GridSizer_SetCols(*args, **kwargs)
12553
12554 def SetRows(*args, **kwargs):
248ed943
RD		 12555 """
12556 SetRows(self, int rows)
12557
12558 Sets the number of rows in the sizer.
12559 """
d55e5bfc
RD		 12560 return _core_.GridSizer_SetRows(*args, **kwargs)
12561
12562 def SetVGap(*args, **kwargs):
248ed943
RD		 12563 """
12564 SetVGap(self, int gap)
12565
12566 Sets the vertical gap (in pixels) between the cells in the sizer.
12567 """
d55e5bfc
RD		 12568 return _core_.GridSizer_SetVGap(*args, **kwargs)
12569
12570 def SetHGap(*args, **kwargs):
248ed943
RD		 12571 """
12572 SetHGap(self, int gap)
12573
12574 Sets the horizontal gap (in pixels) between cells in the sizer
12575 """
d55e5bfc
RD		 12576 return _core_.GridSizer_SetHGap(*args, **kwargs)
12577
12578 def GetCols(*args, **kwargs):
248ed943
RD		 12579 """
12580 GetCols(self) -> int
12581
12582 Returns the number of columns in the sizer.
12583 """
d55e5bfc
RD		 12584 return _core_.GridSizer_GetCols(*args, **kwargs)
12585
12586 def GetRows(*args, **kwargs):
248ed943
RD		 12587 """
12588 GetRows(self) -> int
12589
12590 Returns the number of rows in the sizer.
12591 """
d55e5bfc
RD		 12592 return _core_.GridSizer_GetRows(*args, **kwargs)
12593
12594 def GetVGap(*args, **kwargs):
248ed943
RD		 12595 """
12596 GetVGap(self) -> int
12597
12598 Returns the vertical gap (in pixels) between the cells in the sizer.
12599 """
d55e5bfc
RD		 12600 return _core_.GridSizer_GetVGap(*args, **kwargs)
12601
12602 def GetHGap(*args, **kwargs):
248ed943
RD		 12603 """
12604 GetHGap(self) -> int
12605
12606 Returns the horizontal gap (in pixels) between cells in the sizer.
12607 """
d55e5bfc
RD		 12608 return _core_.GridSizer_GetHGap(*args, **kwargs)
12609
554f62e9
RD		 12610 def CalcRowsCols(self):
12611 """
12612 CalcRowsCols() -> (rows, cols)
d55e5bfc 12613
554f62e9
RD		 12614 Calculates how many rows and columns will be in the sizer based
12615 on the current number of items and also the rows, cols specified
12616 in the constructor.
12617 """
12618 nitems = len(self.GetChildren())
12619 rows = self.GetRows()
12620 cols = self.GetCols()
12621 assert rows != 0 or cols != 0, "Grid sizer must have either rows or columns fixed"
12622 if cols != 0:
12623 rows = (nitems + cols - 1) / cols
12624 elif rows != 0:
12625 cols = (nitems + rows - 1) / rows
12626 return (rows, cols)
12627
97ab0f6a
RD		 12628 Cols = property(GetCols,SetCols,doc="See `GetCols` and `SetCols`")
12629 HGap = property(GetHGap,SetHGap,doc="See `GetHGap` and `SetHGap`")
12630 Rows = property(GetRows,SetRows,doc="See `GetRows` and `SetRows`")
12631 VGap = property(GetVGap,SetVGap,doc="See `GetVGap` and `SetVGap`")
2131d850 12632_core_.GridSizer_swigregister(GridSizer)
d55e5bfc
RD		 12633
12634#---------------------------------------------------------------------------
12635
12636FLEX_GROWMODE_NONE = _core_.FLEX_GROWMODE_NONE
12637FLEX_GROWMODE_SPECIFIED = _core_.FLEX_GROWMODE_SPECIFIED
12638FLEX_GROWMODE_ALL = _core_.FLEX_GROWMODE_ALL
12639class FlexGridSizer(GridSizer):
248ed943
RD		 12640 """
12641 A flex grid sizer is a sizer which lays out its children in a
12642 two-dimensional table with all table cells in one row having the same
12643 height and all cells in one column having the same width, but all
12644 rows or all columns are not necessarily the same height or width as in
12645 the `wx.GridSizer`.
12646
12647 wx.FlexGridSizer can also size items equally in one direction but
12648 unequally ("flexibly") in the other. If the sizer is only flexible
12649 in one direction (this can be changed using `SetFlexibleDirection`), it
12650 needs to be decided how the sizer should grow in the other ("non
12651 flexible") direction in order to fill the available space. The
12652 `SetNonFlexibleGrowMode` method serves this purpose.
12653
12654
12655 """
554f62e9
RD		 12656 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12657 __repr__ = _swig_repr
12658 def __init__(self, *args, **kwargs):
248ed943
RD		 12659 """
12660 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> FlexGridSizer
12661
12662 Constructor for a wx.FlexGridSizer. *rows* and *cols* determine the
12663 number of columns and rows in the sizer - if either of the parameters
12664 is zero, it will be calculated to from the total number of children in
12665 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
12666 define extra space between all children.
12667 """
554f62e9 12668 _core_.FlexGridSizer_swiginit(self,_core_.new_FlexGridSizer(*args, **kwargs))
d55e5bfc
RD		 12669 self._setOORInfo(self)
12670
248ed943
RD		 12671 def AddGrowableRow(*args, **kwargs):
12672 """
12673 AddGrowableRow(self, size_t idx, int proportion=0)
d55e5bfc 12674
248ed943
RD		 12675 Specifies that row *idx* (starting from zero) should be grown if there
12676 is extra space available to the sizer.
d55e5bfc 12677
248ed943
RD		 12678 The *proportion* parameter has the same meaning as the stretch factor
12679 for the box sizers except that if all proportions are 0, then all
12680 columns are resized equally (instead of not being resized at all).
12681 """
d55e5bfc
RD		 12682 return _core_.FlexGridSizer_AddGrowableRow(*args, **kwargs)
12683
12684 def RemoveGrowableRow(*args, **kwargs):
248ed943
RD		 12685 """
12686 RemoveGrowableRow(self, size_t idx)
12687
12688 Specifies that row *idx* is no longer growable.
12689 """
d55e5bfc
RD		 12690 return _core_.FlexGridSizer_RemoveGrowableRow(*args, **kwargs)
12691
12692 def AddGrowableCol(*args, **kwargs):
248ed943
RD		 12693 """
12694 AddGrowableCol(self, size_t idx, int proportion=0)
12695
12696 Specifies that column *idx* (starting from zero) should be grown if
12697 there is extra space available to the sizer.
12698
12699 The *proportion* parameter has the same meaning as the stretch factor
12700 for the box sizers except that if all proportions are 0, then all
12701 columns are resized equally (instead of not being resized at all).
12702 """
d55e5bfc
RD		 12703 return _core_.FlexGridSizer_AddGrowableCol(*args, **kwargs)
12704
12705 def RemoveGrowableCol(*args, **kwargs):
248ed943
RD		 12706 """
12707 RemoveGrowableCol(self, size_t idx)
12708
12709 Specifies that column *idx* is no longer growable.
12710 """
d55e5bfc
RD		 12711 return _core_.FlexGridSizer_RemoveGrowableCol(*args, **kwargs)
12712
12713 def SetFlexibleDirection(*args, **kwargs):
248ed943
RD		 12714 """
12715 SetFlexibleDirection(self, int direction)
12716
12717 Specifies whether the sizer should flexibly resize its columns, rows,
12718 or both. Argument *direction* can be one of the following values. Any
12719 other value is ignored.
12720
12721 ============== =======================================
12722 wx.VERTICAL Rows are flexibly sized.
12723 wx.HORIZONTAL Columns are flexibly sized.
12724 wx.BOTH Both rows and columns are flexibly sized
12725 (this is the default value).
12726 ============== =======================================
12727
12728 Note that this method does not trigger relayout.
12729
12730 """
d55e5bfc
RD		 12731 return _core_.FlexGridSizer_SetFlexibleDirection(*args, **kwargs)
12732
12733 def GetFlexibleDirection(*args, **kwargs):
248ed943
RD		 12734 """
12735 GetFlexibleDirection(self) -> int
12736
12737 Returns a value that specifies whether the sizer
12738 flexibly resizes its columns, rows, or both (default).
12739
12740 :see: `SetFlexibleDirection`
12741 """
d55e5bfc
RD		 12742 return _core_.FlexGridSizer_GetFlexibleDirection(*args, **kwargs)
12743
12744 def SetNonFlexibleGrowMode(*args, **kwargs):
248ed943
RD		 12745 """
12746 SetNonFlexibleGrowMode(self, int mode)
12747
12748 Specifies how the sizer should grow in the non-flexible direction if
12749 there is one (so `SetFlexibleDirection` must have been called
12750 previously). Argument *mode* can be one of the following values:
12751
12752 ========================== =================================================
12753 wx.FLEX_GROWMODE_NONE Sizer doesn't grow in the non flexible direction.
12754 wx.FLEX_GROWMODE_SPECIFIED Sizer honors growable columns/rows set with
12755 `AddGrowableCol` and `AddGrowableRow`. In this
12756 case equal sizing applies to minimum sizes of
12757 columns or rows (this is the default value).
12758 wx.FLEX_GROWMODE_ALL Sizer equally stretches all columns or rows in
12759 the non flexible direction, whether they are
12760 growable or not in the flexbile direction.
12761 ========================== =================================================
12762
12763 Note that this method does not trigger relayout.
248ed943 12764 """
d55e5bfc
RD		 12765 return _core_.FlexGridSizer_SetNonFlexibleGrowMode(*args, **kwargs)
12766
12767 def GetNonFlexibleGrowMode(*args, **kwargs):
248ed943
RD		 12768 """
12769 GetNonFlexibleGrowMode(self) -> int
12770
12771 Returns the value that specifies how the sizer grows in the
12772 non-flexible direction if there is one.
12773
12774 :see: `SetNonFlexibleGrowMode`
12775 """
d55e5bfc
RD		 12776 return _core_.FlexGridSizer_GetNonFlexibleGrowMode(*args, **kwargs)
12777
12778 def GetRowHeights(*args, **kwargs):
a8eff060
RD		 12779 """
12780 GetRowHeights(self) -> list
12781
12782 Returns a list of integers representing the heights of each of the
12783 rows in the sizer.
12784 """
d55e5bfc
RD		 12785 return _core_.FlexGridSizer_GetRowHeights(*args, **kwargs)
12786
12787 def GetColWidths(*args, **kwargs):
a8eff060
RD		 12788 """
12789 GetColWidths(self) -> list
12790
12791 Returns a list of integers representing the widths of each of the
12792 columns in the sizer.
12793 """
d55e5bfc
RD		 12794 return _core_.FlexGridSizer_GetColWidths(*args, **kwargs)
12795
97ab0f6a
RD		 12796 ColWidths = property(GetColWidths,doc="See `GetColWidths`")
12797 FlexibleDirection = property(GetFlexibleDirection,SetFlexibleDirection,doc="See `GetFlexibleDirection` and `SetFlexibleDirection`")
12798 NonFlexibleGrowMode = property(GetNonFlexibleGrowMode,SetNonFlexibleGrowMode,doc="See `GetNonFlexibleGrowMode` and `SetNonFlexibleGrowMode`")
12799 RowHeights = property(GetRowHeights,doc="See `GetRowHeights`")
2131d850 12800_core_.FlexGridSizer_swigregister(FlexGridSizer)
d55e5bfc 12801
62d32a5f
RD		 12802class StdDialogButtonSizer(BoxSizer):
12803 """
12804 A special sizer that knows how to order and position standard buttons
12805 in order to conform to the current platform's standards. You simply
12806 need to add each `wx.Button` to the sizer, and be sure to create the
53aa7709 12807 buttons using the standard ID's. Then call `Realize` and the sizer
62d32a5f
RD		 12808 will take care of the rest.
12809
12810 """
554f62e9
RD		 12811 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12812 __repr__ = _swig_repr
12813 def __init__(self, *args, **kwargs):
62d32a5f 12814 """__init__(self) -> StdDialogButtonSizer"""
554f62e9 12815 _core_.StdDialogButtonSizer_swiginit(self,_core_.new_StdDialogButtonSizer(*args, **kwargs))
62d32a5f
RD		 12816 def AddButton(*args, **kwargs):
12817 """
12818 AddButton(self, wxButton button)
12819
12820 Use this to add the buttons to this sizer. Do not use the `Add`
12821 method in the base class.
12822 """
12823 return _core_.StdDialogButtonSizer_AddButton(*args, **kwargs)
12824
53aa7709 12825 def Realize(*args, **kwargs):
62d32a5f 12826 """
53aa7709 12827 Realize(self)
62d32a5f
RD		 12828
12829 This funciton needs to be called after all the buttons have been added
12830 to the sizer. It will reorder them and position them in a platform
12831 specifc manner.
12832 """
53aa7709 12833 return _core_.StdDialogButtonSizer_Realize(*args, **kwargs)
51b83b37
RD		 12834
12835 def SetAffirmativeButton(*args, **kwargs):
12836 """SetAffirmativeButton(self, wxButton button)"""
12837 return _core_.StdDialogButtonSizer_SetAffirmativeButton(*args, **kwargs)
12838
12839 def SetNegativeButton(*args, **kwargs):
12840 """SetNegativeButton(self, wxButton button)"""
12841 return _core_.StdDialogButtonSizer_SetNegativeButton(*args, **kwargs)
12842
12843 def SetCancelButton(*args, **kwargs):
12844 """SetCancelButton(self, wxButton button)"""
12845 return _core_.StdDialogButtonSizer_SetCancelButton(*args, **kwargs)
62d32a5f
RD		 12846
12847 def GetAffirmativeButton(*args, **kwargs):
12848 """GetAffirmativeButton(self) -> wxButton"""
12849 return _core_.StdDialogButtonSizer_GetAffirmativeButton(*args, **kwargs)
12850
12851 def GetApplyButton(*args, **kwargs):
12852 """GetApplyButton(self) -> wxButton"""
12853 return _core_.StdDialogButtonSizer_GetApplyButton(*args, **kwargs)
12854
12855 def GetNegativeButton(*args, **kwargs):
12856 """GetNegativeButton(self) -> wxButton"""
12857 return _core_.StdDialogButtonSizer_GetNegativeButton(*args, **kwargs)
12858
12859 def GetCancelButton(*args, **kwargs):
12860 """GetCancelButton(self) -> wxButton"""
12861 return _core_.StdDialogButtonSizer_GetCancelButton(*args, **kwargs)
12862
12863 def GetHelpButton(*args, **kwargs):
12864 """GetHelpButton(self) -> wxButton"""
12865 return _core_.StdDialogButtonSizer_GetHelpButton(*args, **kwargs)
12866
33d6fd3b
RD		 12867 AffirmativeButton = property(GetAffirmativeButton,SetAffirmativeButton,doc="See `GetAffirmativeButton` and `SetAffirmativeButton`")
12868 ApplyButton = property(GetApplyButton,doc="See `GetApplyButton`")
12869 CancelButton = property(GetCancelButton,SetCancelButton,doc="See `GetCancelButton` and `SetCancelButton`")
12870 HelpButton = property(GetHelpButton,doc="See `GetHelpButton`")
12871 NegativeButton = property(GetNegativeButton,SetNegativeButton,doc="See `GetNegativeButton` and `SetNegativeButton`")
2131d850 12872_core_.StdDialogButtonSizer_swigregister(StdDialogButtonSizer)
62d32a5f 12873
d55e5bfc
RD		 12874#---------------------------------------------------------------------------
12875
12876class GBPosition(object):
248ed943
RD		 12877 """
12878 This class represents the position of an item in a virtual grid of
12879 rows and columns managed by a `wx.GridBagSizer`. wxPython has
12880 typemaps that will automatically convert from a 2-element sequence of
12881 integers to a wx.GBPosition, so you can use the more pythonic
12882 representation of the position nearly transparently in Python code.
12883 """
554f62e9
RD		 12884 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12885 __repr__ = _swig_repr
12886 def __init__(self, *args, **kwargs):
248ed943
RD		 12887 """
12888 __init__(self, int row=0, int col=0) -> GBPosition
12889
12890 This class represents the position of an item in a virtual grid of
12891 rows and columns managed by a `wx.GridBagSizer`. wxPython has
12892 typemaps that will automatically convert from a 2-element sequence of
12893 integers to a wx.GBPosition, so you can use the more pythonic
12894 representation of the position nearly transparently in Python code.
12895 """
554f62e9
RD		 12896 _core_.GBPosition_swiginit(self,_core_.new_GBPosition(*args, **kwargs))
12897 __swig_destroy__ = _core_.delete_GBPosition
12898 __del__ = lambda self : None;
d55e5bfc
RD		 12899 def GetRow(*args, **kwargs):
12900 """GetRow(self) -> int"""
12901 return _core_.GBPosition_GetRow(*args, **kwargs)
12902
12903 def GetCol(*args, **kwargs):
12904 """GetCol(self) -> int"""
12905 return _core_.GBPosition_GetCol(*args, **kwargs)
12906
12907 def SetRow(*args, **kwargs):
12908 """SetRow(self, int row)"""
12909 return _core_.GBPosition_SetRow(*args, **kwargs)
12910
12911 def SetCol(*args, **kwargs):
12912 """SetCol(self, int col)"""
12913 return _core_.GBPosition_SetCol(*args, **kwargs)
12914
12915 def __eq__(*args, **kwargs):
e9d6f3a4
RD		 12916 """
12917 __eq__(self, PyObject other) -> bool
12918
12919 Compare GBPosition for equality.
12920 """
d55e5bfc
RD		 12921 return _core_.GBPosition___eq__(*args, **kwargs)
12922
12923 def __ne__(*args, **kwargs):
e9d6f3a4
RD		 12924 """
12925 __ne__(self, PyObject other) -> bool
12926
12927 Compare GBPosition for inequality.
12928 """
d55e5bfc
RD		 12929 return _core_.GBPosition___ne__(*args, **kwargs)
12930
12931 def Set(*args, **kwargs):
12932 """Set(self, int row=0, int col=0)"""
12933 return _core_.GBPosition_Set(*args, **kwargs)
12934
12935 def Get(*args, **kwargs):
12936 """Get(self) -> PyObject"""
12937 return _core_.GBPosition_Get(*args, **kwargs)
12938
79fccf9d 12939 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD		 12940 def __str__(self): return str(self.Get())
12941 def __repr__(self): return 'wx.GBPosition'+str(self.Get())
12942 def __len__(self): return len(self.Get())
12943 def __getitem__(self, index): return self.Get()[index]
12944 def __setitem__(self, index, val):
12945 if index == 0: self.SetRow(val)
12946 elif index == 1: self.SetCol(val)
12947 else: raise IndexError
12948 def __nonzero__(self): return self.Get() != (0,0)
12949 __safe_for_unpickling__ = True
12950 def __reduce__(self): return (wx.GBPosition, self.Get())
12951
12952 row = property(GetRow, SetRow)
12953 col = property(GetCol, SetCol)
12954
2131d850 12955_core_.GBPosition_swigregister(GBPosition)
d55e5bfc
RD		 12956
12957class GBSpan(object):
248ed943
RD		 12958 """
12959 This class is used to hold the row and column spanning attributes of
12960 items in a `wx.GridBagSizer`. wxPython has typemaps that will
12961 automatically convert from a 2-element sequence of integers to a
12962 wx.GBSpan, so you can use the more pythonic representation of the span
12963 nearly transparently in Python code.
12964
12965 """
554f62e9
RD		 12966 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12967 __repr__ = _swig_repr
12968 def __init__(self, *args, **kwargs):
248ed943
RD		 12969 """
12970 __init__(self, int rowspan=1, int colspan=1) -> GBSpan
12971
12972 Construct a new wxGBSpan, optionally setting the rowspan and
12973 colspan. The default is (1,1). (Meaning that the item occupies one
12974 cell in each direction.
12975 """
554f62e9
RD		 12976 _core_.GBSpan_swiginit(self,_core_.new_GBSpan(*args, **kwargs))
12977 __swig_destroy__ = _core_.delete_GBSpan
12978 __del__ = lambda self : None;
d55e5bfc
RD		 12979 def GetRowspan(*args, **kwargs):
12980 """GetRowspan(self) -> int"""
12981 return _core_.GBSpan_GetRowspan(*args, **kwargs)
12982
12983 def GetColspan(*args, **kwargs):
12984 """GetColspan(self) -> int"""
12985 return _core_.GBSpan_GetColspan(*args, **kwargs)
12986
12987 def SetRowspan(*args, **kwargs):
12988 """SetRowspan(self, int rowspan)"""
12989 return _core_.GBSpan_SetRowspan(*args, **kwargs)
12990
12991 def SetColspan(*args, **kwargs):
12992 """SetColspan(self, int colspan)"""
12993 return _core_.GBSpan_SetColspan(*args, **kwargs)
12994
12995 def __eq__(*args, **kwargs):
e9d6f3a4
RD		 12996 """
12997 __eq__(self, PyObject other) -> bool
12998
12999 Compare wxGBSpan for equality.
13000 """
d55e5bfc
RD		 13001 return _core_.GBSpan___eq__(*args, **kwargs)
13002
13003 def __ne__(*args, **kwargs):
e9d6f3a4
RD		 13004 """
13005 __ne__(self, PyObject other) -> bool
13006
13007 Compare GBSpan for inequality.
13008 """
d55e5bfc
RD		 13009 return _core_.GBSpan___ne__(*args, **kwargs)
13010
13011 def Set(*args, **kwargs):
13012 """Set(self, int rowspan=1, int colspan=1)"""
13013 return _core_.GBSpan_Set(*args, **kwargs)
13014
13015 def Get(*args, **kwargs):
13016 """Get(self) -> PyObject"""
13017 return _core_.GBSpan_Get(*args, **kwargs)
13018
79fccf9d 13019 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD		 13020 def __str__(self): return str(self.Get())
13021 def __repr__(self): return 'wx.GBSpan'+str(self.Get())
13022 def __len__(self): return len(self.Get())
13023 def __getitem__(self, index): return self.Get()[index]
13024 def __setitem__(self, index, val):
13025 if index == 0: self.SetRowspan(val)
13026 elif index == 1: self.SetColspan(val)
13027 else: raise IndexError
13028 def __nonzero__(self): return self.Get() != (0,0)
13029 __safe_for_unpickling__ = True
13030 def __reduce__(self): return (wx.GBSpan, self.Get())
13031
13032 rowspan = property(GetRowspan, SetRowspan)
13033 colspan = property(GetColspan, SetColspan)
13034
2131d850 13035_core_.GBSpan_swigregister(GBSpan)
d55e5bfc
RD		 13036
13037class GBSizerItem(SizerItem):
248ed943
RD		 13038 """
13039 The wx.GBSizerItem class is used to track the additional data about
13040 items in a `wx.GridBagSizer` such as the item's position in the grid
13041 and how many rows or columns it spans.
13042
13043 """
554f62e9
RD		 13044 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
13045 __repr__ = _swig_repr
13046 def __init__(self, *args, **kwargs):
248ed943
RD		 13047 """
13048 __init__(self) -> GBSizerItem
13049
13050 Constructs an empty wx.GBSizerItem. Either a window, sizer or spacer
13051 size will need to be set, as well as a position and span before this
13052 item can be used in a Sizer.
13053
13054 You will probably never need to create a wx.GBSizerItem directly as they
13055 are created automatically when the sizer's Add method is called.
13056 """
554f62e9
RD		 13057 _core_.GBSizerItem_swiginit(self,_core_.new_GBSizerItem(*args, **kwargs))
13058 __swig_destroy__ = _core_.delete_GBSizerItem
13059 __del__ = lambda self : None;
d55e5bfc 13060 def GetPos(*args, **kwargs):
248ed943
RD		 13061 """
13062 GetPos(self) -> GBPosition
13063
13064 Get the grid position of the item
13065 """
d55e5bfc
RD		 13066 return _core_.GBSizerItem_GetPos(*args, **kwargs)
13067
13068 def GetPosTuple(self): return self.GetPos().Get()
13069 def GetSpan(*args, **kwargs):
248ed943
RD		 13070 """
13071 GetSpan(self) -> GBSpan
13072
13073 Get the row and column spanning of the item
13074 """
d55e5bfc
RD		 13075 return _core_.GBSizerItem_GetSpan(*args, **kwargs)
13076
13077 def GetSpanTuple(self): return self.GetSpan().Get()
13078 def SetPos(*args, **kwargs):
248ed943
RD		 13079 """
13080 SetPos(self, GBPosition pos) -> bool
13081
13082 If the item is already a member of a sizer then first ensure that
13083 there is no other item that would intersect with this one at the new
13084 position, then set the new position. Returns True if the change is
13085 successful and after the next Layout() the item will be moved.
13086 """
d55e5bfc
RD		 13087 return _core_.GBSizerItem_SetPos(*args, **kwargs)
13088
13089 def SetSpan(*args, **kwargs):
248ed943
RD		 13090 """
13091 SetSpan(self, GBSpan span) -> bool
13092
13093 If the item is already a member of a sizer then first ensure that
13094 there is no other item that would intersect with this one with its new
13095 spanning size, then set the new spanning. Returns True if the change
13096 is successful and after the next Layout() the item will be resized.
13097
13098 """
d55e5bfc
RD		 13099 return _core_.GBSizerItem_SetSpan(*args, **kwargs)
13100
248ed943 13101 def Intersects(*args, **kwargs):
d55e5bfc
RD		 13102 """
13103 Intersects(self, GBSizerItem other) -> bool
248ed943
RD		 13104
13105 Returns True if this item and the other item instersect.
d55e5bfc 13106 """
248ed943
RD		 13107 return _core_.GBSizerItem_Intersects(*args, **kwargs)
13108
13109 def IntersectsPos(*args, **kwargs):
13110 """
13111 IntersectsPos(self, GBPosition pos, GBSpan span) -> bool
13112
13113 Returns True if the given pos/span would intersect with this item.
13114 """
13115 return _core_.GBSizerItem_IntersectsPos(*args, **kwargs)
d55e5bfc
RD		 13116
13117 def GetEndPos(*args, **kwargs):
248ed943
RD		 13118 """
13119 GetEndPos(self) -> GBPosition
13120
13121 Get the row and column of the endpoint of this item.
13122 """
d55e5bfc
RD		 13123 return _core_.GBSizerItem_GetEndPos(*args, **kwargs)
13124
13125 def GetGBSizer(*args, **kwargs):
248ed943
RD		 13126 """
13127 GetGBSizer(self) -> GridBagSizer
13128
13129 Get the sizer this item is a member of.
13130 """
d55e5bfc
RD		 13131 return _core_.GBSizerItem_GetGBSizer(*args, **kwargs)
13132
13133 def SetGBSizer(*args, **kwargs):
248ed943
RD		 13134 """
13135 SetGBSizer(self, GridBagSizer sizer)
13136
13137 Set the sizer this item is a member of.
13138 """
d55e5bfc
RD		 13139 return _core_.GBSizerItem_SetGBSizer(*args, **kwargs)
13140
97ab0f6a
RD		 13141 EndPos = property(GetEndPos,doc="See `GetEndPos`")
13142 GBSizer = property(GetGBSizer,SetGBSizer,doc="See `GetGBSizer` and `SetGBSizer`")
13143 Pos = property(GetPos,SetPos,doc="See `GetPos` and `SetPos`")
13144 Span = property(GetSpan,SetSpan,doc="See `GetSpan` and `SetSpan`")
2131d850 13145_core_.GBSizerItem_swigregister(GBSizerItem)
d55e5bfc
RD		 13146DefaultSpan = cvar.DefaultSpan
13147
13148def GBSizerItemWindow(*args, **kwargs):
13149 """
13150 GBSizerItemWindow(Window window, GBPosition pos, GBSpan span, int flag,
248ed943
RD		 13151 int border, PyObject userData=None) -> GBSizerItem
13152
13153 Construct a `wx.GBSizerItem` for a window.
d55e5bfc
RD		 13154 """
13155 val = _core_.new_GBSizerItemWindow(*args, **kwargs)
d55e5bfc
RD		 13156 return val
13157
13158def GBSizerItemSizer(*args, **kwargs):
13159 """
13160 GBSizerItemSizer(Sizer sizer, GBPosition pos, GBSpan span, int flag,
248ed943
RD		 13161 int border, PyObject userData=None) -> GBSizerItem
13162
13163 Construct a `wx.GBSizerItem` for a sizer
d55e5bfc
RD		 13164 """
13165 val = _core_.new_GBSizerItemSizer(*args, **kwargs)
d55e5bfc
RD		 13166 return val
13167
13168def GBSizerItemSpacer(*args, **kwargs):
13169 """
13170 GBSizerItemSpacer(int width, int height, GBPosition pos, GBSpan span,
248ed943
RD		 13171 int flag, int border, PyObject userData=None) -> GBSizerItem
13172
13173 Construct a `wx.GBSizerItem` for a spacer.
d55e5bfc
RD		 13174 """
13175 val = _core_.new_GBSizerItemSpacer(*args, **kwargs)
d55e5bfc
RD		 13176 return val
13177
13178class GridBagSizer(FlexGridSizer):
248ed943
RD		 13179 """
13180 A `wx.Sizer` that can lay out items in a virtual grid like a
13181 `wx.FlexGridSizer` but in this case explicit positioning of the items
13182 is allowed using `wx.GBPosition`, and items can optionally span more
13183 than one row and/or column using `wx.GBSpan`. The total size of the
13184 virtual grid is determined by the largest row and column that items are
13185 positioned at, adjusted for spanning.
13186
13187 """
554f62e9
RD		 13188 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
13189 __repr__ = _swig_repr
13190 def __init__(self, *args, **kwargs):
248ed943
RD		 13191 """
13192 __init__(self, int vgap=0, int hgap=0) -> GridBagSizer
13193
13194 Constructor, with optional parameters to specify the gap between the
13195 rows and columns.
13196 """
554f62e9 13197 _core_.GridBagSizer_swiginit(self,_core_.new_GridBagSizer(*args, **kwargs))
c9c2cf70
RD		 13198 self._setOORInfo(self)
13199
d55e5bfc
RD		 13200 def Add(*args, **kwargs):
13201 """
248ed943 13202 Add(self, item, GBPosition pos, GBSpan span=DefaultSpan, int flag=0,
c1cb24a4 13203 int border=0, userData=None) -> wx.GBSizerItem
248ed943
RD		 13204
13205 Adds an item to the sizer at the grid cell *pos*, optionally spanning
13206 more than one row or column as specified with *span*. The remaining
13207 args behave similarly to `wx.Sizer.Add`.
13208
13209 Returns True if the item was successfully placed at the given cell
13210 position, False if something was already there.
13211
d55e5bfc
RD		 13212 """
13213 return _core_.GridBagSizer_Add(*args, **kwargs)
13214
13215 def AddItem(*args, **kwargs):
248ed943 13216 """
c1cb24a4 13217 Add(self, GBSizerItem item) -> wx.GBSizerItem
248ed943
RD		 13218
13219 Add an item to the sizer using a `wx.GBSizerItem`. Returns True if
13220 the item was successfully placed at its given cell position, False if
13221 something was already there.
13222 """
d55e5bfc
RD		 13223 return _core_.GridBagSizer_AddItem(*args, **kwargs)
13224
84f85550
RD		 13225 def GetCellSize(*args, **kwargs):
13226 """
13227 GetCellSize(self, int row, int col) -> Size
13228
13229 Get the size of the specified cell, including hgap and
13230 vgap. Only valid after a Layout.
13231 """
13232 return _core_.GridBagSizer_GetCellSize(*args, **kwargs)
13233
d55e5bfc 13234 def GetEmptyCellSize(*args, **kwargs):
248ed943
RD		 13235 """
13236 GetEmptyCellSize(self) -> Size
13237
13238 Get the size used for cells in the grid with no item.
13239 """
d55e5bfc
RD		 13240 return _core_.GridBagSizer_GetEmptyCellSize(*args, **kwargs)
13241
13242 def SetEmptyCellSize(*args, **kwargs):
248ed943
RD		 13243 """
13244 SetEmptyCellSize(self, Size sz)
13245
13246 Set the size used for cells in the grid with no item.
13247 """
d55e5bfc
RD		 13248 return _core_.GridBagSizer_SetEmptyCellSize(*args, **kwargs)
13249
13250 def GetItemPosition(*args):
13251 """
248ed943
RD		 13252 GetItemPosition(self, item) -> GBPosition
13253
13254 Get the grid position of the specified *item* where *item* is either a
13255 window or subsizer that is a member of this sizer, or a zero-based
13256 index of an item.
d55e5bfc
RD		 13257 """
13258 return _core_.GridBagSizer_GetItemPosition(*args)
13259
13260 def SetItemPosition(*args):
13261 """
248ed943
RD		 13262 SetItemPosition(self, item, GBPosition pos) -> bool
13263
13264 Set the grid position of the specified *item* where *item* is either a
13265 window or subsizer that is a member of this sizer, or a zero-based
13266 index of an item. Returns True on success. If the move is not
13267 allowed (because an item is already there) then False is returned.
13268
d55e5bfc
RD		 13269 """
13270 return _core_.GridBagSizer_SetItemPosition(*args)
13271
13272 def GetItemSpan(*args):
13273 """
248ed943
RD		 13274 GetItemSpan(self, item) -> GBSpan
13275
13276 Get the row/col spanning of the specified *item* where *item* is
13277 either a window or subsizer that is a member of this sizer, or a
13278 zero-based index of an item.
d55e5bfc
RD		 13279 """
13280 return _core_.GridBagSizer_GetItemSpan(*args)
13281
13282 def SetItemSpan(*args):
13283 """
248ed943
RD		 13284 SetItemSpan(self, item, GBSpan span) -> bool
13285
13286 Set the row/col spanning of the specified *item* where *item* is
13287 either a window or subsizer that is a member of this sizer, or a
13288 zero-based index of an item. Returns True on success. If the move is
13289 not allowed (because an item is already there) then False is returned.
d55e5bfc
RD		 13290 """
13291 return _core_.GridBagSizer_SetItemSpan(*args)
13292
13293 def FindItem(*args):
13294 """
248ed943
RD		 13295 FindItem(self, item) -> GBSizerItem
13296
13297 Find the sizer item for the given window or subsizer, returns None if
13298 not found. (non-recursive)
d55e5bfc
RD		 13299 """
13300 return _core_.GridBagSizer_FindItem(*args)
13301
13302 def FindItemAtPosition(*args, **kwargs):
248ed943
RD		 13303 """
13304 FindItemAtPosition(self, GBPosition pos) -> GBSizerItem
13305
13306 Return the sizer item for the given grid cell, or None if there is no
13307 item at that position. (non-recursive)
13308 """
d55e5bfc
RD		 13309 return _core_.GridBagSizer_FindItemAtPosition(*args, **kwargs)
13310
13311 def FindItemAtPoint(*args, **kwargs):
248ed943
RD		 13312 """
13313 FindItemAtPoint(self, Point pt) -> GBSizerItem
13314
13315 Return the sizer item located at the point given in *pt*, or None if
13316 there is no item at that point. The (x,y) coordinates in pt correspond
13317 to the client coordinates of the window using the sizer for
13318 layout. (non-recursive)
13319 """
d55e5bfc
RD		 13320 return _core_.GridBagSizer_FindItemAtPoint(*args, **kwargs)
13321
248ed943
RD		 13322 def CheckForIntersection(*args, **kwargs):
13323 """
13324 CheckForIntersection(self, GBSizerItem item, GBSizerItem excludeItem=None) -> bool
d55e5bfc 13325
248ed943
RD		 13326 Look at all items and see if any intersect (or would overlap) the
13327 given *item*. Returns True if so, False if there would be no overlap.
13328 If an *excludeItem* is given then it will not be checked for
13329 intersection, for example it may be the item we are checking the
13330 position of.
d55e5bfc 13331
248ed943
RD		 13332 """
13333 return _core_.GridBagSizer_CheckForIntersection(*args, **kwargs)
d55e5bfc 13334
248ed943 13335 def CheckForIntersectionPos(*args, **kwargs):
d55e5bfc 13336 """
248ed943
RD		 13337 CheckForIntersectionPos(self, GBPosition pos, GBSpan span, GBSizerItem excludeItem=None) -> bool
13338
13339 Look at all items and see if any intersect (or would overlap) the
13340 given position and span. Returns True if so, False if there would be
13341 no overlap. If an *excludeItem* is given then it will not be checked
13342 for intersection, for example it may be the item we are checking the
13343 position of.
d55e5bfc 13344 """
248ed943 13345 return _core_.GridBagSizer_CheckForIntersectionPos(*args, **kwargs)
d55e5bfc 13346
2131d850 13347_core_.GridBagSizer_swigregister(GridBagSizer)
d55e5bfc
RD		 13348
13349#---------------------------------------------------------------------------
13350
13351Left = _core_.Left
13352Top = _core_.Top
13353Right = _core_.Right
13354Bottom = _core_.Bottom
13355Width = _core_.Width
13356Height = _core_.Height
13357Centre = _core_.Centre
13358Center = _core_.Center
13359CentreX = _core_.CentreX
13360CentreY = _core_.CentreY
13361Unconstrained = _core_.Unconstrained
13362AsIs = _core_.AsIs
13363PercentOf = _core_.PercentOf
13364Above = _core_.Above
13365Below = _core_.Below
13366LeftOf = _core_.LeftOf
13367RightOf = _core_.RightOf
13368SameAs = _core_.SameAs
13369Absolute = _core_.Absolute
13370class IndividualLayoutConstraint(Object):
13371 """
79fccf9d
RD		 13372 Objects of this class are stored in the `wx.LayoutConstraints` class as
13373 one of eight possible constraints that a window can be involved in.
13374 You will never need to create an instance of
13375 wx.IndividualLayoutConstraint, rather you should create a
13376 `wx.LayoutConstraints` instance and use the individual contstraints
d55e5bfc 13377 that it contains.
d55e5bfc 13378 """
554f62e9
RD		 13379 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
13380 def __init__(self): raise AttributeError, "No constructor defined"
13381 __repr__ = _swig_repr
d55e5bfc 13382 def Set(*args, **kwargs):
79fccf9d
RD		 13383 """
13384 Set(self, int rel, Window otherW, int otherE, int val=0, int marg=wxLAYOUT_DEFAULT_MARGIN)
13385
13386 Sets the properties of the constraint. Normally called by one of the
13387 convenience functions such as Above, RightOf, SameAs.
13388 """
d55e5bfc
RD		 13389 return _core_.IndividualLayoutConstraint_Set(*args, **kwargs)
13390
13391 def LeftOf(*args, **kwargs):
13392 """
13393 LeftOf(self, Window sibling, int marg=0)
13394
79fccf9d
RD		 13395 Constrains this edge to be to the left of the given window, with an
13396 optional margin. Implicitly, this is relative to the left edge of the
13397 other window.
d55e5bfc
RD		 13398 """
13399 return _core_.IndividualLayoutConstraint_LeftOf(*args, **kwargs)
13400
13401 def RightOf(*args, **kwargs):
13402 """
13403 RightOf(self, Window sibling, int marg=0)
13404
79fccf9d
RD		 13405 Constrains this edge to be to the right of the given window, with an
13406 optional margin. Implicitly, this is relative to the right edge of the
13407 other window.
d55e5bfc
RD		 13408 """
13409 return _core_.IndividualLayoutConstraint_RightOf(*args, **kwargs)
13410
13411 def Above(*args, **kwargs):
13412 """
13413 Above(self, Window sibling, int marg=0)
13414
79fccf9d
RD		 13415 Constrains this edge to be above the given window, with an optional
13416 margin. Implicitly, this is relative to the top edge of the other
13417 window.
d55e5bfc
RD		 13418 """
13419 return _core_.IndividualLayoutConstraint_Above(*args, **kwargs)
13420
13421 def Below(*args, **kwargs):
13422 """
13423 Below(self, Window sibling, int marg=0)
13424
79fccf9d
RD		 13425 Constrains this edge to be below the given window, with an optional
13426 margin. Implicitly, this is relative to the bottom edge of the other
13427 window.
d55e5bfc
RD		 13428 """
13429 return _core_.IndividualLayoutConstraint_Below(*args, **kwargs)
13430
13431 def SameAs(*args, **kwargs):
13432 """
13433 SameAs(self, Window otherW, int edge, int marg=0)
13434
79fccf9d
RD		 13435 Constrains this edge or dimension to be to the same as the edge of the
13436 given window, with an optional margin.
d55e5bfc
RD		 13437 """
13438 return _core_.IndividualLayoutConstraint_SameAs(*args, **kwargs)
13439
13440 def PercentOf(*args, **kwargs):
13441 """
13442 PercentOf(self, Window otherW, int wh, int per)
13443
79fccf9d
RD		 13444 Constrains this edge or dimension to be to a percentage of the given
13445 window, with an optional margin.
d55e5bfc
RD		 13446 """
13447 return _core_.IndividualLayoutConstraint_PercentOf(*args, **kwargs)
13448
13449 def Absolute(*args, **kwargs):
13450 """
13451 Absolute(self, int val)
13452
79fccf9d 13453 Constrains this edge or dimension to be the given absolute value.
d55e5bfc
RD		 13454 """
13455 return _core_.IndividualLayoutConstraint_Absolute(*args, **kwargs)
13456
13457 def Unconstrained(*args, **kwargs):
13458 """
13459 Unconstrained(self)
13460
79fccf9d
RD		 13461 Sets this edge or dimension to be unconstrained, that is, dependent on
13462 other edges and dimensions from which this value can be deduced.
d55e5bfc
RD		 13463 """
13464 return _core_.IndividualLayoutConstraint_Unconstrained(*args, **kwargs)
13465
13466 def AsIs(*args, **kwargs):
13467 """
13468 AsIs(self)
13469
79fccf9d
RD		 13470 Sets this edge or constraint to be whatever the window's value is at
13471 the moment. If either of the width and height constraints are *as is*,
13472 the window will not be resized, but moved instead. This is important
13473 when considering panel items which are intended to have a default
13474 size, such as a button, which may take its size from the size of the
13475 button label.
d55e5bfc
RD		 13476 """
13477 return _core_.IndividualLayoutConstraint_AsIs(*args, **kwargs)
13478
13479 def GetOtherWindow(*args, **kwargs):
13480 """GetOtherWindow(self) -> Window"""
13481 return _core_.IndividualLayoutConstraint_GetOtherWindow(*args, **kwargs)
13482
13483 def GetMyEdge(*args, **kwargs):
13484 """GetMyEdge(self) -> int"""
13485 return _core_.IndividualLayoutConstraint_GetMyEdge(*args, **kwargs)
13486
13487 def SetEdge(*args, **kwargs):
13488 """SetEdge(self, int which)"""
13489 return _core_.IndividualLayoutConstraint_SetEdge(*args, **kwargs)
13490
13491 def SetValue(*args, **kwargs):
13492 """SetValue(self, int v)"""
13493 return _core_.IndividualLayoutConstraint_SetValue(*args, **kwargs)
13494
13495 def GetMargin(*args, **kwargs):
13496 """GetMargin(self) -> int"""
13497 return _core_.IndividualLayoutConstraint_GetMargin(*args, **kwargs)
13498
13499 def SetMargin(*args, **kwargs):
13500 """SetMargin(self, int m)"""
13501 return _core_.IndividualLayoutConstraint_SetMargin(*args, **kwargs)
13502
13503 def GetValue(*args, **kwargs):
13504 """GetValue(self) -> int"""
13505 return _core_.IndividualLayoutConstraint_GetValue(*args, **kwargs)
13506
13507 def GetPercent(*args, **kwargs):
13508 """GetPercent(self) -> int"""
13509 return _core_.IndividualLayoutConstraint_GetPercent(*args, **kwargs)
13510
13511 def GetOtherEdge(*args, **kwargs):
13512 """GetOtherEdge(self) -> int"""
13513 return _core_.IndividualLayoutConstraint_GetOtherEdge(*args, **kwargs)
13514
13515 def GetDone(*args, **kwargs):
13516 """GetDone(self) -> bool"""
13517 return _core_.IndividualLayoutConstraint_GetDone(*args, **kwargs)
13518
13519 def SetDone(*args, **kwargs):
13520 """SetDone(self, bool d)"""
13521 return _core_.IndividualLayoutConstraint_SetDone(*args, **kwargs)
13522
13523 def GetRelationship(*args, **kwargs):
13524 """GetRelationship(self) -> int"""
13525 return _core_.IndividualLayoutConstraint_GetRelationship(*args, **kwargs)
13526
13527 def SetRelationship(*args, **kwargs):
13528 """SetRelationship(self, int r)"""
13529 return _core_.IndividualLayoutConstraint_SetRelationship(*args, **kwargs)
13530
13531 def ResetIfWin(*args, **kwargs):
13532 """
13533 ResetIfWin(self, Window otherW) -> bool
13534
13535 Reset constraint if it mentions otherWin
13536 """
13537 return _core_.IndividualLayoutConstraint_ResetIfWin(*args, **kwargs)
13538
13539 def SatisfyConstraint(*args, **kwargs):
13540 """
13541 SatisfyConstraint(self, LayoutConstraints constraints, Window win) -> bool
13542
13543 Try to satisfy constraint
13544 """
13545 return _core_.IndividualLayoutConstraint_SatisfyConstraint(*args, **kwargs)
13546
13547 def GetEdge(*args, **kwargs):
13548 """
13549 GetEdge(self, int which, Window thisWin, Window other) -> int
13550
13551 Get the value of this edge or dimension, or if this
13552 is not determinable, -1.
13553 """
13554 return _core_.IndividualLayoutConstraint_GetEdge(*args, **kwargs)
13555
97ab0f6a
RD		 13556 Done = property(GetDone,SetDone,doc="See `GetDone` and `SetDone`")
13557 Margin = property(GetMargin,SetMargin,doc="See `GetMargin` and `SetMargin`")
13558 MyEdge = property(GetMyEdge,doc="See `GetMyEdge`")
13559 OtherEdge = property(GetOtherEdge,doc="See `GetOtherEdge`")
13560 OtherWindow = property(GetOtherWindow,doc="See `GetOtherWindow`")
13561 Percent = property(GetPercent,doc="See `GetPercent`")
13562 Relationship = property(GetRelationship,SetRelationship,doc="See `GetRelationship` and `SetRelationship`")
13563 Value = property(GetValue,SetValue,doc="See `GetValue` and `SetValue`")
2131d850 13564_core_.IndividualLayoutConstraint_swigregister(IndividualLayoutConstraint)
d55e5bfc
RD		 13565
13566class LayoutConstraints(Object):
13567 """
79fccf9d
RD		 13568 **Note:** constraints are now deprecated and you should use sizers
13569 instead.
d55e5bfc 13570
79fccf9d
RD		 13571 Objects of this class can be associated with a window to define its
13572 layout constraints, with respect to siblings or its parent.
d55e5bfc
RD		 13573
13574 The class consists of the following eight constraints of class
13575 wx.IndividualLayoutConstraint, some or all of which should be accessed
13576 directly to set the appropriate constraints.
13577
13578 * left: represents the left hand edge of the window
13579 * right: represents the right hand edge of the window
13580 * top: represents the top edge of the window
13581 * bottom: represents the bottom edge of the window
13582 * width: represents the width of the window
13583 * height: represents the height of the window
13584 * centreX: represents the horizontal centre point of the window
13585 * centreY: represents the vertical centre point of the window
13586
79fccf9d
RD		 13587 Most constraints are initially set to have the relationship
13588 wxUnconstrained, which means that their values should be calculated by
13589 looking at known constraints. The exceptions are width and height,
13590 which are set to wxAsIs to ensure that if the user does not specify a
13591 constraint, the existing width and height will be used, to be
13592 compatible with panel items which often have take a default size. If
13593 the constraint is ``wx.AsIs``, the dimension will not be changed.
13594
13595 :see: `wx.IndividualLayoutConstraint`, `wx.Window.SetConstraints`
d55e5bfc
RD		 13596
13597 """
554f62e9
RD		 13598 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
13599 __repr__ = _swig_repr
d55e5bfc
RD		 13600 left = property(_core_.LayoutConstraints_left_get)
13601 top = property(_core_.LayoutConstraints_top_get)
13602 right = property(_core_.LayoutConstraints_right_get)
13603 bottom = property(_core_.LayoutConstraints_bottom_get)
13604 width = property(_core_.LayoutConstraints_width_get)
13605 height = property(_core_.LayoutConstraints_height_get)
13606 centreX = property(_core_.LayoutConstraints_centreX_get)
13607 centreY = property(_core_.LayoutConstraints_centreY_get)
554f62e9 13608 def __init__(self, *args, **kwargs):
d55e5bfc 13609 """__init__(self) -> LayoutConstraints"""
554f62e9
RD		 13610 _core_.LayoutConstraints_swiginit(self,_core_.new_LayoutConstraints(*args, **kwargs))
13611 __swig_destroy__ = _core_.delete_LayoutConstraints
13612 __del__ = lambda self : None;
d55e5bfc
RD		 13613 def SatisfyConstraints(*args, **kwargs):
13614 """SatisfyConstraints(Window win) -> (areSatisfied, noChanges)"""
13615 return _core_.LayoutConstraints_SatisfyConstraints(*args, **kwargs)
13616
13617 def AreSatisfied(*args, **kwargs):
13618 """AreSatisfied(self) -> bool"""
13619 return _core_.LayoutConstraints_AreSatisfied(*args, **kwargs)
13620
2131d850 13621_core_.LayoutConstraints_swigregister(LayoutConstraints)
d55e5bfc
RD		 13622
13623#----------------------------------------------------------------------------
13624
13625# Use Python's bool constants if available, make some if not
13626try:
13627 True
13628except NameError:
13629 __builtins__.True = 1==1
13630 __builtins__.False = 1==0
13631 def bool(value): return not not value
13632 __builtins__.bool = bool
13633
13634
13635
13636# workarounds for bad wxRTTI names
13637__wxPyPtrTypeMap['wxGauge95'] = 'wxGauge'
13638__wxPyPtrTypeMap['wxSlider95'] = 'wxSlider'
13639__wxPyPtrTypeMap['wxStatusBar95'] = 'wxStatusBar'
13640
13641
13642#----------------------------------------------------------------------------
13643# Load version numbers from __version__... Ensure that major and minor
0f63ec68 13644# versions are the same for both wxPython and wxWidgets.
d55e5bfc
RD		 13645
13646from __version__ import *
13647__version__ = VERSION_STRING
13648
0f63ec68
RD		 13649assert MAJOR_VERSION == _core_.MAJOR_VERSION, "wxPython/wxWidgets version mismatch"
13650assert MINOR_VERSION == _core_.MINOR_VERSION, "wxPython/wxWidgets version mismatch"
d55e5bfc
RD		 13651if RELEASE_VERSION != _core_.RELEASE_VERSION:
13652 import warnings
0f63ec68 13653 warnings.warn("wxPython/wxWidgets release number mismatch")
d55e5bfc
RD		 13654
13655#----------------------------------------------------------------------------
13656
70b7a5fe
RD		 13657# Set wxPython's default string<-->unicode conversion encoding from
13658# the locale, but only if Python's default hasn't been changed. (We
13659# assume that if the user has customized it already then that is the
13660# encoding we need to use as well.)
13661#
13662# The encoding selected here is used when string or unicode objects
13663# need to be converted in order to pass them to wxWidgets. Please be
13664# aware that the default encoding within the same locale may be
13665# slightly different on different platforms. For example, please see
62d32a5f
RD		 13666# http://www.alanwood.net/demos/charsetdiffs.html for differences
13667# between the common latin/roman encodings.
396fb509
RD		 13668
13669default = _sys.getdefaultencoding()
13670if default == 'ascii':
13671 import locale
13672 import codecs
13673 try:
13674 default = locale.getdefaultlocale()[1]
13675 codecs.lookup(default)
70b7a5fe 13676 except (ValueError, LookupError, TypeError):
396fb509
RD		 13677 default = _sys.getdefaultencoding()
13678 del locale
13679 del codecs
5cbf236d
RD		 13680if default:
13681 wx.SetDefaultPyEncoding(default)
13682del default
5cbf236d
RD		 13683
13684#----------------------------------------------------------------------------
13685
d55e5bfc
RD		 13686class PyDeadObjectError(AttributeError):
13687 pass
13688
13689class _wxPyDeadObject(object):
13690 """
13691 Instances of wx objects that are OOR capable will have their __class__
13692 changed to this class when the C++ object is deleted. This should help
13693 prevent crashes due to referencing a bogus C++ pointer.
13694 """
13695 reprStr = "wxPython wrapper for DELETED %s object! (The C++ object no longer exists.)"
13696 attrStr = "The C++ part of the %s object has been deleted, attribute access no longer allowed."
13697
13698 def __repr__(self):
13699 if not hasattr(self, "_name"):
13700 self._name = "[unknown]"
13701 return self.reprStr % self._name
13702
13703 def __getattr__(self, *args):
13704 if not hasattr(self, "_name"):
13705 self._name = "[unknown]"
13706 raise PyDeadObjectError(self.attrStr % self._name)
13707
13708 def __nonzero__(self):
13709 return 0
13710
13711
13712
13713class PyUnbornObjectError(AttributeError):
13714 pass
13715
13716class _wxPyUnbornObject(object):
13717 """
13718 Some stock objects are created when the wx._core module is
13719 imported, but their C++ instance is not created until the wx.App
13720 object is created and initialized. These object instances will
13721 temporarily have their __class__ changed to this class so an
13722 exception will be raised if they are used before the C++ instance
13723 is ready.
13724 """
13725
13726 reprStr = "wxPython wrapper for UNBORN object! (The C++ object is not initialized yet.)"
13727 attrStr = "The C++ part of this object has not been initialized, attribute access not allowed."
13728
13729 def __repr__(self):
13730 #if not hasattr(self, "_name"):
13731 # self._name = "[unknown]"
13732 return self.reprStr #% self._name
13733
13734 def __getattr__(self, *args):
13735 #if not hasattr(self, "_name"):
13736 # self._name = "[unknown]"
13737 raise PyUnbornObjectError(self.attrStr) # % self._name )
13738
13739 def __nonzero__(self):
13740 return 0
13741
13742
13743#----------------------------------------------------------------------------
d55e5bfc
RD		 13744
13745def CallAfter(callable, *args, **kw):
13746 """
13747 Call the specified function after the current and pending event
13748 handlers have been completed. This is also good for making GUI
0439c23b
RD		 13749 method calls from non-GUI threads. Any extra positional or
13750 keyword args are passed on to the callable when it is called.
13751
846c181b 13752 :see: `wx.CallLater`
d55e5bfc
RD		 13753 """
13754 app = wx.GetApp()
a001823c 13755 assert app is not None, 'No wx.App created yet'
d55e5bfc 13756
891bb194
RD		 13757 if not hasattr(app, "_CallAfterId"):
13758 app._CallAfterId = wx.NewEventType()
13759 app.Connect(-1, -1, app._CallAfterId,
13760 lambda event: event.callable(*event.args, **event.kw) )
d55e5bfc 13761 evt = wx.PyEvent()
891bb194 13762 evt.SetEventType(app._CallAfterId)
d55e5bfc
RD		 13763 evt.callable = callable
13764 evt.args = args
13765 evt.kw = kw
13766 wx.PostEvent(app, evt)
13767
d55e5bfc
RD		 13768#----------------------------------------------------------------------------
13769
13770
846c181b 13771class CallLater:
d55e5bfc 13772 """
8ac8dba0 13773 A convenience class for `wx.Timer`, that calls the given callable
d55e5bfc
RD		 13774 object once after the given amount of milliseconds, passing any
13775 positional or keyword args. The return value of the callable is
0439c23b 13776 availbale after it has been run with the `GetResult` method.
d55e5bfc
RD		 13777
13778 If you don't need to get the return value or restart the timer
13779 then there is no need to hold a reference to this object. It will
13780 hold a reference to itself while the timer is running (the timer
13781 has a reference to self.Notify) but the cycle will be broken when
846c181b 13782 the timer completes, automatically cleaning up the wx.CallLater
d55e5bfc 13783 object.
0439c23b
RD		 13784
13785 :see: `wx.CallAfter`
d55e5bfc
RD		 13786 """
13787 def __init__(self, millis, callable, *args, **kwargs):
13788 self.millis = millis
13789 self.callable = callable
13790 self.SetArgs(*args, **kwargs)
13791 self.runCount = 0
13792 self.running = False
13793 self.hasRun = False
13794 self.result = None
13795 self.timer = None
13796 self.Start()
13797
13798 def __del__(self):
13799 self.Stop()
13800
13801
13802 def Start(self, millis=None, *args, **kwargs):
13803 """
13804 (Re)start the timer
13805 """
13806 self.hasRun = False
13807 if millis is not None:
13808 self.millis = millis
13809 if args or kwargs:
13810 self.SetArgs(*args, **kwargs)
13811 self.Stop()
13812 self.timer = wx.PyTimer(self.Notify)
13813 self.timer.Start(self.millis, wx.TIMER_ONE_SHOT)
13814 self.running = True
13815 Restart = Start
13816
13817
13818 def Stop(self):
13819 """
13820 Stop and destroy the timer.
13821 """
13822 if self.timer is not None:
13823 self.timer.Stop()
13824 self.timer = None
13825
13826
13827 def GetInterval(self):
13828 if self.timer is not None:
13829 return self.timer.GetInterval()
13830 else:
13831 return 0
13832
13833
13834 def IsRunning(self):
13835 return self.timer is not None and self.timer.IsRunning()
13836
13837
13838 def SetArgs(self, *args, **kwargs):
13839 """
13840 (Re)set the args passed to the callable object. This is
13841 useful in conjunction with Restart if you want to schedule a
13842 new call to the same callable object but with different
13843 parameters.
13844 """
13845 self.args = args
13846 self.kwargs = kwargs
13847
13848
13849 def HasRun(self):
13850 return self.hasRun
13851
13852 def GetResult(self):
13853 return self.result
13854
13855 def Notify(self):
13856 """
13857 The timer has expired so call the callable.
13858 """
13859 if self.callable and getattr(self.callable, 'im_self', True):
13860 self.runCount += 1
13861 self.running = False
13862 self.result = self.callable(*self.args, **self.kwargs)
13863 self.hasRun = True
13864 if not self.running:
13865 # if it wasn't restarted, then cleanup
13866 wx.CallAfter(self.Stop)
13867
97ab0f6a
RD		 13868 Interval = property(GetInterval)
13869 Result = property(GetResult)
d55e5bfc
RD		 13870
13871
846c181b
RD		 13872class FutureCall(CallLater):
13873 """A compatibility alias for `CallLater`."""
13874
d55e5bfc
RD		 13875#----------------------------------------------------------------------------
13876# Control which items in this module should be documented by epydoc.
13877# We allow only classes and functions, which will help reduce the size
13878# of the docs by filtering out the zillions of constants, EVT objects,
13879# and etc that don't make much sense by themselves, but are instead
13880# documented (or will be) as part of the classes/functions/methods
13881# where they should be used.
13882
c24da6d6
RD		 13883class __DocFilter:
13884 """
13885 A filter for epydoc that only allows non-Ptr classes and
0f83f5da 13886 functions, in order to reduce the clutter in the API docs.
c24da6d6
RD		 13887 """
13888 def __init__(self, globals):
13889 self._globals = globals
13890
13891 def __call__(self, name):
13892 import types
13893 obj = self._globals.get(name, None)
0f83f5da
RD		 13894
13895 # only document classes and function
c24da6d6
RD		 13896 if type(obj) not in [type, types.ClassType, types.FunctionType, types.BuiltinFunctionType]:
13897 return False
0f83f5da
RD		 13898
13899 # skip other things that are private or will be documented as part of somethign else
554f62e9 13900 if name.startswith('_') or name.startswith('EVT') or name.endswith('_swigregister') or name.endswith('Ptr') :
c24da6d6 13901 return False
0f83f5da
RD		 13902
13903 # skip functions that are duplicates of static functions in a class
13904 if name.find('_') != -1:
13905 cls = self._globals.get(name.split('_')[0], None)
13906 methname = name.split('_')[1]
13907 if hasattr(cls, methname) and type(getattr(cls, methname)) is types.FunctionType:
13908 return False
13909
c24da6d6 13910 return True
d55e5bfc
RD		 13911
13912#----------------------------------------------------------------------------
13913#----------------------------------------------------------------------------
13914
13915# Import other modules in this package that should show up in the
13916# "core" wx namespace
13917from _gdi import *
13918from _windows import *
13919from _controls import *
13920from _misc import *
13921
d55e5bfc
RD		 13922#----------------------------------------------------------------------------
13923#----------------------------------------------------------------------------
13924
13925
7449af73 13926
wxWidgets (Impactor)