]> git.saurik.com Git - wxWidgets.git/blame - wxPython/src/mac/_core.py
projects / wxWidgets.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
reSWIGged
[wxWidgets.git] / wxPython / src / mac / _core.py
CommitLineData
1bd55598 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
5b5c9bc7 4import _core_
1bd55598
RD		 5import new
6new_instancemethod = new.instancemethod
36ed4f51 7def _swig_setattr_nondynamic(self,class_type,name,value,static=1):
1bd55598 8 if (name == "thisown"): return self.this.own(value)
36ed4f51 9 if (name == "this"):
1bd55598
RD		 10 if type(value).__name__ == 'PySwigObject':
11 self.__dict__[name] = value
36ed4f51
RD		 12 return
13 method = class_type.__swig_setmethods__.get(name,None)
14 if method: return method(self,value)
1bd55598 15 if (not static) or hasattr(self,name):
36ed4f51
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):
1bd55598 24 if (name == "thisown"): return self.this.own()
36ed4f51
RD		 25 method = class_type.__swig_getmethods__.get(name,None)
26 if method: return method(self)
27 raise AttributeError,name
28
1bd55598
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
36ed4f51
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):
1bd55598
RD		 46 if (name == "thisown"): return self.this.own(value)
47 if hasattr(self,name) or (name == "this"):
36ed4f51
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
d6c14a4c
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
5b5c9bc7
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
95DEFAULT_CONTROL_BORDER = _core_.DEFAULT_CONTROL_BORDER
6d88e192 96DEFAULT_STATUSBAR_STYLE = _core_.DEFAULT_STATUSBAR_STYLE
5b5c9bc7
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
103CLIP_CHILDREN = _core_.CLIP_CHILDREN
104CLIP_SIBLINGS = _core_.CLIP_SIBLINGS
092f0ed7 105WINDOW_STYLE_MASK = _core_.WINDOW_STYLE_MASK
5b5c9bc7
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
129RA_USE_CHECKBOX = _core_.RA_USE_CHECKBOX
130RB_GROUP = _core_.RB_GROUP
131RB_SINGLE = _core_.RB_SINGLE
132SB_HORIZONTAL = _core_.SB_HORIZONTAL
133SB_VERTICAL = _core_.SB_VERTICAL
134RB_USE_CHECKBOX = _core_.RB_USE_CHECKBOX
135ST_SIZEGRIP = _core_.ST_SIZEGRIP
136ST_NO_AUTORESIZE = _core_.ST_NO_AUTORESIZE
e9d6f3a4
RD		 137ST_DOTS_MIDDLE = _core_.ST_DOTS_MIDDLE
138ST_DOTS_END = _core_.ST_DOTS_END
5b5c9bc7
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
943e8dfd 174SIZE_FORCE = _core_.SIZE_FORCE
5b5c9bc7
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
943e8dfd 183ID_NONE = _core_.ID_NONE
5b5c9bc7
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
5b5c9bc7
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
5b5c9bc7
RD		 206ID_CLOSE_ALL = _core_.ID_CLOSE_ALL
207ID_PREFERENCES = _core_.ID_PREFERENCES
ac5d357a 208ID_EDIT = _core_.ID_EDIT
5b5c9bc7
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
ac5d357a 228ID_FILE = _core_.ID_FILE
5b5c9bc7
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
256ID_ADD = _core_.ID_ADD
257ID_REMOVE = _core_.ID_REMOVE
258ID_UP = _core_.ID_UP
259ID_DOWN = _core_.ID_DOWN
260ID_HOME = _core_.ID_HOME
261ID_REFRESH = _core_.ID_REFRESH
262ID_STOP = _core_.ID_STOP
263ID_INDEX = _core_.ID_INDEX
264ID_BOLD = _core_.ID_BOLD
265ID_ITALIC = _core_.ID_ITALIC
266ID_JUSTIFY_CENTER = _core_.ID_JUSTIFY_CENTER
267ID_JUSTIFY_FILL = _core_.ID_JUSTIFY_FILL
268ID_JUSTIFY_RIGHT = _core_.ID_JUSTIFY_RIGHT
269ID_JUSTIFY_LEFT = _core_.ID_JUSTIFY_LEFT
270ID_UNDERLINE = _core_.ID_UNDERLINE
271ID_INDENT = _core_.ID_INDENT
272ID_UNINDENT = _core_.ID_UNINDENT
273ID_ZOOM_100 = _core_.ID_ZOOM_100
274ID_ZOOM_FIT = _core_.ID_ZOOM_FIT
275ID_ZOOM_IN = _core_.ID_ZOOM_IN
276ID_ZOOM_OUT = _core_.ID_ZOOM_OUT
277ID_UNDELETE = _core_.ID_UNDELETE
278ID_REVERT_TO_SAVED = _core_.ID_REVERT_TO_SAVED
279ID_HIGHEST = _core_.ID_HIGHEST
5b5c9bc7
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
346BG_STYLE_SYSTEM = _core_.BG_STYLE_SYSTEM
347BG_STYLE_COLOUR = _core_.BG_STYLE_COLOUR
348BG_STYLE_CUSTOM = _core_.BG_STYLE_CUSTOM
349DEFAULT = _core_.DEFAULT
350DECORATIVE = _core_.DECORATIVE
351ROMAN = _core_.ROMAN
352SCRIPT = _core_.SCRIPT
353SWISS = _core_.SWISS
354MODERN = _core_.MODERN
355TELETYPE = _core_.TELETYPE
356VARIABLE = _core_.VARIABLE
357FIXED = _core_.FIXED
358NORMAL = _core_.NORMAL
359LIGHT = _core_.LIGHT
360BOLD = _core_.BOLD
361ITALIC = _core_.ITALIC
362SLANT = _core_.SLANT
363SOLID = _core_.SOLID
364DOT = _core_.DOT
365LONG_DASH = _core_.LONG_DASH
366SHORT_DASH = _core_.SHORT_DASH
367DOT_DASH = _core_.DOT_DASH
368USER_DASH = _core_.USER_DASH
369TRANSPARENT = _core_.TRANSPARENT
370STIPPLE = _core_.STIPPLE
d04418a7
RD		 371STIPPLE_MASK = _core_.STIPPLE_MASK
372STIPPLE_MASK_OPAQUE = _core_.STIPPLE_MASK_OPAQUE
5b5c9bc7
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
507WXK_COMMAND = _core_.WXK_COMMAND
508WXK_SPECIAL1 = _core_.WXK_SPECIAL1
509WXK_SPECIAL2 = _core_.WXK_SPECIAL2
510WXK_SPECIAL3 = _core_.WXK_SPECIAL3
511WXK_SPECIAL4 = _core_.WXK_SPECIAL4
512WXK_SPECIAL5 = _core_.WXK_SPECIAL5
513WXK_SPECIAL6 = _core_.WXK_SPECIAL6
514WXK_SPECIAL7 = _core_.WXK_SPECIAL7
515WXK_SPECIAL8 = _core_.WXK_SPECIAL8
516WXK_SPECIAL9 = _core_.WXK_SPECIAL9
517WXK_SPECIAL10 = _core_.WXK_SPECIAL10
518WXK_SPECIAL11 = _core_.WXK_SPECIAL11
519WXK_SPECIAL12 = _core_.WXK_SPECIAL12
520WXK_SPECIAL13 = _core_.WXK_SPECIAL13
521WXK_SPECIAL14 = _core_.WXK_SPECIAL14
522WXK_SPECIAL15 = _core_.WXK_SPECIAL15
523WXK_SPECIAL16 = _core_.WXK_SPECIAL16
524WXK_SPECIAL17 = _core_.WXK_SPECIAL17
525WXK_SPECIAL18 = _core_.WXK_SPECIAL18
526WXK_SPECIAL19 = _core_.WXK_SPECIAL19
527WXK_SPECIAL20 = _core_.WXK_SPECIAL20
528PAPER_NONE = _core_.PAPER_NONE
529PAPER_LETTER = _core_.PAPER_LETTER
530PAPER_LEGAL = _core_.PAPER_LEGAL
531PAPER_A4 = _core_.PAPER_A4
532PAPER_CSHEET = _core_.PAPER_CSHEET
533PAPER_DSHEET = _core_.PAPER_DSHEET
534PAPER_ESHEET = _core_.PAPER_ESHEET
535PAPER_LETTERSMALL = _core_.PAPER_LETTERSMALL
536PAPER_TABLOID = _core_.PAPER_TABLOID
537PAPER_LEDGER = _core_.PAPER_LEDGER
538PAPER_STATEMENT = _core_.PAPER_STATEMENT
539PAPER_EXECUTIVE = _core_.PAPER_EXECUTIVE
540PAPER_A3 = _core_.PAPER_A3
541PAPER_A4SMALL = _core_.PAPER_A4SMALL
542PAPER_A5 = _core_.PAPER_A5
543PAPER_B4 = _core_.PAPER_B4
544PAPER_B5 = _core_.PAPER_B5
545PAPER_FOLIO = _core_.PAPER_FOLIO
546PAPER_QUARTO = _core_.PAPER_QUARTO
547PAPER_10X14 = _core_.PAPER_10X14
548PAPER_11X17 = _core_.PAPER_11X17
549PAPER_NOTE = _core_.PAPER_NOTE
550PAPER_ENV_9 = _core_.PAPER_ENV_9
551PAPER_ENV_10 = _core_.PAPER_ENV_10
552PAPER_ENV_11 = _core_.PAPER_ENV_11
553PAPER_ENV_12 = _core_.PAPER_ENV_12
554PAPER_ENV_14 = _core_.PAPER_ENV_14
555PAPER_ENV_DL = _core_.PAPER_ENV_DL
556PAPER_ENV_C5 = _core_.PAPER_ENV_C5
557PAPER_ENV_C3 = _core_.PAPER_ENV_C3
558PAPER_ENV_C4 = _core_.PAPER_ENV_C4
559PAPER_ENV_C6 = _core_.PAPER_ENV_C6
560PAPER_ENV_C65 = _core_.PAPER_ENV_C65
561PAPER_ENV_B4 = _core_.PAPER_ENV_B4
562PAPER_ENV_B5 = _core_.PAPER_ENV_B5
563PAPER_ENV_B6 = _core_.PAPER_ENV_B6
564PAPER_ENV_ITALY = _core_.PAPER_ENV_ITALY
565PAPER_ENV_MONARCH = _core_.PAPER_ENV_MONARCH
566PAPER_ENV_PERSONAL = _core_.PAPER_ENV_PERSONAL
567PAPER_FANFOLD_US = _core_.PAPER_FANFOLD_US
568PAPER_FANFOLD_STD_GERMAN = _core_.PAPER_FANFOLD_STD_GERMAN
569PAPER_FANFOLD_LGL_GERMAN = _core_.PAPER_FANFOLD_LGL_GERMAN
570PAPER_ISO_B4 = _core_.PAPER_ISO_B4
571PAPER_JAPANESE_POSTCARD = _core_.PAPER_JAPANESE_POSTCARD
572PAPER_9X11 = _core_.PAPER_9X11
573PAPER_10X11 = _core_.PAPER_10X11
574PAPER_15X11 = _core_.PAPER_15X11
575PAPER_ENV_INVITE = _core_.PAPER_ENV_INVITE
576PAPER_LETTER_EXTRA = _core_.PAPER_LETTER_EXTRA
577PAPER_LEGAL_EXTRA = _core_.PAPER_LEGAL_EXTRA
578PAPER_TABLOID_EXTRA = _core_.PAPER_TABLOID_EXTRA
579PAPER_A4_EXTRA = _core_.PAPER_A4_EXTRA
580PAPER_LETTER_TRANSVERSE = _core_.PAPER_LETTER_TRANSVERSE
581PAPER_A4_TRANSVERSE = _core_.PAPER_A4_TRANSVERSE
582PAPER_LETTER_EXTRA_TRANSVERSE = _core_.PAPER_LETTER_EXTRA_TRANSVERSE
583PAPER_A_PLUS = _core_.PAPER_A_PLUS
584PAPER_B_PLUS = _core_.PAPER_B_PLUS
585PAPER_LETTER_PLUS = _core_.PAPER_LETTER_PLUS
586PAPER_A4_PLUS = _core_.PAPER_A4_PLUS
587PAPER_A5_TRANSVERSE = _core_.PAPER_A5_TRANSVERSE
588PAPER_B5_TRANSVERSE = _core_.PAPER_B5_TRANSVERSE
589PAPER_A3_EXTRA = _core_.PAPER_A3_EXTRA
590PAPER_A5_EXTRA = _core_.PAPER_A5_EXTRA
591PAPER_B5_EXTRA = _core_.PAPER_B5_EXTRA
592PAPER_A2 = _core_.PAPER_A2
593PAPER_A3_TRANSVERSE = _core_.PAPER_A3_TRANSVERSE
594PAPER_A3_EXTRA_TRANSVERSE = _core_.PAPER_A3_EXTRA_TRANSVERSE
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
5b5c9bc7
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
943e8dfd 672MOD_ALTGR = _core_.MOD_ALTGR
5b5c9bc7 673MOD_SHIFT = _core_.MOD_SHIFT
943e8dfd 674MOD_META = _core_.MOD_META
5b5c9bc7 675MOD_WIN = _core_.MOD_WIN
943e8dfd
RD		 676MOD_CMD = _core_.MOD_CMD
677MOD_ALL = _core_.MOD_ALL
5b5c9bc7
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
5b5c9bc7 686class Object(object):
d55e5bfc
RD		 687 """
688 The base class for most wx objects, although in wxPython not
689 much functionality is needed nor exposed.
690 """
1bd55598
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 """
5b5c9bc7 696 GetClassName(self) -> String
d55e5bfc
RD		 697
698 Returns the class name of the C++ class using wxRTTI.
699 """
5b5c9bc7 700 return _core_.Object_GetClassName(*args, **kwargs)
d55e5bfc
RD		 701
702 def Destroy(*args, **kwargs):
703 """
704 Destroy(self)
705
706 Deletes the C++ object this Python object is a proxy for.
707 """
b39fe951
RD		 708 args[0].this.own(False)
709 return _core_.Object_Destroy(*args, **kwargs)
d55e5bfc 710
8f514ab4
RD		 711 def IsSameAs(*args, **kwargs):
712 """
713 IsSameAs(self, Object p) -> bool
714
715 For wx.Objects that use C++ reference counting internally, this method
716 can be used to determine if two objects are referencing the same data
717 object.
718 """
719 return _core_.Object_IsSameAs(*args, **kwargs)
720
33d6fd3b 721 ClassName = property(GetClassName,doc="See `GetClassName`")
2131d850 722_core_.Object_swigregister(Object)
5b5c9bc7 723_wxPySetDictionary = _core_._wxPySetDictionary
5b5c9bc7 724cvar = _core_.cvar
d55e5bfc
RD		 725EmptyString = cvar.EmptyString
726
727#---------------------------------------------------------------------------
728
5b5c9bc7
RD		 729BITMAP_TYPE_INVALID = _core_.BITMAP_TYPE_INVALID
730BITMAP_TYPE_BMP = _core_.BITMAP_TYPE_BMP
731BITMAP_TYPE_ICO = _core_.BITMAP_TYPE_ICO
732BITMAP_TYPE_CUR = _core_.BITMAP_TYPE_CUR
733BITMAP_TYPE_XBM = _core_.BITMAP_TYPE_XBM
734BITMAP_TYPE_XBM_DATA = _core_.BITMAP_TYPE_XBM_DATA
735BITMAP_TYPE_XPM = _core_.BITMAP_TYPE_XPM
736BITMAP_TYPE_XPM_DATA = _core_.BITMAP_TYPE_XPM_DATA
737BITMAP_TYPE_TIF = _core_.BITMAP_TYPE_TIF
738BITMAP_TYPE_GIF = _core_.BITMAP_TYPE_GIF
739BITMAP_TYPE_PNG = _core_.BITMAP_TYPE_PNG
740BITMAP_TYPE_JPEG = _core_.BITMAP_TYPE_JPEG
741BITMAP_TYPE_PNM = _core_.BITMAP_TYPE_PNM
742BITMAP_TYPE_PCX = _core_.BITMAP_TYPE_PCX
743BITMAP_TYPE_PICT = _core_.BITMAP_TYPE_PICT
744BITMAP_TYPE_ICON = _core_.BITMAP_TYPE_ICON
745BITMAP_TYPE_ANI = _core_.BITMAP_TYPE_ANI
746BITMAP_TYPE_IFF = _core_.BITMAP_TYPE_IFF
8f514ab4 747BITMAP_TYPE_TGA = _core_.BITMAP_TYPE_TGA
5b5c9bc7
RD		 748BITMAP_TYPE_MACCURSOR = _core_.BITMAP_TYPE_MACCURSOR
749BITMAP_TYPE_ANY = _core_.BITMAP_TYPE_ANY
750CURSOR_NONE = _core_.CURSOR_NONE
751CURSOR_ARROW = _core_.CURSOR_ARROW
752CURSOR_RIGHT_ARROW = _core_.CURSOR_RIGHT_ARROW
753CURSOR_BULLSEYE = _core_.CURSOR_BULLSEYE
754CURSOR_CHAR = _core_.CURSOR_CHAR
755CURSOR_CROSS = _core_.CURSOR_CROSS
756CURSOR_HAND = _core_.CURSOR_HAND
757CURSOR_IBEAM = _core_.CURSOR_IBEAM
758CURSOR_LEFT_BUTTON = _core_.CURSOR_LEFT_BUTTON
759CURSOR_MAGNIFIER = _core_.CURSOR_MAGNIFIER
760CURSOR_MIDDLE_BUTTON = _core_.CURSOR_MIDDLE_BUTTON
761CURSOR_NO_ENTRY = _core_.CURSOR_NO_ENTRY
762CURSOR_PAINT_BRUSH = _core_.CURSOR_PAINT_BRUSH
763CURSOR_PENCIL = _core_.CURSOR_PENCIL
764CURSOR_POINT_LEFT = _core_.CURSOR_POINT_LEFT
765CURSOR_POINT_RIGHT = _core_.CURSOR_POINT_RIGHT
766CURSOR_QUESTION_ARROW = _core_.CURSOR_QUESTION_ARROW
767CURSOR_RIGHT_BUTTON = _core_.CURSOR_RIGHT_BUTTON
768CURSOR_SIZENESW = _core_.CURSOR_SIZENESW
769CURSOR_SIZENS = _core_.CURSOR_SIZENS
770CURSOR_SIZENWSE = _core_.CURSOR_SIZENWSE
771CURSOR_SIZEWE = _core_.CURSOR_SIZEWE
772CURSOR_SIZING = _core_.CURSOR_SIZING
773CURSOR_SPRAYCAN = _core_.CURSOR_SPRAYCAN
774CURSOR_WAIT = _core_.CURSOR_WAIT
775CURSOR_WATCH = _core_.CURSOR_WATCH
776CURSOR_BLANK = _core_.CURSOR_BLANK
777CURSOR_DEFAULT = _core_.CURSOR_DEFAULT
778CURSOR_COPY_ARROW = _core_.CURSOR_COPY_ARROW
779CURSOR_ARROWWAIT = _core_.CURSOR_ARROWWAIT
780CURSOR_MAX = _core_.CURSOR_MAX
d55e5bfc
RD		 781#---------------------------------------------------------------------------
782
5b5c9bc7 783class Size(object):
d55e5bfc 784 """
15817c7e 785 wx.Size is a useful data structure used to represent the size of
1bd55598
RD		 786 something. It simply contains integer width and height
787 properties. In most places in wxPython where a wx.Size is
36ed4f51 788 expected a (width, height) tuple can be used instead.
d55e5bfc 789 """
1bd55598
RD		 790 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
791 __repr__ = _swig_repr
5b5c9bc7
RD		 792 width = property(_core_.Size_width_get, _core_.Size_width_set)
793 height = property(_core_.Size_height_get, _core_.Size_height_set)
d55e5bfc 794 x = width; y = height
1bd55598 795 def __init__(self, *args, **kwargs):
d55e5bfc 796 """
5b5c9bc7 797 __init__(self, int w=0, int h=0) -> Size
d55e5bfc
RD		 798
799 Creates a size object.
800 """
1bd55598
RD		 801 _core_.Size_swiginit(self,_core_.new_Size(*args, **kwargs))
802 __swig_destroy__ = _core_.delete_Size
803 __del__ = lambda self : None;
d55e5bfc
RD		 804 def __eq__(*args, **kwargs):
805 """
e9d6f3a4 806 __eq__(self, PyObject other) -> bool
d55e5bfc
RD		 807
808 Test for equality of wx.Size objects.
809 """
5b5c9bc7 810 return _core_.Size___eq__(*args, **kwargs)
d55e5bfc
RD		 811
812 def __ne__(*args, **kwargs):
813 """
e9d6f3a4 814 __ne__(self, PyObject other) -> bool
d55e5bfc 815
e9d6f3a4 816 Test for inequality of wx.Size objects.
d55e5bfc 817 """
5b5c9bc7 818 return _core_.Size___ne__(*args, **kwargs)
d55e5bfc
RD		 819
820 def __add__(*args, **kwargs):
821 """
5b5c9bc7 822 __add__(self, Size sz) -> Size
d55e5bfc
RD		 823
824 Add sz's proprties to this and return the result.
825 """
5b5c9bc7 826 return _core_.Size___add__(*args, **kwargs)
d55e5bfc
RD		 827
828 def __sub__(*args, **kwargs):
829 """
5b5c9bc7 830 __sub__(self, Size sz) -> Size
d55e5bfc
RD		 831
832 Subtract sz's properties from this and return the result.
833 """
5b5c9bc7 834 return _core_.Size___sub__(*args, **kwargs)
d55e5bfc
RD		 835
836 def IncTo(*args, **kwargs):
837 """
5b5c9bc7 838 IncTo(self, Size sz)
d55e5bfc
RD		 839
840 Increments this object so that both of its dimensions are not less
841 than the corresponding dimensions of the size.
842 """
5b5c9bc7 843 return _core_.Size_IncTo(*args, **kwargs)
d55e5bfc
RD		 844
845 def DecTo(*args, **kwargs):
846 """
5b5c9bc7 847 DecTo(self, Size sz)
d55e5bfc
RD		 848
849 Decrements this object so that both of its dimensions are not greater
850 than the corresponding dimensions of the size.
851 """
5b5c9bc7 852 return _core_.Size_DecTo(*args, **kwargs)
d55e5bfc 853
f5263701
RD		 854 def IncBy(*args, **kwargs):
855 """IncBy(self, int dx, int dy)"""
856 return _core_.Size_IncBy(*args, **kwargs)
857
858 def DecBy(*args, **kwargs):
859 """DecBy(self, int dx, int dy)"""
860 return _core_.Size_DecBy(*args, **kwargs)
861
1eeb270e
RD		 862 def Scale(*args, **kwargs):
863 """
864 Scale(self, float xscale, float yscale)
865
866 Scales the dimensions of this object by the given factors.
867 """
868 return _core_.Size_Scale(*args, **kwargs)
869
d55e5bfc
RD		 870 def Set(*args, **kwargs):
871 """
872 Set(self, int w, int h)
873
874 Set both width and height.
875 """
5b5c9bc7 876 return _core_.Size_Set(*args, **kwargs)
d55e5bfc
RD		 877
878 def SetWidth(*args, **kwargs):
879 """SetWidth(self, int w)"""
5b5c9bc7 880 return _core_.Size_SetWidth(*args, **kwargs)
d55e5bfc
RD		 881
882 def SetHeight(*args, **kwargs):
883 """SetHeight(self, int h)"""
5b5c9bc7 884 return _core_.Size_SetHeight(*args, **kwargs)
d55e5bfc
RD		 885
886 def GetWidth(*args, **kwargs):
887 """GetWidth(self) -> int"""
5b5c9bc7 888 return _core_.Size_GetWidth(*args, **kwargs)
d55e5bfc
RD		 889
890 def GetHeight(*args, **kwargs):
891 """GetHeight(self) -> int"""
5b5c9bc7 892 return _core_.Size_GetHeight(*args, **kwargs)
d55e5bfc
RD		 893
894 def IsFullySpecified(*args, **kwargs):
895 """
896 IsFullySpecified(self) -> bool
897
898 Returns True if both components of the size are non-default values.
899 """
5b5c9bc7 900 return _core_.Size_IsFullySpecified(*args, **kwargs)
d55e5bfc
RD		 901
902 def SetDefaults(*args, **kwargs):
903 """
5b5c9bc7 904 SetDefaults(self, Size size)
d55e5bfc 905
15817c7e
RD		 906 Combine this size with the other one replacing the default components
907 of this object (i.e. equal to -1) with those of the other.
d55e5bfc 908 """
5b5c9bc7 909 return _core_.Size_SetDefaults(*args, **kwargs)
d55e5bfc
RD		 910
911 def Get(*args, **kwargs):
912 """
913 Get() -> (width,height)
914
915 Returns the width and height properties as a tuple.
916 """
5b5c9bc7 917 return _core_.Size_Get(*args, **kwargs)
d55e5bfc 918
15817c7e 919 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD		 920 def __str__(self): return str(self.Get())
921 def __repr__(self): return 'wx.Size'+str(self.Get())
922 def __len__(self): return len(self.Get())
923 def __getitem__(self, index): return self.Get()[index]
924 def __setitem__(self, index, val):
925 if index == 0: self.width = val
926 elif index == 1: self.height = val
927 else: raise IndexError
928 def __nonzero__(self): return self.Get() != (0,0)
929 __safe_for_unpickling__ = True
930 def __reduce__(self): return (wx.Size, self.Get())
931
2131d850 932_core_.Size_swigregister(Size)
d55e5bfc
RD		 933
934#---------------------------------------------------------------------------
935
5b5c9bc7 936class RealPoint(object):
d55e5bfc 937 """
15817c7e
RD		 938 A data structure for representing a point or position with floating
939 point x and y properties. In wxPython most places that expect a
940 wx.RealPoint can also accept a (x,y) tuple.
d55e5bfc 941 """
1bd55598
RD		 942 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
943 __repr__ = _swig_repr
5b5c9bc7
RD		 944 x = property(_core_.RealPoint_x_get, _core_.RealPoint_x_set)
945 y = property(_core_.RealPoint_y_get, _core_.RealPoint_y_set)
1bd55598 946 def __init__(self, *args, **kwargs):
d55e5bfc 947 """
5b5c9bc7 948 __init__(self, double x=0.0, double y=0.0) -> RealPoint
d55e5bfc
RD		 949
950 Create a wx.RealPoint object
951 """
1bd55598
RD		 952 _core_.RealPoint_swiginit(self,_core_.new_RealPoint(*args, **kwargs))
953 __swig_destroy__ = _core_.delete_RealPoint
954 __del__ = lambda self : None;
d55e5bfc
RD		 955 def __eq__(*args, **kwargs):
956 """
e9d6f3a4 957 __eq__(self, PyObject other) -> bool
d55e5bfc
RD		 958
959 Test for equality of wx.RealPoint objects.
960 """
5b5c9bc7 961 return _core_.RealPoint___eq__(*args, **kwargs)
d55e5bfc
RD		 962
963 def __ne__(*args, **kwargs):
964 """
e9d6f3a4 965 __ne__(self, PyObject other) -> bool
d55e5bfc
RD		 966
967 Test for inequality of wx.RealPoint objects.
968 """
5b5c9bc7 969 return _core_.RealPoint___ne__(*args, **kwargs)
d55e5bfc
RD		 970
971 def __add__(*args, **kwargs):
972 """
5b5c9bc7 973 __add__(self, RealPoint pt) -> RealPoint
d55e5bfc
RD		 974
975 Add pt's proprties to this and return the result.
976 """
5b5c9bc7 977 return _core_.RealPoint___add__(*args, **kwargs)
d55e5bfc
RD		 978
979 def __sub__(*args, **kwargs):
980 """
5b5c9bc7 981 __sub__(self, RealPoint pt) -> RealPoint
d55e5bfc
RD		 982
983 Subtract pt's proprties from this and return the result
984 """
5b5c9bc7 985 return _core_.RealPoint___sub__(*args, **kwargs)
d55e5bfc
RD		 986
987 def Set(*args, **kwargs):
988 """
989 Set(self, double x, double y)
990
991 Set both the x and y properties
992 """
5b5c9bc7 993 return _core_.RealPoint_Set(*args, **kwargs)
d55e5bfc
RD		 994
995 def Get(*args, **kwargs):
996 """
997 Get() -> (x,y)
998
999 Return the x and y properties as a tuple.
1000 """
5b5c9bc7 1001 return _core_.RealPoint_Get(*args, **kwargs)
d55e5bfc 1002
15817c7e 1003 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD		 1004 def __str__(self): return str(self.Get())
1005 def __repr__(self): return 'wx.RealPoint'+str(self.Get())
1006 def __len__(self): return len(self.Get())
1007 def __getitem__(self, index): return self.Get()[index]
1008 def __setitem__(self, index, val):
1009 if index == 0: self.x = val
1010 elif index == 1: self.y = val
1011 else: raise IndexError
1012 def __nonzero__(self): return self.Get() != (0.0, 0.0)
1013 __safe_for_unpickling__ = True
1014 def __reduce__(self): return (wx.RealPoint, self.Get())
1015
2131d850 1016_core_.RealPoint_swigregister(RealPoint)
d55e5bfc
RD		 1017
1018#---------------------------------------------------------------------------
1019
5b5c9bc7 1020class Point(object):
d55e5bfc 1021 """
15817c7e
RD		 1022 A data structure for representing a point or position with integer x
1023 and y properties. Most places in wxPython that expect a wx.Point can
1024 also accept a (x,y) tuple.
d55e5bfc 1025 """
1bd55598
RD		 1026 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1027 __repr__ = _swig_repr
5b5c9bc7
RD		 1028 x = property(_core_.Point_x_get, _core_.Point_x_set)
1029 y = property(_core_.Point_y_get, _core_.Point_y_set)
1bd55598 1030 def __init__(self, *args, **kwargs):
d55e5bfc 1031 """
5b5c9bc7 1032 __init__(self, int x=0, int y=0) -> Point
d55e5bfc
RD		 1033
1034 Create a wx.Point object
1035 """
1bd55598
RD		 1036 _core_.Point_swiginit(self,_core_.new_Point(*args, **kwargs))
1037 __swig_destroy__ = _core_.delete_Point
1038 __del__ = lambda self : None;
d55e5bfc
RD		 1039 def __eq__(*args, **kwargs):
1040 """
e9d6f3a4 1041 __eq__(self, PyObject other) -> bool
d55e5bfc
RD		 1042
1043 Test for equality of wx.Point objects.
1044 """
5b5c9bc7 1045 return _core_.Point___eq__(*args, **kwargs)
d55e5bfc
RD		 1046
1047 def __ne__(*args, **kwargs):
1048 """
e9d6f3a4 1049 __ne__(self, PyObject other) -> bool
d55e5bfc
RD		 1050
1051 Test for inequality of wx.Point objects.
1052 """
5b5c9bc7 1053 return _core_.Point___ne__(*args, **kwargs)
d55e5bfc
RD		 1054
1055 def __add__(*args, **kwargs):
1056 """
5b5c9bc7 1057 __add__(self, Point pt) -> Point
d55e5bfc
RD		 1058
1059 Add pt's proprties to this and return the result.
1060 """
5b5c9bc7 1061 return _core_.Point___add__(*args, **kwargs)
d55e5bfc
RD		 1062
1063 def __sub__(*args, **kwargs):
1064 """
5b5c9bc7 1065 __sub__(self, Point pt) -> Point
d55e5bfc
RD		 1066
1067 Subtract pt's proprties from this and return the result
1068 """
5b5c9bc7 1069 return _core_.Point___sub__(*args, **kwargs)
d55e5bfc
RD		 1070
1071 def __iadd__(*args, **kwargs):
1072 """
5b5c9bc7 1073 __iadd__(self, Point pt) -> Point
d55e5bfc
RD		 1074
1075 Add pt to this object.
1076 """
5b5c9bc7 1077 return _core_.Point___iadd__(*args, **kwargs)
d55e5bfc
RD		 1078
1079 def __isub__(*args, **kwargs):
1080 """
5b5c9bc7 1081 __isub__(self, Point pt) -> Point
d55e5bfc
RD		 1082
1083 Subtract pt from this object.
1084 """
5b5c9bc7 1085 return _core_.Point___isub__(*args, **kwargs)
d55e5bfc
RD		 1086
1087 def Set(*args, **kwargs):
1088 """
1089 Set(self, long x, long y)
1090
1091 Set both the x and y properties
1092 """
5b5c9bc7 1093 return _core_.Point_Set(*args, **kwargs)
d55e5bfc
RD		 1094
1095 def Get(*args, **kwargs):
1096 """
1097 Get() -> (x,y)
1098
1099 Return the x and y properties as a tuple.
1100 """
5b5c9bc7 1101 return _core_.Point_Get(*args, **kwargs)
d55e5bfc 1102
15817c7e 1103 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD		 1104 def __str__(self): return str(self.Get())
1105 def __repr__(self): return 'wx.Point'+str(self.Get())
1106 def __len__(self): return len(self.Get())
1107 def __getitem__(self, index): return self.Get()[index]
1108 def __setitem__(self, index, val):
1109 if index == 0: self.x = val
1110 elif index == 1: self.y = val
1111 else: raise IndexError
1112 def __nonzero__(self): return self.Get() != (0,0)
1113 __safe_for_unpickling__ = True
1114 def __reduce__(self): return (wx.Point, self.Get())
1115
2131d850 1116_core_.Point_swigregister(Point)
d55e5bfc
RD		 1117
1118#---------------------------------------------------------------------------
1119
5b5c9bc7 1120class Rect(object):
d55e5bfc 1121 """
15817c7e
RD		 1122 A class for representing and manipulating rectangles. It has x, y,
1123 width and height properties. In wxPython most palces that expect a
1124 wx.Rect can also accept a (x,y,width,height) tuple.
d55e5bfc 1125 """
1bd55598
RD		 1126 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1127 __repr__ = _swig_repr
1128 def __init__(self, *args, **kwargs):
d55e5bfc 1129 """
5b5c9bc7 1130 __init__(self, int x=0, int y=0, int width=0, int height=0) -> Rect
d55e5bfc
RD		 1131
1132 Create a new Rect object.
1133 """
1bd55598
RD		 1134 _core_.Rect_swiginit(self,_core_.new_Rect(*args, **kwargs))
1135 __swig_destroy__ = _core_.delete_Rect
1136 __del__ = lambda self : None;
d55e5bfc
RD		 1137 def GetX(*args, **kwargs):
1138 """GetX(self) -> int"""
5b5c9bc7 1139 return _core_.Rect_GetX(*args, **kwargs)
d55e5bfc
RD		 1140
1141 def SetX(*args, **kwargs):
1142 """SetX(self, int x)"""
5b5c9bc7 1143 return _core_.Rect_SetX(*args, **kwargs)
d55e5bfc
RD		 1144
1145 def GetY(*args, **kwargs):
1146 """GetY(self) -> int"""
5b5c9bc7 1147 return _core_.Rect_GetY(*args, **kwargs)
d55e5bfc
RD		 1148
1149 def SetY(*args, **kwargs):
1150 """SetY(self, int y)"""
5b5c9bc7 1151 return _core_.Rect_SetY(*args, **kwargs)
d55e5bfc
RD		 1152
1153 def GetWidth(*args, **kwargs):
1154 """GetWidth(self) -> int"""
5b5c9bc7 1155 return _core_.Rect_GetWidth(*args, **kwargs)
d55e5bfc
RD		 1156
1157 def SetWidth(*args, **kwargs):
1158 """SetWidth(self, int w)"""
5b5c9bc7 1159 return _core_.Rect_SetWidth(*args, **kwargs)
d55e5bfc
RD		 1160
1161 def GetHeight(*args, **kwargs):
1162 """GetHeight(self) -> int"""
5b5c9bc7 1163 return _core_.Rect_GetHeight(*args, **kwargs)
d55e5bfc
RD		 1164
1165 def SetHeight(*args, **kwargs):
1166 """SetHeight(self, int h)"""
5b5c9bc7 1167 return _core_.Rect_SetHeight(*args, **kwargs)
d55e5bfc
RD		 1168
1169 def GetPosition(*args, **kwargs):
5b5c9bc7
RD		 1170 """GetPosition(self) -> Point"""
1171 return _core_.Rect_GetPosition(*args, **kwargs)
d55e5bfc
RD		 1172
1173 def SetPosition(*args, **kwargs):
5b5c9bc7
RD		 1174 """SetPosition(self, Point p)"""
1175 return _core_.Rect_SetPosition(*args, **kwargs)
d55e5bfc
RD		 1176
1177 def GetSize(*args, **kwargs):
5b5c9bc7
RD		 1178 """GetSize(self) -> Size"""
1179 return _core_.Rect_GetSize(*args, **kwargs)
d55e5bfc
RD		 1180
1181 def SetSize(*args, **kwargs):
5b5c9bc7
RD		 1182 """SetSize(self, Size s)"""
1183 return _core_.Rect_SetSize(*args, **kwargs)
d55e5bfc 1184
aff4cc5c
RD		 1185 def IsEmpty(*args, **kwargs):
1186 """IsEmpty(self) -> bool"""
5b5c9bc7 1187 return _core_.Rect_IsEmpty(*args, **kwargs)
aff4cc5c 1188
d55e5bfc 1189 def GetTopLeft(*args, **kwargs):
5b5c9bc7
RD		 1190 """GetTopLeft(self) -> Point"""
1191 return _core_.Rect_GetTopLeft(*args, **kwargs)
d55e5bfc
RD		 1192
1193 def SetTopLeft(*args, **kwargs):
5b5c9bc7
RD		 1194 """SetTopLeft(self, Point p)"""
1195 return _core_.Rect_SetTopLeft(*args, **kwargs)
d55e5bfc
RD		 1196
1197 def GetBottomRight(*args, **kwargs):
5b5c9bc7
RD		 1198 """GetBottomRight(self) -> Point"""
1199 return _core_.Rect_GetBottomRight(*args, **kwargs)
d55e5bfc
RD		 1200
1201 def SetBottomRight(*args, **kwargs):
5b5c9bc7
RD		 1202 """SetBottomRight(self, Point p)"""
1203 return _core_.Rect_SetBottomRight(*args, **kwargs)
d55e5bfc 1204
5acb46e0
RD		 1205 def GetTopRight(*args, **kwargs):
1206 """GetTopRight(self) -> Point"""
1207 return _core_.Rect_GetTopRight(*args, **kwargs)
1208
1209 def SetTopRight(*args, **kwargs):
1210 """SetTopRight(self, Point p)"""
1211 return _core_.Rect_SetTopRight(*args, **kwargs)
1212
1213 def GetBottomLeft(*args, **kwargs):
1214 """GetBottomLeft(self) -> Point"""
1215 return _core_.Rect_GetBottomLeft(*args, **kwargs)
1216
1217 def SetBottomLeft(*args, **kwargs):
1218 """SetBottomLeft(self, Point p)"""
1219 return _core_.Rect_SetBottomLeft(*args, **kwargs)
1220
d55e5bfc
RD		 1221 def GetLeft(*args, **kwargs):
1222 """GetLeft(self) -> int"""
5b5c9bc7 1223 return _core_.Rect_GetLeft(*args, **kwargs)
d55e5bfc
RD		 1224
1225 def GetTop(*args, **kwargs):
1226 """GetTop(self) -> int"""
5b5c9bc7 1227 return _core_.Rect_GetTop(*args, **kwargs)
d55e5bfc
RD		 1228
1229 def GetBottom(*args, **kwargs):
1230 """GetBottom(self) -> int"""
5b5c9bc7 1231 return _core_.Rect_GetBottom(*args, **kwargs)
d55e5bfc
RD		 1232
1233 def GetRight(*args, **kwargs):
1234 """GetRight(self) -> int"""
5b5c9bc7 1235 return _core_.Rect_GetRight(*args, **kwargs)
d55e5bfc
RD		 1236
1237 def SetLeft(*args, **kwargs):
1238 """SetLeft(self, int left)"""
5b5c9bc7 1239 return _core_.Rect_SetLeft(*args, **kwargs)
d55e5bfc
RD		 1240
1241 def SetRight(*args, **kwargs):
1242 """SetRight(self, int right)"""
5b5c9bc7 1243 return _core_.Rect_SetRight(*args, **kwargs)
d55e5bfc
RD		 1244
1245 def SetTop(*args, **kwargs):
1246 """SetTop(self, int top)"""
5b5c9bc7 1247 return _core_.Rect_SetTop(*args, **kwargs)
d55e5bfc
RD		 1248
1249 def SetBottom(*args, **kwargs):
1250 """SetBottom(self, int bottom)"""
5b5c9bc7 1251 return _core_.Rect_SetBottom(*args, **kwargs)
d55e5bfc
RD		 1252
1253 position = property(GetPosition, SetPosition)
1254 size = property(GetSize, SetSize)
1255 left = property(GetLeft, SetLeft)
1256 right = property(GetRight, SetRight)
1257 top = property(GetTop, SetTop)
1258 bottom = property(GetBottom, SetBottom)
1259
1260 def Inflate(*args, **kwargs):
1261 """
5b5c9bc7 1262 Inflate(self, int dx, int dy) -> Rect
d55e5bfc 1263
091fdbfa
RD		 1264 Increases the size of the rectangle.
1265
1266 The left border is moved farther left and the right border is moved
1267 farther right by ``dx``. The upper border is moved farther up and the
1268 bottom border is moved farther down by ``dy``. (Note the the width and
1269 height of the rectangle thus change by ``2*dx`` and ``2*dy``,
1270 respectively.) If one or both of ``dx`` and ``dy`` are negative, the
1271 opposite happens: the rectangle size decreases in the respective
1272 direction.
1273
1274 The change is made to the rectangle inplace, if instead you need a
1275 copy that is inflated, preserving the original then make the copy
1276 first::
1277
1278 copy = wx.Rect(*original)
1279 copy.Inflate(10,15)
1280
1281
d55e5bfc 1282 """
5b5c9bc7 1283 return _core_.Rect_Inflate(*args, **kwargs)
d55e5bfc
RD		 1284
1285 def Deflate(*args, **kwargs):
1286 """
5b5c9bc7 1287 Deflate(self, int dx, int dy) -> Rect
d55e5bfc 1288
091fdbfa
RD		 1289 Decrease the rectangle size. This method is the opposite of `Inflate`
1290 in that Deflate(a,b) is equivalent to Inflate(-a,-b). Please refer to
1291 `Inflate` for a full description.
d55e5bfc 1292 """
5b5c9bc7 1293 return _core_.Rect_Deflate(*args, **kwargs)
d55e5bfc
RD		 1294
1295 def OffsetXY(*args, **kwargs):
1296 """
1297 OffsetXY(self, int dx, int dy)
1298
15817c7e
RD		 1299 Moves the rectangle by the specified offset. If dx is positive, the
1300 rectangle is moved to the right, if dy is positive, it is moved to the
1301 bottom, otherwise it is moved to the left or top respectively.
d55e5bfc 1302 """
5b5c9bc7 1303 return _core_.Rect_OffsetXY(*args, **kwargs)
d55e5bfc
RD		 1304
1305 def Offset(*args, **kwargs):
1306 """
5b5c9bc7 1307 Offset(self, Point pt)
d55e5bfc 1308
b1fcee84 1309 Same as `OffsetXY` but uses dx,dy from Point
d55e5bfc 1310 """
5b5c9bc7 1311 return _core_.Rect_Offset(*args, **kwargs)
d55e5bfc
RD		 1312
1313 def Intersect(*args, **kwargs):
1314 """
5b5c9bc7 1315 Intersect(self, Rect rect) -> Rect
d55e5bfc 1316
5cbf236d 1317 Returns the intersectsion of this rectangle and rect.
d55e5bfc 1318 """
5b5c9bc7 1319 return _core_.Rect_Intersect(*args, **kwargs)
d55e5bfc 1320
5cbf236d
RD		 1321 def Union(*args, **kwargs):
1322 """
5b5c9bc7 1323 Union(self, Rect rect) -> Rect
5cbf236d
RD		 1324
1325 Returns the union of this rectangle and rect.
1326 """
5b5c9bc7 1327 return _core_.Rect_Union(*args, **kwargs)
5cbf236d 1328
d55e5bfc
RD		 1329 def __add__(*args, **kwargs):
1330 """
5b5c9bc7 1331 __add__(self, Rect rect) -> Rect
d55e5bfc
RD		 1332
1333 Add the properties of rect to this rectangle and return the result.
1334 """
5b5c9bc7 1335 return _core_.Rect___add__(*args, **kwargs)
d55e5bfc
RD		 1336
1337 def __iadd__(*args, **kwargs):
1338 """
5b5c9bc7 1339 __iadd__(self, Rect rect) -> Rect
d55e5bfc
RD		 1340
1341 Add the properties of rect to this rectangle, updating this rectangle.
1342 """
5b5c9bc7 1343 return _core_.Rect___iadd__(*args, **kwargs)
d55e5bfc
RD		 1344
1345 def __eq__(*args, **kwargs):
1346 """
e9d6f3a4 1347 __eq__(self, PyObject other) -> bool
d55e5bfc 1348
e9d6f3a4 1349 Test for equality of wx.Rect objects.
d55e5bfc 1350 """
5b5c9bc7 1351 return _core_.Rect___eq__(*args, **kwargs)
d55e5bfc
RD		 1352
1353 def __ne__(*args, **kwargs):
1354 """
e9d6f3a4 1355 __ne__(self, PyObject other) -> bool
d55e5bfc 1356
e9d6f3a4 1357 Test for inequality of wx.Rect objects.
d55e5bfc 1358 """
5b5c9bc7 1359 return _core_.Rect___ne__(*args, **kwargs)
d55e5bfc 1360
33d6fd3b 1361 def ContainsXY(*args, **kwargs):
d55e5bfc 1362 """
33d6fd3b 1363 ContainsXY(self, int x, int y) -> bool
d55e5bfc 1364
33d6fd3b 1365 Return True if the point is inside the rect.
d55e5bfc 1366 """
33d6fd3b 1367 return _core_.Rect_ContainsXY(*args, **kwargs)
d55e5bfc 1368
33d6fd3b 1369 def Contains(*args, **kwargs):
d55e5bfc 1370 """
33d6fd3b 1371 Contains(self, Point pt) -> bool
d55e5bfc 1372
33d6fd3b 1373 Return True if the point is inside the rect.
d55e5bfc 1374 """
33d6fd3b 1375 return _core_.Rect_Contains(*args, **kwargs)
d55e5bfc 1376
33d6fd3b 1377 def ContainsRect(*args, **kwargs):
fc46b7f3 1378 """
33d6fd3b 1379 ContainsRect(self, Rect rect) -> bool
fc46b7f3
RD		 1380
1381 Returns ``True`` if the given rectangle is completely inside this
1382 rectangle or touches its boundary.
1383 """
33d6fd3b
RD		 1384 return _core_.Rect_ContainsRect(*args, **kwargs)
1385
72ef6efb
RD		 1386 #Inside = wx._deprecated(Contains, "Use `Contains` instead.")
1387 #InsideXY = wx._deprecated(ContainsXY, "Use `ContainsXY` instead.")
1388 #InsideRect = wx._deprecated(ContainsRect, "Use `ContainsRect` instead.")
1389 Inside = Contains
1390 InsideXY = ContainsXY
1391 InsideRect = ContainsRect
fc46b7f3 1392
d55e5bfc
RD		 1393 def Intersects(*args, **kwargs):
1394 """
5b5c9bc7 1395 Intersects(self, Rect rect) -> bool
d55e5bfc
RD		 1396
1397 Returns True if the rectangles have a non empty intersection.
1398 """
5b5c9bc7 1399 return _core_.Rect_Intersects(*args, **kwargs)
d55e5bfc 1400
b1fcee84
RD		 1401 def CenterIn(*args, **kwargs):
1402 """
1403 CenterIn(self, Rect r, int dir=BOTH) -> Rect
1404
1405 Center this rectangle within the one passed to the method, which is
1406 usually, but not necessarily, the larger one.
1407 """
1408 return _core_.Rect_CenterIn(*args, **kwargs)
1409
1410 CentreIn = CenterIn
5b5c9bc7
RD		 1411 x = property(_core_.Rect_x_get, _core_.Rect_x_set)
1412 y = property(_core_.Rect_y_get, _core_.Rect_y_set)
1413 width = property(_core_.Rect_width_get, _core_.Rect_width_set)
1414 height = property(_core_.Rect_height_get, _core_.Rect_height_set)
d55e5bfc
RD		 1415 def Set(*args, **kwargs):
1416 """
1417 Set(self, int x=0, int y=0, int width=0, int height=0)
1418
1419 Set all rectangle properties.
1420 """
5b5c9bc7 1421 return _core_.Rect_Set(*args, **kwargs)
d55e5bfc
RD		 1422
1423 def Get(*args, **kwargs):
1424 """
1425 Get() -> (x,y,width,height)
1426
1427 Return the rectangle properties as a tuple.
1428 """
5b5c9bc7 1429 return _core_.Rect_Get(*args, **kwargs)
d55e5bfc 1430
15817c7e 1431 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD		 1432 def __str__(self): return str(self.Get())
1433 def __repr__(self): return 'wx.Rect'+str(self.Get())
1434 def __len__(self): return len(self.Get())
1435 def __getitem__(self, index): return self.Get()[index]
1436 def __setitem__(self, index, val):
1437 if index == 0: self.x = val
1438 elif index == 1: self.y = val
1439 elif index == 2: self.width = val
1440 elif index == 3: self.height = val
1441 else: raise IndexError
1442 def __nonzero__(self): return self.Get() != (0,0,0,0)
1443 __safe_for_unpickling__ = True
1444 def __reduce__(self): return (wx.Rect, self.Get())
1445
33d6fd3b
RD		 1446 Bottom = property(GetBottom,SetBottom,doc="See `GetBottom` and `SetBottom`")
1447 BottomRight = property(GetBottomRight,SetBottomRight,doc="See `GetBottomRight` and `SetBottomRight`")
5acb46e0 1448 BottomLeft = property(GetBottomLeft,SetBottomLeft,doc="See `GetBottomLeft` and `SetBottomLeft`")
33d6fd3b
RD		 1449 Height = property(GetHeight,SetHeight,doc="See `GetHeight` and `SetHeight`")
1450 Left = property(GetLeft,SetLeft,doc="See `GetLeft` and `SetLeft`")
1451 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
1452 Right = property(GetRight,SetRight,doc="See `GetRight` and `SetRight`")
1453 Size = property(GetSize,SetSize,doc="See `GetSize` and `SetSize`")
1454 Top = property(GetTop,SetTop,doc="See `GetTop` and `SetTop`")
1455 TopLeft = property(GetTopLeft,SetTopLeft,doc="See `GetTopLeft` and `SetTopLeft`")
5acb46e0 1456 TopRight = property(GetTopRight,SetTopRight,doc="See `GetTopRight` and `SetTopRight`")
33d6fd3b
RD		 1457 Width = property(GetWidth,SetWidth,doc="See `GetWidth` and `SetWidth`")
1458 X = property(GetX,SetX,doc="See `GetX` and `SetX`")
1459 Y = property(GetY,SetY,doc="See `GetY` and `SetY`")
1460 Empty = property(IsEmpty,doc="See `IsEmpty`")
2131d850 1461_core_.Rect_swigregister(Rect)
d55e5bfc
RD		 1462
1463def RectPP(*args, **kwargs):
1464 """
5b5c9bc7 1465 RectPP(Point topLeft, Point bottomRight) -> Rect
d55e5bfc
RD		 1466
1467 Create a new Rect object from Points representing two corners.
1468 """
5b5c9bc7 1469 val = _core_.new_RectPP(*args, **kwargs)
d55e5bfc
RD		 1470 return val
1471
1472def RectPS(*args, **kwargs):
1473 """
5b5c9bc7 1474 RectPS(Point pos, Size size) -> Rect
d55e5bfc
RD		 1475
1476 Create a new Rect from a position and size.
1477 """
5b5c9bc7 1478 val = _core_.new_RectPS(*args, **kwargs)
d55e5bfc
RD		 1479 return val
1480
070c48b4
RD		 1481def RectS(*args, **kwargs):
1482 """
5b5c9bc7 1483 RectS(Size size) -> Rect
070c48b4
RD		 1484
1485 Create a new Rect from a size only.
1486 """
5b5c9bc7 1487 val = _core_.new_RectS(*args, **kwargs)
070c48b4
RD		 1488 return val
1489
d55e5bfc 1490
5b5c9bc7 1491def IntersectRect(*args, **kwargs):
1bd55598 1492 """
d55e5bfc
RD		 1493 IntersectRect(Rect r1, Rect r2) -> Rect
1494
1495 Calculate and return the intersection of r1 and r2.
1496 """
1bd55598 1497 return _core_.IntersectRect(*args, **kwargs)
d55e5bfc
RD		 1498#---------------------------------------------------------------------------
1499
5b5c9bc7 1500class Point2D(object):
15817c7e
RD		 1501 """
1502 wx.Point2Ds represent a point or a vector in a 2d coordinate system
1503 with floating point values.
1504 """
1bd55598
RD		 1505 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1506 __repr__ = _swig_repr
1507 def __init__(self, *args, **kwargs):
d55e5bfc 1508 """
5b5c9bc7 1509 __init__(self, double x=0.0, double y=0.0) -> Point2D
d55e5bfc
RD		 1510
1511 Create a w.Point2D object.
1512 """
1bd55598 1513 _core_.Point2D_swiginit(self,_core_.new_Point2D(*args, **kwargs))
b39fe951
RD		 1514 __swig_destroy__ = _core_.delete_Point2D
1515 __del__ = lambda self : None;
d55e5bfc 1516 def GetFloor(*args, **kwargs):
fd2dc343
RD		 1517 """
1518 GetFloor() -> (x,y)
1519
1520 Convert to integer
1521 """
5b5c9bc7 1522 return _core_.Point2D_GetFloor(*args, **kwargs)
d55e5bfc
RD		 1523
1524 def GetRounded(*args, **kwargs):
fd2dc343
RD		 1525 """
1526 GetRounded() -> (x,y)
1527
1528 Convert to integer
1529 """
5b5c9bc7 1530 return _core_.Point2D_GetRounded(*args, **kwargs)
d55e5bfc
RD		 1531
1532 def GetVectorLength(*args, **kwargs):
1533 """GetVectorLength(self) -> double"""
5b5c9bc7 1534 return _core_.Point2D_GetVectorLength(*args, **kwargs)
d55e5bfc
RD		 1535
1536 def GetVectorAngle(*args, **kwargs):
1537 """GetVectorAngle(self) -> double"""
5b5c9bc7 1538 return _core_.Point2D_GetVectorAngle(*args, **kwargs)
d55e5bfc
RD		 1539
1540 def SetVectorLength(*args, **kwargs):
1541 """SetVectorLength(self, double length)"""
5b5c9bc7 1542 return _core_.Point2D_SetVectorLength(*args, **kwargs)
d55e5bfc
RD		 1543
1544 def SetVectorAngle(*args, **kwargs):
1545 """SetVectorAngle(self, double degrees)"""
5b5c9bc7 1546 return _core_.Point2D_SetVectorAngle(*args, **kwargs)
d55e5bfc
RD		 1547
1548 def SetPolarCoordinates(self, angle, length):
1549 self.SetVectorLength(length)
1550 self.SetVectorAngle(angle)
1551 def Normalize(self):
1552 self.SetVectorLength(1.0)
1553
1554 def GetDistance(*args, **kwargs):
5b5c9bc7
RD		 1555 """GetDistance(self, Point2D pt) -> double"""
1556 return _core_.Point2D_GetDistance(*args, **kwargs)
d55e5bfc
RD		 1557
1558 def GetDistanceSquare(*args, **kwargs):
5b5c9bc7
RD		 1559 """GetDistanceSquare(self, Point2D pt) -> double"""
1560 return _core_.Point2D_GetDistanceSquare(*args, **kwargs)
d55e5bfc
RD		 1561
1562 def GetDotProduct(*args, **kwargs):
5b5c9bc7
RD		 1563 """GetDotProduct(self, Point2D vec) -> double"""
1564 return _core_.Point2D_GetDotProduct(*args, **kwargs)
d55e5bfc
RD		 1565
1566 def GetCrossProduct(*args, **kwargs):
5b5c9bc7
RD		 1567 """GetCrossProduct(self, Point2D vec) -> double"""
1568 return _core_.Point2D_GetCrossProduct(*args, **kwargs)
d55e5bfc
RD		 1569
1570 def __neg__(*args, **kwargs):
1571 """
5b5c9bc7 1572 __neg__(self) -> Point2D
d55e5bfc
RD		 1573
1574 the reflection of this point
1575 """
5b5c9bc7 1576 return _core_.Point2D___neg__(*args, **kwargs)
d55e5bfc
RD		 1577
1578 def __iadd__(*args, **kwargs):
5b5c9bc7
RD		 1579 """__iadd__(self, Point2D pt) -> Point2D"""
1580 return _core_.Point2D___iadd__(*args, **kwargs)
d55e5bfc
RD		 1581
1582 def __isub__(*args, **kwargs):
5b5c9bc7
RD		 1583 """__isub__(self, Point2D pt) -> Point2D"""
1584 return _core_.Point2D___isub__(*args, **kwargs)
d55e5bfc
RD		 1585
1586 def __imul__(*args, **kwargs):
5b5c9bc7
RD		 1587 """__imul__(self, Point2D pt) -> Point2D"""
1588 return _core_.Point2D___imul__(*args, **kwargs)
d55e5bfc
RD		 1589
1590 def __idiv__(*args, **kwargs):
5b5c9bc7
RD		 1591 """__idiv__(self, Point2D pt) -> Point2D"""
1592 return _core_.Point2D___idiv__(*args, **kwargs)
d55e5bfc
RD		 1593
1594 def __eq__(*args, **kwargs):
1595 """
e9d6f3a4 1596 __eq__(self, PyObject other) -> bool
d55e5bfc 1597
e9d6f3a4 1598 Test for equality of wx.Point2D objects.
d55e5bfc 1599 """
5b5c9bc7 1600 return _core_.Point2D___eq__(*args, **kwargs)
d55e5bfc
RD		 1601
1602 def __ne__(*args, **kwargs):
1603 """
e9d6f3a4 1604 __ne__(self, PyObject other) -> bool
d55e5bfc 1605
e9d6f3a4 1606 Test for inequality of wx.Point2D objects.
d55e5bfc 1607 """
5b5c9bc7 1608 return _core_.Point2D___ne__(*args, **kwargs)
d55e5bfc 1609
5b5c9bc7
RD		 1610 x = property(_core_.Point2D_x_get, _core_.Point2D_x_set)
1611 y = property(_core_.Point2D_y_get, _core_.Point2D_y_set)
d55e5bfc
RD		 1612 def Set(*args, **kwargs):
1613 """Set(self, double x=0, double y=0)"""
5b5c9bc7 1614 return _core_.Point2D_Set(*args, **kwargs)
d55e5bfc
RD		 1615
1616 def Get(*args, **kwargs):
1617 """
1618 Get() -> (x,y)
1619
1620 Return x and y properties as a tuple.
1621 """
5b5c9bc7 1622 return _core_.Point2D_Get(*args, **kwargs)
d55e5bfc 1623
15817c7e 1624 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD		 1625 def __str__(self): return str(self.Get())
1626 def __repr__(self): return 'wx.Point2D'+str(self.Get())
1627 def __len__(self): return len(self.Get())
1628 def __getitem__(self, index): return self.Get()[index]
1629 def __setitem__(self, index, val):
1630 if index == 0: self.x = val
1631 elif index == 1: self.y = val
1632 else: raise IndexError
1633 def __nonzero__(self): return self.Get() != (0.0, 0.0)
1634 __safe_for_unpickling__ = True
1635 def __reduce__(self): return (wx.Point2D, self.Get())
1636
33d6fd3b
RD		 1637 Floor = property(GetFloor,doc="See `GetFloor`")
1638 Rounded = property(GetRounded,doc="See `GetRounded`")
1639 VectorAngle = property(GetVectorAngle,SetVectorAngle,doc="See `GetVectorAngle` and `SetVectorAngle`")
1640 VectorLength = property(GetVectorLength,SetVectorLength,doc="See `GetVectorLength` and `SetVectorLength`")
2131d850 1641_core_.Point2D_swigregister(Point2D)
d55e5bfc
RD		 1642
1643def Point2DCopy(*args, **kwargs):
1644 """
5b5c9bc7 1645 Point2DCopy(Point2D pt) -> Point2D
d55e5bfc
RD		 1646
1647 Create a w.Point2D object.
1648 """
5b5c9bc7 1649 val = _core_.new_Point2DCopy(*args, **kwargs)
d55e5bfc
RD		 1650 return val
1651
1652def Point2DFromPoint(*args, **kwargs):
1653 """
5b5c9bc7 1654 Point2DFromPoint(Point pt) -> Point2D
d55e5bfc
RD		 1655
1656 Create a w.Point2D object.
1657 """
5b5c9bc7 1658 val = _core_.new_Point2DFromPoint(*args, **kwargs)
d55e5bfc
RD		 1659 return val
1660
1661#---------------------------------------------------------------------------
1662
70d7cb34
RD		 1663Inside = _core_.Inside
1664OutLeft = _core_.OutLeft
1665OutRight = _core_.OutRight
1666OutTop = _core_.OutTop
1667OutBottom = _core_.OutBottom
1668class Rect2D(object):
1669 """
1670 wx.Rect2D is a rectangle, with position and size, in a 2D coordinate system
1671 with floating point component values.
1672 """
1673 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1674 __repr__ = _swig_repr
1675 def __init__(self, *args, **kwargs):
1676 """
1677 __init__(self, wxDouble x=0.0, wxDouble y=0.0, wxDouble w=0.0, wxDouble h=0.0) -> Rect2D
1678
1679 wx.Rect2D is a rectangle, with position and size, in a 2D coordinate system
1680 with floating point component values.
1681 """
1682 _core_.Rect2D_swiginit(self,_core_.new_Rect2D(*args, **kwargs))
1683 __swig_destroy__ = _core_.delete_Rect2D
1684 __del__ = lambda self : None;
1685 def GetPosition(*args, **kwargs):
1686 """GetPosition(self) -> Point2D"""
1687 return _core_.Rect2D_GetPosition(*args, **kwargs)
1688
1689 def GetSize(*args, **kwargs):
1690 """GetSize(self) -> Size"""
1691 return _core_.Rect2D_GetSize(*args, **kwargs)
1692
1693 def GetLeft(*args, **kwargs):
1694 """GetLeft(self) -> wxDouble"""
1695 return _core_.Rect2D_GetLeft(*args, **kwargs)
1696
1697 def SetLeft(*args, **kwargs):
1698 """SetLeft(self, wxDouble n)"""
1699 return _core_.Rect2D_SetLeft(*args, **kwargs)
1700
1701 def MoveLeftTo(*args, **kwargs):
1702 """MoveLeftTo(self, wxDouble n)"""
1703 return _core_.Rect2D_MoveLeftTo(*args, **kwargs)
1704
1705 def GetTop(*args, **kwargs):
1706 """GetTop(self) -> wxDouble"""
1707 return _core_.Rect2D_GetTop(*args, **kwargs)
1708
1709 def SetTop(*args, **kwargs):
1710 """SetTop(self, wxDouble n)"""
1711 return _core_.Rect2D_SetTop(*args, **kwargs)
1712
1713 def MoveTopTo(*args, **kwargs):
1714 """MoveTopTo(self, wxDouble n)"""
1715 return _core_.Rect2D_MoveTopTo(*args, **kwargs)
1716
1717 def GetBottom(*args, **kwargs):
1718 """GetBottom(self) -> wxDouble"""
1719 return _core_.Rect2D_GetBottom(*args, **kwargs)
1720
1721 def SetBottom(*args, **kwargs):
1722 """SetBottom(self, wxDouble n)"""
1723 return _core_.Rect2D_SetBottom(*args, **kwargs)
1724
1725 def MoveBottomTo(*args, **kwargs):
1726 """MoveBottomTo(self, wxDouble n)"""
1727 return _core_.Rect2D_MoveBottomTo(*args, **kwargs)
1728
1729 def GetRight(*args, **kwargs):
1730 """GetRight(self) -> wxDouble"""
1731 return _core_.Rect2D_GetRight(*args, **kwargs)
1732
1733 def SetRight(*args, **kwargs):
1734 """SetRight(self, wxDouble n)"""
1735 return _core_.Rect2D_SetRight(*args, **kwargs)
1736
1737 def MoveRightTo(*args, **kwargs):
1738 """MoveRightTo(self, wxDouble n)"""
1739 return _core_.Rect2D_MoveRightTo(*args, **kwargs)
1740
1741 def GetLeftTop(*args, **kwargs):
1742 """GetLeftTop(self) -> Point2D"""
1743 return _core_.Rect2D_GetLeftTop(*args, **kwargs)
1744
1745 def SetLeftTop(*args, **kwargs):
1746 """SetLeftTop(self, Point2D pt)"""
1747 return _core_.Rect2D_SetLeftTop(*args, **kwargs)
1748
1749 def MoveLeftTopTo(*args, **kwargs):
1750 """MoveLeftTopTo(self, Point2D pt)"""
1751 return _core_.Rect2D_MoveLeftTopTo(*args, **kwargs)
1752
1753 def GetLeftBottom(*args, **kwargs):
1754 """GetLeftBottom(self) -> Point2D"""
1755 return _core_.Rect2D_GetLeftBottom(*args, **kwargs)
1756
1757 def SetLeftBottom(*args, **kwargs):
1758 """SetLeftBottom(self, Point2D pt)"""
1759 return _core_.Rect2D_SetLeftBottom(*args, **kwargs)
1760
1761 def MoveLeftBottomTo(*args, **kwargs):
1762 """MoveLeftBottomTo(self, Point2D pt)"""
1763 return _core_.Rect2D_MoveLeftBottomTo(*args, **kwargs)
1764
1765 def GetRightTop(*args, **kwargs):
1766 """GetRightTop(self) -> Point2D"""
1767 return _core_.Rect2D_GetRightTop(*args, **kwargs)
1768
1769 def SetRightTop(*args, **kwargs):
1770 """SetRightTop(self, Point2D pt)"""
1771 return _core_.Rect2D_SetRightTop(*args, **kwargs)
1772
1773 def MoveRightTopTo(*args, **kwargs):
1774 """MoveRightTopTo(self, Point2D pt)"""
1775 return _core_.Rect2D_MoveRightTopTo(*args, **kwargs)
1776
1777 def GetRightBottom(*args, **kwargs):
1778 """GetRightBottom(self) -> Point2D"""
1779 return _core_.Rect2D_GetRightBottom(*args, **kwargs)
1780
1781 def SetRightBottom(*args, **kwargs):
1782 """SetRightBottom(self, Point2D pt)"""
1783 return _core_.Rect2D_SetRightBottom(*args, **kwargs)
1784
1785 def MoveRightBottomTo(*args, **kwargs):
1786 """MoveRightBottomTo(self, Point2D pt)"""
1787 return _core_.Rect2D_MoveRightBottomTo(*args, **kwargs)
1788
1789 def GetCentre(*args, **kwargs):
1790 """GetCentre(self) -> Point2D"""
1791 return _core_.Rect2D_GetCentre(*args, **kwargs)
1792
1793 def SetCentre(*args, **kwargs):
1794 """SetCentre(self, Point2D pt)"""
1795 return _core_.Rect2D_SetCentre(*args, **kwargs)
1796
1797 def MoveCentreTo(*args, **kwargs):
1798 """MoveCentreTo(self, Point2D pt)"""
1799 return _core_.Rect2D_MoveCentreTo(*args, **kwargs)
1800
1801 def GetOutcode(*args, **kwargs):
1802 """GetOutcode(self, Point2D pt) -> int"""
1803 return _core_.Rect2D_GetOutcode(*args, **kwargs)
1804
1805 def Contains(*args, **kwargs):
1806 """Contains(self, Point2D pt) -> bool"""
1807 return _core_.Rect2D_Contains(*args, **kwargs)
1808
1809 def ContainsRect(*args, **kwargs):
1810 """ContainsRect(self, Rect2D rect) -> bool"""
1811 return _core_.Rect2D_ContainsRect(*args, **kwargs)
1812
1813 def IsEmpty(*args, **kwargs):
1814 """IsEmpty(self) -> bool"""
1815 return _core_.Rect2D_IsEmpty(*args, **kwargs)
1816
1817 def HaveEqualSize(*args, **kwargs):
1818 """HaveEqualSize(self, Rect2D rect) -> bool"""
1819 return _core_.Rect2D_HaveEqualSize(*args, **kwargs)
1820
1821 def Inset(*args):
1822 """
1823 Inset(self, wxDouble x, wxDouble y)
1824 Inset(self, wxDouble left, wxDouble top, wxDouble right, wxDouble bottom)
1825 """
1826 return _core_.Rect2D_Inset(*args)
1827
1828 def Offset(*args, **kwargs):
1829 """Offset(self, Point2D pt)"""
1830 return _core_.Rect2D_Offset(*args, **kwargs)
1831
1832 def ConstrainTo(*args, **kwargs):
1833 """ConstrainTo(self, Rect2D rect)"""
1834 return _core_.Rect2D_ConstrainTo(*args, **kwargs)
1835
1836 def Interpolate(*args, **kwargs):
1837 """Interpolate(self, int widthfactor, int heightfactor) -> Point2D"""
1838 return _core_.Rect2D_Interpolate(*args, **kwargs)
1839
1840 def Intersect(*args, **kwargs):
1841 """Intersect(self, Rect2D otherRect)"""
1842 return _core_.Rect2D_Intersect(*args, **kwargs)
1843
1844 def CreateIntersection(*args, **kwargs):
1845 """CreateIntersection(self, Rect2D otherRect) -> Rect2D"""
1846 return _core_.Rect2D_CreateIntersection(*args, **kwargs)
1847
1848 def Intersects(*args, **kwargs):
1849 """Intersects(self, Rect2D rect) -> bool"""
1850 return _core_.Rect2D_Intersects(*args, **kwargs)
1851
1852 def Union(*args, **kwargs):
1853 """Union(self, Rect2D otherRect)"""
1854 return _core_.Rect2D_Union(*args, **kwargs)
1855
1856 def CreateUnion(*args, **kwargs):
1857 """CreateUnion(self, Rect2D otherRect) -> Rect2D"""
1858 return _core_.Rect2D_CreateUnion(*args, **kwargs)
1859
1860 def Scale(*args):
1861 """
1862 Scale(self, wxDouble f)
1863 Scale(self, int num, int denum)
1864 """
1865 return _core_.Rect2D_Scale(*args)
1866
1867 def __eq__(*args, **kwargs):
1868 """
1869 __eq__(self, PyObject other) -> bool
1870
1871 Test for equality of wx.Rect2D objects.
1872 """
1873 return _core_.Rect2D___eq__(*args, **kwargs)
1874
1875 def __ne__(*args, **kwargs):
1876 """
1877 __ne__(self, PyObject other) -> bool
1878
1879 Test for inequality of wx.Rect2D objects.
1880 """
1881 return _core_.Rect2D___ne__(*args, **kwargs)
1882
1883 x = property(_core_.Rect2D_x_get, _core_.Rect2D_x_set)
1884 y = property(_core_.Rect2D_y_get, _core_.Rect2D_y_set)
1885 width = property(_core_.Rect2D_width_get, _core_.Rect2D_width_set)
1886 height = property(_core_.Rect2D_height_get, _core_.Rect2D_height_set)
1887 def Set(*args, **kwargs):
1888 """Set(self, wxDouble x=0, wxDouble y=0, wxDouble width=0, wxDouble height=0)"""
1889 return _core_.Rect2D_Set(*args, **kwargs)
1890
1891 def Get(*args, **kwargs):
1892 """
1893 Get() -> (x,y, width, height)
1894
1895 Return x, y, width and height y properties as a tuple.
1896 """
1897 return _core_.Rect2D_Get(*args, **kwargs)
1898
1899 def __str__(self): return str(self.Get())
1900 def __repr__(self): return 'wx.Rect2D'+str(self.Get())
1901 def __len__(self): return len(self.Get())
1902 def __getitem__(self, index): return self.Get()[index]
1903 def __setitem__(self, index, val):
1904 if index == 0: self.x = val
1905 elif index == 1: self.y = val
1906 elif index == 2: self.width = val
1907 elif index == 3: self.height = val
1908 else: raise IndexError
1909 def __nonzero__(self): return self.Get() != (0.0, 0.0, 0.0, 0.0)
1910 __safe_for_unpickling__ = True
1911 def __reduce__(self): return (wx.Rect2D, self.Get())
1912
1913_core_.Rect2D_swigregister(Rect2D)
1914
1915#---------------------------------------------------------------------------
1916
5b5c9bc7
RD		 1917FromStart = _core_.FromStart
1918FromCurrent = _core_.FromCurrent
1919FromEnd = _core_.FromEnd
d55e5bfc 1920class InputStream(object):
36ed4f51 1921 """Proxy of C++ InputStream class"""
1bd55598
RD		 1922 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1923 __repr__ = _swig_repr
1924 def __init__(self, *args, **kwargs):
d55e5bfc 1925 """__init__(self, PyObject p) -> InputStream"""
1bd55598
RD		 1926 _core_.InputStream_swiginit(self,_core_.new_InputStream(*args, **kwargs))
1927 __swig_destroy__ = _core_.delete_InputStream
1928 __del__ = lambda self : None;
d55e5bfc
RD		 1929 def close(*args, **kwargs):
1930 """close(self)"""
5b5c9bc7 1931 return _core_.InputStream_close(*args, **kwargs)
d55e5bfc
RD		 1932
1933 def flush(*args, **kwargs):
1934 """flush(self)"""
5b5c9bc7 1935 return _core_.InputStream_flush(*args, **kwargs)
d55e5bfc
RD		 1936
1937 def eof(*args, **kwargs):
1938 """eof(self) -> bool"""
5b5c9bc7 1939 return _core_.InputStream_eof(*args, **kwargs)
d55e5bfc
RD		 1940
1941 def read(*args, **kwargs):
1942 """read(self, int size=-1) -> PyObject"""
5b5c9bc7 1943 return _core_.InputStream_read(*args, **kwargs)
d55e5bfc
RD		 1944
1945 def readline(*args, **kwargs):
1946 """readline(self, int size=-1) -> PyObject"""
5b5c9bc7 1947 return _core_.InputStream_readline(*args, **kwargs)
d55e5bfc
RD		 1948
1949 def readlines(*args, **kwargs):
1950 """readlines(self, int sizehint=-1) -> PyObject"""
5b5c9bc7 1951 return _core_.InputStream_readlines(*args, **kwargs)
d55e5bfc
RD		 1952
1953 def seek(*args, **kwargs):
1954 """seek(self, int offset, int whence=0)"""
5b5c9bc7 1955 return _core_.InputStream_seek(*args, **kwargs)
d55e5bfc
RD		 1956
1957 def tell(*args, **kwargs):
1958 """tell(self) -> int"""
5b5c9bc7 1959 return _core_.InputStream_tell(*args, **kwargs)
d55e5bfc
RD		 1960
1961 def Peek(*args, **kwargs):
1962 """Peek(self) -> char"""
5b5c9bc7 1963 return _core_.InputStream_Peek(*args, **kwargs)
d55e5bfc
RD		 1964
1965 def GetC(*args, **kwargs):
1966 """GetC(self) -> char"""
5b5c9bc7 1967 return _core_.InputStream_GetC(*args, **kwargs)
d55e5bfc
RD		 1968
1969 def LastRead(*args, **kwargs):
1970 """LastRead(self) -> size_t"""
5b5c9bc7 1971 return _core_.InputStream_LastRead(*args, **kwargs)
d55e5bfc
RD		 1972
1973 def CanRead(*args, **kwargs):
1974 """CanRead(self) -> bool"""
5b5c9bc7 1975 return _core_.InputStream_CanRead(*args, **kwargs)
d55e5bfc
RD		 1976
1977 def Eof(*args, **kwargs):
1978 """Eof(self) -> bool"""
5b5c9bc7 1979 return _core_.InputStream_Eof(*args, **kwargs)
d55e5bfc
RD		 1980
1981 def Ungetch(*args, **kwargs):
1982 """Ungetch(self, char c) -> bool"""
5b5c9bc7 1983 return _core_.InputStream_Ungetch(*args, **kwargs)
d55e5bfc
RD		 1984
1985 def SeekI(*args, **kwargs):
5b5c9bc7
RD		 1986 """SeekI(self, long pos, int mode=FromStart) -> long"""
1987 return _core_.InputStream_SeekI(*args, **kwargs)
d55e5bfc
RD		 1988
1989 def TellI(*args, **kwargs):
1990 """TellI(self) -> long"""
5b5c9bc7 1991 return _core_.InputStream_TellI(*args, **kwargs)
d55e5bfc 1992
2131d850 1993_core_.InputStream_swigregister(InputStream)
5b5c9bc7
RD		 1994DefaultPosition = cvar.DefaultPosition
1995DefaultSize = cvar.DefaultSize
d55e5bfc 1996
5b5c9bc7
RD		 1997class OutputStream(object):
1998 """Proxy of C++ OutputStream class"""
1bd55598
RD		 1999 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2000 def __init__(self): raise AttributeError, "No constructor defined"
2001 __repr__ = _swig_repr
d55e5bfc
RD		 2002 def write(*args, **kwargs):
2003 """write(self, PyObject obj)"""
5b5c9bc7 2004 return _core_.OutputStream_write(*args, **kwargs)
d55e5bfc 2005
1bd55598
RD		 2006 def LastWrite(*args, **kwargs):
2007 """LastWrite(self) -> size_t"""
2008 return _core_.OutputStream_LastWrite(*args, **kwargs)
d55e5bfc 2009
2131d850 2010_core_.OutputStream_swigregister(OutputStream)
d55e5bfc
RD		 2011
2012#---------------------------------------------------------------------------
2013
5b5c9bc7
RD		 2014class FSFile(Object):
2015 """Proxy of C++ FSFile class"""
1bd55598
RD		 2016 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2017 __repr__ = _swig_repr
2018 def __init__(self, *args, **kwargs):
d55e5bfc 2019 """
5b5c9bc7
RD		 2020 __init__(self, InputStream stream, String loc, String mimetype, String anchor,
2021 DateTime modif) -> FSFile
d55e5bfc 2022 """
1bd55598 2023 _core_.FSFile_swiginit(self,_core_.new_FSFile(*args, **kwargs))
1bd55598
RD		 2024 __swig_destroy__ = _core_.delete_FSFile
2025 __del__ = lambda self : None;
d55e5bfc 2026 def GetStream(*args, **kwargs):
5b5c9bc7
RD		 2027 """GetStream(self) -> InputStream"""
2028 return _core_.FSFile_GetStream(*args, **kwargs)
d55e5bfc 2029
ac5d357a
RD		 2030 def DetachStream(*args, **kwargs):
2031 """DetachStream(self)"""
2032 return _core_.FSFile_DetachStream(*args, **kwargs)
2033
d55e5bfc 2034 def GetMimeType(*args, **kwargs):
5b5c9bc7
RD		 2035 """GetMimeType(self) -> String"""
2036 return _core_.FSFile_GetMimeType(*args, **kwargs)
d55e5bfc
RD		 2037
2038 def GetLocation(*args, **kwargs):
5b5c9bc7
RD		 2039 """GetLocation(self) -> String"""
2040 return _core_.FSFile_GetLocation(*args, **kwargs)
d55e5bfc
RD		 2041
2042 def GetAnchor(*args, **kwargs):
5b5c9bc7
RD		 2043 """GetAnchor(self) -> String"""
2044 return _core_.FSFile_GetAnchor(*args, **kwargs)
d55e5bfc
RD		 2045
2046 def GetModificationTime(*args, **kwargs):
5b5c9bc7
RD		 2047 """GetModificationTime(self) -> DateTime"""
2048 return _core_.FSFile_GetModificationTime(*args, **kwargs)
d55e5bfc 2049
ac5d357a
RD		 2050 Anchor = property(GetAnchor,doc="See `GetAnchor`")
2051 Location = property(GetLocation,doc="See `GetLocation`")
2052 MimeType = property(GetMimeType,doc="See `GetMimeType`")
2053 ModificationTime = property(GetModificationTime,doc="See `GetModificationTime`")
2054 Stream = property(GetStream,doc="See `GetStream`")
2131d850 2055_core_.FSFile_swigregister(FSFile)
d55e5bfc
RD		 2056
2057class CPPFileSystemHandler(object):
36ed4f51 2058 """Proxy of C++ CPPFileSystemHandler class"""
1bd55598
RD		 2059 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2060 def __init__(self): raise AttributeError, "No constructor defined"
2061 __repr__ = _swig_repr
50f151d7
RD		 2062 __swig_destroy__ = _core_.delete_CPPFileSystemHandler
2063 __del__ = lambda self : None;
2131d850 2064_core_.CPPFileSystemHandler_swigregister(CPPFileSystemHandler)
d55e5bfc
RD		 2065
2066class FileSystemHandler(CPPFileSystemHandler):
36ed4f51 2067 """Proxy of C++ FileSystemHandler class"""
1bd55598
RD		 2068 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2069 __repr__ = _swig_repr
2070 def __init__(self, *args, **kwargs):
d55e5bfc 2071 """__init__(self) -> FileSystemHandler"""
1bd55598 2072 _core_.FileSystemHandler_swiginit(self,_core_.new_FileSystemHandler(*args, **kwargs))
d55e5bfc
RD		 2073 self._setCallbackInfo(self, FileSystemHandler)
2074
2075 def _setCallbackInfo(*args, **kwargs):
2076 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
5b5c9bc7 2077 return _core_.FileSystemHandler__setCallbackInfo(*args, **kwargs)
d55e5bfc
RD		 2078
2079 def CanOpen(*args, **kwargs):
5b5c9bc7
RD		 2080 """CanOpen(self, String location) -> bool"""
2081 return _core_.FileSystemHandler_CanOpen(*args, **kwargs)
d55e5bfc
RD		 2082
2083 def OpenFile(*args, **kwargs):
5b5c9bc7
RD		 2084 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
2085 return _core_.FileSystemHandler_OpenFile(*args, **kwargs)
d55e5bfc
RD		 2086
2087 def FindFirst(*args, **kwargs):
5b5c9bc7
RD		 2088 """FindFirst(self, String spec, int flags=0) -> String"""
2089 return _core_.FileSystemHandler_FindFirst(*args, **kwargs)
d55e5bfc
RD		 2090
2091 def FindNext(*args, **kwargs):
5b5c9bc7
RD		 2092 """FindNext(self) -> String"""
2093 return _core_.FileSystemHandler_FindNext(*args, **kwargs)
d55e5bfc
RD		 2094
2095 def GetProtocol(*args, **kwargs):
5b5c9bc7
RD		 2096 """GetProtocol(self, String location) -> String"""
2097 return _core_.FileSystemHandler_GetProtocol(*args, **kwargs)
d55e5bfc
RD		 2098
2099 def GetLeftLocation(*args, **kwargs):
5b5c9bc7
RD		 2100 """GetLeftLocation(self, String location) -> String"""
2101 return _core_.FileSystemHandler_GetLeftLocation(*args, **kwargs)
d55e5bfc
RD		 2102
2103 def GetAnchor(*args, **kwargs):
5b5c9bc7
RD		 2104 """GetAnchor(self, String location) -> String"""
2105 return _core_.FileSystemHandler_GetAnchor(*args, **kwargs)
d55e5bfc
RD		 2106
2107 def GetRightLocation(*args, **kwargs):
5b5c9bc7
RD		 2108 """GetRightLocation(self, String location) -> String"""
2109 return _core_.FileSystemHandler_GetRightLocation(*args, **kwargs)
d55e5bfc
RD		 2110
2111 def GetMimeTypeFromExt(*args, **kwargs):
5b5c9bc7
RD		 2112 """GetMimeTypeFromExt(self, String location) -> String"""
2113 return _core_.FileSystemHandler_GetMimeTypeFromExt(*args, **kwargs)
d55e5bfc 2114
ac5d357a
RD		 2115 Anchor = property(GetAnchor,doc="See `GetAnchor`")
2116 LeftLocation = property(GetLeftLocation,doc="See `GetLeftLocation`")
2117 MimeTypeFromExt = property(GetMimeTypeFromExt,doc="See `GetMimeTypeFromExt`")
2118 Protocol = property(GetProtocol,doc="See `GetProtocol`")
2119 RightLocation = property(GetRightLocation,doc="See `GetRightLocation`")
2131d850 2120_core_.FileSystemHandler_swigregister(FileSystemHandler)
d55e5bfc 2121
5b5c9bc7
RD		 2122class FileSystem(Object):
2123 """Proxy of C++ FileSystem class"""
1bd55598
RD		 2124 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2125 __repr__ = _swig_repr
2126 def __init__(self, *args, **kwargs):
5b5c9bc7 2127 """__init__(self) -> FileSystem"""
1bd55598
RD		 2128 _core_.FileSystem_swiginit(self,_core_.new_FileSystem(*args, **kwargs))
2129 __swig_destroy__ = _core_.delete_FileSystem
2130 __del__ = lambda self : None;
d55e5bfc 2131 def ChangePathTo(*args, **kwargs):
5b5c9bc7
RD		 2132 """ChangePathTo(self, String location, bool is_dir=False)"""
2133 return _core_.FileSystem_ChangePathTo(*args, **kwargs)
d55e5bfc
RD		 2134
2135 def GetPath(*args, **kwargs):
5b5c9bc7
RD		 2136 """GetPath(self) -> String"""
2137 return _core_.FileSystem_GetPath(*args, **kwargs)
d55e5bfc
RD		 2138
2139 def OpenFile(*args, **kwargs):
5b5c9bc7
RD		 2140 """OpenFile(self, String location) -> FSFile"""
2141 return _core_.FileSystem_OpenFile(*args, **kwargs)
d55e5bfc
RD		 2142
2143 def FindFirst(*args, **kwargs):
5b5c9bc7
RD		 2144 """FindFirst(self, String spec, int flags=0) -> String"""
2145 return _core_.FileSystem_FindFirst(*args, **kwargs)
d55e5bfc
RD		 2146
2147 def FindNext(*args, **kwargs):
5b5c9bc7
RD		 2148 """FindNext(self) -> String"""
2149 return _core_.FileSystem_FindNext(*args, **kwargs)
d55e5bfc
RD		 2150
2151 def AddHandler(*args, **kwargs):
d6c14a4c 2152 """AddHandler(CPPFileSystemHandler handler)"""
5b5c9bc7 2153 return _core_.FileSystem_AddHandler(*args, **kwargs)
d55e5bfc
RD		 2154
2155 AddHandler = staticmethod(AddHandler)
ac5d357a
RD		 2156 def RemoveHandler(*args, **kwargs):
2157 """RemoveHandler(CPPFileSystemHandler handler) -> CPPFileSystemHandler"""
2158 return _core_.FileSystem_RemoveHandler(*args, **kwargs)
2159
2160 RemoveHandler = staticmethod(RemoveHandler)
d55e5bfc 2161 def CleanUpHandlers(*args, **kwargs):
d6c14a4c 2162 """CleanUpHandlers()"""
5b5c9bc7 2163 return _core_.FileSystem_CleanUpHandlers(*args, **kwargs)
d55e5bfc
RD		 2164
2165 CleanUpHandlers = staticmethod(CleanUpHandlers)
2166 def FileNameToURL(*args, **kwargs):
5b5c9bc7
RD		 2167 """FileNameToURL(String filename) -> String"""
2168 return _core_.FileSystem_FileNameToURL(*args, **kwargs)
d55e5bfc
RD		 2169
2170 FileNameToURL = staticmethod(FileNameToURL)
b411df4a 2171 def URLToFileName(*args, **kwargs):
5b5c9bc7
RD		 2172 """URLToFileName(String url) -> String"""
2173 return _core_.FileSystem_URLToFileName(*args, **kwargs)
b411df4a
RD		 2174
2175 URLToFileName = staticmethod(URLToFileName)
ac5d357a 2176 Path = property(GetPath,doc="See `GetPath`")
2131d850 2177_core_.FileSystem_swigregister(FileSystem)
d55e5bfc 2178
5b5c9bc7 2179def FileSystem_AddHandler(*args, **kwargs):
1bd55598
RD		 2180 """FileSystem_AddHandler(CPPFileSystemHandler handler)"""
2181 return _core_.FileSystem_AddHandler(*args, **kwargs)
d55e5bfc 2182
ac5d357a
RD		 2183def FileSystem_RemoveHandler(*args, **kwargs):
2184 """FileSystem_RemoveHandler(CPPFileSystemHandler handler) -> CPPFileSystemHandler"""
2185 return _core_.FileSystem_RemoveHandler(*args, **kwargs)
2186
1bd55598
RD		 2187def FileSystem_CleanUpHandlers(*args):
2188 """FileSystem_CleanUpHandlers()"""
2189 return _core_.FileSystem_CleanUpHandlers(*args)
d55e5bfc 2190
5b5c9bc7 2191def FileSystem_FileNameToURL(*args, **kwargs):
1bd55598
RD		 2192 """FileSystem_FileNameToURL(String filename) -> String"""
2193 return _core_.FileSystem_FileNameToURL(*args, **kwargs)
d55e5bfc 2194
5b5c9bc7 2195def FileSystem_URLToFileName(*args, **kwargs):
1bd55598
RD		 2196 """FileSystem_URLToFileName(String url) -> String"""
2197 return _core_.FileSystem_URLToFileName(*args, **kwargs)
b411df4a 2198
5b5c9bc7
RD		 2199class InternetFSHandler(CPPFileSystemHandler):
2200 """Proxy of C++ InternetFSHandler class"""
1bd55598
RD		 2201 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2202 __repr__ = _swig_repr
2203 def __init__(self, *args, **kwargs):
5b5c9bc7 2204 """__init__(self) -> InternetFSHandler"""
1bd55598 2205 _core_.InternetFSHandler_swiginit(self,_core_.new_InternetFSHandler(*args, **kwargs))
d55e5bfc 2206 def CanOpen(*args, **kwargs):
5b5c9bc7
RD		 2207 """CanOpen(self, String location) -> bool"""
2208 return _core_.InternetFSHandler_CanOpen(*args, **kwargs)
d55e5bfc
RD		 2209
2210 def OpenFile(*args, **kwargs):
5b5c9bc7
RD		 2211 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
2212 return _core_.InternetFSHandler_OpenFile(*args, **kwargs)
d55e5bfc 2213
2131d850 2214_core_.InternetFSHandler_swigregister(InternetFSHandler)
d55e5bfc 2215
5b5c9bc7
RD		 2216class ZipFSHandler(CPPFileSystemHandler):
2217 """Proxy of C++ ZipFSHandler class"""
1bd55598
RD		 2218 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2219 __repr__ = _swig_repr
2220 def __init__(self, *args, **kwargs):
5b5c9bc7 2221 """__init__(self) -> ZipFSHandler"""
1bd55598 2222 _core_.ZipFSHandler_swiginit(self,_core_.new_ZipFSHandler(*args, **kwargs))
d55e5bfc 2223 def CanOpen(*args, **kwargs):
5b5c9bc7
RD		 2224 """CanOpen(self, String location) -> bool"""
2225 return _core_.ZipFSHandler_CanOpen(*args, **kwargs)
d55e5bfc
RD		 2226
2227 def OpenFile(*args, **kwargs):
5b5c9bc7
RD		 2228 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
2229 return _core_.ZipFSHandler_OpenFile(*args, **kwargs)
d55e5bfc
RD		 2230
2231 def FindFirst(*args, **kwargs):
5b5c9bc7
RD		 2232 """FindFirst(self, String spec, int flags=0) -> String"""
2233 return _core_.ZipFSHandler_FindFirst(*args, **kwargs)
d55e5bfc
RD		 2234
2235 def FindNext(*args, **kwargs):
5b5c9bc7
RD		 2236 """FindNext(self) -> String"""
2237 return _core_.ZipFSHandler_FindNext(*args, **kwargs)
d55e5bfc 2238
2131d850 2239_core_.ZipFSHandler_swigregister(ZipFSHandler)
d55e5bfc
RD		 2240
2241
2242def __wxMemoryFSHandler_AddFile_wxImage(*args, **kwargs):
1bd55598
RD		 2243 """__wxMemoryFSHandler_AddFile_wxImage(String filename, Image image, long type)"""
2244 return _core_.__wxMemoryFSHandler_AddFile_wxImage(*args, **kwargs)
d55e5bfc
RD		 2245
2246def __wxMemoryFSHandler_AddFile_wxBitmap(*args, **kwargs):
1bd55598
RD		 2247 """__wxMemoryFSHandler_AddFile_wxBitmap(String filename, Bitmap bitmap, long type)"""
2248 return _core_.__wxMemoryFSHandler_AddFile_wxBitmap(*args, **kwargs)
d55e5bfc
RD		 2249
2250def __wxMemoryFSHandler_AddFile_Data(*args, **kwargs):
1bd55598
RD		 2251 """__wxMemoryFSHandler_AddFile_Data(String filename, PyObject data)"""
2252 return _core_.__wxMemoryFSHandler_AddFile_Data(*args, **kwargs)
b411df4a
RD		 2253def MemoryFSHandler_AddFile(filename, dataItem, imgType=-1):
2254 """
2255 Add 'file' to the memory filesystem. The dataItem parameter can
2256 either be a `wx.Bitmap`, `wx.Image` or a string that can contain
2257 arbitrary data. If a bitmap or image is used then the imgType
2258 parameter should specify what kind of image file it should be
2259 written as, wx.BITMAP_TYPE_PNG, etc.
2260 """
2261 if isinstance(dataItem, wx.Image):
2262 __wxMemoryFSHandler_AddFile_wxImage(filename, dataItem, imgType)
2263 elif isinstance(dataItem, wx.Bitmap):
2264 __wxMemoryFSHandler_AddFile_wxBitmap(filename, dataItem, imgType)
2265 elif type(dataItem) == str:
2266 __wxMemoryFSHandler_AddFile_Data(filename, dataItem)
2267 else:
2268 raise TypeError, 'wx.Image, wx.Bitmap or string expected'
d55e5bfc 2269
5b5c9bc7
RD		 2270class MemoryFSHandler(CPPFileSystemHandler):
2271 """Proxy of C++ MemoryFSHandler class"""
1bd55598
RD		 2272 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2273 __repr__ = _swig_repr
2274 def __init__(self, *args, **kwargs):
5b5c9bc7 2275 """__init__(self) -> MemoryFSHandler"""
1bd55598 2276 _core_.MemoryFSHandler_swiginit(self,_core_.new_MemoryFSHandler(*args, **kwargs))
d55e5bfc 2277 def RemoveFile(*args, **kwargs):
5b5c9bc7
RD		 2278 """RemoveFile(String filename)"""
2279 return _core_.MemoryFSHandler_RemoveFile(*args, **kwargs)
d55e5bfc
RD		 2280
2281 RemoveFile = staticmethod(RemoveFile)
2282 AddFile = staticmethod(MemoryFSHandler_AddFile)
2283 def CanOpen(*args, **kwargs):
5b5c9bc7
RD		 2284 """CanOpen(self, String location) -> bool"""
2285 return _core_.MemoryFSHandler_CanOpen(*args, **kwargs)
d55e5bfc
RD		 2286
2287 def OpenFile(*args, **kwargs):
5b5c9bc7
RD		 2288 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
2289 return _core_.MemoryFSHandler_OpenFile(*args, **kwargs)
d55e5bfc
RD		 2290
2291 def FindFirst(*args, **kwargs):
5b5c9bc7
RD		 2292 """FindFirst(self, String spec, int flags=0) -> String"""
2293 return _core_.MemoryFSHandler_FindFirst(*args, **kwargs)
d55e5bfc
RD		 2294
2295 def FindNext(*args, **kwargs):
5b5c9bc7
RD		 2296 """FindNext(self) -> String"""
2297 return _core_.MemoryFSHandler_FindNext(*args, **kwargs)
d55e5bfc 2298
2131d850 2299_core_.MemoryFSHandler_swigregister(MemoryFSHandler)
d55e5bfc 2300
5b5c9bc7 2301def MemoryFSHandler_RemoveFile(*args, **kwargs):
1bd55598
RD		 2302 """MemoryFSHandler_RemoveFile(String filename)"""
2303 return _core_.MemoryFSHandler_RemoveFile(*args, **kwargs)
d55e5bfc 2304
5b5c9bc7
RD		 2305IMAGE_ALPHA_TRANSPARENT = _core_.IMAGE_ALPHA_TRANSPARENT
2306IMAGE_ALPHA_THRESHOLD = _core_.IMAGE_ALPHA_THRESHOLD
2307IMAGE_ALPHA_OPAQUE = _core_.IMAGE_ALPHA_OPAQUE
f5263701
RD		 2308IMAGE_QUALITY_NORMAL = _core_.IMAGE_QUALITY_NORMAL
2309IMAGE_QUALITY_HIGH = _core_.IMAGE_QUALITY_HIGH
d55e5bfc
RD		 2310#---------------------------------------------------------------------------
2311
5b5c9bc7 2312class ImageHandler(Object):
27fb7603
RD		 2313 """
2314 This is the base class for implementing image file loading/saving, and
2315 image creation from data. It is used within `wx.Image` and is not
2316 normally seen by the application.
2317 """
1bd55598
RD		 2318 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2319 def __init__(self): raise AttributeError, "No constructor defined"
2320 __repr__ = _swig_repr
d55e5bfc 2321 def GetName(*args, **kwargs):
5b5c9bc7
RD		 2322 """GetName(self) -> String"""
2323 return _core_.ImageHandler_GetName(*args, **kwargs)
d55e5bfc
RD		 2324
2325 def GetExtension(*args, **kwargs):
5b5c9bc7
RD		 2326 """GetExtension(self) -> String"""
2327 return _core_.ImageHandler_GetExtension(*args, **kwargs)
d55e5bfc
RD		 2328
2329 def GetType(*args, **kwargs):
2330 """GetType(self) -> long"""
5b5c9bc7 2331 return _core_.ImageHandler_GetType(*args, **kwargs)
d55e5bfc
RD		 2332
2333 def GetMimeType(*args, **kwargs):
5b5c9bc7
RD		 2334 """GetMimeType(self) -> String"""
2335 return _core_.ImageHandler_GetMimeType(*args, **kwargs)
d55e5bfc
RD		 2336
2337 def CanRead(*args, **kwargs):
5b5c9bc7
RD		 2338 """CanRead(self, String name) -> bool"""
2339 return _core_.ImageHandler_CanRead(*args, **kwargs)
d55e5bfc 2340
b02396e8
RD		 2341 def CanReadStream(*args, **kwargs):
2342 """CanReadStream(self, InputStream stream) -> bool"""
2343 return _core_.ImageHandler_CanReadStream(*args, **kwargs)
2344
d55e5bfc 2345 def SetName(*args, **kwargs):
5b5c9bc7
RD		 2346 """SetName(self, String name)"""
2347 return _core_.ImageHandler_SetName(*args, **kwargs)
d55e5bfc
RD		 2348
2349 def SetExtension(*args, **kwargs):
5b5c9bc7
RD		 2350 """SetExtension(self, String extension)"""
2351 return _core_.ImageHandler_SetExtension(*args, **kwargs)
d55e5bfc
RD		 2352
2353 def SetType(*args, **kwargs):
2354 """SetType(self, long type)"""
5b5c9bc7 2355 return _core_.ImageHandler_SetType(*args, **kwargs)
d55e5bfc
RD		 2356
2357 def SetMimeType(*args, **kwargs):
5b5c9bc7
RD		 2358 """SetMimeType(self, String mimetype)"""
2359 return _core_.ImageHandler_SetMimeType(*args, **kwargs)
d55e5bfc 2360
ac5d357a
RD		 2361 Extension = property(GetExtension,SetExtension,doc="See `GetExtension` and `SetExtension`")
2362 MimeType = property(GetMimeType,SetMimeType,doc="See `GetMimeType` and `SetMimeType`")
2363 Name = property(GetName,SetName,doc="See `GetName` and `SetName`")
2364 Type = property(GetType,SetType,doc="See `GetType` and `SetType`")
2131d850 2365_core_.ImageHandler_swigregister(ImageHandler)
d55e5bfc 2366
943e8dfd
RD		 2367class PyImageHandler(ImageHandler):
2368 """
2369 This is the base class for implementing image file loading/saving, and
2370 image creation from data, all written in Python. To create a custom
2371 image handler derive a new class from wx.PyImageHandler and provide
2372 the following methods::
2373
2374 def DoCanRead(self, stream) --> bool
2375 '''Check if this handler can read the image on the stream'''
2376
2377 def LoadFile(self, image, stream, verbose, index) --> bool
2378 '''Load image data from the stream and load it into image.'''
2379
2380 def SaveFile(self, image, stream, verbose) --> bool
2381 '''Save the iamge data in image to the stream using
2382 this handler's image file format.'''
2383
2384 def GetImageCount(self, stream) --> int
2385 '''If this image format can hold more than one image,
2386 how many does the image on the stream have?'''
2387
2388 To activate your handler create an instance of it and pass it to
2389 `wx.Image_AddHandler`. Be sure to call `SetName`, `SetType`, and
2390 `SetExtension` from your constructor.
2391
2392 """
1bd55598
RD		 2393 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2394 __repr__ = _swig_repr
2395 def __init__(self, *args, **kwargs):
943e8dfd
RD		 2396 """
2397 __init__(self) -> PyImageHandler
2398
2399 This is the base class for implementing image file loading/saving, and
2400 image creation from data, all written in Python. To create a custom
2401 image handler derive a new class from wx.PyImageHandler and provide
2402 the following methods::
2403
2404 def DoCanRead(self, stream) --> bool
2405 '''Check if this handler can read the image on the stream'''
2406
2407 def LoadFile(self, image, stream, verbose, index) --> bool
2408 '''Load image data from the stream and load it into image.'''
2409
2410 def SaveFile(self, image, stream, verbose) --> bool
2411 '''Save the iamge data in image to the stream using
2412 this handler's image file format.'''
2413
2414 def GetImageCount(self, stream) --> int
2415 '''If this image format can hold more than one image,
2416 how many does the image on the stream have?'''
2417
2418 To activate your handler create an instance of it and pass it to
2419 `wx.Image_AddHandler`. Be sure to call `SetName`, `SetType`, and
2420 `SetExtension` from your constructor.
2421
2422 """
1bd55598 2423 _core_.PyImageHandler_swiginit(self,_core_.new_PyImageHandler(*args, **kwargs))
943e8dfd
RD		 2424 self._SetSelf(self)
2425
2426 def _SetSelf(*args, **kwargs):
2427 """_SetSelf(self, PyObject self)"""
2428 return _core_.PyImageHandler__SetSelf(*args, **kwargs)
2429
2131d850 2430_core_.PyImageHandler_swigregister(PyImageHandler)
943e8dfd 2431
5b5c9bc7
RD		 2432class ImageHistogram(object):
2433 """Proxy of C++ ImageHistogram class"""
1bd55598
RD		 2434 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2435 __repr__ = _swig_repr
2436 def __init__(self, *args, **kwargs):
5b5c9bc7 2437 """__init__(self) -> ImageHistogram"""
1bd55598 2438 _core_.ImageHistogram_swiginit(self,_core_.new_ImageHistogram(*args, **kwargs))
d55e5bfc
RD		 2439 def MakeKey(*args, **kwargs):
2440 """
7a27cf7c 2441 MakeKey(byte r, byte g, byte b) -> unsigned long
d55e5bfc
RD		 2442
2443 Get the key in the histogram for the given RGB values
2444 """
5b5c9bc7 2445 return _core_.ImageHistogram_MakeKey(*args, **kwargs)
d55e5bfc
RD		 2446
2447 MakeKey = staticmethod(MakeKey)
2448 def FindFirstUnusedColour(*args, **kwargs):
fd2dc343
RD		 2449 """
2450 FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)
2451
2452 Find first colour that is not used in the image and has higher RGB
2453 values than startR, startG, startB. Returns a tuple consisting of a
2454 success flag and rgb values.
2455 """
5b5c9bc7 2456 return _core_.ImageHistogram_FindFirstUnusedColour(*args, **kwargs)
d55e5bfc 2457
f1cbd8fa
RD		 2458 def GetCount(*args, **kwargs):
2459 """
2460 GetCount(self, unsigned long key) -> unsigned long
2461
2462 Returns the pixel count for the given key. Use `MakeKey` to create a
2463 key value from a RGB tripple.
2464 """
5b5c9bc7 2465 return _core_.ImageHistogram_GetCount(*args, **kwargs)
f1cbd8fa
RD		 2466
2467 def GetCountRGB(*args, **kwargs):
2468 """
7a27cf7c 2469 GetCountRGB(self, byte r, byte g, byte b) -> unsigned long
f1cbd8fa
RD		 2470
2471 Returns the pixel count for the given RGB values.
2472 """
5b5c9bc7 2473 return _core_.ImageHistogram_GetCountRGB(*args, **kwargs)
f1cbd8fa
RD		 2474
2475 def GetCountColour(*args, **kwargs):
2476 """
5b5c9bc7 2477 GetCountColour(self, Colour colour) -> unsigned long
f1cbd8fa
RD		 2478
2479 Returns the pixel count for the given `wx.Colour` value.
2480 """
5b5c9bc7 2481 return _core_.ImageHistogram_GetCountColour(*args, **kwargs)
f1cbd8fa 2482
2131d850 2483_core_.ImageHistogram_swigregister(ImageHistogram)
d55e5bfc 2484
5b5c9bc7 2485def ImageHistogram_MakeKey(*args, **kwargs):
1bd55598 2486 """
7a27cf7c 2487 ImageHistogram_MakeKey(byte r, byte g, byte b) -> unsigned long
d55e5bfc
RD		 2488
2489 Get the key in the histogram for the given RGB values
2490 """
1bd55598 2491 return _core_.ImageHistogram_MakeKey(*args, **kwargs)
d55e5bfc 2492
943e8dfd
RD		 2493class Image_RGBValue(object):
2494 """
2495 An object that contains values for red, green and blue which represent
2496 the value of a color. It is used by `wx.Image.HSVtoRGB` and
2497 `wx.Image.RGBtoHSV`, which converts between HSV color space and RGB
2498 color space.
2499 """
1bd55598
RD		 2500 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2501 __repr__ = _swig_repr
2502 def __init__(self, *args, **kwargs):
943e8dfd
RD		 2503 """
2504 __init__(self, byte r=0, byte g=0, byte b=0) -> Image_RGBValue
2505
2506 Constructor.
2507 """
1bd55598 2508 _core_.Image_RGBValue_swiginit(self,_core_.new_Image_RGBValue(*args, **kwargs))
943e8dfd
RD		 2509 red = property(_core_.Image_RGBValue_red_get, _core_.Image_RGBValue_red_set)
2510 green = property(_core_.Image_RGBValue_green_get, _core_.Image_RGBValue_green_set)
2511 blue = property(_core_.Image_RGBValue_blue_get, _core_.Image_RGBValue_blue_set)
2131d850 2512_core_.Image_RGBValue_swigregister(Image_RGBValue)
943e8dfd
RD		 2513
2514class Image_HSVValue(object):
2515 """
2516 An object that contains values for hue, saturation and value which
2517 represent the value of a color. It is used by `wx.Image.HSVtoRGB` and
2518 `wx.Image.RGBtoHSV`, which +converts between HSV color space and RGB
2519 color space.
2520 """
1bd55598
RD		 2521 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2522 __repr__ = _swig_repr
2523 def __init__(self, *args, **kwargs):
943e8dfd
RD		 2524 """
2525 __init__(self, double h=0.0, double s=0.0, double v=0.0) -> Image_HSVValue
2526
2527 Constructor.
2528 """
1bd55598 2529 _core_.Image_HSVValue_swiginit(self,_core_.new_Image_HSVValue(*args, **kwargs))
943e8dfd
RD		 2530 hue = property(_core_.Image_HSVValue_hue_get, _core_.Image_HSVValue_hue_set)
2531 saturation = property(_core_.Image_HSVValue_saturation_get, _core_.Image_HSVValue_saturation_set)
2532 value = property(_core_.Image_HSVValue_value_get, _core_.Image_HSVValue_value_set)
2131d850 2533_core_.Image_HSVValue_swigregister(Image_HSVValue)
943e8dfd 2534
5b5c9bc7 2535class Image(Object):
7a27cf7c
RD		 2536 """
2537 A platform-independent image class. An image can be created from
2538 data, or using `wx.Bitmap.ConvertToImage`, or loaded from a file in a
2539 variety of formats. Functions are available to set and get image
2540 bits, so it can be used for basic image manipulation.
2541
2542 A wx.Image cannot be drawn directly to a `wx.DC`. Instead, a
2543 platform-specific `wx.Bitmap` object must be created from it using the
2544 `wx.BitmapFromImage` constructor. This bitmap can then be drawn in a
2545 device context, using `wx.DC.DrawBitmap`.
2546
2547 One colour value of the image may be used as a mask colour which will
2548 lead to the automatic creation of a `wx.Mask` object associated to the
2549 bitmap object.
2550
2551 wx.Image supports alpha channel data, that is in addition to a byte
2552 for the red, green and blue colour components for each pixel it also
2553 stores a byte representing the pixel opacity. An alpha value of 0
2554 corresponds to a transparent pixel (null opacity) while a value of 255
2555 means that the pixel is 100% opaque.
2556
2557 Unlike RGB data, not all images have an alpha channel and before using
2558 `GetAlpha` you should check if this image contains an alpha channel
2559 with `HasAlpha`. Note that currently only images loaded from PNG files
2560 with transparency information will have an alpha channel.
2561 """
1bd55598
RD		 2562 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2563 __repr__ = _swig_repr
2564 def __init__(self, *args, **kwargs):
7a27cf7c
RD		 2565 """
2566 __init__(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> Image
2567
2568 Loads an image from a file.
2569 """
1bd55598
RD		 2570 _core_.Image_swiginit(self,_core_.new_Image(*args, **kwargs))
2571 __swig_destroy__ = _core_.delete_Image
2572 __del__ = lambda self : None;
d55e5bfc 2573 def Create(*args, **kwargs):
7a27cf7c
RD		 2574 """
2575 Create(self, int width, int height, bool clear=True)
2576
2577 Creates a fresh image. If clear is ``True``, the new image will be
2578 initialized to black. Otherwise, the image data will be uninitialized.
2579 """
5b5c9bc7 2580 return _core_.Image_Create(*args, **kwargs)
d55e5bfc
RD		 2581
2582 def Destroy(*args, **kwargs):
2583 """
2584 Destroy(self)
2585
7a27cf7c 2586 Destroys the image data.
d55e5bfc 2587 """
b39fe951
RD		 2588 args[0].this.own(False)
2589 return _core_.Image_Destroy(*args, **kwargs)
d55e5bfc
RD		 2590
2591 def Scale(*args, **kwargs):
7a27cf7c 2592 """
f5263701 2593 Scale(self, int width, int height, int quality=IMAGE_QUALITY_NORMAL) -> Image
7a27cf7c
RD		 2594
2595 Returns a scaled version of the image. This is also useful for scaling
2596 bitmaps in general as the only other way to scale bitmaps is to blit a
f5263701
RD		 2597 `wx.MemoryDC` into another `wx.MemoryDC`. The ``quality`` parameter
2598 specifies what method to use for resampling the image. It can be
2599 either wx.IMAGE_QUALITY_NORMAL, which uses the normal default scaling
2600 method of pixel replication, or wx.IMAGE_QUALITY_HIGH which uses
2601 bicubic and box averaging resampling methods for upsampling and
2602 downsampling respectively.
7a27cf7c 2603 """
5b5c9bc7 2604 return _core_.Image_Scale(*args, **kwargs)
d55e5bfc 2605
f5263701
RD		 2606 def ResampleBox(*args, **kwargs):
2607 """ResampleBox(self, int width, int height) -> Image"""
2608 return _core_.Image_ResampleBox(*args, **kwargs)
2609
2610 def ResampleBicubic(*args, **kwargs):
2611 """ResampleBicubic(self, int width, int height) -> Image"""
2612 return _core_.Image_ResampleBicubic(*args, **kwargs)
2613
2614 def Blur(*args, **kwargs):
2615 """
2616 Blur(self, int radius) -> Image
2617
2618 Blurs the image in both horizontal and vertical directions by the
2619 specified pixel ``radius``. This should not be used when using a
2620 single mask colour for transparency.
2621 """
2622 return _core_.Image_Blur(*args, **kwargs)
2623
2624 def BlurHorizontal(*args, **kwargs):
2625 """
2626 BlurHorizontal(self, int radius) -> Image
2627
2628 Blurs the image in the horizontal direction only. This should not be
2629 used when using a single mask colour for transparency.
2630
2631 """
2632 return _core_.Image_BlurHorizontal(*args, **kwargs)
2633
2634 def BlurVertical(*args, **kwargs):
2635 """
2636 BlurVertical(self, int radius) -> Image
2637
2638 Blurs the image in the vertical direction only. This should not be
2639 used when using a single mask colour for transparency.
2640 """
2641 return _core_.Image_BlurVertical(*args, **kwargs)
2642
d55e5bfc 2643 def ShrinkBy(*args, **kwargs):
7a27cf7c
RD		 2644 """
2645 ShrinkBy(self, int xFactor, int yFactor) -> Image
2646
2647 Return a version of the image scaled smaller by the given factors.
2648 """
5b5c9bc7 2649 return _core_.Image_ShrinkBy(*args, **kwargs)
d55e5bfc
RD		 2650
2651 def Rescale(*args, **kwargs):
7a27cf7c 2652 """
f5263701 2653 Rescale(self, int width, int height, int quality=IMAGE_QUALITY_NORMAL) -> Image
7a27cf7c
RD		 2654
2655 Changes the size of the image in-place by scaling it: after a call to
2656 this function, the image will have the given width and height.
2657
2658 Returns the (modified) image itself.
2659 """
5b5c9bc7 2660 return _core_.Image_Rescale(*args, **kwargs)
d55e5bfc 2661
aff4cc5c 2662 def Resize(*args, **kwargs):
7a27cf7c
RD		 2663 """
2664 Resize(self, Size size, Point pos, int r=-1, int g=-1, int b=-1) -> Image
2665
2666 Changes the size of the image in-place without scaling it, by adding
2667 either a border with the given colour or cropping as necessary. The
2668 image is pasted into a new image with the given size and background
2669 colour at the position pos relative to the upper left of the new
2670 image. If red = green = blue = -1 then use either the current mask
2671 colour if set or find, use, and set a suitable mask colour for any
2672 newly exposed areas.
2673
2674 Returns the (modified) image itself.
2675 """
5b5c9bc7 2676 return _core_.Image_Resize(*args, **kwargs)
aff4cc5c 2677
d55e5bfc 2678 def SetRGB(*args, **kwargs):
7a27cf7c
RD		 2679 """
2680 SetRGB(self, int x, int y, byte r, byte g, byte b)
2681
2682 Sets the pixel at the given coordinate. This routine performs
2683 bounds-checks for the coordinate so it can be considered a safe way to
2684 manipulate the data, but in some cases this might be too slow so that
2685 the data will have to be set directly. In that case you will have to
2686 get access to the image data using the `GetData` method.
2687 """
5b5c9bc7 2688 return _core_.Image_SetRGB(*args, **kwargs)
d55e5bfc 2689
aff4cc5c 2690 def SetRGBRect(*args, **kwargs):
7a27cf7c
RD		 2691 """
2692 SetRGBRect(self, Rect rect, byte r, byte g, byte b)
2693
2694 Sets the colour of the pixels within the given rectangle. This routine
2695 performs bounds-checks for the rectangle so it can be considered a
2696 safe way to manipulate the data.
2697 """
5b5c9bc7 2698 return _core_.Image_SetRGBRect(*args, **kwargs)
aff4cc5c 2699
d55e5bfc 2700 def GetRed(*args, **kwargs):
7a27cf7c
RD		 2701 """
2702 GetRed(self, int x, int y) -> byte
2703
2704 Returns the red intensity at the given coordinate.
2705 """
5b5c9bc7 2706 return _core_.Image_GetRed(*args, **kwargs)
d55e5bfc
RD		 2707
2708 def GetGreen(*args, **kwargs):
7a27cf7c
RD		 2709 """
2710 GetGreen(self, int x, int y) -> byte
2711
2712 Returns the green intensity at the given coordinate.
2713 """
5b5c9bc7 2714 return _core_.Image_GetGreen(*args, **kwargs)
d55e5bfc
RD		 2715
2716 def GetBlue(*args, **kwargs):
7a27cf7c
RD		 2717 """
2718 GetBlue(self, int x, int y) -> byte
2719
2720 Returns the blue intensity at the given coordinate.
2721 """
5b5c9bc7 2722 return _core_.Image_GetBlue(*args, **kwargs)
d55e5bfc
RD		 2723
2724 def SetAlpha(*args, **kwargs):
7a27cf7c
RD		 2725 """
2726 SetAlpha(self, int x, int y, byte alpha)
2727
2728 Sets the alpha value for the given pixel. This function should only be
2729 called if the image has alpha channel data, use `HasAlpha` to check
2730 for this.
2731 """
5b5c9bc7 2732 return _core_.Image_SetAlpha(*args, **kwargs)
d55e5bfc
RD		 2733
2734 def GetAlpha(*args, **kwargs):
7a27cf7c
RD		 2735 """
2736 GetAlpha(self, int x, int y) -> byte
2737
2738 Returns the alpha value for the given pixel. This function may only be
2739 called for the images with alpha channel, use `HasAlpha` to check for
2740 this.
2741
2742 The returned value is the *opacity* of the image, i.e. the value of 0
2743 corresponds to the fully transparent pixels while the value of 255 to
2744 the fully opaque pixels.
2745 """
5b5c9bc7 2746 return _core_.Image_GetAlpha(*args, **kwargs)
d55e5bfc
RD		 2747
2748 def HasAlpha(*args, **kwargs):
7a27cf7c
RD		 2749 """
2750 HasAlpha(self) -> bool
2751
2752 Returns true if this image has alpha channel, false otherwise.
2753 """
5b5c9bc7 2754 return _core_.Image_HasAlpha(*args, **kwargs)
d55e5bfc 2755
68350608
RD		 2756 def InitAlpha(*args, **kwargs):
2757 """
2758 InitAlpha(self)
2759
2760 Initializes the image alpha channel data. It is an error to call it if
2761 the image already has alpha data. If it doesn't, alpha data will be by
2762 default initialized to all pixels being fully opaque. But if the image
2763 has a a mask colour, all mask pixels will be completely transparent.
2764 """
5b5c9bc7
RD		 2765 return _core_.Image_InitAlpha(*args, **kwargs)
2766
2767 def IsTransparent(*args, **kwargs):
2768 """
7a27cf7c 2769 IsTransparent(self, int x, int y, byte threshold=IMAGE_ALPHA_THRESHOLD) -> bool
5b5c9bc7 2770
7a27cf7c
RD		 2771 Returns ``True`` if this pixel is masked or has an alpha value less
2772 than the spcified threshold.
5b5c9bc7
RD		 2773 """
2774 return _core_.Image_IsTransparent(*args, **kwargs)
68350608 2775
d55e5bfc 2776 def FindFirstUnusedColour(*args, **kwargs):
fd2dc343
RD		 2777 """
2778 FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)
2779
2780 Find first colour that is not used in the image and has higher RGB
2781 values than startR, startG, startB. Returns a tuple consisting of a
2782 success flag and rgb values.
2783 """
5b5c9bc7 2784 return _core_.Image_FindFirstUnusedColour(*args, **kwargs)
d55e5bfc 2785
4cf4100f
RD		 2786 def ConvertAlphaToMask(*args, **kwargs):
2787 """
5b5c9bc7 2788 ConvertAlphaToMask(self, byte threshold=IMAGE_ALPHA_THRESHOLD) -> bool
4cf4100f 2789
7a27cf7c
RD		 2790 If the image has alpha channel, this method converts it to mask. All
2791 pixels with alpha value less than ``threshold`` are replaced with the
2792 mask colour and the alpha channel is removed. The mask colour is
2793 chosen automatically using `FindFirstUnusedColour`.
4cf4100f
RD		 2794
2795 If the image image doesn't have alpha channel, ConvertAlphaToMask does
2796 nothing.
2797 """
5b5c9bc7 2798 return _core_.Image_ConvertAlphaToMask(*args, **kwargs)
4cf4100f 2799
8fb0e70a
RD		 2800 def ConvertColourToAlpha(*args, **kwargs):
2801 """
7a27cf7c 2802 ConvertColourToAlpha(self, byte r, byte g, byte b) -> bool
8fb0e70a
RD		 2803
2804 This method converts an image where the original alpha information is
2805 only available as a shades of a colour (actually shades of grey)
2806 typically when you draw anti-aliased text into a bitmap. The DC
2807 drawing routines draw grey values on the black background although
2808 they actually mean to draw white with differnt alpha values. This
2809 method reverses it, assuming a black (!) background and white text.
2810 The method will then fill up the whole image with the colour given.
2811 """
5b5c9bc7 2812 return _core_.Image_ConvertColourToAlpha(*args, **kwargs)
8fb0e70a 2813
d55e5bfc 2814 def SetMaskFromImage(*args, **kwargs):
7a27cf7c
RD		 2815 """
2816 SetMaskFromImage(self, Image mask, byte mr, byte mg, byte mb) -> bool
2817
2818 Sets the image's mask so that the pixels that have RGB value of
2819 ``(mr,mg,mb)`` in ``mask`` will be masked in this image. This is done
2820 by first finding an unused colour in the image, setting this colour as
2821 the mask colour and then using this colour to draw all pixels in the
2822 image who corresponding pixel in mask has given RGB value.
2823
2824 Returns ``False`` if ``mask`` does not have same dimensions as the
2825 image or if there is no unused colour left. Returns ``True`` if the
2826 mask was successfully applied.
2827
2828 Note that this method involves computing the histogram, which is
2829 computationally intensive operation.
2830 """
5b5c9bc7 2831 return _core_.Image_SetMaskFromImage(*args, **kwargs)
d55e5bfc
RD		 2832
2833 def CanRead(*args, **kwargs):
7a27cf7c
RD		 2834 """
2835 CanRead(String filename) -> bool
2836
2837 Returns True if the image handlers can read this file.
2838 """
5b5c9bc7 2839 return _core_.Image_CanRead(*args, **kwargs)
d55e5bfc
RD		 2840
2841 CanRead = staticmethod(CanRead)
2842 def GetImageCount(*args, **kwargs):
7a27cf7c
RD		 2843 """
2844 GetImageCount(String filename, long type=BITMAP_TYPE_ANY) -> int
2845
2846 If the image file contains more than one image and the image handler
2847 is capable of retrieving these individually, this function will return
2848 the number of available images.
2849 """
5b5c9bc7 2850 return _core_.Image_GetImageCount(*args, **kwargs)
d55e5bfc
RD		 2851
2852 GetImageCount = staticmethod(GetImageCount)
2853 def LoadFile(*args, **kwargs):
7a27cf7c
RD		 2854 """
2855 LoadFile(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> bool
2856
2857 Loads an image from a file. If no handler type is provided, the
2858 library will try to autodetect the format.
2859 """
5b5c9bc7 2860 return _core_.Image_LoadFile(*args, **kwargs)
d55e5bfc
RD		 2861
2862 def LoadMimeFile(*args, **kwargs):
7a27cf7c
RD		 2863 """
2864 LoadMimeFile(self, String name, String mimetype, int index=-1) -> bool
2865
2866 Loads an image from a file, specifying the image type with a MIME type
2867 string.
2868 """
5b5c9bc7 2869 return _core_.Image_LoadMimeFile(*args, **kwargs)
d55e5bfc
RD		 2870
2871 def SaveFile(*args, **kwargs):
7a27cf7c
RD		 2872 """
2873 SaveFile(self, String name, int type) -> bool
2874
2875 Saves an image in the named file.
2876 """
5b5c9bc7 2877 return _core_.Image_SaveFile(*args, **kwargs)
d55e5bfc
RD		 2878
2879 def SaveMimeFile(*args, **kwargs):
7a27cf7c
RD		 2880 """
2881 SaveMimeFile(self, String name, String mimetype) -> bool
2882
2883 Saves an image in the named file.
2884 """
5b5c9bc7 2885 return _core_.Image_SaveMimeFile(*args, **kwargs)
d55e5bfc
RD		 2886
2887 def CanReadStream(*args, **kwargs):
7a27cf7c
RD		 2888 """
2889 CanReadStream(InputStream stream) -> bool
2890
2891 Returns True if the image handlers can read an image file from the
2892 data currently on the input stream, or a readable Python file-like
2893 object.
2894 """
5b5c9bc7 2895 return _core_.Image_CanReadStream(*args, **kwargs)
d55e5bfc
RD		 2896
2897 CanReadStream = staticmethod(CanReadStream)
2898 def LoadStream(*args, **kwargs):
7a27cf7c
RD		 2899 """
2900 LoadStream(self, InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> bool
2901
2902 Loads an image from an input stream or a readable Python file-like
2903 object. If no handler type is provided, the library will try to
2904 autodetect the format.
2905 """
5b5c9bc7 2906 return _core_.Image_LoadStream(*args, **kwargs)
d55e5bfc
RD		 2907
2908 def LoadMimeStream(*args, **kwargs):
7a27cf7c
RD		 2909 """
2910 LoadMimeStream(self, InputStream stream, String mimetype, int index=-1) -> bool
2911
2912 Loads an image from an input stream or a readable Python file-like
2913 object, using a MIME type string to specify the image file format.
2914 """
5b5c9bc7 2915 return _core_.Image_LoadMimeStream(*args, **kwargs)
d55e5bfc 2916
b39fe951 2917 def IsOk(*args, **kwargs):
7a27cf7c 2918 """
b39fe951 2919 IsOk(self) -> bool
7a27cf7c
RD		 2920
2921 Returns true if image data is present.
2922 """
b39fe951 2923 return _core_.Image_IsOk(*args, **kwargs)
d55e5bfc 2924
b39fe951 2925 Ok = IsOk
d55e5bfc 2926 def GetWidth(*args, **kwargs):
7a27cf7c
RD		 2927 """
2928 GetWidth(self) -> int
2929
2930 Gets the width of the image in pixels.
2931 """
5b5c9bc7 2932 return _core_.Image_GetWidth(*args, **kwargs)
d55e5bfc
RD		 2933
2934 def GetHeight(*args, **kwargs):
7a27cf7c
RD		 2935 """
2936 GetHeight(self) -> int
2937
2938 Gets the height of the image in pixels.
2939 """
5b5c9bc7 2940 return _core_.Image_GetHeight(*args, **kwargs)
d55e5bfc
RD		 2941
2942 def GetSize(*args, **kwargs):
7a27cf7c
RD		 2943 """
2944 GetSize(self) -> Size
2945
2946 Returns the size of the image in pixels.
2947 """
5b5c9bc7 2948 return _core_.Image_GetSize(*args, **kwargs)
d55e5bfc
RD		 2949
2950 def GetSubImage(*args, **kwargs):
7a27cf7c
RD		 2951 """
2952 GetSubImage(self, Rect rect) -> Image
2953
2954 Returns a sub image of the current one as long as the rect belongs
2955 entirely to the image.
2956 """
5b5c9bc7 2957 return _core_.Image_GetSubImage(*args, **kwargs)
d55e5bfc 2958
aff4cc5c 2959 def Size(*args, **kwargs):
7a27cf7c
RD		 2960 """
2961 Size(self, Size size, Point pos, int r=-1, int g=-1, int b=-1) -> Image
2962
2963 Returns a resized version of this image without scaling it by adding
2964 either a border with the given colour or cropping as necessary. The
2965 image is pasted into a new image with the given size and background
2966 colour at the position ``pos`` relative to the upper left of the new
2967 image. If red = green = blue = -1 then use either the current mask
2968 colour if set or find, use, and set a suitable mask colour for any
2969 newly exposed areas.
2970 """
5b5c9bc7 2971 return _core_.Image_Size(*args, **kwargs)
aff4cc5c 2972
d55e5bfc 2973 def Copy(*args, **kwargs):
7a27cf7c
RD		 2974 """
2975 Copy(self) -> Image
2976
2977 Returns an identical copy of the image.
2978 """
5b5c9bc7 2979 return _core_.Image_Copy(*args, **kwargs)
d55e5bfc
RD		 2980
2981 def Paste(*args, **kwargs):
7a27cf7c
RD		 2982 """
2983 Paste(self, Image image, int x, int y)
2984
2985 Pastes ``image`` into this instance and takes care of the mask colour
2986 and any out of bounds problems.
2987 """
5b5c9bc7 2988 return _core_.Image_Paste(*args, **kwargs)
d55e5bfc
RD		 2989
2990 def GetData(*args, **kwargs):
bb2ef2cc
RD		 2991 """
2992 GetData(self) -> PyObject
2993
2994 Returns a string containing a copy of the RGB bytes of the image.
2995 """
5b5c9bc7 2996 return _core_.Image_GetData(*args, **kwargs)
d55e5bfc
RD		 2997
2998 def SetData(*args, **kwargs):
bb2ef2cc
RD		 2999 """
3000 SetData(self, buffer data)
3001
3002 Resets the Image's RGB data from a buffer of RGB bytes. Accepts
3003 either a string or a buffer object holding the data and the length of
3004 the data must be width*height*3.
3005 """
5b5c9bc7 3006 return _core_.Image_SetData(*args, **kwargs)
d55e5bfc
RD		 3007
3008 def GetDataBuffer(*args, **kwargs):
bb2ef2cc
RD		 3009 """
3010 GetDataBuffer(self) -> PyObject
3011
3012 Returns a writable Python buffer object that is pointing at the RGB
7a27cf7c
RD		 3013 image data buffer inside the wx.Image. You need to ensure that you do
3014 not use this buffer object after the image has been destroyed.
bb2ef2cc 3015 """
5b5c9bc7 3016 return _core_.Image_GetDataBuffer(*args, **kwargs)
d55e5bfc
RD		 3017
3018 def SetDataBuffer(*args, **kwargs):
bb2ef2cc
RD		 3019 """
3020 SetDataBuffer(self, buffer data)
3021
3022 Sets the internal image data pointer to point at a Python buffer
7a27cf7c
RD		 3023 object. This can save making an extra copy of the data but you must
3024 ensure that the buffer object lives longer than the wx.Image does.
bb2ef2cc 3025 """
5b5c9bc7 3026 return _core_.Image_SetDataBuffer(*args, **kwargs)
d55e5bfc
RD		 3027
3028 def GetAlphaData(*args, **kwargs):
bb2ef2cc
RD		 3029 """
3030 GetAlphaData(self) -> PyObject
3031
3032 Returns a string containing a copy of the alpha bytes of the image.
3033 """
5b5c9bc7 3034 return _core_.Image_GetAlphaData(*args, **kwargs)
d55e5bfc
RD		 3035
3036 def SetAlphaData(*args, **kwargs):
bb2ef2cc
RD		 3037 """
3038 SetAlphaData(self, buffer alpha)
3039
3040 Resets the Image's alpha data from a buffer of bytes. Accepts either
3041 a string or a buffer object holding the data and the length of the
3042 data must be width*height.
3043 """
5b5c9bc7 3044 return _core_.Image_SetAlphaData(*args, **kwargs)
d55e5bfc
RD		 3045
3046 def GetAlphaBuffer(*args, **kwargs):
fc46b7f3
RD		 3047 """
3048 GetAlphaBuffer(self) -> PyObject
3049
3050 Returns a writable Python buffer object that is pointing at the Alpha
3051 data buffer inside the wx.Image. You need to ensure that you do not
3052 use this buffer object after the image has been destroyed.
3053 """
5b5c9bc7 3054 return _core_.Image_GetAlphaBuffer(*args, **kwargs)
d55e5bfc
RD		 3055
3056 def SetAlphaBuffer(*args, **kwargs):
fc46b7f3
RD		 3057 """
3058 SetAlphaBuffer(self, buffer alpha)
3059
3060 Sets the internal image alpha pointer to point at a Python buffer
3061 object. This can save making an extra copy of the data but you must
3062 ensure that the buffer object lives as long as the wx.Image does.
3063 """
5b5c9bc7 3064 return _core_.Image_SetAlphaBuffer(*args, **kwargs)
d55e5bfc
RD		 3065
3066 def SetMaskColour(*args, **kwargs):
7a27cf7c
RD		 3067 """
3068 SetMaskColour(self, byte r, byte g, byte b)
3069
3070 Sets the mask colour for this image (and tells the image to use the
3071 mask).
3072 """
5b5c9bc7 3073 return _core_.Image_SetMaskColour(*args, **kwargs)
d55e5bfc 3074
aff4cc5c
RD		 3075 def GetOrFindMaskColour(*args, **kwargs):
3076 """
3077 GetOrFindMaskColour() -> (r,g,b)
3078
3079 Get the current mask colour or find a suitable colour.
3080 """
5b5c9bc7 3081 return _core_.Image_GetOrFindMaskColour(*args, **kwargs)
aff4cc5c 3082
d55e5bfc 3083 def GetMaskRed(*args, **kwargs):
7a27cf7c
RD		 3084 """
3085 GetMaskRed(self) -> byte
3086
3087 Gets the red component of the mask colour.
3088 """
5b5c9bc7 3089 return _core_.Image_GetMaskRed(*args, **kwargs)
d55e5bfc
RD		 3090
3091 def GetMaskGreen(*args, **kwargs):
7a27cf7c
RD		 3092 """
3093 GetMaskGreen(self) -> byte
3094
3095 Gets the green component of the mask colour.
3096 """
5b5c9bc7 3097 return _core_.Image_GetMaskGreen(*args, **kwargs)
d55e5bfc
RD		 3098
3099 def GetMaskBlue(*args, **kwargs):
7a27cf7c
RD		 3100 """
3101 GetMaskBlue(self) -> byte
3102
3103 Gets the blue component of the mask colour.
3104 """
5b5c9bc7 3105 return _core_.Image_GetMaskBlue(*args, **kwargs)
d55e5bfc
RD		 3106
3107 def SetMask(*args, **kwargs):
7a27cf7c
RD		 3108 """
3109 SetMask(self, bool mask=True)
3110
3111 Specifies whether there is a mask or not. The area of the mask is
3112 determined by the current mask colour.
3113 """
5b5c9bc7 3114 return _core_.Image_SetMask(*args, **kwargs)
d55e5bfc
RD		 3115
3116 def HasMask(*args, **kwargs):
7a27cf7c
RD		 3117 """
3118 HasMask(self) -> bool
3119
3120 Returns ``True`` if there is a mask active, ``False`` otherwise.
3121 """
5b5c9bc7 3122 return _core_.Image_HasMask(*args, **kwargs)
d55e5bfc
RD		 3123
3124 def Rotate(*args, **kwargs):
3125 """
5b5c9bc7
RD		 3126 Rotate(self, double angle, Point centre_of_rotation, bool interpolating=True,
3127 Point offset_after_rotation=None) -> Image
7a27cf7c
RD		 3128
3129 Rotates the image about the given point, by ``angle`` radians. Passing
3130 ``True`` to ``interpolating`` results in better image quality, but is
3131 slower. If the image has a mask, then the mask colour is used for the
3132 uncovered pixels in the rotated image background. Otherwise, black
3133 will be used as the fill colour.
3134
3135 Returns the rotated image, leaving this image intact.
d55e5bfc 3136 """
5b5c9bc7 3137 return _core_.Image_Rotate(*args, **kwargs)
d55e5bfc
RD		 3138
3139 def Rotate90(*args, **kwargs):
7a27cf7c
RD		 3140 """
3141 Rotate90(self, bool clockwise=True) -> Image
3142
3143 Returns a copy of the image rotated 90 degrees in the direction
3144 indicated by ``clockwise``.
3145 """
5b5c9bc7 3146 return _core_.Image_Rotate90(*args, **kwargs)
d55e5bfc
RD		 3147
3148 def Mirror(*args, **kwargs):
7a27cf7c
RD		 3149 """
3150 Mirror(self, bool horizontally=True) -> Image
3151
3152 Returns a mirrored copy of the image. The parameter ``horizontally``
3153 indicates the orientation.
3154 """
5b5c9bc7 3155 return _core_.Image_Mirror(*args, **kwargs)
d55e5bfc
RD		 3156
3157 def Replace(*args, **kwargs):
3158 """
7a27cf7c
RD		 3159 Replace(self, byte r1, byte g1, byte b1, byte r2, byte g2, byte b2)
3160
3161 Replaces the colour specified by ``(r1,g1,b1)`` by the colour
3162 ``(r2,g2,b2)``.
d55e5bfc 3163 """
5b5c9bc7 3164 return _core_.Image_Replace(*args, **kwargs)
d55e5bfc 3165
32fe5131
RD		 3166 def ConvertToGreyscale(*args, **kwargs):
3167 """
3168 ConvertToGreyscale(self, double lr=0.299, double lg=0.587, double lb=0.114) -> Image
3169
3170 Convert to greyscale image. Uses the luminance component (Y) of the
3171 image. The luma value (YUV) is calculated using (R * lr) + (G * lg) + (B * lb),
3172 defaults to ITU-T BT.601
3173 """
3174 return _core_.Image_ConvertToGreyscale(*args, **kwargs)
3175
d55e5bfc 3176 def ConvertToMono(*args, **kwargs):
7a27cf7c
RD		 3177 """
3178 ConvertToMono(self, byte r, byte g, byte b) -> Image
3179
3180 Returns monochromatic version of the image. The returned image has
3181 white colour where the original has ``(r,g,b)`` colour and black
3182 colour everywhere else.
3183 """
5b5c9bc7 3184 return _core_.Image_ConvertToMono(*args, **kwargs)
d55e5bfc
RD		 3185
3186 def SetOption(*args, **kwargs):
7a27cf7c
RD		 3187 """
3188 SetOption(self, String name, String value)
3189
3190 Sets an image handler defined option. For example, when saving as a
3191 JPEG file, the option ``wx.IMAGE_OPTION_QUALITY`` is used, which is a
3192 number between 0 and 100 (0 is terrible, 100 is very good).
3193 """
5b5c9bc7 3194 return _core_.Image_SetOption(*args, **kwargs)
d55e5bfc
RD		 3195
3196 def SetOptionInt(*args, **kwargs):
7a27cf7c
RD		 3197 """
3198 SetOptionInt(self, String name, int value)
3199
3200 Sets an image option as an integer.
3201 """
5b5c9bc7 3202 return _core_.Image_SetOptionInt(*args, **kwargs)
d55e5bfc
RD		 3203
3204 def GetOption(*args, **kwargs):
7a27cf7c
RD		 3205 """
3206 GetOption(self, String name) -> String
3207
3208 Gets the value of an image handler option.
3209 """
5b5c9bc7 3210 return _core_.Image_GetOption(*args, **kwargs)
d55e5bfc
RD		 3211
3212 def GetOptionInt(*args, **kwargs):
7a27cf7c
RD		 3213 """
3214 GetOptionInt(self, String name) -> int
3215
3216 Gets the value of an image handler option as an integer. If the given
3217 option is not present, the function returns 0.
3218 """
5b5c9bc7 3219 return _core_.Image_GetOptionInt(*args, **kwargs)
d55e5bfc
RD		 3220
3221 def HasOption(*args, **kwargs):
7a27cf7c
RD		 3222 """
3223 HasOption(self, String name) -> bool
3224
3225 Returns true if the given option is present.
3226 """
5b5c9bc7 3227 return _core_.Image_HasOption(*args, **kwargs)
d55e5bfc
RD		 3228
3229 def CountColours(*args, **kwargs):
3230 """CountColours(self, unsigned long stopafter=(unsigned long) -1) -> unsigned long"""
5b5c9bc7 3231 return _core_.Image_CountColours(*args, **kwargs)
d55e5bfc
RD		 3232
3233 def ComputeHistogram(*args, **kwargs):
5b5c9bc7
RD		 3234 """ComputeHistogram(self, ImageHistogram h) -> unsigned long"""
3235 return _core_.Image_ComputeHistogram(*args, **kwargs)
d55e5bfc
RD		 3236
3237 def AddHandler(*args, **kwargs):
5b5c9bc7
RD		 3238 """AddHandler(ImageHandler handler)"""
3239 return _core_.Image_AddHandler(*args, **kwargs)
d55e5bfc
RD		 3240
3241 AddHandler = staticmethod(AddHandler)
3242 def InsertHandler(*args, **kwargs):
5b5c9bc7
RD		 3243 """InsertHandler(ImageHandler handler)"""
3244 return _core_.Image_InsertHandler(*args, **kwargs)
d55e5bfc
RD		 3245
3246 InsertHandler = staticmethod(InsertHandler)
3247 def RemoveHandler(*args, **kwargs):
5b5c9bc7
RD		 3248 """RemoveHandler(String name) -> bool"""
3249 return _core_.Image_RemoveHandler(*args, **kwargs)
d55e5bfc
RD		 3250
3251 RemoveHandler = staticmethod(RemoveHandler)
1bd55598
RD		 3252 def GetHandlers(*args, **kwargs):
3253 """GetHandlers() -> PyObject"""
3254 return _core_.Image_GetHandlers(*args, **kwargs)
3255
3256 GetHandlers = staticmethod(GetHandlers)
d55e5bfc 3257 def GetImageExtWildcard(*args, **kwargs):
7a27cf7c
RD		 3258 """
3259 GetImageExtWildcard() -> String
3260
3261 Iterates all registered wxImageHandler objects, and returns a string
3262 containing file extension masks suitable for passing to file open/save
3263 dialog boxes.
3264 """
5b5c9bc7 3265 return _core_.Image_GetImageExtWildcard(*args, **kwargs)
d55e5bfc
RD		 3266
3267 GetImageExtWildcard = staticmethod(GetImageExtWildcard)
3268 def ConvertToBitmap(*args, **kwargs):
5b5c9bc7
RD		 3269 """ConvertToBitmap(self, int depth=-1) -> Bitmap"""
3270 return _core_.Image_ConvertToBitmap(*args, **kwargs)
d55e5bfc
RD		 3271
3272 def ConvertToMonoBitmap(*args, **kwargs):
7a27cf7c 3273 """ConvertToMonoBitmap(self, byte red, byte green, byte blue) -> Bitmap"""
5b5c9bc7 3274 return _core_.Image_ConvertToMonoBitmap(*args, **kwargs)
d55e5bfc 3275
943e8dfd
RD		 3276 def RotateHue(*args, **kwargs):
3277 """
3278 RotateHue(self, double angle)
3279
3280 Rotates the hue of each pixel of the image. Hue is a double in the
3281 range -1.0..1.0 where -1.0 is -360 degrees and 1.0 is 360 degrees
3282 """
3283 return _core_.Image_RotateHue(*args, **kwargs)
3284
3285 def RGBtoHSV(*args, **kwargs):
3286 """
3287 RGBtoHSV(Image_RGBValue rgb) -> Image_HSVValue
3288
3289 Converts a color in RGB color space to HSV color space.
3290 """
3291 return _core_.Image_RGBtoHSV(*args, **kwargs)
3292
3293 RGBtoHSV = staticmethod(RGBtoHSV)
3294 def HSVtoRGB(*args, **kwargs):
3295 """
3296 HSVtoRGB(Image_HSVValue hsv) -> Image_RGBValue
3297
3298 Converts a color in HSV color space to RGB color space.
3299 """
3300 return _core_.Image_HSVtoRGB(*args, **kwargs)
3301
3302 HSVtoRGB = staticmethod(HSVtoRGB)
b39fe951 3303 def __nonzero__(self): return self.IsOk()
ac5d357a
RD		 3304 AlphaBuffer = property(GetAlphaBuffer,SetAlphaBuffer,doc="See `GetAlphaBuffer` and `SetAlphaBuffer`")
3305 AlphaData = property(GetAlphaData,SetAlphaData,doc="See `GetAlphaData` and `SetAlphaData`")
3306 Data = property(GetData,SetData,doc="See `GetData` and `SetData`")
3307 DataBuffer = property(GetDataBuffer,SetDataBuffer,doc="See `GetDataBuffer` and `SetDataBuffer`")
3308 Height = property(GetHeight,doc="See `GetHeight`")
3309 MaskBlue = property(GetMaskBlue,doc="See `GetMaskBlue`")
3310 MaskGreen = property(GetMaskGreen,doc="See `GetMaskGreen`")
3311 MaskRed = property(GetMaskRed,doc="See `GetMaskRed`")
ac5d357a 3312 Width = property(GetWidth,doc="See `GetWidth`")
2131d850 3313_core_.Image_swigregister(Image)
d55e5bfc
RD		 3314
3315def ImageFromMime(*args, **kwargs):
7a27cf7c
RD		 3316 """
3317 ImageFromMime(String name, String mimetype, int index=-1) -> Image
3318
3319 Loads an image from a file, using a MIME type string (such as
3320 'image/jpeg') to specify image type.
3321 """
5b5c9bc7 3322 val = _core_.new_ImageFromMime(*args, **kwargs)
d55e5bfc
RD		 3323 return val
3324
3325def ImageFromStream(*args, **kwargs):
7a27cf7c
RD		 3326 """
3327 ImageFromStream(InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> Image
3328
3329 Loads an image from an input stream, or any readable Python file-like
3330 object.
3331 """
5b5c9bc7 3332 val = _core_.new_ImageFromStream(*args, **kwargs)
d55e5bfc
RD		 3333 return val
3334
3335def ImageFromStreamMime(*args, **kwargs):
7a27cf7c
RD		 3336 """
3337 ImageFromStreamMime(InputStream stream, String mimetype, int index=-1) -> Image
3338
3339 Loads an image from an input stream, or any readable Python file-like
3340 object, specifying the image format with a MIME type string.
3341 """
5b5c9bc7 3342 val = _core_.new_ImageFromStreamMime(*args, **kwargs)
d55e5bfc
RD		 3343 return val
3344
d6c14a4c 3345def EmptyImage(*args, **kwargs):
bb2ef2cc 3346 """
5b5c9bc7 3347 EmptyImage(int width=0, int height=0, bool clear=True) -> Image
bb2ef2cc
RD		 3348
3349 Construct an empty image of a given size, optionally setting all
3350 pixels to black.
3351 """
5b5c9bc7 3352 val = _core_.new_EmptyImage(*args, **kwargs)
d55e5bfc
RD		 3353 return val
3354
3355def ImageFromBitmap(*args, **kwargs):
bb2ef2cc 3356 """
5b5c9bc7 3357 ImageFromBitmap(Bitmap bitmap) -> Image
bb2ef2cc
RD		 3358
3359 Construct an Image from a `wx.Bitmap`.
3360 """
5b5c9bc7 3361 val = _core_.new_ImageFromBitmap(*args, **kwargs)
d55e5bfc
RD		 3362 return val
3363
3364def ImageFromData(*args, **kwargs):
bb2ef2cc 3365 """
5b5c9bc7 3366 ImageFromData(int width, int height, buffer data) -> Image
bb2ef2cc
RD		 3367
3368 Construct an Image from a buffer of RGB bytes. Accepts either a
3369 string or a buffer object holding the data and the length of the data
3370 must be width*height*3.
3371 """
5b5c9bc7 3372 val = _core_.new_ImageFromData(*args, **kwargs)
d55e5bfc
RD		 3373 return val
3374
03e46024 3375def ImageFromDataWithAlpha(*args, **kwargs):
bb2ef2cc 3376 """
5b5c9bc7 3377 ImageFromDataWithAlpha(int width, int height, buffer data, buffer alpha) -> Image
bb2ef2cc
RD		 3378
3379 Construct an Image from a buffer of RGB bytes with an Alpha channel.
3380 Accepts either a string or a buffer object holding the data and the
7a27cf7c
RD		 3381 length of the data must be width*height*3 bytes, and the length of the
3382 alpha data must be width*height bytes.
bb2ef2cc 3383 """
5b5c9bc7 3384 val = _core_.new_ImageFromDataWithAlpha(*args, **kwargs)
03e46024
RD		 3385 return val
3386
5b5c9bc7 3387def Image_CanRead(*args, **kwargs):
1bd55598 3388 """
7a27cf7c
RD		 3389 Image_CanRead(String filename) -> bool
3390
3391 Returns True if the image handlers can read this file.
3392 """
1bd55598 3393 return _core_.Image_CanRead(*args, **kwargs)
d55e5bfc 3394
5b5c9bc7 3395def Image_GetImageCount(*args, **kwargs):
1bd55598 3396 """
7a27cf7c
RD		 3397 Image_GetImageCount(String filename, long type=BITMAP_TYPE_ANY) -> int
3398
3399 If the image file contains more than one image and the image handler
3400 is capable of retrieving these individually, this function will return
3401 the number of available images.
3402 """
1bd55598 3403 return _core_.Image_GetImageCount(*args, **kwargs)
d55e5bfc 3404
5b5c9bc7 3405def Image_CanReadStream(*args, **kwargs):
1bd55598 3406 """
7a27cf7c
RD		 3407 Image_CanReadStream(InputStream stream) -> bool
3408
3409 Returns True if the image handlers can read an image file from the
3410 data currently on the input stream, or a readable Python file-like
3411 object.
3412 """
1bd55598 3413 return _core_.Image_CanReadStream(*args, **kwargs)
d55e5bfc 3414
5b5c9bc7 3415def Image_AddHandler(*args, **kwargs):
1bd55598
RD		 3416 """Image_AddHandler(ImageHandler handler)"""
3417 return _core_.Image_AddHandler(*args, **kwargs)
d55e5bfc 3418
5b5c9bc7 3419def Image_InsertHandler(*args, **kwargs):
1bd55598
RD		 3420 """Image_InsertHandler(ImageHandler handler)"""
3421 return _core_.Image_InsertHandler(*args, **kwargs)
d55e5bfc 3422
5b5c9bc7 3423def Image_RemoveHandler(*args, **kwargs):
1bd55598
RD		 3424 """Image_RemoveHandler(String name) -> bool"""
3425 return _core_.Image_RemoveHandler(*args, **kwargs)
d55e5bfc 3426
1bd55598
RD		 3427def Image_GetHandlers(*args):
3428 """Image_GetHandlers() -> PyObject"""
3429 return _core_.Image_GetHandlers(*args)
3430
3431def Image_GetImageExtWildcard(*args):
3432 """
7a27cf7c
RD		 3433 Image_GetImageExtWildcard() -> String
3434
3435 Iterates all registered wxImageHandler objects, and returns a string
3436 containing file extension masks suitable for passing to file open/save
3437 dialog boxes.
3438 """
1bd55598 3439 return _core_.Image_GetImageExtWildcard(*args)
d55e5bfc 3440
943e8dfd 3441def Image_RGBtoHSV(*args, **kwargs):
1bd55598 3442 """
943e8dfd
RD		 3443 Image_RGBtoHSV(Image_RGBValue rgb) -> Image_HSVValue
3444
3445 Converts a color in RGB color space to HSV color space.
3446 """
1bd55598 3447 return _core_.Image_RGBtoHSV(*args, **kwargs)
943e8dfd
RD		 3448
3449def Image_HSVtoRGB(*args, **kwargs):
1bd55598 3450 """
943e8dfd
RD		 3451 Image_HSVtoRGB(Image_HSVValue hsv) -> Image_RGBValue
3452
3453 Converts a color in HSV color space to RGB color space.
3454 """
1bd55598 3455 return _core_.Image_HSVtoRGB(*args, **kwargs)
943e8dfd 3456
fc46b7f3
RD		 3457
3458def _ImageFromBuffer(*args, **kwargs):
3459 """_ImageFromBuffer(int width, int height, buffer data, buffer alpha=None) -> Image"""
3460 return _core_._ImageFromBuffer(*args, **kwargs)
3461def ImageFromBuffer(width, height, dataBuffer, alphaBuffer=None):
3462 """
3463 Creates a `wx.Image` from the data in dataBuffer. The dataBuffer
eec1c382
RD		 3464 parameter must be a Python object that implements the buffer interface,
3465 such as a string, array, etc. The dataBuffer object is expected to
3466 contain a series of RGB bytes and be width*height*3 bytes long. A buffer
3467 object can optionally be supplied for the image's alpha channel data, and
3468 it is expected to be width*height bytes long.
fc46b7f3
RD		 3469
3470 The wx.Image will be created with its data and alpha pointers initialized
3471 to the memory address pointed to by the buffer objects, thus saving the
3472 time needed to copy the image data from the buffer object to the wx.Image.
3473 While this has advantages, it also has the shoot-yourself-in-the-foot
3474 risks associated with sharing a C pointer between two objects.
3475
3476 To help alleviate the risk a reference to the data and alpha buffer
3477 objects are kept with the wx.Image, so that they won't get deleted until
3478 after the wx.Image is deleted. However please be aware that it is not
3479 guaranteed that an object won't move its memory buffer to a new location
3480 when it needs to resize its contents. If that happens then the wx.Image
3481 will end up referring to an invalid memory location and could cause the
3482 application to crash. Therefore care should be taken to not manipulate
3483 the objects used for the data and alpha buffers in a way that would cause
3484 them to change size.
3485 """
fc46b7f3
RD		 3486 image = _core_._ImageFromBuffer(width, height, dataBuffer, alphaBuffer)
3487 image._buffer = dataBuffer
3488 image._alpha = alphaBuffer
3489 return image
3490
68e533f8
RD		 3491def InitAllImageHandlers():
3492 """
3493 The former functionality of InitAllImageHanders is now done internal to
3494 the _core_ extension module and so this function has become a simple NOP.
3495 """
3496 pass
d55e5bfc 3497
5b5c9bc7
RD		 3498IMAGE_RESOLUTION_INCHES = _core_.IMAGE_RESOLUTION_INCHES
3499IMAGE_RESOLUTION_CM = _core_.IMAGE_RESOLUTION_CM
3500PNG_TYPE_COLOUR = _core_.PNG_TYPE_COLOUR
3501PNG_TYPE_GREY = _core_.PNG_TYPE_GREY
3502PNG_TYPE_GREY_RED = _core_.PNG_TYPE_GREY_RED
3503BMP_24BPP = _core_.BMP_24BPP
3504BMP_8BPP = _core_.BMP_8BPP
3505BMP_8BPP_GREY = _core_.BMP_8BPP_GREY
3506BMP_8BPP_GRAY = _core_.BMP_8BPP_GRAY
3507BMP_8BPP_RED = _core_.BMP_8BPP_RED
3508BMP_8BPP_PALETTE = _core_.BMP_8BPP_PALETTE
3509BMP_4BPP = _core_.BMP_4BPP
3510BMP_1BPP = _core_.BMP_1BPP
3511BMP_1BPP_BW = _core_.BMP_1BPP_BW
3512class BMPHandler(ImageHandler):
27fb7603 3513 """A `wx.ImageHandler` for \*.bmp bitmap files."""
1bd55598
RD		 3514 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3515 __repr__ = _swig_repr
3516 def __init__(self, *args, **kwargs):
27fb7603
RD		 3517 """
3518 __init__(self) -> BMPHandler
3519
3520 A `wx.ImageHandler` for \*.bmp bitmap files.
3521 """
1bd55598 3522 _core_.BMPHandler_swiginit(self,_core_.new_BMPHandler(*args, **kwargs))
2131d850 3523_core_.BMPHandler_swigregister(BMPHandler)
5b5c9bc7 3524NullImage = cvar.NullImage
68350608 3525IMAGE_OPTION_FILENAME = cvar.IMAGE_OPTION_FILENAME
d55e5bfc
RD		 3526IMAGE_OPTION_BMP_FORMAT = cvar.IMAGE_OPTION_BMP_FORMAT
3527IMAGE_OPTION_CUR_HOTSPOT_X = cvar.IMAGE_OPTION_CUR_HOTSPOT_X
3528IMAGE_OPTION_CUR_HOTSPOT_Y = cvar.IMAGE_OPTION_CUR_HOTSPOT_Y
3529IMAGE_OPTION_RESOLUTION = cvar.IMAGE_OPTION_RESOLUTION
68350608
RD		 3530IMAGE_OPTION_RESOLUTIONX = cvar.IMAGE_OPTION_RESOLUTIONX
3531IMAGE_OPTION_RESOLUTIONY = cvar.IMAGE_OPTION_RESOLUTIONY
d55e5bfc 3532IMAGE_OPTION_RESOLUTIONUNIT = cvar.IMAGE_OPTION_RESOLUTIONUNIT
24d7cbea 3533IMAGE_OPTION_QUALITY = cvar.IMAGE_OPTION_QUALITY
68350608
RD		 3534IMAGE_OPTION_BITSPERSAMPLE = cvar.IMAGE_OPTION_BITSPERSAMPLE
3535IMAGE_OPTION_SAMPLESPERPIXEL = cvar.IMAGE_OPTION_SAMPLESPERPIXEL
3536IMAGE_OPTION_COMPRESSION = cvar.IMAGE_OPTION_COMPRESSION
3537IMAGE_OPTION_IMAGEDESCRIPTOR = cvar.IMAGE_OPTION_IMAGEDESCRIPTOR
7fbf8399
RD		 3538IMAGE_OPTION_PNG_FORMAT = cvar.IMAGE_OPTION_PNG_FORMAT
3539IMAGE_OPTION_PNG_BITDEPTH = cvar.IMAGE_OPTION_PNG_BITDEPTH
d55e5bfc 3540
5b5c9bc7 3541class ICOHandler(BMPHandler):
27fb7603 3542 """A `wx.ImageHandler` for \*.ico icon files."""
1bd55598
RD		 3543 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3544 __repr__ = _swig_repr
3545 def __init__(self, *args, **kwargs):
27fb7603
RD		 3546 """
3547 __init__(self) -> ICOHandler
3548
3549 A `wx.ImageHandler` for \*.ico icon files.
3550 """
1bd55598 3551 _core_.ICOHandler_swiginit(self,_core_.new_ICOHandler(*args, **kwargs))
2131d850 3552_core_.ICOHandler_swigregister(ICOHandler)
d55e5bfc 3553
5b5c9bc7 3554class CURHandler(ICOHandler):
27fb7603 3555 """A `wx.ImageHandler` for \*.cur cursor files."""
1bd55598
RD		 3556 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3557 __repr__ = _swig_repr
3558 def __init__(self, *args, **kwargs):
27fb7603
RD		 3559 """
3560 __init__(self) -> CURHandler
3561
3562 A `wx.ImageHandler` for \*.cur cursor files.
3563 """
1bd55598 3564 _core_.CURHandler_swiginit(self,_core_.new_CURHandler(*args, **kwargs))
2131d850 3565_core_.CURHandler_swigregister(CURHandler)
d55e5bfc 3566
5b5c9bc7 3567class ANIHandler(CURHandler):
27fb7603 3568 """A `wx.ImageHandler` for \*.ani animated cursor files."""
1bd55598
RD		 3569 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3570 __repr__ = _swig_repr
3571 def __init__(self, *args, **kwargs):
27fb7603
RD		 3572 """
3573 __init__(self) -> ANIHandler
3574
3575 A `wx.ImageHandler` for \*.ani animated cursor files.
3576 """
1bd55598 3577 _core_.ANIHandler_swiginit(self,_core_.new_ANIHandler(*args, **kwargs))
2131d850 3578_core_.ANIHandler_swigregister(ANIHandler)
d55e5bfc 3579
5b5c9bc7 3580class PNGHandler(ImageHandler):
27fb7603 3581 """A `wx.ImageHandler` for PNG image files."""
1bd55598
RD		 3582 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3583 __repr__ = _swig_repr
3584 def __init__(self, *args, **kwargs):
27fb7603
RD		 3585 """
3586 __init__(self) -> PNGHandler
3587
3588 A `wx.ImageHandler` for PNG image files.
3589 """
1bd55598 3590 _core_.PNGHandler_swiginit(self,_core_.new_PNGHandler(*args, **kwargs))
2131d850 3591_core_.PNGHandler_swigregister(PNGHandler)
d55e5bfc 3592
5b5c9bc7 3593class GIFHandler(ImageHandler):
27fb7603 3594 """A `wx.ImageHandler` for GIF image files."""
1bd55598
RD		 3595 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3596 __repr__ = _swig_repr
3597 def __init__(self, *args, **kwargs):
27fb7603
RD		 3598 """
3599 __init__(self) -> GIFHandler
3600
3601 A `wx.ImageHandler` for GIF image files.
3602 """
1bd55598 3603 _core_.GIFHandler_swiginit(self,_core_.new_GIFHandler(*args, **kwargs))
2131d850 3604_core_.GIFHandler_swigregister(GIFHandler)
d55e5bfc 3605
5b5c9bc7 3606class PCXHandler(ImageHandler):
27fb7603 3607 """A `wx.ImageHandler` for PCX imager files."""
1bd55598
RD		 3608 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3609 __repr__ = _swig_repr
3610 def __init__(self, *args, **kwargs):
27fb7603
RD		 3611 """
3612 __init__(self) -> PCXHandler
3613
3614 A `wx.ImageHandler` for PCX imager files.
3615 """
1bd55598 3616 _core_.PCXHandler_swiginit(self,_core_.new_PCXHandler(*args, **kwargs))
2131d850 3617_core_.PCXHandler_swigregister(PCXHandler)
d55e5bfc 3618
5b5c9bc7 3619class JPEGHandler(ImageHandler):
27fb7603 3620 """A `wx.ImageHandler` for JPEG/JPG image files."""
1bd55598
RD		 3621 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3622 __repr__ = _swig_repr
3623 def __init__(self, *args, **kwargs):
27fb7603
RD		 3624 """
3625 __init__(self) -> JPEGHandler
3626
3627 A `wx.ImageHandler` for JPEG/JPG image files.
3628 """
1bd55598 3629 _core_.JPEGHandler_swiginit(self,_core_.new_JPEGHandler(*args, **kwargs))
2131d850 3630_core_.JPEGHandler_swigregister(JPEGHandler)
d55e5bfc 3631
5b5c9bc7 3632class PNMHandler(ImageHandler):
27fb7603 3633 """A `wx.ImageHandler` for PNM image files."""
1bd55598
RD		 3634 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3635 __repr__ = _swig_repr
3636 def __init__(self, *args, **kwargs):
27fb7603
RD		 3637 """
3638 __init__(self) -> PNMHandler
3639
3640 A `wx.ImageHandler` for PNM image files.
3641 """
1bd55598 3642 _core_.PNMHandler_swiginit(self,_core_.new_PNMHandler(*args, **kwargs))
2131d850 3643_core_.PNMHandler_swigregister(PNMHandler)
d55e5bfc 3644
5b5c9bc7 3645class XPMHandler(ImageHandler):
27fb7603 3646 """A `wx.ImageHandler` for XPM image."""
1bd55598
RD		 3647 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3648 __repr__ = _swig_repr
3649 def __init__(self, *args, **kwargs):
27fb7603
RD		 3650 """
3651 __init__(self) -> XPMHandler
3652
3653 A `wx.ImageHandler` for XPM image.
3654 """
1bd55598 3655 _core_.XPMHandler_swiginit(self,_core_.new_XPMHandler(*args, **kwargs))
2131d850 3656_core_.XPMHandler_swigregister(XPMHandler)
d55e5bfc 3657
5b5c9bc7 3658class TIFFHandler(ImageHandler):
27fb7603 3659 """A `wx.ImageHandler` for TIFF image files."""
1bd55598
RD		 3660 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3661 __repr__ = _swig_repr
3662 def __init__(self, *args, **kwargs):
27fb7603
RD		 3663 """
3664 __init__(self) -> TIFFHandler
3665
3666 A `wx.ImageHandler` for TIFF image files.
3667 """
1bd55598 3668 _core_.TIFFHandler_swiginit(self,_core_.new_TIFFHandler(*args, **kwargs))
2131d850 3669_core_.TIFFHandler_swigregister(TIFFHandler)
d55e5bfc 3670
580080c5
RD		 3671class TGAHandler(ImageHandler):
3672 """A `wx.ImageHandler` for TGA image files."""
3673 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3674 __repr__ = _swig_repr
3675 def __init__(self, *args, **kwargs):
3676 """
3677 __init__(self) -> TGAHandler
3678
3679 A `wx.ImageHandler` for TGA image files.
3680 """
3681 _core_.TGAHandler_swiginit(self,_core_.new_TGAHandler(*args, **kwargs))
3682_core_.TGAHandler_swigregister(TGAHandler)
3683
5b5c9bc7
RD		 3684QUANTIZE_INCLUDE_WINDOWS_COLOURS = _core_.QUANTIZE_INCLUDE_WINDOWS_COLOURS
3685QUANTIZE_FILL_DESTINATION_IMAGE = _core_.QUANTIZE_FILL_DESTINATION_IMAGE
3686class Quantize(object):
c0de73ae 3687 """Performs quantization, or colour reduction, on a wxImage."""
1bd55598
RD		 3688 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3689 def __init__(self): raise AttributeError, "No constructor defined"
3690 __repr__ = _swig_repr
c0de73ae
RD		 3691 def Quantize(*args, **kwargs):
3692 """
5b5c9bc7 3693 Quantize(Image src, Image dest, int desiredNoColours=236, int flags=wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE) -> bool
c0de73ae
RD		 3694
3695 Reduce the colours in the source image and put the result into the
3696 destination image, setting the palette in the destination if
3697 needed. Both images may be the same, to overwrite the source image.
3698 """
5b5c9bc7 3699 return _core_.Quantize_Quantize(*args, **kwargs)
c0de73ae
RD		 3700
3701 Quantize = staticmethod(Quantize)
2131d850 3702_core_.Quantize_swigregister(Quantize)
c0de73ae 3703
5b5c9bc7 3704def Quantize_Quantize(*args, **kwargs):
1bd55598 3705 """
5b5c9bc7 3706 Quantize_Quantize(Image src, Image dest, int desiredNoColours=236, int flags=wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE) -> bool
c0de73ae
RD		 3707
3708 Reduce the colours in the source image and put the result into the
3709 destination image, setting the palette in the destination if
3710 needed. Both images may be the same, to overwrite the source image.
3711 """
1bd55598 3712 return _core_.Quantize_Quantize(*args, **kwargs)
c0de73ae 3713
d55e5bfc
RD		 3714#---------------------------------------------------------------------------
3715
5b5c9bc7
RD		 3716class EvtHandler(Object):
3717 """Proxy of C++ EvtHandler class"""
1bd55598
RD		 3718 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3719 __repr__ = _swig_repr
3720 def __init__(self, *args, **kwargs):
5b5c9bc7 3721 """__init__(self) -> EvtHandler"""
1bd55598 3722 _core_.EvtHandler_swiginit(self,_core_.new_EvtHandler(*args, **kwargs))
d49bdf34
RD		 3723 self._setOORInfo(self)
3724
d55e5bfc 3725 def GetNextHandler(*args, **kwargs):
5b5c9bc7
RD		 3726 """GetNextHandler(self) -> EvtHandler"""
3727 return _core_.EvtHandler_GetNextHandler(*args, **kwargs)
d55e5bfc
RD		 3728
3729 def GetPreviousHandler(*args, **kwargs):
5b5c9bc7
RD		 3730 """GetPreviousHandler(self) -> EvtHandler"""
3731 return _core_.EvtHandler_GetPreviousHandler(*args, **kwargs)
d55e5bfc
RD		 3732
3733 def SetNextHandler(*args, **kwargs):
5b5c9bc7
RD		 3734 """SetNextHandler(self, EvtHandler handler)"""
3735 return _core_.EvtHandler_SetNextHandler(*args, **kwargs)
d55e5bfc
RD		 3736
3737 def SetPreviousHandler(*args, **kwargs):
5b5c9bc7
RD		 3738 """SetPreviousHandler(self, EvtHandler handler)"""
3739 return _core_.EvtHandler_SetPreviousHandler(*args, **kwargs)
d55e5bfc
RD		 3740
3741 def GetEvtHandlerEnabled(*args, **kwargs):
3742 """GetEvtHandlerEnabled(self) -> bool"""
5b5c9bc7 3743 return _core_.EvtHandler_GetEvtHandlerEnabled(*args, **kwargs)
d55e5bfc
RD		 3744
3745 def SetEvtHandlerEnabled(*args, **kwargs):
3746 """SetEvtHandlerEnabled(self, bool enabled)"""
5b5c9bc7 3747 return _core_.EvtHandler_SetEvtHandlerEnabled(*args, **kwargs)
d55e5bfc
RD		 3748
3749 def ProcessEvent(*args, **kwargs):
5b5c9bc7
RD		 3750 """ProcessEvent(self, Event event) -> bool"""
3751 return _core_.EvtHandler_ProcessEvent(*args, **kwargs)
d55e5bfc
RD		 3752
3753 def AddPendingEvent(*args, **kwargs):
5b5c9bc7
RD		 3754 """AddPendingEvent(self, Event event)"""
3755 return _core_.EvtHandler_AddPendingEvent(*args, **kwargs)
d55e5bfc
RD		 3756
3757 def ProcessPendingEvents(*args, **kwargs):
3758 """ProcessPendingEvents(self)"""
5b5c9bc7 3759 return _core_.EvtHandler_ProcessPendingEvents(*args, **kwargs)
d55e5bfc 3760
b39fe951
RD		 3761 def AllowReentrance(*args, **kwargs):
3762 """AllowReentrance(self, bool allow=True)"""
3763 return _core_.EvtHandler_AllowReentrance(*args, **kwargs)
3764
3765 def IsReentranceAllowed(*args, **kwargs):
3766 """IsReentranceAllowed(self) -> bool"""
3767 return _core_.EvtHandler_IsReentranceAllowed(*args, **kwargs)
3768
3769 def IsEventHandlingInProgress(*args, **kwargs):
3770 """IsEventHandlingInProgress(self) -> bool"""
3771 return _core_.EvtHandler_IsEventHandlingInProgress(*args, **kwargs)
3772
d55e5bfc
RD		 3773 def Connect(*args, **kwargs):
3774 """Connect(self, int id, int lastId, int eventType, PyObject func)"""
5b5c9bc7 3775 return _core_.EvtHandler_Connect(*args, **kwargs)
d55e5bfc
RD		 3776
3777 def Disconnect(*args, **kwargs):
2131d850 3778 """Disconnect(self, int id, int lastId=-1, EventType eventType=wxEVT_NULL) -> bool"""
5b5c9bc7 3779 return _core_.EvtHandler_Disconnect(*args, **kwargs)
d55e5bfc
RD		 3780
3781 def _setOORInfo(*args, **kwargs):
36ed4f51 3782 """_setOORInfo(self, PyObject _self, bool incref=True)"""
7e08d4ef
RD		 3783 val = _core_.EvtHandler__setOORInfo(*args, **kwargs)
3784 args[0].thisown = 0
3785 return val
d55e5bfc
RD		 3786
3787 def Bind(self, event, handler, source=None, id=wx.ID_ANY, id2=wx.ID_ANY):
3788 """
3789 Bind an event to an event handler.
3790
a5ee0656
RD		 3791 :param event: One of the EVT_* objects that specifies the
3792 type of event to bind,
d55e5bfc 3793
a5ee0656
RD		 3794 :param handler: A callable object to be invoked when the
3795 event is delivered to self. Pass None to
3796 disconnect an event handler.
d55e5bfc 3797
a5ee0656
RD		 3798 :param source: Sometimes the event originates from a
3799 different window than self, but you still
3800 want to catch it in self. (For example, a
3801 button event delivered to a frame.) By
3802 passing the source of the event, the event
3803 handling system is able to differentiate
3804 between the same event type from different
3805 controls.
d55e5bfc 3806
a5ee0656
RD		 3807 :param id: Used to spcify the event source by ID instead
3808 of instance.
3809
3810 :param id2: Used when it is desirable to bind a handler
3811 to a range of IDs, such as with EVT_MENU_RANGE.
d55e5bfc
RD		 3812 """
3813 if source is not None:
3814 id = source.GetId()
3815 event.Bind(self, id, id2, handler)
3816
d6c14a4c
RD		 3817 def Unbind(self, event, source=None, id=wx.ID_ANY, id2=wx.ID_ANY):
3818 """
3819 Disconencts the event handler binding for event from self.
3820 Returns True if successful.
3821 """
3822 if source is not None:
3823 id = source.GetId()
3824 return event.Unbind(self, id, id2)
d55e5bfc 3825
ac5d357a
RD		 3826 EvtHandlerEnabled = property(GetEvtHandlerEnabled,SetEvtHandlerEnabled,doc="See `GetEvtHandlerEnabled` and `SetEvtHandlerEnabled`")
3827 NextHandler = property(GetNextHandler,SetNextHandler,doc="See `GetNextHandler` and `SetNextHandler`")
3828 PreviousHandler = property(GetPreviousHandler,SetPreviousHandler,doc="See `GetPreviousHandler` and `SetPreviousHandler`")
2131d850 3829_core_.EvtHandler_swigregister(EvtHandler)
d55e5bfc
RD		 3830
3831#---------------------------------------------------------------------------
3832
3833class PyEventBinder(object):
3834 """
3835 Instances of this class are used to bind specific events to event
3836 handlers.
3837 """
3838 def __init__(self, evtType, expectedIDs=0):
3839 if expectedIDs not in [0, 1, 2]:
3840 raise ValueError, "Invalid number of expectedIDs"
3841 self.expectedIDs = expectedIDs
3842
3843 if type(evtType) == list or type(evtType) == tuple:
3844 self.evtType = evtType
3845 else:
3846 self.evtType = [evtType]
3847
3848
3849 def Bind(self, target, id1, id2, function):
3850 """Bind this set of event types to target."""
3851 for et in self.evtType:
3852 target.Connect(id1, id2, et, function)
3853
d6c14a4c
RD		 3854
3855 def Unbind(self, target, id1, id2):
3856 """Remove an event binding."""
3857 success = 0
3858 for et in self.evtType:
3859 success += target.Disconnect(id1, id2, et)
3860 return success != 0
3861
d55e5bfc
RD		 3862
3863 def __call__(self, *args):
3864 """
3865 For backwards compatibility with the old EVT_* functions.
3866 Should be called with either (window, func), (window, ID,
3867 func) or (window, ID1, ID2, func) parameters depending on the
3868 type of the event.
3869 """
3870 assert len(args) == 2 + self.expectedIDs
3871 id1 = wx.ID_ANY
3872 id2 = wx.ID_ANY
3873 target = args[0]
3874 if self.expectedIDs == 0:
3875 func = args[1]
3876 elif self.expectedIDs == 1:
3877 id1 = args[1]
3878 func = args[2]
3879 elif self.expectedIDs == 2:
3880 id1 = args[1]
3881 id2 = args[2]
3882 func = args[3]
3883 else:
3884 raise ValueError, "Unexpected number of IDs"
3885
3886 self.Bind(target, id1, id2, func)
3887
3888
3889# These two are square pegs that don't fit the PyEventBinder hole...
3890def EVT_COMMAND(win, id, cmd, func):
3891 win.Connect(id, -1, cmd, func)
3892def EVT_COMMAND_RANGE(win, id1, id2, cmd, func):
3893 win.Connect(id1, id2, cmd, func)
3894
3895
3896#---------------------------------------------------------------------------
3897
3898#---------------------------------------------------------------------------
3899
5b5c9bc7
RD		 3900EVENT_PROPAGATE_NONE = _core_.EVENT_PROPAGATE_NONE
3901EVENT_PROPAGATE_MAX = _core_.EVENT_PROPAGATE_MAX
3902
1bd55598 3903def NewEventType(*args):
2131d850 3904 """NewEventType() -> EventType"""
1bd55598 3905 return _core_.NewEventType(*args)
5b5c9bc7
RD		 3906wxEVT_NULL = _core_.wxEVT_NULL
3907wxEVT_FIRST = _core_.wxEVT_FIRST
3908wxEVT_USER_FIRST = _core_.wxEVT_USER_FIRST
3909wxEVT_COMMAND_BUTTON_CLICKED = _core_.wxEVT_COMMAND_BUTTON_CLICKED
3910wxEVT_COMMAND_CHECKBOX_CLICKED = _core_.wxEVT_COMMAND_CHECKBOX_CLICKED
3911wxEVT_COMMAND_CHOICE_SELECTED = _core_.wxEVT_COMMAND_CHOICE_SELECTED
3912wxEVT_COMMAND_LISTBOX_SELECTED = _core_.wxEVT_COMMAND_LISTBOX_SELECTED
3913wxEVT_COMMAND_LISTBOX_DOUBLECLICKED = _core_.wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
3914wxEVT_COMMAND_CHECKLISTBOX_TOGGLED = _core_.wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
3915wxEVT_COMMAND_MENU_SELECTED = _core_.wxEVT_COMMAND_MENU_SELECTED
3916wxEVT_COMMAND_TOOL_CLICKED = _core_.wxEVT_COMMAND_TOOL_CLICKED
3917wxEVT_COMMAND_SLIDER_UPDATED = _core_.wxEVT_COMMAND_SLIDER_UPDATED
3918wxEVT_COMMAND_RADIOBOX_SELECTED = _core_.wxEVT_COMMAND_RADIOBOX_SELECTED
3919wxEVT_COMMAND_RADIOBUTTON_SELECTED = _core_.wxEVT_COMMAND_RADIOBUTTON_SELECTED
3920wxEVT_COMMAND_SCROLLBAR_UPDATED = _core_.wxEVT_COMMAND_SCROLLBAR_UPDATED
3921wxEVT_COMMAND_VLBOX_SELECTED = _core_.wxEVT_COMMAND_VLBOX_SELECTED
3922wxEVT_COMMAND_COMBOBOX_SELECTED = _core_.wxEVT_COMMAND_COMBOBOX_SELECTED
3923wxEVT_COMMAND_TOOL_RCLICKED = _core_.wxEVT_COMMAND_TOOL_RCLICKED
3924wxEVT_COMMAND_TOOL_ENTER = _core_.wxEVT_COMMAND_TOOL_ENTER
3925wxEVT_LEFT_DOWN = _core_.wxEVT_LEFT_DOWN
3926wxEVT_LEFT_UP = _core_.wxEVT_LEFT_UP
3927wxEVT_MIDDLE_DOWN = _core_.wxEVT_MIDDLE_DOWN
3928wxEVT_MIDDLE_UP = _core_.wxEVT_MIDDLE_UP
3929wxEVT_RIGHT_DOWN = _core_.wxEVT_RIGHT_DOWN
3930wxEVT_RIGHT_UP = _core_.wxEVT_RIGHT_UP
3931wxEVT_MOTION = _core_.wxEVT_MOTION
3932wxEVT_ENTER_WINDOW = _core_.wxEVT_ENTER_WINDOW
3933wxEVT_LEAVE_WINDOW = _core_.wxEVT_LEAVE_WINDOW
3934wxEVT_LEFT_DCLICK = _core_.wxEVT_LEFT_DCLICK
3935wxEVT_MIDDLE_DCLICK = _core_.wxEVT_MIDDLE_DCLICK
3936wxEVT_RIGHT_DCLICK = _core_.wxEVT_RIGHT_DCLICK
3937wxEVT_SET_FOCUS = _core_.wxEVT_SET_FOCUS
3938wxEVT_KILL_FOCUS = _core_.wxEVT_KILL_FOCUS
3939wxEVT_CHILD_FOCUS = _core_.wxEVT_CHILD_FOCUS
3940wxEVT_MOUSEWHEEL = _core_.wxEVT_MOUSEWHEEL
3941wxEVT_NC_LEFT_DOWN = _core_.wxEVT_NC_LEFT_DOWN
3942wxEVT_NC_LEFT_UP = _core_.wxEVT_NC_LEFT_UP
3943wxEVT_NC_MIDDLE_DOWN = _core_.wxEVT_NC_MIDDLE_DOWN
3944wxEVT_NC_MIDDLE_UP = _core_.wxEVT_NC_MIDDLE_UP
3945wxEVT_NC_RIGHT_DOWN = _core_.wxEVT_NC_RIGHT_DOWN
3946wxEVT_NC_RIGHT_UP = _core_.wxEVT_NC_RIGHT_UP
3947wxEVT_NC_MOTION = _core_.wxEVT_NC_MOTION
3948wxEVT_NC_ENTER_WINDOW = _core_.wxEVT_NC_ENTER_WINDOW
3949wxEVT_NC_LEAVE_WINDOW = _core_.wxEVT_NC_LEAVE_WINDOW
3950wxEVT_NC_LEFT_DCLICK = _core_.wxEVT_NC_LEFT_DCLICK
3951wxEVT_NC_MIDDLE_DCLICK = _core_.wxEVT_NC_MIDDLE_DCLICK
3952wxEVT_NC_RIGHT_DCLICK = _core_.wxEVT_NC_RIGHT_DCLICK
3953wxEVT_CHAR = _core_.wxEVT_CHAR
3954wxEVT_CHAR_HOOK = _core_.wxEVT_CHAR_HOOK
3955wxEVT_NAVIGATION_KEY = _core_.wxEVT_NAVIGATION_KEY
3956wxEVT_KEY_DOWN = _core_.wxEVT_KEY_DOWN
3957wxEVT_KEY_UP = _core_.wxEVT_KEY_UP
3958wxEVT_HOTKEY = _core_.wxEVT_HOTKEY
3959wxEVT_SET_CURSOR = _core_.wxEVT_SET_CURSOR
3960wxEVT_SCROLL_TOP = _core_.wxEVT_SCROLL_TOP
3961wxEVT_SCROLL_BOTTOM = _core_.wxEVT_SCROLL_BOTTOM
3962wxEVT_SCROLL_LINEUP = _core_.wxEVT_SCROLL_LINEUP
3963wxEVT_SCROLL_LINEDOWN = _core_.wxEVT_SCROLL_LINEDOWN
3964wxEVT_SCROLL_PAGEUP = _core_.wxEVT_SCROLL_PAGEUP
3965wxEVT_SCROLL_PAGEDOWN = _core_.wxEVT_SCROLL_PAGEDOWN
3966wxEVT_SCROLL_THUMBTRACK = _core_.wxEVT_SCROLL_THUMBTRACK
3967wxEVT_SCROLL_THUMBRELEASE = _core_.wxEVT_SCROLL_THUMBRELEASE
4f433fef
RD		 3968wxEVT_SCROLL_CHANGED = _core_.wxEVT_SCROLL_CHANGED
3969wxEVT_SCROLL_ENDSCROLL = wxEVT_SCROLL_CHANGED
5b5c9bc7
RD		 3970wxEVT_SCROLLWIN_TOP = _core_.wxEVT_SCROLLWIN_TOP
3971wxEVT_SCROLLWIN_BOTTOM = _core_.wxEVT_SCROLLWIN_BOTTOM
3972wxEVT_SCROLLWIN_LINEUP = _core_.wxEVT_SCROLLWIN_LINEUP
3973wxEVT_SCROLLWIN_LINEDOWN = _core_.wxEVT_SCROLLWIN_LINEDOWN
3974wxEVT_SCROLLWIN_PAGEUP = _core_.wxEVT_SCROLLWIN_PAGEUP
3975wxEVT_SCROLLWIN_PAGEDOWN = _core_.wxEVT_SCROLLWIN_PAGEDOWN
3976wxEVT_SCROLLWIN_THUMBTRACK = _core_.wxEVT_SCROLLWIN_THUMBTRACK
3977wxEVT_SCROLLWIN_THUMBRELEASE = _core_.wxEVT_SCROLLWIN_THUMBRELEASE
3978wxEVT_SIZE = _core_.wxEVT_SIZE
3979wxEVT_MOVE = _core_.wxEVT_MOVE
3980wxEVT_CLOSE_WINDOW = _core_.wxEVT_CLOSE_WINDOW
3981wxEVT_END_SESSION = _core_.wxEVT_END_SESSION
3982wxEVT_QUERY_END_SESSION = _core_.wxEVT_QUERY_END_SESSION
3983wxEVT_ACTIVATE_APP = _core_.wxEVT_ACTIVATE_APP
5b5c9bc7
RD		 3984wxEVT_ACTIVATE = _core_.wxEVT_ACTIVATE
3985wxEVT_CREATE = _core_.wxEVT_CREATE
3986wxEVT_DESTROY = _core_.wxEVT_DESTROY
3987wxEVT_SHOW = _core_.wxEVT_SHOW
3988wxEVT_ICONIZE = _core_.wxEVT_ICONIZE
3989wxEVT_MAXIMIZE = _core_.wxEVT_MAXIMIZE
3990wxEVT_MOUSE_CAPTURE_CHANGED = _core_.wxEVT_MOUSE_CAPTURE_CHANGED
34e0a3bb 3991wxEVT_MOUSE_CAPTURE_LOST = _core_.wxEVT_MOUSE_CAPTURE_LOST
5b5c9bc7
RD		 3992wxEVT_PAINT = _core_.wxEVT_PAINT
3993wxEVT_ERASE_BACKGROUND = _core_.wxEVT_ERASE_BACKGROUND
3994wxEVT_NC_PAINT = _core_.wxEVT_NC_PAINT
3995wxEVT_PAINT_ICON = _core_.wxEVT_PAINT_ICON
3996wxEVT_MENU_OPEN = _core_.wxEVT_MENU_OPEN
3997wxEVT_MENU_CLOSE = _core_.wxEVT_MENU_CLOSE
3998wxEVT_MENU_HIGHLIGHT = _core_.wxEVT_MENU_HIGHLIGHT
3999wxEVT_CONTEXT_MENU = _core_.wxEVT_CONTEXT_MENU
4000wxEVT_SYS_COLOUR_CHANGED = _core_.wxEVT_SYS_COLOUR_CHANGED
4001wxEVT_DISPLAY_CHANGED = _core_.wxEVT_DISPLAY_CHANGED
4002wxEVT_SETTING_CHANGED = _core_.wxEVT_SETTING_CHANGED
4003wxEVT_QUERY_NEW_PALETTE = _core_.wxEVT_QUERY_NEW_PALETTE
4004wxEVT_PALETTE_CHANGED = _core_.wxEVT_PALETTE_CHANGED
4005wxEVT_DROP_FILES = _core_.wxEVT_DROP_FILES
4006wxEVT_DRAW_ITEM = _core_.wxEVT_DRAW_ITEM
4007wxEVT_MEASURE_ITEM = _core_.wxEVT_MEASURE_ITEM
4008wxEVT_COMPARE_ITEM = _core_.wxEVT_COMPARE_ITEM
4009wxEVT_INIT_DIALOG = _core_.wxEVT_INIT_DIALOG
4010wxEVT_IDLE = _core_.wxEVT_IDLE
4011wxEVT_UPDATE_UI = _core_.wxEVT_UPDATE_UI
4012wxEVT_SIZING = _core_.wxEVT_SIZING
4013wxEVT_MOVING = _core_.wxEVT_MOVING
4014wxEVT_HIBERNATE = _core_.wxEVT_HIBERNATE
2131d850
RD		 4015wxEVT_COMMAND_TEXT_COPY = _core_.wxEVT_COMMAND_TEXT_COPY
4016wxEVT_COMMAND_TEXT_CUT = _core_.wxEVT_COMMAND_TEXT_CUT
4017wxEVT_COMMAND_TEXT_PASTE = _core_.wxEVT_COMMAND_TEXT_PASTE
5b5c9bc7
RD		 4018wxEVT_COMMAND_LEFT_CLICK = _core_.wxEVT_COMMAND_LEFT_CLICK
4019wxEVT_COMMAND_LEFT_DCLICK = _core_.wxEVT_COMMAND_LEFT_DCLICK
4020wxEVT_COMMAND_RIGHT_CLICK = _core_.wxEVT_COMMAND_RIGHT_CLICK
4021wxEVT_COMMAND_RIGHT_DCLICK = _core_.wxEVT_COMMAND_RIGHT_DCLICK
4022wxEVT_COMMAND_SET_FOCUS = _core_.wxEVT_COMMAND_SET_FOCUS
4023wxEVT_COMMAND_KILL_FOCUS = _core_.wxEVT_COMMAND_KILL_FOCUS
4024wxEVT_COMMAND_ENTER = _core_.wxEVT_COMMAND_ENTER
d55e5bfc
RD		 4025#
4026# Create some event binders
4027EVT_SIZE = wx.PyEventBinder( wxEVT_SIZE )
4028EVT_SIZING = wx.PyEventBinder( wxEVT_SIZING )
4029EVT_MOVE = wx.PyEventBinder( wxEVT_MOVE )
4030EVT_MOVING = wx.PyEventBinder( wxEVT_MOVING )
4031EVT_CLOSE = wx.PyEventBinder( wxEVT_CLOSE_WINDOW )
4032EVT_END_SESSION = wx.PyEventBinder( wxEVT_END_SESSION )
4033EVT_QUERY_END_SESSION = wx.PyEventBinder( wxEVT_QUERY_END_SESSION )
4034EVT_PAINT = wx.PyEventBinder( wxEVT_PAINT )
4035EVT_NC_PAINT = wx.PyEventBinder( wxEVT_NC_PAINT )
4036EVT_ERASE_BACKGROUND = wx.PyEventBinder( wxEVT_ERASE_BACKGROUND )
4037EVT_CHAR = wx.PyEventBinder( wxEVT_CHAR )
4038EVT_KEY_DOWN = wx.PyEventBinder( wxEVT_KEY_DOWN )
4039EVT_KEY_UP = wx.PyEventBinder( wxEVT_KEY_UP )
704eda0c 4040EVT_HOTKEY = wx.PyEventBinder( wxEVT_HOTKEY, 1)
d55e5bfc
RD		 4041EVT_CHAR_HOOK = wx.PyEventBinder( wxEVT_CHAR_HOOK )
4042EVT_MENU_OPEN = wx.PyEventBinder( wxEVT_MENU_OPEN )
4043EVT_MENU_CLOSE = wx.PyEventBinder( wxEVT_MENU_CLOSE )
4044EVT_MENU_HIGHLIGHT = wx.PyEventBinder( wxEVT_MENU_HIGHLIGHT, 1)
4045EVT_MENU_HIGHLIGHT_ALL = wx.PyEventBinder( wxEVT_MENU_HIGHLIGHT )
4046EVT_SET_FOCUS = wx.PyEventBinder( wxEVT_SET_FOCUS )
4047EVT_KILL_FOCUS = wx.PyEventBinder( wxEVT_KILL_FOCUS )
4048EVT_CHILD_FOCUS = wx.PyEventBinder( wxEVT_CHILD_FOCUS )
4049EVT_ACTIVATE = wx.PyEventBinder( wxEVT_ACTIVATE )
4050EVT_ACTIVATE_APP = wx.PyEventBinder( wxEVT_ACTIVATE_APP )
704eda0c 4051EVT_HIBERNATE = wx.PyEventBinder( wxEVT_HIBERNATE )
d55e5bfc
RD		 4052EVT_END_SESSION = wx.PyEventBinder( wxEVT_END_SESSION )
4053EVT_QUERY_END_SESSION = wx.PyEventBinder( wxEVT_QUERY_END_SESSION )
4054EVT_DROP_FILES = wx.PyEventBinder( wxEVT_DROP_FILES )
4055EVT_INIT_DIALOG = wx.PyEventBinder( wxEVT_INIT_DIALOG )
4056EVT_SYS_COLOUR_CHANGED = wx.PyEventBinder( wxEVT_SYS_COLOUR_CHANGED )
4057EVT_DISPLAY_CHANGED = wx.PyEventBinder( wxEVT_DISPLAY_CHANGED )
4058EVT_SHOW = wx.PyEventBinder( wxEVT_SHOW )
4059EVT_MAXIMIZE = wx.PyEventBinder( wxEVT_MAXIMIZE )
4060EVT_ICONIZE = wx.PyEventBinder( wxEVT_ICONIZE )
4061EVT_NAVIGATION_KEY = wx.PyEventBinder( wxEVT_NAVIGATION_KEY )
4062EVT_PALETTE_CHANGED = wx.PyEventBinder( wxEVT_PALETTE_CHANGED )
4063EVT_QUERY_NEW_PALETTE = wx.PyEventBinder( wxEVT_QUERY_NEW_PALETTE )
4064EVT_WINDOW_CREATE = wx.PyEventBinder( wxEVT_CREATE )
4065EVT_WINDOW_DESTROY = wx.PyEventBinder( wxEVT_DESTROY )
4066EVT_SET_CURSOR = wx.PyEventBinder( wxEVT_SET_CURSOR )
4067EVT_MOUSE_CAPTURE_CHANGED = wx.PyEventBinder( wxEVT_MOUSE_CAPTURE_CHANGED )
34e0a3bb 4068EVT_MOUSE_CAPTURE_LOST = wx.PyEventBinder( wxEVT_MOUSE_CAPTURE_LOST )
d55e5bfc
RD		 4069
4070EVT_LEFT_DOWN = wx.PyEventBinder( wxEVT_LEFT_DOWN )
4071EVT_LEFT_UP = wx.PyEventBinder( wxEVT_LEFT_UP )
4072EVT_MIDDLE_DOWN = wx.PyEventBinder( wxEVT_MIDDLE_DOWN )
4073EVT_MIDDLE_UP = wx.PyEventBinder( wxEVT_MIDDLE_UP )
4074EVT_RIGHT_DOWN = wx.PyEventBinder( wxEVT_RIGHT_DOWN )
4075EVT_RIGHT_UP = wx.PyEventBinder( wxEVT_RIGHT_UP )
4076EVT_MOTION = wx.PyEventBinder( wxEVT_MOTION )
4077EVT_LEFT_DCLICK = wx.PyEventBinder( wxEVT_LEFT_DCLICK )
4078EVT_MIDDLE_DCLICK = wx.PyEventBinder( wxEVT_MIDDLE_DCLICK )
4079EVT_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_RIGHT_DCLICK )
4080EVT_LEAVE_WINDOW = wx.PyEventBinder( wxEVT_LEAVE_WINDOW )
4081EVT_ENTER_WINDOW = wx.PyEventBinder( wxEVT_ENTER_WINDOW )
4082EVT_MOUSEWHEEL = wx.PyEventBinder( wxEVT_MOUSEWHEEL )
4083
4084EVT_MOUSE_EVENTS = wx.PyEventBinder([ wxEVT_LEFT_DOWN,
4085 wxEVT_LEFT_UP,
4086 wxEVT_MIDDLE_DOWN,
4087 wxEVT_MIDDLE_UP,
4088 wxEVT_RIGHT_DOWN,
4089 wxEVT_RIGHT_UP,
4090 wxEVT_MOTION,
4091 wxEVT_LEFT_DCLICK,
4092 wxEVT_MIDDLE_DCLICK,
4093 wxEVT_RIGHT_DCLICK,
4094 wxEVT_ENTER_WINDOW,
4095 wxEVT_LEAVE_WINDOW,
4096 wxEVT_MOUSEWHEEL
4097 ])
4098
4099
4100# Scrolling from wxWindow (sent to wxScrolledWindow)
704eda0c 4101EVT_SCROLLWIN = wx.PyEventBinder([ wxEVT_SCROLLWIN_TOP,
d55e5bfc
RD		 4102 wxEVT_SCROLLWIN_BOTTOM,
4103 wxEVT_SCROLLWIN_LINEUP,
4104 wxEVT_SCROLLWIN_LINEDOWN,
704eda0c 4105 wxEVT_SCROLLWIN_PAGEUP,
d55e5bfc
RD		 4106 wxEVT_SCROLLWIN_PAGEDOWN,
4107 wxEVT_SCROLLWIN_THUMBTRACK,
4108 wxEVT_SCROLLWIN_THUMBRELEASE,
4109 ])
4110
4111EVT_SCROLLWIN_TOP = wx.PyEventBinder( wxEVT_SCROLLWIN_TOP )
4112EVT_SCROLLWIN_BOTTOM = wx.PyEventBinder( wxEVT_SCROLLWIN_BOTTOM )
4113EVT_SCROLLWIN_LINEUP = wx.PyEventBinder( wxEVT_SCROLLWIN_LINEUP )
4114EVT_SCROLLWIN_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLLWIN_LINEDOWN )
4115EVT_SCROLLWIN_PAGEUP = wx.PyEventBinder( wxEVT_SCROLLWIN_PAGEUP )
4116EVT_SCROLLWIN_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLLWIN_PAGEDOWN )
4117EVT_SCROLLWIN_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLLWIN_THUMBTRACK )
4118EVT_SCROLLWIN_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLLWIN_THUMBRELEASE )
4119
27fb7603 4120# Scrolling from wx.Slider and wx.ScrollBar
704eda0c
RD		 4121EVT_SCROLL = wx.PyEventBinder([ wxEVT_SCROLL_TOP,
4122 wxEVT_SCROLL_BOTTOM,
4123 wxEVT_SCROLL_LINEUP,
4124 wxEVT_SCROLL_LINEDOWN,
4125 wxEVT_SCROLL_PAGEUP,
4126 wxEVT_SCROLL_PAGEDOWN,
4127 wxEVT_SCROLL_THUMBTRACK,
4128 wxEVT_SCROLL_THUMBRELEASE,
4f433fef 4129 wxEVT_SCROLL_CHANGED,
d55e5bfc
RD		 4130 ])
4131
4132EVT_SCROLL_TOP = wx.PyEventBinder( wxEVT_SCROLL_TOP )
4133EVT_SCROLL_BOTTOM = wx.PyEventBinder( wxEVT_SCROLL_BOTTOM )
4134EVT_SCROLL_LINEUP = wx.PyEventBinder( wxEVT_SCROLL_LINEUP )
4135EVT_SCROLL_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLL_LINEDOWN )
4136EVT_SCROLL_PAGEUP = wx.PyEventBinder( wxEVT_SCROLL_PAGEUP )
4137EVT_SCROLL_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLL_PAGEDOWN )
4138EVT_SCROLL_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLL_THUMBTRACK )
4139EVT_SCROLL_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE )
4f433fef
RD		 4140EVT_SCROLL_CHANGED = wx.PyEventBinder( wxEVT_SCROLL_CHANGED )
4141EVT_SCROLL_ENDSCROLL = EVT_SCROLL_CHANGED
704eda0c 4142
27fb7603 4143# Scrolling from wx.Slider and wx.ScrollBar, with an id
704eda0c
RD		 4144EVT_COMMAND_SCROLL = wx.PyEventBinder([ wxEVT_SCROLL_TOP,
4145 wxEVT_SCROLL_BOTTOM,
4146 wxEVT_SCROLL_LINEUP,
4147 wxEVT_SCROLL_LINEDOWN,
4148 wxEVT_SCROLL_PAGEUP,
4149 wxEVT_SCROLL_PAGEDOWN,
4150 wxEVT_SCROLL_THUMBTRACK,
d55e5bfc 4151 wxEVT_SCROLL_THUMBRELEASE,
4f433fef 4152 wxEVT_SCROLL_CHANGED,
d55e5bfc
RD		 4153 ], 1)
4154
4155EVT_COMMAND_SCROLL_TOP = wx.PyEventBinder( wxEVT_SCROLL_TOP, 1)
4156EVT_COMMAND_SCROLL_BOTTOM = wx.PyEventBinder( wxEVT_SCROLL_BOTTOM, 1)
4157EVT_COMMAND_SCROLL_LINEUP = wx.PyEventBinder( wxEVT_SCROLL_LINEUP, 1)
4158EVT_COMMAND_SCROLL_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLL_LINEDOWN, 1)
4159EVT_COMMAND_SCROLL_PAGEUP = wx.PyEventBinder( wxEVT_SCROLL_PAGEUP, 1)
4160EVT_COMMAND_SCROLL_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLL_PAGEDOWN, 1)
4161EVT_COMMAND_SCROLL_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLL_THUMBTRACK, 1)
4162EVT_COMMAND_SCROLL_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE, 1)
4f433fef
RD		 4163EVT_COMMAND_SCROLL_CHANGED = wx.PyEventBinder( wxEVT_SCROLL_CHANGED, 1)
4164EVT_COMMAND_SCROLL_ENDSCROLL = EVT_COMMAND_SCROLL_CHANGED
d55e5bfc
RD		 4165
4166EVT_BUTTON = wx.PyEventBinder( wxEVT_COMMAND_BUTTON_CLICKED, 1)
4167EVT_CHECKBOX = wx.PyEventBinder( wxEVT_COMMAND_CHECKBOX_CLICKED, 1)
4168EVT_CHOICE = wx.PyEventBinder( wxEVT_COMMAND_CHOICE_SELECTED, 1)
4169EVT_LISTBOX = wx.PyEventBinder( wxEVT_COMMAND_LISTBOX_SELECTED, 1)
4170EVT_LISTBOX_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, 1)
4171EVT_MENU = wx.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED, 1)
4172EVT_MENU_RANGE = wx.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED, 2)
4173EVT_SLIDER = wx.PyEventBinder( wxEVT_COMMAND_SLIDER_UPDATED, 1)
4174EVT_RADIOBOX = wx.PyEventBinder( wxEVT_COMMAND_RADIOBOX_SELECTED, 1)
4175EVT_RADIOBUTTON = wx.PyEventBinder( wxEVT_COMMAND_RADIOBUTTON_SELECTED, 1)
4176
4177EVT_SCROLLBAR = wx.PyEventBinder( wxEVT_COMMAND_SCROLLBAR_UPDATED, 1)
4178EVT_VLBOX = wx.PyEventBinder( wxEVT_COMMAND_VLBOX_SELECTED, 1)
4179EVT_COMBOBOX = wx.PyEventBinder( wxEVT_COMMAND_COMBOBOX_SELECTED, 1)
4180EVT_TOOL = wx.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED, 1)
4181EVT_TOOL_RANGE = wx.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED, 2)
4182EVT_TOOL_RCLICKED = wx.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED, 1)
4183EVT_TOOL_RCLICKED_RANGE = wx.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED, 2)
4184EVT_TOOL_ENTER = wx.PyEventBinder( wxEVT_COMMAND_TOOL_ENTER, 1)
4185EVT_CHECKLISTBOX = wx.PyEventBinder( wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, 1)
4186
4187
4188EVT_COMMAND_LEFT_CLICK = wx.PyEventBinder( wxEVT_COMMAND_LEFT_CLICK, 1)
4189EVT_COMMAND_LEFT_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_LEFT_DCLICK, 1)
4190EVT_COMMAND_RIGHT_CLICK = wx.PyEventBinder( wxEVT_COMMAND_RIGHT_CLICK, 1)
4191EVT_COMMAND_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_RIGHT_DCLICK, 1)
4192EVT_COMMAND_SET_FOCUS = wx.PyEventBinder( wxEVT_COMMAND_SET_FOCUS, 1)
4193EVT_COMMAND_KILL_FOCUS = wx.PyEventBinder( wxEVT_COMMAND_KILL_FOCUS, 1)
4194EVT_COMMAND_ENTER = wx.PyEventBinder( wxEVT_COMMAND_ENTER, 1)
4195
4196EVT_IDLE = wx.PyEventBinder( wxEVT_IDLE )
4197
4198EVT_UPDATE_UI = wx.PyEventBinder( wxEVT_UPDATE_UI, 1)
4199EVT_UPDATE_UI_RANGE = wx.PyEventBinder( wxEVT_UPDATE_UI, 2)
4200
4201EVT_CONTEXT_MENU = wx.PyEventBinder( wxEVT_CONTEXT_MENU )
4202
2131d850
RD		 4203EVT_TEXT_CUT = wx.PyEventBinder( wxEVT_COMMAND_TEXT_CUT )
4204EVT_TEXT_COPY = wx.PyEventBinder( wxEVT_COMMAND_TEXT_COPY )
4205EVT_TEXT_PASTE = wx.PyEventBinder( wxEVT_COMMAND_TEXT_PASTE )
d55e5bfc
RD		 4206
4207
4208#---------------------------------------------------------------------------
4209
5b5c9bc7 4210class Event(Object):
27fb7603
RD		 4211 """
4212 An event is a structure holding information about an event passed to a
4213 callback or member function. wx.Event is an abstract base class for
4214 other event classes
4215 """
1bd55598
RD		 4216 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4217 def __init__(self): raise AttributeError, "No constructor defined"
4218 __repr__ = _swig_repr
4219 __swig_destroy__ = _core_.delete_Event
4220 __del__ = lambda self : None;
d55e5bfc 4221 def SetEventType(*args, **kwargs):
27fb7603 4222 """
2131d850 4223 SetEventType(self, EventType typ)
27fb7603
RD		 4224
4225 Sets the specific type of the event.
4226 """
5b5c9bc7 4227 return _core_.Event_SetEventType(*args, **kwargs)
d55e5bfc
RD		 4228
4229 def GetEventType(*args, **kwargs):
27fb7603 4230 """
2131d850 4231 GetEventType(self) -> EventType
27fb7603
RD		 4232
4233 Returns the identifier of the given event type, such as
4234 ``wxEVT_COMMAND_BUTTON_CLICKED``.
4235 """
5b5c9bc7 4236 return _core_.Event_GetEventType(*args, **kwargs)
d55e5bfc
RD		 4237
4238 def GetEventObject(*args, **kwargs):
27fb7603
RD		 4239 """
4240 GetEventObject(self) -> Object
4241
4242 Returns the object (usually a window) associated with the event, if
4243 any.
4244 """
5b5c9bc7 4245 return _core_.Event_GetEventObject(*args, **kwargs)
d55e5bfc
RD		 4246
4247 def SetEventObject(*args, **kwargs):
27fb7603
RD		 4248 """
4249 SetEventObject(self, Object obj)
4250
4251 Sets the originating object, or in other words, obj is normally the
4252 object that is sending the event.
4253 """
5b5c9bc7 4254 return _core_.Event_SetEventObject(*args, **kwargs)
d55e5bfc
RD		 4255
4256 def GetTimestamp(*args, **kwargs):
4257 """GetTimestamp(self) -> long"""
5b5c9bc7 4258 return _core_.Event_GetTimestamp(*args, **kwargs)
d55e5bfc
RD		 4259
4260 def SetTimestamp(*args, **kwargs):
4261 """SetTimestamp(self, long ts=0)"""
5b5c9bc7 4262 return _core_.Event_SetTimestamp(*args, **kwargs)
d55e5bfc
RD		 4263
4264 def GetId(*args, **kwargs):
27fb7603
RD		 4265 """
4266 GetId(self) -> int
4267
4268 Returns the identifier associated with this event, such as a button
4269 command id.
4270 """
5b5c9bc7 4271 return _core_.Event_GetId(*args, **kwargs)
d55e5bfc
RD		 4272
4273 def SetId(*args, **kwargs):
27fb7603
RD		 4274 """
4275 SetId(self, int Id)
4276
4277 Set's the ID for the event. This is usually the ID of the window that
4278 is sending the event, but it can also be a command id from a menu
4279 item, etc.
4280 """
5b5c9bc7 4281 return _core_.Event_SetId(*args, **kwargs)
d55e5bfc
RD		 4282
4283 def IsCommandEvent(*args, **kwargs):
27fb7603
RD		 4284 """
4285 IsCommandEvent(self) -> bool
4286
4287 Returns true if the event is or is derived from `wx.CommandEvent` else
4288 it returns false. Note: Exists only for optimization purposes.
4289 """
5b5c9bc7 4290 return _core_.Event_IsCommandEvent(*args, **kwargs)
d55e5bfc
RD		 4291
4292 def Skip(*args, **kwargs):
51b83b37
RD		 4293 """
4294 Skip(self, bool skip=True)
4295
6b449b19
RD		 4296 This method can be used inside an event handler to control whether
4297 further event handlers bound to this event will be called after the
4298 current one returns. Without Skip() (or equivalently if Skip(False) is
4299 used), the event will not be processed any more. If Skip(True) is
4300 called, the event processing system continues searching for a further
4301 handler function for this event, even though it has been processed
4302 already in the current handler.
51b83b37 4303 """
5b5c9bc7 4304 return _core_.Event_Skip(*args, **kwargs)
d55e5bfc
RD		 4305
4306 def GetSkipped(*args, **kwargs):
27fb7603
RD		 4307 """
4308 GetSkipped(self) -> bool
4309
4310 Returns true if the event handler should be skipped, false otherwise.
4311 :see: `Skip`
4312 """
5b5c9bc7 4313 return _core_.Event_GetSkipped(*args, **kwargs)
d55e5bfc
RD		 4314
4315 def ShouldPropagate(*args, **kwargs):
27fb7603
RD		 4316 """
4317 ShouldPropagate(self) -> bool
4318
4319 Test if this event should be propagated to the parent window or not,
4320 i.e. if the propagation level is currently greater than 0.
4321 """
5b5c9bc7 4322 return _core_.Event_ShouldPropagate(*args, **kwargs)
d55e5bfc
RD		 4323
4324 def StopPropagation(*args, **kwargs):
27fb7603
RD		 4325 """
4326 StopPropagation(self) -> int
4327
4328 Stop the event from propagating to its parent window. Returns the old
4329 propagation level value which may be later passed to
4330 `ResumePropagation` to allow propagating the event again.
4331 """
5b5c9bc7 4332 return _core_.Event_StopPropagation(*args, **kwargs)
d55e5bfc
RD		 4333
4334 def ResumePropagation(*args, **kwargs):
27fb7603
RD		 4335 """
4336 ResumePropagation(self, int propagationLevel)
4337
4338 Resume the event propagation by restoring the propagation level. (For
4339 example, you can use the value returned by an earlier call to
4340 `StopPropagation`.)
4341
4342 """
5b5c9bc7 4343 return _core_.Event_ResumePropagation(*args, **kwargs)
d55e5bfc
RD		 4344
4345 def Clone(*args, **kwargs):
5b5c9bc7
RD		 4346 """Clone(self) -> Event"""
4347 return _core_.Event_Clone(*args, **kwargs)
d55e5bfc 4348
ac5d357a
RD		 4349 EventObject = property(GetEventObject,SetEventObject,doc="See `GetEventObject` and `SetEventObject`")
4350 EventType = property(GetEventType,SetEventType,doc="See `GetEventType` and `SetEventType`")
4351 Id = property(GetId,SetId,doc="See `GetId` and `SetId`")
4352 Skipped = property(GetSkipped,doc="See `GetSkipped`")
4353 Timestamp = property(GetTimestamp,SetTimestamp,doc="See `GetTimestamp` and `SetTimestamp`")
2131d850 4354_core_.Event_swigregister(Event)
d55e5bfc
RD		 4355
4356#---------------------------------------------------------------------------
4357
5b5c9bc7 4358class PropagationDisabler(object):
27fb7603
RD		 4359 """
4360 Helper class to temporarily change an event not to propagate. Simply
4361 create an instance of this class and then whe it is destroyed the
4362 propogation of the event will be restored.
4363 """
1bd55598
RD		 4364 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4365 __repr__ = _swig_repr
4366 def __init__(self, *args, **kwargs):
27fb7603
RD		 4367 """
4368 __init__(self, Event event) -> PropagationDisabler
4369
4370 Helper class to temporarily change an event not to propagate. Simply
4371 create an instance of this class and then whe it is destroyed the
4372 propogation of the event will be restored.
4373 """
1bd55598
RD		 4374 _core_.PropagationDisabler_swiginit(self,_core_.new_PropagationDisabler(*args, **kwargs))
4375 __swig_destroy__ = _core_.delete_PropagationDisabler
4376 __del__ = lambda self : None;
2131d850 4377_core_.PropagationDisabler_swigregister(PropagationDisabler)
d55e5bfc 4378
5b5c9bc7 4379class PropagateOnce(object):
27fb7603
RD		 4380 """
4381 A helper class that will temporarily lower propagation level of an
4382 event. Simply create an instance of this class and then whe it is
4383 destroyed the propogation of the event will be restored.
4384 """
1bd55598
RD		 4385 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4386 __repr__ = _swig_repr
4387 def __init__(self, *args, **kwargs):
27fb7603
RD		 4388 """
4389 __init__(self, Event event) -> PropagateOnce
4390
4391 A helper class that will temporarily lower propagation level of an
4392 event. Simply create an instance of this class and then whe it is
4393 destroyed the propogation of the event will be restored.
4394 """
1bd55598
RD		 4395 _core_.PropagateOnce_swiginit(self,_core_.new_PropagateOnce(*args, **kwargs))
4396 __swig_destroy__ = _core_.delete_PropagateOnce
4397 __del__ = lambda self : None;
2131d850 4398_core_.PropagateOnce_swigregister(PropagateOnce)
d55e5bfc
RD		 4399
4400#---------------------------------------------------------------------------
4401
5b5c9bc7 4402class CommandEvent(Event):
27fb7603
RD		 4403 """
4404 This event class contains information about command events, which
4405 originate from a variety of simple controls, as well as menus and
4406 toolbars.
4407 """
1bd55598
RD		 4408 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4409 __repr__ = _swig_repr
4410 def __init__(self, *args, **kwargs):
27fb7603 4411 """
2131d850 4412 __init__(self, EventType commandType=wxEVT_NULL, int winid=0) -> CommandEvent
27fb7603
RD		 4413
4414 This event class contains information about command events, which
4415 originate from a variety of simple controls, as well as menus and
4416 toolbars.
4417 """
1bd55598 4418 _core_.CommandEvent_swiginit(self,_core_.new_CommandEvent(*args, **kwargs))
d55e5bfc 4419 def GetSelection(*args, **kwargs):
27fb7603
RD		 4420 """
4421 GetSelection(self) -> int
4422
4423 Returns item index for a listbox or choice selection event (not valid
4424 for a deselection).
4425 """
5b5c9bc7 4426 return _core_.CommandEvent_GetSelection(*args, **kwargs)
d55e5bfc
RD		 4427
4428 def SetString(*args, **kwargs):
5b5c9bc7
RD		 4429 """SetString(self, String s)"""
4430 return _core_.CommandEvent_SetString(*args, **kwargs)
d55e5bfc
RD		 4431
4432 def GetString(*args, **kwargs):
27fb7603
RD		 4433 """
4434 GetString(self) -> String
4435
4436 Returns item string for a listbox or choice selection event (not valid
4437 for a deselection).
4438 """
5b5c9bc7 4439 return _core_.CommandEvent_GetString(*args, **kwargs)
d55e5bfc
RD		 4440
4441 def IsChecked(*args, **kwargs):
27fb7603
RD		 4442 """
4443 IsChecked(self) -> bool
4444
4445 This method can be used with checkbox and menu events: for the
4446 checkboxes, the method returns true for a selection event and false
4447 for a deselection one. For the menu events, this method indicates if
4448 the menu item just has become checked or unchecked (and thus only
4449 makes sense for checkable menu items).
4450 """
5b5c9bc7 4451 return _core_.CommandEvent_IsChecked(*args, **kwargs)
d55e5bfc
RD		 4452
4453 Checked = IsChecked
4454 def IsSelection(*args, **kwargs):
27fb7603
RD		 4455 """
4456 IsSelection(self) -> bool
4457
4458 For a listbox or similar event, returns true if it is a selection,
4459 false if it is a deselection.
4460 """
5b5c9bc7 4461 return _core_.CommandEvent_IsSelection(*args, **kwargs)
d55e5bfc
RD		 4462
4463 def SetExtraLong(*args, **kwargs):
4464 """SetExtraLong(self, long extraLong)"""
5b5c9bc7 4465 return _core_.CommandEvent_SetExtraLong(*args, **kwargs)
d55e5bfc
RD		 4466
4467 def GetExtraLong(*args, **kwargs):
27fb7603
RD		 4468 """
4469 GetExtraLong(self) -> long
4470
5ba5649b
RD		 4471 Returns extra information dependant on the event objects type. If the
4472 event comes from a listbox selection, it is a boolean determining
4473 whether the event was a selection (true) or a deselection (false). A
4474 listbox deselection only occurs for multiple-selection boxes, and in
4475 this case the index and string values are indeterminate and the
4476 listbox must be examined by the application.
27fb7603 4477 """
5b5c9bc7 4478 return _core_.CommandEvent_GetExtraLong(*args, **kwargs)
d55e5bfc
RD		 4479
4480 def SetInt(*args, **kwargs):
4481 """SetInt(self, int i)"""
5b5c9bc7 4482 return _core_.CommandEvent_SetInt(*args, **kwargs)
d55e5bfc
RD		 4483
4484 def GetInt(*args, **kwargs):
27fb7603 4485 """
2131d850 4486 GetInt(self) -> int
27fb7603 4487
5ba5649b
RD		 4488 Returns the integer identifier corresponding to a listbox, choice or
4489 radiobox selection (only if the event was a selection, not a
4490 deselection), or a boolean value representing the value of a checkbox.
27fb7603 4491 """
5b5c9bc7 4492 return _core_.CommandEvent_GetInt(*args, **kwargs)
d55e5bfc 4493
1bd55598
RD		 4494 def GetClientData(*args, **kwargs):
4495 """
4496 GetClientData(self) -> PyObject
4497
4498 Returns the client data object for a listbox or choice selection event, (if any.)
4499 """
4500 return _core_.CommandEvent_GetClientData(*args, **kwargs)
4501
4502 def SetClientData(*args, **kwargs):
4503 """
4504 SetClientData(self, PyObject clientData)
4505
4506 Associate the given client data with the item at position n.
4507 """
4508 return _core_.CommandEvent_SetClientData(*args, **kwargs)
4509
4510 GetClientObject = GetClientData
4511 SetClientObject = SetClientData
4512
d55e5bfc 4513 def Clone(*args, **kwargs):
5b5c9bc7
RD		 4514 """Clone(self) -> Event"""
4515 return _core_.CommandEvent_Clone(*args, **kwargs)
d55e5bfc 4516
2bf58437
RD		 4517 ClientData = property(GetClientData,SetClientData,doc="See `GetClientData` and `SetClientData`")
4518 ClientObject = property(GetClientObject,SetClientObject,doc="See `GetClientObject` and `SetClientObject`")
4519 ExtraLong = property(GetExtraLong,SetExtraLong,doc="See `GetExtraLong` and `SetExtraLong`")
4520 Int = property(GetInt,SetInt,doc="See `GetInt` and `SetInt`")
4521 Selection = property(GetSelection,doc="See `GetSelection`")
4522 String = property(GetString,SetString,doc="See `GetString` and `SetString`")
2131d850 4523_core_.CommandEvent_swigregister(CommandEvent)
d55e5bfc
RD		 4524
4525#---------------------------------------------------------------------------
4526
5b5c9bc7 4527class NotifyEvent(CommandEvent):
27fb7603
RD		 4528 """
4529 An instance of this class (or one of its derived classes) is sent from
4530 a control when the control's state is being changed and the control
4531 allows that change to be prevented from happening. The event handler
4532 can call `Veto` or `Allow` to tell the control what to do.
4533 """
1bd55598
RD		 4534 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4535 __repr__ = _swig_repr
4536 def __init__(self, *args, **kwargs):
27fb7603 4537 """
2131d850 4538 __init__(self, EventType commandType=wxEVT_NULL, int winid=0) -> NotifyEvent
27fb7603
RD		 4539
4540 An instance of this class (or one of its derived classes) is sent from
4541 a control when the control's state is being changed and the control
4542 allows that change to be prevented from happening. The event handler
4543 can call `Veto` or `Allow` to tell the control what to do.
4544 """
1bd55598 4545 _core_.NotifyEvent_swiginit(self,_core_.new_NotifyEvent(*args, **kwargs))
d55e5bfc 4546 def Veto(*args, **kwargs):
27fb7603
RD		 4547 """
4548 Veto(self)
4549
4550 Prevents the change announced by this event from happening.
4551
4552 It is in general a good idea to notify the user about the reasons for
4553 vetoing the change because otherwise the applications behaviour (which
4554 just refuses to do what the user wants) might be quite surprising.
4555 """
5b5c9bc7 4556 return _core_.NotifyEvent_Veto(*args, **kwargs)
d55e5bfc
RD		 4557
4558 def Allow(*args, **kwargs):
27fb7603
RD		 4559 """
4560 Allow(self)
4561
4562 This is the opposite of `Veto`: it explicitly allows the event to be
4563 processed. For most events it is not necessary to call this method as
4564 the events are allowed anyhow but some are forbidden by default (this
4565 will be mentioned in the corresponding event description).
4566 """
5b5c9bc7 4567 return _core_.NotifyEvent_Allow(*args, **kwargs)
d55e5bfc
RD		 4568
4569 def IsAllowed(*args, **kwargs):
27fb7603
RD		 4570 """
4571 IsAllowed(self) -> bool
4572
4573 Returns true if the change is allowed (`Veto` hasn't been called) or
4574 false otherwise (if it was).
4575 """
5b5c9bc7 4576 return _core_.NotifyEvent_IsAllowed(*args, **kwargs)
d55e5bfc 4577
2131d850 4578_core_.NotifyEvent_swigregister(NotifyEvent)
d55e5bfc
RD		 4579
4580#---------------------------------------------------------------------------
4581
5b5c9bc7 4582class ScrollEvent(CommandEvent):
27fb7603
RD		 4583 """
4584 A scroll event holds information about events sent from stand-alone
4585 scrollbars and sliders. Note that scrolled windows do not send
4586 instnaces of this event class, but send the `wx.ScrollWinEvent`
4587 instead.
4588 """
1bd55598
RD		 4589 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4590 __repr__ = _swig_repr
4591 def __init__(self, *args, **kwargs):
d55e5bfc 4592 """
2131d850 4593 __init__(self, EventType commandType=wxEVT_NULL, int winid=0, int pos=0,
5b5c9bc7 4594 int orient=0) -> ScrollEvent
d55e5bfc 4595 """
1bd55598 4596 _core_.ScrollEvent_swiginit(self,_core_.new_ScrollEvent(*args, **kwargs))
d55e5bfc 4597 def GetOrientation(*args, **kwargs):
27fb7603
RD		 4598 """
4599 GetOrientation(self) -> int
4600
4601 Returns wx.HORIZONTAL or wx.VERTICAL, depending on the orientation of
4602 the scrollbar.
4603 """
5b5c9bc7 4604 return _core_.ScrollEvent_GetOrientation(*args, **kwargs)
d55e5bfc
RD		 4605
4606 def GetPosition(*args, **kwargs):
27fb7603
RD		 4607 """
4608 GetPosition(self) -> int
4609
4610 Returns the position of the scrollbar.
4611 """
5b5c9bc7 4612 return _core_.ScrollEvent_GetPosition(*args, **kwargs)
d55e5bfc
RD		 4613
4614 def SetOrientation(*args, **kwargs):
4615 """SetOrientation(self, int orient)"""
5b5c9bc7 4616 return _core_.ScrollEvent_SetOrientation(*args, **kwargs)
d55e5bfc
RD		 4617
4618 def SetPosition(*args, **kwargs):
4619 """SetPosition(self, int pos)"""
5b5c9bc7 4620 return _core_.ScrollEvent_SetPosition(*args, **kwargs)
d55e5bfc 4621
33d6fd3b
RD		 4622 Orientation = property(GetOrientation,SetOrientation,doc="See `GetOrientation` and `SetOrientation`")
4623 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
2131d850 4624_core_.ScrollEvent_swigregister(ScrollEvent)
d55e5bfc
RD		 4625
4626#---------------------------------------------------------------------------
4627
5b5c9bc7 4628class ScrollWinEvent(Event):
27fb7603
RD		 4629 """
4630 A wx.ScrollWinEvent holds information about scrolling and is sent from
4631 scrolling windows.
4632 """
1bd55598
RD		 4633 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4634 __repr__ = _swig_repr
4635 def __init__(self, *args, **kwargs):
27fb7603 4636 """
2131d850 4637 __init__(self, EventType commandType=wxEVT_NULL, int pos=0, int orient=0) -> ScrollWinEvent
27fb7603
RD		 4638
4639 A wx.ScrollWinEvent holds information about scrolling and is sent from
4640 scrolling windows.
4641 """
1bd55598 4642 _core_.ScrollWinEvent_swiginit(self,_core_.new_ScrollWinEvent(*args, **kwargs))
d55e5bfc 4643 def GetOrientation(*args, **kwargs):
27fb7603
RD		 4644 """
4645 GetOrientation(self) -> int
4646
4647 Returns wx.HORIZONTAL or wx.VERTICAL, depending on the orientation of
4648 the scrollbar.
4649 """
5b5c9bc7 4650 return _core_.ScrollWinEvent_GetOrientation(*args, **kwargs)
d55e5bfc
RD		 4651
4652 def GetPosition(*args, **kwargs):
27fb7603
RD		 4653 """
4654 GetPosition(self) -> int
4655
4656 Returns the position of the scrollbar for the thumb track and release
4657 events. Note that this field can't be used for the other events, you
4658 need to query the window itself for the current position in that case.
4659 """
5b5c9bc7 4660 return _core_.ScrollWinEvent_GetPosition(*args, **kwargs)
d55e5bfc
RD		 4661
4662 def SetOrientation(*args, **kwargs):
4663 """SetOrientation(self, int orient)"""
5b5c9bc7 4664 return _core_.ScrollWinEvent_SetOrientation(*args, **kwargs)
d55e5bfc
RD		 4665
4666 def SetPosition(*args, **kwargs):
4667 """SetPosition(self, int pos)"""
5b5c9bc7 4668 return _core_.ScrollWinEvent_SetPosition(*args, **kwargs)
d55e5bfc 4669
33d6fd3b
RD		 4670 Orientation = property(GetOrientation,SetOrientation,doc="See `GetOrientation` and `SetOrientation`")
4671 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
2131d850 4672_core_.ScrollWinEvent_swigregister(ScrollWinEvent)
d55e5bfc
RD		 4673
4674#---------------------------------------------------------------------------
4675
5b5c9bc7
RD		 4676MOUSE_BTN_ANY = _core_.MOUSE_BTN_ANY
4677MOUSE_BTN_NONE = _core_.MOUSE_BTN_NONE
4678MOUSE_BTN_LEFT = _core_.MOUSE_BTN_LEFT
4679MOUSE_BTN_MIDDLE = _core_.MOUSE_BTN_MIDDLE
4680MOUSE_BTN_RIGHT = _core_.MOUSE_BTN_RIGHT
4681class MouseEvent(Event):
27fb7603
RD		 4682 """
4683 This event class contains information about the events generated by
4684 the mouse: they include mouse buttons press and release events and
4685 mouse move events.
4686
4687 All mouse events involving the buttons use ``wx.MOUSE_BTN_LEFT`` for
4688 the left mouse button, ``wx.MOUSE_BTN_MIDDLE`` for the middle one and
4689 ``wx.MOUSE_BTN_RIGHT`` for the right one. Note that not all mice have
4690 a middle button so a portable application should avoid relying on the
4691 events from it.
4692
4693 Note the difference between methods like `LeftDown` and `LeftIsDown`:
4694 the former returns true when the event corresponds to the left mouse
4695 button click while the latter returns true if the left mouse button is
4696 currently being pressed. For example, when the user is dragging the
4697 mouse you can use `LeftIsDown` to test whether the left mouse button
4698 is (still) depressed. Also, by convention, if `LeftDown` returns true,
4699 `LeftIsDown` will also return true in wxWidgets whatever the
4700 underlying GUI behaviour is (which is platform-dependent). The same
4701 applies, of course, to other mouse buttons as well.
4702 """
1bd55598
RD		 4703 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4704 __repr__ = _swig_repr
4705 def __init__(self, *args, **kwargs):
27fb7603 4706 """
2131d850 4707 __init__(self, EventType mouseType=wxEVT_NULL) -> MouseEvent
27fb7603
RD		 4708
4709 Constructs a wx.MouseEvent. Valid event types are:
4710
4711 * wxEVT_ENTER_WINDOW
4712 * wxEVT_LEAVE_WINDOW
4713 * wxEVT_LEFT_DOWN
4714 * wxEVT_LEFT_UP
4715 * wxEVT_LEFT_DCLICK
4716 * wxEVT_MIDDLE_DOWN
4717 * wxEVT_MIDDLE_UP
4718 * wxEVT_MIDDLE_DCLICK
4719 * wxEVT_RIGHT_DOWN
4720 * wxEVT_RIGHT_UP
4721 * wxEVT_RIGHT_DCLICK
4722 * wxEVT_MOTION
4723 * wxEVT_MOUSEWHEEL
4724 """
1bd55598 4725 _core_.MouseEvent_swiginit(self,_core_.new_MouseEvent(*args, **kwargs))
d55e5bfc 4726 def IsButton(*args, **kwargs):
27fb7603
RD		 4727 """
4728 IsButton(self) -> bool
4729
4730 Returns true if the event was a mouse button event (not necessarily a
4731 button down event - that may be tested using `ButtonDown`).
4732 """
5b5c9bc7 4733 return _core_.MouseEvent_IsButton(*args, **kwargs)
d55e5bfc
RD		 4734
4735 def ButtonDown(*args, **kwargs):
27fb7603
RD		 4736 """
4737 ButtonDown(self, int but=MOUSE_BTN_ANY) -> bool
4738
5ba5649b
RD		 4739 If the argument is omitted, this returns true if the event was any
4740 mouse button down event. Otherwise the argument specifies which
4741 button-down event shold be checked for (see `Button` for the possible
4742 values).
27fb7603 4743 """
5b5c9bc7 4744 return _core_.MouseEvent_ButtonDown(*args, **kwargs)
d55e5bfc
RD		 4745
4746 def ButtonDClick(*args, **kwargs):
27fb7603
RD		 4747 """
4748 ButtonDClick(self, int but=MOUSE_BTN_ANY) -> bool
4749
4750 If the argument is omitted, this returns true if the event was any
4751 mouse double click event. Otherwise the argument specifies which
4752 double click event to check for (see `Button` for the possible
4753 values).
4754 """
5b5c9bc7 4755 return _core_.MouseEvent_ButtonDClick(*args, **kwargs)
d55e5bfc
RD		 4756
4757 def ButtonUp(*args, **kwargs):
27fb7603
RD		 4758 """
4759 ButtonUp(self, int but=MOUSE_BTN_ANY) -> bool
4760
4761 If the argument is omitted, this returns true if the event was any
5ba5649b
RD		 4762 mouse button up event. Otherwise the argument specifies which button
4763 up event to check for (see `Button` for the possible values).
27fb7603 4764 """
5b5c9bc7 4765 return _core_.MouseEvent_ButtonUp(*args, **kwargs)
d55e5bfc
RD		 4766
4767 def Button(*args, **kwargs):
27fb7603
RD		 4768 """
4769 Button(self, int button) -> bool
4770
4771 Returns true if the identified mouse button is changing state. Valid
4772 values of button are:
4773
4774 ==================== =====================================
4775 wx.MOUSE_BTN_LEFT check if left button was pressed
4776 wx.MOUSE_BTN_MIDDLE check if middle button was pressed
4777 wx.MOUSE_BTN_RIGHT check if right button was pressed
4778 wx.MOUSE_BTN_ANY check if any button was pressed
4779 ==================== =====================================
4780
4781 """
5b5c9bc7 4782 return _core_.MouseEvent_Button(*args, **kwargs)
d55e5bfc
RD		 4783
4784 def ButtonIsDown(*args, **kwargs):
4785 """ButtonIsDown(self, int but) -> bool"""
5b5c9bc7 4786 return _core_.MouseEvent_ButtonIsDown(*args, **kwargs)
d55e5bfc
RD		 4787
4788 def GetButton(*args, **kwargs):
27fb7603
RD		 4789 """
4790 GetButton(self) -> int
4791
4792 Returns the mouse button which generated this event or
4793 wx.MOUSE_BTN_NONE if no button is involved (for mouse move, enter or
4794 leave event, for example). Otherwise wx.MOUSE_BTN_LEFT is returned for
4795 the left button down, up and double click events, wx.MOUSE_BTN_MIDDLE
4796 and wx.MOUSE_BTN_RIGHT for the same events for the middle and the
4797 right buttons respectively.
4798 """
5b5c9bc7 4799 return _core_.MouseEvent_GetButton(*args, **kwargs)
d55e5bfc
RD		 4800
4801 def ControlDown(*args, **kwargs):
27fb7603
RD		 4802 """
4803 ControlDown(self) -> bool
4804
4805 Returns true if the control key was down at the time of the event.
4806 """
5b5c9bc7 4807 return _core_.MouseEvent_ControlDown(*args, **kwargs)
d55e5bfc
RD		 4808
4809 def MetaDown(*args, **kwargs):
27fb7603
RD		 4810 """
4811 MetaDown(self) -> bool
4812
4813 Returns true if the Meta key was down at the time of the event.
4814 """
5b5c9bc7 4815 return _core_.MouseEvent_MetaDown(*args, **kwargs)
d55e5bfc
RD		 4816
4817 def AltDown(*args, **kwargs):
27fb7603
RD		 4818 """
4819 AltDown(self) -> bool
4820
4821 Returns true if the Alt key was down at the time of the event.
4822 """
5b5c9bc7 4823 return _core_.MouseEvent_AltDown(*args, **kwargs)
d55e5bfc
RD		 4824
4825 def ShiftDown(*args, **kwargs):
27fb7603
RD		 4826 """
4827 ShiftDown(self) -> bool
4828
4829 Returns true if the Shift key was down at the time of the event.
4830 """
5b5c9bc7 4831 return _core_.MouseEvent_ShiftDown(*args, **kwargs)
d55e5bfc 4832
412d302d
RD		 4833 def CmdDown(*args, **kwargs):
4834 """
4835 CmdDown(self) -> bool
4836
4837 "Cmd" is a pseudo key which is the same as Control for PC and Unix
4838 platforms but the special "Apple" (a.k.a as "Command") key on
5ba5649b 4839 Macs. It often makes sense to use it instead of, say, `ControlDown`
412d302d 4840 because Cmd key is used for the same thing under Mac as Ctrl
27fb7603 4841 elsewhere. The Ctrl key still exists, it's just not used for this
412d302d
RD		 4842 purpose. So for non-Mac platforms this is the same as `ControlDown`
4843 and Macs this is the same as `MetaDown`.
4844 """
5b5c9bc7 4845 return _core_.MouseEvent_CmdDown(*args, **kwargs)
412d302d 4846
d55e5bfc 4847 def LeftDown(*args, **kwargs):
27fb7603
RD		 4848 """
4849 LeftDown(self) -> bool
4850
4851 Returns true if the left mouse button state changed to down.
4852 """
5b5c9bc7 4853 return _core_.MouseEvent_LeftDown(*args, **kwargs)
d55e5bfc
RD		 4854
4855 def MiddleDown(*args, **kwargs):
27fb7603
RD		 4856 """
4857 MiddleDown(self) -> bool
4858
4859 Returns true if the middle mouse button state changed to down.
4860 """
5b5c9bc7 4861 return _core_.MouseEvent_MiddleDown(*args, **kwargs)
d55e5bfc
RD		 4862
4863 def RightDown(*args, **kwargs):
27fb7603
RD		 4864 """
4865 RightDown(self) -> bool
4866
4867 Returns true if the right mouse button state changed to down.
4868 """
5b5c9bc7 4869 return _core_.MouseEvent_RightDown(*args, **kwargs)
d55e5bfc
RD		 4870
4871 def LeftUp(*args, **kwargs):
27fb7603
RD		 4872 """
4873 LeftUp(self) -> bool
4874
4875 Returns true if the left mouse button state changed to up.
4876 """
5b5c9bc7 4877 return _core_.MouseEvent_LeftUp(*args, **kwargs)
d55e5bfc
RD		 4878
4879 def MiddleUp(*args, **kwargs):
27fb7603
RD		 4880 """
4881 MiddleUp(self) -> bool
4882
4883 Returns true if the middle mouse button state changed to up.
4884 """
5b5c9bc7 4885 return _core_.MouseEvent_MiddleUp(*args, **kwargs)
d55e5bfc
RD		 4886
4887 def RightUp(*args, **kwargs):
27fb7603
RD		 4888 """
4889 RightUp(self) -> bool
4890
4891 Returns true if the right mouse button state changed to up.
4892 """
5b5c9bc7 4893 return _core_.MouseEvent_RightUp(*args, **kwargs)
d55e5bfc
RD		 4894
4895 def LeftDClick(*args, **kwargs):
27fb7603
RD		 4896 """
4897 LeftDClick(self) -> bool
4898
4899 Returns true if the event was a left button double click.
4900 """
5b5c9bc7 4901 return _core_.MouseEvent_LeftDClick(*args, **kwargs)
d55e5bfc
RD		 4902
4903 def MiddleDClick(*args, **kwargs):
27fb7603
RD		 4904 """
4905 MiddleDClick(self) -> bool
4906
4907 Returns true if the event was a middle button double click.
4908 """
5b5c9bc7 4909 return _core_.MouseEvent_MiddleDClick(*args, **kwargs)
d55e5bfc
RD		 4910
4911 def RightDClick(*args, **kwargs):
27fb7603
RD		 4912 """
4913 RightDClick(self) -> bool
4914
4915 Returns true if the event was a right button double click.
4916 """
5b5c9bc7 4917 return _core_.MouseEvent_RightDClick(*args, **kwargs)
d55e5bfc
RD		 4918
4919 def LeftIsDown(*args, **kwargs):
27fb7603
RD		 4920 """
4921 LeftIsDown(self) -> bool
4922
4923 Returns true if the left mouse button is currently down, independent
4924 of the current event type.
4925
4926 Please notice that it is not the same as LeftDown which returns true
4927 if the left mouse button was just pressed. Rather, it describes the
4928 state of the mouse button before the event happened.
4929
4930 This event is usually used in the mouse event handlers which process
4931 "move mouse" messages to determine whether the user is (still)
4932 dragging the mouse.
4933 """
5b5c9bc7 4934 return _core_.MouseEvent_LeftIsDown(*args, **kwargs)
d55e5bfc
RD		 4935
4936 def MiddleIsDown(*args, **kwargs):
27fb7603
RD		 4937 """
4938 MiddleIsDown(self) -> bool
4939
4940 Returns true if the middle mouse button is currently down, independent
4941 of the current event type.
4942 """
5b5c9bc7 4943 return _core_.MouseEvent_MiddleIsDown(*args, **kwargs)
d55e5bfc
RD		 4944
4945 def RightIsDown(*args, **kwargs):
27fb7603
RD		 4946 """
4947 RightIsDown(self) -> bool
4948
4949 Returns true if the right mouse button is currently down, independent
4950 of the current event type.
4951 """
5b5c9bc7 4952 return _core_.MouseEvent_RightIsDown(*args, **kwargs)
d55e5bfc
RD		 4953
4954 def Dragging(*args, **kwargs):
27fb7603
RD		 4955 """
4956 Dragging(self) -> bool
4957
4958 Returns true if this was a dragging event (motion while a button is
4959 depressed).
4960 """
5b5c9bc7 4961 return _core_.MouseEvent_Dragging(*args, **kwargs)
d55e5bfc
RD		 4962
4963 def Moving(*args, **kwargs):
27fb7603
RD		 4964 """
4965 Moving(self) -> bool
4966
4967 Returns true if this was a motion event and no mouse buttons were
4968 pressed. If any mouse button is held pressed, then this method returns
4969 false and Dragging returns true.
4970 """
5b5c9bc7 4971 return _core_.MouseEvent_Moving(*args, **kwargs)
d55e5bfc
RD		 4972
4973 def Entering(*args, **kwargs):
27fb7603
RD		 4974 """
4975 Entering(self) -> bool
4976
4977 Returns true if the mouse was entering the window.
4978 """
5b5c9bc7 4979 return _core_.MouseEvent_Entering(*args, **kwargs)
d55e5bfc
RD		 4980
4981 def Leaving(*args, **kwargs):
27fb7603
RD		 4982 """
4983 Leaving(self) -> bool
4984
4985 Returns true if the mouse was leaving the window.
4986 """
5b5c9bc7 4987 return _core_.MouseEvent_Leaving(*args, **kwargs)
d55e5bfc
RD		 4988
4989 def GetPosition(*args, **kwargs):
4990 """
5b5c9bc7 4991 GetPosition(self) -> Point
d55e5bfc 4992
27fb7603
RD		 4993 Returns the pixel position of the mouse in window coordinates when the
4994 event happened.
d55e5bfc 4995 """
5b5c9bc7 4996 return _core_.MouseEvent_GetPosition(*args, **kwargs)
d55e5bfc
RD		 4997
4998 def GetPositionTuple(*args, **kwargs):
4999 """
5000 GetPositionTuple() -> (x,y)
5001
27fb7603
RD		 5002 Returns the pixel position of the mouse in window coordinates when the
5003 event happened.
d55e5bfc 5004 """
5b5c9bc7 5005 return _core_.MouseEvent_GetPositionTuple(*args, **kwargs)
d55e5bfc
RD		 5006
5007 def GetLogicalPosition(*args, **kwargs):
27fb7603
RD		 5008 """
5009 GetLogicalPosition(self, DC dc) -> Point
5010
5011 Returns the logical mouse position in pixels (i.e. translated
5012 according to the translation set for the DC, which usually indicates
5013 that the window has been scrolled).
5014 """
5b5c9bc7 5015 return _core_.MouseEvent_GetLogicalPosition(*args, **kwargs)
d55e5bfc
RD		 5016
5017 def GetX(*args, **kwargs):
27fb7603
RD		 5018 """
5019 GetX(self) -> int
5020
5021 Returns X coordinate of the physical mouse event position.
5022 """
5b5c9bc7 5023 return _core_.MouseEvent_GetX(*args, **kwargs)
d55e5bfc
RD		 5024
5025 def GetY(*args, **kwargs):
27fb7603
RD		 5026 """
5027 GetY(self) -> int
5028
5029 Returns Y coordinate of the physical mouse event position.
5030 """
5b5c9bc7 5031 return _core_.MouseEvent_GetY(*args, **kwargs)
d55e5bfc
RD		 5032
5033 def GetWheelRotation(*args, **kwargs):
27fb7603
RD		 5034 """
5035 GetWheelRotation(self) -> int
5036
5037 Get wheel rotation, positive or negative indicates direction of
5038 rotation. Current devices all send an event when rotation is equal to
5039 +/-WheelDelta, but this allows for finer resolution devices to be
5040 created in the future. Because of this you shouldn't assume that one
5041 event is equal to 1 line or whatever, but you should be able to either
5042 do partial line scrolling or wait until +/-WheelDelta rotation values
5043 have been accumulated before scrolling.
5044 """
5b5c9bc7 5045 return _core_.MouseEvent_GetWheelRotation(*args, **kwargs)
d55e5bfc
RD		 5046
5047 def GetWheelDelta(*args, **kwargs):
27fb7603
RD		 5048 """
5049 GetWheelDelta(self) -> int
5050
5051 Get wheel delta, normally 120. This is the threshold for action to be
5052 taken, and one such action (for example, scrolling one increment)
5053 should occur for each delta.
5054 """
5b5c9bc7 5055 return _core_.MouseEvent_GetWheelDelta(*args, **kwargs)
d55e5bfc
RD		 5056
5057 def GetLinesPerAction(*args, **kwargs):
27fb7603
RD		 5058 """
5059 GetLinesPerAction(self) -> int
5060
5061 Returns the configured number of lines (or whatever) to be scrolled
5062 per wheel action. Defaults to three.
5063 """
5b5c9bc7 5064 return _core_.MouseEvent_GetLinesPerAction(*args, **kwargs)
d55e5bfc
RD		 5065
5066 def IsPageScroll(*args, **kwargs):
27fb7603
RD		 5067 """
5068 IsPageScroll(self) -> bool
5069
5070 Returns true if the system has been setup to do page scrolling with
5071 the mouse wheel instead of line scrolling.
5072 """
5b5c9bc7
RD		 5073 return _core_.MouseEvent_IsPageScroll(*args, **kwargs)
5074
5075 m_x = property(_core_.MouseEvent_m_x_get, _core_.MouseEvent_m_x_set)
5076 m_y = property(_core_.MouseEvent_m_y_get, _core_.MouseEvent_m_y_set)
5077 m_leftDown = property(_core_.MouseEvent_m_leftDown_get, _core_.MouseEvent_m_leftDown_set)
5078 m_middleDown = property(_core_.MouseEvent_m_middleDown_get, _core_.MouseEvent_m_middleDown_set)
5079 m_rightDown = property(_core_.MouseEvent_m_rightDown_get, _core_.MouseEvent_m_rightDown_set)
5080 m_controlDown = property(_core_.MouseEvent_m_controlDown_get, _core_.MouseEvent_m_controlDown_set)
5081 m_shiftDown = property(_core_.MouseEvent_m_shiftDown_get, _core_.MouseEvent_m_shiftDown_set)
5082 m_altDown = property(_core_.MouseEvent_m_altDown_get, _core_.MouseEvent_m_altDown_set)
5083 m_metaDown = property(_core_.MouseEvent_m_metaDown_get, _core_.MouseEvent_m_metaDown_set)
5084 m_wheelRotation = property(_core_.MouseEvent_m_wheelRotation_get, _core_.MouseEvent_m_wheelRotation_set)
5085 m_wheelDelta = property(_core_.MouseEvent_m_wheelDelta_get, _core_.MouseEvent_m_wheelDelta_set)
5086 m_linesPerAction = property(_core_.MouseEvent_m_linesPerAction_get, _core_.MouseEvent_m_linesPerAction_set)
57332a5a
RD		 5087 Button = property(GetButton,doc="See `GetButton`")
5088 LinesPerAction = property(GetLinesPerAction,doc="See `GetLinesPerAction`")
5089 LogicalPosition = property(GetLogicalPosition,doc="See `GetLogicalPosition`")
5090 Position = property(GetPosition,doc="See `GetPosition`")
5091 WheelDelta = property(GetWheelDelta,doc="See `GetWheelDelta`")
5092 WheelRotation = property(GetWheelRotation,doc="See `GetWheelRotation`")
5093 X = property(GetX,doc="See `GetX`")
5094 Y = property(GetY,doc="See `GetY`")
2131d850 5095_core_.MouseEvent_swigregister(MouseEvent)
d55e5bfc
RD		 5096
5097#---------------------------------------------------------------------------
5098
5b5c9bc7 5099class SetCursorEvent(Event):
5ba5649b
RD		 5100 """
5101 A SetCursorEvent is generated when the mouse cursor is about to be set
5102 as a result of mouse motion. This event gives the application the
5103 chance to perform specific mouse cursor processing based on the
5104 current position of the mouse within the window. Use the `SetCursor`
5105 method to specify the cursor you want to be displayed.
5106 """
1bd55598
RD		 5107 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5108 __repr__ = _swig_repr
5109 def __init__(self, *args, **kwargs):
5ba5649b
RD		 5110 """
5111 __init__(self, int x=0, int y=0) -> SetCursorEvent
5112
5113 Construct a new `wx.SetCursorEvent`.
5114 """
1bd55598 5115 _core_.SetCursorEvent_swiginit(self,_core_.new_SetCursorEvent(*args, **kwargs))
d55e5bfc 5116 def GetX(*args, **kwargs):
5ba5649b
RD		 5117 """
5118 GetX(self) -> int
5119
5120 Returns the X coordinate of the mouse in client coordinates.
5121 """
5b5c9bc7 5122 return _core_.SetCursorEvent_GetX(*args, **kwargs)
d55e5bfc
RD		 5123
5124 def GetY(*args, **kwargs):
5ba5649b
RD		 5125 """
5126 GetY(self) -> int
5127
5128 Returns the Y coordinate of the mouse in client coordinates.
5129 """
5b5c9bc7 5130 return _core_.SetCursorEvent_GetY(*args, **kwargs)
d55e5bfc
RD		 5131
5132 def SetCursor(*args, **kwargs):
5ba5649b
RD		 5133 """
5134 SetCursor(self, Cursor cursor)
5135
5136 Sets the cursor associated with this event.
5137 """
5b5c9bc7 5138 return _core_.SetCursorEvent_SetCursor(*args, **kwargs)
d55e5bfc
RD		 5139
5140 def GetCursor(*args, **kwargs):
5ba5649b
RD		 5141 """
5142 GetCursor(self) -> Cursor
5143
5144 Returns a reference to the cursor specified by this event.
5145 """
5b5c9bc7 5146 return _core_.SetCursorEvent_GetCursor(*args, **kwargs)
d55e5bfc
RD		 5147
5148 def HasCursor(*args, **kwargs):
5ba5649b
RD		 5149 """
5150 HasCursor(self) -> bool
5151
5152 Returns true if the cursor specified by this event is a valid cursor.
5153 """
5b5c9bc7 5154 return _core_.SetCursorEvent_HasCursor(*args, **kwargs)
d55e5bfc 5155
33d6fd3b
RD		 5156 Cursor = property(GetCursor,SetCursor,doc="See `GetCursor` and `SetCursor`")
5157 X = property(GetX,doc="See `GetX`")
5158 Y = property(GetY,doc="See `GetY`")
2131d850 5159_core_.SetCursorEvent_swigregister(SetCursorEvent)
d55e5bfc
RD		 5160
5161#---------------------------------------------------------------------------
5162
5b5c9bc7 5163class KeyEvent(Event):
5ba5649b
RD		 5164 """
5165 This event class contains information about keypress and character
5166 events. These events are only sent to the widget that currently has
5167 the keyboard focus.
5168
5169 Notice that there are three different kinds of keyboard events in
5170 wxWidgets: key down and up events and char events. The difference
5171 between the first two is clear - the first corresponds to a key press
5172 and the second to a key release - otherwise they are identical. Just
5173 note that if the key is maintained in a pressed state you will
5174 typically get a lot of (automatically generated) down events but only
5175 one up so it is wrong to assume that there is one up event
5176 corresponding to each down one.
5177
5178 Both key events provide untranslated key codes while the char event
5179 carries the translated one. The untranslated code for alphanumeric
5180 keys is always an upper case value. For the other keys it is one of
5181 WXK_XXX values from the keycodes table. The translated key is, in
5182 general, the character the user expects to appear as the result of the
5183 key combination when typing the text into a text entry zone, for
5184 example.
5185
5186 A few examples to clarify this (all assume that CAPS LOCK is unpressed
5187 and the standard US keyboard): when the 'A' key is pressed, the key
5188 down event key code is equal to ASCII A == 65. But the char event key
5189 code is ASCII a == 97. On the other hand, if you press both SHIFT and
5190 'A' keys simultaneously , the key code in key down event will still be
5191 just 'A' while the char event key code parameter will now be 'A' as
5192 well.
5193
5194 Although in this simple case it is clear that the correct key code
5195 could be found in the key down event handler by checking the value
5196 returned by `ShiftDown`, in general you should use EVT_CHAR for this
5197 as for non alphanumeric keys or non-US keyboard layouts the
5198 translation is keyboard-layout dependent and can only be done properly
5199 by the system itself.
5200
5201 Another kind of translation is done when the control key is pressed:
5202 for example, for CTRL-A key press the key down event still carries the
5203 same key code 'A' as usual but the char event will have key code of 1,
5204 the ASCII value of this key combination.
5205
5206 You may discover how the other keys on your system behave
5207 interactively by running the KeyEvents sample in the wxPython demo and
5208 pressing some keys while the blue box at the top has the keyboard
5209 focus.
5210
5211 **Note**: If a key down event is caught and the event handler does not
5212 call event.Skip() then the coresponding char event will not
5213 happen. This is by design and enables the programs that handle both
5214 types of events to be a bit simpler.
5215
5216 **Note for Windows programmers**: The key and char events in wxWidgets
5217 are similar to but slightly different from Windows WM_KEYDOWN and
5218 WM_CHAR events. In particular, Alt-x combination will generate a char
5219 event in wxWidgets (unless it is used as an accelerator).
5220
5221 **Tip**: be sure to call event.Skip() for events that you don't
5222 process in key event function, otherwise menu shortcuts may cease to
5223 work under Windows.
5224
5225 """
1bd55598
RD		 5226 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5227 __repr__ = _swig_repr
5228 def __init__(self, *args, **kwargs):
5ba5649b 5229 """
2131d850 5230 __init__(self, EventType eventType=wxEVT_NULL) -> KeyEvent
5ba5649b
RD		 5231
5232 Construct a new `wx.KeyEvent`. Valid event types are:
5233 *
5234 """
1bd55598 5235 _core_.KeyEvent_swiginit(self,_core_.new_KeyEvent(*args, **kwargs))
b1fcee84
RD		 5236 def GetModifiers(*args, **kwargs):
5237 """
5238 GetModifiers(self) -> int
5239
5240 Returns a bitmask of the current modifier settings. Can be used to
5241 check if the key event has exactly the given modifiers without having
5242 to explicitly check that the other modifiers are not down. For
5243 example::
5244
5245 if event.GetModifers() == wx.MOD_CONTROL:
5246 DoSomething()
5247
5248 """
5249 return _core_.KeyEvent_GetModifiers(*args, **kwargs)
5250
d55e5bfc 5251 def ControlDown(*args, **kwargs):
5ba5649b
RD		 5252 """
5253 ControlDown(self) -> bool
5254
5255 Returns ``True`` if the Control key was down at the time of the event.
5256 """
5b5c9bc7 5257 return _core_.KeyEvent_ControlDown(*args, **kwargs)
d55e5bfc
RD		 5258
5259 def MetaDown(*args, **kwargs):
5ba5649b
RD		 5260 """
5261 MetaDown(self) -> bool
5262
5263 Returns ``True`` if the Meta key was down at the time of the event.
5264 """
5b5c9bc7 5265 return _core_.KeyEvent_MetaDown(*args, **kwargs)
d55e5bfc
RD		 5266
5267 def AltDown(*args, **kwargs):
5ba5649b
RD		 5268 """
5269 AltDown(self) -> bool
5270
5271 Returns ``True`` if the Alt key was down at the time of the event.
5272 """
5b5c9bc7 5273 return _core_.KeyEvent_AltDown(*args, **kwargs)
d55e5bfc
RD		 5274
5275 def ShiftDown(*args, **kwargs):
5ba5649b
RD		 5276 """
5277 ShiftDown(self) -> bool
5278
5279 Returns ``True`` if the Shift key was down at the time of the event.
5280 """
5b5c9bc7 5281 return _core_.KeyEvent_ShiftDown(*args, **kwargs)
d55e5bfc 5282
412d302d
RD		 5283 def CmdDown(*args, **kwargs):
5284 """
5285 CmdDown(self) -> bool
5286
5287 "Cmd" is a pseudo key which is the same as Control for PC and Unix
5288 platforms but the special "Apple" (a.k.a as "Command") key on
5ba5649b 5289 Macs. It makes often sense to use it instead of, say, `ControlDown`
412d302d
RD		 5290 because Cmd key is used for the same thing under Mac as Ctrl
5291 elsewhere. The Ctrl still exists, it's just not used for this
5292 purpose. So for non-Mac platforms this is the same as `ControlDown`
5293 and Macs this is the same as `MetaDown`.
5294 """
5b5c9bc7 5295 return _core_.KeyEvent_CmdDown(*args, **kwargs)
412d302d 5296
d55e5bfc 5297 def HasModifiers(*args, **kwargs):
5ba5649b
RD		 5298 """
5299 HasModifiers(self) -> bool
5300
5301 Returns true if either CTRL or ALT keys was down at the time of the
5302 key event. Note that this function does not take into account neither
5303 SHIFT nor META key states (the reason for ignoring the latter is that
5304 it is common for NUMLOCK key to be configured as META under X but the
5305 key presses even while NUMLOCK is on should be still processed
5306 normally).
5307 """
5b5c9bc7 5308 return _core_.KeyEvent_HasModifiers(*args, **kwargs)
d55e5bfc
RD		 5309
5310 def GetKeyCode(*args, **kwargs):
5ba5649b
RD		 5311 """
5312 GetKeyCode(self) -> int
5313
5314 Returns the virtual key code. ASCII events return normal ASCII values,
5315 while non-ASCII events return values such as WXK_LEFT for the left
5316 cursor key. See `wx.KeyEvent` for a full list of the virtual key
5317 codes.
5318
5319 Note that in Unicode build, the returned value is meaningful only if
5320 the user entered a character that can be represented in current
5321 locale's default charset. You can obtain the corresponding Unicode
5322 character using `GetUnicodeKey`.
5323 """
5b5c9bc7 5324 return _core_.KeyEvent_GetKeyCode(*args, **kwargs)
d55e5bfc 5325
bb4524c4 5326 def GetUnicodeKey(*args, **kwargs):
5ba5649b
RD		 5327 """
5328 GetUnicodeKey(self) -> int
5329
5330 Returns the Unicode character corresponding to this key event. This
5331 function is only meaningfule in a Unicode build of wxPython.
5332 """
5b5c9bc7 5333 return _core_.KeyEvent_GetUnicodeKey(*args, **kwargs)
d55e5bfc 5334
bb4524c4 5335 GetUniChar = GetUnicodeKey
b850e7f3
RD		 5336 def SetUnicodeKey(*args, **kwargs):
5337 """
5338 SetUnicodeKey(self, int uniChar)
5339
5340 Set the Unicode value of the key event, but only if this is a Unicode
5341 build of wxPython.
5342 """
5343 return _core_.KeyEvent_SetUnicodeKey(*args, **kwargs)
5344
d55e5bfc 5345 def GetRawKeyCode(*args, **kwargs):
5ba5649b
RD		 5346 """
5347 GetRawKeyCode(self) -> unsigned int
5348
5349 Returns the raw key code for this event. This is a platform-dependent
5350 scan code which should only be used in advanced
5351 applications. Currently the raw key codes are not supported by all
5352 ports.
5353 """
5b5c9bc7 5354 return _core_.KeyEvent_GetRawKeyCode(*args, **kwargs)
d55e5bfc
RD		 5355
5356 def GetRawKeyFlags(*args, **kwargs):
5ba5649b
RD		 5357 """
5358 GetRawKeyFlags(self) -> unsigned int
5359
5360 Returns the low level key flags for this event. The flags are
5361 platform-dependent and should only be used in advanced applications.
5362 Currently the raw key flags are not supported by all ports.
5363 """
5b5c9bc7 5364 return _core_.KeyEvent_GetRawKeyFlags(*args, **kwargs)
d55e5bfc
RD		 5365
5366 def GetPosition(*args, **kwargs):
5367 """
5b5c9bc7 5368 GetPosition(self) -> Point
d55e5bfc 5369
5ba5649b 5370 Find the position of the event, if applicable.
d55e5bfc 5371 """
5b5c9bc7 5372 return _core_.KeyEvent_GetPosition(*args, **kwargs)
d55e5bfc
RD		 5373
5374 def GetPositionTuple(*args, **kwargs):
5375 """
5376 GetPositionTuple() -> (x,y)
5377
5ba5649b 5378 Find the position of the event, if applicable.
d55e5bfc 5379 """
5b5c9bc7 5380 return _core_.KeyEvent_GetPositionTuple(*args, **kwargs)
d55e5bfc
RD		 5381
5382 def GetX(*args, **kwargs):
5ba5649b
RD		 5383 """
5384 GetX(self) -> int
5385
5386 Returns the X position (in client coordinates) of the event, if
5387 applicable.
5388 """
5b5c9bc7 5389 return _core_.KeyEvent_GetX(*args, **kwargs)
d55e5bfc
RD		 5390
5391 def GetY(*args, **kwargs):
5ba5649b
RD		 5392 """
5393 GetY(self) -> int
5394
5395 Returns the Y position (in client coordinates) of the event, if
5396 applicable.
5397 """
5b5c9bc7
RD		 5398 return _core_.KeyEvent_GetY(*args, **kwargs)
5399
5400 m_x = property(_core_.KeyEvent_m_x_get, _core_.KeyEvent_m_x_set)
5401 m_y = property(_core_.KeyEvent_m_y_get, _core_.KeyEvent_m_y_set)
5402 m_keyCode = property(_core_.KeyEvent_m_keyCode_get, _core_.KeyEvent_m_keyCode_set)
5403 m_controlDown = property(_core_.KeyEvent_m_controlDown_get, _core_.KeyEvent_m_controlDown_set)
5404 m_shiftDown = property(_core_.KeyEvent_m_shiftDown_get, _core_.KeyEvent_m_shiftDown_set)
5405 m_altDown = property(_core_.KeyEvent_m_altDown_get, _core_.KeyEvent_m_altDown_set)
5406 m_metaDown = property(_core_.KeyEvent_m_metaDown_get, _core_.KeyEvent_m_metaDown_set)
5407 m_scanCode = property(_core_.KeyEvent_m_scanCode_get, _core_.KeyEvent_m_scanCode_set)
5408 m_rawCode = property(_core_.KeyEvent_m_rawCode_get, _core_.KeyEvent_m_rawCode_set)
5409 m_rawFlags = property(_core_.KeyEvent_m_rawFlags_get, _core_.KeyEvent_m_rawFlags_set)
ac5d357a
RD		 5410 KeyCode = property(GetKeyCode,doc="See `GetKeyCode`")
5411 Modifiers = property(GetModifiers,doc="See `GetModifiers`")
5412 Position = property(GetPosition,doc="See `GetPosition`")
5413 RawKeyCode = property(GetRawKeyCode,doc="See `GetRawKeyCode`")
5414 RawKeyFlags = property(GetRawKeyFlags,doc="See `GetRawKeyFlags`")
5415 UnicodeKey = property(GetUnicodeKey,SetUnicodeKey,doc="See `GetUnicodeKey` and `SetUnicodeKey`")
5416 X = property(GetX,doc="See `GetX`")
5417 Y = property(GetY,doc="See `GetY`")
2131d850 5418_core_.KeyEvent_swigregister(KeyEvent)
d55e5bfc
RD		 5419
5420#---------------------------------------------------------------------------
5421
5b5c9bc7 5422class SizeEvent(Event):
5ba5649b
RD		 5423 """
5424 A size event holds information about size change events. The EVT_SIZE
5425 handler function will be called when the window it is bound to has
5426 been resized.
5427
5428 Note that the size passed is of the whole window: call
5429 `wx.Window.GetClientSize` for the area which may be used by the
5430 application.
5431
5432 When a window is resized, usually only a small part of the window is
5433 damaged and and that area is all that is in the update region for the
5434 next paint event. However, if your drawing depends on the size of the
5435 window, you may need to clear the DC explicitly and repaint the whole
5436 window. In which case, you may need to call `wx.Window.Refresh` to
5437 invalidate the entire window.
5438
5439 """
1bd55598
RD		 5440 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5441 __repr__ = _swig_repr
5442 def __init__(self, *args, **kwargs):
5ba5649b
RD		 5443 """
5444 __init__(self, Size sz=DefaultSize, int winid=0) -> SizeEvent
5445
5446 Construct a new ``wx.SizeEvent``.
5447 """
1bd55598 5448 _core_.SizeEvent_swiginit(self,_core_.new_SizeEvent(*args, **kwargs))
d55e5bfc 5449 def GetSize(*args, **kwargs):
5ba5649b
RD		 5450 """
5451 GetSize(self) -> Size
5452
5453 Returns the entire size of the window generating the size change
5454 event.
5455 """
5b5c9bc7 5456 return _core_.SizeEvent_GetSize(*args, **kwargs)
d55e5bfc
RD		 5457
5458 def GetRect(*args, **kwargs):
5b5c9bc7
RD		 5459 """GetRect(self) -> Rect"""
5460 return _core_.SizeEvent_GetRect(*args, **kwargs)
d55e5bfc
RD		 5461
5462 def SetRect(*args, **kwargs):
5b5c9bc7
RD		 5463 """SetRect(self, Rect rect)"""
5464 return _core_.SizeEvent_SetRect(*args, **kwargs)
d55e5bfc
RD		 5465
5466 def SetSize(*args, **kwargs):
5b5c9bc7
RD		 5467 """SetSize(self, Size size)"""
5468 return _core_.SizeEvent_SetSize(*args, **kwargs)
d55e5bfc 5469
5b5c9bc7
RD		 5470 m_size = property(_core_.SizeEvent_m_size_get, _core_.SizeEvent_m_size_set)
5471 m_rect = property(_core_.SizeEvent_m_rect_get, _core_.SizeEvent_m_rect_set)
33d6fd3b
RD		 5472 Rect = property(GetRect,SetRect,doc="See `GetRect` and `SetRect`")
5473 Size = property(GetSize,SetSize,doc="See `GetSize` and `SetSize`")
2131d850 5474_core_.SizeEvent_swigregister(SizeEvent)
d55e5bfc
RD		 5475
5476#---------------------------------------------------------------------------
5477
5b5c9bc7 5478class MoveEvent(Event):
5ba5649b
RD		 5479 """
5480 This event object is sent for EVT_MOVE event bindings when a window is
5481 moved to a new position.
5482 """
1bd55598
RD		 5483 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5484 __repr__ = _swig_repr
5485 def __init__(self, *args, **kwargs):
5ba5649b
RD		 5486 """
5487 __init__(self, Point pos=DefaultPosition, int winid=0) -> MoveEvent
5488
5489 Constructor.
5490 """
1bd55598 5491 _core_.MoveEvent_swiginit(self,_core_.new_MoveEvent(*args, **kwargs))
d55e5bfc 5492 def GetPosition(*args, **kwargs):
5ba5649b
RD		 5493 """
5494 GetPosition(self) -> Point
5495
5496 Returns the position of the window generating the move change event.
5497 """
5b5c9bc7 5498 return _core_.MoveEvent_GetPosition(*args, **kwargs)
d55e5bfc
RD		 5499
5500 def GetRect(*args, **kwargs):
5b5c9bc7
RD		 5501 """GetRect(self) -> Rect"""
5502 return _core_.MoveEvent_GetRect(*args, **kwargs)
d55e5bfc
RD		 5503
5504 def SetRect(*args, **kwargs):
5b5c9bc7
RD		 5505 """SetRect(self, Rect rect)"""
5506 return _core_.MoveEvent_SetRect(*args, **kwargs)
d55e5bfc
RD		 5507
5508 def SetPosition(*args, **kwargs):
5b5c9bc7
RD		 5509 """SetPosition(self, Point pos)"""
5510 return _core_.MoveEvent_SetPosition(*args, **kwargs)
d55e5bfc 5511
fef4c27a
RD		 5512 m_pos = property(GetPosition, SetPosition)
5513 m_rect = property(GetRect, SetRect)
5514
57332a5a
RD		 5515 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
5516 Rect = property(GetRect,SetRect,doc="See `GetRect` and `SetRect`")
2131d850 5517_core_.MoveEvent_swigregister(MoveEvent)
d55e5bfc
RD		 5518
5519#---------------------------------------------------------------------------
5520
5b5c9bc7 5521class PaintEvent(Event):
5ba5649b
RD		 5522 """
5523 A paint event is sent when a window's contents needs to be repainted.
5524 Note that in an EVT_PAINT handler the application must *always* create
5525 a `wx.PaintDC` object, even if you do not use it. Otherwise MS
5526 Windows assumes that the window has not been painted yet and will send
5527 the event again, causing endless refreshes.
5528
5529 You can optimize painting by retrieving the rectangles that have been
5530 damaged using `wx.Window.GetUpdateRegion` and/or `wx.RegionIterator`,
5531 and only repainting these rectangles. The rectangles are in terms of
5532 the client area, and are unscrolled, so you will need to do some
5533 calculations using the current view position to obtain logical,
5534 scrolled units.
5535
5536 """
1bd55598
RD		 5537 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5538 __repr__ = _swig_repr
5539 def __init__(self, *args, **kwargs):
5b5c9bc7 5540 """__init__(self, int Id=0) -> PaintEvent"""
1bd55598 5541 _core_.PaintEvent_swiginit(self,_core_.new_PaintEvent(*args, **kwargs))
2131d850 5542_core_.PaintEvent_swigregister(PaintEvent)
d55e5bfc 5543
5b5c9bc7
RD		 5544class NcPaintEvent(Event):
5545 """Proxy of C++ NcPaintEvent class"""
1bd55598
RD		 5546 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5547 __repr__ = _swig_repr
5548 def __init__(self, *args, **kwargs):
5b5c9bc7 5549 """__init__(self, int winid=0) -> NcPaintEvent"""
1bd55598 5550 _core_.NcPaintEvent_swiginit(self,_core_.new_NcPaintEvent(*args, **kwargs))
2131d850 5551_core_.NcPaintEvent_swigregister(NcPaintEvent)
d55e5bfc
RD		 5552
5553#---------------------------------------------------------------------------
5554
5b5c9bc7 5555class EraseEvent(Event):
5ba5649b
RD		 5556 """
5557 An erase event is sent whenever the background of a window needs to be
5558 repainted. To intercept this event use the EVT_ERASE_BACKGROUND event
5559 binder. On some platforms, such as GTK+, this event is simulated
5560 (simply generated just before the paint event) and may cause flicker.
5561
5562 To paint a custom background use the `GetDC` method and use the returned
5563 device context if it is not ``None``, otherwise create a temporary
5564 `wx.ClientDC` and draw on that.
5565
5566 """
1bd55598
RD		 5567 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5568 __repr__ = _swig_repr
5569 def __init__(self, *args, **kwargs):
5ba5649b
RD		 5570 """
5571 __init__(self, int Id=0, DC dc=None) -> EraseEvent
5572
5573 Constructor
5574 """
1bd55598 5575 _core_.EraseEvent_swiginit(self,_core_.new_EraseEvent(*args, **kwargs))
d55e5bfc 5576 def GetDC(*args, **kwargs):
5ba5649b
RD		 5577 """
5578 GetDC(self) -> DC
5579
5580 Returns the device context the event handler should draw upon. If
5581 ``None`` is returned then create a temporary `wx.ClientDC` and use
5582 that instead.
5583 """
5b5c9bc7 5584 return _core_.EraseEvent_GetDC(*args, **kwargs)
d55e5bfc 5585
ac5d357a 5586 DC = property(GetDC,doc="See `GetDC`")
2131d850 5587_core_.EraseEvent_swigregister(EraseEvent)
d55e5bfc
RD		 5588
5589#---------------------------------------------------------------------------
5590
5b5c9bc7 5591class FocusEvent(Event):
5ba5649b
RD		 5592 """
5593 A focus event is sent when a window's focus changes. The window losing
5594 focus receives an EVT_KILL_FOCUS event while the window gaining it
5595 gets an EVT_SET_FOCUS event.
5596
5597 Notice that the set focus event happens both when the user gives focus
5598 to the window (whether using the mouse or keyboard) and when it is
5599 done from the program itself using `wx.Window.SetFocus`.
5600
5601 """
1bd55598
RD		 5602 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5603 __repr__ = _swig_repr
5604 def __init__(self, *args, **kwargs):
5ba5649b 5605 """
2131d850 5606 __init__(self, EventType type=wxEVT_NULL, int winid=0) -> FocusEvent
5ba5649b
RD		 5607
5608 Constructor
5609 """
1bd55598 5610 _core_.FocusEvent_swiginit(self,_core_.new_FocusEvent(*args, **kwargs))
d55e5bfc 5611 def GetWindow(*args, **kwargs):
5ba5649b
RD		 5612 """
5613 GetWindow(self) -> Window
5614
5615 Returns the other window associated with this event, that is the
5616 window which had the focus before for the EVT_SET_FOCUS event and the
5617 window which is going to receive focus for the wxEVT_KILL_FOCUS event.
5618
5619 Warning: the window returned may be None!
5620 """
5b5c9bc7 5621 return _core_.FocusEvent_GetWindow(*args, **kwargs)
d55e5bfc
RD		 5622
5623 def SetWindow(*args, **kwargs):
5b5c9bc7
RD		 5624 """SetWindow(self, Window win)"""
5625 return _core_.FocusEvent_SetWindow(*args, **kwargs)
d55e5bfc 5626
ac5d357a 5627 Window = property(GetWindow,SetWindow,doc="See `GetWindow` and `SetWindow`")
2131d850 5628_core_.FocusEvent_swigregister(FocusEvent)
d55e5bfc
RD		 5629
5630#---------------------------------------------------------------------------
5631
5b5c9bc7 5632class ChildFocusEvent(CommandEvent):
5ba5649b 5633 """
33d6fd3b
RD		 5634 A child focus event is sent to a (parent-)window when one of its child
5635 windows gains focus, so that the window could restore the focus back
5636 to its corresponding child if it loses it now and regains later.
5637
5638 Notice that child window is the direct child of the window receiving
5639 the event, and so may not be the actual widget recieving focus if it
5640 is further down the containment heirarchy. Use `wx.Window.FindFocus`
5641 to get the widget that is actually receiving focus.
5ba5649b 5642 """
1bd55598
RD		 5643 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5644 __repr__ = _swig_repr
5645 def __init__(self, *args, **kwargs):
5ba5649b
RD		 5646 """
5647 __init__(self, Window win=None) -> ChildFocusEvent
5648
5649 Constructor
5650 """
1bd55598 5651 _core_.ChildFocusEvent_swiginit(self,_core_.new_ChildFocusEvent(*args, **kwargs))
d55e5bfc 5652 def GetWindow(*args, **kwargs):
5ba5649b
RD		 5653 """
5654 GetWindow(self) -> Window
5655
33d6fd3b
RD		 5656 The window, or (grand)parent of the window which has just received the
5657 focus.
5ba5649b 5658 """
5b5c9bc7 5659 return _core_.ChildFocusEvent_GetWindow(*args, **kwargs)
d55e5bfc 5660
2bf58437 5661 Window = property(GetWindow,doc="See `GetWindow`")
2131d850 5662_core_.ChildFocusEvent_swigregister(ChildFocusEvent)
d55e5bfc
RD		 5663
5664#---------------------------------------------------------------------------
5665
5b5c9bc7 5666class ActivateEvent(Event):
5ba5649b
RD		 5667 """
5668 An activate event is sent when a top-level window or the entire
5669 application is being activated or deactivated.
5670
5671 A top-level window (a dialog or frame) receives an activate event when
5672 is being activated or deactivated. This is indicated visually by the
5673 title bar changing colour, and a subwindow gaining the keyboard focus.
5674 An application is activated or deactivated when one of its frames
5675 becomes activated, or a frame becomes inactivate resulting in all
5676 application frames being inactive.
5677
5678 Please note that usually you should call event.Skip() in your handlers
5679 for these events so the default handlers will still be called, as not
5680 doing so can result in strange effects.
5681
5682 """
1bd55598
RD		 5683 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5684 __repr__ = _swig_repr
5685 def __init__(self, *args, **kwargs):
5ba5649b 5686 """
2131d850 5687 __init__(self, EventType type=wxEVT_NULL, bool active=True, int Id=0) -> ActivateEvent
5ba5649b
RD		 5688
5689 Constructor
5690 """
1bd55598 5691 _core_.ActivateEvent_swiginit(self,_core_.new_ActivateEvent(*args, **kwargs))
d55e5bfc 5692 def GetActive(*args, **kwargs):
5ba5649b
RD		 5693 """
5694 GetActive(self) -> bool
5695
5696 Returns true if the application or window is being activated, false
5697 otherwise.
5698 """
5b5c9bc7 5699 return _core_.ActivateEvent_GetActive(*args, **kwargs)
d55e5bfc 5700
2bf58437 5701 Active = property(GetActive,doc="See `GetActive`")
2131d850 5702_core_.ActivateEvent_swigregister(ActivateEvent)
d55e5bfc
RD		 5703
5704#---------------------------------------------------------------------------
5705
5b5c9bc7 5706class InitDialogEvent(Event):
5ba5649b
RD		 5707 """
5708 A wx.InitDialogEvent is sent as a dialog is being initialised, or for
5709 any window when `wx.Window.InitDialog` is called. Handlers for this
5710 event can transfer data to the window, or anything else that should be
5711 done before the user begins editing the form. The default handler
5712 calls `wx.Window.TransferDataToWindow`.
5713 """
1bd55598
RD		 5714 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5715 __repr__ = _swig_repr
5716 def __init__(self, *args, **kwargs):
5ba5649b
RD		 5717 """
5718 __init__(self, int Id=0) -> InitDialogEvent
5719
5720 Constructor
5721 """
1bd55598 5722 _core_.InitDialogEvent_swiginit(self,_core_.new_InitDialogEvent(*args, **kwargs))
2131d850 5723_core_.InitDialogEvent_swigregister(InitDialogEvent)
d55e5bfc
RD		 5724
5725#---------------------------------------------------------------------------
5726
5b5c9bc7 5727class MenuEvent(Event):
5ba5649b
RD		 5728 """
5729 This class is used for a variety of menu-related events. Note that
5730 these do not include menu command events, which are handled by sending
5731 `wx.CommandEvent` objects.
5732
5733 The default handler for wx.EVT_MENU_HIGHLIGHT displays menu item help
5734 text in the first field of the status bar.
5735 """
1bd55598
RD		 5736 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5737 __repr__ = _swig_repr
5738 def __init__(self, *args, **kwargs):
5ba5649b 5739 """
2131d850 5740 __init__(self, EventType type=wxEVT_NULL, int winid=0, Menu menu=None) -> MenuEvent
5ba5649b
RD		 5741
5742 Constructor
5743 """
1bd55598 5744 _core_.MenuEvent_swiginit(self,_core_.new_MenuEvent(*args, **kwargs))
d55e5bfc 5745 def GetMenuId(*args, **kwargs):
5ba5649b
RD		 5746 """
5747 GetMenuId(self) -> int
5748
5749 Returns the menu identifier associated with the event. This method
5750 should be only used with the HIGHLIGHT events.
5751 """
5b5c9bc7 5752 return _core_.MenuEvent_GetMenuId(*args, **kwargs)
d55e5bfc
RD		 5753
5754 def IsPopup(*args, **kwargs):
5ba5649b
RD		 5755 """
5756 IsPopup(self) -> bool
5757
5758 Returns ``True`` if the menu which is being opened or closed is a
5759 popup menu, ``False`` if it is a normal one. This method should only
5760 be used with the OPEN and CLOSE events.
5761 """
5b5c9bc7 5762 return _core_.MenuEvent_IsPopup(*args, **kwargs)
d55e5bfc
RD		 5763
5764 def GetMenu(*args, **kwargs):
5ba5649b
RD		 5765 """
5766 GetMenu(self) -> Menu
5767
5768 Returns the menu which is being opened or closed. This method should
5769 only be used with the OPEN and CLOSE events.
5770 """
5b5c9bc7 5771 return _core_.MenuEvent_GetMenu(*args, **kwargs)
d55e5bfc 5772
57332a5a
RD		 5773 Menu = property(GetMenu,doc="See `GetMenu`")
5774 MenuId = property(GetMenuId,doc="See `GetMenuId`")
2131d850 5775_core_.MenuEvent_swigregister(MenuEvent)
d55e5bfc
RD		 5776
5777#---------------------------------------------------------------------------
5778
5b5c9bc7 5779class CloseEvent(Event):
5ba5649b
RD		 5780 """
5781 This event class contains information about window and session close
5782 events.
5783
5784 The handler function for EVT_CLOSE is called when the user has tried
5785 to close a a frame or dialog box using the window manager controls or
5786 the system menu. It can also be invoked by the application itself
5787 programmatically, for example by calling the `wx.Window.Close`
5788 function.
5789
5790 You should check whether the application is forcing the deletion of
5791 the window using `CanVeto`. If it returns ``False``, you must destroy
5792 the window using `wx.Window.Destroy`. If the return value is ``True``,
5793 it is up to you whether you respond by destroying the window or not.
5794 For example you may wish to display a message dialog prompting to save
5795 files or to cancel the close.
5796
5797 If you don't destroy the window, you should call `Veto` to let the
5798 calling code know that you did not destroy the window. This allows the
5799 `wx.Window.Close` function to return ``True`` or ``False`` depending
5800 on whether the close instruction was honored or not.
5801 """
1bd55598
RD		 5802 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5803 __repr__ = _swig_repr
5804 def __init__(self, *args, **kwargs):
5ba5649b 5805 """
2131d850 5806 __init__(self, EventType type=wxEVT_NULL, int winid=0) -> CloseEvent
5ba5649b
RD		 5807
5808 Constructor.
5809 """
1bd55598 5810 _core_.CloseEvent_swiginit(self,_core_.new_CloseEvent(*args, **kwargs))
d55e5bfc 5811 def SetLoggingOff(*args, **kwargs):
5ba5649b
RD		 5812 """
5813 SetLoggingOff(self, bool logOff)
5814
5815 Sets the 'logging off' flag.
5816 """
5b5c9bc7 5817 return _core_.CloseEvent_SetLoggingOff(*args, **kwargs)
d55e5bfc
RD		 5818
5819 def GetLoggingOff(*args, **kwargs):
5ba5649b
RD		 5820 """
5821 GetLoggingOff(self) -> bool
5822
034e3677
RD		 5823 Returns ``True`` if the user is logging off or ``False`` if the
5824 system is shutting down. This method can only be called for end
5825 session and query end session events, it doesn't make sense for close
5826 window event.
5ba5649b 5827 """
5b5c9bc7 5828 return _core_.CloseEvent_GetLoggingOff(*args, **kwargs)
d55e5bfc
RD		 5829
5830 def Veto(*args, **kwargs):
5ba5649b
RD		 5831 """
5832 Veto(self, bool veto=True)
5833
5834 Call this from your event handler to veto a system shutdown or to
5835 signal to the calling application that a window close did not happen.
5836
5837 You can only veto a shutdown or close if `CanVeto` returns true.
5838 """
5b5c9bc7 5839 return _core_.CloseEvent_Veto(*args, **kwargs)
d55e5bfc 5840
5ba5649b
RD		 5841 def GetVeto(*args, **kwargs):
5842 """GetVeto(self) -> bool"""
5843 return _core_.CloseEvent_GetVeto(*args, **kwargs)
5844
d55e5bfc 5845 def SetCanVeto(*args, **kwargs):
5ba5649b
RD		 5846 """
5847 SetCanVeto(self, bool canVeto)
5848
5849 Sets the 'can veto' flag.
5850 """
5b5c9bc7 5851 return _core_.CloseEvent_SetCanVeto(*args, **kwargs)
d55e5bfc
RD		 5852
5853 def CanVeto(*args, **kwargs):
5ba5649b
RD		 5854 """
5855 CanVeto(self) -> bool
d55e5bfc 5856
5ba5649b
RD		 5857 Returns true if you can veto a system shutdown or a window close
5858 event. Vetoing a window close event is not possible if the calling
5859 code wishes to force the application to exit, and so this function
5860 must be called to check this.
5861 """
5862 return _core_.CloseEvent_CanVeto(*args, **kwargs)
d55e5bfc 5863
2bf58437 5864 LoggingOff = property(GetLoggingOff,SetLoggingOff,doc="See `GetLoggingOff` and `SetLoggingOff`")
2131d850 5865_core_.CloseEvent_swigregister(CloseEvent)
d55e5bfc
RD		 5866
5867#---------------------------------------------------------------------------
5868
5b5c9bc7 5869class ShowEvent(Event):
5ba5649b 5870 """An EVT_SHOW event is sent when a window is shown or hidden."""
1bd55598
RD		 5871 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5872 __repr__ = _swig_repr
5873 def __init__(self, *args, **kwargs):
5ba5649b
RD		 5874 """
5875 __init__(self, int winid=0, bool show=False) -> ShowEvent
5876
5877 An EVT_SHOW event is sent when a window is shown or hidden.
5878 """
1bd55598 5879 _core_.ShowEvent_swiginit(self,_core_.new_ShowEvent(*args, **kwargs))
d55e5bfc
RD		 5880 def SetShow(*args, **kwargs):
5881 """SetShow(self, bool show)"""
5b5c9bc7 5882 return _core_.ShowEvent_SetShow(*args, **kwargs)
d55e5bfc
RD		 5883
5884 def GetShow(*args, **kwargs):
5885 """GetShow(self) -> bool"""
5b5c9bc7 5886 return _core_.ShowEvent_GetShow(*args, **kwargs)
d55e5bfc 5887
33d6fd3b 5888 Show = property(GetShow,SetShow,doc="See `GetShow` and `SetShow`")
2131d850 5889_core_.ShowEvent_swigregister(ShowEvent)
d55e5bfc
RD		 5890
5891#---------------------------------------------------------------------------
5892
5b5c9bc7 5893class IconizeEvent(Event):
5ba5649b
RD		 5894 """
5895 An EVT_ICONIZE event is sent when a frame is iconized (minimized) or
5896 restored.
5897 """
1bd55598
RD		 5898 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5899 __repr__ = _swig_repr
5900 def __init__(self, *args, **kwargs):
5ba5649b
RD		 5901 """
5902 __init__(self, int id=0, bool iconized=True) -> IconizeEvent
5903
5904 An EVT_ICONIZE event is sent when a frame is iconized (minimized) or
5905 restored.
5906 """
1bd55598 5907 _core_.IconizeEvent_swiginit(self,_core_.new_IconizeEvent(*args, **kwargs))
d55e5bfc 5908 def Iconized(*args, **kwargs):
5ba5649b
RD		 5909 """
5910 Iconized(self) -> bool
5911
5912 Returns ``True`` if the frame has been iconized, ``False`` if it has
5913 been restored.
5914 """
5b5c9bc7 5915 return _core_.IconizeEvent_Iconized(*args, **kwargs)
d55e5bfc 5916
2131d850 5917_core_.IconizeEvent_swigregister(IconizeEvent)
d55e5bfc
RD		 5918
5919#---------------------------------------------------------------------------
5920
5b5c9bc7 5921class MaximizeEvent(Event):
5ba5649b 5922 """An EVT_MAXIMIZE event is sent when a frame is maximized or restored."""
1bd55598
RD		 5923 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5924 __repr__ = _swig_repr
5925 def __init__(self, *args, **kwargs):
5ba5649b
RD		 5926 """
5927 __init__(self, int id=0) -> MaximizeEvent
5928
5929 An EVT_MAXIMIZE event is sent when a frame is maximized or restored.
5930 """
1bd55598 5931 _core_.MaximizeEvent_swiginit(self,_core_.new_MaximizeEvent(*args, **kwargs))
2131d850 5932_core_.MaximizeEvent_swigregister(MaximizeEvent)
d55e5bfc
RD		 5933
5934#---------------------------------------------------------------------------
5935
5b5c9bc7 5936class DropFilesEvent(Event):
5ba5649b
RD		 5937 """
5938 This class is used for drop files events, that is, when files have
5939 been dropped onto the window. This functionality is only available
5940 under Windows. The window must have previously been enabled for
5941 dropping by calling `wx.Window.DragAcceptFiles`.
5942
5943 Important note: this is a separate implementation to the more general
5944 drag and drop implementation using `wx.FileDropTarget`, and etc. This
5945 implementation uses the older, Windows message-based approach of
5946 dropping files.
5947
5948 Use wx.EVT_DROP_FILES to bind an event handler to receive file drop
5949 events.
5950
5951 """
1bd55598
RD		 5952 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5953 def __init__(self): raise AttributeError, "No constructor defined"
5954 __repr__ = _swig_repr
d55e5bfc 5955 def GetPosition(*args, **kwargs):
5ba5649b
RD		 5956 """
5957 GetPosition(self) -> Point
5958
5959 Returns the position at which the files were dropped.
5960 """
5b5c9bc7 5961 return _core_.DropFilesEvent_GetPosition(*args, **kwargs)
d55e5bfc
RD		 5962
5963 def GetNumberOfFiles(*args, **kwargs):
5ba5649b
RD		 5964 """
5965 GetNumberOfFiles(self) -> int
5966
5967 Returns the number of files dropped.
5968 """
5b5c9bc7 5969 return _core_.DropFilesEvent_GetNumberOfFiles(*args, **kwargs)
d55e5bfc
RD		 5970
5971 def GetFiles(*args, **kwargs):
5ba5649b
RD		 5972 """
5973 GetFiles(self) -> PyObject
5974
5975 Returns a list of the filenames that were dropped.
5976 """
5b5c9bc7 5977 return _core_.DropFilesEvent_GetFiles(*args, **kwargs)
d55e5bfc 5978
2bf58437
RD		 5979 Files = property(GetFiles,doc="See `GetFiles`")
5980 NumberOfFiles = property(GetNumberOfFiles,doc="See `GetNumberOfFiles`")
5981 Position = property(GetPosition,doc="See `GetPosition`")
2131d850 5982_core_.DropFilesEvent_swigregister(DropFilesEvent)
d55e5bfc
RD		 5983
5984#---------------------------------------------------------------------------
5985
5b5c9bc7
RD		 5986UPDATE_UI_PROCESS_ALL = _core_.UPDATE_UI_PROCESS_ALL
5987UPDATE_UI_PROCESS_SPECIFIED = _core_.UPDATE_UI_PROCESS_SPECIFIED
5988class UpdateUIEvent(CommandEvent):
5ba5649b
RD		 5989 """
5990 This class is used for EVT_UPDATE_UI pseudo-events which are sent by
5991 wxWidgets to give an application the chance to update various user
5992 interface elements.
5993
5994 Without update UI events, an application has to work hard to
5995 check/uncheck, enable/disable, and set the text for elements such as
5996 menu items and toolbar buttons. The code for doing this has to be
5997 mixed up with the code that is invoked when an action is invoked for a
5998 menu item or button.
5999
6000 With update UI events, you define an event handler to look at the
6001 state of the application and change UI elements accordingly. wxWidgets
6002 will call your handler functions in idle time, so you don't have to
6003 worry where to call this code. In addition to being a clearer and more
6004 declarative method, it also means you don't have to worry whether
6005 you're updating a toolbar or menubar identifier. The same handler can
6006 update a menu item and toolbar button, if the ID values are the same.
6007
6008 Instead of directly manipulating the menu or button, you call
6009 functions in the event object, such as `Check`. wxWidgets will
6010 determine whether such a call has been made, and which UI element to
6011 update.
6012
6013 These events will work for popup menus as well as menubars. Just
6014 before a menu is popped up, `wx.Menu.UpdateUI` is called to process
6015 any UI events for the window that owns the menu.
6016
6017 If you find that the overhead of UI update processing is affecting
6018 your application, you can do one or both of the following:
6019
6020 1. Call `wx.UpdateUIEvent.SetMode` with a value of
6021 wx.UPDATE_UI_PROCESS_SPECIFIED, and set the extra style
6022 wx.WS_EX_PROCESS_UPDATE_EVENTS for every window that should
6023 receive update events. No other windows will receive update
6024 events.
6025
6026 2. Call `wx.UpdateUIEvent.SetUpdateInterval` with a millisecond
6027 value to set the delay between updates. You may need to call
6028 `wx.Window.UpdateWindowUI` at critical points, for example when
6029 a dialog is about to be shown, in case the user sees a slight
6030 delay before windows are updated.
6031
6032 Note that although events are sent in idle time, defining a EVT_IDLE
6033 handler for a window does not affect this because the events are sent
6034 from an internal idle handler.
6035
6036 wxWidgets tries to optimize update events on some platforms. On
6037 Windows and GTK+, events for menubar items are only sent when the menu
6038 is about to be shown, and not in idle time.
6039
6040 """
1bd55598
RD		 6041 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6042 __repr__ = _swig_repr
6043 def __init__(self, *args, **kwargs):
5ba5649b
RD		 6044 """
6045 __init__(self, int commandId=0) -> UpdateUIEvent
6046
6047 Constructor
6048 """
1bd55598 6049 _core_.UpdateUIEvent_swiginit(self,_core_.new_UpdateUIEvent(*args, **kwargs))
d55e5bfc 6050 def GetChecked(*args, **kwargs):
5ba5649b
RD		 6051 """
6052 GetChecked(self) -> bool
6053
6054 Returns ``True`` if the UI element should be checked.
6055 """
5b5c9bc7 6056 return _core_.UpdateUIEvent_GetChecked(*args, **kwargs)
d55e5bfc
RD		 6057
6058 def GetEnabled(*args, **kwargs):
5ba5649b
RD		 6059 """
6060 GetEnabled(self) -> bool
6061
6062 Returns ``True`` if the UI element should be enabled.
6063 """
5b5c9bc7 6064 return _core_.UpdateUIEvent_GetEnabled(*args, **kwargs)
d55e5bfc 6065
b1fcee84
RD		 6066 def GetShown(*args, **kwargs):
6067 """
6068 GetShown(self) -> bool
6069
6070 Returns ``True`` if the UI element should be shown.
6071 """
6072 return _core_.UpdateUIEvent_GetShown(*args, **kwargs)
6073
d55e5bfc 6074 def GetText(*args, **kwargs):
5ba5649b
RD		 6075 """
6076 GetText(self) -> String
6077
6078 Returns the text that should be set for the UI element.
6079 """
5b5c9bc7 6080 return _core_.UpdateUIEvent_GetText(*args, **kwargs)
d55e5bfc
RD		 6081
6082 def GetSetText(*args, **kwargs):
5ba5649b
RD		 6083 """
6084 GetSetText(self) -> bool
6085
6086 Returns ``True`` if the application has called `SetText`. For
6087 wxWidgets internal use only.
6088 """
5b5c9bc7 6089 return _core_.UpdateUIEvent_GetSetText(*args, **kwargs)
d55e5bfc
RD		 6090
6091 def GetSetChecked(*args, **kwargs):
5ba5649b
RD		 6092 """
6093 GetSetChecked(self) -> bool
6094
6095 Returns ``True`` if the application has called `Check`. For wxWidgets
6096 internal use only.
6097 """
5b5c9bc7 6098 return _core_.UpdateUIEvent_GetSetChecked(*args, **kwargs)
d55e5bfc
RD		 6099
6100 def GetSetEnabled(*args, **kwargs):
5ba5649b
RD		 6101 """
6102 GetSetEnabled(self) -> bool
6103
6104 Returns ``True`` if the application has called `Enable`. For wxWidgets
6105 internal use only.
6106 """
5b5c9bc7 6107 return _core_.UpdateUIEvent_GetSetEnabled(*args, **kwargs)
d55e5bfc 6108
b1fcee84
RD		 6109 def GetSetShown(*args, **kwargs):
6110 """
6111 GetSetShown(self) -> bool
6112
6113 Returns ``True`` if the application has called `Show`. For wxWidgets
6114 internal use only.
6115 """
6116 return _core_.UpdateUIEvent_GetSetShown(*args, **kwargs)
6117
d55e5bfc 6118 def Check(*args, **kwargs):
5ba5649b
RD		 6119 """
6120 Check(self, bool check)
6121
6122 Check or uncheck the UI element.
6123 """
5b5c9bc7 6124 return _core_.UpdateUIEvent_Check(*args, **kwargs)
d55e5bfc
RD		 6125
6126 def Enable(*args, **kwargs):
5ba5649b
RD		 6127 """
6128 Enable(self, bool enable)
6129
6130 Enable or disable the UI element.
6131 """
5b5c9bc7 6132 return _core_.UpdateUIEvent_Enable(*args, **kwargs)
d55e5bfc 6133
b1fcee84
RD		 6134 def Show(*args, **kwargs):
6135 """
6136 Show(self, bool show)
6137
6138 Show or hide the UI element.
6139 """
6140 return _core_.UpdateUIEvent_Show(*args, **kwargs)
6141
d55e5bfc 6142 def SetText(*args, **kwargs):
5ba5649b
RD		 6143 """
6144 SetText(self, String text)
6145
6146 Sets the text for this UI element.
6147 """
5b5c9bc7 6148 return _core_.UpdateUIEvent_SetText(*args, **kwargs)
d55e5bfc
RD		 6149
6150 def SetUpdateInterval(*args, **kwargs):
5ba5649b
RD		 6151 """
6152 SetUpdateInterval(long updateInterval)
6153
6154 Sets the interval between updates in milliseconds. Set to -1 to
6155 disable updates, or to 0 to update as frequently as possible. The
6156 default is 0.
6157
6158 Use this to reduce the overhead of UI update events if your
6159 application has a lot of windows. If you set the value to -1 or
6160 greater than 0, you may also need to call `wx.Window.UpdateWindowUI`
6161 at appropriate points in your application, such as when a dialog is
6162 about to be shown.
6163 """
5b5c9bc7 6164 return _core_.UpdateUIEvent_SetUpdateInterval(*args, **kwargs)
d55e5bfc
RD		 6165
6166 SetUpdateInterval = staticmethod(SetUpdateInterval)
6167 def GetUpdateInterval(*args, **kwargs):
5ba5649b
RD		 6168 """
6169 GetUpdateInterval() -> long
6170
6171 Returns the current interval between updates in milliseconds. -1
6172 disables updates, 0 updates as frequently as possible.
6173 """
5b5c9bc7 6174 return _core_.UpdateUIEvent_GetUpdateInterval(*args, **kwargs)
d55e5bfc
RD		 6175
6176 GetUpdateInterval = staticmethod(GetUpdateInterval)
6177 def CanUpdate(*args, **kwargs):
5ba5649b
RD		 6178 """
6179 CanUpdate(Window win) -> bool
6180
6181 Returns ``True`` if it is appropriate to update (send UI update events
6182 to) this window.
6183
6184 This function looks at the mode used (see `wx.UpdateUIEvent.SetMode`),
6185 the wx.WS_EX_PROCESS_UPDATE_EVENTS flag in window, the time update
6186 events were last sent in idle time, and the update interval, to
6187 determine whether events should be sent to this window now. By default
6188 this will always return true because the update mode is initially
6189 wx.UPDATE_UI_PROCESS_ALL and the interval is set to 0; so update
6190 events will be sent as often as possible. You can reduce the frequency
6191 that events are sent by changing the mode and/or setting an update
6192 interval.
6193
6194 """
5b5c9bc7 6195 return _core_.UpdateUIEvent_CanUpdate(*args, **kwargs)
d55e5bfc
RD		 6196
6197 CanUpdate = staticmethod(CanUpdate)
6198 def ResetUpdateTime(*args, **kwargs):
5ba5649b
RD		 6199 """
6200 ResetUpdateTime()
6201
6202 Used internally to reset the last-updated time to the current time. It
6203 is assumed that update events are normally sent in idle time, so this
6204 is called at the end of idle processing.
6205 """
5b5c9bc7 6206 return _core_.UpdateUIEvent_ResetUpdateTime(*args, **kwargs)
d55e5bfc
RD		 6207
6208 ResetUpdateTime = staticmethod(ResetUpdateTime)
6209 def SetMode(*args, **kwargs):
5ba5649b
RD		 6210 """
6211 SetMode(int mode)
6212
6213 Specify how wxWidgets will send update events: to all windows, or only
6214 to those which specify that they will process the events.
6215
6216 The mode may be one of the following values:
6217
6218 ============================= ==========================================
6219 wxUPDATE_UI_PROCESS_ALL Send UI update events to all windows. This
6220 is the default setting.
6221 wxUPDATE_UI_PROCESS_SPECIFIED Send UI update events only to windows that
6222 have the wx.WS_EX_PROCESS_UI_UPDATES extra
6223 style set.
6224 ============================= ==========================================
6225
6226 """
5b5c9bc7 6227 return _core_.UpdateUIEvent_SetMode(*args, **kwargs)
d55e5bfc
RD		 6228
6229 SetMode = staticmethod(SetMode)
6230 def GetMode(*args, **kwargs):
5ba5649b
RD		 6231 """
6232 GetMode() -> int
6233
6234 Returns a value specifying how wxWidgets will send update events: to
6235 all windows, or only to those which specify that they will process the
6236 events.
6237 """
5b5c9bc7 6238 return _core_.UpdateUIEvent_GetMode(*args, **kwargs)
d55e5bfc
RD		 6239
6240 GetMode = staticmethod(GetMode)
dba7934c
RD		 6241 Checked = property(GetChecked,Check,doc="See `GetChecked`")
6242 Enabled = property(GetEnabled,Enable,doc="See `GetEnabled`")
6243 Shown = property(GetShown,Show,doc="See `GetShown`")
6244 Text = property(GetText,SetText,doc="See `GetText` and `SetText`")
2131d850 6245_core_.UpdateUIEvent_swigregister(UpdateUIEvent)
d55e5bfc 6246
5b5c9bc7 6247def UpdateUIEvent_SetUpdateInterval(*args, **kwargs):
1bd55598 6248 """
5ba5649b
RD		 6249 UpdateUIEvent_SetUpdateInterval(long updateInterval)
6250
6251 Sets the interval between updates in milliseconds. Set to -1 to
6252 disable updates, or to 0 to update as frequently as possible. The
6253 default is 0.
6254
6255 Use this to reduce the overhead of UI update events if your
6256 application has a lot of windows. If you set the value to -1 or
6257 greater than 0, you may also need to call `wx.Window.UpdateWindowUI`
6258 at appropriate points in your application, such as when a dialog is
6259 about to be shown.
6260 """
1bd55598 6261 return _core_.UpdateUIEvent_SetUpdateInterval(*args, **kwargs)
d55e5bfc 6262
1bd55598
RD		 6263def UpdateUIEvent_GetUpdateInterval(*args):
6264 """
5ba5649b
RD		 6265 UpdateUIEvent_GetUpdateInterval() -> long
6266
6267 Returns the current interval between updates in milliseconds. -1
6268 disables updates, 0 updates as frequently as possible.
6269 """
1bd55598 6270 return _core_.UpdateUIEvent_GetUpdateInterval(*args)
d55e5bfc 6271
5b5c9bc7 6272def UpdateUIEvent_CanUpdate(*args, **kwargs):
1bd55598 6273 """
5ba5649b
RD		 6274 UpdateUIEvent_CanUpdate(Window win) -> bool
6275
6276 Returns ``True`` if it is appropriate to update (send UI update events
6277 to) this window.
6278
6279 This function looks at the mode used (see `wx.UpdateUIEvent.SetMode`),
6280 the wx.WS_EX_PROCESS_UPDATE_EVENTS flag in window, the time update
6281 events were last sent in idle time, and the update interval, to
6282 determine whether events should be sent to this window now. By default
6283 this will always return true because the update mode is initially
6284 wx.UPDATE_UI_PROCESS_ALL and the interval is set to 0; so update
6285 events will be sent as often as possible. You can reduce the frequency
6286 that events are sent by changing the mode and/or setting an update
6287 interval.
6288
6289 """
1bd55598 6290 return _core_.UpdateUIEvent_CanUpdate(*args, **kwargs)
d55e5bfc 6291
1bd55598
RD		 6292def UpdateUIEvent_ResetUpdateTime(*args):
6293 """
5ba5649b
RD		 6294 UpdateUIEvent_ResetUpdateTime()
6295
6296 Used internally to reset the last-updated time to the current time. It
6297 is assumed that update events are normally sent in idle time, so this
6298 is called at the end of idle processing.
6299 """
1bd55598 6300 return _core_.UpdateUIEvent_ResetUpdateTime(*args)
d55e5bfc 6301
5b5c9bc7 6302def UpdateUIEvent_SetMode(*args, **kwargs):
1bd55598 6303 """
5ba5649b
RD		 6304 UpdateUIEvent_SetMode(int mode)
6305
6306 Specify how wxWidgets will send update events: to all windows, or only
6307 to those which specify that they will process the events.
6308
6309 The mode may be one of the following values:
6310
6311 ============================= ==========================================
6312 wxUPDATE_UI_PROCESS_ALL Send UI update events to all windows. This
6313 is the default setting.
6314 wxUPDATE_UI_PROCESS_SPECIFIED Send UI update events only to windows that
6315 have the wx.WS_EX_PROCESS_UI_UPDATES extra
6316 style set.
6317 ============================= ==========================================
6318
6319 """
1bd55598 6320 return _core_.UpdateUIEvent_SetMode(*args, **kwargs)
d55e5bfc 6321
1bd55598
RD		 6322def UpdateUIEvent_GetMode(*args):
6323 """
5ba5649b
RD		 6324 UpdateUIEvent_GetMode() -> int
6325
6326 Returns a value specifying how wxWidgets will send update events: to
6327 all windows, or only to those which specify that they will process the
6328 events.
6329 """
1bd55598 6330 return _core_.UpdateUIEvent_GetMode(*args)
d55e5bfc
RD		 6331
6332#---------------------------------------------------------------------------
6333
5b5c9bc7 6334class SysColourChangedEvent(Event):
5ba5649b
RD		 6335 """
6336 This class is used for EVT_SYS_COLOUR_CHANGED, which are generated
6337 when the user changes the colour settings using the control
6338 panel. This is only applicable under Windows.
6339
6340 The default event handler for this event propagates the event to child
6341 windows, since Windows only sends the events to top-level windows. If
6342 intercepting this event for a top-level window, remember to call
6343 `Skip` so the the base class handler will still be executed, or to
6344 pass the event on to the window's children explicitly.
6345
6346 """
1bd55598
RD		 6347 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6348 __repr__ = _swig_repr
6349 def __init__(self, *args, **kwargs):
5ba5649b
RD		 6350 """
6351 __init__(self) -> SysColourChangedEvent
6352
6353 Constructor
6354 """
1bd55598 6355 _core_.SysColourChangedEvent_swiginit(self,_core_.new_SysColourChangedEvent(*args, **kwargs))
2131d850 6356_core_.SysColourChangedEvent_swigregister(SysColourChangedEvent)
d55e5bfc
RD		 6357
6358#---------------------------------------------------------------------------
6359
5b5c9bc7 6360class MouseCaptureChangedEvent(Event):
5ba5649b
RD		 6361 """
6362 An mouse capture changed event (EVT_MOUSE_CAPTURE_CHANGED) is sent to
6363 a window that loses its mouse capture. This is called even if
6364 `wx.Window.ReleaseMouse` was called by the application code. Handling
6365 this event allows an application to cater for unexpected capture
6366 releases which might otherwise confuse mouse handling code.
6367
6368 This event is implemented under Windows only.
6369 """
1bd55598
RD		 6370 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6371 __repr__ = _swig_repr
6372 def __init__(self, *args, **kwargs):
5ba5649b
RD		 6373 """
6374 __init__(self, int winid=0, Window gainedCapture=None) -> MouseCaptureChangedEvent
6375
6376 Constructor
6377 """
1bd55598 6378 _core_.MouseCaptureChangedEvent_swiginit(self,_core_.new_MouseCaptureChangedEvent(*args, **kwargs))
d55e5bfc 6379 def GetCapturedWindow(*args, **kwargs):
5ba5649b
RD		 6380 """
6381 GetCapturedWindow(self) -> Window
6382
6383 Returns the window that gained the capture, or ``None`` if it was a
6384 non-wxWidgets window.
6385 """
5b5c9bc7 6386 return _core_.MouseCaptureChangedEvent_GetCapturedWindow(*args, **kwargs)
d55e5bfc 6387
57332a5a 6388 CapturedWindow = property(GetCapturedWindow,doc="See `GetCapturedWindow`")
2131d850 6389_core_.MouseCaptureChangedEvent_swigregister(MouseCaptureChangedEvent)
d55e5bfc
RD		 6390
6391#---------------------------------------------------------------------------
6392
34e0a3bb
RD		 6393class MouseCaptureLostEvent(Event):
6394 """
6395 A mouse capture lost event is sent to a window that obtained mouse
6396 capture, which was subsequently loss due to "external" event, for
6397 example when a dialog box is shown or if another application captures
6398 the mouse.
6399
6400 If this happens, this event is sent to all windows that are on the
6401 capture stack (i.e. a window that called `wx.Window.CaptureMouse`, but
6402 didn't call `wx.Window.ReleaseMouse` yet). The event is *not* sent
6403 if the capture changes because of a call to CaptureMouse or
6404 ReleaseMouse.
6405
6406 This event is currently emitted under Windows only.
6407
6408 """
6409 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6410 __repr__ = _swig_repr
6411 def __init__(self, *args, **kwargs):
6412 """
6413 __init__(self, int winid=0) -> MouseCaptureLostEvent
6414
6415 A mouse capture lost event is sent to a window that obtained mouse
6416 capture, which was subsequently loss due to "external" event, for
6417 example when a dialog box is shown or if another application captures
6418 the mouse.
6419
6420 If this happens, this event is sent to all windows that are on the
6421 capture stack (i.e. a window that called `wx.Window.CaptureMouse`, but
6422 didn't call `wx.Window.ReleaseMouse` yet). The event is *not* sent
6423 if the capture changes because of a call to CaptureMouse or
6424 ReleaseMouse.
6425
6426 This event is currently emitted under Windows only.
6427
6428 """
6429 _core_.MouseCaptureLostEvent_swiginit(self,_core_.new_MouseCaptureLostEvent(*args, **kwargs))
6430_core_.MouseCaptureLostEvent_swigregister(MouseCaptureLostEvent)
6431
6432#---------------------------------------------------------------------------
6433
5b5c9bc7 6434class DisplayChangedEvent(Event):
5ba5649b
RD		 6435 """
6436 An EVT_DISPLAY_CHANGED event is sent to all windows when the display
6437 resolution has changed.
6438
6439 This event is implemented under Windows only.
6440 """
1bd55598
RD		 6441 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6442 __repr__ = _swig_repr
6443 def __init__(self, *args, **kwargs):
5b5c9bc7 6444 """__init__(self) -> DisplayChangedEvent"""
1bd55598 6445 _core_.DisplayChangedEvent_swiginit(self,_core_.new_DisplayChangedEvent(*args, **kwargs))
2131d850 6446_core_.DisplayChangedEvent_swigregister(DisplayChangedEvent)
d55e5bfc
RD		 6447
6448#---------------------------------------------------------------------------
6449
5b5c9bc7 6450class PaletteChangedEvent(Event):
5ba5649b
RD		 6451 """
6452 An EVT_PALETTE_CHANGED event is sent when the system palette has
6453 changed, thereby giving each window a chance to redo their own to
6454 match.
6455
6456 This event is implemented under Windows only.
6457 """
1bd55598
RD		 6458 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6459 __repr__ = _swig_repr
6460 def __init__(self, *args, **kwargs):
5ba5649b
RD		 6461 """
6462 __init__(self, int id=0) -> PaletteChangedEvent
6463
6464 An EVT_PALETTE_CHANGED event is sent when the system palette has
6465 changed, thereby giving each window a chance to redo their own to
6466 match.
6467
6468 This event is implemented under Windows only.
6469 """
1bd55598 6470 _core_.PaletteChangedEvent_swiginit(self,_core_.new_PaletteChangedEvent(*args, **kwargs))
d55e5bfc 6471 def SetChangedWindow(*args, **kwargs):
5b5c9bc7
RD		 6472 """SetChangedWindow(self, Window win)"""
6473 return _core_.PaletteChangedEvent_SetChangedWindow(*args, **kwargs)
d55e5bfc
RD		 6474
6475 def GetChangedWindow(*args, **kwargs):
5b5c9bc7
RD		 6476 """GetChangedWindow(self) -> Window"""
6477 return _core_.PaletteChangedEvent_GetChangedWindow(*args, **kwargs)
d55e5bfc 6478
33d6fd3b 6479 ChangedWindow = property(GetChangedWindow,SetChangedWindow,doc="See `GetChangedWindow` and `SetChangedWindow`")
2131d850 6480_core_.PaletteChangedEvent_swigregister(PaletteChangedEvent)
d55e5bfc
RD		 6481
6482#---------------------------------------------------------------------------
6483
5b5c9bc7 6484class QueryNewPaletteEvent(Event):
5ba5649b
RD		 6485 """
6486 An EVT_QUERY_NEW_PALETE event indicates the window is getting keyboard
6487 focus and should re-do its palette.
6488
6489 This event is implemented under Windows only.
6490 """
1bd55598
RD		 6491 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6492 __repr__ = _swig_repr
6493 def __init__(self, *args, **kwargs):
5ba5649b
RD		 6494 """
6495 __init__(self, int winid=0) -> QueryNewPaletteEvent
6496
6497 Constructor.
6498 """
1bd55598 6499 _core_.QueryNewPaletteEvent_swiginit(self,_core_.new_QueryNewPaletteEvent(*args, **kwargs))
d55e5bfc 6500 def SetPaletteRealized(*args, **kwargs):
5ba5649b
RD		 6501 """
6502 SetPaletteRealized(self, bool realized)
6503
6504 App should set this if it changes the palette.
6505 """
5b5c9bc7 6506 return _core_.QueryNewPaletteEvent_SetPaletteRealized(*args, **kwargs)
d55e5bfc
RD		 6507
6508 def GetPaletteRealized(*args, **kwargs):
6509 """GetPaletteRealized(self) -> bool"""
5b5c9bc7 6510 return _core_.QueryNewPaletteEvent_GetPaletteRealized(*args, **kwargs)
d55e5bfc 6511
33d6fd3b 6512 PaletteRealized = property(GetPaletteRealized,SetPaletteRealized,doc="See `GetPaletteRealized` and `SetPaletteRealized`")
2131d850 6513_core_.QueryNewPaletteEvent_swigregister(QueryNewPaletteEvent)
d55e5bfc
RD		 6514
6515#---------------------------------------------------------------------------
6516
5b5c9bc7 6517class NavigationKeyEvent(Event):
5ba5649b
RD		 6518 """
6519 EVT_NAVIGATION_KEY events are used to control moving the focus between
6520 widgets, otherwise known as tab-traversal. You woudl normally not
6521 catch navigation events in applications as there are already
6522 appropriate handlers in `wx.Dialog` and `wx.Panel`, but you may find
6523 it useful to send navigation events in certain situations to change
6524 the focus in certain ways, although it's probably easier to just call
6525 `wx.Window.Navigate`.
6526 """
1bd55598
RD		 6527 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6528 __repr__ = _swig_repr
6529 def __init__(self, *args, **kwargs):
5b5c9bc7 6530 """__init__(self) -> NavigationKeyEvent"""
1bd55598 6531 _core_.NavigationKeyEvent_swiginit(self,_core_.new_NavigationKeyEvent(*args, **kwargs))
d55e5bfc 6532 def GetDirection(*args, **kwargs):
5ba5649b
RD		 6533 """
6534 GetDirection(self) -> bool
6535
6536 Returns ``True`` if the direction is forward, ``False`` otherwise.
6537 """
5b5c9bc7 6538 return _core_.NavigationKeyEvent_GetDirection(*args, **kwargs)
d55e5bfc
RD		 6539
6540 def SetDirection(*args, **kwargs):
5ba5649b
RD		 6541 """
6542 SetDirection(self, bool forward)
6543
6544 Specify the direction that the navigation should take. Usually the
6545 difference between using Tab and Shift-Tab.
6546 """
5b5c9bc7 6547 return _core_.NavigationKeyEvent_SetDirection(*args, **kwargs)
d55e5bfc
RD		 6548
6549 def IsWindowChange(*args, **kwargs):
5ba5649b
RD		 6550 """
6551 IsWindowChange(self) -> bool
6552
6553 Returns ``True`` if window change is allowed.
6554 """
5b5c9bc7 6555 return _core_.NavigationKeyEvent_IsWindowChange(*args, **kwargs)
d55e5bfc
RD		 6556
6557 def SetWindowChange(*args, **kwargs):
5ba5649b
RD		 6558 """
6559 SetWindowChange(self, bool ischange)
6560
6561 Specify if the navigation should be able to change parent windows.
6562 For example, changing notebook pages, etc. This is usually implemented
6563 by using Control-Tab.
6564 """
5b5c9bc7 6565 return _core_.NavigationKeyEvent_SetWindowChange(*args, **kwargs)
d55e5bfc 6566
68350608 6567 def IsFromTab(*args, **kwargs):
5ba5649b
RD		 6568 """
6569 IsFromTab(self) -> bool
6570
6571 Returns ``True`` if the navigation event is originated from the Tab
6572 key.
6573 """
5b5c9bc7 6574 return _core_.NavigationKeyEvent_IsFromTab(*args, **kwargs)
68350608
RD		 6575
6576 def SetFromTab(*args, **kwargs):
5ba5649b
RD		 6577 """
6578 SetFromTab(self, bool bIs)
6579
6580 Set to true under MSW if the event was generated using the tab key.
6581 This is required for proper navogation over radio buttons.
6582 """
5b5c9bc7 6583 return _core_.NavigationKeyEvent_SetFromTab(*args, **kwargs)
68350608 6584
908b74cd 6585 def SetFlags(*args, **kwargs):
5ba5649b
RD		 6586 """
6587 SetFlags(self, long flags)
6588
6589 Set the navigation flags to a combination of the following:
6590
6591 * wx.NavigationKeyEvent.IsBackward
6592 * wx.NavigationKeyEvent.IsForward
6593 * wx.NavigationKeyEvent.WinChange
6594 * wx.NavigationKeyEvent.FromTab
6595
6596 """
5b5c9bc7 6597 return _core_.NavigationKeyEvent_SetFlags(*args, **kwargs)
908b74cd 6598
d55e5bfc 6599 def GetCurrentFocus(*args, **kwargs):
5ba5649b
RD		 6600 """
6601 GetCurrentFocus(self) -> Window
6602
6603 Returns the child window which currenty has the focus. May be
6604 ``None``.
6605 """
5b5c9bc7 6606 return _core_.NavigationKeyEvent_GetCurrentFocus(*args, **kwargs)
d55e5bfc
RD		 6607
6608 def SetCurrentFocus(*args, **kwargs):
5ba5649b
RD		 6609 """
6610 SetCurrentFocus(self, Window win)
6611
6612 Set the window that has the focus.
6613 """
5b5c9bc7 6614 return _core_.NavigationKeyEvent_SetCurrentFocus(*args, **kwargs)
d55e5bfc 6615
5b5c9bc7
RD		 6616 IsBackward = _core_.NavigationKeyEvent_IsBackward
6617 IsForward = _core_.NavigationKeyEvent_IsForward
6618 WinChange = _core_.NavigationKeyEvent_WinChange
6619 FromTab = _core_.NavigationKeyEvent_FromTab
57332a5a
RD		 6620 CurrentFocus = property(GetCurrentFocus,SetCurrentFocus,doc="See `GetCurrentFocus` and `SetCurrentFocus`")
6621 Direction = property(GetDirection,SetDirection,doc="See `GetDirection` and `SetDirection`")
2131d850 6622_core_.NavigationKeyEvent_swigregister(NavigationKeyEvent)
d55e5bfc
RD		 6623
6624#---------------------------------------------------------------------------
6625
5b5c9bc7 6626class WindowCreateEvent(CommandEvent):
5ba5649b
RD		 6627 """
6628 The EVT_WINDOW_CREATE event is sent as soon as the window object (the
6629 underlying GUI object) exists.
6630 """
1bd55598
RD		 6631 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6632 __repr__ = _swig_repr
6633 def __init__(self, *args, **kwargs):
5ba5649b
RD		 6634 """
6635 __init__(self, Window win=None) -> WindowCreateEvent
6636
6637 The EVT_WINDOW_CREATE event is sent as soon as the window object (the
6638 underlying GUI object) exists.
6639 """
1bd55598 6640 _core_.WindowCreateEvent_swiginit(self,_core_.new_WindowCreateEvent(*args, **kwargs))
d55e5bfc 6641 def GetWindow(*args, **kwargs):
5ba5649b
RD		 6642 """
6643 GetWindow(self) -> Window
6644
6645 Returns the window that this event refers to.
6646 """
5b5c9bc7 6647 return _core_.WindowCreateEvent_GetWindow(*args, **kwargs)
d55e5bfc 6648
dba7934c 6649 Window = property(GetWindow,doc="See `GetWindow`")
2131d850 6650_core_.WindowCreateEvent_swigregister(WindowCreateEvent)
d55e5bfc 6651
5b5c9bc7 6652class WindowDestroyEvent(CommandEvent):
5ba5649b 6653 """
943e8dfd
RD		 6654 The EVT_WINDOW_DESTROY event is sent from the `wx.Window` destructor
6655 when the GUI window is destroyed.
6656
6657 When a class derived from `wx.Window` is destroyed its destructor will
6658 have already run by the time this event is sent. Therefore this event
6659 will not usually be received at all by the window itself. Since it is
6660 received after the destructor has run, an object should not try to
6661 handle its own wx.WindowDestroyEvent, but it can be used to get
6662 notification of the destruction of another window.
5ba5649b 6663 """
1bd55598
RD		 6664 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6665 __repr__ = _swig_repr
6666 def __init__(self, *args, **kwargs):
5ba5649b
RD		 6667 """
6668 __init__(self, Window win=None) -> WindowDestroyEvent
6669
943e8dfd
RD		 6670 The EVT_WINDOW_DESTROY event is sent from the `wx.Window` destructor
6671 when the GUI window is destroyed.
6672
6673 When a class derived from `wx.Window` is destroyed its destructor will
6674 have already run by the time this event is sent. Therefore this event
6675 will not usually be received at all by the window itself. Since it is
6676 received after the destructor has run, an object should not try to
6677 handle its own wx.WindowDestroyEvent, but it can be used to get
6678 notification of the destruction of another window.
5ba5649b 6679 """
1bd55598 6680 _core_.WindowDestroyEvent_swiginit(self,_core_.new_WindowDestroyEvent(*args, **kwargs))
d55e5bfc 6681 def GetWindow(*args, **kwargs):
5ba5649b
RD		 6682 """
6683 GetWindow(self) -> Window
6684
6685 Returns the window that this event refers to.
6686 """
5b5c9bc7 6687 return _core_.WindowDestroyEvent_GetWindow(*args, **kwargs)
d55e5bfc 6688
dba7934c 6689 Window = property(GetWindow,doc="See `GetWindow`")
2131d850 6690_core_.WindowDestroyEvent_swigregister(WindowDestroyEvent)
d55e5bfc
RD		 6691
6692#---------------------------------------------------------------------------
6693
5b5c9bc7 6694class ContextMenuEvent(CommandEvent):
5ba5649b
RD		 6695 """
6696 This class is used for context menu events (EVT_CONTECT_MENU,) sent to
6697 give the application a chance to show a context (popup) menu.
6698 """
1bd55598
RD		 6699 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6700 __repr__ = _swig_repr
6701 def __init__(self, *args, **kwargs):
5ba5649b 6702 """
2131d850 6703 __init__(self, EventType type=wxEVT_NULL, int winid=0, Point pt=DefaultPosition) -> ContextMenuEvent
5ba5649b
RD		 6704
6705 Constructor.
6706 """
1bd55598 6707 _core_.ContextMenuEvent_swiginit(self,_core_.new_ContextMenuEvent(*args, **kwargs))
d55e5bfc 6708 def GetPosition(*args, **kwargs):
5ba5649b
RD		 6709 """
6710 GetPosition(self) -> Point
6711
6712 Returns the position (in screen coordinants) at which the menu should
6713 be shown.
6714 """
5b5c9bc7 6715 return _core_.ContextMenuEvent_GetPosition(*args, **kwargs)
d55e5bfc
RD		 6716
6717 def SetPosition(*args, **kwargs):
5ba5649b
RD		 6718 """
6719 SetPosition(self, Point pos)
6720
6721 Sets the position at which the menu should be shown.
6722 """
5b5c9bc7 6723 return _core_.ContextMenuEvent_SetPosition(*args, **kwargs)
d55e5bfc 6724
2bf58437 6725 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
2131d850 6726_core_.ContextMenuEvent_swigregister(ContextMenuEvent)
d55e5bfc
RD		 6727
6728#---------------------------------------------------------------------------
6729
5b5c9bc7
RD		 6730IDLE_PROCESS_ALL = _core_.IDLE_PROCESS_ALL
6731IDLE_PROCESS_SPECIFIED = _core_.IDLE_PROCESS_SPECIFIED
6732class IdleEvent(Event):
5ba5649b
RD		 6733 """
6734 This class is used for EVT_IDLE events, which are generated and sent
6735 when the application *becomes* idle. In other words, the when the
6736 event queue becomes empty then idle events are sent to all windows (by
6737 default) and as long as none of them call `RequestMore` then there are
6738 no more idle events until after the system event queue has some normal
6739 events and then becomes empty again.
6740
6741 By default, idle events are sent to all windows. If this is causing a
6742 significant overhead in your application, you can call
6743 `wx.IdleEvent.SetMode` with the value wx.IDLE_PROCESS_SPECIFIED, and
6744 set the wx.WS_EX_PROCESS_IDLE extra window style for every window
6745 which should receive idle events. Then idle events will only be sent
6746 to those windows and not to any others.
6747 """
1bd55598
RD		 6748 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6749 __repr__ = _swig_repr
6750 def __init__(self, *args, **kwargs):
5ba5649b
RD		 6751 """
6752 __init__(self) -> IdleEvent
6753
6754 Constructor
6755 """
1bd55598 6756 _core_.IdleEvent_swiginit(self,_core_.new_IdleEvent(*args, **kwargs))
d55e5bfc 6757 def RequestMore(*args, **kwargs):
5ba5649b
RD		 6758 """
6759 RequestMore(self, bool needMore=True)
6760
6761 Tells wxWidgets that more processing is required. This function can be
6762 called by an EVT_IDLE handler for a window to indicate that the
6763 application should forward the EVT_IDLE event once more to the
6764 application windows. If no window calls this function during its
6765 EVT_IDLE handler, then the application will remain in a passive event
6766 loop until a new event is posted to the application by the windowing
6767 system.
6768 """
5b5c9bc7 6769 return _core_.IdleEvent_RequestMore(*args, **kwargs)
d55e5bfc
RD		 6770
6771 def MoreRequested(*args, **kwargs):
5ba5649b
RD		 6772 """
6773 MoreRequested(self) -> bool
6774
6775 Returns ``True`` if the OnIdle function processing this event
6776 requested more processing time.
6777 """
5b5c9bc7 6778 return _core_.IdleEvent_MoreRequested(*args, **kwargs)
d55e5bfc
RD		 6779
6780 def SetMode(*args, **kwargs):
5ba5649b
RD		 6781 """
6782 SetMode(int mode)
6783
6784 Static method for specifying how wxWidgets will send idle events: to
6785 all windows, or only to those which specify that they will process the
6786 events.
6787
6788 The mode can be one of the following values:
6789
6790 ========================= ========================================
6791 wx.IDLE_PROCESS_ALL Send idle events to all windows
6792 wx.IDLE_PROCESS_SPECIFIED Send idle events only to windows that have
6793 the wx.WS_EX_PROCESS_IDLE extra style
6794 flag set.
6795 ========================= ========================================
6796
6797 """
5b5c9bc7 6798 return _core_.IdleEvent_SetMode(*args, **kwargs)
d55e5bfc
RD		 6799
6800 SetMode = staticmethod(SetMode)
6801 def GetMode(*args, **kwargs):
5ba5649b
RD		 6802 """
6803 GetMode() -> int
6804
6805 Static method returning a value specifying how wxWidgets will send
6806 idle events: to all windows, or only to those which specify that they
6807 will process the events.
6808 """
5b5c9bc7 6809 return _core_.IdleEvent_GetMode(*args, **kwargs)
d55e5bfc
RD		 6810
6811 GetMode = staticmethod(GetMode)
6812 def CanSend(*args, **kwargs):
5ba5649b
RD		 6813 """
6814 CanSend(Window win) -> bool
6815
6816 Returns ``True`` if it is appropriate to send idle events to this
6817 window.
6818
6819 This function looks at the mode used (see `wx.IdleEvent.SetMode`), and
6820 the wx.WS_EX_PROCESS_IDLE style in window to determine whether idle
6821 events should be sent to this window now. By default this will always
6822 return ``True`` because the update mode is initially
6823 wx.IDLE_PROCESS_ALL. You can change the mode to only send idle events
6824 to windows with the wx.WS_EX_PROCESS_IDLE extra window style set.
6825 """
5b5c9bc7 6826 return _core_.IdleEvent_CanSend(*args, **kwargs)
d55e5bfc
RD		 6827
6828 CanSend = staticmethod(CanSend)
2131d850 6829_core_.IdleEvent_swigregister(IdleEvent)
d55e5bfc 6830
5b5c9bc7 6831def IdleEvent_SetMode(*args, **kwargs):
1bd55598 6832 """
5ba5649b
RD		 6833 IdleEvent_SetMode(int mode)
6834
6835 Static method for specifying how wxWidgets will send idle events: to
6836 all windows, or only to those which specify that they will process the
6837 events.
6838
6839 The mode can be one of the following values:
6840
6841 ========================= ========================================
6842 wx.IDLE_PROCESS_ALL Send idle events to all windows
6843 wx.IDLE_PROCESS_SPECIFIED Send idle events only to windows that have
6844 the wx.WS_EX_PROCESS_IDLE extra style
6845 flag set.
6846 ========================= ========================================
6847
6848 """
1bd55598 6849 return _core_.IdleEvent_SetMode(*args, **kwargs)
d55e5bfc 6850
1bd55598
RD		 6851def IdleEvent_GetMode(*args):
6852 """
5ba5649b
RD		 6853 IdleEvent_GetMode() -> int
6854
6855 Static method returning a value specifying how wxWidgets will send
6856 idle events: to all windows, or only to those which specify that they
6857 will process the events.
6858 """
1bd55598 6859 return _core_.IdleEvent_GetMode(*args)
d55e5bfc 6860
5b5c9bc7 6861def IdleEvent_CanSend(*args, **kwargs):
1bd55598 6862 """
5ba5649b
RD		 6863 IdleEvent_CanSend(Window win) -> bool
6864
6865 Returns ``True`` if it is appropriate to send idle events to this
6866 window.
6867
6868 This function looks at the mode used (see `wx.IdleEvent.SetMode`), and
6869 the wx.WS_EX_PROCESS_IDLE style in window to determine whether idle
6870 events should be sent to this window now. By default this will always
6871 return ``True`` because the update mode is initially
6872 wx.IDLE_PROCESS_ALL. You can change the mode to only send idle events
6873 to windows with the wx.WS_EX_PROCESS_IDLE extra window style set.
6874 """
1bd55598 6875 return _core_.IdleEvent_CanSend(*args, **kwargs)
d55e5bfc
RD		 6876
6877#---------------------------------------------------------------------------
6878
2131d850
RD		 6879class ClipboardTextEvent(CommandEvent):
6880 """
6881 A Clipboard Text event is sent when a window intercepts a text
6882 copy/cut/paste message, i.e. the user has cut/copied/pasted data
6883 from/into a text control via ctrl-C/X/V, ctrl/shift-del/insert, a
6884 popup menu command, etc. NOTE : under windows these events are *NOT*
6885 generated automatically for a Rich Edit text control.
6886 """
6887 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6888 __repr__ = _swig_repr
6889 def __init__(self, *args, **kwargs):
6890 """
6891 __init__(self, EventType type=wxEVT_NULL, int winid=0) -> ClipboardTextEvent
6892
6893 A Clipboard Text event is sent when a window intercepts a text
6894 copy/cut/paste message, i.e. the user has cut/copied/pasted data
6895 from/into a text control via ctrl-C/X/V, ctrl/shift-del/insert, a
6896 popup menu command, etc. NOTE : under windows these events are *NOT*
6897 generated automatically for a Rich Edit text control.
6898 """
6899 _core_.ClipboardTextEvent_swiginit(self,_core_.new_ClipboardTextEvent(*args, **kwargs))
6900_core_.ClipboardTextEvent_swigregister(ClipboardTextEvent)
6901
6902#---------------------------------------------------------------------------
6903
5b5c9bc7 6904class PyEvent(Event):
5ba5649b
RD		 6905 """
6906 wx.PyEvent can be used as a base class for implementing custom event
6907 types in Python. You should derived from this class instead of
6908 `wx.Event` because this class is Python-aware and is able to transport
6909 its Python bits safely through the wxWidgets event system and have
6910 them still be there when the event handler is invoked.
6911
6912 :see: `wx.PyCommandEvent`
6913
6914 """
1bd55598
RD		 6915 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6916 __repr__ = _swig_repr
6917 def __init__(self, *args, **kwargs):
2131d850 6918 """__init__(self, int winid=0, EventType eventType=wxEVT_NULL) -> PyEvent"""
1bd55598 6919 _core_.PyEvent_swiginit(self,_core_.new_PyEvent(*args, **kwargs))
5ba5649b 6920 self._SetSelf(self)
d55e5bfc 6921
1bd55598
RD		 6922 __swig_destroy__ = _core_.delete_PyEvent
6923 __del__ = lambda self : None;
5ba5649b
RD		 6924 def _SetSelf(*args, **kwargs):
6925 """_SetSelf(self, PyObject self)"""
6926 return _core_.PyEvent__SetSelf(*args, **kwargs)
d55e5bfc 6927
5ba5649b
RD		 6928 def _GetSelf(*args, **kwargs):
6929 """_GetSelf(self) -> PyObject"""
6930 return _core_.PyEvent__GetSelf(*args, **kwargs)
d55e5bfc 6931
2131d850 6932_core_.PyEvent_swigregister(PyEvent)
d55e5bfc 6933
5b5c9bc7 6934class PyCommandEvent(CommandEvent):
5ba5649b
RD		 6935 """
6936 wx.PyCommandEvent can be used as a base class for implementing custom
6937 event types in Python, where the event shoudl travel up to parent
6938 windows looking for a handler. You should derived from this class
6939 instead of `wx.CommandEvent` because this class is Python-aware and is
6940 able to transport its Python bits safely through the wxWidgets event
6941 system and have them still be there when the event handler is invoked.
6942
6943 :see: `wx.PyEvent`
6944
6945 """
1bd55598
RD		 6946 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6947 __repr__ = _swig_repr
6948 def __init__(self, *args, **kwargs):
2131d850 6949 """__init__(self, EventType eventType=wxEVT_NULL, int id=0) -> PyCommandEvent"""
1bd55598 6950 _core_.PyCommandEvent_swiginit(self,_core_.new_PyCommandEvent(*args, **kwargs))
5ba5649b 6951 self._SetSelf(self)
d55e5bfc 6952
1bd55598
RD		 6953 __swig_destroy__ = _core_.delete_PyCommandEvent
6954 __del__ = lambda self : None;
5ba5649b
RD		 6955 def _SetSelf(*args, **kwargs):
6956 """_SetSelf(self, PyObject self)"""
6957 return _core_.PyCommandEvent__SetSelf(*args, **kwargs)
d55e5bfc 6958
5ba5649b
RD		 6959 def _GetSelf(*args, **kwargs):
6960 """_GetSelf(self) -> PyObject"""
6961 return _core_.PyCommandEvent__GetSelf(*args, **kwargs)
d55e5bfc 6962
2131d850 6963_core_.PyCommandEvent_swigregister(PyCommandEvent)
d55e5bfc 6964
5b5c9bc7 6965class DateEvent(CommandEvent):
5ba5649b
RD		 6966 """
6967 This event class holds information about a date change event and is
6968 used together with `wx.DatePickerCtrl`. It also serves as a base class
6969 for `wx.calendar.CalendarEvent`. Bind these event types with
6970 EVT_DATE_CHANGED.
6971 """
1bd55598
RD		 6972 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6973 __repr__ = _swig_repr
6974 def __init__(self, *args, **kwargs):
2131d850 6975 """__init__(self, Window win, DateTime dt, EventType type) -> DateEvent"""
1bd55598 6976 _core_.DateEvent_swiginit(self,_core_.new_DateEvent(*args, **kwargs))
53aa7709 6977 def GetDate(*args, **kwargs):
5ba5649b
RD		 6978 """
6979 GetDate(self) -> DateTime
6980
6981 Returns the date.
6982 """
5b5c9bc7 6983 return _core_.DateEvent_GetDate(*args, **kwargs)
53aa7709
RD		 6984
6985 def SetDate(*args, **kwargs):
5ba5649b
RD		 6986 """
6987 SetDate(self, DateTime date)
6988
6989 Sets the date carried by the event, normally only used by the library
6990 internally.
6991 """
5b5c9bc7 6992 return _core_.DateEvent_SetDate(*args, **kwargs)
53aa7709 6993
2bf58437 6994 Date = property(GetDate,SetDate,doc="See `GetDate` and `SetDate`")
2131d850 6995_core_.DateEvent_swigregister(DateEvent)
53aa7709 6996
5b5c9bc7 6997wxEVT_DATE_CHANGED = _core_.wxEVT_DATE_CHANGED
53aa7709
RD		 6998EVT_DATE_CHANGED = wx.PyEventBinder( wxEVT_DATE_CHANGED, 1 )
6999
d55e5bfc
RD		 7000#---------------------------------------------------------------------------
7001
5b5c9bc7
RD		 7002PYAPP_ASSERT_SUPPRESS = _core_.PYAPP_ASSERT_SUPPRESS
7003PYAPP_ASSERT_EXCEPTION = _core_.PYAPP_ASSERT_EXCEPTION
7004PYAPP_ASSERT_DIALOG = _core_.PYAPP_ASSERT_DIALOG
7005PYAPP_ASSERT_LOG = _core_.PYAPP_ASSERT_LOG
7006PRINT_WINDOWS = _core_.PRINT_WINDOWS
7007PRINT_POSTSCRIPT = _core_.PRINT_POSTSCRIPT
7008class PyApp(EvtHandler):
d6c14a4c
RD		 7009 """
7010 The ``wx.PyApp`` class is an *implementation detail*, please use the
7011 `wx.App` class (or some other derived class) instead.
7012 """
1bd55598
RD		 7013 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7014 __repr__ = _swig_repr
7015 def __init__(self, *args, **kwargs):
d55e5bfc 7016 """
5b5c9bc7 7017 __init__(self) -> PyApp
d55e5bfc
RD		 7018
7019 Create a new application object, starting the bootstrap process.
7020 """
1bd55598 7021 _core_.PyApp_swiginit(self,_core_.new_PyApp(*args, **kwargs))
7993762b
RD		 7022 self._setCallbackInfo(self, PyApp, False)
7023 self._setOORInfo(self, False)
d55e5bfc 7024
1bd55598
RD		 7025 __swig_destroy__ = _core_.delete_PyApp
7026 __del__ = lambda self : None;
d55e5bfc 7027 def _setCallbackInfo(*args, **kwargs):
7993762b 7028 """_setCallbackInfo(self, PyObject self, PyObject _class, bool incref)"""
5b5c9bc7 7029 return _core_.PyApp__setCallbackInfo(*args, **kwargs)
d55e5bfc
RD		 7030
7031 def GetAppName(*args, **kwargs):
7032 """
5b5c9bc7 7033 GetAppName(self) -> String
d55e5bfc
RD		 7034
7035 Get the application name.
7036 """
5b5c9bc7 7037 return _core_.PyApp_GetAppName(*args, **kwargs)
d55e5bfc
RD		 7038
7039 def SetAppName(*args, **kwargs):
7040 """
5b5c9bc7 7041 SetAppName(self, String name)
d55e5bfc 7042
d6c14a4c
RD		 7043 Set the application name. This value may be used automatically by
7044 `wx.Config` and such.
d55e5bfc 7045 """
5b5c9bc7 7046 return _core_.PyApp_SetAppName(*args, **kwargs)
d55e5bfc
RD		 7047
7048 def GetClassName(*args, **kwargs):
7049 """
5b5c9bc7 7050 GetClassName(self) -> String
d55e5bfc
RD		 7051
7052 Get the application's class name.
7053 """
5b5c9bc7 7054 return _core_.PyApp_GetClassName(*args, **kwargs)
d55e5bfc
RD		 7055
7056 def SetClassName(*args, **kwargs):
7057 """
5b5c9bc7 7058 SetClassName(self, String name)
d55e5bfc 7059
d6c14a4c
RD		 7060 Set the application's class name. This value may be used for
7061 X-resources if applicable for the platform
d55e5bfc 7062 """
5b5c9bc7 7063 return _core_.PyApp_SetClassName(*args, **kwargs)
d55e5bfc
RD		 7064
7065 def GetVendorName(*args, **kwargs):
7066 """
5b5c9bc7 7067 GetVendorName(self) -> String
d55e5bfc
RD		 7068
7069 Get the application's vendor name.
7070 """
5b5c9bc7 7071 return _core_.PyApp_GetVendorName(*args, **kwargs)
d55e5bfc
RD		 7072
7073 def SetVendorName(*args, **kwargs):
7074 """
5b5c9bc7 7075 SetVendorName(self, String name)
d55e5bfc 7076
d6c14a4c
RD		 7077 Set the application's vendor name. This value may be used
7078 automatically by `wx.Config` and such.
d55e5bfc 7079 """
5b5c9bc7 7080 return _core_.PyApp_SetVendorName(*args, **kwargs)
d55e5bfc
RD		 7081
7082 def GetTraits(*args, **kwargs):
7083 """
7084 GetTraits(self) -> wxAppTraits
7085
d6c14a4c
RD		 7086 Return (and create if necessary) the app traits object to which we
7087 delegate for everything which either should be configurable by the
7088 user (then he can change the default behaviour simply by overriding
7089 CreateTraits() and returning his own traits object) or which is
7090 GUI/console dependent as then wx.AppTraits allows us to abstract the
7091 differences behind the common facade.
7092
7093 :todo: Add support for overriding CreateAppTraits in wxPython.
d55e5bfc 7094 """
5b5c9bc7 7095 return _core_.PyApp_GetTraits(*args, **kwargs)
d55e5bfc
RD		 7096
7097 def ProcessPendingEvents(*args, **kwargs):
7098 """
7099 ProcessPendingEvents(self)
7100
d6c14a4c
RD		 7101 Process all events in the Pending Events list -- it is necessary to
7102 call this function to process posted events. This normally happens
7103 during each event loop iteration.
d55e5bfc 7104 """
5b5c9bc7 7105 return _core_.PyApp_ProcessPendingEvents(*args, **kwargs)
d55e5bfc
RD		 7106
7107 def Yield(*args, **kwargs):
7108 """
7109 Yield(self, bool onlyIfNeeded=False) -> bool
7110
d6c14a4c
RD		 7111 Process all currently pending events right now, instead of waiting
7112 until return to the event loop. It is an error to call ``Yield``
7113 recursively unless the value of ``onlyIfNeeded`` is True.
d55e5bfc 7114
d6c14a4c 7115 :warning: This function is dangerous as it can lead to unexpected
15817c7e
RD		 7116 reentrancies (i.e. when called from an event handler it may
7117 result in calling the same event handler again), use with
7118 extreme care or, better, don't use at all!
d55e5bfc 7119
d6c14a4c 7120 :see: `wx.Yield`, `wx.YieldIfNeeded`, `wx.SafeYield`
15817c7e 7121
d55e5bfc 7122 """
5b5c9bc7 7123 return _core_.PyApp_Yield(*args, **kwargs)
d55e5bfc
RD		 7124
7125 def WakeUpIdle(*args, **kwargs):
7126 """
7127 WakeUpIdle(self)
7128
d6c14a4c
RD		 7129 Make sure that idle events are sent again.
7130 :see: `wx.WakeUpIdle`
d55e5bfc 7131 """
5b5c9bc7 7132 return _core_.PyApp_WakeUpIdle(*args, **kwargs)
d55e5bfc 7133
84f85550
RD		 7134 def IsMainLoopRunning(*args, **kwargs):
7135 """
7136 IsMainLoopRunning() -> bool
7137
7138 Returns True if we're running the main loop, i.e. if the events can
7139 currently be dispatched.
7140 """
5b5c9bc7 7141 return _core_.PyApp_IsMainLoopRunning(*args, **kwargs)
84f85550
RD		 7142
7143 IsMainLoopRunning = staticmethod(IsMainLoopRunning)
d55e5bfc
RD		 7144 def MainLoop(*args, **kwargs):
7145 """
7146 MainLoop(self) -> int
7147
d6c14a4c
RD		 7148 Execute the main GUI loop, the function doesn't normally return until
7149 all top level windows have been closed and destroyed.
d55e5bfc 7150 """
5b5c9bc7 7151 return _core_.PyApp_MainLoop(*args, **kwargs)
d55e5bfc
RD		 7152
7153 def Exit(*args, **kwargs):
7154 """
7155 Exit(self)
7156
7157 Exit the main loop thus terminating the application.
d6c14a4c 7158 :see: `wx.Exit`
d55e5bfc 7159 """
5b5c9bc7 7160 return _core_.PyApp_Exit(*args, **kwargs)
d55e5bfc 7161
ac5d357a
RD		 7162 def GetLayoutDirection(*args, **kwargs):
7163 """
994453b8 7164 GetLayoutDirection(self) -> int
ac5d357a
RD		 7165
7166 Return the layout direction for the current locale.
7167 """
7168 return _core_.PyApp_GetLayoutDirection(*args, **kwargs)
7169
d55e5bfc
RD		 7170 def ExitMainLoop(*args, **kwargs):
7171 """
7172 ExitMainLoop(self)
7173
d6c14a4c
RD		 7174 Exit the main GUI loop during the next iteration of the main
7175 loop, (i.e. it does not stop the program immediately!)
d55e5bfc 7176 """
5b5c9bc7 7177 return _core_.PyApp_ExitMainLoop(*args, **kwargs)
d55e5bfc
RD		 7178
7179 def Pending(*args, **kwargs):
7180 """
7181 Pending(self) -> bool
7182
7183 Returns True if there are unprocessed events in the event queue.
7184 """
5b5c9bc7 7185 return _core_.PyApp_Pending(*args, **kwargs)
d55e5bfc
RD		 7186
7187 def Dispatch(*args, **kwargs):
7188 """
7189 Dispatch(self) -> bool
7190
7191 Process the first event in the event queue (blocks until an event
7192 appears if there are none currently)
7193 """
5b5c9bc7 7194 return _core_.PyApp_Dispatch(*args, **kwargs)
d55e5bfc
RD		 7195
7196 def ProcessIdle(*args, **kwargs):
7197 """
7198 ProcessIdle(self) -> bool
7199
d6c14a4c
RD		 7200 Called from the MainLoop when the application becomes idle (there are
7201 no pending events) and sends a `wx.IdleEvent` to all interested
7202 parties. Returns True if more idle events are needed, False if not.
d55e5bfc 7203 """
5b5c9bc7 7204 return _core_.PyApp_ProcessIdle(*args, **kwargs)
d55e5bfc
RD		 7205
7206 def SendIdleEvents(*args, **kwargs):
7207 """
5b5c9bc7 7208 SendIdleEvents(self, Window win, IdleEvent event) -> bool
d55e5bfc 7209
d6c14a4c
RD		 7210 Send idle event to window and all subwindows. Returns True if more
7211 idle time is requested.
d55e5bfc 7212 """
5b5c9bc7 7213 return _core_.PyApp_SendIdleEvents(*args, **kwargs)
d55e5bfc
RD		 7214
7215 def IsActive(*args, **kwargs):
7216 """
7217 IsActive(self) -> bool
7218
7219 Return True if our app has focus.
7220 """
5b5c9bc7 7221 return _core_.PyApp_IsActive(*args, **kwargs)
d55e5bfc
RD		 7222
7223 def SetTopWindow(*args, **kwargs):
7224 """
5b5c9bc7 7225 SetTopWindow(self, Window win)
d55e5bfc 7226
d6c14a4c 7227 Set the *main* top level window
d55e5bfc 7228 """
5b5c9bc7 7229 return _core_.PyApp_SetTopWindow(*args, **kwargs)
d55e5bfc
RD		 7230
7231 def GetTopWindow(*args, **kwargs):
7232 """
5b5c9bc7 7233 GetTopWindow(self) -> Window
d55e5bfc 7234
d6c14a4c
RD		 7235 Return the *main* top level window (if it hadn't been set previously
7236 with SetTopWindow(), will return just some top level window and, if
7237 there not any, will return None)
d55e5bfc 7238 """
5b5c9bc7 7239 return _core_.PyApp_GetTopWindow(*args, **kwargs)
d55e5bfc
RD		 7240
7241 def SetExitOnFrameDelete(*args, **kwargs):
7242 """
7243 SetExitOnFrameDelete(self, bool flag)
7244
d6c14a4c
RD		 7245 Control the exit behaviour: by default, the program will exit the main
7246 loop (and so, usually, terminate) when the last top-level program
7247 window is deleted. Beware that if you disable this behaviour (with
7248 SetExitOnFrameDelete(False)), you'll have to call ExitMainLoop()
7249 explicitly from somewhere.
d55e5bfc 7250 """
5b5c9bc7 7251 return _core_.PyApp_SetExitOnFrameDelete(*args, **kwargs)
d55e5bfc
RD		 7252
7253 def GetExitOnFrameDelete(*args, **kwargs):
7254 """
7255 GetExitOnFrameDelete(self) -> bool
7256
7257 Get the current exit behaviour setting.
7258 """
5b5c9bc7 7259 return _core_.PyApp_GetExitOnFrameDelete(*args, **kwargs)
d55e5bfc
RD		 7260
7261 def SetUseBestVisual(*args, **kwargs):
7262 """
7263 SetUseBestVisual(self, bool flag)
7264
d6c14a4c
RD		 7265 Set whether the app should try to use the best available visual on
7266 systems where more than one is available, (Sun, SGI, XFree86 4, etc.)
d55e5bfc 7267 """
5b5c9bc7 7268 return _core_.PyApp_SetUseBestVisual(*args, **kwargs)
d55e5bfc
RD		 7269
7270 def GetUseBestVisual(*args, **kwargs):
7271 """
7272 GetUseBestVisual(self) -> bool
7273
7274 Get current UseBestVisual setting.
7275 """
5b5c9bc7 7276 return _core_.PyApp_GetUseBestVisual(*args, **kwargs)
d55e5bfc
RD		 7277
7278 def SetPrintMode(*args, **kwargs):
7279 """SetPrintMode(self, int mode)"""
5b5c9bc7 7280 return _core_.PyApp_SetPrintMode(*args, **kwargs)
d55e5bfc
RD		 7281
7282 def GetPrintMode(*args, **kwargs):
7283 """GetPrintMode(self) -> int"""
5b5c9bc7 7284 return _core_.PyApp_GetPrintMode(*args, **kwargs)
d55e5bfc
RD		 7285
7286 def SetAssertMode(*args, **kwargs):
7287 """
7288 SetAssertMode(self, int mode)
7289
15817c7e 7290 Set the OnAssert behaviour for debug and hybrid builds.
d55e5bfc 7291 """
5b5c9bc7 7292 return _core_.PyApp_SetAssertMode(*args, **kwargs)
d55e5bfc
RD		 7293
7294 def GetAssertMode(*args, **kwargs):
7295 """
7296 GetAssertMode(self) -> int
7297
7298 Get the current OnAssert behaviour setting.
7299 """
5b5c9bc7 7300 return _core_.PyApp_GetAssertMode(*args, **kwargs)
d55e5bfc
RD		 7301
7302 def GetMacSupportPCMenuShortcuts(*args, **kwargs):
d6c14a4c 7303 """GetMacSupportPCMenuShortcuts() -> bool"""
5b5c9bc7 7304 return _core_.PyApp_GetMacSupportPCMenuShortcuts(*args, **kwargs)
d55e5bfc
RD		 7305
7306 GetMacSupportPCMenuShortcuts = staticmethod(GetMacSupportPCMenuShortcuts)
7307 def GetMacAboutMenuItemId(*args, **kwargs):
d6c14a4c 7308 """GetMacAboutMenuItemId() -> long"""
5b5c9bc7 7309 return _core_.PyApp_GetMacAboutMenuItemId(*args, **kwargs)
d55e5bfc
RD		 7310
7311 GetMacAboutMenuItemId = staticmethod(GetMacAboutMenuItemId)
7312 def GetMacPreferencesMenuItemId(*args, **kwargs):
d6c14a4c 7313 """GetMacPreferencesMenuItemId() -> long"""
5b5c9bc7 7314 return _core_.PyApp_GetMacPreferencesMenuItemId(*args, **kwargs)
d55e5bfc
RD		 7315
7316 GetMacPreferencesMenuItemId = staticmethod(GetMacPreferencesMenuItemId)
7317 def GetMacExitMenuItemId(*args, **kwargs):
d6c14a4c 7318 """GetMacExitMenuItemId() -> long"""
5b5c9bc7 7319 return _core_.PyApp_GetMacExitMenuItemId(*args, **kwargs)
d55e5bfc
RD		 7320
7321 GetMacExitMenuItemId = staticmethod(GetMacExitMenuItemId)
7322 def GetMacHelpMenuTitleName(*args, **kwargs):
5b5c9bc7
RD		 7323 """GetMacHelpMenuTitleName() -> String"""
7324 return _core_.PyApp_GetMacHelpMenuTitleName(*args, **kwargs)
d55e5bfc
RD		 7325
7326 GetMacHelpMenuTitleName = staticmethod(GetMacHelpMenuTitleName)
7327 def SetMacSupportPCMenuShortcuts(*args, **kwargs):
d6c14a4c 7328 """SetMacSupportPCMenuShortcuts(bool val)"""
5b5c9bc7 7329 return _core_.PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs)
d55e5bfc
RD		 7330
7331 SetMacSupportPCMenuShortcuts = staticmethod(SetMacSupportPCMenuShortcuts)
7332 def SetMacAboutMenuItemId(*args, **kwargs):
d6c14a4c 7333 """SetMacAboutMenuItemId(long val)"""
5b5c9bc7 7334 return _core_.PyApp_SetMacAboutMenuItemId(*args, **kwargs)
d55e5bfc
RD		 7335
7336 SetMacAboutMenuItemId = staticmethod(SetMacAboutMenuItemId)
7337 def SetMacPreferencesMenuItemId(*args, **kwargs):
d6c14a4c 7338 """SetMacPreferencesMenuItemId(long val)"""
5b5c9bc7 7339 return _core_.PyApp_SetMacPreferencesMenuItemId(*args, **kwargs)
d55e5bfc
RD		 7340
7341 SetMacPreferencesMenuItemId = staticmethod(SetMacPreferencesMenuItemId)
7342 def SetMacExitMenuItemId(*args, **kwargs):
d6c14a4c 7343 """SetMacExitMenuItemId(long val)"""
5b5c9bc7 7344 return _core_.PyApp_SetMacExitMenuItemId(*args, **kwargs)
d55e5bfc
RD		 7345
7346 SetMacExitMenuItemId = staticmethod(SetMacExitMenuItemId)
7347 def SetMacHelpMenuTitleName(*args, **kwargs):
5b5c9bc7
RD		 7348 """SetMacHelpMenuTitleName(String val)"""
7349 return _core_.PyApp_SetMacHelpMenuTitleName(*args, **kwargs)
d55e5bfc
RD		 7350
7351 SetMacHelpMenuTitleName = staticmethod(SetMacHelpMenuTitleName)
7352 def _BootstrapApp(*args, **kwargs):
7353 """
7354 _BootstrapApp(self)
7355
7356 For internal use only
7357 """
5b5c9bc7 7358 return _core_.PyApp__BootstrapApp(*args, **kwargs)
d55e5bfc
RD		 7359
7360 def GetComCtl32Version(*args, **kwargs):
7361 """
d6c14a4c 7362 GetComCtl32Version() -> int
d55e5bfc 7363
d6c14a4c
RD		 7364 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
7365 it wasn't found at all. Raises an exception on non-Windows platforms.
d55e5bfc 7366 """
5b5c9bc7 7367 return _core_.PyApp_GetComCtl32Version(*args, **kwargs)
d55e5bfc
RD		 7368
7369 GetComCtl32Version = staticmethod(GetComCtl32Version)
33d6fd3b 7370 def IsDisplayAvailable(*args, **kwargs):
fc46b7f3 7371 """
33d6fd3b 7372 IsDisplayAvailable() -> bool
fc46b7f3
RD		 7373
7374 Tests if it is possible to create a GUI in the current environment.
7375 This will mean different things on the different platforms.
7376
7377 * On X Windows systems this function will return ``False`` if it is
7378 not able to open a connection to the X display, which can happen
7379 if $DISPLAY is not set, or is not set correctly.
7380
7381 * On Mac OS X a ``False`` return value will mean that wx is not
7382 able to access the window manager, which can happen if logged in
7383 remotely or if running from the normal version of python instead
7384 of the framework version, (i.e., pythonw.)
7385
7386 * On MS Windows...
7387
7388 """
33d6fd3b
RD		 7389 return _core_.PyApp_IsDisplayAvailable(*args, **kwargs)
7390
7391 IsDisplayAvailable = staticmethod(IsDisplayAvailable)
7392 AppName = property(GetAppName,SetAppName,doc="See `GetAppName` and `SetAppName`")
7393 AssertMode = property(GetAssertMode,SetAssertMode,doc="See `GetAssertMode` and `SetAssertMode`")
7394 ClassName = property(GetClassName,SetClassName,doc="See `GetClassName` and `SetClassName`")
7395 ExitOnFrameDelete = property(GetExitOnFrameDelete,SetExitOnFrameDelete,doc="See `GetExitOnFrameDelete` and `SetExitOnFrameDelete`")
7396 LayoutDirection = property(GetLayoutDirection,doc="See `GetLayoutDirection`")
7397 PrintMode = property(GetPrintMode,SetPrintMode,doc="See `GetPrintMode` and `SetPrintMode`")
7398 TopWindow = property(GetTopWindow,SetTopWindow,doc="See `GetTopWindow` and `SetTopWindow`")
7399 Traits = property(GetTraits,doc="See `GetTraits`")
7400 UseBestVisual = property(GetUseBestVisual,SetUseBestVisual,doc="See `GetUseBestVisual` and `SetUseBestVisual`")
7401 VendorName = property(GetVendorName,SetVendorName,doc="See `GetVendorName` and `SetVendorName`")
7402 Active = property(IsActive)
2131d850 7403_core_.PyApp_swigregister(PyApp)
d55e5bfc 7404
1bd55598
RD		 7405def PyApp_IsMainLoopRunning(*args):
7406 """
5b5c9bc7 7407 PyApp_IsMainLoopRunning() -> bool
84f85550
RD		 7408
7409 Returns True if we're running the main loop, i.e. if the events can
7410 currently be dispatched.
7411 """
1bd55598 7412 return _core_.PyApp_IsMainLoopRunning(*args)
84f85550 7413
1bd55598
RD		 7414def PyApp_GetMacSupportPCMenuShortcuts(*args):
7415 """PyApp_GetMacSupportPCMenuShortcuts() -> bool"""
7416 return _core_.PyApp_GetMacSupportPCMenuShortcuts(*args)
d55e5bfc 7417
1bd55598
RD		 7418def PyApp_GetMacAboutMenuItemId(*args):
7419 """PyApp_GetMacAboutMenuItemId() -> long"""
7420 return _core_.PyApp_GetMacAboutMenuItemId(*args)
d55e5bfc 7421
1bd55598
RD		 7422def PyApp_GetMacPreferencesMenuItemId(*args):
7423 """PyApp_GetMacPreferencesMenuItemId() -> long"""
7424 return _core_.PyApp_GetMacPreferencesMenuItemId(*args)
d55e5bfc 7425
1bd55598
RD		 7426def PyApp_GetMacExitMenuItemId(*args):
7427 """PyApp_GetMacExitMenuItemId() -> long"""
7428 return _core_.PyApp_GetMacExitMenuItemId(*args)
d55e5bfc 7429
1bd55598
RD		 7430def PyApp_GetMacHelpMenuTitleName(*args):
7431 """PyApp_GetMacHelpMenuTitleName() -> String"""
7432 return _core_.PyApp_GetMacHelpMenuTitleName(*args)
d55e5bfc 7433
5b5c9bc7 7434def PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs):
1bd55598
RD		 7435 """PyApp_SetMacSupportPCMenuShortcuts(bool val)"""
7436 return _core_.PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs)
d55e5bfc 7437
5b5c9bc7 7438def PyApp_SetMacAboutMenuItemId(*args, **kwargs):
1bd55598
RD		 7439 """PyApp_SetMacAboutMenuItemId(long val)"""
7440 return _core_.PyApp_SetMacAboutMenuItemId(*args, **kwargs)
d55e5bfc 7441
5b5c9bc7 7442def PyApp_SetMacPreferencesMenuItemId(*args, **kwargs):
1bd55598
RD		 7443 """PyApp_SetMacPreferencesMenuItemId(long val)"""
7444 return _core_.PyApp_SetMacPreferencesMenuItemId(*args, **kwargs)
d55e5bfc 7445
5b5c9bc7 7446def PyApp_SetMacExitMenuItemId(*args, **kwargs):
1bd55598
RD		 7447 """PyApp_SetMacExitMenuItemId(long val)"""
7448 return _core_.PyApp_SetMacExitMenuItemId(*args, **kwargs)
d55e5bfc 7449
5b5c9bc7 7450def PyApp_SetMacHelpMenuTitleName(*args, **kwargs):
1bd55598
RD		 7451 """PyApp_SetMacHelpMenuTitleName(String val)"""
7452 return _core_.PyApp_SetMacHelpMenuTitleName(*args, **kwargs)
d55e5bfc 7453
1bd55598
RD		 7454def PyApp_GetComCtl32Version(*args):
7455 """
5b5c9bc7 7456 PyApp_GetComCtl32Version() -> int
d55e5bfc 7457
d6c14a4c
RD		 7458 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
7459 it wasn't found at all. Raises an exception on non-Windows platforms.
d55e5bfc 7460 """
1bd55598 7461 return _core_.PyApp_GetComCtl32Version(*args)
d55e5bfc 7462
33d6fd3b 7463def PyApp_IsDisplayAvailable(*args):
fc46b7f3 7464 """
33d6fd3b 7465 PyApp_IsDisplayAvailable() -> bool
fc46b7f3
RD		 7466
7467 Tests if it is possible to create a GUI in the current environment.
7468 This will mean different things on the different platforms.
7469
7470 * On X Windows systems this function will return ``False`` if it is
7471 not able to open a connection to the X display, which can happen
7472 if $DISPLAY is not set, or is not set correctly.
7473
7474 * On Mac OS X a ``False`` return value will mean that wx is not
7475 able to access the window manager, which can happen if logged in
7476 remotely or if running from the normal version of python instead
7477 of the framework version, (i.e., pythonw.)
7478
7479 * On MS Windows...
7480
7481 """
33d6fd3b 7482 return _core_.PyApp_IsDisplayAvailable(*args)
fc46b7f3 7483
d55e5bfc
RD		 7484#---------------------------------------------------------------------------
7485
7486
1bd55598
RD		 7487def Exit(*args):
7488 """
5b5c9bc7 7489 Exit()
d55e5bfc
RD		 7490
7491 Force an exit of the application. Convenience for wx.GetApp().Exit()
7492 """
1bd55598 7493 return _core_.Exit(*args)
d55e5bfc 7494
1bd55598
RD		 7495def Yield(*args):
7496 """
5b5c9bc7 7497 Yield() -> bool
d55e5bfc
RD		 7498
7499 Yield to other apps/messages. Convenience for wx.GetApp().Yield()
7500 """
1bd55598 7501 return _core_.Yield(*args)
d55e5bfc 7502
1bd55598
RD		 7503def YieldIfNeeded(*args):
7504 """
5b5c9bc7 7505 YieldIfNeeded() -> bool
d55e5bfc
RD		 7506
7507 Yield to other apps/messages. Convenience for wx.GetApp().Yield(True)
7508 """
1bd55598 7509 return _core_.YieldIfNeeded(*args)
d55e5bfc 7510
5b5c9bc7 7511def SafeYield(*args, **kwargs):
1bd55598 7512 """
5b5c9bc7 7513 SafeYield(Window win=None, bool onlyIfNeeded=False) -> bool
d55e5bfc 7514
d6c14a4c
RD		 7515 This function is similar to `wx.Yield`, except that it disables the
7516 user input to all program windows before calling `wx.Yield` and
7517 re-enables it again afterwards. If ``win`` is not None, this window
7518 will remain enabled, allowing the implementation of some limited user
7519 interaction.
d55e5bfc 7520
d6c14a4c 7521 :Returns: the result of the call to `wx.Yield`.
d55e5bfc 7522 """
1bd55598 7523 return _core_.SafeYield(*args, **kwargs)
d55e5bfc 7524
1bd55598
RD		 7525def WakeUpIdle(*args):
7526 """
5b5c9bc7 7527 WakeUpIdle()
d55e5bfc 7528
d6c14a4c
RD		 7529 Cause the message queue to become empty again, so idle events will be
7530 sent.
d55e5bfc 7531 """
1bd55598 7532 return _core_.WakeUpIdle(*args)
d55e5bfc 7533
5b5c9bc7 7534def PostEvent(*args, **kwargs):
1bd55598 7535 """
5b5c9bc7 7536 PostEvent(EvtHandler dest, Event event)
d55e5bfc 7537
d6c14a4c
RD		 7538 Send an event to a window or other wx.EvtHandler to be processed
7539 later.
d55e5bfc 7540 """
1bd55598 7541 return _core_.PostEvent(*args, **kwargs)
d55e5bfc 7542
1bd55598
RD		 7543def App_CleanUp(*args):
7544 """
5b5c9bc7 7545 App_CleanUp()
d55e5bfc 7546
15817c7e 7547 For internal use only, it is used to cleanup after wxWidgets when
d6c14a4c 7548 Python shuts down.
d55e5bfc 7549 """
1bd55598 7550 return _core_.App_CleanUp(*args)
d55e5bfc 7551
1bd55598
RD		 7552def GetApp(*args):
7553 """
5b5c9bc7 7554 GetApp() -> PyApp
d55e5bfc
RD		 7555
7556 Return a reference to the current wx.App object.
7557 """
1bd55598 7558 return _core_.GetApp(*args)
5cbf236d 7559
5b5c9bc7 7560def SetDefaultPyEncoding(*args, **kwargs):
1bd55598 7561 """
5cbf236d
RD		 7562 SetDefaultPyEncoding(string encoding)
7563
7564 Sets the encoding that wxPython will use when it needs to convert a
7565 Python string or unicode object to or from a wxString.
62d32a5f
RD		 7566
7567 The default encoding is the value of ``locale.getdefaultlocale()[1]``
7568 but please be aware that the default encoding within the same locale
7569 may be slightly different on different platforms. For example, please
7570 see http://www.alanwood.net/demos/charsetdiffs.html for differences
7571 between the common latin/roman encodings.
5cbf236d 7572 """
1bd55598 7573 return _core_.SetDefaultPyEncoding(*args, **kwargs)
5cbf236d 7574
1bd55598
RD		 7575def GetDefaultPyEncoding(*args):
7576 """
5cbf236d
RD		 7577 GetDefaultPyEncoding() -> string
7578
7579 Gets the current encoding that wxPython will use when it needs to
7580 convert a Python string or unicode object to or from a wxString.
7581 """
1bd55598 7582 return _core_.GetDefaultPyEncoding(*args)
d55e5bfc
RD		 7583#----------------------------------------------------------------------
7584
7585class PyOnDemandOutputWindow:
7586 """
7587 A class that can be used for redirecting Python's stdout and
7588 stderr streams. It will do nothing until something is wrriten to
7589 the stream at which point it will create a Frame with a text area
7590 and write the text there.
7591 """
7592 def __init__(self, title = "wxPython: stdout/stderr"):
7593 self.frame = None
7594 self.title = title
412d302d
RD		 7595 self.pos = wx.DefaultPosition
7596 self.size = (450, 300)
d55e5bfc
RD		 7597 self.parent = None
7598
7599 def SetParent(self, parent):
7600 """Set the window to be used as the popup Frame's parent."""
7601 self.parent = parent
7602
7603
7604 def CreateOutputWindow(self, st):
412d302d
RD		 7605 self.frame = wx.Frame(self.parent, -1, self.title, self.pos, self.size,
7606 style=wx.DEFAULT_FRAME_STYLE)
d55e5bfc 7607 self.text = wx.TextCtrl(self.frame, -1, "",
412d302d 7608 style=wx.TE_MULTILINE|wx.TE_READONLY)
d55e5bfc 7609 self.text.AppendText(st)
d55e5bfc 7610 self.frame.Show(True)
2131d850 7611 self.frame.Bind(wx.EVT_CLOSE, self.OnCloseWindow)
d55e5bfc
RD		 7612
7613
7614 def OnCloseWindow(self, event):
7615 if self.frame is not None:
7616 self.frame.Destroy()
7617 self.frame = None
7618 self.text = None
7619
7620
7621 # These methods provide the file-like output behaviour.
7622 def write(self, text):
7623 """
7624 Create the output window if needed and write the string to it.
7625 If not called in the context of the gui thread then uses
7626 CallAfter to do the work there.
7627 """
7628 if self.frame is None:
7629 if not wx.Thread_IsMain():
7630 wx.CallAfter(self.CreateOutputWindow, text)
7631 else:
7632 self.CreateOutputWindow(text)
7633 else:
7634 if not wx.Thread_IsMain():
7635 wx.CallAfter(self.text.AppendText, text)
7636 else:
7637 self.text.AppendText(text)
7638
7639
7640 def close(self):
7641 if self.frame is not None:
7642 wx.CallAfter(self.frame.Close)
7643
7644
bb4524c4
RD		 7645 def flush(self):
7646 pass
7647
7648
d55e5bfc
RD		 7649
7650#----------------------------------------------------------------------
7651
7652_defRedirect = (wx.Platform == '__WXMSW__' or wx.Platform == '__WXMAC__')
fc46b7f3 7653
d55e5bfc
RD		 7654class App(wx.PyApp):
7655 """
d6c14a4c
RD		 7656 The ``wx.App`` class represents the application and is used to:
7657
7658 * bootstrap the wxPython system and initialize the underlying
7659 gui toolkit
7660 * set and get application-wide properties
7661 * implement the windowing system main message or event loop,
7662 and to dispatch events to window instances
7663 * etc.
7664
7665 Every application must have a ``wx.App`` instance, and all
7666 creation of UI objects should be delayed until after the
7667 ``wx.App`` object has been created in order to ensure that the gui
7668 platform and wxWidgets have been fully initialized.
7669
7670 Normally you would derive from this class and implement an
7671 ``OnInit`` method that creates a frame and then calls
7672 ``self.SetTopWindow(frame)``.
7673
7674 :see: `wx.PySimpleApp` for a simpler app class that can be used
15817c7e 7675 directly.
d55e5bfc 7676 """
d6c14a4c 7677
d55e5bfc
RD		 7678 outputWindowClass = PyOnDemandOutputWindow
7679
d6c14a4c
RD		 7680 def __init__(self, redirect=_defRedirect, filename=None,
7681 useBestVisual=False, clearSigInt=True):
7682 """
7683 Construct a ``wx.App`` object.
7684
7685 :param redirect: Should ``sys.stdout`` and ``sys.stderr`` be
7686 redirected? Defaults to True on Windows and Mac, False
7687 otherwise. If `filename` is None then output will be
7688 redirected to a window that pops up as needed. (You can
7689 control what kind of window is created for the output by
7690 resetting the class variable ``outputWindowClass`` to a
7691 class of your choosing.)
7692
7693 :param filename: The name of a file to redirect output to, if
7694 redirect is True.
7695
7696 :param useBestVisual: Should the app try to use the best
7697 available visual provided by the system (only relevant on
7698 systems that have more than one visual.) This parameter
7699 must be used instead of calling `SetUseBestVisual` later
7700 on because it must be set before the underlying GUI
7701 toolkit is initialized.
7702
7703 :param clearSigInt: Should SIGINT be cleared? This allows the
7704 app to terminate upon a Ctrl-C in the console like other
7705 GUI apps will.
7706
7707 :note: You should override OnInit to do applicaition
7708 initialization to ensure that the system, toolkit and
7709 wxWidgets are fully initialized.
7710 """
fc46b7f3 7711
d55e5bfc
RD		 7712 wx.PyApp.__init__(self)
7713
fc46b7f3 7714 # make sure we can create a GUI
33d6fd3b 7715 if not self.IsDisplayAvailable():
fc46b7f3
RD		 7716
7717 if wx.Platform == "__WXMAC__":
7718 msg = """This program needs access to the screen.
7719Please run with 'pythonw', not 'python', and only when you are logged
7720in on the main display of your Mac."""
7721
7722 elif wx.Platform == "__WXGTK__":
7723 msg ="Unable to access the X Display, is $DISPLAY set properly?"
d55e5bfc 7724
fc46b7f3
RD		 7725 else:
7726 msg = "Unable to create GUI"
7727 # TODO: more description is needed for wxMSW...
7728
7729 raise SystemExit(msg)
7730
d55e5bfc
RD		 7731 # This has to be done before OnInit
7732 self.SetUseBestVisual(useBestVisual)
7733
7734 # Set the default handler for SIGINT. This fixes a problem
7735 # where if Ctrl-C is pressed in the console that started this
7736 # app then it will not appear to do anything, (not even send
7737 # KeyboardInterrupt???) but will later segfault on exit. By
7738 # setting the default handler then the app will exit, as
7739 # expected (depending on platform.)
d6c14a4c
RD		 7740 if clearSigInt:
7741 try:
7742 import signal
7743 signal.signal(signal.SIGINT, signal.SIG_DFL)
7744 except:
7745 pass
d55e5bfc
RD		 7746
7747 # Save and redirect the stdio to a window?
7748 self.stdioWin = None
7749 self.saveStdio = (_sys.stdout, _sys.stderr)
7750 if redirect:
7751 self.RedirectStdio(filename)
7752
8fb0e70a
RD		 7753 # Use Python's install prefix as the default
7754 wx.StandardPaths.Get().SetInstallPrefix(_sys.prefix)
7755
d55e5bfc
RD		 7756 # This finishes the initialization of wxWindows and then calls
7757 # the OnInit that should be present in the derived class
7758 self._BootstrapApp()
7759
7760
2131d850
RD		 7761 def OnPreInit(self):
7762 """
7763 Things that must be done after _BootstrapApp has done its
7764 thing, but would be nice if they were already done by the time
7765 that OnInit is called.
7766 """
7767 wx.StockGDI._initStockObjects()
7768
7769
66af7a75
RD		 7770 def __del__(self, destroy=wx.PyApp.__del__):
7771 self.RestoreStdio() # Just in case the MainLoop was overridden
7772 destroy(self)
d55e5bfc 7773
7993762b 7774 def Destroy(self):
b39fe951 7775 self.this.own(False)
7993762b 7776 wx.PyApp.Destroy(self)
d55e5bfc
RD		 7777
7778 def SetTopWindow(self, frame):
7779 """Set the \"main\" top level window"""
7780 if self.stdioWin:
7781 self.stdioWin.SetParent(frame)
7782 wx.PyApp.SetTopWindow(self, frame)
7783
7784
7785 def MainLoop(self):
7786 """Execute the main GUI event loop"""
7787 wx.PyApp.MainLoop(self)
7788 self.RestoreStdio()
7789
7790
7791 def RedirectStdio(self, filename=None):
7792 """Redirect sys.stdout and sys.stderr to a file or a popup window."""
7793 if filename:
7794 _sys.stdout = _sys.stderr = open(filename, 'a')
7795 else:
7796 self.stdioWin = self.outputWindowClass()
7797 _sys.stdout = _sys.stderr = self.stdioWin
7798
7799
7800 def RestoreStdio(self):
66af7a75
RD		 7801 try:
7802 _sys.stdout, _sys.stderr = self.saveStdio
7803 except:
7804 pass
d55e5bfc
RD		 7805
7806
412d302d
RD		 7807 def SetOutputWindowAttributes(self, title=None, pos=None, size=None):
7808 """
7809 Set the title, position and/or size of the output window if
f5b96ee1
RD		 7810 the stdio has been redirected. This should be called before
7811 any output would cause the output window to be created.
412d302d
RD		 7812 """
7813 if self.stdioWin:
7814 if title is not None:
7815 self.stdioWin.title = title
7816 if pos is not None:
7817 self.stdioWin.pos = pos
7818 if size is not None:
7819 self.stdioWin.size = size
7820
7821
7822
d55e5bfc 7823
d6c14a4c 7824# change from wx.PyApp_XX to wx.App_XX
d55e5bfc
RD		 7825App_GetMacSupportPCMenuShortcuts = _core_.PyApp_GetMacSupportPCMenuShortcuts
7826App_GetMacAboutMenuItemId = _core_.PyApp_GetMacAboutMenuItemId
7827App_GetMacPreferencesMenuItemId = _core_.PyApp_GetMacPreferencesMenuItemId
7828App_GetMacExitMenuItemId = _core_.PyApp_GetMacExitMenuItemId
7829App_GetMacHelpMenuTitleName = _core_.PyApp_GetMacHelpMenuTitleName
7830App_SetMacSupportPCMenuShortcuts = _core_.PyApp_SetMacSupportPCMenuShortcuts
7831App_SetMacAboutMenuItemId = _core_.PyApp_SetMacAboutMenuItemId
7832App_SetMacPreferencesMenuItemId = _core_.PyApp_SetMacPreferencesMenuItemId
7833App_SetMacExitMenuItemId = _core_.PyApp_SetMacExitMenuItemId
7834App_SetMacHelpMenuTitleName = _core_.PyApp_SetMacHelpMenuTitleName
7835App_GetComCtl32Version = _core_.PyApp_GetComCtl32Version
7836
7837#----------------------------------------------------------------------------
7838
7839class PySimpleApp(wx.App):
7840 """
7841 A simple application class. You can just create one of these and
7842 then then make your top level windows later, and not have to worry
d6c14a4c 7843 about OnInit. For example::
d55e5bfc 7844
d6c14a4c
RD		 7845 app = wx.PySimpleApp()
7846 frame = wx.Frame(None, title='Hello World')
7847 frame.Show()
7848 app.MainLoop()
7849
7850 :see: `wx.App`
7851 """
7852
7853 def __init__(self, redirect=False, filename=None,
7854 useBestVisual=False, clearSigInt=True):
7855 """
7856 :see: `wx.App.__init__`
7857 """
7858 wx.App.__init__(self, redirect, filename, useBestVisual, clearSigInt)
d55e5bfc
RD		 7859
7860 def OnInit(self):
d55e5bfc
RD		 7861 return True
7862
7863
d6c14a4c 7864
d55e5bfc
RD		 7865# Is anybody using this one?
7866class PyWidgetTester(wx.App):
7867 def __init__(self, size = (250, 100)):
7868 self.size = size
7869 wx.App.__init__(self, 0)
7870
7871 def OnInit(self):
7872 self.frame = wx.Frame(None, -1, "Widget Tester", pos=(0,0), size=self.size)
7873 self.SetTopWindow(self.frame)
7874 return True
7875
d6c14a4c
RD		 7876 def SetWidget(self, widgetClass, *args, **kwargs):
7877 w = widgetClass(self.frame, *args, **kwargs)
d55e5bfc
RD		 7878 self.frame.Show(True)
7879
7880#----------------------------------------------------------------------------
7881# DO NOT hold any other references to this object. This is how we
d6c14a4c 7882# know when to cleanup system resources that wxWidgets is holding. When
d55e5bfc 7883# the sys module is unloaded, the refcount on sys.__wxPythonCleanup
d6c14a4c 7884# goes to zero and it calls the wx.App_CleanUp function.
d55e5bfc
RD		 7885
7886class __wxPyCleanup:
7887 def __init__(self):
7888 self.cleanup = _core_.App_CleanUp
7889 def __del__(self):
7890 self.cleanup()
7891
7892_sys.__wxPythonCleanup = __wxPyCleanup()
7893
7894## # another possible solution, but it gets called too early...
d6c14a4c
RD		 7895## import atexit
7896## atexit.register(_core_.wxApp_CleanUp)
d55e5bfc
RD		 7897
7898
7899#----------------------------------------------------------------------------
7900
7901#---------------------------------------------------------------------------
7902
5b5c9bc7
RD		 7903class EventLoop(object):
7904 """Proxy of C++ EventLoop class"""
1bd55598
RD		 7905 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7906 __repr__ = _swig_repr
7907 def __init__(self, *args, **kwargs):
5b5c9bc7 7908 """__init__(self) -> EventLoop"""
1bd55598
RD		 7909 _core_.EventLoop_swiginit(self,_core_.new_EventLoop(*args, **kwargs))
7910 __swig_destroy__ = _core_.delete_EventLoop
7911 __del__ = lambda self : None;
b411df4a
RD		 7912 def Run(*args, **kwargs):
7913 """Run(self) -> int"""
5b5c9bc7 7914 return _core_.EventLoop_Run(*args, **kwargs)
b411df4a
RD		 7915
7916 def Exit(*args, **kwargs):
7917 """Exit(self, int rc=0)"""
5b5c9bc7 7918 return _core_.EventLoop_Exit(*args, **kwargs)
b411df4a
RD		 7919
7920 def Pending(*args, **kwargs):
7921 """Pending(self) -> bool"""
5b5c9bc7 7922 return _core_.EventLoop_Pending(*args, **kwargs)
b411df4a
RD		 7923
7924 def Dispatch(*args, **kwargs):
7925 """Dispatch(self) -> bool"""
5b5c9bc7 7926 return _core_.EventLoop_Dispatch(*args, **kwargs)
b411df4a
RD		 7927
7928 def IsRunning(*args, **kwargs):
7929 """IsRunning(self) -> bool"""
5b5c9bc7 7930 return _core_.EventLoop_IsRunning(*args, **kwargs)
b411df4a
RD		 7931
7932 def GetActive(*args, **kwargs):
5b5c9bc7
RD		 7933 """GetActive() -> EventLoop"""
7934 return _core_.EventLoop_GetActive(*args, **kwargs)
b411df4a
RD		 7935
7936 GetActive = staticmethod(GetActive)
7937 def SetActive(*args, **kwargs):
5b5c9bc7
RD		 7938 """SetActive(EventLoop loop)"""
7939 return _core_.EventLoop_SetActive(*args, **kwargs)
b411df4a
RD		 7940
7941 SetActive = staticmethod(SetActive)
2131d850 7942_core_.EventLoop_swigregister(EventLoop)
b411df4a 7943
1bd55598
RD		 7944def EventLoop_GetActive(*args):
7945 """EventLoop_GetActive() -> EventLoop"""
7946 return _core_.EventLoop_GetActive(*args)
b411df4a 7947
5b5c9bc7 7948def EventLoop_SetActive(*args, **kwargs):
1bd55598
RD		 7949 """EventLoop_SetActive(EventLoop loop)"""
7950 return _core_.EventLoop_SetActive(*args, **kwargs)
b411df4a 7951
32fe5131
RD		 7952class EventLoopActivator(object):
7953 """Proxy of C++ EventLoopActivator class"""
1bd55598
RD		 7954 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7955 __repr__ = _swig_repr
7956 def __init__(self, *args, **kwargs):
32fe5131 7957 """__init__(self, EventLoop evtLoop) -> EventLoopActivator"""
1bd55598
RD		 7958 _core_.EventLoopActivator_swiginit(self,_core_.new_EventLoopActivator(*args, **kwargs))
7959 __swig_destroy__ = _core_.delete_EventLoopActivator
7960 __del__ = lambda self : None;
2131d850 7961_core_.EventLoopActivator_swigregister(EventLoopActivator)
32fe5131 7962
b411df4a
RD		 7963#---------------------------------------------------------------------------
7964
eec1c382
RD		 7965ACCEL_ALT = _core_.ACCEL_ALT
7966ACCEL_CTRL = _core_.ACCEL_CTRL
7967ACCEL_SHIFT = _core_.ACCEL_SHIFT
7968ACCEL_NORMAL = _core_.ACCEL_NORMAL
7969ACCEL_CMD = _core_.ACCEL_CMD
5b5c9bc7 7970class AcceleratorEntry(object):
d6c14a4c
RD		 7971 """
7972 A class used to define items in an `wx.AcceleratorTable`. wxPython
7973 programs can choose to use wx.AcceleratorEntry objects, but using a
7974 list of 3-tuple of integers (flags, keyCode, cmdID) usually works just
15817c7e 7975 as well. See `__init__` for of the tuple values.
d6c14a4c
RD		 7976
7977 :see: `wx.AcceleratorTable`
7978 """
1bd55598
RD		 7979 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7980 __repr__ = _swig_repr
7981 def __init__(self, *args, **kwargs):
d6c14a4c 7982 """
5b5c9bc7 7983 __init__(self, int flags=0, int keyCode=0, int cmdID=0) -> AcceleratorEntry
d6c14a4c
RD		 7984
7985 Construct a wx.AcceleratorEntry.
d6c14a4c 7986 """
1bd55598
RD		 7987 _core_.AcceleratorEntry_swiginit(self,_core_.new_AcceleratorEntry(*args, **kwargs))
7988 __swig_destroy__ = _core_.delete_AcceleratorEntry
7989 __del__ = lambda self : None;
d55e5bfc 7990 def Set(*args, **kwargs):
d6c14a4c
RD		 7991 """
7992 Set(self, int flags, int keyCode, int cmd)
d55e5bfc 7993
d6c14a4c
RD		 7994 (Re)set the attributes of a wx.AcceleratorEntry.
7995 :see `__init__`
7996 """
5b5c9bc7 7997 return _core_.AcceleratorEntry_Set(*args, **kwargs)
d55e5bfc 7998
ac5d357a
RD		 7999 def Create(*args, **kwargs):
8000 """
8001 Create(String str) -> AcceleratorEntry
8002
8003 Create accelerator corresponding to the specified string, or None if
8004 it coulnd't be parsed.
8005 """
8006 return _core_.AcceleratorEntry_Create(*args, **kwargs)
8007
8008 Create = staticmethod(Create)
d55e5bfc 8009 def GetFlags(*args, **kwargs):
d6c14a4c
RD		 8010 """
8011 GetFlags(self) -> int
8012
8013 Get the AcceleratorEntry's flags.
8014 """
5b5c9bc7 8015 return _core_.AcceleratorEntry_GetFlags(*args, **kwargs)
d55e5bfc
RD		 8016
8017 def GetKeyCode(*args, **kwargs):
d6c14a4c
RD		 8018 """
8019 GetKeyCode(self) -> int
8020
8021 Get the AcceleratorEntry's keycode.
8022 """
5b5c9bc7 8023 return _core_.AcceleratorEntry_GetKeyCode(*args, **kwargs)
d55e5bfc
RD		 8024
8025 def GetCommand(*args, **kwargs):
d6c14a4c
RD		 8026 """
8027 GetCommand(self) -> int
8028
8029 Get the AcceleratorEntry's command ID.
8030 """
5b5c9bc7 8031 return _core_.AcceleratorEntry_GetCommand(*args, **kwargs)
d55e5bfc 8032
ac5d357a
RD		 8033 def IsOk(*args, **kwargs):
8034 """IsOk(self) -> bool"""
8035 return _core_.AcceleratorEntry_IsOk(*args, **kwargs)
8036
8037 def ToString(*args, **kwargs):
8038 """
8039 ToString(self) -> String
8040
8041 Returns a string representation for the this accelerator. The string
8042 is formatted using the <flags>-<keycode> format where <flags> maybe a
8043 hyphen-separed list of "shift|alt|ctrl"
8044
8045 """
8046 return _core_.AcceleratorEntry_ToString(*args, **kwargs)
8047
8048 def FromString(*args, **kwargs):
8049 """
8050 FromString(self, String str) -> bool
8051
8052 Returns true if the given string correctly initialized this object.
8053 """
8054 return _core_.AcceleratorEntry_FromString(*args, **kwargs)
8055
2bf58437
RD		 8056 Command = property(GetCommand,doc="See `GetCommand`")
8057 Flags = property(GetFlags,doc="See `GetFlags`")
8058 KeyCode = property(GetKeyCode,doc="See `GetKeyCode`")
2131d850 8059_core_.AcceleratorEntry_swigregister(AcceleratorEntry)
d55e5bfc 8060
ac5d357a
RD		 8061def AcceleratorEntry_Create(*args, **kwargs):
8062 """
8063 AcceleratorEntry_Create(String str) -> AcceleratorEntry
8064
8065 Create accelerator corresponding to the specified string, or None if
8066 it coulnd't be parsed.
8067 """
8068 return _core_.AcceleratorEntry_Create(*args, **kwargs)
8069
5b5c9bc7 8070class AcceleratorTable(Object):
d6c14a4c
RD		 8071 """
8072 An accelerator table allows the application to specify a table of
8073 keyboard shortcuts for menus or other commands. On Windows, menu or
8074 button commands are supported; on GTK, only menu commands are
8075 supported.
d6c14a4c 8076 """
1bd55598
RD		 8077 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
8078 __repr__ = _swig_repr
8079 def __init__(self, *args, **kwargs):
d55e5bfc
RD		 8080 """
8081 __init__(entries) -> AcceleratorTable
8082
d6c14a4c
RD		 8083 Construct an AcceleratorTable from a list of `wx.AcceleratorEntry`
8084 items or or of 3-tuples (flags, keyCode, cmdID)
8085
8086 :see: `wx.AcceleratorEntry`
d55e5bfc 8087 """
1bd55598
RD		 8088 _core_.AcceleratorTable_swiginit(self,_core_.new_AcceleratorTable(*args, **kwargs))
8089 __swig_destroy__ = _core_.delete_AcceleratorTable
8090 __del__ = lambda self : None;
b39fe951
RD		 8091 def IsOk(*args, **kwargs):
8092 """IsOk(self) -> bool"""
8093 return _core_.AcceleratorTable_IsOk(*args, **kwargs)
d55e5bfc 8094
b39fe951 8095 Ok = IsOk
2131d850 8096_core_.AcceleratorTable_swigregister(AcceleratorTable)
d55e5bfc
RD		 8097
8098
5b5c9bc7 8099def GetAccelFromString(*args, **kwargs):
1bd55598
RD		 8100 """GetAccelFromString(String label) -> AcceleratorEntry"""
8101 return _core_.GetAccelFromString(*args, **kwargs)
d55e5bfc
RD		 8102#---------------------------------------------------------------------------
8103
5b5c9bc7 8104class VisualAttributes(object):
d55e5bfc 8105 """struct containing all the visual attributes of a control"""
1bd55598
RD		 8106 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
8107 __repr__ = _swig_repr
8108 def __init__(self, *args, **kwargs):
d55e5bfc 8109 """
5b5c9bc7 8110 __init__(self) -> VisualAttributes
d55e5bfc
RD		 8111
8112 struct containing all the visual attributes of a control
8113 """
1bd55598
RD		 8114 _core_.VisualAttributes_swiginit(self,_core_.new_VisualAttributes(*args, **kwargs))
8115 __swig_destroy__ = _core_.delete_VisualAttributes
8116 __del__ = lambda self : None;
5b5c9bc7
RD		 8117 font = property(_core_.VisualAttributes_font_get, _core_.VisualAttributes_font_set)
8118 colFg = property(_core_.VisualAttributes_colFg_get, _core_.VisualAttributes_colFg_set)
8119 colBg = property(_core_.VisualAttributes_colBg_get, _core_.VisualAttributes_colBg_set)
2131d850 8120_core_.VisualAttributes_swigregister(VisualAttributes)
5b5c9bc7 8121NullAcceleratorTable = cvar.NullAcceleratorTable
d55e5bfc
RD		 8122PanelNameStr = cvar.PanelNameStr
8123
5b5c9bc7
RD		 8124WINDOW_VARIANT_NORMAL = _core_.WINDOW_VARIANT_NORMAL
8125WINDOW_VARIANT_SMALL = _core_.WINDOW_VARIANT_SMALL
8126WINDOW_VARIANT_MINI = _core_.WINDOW_VARIANT_MINI
8127WINDOW_VARIANT_LARGE = _core_.WINDOW_VARIANT_LARGE
8128WINDOW_VARIANT_MAX = _core_.WINDOW_VARIANT_MAX
8129class Window(EvtHandler):
d55e5bfc
RD		 8130 """
8131 wx.Window is the base class for all windows and represents any visible
8132 object on the screen. All controls, top level windows and so on are
8133 wx.Windows. Sizers and device contexts are not however, as they don't
8134 appear on screen themselves.
8135
8136 """
1bd55598
RD		 8137 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
8138 __repr__ = _swig_repr
8139 def __init__(self, *args, **kwargs):
d55e5bfc 8140 """
5b5c9bc7
RD		 8141 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
8142 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> Window
d55e5bfc
RD		 8143
8144 Construct and show a generic Window.
8145 """
1bd55598 8146 _core_.Window_swiginit(self,_core_.new_Window(*args, **kwargs))
d55e5bfc
RD		 8147 self._setOORInfo(self)
8148
8149 def Create(*args, **kwargs):
8150 """
5b5c9bc7
RD		 8151 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
8152 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> bool
d55e5bfc
RD		 8153
8154 Create the GUI part of the Window for 2-phase creation mode.
8155 """
5b5c9bc7 8156 return _core_.Window_Create(*args, **kwargs)
d55e5bfc
RD		 8157
8158 def Close(*args, **kwargs):
8159 """
8160 Close(self, bool force=False) -> bool
8161
8162 This function simply generates a EVT_CLOSE event whose handler usually
8163 tries to close the window. It doesn't close the window itself,
8164 however. If force is False (the default) then the window's close
8165 handler will be allowed to veto the destruction of the window.
d55e5bfc 8166 """
5b5c9bc7 8167 return _core_.Window_Close(*args, **kwargs)
d55e5bfc
RD		 8168
8169 def Destroy(*args, **kwargs):
8170 """
8171 Destroy(self) -> bool
8172
8173 Destroys the window safely. Frames and dialogs are not destroyed
8174 immediately when this function is called -- they are added to a list
8175 of windows to be deleted on idle time, when all the window's events
8176 have been processed. This prevents problems with events being sent to
8177 non-existent windows.
8178
8179 Returns True if the window has either been successfully deleted, or it
8180 has been added to the list of windows pending real deletion.
8181 """
b39fe951
RD		 8182 args[0].this.own(False)
8183 return _core_.Window_Destroy(*args, **kwargs)
d55e5bfc
RD		 8184
8185 def DestroyChildren(*args, **kwargs):
8186 """
8187 DestroyChildren(self) -> bool
8188
15817c7e
RD		 8189 Destroys all children of a window. Called automatically by the
8190 destructor.
d55e5bfc 8191 """
5b5c9bc7 8192 return _core_.Window_DestroyChildren(*args, **kwargs)
d55e5bfc
RD		 8193
8194 def IsBeingDeleted(*args, **kwargs):
8195 """
8196 IsBeingDeleted(self) -> bool
8197
8198 Is the window in the process of being deleted?
8199 """
5b5c9bc7 8200 return _core_.Window_IsBeingDeleted(*args, **kwargs)
d55e5bfc 8201
d55e5bfc
RD		 8202 def SetLabel(*args, **kwargs):
8203 """
5b5c9bc7 8204 SetLabel(self, String label)
d55e5bfc
RD		 8205
8206 Set the text which the window shows in its label if applicable.
8207 """
5b5c9bc7 8208 return _core_.Window_SetLabel(*args, **kwargs)
d55e5bfc
RD		 8209
8210 def GetLabel(*args, **kwargs):
8211 """
5b5c9bc7 8212 GetLabel(self) -> String
d55e5bfc 8213
15817c7e
RD		 8214 Generic way of getting a label from any window, for identification
8215 purposes. The interpretation of this function differs from class to
8216 class. For frames and dialogs, the value returned is the title. For
8217 buttons or static text controls, it is the button text. This function
8218 can be useful for meta-programs such as testing tools or special-needs
8219 access programs)which need to identify windows by name.
d55e5bfc 8220 """
5b5c9bc7 8221 return _core_.Window_GetLabel(*args, **kwargs)
d55e5bfc
RD		 8222
8223 def SetName(*args, **kwargs):
8224 """
5b5c9bc7 8225 SetName(self, String name)
d55e5bfc 8226
15817c7e
RD		 8227 Sets the window's name. The window name is used for ressource setting
8228 in X, it is not the same as the window title/label
d55e5bfc 8229 """
5b5c9bc7 8230 return _core_.Window_SetName(*args, **kwargs)
d55e5bfc
RD		 8231
8232 def GetName(*args, **kwargs):
8233 """
5b5c9bc7 8234 GetName(self) -> String
d55e5bfc 8235
15817c7e
RD		 8236 Returns the windows name. This name is not guaranteed to be unique;
8237 it is up to the programmer to supply an appropriate name in the window
8238 constructor or via wx.Window.SetName.
d55e5bfc 8239 """
5b5c9bc7 8240 return _core_.Window_GetName(*args, **kwargs)
d55e5bfc
RD		 8241
8242 def SetWindowVariant(*args, **kwargs):
8243 """
8244 SetWindowVariant(self, int variant)
8245
15817c7e
RD		 8246 Sets the variant of the window/font size to use for this window, if
8247 the platform supports variants, for example, wxMac.
d55e5bfc 8248 """
5b5c9bc7 8249 return _core_.Window_SetWindowVariant(*args, **kwargs)
d55e5bfc
RD		 8250
8251 def GetWindowVariant(*args, **kwargs):
8252 """GetWindowVariant(self) -> int"""
5b5c9bc7 8253 return _core_.Window_GetWindowVariant(*args, **kwargs)
d55e5bfc
RD		 8254
8255 def SetId(*args, **kwargs):
8256 """
8257 SetId(self, int winid)
8258
8259 Sets the identifier of the window. Each window has an integer
8260 identifier. If the application has not provided one, an identifier
8261 will be generated. Normally, the identifier should be provided on
8262 creation and should not be modified subsequently.
8263 """
5b5c9bc7 8264 return _core_.Window_SetId(*args, **kwargs)
d55e5bfc
RD		 8265
8266 def GetId(*args, **kwargs):
8267 """
8268 GetId(self) -> int
8269
8270 Returns the identifier of the window. Each window has an integer
8271 identifier. If the application has not provided one (or the default Id
8272 -1 is used) then an unique identifier with a negative value will be
8273 generated.
8274 """
5b5c9bc7 8275 return _core_.Window_GetId(*args, **kwargs)
d55e5bfc
RD		 8276
8277 def NewControlId(*args, **kwargs):
8278 """
d6c14a4c 8279 NewControlId() -> int
d55e5bfc
RD		 8280
8281 Generate a control id for the controls which were not given one.
8282 """
5b5c9bc7 8283 return _core_.Window_NewControlId(*args, **kwargs)
d55e5bfc
RD		 8284
8285 NewControlId = staticmethod(NewControlId)
8286 def NextControlId(*args, **kwargs):
8287 """
d6c14a4c 8288 NextControlId(int winid) -> int
d55e5bfc
RD		 8289
8290 Get the id of the control following the one with the given
15817c7e 8291 autogenerated) id
d55e5bfc 8292 """
5b5c9bc7 8293 return _core_.Window_NextControlId(*args, **kwargs)
d55e5bfc
RD		 8294
8295 NextControlId = staticmethod(NextControlId)
8296 def PrevControlId(*args, **kwargs):
8297 """
d6c14a4c 8298 PrevControlId(int winid) -> int
d55e5bfc
RD		 8299
8300 Get the id of the control preceding the one with the given
15817c7e 8301 autogenerated) id
d55e5bfc 8302 """
5b5c9bc7 8303 return _core_.Window_PrevControlId(*args, **kwargs)
d55e5bfc
RD		 8304
8305 PrevControlId = staticmethod(PrevControlId)
ac5d357a
RD		 8306 def GetLayoutDirection(*args, **kwargs):
8307 """
994453b8 8308 GetLayoutDirection(self) -> int
ac5d357a
RD		 8309
8310 Get the layout direction (LTR or RTL) for this window. Returns
8311 ``wx.Layout_Default`` if layout direction is not supported.
8312 """
8313 return _core_.Window_GetLayoutDirection(*args, **kwargs)
8314
8315 def SetLayoutDirection(*args, **kwargs):
8316 """
994453b8 8317 SetLayoutDirection(self, int dir)
ac5d357a
RD		 8318
8319 Set the layout direction (LTR or RTL) for this window.
8320 """
8321 return _core_.Window_SetLayoutDirection(*args, **kwargs)
8322
8323 def AdjustForLayoutDirection(*args, **kwargs):
8324 """
8325 AdjustForLayoutDirection(self, int x, int width, int widthTotal) -> int
8326
8327 Mirror coordinates for RTL layout if this window uses it and if the
8328 mirroring is not done automatically like Win32.
8329 """
8330 return _core_.Window_AdjustForLayoutDirection(*args, **kwargs)
8331
d55e5bfc
RD		 8332 def SetSize(*args, **kwargs):
8333 """
5b5c9bc7 8334 SetSize(self, Size size)
d55e5bfc
RD		 8335
8336 Sets the size of the window in pixels.
8337 """
5b5c9bc7 8338 return _core_.Window_SetSize(*args, **kwargs)
d55e5bfc
RD		 8339
8340 def SetDimensions(*args, **kwargs):
8341 """
5b5c9bc7 8342 SetDimensions(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)
d55e5bfc
RD		 8343
8344 Sets the position and size of the window in pixels. The sizeFlags
8345 parameter indicates the interpretation of the other params if they are
62d32a5f
RD		 8346 equal to -1.
8347
8348 ======================== ======================================
8349 wx.SIZE_AUTO A -1 indicates that a class-specific
8350 default should be used.
8351 wx.SIZE_USE_EXISTING Axisting dimensions should be used if
8352 -1 values are supplied.
8353 wxSIZE_ALLOW_MINUS_ONE Allow dimensions of -1 and less to be
8354 interpreted as real dimensions, not
8355 default values.
8356 ======================== ======================================
8357
d55e5bfc 8358 """
5b5c9bc7 8359 return _core_.Window_SetDimensions(*args, **kwargs)
d55e5bfc
RD		 8360
8361 def SetRect(*args, **kwargs):
8362 """
5b5c9bc7 8363 SetRect(self, Rect rect, int sizeFlags=SIZE_AUTO)
d55e5bfc
RD		 8364
8365 Sets the position and size of the window in pixels using a wx.Rect.
8366 """
5b5c9bc7 8367 return _core_.Window_SetRect(*args, **kwargs)
d55e5bfc
RD		 8368
8369 def SetSizeWH(*args, **kwargs):
8370 """
8371 SetSizeWH(self, int width, int height)
8372
8373 Sets the size of the window in pixels.
8374 """
5b5c9bc7 8375 return _core_.Window_SetSizeWH(*args, **kwargs)
d55e5bfc
RD		 8376
8377 def Move(*args, **kwargs):
8378 """
5b5c9bc7 8379 Move(self, Point pt, int flags=SIZE_USE_EXISTING)
d55e5bfc
RD		 8380
8381 Moves the window to the given position.
8382 """
5b5c9bc7 8383 return _core_.Window_Move(*args, **kwargs)
d55e5bfc
RD		 8384
8385 SetPosition = Move
8386 def MoveXY(*args, **kwargs):
8387 """
5b5c9bc7 8388 MoveXY(self, int x, int y, int flags=SIZE_USE_EXISTING)
d55e5bfc
RD		 8389
8390 Moves the window to the given position.
8391 """
5b5c9bc7 8392 return _core_.Window_MoveXY(*args, **kwargs)
d55e5bfc 8393
580080c5 8394 def SetInitialSize(*args, **kwargs):
f8167d6e 8395 """
580080c5 8396 SetInitialSize(self, Size size=DefaultSize)
f8167d6e
RD		 8397
8398 A 'Smart' SetSize that will fill in default size components with the
8399 window's *best size* values. Also set's the minsize for use with sizers.
8400 """
580080c5 8401 return _core_.Window_SetInitialSize(*args, **kwargs)
f8167d6e 8402
580080c5 8403 SetBestFittingSize = wx._deprecated(SetInitialSize, 'Use `SetInitialSize`')
d55e5bfc
RD		 8404 def Raise(*args, **kwargs):
8405 """
8406 Raise(self)
8407
943e8dfd
RD		 8408 Raises the window to the top of the window hierarchy. In current
8409 version of wxWidgets this works both for manage and child windows.
d55e5bfc 8410 """
5b5c9bc7 8411 return _core_.Window_Raise(*args, **kwargs)
d55e5bfc
RD		 8412
8413 def Lower(*args, **kwargs):
8414 """
8415 Lower(self)
8416
943e8dfd
RD		 8417 Lowers the window to the bottom of the window hierarchy. In current
8418 version of wxWidgets this works both for manage and child windows.
d55e5bfc 8419 """
5b5c9bc7 8420 return _core_.Window_Lower(*args, **kwargs)
d55e5bfc
RD		 8421
8422 def SetClientSize(*args, **kwargs):
8423 """
5b5c9bc7 8424 SetClientSize(self, Size size)
d55e5bfc
RD		 8425
8426 This sets the size of the window client area in pixels. Using this
8427 function to size a window tends to be more device-independent than
8428 wx.Window.SetSize, since the application need not worry about what
8429 dimensions the border or title bar have when trying to fit the window
8430 around panel items, for example.
8431 """
5b5c9bc7 8432 return _core_.Window_SetClientSize(*args, **kwargs)
d55e5bfc
RD		 8433
8434 def SetClientSizeWH(*args, **kwargs):
8435 """
8436 SetClientSizeWH(self, int width, int height)
8437
8438 This sets the size of the window client area in pixels. Using this
8439 function to size a window tends to be more device-independent than
8440 wx.Window.SetSize, since the application need not worry about what
8441 dimensions the border or title bar have when trying to fit the window
8442 around panel items, for example.
8443 """
5b5c9bc7 8444 return _core_.Window_SetClientSizeWH(*args, **kwargs)
d55e5bfc
RD		 8445
8446 def SetClientRect(*args, **kwargs):
8447 """
5b5c9bc7 8448 SetClientRect(self, Rect rect)
d55e5bfc
RD		 8449
8450 This sets the size of the window client area in pixels. Using this
8451 function to size a window tends to be more device-independent than
8452 wx.Window.SetSize, since the application need not worry about what
8453 dimensions the border or title bar have when trying to fit the window
8454 around panel items, for example.
8455 """
5b5c9bc7 8456 return _core_.Window_SetClientRect(*args, **kwargs)
d55e5bfc
RD		 8457
8458 def GetPosition(*args, **kwargs):
8459 """
5b5c9bc7 8460 GetPosition(self) -> Point
d55e5bfc 8461
1c71765a
RD		 8462 Get the window's position. Notice that the position is in client
8463 coordinates for child windows and screen coordinates for the top level
8464 ones, use `GetScreenPosition` if you need screen coordinates for all
8465 kinds of windows.
d55e5bfc 8466 """
5b5c9bc7 8467 return _core_.Window_GetPosition(*args, **kwargs)
d55e5bfc
RD		 8468
8469 def GetPositionTuple(*args, **kwargs):
8470 """
8471 GetPositionTuple() -> (x,y)
8472
1c71765a
RD		 8473 Get the window's position. Notice that the position is in client
8474 coordinates for child windows and screen coordinates for the top level
8475 ones, use `GetScreenPosition` if you need screen coordinates for all
8476 kinds of windows.
d55e5bfc 8477 """
5b5c9bc7 8478 return _core_.Window_GetPositionTuple(*args, **kwargs)
d55e5bfc 8479
1c71765a
RD		 8480 def GetScreenPosition(*args, **kwargs):
8481 """
8482 GetScreenPosition(self) -> Point
8483
8484 Get the position of the window in screen coordinantes.
8485 """
8486 return _core_.Window_GetScreenPosition(*args, **kwargs)
8487
8488 def GetScreenPositionTuple(*args, **kwargs):
8489 """
8490 GetScreenPositionTuple() -> (x,y)
8491
8492 Get the position of the window in screen coordinantes.
8493 """
8494 return _core_.Window_GetScreenPositionTuple(*args, **kwargs)
8495
8496 def GetScreenRect(*args, **kwargs):
8497 """
8498 GetScreenRect(self) -> Rect
8499
8500 Returns the size and position of the window in screen coordinantes as
8501 a `wx.Rect` object.
8502 """
8503 return _core_.Window_GetScreenRect(*args, **kwargs)
8504
d55e5bfc
RD		 8505 def GetSize(*args, **kwargs):
8506 """
5b5c9bc7 8507 GetSize(self) -> Size
d55e5bfc
RD		 8508
8509 Get the window size.
8510 """
5b5c9bc7 8511 return _core_.Window_GetSize(*args, **kwargs)
d55e5bfc
RD		 8512
8513 def GetSizeTuple(*args, **kwargs):
8514 """
8515 GetSizeTuple() -> (width, height)
8516
8517 Get the window size.
8518 """
5b5c9bc7 8519 return _core_.Window_GetSizeTuple(*args, **kwargs)
d55e5bfc
RD		 8520
8521 def GetRect(*args, **kwargs):
8522 """
5b5c9bc7 8523 GetRect(self) -> Rect
d55e5bfc 8524
1c71765a 8525 Returns the size and position of the window as a `wx.Rect` object.
d55e5bfc 8526 """
5b5c9bc7 8527 return _core_.Window_GetRect(*args, **kwargs)
d55e5bfc
RD		 8528
8529 def GetClientSize(*args, **kwargs):
8530 """
5b5c9bc7 8531 GetClientSize(self) -> Size
d55e5bfc
RD		 8532
8533 This gets the size of the window's 'client area' in pixels. The client
8534 area is the area which may be drawn on by the programmer, excluding
8535 title bar, border, scrollbars, etc.
8536 """
5b5c9bc7 8537 return _core_.Window_GetClientSize(*args, **kwargs)
d55e5bfc
RD		 8538
8539 def GetClientSizeTuple(*args, **kwargs):
8540 """
8541 GetClientSizeTuple() -> (width, height)
8542
8543 This gets the size of the window's 'client area' in pixels. The client
8544 area is the area which may be drawn on by the programmer, excluding
8545 title bar, border, scrollbars, etc.
8546 """
5b5c9bc7 8547 return _core_.Window_GetClientSizeTuple(*args, **kwargs)
d55e5bfc
RD		 8548
8549 def GetClientAreaOrigin(*args, **kwargs):
8550 """
5b5c9bc7 8551 GetClientAreaOrigin(self) -> Point
d55e5bfc
RD		 8552
8553 Get the origin of the client area of the window relative to the
8554 window's top left corner (the client area may be shifted because of
8555 the borders, scrollbars, other decorations...)
8556 """
5b5c9bc7 8557 return _core_.Window_GetClientAreaOrigin(*args, **kwargs)
d55e5bfc
RD		 8558
8559 def GetClientRect(*args, **kwargs):
8560 """
5b5c9bc7 8561 GetClientRect(self) -> Rect
d55e5bfc 8562
0439c23b 8563 Get the client area position and size as a `wx.Rect` object.
d55e5bfc 8564 """
5b5c9bc7 8565 return _core_.Window_GetClientRect(*args, **kwargs)
d55e5bfc
RD		 8566
8567 def GetBestSize(*args, **kwargs):
8568 """
5b5c9bc7 8569 GetBestSize(self) -> Size
d55e5bfc 8570
bfddbb17 8571 This function returns the best acceptable minimal size for the
15817c7e
RD		 8572 window, if applicable. For example, for a static text control, it will
8573 be the minimal size such that the control label is not truncated. For
8574 windows containing subwindows (suzh aswx.Panel), the size returned by
8575 this function will be the same as the size the window would have had
8576 after calling Fit.
d55e5bfc 8577 """
5b5c9bc7 8578 return _core_.Window_GetBestSize(*args, **kwargs)
d55e5bfc
RD		 8579
8580 def GetBestSizeTuple(*args, **kwargs):
8581 """
8582 GetBestSizeTuple() -> (width, height)
8583
bfddbb17 8584 This function returns the best acceptable minimal size for the
15817c7e
RD		 8585 window, if applicable. For example, for a static text control, it will
8586 be the minimal size such that the control label is not truncated. For
8587 windows containing subwindows (suzh aswx.Panel), the size returned by
8588 this function will be the same as the size the window would have had
8589 after calling Fit.
d55e5bfc 8590 """
5b5c9bc7 8591 return _core_.Window_GetBestSizeTuple(*args, **kwargs)
d55e5bfc 8592
a001823c
RD		 8593 def InvalidateBestSize(*args, **kwargs):
8594 """
8595 InvalidateBestSize(self)
8596
8597 Reset the cached best size value so it will be recalculated the next
8598 time it is needed.
8599 """
5b5c9bc7 8600 return _core_.Window_InvalidateBestSize(*args, **kwargs)
a001823c 8601
e2813725
RD		 8602 def CacheBestSize(*args, **kwargs):
8603 """
8604 CacheBestSize(self, Size size)
8605
8606 Cache the best size so it doesn't need to be calculated again, (at least until
8607 some properties of the window change.)
8608 """
8609 return _core_.Window_CacheBestSize(*args, **kwargs)
8610
580080c5 8611 def GetEffectiveMinSize(*args, **kwargs):
a001823c 8612 """
580080c5 8613 GetEffectiveMinSize(self) -> Size
a001823c
RD		 8614
8615 This function will merge the window's best size into the window's
8616 minimum size, giving priority to the min size components, and returns
8617 the results.
8618
8619 """
580080c5 8620 return _core_.Window_GetEffectiveMinSize(*args, **kwargs)
a001823c 8621
580080c5 8622 GetBestFittingSize = wx._deprecated(GetEffectiveMinSize, , 'Use `GetEffectiveMinSize` instead.')
8f514ab4
RD		 8623 def GetAdjustedBestSize(self):
8624 s = self.GetBestSize()
8625 return wx.Size(max(s.width, self.GetMinWidth()),
8626 max(s.height, self.GetMinHeight()))
580080c5 8627 GetAdjustedBestSize = wx._deprecated(GetAdjustedBestSize, 'Use `GetEffectiveMinSize` instead.')
d55e5bfc
RD		 8628
8629 def Center(*args, **kwargs):
8630 """
5b5c9bc7 8631 Center(self, int direction=BOTH)
d55e5bfc
RD		 8632
8633 Centers the window. The parameter specifies the direction for
8634 cetering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may
8635 also include wx.CENTER_ON_SCREEN flag if you want to center the window
8636 on the entire screen and not on its parent window. If it is a
8637 top-level window and has no parent then it will always be centered
8638 relative to the screen.
8639 """
5b5c9bc7 8640 return _core_.Window_Center(*args, **kwargs)
d55e5bfc
RD		 8641
8642 Centre = Center
d55e5bfc
RD		 8643 def CenterOnParent(*args, **kwargs):
8644 """
5b5c9bc7 8645 CenterOnParent(self, int dir=BOTH)
d55e5bfc
RD		 8646
8647 Center with respect to the the parent window
8648 """
5b5c9bc7 8649 return _core_.Window_CenterOnParent(*args, **kwargs)
d55e5bfc
RD		 8650
8651 CentreOnParent = CenterOnParent
8652 def Fit(*args, **kwargs):
8653 """
8654 Fit(self)
8655
8656 Sizes the window so that it fits around its subwindows. This function
8657 won't do anything if there are no subwindows and will only really work
8658 correctly if sizers are used for the subwindows layout. Also, if the
8659 window has exactly one subwindow it is better (faster and the result
8660 is more precise as Fit adds some margin to account for fuzziness of
8661 its calculations) to call window.SetClientSize(child.GetSize())
8662 instead of calling Fit.
8663 """
5b5c9bc7 8664 return _core_.Window_Fit(*args, **kwargs)
d55e5bfc
RD		 8665
8666 def FitInside(*args, **kwargs):
8667 """
8668 FitInside(self)
8669
8670 Similar to Fit, but sizes the interior (virtual) size of a
8671 window. Mainly useful with scrolled windows to reset scrollbars after
8672 sizing changes that do not trigger a size event, and/or scrolled
8673 windows without an interior sizer. This function similarly won't do
8674 anything if there are no subwindows.
8675 """
5b5c9bc7 8676 return _core_.Window_FitInside(*args, **kwargs)
d55e5bfc 8677
03837c5c 8678 def SetSizeHints(*args, **kwargs):
d55e5bfc
RD		 8679 """
8680 SetSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1,
8681 int incH=-1)
d55e5bfc
RD		 8682
8683 Allows specification of minimum and maximum window sizes, and window
8684 size increments. If a pair of values is not set (or set to -1), the
8685 default values will be used. If this function is called, the user
908b74cd
RD		 8686 will not be able to size the window outside the given bounds (if it is
8687 a top-level window.) Sizers will also inspect the minimum window size
8688 and will use that value if set when calculating layout.
8689
8690 The resizing increments are only significant under Motif or Xt.
d55e5bfc 8691 """
5b5c9bc7 8692 return _core_.Window_SetSizeHints(*args, **kwargs)
d55e5bfc 8693
03837c5c
RD		 8694 def SetSizeHintsSz(*args, **kwargs):
8695 """
5b5c9bc7 8696 SetSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize, Size incSize=DefaultSize)
03837c5c
RD		 8697
8698 Allows specification of minimum and maximum window sizes, and window
8699 size increments. If a pair of values is not set (or set to -1), the
8700 default values will be used. If this function is called, the user
8701 will not be able to size the window outside the given bounds (if it is
8702 a top-level window.) Sizers will also inspect the minimum window size
8703 and will use that value if set when calculating layout.
8704
8705 The resizing increments are only significant under Motif or Xt.
8706 """
5b5c9bc7 8707 return _core_.Window_SetSizeHintsSz(*args, **kwargs)
03837c5c
RD		 8708
8709 def SetVirtualSizeHints(*args, **kwargs):
d55e5bfc 8710 """
908b74cd 8711 SetVirtualSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1)
d55e5bfc
RD		 8712
8713 Allows specification of minimum and maximum virtual window sizes. If a
8714 pair of values is not set (or set to -1), the default values will be
8715 used. If this function is called, the user will not be able to size
8716 the virtual area of the window outside the given bounds.
8717 """
5b5c9bc7 8718 return _core_.Window_SetVirtualSizeHints(*args, **kwargs)
03837c5c
RD		 8719
8720 def SetVirtualSizeHintsSz(*args, **kwargs):
8721 """
5b5c9bc7 8722 SetVirtualSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize)
03837c5c
RD		 8723
8724 Allows specification of minimum and maximum virtual window sizes. If a
8725 pair of values is not set (or set to -1), the default values will be
8726 used. If this function is called, the user will not be able to size
8727 the virtual area of the window outside the given bounds.
8728 """
5b5c9bc7 8729 return _core_.Window_SetVirtualSizeHintsSz(*args, **kwargs)
d55e5bfc 8730
908b74cd 8731 def GetMaxSize(*args, **kwargs):
5b5c9bc7
RD		 8732 """GetMaxSize(self) -> Size"""
8733 return _core_.Window_GetMaxSize(*args, **kwargs)
908b74cd
RD		 8734
8735 def GetMinSize(*args, **kwargs):
5b5c9bc7
RD		 8736 """GetMinSize(self) -> Size"""
8737 return _core_.Window_GetMinSize(*args, **kwargs)
908b74cd
RD		 8738
8739 def SetMinSize(*args, **kwargs):
8740 """
5b5c9bc7 8741 SetMinSize(self, Size minSize)
908b74cd
RD		 8742
8743 A more convenient method than `SetSizeHints` for setting just the
8744 min size.
8745 """
5b5c9bc7 8746 return _core_.Window_SetMinSize(*args, **kwargs)
908b74cd
RD		 8747
8748 def SetMaxSize(*args, **kwargs):
8749 """
5b5c9bc7 8750 SetMaxSize(self, Size maxSize)
908b74cd
RD		 8751
8752 A more convenient method than `SetSizeHints` for setting just the
8753 max size.
8754 """
5b5c9bc7 8755 return _core_.Window_SetMaxSize(*args, **kwargs)
908b74cd 8756
d55e5bfc
RD		 8757 def GetMinWidth(*args, **kwargs):
8758 """GetMinWidth(self) -> int"""
5b5c9bc7 8759 return _core_.Window_GetMinWidth(*args, **kwargs)
d55e5bfc
RD		 8760
8761 def GetMinHeight(*args, **kwargs):
8762 """GetMinHeight(self) -> int"""
5b5c9bc7 8763 return _core_.Window_GetMinHeight(*args, **kwargs)
d55e5bfc
RD		 8764
8765 def GetMaxWidth(*args, **kwargs):
8766 """GetMaxWidth(self) -> int"""
5b5c9bc7 8767 return _core_.Window_GetMaxWidth(*args, **kwargs)
d55e5bfc
RD		 8768
8769 def GetMaxHeight(*args, **kwargs):
8770 """GetMaxHeight(self) -> int"""
5b5c9bc7 8771 return _core_.Window_GetMaxHeight(*args, **kwargs)
d55e5bfc 8772
d55e5bfc
RD		 8773 def SetVirtualSize(*args, **kwargs):
8774 """
5b5c9bc7 8775 SetVirtualSize(self, Size size)
d55e5bfc
RD		 8776
8777 Set the the virtual size of a window in pixels. For most windows this
8778 is just the client area of the window, but for some like scrolled
8779 windows it is more or less independent of the screen window size.
8780 """
5b5c9bc7 8781 return _core_.Window_SetVirtualSize(*args, **kwargs)
d55e5bfc
RD		 8782
8783 def SetVirtualSizeWH(*args, **kwargs):
8784 """
8785 SetVirtualSizeWH(self, int w, int h)
8786
8787 Set the the virtual size of a window in pixels. For most windows this
8788 is just the client area of the window, but for some like scrolled
8789 windows it is more or less independent of the screen window size.
8790 """
5b5c9bc7 8791 return _core_.Window_SetVirtualSizeWH(*args, **kwargs)
d55e5bfc
RD		 8792
8793 def GetVirtualSize(*args, **kwargs):
8794 """
5b5c9bc7 8795 GetVirtualSize(self) -> Size
d55e5bfc
RD		 8796
8797 Get the the virtual size of the window in pixels. For most windows
8798 this is just the client area of the window, but for some like scrolled
8799 windows it is more or less independent of the screen window size.
8800 """
5b5c9bc7 8801 return _core_.Window_GetVirtualSize(*args, **kwargs)
d55e5bfc
RD		 8802
8803 def GetVirtualSizeTuple(*args, **kwargs):
8804 """
8805 GetVirtualSizeTuple() -> (width, height)
8806
8807 Get the the virtual size of the window in pixels. For most windows
8808 this is just the client area of the window, but for some like scrolled
8809 windows it is more or less independent of the screen window size.
8810 """
5b5c9bc7 8811 return _core_.Window_GetVirtualSizeTuple(*args, **kwargs)
d55e5bfc
RD		 8812
8813 def GetBestVirtualSize(*args, **kwargs):
8814 """
5b5c9bc7 8815 GetBestVirtualSize(self) -> Size
d55e5bfc
RD		 8816
8817 Return the largest of ClientSize and BestSize (as determined by a
8818 sizer, interior children, or other means)
8819 """
5b5c9bc7 8820 return _core_.Window_GetBestVirtualSize(*args, **kwargs)
d55e5bfc
RD		 8821
8822 def Show(*args, **kwargs):
8823 """
8824 Show(self, bool show=True) -> bool
8825
8826 Shows or hides the window. You may need to call Raise for a top level
8827 window if you want to bring it to top, although this is not needed if
8828 Show is called immediately after the frame creation. Returns True if
8829 the window has been shown or hidden or False if nothing was done
8830 because it already was in the requested state.
8831 """
5b5c9bc7 8832 return _core_.Window_Show(*args, **kwargs)
d55e5bfc
RD		 8833
8834 def Hide(*args, **kwargs):
8835 """
8836 Hide(self) -> bool
8837
8838 Equivalent to calling Show(False).
8839 """
5b5c9bc7 8840 return _core_.Window_Hide(*args, **kwargs)
d55e5bfc
RD		 8841
8842 def Enable(*args, **kwargs):
8843 """
8844 Enable(self, bool enable=True) -> bool
8845
8846 Enable or disable the window for user input. Note that when a parent
8847 window is disabled, all of its children are disabled as well and they
8848 are reenabled again when the parent is. Returns true if the window
8849 has been enabled or disabled, false if nothing was done, i.e. if the
8850 window had already been in the specified state.
8851 """
5b5c9bc7 8852 return _core_.Window_Enable(*args, **kwargs)
d55e5bfc
RD		 8853
8854 def Disable(*args, **kwargs):
8855 """
8856 Disable(self) -> bool
8857
8858 Disables the window, same as Enable(false).
8859 """
5b5c9bc7 8860 return _core_.Window_Disable(*args, **kwargs)
d55e5bfc
RD		 8861
8862 def IsShown(*args, **kwargs):
8863 """
8864 IsShown(self) -> bool
8865
8866 Returns true if the window is shown, false if it has been hidden.
8867 """
5b5c9bc7 8868 return _core_.Window_IsShown(*args, **kwargs)
d55e5bfc
RD		 8869
8870 def IsEnabled(*args, **kwargs):
8871 """
8872 IsEnabled(self) -> bool
8873
8874 Returns true if the window is enabled for input, false otherwise.
8875 """
5b5c9bc7 8876 return _core_.Window_IsEnabled(*args, **kwargs)
d55e5bfc 8877
33d6fd3b
RD		 8878 def IsShownOnScreen(*args, **kwargs):
8879 """
8880 IsShownOnScreen(self) -> bool
8881
8882 Returns ``True`` if the window is physically visible on the screen,
8883 i.e. it is shown and all its parents up to the toplevel window are
8884 shown as well.
8885 """
8886 return _core_.Window_IsShownOnScreen(*args, **kwargs)
8887
d55e5bfc
RD		 8888 def SetWindowStyleFlag(*args, **kwargs):
8889 """
8890 SetWindowStyleFlag(self, long style)
8891
15817c7e
RD		 8892 Sets the style of the window. Please note that some styles cannot be
8893 changed after the window creation and that Refresh() might need to be
8894 called after changing the others for the change to take place
8895 immediately.
d55e5bfc 8896 """
5b5c9bc7 8897 return _core_.Window_SetWindowStyleFlag(*args, **kwargs)
d55e5bfc
RD		 8898
8899 def GetWindowStyleFlag(*args, **kwargs):
8900 """
8901 GetWindowStyleFlag(self) -> long
8902
8903 Gets the window style that was passed to the constructor or Create
8904 method.
8905 """
5b5c9bc7 8906 return _core_.Window_GetWindowStyleFlag(*args, **kwargs)
d55e5bfc
RD		 8907
8908 SetWindowStyle = SetWindowStyleFlag; GetWindowStyle = GetWindowStyleFlag
8909 def HasFlag(*args, **kwargs):
8910 """
8911 HasFlag(self, int flag) -> bool
8912
8913 Test if the given style is set for this window.
8914 """
5b5c9bc7 8915 return _core_.Window_HasFlag(*args, **kwargs)
d55e5bfc
RD		 8916
8917 def IsRetained(*args, **kwargs):
8918 """
8919 IsRetained(self) -> bool
8920
8921 Returns true if the window is retained, false otherwise. Retained
8922 windows are only available on X platforms.
8923 """
5b5c9bc7 8924 return _core_.Window_IsRetained(*args, **kwargs)
d55e5bfc
RD		 8925
8926 def SetExtraStyle(*args, **kwargs):
8927 """
8928 SetExtraStyle(self, long exStyle)
8929
8930 Sets the extra style bits for the window. Extra styles are the less
8931 often used style bits which can't be set with the constructor or with
8932 SetWindowStyleFlag()
8933 """
5b5c9bc7 8934 return _core_.Window_SetExtraStyle(*args, **kwargs)
d55e5bfc
RD		 8935
8936 def GetExtraStyle(*args, **kwargs):
8937 """
8938 GetExtraStyle(self) -> long
8939
8940 Returns the extra style bits for the window.
8941 """
5b5c9bc7 8942 return _core_.Window_GetExtraStyle(*args, **kwargs)
d55e5bfc
RD		 8943
8944 def MakeModal(*args, **kwargs):
8945 """
8946 MakeModal(self, bool modal=True)
8947
8948 Disables all other windows in the application so that the user can
8949 only interact with this window. Passing False will reverse this
8950 effect.
8951 """
5b5c9bc7 8952 return _core_.Window_MakeModal(*args, **kwargs)
d55e5bfc
RD		 8953
8954 def SetThemeEnabled(*args, **kwargs):
8955 """
8956 SetThemeEnabled(self, bool enableTheme)
8957
8958 This function tells a window if it should use the system's "theme"
8959 code to draw the windows' background instead if its own background
8960 drawing code. This will only have an effect on platforms that support
8961 the notion of themes in user defined windows. One such platform is
8962 GTK+ where windows can have (very colourful) backgrounds defined by a
8963 user's selected theme.
8964
8965 Dialogs, notebook pages and the status bar have this flag set to true
8966 by default so that the default look and feel is simulated best.
8967 """
5b5c9bc7 8968 return _core_.Window_SetThemeEnabled(*args, **kwargs)
d55e5bfc
RD		 8969
8970 def GetThemeEnabled(*args, **kwargs):
8971 """
8972 GetThemeEnabled(self) -> bool
8973
8974 Return the themeEnabled flag.
8975 """
5b5c9bc7 8976 return _core_.Window_GetThemeEnabled(*args, **kwargs)
d55e5bfc
RD		 8977
8978 def SetFocus(*args, **kwargs):
8979 """
8980 SetFocus(self)
8981
8982 Set's the focus to this window, allowing it to receive keyboard input.
8983 """
5b5c9bc7 8984 return _core_.Window_SetFocus(*args, **kwargs)
d55e5bfc
RD		 8985
8986 def SetFocusFromKbd(*args, **kwargs):
8987 """
8988 SetFocusFromKbd(self)
8989
8990 Set focus to this window as the result of a keyboard action. Normally
8991 only called internally.
8992 """
5b5c9bc7 8993 return _core_.Window_SetFocusFromKbd(*args, **kwargs)
d55e5bfc
RD		 8994
8995 def FindFocus(*args, **kwargs):
8996 """
5b5c9bc7 8997 FindFocus() -> Window
d55e5bfc
RD		 8998
8999 Returns the window or control that currently has the keyboard focus,
9000 or None.
9001 """
5b5c9bc7 9002 return _core_.Window_FindFocus(*args, **kwargs)
d55e5bfc
RD		 9003
9004 FindFocus = staticmethod(FindFocus)
9005 def AcceptsFocus(*args, **kwargs):
9006 """
9007 AcceptsFocus(self) -> bool
9008
9009 Can this window have focus?
9010 """
5b5c9bc7 9011 return _core_.Window_AcceptsFocus(*args, **kwargs)
d55e5bfc
RD		 9012
9013 def AcceptsFocusFromKeyboard(*args, **kwargs):
9014 """
9015 AcceptsFocusFromKeyboard(self) -> bool
9016
9017 Can this window be given focus by keyboard navigation? if not, the
9018 only way to give it focus (provided it accepts it at all) is to click
9019 it.
9020 """
5b5c9bc7 9021 return _core_.Window_AcceptsFocusFromKeyboard(*args, **kwargs)
d55e5bfc 9022
908b74cd
RD		 9023 def Navigate(*args, **kwargs):
9024 """
9025 Navigate(self, int flags=NavigationKeyEvent.IsForward) -> bool
9026
fd2dc343
RD		 9027 Does keyboard navigation from this window to another, by sending a
9028 `wx.NavigationKeyEvent`.
908b74cd 9029 """
5b5c9bc7 9030 return _core_.Window_Navigate(*args, **kwargs)
908b74cd 9031
bf26d883
RD		 9032 def MoveAfterInTabOrder(*args, **kwargs):
9033 """
5b5c9bc7 9034 MoveAfterInTabOrder(self, Window win)
bf26d883
RD		 9035
9036 Moves this window in the tab navigation order after the specified
9037 sibling window. This means that when the user presses the TAB key on
9038 that other window, the focus switches to this window.
9039
9040 The default tab order is the same as creation order. This function
9041 and `MoveBeforeInTabOrder` allow to change it after creating all the
9042 windows.
9043
9044 """
5b5c9bc7 9045 return _core_.Window_MoveAfterInTabOrder(*args, **kwargs)
bf26d883
RD		 9046
9047 def MoveBeforeInTabOrder(*args, **kwargs):
9048 """
5b5c9bc7 9049 MoveBeforeInTabOrder(self, Window win)
bf26d883
RD		 9050
9051 Same as `MoveAfterInTabOrder` except that it inserts this window just
9052 before win instead of putting it right after it.
9053 """
5b5c9bc7 9054 return _core_.Window_MoveBeforeInTabOrder(*args, **kwargs)
bf26d883 9055
d55e5bfc
RD		 9056 def GetChildren(*args, **kwargs):
9057 """
9058 GetChildren(self) -> PyObject
9059
9060 Returns a list of the window's children. NOTE: Currently this is a
9061 copy of the child window list maintained by the window, so the return
9062 value of this function is only valid as long as the window's children
9063 do not change.
9064 """
5b5c9bc7 9065 return _core_.Window_GetChildren(*args, **kwargs)
d55e5bfc
RD		 9066
9067 def GetParent(*args, **kwargs):
9068 """
5b5c9bc7 9069 GetParent(self) -> Window
d55e5bfc
RD		 9070
9071 Returns the parent window of this window, or None if there isn't one.
9072 """
5b5c9bc7 9073 return _core_.Window_GetParent(*args, **kwargs)
d55e5bfc
RD		 9074
9075 def GetGrandParent(*args, **kwargs):
9076 """
5b5c9bc7 9077 GetGrandParent(self) -> Window
d55e5bfc 9078
15817c7e
RD		 9079 Returns the parent of the parent of this window, or None if there
9080 isn't one.
d55e5bfc 9081 """
5b5c9bc7 9082 return _core_.Window_GetGrandParent(*args, **kwargs)
d55e5bfc
RD		 9083
9084 def IsTopLevel(*args, **kwargs):
9085 """
9086 IsTopLevel(self) -> bool
9087
9088 Returns true if the given window is a top-level one. Currently all
9089 frames and dialogs are always considered to be top-level windows (even
9090 if they have a parent window).
9091 """
5b5c9bc7 9092 return _core_.Window_IsTopLevel(*args, **kwargs)
d55e5bfc
RD		 9093
9094 def Reparent(*args, **kwargs):
9095 """
5b5c9bc7 9096 Reparent(self, Window newParent) -> bool
d55e5bfc
RD		 9097
9098 Reparents the window, i.e the window will be removed from its current
9099 parent window (e.g. a non-standard toolbar in a wxFrame) and then
9100 re-inserted into another. Available on Windows and GTK. Returns True
9101 if the parent was changed, False otherwise (error or newParent ==
9102 oldParent)
9103 """
5b5c9bc7 9104 return _core_.Window_Reparent(*args, **kwargs)
d55e5bfc
RD		 9105
9106 def AddChild(*args, **kwargs):
9107 """
5b5c9bc7 9108 AddChild(self, Window child)
d55e5bfc
RD		 9109
9110 Adds a child window. This is called automatically by window creation
9111 functions so should not be required by the application programmer.
9112 """
5b5c9bc7 9113 return _core_.Window_AddChild(*args, **kwargs)
d55e5bfc
RD		 9114
9115 def RemoveChild(*args, **kwargs):
9116 """
5b5c9bc7 9117 RemoveChild(self, Window child)
d55e5bfc
RD		 9118
9119 Removes a child window. This is called automatically by window
9120 deletion functions so should not be required by the application
9121 programmer.
9122 """
5b5c9bc7 9123 return _core_.Window_RemoveChild(*args, **kwargs)
d55e5bfc 9124
704eda0c
RD		 9125 def SetDoubleBuffered(*args, **kwargs):
9126 """
9127 SetDoubleBuffered(self, bool on)
9128
9129 Currently wxGTK2 only.
9130 """
9131 return _core_.Window_SetDoubleBuffered(*args, **kwargs)
9132
d55e5bfc
RD		 9133 def FindWindowById(*args, **kwargs):
9134 """
5b5c9bc7 9135 FindWindowById(self, long winid) -> Window
d55e5bfc
RD		 9136
9137 Find a chld of this window by window ID
9138 """
5b5c9bc7 9139 return _core_.Window_FindWindowById(*args, **kwargs)
d55e5bfc
RD		 9140
9141 def FindWindowByName(*args, **kwargs):
9142 """
5b5c9bc7 9143 FindWindowByName(self, String name) -> Window
d55e5bfc
RD		 9144
9145 Find a child of this window by name
9146 """
5b5c9bc7 9147 return _core_.Window_FindWindowByName(*args, **kwargs)
d55e5bfc
RD		 9148
9149 def GetEventHandler(*args, **kwargs):
9150 """
5b5c9bc7 9151 GetEventHandler(self) -> EvtHandler
d55e5bfc
RD		 9152
9153 Returns the event handler for this window. By default, the window is
9154 its own event handler.
9155 """
5b5c9bc7 9156 return _core_.Window_GetEventHandler(*args, **kwargs)
d55e5bfc
RD		 9157
9158 def SetEventHandler(*args, **kwargs):
9159 """
5b5c9bc7 9160 SetEventHandler(self, EvtHandler handler)
d55e5bfc
RD		 9161
9162 Sets the event handler for this window. An event handler is an object
d49bdf34
RD		 9163 that is capable of processing the events sent to a window. (In other
9164 words, is able to dispatch the events to handler function.) By
9165 default, the window is its own event handler, but an application may
9166 wish to substitute another, for example to allow central
9167 implementation of event-handling for a variety of different window
9168 classes.
d55e5bfc 9169
15817c7e 9170 It is usually better to use `wx.Window.PushEventHandler` since this sets
d55e5bfc 9171 up a chain of event handlers, where an event not handled by one event
d49bdf34 9172 handler is handed off to the next one in the chain.
d55e5bfc 9173 """
5b5c9bc7 9174 return _core_.Window_SetEventHandler(*args, **kwargs)
d55e5bfc
RD		 9175
9176 def PushEventHandler(*args, **kwargs):
9177 """
5b5c9bc7 9178 PushEventHandler(self, EvtHandler handler)
d55e5bfc
RD		 9179
9180 Pushes this event handler onto the event handler stack for the window.
9181 An event handler is an object that is capable of processing the events
d49bdf34
RD		 9182 sent to a window. (In other words, is able to dispatch the events to
9183 handler function.) By default, the window is its own event handler,
9184 but an application may wish to substitute another, for example to
9185 allow central implementation of event-handling for a variety of
9186 different window classes.
d55e5bfc
RD		 9187
9188 wx.Window.PushEventHandler allows an application to set up a chain of
9189 event handlers, where an event not handled by one event handler is
d49bdf34
RD		 9190 handed to the next one in the chain. Use `wx.Window.PopEventHandler`
9191 to remove the event handler. Ownership of the handler is *not* given
9192 to the window, so you should be sure to pop the handler before the
9193 window is destroyed and either let PopEventHandler destroy it, or call
9194 its Destroy method yourself.
d55e5bfc 9195 """
5b5c9bc7 9196 return _core_.Window_PushEventHandler(*args, **kwargs)
d55e5bfc
RD		 9197
9198 def PopEventHandler(*args, **kwargs):
9199 """
5b5c9bc7 9200 PopEventHandler(self, bool deleteHandler=False) -> EvtHandler
d55e5bfc
RD		 9201
9202 Removes and returns the top-most event handler on the event handler
9203 stack. If deleteHandler is True then the wx.EvtHandler object will be
d49bdf34 9204 destroyed after it is popped, and ``None`` will be returned instead.
d55e5bfc 9205 """
5b5c9bc7 9206 return _core_.Window_PopEventHandler(*args, **kwargs)
d55e5bfc
RD		 9207
9208 def RemoveEventHandler(*args, **kwargs):
9209 """
5b5c9bc7 9210 RemoveEventHandler(self, EvtHandler handler) -> bool
d55e5bfc 9211
15817c7e 9212 Find the given handler in the event handler chain and remove (but not
d49bdf34 9213 delete) it from the event handler chain, returns True if it was found
15817c7e
RD		 9214 and False otherwise (this also results in an assert failure so this
9215 function should only be called when the handler is supposed to be
9216 there.)
d55e5bfc 9217 """
5b5c9bc7 9218 return _core_.Window_RemoveEventHandler(*args, **kwargs)
d55e5bfc
RD		 9219
9220 def SetValidator(*args, **kwargs):
9221 """
5b5c9bc7 9222 SetValidator(self, Validator validator)
d55e5bfc
RD		 9223
9224 Deletes the current validator (if any) and sets the window validator,
9225 having called wx.Validator.Clone to create a new validator of this
9226 type.
9227 """
5b5c9bc7 9228 return _core_.Window_SetValidator(*args, **kwargs)
d55e5bfc
RD		 9229
9230 def GetValidator(*args, **kwargs):
9231 """
5b5c9bc7 9232 GetValidator(self) -> Validator
d55e5bfc
RD		 9233
9234 Returns a pointer to the current validator for the window, or None if
9235 there is none.
9236 """
5b5c9bc7 9237 return _core_.Window_GetValidator(*args, **kwargs)
d55e5bfc
RD		 9238
9239 def Validate(*args, **kwargs):
9240 """
9241 Validate(self) -> bool
9242
9243 Validates the current values of the child controls using their
15817c7e
RD		 9244 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
9245 style flag set, the method will also call Validate() of all child
9246 windows. Returns false if any of the validations failed.
d55e5bfc 9247 """
5b5c9bc7 9248 return _core_.Window_Validate(*args, **kwargs)
d55e5bfc
RD		 9249
9250 def TransferDataToWindow(*args, **kwargs):
9251 """
9252 TransferDataToWindow(self) -> bool
9253
15817c7e
RD		 9254 Transfers values to child controls from data areas specified by their
9255 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
9256 style flag set, the method will also call TransferDataToWindow() of
9257 all child windows.
d55e5bfc 9258 """
5b5c9bc7 9259 return _core_.Window_TransferDataToWindow(*args, **kwargs)
d55e5bfc
RD		 9260
9261 def TransferDataFromWindow(*args, **kwargs):
9262 """
9263 TransferDataFromWindow(self) -> bool
9264
15817c7e
RD		 9265 Transfers values from child controls to data areas specified by their
9266 validators. Returns false if a transfer failed. If the window has
9267 wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will
9268 also call TransferDataFromWindow() of all child windows.
d55e5bfc 9269 """
5b5c9bc7 9270 return _core_.Window_TransferDataFromWindow(*args, **kwargs)
d55e5bfc
RD		 9271
9272 def InitDialog(*args, **kwargs):
9273 """
9274 InitDialog(self)
9275
15817c7e
RD		 9276 Sends an EVT_INIT_DIALOG event, whose handler usually transfers data
9277 to the dialog via validators.
d55e5bfc 9278 """
5b5c9bc7 9279 return _core_.Window_InitDialog(*args, **kwargs)
d55e5bfc
RD		 9280
9281 def SetAcceleratorTable(*args, **kwargs):
9282 """
5b5c9bc7 9283 SetAcceleratorTable(self, AcceleratorTable accel)
d55e5bfc
RD		 9284
9285 Sets the accelerator table for this window.
9286 """
5b5c9bc7 9287 return _core_.Window_SetAcceleratorTable(*args, **kwargs)
d55e5bfc
RD		 9288
9289 def GetAcceleratorTable(*args, **kwargs):
9290 """
5b5c9bc7 9291 GetAcceleratorTable(self) -> AcceleratorTable
d55e5bfc
RD		 9292
9293 Gets the accelerator table for this window.
9294 """
5b5c9bc7 9295 return _core_.Window_GetAcceleratorTable(*args, **kwargs)
d55e5bfc
RD		 9296
9297 def RegisterHotKey(*args, **kwargs):
9298 """
9299 RegisterHotKey(self, int hotkeyId, int modifiers, int keycode) -> bool
9300
9301 Registers a system wide hotkey. Every time the user presses the hotkey
9302 registered here, this window will receive a hotkey event. It will
9303 receive the event even if the application is in the background and
9304 does not have the input focus because the user is working with some
9305 other application. To bind an event handler function to this hotkey
9306 use EVT_HOTKEY with an id equal to hotkeyId. Returns True if the
9307 hotkey was registered successfully.
9308 """
5b5c9bc7 9309 return _core_.Window_RegisterHotKey(*args, **kwargs)
d55e5bfc
RD		 9310
9311 def UnregisterHotKey(*args, **kwargs):
9312 """
9313 UnregisterHotKey(self, int hotkeyId) -> bool
9314
9315 Unregisters a system wide hotkey.
9316 """
5b5c9bc7 9317 return _core_.Window_UnregisterHotKey(*args, **kwargs)
d55e5bfc
RD		 9318
9319 def ConvertDialogPointToPixels(*args, **kwargs):
9320 """
5b5c9bc7 9321 ConvertDialogPointToPixels(self, Point pt) -> Point
d55e5bfc
RD		 9322
9323 Converts a point or size from dialog units to pixels. Dialog units
9324 are used for maintaining a dialog's proportions even if the font
9325 changes. For the x dimension, the dialog units are multiplied by the
9326 average character width and then divided by 4. For the y dimension,
9327 the dialog units are multiplied by the average character height and
9328 then divided by 8.
9329 """
5b5c9bc7 9330 return _core_.Window_ConvertDialogPointToPixels(*args, **kwargs)
d55e5bfc
RD		 9331
9332 def ConvertDialogSizeToPixels(*args, **kwargs):
9333 """
5b5c9bc7 9334 ConvertDialogSizeToPixels(self, Size sz) -> Size
d55e5bfc
RD		 9335
9336 Converts a point or size from dialog units to pixels. Dialog units
9337 are used for maintaining a dialog's proportions even if the font
9338 changes. For the x dimension, the dialog units are multiplied by the
9339 average character width and then divided by 4. For the y dimension,
9340 the dialog units are multiplied by the average character height and
9341 then divided by 8.
9342 """
5b5c9bc7 9343 return _core_.Window_ConvertDialogSizeToPixels(*args, **kwargs)
d55e5bfc
RD		 9344
9345 def DLG_PNT(*args, **kwargs):
9346 """
5b5c9bc7 9347 DLG_PNT(self, Point pt) -> Point
d55e5bfc
RD		 9348
9349 Converts a point or size from dialog units to pixels. Dialog units
9350 are used for maintaining a dialog's proportions even if the font
9351 changes. For the x dimension, the dialog units are multiplied by the
9352 average character width and then divided by 4. For the y dimension,
9353 the dialog units are multiplied by the average character height and
9354 then divided by 8.
9355 """
5b5c9bc7 9356 return _core_.Window_DLG_PNT(*args, **kwargs)
d55e5bfc
RD		 9357
9358 def DLG_SZE(*args, **kwargs):
9359 """
5b5c9bc7 9360 DLG_SZE(self, Size sz) -> Size
d55e5bfc
RD		 9361
9362 Converts a point or size from dialog units to pixels. Dialog units
9363 are used for maintaining a dialog's proportions even if the font
9364 changes. For the x dimension, the dialog units are multiplied by the
9365 average character width and then divided by 4. For the y dimension,
9366 the dialog units are multiplied by the average character height and
9367 then divided by 8.
9368 """
5b5c9bc7 9369 return _core_.Window_DLG_SZE(*args, **kwargs)
d55e5bfc
RD		 9370
9371 def ConvertPixelPointToDialog(*args, **kwargs):
5b5c9bc7
RD		 9372 """ConvertPixelPointToDialog(self, Point pt) -> Point"""
9373 return _core_.Window_ConvertPixelPointToDialog(*args, **kwargs)
d55e5bfc
RD		 9374
9375 def ConvertPixelSizeToDialog(*args, **kwargs):
5b5c9bc7
RD		 9376 """ConvertPixelSizeToDialog(self, Size sz) -> Size"""
9377 return _core_.Window_ConvertPixelSizeToDialog(*args, **kwargs)
d55e5bfc
RD		 9378
9379 def WarpPointer(*args, **kwargs):
9380 """
9381 WarpPointer(self, int x, int y)
9382
9383 Moves the pointer to the given position on the window.
9384
9385 NOTE: This function is not supported under Mac because Apple Human
9386 Interface Guidelines forbid moving the mouse cursor programmatically.
9387 """
5b5c9bc7 9388 return _core_.Window_WarpPointer(*args, **kwargs)
d55e5bfc
RD		 9389
9390 def CaptureMouse(*args, **kwargs):
9391 """
9392 CaptureMouse(self)
9393
9394 Directs all mouse input to this window. Call wx.Window.ReleaseMouse to
9395 release the capture.
9396
9397 Note that wxWindows maintains the stack of windows having captured the
9398 mouse and when the mouse is released the capture returns to the window
9399 which had had captured it previously and it is only really released if
9400 there were no previous window. In particular, this means that you must
34e0a3bb
RD		 9401 release the mouse as many times as you capture it, unless the window
9402 receives the `wx.MouseCaptureLostEvent` event.
9403
9404 Any application which captures the mouse in the beginning of some
9405 operation *must* handle `wx.MouseCaptureLostEvent` and cancel this
9406 operation when it receives the event. The event handler must not
9407 recapture mouse.
d55e5bfc 9408 """
5b5c9bc7 9409 return _core_.Window_CaptureMouse(*args, **kwargs)
d55e5bfc
RD		 9410
9411 def ReleaseMouse(*args, **kwargs):
9412 """
9413 ReleaseMouse(self)
9414
9415 Releases mouse input captured with wx.Window.CaptureMouse.
9416 """
5b5c9bc7 9417 return _core_.Window_ReleaseMouse(*args, **kwargs)
d55e5bfc
RD		 9418
9419 def GetCapture(*args, **kwargs):
9420 """
5b5c9bc7 9421 GetCapture() -> Window
d55e5bfc
RD		 9422
9423 Returns the window which currently captures the mouse or None
9424 """
5b5c9bc7 9425 return _core_.Window_GetCapture(*args, **kwargs)
d55e5bfc
RD		 9426
9427 GetCapture = staticmethod(GetCapture)
9428 def HasCapture(*args, **kwargs):
9429 """
9430 HasCapture(self) -> bool
9431
9432 Returns true if this window has the current mouse capture.
9433 """
5b5c9bc7 9434 return _core_.Window_HasCapture(*args, **kwargs)
d55e5bfc
RD		 9435
9436 def Refresh(*args, **kwargs):
9437 """
5b5c9bc7 9438 Refresh(self, bool eraseBackground=True, Rect rect=None)
d55e5bfc
RD		 9439
9440 Mark the specified rectangle (or the whole window) as "dirty" so it
9441 will be repainted. Causes an EVT_PAINT event to be generated and sent
9442 to the window.
9443 """
5b5c9bc7 9444 return _core_.Window_Refresh(*args, **kwargs)
d55e5bfc
RD		 9445
9446 def RefreshRect(*args, **kwargs):
9447 """
5b5c9bc7 9448 RefreshRect(self, Rect rect, bool eraseBackground=True)
d55e5bfc
RD		 9449
9450 Redraws the contents of the given rectangle: the area inside it will
9451 be repainted. This is the same as Refresh but has a nicer syntax.
9452 """
5b5c9bc7 9453 return _core_.Window_RefreshRect(*args, **kwargs)
d55e5bfc
RD		 9454
9455 def Update(*args, **kwargs):
9456 """
9457 Update(self)
9458
9459 Calling this method immediately repaints the invalidated area of the
9460 window instead of waiting for the EVT_PAINT event to happen, (normally
9461 this would usually only happen when the flow of control returns to the
9462 event loop.) Notice that this function doesn't refresh the window and
9b940138 9463 does nothing if the window has been already repainted. Use `Refresh`
d55e5bfc
RD		 9464 first if you want to immediately redraw the window (or some portion of
9465 it) unconditionally.
9466 """
5b5c9bc7 9467 return _core_.Window_Update(*args, **kwargs)
d55e5bfc
RD		 9468
9469 def ClearBackground(*args, **kwargs):
9470 """
9471 ClearBackground(self)
9472
9473 Clears the window by filling it with the current background
9474 colour. Does not cause an erase background event to be generated.
9475 """
5b5c9bc7 9476 return _core_.Window_ClearBackground(*args, **kwargs)
d55e5bfc
RD		 9477
9478 def Freeze(*args, **kwargs):
9479 """
9480 Freeze(self)
9481
15817c7e
RD		 9482 Freezes the window or, in other words, prevents any updates from
9483 taking place on screen, the window is not redrawn at all. Thaw must be
9484 called to reenable window redrawing. Calls to Freeze/Thaw may be
9485 nested, with the actual Thaw being delayed until all the nesting has
9486 been undone.
d55e5bfc
RD		 9487
9488 This method is useful for visual appearance optimization (for example,
9489 it is a good idea to use it before inserting large amount of text into
9490 a wxTextCtrl under wxGTK) but is not implemented on all platforms nor
9491 for all controls so it is mostly just a hint to wxWindows and not a
9492 mandatory directive.
9493 """
5b5c9bc7 9494 return _core_.Window_Freeze(*args, **kwargs)
d55e5bfc 9495
33d6fd3b
RD		 9496 def IsFrozen(*args, **kwargs):
9497 """
9498 IsFrozen(self) -> bool
9499
9500 Returns ``True`` if the window has been frozen and not thawed yet.
9501
9502 :see: `Freeze` and `Thaw`
9503 """
9504 return _core_.Window_IsFrozen(*args, **kwargs)
9505
d55e5bfc
RD		 9506 def Thaw(*args, **kwargs):
9507 """
9508 Thaw(self)
9509
9510 Reenables window updating after a previous call to Freeze. Calls to
15817c7e
RD		 9511 Freeze/Thaw may be nested, so Thaw must be called the same number of
9512 times that Freeze was before the window will be updated.
d55e5bfc 9513 """
5b5c9bc7 9514 return _core_.Window_Thaw(*args, **kwargs)
d55e5bfc
RD		 9515
9516 def PrepareDC(*args, **kwargs):
9517 """
5b5c9bc7 9518 PrepareDC(self, DC dc)
d55e5bfc
RD		 9519
9520 Call this function to prepare the device context for drawing a
9521 scrolled image. It sets the device origin according to the current
9522 scroll position.
9523 """
5b5c9bc7 9524 return _core_.Window_PrepareDC(*args, **kwargs)
d55e5bfc 9525
b39fe951
RD		 9526 def IsDoubleBuffered(*args, **kwargs):
9527 """
9528 IsDoubleBuffered(self) -> bool
9529
9530 Returns ``True`` if the window contents is double-buffered by the
9531 system, i.e. if any drawing done on the window is really done on a
9532 temporary backing surface and transferred to the screen all at once
9533 later.
9534 """
9535 return _core_.Window_IsDoubleBuffered(*args, **kwargs)
9536
d55e5bfc
RD		 9537 def GetUpdateRegion(*args, **kwargs):
9538 """
5b5c9bc7 9539 GetUpdateRegion(self) -> Region
d55e5bfc
RD		 9540
9541 Returns the region specifying which parts of the window have been
9542 damaged. Should only be called within an EVT_PAINT handler.
9543 """
5b5c9bc7 9544 return _core_.Window_GetUpdateRegion(*args, **kwargs)
d55e5bfc
RD		 9545
9546 def GetUpdateClientRect(*args, **kwargs):
9547 """
5b5c9bc7 9548 GetUpdateClientRect(self) -> Rect
d55e5bfc
RD		 9549
9550 Get the update rectangle region bounding box in client coords.
9551 """
5b5c9bc7 9552 return _core_.Window_GetUpdateClientRect(*args, **kwargs)
d55e5bfc
RD		 9553
9554 def IsExposed(*args, **kwargs):
9555 """
9556 IsExposed(self, int x, int y, int w=1, int h=1) -> bool
9557
9558 Returns true if the given point or rectangle area has been exposed
9559 since the last repaint. Call this in an paint event handler to
9560 optimize redrawing by only redrawing those areas, which have been
9561 exposed.
9562 """
5b5c9bc7 9563 return _core_.Window_IsExposed(*args, **kwargs)
d55e5bfc
RD		 9564
9565 def IsExposedPoint(*args, **kwargs):
9566 """
5b5c9bc7 9567 IsExposedPoint(self, Point pt) -> bool
d55e5bfc
RD		 9568
9569 Returns true if the given point or rectangle area has been exposed
9570 since the last repaint. Call this in an paint event handler to
9571 optimize redrawing by only redrawing those areas, which have been
9572 exposed.
9573 """
5b5c9bc7 9574 return _core_.Window_IsExposedPoint(*args, **kwargs)
d55e5bfc
RD		 9575
9576 def IsExposedRect(*args, **kwargs):
9577 """
5b5c9bc7 9578 IsExposedRect(self, Rect rect) -> bool
d55e5bfc
RD		 9579
9580 Returns true if the given point or rectangle area has been exposed
9581 since the last repaint. Call this in an paint event handler to
9582 optimize redrawing by only redrawing those areas, which have been
9583 exposed.
9584 """
5b5c9bc7 9585 return _core_.Window_IsExposedRect(*args, **kwargs)
d55e5bfc
RD		 9586
9587 def GetDefaultAttributes(*args, **kwargs):
9588 """
5b5c9bc7 9589 GetDefaultAttributes(self) -> VisualAttributes
d55e5bfc 9590
15817c7e
RD		 9591 Get the default attributes for an instance of this class. This is
9592 useful if you want to use the same font or colour in your own control
9593 as in a standard control -- which is a much better idea than hard
9594 coding specific colours or fonts which might look completely out of
a5ee0656 9595 place on the user's system, especially if it uses themes.
d55e5bfc 9596 """
5b5c9bc7 9597 return _core_.Window_GetDefaultAttributes(*args, **kwargs)
d55e5bfc
RD		 9598
9599 def GetClassDefaultAttributes(*args, **kwargs):
9600 """
5b5c9bc7 9601 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
d55e5bfc 9602
15817c7e
RD		 9603 Get the default attributes for this class. This is useful if you want
9604 to use the same font or colour in your own control as in a standard
9605 control -- which is a much better idea than hard coding specific
a5ee0656
RD		 9606 colours or fonts which might look completely out of place on the
9607 user's system, especially if it uses themes.
d55e5bfc
RD		 9608
9609 The variant parameter is only relevant under Mac currently and is
15817c7e 9610 ignore under other platforms. Under Mac, it will change the size of
a5ee0656
RD		 9611 the returned font. See `wx.Window.SetWindowVariant` for more about
9612 this.
d55e5bfc 9613 """
5b5c9bc7 9614 return _core_.Window_GetClassDefaultAttributes(*args, **kwargs)
d55e5bfc
RD		 9615
9616 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
9617 def SetBackgroundColour(*args, **kwargs):
9618 """
5b5c9bc7 9619 SetBackgroundColour(self, Colour colour) -> bool
d55e5bfc
RD		 9620
9621 Sets the background colour of the window. Returns True if the colour
9622 was changed. The background colour is usually painted by the default
9623 EVT_ERASE_BACKGROUND event handler function under Windows and
f8167d6e
RD		 9624 automatically under GTK. Using `wx.NullColour` will reset the window
9625 to the default background colour.
d55e5bfc 9626
a5ee0656 9627 Note that setting the background colour may not cause an immediate
f8167d6e 9628 refresh, so you may wish to call `ClearBackground` or `Refresh` after
d55e5bfc
RD		 9629 calling this function.
9630
f8167d6e
RD		 9631 Using this function will disable attempts to use themes for this
9632 window, if the system supports them. Use with care since usually the
9633 themes represent the appearance chosen by the user to be used for all
9634 applications on the system.
d55e5bfc 9635 """
5b5c9bc7 9636 return _core_.Window_SetBackgroundColour(*args, **kwargs)
d55e5bfc 9637
412d302d 9638 def SetOwnBackgroundColour(*args, **kwargs):
5b5c9bc7
RD		 9639 """SetOwnBackgroundColour(self, Colour colour)"""
9640 return _core_.Window_SetOwnBackgroundColour(*args, **kwargs)
d55e5bfc
RD		 9641
9642 def SetForegroundColour(*args, **kwargs):
9643 """
5b5c9bc7 9644 SetForegroundColour(self, Colour colour) -> bool
d55e5bfc
RD		 9645
9646 Sets the foreground colour of the window. Returns True is the colour
9647 was changed. The interpretation of foreground colour is dependent on
9648 the window class; it may be the text colour or other colour, or it may
9649 not be used at all.
9650 """
5b5c9bc7 9651 return _core_.Window_SetForegroundColour(*args, **kwargs)
d55e5bfc 9652
fa47d7a7 9653 def SetOwnForegroundColour(*args, **kwargs):
5b5c9bc7
RD		 9654 """SetOwnForegroundColour(self, Colour colour)"""
9655 return _core_.Window_SetOwnForegroundColour(*args, **kwargs)
d55e5bfc
RD		 9656
9657 def GetBackgroundColour(*args, **kwargs):
9658 """
5b5c9bc7 9659 GetBackgroundColour(self) -> Colour
d55e5bfc
RD		 9660
9661 Returns the background colour of the window.
9662 """
5b5c9bc7 9663 return _core_.Window_GetBackgroundColour(*args, **kwargs)
d55e5bfc
RD		 9664
9665 def GetForegroundColour(*args, **kwargs):
9666 """
5b5c9bc7 9667 GetForegroundColour(self) -> Colour
d55e5bfc
RD		 9668
9669 Returns the foreground colour of the window. The interpretation of
9670 foreground colour is dependent on the window class; it may be the text
9671 colour or other colour, or it may not be used at all.
9672 """
5b5c9bc7 9673 return _core_.Window_GetForegroundColour(*args, **kwargs)
d55e5bfc 9674
dcb8fc74
RD		 9675 def InheritsBackgroundColour(*args, **kwargs):
9676 """InheritsBackgroundColour(self) -> bool"""
5b5c9bc7 9677 return _core_.Window_InheritsBackgroundColour(*args, **kwargs)
dcb8fc74
RD		 9678
9679 def UseBgCol(*args, **kwargs):
9680 """UseBgCol(self) -> bool"""
5b5c9bc7 9681 return _core_.Window_UseBgCol(*args, **kwargs)
dcb8fc74 9682
0f63ec68
RD		 9683 def SetBackgroundStyle(*args, **kwargs):
9684 """
9685 SetBackgroundStyle(self, int style) -> bool
9686
9687 Returns the background style of the window. The background style
9688 indicates how the background of the window is drawn.
9689
9690 ====================== ========================================
9691 wx.BG_STYLE_SYSTEM The background colour or pattern should
9692 be determined by the system
9693 wx.BG_STYLE_COLOUR The background should be a solid colour
9694 wx.BG_STYLE_CUSTOM The background will be implemented by the
9695 application.
9696 ====================== ========================================
9697
9698 On GTK+, use of wx.BG_STYLE_CUSTOM allows the flicker-free drawing of
9699 a custom background, such as a tiled bitmap. Currently the style has
9700 no effect on other platforms.
9701
9702 :see: `GetBackgroundStyle`, `SetBackgroundColour`
9703 """
5b5c9bc7 9704 return _core_.Window_SetBackgroundStyle(*args, **kwargs)
0f63ec68
RD		 9705
9706 def GetBackgroundStyle(*args, **kwargs):
9707 """
9708 GetBackgroundStyle(self) -> int
9709
9710 Returns the background style of the window.
9711
9712 :see: `SetBackgroundStyle`
9713 """
5b5c9bc7 9714 return _core_.Window_GetBackgroundStyle(*args, **kwargs)
0f63ec68 9715
51b83b37
RD		 9716 def HasTransparentBackground(*args, **kwargs):
9717 """
9718 HasTransparentBackground(self) -> bool
9719
9720 Returns True if this window's background is transparent (as, for
9721 example, for `wx.StaticText`) and should show the parent window's
9722 background.
9723
9724 This method is mostly used internally by the library itself and you
9725 normally shouldn't have to call it. You may, however, have to override
9726 it in your custom control classes to ensure that background is painted
9727 correctly.
9728 """
5b5c9bc7 9729 return _core_.Window_HasTransparentBackground(*args, **kwargs)
51b83b37 9730
d55e5bfc
RD		 9731 def SetCursor(*args, **kwargs):
9732 """
5b5c9bc7 9733 SetCursor(self, Cursor cursor) -> bool
d55e5bfc
RD		 9734
9735 Sets the window's cursor. Notice that the window cursor also sets it
9736 for the children of the window implicitly.
9737
9738 The cursor may be wx.NullCursor in which case the window cursor will
9739 be reset back to default.
9740 """
5b5c9bc7 9741 return _core_.Window_SetCursor(*args, **kwargs)
d55e5bfc
RD		 9742
9743 def GetCursor(*args, **kwargs):
9744 """
5b5c9bc7 9745 GetCursor(self) -> Cursor
d55e5bfc
RD		 9746
9747 Return the cursor associated with this window.
9748 """
5b5c9bc7 9749 return _core_.Window_GetCursor(*args, **kwargs)
d55e5bfc
RD		 9750
9751 def SetFont(*args, **kwargs):
9752 """
5b5c9bc7 9753 SetFont(self, Font font) -> bool
d55e5bfc
RD		 9754
9755 Sets the font for this window.
9756 """
5b5c9bc7 9757 return _core_.Window_SetFont(*args, **kwargs)
d55e5bfc 9758
fa47d7a7 9759 def SetOwnFont(*args, **kwargs):
5b5c9bc7
RD		 9760 """SetOwnFont(self, Font font)"""
9761 return _core_.Window_SetOwnFont(*args, **kwargs)
d55e5bfc
RD		 9762
9763 def GetFont(*args, **kwargs):
9764 """
5b5c9bc7 9765 GetFont(self) -> Font
d55e5bfc
RD		 9766
9767 Returns the default font used for this window.
9768 """
5b5c9bc7 9769 return _core_.Window_GetFont(*args, **kwargs)
d55e5bfc
RD		 9770
9771 def SetCaret(*args, **kwargs):
9772 """
5b5c9bc7 9773 SetCaret(self, Caret caret)
d55e5bfc
RD		 9774
9775 Sets the caret associated with the window.
9776 """
5b5c9bc7 9777 return _core_.Window_SetCaret(*args, **kwargs)
d55e5bfc
RD		 9778
9779 def GetCaret(*args, **kwargs):
9780 """
5b5c9bc7 9781 GetCaret(self) -> Caret
d55e5bfc
RD		 9782
9783 Returns the caret associated with the window.
9784 """
5b5c9bc7 9785 return _core_.Window_GetCaret(*args, **kwargs)
d55e5bfc
RD		 9786
9787 def GetCharHeight(*args, **kwargs):
9788 """
9789 GetCharHeight(self) -> int
9790
9791 Get the (average) character size for the current font.
9792 """
5b5c9bc7 9793 return _core_.Window_GetCharHeight(*args, **kwargs)
d55e5bfc
RD		 9794
9795 def GetCharWidth(*args, **kwargs):
9796 """
9797 GetCharWidth(self) -> int
9798
9799 Get the (average) character size for the current font.
9800 """
5b5c9bc7 9801 return _core_.Window_GetCharWidth(*args, **kwargs)
d55e5bfc
RD		 9802
9803 def GetTextExtent(*args, **kwargs):
fd2dc343
RD		 9804 """
9805 GetTextExtent(String string) -> (width, height)
9806
9807 Get the width and height of the text using the current font.
9808 """
5b5c9bc7 9809 return _core_.Window_GetTextExtent(*args, **kwargs)
d55e5bfc
RD		 9810
9811 def GetFullTextExtent(*args, **kwargs):
9812 """
9813 GetFullTextExtent(String string, Font font=None) ->
9814 (width, height, descent, externalLeading)
9815
9816 Get the width, height, decent and leading of the text using the
9817 current or specified font.
9818 """
5b5c9bc7 9819 return _core_.Window_GetFullTextExtent(*args, **kwargs)
d55e5bfc
RD		 9820
9821 def ClientToScreenXY(*args, **kwargs):
9822 """
9823 ClientToScreenXY(int x, int y) -> (x,y)
9824
9825 Converts to screen coordinates from coordinates relative to this window.
9826 """
5b5c9bc7 9827 return _core_.Window_ClientToScreenXY(*args, **kwargs)
d55e5bfc
RD		 9828
9829 def ScreenToClientXY(*args, **kwargs):
9830 """
9831 ScreenToClientXY(int x, int y) -> (x,y)
9832
9833 Converts from screen to client window coordinates.
9834 """
5b5c9bc7 9835 return _core_.Window_ScreenToClientXY(*args, **kwargs)
d55e5bfc
RD		 9836
9837 def ClientToScreen(*args, **kwargs):
9838 """
5b5c9bc7 9839 ClientToScreen(self, Point pt) -> Point
d55e5bfc
RD		 9840
9841 Converts to screen coordinates from coordinates relative to this window.
9842 """
5b5c9bc7 9843 return _core_.Window_ClientToScreen(*args, **kwargs)
d55e5bfc
RD		 9844
9845 def ScreenToClient(*args, **kwargs):
9846 """
5b5c9bc7 9847 ScreenToClient(self, Point pt) -> Point
d55e5bfc
RD		 9848
9849 Converts from screen to client window coordinates.
9850 """
5b5c9bc7 9851 return _core_.Window_ScreenToClient(*args, **kwargs)
d55e5bfc
RD		 9852
9853 def HitTestXY(*args, **kwargs):
9854 """
9855 HitTestXY(self, int x, int y) -> int
9856
9857 Test where the given (in client coords) point lies
9858 """
5b5c9bc7 9859 return _core_.Window_HitTestXY(*args, **kwargs)
d55e5bfc
RD		 9860
9861 def HitTest(*args, **kwargs):
9862 """
5b5c9bc7 9863 HitTest(self, Point pt) -> int
d55e5bfc
RD		 9864
9865 Test where the given (in client coords) point lies
9866 """
5b5c9bc7 9867 return _core_.Window_HitTest(*args, **kwargs)
d55e5bfc
RD		 9868
9869 def GetBorder(*args):
9870 """
9871 GetBorder(self, long flags) -> int
9872 GetBorder(self) -> int
9873
9874 Get border for the flags of this window
9875 """
5b5c9bc7 9876 return _core_.Window_GetBorder(*args)
d55e5bfc
RD		 9877
9878 def UpdateWindowUI(*args, **kwargs):
9879 """
5b5c9bc7 9880 UpdateWindowUI(self, long flags=UPDATE_UI_NONE)
d55e5bfc
RD		 9881
9882 This function sends EVT_UPDATE_UI events to the window. The particular
9883 implementation depends on the window; for example a wx.ToolBar will
9884 send an update UI event for each toolbar button, and a wx.Frame will
9885 send an update UI event for each menubar menu item. You can call this
9886 function from your application to ensure that your UI is up-to-date at
9887 a particular point in time (as far as your EVT_UPDATE_UI handlers are
9888 concerned). This may be necessary if you have called
5ba5649b 9889 `wx.UpdateUIEvent.SetMode` or `wx.UpdateUIEvent.SetUpdateInterval` to
d55e5bfc
RD		 9890 limit the overhead that wxWindows incurs by sending update UI events
9891 in idle time.
d55e5bfc 9892 """
5b5c9bc7 9893 return _core_.Window_UpdateWindowUI(*args, **kwargs)
d55e5bfc
RD		 9894
9895 def PopupMenuXY(*args, **kwargs):
9896 """
5b5c9bc7 9897 PopupMenuXY(self, Menu menu, int x=-1, int y=-1) -> bool
d55e5bfc 9898
b0503257
RD		 9899 Pops up the given menu at the specified coordinates, relative to this window,
9900 and returns control when the user has dismissed the menu. If a menu item is
9901 selected, the corresponding menu event is generated and will be processed as
9902 usual. If the default position is given then the current position of the
9903 mouse cursor will be used.
d55e5bfc 9904 """
5b5c9bc7 9905 return _core_.Window_PopupMenuXY(*args, **kwargs)
d55e5bfc
RD		 9906
9907 def PopupMenu(*args, **kwargs):
9908 """
5b5c9bc7 9909 PopupMenu(self, Menu menu, Point pos=DefaultPosition) -> bool
d55e5bfc 9910
b0503257
RD		 9911 Pops up the given menu at the specified coordinates, relative to this window,
9912 and returns control when the user has dismissed the menu. If a menu item is
9913 selected, the corresponding menu event is generated and will be processed as
9914 usual. If the default position is given then the current position of the
9915 mouse cursor will be used.
d55e5bfc 9916 """
5b5c9bc7 9917 return _core_.Window_PopupMenu(*args, **kwargs)
d55e5bfc 9918
1eeb270e
RD		 9919 def HasMultiplePages(*args, **kwargs):
9920 """HasMultiplePages(self) -> bool"""
9921 return _core_.Window_HasMultiplePages(*args, **kwargs)
9922
d55e5bfc
RD		 9923 def GetHandle(*args, **kwargs):
9924 """
9925 GetHandle(self) -> long
9926
9927 Returns the platform-specific handle (as a long integer) of the
9928 physical window. Currently on wxMac it returns the handle of the
9929 toplevel parent of the window.
9930 """
5b5c9bc7 9931 return _core_.Window_GetHandle(*args, **kwargs)
d55e5bfc 9932
629e65c2
RD		 9933 def AssociateHandle(*args, **kwargs):
9934 """
9935 AssociateHandle(self, long handle)
9936
9937 Associate the window with a new native handle
9938 """
5b5c9bc7 9939 return _core_.Window_AssociateHandle(*args, **kwargs)
629e65c2
RD		 9940
9941 def DissociateHandle(*args, **kwargs):
9942 """
9943 DissociateHandle(self)
9944
9945 Dissociate the current native handle from the window
9946 """
5b5c9bc7 9947 return _core_.Window_DissociateHandle(*args, **kwargs)
629e65c2 9948
d55e5bfc
RD		 9949 def HasScrollbar(*args, **kwargs):
9950 """
9951 HasScrollbar(self, int orient) -> bool
9952
9953 Does the window have the scrollbar for this orientation?
9954 """
5b5c9bc7 9955 return _core_.Window_HasScrollbar(*args, **kwargs)
d55e5bfc
RD		 9956
9957 def SetScrollbar(*args, **kwargs):
9958 """
15817c7e 9959 SetScrollbar(self, int orientation, int position, int thumbSize, int range,
d55e5bfc
RD		 9960 bool refresh=True)
9961
9962 Sets the scrollbar properties of a built-in scrollbar.
d55e5bfc 9963 """
5b5c9bc7 9964 return _core_.Window_SetScrollbar(*args, **kwargs)
d55e5bfc
RD		 9965
9966 def SetScrollPos(*args, **kwargs):
9967 """
9968 SetScrollPos(self, int orientation, int pos, bool refresh=True)
9969
9970 Sets the position of one of the built-in scrollbars.
9971 """
5b5c9bc7 9972 return _core_.Window_SetScrollPos(*args, **kwargs)
d55e5bfc
RD		 9973
9974 def GetScrollPos(*args, **kwargs):
9975 """
9976 GetScrollPos(self, int orientation) -> int
9977
9978 Returns the built-in scrollbar position.
9979 """
5b5c9bc7 9980 return _core_.Window_GetScrollPos(*args, **kwargs)
d55e5bfc
RD		 9981
9982 def GetScrollThumb(*args, **kwargs):
9983 """
9984 GetScrollThumb(self, int orientation) -> int
9985
9986 Returns the built-in scrollbar thumb size.
9987 """
5b5c9bc7 9988 return _core_.Window_GetScrollThumb(*args, **kwargs)
d55e5bfc
RD		 9989
9990 def GetScrollRange(*args, **kwargs):
9991 """
9992 GetScrollRange(self, int orientation) -> int
9993
9994 Returns the built-in scrollbar range.
9995 """
5b5c9bc7 9996 return _core_.Window_GetScrollRange(*args, **kwargs)
d55e5bfc
RD		 9997
9998 def ScrollWindow(*args, **kwargs):
9999 """
5b5c9bc7 10000 ScrollWindow(self, int dx, int dy, Rect rect=None)
d55e5bfc
RD		 10001
10002 Physically scrolls the pixels in the window and move child windows
10003 accordingly. Use this function to optimise your scrolling
10004 implementations, to minimise the area that must be redrawn. Note that
10005 it is rarely required to call this function from a user program.
d55e5bfc 10006 """
5b5c9bc7 10007 return _core_.Window_ScrollWindow(*args, **kwargs)
d55e5bfc
RD		 10008
10009 def ScrollLines(*args, **kwargs):
10010 """
10011 ScrollLines(self, int lines) -> bool
10012
10013 If the platform and window class supports it, scrolls the window by
10014 the given number of lines down, if lines is positive, or up if lines
10015 is negative. Returns True if the window was scrolled, False if it was
10016 already on top/bottom and nothing was done.
10017 """
5b5c9bc7 10018 return _core_.Window_ScrollLines(*args, **kwargs)
d55e5bfc
RD		 10019
10020 def ScrollPages(*args, **kwargs):
10021 """
10022 ScrollPages(self, int pages) -> bool
10023
15817c7e 10024 If the platform and window class supports it, scrolls the window by
d55e5bfc
RD		 10025 the given number of pages down, if pages is positive, or up if pages
10026 is negative. Returns True if the window was scrolled, False if it was
10027 already on top/bottom and nothing was done.
10028 """
5b5c9bc7 10029 return _core_.Window_ScrollPages(*args, **kwargs)
d55e5bfc
RD		 10030
10031 def LineUp(*args, **kwargs):
10032 """
10033 LineUp(self) -> bool
10034
10035 This is just a wrapper for ScrollLines(-1).
10036 """
5b5c9bc7 10037 return _core_.Window_LineUp(*args, **kwargs)
d55e5bfc
RD		 10038
10039 def LineDown(*args, **kwargs):
10040 """
10041 LineDown(self) -> bool
10042
10043 This is just a wrapper for ScrollLines(1).
10044 """
5b5c9bc7 10045 return _core_.Window_LineDown(*args, **kwargs)
d55e5bfc
RD		 10046
10047 def PageUp(*args, **kwargs):
10048 """
10049 PageUp(self) -> bool
10050
10051 This is just a wrapper for ScrollPages(-1).
10052 """
5b5c9bc7 10053 return _core_.Window_PageUp(*args, **kwargs)
d55e5bfc
RD		 10054
10055 def PageDown(*args, **kwargs):
10056 """
10057 PageDown(self) -> bool
10058
10059 This is just a wrapper for ScrollPages(1).
10060 """
5b5c9bc7 10061 return _core_.Window_PageDown(*args, **kwargs)
d55e5bfc
RD		 10062
10063 def SetHelpText(*args, **kwargs):
10064 """
5b5c9bc7 10065 SetHelpText(self, String text)
d55e5bfc
RD		 10066
10067 Sets the help text to be used as context-sensitive help for this
10068 window. Note that the text is actually stored by the current
f52cbe90 10069 `wx.HelpProvider` implementation, and not in the window object itself.
d55e5bfc 10070 """
5b5c9bc7 10071 return _core_.Window_SetHelpText(*args, **kwargs)
d55e5bfc
RD		 10072
10073 def SetHelpTextForId(*args, **kwargs):
10074 """
5b5c9bc7 10075 SetHelpTextForId(self, String text)
d55e5bfc
RD		 10076
10077 Associate this help text with all windows with the same id as this
10078 one.
10079 """
5b5c9bc7 10080 return _core_.Window_SetHelpTextForId(*args, **kwargs)
d55e5bfc 10081
b850e7f3
RD		 10082 def GetHelpTextAtPoint(*args, **kwargs):
10083 """
10084 GetHelpTextAtPoint(self, Point pt, wxHelpEvent::Origin origin) -> String
10085
10086 Get the help string associated with the given position in this window.
10087
10088 Notice that pt may be invalid if event origin is keyboard or unknown
10089 and this method should return the global window help text then
10090
10091 """
10092 return _core_.Window_GetHelpTextAtPoint(*args, **kwargs)
10093
d55e5bfc
RD		 10094 def GetHelpText(*args, **kwargs):
10095 """
5b5c9bc7 10096 GetHelpText(self) -> String
d55e5bfc
RD		 10097
10098 Gets the help text to be used as context-sensitive help for this
10099 window. Note that the text is actually stored by the current
f52cbe90 10100 `wx.HelpProvider` implementation, and not in the window object itself.
d55e5bfc 10101 """
5b5c9bc7 10102 return _core_.Window_GetHelpText(*args, **kwargs)
d55e5bfc
RD		 10103
10104 def SetToolTipString(*args, **kwargs):
10105 """
5b5c9bc7 10106 SetToolTipString(self, String tip)
d55e5bfc
RD		 10107
10108 Attach a tooltip to the window.
10109 """
5b5c9bc7 10110 return _core_.Window_SetToolTipString(*args, **kwargs)
d55e5bfc
RD		 10111
10112 def SetToolTip(*args, **kwargs):
10113 """
5b5c9bc7 10114 SetToolTip(self, ToolTip tip)
d55e5bfc
RD		 10115
10116 Attach a tooltip to the window.
10117 """
5b5c9bc7 10118 return _core_.Window_SetToolTip(*args, **kwargs)
d55e5bfc
RD		 10119
10120 def GetToolTip(*args, **kwargs):
10121 """
5b5c9bc7 10122 GetToolTip(self) -> ToolTip
d55e5bfc
RD		 10123
10124 get the associated tooltip or None if none
10125 """
5b5c9bc7 10126 return _core_.Window_GetToolTip(*args, **kwargs)
d55e5bfc
RD		 10127
10128 def SetDropTarget(*args, **kwargs):
10129 """
5b5c9bc7 10130 SetDropTarget(self, DropTarget dropTarget)
d55e5bfc
RD		 10131
10132 Associates a drop target with this window. If the window already has
10133 a drop target, it is deleted.
10134 """
5b5c9bc7 10135 return _core_.Window_SetDropTarget(*args, **kwargs)
d55e5bfc
RD		 10136
10137 def GetDropTarget(*args, **kwargs):
10138 """
5b5c9bc7 10139 GetDropTarget(self) -> DropTarget
d55e5bfc
RD		 10140
10141 Returns the associated drop target, which may be None.
10142 """
5b5c9bc7 10143 return _core_.Window_GetDropTarget(*args, **kwargs)
d55e5bfc 10144
5ba5649b
RD		 10145 def DragAcceptFiles(*args, **kwargs):
10146 """
10147 DragAcceptFiles(self, bool accept)
10148
10149 Enables or disables eligibility for drop file events, EVT_DROP_FILES.
10150 Only functional on Windows.
10151 """
10152 return _core_.Window_DragAcceptFiles(*args, **kwargs)
10153
d55e5bfc
RD		 10154 def SetConstraints(*args, **kwargs):
10155 """
5b5c9bc7 10156 SetConstraints(self, LayoutConstraints constraints)
d55e5bfc
RD		 10157
10158 Sets the window to have the given layout constraints. If an existing
10159 layout constraints object is already owned by the window, it will be
10160 deleted. Pass None to disassociate and delete the window's current
10161 constraints.
10162
10163 You must call SetAutoLayout to tell a window to use the constraints
10164 automatically in its default EVT_SIZE handler; otherwise, you must
10165 handle EVT_SIZE yourself and call Layout() explicitly. When setting
10166 both a wx.LayoutConstraints and a wx.Sizer, only the sizer will have
10167 effect.
10168 """
5b5c9bc7 10169 return _core_.Window_SetConstraints(*args, **kwargs)
d55e5bfc
RD		 10170
10171 def GetConstraints(*args, **kwargs):
10172 """
5b5c9bc7 10173 GetConstraints(self) -> LayoutConstraints
d55e5bfc
RD		 10174
10175 Returns a pointer to the window's layout constraints, or None if there
10176 are none.
10177 """
5b5c9bc7 10178 return _core_.Window_GetConstraints(*args, **kwargs)
d55e5bfc
RD		 10179
10180 def SetAutoLayout(*args, **kwargs):
10181 """
10182 SetAutoLayout(self, bool autoLayout)
10183
10184 Determines whether the Layout function will be called automatically
b1fcee84
RD		 10185 when the window is resized. lease note that this only happens for the
10186 windows usually used to contain children, namely `wx.Panel` and
10187 `wx.TopLevelWindow` (and the classes deriving from them).
10188
10189 This method is called implicitly by `SetSizer` but if you use
10190 `SetConstraints` you should call it manually or otherwise the window
10191 layout won't be correctly updated when its size changes.
d55e5bfc 10192 """
5b5c9bc7 10193 return _core_.Window_SetAutoLayout(*args, **kwargs)
d55e5bfc
RD		 10194
10195 def GetAutoLayout(*args, **kwargs):
10196 """
10197 GetAutoLayout(self) -> bool
10198
10199 Returns the current autoLayout setting
10200 """
5b5c9bc7 10201 return _core_.Window_GetAutoLayout(*args, **kwargs)
d55e5bfc
RD		 10202
10203 def Layout(*args, **kwargs):
10204 """
10205 Layout(self) -> bool
10206
10207 Invokes the constraint-based layout algorithm or the sizer-based
10208 algorithm for this window. See SetAutoLayout: when auto layout is on,
10209 this function gets called automatically by the default EVT_SIZE
10210 handler when the window is resized.
10211 """
5b5c9bc7 10212 return _core_.Window_Layout(*args, **kwargs)
d55e5bfc
RD		 10213
10214 def SetSizer(*args, **kwargs):
10215 """
5b5c9bc7 10216 SetSizer(self, Sizer sizer, bool deleteOld=True)
d55e5bfc
RD		 10217
10218 Sets the window to have the given layout sizer. The window will then
10219 own the object, and will take care of its deletion. If an existing
10220 layout sizer object is already owned by the window, it will be deleted
10221 if the deleteOld parameter is true. Note that this function will also
10222 call SetAutoLayout implicitly with a True parameter if the sizer is
b411df4a 10223 non-None, and False otherwise.
d55e5bfc 10224 """
5b5c9bc7 10225 return _core_.Window_SetSizer(*args, **kwargs)
d55e5bfc
RD		 10226
10227 def SetSizerAndFit(*args, **kwargs):
10228 """
5b5c9bc7 10229 SetSizerAndFit(self, Sizer sizer, bool deleteOld=True)
d55e5bfc
RD		 10230
10231 The same as SetSizer, except it also sets the size hints for the
10232 window based on the sizer's minimum size.
10233 """
5b5c9bc7 10234 return _core_.Window_SetSizerAndFit(*args, **kwargs)
d55e5bfc
RD		 10235
10236 def GetSizer(*args, **kwargs):
10237 """
5b5c9bc7 10238 GetSizer(self) -> Sizer
d55e5bfc
RD		 10239
10240 Return the sizer associated with the window by a previous call to
10241 SetSizer or None if there isn't one.
10242 """
5b5c9bc7 10243 return _core_.Window_GetSizer(*args, **kwargs)
d55e5bfc
RD		 10244
10245 def SetContainingSizer(*args, **kwargs):
10246 """
5b5c9bc7 10247 SetContainingSizer(self, Sizer sizer)
d55e5bfc
RD		 10248
10249 This normally does not need to be called by application code. It is
10250 called internally when a window is added to a sizer, and is used so
10251 the window can remove itself from the sizer when it is destroyed.
10252 """
5b5c9bc7 10253 return _core_.Window_SetContainingSizer(*args, **kwargs)
d55e5bfc
RD		 10254
10255 def GetContainingSizer(*args, **kwargs):
10256 """
5b5c9bc7 10257 GetContainingSizer(self) -> Sizer
d55e5bfc
RD		 10258
10259 Return the sizer that this window is a member of, if any, otherwise None.
10260 """
5b5c9bc7 10261 return _core_.Window_GetContainingSizer(*args, **kwargs)
d55e5bfc
RD		 10262
10263 def InheritAttributes(*args, **kwargs):
10264 """
10265 InheritAttributes(self)
10266
15817c7e
RD		 10267 This function is (or should be, in case of custom controls) called
10268 during window creation to intelligently set up the window visual
10269 attributes, that is the font and the foreground and background
10270 colours.
10271
10272 By 'intelligently' the following is meant: by default, all windows use
10273 their own default attributes. However if some of the parent's
10274 attributes are explicitly changed (that is, using SetFont and not
fa47d7a7 10275 SetOwnFont) and if the corresponding attribute hadn't been
15817c7e
RD		 10276 explicitly set for this window itself, then this window takes the same
10277 value as used by the parent. In addition, if the window overrides
10278 ShouldInheritColours to return false, the colours will not be changed
10279 no matter what and only the font might.
10280
a7bb0a9d
RD		 10281 This rather complicated logic is necessary in order to accommodate the
10282 different usage scenarios. The most common one is when all default
15817c7e
RD		 10283 attributes are used and in this case, nothing should be inherited as
10284 in modern GUIs different controls use different fonts (and colours)
10285 than their siblings so they can't inherit the same value from the
10286 parent. However it was also deemed desirable to allow to simply change
10287 the attributes of all children at once by just changing the font or
10288 colour of their common parent, hence in this case we do inherit the
10289 parents attributes.
10290
d55e5bfc 10291 """
5b5c9bc7 10292 return _core_.Window_InheritAttributes(*args, **kwargs)
d55e5bfc
RD		 10293
10294 def ShouldInheritColours(*args, **kwargs):
10295 """
10296 ShouldInheritColours(self) -> bool
10297
10298 Return true from here to allow the colours of this window to be
15817c7e
RD		 10299 changed by InheritAttributes, returning false forbids inheriting them
10300 from the parent window.
d55e5bfc 10301
15817c7e
RD		 10302 The base class version returns false, but this method is overridden in
10303 wxControl where it returns true.
d55e5bfc 10304 """
5b5c9bc7 10305 return _core_.Window_ShouldInheritColours(*args, **kwargs)
d55e5bfc 10306
fc46b7f3
RD		 10307 def CanSetTransparent(*args, **kwargs):
10308 """
10309 CanSetTransparent(self) -> bool
10310
10311 Returns ``True`` if the platform supports setting the transparency for
10312 this window. Note that this method will err on the side of caution,
10313 so it is possible that this will return ``False`` when it is in fact
10314 possible to set the transparency.
10315
10316 NOTE: On X-windows systems the X server must have the composite
10317 extension loaded, and there must be a composite manager program (such
10318 as xcompmgr) running.
10319 """
10320 return _core_.Window_CanSetTransparent(*args, **kwargs)
10321
10322 def SetTransparent(*args, **kwargs):
10323 """
10324 SetTransparent(self, byte alpha) -> bool
10325
10326 Attempt to set the transparency of this window to the ``alpha`` value,
10327 returns True on success. The ``alpha`` value is an integer in the
10328 range of 0 to 255, where 0 is fully transparent and 255 is fully
10329 opaque.
10330 """
10331 return _core_.Window_SetTransparent(*args, **kwargs)
10332
d55e5bfc
RD		 10333 def PostCreate(self, pre):
10334 """
10335 Phase 3 of the 2-phase create <wink!>
10336 Call this method after precreating the window with the 2-phase create method.
10337 """
10338 self.this = pre.this
10339 self.thisown = pre.thisown
10340 pre.thisown = 0
10341 if hasattr(self, '_setOORInfo'):
10342 self._setOORInfo(self)
10343 if hasattr(self, '_setCallbackInfo'):
10344 self._setCallbackInfo(self, self.__class__)
10345
7e08d4ef 10346 def SendSizeEvent(self):
92515dfc 10347 self.GetEventHandler().ProcessEvent(wx.SizeEvent((-1,-1)))
7e08d4ef 10348
2bf58437
RD		 10349 AcceleratorTable = property(GetAcceleratorTable,SetAcceleratorTable,doc="See `GetAcceleratorTable` and `SetAcceleratorTable`")
10350 AdjustedBestSize = property(GetAdjustedBestSize,doc="See `GetAdjustedBestSize`")
10351 AutoLayout = property(GetAutoLayout,SetAutoLayout,doc="See `GetAutoLayout` and `SetAutoLayout`")
10352 BackgroundColour = property(GetBackgroundColour,SetBackgroundColour,doc="See `GetBackgroundColour` and `SetBackgroundColour`")
10353 BackgroundStyle = property(GetBackgroundStyle,SetBackgroundStyle,doc="See `GetBackgroundStyle` and `SetBackgroundStyle`")
580080c5 10354 EffectiveMinSize = property(GetEffectiveMinSize,doc="See `GetEffectiveMinSize`")
2bf58437
RD		 10355 BestSize = property(GetBestSize,doc="See `GetBestSize`")
10356 BestVirtualSize = property(GetBestVirtualSize,doc="See `GetBestVirtualSize`")
10357 Border = property(GetBorder,doc="See `GetBorder`")
10358 Caret = property(GetCaret,SetCaret,doc="See `GetCaret` and `SetCaret`")
10359 CharHeight = property(GetCharHeight,doc="See `GetCharHeight`")
10360 CharWidth = property(GetCharWidth,doc="See `GetCharWidth`")
10361 Children = property(GetChildren,doc="See `GetChildren`")
10362 ClientAreaOrigin = property(GetClientAreaOrigin,doc="See `GetClientAreaOrigin`")
10363 ClientRect = property(GetClientRect,SetClientRect,doc="See `GetClientRect` and `SetClientRect`")
10364 ClientSize = property(GetClientSize,SetClientSize,doc="See `GetClientSize` and `SetClientSize`")
10365 Constraints = property(GetConstraints,SetConstraints,doc="See `GetConstraints` and `SetConstraints`")
10366 ContainingSizer = property(GetContainingSizer,SetContainingSizer,doc="See `GetContainingSizer` and `SetContainingSizer`")
10367 Cursor = property(GetCursor,SetCursor,doc="See `GetCursor` and `SetCursor`")
10368 DefaultAttributes = property(GetDefaultAttributes,doc="See `GetDefaultAttributes`")
10369 DropTarget = property(GetDropTarget,SetDropTarget,doc="See `GetDropTarget` and `SetDropTarget`")
10370 EventHandler = property(GetEventHandler,SetEventHandler,doc="See `GetEventHandler` and `SetEventHandler`")
10371 ExtraStyle = property(GetExtraStyle,SetExtraStyle,doc="See `GetExtraStyle` and `SetExtraStyle`")
10372 Font = property(GetFont,SetFont,doc="See `GetFont` and `SetFont`")
10373 ForegroundColour = property(GetForegroundColour,SetForegroundColour,doc="See `GetForegroundColour` and `SetForegroundColour`")
2bf58437
RD		 10374 GrandParent = property(GetGrandParent,doc="See `GetGrandParent`")
10375 Handle = property(GetHandle,doc="See `GetHandle`")
10376 HelpText = property(GetHelpText,SetHelpText,doc="See `GetHelpText` and `SetHelpText`")
2bf58437
RD		 10377 Id = property(GetId,SetId,doc="See `GetId` and `SetId`")
10378 Label = property(GetLabel,SetLabel,doc="See `GetLabel` and `SetLabel`")
994453b8 10379 LayoutDirection = property(GetLayoutDirection,SetLayoutDirection,doc="See `GetLayoutDirection` and `SetLayoutDirection`")
2bf58437
RD		 10380 MaxHeight = property(GetMaxHeight,doc="See `GetMaxHeight`")
10381 MaxSize = property(GetMaxSize,SetMaxSize,doc="See `GetMaxSize` and `SetMaxSize`")
10382 MaxWidth = property(GetMaxWidth,doc="See `GetMaxWidth`")
10383 MinHeight = property(GetMinHeight,doc="See `GetMinHeight`")
10384 MinSize = property(GetMinSize,SetMinSize,doc="See `GetMinSize` and `SetMinSize`")
10385 MinWidth = property(GetMinWidth,doc="See `GetMinWidth`")
10386 Name = property(GetName,SetName,doc="See `GetName` and `SetName`")
10387 Parent = property(GetParent,doc="See `GetParent`")
10388 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
10389 Rect = property(GetRect,SetRect,doc="See `GetRect` and `SetRect`")
10390 ScreenPosition = property(GetScreenPosition,doc="See `GetScreenPosition`")
10391 ScreenRect = property(GetScreenRect,doc="See `GetScreenRect`")
2bf58437
RD		 10392 Size = property(GetSize,SetSize,doc="See `GetSize` and `SetSize`")
10393 Sizer = property(GetSizer,SetSizer,doc="See `GetSizer` and `SetSizer`")
2bf58437
RD		 10394 ThemeEnabled = property(GetThemeEnabled,SetThemeEnabled,doc="See `GetThemeEnabled` and `SetThemeEnabled`")
10395 ToolTip = property(GetToolTip,SetToolTip,doc="See `GetToolTip` and `SetToolTip`")
10396 UpdateClientRect = property(GetUpdateClientRect,doc="See `GetUpdateClientRect`")
10397 UpdateRegion = property(GetUpdateRegion,doc="See `GetUpdateRegion`")
10398 Validator = property(GetValidator,SetValidator,doc="See `GetValidator` and `SetValidator`")
10399 VirtualSize = property(GetVirtualSize,SetVirtualSize,doc="See `GetVirtualSize` and `SetVirtualSize`")
10400 WindowStyle = property(GetWindowStyle,SetWindowStyle,doc="See `GetWindowStyle` and `SetWindowStyle`")
10401 WindowStyleFlag = property(GetWindowStyleFlag,SetWindowStyleFlag,doc="See `GetWindowStyleFlag` and `SetWindowStyleFlag`")
10402 WindowVariant = property(GetWindowVariant,SetWindowVariant,doc="See `GetWindowVariant` and `SetWindowVariant`")
ac5d357a
RD		 10403 Shown = property(IsShown,Show,doc="See `IsShown` and `Show`")
10404 Enabled = property(IsEnabled,Enable,doc="See `IsEnabled` and `Enable`")
10405 TopLevel = property(IsTopLevel,doc="See `IsTopLevel`")
2131d850 10406_core_.Window_swigregister(Window)
d55e5bfc
RD		 10407
10408def PreWindow(*args, **kwargs):
10409 """
5b5c9bc7 10410 PreWindow() -> Window
d55e5bfc
RD		 10411
10412 Precreate a Window for 2-phase creation.
10413 """
5b5c9bc7 10414 val = _core_.new_PreWindow(*args, **kwargs)
d55e5bfc
RD		 10415 return val
10416
1bd55598
RD		 10417def Window_NewControlId(*args):
10418 """
5b5c9bc7 10419 Window_NewControlId() -> int
d55e5bfc
RD		 10420
10421 Generate a control id for the controls which were not given one.
10422 """
1bd55598 10423 return _core_.Window_NewControlId(*args)
d55e5bfc 10424
5b5c9bc7 10425def Window_NextControlId(*args, **kwargs):
1bd55598 10426 """
5b5c9bc7 10427 Window_NextControlId(int winid) -> int
d55e5bfc
RD		 10428
10429 Get the id of the control following the one with the given
15817c7e 10430 autogenerated) id
d55e5bfc 10431 """
1bd55598 10432 return _core_.Window_NextControlId(*args, **kwargs)
d55e5bfc 10433
5b5c9bc7 10434def Window_PrevControlId(*args, **kwargs):
1bd55598 10435 """
5b5c9bc7 10436 Window_PrevControlId(int winid) -> int
d55e5bfc
RD		 10437
10438 Get the id of the control preceding the one with the given
15817c7e 10439 autogenerated) id
d55e5bfc 10440 """
1bd55598 10441 return _core_.Window_PrevControlId(*args, **kwargs)
d55e5bfc 10442
1bd55598
RD		 10443def Window_FindFocus(*args):
10444 """
5b5c9bc7 10445 Window_FindFocus() -> Window
d55e5bfc
RD		 10446
10447 Returns the window or control that currently has the keyboard focus,
10448 or None.
10449 """
1bd55598 10450 return _core_.Window_FindFocus(*args)
d55e5bfc 10451
1bd55598
RD		 10452def Window_GetCapture(*args):
10453 """
5b5c9bc7 10454 Window_GetCapture() -> Window
d55e5bfc
RD		 10455
10456 Returns the window which currently captures the mouse or None
10457 """
1bd55598 10458 return _core_.Window_GetCapture(*args)
d55e5bfc 10459
5b5c9bc7 10460def Window_GetClassDefaultAttributes(*args, **kwargs):
1bd55598 10461 """
5b5c9bc7 10462 Window_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
d55e5bfc 10463
15817c7e
RD		 10464 Get the default attributes for this class. This is useful if you want
10465 to use the same font or colour in your own control as in a standard
10466 control -- which is a much better idea than hard coding specific
a5ee0656
RD		 10467 colours or fonts which might look completely out of place on the
10468 user's system, especially if it uses themes.
d55e5bfc
RD		 10469
10470 The variant parameter is only relevant under Mac currently and is
15817c7e 10471 ignore under other platforms. Under Mac, it will change the size of
a5ee0656
RD		 10472 the returned font. See `wx.Window.SetWindowVariant` for more about
10473 this.
d55e5bfc 10474 """
1bd55598 10475 return _core_.Window_GetClassDefaultAttributes(*args, **kwargs)
d55e5bfc
RD		 10476
10477def DLG_PNT(win, point_or_x, y=None):
10478 """
10479 Convenience function for converting a Point or (x,y) in
10480 dialog units to pixel units.
10481 """
10482 if y is None:
10483 return win.ConvertDialogPointToPixels(point_or_x)
10484 else:
10485 return win.ConvertDialogPointToPixels(wx.Point(point_or_x, y))
10486
10487def DLG_SZE(win, size_width, height=None):
10488 """
10489 Convenience function for converting a Size or (w,h) in
10490 dialog units to pixel units.
10491 """
10492 if height is None:
10493 return win.ConvertDialogSizeToPixels(size_width)
10494 else:
10495 return win.ConvertDialogSizeToPixels(wx.Size(size_width, height))
10496
10497
5b5c9bc7 10498def FindWindowById(*args, **kwargs):
1bd55598 10499 """
5b5c9bc7 10500 FindWindowById(long id, Window parent=None) -> Window
d55e5bfc
RD		 10501
10502 Find the first window in the application with the given id. If parent
10503 is None, the search will start from all top-level frames and dialog
10504 boxes; if non-None, the search will be limited to the given window
10505 hierarchy. The search is recursive in both cases.
10506 """
1bd55598 10507 return _core_.FindWindowById(*args, **kwargs)
d55e5bfc 10508
5b5c9bc7 10509def FindWindowByName(*args, **kwargs):
1bd55598 10510 """
5b5c9bc7 10511 FindWindowByName(String name, Window parent=None) -> Window
d55e5bfc
RD		 10512
10513 Find a window by its name (as given in a window constructor or Create
10514 function call). If parent is None, the search will start from all
10515 top-level frames and dialog boxes; if non-None, the search will be
10516 limited to the given window hierarchy. The search is recursive in both
10517 cases.
10518
10519 If no window with such name is found, wx.FindWindowByLabel is called.
10520 """
1bd55598 10521 return _core_.FindWindowByName(*args, **kwargs)
d55e5bfc 10522
5b5c9bc7 10523def FindWindowByLabel(*args, **kwargs):
1bd55598 10524 """
5b5c9bc7 10525 FindWindowByLabel(String label, Window parent=None) -> Window
d55e5bfc
RD		 10526
10527 Find a window by its label. Depending on the type of window, the label
10528 may be a window title or panel item label. If parent is None, the
10529 search will start from all top-level frames and dialog boxes; if
10530 non-None, the search will be limited to the given window
10531 hierarchy. The search is recursive in both cases.
10532 """
1bd55598 10533 return _core_.FindWindowByLabel(*args, **kwargs)
d55e5bfc 10534
5b5c9bc7 10535def Window_FromHWND(*args, **kwargs):
1bd55598
RD		 10536 """Window_FromHWND(Window parent, unsigned long _hWnd) -> Window"""
10537 return _core_.Window_FromHWND(*args, **kwargs)
3215336e 10538
1bd55598
RD		 10539def GetTopLevelWindows(*args):
10540 """
3215336e
RD		 10541 GetTopLevelWindows() -> PyObject
10542
10543 Returns a list of the the application's top-level windows, (frames,
10544 dialogs, etc.) NOTE: Currently this is a copy of the list maintained
10545 by wxWidgets, and so it is only valid as long as no top-level windows
10546 are closed or new top-level windows are created.
10547
10548 """
1bd55598 10549 return _core_.GetTopLevelWindows(*args)
d55e5bfc
RD		 10550#---------------------------------------------------------------------------
10551
5b5c9bc7
RD		 10552class Validator(EvtHandler):
10553 """Proxy of C++ Validator class"""
1bd55598
RD		 10554 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10555 __repr__ = _swig_repr
10556 def __init__(self, *args, **kwargs):
5b5c9bc7 10557 """__init__(self) -> Validator"""
1bd55598 10558 _core_.Validator_swiginit(self,_core_.new_Validator(*args, **kwargs))
d55e5bfc
RD		 10559 self._setOORInfo(self)
10560
10561 def Clone(*args, **kwargs):
5b5c9bc7
RD		 10562 """Clone(self) -> Validator"""
10563 return _core_.Validator_Clone(*args, **kwargs)
d55e5bfc
RD		 10564
10565 def Validate(*args, **kwargs):
5b5c9bc7
RD		 10566 """Validate(self, Window parent) -> bool"""
10567 return _core_.Validator_Validate(*args, **kwargs)
d55e5bfc
RD		 10568
10569 def TransferToWindow(*args, **kwargs):
10570 """TransferToWindow(self) -> bool"""
5b5c9bc7 10571 return _core_.Validator_TransferToWindow(*args, **kwargs)
d55e5bfc
RD		 10572
10573 def TransferFromWindow(*args, **kwargs):
10574 """TransferFromWindow(self) -> bool"""
5b5c9bc7 10575 return _core_.Validator_TransferFromWindow(*args, **kwargs)
d55e5bfc
RD		 10576
10577 def GetWindow(*args, **kwargs):
5b5c9bc7
RD		 10578 """GetWindow(self) -> Window"""
10579 return _core_.Validator_GetWindow(*args, **kwargs)
d55e5bfc
RD		 10580
10581 def SetWindow(*args, **kwargs):
5b5c9bc7
RD		 10582 """SetWindow(self, Window window)"""
10583 return _core_.Validator_SetWindow(*args, **kwargs)
d55e5bfc
RD		 10584
10585 def IsSilent(*args, **kwargs):
d6c14a4c 10586 """IsSilent() -> bool"""
5b5c9bc7 10587 return _core_.Validator_IsSilent(*args, **kwargs)
d55e5bfc
RD		 10588
10589 IsSilent = staticmethod(IsSilent)
10590 def SetBellOnError(*args, **kwargs):
d6c14a4c 10591 """SetBellOnError(int doIt=True)"""
5b5c9bc7 10592 return _core_.Validator_SetBellOnError(*args, **kwargs)
d55e5bfc
RD		 10593
10594 SetBellOnError = staticmethod(SetBellOnError)
dba7934c 10595 Window = property(GetWindow,SetWindow,doc="See `GetWindow` and `SetWindow`")
2131d850 10596_core_.Validator_swigregister(Validator)
d55e5bfc 10597
1bd55598
RD		 10598def Validator_IsSilent(*args):
10599 """Validator_IsSilent() -> bool"""
10600 return _core_.Validator_IsSilent(*args)
d55e5bfc 10601
5b5c9bc7 10602def Validator_SetBellOnError(*args, **kwargs):
1bd55598
RD		 10603 """Validator_SetBellOnError(int doIt=True)"""
10604 return _core_.Validator_SetBellOnError(*args, **kwargs)
d55e5bfc 10605
5b5c9bc7
RD		 10606class PyValidator(Validator):
10607 """Proxy of C++ PyValidator class"""
1bd55598
RD		 10608 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10609 __repr__ = _swig_repr
10610 def __init__(self, *args, **kwargs):
5b5c9bc7 10611 """__init__(self) -> PyValidator"""
1bd55598 10612 _core_.PyValidator_swiginit(self,_core_.new_PyValidator(*args, **kwargs))
d55e5bfc
RD		 10613
10614 self._setCallbackInfo(self, PyValidator, 1)
10615 self._setOORInfo(self)
10616
10617 def _setCallbackInfo(*args, **kwargs):
10618 """_setCallbackInfo(self, PyObject self, PyObject _class, int incref=True)"""
5b5c9bc7 10619 return _core_.PyValidator__setCallbackInfo(*args, **kwargs)
d55e5bfc 10620
2131d850 10621_core_.PyValidator_swigregister(PyValidator)
d55e5bfc
RD		 10622
10623#---------------------------------------------------------------------------
10624
5b5c9bc7
RD		 10625class Menu(EvtHandler):
10626 """Proxy of C++ Menu class"""
1bd55598
RD		 10627 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10628 __repr__ = _swig_repr
10629 def __init__(self, *args, **kwargs):
5b5c9bc7 10630 """__init__(self, String title=EmptyString, long style=0) -> Menu"""
1bd55598 10631 _core_.Menu_swiginit(self,_core_.new_Menu(*args, **kwargs))
d55e5bfc
RD		 10632 self._setOORInfo(self)
10633
10634 def Append(*args, **kwargs):
ac5d357a
RD		 10635 """
10636 Append(self, int id, String text=EmptyString, String help=EmptyString,
10637 int kind=ITEM_NORMAL) -> MenuItem
10638 """
5b5c9bc7 10639 return _core_.Menu_Append(*args, **kwargs)
d55e5bfc
RD		 10640
10641 def AppendSeparator(*args, **kwargs):
5b5c9bc7
RD		 10642 """AppendSeparator(self) -> MenuItem"""
10643 return _core_.Menu_AppendSeparator(*args, **kwargs)
d55e5bfc
RD		 10644
10645 def AppendCheckItem(*args, **kwargs):
5b5c9bc7
RD		 10646 """AppendCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10647 return _core_.Menu_AppendCheckItem(*args, **kwargs)
d55e5bfc
RD		 10648
10649 def AppendRadioItem(*args, **kwargs):
5b5c9bc7
RD		 10650 """AppendRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10651 return _core_.Menu_AppendRadioItem(*args, **kwargs)
d55e5bfc
RD		 10652
10653 def AppendMenu(*args, **kwargs):
5b5c9bc7
RD		 10654 """AppendMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
10655 return _core_.Menu_AppendMenu(*args, **kwargs)
d55e5bfc 10656
da91cb0f
RD		 10657 def AppendSubMenu(*args, **kwargs):
10658 """AppendSubMenu(self, Menu submenu, String text, String help=EmptyString) -> MenuItem"""
10659 return _core_.Menu_AppendSubMenu(*args, **kwargs)
10660
d55e5bfc 10661 def AppendItem(*args, **kwargs):
5b5c9bc7
RD		 10662 """AppendItem(self, MenuItem item) -> MenuItem"""
10663 return _core_.Menu_AppendItem(*args, **kwargs)
d55e5bfc 10664
d55e5bfc 10665 def InsertItem(*args, **kwargs):
5b5c9bc7
RD		 10666 """InsertItem(self, size_t pos, MenuItem item) -> MenuItem"""
10667 return _core_.Menu_InsertItem(*args, **kwargs)
d55e5bfc 10668
1bd55598
RD		 10669 def PrependItem(*args, **kwargs):
10670 """PrependItem(self, MenuItem item) -> MenuItem"""
10671 return _core_.Menu_PrependItem(*args, **kwargs)
10672
10673 def Break(*args, **kwargs):
10674 """Break(self)"""
10675 return _core_.Menu_Break(*args, **kwargs)
10676
d55e5bfc
RD		 10677 def Insert(*args, **kwargs):
10678 """
ac5d357a 10679 Insert(self, size_t pos, int id, String text=EmptyString, String help=EmptyString,
5b5c9bc7 10680 int kind=ITEM_NORMAL) -> MenuItem
d55e5bfc 10681 """
5b5c9bc7 10682 return _core_.Menu_Insert(*args, **kwargs)
d55e5bfc
RD		 10683
10684 def InsertSeparator(*args, **kwargs):
5b5c9bc7
RD		 10685 """InsertSeparator(self, size_t pos) -> MenuItem"""
10686 return _core_.Menu_InsertSeparator(*args, **kwargs)
d55e5bfc
RD		 10687
10688 def InsertCheckItem(*args, **kwargs):
5b5c9bc7
RD		 10689 """InsertCheckItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
10690 return _core_.Menu_InsertCheckItem(*args, **kwargs)
d55e5bfc
RD		 10691
10692 def InsertRadioItem(*args, **kwargs):
5b5c9bc7
RD		 10693 """InsertRadioItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
10694 return _core_.Menu_InsertRadioItem(*args, **kwargs)
d55e5bfc
RD		 10695
10696 def InsertMenu(*args, **kwargs):
5b5c9bc7
RD		 10697 """InsertMenu(self, size_t pos, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
10698 return _core_.Menu_InsertMenu(*args, **kwargs)
d55e5bfc 10699
d55e5bfc 10700 def Prepend(*args, **kwargs):
ac5d357a
RD		 10701 """
10702 Prepend(self, int id, String text=EmptyString, String help=EmptyString,
10703 int kind=ITEM_NORMAL) -> MenuItem
10704 """
5b5c9bc7 10705 return _core_.Menu_Prepend(*args, **kwargs)
d55e5bfc
RD		 10706
10707 def PrependSeparator(*args, **kwargs):
5b5c9bc7
RD		 10708 """PrependSeparator(self) -> MenuItem"""
10709 return _core_.Menu_PrependSeparator(*args, **kwargs)
d55e5bfc
RD		 10710
10711 def PrependCheckItem(*args, **kwargs):
5b5c9bc7
RD		 10712 """PrependCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10713 return _core_.Menu_PrependCheckItem(*args, **kwargs)
d55e5bfc
RD		 10714
10715 def PrependRadioItem(*args, **kwargs):
5b5c9bc7
RD		 10716 """PrependRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10717 return _core_.Menu_PrependRadioItem(*args, **kwargs)
d55e5bfc
RD		 10718
10719 def PrependMenu(*args, **kwargs):
5b5c9bc7
RD		 10720 """PrependMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
10721 return _core_.Menu_PrependMenu(*args, **kwargs)
d55e5bfc
RD		 10722
10723 def Remove(*args, **kwargs):
5b5c9bc7
RD		 10724 """Remove(self, int id) -> MenuItem"""
10725 return _core_.Menu_Remove(*args, **kwargs)
d55e5bfc
RD		 10726
10727 def RemoveItem(*args, **kwargs):
5b5c9bc7
RD		 10728 """RemoveItem(self, MenuItem item) -> MenuItem"""
10729 return _core_.Menu_RemoveItem(*args, **kwargs)
d55e5bfc
RD		 10730
10731 def Delete(*args, **kwargs):
10732 """Delete(self, int id) -> bool"""
5b5c9bc7 10733 return _core_.Menu_Delete(*args, **kwargs)
d55e5bfc
RD		 10734
10735 def DeleteItem(*args, **kwargs):
5b5c9bc7
RD		 10736 """DeleteItem(self, MenuItem item) -> bool"""
10737 return _core_.Menu_DeleteItem(*args, **kwargs)
d55e5bfc
RD		 10738
10739 def Destroy(*args, **kwargs):
10740 """
10741 Destroy(self)
10742
10743 Deletes the C++ object this Python object is a proxy for.
10744 """
b39fe951
RD		 10745 args[0].this.own(False)
10746 return _core_.Menu_Destroy(*args, **kwargs)
d55e5bfc
RD		 10747
10748 def DestroyId(*args, **kwargs):
b39fe951
RD		 10749 """DestroyId(self, int id) -> bool"""
10750 return _core_.Menu_DestroyId(*args, **kwargs)
d55e5bfc
RD		 10751
10752 def DestroyItem(*args, **kwargs):
b39fe951
RD		 10753 """DestroyItem(self, MenuItem item) -> bool"""
10754 return _core_.Menu_DestroyItem(*args, **kwargs)
d55e5bfc
RD		 10755
10756 def GetMenuItemCount(*args, **kwargs):
10757 """GetMenuItemCount(self) -> size_t"""
5b5c9bc7 10758 return _core_.Menu_GetMenuItemCount(*args, **kwargs)
d55e5bfc
RD		 10759
10760 def GetMenuItems(*args, **kwargs):
10761 """GetMenuItems(self) -> PyObject"""
5b5c9bc7 10762 return _core_.Menu_GetMenuItems(*args, **kwargs)
d55e5bfc
RD		 10763
10764 def FindItem(*args, **kwargs):
5b5c9bc7
RD		 10765 """FindItem(self, String item) -> int"""
10766 return _core_.Menu_FindItem(*args, **kwargs)
d55e5bfc
RD		 10767
10768 def FindItemById(*args, **kwargs):
5b5c9bc7
RD		 10769 """FindItemById(self, int id) -> MenuItem"""
10770 return _core_.Menu_FindItemById(*args, **kwargs)
d55e5bfc
RD		 10771
10772 def FindItemByPosition(*args, **kwargs):
5b5c9bc7
RD		 10773 """FindItemByPosition(self, size_t position) -> MenuItem"""
10774 return _core_.Menu_FindItemByPosition(*args, **kwargs)
d55e5bfc
RD		 10775
10776 def Enable(*args, **kwargs):
10777 """Enable(self, int id, bool enable)"""
5b5c9bc7 10778 return _core_.Menu_Enable(*args, **kwargs)
d55e5bfc
RD		 10779
10780 def IsEnabled(*args, **kwargs):
10781 """IsEnabled(self, int id) -> bool"""
5b5c9bc7 10782 return _core_.Menu_IsEnabled(*args, **kwargs)
d55e5bfc
RD		 10783
10784 def Check(*args, **kwargs):
10785 """Check(self, int id, bool check)"""
5b5c9bc7 10786 return _core_.Menu_Check(*args, **kwargs)
d55e5bfc
RD		 10787
10788 def IsChecked(*args, **kwargs):
10789 """IsChecked(self, int id) -> bool"""
5b5c9bc7 10790 return _core_.Menu_IsChecked(*args, **kwargs)
d55e5bfc
RD		 10791
10792 def SetLabel(*args, **kwargs):
5b5c9bc7
RD		 10793 """SetLabel(self, int id, String label)"""
10794 return _core_.Menu_SetLabel(*args, **kwargs)
d55e5bfc
RD		 10795
10796 def GetLabel(*args, **kwargs):
5b5c9bc7
RD		 10797 """GetLabel(self, int id) -> String"""
10798 return _core_.Menu_GetLabel(*args, **kwargs)
d55e5bfc
RD		 10799
10800 def SetHelpString(*args, **kwargs):
5b5c9bc7
RD		 10801 """SetHelpString(self, int id, String helpString)"""
10802 return _core_.Menu_SetHelpString(*args, **kwargs)
d55e5bfc
RD		 10803
10804 def GetHelpString(*args, **kwargs):
5b5c9bc7
RD		 10805 """GetHelpString(self, int id) -> String"""
10806 return _core_.Menu_GetHelpString(*args, **kwargs)
d55e5bfc
RD		 10807
10808 def SetTitle(*args, **kwargs):
5b5c9bc7
RD		 10809 """SetTitle(self, String title)"""
10810 return _core_.Menu_SetTitle(*args, **kwargs)
d55e5bfc
RD		 10811
10812 def GetTitle(*args, **kwargs):
5b5c9bc7
RD		 10813 """GetTitle(self) -> String"""
10814 return _core_.Menu_GetTitle(*args, **kwargs)
d55e5bfc
RD		 10815
10816 def SetEventHandler(*args, **kwargs):
5b5c9bc7
RD		 10817 """SetEventHandler(self, EvtHandler handler)"""
10818 return _core_.Menu_SetEventHandler(*args, **kwargs)
d55e5bfc
RD		 10819
10820 def GetEventHandler(*args, **kwargs):
5b5c9bc7
RD		 10821 """GetEventHandler(self) -> EvtHandler"""
10822 return _core_.Menu_GetEventHandler(*args, **kwargs)
d55e5bfc
RD		 10823
10824 def SetInvokingWindow(*args, **kwargs):
5b5c9bc7
RD		 10825 """SetInvokingWindow(self, Window win)"""
10826 return _core_.Menu_SetInvokingWindow(*args, **kwargs)
d55e5bfc
RD		 10827
10828 def GetInvokingWindow(*args, **kwargs):
5b5c9bc7
RD		 10829 """GetInvokingWindow(self) -> Window"""
10830 return _core_.Menu_GetInvokingWindow(*args, **kwargs)
d55e5bfc
RD		 10831
10832 def GetStyle(*args, **kwargs):
10833 """GetStyle(self) -> long"""
5b5c9bc7 10834 return _core_.Menu_GetStyle(*args, **kwargs)
d55e5bfc
RD		 10835
10836 def UpdateUI(*args, **kwargs):
5b5c9bc7
RD		 10837 """UpdateUI(self, EvtHandler source=None)"""
10838 return _core_.Menu_UpdateUI(*args, **kwargs)
d55e5bfc
RD		 10839
10840 def GetMenuBar(*args, **kwargs):
5b5c9bc7
RD		 10841 """GetMenuBar(self) -> MenuBar"""
10842 return _core_.Menu_GetMenuBar(*args, **kwargs)
d55e5bfc
RD		 10843
10844 def Attach(*args, **kwargs):
10845 """Attach(self, wxMenuBarBase menubar)"""
5b5c9bc7 10846 return _core_.Menu_Attach(*args, **kwargs)
d55e5bfc
RD		 10847
10848 def Detach(*args, **kwargs):
10849 """Detach(self)"""
5b5c9bc7 10850 return _core_.Menu_Detach(*args, **kwargs)
d55e5bfc
RD		 10851
10852 def IsAttached(*args, **kwargs):
10853 """IsAttached(self) -> bool"""
5b5c9bc7 10854 return _core_.Menu_IsAttached(*args, **kwargs)
d55e5bfc
RD		 10855
10856 def SetParent(*args, **kwargs):
5b5c9bc7
RD		 10857 """SetParent(self, Menu parent)"""
10858 return _core_.Menu_SetParent(*args, **kwargs)
d55e5bfc
RD		 10859
10860 def GetParent(*args, **kwargs):
5b5c9bc7
RD		 10861 """GetParent(self) -> Menu"""
10862 return _core_.Menu_GetParent(*args, **kwargs)
d55e5bfc 10863
57332a5a
RD		 10864 EventHandler = property(GetEventHandler,SetEventHandler,doc="See `GetEventHandler` and `SetEventHandler`")
10865 HelpString = property(GetHelpString,SetHelpString,doc="See `GetHelpString` and `SetHelpString`")
10866 InvokingWindow = property(GetInvokingWindow,SetInvokingWindow,doc="See `GetInvokingWindow` and `SetInvokingWindow`")
10867 MenuBar = property(GetMenuBar,doc="See `GetMenuBar`")
10868 MenuItemCount = property(GetMenuItemCount,doc="See `GetMenuItemCount`")
10869 MenuItems = property(GetMenuItems,doc="See `GetMenuItems`")
10870 Parent = property(GetParent,SetParent,doc="See `GetParent` and `SetParent`")
10871 Style = property(GetStyle,doc="See `GetStyle`")
10872 Title = property(GetTitle,SetTitle,doc="See `GetTitle` and `SetTitle`")
2131d850 10873_core_.Menu_swigregister(Menu)
5b5c9bc7 10874DefaultValidator = cvar.DefaultValidator
d55e5bfc
RD		 10875
10876#---------------------------------------------------------------------------
10877
5b5c9bc7
RD		 10878class MenuBar(Window):
10879 """Proxy of C++ MenuBar class"""
1bd55598
RD		 10880 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10881 __repr__ = _swig_repr
10882 def __init__(self, *args, **kwargs):
5b5c9bc7 10883 """__init__(self, long style=0) -> MenuBar"""
1bd55598 10884 _core_.MenuBar_swiginit(self,_core_.new_MenuBar(*args, **kwargs))
d55e5bfc
RD		 10885 self._setOORInfo(self)
10886
10887 def Append(*args, **kwargs):
5b5c9bc7
RD		 10888 """Append(self, Menu menu, String title) -> bool"""
10889 return _core_.MenuBar_Append(*args, **kwargs)
d55e5bfc
RD		 10890
10891 def Insert(*args, **kwargs):
5b5c9bc7
RD		 10892 """Insert(self, size_t pos, Menu menu, String title) -> bool"""
10893 return _core_.MenuBar_Insert(*args, **kwargs)
d55e5bfc
RD		 10894
10895 def GetMenuCount(*args, **kwargs):
10896 """GetMenuCount(self) -> size_t"""
5b5c9bc7 10897 return _core_.MenuBar_GetMenuCount(*args, **kwargs)
d55e5bfc
RD		 10898
10899 def GetMenu(*args, **kwargs):
5b5c9bc7
RD		 10900 """GetMenu(self, size_t pos) -> Menu"""
10901 return _core_.MenuBar_GetMenu(*args, **kwargs)
d55e5bfc
RD		 10902
10903 def Replace(*args, **kwargs):
5b5c9bc7
RD		 10904 """Replace(self, size_t pos, Menu menu, String title) -> Menu"""
10905 return _core_.MenuBar_Replace(*args, **kwargs)
d55e5bfc
RD		 10906
10907 def Remove(*args, **kwargs):
5b5c9bc7
RD		 10908 """Remove(self, size_t pos) -> Menu"""
10909 return _core_.MenuBar_Remove(*args, **kwargs)
d55e5bfc
RD		 10910
10911 def EnableTop(*args, **kwargs):
10912 """EnableTop(self, size_t pos, bool enable)"""
5b5c9bc7 10913 return _core_.MenuBar_EnableTop(*args, **kwargs)
d55e5bfc
RD		 10914
10915 def IsEnabledTop(*args, **kwargs):
10916 """IsEnabledTop(self, size_t pos) -> bool"""
5b5c9bc7 10917 return _core_.MenuBar_IsEnabledTop(*args, **kwargs)
d55e5bfc
RD		 10918
10919 def SetLabelTop(*args, **kwargs):
5b5c9bc7
RD		 10920 """SetLabelTop(self, size_t pos, String label)"""
10921 return _core_.MenuBar_SetLabelTop(*args, **kwargs)
d55e5bfc
RD		 10922
10923 def GetLabelTop(*args, **kwargs):
5b5c9bc7
RD		 10924 """GetLabelTop(self, size_t pos) -> String"""
10925 return _core_.MenuBar_GetLabelTop(*args, **kwargs)
d55e5bfc
RD		 10926
10927 def FindMenuItem(*args, **kwargs):
5b5c9bc7
RD		 10928 """FindMenuItem(self, String menu, String item) -> int"""
10929 return _core_.MenuBar_FindMenuItem(*args, **kwargs)
d55e5bfc
RD		 10930
10931 def FindItemById(*args, **kwargs):
5b5c9bc7
RD		 10932 """FindItemById(self, int id) -> MenuItem"""
10933 return _core_.MenuBar_FindItemById(*args, **kwargs)
d55e5bfc
RD		 10934
10935 def FindMenu(*args, **kwargs):
5b5c9bc7
RD		 10936 """FindMenu(self, String title) -> int"""
10937 return _core_.MenuBar_FindMenu(*args, **kwargs)
d55e5bfc
RD		 10938
10939 def Enable(*args, **kwargs):
10940 """Enable(self, int id, bool enable)"""
5b5c9bc7 10941 return _core_.MenuBar_Enable(*args, **kwargs)
d55e5bfc
RD		 10942
10943 def Check(*args, **kwargs):
10944 """Check(self, int id, bool check)"""
5b5c9bc7 10945 return _core_.MenuBar_Check(*args, **kwargs)
d55e5bfc
RD		 10946
10947 def IsChecked(*args, **kwargs):
10948 """IsChecked(self, int id) -> bool"""
5b5c9bc7 10949 return _core_.MenuBar_IsChecked(*args, **kwargs)
d55e5bfc
RD		 10950
10951 def IsEnabled(*args, **kwargs):
10952 """IsEnabled(self, int id) -> bool"""
5b5c9bc7 10953 return _core_.MenuBar_IsEnabled(*args, **kwargs)
d55e5bfc
RD		 10954
10955 def SetLabel(*args, **kwargs):
5b5c9bc7
RD		 10956 """SetLabel(self, int id, String label)"""
10957 return _core_.MenuBar_SetLabel(*args, **kwargs)
d55e5bfc
RD		 10958
10959 def GetLabel(*args, **kwargs):
5b5c9bc7
RD		 10960 """GetLabel(self, int id) -> String"""
10961 return _core_.MenuBar_GetLabel(*args, **kwargs)
d55e5bfc
RD		 10962
10963 def SetHelpString(*args, **kwargs):
5b5c9bc7
RD		 10964 """SetHelpString(self, int id, String helpString)"""
10965 return _core_.MenuBar_SetHelpString(*args, **kwargs)
d55e5bfc
RD		 10966
10967 def GetHelpString(*args, **kwargs):
5b5c9bc7
RD		 10968 """GetHelpString(self, int id) -> String"""
10969 return _core_.MenuBar_GetHelpString(*args, **kwargs)
d55e5bfc
RD		 10970
10971 def GetFrame(*args, **kwargs):
10972 """GetFrame(self) -> wxFrame"""
5b5c9bc7 10973 return _core_.MenuBar_GetFrame(*args, **kwargs)
d55e5bfc
RD		 10974
10975 def IsAttached(*args, **kwargs):
10976 """IsAttached(self) -> bool"""
5b5c9bc7 10977 return _core_.MenuBar_IsAttached(*args, **kwargs)
d55e5bfc
RD		 10978
10979 def Attach(*args, **kwargs):
10980 """Attach(self, wxFrame frame)"""
5b5c9bc7 10981 return _core_.MenuBar_Attach(*args, **kwargs)
d55e5bfc
RD		 10982
10983 def Detach(*args, **kwargs):
10984 """Detach(self)"""
5b5c9bc7 10985 return _core_.MenuBar_Detach(*args, **kwargs)
d55e5bfc 10986
587d0f36
RD		 10987 def UpdateMenus(*args, **kwargs):
10988 """UpdateMenus(self)"""
10989 return _core_.MenuBar_UpdateMenus(*args, **kwargs)
10990
4f433fef
RD		 10991 def SetAutoWindowMenu(*args, **kwargs):
10992 """SetAutoWindowMenu(bool enable)"""
10993 return _core_.MenuBar_SetAutoWindowMenu(*args, **kwargs)
10994
10995 SetAutoWindowMenu = staticmethod(SetAutoWindowMenu)
10996 def GetAutoWindowMenu(*args, **kwargs):
10997 """GetAutoWindowMenu() -> bool"""
10998 return _core_.MenuBar_GetAutoWindowMenu(*args, **kwargs)
10999
11000 GetAutoWindowMenu = staticmethod(GetAutoWindowMenu)
ac5d357a
RD		 11001 def GetMenus(self):
11002 """Return a list of (menu, label) items for the menus in the MenuBar. """
11003 return [(self.GetMenu(i), self.GetLabelTop(i))
11004 for i in range(self.GetMenuCount())]
11005
11006 def SetMenus(self, items):
11007 """Clear and add new menus to the MenuBar from a list of (menu, label) items. """
11008 for i in range(self.GetMenuCount()-1, -1, -1):
11009 self.Remove(i)
11010 for m, l in items:
11011 self.Append(m, l)
11012
57332a5a
RD		 11013 Frame = property(GetFrame,doc="See `GetFrame`")
11014 Menu = property(GetMenu,doc="See `GetMenu`")
11015 MenuCount = property(GetMenuCount,doc="See `GetMenuCount`")
11016 Menus = property(GetMenus,SetMenus,doc="See `GetMenus` and `SetMenus`")
2131d850 11017_core_.MenuBar_swigregister(MenuBar)
d55e5bfc 11018
4f433fef 11019def MenuBar_SetAutoWindowMenu(*args, **kwargs):
1bd55598
RD		 11020 """MenuBar_SetAutoWindowMenu(bool enable)"""
11021 return _core_.MenuBar_SetAutoWindowMenu(*args, **kwargs)
4f433fef 11022
1bd55598
RD		 11023def MenuBar_GetAutoWindowMenu(*args):
11024 """MenuBar_GetAutoWindowMenu() -> bool"""
11025 return _core_.MenuBar_GetAutoWindowMenu(*args)
4f433fef 11026
d55e5bfc
RD		 11027#---------------------------------------------------------------------------
11028
5b5c9bc7
RD		 11029class MenuItem(Object):
11030 """Proxy of C++ MenuItem class"""
1bd55598
RD		 11031 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11032 __repr__ = _swig_repr
11033 def __init__(self, *args, **kwargs):
d55e5bfc 11034 """
5b5c9bc7
RD		 11035 __init__(self, Menu parentMenu=None, int id=ID_ANY, String text=EmptyString,
11036 String help=EmptyString, int kind=ITEM_NORMAL,
11037 Menu subMenu=None) -> MenuItem
d55e5bfc 11038 """
1bd55598
RD		 11039 _core_.MenuItem_swiginit(self,_core_.new_MenuItem(*args, **kwargs))
11040 __swig_destroy__ = _core_.delete_MenuItem
11041 __del__ = lambda self : None;
d55e5bfc 11042 def GetMenu(*args, **kwargs):
5b5c9bc7
RD		 11043 """GetMenu(self) -> Menu"""
11044 return _core_.MenuItem_GetMenu(*args, **kwargs)
d55e5bfc
RD		 11045
11046 def SetMenu(*args, **kwargs):
5b5c9bc7
RD		 11047 """SetMenu(self, Menu menu)"""
11048 return _core_.MenuItem_SetMenu(*args, **kwargs)
d55e5bfc
RD		 11049
11050 def SetId(*args, **kwargs):
11051 """SetId(self, int id)"""
5b5c9bc7 11052 return _core_.MenuItem_SetId(*args, **kwargs)
d55e5bfc
RD		 11053
11054 def GetId(*args, **kwargs):
11055 """GetId(self) -> int"""
5b5c9bc7 11056 return _core_.MenuItem_GetId(*args, **kwargs)
d55e5bfc
RD		 11057
11058 def IsSeparator(*args, **kwargs):
11059 """IsSeparator(self) -> bool"""
5b5c9bc7 11060 return _core_.MenuItem_IsSeparator(*args, **kwargs)
d55e5bfc
RD		 11061
11062 def SetText(*args, **kwargs):
5b5c9bc7
RD		 11063 """SetText(self, String str)"""
11064 return _core_.MenuItem_SetText(*args, **kwargs)
d55e5bfc
RD		 11065
11066 def GetLabel(*args, **kwargs):
5b5c9bc7
RD		 11067 """GetLabel(self) -> String"""
11068 return _core_.MenuItem_GetLabel(*args, **kwargs)
d55e5bfc
RD		 11069
11070 def GetText(*args, **kwargs):
5b5c9bc7
RD		 11071 """GetText(self) -> String"""
11072 return _core_.MenuItem_GetText(*args, **kwargs)
d55e5bfc
RD		 11073
11074 def GetLabelFromText(*args, **kwargs):
5b5c9bc7
RD		 11075 """GetLabelFromText(String text) -> String"""
11076 return _core_.MenuItem_GetLabelFromText(*args, **kwargs)
d55e5bfc
RD		 11077
11078 GetLabelFromText = staticmethod(GetLabelFromText)
11079 def GetKind(*args, **kwargs):
11080 """GetKind(self) -> int"""
5b5c9bc7 11081 return _core_.MenuItem_GetKind(*args, **kwargs)
d55e5bfc
RD		 11082
11083 def SetKind(*args, **kwargs):
11084 """SetKind(self, int kind)"""
5b5c9bc7 11085 return _core_.MenuItem_SetKind(*args, **kwargs)
d55e5bfc
RD		 11086
11087 def SetCheckable(*args, **kwargs):
11088 """SetCheckable(self, bool checkable)"""
5b5c9bc7 11089 return _core_.MenuItem_SetCheckable(*args, **kwargs)
d55e5bfc
RD		 11090
11091 def IsCheckable(*args, **kwargs):
11092 """IsCheckable(self) -> bool"""
5b5c9bc7 11093 return _core_.MenuItem_IsCheckable(*args, **kwargs)
d55e5bfc
RD		 11094
11095 def IsSubMenu(*args, **kwargs):
11096 """IsSubMenu(self) -> bool"""
5b5c9bc7 11097 return _core_.MenuItem_IsSubMenu(*args, **kwargs)
d55e5bfc
RD		 11098
11099 def SetSubMenu(*args, **kwargs):
5b5c9bc7
RD		 11100 """SetSubMenu(self, Menu menu)"""
11101 return _core_.MenuItem_SetSubMenu(*args, **kwargs)
d55e5bfc
RD		 11102
11103 def GetSubMenu(*args, **kwargs):
5b5c9bc7
RD		 11104 """GetSubMenu(self) -> Menu"""
11105 return _core_.MenuItem_GetSubMenu(*args, **kwargs)
d55e5bfc
RD		 11106
11107 def Enable(*args, **kwargs):
11108 """Enable(self, bool enable=True)"""
5b5c9bc7 11109 return _core_.MenuItem_Enable(*args, **kwargs)
d55e5bfc
RD		 11110
11111 def IsEnabled(*args, **kwargs):
11112 """IsEnabled(self) -> bool"""
5b5c9bc7 11113 return _core_.MenuItem_IsEnabled(*args, **kwargs)
d55e5bfc
RD		 11114
11115 def Check(*args, **kwargs):
11116 """Check(self, bool check=True)"""
5b5c9bc7 11117 return _core_.MenuItem_Check(*args, **kwargs)
d55e5bfc
RD		 11118
11119 def IsChecked(*args, **kwargs):
11120 """IsChecked(self) -> bool"""
5b5c9bc7 11121 return _core_.MenuItem_IsChecked(*args, **kwargs)
d55e5bfc
RD		 11122
11123 def Toggle(*args, **kwargs):
11124 """Toggle(self)"""
5b5c9bc7 11125 return _core_.MenuItem_Toggle(*args, **kwargs)
d55e5bfc
RD		 11126
11127 def SetHelp(*args, **kwargs):
5b5c9bc7
RD		 11128 """SetHelp(self, String str)"""
11129 return _core_.MenuItem_SetHelp(*args, **kwargs)
d55e5bfc
RD		 11130
11131 def GetHelp(*args, **kwargs):
5b5c9bc7
RD		 11132 """GetHelp(self) -> String"""
11133 return _core_.MenuItem_GetHelp(*args, **kwargs)
d55e5bfc
RD		 11134
11135 def GetAccel(*args, **kwargs):
5b5c9bc7
RD		 11136 """GetAccel(self) -> AcceleratorEntry"""
11137 return _core_.MenuItem_GetAccel(*args, **kwargs)
d55e5bfc
RD		 11138
11139 def SetAccel(*args, **kwargs):
5b5c9bc7
RD		 11140 """SetAccel(self, AcceleratorEntry accel)"""
11141 return _core_.MenuItem_SetAccel(*args, **kwargs)
d55e5bfc 11142
32fe5131
RD		 11143 def SetBitmap(*args, **kwargs):
11144 """SetBitmap(self, Bitmap bitmap)"""
11145 return _core_.MenuItem_SetBitmap(*args, **kwargs)
11146
11147 def GetBitmap(*args, **kwargs):
11148 """GetBitmap(self) -> Bitmap"""
11149 return _core_.MenuItem_GetBitmap(*args, **kwargs)
11150
c1280d1e 11151 def SetFont(*args, **kwargs):
5b5c9bc7
RD		 11152 """SetFont(self, Font font)"""
11153 return _core_.MenuItem_SetFont(*args, **kwargs)
c1280d1e
RD		 11154
11155 def GetFont(*args, **kwargs):
5b5c9bc7
RD		 11156 """GetFont(self) -> Font"""
11157 return _core_.MenuItem_GetFont(*args, **kwargs)
c1280d1e
RD		 11158
11159 def SetTextColour(*args, **kwargs):
5b5c9bc7
RD		 11160 """SetTextColour(self, Colour colText)"""
11161 return _core_.MenuItem_SetTextColour(*args, **kwargs)
c1280d1e
RD		 11162
11163 def GetTextColour(*args, **kwargs):
5b5c9bc7
RD		 11164 """GetTextColour(self) -> Colour"""
11165 return _core_.MenuItem_GetTextColour(*args, **kwargs)
c1280d1e
RD		 11166
11167 def SetBackgroundColour(*args, **kwargs):
5b5c9bc7
RD		 11168 """SetBackgroundColour(self, Colour colBack)"""
11169 return _core_.MenuItem_SetBackgroundColour(*args, **kwargs)
c1280d1e
RD		 11170
11171 def GetBackgroundColour(*args, **kwargs):
5b5c9bc7
RD		 11172 """GetBackgroundColour(self) -> Colour"""
11173 return _core_.MenuItem_GetBackgroundColour(*args, **kwargs)
c1280d1e
RD		 11174
11175 def SetBitmaps(*args, **kwargs):
5b5c9bc7
RD		 11176 """SetBitmaps(self, Bitmap bmpChecked, Bitmap bmpUnchecked=wxNullBitmap)"""
11177 return _core_.MenuItem_SetBitmaps(*args, **kwargs)
c1280d1e
RD		 11178
11179 def SetDisabledBitmap(*args, **kwargs):
5b5c9bc7
RD		 11180 """SetDisabledBitmap(self, Bitmap bmpDisabled)"""
11181 return _core_.MenuItem_SetDisabledBitmap(*args, **kwargs)
c1280d1e
RD		 11182
11183 def GetDisabledBitmap(*args, **kwargs):
5b5c9bc7
RD		 11184 """GetDisabledBitmap(self) -> Bitmap"""
11185 return _core_.MenuItem_GetDisabledBitmap(*args, **kwargs)
c1280d1e
RD		 11186
11187 def SetMarginWidth(*args, **kwargs):
11188 """SetMarginWidth(self, int nWidth)"""
5b5c9bc7 11189 return _core_.MenuItem_SetMarginWidth(*args, **kwargs)
c1280d1e
RD		 11190
11191 def GetMarginWidth(*args, **kwargs):
11192 """GetMarginWidth(self) -> int"""
5b5c9bc7 11193 return _core_.MenuItem_GetMarginWidth(*args, **kwargs)
c1280d1e 11194
d55e5bfc 11195 def GetDefaultMarginWidth(*args, **kwargs):
d6c14a4c 11196 """GetDefaultMarginWidth() -> int"""
5b5c9bc7 11197 return _core_.MenuItem_GetDefaultMarginWidth(*args, **kwargs)
d55e5bfc
RD		 11198
11199 GetDefaultMarginWidth = staticmethod(GetDefaultMarginWidth)
c1280d1e
RD		 11200 def IsOwnerDrawn(*args, **kwargs):
11201 """IsOwnerDrawn(self) -> bool"""
5b5c9bc7 11202 return _core_.MenuItem_IsOwnerDrawn(*args, **kwargs)
c1280d1e
RD		 11203
11204 def SetOwnerDrawn(*args, **kwargs):
11205 """SetOwnerDrawn(self, bool ownerDrawn=True)"""
5b5c9bc7 11206 return _core_.MenuItem_SetOwnerDrawn(*args, **kwargs)
c1280d1e
RD		 11207
11208 def ResetOwnerDrawn(*args, **kwargs):
11209 """ResetOwnerDrawn(self)"""
5b5c9bc7 11210 return _core_.MenuItem_ResetOwnerDrawn(*args, **kwargs)
c1280d1e 11211
57332a5a
RD		 11212 Accel = property(GetAccel,SetAccel,doc="See `GetAccel` and `SetAccel`")
11213 BackgroundColour = property(GetBackgroundColour,SetBackgroundColour,doc="See `GetBackgroundColour` and `SetBackgroundColour`")
11214 Bitmap = property(GetBitmap,SetBitmap,doc="See `GetBitmap` and `SetBitmap`")
11215 DisabledBitmap = property(GetDisabledBitmap,SetDisabledBitmap,doc="See `GetDisabledBitmap` and `SetDisabledBitmap`")
11216 Font = property(GetFont,SetFont,doc="See `GetFont` and `SetFont`")
11217 Help = property(GetHelp,SetHelp,doc="See `GetHelp` and `SetHelp`")
11218 Id = property(GetId,SetId,doc="See `GetId` and `SetId`")
11219 Kind = property(GetKind,SetKind,doc="See `GetKind` and `SetKind`")
11220 Label = property(GetLabel,doc="See `GetLabel`")
11221 MarginWidth = property(GetMarginWidth,SetMarginWidth,doc="See `GetMarginWidth` and `SetMarginWidth`")
11222 Menu = property(GetMenu,SetMenu,doc="See `GetMenu` and `SetMenu`")
11223 SubMenu = property(GetSubMenu,SetSubMenu,doc="See `GetSubMenu` and `SetSubMenu`")
11224 Text = property(GetText,SetText,doc="See `GetText` and `SetText`")
11225 TextColour = property(GetTextColour,SetTextColour,doc="See `GetTextColour` and `SetTextColour`")
2131d850 11226_core_.MenuItem_swigregister(MenuItem)
d55e5bfc 11227
5b5c9bc7 11228def MenuItem_GetLabelFromText(*args, **kwargs):
1bd55598
RD		 11229 """MenuItem_GetLabelFromText(String text) -> String"""
11230 return _core_.MenuItem_GetLabelFromText(*args, **kwargs)
d55e5bfc 11231
1bd55598
RD		 11232def MenuItem_GetDefaultMarginWidth(*args):
11233 """MenuItem_GetDefaultMarginWidth() -> int"""
11234 return _core_.MenuItem_GetDefaultMarginWidth(*args)
d55e5bfc
RD		 11235
11236#---------------------------------------------------------------------------
11237
5b5c9bc7 11238class Control(Window):
d55e5bfc
RD		 11239 """
11240 This is the base class for a control or 'widget'.
11241
15817c7e
RD		 11242 A control is generally a small window which processes user input
11243 and/or displays one or more item of data.
d55e5bfc 11244 """
1bd55598
RD		 11245 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11246 __repr__ = _swig_repr
11247 def __init__(self, *args, **kwargs):
d55e5bfc 11248 """
5b5c9bc7
RD		 11249 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
11250 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
11251 String name=ControlNameStr) -> Control
d55e5bfc 11252
15817c7e
RD		 11253 Create a Control. Normally you should only call this from a subclass'
11254 __init__ as a plain old wx.Control is not very useful.
d55e5bfc 11255 """
1bd55598 11256 _core_.Control_swiginit(self,_core_.new_Control(*args, **kwargs))
d55e5bfc
RD		 11257 self._setOORInfo(self)
11258
11259 def Create(*args, **kwargs):
11260 """
5b5c9bc7
RD		 11261 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
11262 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
11263 String name=ControlNameStr) -> bool
d55e5bfc
RD		 11264
11265 Do the 2nd phase and create the GUI control.
11266 """
5b5c9bc7 11267 return _core_.Control_Create(*args, **kwargs)
d55e5bfc 11268
1eeb270e
RD		 11269 def GetAlignment(*args, **kwargs):
11270 """
11271 GetAlignment(self) -> int
11272
11273 Get the control alignment (left/right/centre, top/bottom/centre)
11274 """
11275 return _core_.Control_GetAlignment(*args, **kwargs)
11276
34e0a3bb 11277 def GetLabelText(*args, **kwargs):
1eeb270e 11278 """
1eeb270e
RD		 11279 GetLabelText(self) -> String
11280
11281 Get just the text of the label, without mnemonic characters ('&')
11282 """
34e0a3bb 11283 return _core_.Control_GetLabelText(*args, **kwargs)
1eeb270e 11284
d55e5bfc
RD		 11285 def Command(*args, **kwargs):
11286 """
5b5c9bc7 11287 Command(self, CommandEvent event)
d55e5bfc 11288
15817c7e
RD		 11289 Simulates the effect of the user issuing a command to the item.
11290
11291 :see: `wx.CommandEvent`
11292
d55e5bfc 11293 """
5b5c9bc7 11294 return _core_.Control_Command(*args, **kwargs)
d55e5bfc 11295
d55e5bfc 11296 def GetClassDefaultAttributes(*args, **kwargs):
110da5b0 11297 """
5b5c9bc7 11298 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
110da5b0
RD		 11299
11300 Get the default attributes for this class. This is useful if you want
11301 to use the same font or colour in your own control as in a standard
11302 control -- which is a much better idea than hard coding specific
11303 colours or fonts which might look completely out of place on the
11304 user's system, especially if it uses themes.
11305
11306 The variant parameter is only relevant under Mac currently and is
11307 ignore under other platforms. Under Mac, it will change the size of
11308 the returned font. See `wx.Window.SetWindowVariant` for more about
11309 this.
11310 """
5b5c9bc7 11311 return _core_.Control_GetClassDefaultAttributes(*args, **kwargs)
d55e5bfc
RD		 11312
11313 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
2bf58437 11314 Alignment = property(GetAlignment,doc="See `GetAlignment`")
2bf58437 11315 LabelText = property(GetLabelText,doc="See `GetLabelText`")
2131d850 11316_core_.Control_swigregister(Control)
d55e5bfc
RD		 11317ControlNameStr = cvar.ControlNameStr
11318
11319def PreControl(*args, **kwargs):
11320 """
5b5c9bc7 11321 PreControl() -> Control
d55e5bfc
RD		 11322
11323 Precreate a Control control for 2-phase creation
11324 """
5b5c9bc7 11325 val = _core_.new_PreControl(*args, **kwargs)
d55e5bfc
RD		 11326 return val
11327
5b5c9bc7 11328def Control_GetClassDefaultAttributes(*args, **kwargs):
1bd55598 11329 """
5b5c9bc7 11330 Control_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
110da5b0
RD		 11331
11332 Get the default attributes for this class. This is useful if you want
11333 to use the same font or colour in your own control as in a standard
11334 control -- which is a much better idea than hard coding specific
11335 colours or fonts which might look completely out of place on the
11336 user's system, especially if it uses themes.
11337
11338 The variant parameter is only relevant under Mac currently and is
11339 ignore under other platforms. Under Mac, it will change the size of
11340 the returned font. See `wx.Window.SetWindowVariant` for more about
11341 this.
11342 """
1bd55598 11343 return _core_.Control_GetClassDefaultAttributes(*args, **kwargs)
d55e5bfc
RD		 11344
11345#---------------------------------------------------------------------------
11346
5b5c9bc7 11347class ItemContainer(object):
d55e5bfc 11348 """
53aa7709
RD		 11349 The wx.ItemContainer class defines an interface which is implemented
11350 by all controls which have string subitems, each of which may be
11351 selected, such as `wx.ListBox`, `wx.CheckListBox`, `wx.Choice` as well
11352 as `wx.ComboBox` which implements an extended interface deriving from
15817c7e 11353 this one.
d55e5bfc 11354
15817c7e
RD		 11355 It defines the methods for accessing the control's items and although
11356 each of the derived classes implements them differently, they still
11357 all conform to the same interface.
d55e5bfc 11358
15817c7e
RD		 11359 The items in a wx.ItemContainer have (non empty) string labels and,
11360 optionally, client data associated with them.
d55e5bfc
RD		 11361
11362 """
1bd55598
RD		 11363 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11364 def __init__(self): raise AttributeError, "No constructor defined"
11365 __repr__ = _swig_repr
d55e5bfc
RD		 11366 def Append(*args, **kwargs):
11367 """
5b5c9bc7 11368 Append(self, String item, PyObject clientData=None) -> int
d55e5bfc 11369
15817c7e
RD		 11370 Adds the item to the control, associating the given data with the item
11371 if not None. The return value is the index of the newly added item
11372 which may be different from the last one if the control is sorted (e.g.
11373 has wx.LB_SORT or wx.CB_SORT style).
d55e5bfc 11374 """
5b5c9bc7 11375 return _core_.ItemContainer_Append(*args, **kwargs)
d55e5bfc
RD		 11376
11377 def AppendItems(*args, **kwargs):
11378 """
f5b96ee1 11379 AppendItems(self, List strings)
d55e5bfc 11380
15817c7e
RD		 11381 Apend several items at once to the control. Notice that calling this
11382 method may be much faster than appending the items one by one if you
11383 need to add a lot of items.
d55e5bfc 11384 """
5b5c9bc7 11385 return _core_.ItemContainer_AppendItems(*args, **kwargs)
d55e5bfc
RD		 11386
11387 def Insert(*args, **kwargs):
11388 """
50f151d7 11389 Insert(self, String item, unsigned int pos, PyObject clientData=None) -> int
d55e5bfc 11390
15817c7e 11391 Insert an item into the control before the item at the ``pos`` index,
d55e5bfc
RD		 11392 optionally associating some data object with the item.
11393 """
5b5c9bc7 11394 return _core_.ItemContainer_Insert(*args, **kwargs)
d55e5bfc
RD		 11395
11396 def Clear(*args, **kwargs):
11397 """
11398 Clear(self)
11399
11400 Removes all items from the control.
11401 """
5b5c9bc7 11402 return _core_.ItemContainer_Clear(*args, **kwargs)
d55e5bfc
RD		 11403
11404 def Delete(*args, **kwargs):
11405 """
50f151d7 11406 Delete(self, unsigned int n)
d55e5bfc 11407
15817c7e
RD		 11408 Deletes the item at the zero-based index 'n' from the control. Note
11409 that it is an error (signalled by a `wx.PyAssertionError` exception if
11410 enabled) to remove an item with the index negative or greater or equal
11411 than the number of items in the control.
d55e5bfc 11412 """
5b5c9bc7 11413 return _core_.ItemContainer_Delete(*args, **kwargs)
d55e5bfc 11414
53aa7709
RD		 11415 def GetClientData(*args, **kwargs):
11416 """
50f151d7 11417 GetClientData(self, unsigned int n) -> PyObject
53aa7709
RD		 11418
11419 Returns the client data associated with the given item, (if any.)
11420 """
5b5c9bc7 11421 return _core_.ItemContainer_GetClientData(*args, **kwargs)
53aa7709
RD		 11422
11423 def SetClientData(*args, **kwargs):
11424 """
50f151d7 11425 SetClientData(self, unsigned int n, PyObject clientData)
53aa7709
RD		 11426
11427 Associate the given client data with the item at position n.
11428 """
5b5c9bc7 11429 return _core_.ItemContainer_SetClientData(*args, **kwargs)
53aa7709 11430
d55e5bfc
RD		 11431 def GetCount(*args, **kwargs):
11432 """
50f151d7 11433 GetCount(self) -> unsigned int
d55e5bfc
RD		 11434
11435 Returns the number of items in the control.
11436 """
5b5c9bc7 11437 return _core_.ItemContainer_GetCount(*args, **kwargs)
d55e5bfc
RD		 11438
11439 def IsEmpty(*args, **kwargs):
11440 """
11441 IsEmpty(self) -> bool
11442
11443 Returns True if the control is empty or False if it has some items.
11444 """
5b5c9bc7 11445 return _core_.ItemContainer_IsEmpty(*args, **kwargs)
d55e5bfc
RD		 11446
11447 def GetString(*args, **kwargs):
11448 """
50f151d7 11449 GetString(self, unsigned int n) -> String
d55e5bfc
RD		 11450
11451 Returns the label of the item with the given index.
11452 """
5b5c9bc7 11453 return _core_.ItemContainer_GetString(*args, **kwargs)
d55e5bfc
RD		 11454
11455 def GetStrings(*args, **kwargs):
11456 """GetStrings(self) -> wxArrayString"""
5b5c9bc7 11457 return _core_.ItemContainer_GetStrings(*args, **kwargs)
d55e5bfc
RD		 11458
11459 def SetString(*args, **kwargs):
11460 """
50f151d7 11461 SetString(self, unsigned int n, String s)
d55e5bfc
RD		 11462
11463 Sets the label for the given item.
11464 """
5b5c9bc7 11465 return _core_.ItemContainer_SetString(*args, **kwargs)
d55e5bfc
RD		 11466
11467 def FindString(*args, **kwargs):
11468 """
5b5c9bc7 11469 FindString(self, String s) -> int
d55e5bfc
RD		 11470
11471 Finds an item whose label matches the given string. Returns the
15817c7e
RD		 11472 zero-based position of the item, or ``wx.NOT_FOUND`` if the string was not
11473 found.
d55e5bfc 11474 """
5b5c9bc7 11475 return _core_.ItemContainer_FindString(*args, **kwargs)
d55e5bfc 11476
53aa7709 11477 def SetSelection(*args, **kwargs):
d55e5bfc 11478 """
53aa7709 11479 SetSelection(self, int n)
d55e5bfc
RD		 11480
11481 Sets the item at index 'n' to be the selected item.
11482 """
5b5c9bc7 11483 return _core_.ItemContainer_SetSelection(*args, **kwargs)
d55e5bfc 11484
d55e5bfc
RD		 11485 def GetSelection(*args, **kwargs):
11486 """
11487 GetSelection(self) -> int
11488
15817c7e
RD		 11489 Returns the index of the selected item or ``wx.NOT_FOUND`` if no item
11490 is selected.
d55e5bfc 11491 """
5b5c9bc7 11492 return _core_.ItemContainer_GetSelection(*args, **kwargs)
d55e5bfc 11493
53aa7709 11494 def SetStringSelection(*args, **kwargs):
5b5c9bc7
RD		 11495 """SetStringSelection(self, String s) -> bool"""
11496 return _core_.ItemContainer_SetStringSelection(*args, **kwargs)
53aa7709 11497
d55e5bfc
RD		 11498 def GetStringSelection(*args, **kwargs):
11499 """
5b5c9bc7 11500 GetStringSelection(self) -> String
d55e5bfc 11501
15817c7e
RD		 11502 Returns the label of the selected item or an empty string if no item
11503 is selected.
d55e5bfc 11504 """
5b5c9bc7 11505 return _core_.ItemContainer_GetStringSelection(*args, **kwargs)
d55e5bfc 11506
53aa7709 11507 def Select(*args, **kwargs):
d55e5bfc 11508 """
53aa7709 11509 Select(self, int n)
d55e5bfc 11510
53aa7709
RD		 11511 This is the same as `SetSelection` and exists only because it is
11512 slightly more natural for controls which support multiple selection.
d55e5bfc 11513 """
5b5c9bc7 11514 return _core_.ItemContainer_Select(*args, **kwargs)
d55e5bfc 11515
ac5d357a
RD		 11516 def GetItems(self):
11517 """Return a list of the strings in the control"""
11518 return [self.GetString(i) for i in xrange(self.GetCount())]
11519
11520 def SetItems(self, items):
11521 """Clear and set the strings in the control from a list"""
11522 self.Clear()
11523 for i in items:
11524 self.Append(i)
11525
11526 Count = property(GetCount,doc="See `GetCount`")
11527 Items = property(GetItems,SetItems,doc="See `GetItems` and `SetItems`")
11528 Selection = property(GetSelection,SetSelection,doc="See `GetSelection` and `SetSelection`")
11529 StringSelection = property(GetStringSelection,SetStringSelection,doc="See `GetStringSelection` and `SetStringSelection`")
11530 Strings = property(GetStrings,doc="See `GetStrings`")
2131d850 11531_core_.ItemContainer_swigregister(ItemContainer)
d55e5bfc
RD		 11532
11533#---------------------------------------------------------------------------
11534
5b5c9bc7 11535class ControlWithItems(Control,ItemContainer):
d55e5bfc 11536 """
15817c7e
RD		 11537 wx.ControlWithItems combines the ``wx.ItemContainer`` class with the
11538 wx.Control class, and is used for the base class of various controls
11539 that have items.
d55e5bfc 11540 """
1bd55598
RD		 11541 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11542 def __init__(self): raise AttributeError, "No constructor defined"
11543 __repr__ = _swig_repr
2131d850 11544_core_.ControlWithItems_swigregister(ControlWithItems)
d55e5bfc
RD		 11545
11546#---------------------------------------------------------------------------
11547
5b5c9bc7 11548class SizerItem(Object):
bfddbb17
RD		 11549 """
11550 The wx.SizerItem class is used to track the position, size and other
2131d850
RD		 11551 attributes of each item managed by a `wx.Sizer`. It is not usually
11552 necessary to use this class because the sizer elements can also be
11553 identified by their positions or window or sizer references but
11554 sometimes it may be more convenient to use wx.SizerItem directly.
11555 Also, custom classes derived from `wx.PySizer` will probably need to
11556 use the collection of wx.SizerItems held by wx.Sizer when calculating
11557 layout.
bfddbb17
RD		 11558
11559 :see: `wx.Sizer`, `wx.GBSizerItem`
11560 """
1bd55598
RD		 11561 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11562 __repr__ = _swig_repr
11563 def __init__(self, *args, **kwargs):
bfddbb17 11564 """
5b5c9bc7 11565 __init__(self) -> SizerItem
bfddbb17
RD		 11566
11567 Constructs an empty wx.SizerItem. Either a window, sizer or spacer
11568 size will need to be set before this item can be used in a Sizer.
11569
11570 You will probably never need to create a wx.SizerItem directly as they
11571 are created automatically when the sizer's Add, Insert or Prepend
11572 methods are called.
11573
11574 :see: `wx.SizerItemSpacer`, `wx.SizerItemWindow`, `wx.SizerItemSizer`
11575 """
1bd55598
RD		 11576 _core_.SizerItem_swiginit(self,_core_.new_SizerItem(*args, **kwargs))
11577 __swig_destroy__ = _core_.delete_SizerItem
11578 __del__ = lambda self : None;
d55e5bfc 11579 def DeleteWindows(*args, **kwargs):
bfddbb17
RD		 11580 """
11581 DeleteWindows(self)
11582
11583 Destroy the window or the windows in a subsizer, depending on the type
11584 of item.
11585 """
5b5c9bc7 11586 return _core_.SizerItem_DeleteWindows(*args, **kwargs)
d55e5bfc
RD		 11587
11588 def DetachSizer(*args, **kwargs):
bfddbb17
RD		 11589 """
11590 DetachSizer(self)
11591
11592 Enable deleting the SizerItem without destroying the contained sizer.
11593 """
5b5c9bc7 11594 return _core_.SizerItem_DetachSizer(*args, **kwargs)
d55e5bfc
RD		 11595
11596 def GetSize(*args, **kwargs):
bfddbb17 11597 """
5b5c9bc7 11598 GetSize(self) -> Size
bfddbb17
RD		 11599
11600 Get the current size of the item, as set in the last Layout.
11601 """
5b5c9bc7 11602 return _core_.SizerItem_GetSize(*args, **kwargs)
d55e5bfc
RD		 11603
11604 def CalcMin(*args, **kwargs):
bfddbb17 11605 """
5b5c9bc7 11606 CalcMin(self) -> Size
bfddbb17
RD		 11607
11608 Calculates the minimum desired size for the item, including any space
11609 needed by borders.
11610 """
5b5c9bc7 11611 return _core_.SizerItem_CalcMin(*args, **kwargs)
d55e5bfc
RD		 11612
11613 def SetDimension(*args, **kwargs):
bfddbb17 11614 """
5b5c9bc7 11615 SetDimension(self, Point pos, Size size)
bfddbb17
RD		 11616
11617 Set the position and size of the space allocated for this item by the
11618 sizer, and adjust the position and size of the item (window or
11619 subsizer) to be within that space taking alignment and borders into
11620 account.
11621 """
5b5c9bc7 11622 return _core_.SizerItem_SetDimension(*args, **kwargs)
d55e5bfc
RD		 11623
11624 def GetMinSize(*args, **kwargs):
bfddbb17 11625 """
5b5c9bc7 11626 GetMinSize(self) -> Size
bfddbb17
RD		 11627
11628 Get the minimum size needed for the item.
11629 """
5b5c9bc7 11630 return _core_.SizerItem_GetMinSize(*args, **kwargs)
d55e5bfc 11631
a001823c
RD		 11632 def GetMinSizeWithBorder(*args, **kwargs):
11633 """
5b5c9bc7 11634 GetMinSizeWithBorder(self) -> Size
a001823c
RD		 11635
11636 Get the minimum size needed for the item with space for the borders
11637 added, if needed.
11638 """
5b5c9bc7 11639 return _core_.SizerItem_GetMinSizeWithBorder(*args, **kwargs)
a001823c 11640
d55e5bfc
RD		 11641 def SetInitSize(*args, **kwargs):
11642 """SetInitSize(self, int x, int y)"""
5b5c9bc7 11643 return _core_.SizerItem_SetInitSize(*args, **kwargs)
d55e5bfc
RD		 11644
11645 def SetRatioWH(*args, **kwargs):
bfddbb17
RD		 11646 """
11647 SetRatioWH(self, int width, int height)
11648
11649 Set the ratio item attribute.
11650 """
5b5c9bc7 11651 return _core_.SizerItem_SetRatioWH(*args, **kwargs)
d55e5bfc
RD		 11652
11653 def SetRatioSize(*args, **kwargs):
bfddbb17 11654 """
5b5c9bc7 11655 SetRatioSize(self, Size size)
bfddbb17
RD		 11656
11657 Set the ratio item attribute.
11658 """
5b5c9bc7 11659 return _core_.SizerItem_SetRatioSize(*args, **kwargs)
d55e5bfc
RD		 11660
11661 def SetRatio(*args, **kwargs):
bfddbb17
RD		 11662 """
11663 SetRatio(self, float ratio)
11664
11665 Set the ratio item attribute.
11666 """
5b5c9bc7 11667 return _core_.SizerItem_SetRatio(*args, **kwargs)
d55e5bfc
RD		 11668
11669 def GetRatio(*args, **kwargs):
bfddbb17
RD		 11670 """
11671 GetRatio(self) -> float
11672
11673 Set the ratio item attribute.
11674 """
5b5c9bc7 11675 return _core_.SizerItem_GetRatio(*args, **kwargs)
d55e5bfc 11676
070c48b4
RD		 11677 def GetRect(*args, **kwargs):
11678 """
5b5c9bc7 11679 GetRect(self) -> Rect
070c48b4
RD		 11680
11681 Returns the rectangle that the sizer item should occupy
11682 """
5b5c9bc7 11683 return _core_.SizerItem_GetRect(*args, **kwargs)
070c48b4 11684
d55e5bfc 11685 def IsWindow(*args, **kwargs):
bfddbb17
RD		 11686 """
11687 IsWindow(self) -> bool
11688
11689 Is this sizer item a window?
11690 """
5b5c9bc7 11691 return _core_.SizerItem_IsWindow(*args, **kwargs)
d55e5bfc
RD		 11692
11693 def IsSizer(*args, **kwargs):
bfddbb17
RD		 11694 """
11695 IsSizer(self) -> bool
11696
11697 Is this sizer item a subsizer?
11698 """
5b5c9bc7 11699 return _core_.SizerItem_IsSizer(*args, **kwargs)
d55e5bfc
RD		 11700
11701 def IsSpacer(*args, **kwargs):
bfddbb17
RD		 11702 """
11703 IsSpacer(self) -> bool
11704
11705 Is this sizer item a spacer?
11706 """
5b5c9bc7 11707 return _core_.SizerItem_IsSpacer(*args, **kwargs)
d55e5bfc
RD		 11708
11709 def SetProportion(*args, **kwargs):
bfddbb17
RD		 11710 """
11711 SetProportion(self, int proportion)
11712
11713 Set the proportion value for this item.
11714 """
5b5c9bc7 11715 return _core_.SizerItem_SetProportion(*args, **kwargs)
d55e5bfc
RD		 11716
11717 def GetProportion(*args, **kwargs):
bfddbb17
RD		 11718 """
11719 GetProportion(self) -> int
11720
11721 Get the proportion value for this item.
11722 """
5b5c9bc7 11723 return _core_.SizerItem_GetProportion(*args, **kwargs)
d55e5bfc 11724
bfddbb17
RD		 11725 SetOption = wx._deprecated(SetProportion, "Please use `SetProportion` instead.")
11726 GetOption = wx._deprecated(GetProportion, "Please use `GetProportion` instead.")
d55e5bfc 11727 def SetFlag(*args, **kwargs):
bfddbb17
RD		 11728 """
11729 SetFlag(self, int flag)
11730
11731 Set the flag value for this item.
11732 """
5b5c9bc7 11733 return _core_.SizerItem_SetFlag(*args, **kwargs)
d55e5bfc
RD		 11734
11735 def GetFlag(*args, **kwargs):
bfddbb17
RD		 11736 """
11737 GetFlag(self) -> int
11738
11739 Get the flag value for this item.
11740 """
5b5c9bc7 11741 return _core_.SizerItem_GetFlag(*args, **kwargs)
d55e5bfc
RD		 11742
11743 def SetBorder(*args, **kwargs):
bfddbb17
RD		 11744 """
11745 SetBorder(self, int border)
11746
11747 Set the border value for this item.
11748 """
5b5c9bc7 11749 return _core_.SizerItem_SetBorder(*args, **kwargs)
d55e5bfc
RD		 11750
11751 def GetBorder(*args, **kwargs):
bfddbb17
RD		 11752 """
11753 GetBorder(self) -> int
11754
11755 Get the border value for this item.
11756 """
5b5c9bc7 11757 return _core_.SizerItem_GetBorder(*args, **kwargs)
d55e5bfc
RD		 11758
11759 def GetWindow(*args, **kwargs):
bfddbb17 11760 """
5b5c9bc7 11761 GetWindow(self) -> Window
bfddbb17
RD		 11762
11763 Get the window (if any) that is managed by this sizer item.
11764 """
5b5c9bc7 11765 return _core_.SizerItem_GetWindow(*args, **kwargs)
d55e5bfc
RD		 11766
11767 def SetWindow(*args, **kwargs):
bfddbb17 11768 """
5b5c9bc7 11769 SetWindow(self, Window window)
bfddbb17
RD		 11770
11771 Set the window to be managed by this sizer item.
11772 """
5b5c9bc7 11773 return _core_.SizerItem_SetWindow(*args, **kwargs)
d55e5bfc
RD		 11774
11775 def GetSizer(*args, **kwargs):
bfddbb17 11776 """
5b5c9bc7 11777 GetSizer(self) -> Sizer
bfddbb17
RD		 11778
11779 Get the subsizer (if any) that is managed by this sizer item.
11780 """
5b5c9bc7 11781 return _core_.SizerItem_GetSizer(*args, **kwargs)
d55e5bfc
RD		 11782
11783 def SetSizer(*args, **kwargs):
bfddbb17 11784 """
5b5c9bc7 11785 SetSizer(self, Sizer sizer)
bfddbb17
RD		 11786
11787 Set the subsizer to be managed by this sizer item.
11788 """
5b5c9bc7 11789 return _core_.SizerItem_SetSizer(*args, **kwargs)
d55e5bfc
RD		 11790
11791 def GetSpacer(*args, **kwargs):
bfddbb17 11792 """
5b5c9bc7 11793 GetSpacer(self) -> Size
bfddbb17
RD		 11794
11795 Get the size of the spacer managed by this sizer item.
11796 """
5b5c9bc7 11797 return _core_.SizerItem_GetSpacer(*args, **kwargs)
d55e5bfc
RD		 11798
11799 def SetSpacer(*args, **kwargs):
bfddbb17 11800 """
5b5c9bc7 11801 SetSpacer(self, Size size)
bfddbb17
RD		 11802
11803 Set the size of the spacer to be managed by this sizer item.
11804 """
5b5c9bc7 11805 return _core_.SizerItem_SetSpacer(*args, **kwargs)
d55e5bfc
RD		 11806
11807 def Show(*args, **kwargs):
bfddbb17
RD		 11808 """
11809 Show(self, bool show)
11810
11811 Set the show item attribute, which sizers use to determine if the item
11812 is to be made part of the layout or not. If the item is tracking a
11813 window then it is shown or hidden as needed.
11814 """
5b5c9bc7 11815 return _core_.SizerItem_Show(*args, **kwargs)
d55e5bfc
RD		 11816
11817 def IsShown(*args, **kwargs):
bfddbb17
RD		 11818 """
11819 IsShown(self) -> bool
11820
11821 Is the item to be shown in the layout?
11822 """
5b5c9bc7 11823 return _core_.SizerItem_IsShown(*args, **kwargs)
d55e5bfc
RD		 11824
11825 def GetPosition(*args, **kwargs):
bfddbb17 11826 """
5b5c9bc7 11827 GetPosition(self) -> Point
bfddbb17
RD		 11828
11829 Returns the current position of the item, as set in the last Layout.
11830 """
5b5c9bc7 11831 return _core_.SizerItem_GetPosition(*args, **kwargs)
d55e5bfc
RD		 11832
11833 def GetUserData(*args, **kwargs):
bfddbb17
RD		 11834 """
11835 GetUserData(self) -> PyObject
11836
11837 Returns the userData associated with this sizer item, or None if there
11838 isn't any.
11839 """
5b5c9bc7 11840 return _core_.SizerItem_GetUserData(*args, **kwargs)
d55e5bfc 11841
32fe5131
RD		 11842 def SetUserData(*args, **kwargs):
11843 """
11844 SetUserData(self, PyObject userData)
11845
11846 Associate a Python object with this sizer item.
11847 """
11848 return _core_.SizerItem_SetUserData(*args, **kwargs)
11849
33d6fd3b
RD		 11850 Border = property(GetBorder,SetBorder,doc="See `GetBorder` and `SetBorder`")
11851 Flag = property(GetFlag,SetFlag,doc="See `GetFlag` and `SetFlag`")
11852 MinSize = property(GetMinSize,doc="See `GetMinSize`")
11853 MinSizeWithBorder = property(GetMinSizeWithBorder,doc="See `GetMinSizeWithBorder`")
11854 Position = property(GetPosition,doc="See `GetPosition`")
11855 Proportion = property(GetProportion,SetProportion,doc="See `GetProportion` and `SetProportion`")
11856 Ratio = property(GetRatio,SetRatio,doc="See `GetRatio` and `SetRatio`")
11857 Rect = property(GetRect,doc="See `GetRect`")
11858 Size = property(GetSize,doc="See `GetSize`")
11859 Sizer = property(GetSizer,SetSizer,doc="See `GetSizer` and `SetSizer`")
11860 Spacer = property(GetSpacer,SetSpacer,doc="See `GetSpacer` and `SetSpacer`")
11861 UserData = property(GetUserData,SetUserData,doc="See `GetUserData` and `SetUserData`")
11862 Window = property(GetWindow,SetWindow,doc="See `GetWindow` and `SetWindow`")
2131d850 11863_core_.SizerItem_swigregister(SizerItem)
d55e5bfc 11864
bfddbb17 11865def SizerItemWindow(*args, **kwargs):
d55e5bfc 11866 """
5b5c9bc7
RD		 11867 SizerItemWindow(Window window, int proportion, int flag, int border,
11868 PyObject userData=None) -> SizerItem
bfddbb17
RD		 11869
11870 Constructs a `wx.SizerItem` for tracking a window.
d55e5bfc 11871 """
5b5c9bc7 11872 val = _core_.new_SizerItemWindow(*args, **kwargs)
d55e5bfc
RD		 11873 return val
11874
bfddbb17 11875def SizerItemSpacer(*args, **kwargs):
d55e5bfc 11876 """
bfddbb17 11877 SizerItemSpacer(int width, int height, int proportion, int flag, int border,
5b5c9bc7 11878 PyObject userData=None) -> SizerItem
bfddbb17
RD		 11879
11880 Constructs a `wx.SizerItem` for tracking a spacer.
d55e5bfc 11881 """
5b5c9bc7 11882 val = _core_.new_SizerItemSpacer(*args, **kwargs)
d55e5bfc
RD		 11883 return val
11884
11885def SizerItemSizer(*args, **kwargs):
11886 """
5b5c9bc7
RD		 11887 SizerItemSizer(Sizer sizer, int proportion, int flag, int border,
11888 PyObject userData=None) -> SizerItem
bfddbb17
RD		 11889
11890 Constructs a `wx.SizerItem` for tracking a subsizer
d55e5bfc 11891 """
5b5c9bc7 11892 val = _core_.new_SizerItemSizer(*args, **kwargs)
d55e5bfc
RD		 11893 return val
11894
5b5c9bc7 11895class Sizer(Object):
bfddbb17
RD		 11896 """
11897 wx.Sizer is the abstract base class used for laying out subwindows in
11898 a window. You cannot use wx.Sizer directly; instead, you will have to
11899 use one of the sizer classes derived from it such as `wx.BoxSizer`,
1d5ee749
RD		 11900 `wx.StaticBoxSizer`, `wx.GridSizer`, `wx.FlexGridSizer` and
11901 `wx.GridBagSizer`.
bfddbb17
RD		 11902
11903 The concept implemented by sizers in wxWidgets is closely related to
11904 layout tools in other GUI toolkits, such as Java's AWT, the GTK
11905 toolkit or the Qt toolkit. It is based upon the idea of the individual
11906 subwindows reporting their minimal required size and their ability to
11907 get stretched if the size of the parent window has changed. This will
11908 most often mean that the programmer does not set the original size of
11909 a dialog in the beginning, rather the dialog will assigned a sizer and
11910 this sizer will be queried about the recommended size. The sizer in
11911 turn will query its children, which can be normal windows or contorls,
11912 empty space or other sizers, so that a hierarchy of sizers can be
11913 constructed. Note that wxSizer does not derive from wxWindow and thus
11914 do not interfere with tab ordering and requires very little resources
11915 compared to a real window on screen.
11916
11917 What makes sizers so well fitted for use in wxWidgets is the fact that
11918 every control reports its own minimal size and the algorithm can
11919 handle differences in font sizes or different window (dialog item)
11920 sizes on different platforms without problems. If for example the
11921 standard font as well as the overall design of Mac widgets requires
11922 more space than on Windows, then the initial size of a dialog using a
11923 sizer will automatically be bigger on Mac than on Windows.
11924 """
1bd55598
RD		 11925 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11926 def __init__(self): raise AttributeError, "No constructor defined"
11927 __repr__ = _swig_repr
11928 __swig_destroy__ = _core_.delete_Sizer
11929 __del__ = lambda self : None;
d55e5bfc
RD		 11930 def _setOORInfo(*args, **kwargs):
11931 """_setOORInfo(self, PyObject _self)"""
5b5c9bc7 11932 return _core_.Sizer__setOORInfo(*args, **kwargs)
d55e5bfc
RD		 11933
11934 def Add(*args, **kwargs):
11935 """
bfddbb17 11936 Add(self, item, int proportion=0, int flag=0, int border=0,
070c48b4 11937 PyObject userData=None) -> wx.SizerItem
bfddbb17
RD		 11938
11939 Appends a child item to the sizer.
d55e5bfc 11940 """
5b5c9bc7 11941 return _core_.Sizer_Add(*args, **kwargs)
d55e5bfc
RD		 11942
11943 def Insert(*args, **kwargs):
11944 """
bfddbb17 11945 Insert(self, int before, item, int proportion=0, int flag=0, int border=0,
070c48b4 11946 PyObject userData=None) -> wx.SizerItem
bfddbb17
RD		 11947
11948 Inserts a new item into the list of items managed by this sizer before
11949 the item at index *before*. See `Add` for a description of the parameters.
d55e5bfc 11950 """
5b5c9bc7 11951 return _core_.Sizer_Insert(*args, **kwargs)
d55e5bfc
RD		 11952
11953 def Prepend(*args, **kwargs):
11954 """
bfddbb17 11955 Prepend(self, item, int proportion=0, int flag=0, int border=0,
070c48b4 11956 PyObject userData=None) -> wx.SizerItem
bfddbb17
RD		 11957
11958 Adds a new item to the begining of the list of sizer items managed by
11959 this sizer. See `Add` for a description of the parameters.
d55e5bfc 11960 """
5b5c9bc7 11961 return _core_.Sizer_Prepend(*args, **kwargs)
d55e5bfc
RD		 11962
11963 def Remove(*args, **kwargs):
bfddbb17
RD		 11964 """
11965 Remove(self, item) -> bool
11966
11967 Removes an item from the sizer and destroys it. This method does not
11968 cause any layout or resizing to take place, call `Layout` to update
11969 the layout on screen after removing a child from the sizer. The
11970 *item* parameter can be either a window, a sizer, or the zero-based
11971 index of an item to remove. Returns True if the child item was found
11972 and removed.
11973 """
5b5c9bc7 11974 return _core_.Sizer_Remove(*args, **kwargs)
d55e5bfc 11975
1a6bba1e 11976 def Detach(*args, **kwargs):
bfddbb17
RD		 11977 """
11978 Detach(self, item) -> bool
11979
11980 Detaches an item from the sizer without destroying it. This method
11981 does not cause any layout or resizing to take place, call `Layout` to
11982 do so. The *item* parameter can be either a window, a sizer, or the
11983 zero-based index of the item to be detached. Returns True if the child item
11984 was found and detached.
11985 """
5b5c9bc7 11986 return _core_.Sizer_Detach(*args, **kwargs)
1a6bba1e 11987
070c48b4
RD		 11988 def GetItem(*args, **kwargs):
11989 """
11990 GetItem(self, item) -> wx.SizerItem
11991
11992 Returns the `wx.SizerItem` which holds the *item* given. The *item*
11993 parameter can be either a window, a sizer, or the zero-based index of
4d170c95 11994 the item to be found.
070c48b4 11995 """
5b5c9bc7 11996 return _core_.Sizer_GetItem(*args, **kwargs)
070c48b4 11997
d55e5bfc 11998 def _SetItemMinSize(*args, **kwargs):
5b5c9bc7
RD		 11999 """_SetItemMinSize(self, PyObject item, Size size)"""
12000 return _core_.Sizer__SetItemMinSize(*args, **kwargs)
d55e5bfc 12001
ac5d357a
RD		 12002 def _ReplaceWin(*args, **kwargs):
12003 """_ReplaceWin(self, Window oldwin, Window newwin, bool recursive=False) -> bool"""
12004 return _core_.Sizer__ReplaceWin(*args, **kwargs)
12005
12006 def _ReplaceSizer(*args, **kwargs):
12007 """_ReplaceSizer(self, Sizer oldsz, Sizer newsz, bool recursive=False) -> bool"""
12008 return _core_.Sizer__ReplaceSizer(*args, **kwargs)
12009
12010 def _ReplaceItem(*args, **kwargs):
12011 """_ReplaceItem(self, size_t index, SizerItem newitem) -> bool"""
12012 return _core_.Sizer__ReplaceItem(*args, **kwargs)
12013
12014 def Replace(self, olditem, item, recursive=False):
12015 """
12016 Detaches the given ``olditem`` from the sizer and replaces it with
12017 ``item`` which can be a window, sizer, or `wx.SizerItem`. The
12018 detached child is destroyed only if it is not a window, (because
12019 windows are owned by their parent, not the sizer.) The
12020 ``recursive`` parameter can be used to search for the given
12021 element recursivly in subsizers.
12022
12023 This method does not cause any layout or resizing to take place,
12024 call `Layout` to do so.
12025
12026 Returns ``True`` if the child item was found and removed.
12027 """
12028 if isinstance(olditem, wx.Window):
12029 return self._ReplaceWin(olditem, item, recursive)
12030 elif isinstnace(olditem, wx.Sizer):
12031 return self._ReplaceSizer(olditem, item, recursive)
12032 elif isinstnace(olditem, int):
12033 return self._ReplaceItem(olditem, item)
12034 else:
12035 raise TypeError("Expected Window, Sizer, or integer for first parameter.")
12036
12037 def SetContainingWindow(*args, **kwargs):
12038 """
12039 SetContainingWindow(self, Window window)
12040
12041 Set (or unset) the window this sizer is used in.
12042 """
12043 return _core_.Sizer_SetContainingWindow(*args, **kwargs)
12044
12045 def GetContainingWindow(*args, **kwargs):
12046 """
12047 GetContainingWindow(self) -> Window
12048
12049 Get the window this sizer is used in.
12050 """
12051 return _core_.Sizer_GetContainingWindow(*args, **kwargs)
12052
bfddbb17
RD		 12053 def SetItemMinSize(self, item, *args):
12054 """
12055 SetItemMinSize(self, item, Size size)
12056
12057 Sets the minimum size that will be allocated for an item in the sizer.
12058 The *item* parameter can be either a window, a sizer, or the
12059 zero-based index of the item. If a window or sizer is given then it
12060 will be searched for recursivly in subsizers if neccessary.
12061 """
12062 if len(args) == 2:
12063 # for backward compatibility accept separate width,height args too
12064 return self._SetItemMinSize(item, args)
12065 else:
12066 return self._SetItemMinSize(item, args[0])
12067
d55e5bfc 12068 def AddItem(*args, **kwargs):
bfddbb17
RD		 12069 """
12070 AddItem(self, SizerItem item)
12071
12072 Adds a `wx.SizerItem` to the sizer.
12073 """
5b5c9bc7 12074 return _core_.Sizer_AddItem(*args, **kwargs)
d55e5bfc
RD		 12075
12076 def InsertItem(*args, **kwargs):
bfddbb17
RD		 12077 """
12078 InsertItem(self, int index, SizerItem item)
12079
12080 Inserts a `wx.SizerItem` to the sizer at the position given by *index*.
12081 """
5b5c9bc7 12082 return _core_.Sizer_InsertItem(*args, **kwargs)
d55e5bfc
RD		 12083
12084 def PrependItem(*args, **kwargs):
bfddbb17
RD		 12085 """
12086 PrependItem(self, SizerItem item)
12087
12088 Prepends a `wx.SizerItem` to the sizer.
12089 """
5b5c9bc7 12090 return _core_.Sizer_PrependItem(*args, **kwargs)
d55e5bfc 12091
bfddbb17 12092 def AddMany(self, items):
d6c14a4c
RD		 12093 """
12094 AddMany is a convenience method for adding several items
12095 to a sizer at one time. Simply pass it a list of tuples,
12096 where each tuple consists of the parameters that you
12097 would normally pass to the `Add` method.
12098 """
bfddbb17
RD		 12099 for item in items:
12100 if type(item) != type(()) or (len(item) == 2 and type(item[0]) == type(1)):
12101 item = (item, )
12102 self.Add(*item)
d55e5bfc 12103
0d2c9713
RD		 12104 def AddSpacer(self, *args, **kw):
12105 """AddSpacer(int size) --> SizerItem
12106
12107 Add a spacer that is (size,size) pixels.
12108 """
12109 if args and type(args[0]) == int:
12110 return self.Add( (args[0],args[0] ), 0)
12111 else: # otherwise stay compatible with old AddSpacer
12112 return self.Add(*args, **kw)
12113 def PrependSpacer(self, *args, **kw):
12114 """PrependSpacer(int size) --> SizerItem
12115
12116 Prepend a spacer that is (size, size) pixels."""
12117 if args and type(args[0]) == int:
12118 return self.Prepend( (args[0],args[0] ), 0)
12119 else: # otherwise stay compatible with old PrependSpacer
12120 return self.Prepend(*args, **kw)
12121 def InsertSpacer(self, index, *args, **kw):
12122 """InsertSpacer(int index, int size) --> SizerItem
12123
12124 Insert a spacer at position index that is (size, size) pixels."""
12125 if args and type(args[0]) == int:
12126 return self.Insert( index, (args[0],args[0] ), 0)
12127 else: # otherwise stay compatible with old InsertSpacer
12128 return self.Insert(index, *args, **kw)
12129
12130
12131 def AddStretchSpacer(self, prop=1):
12132 """AddStretchSpacer(int prop=1) --> SizerItem
12133
12134 Add a stretchable spacer."""
12135 return self.Add((0,0), prop)
12136 def PrependStretchSpacer(self, prop=1):
12137 """PrependStretchSpacer(int prop=1) --> SizerItem
12138
12139 Prepend a stretchable spacer."""
12140 return self.Prepend((0,0), prop)
12141 def InsertStretchSpacer(self, index, prop=1):
12142 """InsertStretchSpacer(int index, int prop=1) --> SizerItem
12143
12144 Insert a stretchable spacer."""
12145 return self.Insert(index, (0,0), prop)
12146
12147
d55e5bfc 12148 # for backwards compatibility only, please do not use in new code
7fbf8399
RD		 12149 def AddWindow(self, *args, **kw):
12150 """Compatibility alias for `Add`."""
12151 return self.Add(*args, **kw)
12152 def AddSizer(self, *args, **kw):
12153 """Compatibility alias for `Add`."""
12154 return self.Add(*args, **kw)
7fbf8399
RD		 12155
12156 def PrependWindow(self, *args, **kw):
12157 """Compatibility alias for `Prepend`."""
12158 return self.Prepend(*args, **kw)
12159 def PrependSizer(self, *args, **kw):
12160 """Compatibility alias for `Prepend`."""
12161 return self.Prepend(*args, **kw)
7fbf8399
RD		 12162
12163 def InsertWindow(self, *args, **kw):
12164 """Compatibility alias for `Insert`."""
12165 return self.Insert(*args, **kw)
12166 def InsertSizer(self, *args, **kw):
12167 """Compatibility alias for `Insert`."""
7fbf8399
RD		 12168 return self.Insert(*args, **kw)
12169
12170 def RemoveWindow(self, *args, **kw):
12171 """Compatibility alias for `Remove`."""
12172 return self.Remove(*args, **kw)
12173 def RemoveSizer(self, *args, **kw):
12174 """Compatibility alias for `Remove`."""
12175 return self.Remove(*args, **kw)
12176 def RemovePos(self, *args, **kw):
12177 """Compatibility alias for `Remove`."""
12178 return self.Remove(*args, **kw)
d55e5bfc
RD		 12179
12180
d55e5bfc 12181 def SetDimension(*args, **kwargs):
bfddbb17
RD		 12182 """
12183 SetDimension(self, int x, int y, int width, int height)
12184
12185 Call this to force the sizer to take the given dimension and thus
12186 force the items owned by the sizer to resize themselves according to
12187 the rules defined by the parameter in the `Add`, `Insert` or `Prepend`
12188 methods.
12189 """
5b5c9bc7 12190 return _core_.Sizer_SetDimension(*args, **kwargs)
d55e5bfc
RD		 12191
12192 def SetMinSize(*args, **kwargs):
bfddbb17 12193 """
5b5c9bc7 12194 SetMinSize(self, Size size)
bfddbb17
RD		 12195
12196 Call this to give the sizer a minimal size. Normally, the sizer will
12197 calculate its minimal size based purely on how much space its children
12198 need. After calling this method `GetMinSize` will return either the
12199 minimal size as requested by its children or the minimal size set
12200 here, depending on which is bigger.
12201 """
5b5c9bc7 12202 return _core_.Sizer_SetMinSize(*args, **kwargs)
d55e5bfc
RD		 12203
12204 def GetSize(*args, **kwargs):
bfddbb17 12205 """
5b5c9bc7 12206 GetSize(self) -> Size
bfddbb17
RD		 12207
12208 Returns the current size of the space managed by the sizer.
12209 """
5b5c9bc7 12210 return _core_.Sizer_GetSize(*args, **kwargs)
d55e5bfc
RD		 12211
12212 def GetPosition(*args, **kwargs):
bfddbb17 12213 """
5b5c9bc7 12214 GetPosition(self) -> Point
bfddbb17
RD		 12215
12216 Returns the current position of the sizer's managed space.
12217 """
5b5c9bc7 12218 return _core_.Sizer_GetPosition(*args, **kwargs)
d55e5bfc
RD		 12219
12220 def GetMinSize(*args, **kwargs):
bfddbb17 12221 """
5b5c9bc7 12222 GetMinSize(self) -> Size
bfddbb17
RD		 12223
12224 Returns the minimal size of the sizer. This is either the combined
12225 minimal size of all the children and their borders or the minimal size
12226 set by SetMinSize, depending on which is bigger.
12227 """
5b5c9bc7 12228 return _core_.Sizer_GetMinSize(*args, **kwargs)
d55e5bfc
RD		 12229
12230 def GetSizeTuple(self):
1a6bba1e 12231 return self.GetSize().Get()
d55e5bfc 12232 def GetPositionTuple(self):
1a6bba1e 12233 return self.GetPosition().Get()
d55e5bfc 12234 def GetMinSizeTuple(self):
1a6bba1e 12235 return self.GetMinSize().Get()
d55e5bfc
RD		 12236
12237 def RecalcSizes(*args, **kwargs):
bfddbb17
RD		 12238 """
12239 RecalcSizes(self)
12240
12241 Using the sizes calculated by `CalcMin` reposition and resize all the
12242 items managed by this sizer. You should not need to call this directly as
12243 it is called by `Layout`.
12244 """
5b5c9bc7 12245 return _core_.Sizer_RecalcSizes(*args, **kwargs)
d55e5bfc
RD		 12246
12247 def CalcMin(*args, **kwargs):
bfddbb17 12248 """
5b5c9bc7 12249 CalcMin(self) -> Size
bfddbb17
RD		 12250
12251 This method is where the sizer will do the actual calculation of its
12252 children's minimal sizes. You should not need to call this directly as
12253 it is called by `Layout`.
12254 """
5b5c9bc7 12255 return _core_.Sizer_CalcMin(*args, **kwargs)
d55e5bfc
RD		 12256
12257 def Layout(*args, **kwargs):
bfddbb17
RD		 12258 """
12259 Layout(self)
12260
12261 This method will force the recalculation and layout of the items
12262 controlled by the sizer using the current space allocated to the
12263 sizer. Normally this is called automatically from the owning window's
12264 EVT_SIZE handler, but it is also useful to call it from user code when
12265 one of the items in a sizer change size, or items are added or
12266 removed.
12267 """
5b5c9bc7 12268 return _core_.Sizer_Layout(*args, **kwargs)
d55e5bfc
RD		 12269
12270 def Fit(*args, **kwargs):
bfddbb17 12271 """
5b5c9bc7 12272 Fit(self, Window window) -> Size
bfddbb17
RD		 12273
12274 Tell the sizer to resize the *window* to match the sizer's minimal
12275 size. This is commonly done in the constructor of the window itself in
12276 order to set its initial size to match the needs of the children as
12277 determined by the sizer. Returns the new size.
12278
12279 For a top level window this is the total window size, not the client size.
12280 """
5b5c9bc7 12281 return _core_.Sizer_Fit(*args, **kwargs)
d55e5bfc
RD		 12282
12283 def FitInside(*args, **kwargs):
bfddbb17 12284 """
5b5c9bc7 12285 FitInside(self, Window window)
bfddbb17
RD		 12286
12287 Tell the sizer to resize the *virtual size* of the *window* to match the
12288 sizer's minimal size. This will not alter the on screen size of the
12289 window, but may cause the addition/removal/alteration of scrollbars
12290 required to view the virtual area in windows which manage it.
12291
12292 :see: `wx.ScrolledWindow.SetScrollbars`, `SetVirtualSizeHints`
12293
12294 """
5b5c9bc7 12295 return _core_.Sizer_FitInside(*args, **kwargs)
d55e5bfc
RD		 12296
12297 def SetSizeHints(*args, **kwargs):
bfddbb17 12298 """
5b5c9bc7 12299 SetSizeHints(self, Window window)
bfddbb17
RD		 12300
12301 Tell the sizer to set (and `Fit`) the minimal size of the *window* to
12302 match the sizer's minimal size. This is commonly done in the
12303 constructor of the window itself if the window is resizable (as are
12304 many dialogs under Unix and frames on probably all platforms) in order
12305 to prevent the window from being sized smaller than the minimal size
12306 required by the sizer.
12307 """
5b5c9bc7 12308 return _core_.Sizer_SetSizeHints(*args, **kwargs)
d55e5bfc
RD		 12309
12310 def SetVirtualSizeHints(*args, **kwargs):
bfddbb17 12311 """
5b5c9bc7 12312 SetVirtualSizeHints(self, Window window)
bfddbb17
RD		 12313
12314 Tell the sizer to set the minimal size of the window virtual area to
12315 match the sizer's minimal size. For windows with managed scrollbars
12316 this will set them appropriately.
12317
12318 :see: `wx.ScrolledWindow.SetScrollbars`
12319
12320 """
5b5c9bc7 12321 return _core_.Sizer_SetVirtualSizeHints(*args, **kwargs)
d55e5bfc
RD		 12322
12323 def Clear(*args, **kwargs):
bfddbb17
RD		 12324 """
12325 Clear(self, bool deleteWindows=False)
12326
12327 Clear all items from the sizer, optionally destroying the window items
12328 as well.
12329 """
5b5c9bc7 12330 return _core_.Sizer_Clear(*args, **kwargs)
d55e5bfc
RD		 12331
12332 def DeleteWindows(*args, **kwargs):
bfddbb17
RD		 12333 """
12334 DeleteWindows(self)
12335
12336 Destroy all windows managed by the sizer.
12337 """
5b5c9bc7 12338 return _core_.Sizer_DeleteWindows(*args, **kwargs)
d55e5bfc
RD		 12339
12340 def GetChildren(*args, **kwargs):
bfddbb17 12341 """
51b83b37 12342 GetChildren(self) -> list
bfddbb17
RD		 12343
12344 Returns a list of all the `wx.SizerItem` objects managed by the sizer.
12345 """
5b5c9bc7 12346 return _core_.Sizer_GetChildren(*args, **kwargs)
d55e5bfc
RD		 12347
12348 def Show(*args, **kwargs):
bfddbb17 12349 """
b411df4a 12350 Show(self, item, bool show=True, bool recursive=false) -> bool
d55e5bfc 12351
bfddbb17
RD		 12352 Shows or hides an item managed by the sizer. To make a sizer item
12353 disappear or reappear, use Show followed by `Layout`. The *item*
12354 parameter can be either a window, a sizer, or the zero-based index of
629e65c2
RD		 12355 the item. Use the recursive parameter to show or hide an item in a
12356 subsizer. Returns True if the item was found.
bfddbb17 12357 """
5b5c9bc7 12358 return _core_.Sizer_Show(*args, **kwargs)
d55e5bfc
RD		 12359
12360 def IsShown(*args, **kwargs):
bfddbb17
RD		 12361 """
12362 IsShown(self, item)
12363
b1fcee84 12364 Determines if the item is currently shown. To make a sizer
bfddbb17
RD		 12365 item disappear or reappear, use Show followed by `Layout`. The *item*
12366 parameter can be either a window, a sizer, or the zero-based index of
12367 the item.
12368 """
5b5c9bc7 12369 return _core_.Sizer_IsShown(*args, **kwargs)
d55e5bfc 12370
629e65c2 12371 def Hide(self, item, recursive=False):
bfddbb17 12372 """
27fb7603 12373 A convenience method for `Show` (item, False, recursive).
bfddbb17 12374 """
06759a38 12375 return self.Show(item, False, recursive)
bfddbb17 12376
d55e5bfc 12377 def ShowItems(*args, **kwargs):
bfddbb17
RD		 12378 """
12379 ShowItems(self, bool show)
12380
84f85550 12381 Recursively call `wx.SizerItem.Show` on all sizer items.
bfddbb17 12382 """
5b5c9bc7 12383 return _core_.Sizer_ShowItems(*args, **kwargs)
d55e5bfc 12384
33d6fd3b
RD		 12385 Children = property(GetChildren,doc="See `GetChildren`")
12386 ContainingWindow = property(GetContainingWindow,SetContainingWindow,doc="See `GetContainingWindow` and `SetContainingWindow`")
12387 MinSize = property(GetMinSize,SetMinSize,doc="See `GetMinSize` and `SetMinSize`")
12388 Position = property(GetPosition,doc="See `GetPosition`")
12389 Size = property(GetSize,doc="See `GetSize`")
2131d850 12390_core_.Sizer_swigregister(Sizer)
d55e5bfc 12391
5b5c9bc7 12392class PySizer(Sizer):
bfddbb17
RD		 12393 """
12394 wx.PySizer is a special version of `wx.Sizer` that has been
12395 instrumented to allow the C++ virtual methods to be overloaded in
12396 Python derived classes. You would derive from this class if you are
12397 wanting to implement a custom sizer in Python code. Simply implement
12398 `CalcMin` and `RecalcSizes` in the derived class and you're all set.
12399 For example::
12400
12401 class MySizer(wx.PySizer):
12402 def __init__(self):
12403 wx.PySizer.__init__(self)
12404
12405 def CalcMin(self):
12406 for item in self.GetChildren():
12407 # calculate the total minimum width and height needed
12408 # by all items in the sizer according to this sizer's
12409 # layout algorithm.
12410 ...
12411 return wx.Size(width, height)
12412
12413 def RecalcSizes(self):
12414 # find the space allotted to this sizer
12415 pos = self.GetPosition()
12416 size = self.GetSize()
12417 for item in self.GetChildren():
12418 # Recalculate (if necessary) the position and size of
12419 # each item and then call item.SetDimension to do the
12420 # actual positioning and sizing of the items within the
12421 # space alloted to this sizer.
12422 ...
12423 item.SetDimension(itemPos, itemSize)
12424
12425
12426 When `Layout` is called it first calls `CalcMin` followed by
12427 `RecalcSizes` so you can optimize a bit by saving the results of
62d32a5f 12428 `CalcMin` and reusing them in `RecalcSizes`.
bfddbb17
RD		 12429
12430 :see: `wx.SizerItem`, `wx.Sizer.GetChildren`
12431
12432
12433 """
1bd55598
RD		 12434 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12435 __repr__ = _swig_repr
12436 def __init__(self, *args, **kwargs):
bfddbb17 12437 """
5b5c9bc7 12438 __init__(self) -> PySizer
bfddbb17
RD		 12439
12440 Creates a wx.PySizer. Must be called from the __init__ in the derived
12441 class.
12442 """
1bd55598 12443 _core_.PySizer_swiginit(self,_core_.new_PySizer(*args, **kwargs))
d55e5bfc
RD		 12444 self._setCallbackInfo(self, PySizer);self._setOORInfo(self)
12445
12446 def _setCallbackInfo(*args, **kwargs):
12447 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
5b5c9bc7 12448 return _core_.PySizer__setCallbackInfo(*args, **kwargs)
d55e5bfc 12449
2131d850 12450_core_.PySizer_swigregister(PySizer)
d55e5bfc
RD		 12451
12452#---------------------------------------------------------------------------
12453
5b5c9bc7 12454class BoxSizer(Sizer):
bfddbb17
RD		 12455 """
12456 The basic idea behind a box sizer is that windows will most often be
12457 laid out in rather simple basic geometry, typically in a row or a
12458 column or nested hierarchies of either. A wx.BoxSizer will lay out
12459 its items in a simple row or column, depending on the orientation
12460 parameter passed to the constructor.
12461 """
1bd55598
RD		 12462 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12463 __repr__ = _swig_repr
12464 def __init__(self, *args, **kwargs):
bfddbb17 12465 """
5b5c9bc7 12466 __init__(self, int orient=HORIZONTAL) -> BoxSizer
bfddbb17
RD		 12467
12468 Constructor for a wx.BoxSizer. *orient* may be one of ``wx.VERTICAL``
12469 or ``wx.HORIZONTAL`` for creating either a column sizer or a row
12470 sizer.
12471 """
1bd55598 12472 _core_.BoxSizer_swiginit(self,_core_.new_BoxSizer(*args, **kwargs))
d55e5bfc
RD		 12473 self._setOORInfo(self)
12474
12475 def GetOrientation(*args, **kwargs):
bfddbb17
RD		 12476 """
12477 GetOrientation(self) -> int
12478
12479 Returns the current orientation of the sizer.
12480 """
5b5c9bc7 12481 return _core_.BoxSizer_GetOrientation(*args, **kwargs)
d55e5bfc
RD		 12482
12483 def SetOrientation(*args, **kwargs):
bfddbb17
RD		 12484 """
12485 SetOrientation(self, int orient)
d55e5bfc 12486
bfddbb17
RD		 12487 Resets the orientation of the sizer.
12488 """
5b5c9bc7 12489 return _core_.BoxSizer_SetOrientation(*args, **kwargs)
d55e5bfc 12490
2bf58437 12491 Orientation = property(GetOrientation,SetOrientation,doc="See `GetOrientation` and `SetOrientation`")
2131d850 12492_core_.BoxSizer_swigregister(BoxSizer)
d55e5bfc
RD		 12493
12494#---------------------------------------------------------------------------
12495
5b5c9bc7 12496class StaticBoxSizer(BoxSizer):
bfddbb17
RD		 12497 """
12498 wx.StaticBoxSizer derives from and functions identically to the
12499 `wx.BoxSizer` and adds a `wx.StaticBox` around the items that the sizer
12500 manages. Note that this static box must be created separately and
12501 passed to the sizer constructor.
12502 """
1bd55598
RD		 12503 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12504 __repr__ = _swig_repr
12505 def __init__(self, *args, **kwargs):
bfddbb17 12506 """
5b5c9bc7 12507 __init__(self, StaticBox box, int orient=HORIZONTAL) -> StaticBoxSizer
bfddbb17
RD		 12508
12509 Constructor. It takes an associated static box and the orientation
12510 *orient* as parameters - orient can be either of ``wx.VERTICAL`` or
12511 ``wx.HORIZONTAL``.
12512 """
1bd55598 12513 _core_.StaticBoxSizer_swiginit(self,_core_.new_StaticBoxSizer(*args, **kwargs))
d55e5bfc
RD		 12514 self._setOORInfo(self)
12515
12516 def GetStaticBox(*args, **kwargs):
bfddbb17 12517 """
5b5c9bc7 12518 GetStaticBox(self) -> StaticBox
d55e5bfc 12519
bfddbb17
RD		 12520 Returns the static box associated with this sizer.
12521 """
5b5c9bc7 12522 return _core_.StaticBoxSizer_GetStaticBox(*args, **kwargs)
d55e5bfc 12523
33d6fd3b 12524 StaticBox = property(GetStaticBox,doc="See `GetStaticBox`")
2131d850 12525_core_.StaticBoxSizer_swigregister(StaticBoxSizer)
d55e5bfc
RD		 12526
12527#---------------------------------------------------------------------------
12528
5b5c9bc7 12529class GridSizer(Sizer):
bfddbb17
RD		 12530 """
12531 A grid sizer is a sizer which lays out its children in a
12532 two-dimensional table with all cells having the same size. In other
12533 words, the width of each cell within the grid is the width of the
12534 widest item added to the sizer and the height of each grid cell is the
12535 height of the tallest item. An optional vertical and/or horizontal
12536 gap between items can also be specified (in pixels.)
12537
12538 Items are placed in the cells of the grid in the order they are added,
12539 in row-major order. In other words, the first row is filled first,
12540 then the second, and so on until all items have been added. (If
12541 neccessary, additional rows will be added as items are added.) If you
12542 need to have greater control over the cells that items are placed in
12543 then use the `wx.GridBagSizer`.
12544
12545 """
1bd55598
RD		 12546 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12547 __repr__ = _swig_repr
12548 def __init__(self, *args, **kwargs):
bfddbb17 12549 """
5b5c9bc7 12550 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> GridSizer
bfddbb17
RD		 12551
12552 Constructor for a wx.GridSizer. *rows* and *cols* determine the number
12553 of columns and rows in the sizer - if either of the parameters is
12554 zero, it will be calculated to from the total number of children in
12555 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
12556 define extra space between all children.
12557 """
1bd55598 12558 _core_.GridSizer_swiginit(self,_core_.new_GridSizer(*args, **kwargs))
d55e5bfc
RD		 12559 self._setOORInfo(self)
12560
d55e5bfc 12561 def SetCols(*args, **kwargs):
bfddbb17
RD		 12562 """
12563 SetCols(self, int cols)
12564
12565 Sets the number of columns in the sizer.
12566 """
5b5c9bc7 12567 return _core_.GridSizer_SetCols(*args, **kwargs)
d55e5bfc
RD		 12568
12569 def SetRows(*args, **kwargs):
bfddbb17
RD		 12570 """
12571 SetRows(self, int rows)
12572
12573 Sets the number of rows in the sizer.
12574 """
5b5c9bc7 12575 return _core_.GridSizer_SetRows(*args, **kwargs)
d55e5bfc
RD		 12576
12577 def SetVGap(*args, **kwargs):
bfddbb17
RD		 12578 """
12579 SetVGap(self, int gap)
12580
12581 Sets the vertical gap (in pixels) between the cells in the sizer.
12582 """
5b5c9bc7 12583 return _core_.GridSizer_SetVGap(*args, **kwargs)
d55e5bfc
RD		 12584
12585 def SetHGap(*args, **kwargs):
bfddbb17
RD		 12586 """
12587 SetHGap(self, int gap)
12588
12589 Sets the horizontal gap (in pixels) between cells in the sizer
12590 """
5b5c9bc7 12591 return _core_.GridSizer_SetHGap(*args, **kwargs)
d55e5bfc
RD		 12592
12593 def GetCols(*args, **kwargs):
bfddbb17
RD		 12594 """
12595 GetCols(self) -> int
12596
12597 Returns the number of columns in the sizer.
12598 """
5b5c9bc7 12599 return _core_.GridSizer_GetCols(*args, **kwargs)
d55e5bfc
RD		 12600
12601 def GetRows(*args, **kwargs):
bfddbb17
RD		 12602 """
12603 GetRows(self) -> int
12604
12605 Returns the number of rows in the sizer.
12606 """
5b5c9bc7 12607 return _core_.GridSizer_GetRows(*args, **kwargs)
d55e5bfc
RD		 12608
12609 def GetVGap(*args, **kwargs):
bfddbb17
RD		 12610 """
12611 GetVGap(self) -> int
12612
12613 Returns the vertical gap (in pixels) between the cells in the sizer.
12614 """
5b5c9bc7 12615 return _core_.GridSizer_GetVGap(*args, **kwargs)
d55e5bfc
RD		 12616
12617 def GetHGap(*args, **kwargs):
bfddbb17
RD		 12618 """
12619 GetHGap(self) -> int
12620
12621 Returns the horizontal gap (in pixels) between cells in the sizer.
12622 """
5b5c9bc7 12623 return _core_.GridSizer_GetHGap(*args, **kwargs)
d55e5bfc 12624
1bd55598
RD		 12625 def CalcRowsCols(self):
12626 """
12627 CalcRowsCols() -> (rows, cols)
12628
12629 Calculates how many rows and columns will be in the sizer based
12630 on the current number of items and also the rows, cols specified
12631 in the constructor.
12632 """
12633 nitems = len(self.GetChildren())
12634 rows = self.GetRows()
12635 cols = self.GetCols()
12636 assert rows != 0 or cols != 0, "Grid sizer must have either rows or columns fixed"
12637 if cols != 0:
12638 rows = (nitems + cols - 1) / cols
12639 elif rows != 0:
12640 cols = (nitems + rows - 1) / rows
12641 return (rows, cols)
d55e5bfc 12642
ac5d357a
RD		 12643 Cols = property(GetCols,SetCols,doc="See `GetCols` and `SetCols`")
12644 HGap = property(GetHGap,SetHGap,doc="See `GetHGap` and `SetHGap`")
12645 Rows = property(GetRows,SetRows,doc="See `GetRows` and `SetRows`")
12646 VGap = property(GetVGap,SetVGap,doc="See `GetVGap` and `SetVGap`")
2131d850 12647_core_.GridSizer_swigregister(GridSizer)
d55e5bfc
RD		 12648
12649#---------------------------------------------------------------------------
12650
5b5c9bc7
RD		 12651FLEX_GROWMODE_NONE = _core_.FLEX_GROWMODE_NONE
12652FLEX_GROWMODE_SPECIFIED = _core_.FLEX_GROWMODE_SPECIFIED
12653FLEX_GROWMODE_ALL = _core_.FLEX_GROWMODE_ALL
12654class FlexGridSizer(GridSizer):
bfddbb17
RD		 12655 """
12656 A flex grid sizer is a sizer which lays out its children in a
12657 two-dimensional table with all table cells in one row having the same
12658 height and all cells in one column having the same width, but all
12659 rows or all columns are not necessarily the same height or width as in
12660 the `wx.GridSizer`.
12661
12662 wx.FlexGridSizer can also size items equally in one direction but
12663 unequally ("flexibly") in the other. If the sizer is only flexible
12664 in one direction (this can be changed using `SetFlexibleDirection`), it
12665 needs to be decided how the sizer should grow in the other ("non
12666 flexible") direction in order to fill the available space. The
12667 `SetNonFlexibleGrowMode` method serves this purpose.
12668
12669
12670 """
1bd55598
RD		 12671 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12672 __repr__ = _swig_repr
12673 def __init__(self, *args, **kwargs):
bfddbb17 12674 """
5b5c9bc7 12675 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> FlexGridSizer
bfddbb17
RD		 12676
12677 Constructor for a wx.FlexGridSizer. *rows* and *cols* determine the
12678 number of columns and rows in the sizer - if either of the parameters
12679 is zero, it will be calculated to from the total number of children in
12680 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
12681 define extra space between all children.
12682 """
1bd55598 12683 _core_.FlexGridSizer_swiginit(self,_core_.new_FlexGridSizer(*args, **kwargs))
d55e5bfc
RD		 12684 self._setOORInfo(self)
12685
bfddbb17
RD		 12686 def AddGrowableRow(*args, **kwargs):
12687 """
12688 AddGrowableRow(self, size_t idx, int proportion=0)
d55e5bfc 12689
bfddbb17
RD		 12690 Specifies that row *idx* (starting from zero) should be grown if there
12691 is extra space available to the sizer.
d55e5bfc 12692
bfddbb17
RD		 12693 The *proportion* parameter has the same meaning as the stretch factor
12694 for the box sizers except that if all proportions are 0, then all
12695 columns are resized equally (instead of not being resized at all).
12696 """
5b5c9bc7 12697 return _core_.FlexGridSizer_AddGrowableRow(*args, **kwargs)
d55e5bfc
RD		 12698
12699 def RemoveGrowableRow(*args, **kwargs):
bfddbb17
RD		 12700 """
12701 RemoveGrowableRow(self, size_t idx)
12702
12703 Specifies that row *idx* is no longer growable.
12704 """
5b5c9bc7 12705 return _core_.FlexGridSizer_RemoveGrowableRow(*args, **kwargs)
d55e5bfc
RD		 12706
12707 def AddGrowableCol(*args, **kwargs):
bfddbb17
RD		 12708 """
12709 AddGrowableCol(self, size_t idx, int proportion=0)
12710
12711 Specifies that column *idx* (starting from zero) should be grown if
12712 there is extra space available to the sizer.
12713
12714 The *proportion* parameter has the same meaning as the stretch factor
12715 for the box sizers except that if all proportions are 0, then all
12716 columns are resized equally (instead of not being resized at all).
12717 """
5b5c9bc7 12718 return _core_.FlexGridSizer_AddGrowableCol(*args, **kwargs)
d55e5bfc
RD		 12719
12720 def RemoveGrowableCol(*args, **kwargs):
bfddbb17
RD		 12721 """
12722 RemoveGrowableCol(self, size_t idx)
12723
12724 Specifies that column *idx* is no longer growable.
12725 """
5b5c9bc7 12726 return _core_.FlexGridSizer_RemoveGrowableCol(*args, **kwargs)
d55e5bfc
RD		 12727
12728 def SetFlexibleDirection(*args, **kwargs):
bfddbb17
RD		 12729 """
12730 SetFlexibleDirection(self, int direction)
12731
12732 Specifies whether the sizer should flexibly resize its columns, rows,
12733 or both. Argument *direction* can be one of the following values. Any
12734 other value is ignored.
12735
12736 ============== =======================================
12737 wx.VERTICAL Rows are flexibly sized.
12738 wx.HORIZONTAL Columns are flexibly sized.
12739 wx.BOTH Both rows and columns are flexibly sized
12740 (this is the default value).
12741 ============== =======================================
12742
12743 Note that this method does not trigger relayout.
12744
12745 """
5b5c9bc7 12746 return _core_.FlexGridSizer_SetFlexibleDirection(*args, **kwargs)
d55e5bfc
RD		 12747
12748 def GetFlexibleDirection(*args, **kwargs):
bfddbb17
RD		 12749 """
12750 GetFlexibleDirection(self) -> int
12751
12752 Returns a value that specifies whether the sizer
12753 flexibly resizes its columns, rows, or both (default).
12754
12755 :see: `SetFlexibleDirection`
12756 """
5b5c9bc7 12757 return _core_.FlexGridSizer_GetFlexibleDirection(*args, **kwargs)
d55e5bfc
RD		 12758
12759 def SetNonFlexibleGrowMode(*args, **kwargs):
bfddbb17
RD		 12760 """
12761 SetNonFlexibleGrowMode(self, int mode)
12762
12763 Specifies how the sizer should grow in the non-flexible direction if
12764 there is one (so `SetFlexibleDirection` must have been called
12765 previously). Argument *mode* can be one of the following values:
12766
12767 ========================== =================================================
12768 wx.FLEX_GROWMODE_NONE Sizer doesn't grow in the non flexible direction.
12769 wx.FLEX_GROWMODE_SPECIFIED Sizer honors growable columns/rows set with
12770 `AddGrowableCol` and `AddGrowableRow`. In this
12771 case equal sizing applies to minimum sizes of
12772 columns or rows (this is the default value).
12773 wx.FLEX_GROWMODE_ALL Sizer equally stretches all columns or rows in
12774 the non flexible direction, whether they are
12775 growable or not in the flexbile direction.
12776 ========================== =================================================
12777
12778 Note that this method does not trigger relayout.
bfddbb17 12779 """
5b5c9bc7 12780 return _core_.FlexGridSizer_SetNonFlexibleGrowMode(*args, **kwargs)
d55e5bfc
RD		 12781
12782 def GetNonFlexibleGrowMode(*args, **kwargs):
bfddbb17
RD		 12783 """
12784 GetNonFlexibleGrowMode(self) -> int
12785
12786 Returns the value that specifies how the sizer grows in the
12787 non-flexible direction if there is one.
12788
12789 :see: `SetNonFlexibleGrowMode`
12790 """
5b5c9bc7 12791 return _core_.FlexGridSizer_GetNonFlexibleGrowMode(*args, **kwargs)
d55e5bfc
RD		 12792
12793 def GetRowHeights(*args, **kwargs):
fd2dc343
RD		 12794 """
12795 GetRowHeights(self) -> list
12796
12797 Returns a list of integers representing the heights of each of the
12798 rows in the sizer.
12799 """
5b5c9bc7 12800 return _core_.FlexGridSizer_GetRowHeights(*args, **kwargs)
d55e5bfc
RD		 12801
12802 def GetColWidths(*args, **kwargs):
fd2dc343
RD		 12803 """
12804 GetColWidths(self) -> list
12805
12806 Returns a list of integers representing the widths of each of the
12807 columns in the sizer.
12808 """
5b5c9bc7 12809 return _core_.FlexGridSizer_GetColWidths(*args, **kwargs)
d55e5bfc 12810
ac5d357a
RD		 12811 ColWidths = property(GetColWidths,doc="See `GetColWidths`")
12812 FlexibleDirection = property(GetFlexibleDirection,SetFlexibleDirection,doc="See `GetFlexibleDirection` and `SetFlexibleDirection`")
12813 NonFlexibleGrowMode = property(GetNonFlexibleGrowMode,SetNonFlexibleGrowMode,doc="See `GetNonFlexibleGrowMode` and `SetNonFlexibleGrowMode`")
12814 RowHeights = property(GetRowHeights,doc="See `GetRowHeights`")
2131d850 12815_core_.FlexGridSizer_swigregister(FlexGridSizer)
d55e5bfc 12816
5b5c9bc7 12817class StdDialogButtonSizer(BoxSizer):
62d32a5f
RD		 12818 """
12819 A special sizer that knows how to order and position standard buttons
12820 in order to conform to the current platform's standards. You simply
12821 need to add each `wx.Button` to the sizer, and be sure to create the
53aa7709 12822 buttons using the standard ID's. Then call `Realize` and the sizer
62d32a5f
RD		 12823 will take care of the rest.
12824
12825 """
1bd55598
RD		 12826 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12827 __repr__ = _swig_repr
12828 def __init__(self, *args, **kwargs):
5b5c9bc7 12829 """__init__(self) -> StdDialogButtonSizer"""
1bd55598 12830 _core_.StdDialogButtonSizer_swiginit(self,_core_.new_StdDialogButtonSizer(*args, **kwargs))
62d32a5f
RD		 12831 def AddButton(*args, **kwargs):
12832 """
12833 AddButton(self, wxButton button)
12834
12835 Use this to add the buttons to this sizer. Do not use the `Add`
12836 method in the base class.
12837 """
5b5c9bc7 12838 return _core_.StdDialogButtonSizer_AddButton(*args, **kwargs)
62d32a5f 12839
53aa7709 12840 def Realize(*args, **kwargs):
62d32a5f 12841 """
53aa7709 12842 Realize(self)
62d32a5f
RD		 12843
12844 This funciton needs to be called after all the buttons have been added
12845 to the sizer. It will reorder them and position them in a platform
12846 specifc manner.
12847 """
5b5c9bc7 12848 return _core_.StdDialogButtonSizer_Realize(*args, **kwargs)
51b83b37
RD		 12849
12850 def SetAffirmativeButton(*args, **kwargs):
12851 """SetAffirmativeButton(self, wxButton button)"""
5b5c9bc7 12852 return _core_.StdDialogButtonSizer_SetAffirmativeButton(*args, **kwargs)
51b83b37
RD		 12853
12854 def SetNegativeButton(*args, **kwargs):
12855 """SetNegativeButton(self, wxButton button)"""
5b5c9bc7 12856 return _core_.StdDialogButtonSizer_SetNegativeButton(*args, **kwargs)
51b83b37
RD		 12857
12858 def SetCancelButton(*args, **kwargs):
12859 """SetCancelButton(self, wxButton button)"""
5b5c9bc7 12860 return _core_.StdDialogButtonSizer_SetCancelButton(*args, **kwargs)
62d32a5f
RD		 12861
12862 def GetAffirmativeButton(*args, **kwargs):
12863 """GetAffirmativeButton(self) -> wxButton"""
5b5c9bc7 12864 return _core_.StdDialogButtonSizer_GetAffirmativeButton(*args, **kwargs)
62d32a5f
RD		 12865
12866 def GetApplyButton(*args, **kwargs):
12867 """GetApplyButton(self) -> wxButton"""
5b5c9bc7 12868 return _core_.StdDialogButtonSizer_GetApplyButton(*args, **kwargs)
62d32a5f
RD		 12869
12870 def GetNegativeButton(*args, **kwargs):
12871 """GetNegativeButton(self) -> wxButton"""
5b5c9bc7 12872 return _core_.StdDialogButtonSizer_GetNegativeButton(*args, **kwargs)
62d32a5f
RD		 12873
12874 def GetCancelButton(*args, **kwargs):
12875 """GetCancelButton(self) -> wxButton"""
5b5c9bc7 12876 return _core_.StdDialogButtonSizer_GetCancelButton(*args, **kwargs)
62d32a5f
RD		 12877
12878 def GetHelpButton(*args, **kwargs):
12879 """GetHelpButton(self) -> wxButton"""
5b5c9bc7 12880 return _core_.StdDialogButtonSizer_GetHelpButton(*args, **kwargs)
62d32a5f 12881
33d6fd3b
RD		 12882 AffirmativeButton = property(GetAffirmativeButton,SetAffirmativeButton,doc="See `GetAffirmativeButton` and `SetAffirmativeButton`")
12883 ApplyButton = property(GetApplyButton,doc="See `GetApplyButton`")
12884 CancelButton = property(GetCancelButton,SetCancelButton,doc="See `GetCancelButton` and `SetCancelButton`")
12885 HelpButton = property(GetHelpButton,doc="See `GetHelpButton`")
12886 NegativeButton = property(GetNegativeButton,SetNegativeButton,doc="See `GetNegativeButton` and `SetNegativeButton`")
2131d850 12887_core_.StdDialogButtonSizer_swigregister(StdDialogButtonSizer)
62d32a5f 12888
d55e5bfc
RD		 12889#---------------------------------------------------------------------------
12890
5b5c9bc7 12891class GBPosition(object):
bfddbb17
RD		 12892 """
12893 This class represents the position of an item in a virtual grid of
12894 rows and columns managed by a `wx.GridBagSizer`. wxPython has
12895 typemaps that will automatically convert from a 2-element sequence of
12896 integers to a wx.GBPosition, so you can use the more pythonic
12897 representation of the position nearly transparently in Python code.
12898 """
1bd55598
RD		 12899 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12900 __repr__ = _swig_repr
12901 def __init__(self, *args, **kwargs):
bfddbb17 12902 """
5b5c9bc7 12903 __init__(self, int row=0, int col=0) -> GBPosition
bfddbb17
RD		 12904
12905 This class represents the position of an item in a virtual grid of
12906 rows and columns managed by a `wx.GridBagSizer`. wxPython has
12907 typemaps that will automatically convert from a 2-element sequence of
12908 integers to a wx.GBPosition, so you can use the more pythonic
12909 representation of the position nearly transparently in Python code.
12910 """
1bd55598
RD		 12911 _core_.GBPosition_swiginit(self,_core_.new_GBPosition(*args, **kwargs))
12912 __swig_destroy__ = _core_.delete_GBPosition
12913 __del__ = lambda self : None;
d55e5bfc
RD		 12914 def GetRow(*args, **kwargs):
12915 """GetRow(self) -> int"""
5b5c9bc7 12916 return _core_.GBPosition_GetRow(*args, **kwargs)
d55e5bfc
RD		 12917
12918 def GetCol(*args, **kwargs):
12919 """GetCol(self) -> int"""
5b5c9bc7 12920 return _core_.GBPosition_GetCol(*args, **kwargs)
d55e5bfc
RD		 12921
12922 def SetRow(*args, **kwargs):
12923 """SetRow(self, int row)"""
5b5c9bc7 12924 return _core_.GBPosition_SetRow(*args, **kwargs)
d55e5bfc
RD		 12925
12926 def SetCol(*args, **kwargs):
12927 """SetCol(self, int col)"""
5b5c9bc7 12928 return _core_.GBPosition_SetCol(*args, **kwargs)
d55e5bfc
RD		 12929
12930 def __eq__(*args, **kwargs):
e9d6f3a4
RD		 12931 """
12932 __eq__(self, PyObject other) -> bool
12933
12934 Compare GBPosition for equality.
12935 """
5b5c9bc7 12936 return _core_.GBPosition___eq__(*args, **kwargs)
d55e5bfc
RD		 12937
12938 def __ne__(*args, **kwargs):
e9d6f3a4
RD		 12939 """
12940 __ne__(self, PyObject other) -> bool
12941
12942 Compare GBPosition for inequality.
12943 """
5b5c9bc7 12944 return _core_.GBPosition___ne__(*args, **kwargs)
d55e5bfc
RD		 12945
12946 def Set(*args, **kwargs):
12947 """Set(self, int row=0, int col=0)"""
5b5c9bc7 12948 return _core_.GBPosition_Set(*args, **kwargs)
d55e5bfc
RD		 12949
12950 def Get(*args, **kwargs):
12951 """Get(self) -> PyObject"""
5b5c9bc7 12952 return _core_.GBPosition_Get(*args, **kwargs)
d55e5bfc 12953
15817c7e 12954 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD		 12955 def __str__(self): return str(self.Get())
12956 def __repr__(self): return 'wx.GBPosition'+str(self.Get())
12957 def __len__(self): return len(self.Get())
12958 def __getitem__(self, index): return self.Get()[index]
12959 def __setitem__(self, index, val):
12960 if index == 0: self.SetRow(val)
12961 elif index == 1: self.SetCol(val)
12962 else: raise IndexError
12963 def __nonzero__(self): return self.Get() != (0,0)
12964 __safe_for_unpickling__ = True
12965 def __reduce__(self): return (wx.GBPosition, self.Get())
12966
12967 row = property(GetRow, SetRow)
12968 col = property(GetCol, SetCol)
12969
2131d850 12970_core_.GBPosition_swigregister(GBPosition)
d55e5bfc 12971
5b5c9bc7 12972class GBSpan(object):
bfddbb17
RD		 12973 """
12974 This class is used to hold the row and column spanning attributes of
12975 items in a `wx.GridBagSizer`. wxPython has typemaps that will
12976 automatically convert from a 2-element sequence of integers to a
12977 wx.GBSpan, so you can use the more pythonic representation of the span
12978 nearly transparently in Python code.
12979
12980 """
1bd55598
RD		 12981 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12982 __repr__ = _swig_repr
12983 def __init__(self, *args, **kwargs):
bfddbb17 12984 """
5b5c9bc7 12985 __init__(self, int rowspan=1, int colspan=1) -> GBSpan
bfddbb17
RD		 12986
12987 Construct a new wxGBSpan, optionally setting the rowspan and
12988 colspan. The default is (1,1). (Meaning that the item occupies one
12989 cell in each direction.
12990 """
1bd55598
RD		 12991 _core_.GBSpan_swiginit(self,_core_.new_GBSpan(*args, **kwargs))
12992 __swig_destroy__ = _core_.delete_GBSpan
12993 __del__ = lambda self : None;
d55e5bfc
RD		 12994 def GetRowspan(*args, **kwargs):
12995 """GetRowspan(self) -> int"""
5b5c9bc7 12996 return _core_.GBSpan_GetRowspan(*args, **kwargs)
d55e5bfc
RD		 12997
12998 def GetColspan(*args, **kwargs):
12999 """GetColspan(self) -> int"""
5b5c9bc7 13000 return _core_.GBSpan_GetColspan(*args, **kwargs)
d55e5bfc
RD		 13001
13002 def SetRowspan(*args, **kwargs):
13003 """SetRowspan(self, int rowspan)"""
5b5c9bc7 13004 return _core_.GBSpan_SetRowspan(*args, **kwargs)
d55e5bfc
RD		 13005
13006 def SetColspan(*args, **kwargs):
13007 """SetColspan(self, int colspan)"""
5b5c9bc7 13008 return _core_.GBSpan_SetColspan(*args, **kwargs)
d55e5bfc
RD		 13009
13010 def __eq__(*args, **kwargs):
e9d6f3a4
RD		 13011 """
13012 __eq__(self, PyObject other) -> bool
13013
13014 Compare wxGBSpan for equality.
13015 """
5b5c9bc7 13016 return _core_.GBSpan___eq__(*args, **kwargs)
d55e5bfc
RD		 13017
13018 def __ne__(*args, **kwargs):
e9d6f3a4
RD		 13019 """
13020 __ne__(self, PyObject other) -> bool
13021
13022 Compare GBSpan for inequality.
13023 """
5b5c9bc7 13024 return _core_.GBSpan___ne__(*args, **kwargs)
d55e5bfc
RD		 13025
13026 def Set(*args, **kwargs):
13027 """Set(self, int rowspan=1, int colspan=1)"""
5b5c9bc7 13028 return _core_.GBSpan_Set(*args, **kwargs)
d55e5bfc
RD		 13029
13030 def Get(*args, **kwargs):
13031 """Get(self) -> PyObject"""
5b5c9bc7 13032 return _core_.GBSpan_Get(*args, **kwargs)
d55e5bfc 13033
15817c7e 13034 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD		 13035 def __str__(self): return str(self.Get())
13036 def __repr__(self): return 'wx.GBSpan'+str(self.Get())
13037 def __len__(self): return len(self.Get())
13038 def __getitem__(self, index): return self.Get()[index]
13039 def __setitem__(self, index, val):
13040 if index == 0: self.SetRowspan(val)
13041 elif index == 1: self.SetColspan(val)
13042 else: raise IndexError
13043 def __nonzero__(self): return self.Get() != (0,0)
13044 __safe_for_unpickling__ = True
13045 def __reduce__(self): return (wx.GBSpan, self.Get())
13046
13047 rowspan = property(GetRowspan, SetRowspan)
13048 colspan = property(GetColspan, SetColspan)
13049
2131d850 13050_core_.GBSpan_swigregister(GBSpan)
d55e5bfc 13051
5b5c9bc7 13052class GBSizerItem(SizerItem):
bfddbb17
RD		 13053 """
13054 The wx.GBSizerItem class is used to track the additional data about
13055 items in a `wx.GridBagSizer` such as the item's position in the grid
13056 and how many rows or columns it spans.
13057
13058 """
1bd55598
RD		 13059 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
13060 __repr__ = _swig_repr
13061 def __init__(self, *args, **kwargs):
bfddbb17 13062 """
5b5c9bc7 13063 __init__(self) -> GBSizerItem
bfddbb17
RD		 13064
13065 Constructs an empty wx.GBSizerItem. Either a window, sizer or spacer
13066 size will need to be set, as well as a position and span before this
13067 item can be used in a Sizer.
13068
13069 You will probably never need to create a wx.GBSizerItem directly as they
13070 are created automatically when the sizer's Add method is called.
13071 """
1bd55598
RD		 13072 _core_.GBSizerItem_swiginit(self,_core_.new_GBSizerItem(*args, **kwargs))
13073 __swig_destroy__ = _core_.delete_GBSizerItem
13074 __del__ = lambda self : None;
d55e5bfc 13075 def GetPos(*args, **kwargs):
bfddbb17 13076 """
5b5c9bc7 13077 GetPos(self) -> GBPosition
bfddbb17
RD		 13078
13079 Get the grid position of the item
13080 """
5b5c9bc7 13081 return _core_.GBSizerItem_GetPos(*args, **kwargs)
d55e5bfc
RD		 13082
13083 def GetPosTuple(self): return self.GetPos().Get()
13084 def GetSpan(*args, **kwargs):
bfddbb17 13085 """
5b5c9bc7 13086 GetSpan(self) -> GBSpan
bfddbb17
RD		 13087
13088 Get the row and column spanning of the item
13089 """
5b5c9bc7 13090 return _core_.GBSizerItem_GetSpan(*args, **kwargs)
d55e5bfc
RD		 13091
13092 def GetSpanTuple(self): return self.GetSpan().Get()
13093 def SetPos(*args, **kwargs):
bfddbb17 13094 """
5b5c9bc7 13095 SetPos(self, GBPosition pos) -> bool
bfddbb17
RD		 13096
13097 If the item is already a member of a sizer then first ensure that
13098 there is no other item that would intersect with this one at the new
13099 position, then set the new position. Returns True if the change is
13100 successful and after the next Layout() the item will be moved.
13101 """
5b5c9bc7 13102 return _core_.GBSizerItem_SetPos(*args, **kwargs)
d55e5bfc
RD		 13103
13104 def SetSpan(*args, **kwargs):
bfddbb17 13105 """
5b5c9bc7 13106 SetSpan(self, GBSpan span) -> bool
bfddbb17
RD		 13107
13108 If the item is already a member of a sizer then first ensure that
13109 there is no other item that would intersect with this one with its new
13110 spanning size, then set the new spanning. Returns True if the change
13111 is successful and after the next Layout() the item will be resized.
13112
13113 """
5b5c9bc7 13114 return _core_.GBSizerItem_SetSpan(*args, **kwargs)
d55e5bfc 13115
bfddbb17 13116 def Intersects(*args, **kwargs):
d55e5bfc 13117 """
5b5c9bc7 13118 Intersects(self, GBSizerItem other) -> bool
bfddbb17
RD		 13119
13120 Returns True if this item and the other item instersect.
d55e5bfc 13121 """
5b5c9bc7 13122 return _core_.GBSizerItem_Intersects(*args, **kwargs)
bfddbb17
RD		 13123
13124 def IntersectsPos(*args, **kwargs):
13125 """
5b5c9bc7 13126 IntersectsPos(self, GBPosition pos, GBSpan span) -> bool
bfddbb17
RD		 13127
13128 Returns True if the given pos/span would intersect with this item.
13129 """
5b5c9bc7 13130 return _core_.GBSizerItem_IntersectsPos(*args, **kwargs)
d55e5bfc
RD		 13131
13132 def GetEndPos(*args, **kwargs):
bfddbb17 13133 """
5b5c9bc7 13134 GetEndPos(self) -> GBPosition
bfddbb17
RD		 13135
13136 Get the row and column of the endpoint of this item.
13137 """
5b5c9bc7 13138 return _core_.GBSizerItem_GetEndPos(*args, **kwargs)
d55e5bfc
RD		 13139
13140 def GetGBSizer(*args, **kwargs):
bfddbb17 13141 """
5b5c9bc7 13142 GetGBSizer(self) -> GridBagSizer
bfddbb17
RD		 13143
13144 Get the sizer this item is a member of.
13145 """
5b5c9bc7 13146 return _core_.GBSizerItem_GetGBSizer(*args, **kwargs)
d55e5bfc
RD		 13147
13148 def SetGBSizer(*args, **kwargs):
bfddbb17 13149 """
5b5c9bc7 13150 SetGBSizer(self, GridBagSizer sizer)
bfddbb17
RD		 13151
13152 Set the sizer this item is a member of.
13153 """
5b5c9bc7 13154 return _core_.GBSizerItem_SetGBSizer(*args, **kwargs)
d55e5bfc 13155
ac5d357a
RD		 13156 EndPos = property(GetEndPos,doc="See `GetEndPos`")
13157 GBSizer = property(GetGBSizer,SetGBSizer,doc="See `GetGBSizer` and `SetGBSizer`")
13158 Pos = property(GetPos,SetPos,doc="See `GetPos` and `SetPos`")
13159 Span = property(GetSpan,SetSpan,doc="See `GetSpan` and `SetSpan`")
2131d850 13160_core_.GBSizerItem_swigregister(GBSizerItem)
5b5c9bc7 13161DefaultSpan = cvar.DefaultSpan
d55e5bfc
RD		 13162
13163def GBSizerItemWindow(*args, **kwargs):
13164 """
5b5c9bc7
RD		 13165 GBSizerItemWindow(Window window, GBPosition pos, GBSpan span, int flag,
13166 int border, PyObject userData=None) -> GBSizerItem
bfddbb17
RD		 13167
13168 Construct a `wx.GBSizerItem` for a window.
d55e5bfc 13169 """
5b5c9bc7 13170 val = _core_.new_GBSizerItemWindow(*args, **kwargs)
d55e5bfc
RD		 13171 return val
13172
13173def GBSizerItemSizer(*args, **kwargs):
13174 """
5b5c9bc7
RD		 13175 GBSizerItemSizer(Sizer sizer, GBPosition pos, GBSpan span, int flag,
13176 int border, PyObject userData=None) -> GBSizerItem
bfddbb17
RD		 13177
13178 Construct a `wx.GBSizerItem` for a sizer
d55e5bfc 13179 """
5b5c9bc7 13180 val = _core_.new_GBSizerItemSizer(*args, **kwargs)
d55e5bfc
RD		 13181 return val
13182
13183def GBSizerItemSpacer(*args, **kwargs):
13184 """
5b5c9bc7
RD		 13185 GBSizerItemSpacer(int width, int height, GBPosition pos, GBSpan span,
13186 int flag, int border, PyObject userData=None) -> GBSizerItem
bfddbb17
RD		 13187
13188 Construct a `wx.GBSizerItem` for a spacer.
d55e5bfc 13189 """
5b5c9bc7 13190 val = _core_.new_GBSizerItemSpacer(*args, **kwargs)
d55e5bfc
RD		 13191 return val
13192
5b5c9bc7 13193class GridBagSizer(FlexGridSizer):
bfddbb17
RD		 13194 """
13195 A `wx.Sizer` that can lay out items in a virtual grid like a
13196 `wx.FlexGridSizer` but in this case explicit positioning of the items
13197 is allowed using `wx.GBPosition`, and items can optionally span more
13198 than one row and/or column using `wx.GBSpan`. The total size of the
13199 virtual grid is determined by the largest row and column that items are
13200 positioned at, adjusted for spanning.
13201
13202 """
1bd55598
RD		 13203 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
13204 __repr__ = _swig_repr
13205 def __init__(self, *args, **kwargs):
bfddbb17 13206 """
5b5c9bc7 13207 __init__(self, int vgap=0, int hgap=0) -> GridBagSizer
bfddbb17
RD		 13208
13209 Constructor, with optional parameters to specify the gap between the
13210 rows and columns.
13211 """
1bd55598 13212 _core_.GridBagSizer_swiginit(self,_core_.new_GridBagSizer(*args, **kwargs))
03e46024
RD		 13213 self._setOORInfo(self)
13214
d55e5bfc
RD		 13215 def Add(*args, **kwargs):
13216 """
bfddbb17 13217 Add(self, item, GBPosition pos, GBSpan span=DefaultSpan, int flag=0,
070c48b4 13218 int border=0, userData=None) -> wx.GBSizerItem
bfddbb17
RD		 13219
13220 Adds an item to the sizer at the grid cell *pos*, optionally spanning
13221 more than one row or column as specified with *span*. The remaining
13222 args behave similarly to `wx.Sizer.Add`.
13223
13224 Returns True if the item was successfully placed at the given cell
13225 position, False if something was already there.
13226
d55e5bfc 13227 """
5b5c9bc7 13228 return _core_.GridBagSizer_Add(*args, **kwargs)
d55e5bfc
RD		 13229
13230 def AddItem(*args, **kwargs):
bfddbb17 13231 """
070c48b4 13232 Add(self, GBSizerItem item) -> wx.GBSizerItem
bfddbb17
RD		 13233
13234 Add an item to the sizer using a `wx.GBSizerItem`. Returns True if
13235 the item was successfully placed at its given cell position, False if
13236 something was already there.
13237 """
5b5c9bc7 13238 return _core_.GridBagSizer_AddItem(*args, **kwargs)
d55e5bfc 13239
84f85550
RD		 13240 def GetCellSize(*args, **kwargs):
13241 """
5b5c9bc7 13242 GetCellSize(self, int row, int col) -> Size
84f85550
RD		 13243
13244 Get the size of the specified cell, including hgap and
13245 vgap. Only valid after a Layout.
13246 """
5b5c9bc7 13247 return _core_.GridBagSizer_GetCellSize(*args, **kwargs)
84f85550 13248
d55e5bfc 13249 def GetEmptyCellSize(*args, **kwargs):
bfddbb17 13250 """
5b5c9bc7 13251 GetEmptyCellSize(self) -> Size
bfddbb17
RD		 13252
13253 Get the size used for cells in the grid with no item.
13254 """
5b5c9bc7 13255 return _core_.GridBagSizer_GetEmptyCellSize(*args, **kwargs)
d55e5bfc
RD		 13256
13257 def SetEmptyCellSize(*args, **kwargs):
bfddbb17 13258 """
5b5c9bc7 13259 SetEmptyCellSize(self, Size sz)
bfddbb17
RD		 13260
13261 Set the size used for cells in the grid with no item.
13262 """
5b5c9bc7 13263 return _core_.GridBagSizer_SetEmptyCellSize(*args, **kwargs)
d55e5bfc
RD		 13264
13265 def GetItemPosition(*args):
13266 """
bfddbb17
RD		 13267 GetItemPosition(self, item) -> GBPosition
13268
13269 Get the grid position of the specified *item* where *item* is either a
13270 window or subsizer that is a member of this sizer, or a zero-based
13271 index of an item.
d55e5bfc 13272 """
5b5c9bc7 13273 return _core_.GridBagSizer_GetItemPosition(*args)
d55e5bfc
RD		 13274
13275 def SetItemPosition(*args):
13276 """
bfddbb17
RD		 13277 SetItemPosition(self, item, GBPosition pos) -> bool
13278
13279 Set the grid position of the specified *item* where *item* is either a
13280 window or subsizer that is a member of this sizer, or a zero-based
13281 index of an item. Returns True on success. If the move is not
13282 allowed (because an item is already there) then False is returned.
13283
d55e5bfc 13284 """
5b5c9bc7 13285 return _core_.GridBagSizer_SetItemPosition(*args)
d55e5bfc
RD		 13286
13287 def GetItemSpan(*args):
13288 """
bfddbb17
RD		 13289 GetItemSpan(self, item) -> GBSpan
13290
13291 Get the row/col spanning of the specified *item* where *item* is
13292 either a window or subsizer that is a member of this sizer, or a
13293 zero-based index of an item.
d55e5bfc 13294 """
5b5c9bc7 13295 return _core_.GridBagSizer_GetItemSpan(*args)
d55e5bfc
RD		 13296
13297 def SetItemSpan(*args):
13298 """
bfddbb17
RD		 13299 SetItemSpan(self, item, GBSpan span) -> bool
13300
13301 Set the row/col spanning of the specified *item* where *item* is
13302 either a window or subsizer that is a member of this sizer, or a
13303 zero-based index of an item. Returns True on success. If the move is
13304 not allowed (because an item is already there) then False is returned.
d55e5bfc 13305 """
5b5c9bc7 13306 return _core_.GridBagSizer_SetItemSpan(*args)
d55e5bfc
RD		 13307
13308 def FindItem(*args):
13309 """
bfddbb17
RD		 13310 FindItem(self, item) -> GBSizerItem
13311
13312 Find the sizer item for the given window or subsizer, returns None if
13313 not found. (non-recursive)
d55e5bfc 13314 """
5b5c9bc7 13315 return _core_.GridBagSizer_FindItem(*args)
d55e5bfc
RD		 13316
13317 def FindItemAtPosition(*args, **kwargs):
bfddbb17 13318 """
5b5c9bc7 13319 FindItemAtPosition(self, GBPosition pos) -> GBSizerItem
bfddbb17
RD		 13320
13321 Return the sizer item for the given grid cell, or None if there is no
13322 item at that position. (non-recursive)
13323 """
5b5c9bc7 13324 return _core_.GridBagSizer_FindItemAtPosition(*args, **kwargs)
d55e5bfc
RD		 13325
13326 def FindItemAtPoint(*args, **kwargs):
bfddbb17 13327 """
5b5c9bc7 13328 FindItemAtPoint(self, Point pt) -> GBSizerItem
bfddbb17
RD		 13329
13330 Return the sizer item located at the point given in *pt*, or None if
13331 there is no item at that point. The (x,y) coordinates in pt correspond
13332 to the client coordinates of the window using the sizer for
13333 layout. (non-recursive)
13334 """
5b5c9bc7 13335 return _core_.GridBagSizer_FindItemAtPoint(*args, **kwargs)
d55e5bfc 13336
bfddbb17
RD		 13337 def CheckForIntersection(*args, **kwargs):
13338 """
5b5c9bc7 13339 CheckForIntersection(self, GBSizerItem item, GBSizerItem excludeItem=None) -> bool
d55e5bfc 13340
bfddbb17
RD		 13341 Look at all items and see if any intersect (or would overlap) the
13342 given *item*. Returns True if so, False if there would be no overlap.
13343 If an *excludeItem* is given then it will not be checked for
13344 intersection, for example it may be the item we are checking the
13345 position of.
d55e5bfc 13346
bfddbb17 13347 """
5b5c9bc7 13348 return _core_.GridBagSizer_CheckForIntersection(*args, **kwargs)
d55e5bfc 13349
bfddbb17 13350 def CheckForIntersectionPos(*args, **kwargs):
d55e5bfc 13351 """
5b5c9bc7 13352 CheckForIntersectionPos(self, GBPosition pos, GBSpan span, GBSizerItem excludeItem=None) -> bool
bfddbb17
RD		 13353
13354 Look at all items and see if any intersect (or would overlap) the
13355 given position and span. Returns True if so, False if there would be
13356 no overlap. If an *excludeItem* is given then it will not be checked
13357 for intersection, for example it may be the item we are checking the
13358 position of.
d55e5bfc 13359 """
5b5c9bc7 13360 return _core_.GridBagSizer_CheckForIntersectionPos(*args, **kwargs)
d55e5bfc 13361
2131d850 13362_core_.GridBagSizer_swigregister(GridBagSizer)
d55e5bfc
RD		 13363
13364#---------------------------------------------------------------------------
13365
5b5c9bc7
RD		 13366Left = _core_.Left
13367Top = _core_.Top
13368Right = _core_.Right
13369Bottom = _core_.Bottom
13370Width = _core_.Width
13371Height = _core_.Height
13372Centre = _core_.Centre
13373Center = _core_.Center
13374CentreX = _core_.CentreX
13375CentreY = _core_.CentreY
13376Unconstrained = _core_.Unconstrained
13377AsIs = _core_.AsIs
13378PercentOf = _core_.PercentOf
13379Above = _core_.Above
13380Below = _core_.Below
13381LeftOf = _core_.LeftOf
13382RightOf = _core_.RightOf
13383SameAs = _core_.SameAs
13384Absolute = _core_.Absolute
13385class IndividualLayoutConstraint(Object):
d55e5bfc 13386 """
15817c7e
RD		 13387 Objects of this class are stored in the `wx.LayoutConstraints` class as
13388 one of eight possible constraints that a window can be involved in.
13389 You will never need to create an instance of
13390 wx.IndividualLayoutConstraint, rather you should create a
13391 `wx.LayoutConstraints` instance and use the individual contstraints
d55e5bfc 13392 that it contains.
d55e5bfc 13393 """
1bd55598
RD		 13394 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
13395 def __init__(self): raise AttributeError, "No constructor defined"
13396 __repr__ = _swig_repr
d55e5bfc 13397 def Set(*args, **kwargs):
15817c7e 13398 """
5b5c9bc7 13399 Set(self, int rel, Window otherW, int otherE, int val=0, int marg=wxLAYOUT_DEFAULT_MARGIN)
15817c7e
RD		 13400
13401 Sets the properties of the constraint. Normally called by one of the
13402 convenience functions such as Above, RightOf, SameAs.
13403 """
5b5c9bc7 13404 return _core_.IndividualLayoutConstraint_Set(*args, **kwargs)
d55e5bfc
RD		 13405
13406 def LeftOf(*args, **kwargs):
13407 """
5b5c9bc7 13408 LeftOf(self, Window sibling, int marg=0)
d55e5bfc 13409
15817c7e
RD		 13410 Constrains this edge to be to the left of the given window, with an
13411 optional margin. Implicitly, this is relative to the left edge of the
13412 other window.
d55e5bfc 13413 """
5b5c9bc7 13414 return _core_.IndividualLayoutConstraint_LeftOf(*args, **kwargs)
d55e5bfc
RD		 13415
13416 def RightOf(*args, **kwargs):
13417 """
5b5c9bc7 13418 RightOf(self, Window sibling, int marg=0)
d55e5bfc 13419
15817c7e
RD		 13420 Constrains this edge to be to the right of the given window, with an
13421 optional margin. Implicitly, this is relative to the right edge of the
13422 other window.
d55e5bfc 13423 """
5b5c9bc7 13424 return _core_.IndividualLayoutConstraint_RightOf(*args, **kwargs)
d55e5bfc
RD		 13425
13426 def Above(*args, **kwargs):
13427 """
5b5c9bc7 13428 Above(self, Window sibling, int marg=0)
d55e5bfc 13429
15817c7e
RD		 13430 Constrains this edge to be above the given window, with an optional
13431 margin. Implicitly, this is relative to the top edge of the other
13432 window.
d55e5bfc 13433 """
5b5c9bc7 13434 return _core_.IndividualLayoutConstraint_Above(*args, **kwargs)
d55e5bfc
RD		 13435
13436 def Below(*args, **kwargs):
13437 """
5b5c9bc7 13438 Below(self, Window sibling, int marg=0)
d55e5bfc 13439
15817c7e
RD		 13440 Constrains this edge to be below the given window, with an optional
13441 margin. Implicitly, this is relative to the bottom edge of the other
13442 window.
d55e5bfc 13443 """
5b5c9bc7 13444 return _core_.IndividualLayoutConstraint_Below(*args, **kwargs)
d55e5bfc
RD		 13445
13446 def SameAs(*args, **kwargs):
13447 """
5b5c9bc7 13448 SameAs(self, Window otherW, int edge, int marg=0)
d55e5bfc 13449
15817c7e
RD		 13450 Constrains this edge or dimension to be to the same as the edge of the
13451 given window, with an optional margin.
d55e5bfc 13452 """
5b5c9bc7 13453 return _core_.IndividualLayoutConstraint_SameAs(*args, **kwargs)
d55e5bfc
RD		 13454
13455 def PercentOf(*args, **kwargs):
13456 """
5b5c9bc7 13457 PercentOf(self, Window otherW, int wh, int per)
d55e5bfc 13458
15817c7e
RD		 13459 Constrains this edge or dimension to be to a percentage of the given
13460 window, with an optional margin.
d55e5bfc 13461 """
5b5c9bc7 13462 return _core_.IndividualLayoutConstraint_PercentOf(*args, **kwargs)
d55e5bfc
RD		 13463
13464 def Absolute(*args, **kwargs):
13465 """
13466 Absolute(self, int val)
13467
15817c7e 13468 Constrains this edge or dimension to be the given absolute value.
d55e5bfc 13469 """
5b5c9bc7 13470 return _core_.IndividualLayoutConstraint_Absolute(*args, **kwargs)
d55e5bfc
RD		 13471
13472 def Unconstrained(*args, **kwargs):
13473 """
13474 Unconstrained(self)
13475
15817c7e
RD		 13476 Sets this edge or dimension to be unconstrained, that is, dependent on
13477 other edges and dimensions from which this value can be deduced.
d55e5bfc 13478 """
5b5c9bc7 13479 return _core_.IndividualLayoutConstraint_Unconstrained(*args, **kwargs)
d55e5bfc
RD		 13480
13481 def AsIs(*args, **kwargs):
13482 """
13483 AsIs(self)
13484
15817c7e
RD		 13485 Sets this edge or constraint to be whatever the window's value is at
13486 the moment. If either of the width and height constraints are *as is*,
13487 the window will not be resized, but moved instead. This is important
13488 when considering panel items which are intended to have a default
13489 size, such as a button, which may take its size from the size of the
13490 button label.
d55e5bfc 13491 """
5b5c9bc7 13492 return _core_.IndividualLayoutConstraint_AsIs(*args, **kwargs)
d55e5bfc
RD		 13493
13494 def GetOtherWindow(*args, **kwargs):
5b5c9bc7
RD		 13495 """GetOtherWindow(self) -> Window"""
13496 return _core_.IndividualLayoutConstraint_GetOtherWindow(*args, **kwargs)
d55e5bfc
RD		 13497
13498 def GetMyEdge(*args, **kwargs):
13499 """GetMyEdge(self) -> int"""
5b5c9bc7 13500 return _core_.IndividualLayoutConstraint_GetMyEdge(*args, **kwargs)
d55e5bfc
RD		 13501
13502 def SetEdge(*args, **kwargs):
13503 """SetEdge(self, int which)"""
5b5c9bc7 13504 return _core_.IndividualLayoutConstraint_SetEdge(*args, **kwargs)
d55e5bfc
RD		 13505
13506 def SetValue(*args, **kwargs):
13507 """SetValue(self, int v)"""
5b5c9bc7 13508 return _core_.IndividualLayoutConstraint_SetValue(*args, **kwargs)
d55e5bfc
RD		 13509
13510 def GetMargin(*args, **kwargs):
13511 """GetMargin(self) -> int"""
5b5c9bc7 13512 return _core_.IndividualLayoutConstraint_GetMargin(*args, **kwargs)
d55e5bfc
RD		 13513
13514 def SetMargin(*args, **kwargs):
13515 """SetMargin(self, int m)"""
5b5c9bc7 13516 return _core_.IndividualLayoutConstraint_SetMargin(*args, **kwargs)
d55e5bfc
RD		 13517
13518 def GetValue(*args, **kwargs):
13519 """GetValue(self) -> int"""
5b5c9bc7 13520 return _core_.IndividualLayoutConstraint_GetValue(*args, **kwargs)
d55e5bfc
RD		 13521
13522 def GetPercent(*args, **kwargs):
13523 """GetPercent(self) -> int"""
5b5c9bc7 13524 return _core_.IndividualLayoutConstraint_GetPercent(*args, **kwargs)
d55e5bfc
RD		 13525
13526 def GetOtherEdge(*args, **kwargs):
13527 """GetOtherEdge(self) -> int"""
5b5c9bc7 13528 return _core_.IndividualLayoutConstraint_GetOtherEdge(*args, **kwargs)
d55e5bfc
RD		 13529
13530 def GetDone(*args, **kwargs):
13531 """GetDone(self) -> bool"""
5b5c9bc7 13532 return _core_.IndividualLayoutConstraint_GetDone(*args, **kwargs)
d55e5bfc
RD		 13533
13534 def SetDone(*args, **kwargs):
13535 """SetDone(self, bool d)"""
5b5c9bc7 13536 return _core_.IndividualLayoutConstraint_SetDone(*args, **kwargs)
d55e5bfc
RD		 13537
13538 def GetRelationship(*args, **kwargs):
13539 """GetRelationship(self) -> int"""
5b5c9bc7 13540 return _core_.IndividualLayoutConstraint_GetRelationship(*args, **kwargs)
d55e5bfc
RD		 13541
13542 def SetRelationship(*args, **kwargs):
13543 """SetRelationship(self, int r)"""
5b5c9bc7 13544 return _core_.IndividualLayoutConstraint_SetRelationship(*args, **kwargs)
d55e5bfc
RD		 13545
13546 def ResetIfWin(*args, **kwargs):
13547 """
5b5c9bc7 13548 ResetIfWin(self, Window otherW) -> bool
d55e5bfc
RD		 13549
13550 Reset constraint if it mentions otherWin
13551 """
5b5c9bc7 13552 return _core_.IndividualLayoutConstraint_ResetIfWin(*args, **kwargs)
d55e5bfc
RD		 13553
13554 def SatisfyConstraint(*args, **kwargs):
13555 """
5b5c9bc7 13556 SatisfyConstraint(self, LayoutConstraints constraints, Window win) -> bool
d55e5bfc
RD		 13557
13558 Try to satisfy constraint
13559 """
5b5c9bc7 13560 return _core_.IndividualLayoutConstraint_SatisfyConstraint(*args, **kwargs)
d55e5bfc
RD		 13561
13562 def GetEdge(*args, **kwargs):
13563 """
5b5c9bc7 13564 GetEdge(self, int which, Window thisWin, Window other) -> int
d55e5bfc
RD		 13565
13566 Get the value of this edge or dimension, or if this
13567 is not determinable, -1.
13568 """
5b5c9bc7 13569 return _core_.IndividualLayoutConstraint_GetEdge(*args, **kwargs)
d55e5bfc 13570
ac5d357a
RD		 13571 Done = property(GetDone,SetDone,doc="See `GetDone` and `SetDone`")
13572 Margin = property(GetMargin,SetMargin,doc="See `GetMargin` and `SetMargin`")
13573 MyEdge = property(GetMyEdge,doc="See `GetMyEdge`")
13574 OtherEdge = property(GetOtherEdge,doc="See `GetOtherEdge`")
13575 OtherWindow = property(GetOtherWindow,doc="See `GetOtherWindow`")
13576 Percent = property(GetPercent,doc="See `GetPercent`")
13577 Relationship = property(GetRelationship,SetRelationship,doc="See `GetRelationship` and `SetRelationship`")
13578 Value = property(GetValue,SetValue,doc="See `GetValue` and `SetValue`")
2131d850 13579_core_.IndividualLayoutConstraint_swigregister(IndividualLayoutConstraint)
d55e5bfc 13580
5b5c9bc7 13581class LayoutConstraints(Object):
d55e5bfc 13582 """
15817c7e
RD		 13583 **Note:** constraints are now deprecated and you should use sizers
13584 instead.
d55e5bfc 13585
15817c7e
RD		 13586 Objects of this class can be associated with a window to define its
13587 layout constraints, with respect to siblings or its parent.
d55e5bfc
RD		 13588
13589 The class consists of the following eight constraints of class
13590 wx.IndividualLayoutConstraint, some or all of which should be accessed
13591 directly to set the appropriate constraints.
13592
13593 * left: represents the left hand edge of the window
13594 * right: represents the right hand edge of the window
13595 * top: represents the top edge of the window
13596 * bottom: represents the bottom edge of the window
13597 * width: represents the width of the window
13598 * height: represents the height of the window
13599 * centreX: represents the horizontal centre point of the window
13600 * centreY: represents the vertical centre point of the window
13601
15817c7e
RD		 13602 Most constraints are initially set to have the relationship
13603 wxUnconstrained, which means that their values should be calculated by
13604 looking at known constraints. The exceptions are width and height,
13605 which are set to wxAsIs to ensure that if the user does not specify a
13606 constraint, the existing width and height will be used, to be
13607 compatible with panel items which often have take a default size. If
13608 the constraint is ``wx.AsIs``, the dimension will not be changed.
13609
13610 :see: `wx.IndividualLayoutConstraint`, `wx.Window.SetConstraints`
d55e5bfc
RD		 13611
13612 """
1bd55598
RD		 13613 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
13614 __repr__ = _swig_repr
5b5c9bc7
RD		 13615 left = property(_core_.LayoutConstraints_left_get)
13616 top = property(_core_.LayoutConstraints_top_get)
13617 right = property(_core_.LayoutConstraints_right_get)
13618 bottom = property(_core_.LayoutConstraints_bottom_get)
13619 width = property(_core_.LayoutConstraints_width_get)
13620 height = property(_core_.LayoutConstraints_height_get)
13621 centreX = property(_core_.LayoutConstraints_centreX_get)
13622 centreY = property(_core_.LayoutConstraints_centreY_get)
1bd55598 13623 def __init__(self, *args, **kwargs):
5b5c9bc7 13624 """__init__(self) -> LayoutConstraints"""
1bd55598
RD		 13625 _core_.LayoutConstraints_swiginit(self,_core_.new_LayoutConstraints(*args, **kwargs))
13626 __swig_destroy__ = _core_.delete_LayoutConstraints
13627 __del__ = lambda self : None;
d55e5bfc
RD		 13628 def SatisfyConstraints(*args, **kwargs):
13629 """SatisfyConstraints(Window win) -> (areSatisfied, noChanges)"""
5b5c9bc7 13630 return _core_.LayoutConstraints_SatisfyConstraints(*args, **kwargs)
d55e5bfc
RD		 13631
13632 def AreSatisfied(*args, **kwargs):
13633 """AreSatisfied(self) -> bool"""
5b5c9bc7 13634 return _core_.LayoutConstraints_AreSatisfied(*args, **kwargs)
d55e5bfc 13635
2131d850 13636_core_.LayoutConstraints_swigregister(LayoutConstraints)
d55e5bfc
RD		 13637
13638#----------------------------------------------------------------------------
13639
13640# Use Python's bool constants if available, make some if not
13641try:
13642 True
13643except NameError:
13644 __builtins__.True = 1==1
13645 __builtins__.False = 1==0
13646 def bool(value): return not not value
13647 __builtins__.bool = bool
13648
13649
13650
13651# workarounds for bad wxRTTI names
13652__wxPyPtrTypeMap['wxGauge95'] = 'wxGauge'
13653__wxPyPtrTypeMap['wxSlider95'] = 'wxSlider'
13654__wxPyPtrTypeMap['wxStatusBar95'] = 'wxStatusBar'
13655
13656
13657#----------------------------------------------------------------------------
13658# Load version numbers from __version__... Ensure that major and minor
0f63ec68 13659# versions are the same for both wxPython and wxWidgets.
d55e5bfc
RD		 13660
13661from __version__ import *
13662__version__ = VERSION_STRING
13663
0f63ec68
RD		 13664assert MAJOR_VERSION == _core_.MAJOR_VERSION, "wxPython/wxWidgets version mismatch"
13665assert MINOR_VERSION == _core_.MINOR_VERSION, "wxPython/wxWidgets version mismatch"
d55e5bfc
RD		 13666if RELEASE_VERSION != _core_.RELEASE_VERSION:
13667 import warnings
0f63ec68 13668 warnings.warn("wxPython/wxWidgets release number mismatch")
d55e5bfc
RD		 13669
13670#----------------------------------------------------------------------------
13671
7993762b
RD		 13672# Set wxPython's default string<-->unicode conversion encoding from
13673# the locale, but only if Python's default hasn't been changed. (We
13674# assume that if the user has customized it already then that is the
13675# encoding we need to use as well.)
13676#
13677# The encoding selected here is used when string or unicode objects
13678# need to be converted in order to pass them to wxWidgets. Please be
13679# aware that the default encoding within the same locale may be
13680# slightly different on different platforms. For example, please see
62d32a5f
RD		 13681# http://www.alanwood.net/demos/charsetdiffs.html for differences
13682# between the common latin/roman encodings.
3837a853
RD		 13683
13684default = _sys.getdefaultencoding()
13685if default == 'ascii':
13686 import locale
13687 import codecs
13688 try:
13689 default = locale.getdefaultlocale()[1]
13690 codecs.lookup(default)
7993762b 13691 except (ValueError, LookupError, TypeError):
3837a853
RD		 13692 default = _sys.getdefaultencoding()
13693 del locale
13694 del codecs
5cbf236d
RD		 13695if default:
13696 wx.SetDefaultPyEncoding(default)
13697del default
5cbf236d
RD		 13698
13699#----------------------------------------------------------------------------
13700
d55e5bfc
RD		 13701class PyDeadObjectError(AttributeError):
13702 pass
13703
13704class _wxPyDeadObject(object):
13705 """
13706 Instances of wx objects that are OOR capable will have their __class__
13707 changed to this class when the C++ object is deleted. This should help
13708 prevent crashes due to referencing a bogus C++ pointer.
13709 """
13710 reprStr = "wxPython wrapper for DELETED %s object! (The C++ object no longer exists.)"
13711 attrStr = "The C++ part of the %s object has been deleted, attribute access no longer allowed."
13712
13713 def __repr__(self):
13714 if not hasattr(self, "_name"):
13715 self._name = "[unknown]"
13716 return self.reprStr % self._name
13717
13718 def __getattr__(self, *args):
13719 if not hasattr(self, "_name"):
13720 self._name = "[unknown]"
13721 raise PyDeadObjectError(self.attrStr % self._name)
13722
13723 def __nonzero__(self):
13724 return 0
13725
13726
13727
13728class PyUnbornObjectError(AttributeError):
13729 pass
13730
13731class _wxPyUnbornObject(object):
13732 """
13733 Some stock objects are created when the wx._core module is
13734 imported, but their C++ instance is not created until the wx.App
13735 object is created and initialized. These object instances will
13736 temporarily have their __class__ changed to this class so an
13737 exception will be raised if they are used before the C++ instance
13738 is ready.
13739 """
13740
13741 reprStr = "wxPython wrapper for UNBORN object! (The C++ object is not initialized yet.)"
13742 attrStr = "The C++ part of this object has not been initialized, attribute access not allowed."
13743
13744 def __repr__(self):
13745 #if not hasattr(self, "_name"):
13746 # self._name = "[unknown]"
13747 return self.reprStr #% self._name
13748
13749 def __getattr__(self, *args):
13750 #if not hasattr(self, "_name"):
13751 # self._name = "[unknown]"
13752 raise PyUnbornObjectError(self.attrStr) # % self._name )
13753
13754 def __nonzero__(self):
13755 return 0
13756
13757
13758#----------------------------------------------------------------------------
d55e5bfc
RD		 13759
13760def CallAfter(callable, *args, **kw):
13761 """
13762 Call the specified function after the current and pending event
13763 handlers have been completed. This is also good for making GUI
0439c23b
RD		 13764 method calls from non-GUI threads. Any extra positional or
13765 keyword args are passed on to the callable when it is called.
13766
846c181b 13767 :see: `wx.CallLater`
d55e5bfc
RD		 13768 """
13769 app = wx.GetApp()
a001823c 13770 assert app is not None, 'No wx.App created yet'
d55e5bfc 13771
891bb194
RD		 13772 if not hasattr(app, "_CallAfterId"):
13773 app._CallAfterId = wx.NewEventType()
13774 app.Connect(-1, -1, app._CallAfterId,
13775 lambda event: event.callable(*event.args, **event.kw) )
d55e5bfc 13776 evt = wx.PyEvent()
891bb194 13777 evt.SetEventType(app._CallAfterId)
d55e5bfc
RD		 13778 evt.callable = callable
13779 evt.args = args
13780 evt.kw = kw
13781 wx.PostEvent(app, evt)
13782
d55e5bfc
RD		 13783#----------------------------------------------------------------------------
13784
13785
846c181b 13786class CallLater:
d55e5bfc 13787 """
6e0de3df 13788 A convenience class for `wx.Timer`, that calls the given callable
d55e5bfc
RD		 13789 object once after the given amount of milliseconds, passing any
13790 positional or keyword args. The return value of the callable is
0439c23b 13791 availbale after it has been run with the `GetResult` method.
d55e5bfc
RD		 13792
13793 If you don't need to get the return value or restart the timer
13794 then there is no need to hold a reference to this object. It will
13795 hold a reference to itself while the timer is running (the timer
13796 has a reference to self.Notify) but the cycle will be broken when
846c181b 13797 the timer completes, automatically cleaning up the wx.CallLater
d55e5bfc 13798 object.
0439c23b
RD		 13799
13800 :see: `wx.CallAfter`
d55e5bfc
RD		 13801 """
13802 def __init__(self, millis, callable, *args, **kwargs):
13803 self.millis = millis
13804 self.callable = callable
13805 self.SetArgs(*args, **kwargs)
13806 self.runCount = 0
13807 self.running = False
13808 self.hasRun = False
13809 self.result = None
13810 self.timer = None
13811 self.Start()
13812
13813 def __del__(self):
13814 self.Stop()
13815
13816
13817 def Start(self, millis=None, *args, **kwargs):
13818 """
13819 (Re)start the timer
13820 """
13821 self.hasRun = False
13822 if millis is not None:
13823 self.millis = millis
13824 if args or kwargs:
13825 self.SetArgs(*args, **kwargs)
13826 self.Stop()
13827 self.timer = wx.PyTimer(self.Notify)
13828 self.timer.Start(self.millis, wx.TIMER_ONE_SHOT)
13829 self.running = True
13830 Restart = Start
13831
13832
13833 def Stop(self):
13834 """
13835 Stop and destroy the timer.
13836 """
13837 if self.timer is not None:
13838 self.timer.Stop()
13839 self.timer = None
13840
13841
13842 def GetInterval(self):
13843 if self.timer is not None:
13844 return self.timer.GetInterval()
13845 else:
13846 return 0
13847
13848
13849 def IsRunning(self):
13850 return self.timer is not None and self.timer.IsRunning()
13851
13852
13853 def SetArgs(self, *args, **kwargs):
13854 """
13855 (Re)set the args passed to the callable object. This is
13856 useful in conjunction with Restart if you want to schedule a
13857 new call to the same callable object but with different
13858 parameters.
13859 """
13860 self.args = args
13861 self.kwargs = kwargs
13862
13863
13864 def HasRun(self):
13865 return self.hasRun
13866
13867 def GetResult(self):
13868 return self.result
13869
13870 def Notify(self):
13871 """
13872 The timer has expired so call the callable.
13873 """
13874 if self.callable and getattr(self.callable, 'im_self', True):
13875 self.runCount += 1
13876 self.running = False
13877 self.result = self.callable(*self.args, **self.kwargs)
13878 self.hasRun = True
13879 if not self.running:
13880 # if it wasn't restarted, then cleanup
13881 wx.CallAfter(self.Stop)
13882
ac5d357a
RD		 13883 Interval = property(GetInterval)
13884 Result = property(GetResult)
d55e5bfc
RD		 13885
13886
846c181b
RD		 13887class FutureCall(CallLater):
13888 """A compatibility alias for `CallLater`."""
13889
d55e5bfc
RD		 13890#----------------------------------------------------------------------------
13891# Control which items in this module should be documented by epydoc.
13892# We allow only classes and functions, which will help reduce the size
13893# of the docs by filtering out the zillions of constants, EVT objects,
13894# and etc that don't make much sense by themselves, but are instead
13895# documented (or will be) as part of the classes/functions/methods
13896# where they should be used.
13897
d6c14a4c
RD		 13898class __DocFilter:
13899 """
13900 A filter for epydoc that only allows non-Ptr classes and
34e0a3bb 13901 functions, in order to reduce the clutter in the API docs.
d6c14a4c
RD		 13902 """
13903 def __init__(self, globals):
13904 self._globals = globals
13905
13906 def __call__(self, name):
13907 import types
13908 obj = self._globals.get(name, None)
34e0a3bb
RD		 13909
13910 # only document classes and function
d6c14a4c
RD		 13911 if type(obj) not in [type, types.ClassType, types.FunctionType, types.BuiltinFunctionType]:
13912 return False
34e0a3bb
RD		 13913
13914 # skip other things that are private or will be documented as part of somethign else
1bd55598 13915 if name.startswith('_') or name.startswith('EVT') or name.endswith('_swigregister') or name.endswith('Ptr') :
d6c14a4c 13916 return False
34e0a3bb
RD		 13917
13918 # skip functions that are duplicates of static functions in a class
13919 if name.find('_') != -1:
13920 cls = self._globals.get(name.split('_')[0], None)
13921 methname = name.split('_')[1]
13922 if hasattr(cls, methname) and type(getattr(cls, methname)) is types.FunctionType:
13923 return False
13924
d6c14a4c 13925 return True
d55e5bfc
RD		 13926
13927#----------------------------------------------------------------------------
13928#----------------------------------------------------------------------------
13929
13930# Import other modules in this package that should show up in the
13931# "core" wx namespace
13932from _gdi import *
13933from _windows import *
13934from _controls import *
13935from _misc import *
13936
d55e5bfc
RD		 13937#----------------------------------------------------------------------------
13938#----------------------------------------------------------------------------
13939
13940
32fe5131 13941
wxWidgets (Impactor)