]> git.saurik.com Git - wxWidgets.git/blame - wxPython/src/gtk/_core.py
projects / wxWidgets.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
reSWIGged
[wxWidgets.git] / wxPython / src / gtk / _core.py
CommitLineData
0085ce49 1# This file was created automatically by SWIG 1.3.29.
d14a1e28
RD		 2# Don't modify this file, modify the SWIG interface instead.
3
54f9ee45 4import _core_
0085ce49
RD		 5import new
6new_instancemethod = new.instancemethod
093d3ff1 7def _swig_setattr_nondynamic(self,class_type,name,value,static=1):
0085ce49 8 if (name == "thisown"): return self.this.own(value)
093d3ff1 9 if (name == "this"):
0085ce49
RD		 10 if type(value).__name__ == 'PySwigObject':
11 self.__dict__[name] = value
093d3ff1
RD		 12 return
13 method = class_type.__swig_setmethods__.get(name,None)
14 if method: return method(self,value)
0085ce49 15 if (not static) or hasattr(self,name):
093d3ff1
RD		 16 self.__dict__[name] = value
17 else:
18 raise AttributeError("You cannot add attributes to %s" % self)
19
20def _swig_setattr(self,class_type,name,value):
21 return _swig_setattr_nondynamic(self,class_type,name,value,0)
22
23def _swig_getattr(self,class_type,name):
0085ce49 24 if (name == "thisown"): return self.this.own()
093d3ff1
RD		 25 method = class_type.__swig_getmethods__.get(name,None)
26 if method: return method(self)
27 raise AttributeError,name
28
0085ce49
RD		 29def _swig_repr(self):
30 try: strthis = "proxy of " + self.this.__repr__()
31 except: strthis = ""
32 return "<%s.%s; %s >" % (self.__class__.__module__, self.__class__.__name__, strthis,)
33
093d3ff1
RD		 34import types
35try:
36 _object = types.ObjectType
37 _newclass = 1
38except AttributeError:
39 class _object : pass
40 _newclass = 0
41del types
42
43
44def _swig_setattr_nondynamic_method(set):
45 def set_attr(self,name,value):
0085ce49
RD		 46 if (name == "thisown"): return self.this.own(value)
47 if hasattr(self,name) or (name == "this"):
093d3ff1
RD		 48 set(self,name,value)
49 else:
50 raise AttributeError("You cannot add attributes to %s" % self)
51 return set_attr
52
53
d14a1e28
RD		 54#// Give a reference to the dictionary of this module to the C++ extension
55#// code.
54f9ee45 56_core_._wxPySetDictionary(vars())
d14a1e28
RD		 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
66c033b4
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
54f9ee45
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
bcd0d7b6 95DEFAULT_CONTROL_BORDER = _core_.DEFAULT_CONTROL_BORDER
6d88e192 96DEFAULT_STATUSBAR_STYLE = _core_.DEFAULT_STATUSBAR_STYLE
54f9ee45
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
54f9ee45
RD		 103CLIP_CHILDREN = _core_.CLIP_CHILDREN
104CLIP_SIBLINGS = _core_.CLIP_SIBLINGS
092f0ed7 105WINDOW_STYLE_MASK = _core_.WINDOW_STYLE_MASK
54f9ee45
RD		 106ALWAYS_SHOW_SB = _core_.ALWAYS_SHOW_SB
107RETAINED = _core_.RETAINED
108BACKINGSTORE = _core_.BACKINGSTORE
109COLOURED = _core_.COLOURED
110FIXED_LENGTH = _core_.FIXED_LENGTH
111LB_NEEDED_SB = _core_.LB_NEEDED_SB
112LB_ALWAYS_SB = _core_.LB_ALWAYS_SB
113LB_SORT = _core_.LB_SORT
114LB_SINGLE = _core_.LB_SINGLE
115LB_MULTIPLE = _core_.LB_MULTIPLE
116LB_EXTENDED = _core_.LB_EXTENDED
117LB_OWNERDRAW = _core_.LB_OWNERDRAW
118LB_HSCROLL = _core_.LB_HSCROLL
119PROCESS_ENTER = _core_.PROCESS_ENTER
120PASSWORD = _core_.PASSWORD
121CB_SIMPLE = _core_.CB_SIMPLE
122CB_DROPDOWN = _core_.CB_DROPDOWN
123CB_SORT = _core_.CB_SORT
124CB_READONLY = _core_.CB_READONLY
125RA_HORIZONTAL = _core_.RA_HORIZONTAL
126RA_VERTICAL = _core_.RA_VERTICAL
127RA_SPECIFY_ROWS = _core_.RA_SPECIFY_ROWS
128RA_SPECIFY_COLS = _core_.RA_SPECIFY_COLS
fef4c27a 129RA_USE_CHECKBOX = _core_.RA_USE_CHECKBOX
54f9ee45
RD		 130RB_GROUP = _core_.RB_GROUP
131RB_SINGLE = _core_.RB_SINGLE
54f9ee45
RD		 132SB_HORIZONTAL = _core_.SB_HORIZONTAL
133SB_VERTICAL = _core_.SB_VERTICAL
fef4c27a 134RB_USE_CHECKBOX = _core_.RB_USE_CHECKBOX
54f9ee45
RD		 135ST_SIZEGRIP = _core_.ST_SIZEGRIP
136ST_NO_AUTORESIZE = _core_.ST_NO_AUTORESIZE
e9d6f3a4
RD		 137ST_DOTS_MIDDLE = _core_.ST_DOTS_MIDDLE
138ST_DOTS_END = _core_.ST_DOTS_END
54f9ee45
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
54f9ee45
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
54f9ee45
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
54f9ee45
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
10044bf1
RD		 204ID_HELP_INDEX = _core_.ID_HELP_INDEX
205ID_HELP_SEARCH = _core_.ID_HELP_SEARCH
54f9ee45
RD		 206ID_CLOSE_ALL = _core_.ID_CLOSE_ALL
207ID_PREFERENCES = _core_.ID_PREFERENCES
97ab0f6a 208ID_EDIT = _core_.ID_EDIT
54f9ee45
RD		 209ID_CUT = _core_.ID_CUT
210ID_COPY = _core_.ID_COPY
211ID_PASTE = _core_.ID_PASTE
212ID_CLEAR = _core_.ID_CLEAR
213ID_FIND = _core_.ID_FIND
214ID_DUPLICATE = _core_.ID_DUPLICATE
215ID_SELECTALL = _core_.ID_SELECTALL
216ID_DELETE = _core_.ID_DELETE
217ID_REPLACE = _core_.ID_REPLACE
218ID_REPLACE_ALL = _core_.ID_REPLACE_ALL
219ID_PROPERTIES = _core_.ID_PROPERTIES
220ID_VIEW_DETAILS = _core_.ID_VIEW_DETAILS
221ID_VIEW_LARGEICONS = _core_.ID_VIEW_LARGEICONS
222ID_VIEW_SMALLICONS = _core_.ID_VIEW_SMALLICONS
223ID_VIEW_LIST = _core_.ID_VIEW_LIST
224ID_VIEW_SORTDATE = _core_.ID_VIEW_SORTDATE
225ID_VIEW_SORTNAME = _core_.ID_VIEW_SORTNAME
226ID_VIEW_SORTSIZE = _core_.ID_VIEW_SORTSIZE
227ID_VIEW_SORTTYPE = _core_.ID_VIEW_SORTTYPE
97ab0f6a 228ID_FILE = _core_.ID_FILE
54f9ee45
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
7bc1e663
RD		 256ID_ADD = _core_.ID_ADD
257ID_REMOVE = _core_.ID_REMOVE
258ID_UP = _core_.ID_UP
259ID_DOWN = _core_.ID_DOWN
260ID_HOME = _core_.ID_HOME
261ID_REFRESH = _core_.ID_REFRESH
262ID_STOP = _core_.ID_STOP
263ID_INDEX = _core_.ID_INDEX
264ID_BOLD = _core_.ID_BOLD
265ID_ITALIC = _core_.ID_ITALIC
266ID_JUSTIFY_CENTER = _core_.ID_JUSTIFY_CENTER
267ID_JUSTIFY_FILL = _core_.ID_JUSTIFY_FILL
268ID_JUSTIFY_RIGHT = _core_.ID_JUSTIFY_RIGHT
269ID_JUSTIFY_LEFT = _core_.ID_JUSTIFY_LEFT
270ID_UNDERLINE = _core_.ID_UNDERLINE
271ID_INDENT = _core_.ID_INDENT
272ID_UNINDENT = _core_.ID_UNINDENT
273ID_ZOOM_100 = _core_.ID_ZOOM_100
274ID_ZOOM_FIT = _core_.ID_ZOOM_FIT
275ID_ZOOM_IN = _core_.ID_ZOOM_IN
276ID_ZOOM_OUT = _core_.ID_ZOOM_OUT
277ID_UNDELETE = _core_.ID_UNDELETE
278ID_REVERT_TO_SAVED = _core_.ID_REVERT_TO_SAVED
54f9ee45 279ID_HIGHEST = _core_.ID_HIGHEST
54f9ee45
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
7bc1e663
RD		 346BG_STYLE_SYSTEM = _core_.BG_STYLE_SYSTEM
347BG_STYLE_COLOUR = _core_.BG_STYLE_COLOUR
348BG_STYLE_CUSTOM = _core_.BG_STYLE_CUSTOM
54f9ee45
RD		 349DEFAULT = _core_.DEFAULT
350DECORATIVE = _core_.DECORATIVE
351ROMAN = _core_.ROMAN
352SCRIPT = _core_.SCRIPT
353SWISS = _core_.SWISS
354MODERN = _core_.MODERN
355TELETYPE = _core_.TELETYPE
356VARIABLE = _core_.VARIABLE
357FIXED = _core_.FIXED
358NORMAL = _core_.NORMAL
359LIGHT = _core_.LIGHT
360BOLD = _core_.BOLD
361ITALIC = _core_.ITALIC
362SLANT = _core_.SLANT
363SOLID = _core_.SOLID
364DOT = _core_.DOT
365LONG_DASH = _core_.LONG_DASH
366SHORT_DASH = _core_.SHORT_DASH
367DOT_DASH = _core_.DOT_DASH
368USER_DASH = _core_.USER_DASH
369TRANSPARENT = _core_.TRANSPARENT
370STIPPLE = _core_.STIPPLE
d04418a7
RD		 371STIPPLE_MASK = _core_.STIPPLE_MASK
372STIPPLE_MASK_OPAQUE = _core_.STIPPLE_MASK_OPAQUE
54f9ee45
RD		 373BDIAGONAL_HATCH = _core_.BDIAGONAL_HATCH
374CROSSDIAG_HATCH = _core_.CROSSDIAG_HATCH
375FDIAGONAL_HATCH = _core_.FDIAGONAL_HATCH
376CROSS_HATCH = _core_.CROSS_HATCH
377HORIZONTAL_HATCH = _core_.HORIZONTAL_HATCH
378VERTICAL_HATCH = _core_.VERTICAL_HATCH
379JOIN_BEVEL = _core_.JOIN_BEVEL
380JOIN_MITER = _core_.JOIN_MITER
381JOIN_ROUND = _core_.JOIN_ROUND
382CAP_ROUND = _core_.CAP_ROUND
383CAP_PROJECTING = _core_.CAP_PROJECTING
384CAP_BUTT = _core_.CAP_BUTT
385CLEAR = _core_.CLEAR
386XOR = _core_.XOR
387INVERT = _core_.INVERT
388OR_REVERSE = _core_.OR_REVERSE
389AND_REVERSE = _core_.AND_REVERSE
390COPY = _core_.COPY
391AND = _core_.AND
392AND_INVERT = _core_.AND_INVERT
393NO_OP = _core_.NO_OP
394NOR = _core_.NOR
395EQUIV = _core_.EQUIV
396SRC_INVERT = _core_.SRC_INVERT
397OR_INVERT = _core_.OR_INVERT
398NAND = _core_.NAND
399OR = _core_.OR
400SET = _core_.SET
401WXK_BACK = _core_.WXK_BACK
402WXK_TAB = _core_.WXK_TAB
403WXK_RETURN = _core_.WXK_RETURN
404WXK_ESCAPE = _core_.WXK_ESCAPE
405WXK_SPACE = _core_.WXK_SPACE
406WXK_DELETE = _core_.WXK_DELETE
407WXK_START = _core_.WXK_START
408WXK_LBUTTON = _core_.WXK_LBUTTON
409WXK_RBUTTON = _core_.WXK_RBUTTON
410WXK_CANCEL = _core_.WXK_CANCEL
411WXK_MBUTTON = _core_.WXK_MBUTTON
412WXK_CLEAR = _core_.WXK_CLEAR
413WXK_SHIFT = _core_.WXK_SHIFT
414WXK_ALT = _core_.WXK_ALT
415WXK_CONTROL = _core_.WXK_CONTROL
416WXK_MENU = _core_.WXK_MENU
417WXK_PAUSE = _core_.WXK_PAUSE
418WXK_CAPITAL = _core_.WXK_CAPITAL
419WXK_PRIOR = _core_.WXK_PRIOR
420WXK_NEXT = _core_.WXK_NEXT
421WXK_END = _core_.WXK_END
422WXK_HOME = _core_.WXK_HOME
423WXK_LEFT = _core_.WXK_LEFT
424WXK_UP = _core_.WXK_UP
425WXK_RIGHT = _core_.WXK_RIGHT
426WXK_DOWN = _core_.WXK_DOWN
427WXK_SELECT = _core_.WXK_SELECT
428WXK_PRINT = _core_.WXK_PRINT
429WXK_EXECUTE = _core_.WXK_EXECUTE
430WXK_SNAPSHOT = _core_.WXK_SNAPSHOT
431WXK_INSERT = _core_.WXK_INSERT
432WXK_HELP = _core_.WXK_HELP
433WXK_NUMPAD0 = _core_.WXK_NUMPAD0
434WXK_NUMPAD1 = _core_.WXK_NUMPAD1
435WXK_NUMPAD2 = _core_.WXK_NUMPAD2
436WXK_NUMPAD3 = _core_.WXK_NUMPAD3
437WXK_NUMPAD4 = _core_.WXK_NUMPAD4
438WXK_NUMPAD5 = _core_.WXK_NUMPAD5
439WXK_NUMPAD6 = _core_.WXK_NUMPAD6
440WXK_NUMPAD7 = _core_.WXK_NUMPAD7
441WXK_NUMPAD8 = _core_.WXK_NUMPAD8
442WXK_NUMPAD9 = _core_.WXK_NUMPAD9
443WXK_MULTIPLY = _core_.WXK_MULTIPLY
444WXK_ADD = _core_.WXK_ADD
445WXK_SEPARATOR = _core_.WXK_SEPARATOR
446WXK_SUBTRACT = _core_.WXK_SUBTRACT
447WXK_DECIMAL = _core_.WXK_DECIMAL
448WXK_DIVIDE = _core_.WXK_DIVIDE
449WXK_F1 = _core_.WXK_F1
450WXK_F2 = _core_.WXK_F2
451WXK_F3 = _core_.WXK_F3
452WXK_F4 = _core_.WXK_F4
453WXK_F5 = _core_.WXK_F5
454WXK_F6 = _core_.WXK_F6
455WXK_F7 = _core_.WXK_F7
456WXK_F8 = _core_.WXK_F8
457WXK_F9 = _core_.WXK_F9
458WXK_F10 = _core_.WXK_F10
459WXK_F11 = _core_.WXK_F11
460WXK_F12 = _core_.WXK_F12
461WXK_F13 = _core_.WXK_F13
462WXK_F14 = _core_.WXK_F14
463WXK_F15 = _core_.WXK_F15
464WXK_F16 = _core_.WXK_F16
465WXK_F17 = _core_.WXK_F17
466WXK_F18 = _core_.WXK_F18
467WXK_F19 = _core_.WXK_F19
468WXK_F20 = _core_.WXK_F20
469WXK_F21 = _core_.WXK_F21
470WXK_F22 = _core_.WXK_F22
471WXK_F23 = _core_.WXK_F23
472WXK_F24 = _core_.WXK_F24
473WXK_NUMLOCK = _core_.WXK_NUMLOCK
474WXK_SCROLL = _core_.WXK_SCROLL
475WXK_PAGEUP = _core_.WXK_PAGEUP
476WXK_PAGEDOWN = _core_.WXK_PAGEDOWN
477WXK_NUMPAD_SPACE = _core_.WXK_NUMPAD_SPACE
478WXK_NUMPAD_TAB = _core_.WXK_NUMPAD_TAB
479WXK_NUMPAD_ENTER = _core_.WXK_NUMPAD_ENTER
480WXK_NUMPAD_F1 = _core_.WXK_NUMPAD_F1
481WXK_NUMPAD_F2 = _core_.WXK_NUMPAD_F2
482WXK_NUMPAD_F3 = _core_.WXK_NUMPAD_F3
483WXK_NUMPAD_F4 = _core_.WXK_NUMPAD_F4
484WXK_NUMPAD_HOME = _core_.WXK_NUMPAD_HOME
485WXK_NUMPAD_LEFT = _core_.WXK_NUMPAD_LEFT
486WXK_NUMPAD_UP = _core_.WXK_NUMPAD_UP
487WXK_NUMPAD_RIGHT = _core_.WXK_NUMPAD_RIGHT
488WXK_NUMPAD_DOWN = _core_.WXK_NUMPAD_DOWN
489WXK_NUMPAD_PRIOR = _core_.WXK_NUMPAD_PRIOR
490WXK_NUMPAD_PAGEUP = _core_.WXK_NUMPAD_PAGEUP
491WXK_NUMPAD_NEXT = _core_.WXK_NUMPAD_NEXT
492WXK_NUMPAD_PAGEDOWN = _core_.WXK_NUMPAD_PAGEDOWN
493WXK_NUMPAD_END = _core_.WXK_NUMPAD_END
494WXK_NUMPAD_BEGIN = _core_.WXK_NUMPAD_BEGIN
495WXK_NUMPAD_INSERT = _core_.WXK_NUMPAD_INSERT
496WXK_NUMPAD_DELETE = _core_.WXK_NUMPAD_DELETE
497WXK_NUMPAD_EQUAL = _core_.WXK_NUMPAD_EQUAL
498WXK_NUMPAD_MULTIPLY = _core_.WXK_NUMPAD_MULTIPLY
499WXK_NUMPAD_ADD = _core_.WXK_NUMPAD_ADD
500WXK_NUMPAD_SEPARATOR = _core_.WXK_NUMPAD_SEPARATOR
501WXK_NUMPAD_SUBTRACT = _core_.WXK_NUMPAD_SUBTRACT
502WXK_NUMPAD_DECIMAL = _core_.WXK_NUMPAD_DECIMAL
503WXK_NUMPAD_DIVIDE = _core_.WXK_NUMPAD_DIVIDE
504WXK_WINDOWS_LEFT = _core_.WXK_WINDOWS_LEFT
505WXK_WINDOWS_RIGHT = _core_.WXK_WINDOWS_RIGHT
506WXK_WINDOWS_MENU = _core_.WXK_WINDOWS_MENU
88c6b281
RD		 507WXK_COMMAND = _core_.WXK_COMMAND
508WXK_SPECIAL1 = _core_.WXK_SPECIAL1
509WXK_SPECIAL2 = _core_.WXK_SPECIAL2
510WXK_SPECIAL3 = _core_.WXK_SPECIAL3
511WXK_SPECIAL4 = _core_.WXK_SPECIAL4
512WXK_SPECIAL5 = _core_.WXK_SPECIAL5
513WXK_SPECIAL6 = _core_.WXK_SPECIAL6
514WXK_SPECIAL7 = _core_.WXK_SPECIAL7
515WXK_SPECIAL8 = _core_.WXK_SPECIAL8
516WXK_SPECIAL9 = _core_.WXK_SPECIAL9
517WXK_SPECIAL10 = _core_.WXK_SPECIAL10
518WXK_SPECIAL11 = _core_.WXK_SPECIAL11
519WXK_SPECIAL12 = _core_.WXK_SPECIAL12
520WXK_SPECIAL13 = _core_.WXK_SPECIAL13
521WXK_SPECIAL14 = _core_.WXK_SPECIAL14
522WXK_SPECIAL15 = _core_.WXK_SPECIAL15
523WXK_SPECIAL16 = _core_.WXK_SPECIAL16
524WXK_SPECIAL17 = _core_.WXK_SPECIAL17
525WXK_SPECIAL18 = _core_.WXK_SPECIAL18
526WXK_SPECIAL19 = _core_.WXK_SPECIAL19
527WXK_SPECIAL20 = _core_.WXK_SPECIAL20
54f9ee45
RD		 528PAPER_NONE = _core_.PAPER_NONE
529PAPER_LETTER = _core_.PAPER_LETTER
530PAPER_LEGAL = _core_.PAPER_LEGAL
531PAPER_A4 = _core_.PAPER_A4
532PAPER_CSHEET = _core_.PAPER_CSHEET
533PAPER_DSHEET = _core_.PAPER_DSHEET
534PAPER_ESHEET = _core_.PAPER_ESHEET
535PAPER_LETTERSMALL = _core_.PAPER_LETTERSMALL
536PAPER_TABLOID = _core_.PAPER_TABLOID
537PAPER_LEDGER = _core_.PAPER_LEDGER
538PAPER_STATEMENT = _core_.PAPER_STATEMENT
539PAPER_EXECUTIVE = _core_.PAPER_EXECUTIVE
540PAPER_A3 = _core_.PAPER_A3
541PAPER_A4SMALL = _core_.PAPER_A4SMALL
542PAPER_A5 = _core_.PAPER_A5
543PAPER_B4 = _core_.PAPER_B4
544PAPER_B5 = _core_.PAPER_B5
545PAPER_FOLIO = _core_.PAPER_FOLIO
546PAPER_QUARTO = _core_.PAPER_QUARTO
547PAPER_10X14 = _core_.PAPER_10X14
548PAPER_11X17 = _core_.PAPER_11X17
549PAPER_NOTE = _core_.PAPER_NOTE
550PAPER_ENV_9 = _core_.PAPER_ENV_9
551PAPER_ENV_10 = _core_.PAPER_ENV_10
552PAPER_ENV_11 = _core_.PAPER_ENV_11
553PAPER_ENV_12 = _core_.PAPER_ENV_12
554PAPER_ENV_14 = _core_.PAPER_ENV_14
555PAPER_ENV_DL = _core_.PAPER_ENV_DL
556PAPER_ENV_C5 = _core_.PAPER_ENV_C5
557PAPER_ENV_C3 = _core_.PAPER_ENV_C3
558PAPER_ENV_C4 = _core_.PAPER_ENV_C4
559PAPER_ENV_C6 = _core_.PAPER_ENV_C6
560PAPER_ENV_C65 = _core_.PAPER_ENV_C65
561PAPER_ENV_B4 = _core_.PAPER_ENV_B4
562PAPER_ENV_B5 = _core_.PAPER_ENV_B5
563PAPER_ENV_B6 = _core_.PAPER_ENV_B6
564PAPER_ENV_ITALY = _core_.PAPER_ENV_ITALY
565PAPER_ENV_MONARCH = _core_.PAPER_ENV_MONARCH
566PAPER_ENV_PERSONAL = _core_.PAPER_ENV_PERSONAL
567PAPER_FANFOLD_US = _core_.PAPER_FANFOLD_US
568PAPER_FANFOLD_STD_GERMAN = _core_.PAPER_FANFOLD_STD_GERMAN
569PAPER_FANFOLD_LGL_GERMAN = _core_.PAPER_FANFOLD_LGL_GERMAN
570PAPER_ISO_B4 = _core_.PAPER_ISO_B4
571PAPER_JAPANESE_POSTCARD = _core_.PAPER_JAPANESE_POSTCARD
572PAPER_9X11 = _core_.PAPER_9X11
573PAPER_10X11 = _core_.PAPER_10X11
574PAPER_15X11 = _core_.PAPER_15X11
575PAPER_ENV_INVITE = _core_.PAPER_ENV_INVITE
576PAPER_LETTER_EXTRA = _core_.PAPER_LETTER_EXTRA
577PAPER_LEGAL_EXTRA = _core_.PAPER_LEGAL_EXTRA
578PAPER_TABLOID_EXTRA = _core_.PAPER_TABLOID_EXTRA
579PAPER_A4_EXTRA = _core_.PAPER_A4_EXTRA
580PAPER_LETTER_TRANSVERSE = _core_.PAPER_LETTER_TRANSVERSE
581PAPER_A4_TRANSVERSE = _core_.PAPER_A4_TRANSVERSE
582PAPER_LETTER_EXTRA_TRANSVERSE = _core_.PAPER_LETTER_EXTRA_TRANSVERSE
583PAPER_A_PLUS = _core_.PAPER_A_PLUS
584PAPER_B_PLUS = _core_.PAPER_B_PLUS
585PAPER_LETTER_PLUS = _core_.PAPER_LETTER_PLUS
586PAPER_A4_PLUS = _core_.PAPER_A4_PLUS
587PAPER_A5_TRANSVERSE = _core_.PAPER_A5_TRANSVERSE
588PAPER_B5_TRANSVERSE = _core_.PAPER_B5_TRANSVERSE
589PAPER_A3_EXTRA = _core_.PAPER_A3_EXTRA
590PAPER_A5_EXTRA = _core_.PAPER_A5_EXTRA
591PAPER_B5_EXTRA = _core_.PAPER_B5_EXTRA
592PAPER_A2 = _core_.PAPER_A2
593PAPER_A3_TRANSVERSE = _core_.PAPER_A3_TRANSVERSE
594PAPER_A3_EXTRA_TRANSVERSE = _core_.PAPER_A3_EXTRA_TRANSVERSE
6c75a4cf
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
54f9ee45
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
54f9ee45 673MOD_SHIFT = _core_.MOD_SHIFT
943e8dfd 674MOD_META = _core_.MOD_META
54f9ee45 675MOD_WIN = _core_.MOD_WIN
943e8dfd
RD		 676MOD_CMD = _core_.MOD_CMD
677MOD_ALL = _core_.MOD_ALL
54f9ee45
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
d14a1e28
RD		 684#---------------------------------------------------------------------------
685
686class Object(object):
0df68c9f
RD		 687 """
688 The base class for most wx objects, although in wxPython not
689 much functionality is needed nor exposed.
690 """
0085ce49
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
e811c8ce 694 def GetClassName(*args, **kwargs):
0df68c9f 695 """
a95a7133 696 GetClassName(self) -> String
e811c8ce 697
a95a7133 698 Returns the class name of the C++ class using wxRTTI.
0df68c9f 699 """
54f9ee45 700 return _core_.Object_GetClassName(*args, **kwargs)
e811c8ce
RD		 701
702 def Destroy(*args, **kwargs):
0df68c9f 703 """
a95a7133 704 Destroy(self)
e811c8ce 705
0df68c9f
RD		 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)
e811c8ce 710
33d6fd3b 711 ClassName = property(GetClassName,doc="See `GetClassName`")
2131d850 712_core_.Object_swigregister(Object)
54f9ee45 713_wxPySetDictionary = _core_._wxPySetDictionary
54f9ee45 714cvar = _core_.cvar
196addbf 715EmptyString = cvar.EmptyString
d14a1e28
RD		 716
717#---------------------------------------------------------------------------
718
54f9ee45
RD		 719BITMAP_TYPE_INVALID = _core_.BITMAP_TYPE_INVALID
720BITMAP_TYPE_BMP = _core_.BITMAP_TYPE_BMP
721BITMAP_TYPE_ICO = _core_.BITMAP_TYPE_ICO
722BITMAP_TYPE_CUR = _core_.BITMAP_TYPE_CUR
723BITMAP_TYPE_XBM = _core_.BITMAP_TYPE_XBM
724BITMAP_TYPE_XBM_DATA = _core_.BITMAP_TYPE_XBM_DATA
725BITMAP_TYPE_XPM = _core_.BITMAP_TYPE_XPM
726BITMAP_TYPE_XPM_DATA = _core_.BITMAP_TYPE_XPM_DATA
727BITMAP_TYPE_TIF = _core_.BITMAP_TYPE_TIF
728BITMAP_TYPE_GIF = _core_.BITMAP_TYPE_GIF
729BITMAP_TYPE_PNG = _core_.BITMAP_TYPE_PNG
730BITMAP_TYPE_JPEG = _core_.BITMAP_TYPE_JPEG
731BITMAP_TYPE_PNM = _core_.BITMAP_TYPE_PNM
732BITMAP_TYPE_PCX = _core_.BITMAP_TYPE_PCX
733BITMAP_TYPE_PICT = _core_.BITMAP_TYPE_PICT
734BITMAP_TYPE_ICON = _core_.BITMAP_TYPE_ICON
735BITMAP_TYPE_ANI = _core_.BITMAP_TYPE_ANI
736BITMAP_TYPE_IFF = _core_.BITMAP_TYPE_IFF
737BITMAP_TYPE_MACCURSOR = _core_.BITMAP_TYPE_MACCURSOR
738BITMAP_TYPE_ANY = _core_.BITMAP_TYPE_ANY
739CURSOR_NONE = _core_.CURSOR_NONE
740CURSOR_ARROW = _core_.CURSOR_ARROW
741CURSOR_RIGHT_ARROW = _core_.CURSOR_RIGHT_ARROW
742CURSOR_BULLSEYE = _core_.CURSOR_BULLSEYE
743CURSOR_CHAR = _core_.CURSOR_CHAR
744CURSOR_CROSS = _core_.CURSOR_CROSS
745CURSOR_HAND = _core_.CURSOR_HAND
746CURSOR_IBEAM = _core_.CURSOR_IBEAM
747CURSOR_LEFT_BUTTON = _core_.CURSOR_LEFT_BUTTON
748CURSOR_MAGNIFIER = _core_.CURSOR_MAGNIFIER
749CURSOR_MIDDLE_BUTTON = _core_.CURSOR_MIDDLE_BUTTON
750CURSOR_NO_ENTRY = _core_.CURSOR_NO_ENTRY
751CURSOR_PAINT_BRUSH = _core_.CURSOR_PAINT_BRUSH
752CURSOR_PENCIL = _core_.CURSOR_PENCIL
753CURSOR_POINT_LEFT = _core_.CURSOR_POINT_LEFT
754CURSOR_POINT_RIGHT = _core_.CURSOR_POINT_RIGHT
755CURSOR_QUESTION_ARROW = _core_.CURSOR_QUESTION_ARROW
756CURSOR_RIGHT_BUTTON = _core_.CURSOR_RIGHT_BUTTON
757CURSOR_SIZENESW = _core_.CURSOR_SIZENESW
758CURSOR_SIZENS = _core_.CURSOR_SIZENS
759CURSOR_SIZENWSE = _core_.CURSOR_SIZENWSE
760CURSOR_SIZEWE = _core_.CURSOR_SIZEWE
761CURSOR_SIZING = _core_.CURSOR_SIZING
762CURSOR_SPRAYCAN = _core_.CURSOR_SPRAYCAN
763CURSOR_WAIT = _core_.CURSOR_WAIT
764CURSOR_WATCH = _core_.CURSOR_WATCH
765CURSOR_BLANK = _core_.CURSOR_BLANK
766CURSOR_DEFAULT = _core_.CURSOR_DEFAULT
767CURSOR_COPY_ARROW = _core_.CURSOR_COPY_ARROW
768CURSOR_ARROWWAIT = _core_.CURSOR_ARROWWAIT
769CURSOR_MAX = _core_.CURSOR_MAX
d14a1e28
RD		 770#---------------------------------------------------------------------------
771
772class Size(object):
0df68c9f 773 """
41e2b43e 774 wx.Size is a useful data structure used to represent the size of
0085ce49
RD		 775 something. It simply contains integer width and height
776 properties. In most places in wxPython where a wx.Size is
093d3ff1 777 expected a (width, height) tuple can be used instead.
0df68c9f 778 """
0085ce49
RD		 779 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
780 __repr__ = _swig_repr
54f9ee45
RD		 781 width = property(_core_.Size_width_get, _core_.Size_width_set)
782 height = property(_core_.Size_height_get, _core_.Size_height_set)
242b7b46 783 x = width; y = height
0085ce49 784 def __init__(self, *args, **kwargs):
0df68c9f 785 """
a95a7133 786 __init__(self, int w=0, int h=0) -> Size
e811c8ce 787
0df68c9f
RD		 788 Creates a size object.
789 """
0085ce49
RD		 790 _core_.Size_swiginit(self,_core_.new_Size(*args, **kwargs))
791 __swig_destroy__ = _core_.delete_Size
792 __del__ = lambda self : None;
e811c8ce 793 def __eq__(*args, **kwargs):
0df68c9f 794 """
e9d6f3a4 795 __eq__(self, PyObject other) -> bool
e811c8ce 796
0df68c9f
RD		 797 Test for equality of wx.Size objects.
798 """
54f9ee45 799 return _core_.Size___eq__(*args, **kwargs)
e811c8ce
RD		 800
801 def __ne__(*args, **kwargs):
0df68c9f 802 """
e9d6f3a4 803 __ne__(self, PyObject other) -> bool
e811c8ce 804
e9d6f3a4 805 Test for inequality of wx.Size objects.
0df68c9f 806 """
54f9ee45 807 return _core_.Size___ne__(*args, **kwargs)
e811c8ce
RD		 808
809 def __add__(*args, **kwargs):
0df68c9f 810 """
a95a7133 811 __add__(self, Size sz) -> Size
e811c8ce 812
0df68c9f
RD		 813 Add sz's proprties to this and return the result.
814 """
54f9ee45 815 return _core_.Size___add__(*args, **kwargs)
e811c8ce
RD		 816
817 def __sub__(*args, **kwargs):
0df68c9f 818 """
a95a7133 819 __sub__(self, Size sz) -> Size
e811c8ce 820
0df68c9f
RD		 821 Subtract sz's properties from this and return the result.
822 """
54f9ee45 823 return _core_.Size___sub__(*args, **kwargs)
e811c8ce
RD		 824
825 def IncTo(*args, **kwargs):
0df68c9f 826 """
a95a7133 827 IncTo(self, Size sz)
e811c8ce 828
0df68c9f
RD		 829 Increments this object so that both of its dimensions are not less
830 than the corresponding dimensions of the size.
831 """
54f9ee45 832 return _core_.Size_IncTo(*args, **kwargs)
e811c8ce
RD		 833
834 def DecTo(*args, **kwargs):
0df68c9f 835 """
a95a7133 836 DecTo(self, Size sz)
e811c8ce 837
0df68c9f
RD		 838 Decrements this object so that both of its dimensions are not greater
839 than the corresponding dimensions of the size.
840 """
54f9ee45 841 return _core_.Size_DecTo(*args, **kwargs)
e811c8ce 842
f5263701
RD		 843 def IncBy(*args, **kwargs):
844 """IncBy(self, int dx, int dy)"""
845 return _core_.Size_IncBy(*args, **kwargs)
846
847 def DecBy(*args, **kwargs):
848 """DecBy(self, int dx, int dy)"""
849 return _core_.Size_DecBy(*args, **kwargs)
850
10044bf1
RD		 851 def Scale(*args, **kwargs):
852 """
853 Scale(self, float xscale, float yscale)
854
855 Scales the dimensions of this object by the given factors.
856 """
857 return _core_.Size_Scale(*args, **kwargs)
858
e811c8ce 859 def Set(*args, **kwargs):
0df68c9f 860 """
a95a7133 861 Set(self, int w, int h)
e811c8ce 862
0df68c9f
RD		 863 Set both width and height.
864 """
54f9ee45 865 return _core_.Size_Set(*args, **kwargs)
e811c8ce
RD		 866
867 def SetWidth(*args, **kwargs):
a95a7133 868 """SetWidth(self, int w)"""
54f9ee45 869 return _core_.Size_SetWidth(*args, **kwargs)
e811c8ce
RD		 870
871 def SetHeight(*args, **kwargs):
a95a7133 872 """SetHeight(self, int h)"""
54f9ee45 873 return _core_.Size_SetHeight(*args, **kwargs)
e811c8ce
RD		 874
875 def GetWidth(*args, **kwargs):
a95a7133 876 """GetWidth(self) -> int"""
54f9ee45 877 return _core_.Size_GetWidth(*args, **kwargs)
e811c8ce
RD		 878
879 def GetHeight(*args, **kwargs):
a95a7133 880 """GetHeight(self) -> int"""
54f9ee45 881 return _core_.Size_GetHeight(*args, **kwargs)
e811c8ce 882
74a57fcd
RD		 883 def IsFullySpecified(*args, **kwargs):
884 """
a95a7133 885 IsFullySpecified(self) -> bool
74a57fcd
RD		 886
887 Returns True if both components of the size are non-default values.
888 """
54f9ee45 889 return _core_.Size_IsFullySpecified(*args, **kwargs)
74a57fcd
RD		 890
891 def SetDefaults(*args, **kwargs):
892 """
a95a7133 893 SetDefaults(self, Size size)
74a57fcd 894
41e2b43e
RD		 895 Combine this size with the other one replacing the default components
896 of this object (i.e. equal to -1) with those of the other.
74a57fcd 897 """
54f9ee45 898 return _core_.Size_SetDefaults(*args, **kwargs)
74a57fcd 899
e811c8ce 900 def Get(*args, **kwargs):
0df68c9f
RD		 901 """
902 Get() -> (width,height)
e811c8ce 903
0df68c9f
RD		 904 Returns the width and height properties as a tuple.
905 """
54f9ee45 906 return _core_.Size_Get(*args, **kwargs)
e811c8ce 907
41e2b43e 908 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
e811c8ce
RD		 909 def __str__(self): return str(self.Get())
910 def __repr__(self): return 'wx.Size'+str(self.Get())
911 def __len__(self): return len(self.Get())
912 def __getitem__(self, index): return self.Get()[index]
d14a1e28
RD		 913 def __setitem__(self, index, val):
914 if index == 0: self.width = val
915 elif index == 1: self.height = val
916 else: raise IndexError
e811c8ce 917 def __nonzero__(self): return self.Get() != (0,0)
74e96f3d
RD		 918 __safe_for_unpickling__ = True
919 def __reduce__(self): return (wx.Size, self.Get())
d14a1e28 920
2131d850 921_core_.Size_swigregister(Size)
d14a1e28
RD		 922
923#---------------------------------------------------------------------------
924
925class RealPoint(object):
0df68c9f 926 """
41e2b43e
RD		 927 A data structure for representing a point or position with floating
928 point x and y properties. In wxPython most places that expect a
929 wx.RealPoint can also accept a (x,y) tuple.
0df68c9f 930 """
0085ce49
RD		 931 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
932 __repr__ = _swig_repr
54f9ee45
RD		 933 x = property(_core_.RealPoint_x_get, _core_.RealPoint_x_set)
934 y = property(_core_.RealPoint_y_get, _core_.RealPoint_y_set)
0085ce49 935 def __init__(self, *args, **kwargs):
0df68c9f 936 """
a95a7133 937 __init__(self, double x=0.0, double y=0.0) -> RealPoint
e811c8ce 938
0df68c9f
RD		 939 Create a wx.RealPoint object
940 """
0085ce49
RD		 941 _core_.RealPoint_swiginit(self,_core_.new_RealPoint(*args, **kwargs))
942 __swig_destroy__ = _core_.delete_RealPoint
943 __del__ = lambda self : None;
e811c8ce 944 def __eq__(*args, **kwargs):
0df68c9f 945 """
e9d6f3a4 946 __eq__(self, PyObject other) -> bool
e811c8ce 947
0df68c9f
RD		 948 Test for equality of wx.RealPoint objects.
949 """
54f9ee45 950 return _core_.RealPoint___eq__(*args, **kwargs)
e811c8ce
RD		 951
952 def __ne__(*args, **kwargs):
0df68c9f 953 """
e9d6f3a4 954 __ne__(self, PyObject other) -> bool
e811c8ce 955
0df68c9f
RD		 956 Test for inequality of wx.RealPoint objects.
957 """
54f9ee45 958 return _core_.RealPoint___ne__(*args, **kwargs)
e811c8ce
RD		 959
960 def __add__(*args, **kwargs):
0df68c9f 961 """
a95a7133 962 __add__(self, RealPoint pt) -> RealPoint
e811c8ce 963
0df68c9f
RD		 964 Add pt's proprties to this and return the result.
965 """
54f9ee45 966 return _core_.RealPoint___add__(*args, **kwargs)
e811c8ce
RD		 967
968 def __sub__(*args, **kwargs):
0df68c9f 969 """
a95a7133 970 __sub__(self, RealPoint pt) -> RealPoint
e811c8ce 971
0df68c9f
RD		 972 Subtract pt's proprties from this and return the result
973 """
54f9ee45 974 return _core_.RealPoint___sub__(*args, **kwargs)
e811c8ce
RD		 975
976 def Set(*args, **kwargs):
0df68c9f 977 """
a95a7133 978 Set(self, double x, double y)
e811c8ce 979
0df68c9f
RD		 980 Set both the x and y properties
981 """
54f9ee45 982 return _core_.RealPoint_Set(*args, **kwargs)
e811c8ce
RD		 983
984 def Get(*args, **kwargs):
0df68c9f
RD		 985 """
986 Get() -> (x,y)
e811c8ce 987
0df68c9f
RD		 988 Return the x and y properties as a tuple.
989 """
54f9ee45 990 return _core_.RealPoint_Get(*args, **kwargs)
e811c8ce 991
41e2b43e 992 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
e811c8ce
RD		 993 def __str__(self): return str(self.Get())
994 def __repr__(self): return 'wx.RealPoint'+str(self.Get())
995 def __len__(self): return len(self.Get())
996 def __getitem__(self, index): return self.Get()[index]
d14a1e28 997 def __setitem__(self, index, val):
e811c8ce
RD		 998 if index == 0: self.x = val
999 elif index == 1: self.y = val
d14a1e28 1000 else: raise IndexError
e811c8ce 1001 def __nonzero__(self): return self.Get() != (0.0, 0.0)
74e96f3d
RD		 1002 __safe_for_unpickling__ = True
1003 def __reduce__(self): return (wx.RealPoint, self.Get())
d14a1e28 1004
2131d850 1005_core_.RealPoint_swigregister(RealPoint)
d14a1e28
RD		 1006
1007#---------------------------------------------------------------------------
1008
1009class Point(object):
0df68c9f 1010 """
41e2b43e
RD		 1011 A data structure for representing a point or position with integer x
1012 and y properties. Most places in wxPython that expect a wx.Point can
1013 also accept a (x,y) tuple.
0df68c9f 1014 """
0085ce49
RD		 1015 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1016 __repr__ = _swig_repr
54f9ee45
RD		 1017 x = property(_core_.Point_x_get, _core_.Point_x_set)
1018 y = property(_core_.Point_y_get, _core_.Point_y_set)
0085ce49 1019 def __init__(self, *args, **kwargs):
0df68c9f 1020 """
a95a7133 1021 __init__(self, int x=0, int y=0) -> Point
e811c8ce 1022
0df68c9f
RD		 1023 Create a wx.Point object
1024 """
0085ce49
RD		 1025 _core_.Point_swiginit(self,_core_.new_Point(*args, **kwargs))
1026 __swig_destroy__ = _core_.delete_Point
1027 __del__ = lambda self : None;
e811c8ce 1028 def __eq__(*args, **kwargs):
0df68c9f 1029 """
e9d6f3a4 1030 __eq__(self, PyObject other) -> bool
e811c8ce 1031
0df68c9f
RD		 1032 Test for equality of wx.Point objects.
1033 """
54f9ee45 1034 return _core_.Point___eq__(*args, **kwargs)
e811c8ce
RD		 1035
1036 def __ne__(*args, **kwargs):
0df68c9f 1037 """
e9d6f3a4 1038 __ne__(self, PyObject other) -> bool
e811c8ce 1039
0df68c9f
RD		 1040 Test for inequality of wx.Point objects.
1041 """
54f9ee45 1042 return _core_.Point___ne__(*args, **kwargs)
e811c8ce
RD		 1043
1044 def __add__(*args, **kwargs):
0df68c9f 1045 """
a95a7133 1046 __add__(self, Point pt) -> Point
e811c8ce 1047
0df68c9f
RD		 1048 Add pt's proprties to this and return the result.
1049 """
54f9ee45 1050 return _core_.Point___add__(*args, **kwargs)
e811c8ce
RD		 1051
1052 def __sub__(*args, **kwargs):
0df68c9f 1053 """
a95a7133 1054 __sub__(self, Point pt) -> Point
e811c8ce 1055
0df68c9f
RD		 1056 Subtract pt's proprties from this and return the result
1057 """
54f9ee45 1058 return _core_.Point___sub__(*args, **kwargs)
e811c8ce
RD		 1059
1060 def __iadd__(*args, **kwargs):
0df68c9f 1061 """
a95a7133 1062 __iadd__(self, Point pt) -> Point
e811c8ce 1063
0df68c9f
RD		 1064 Add pt to this object.
1065 """
54f9ee45 1066 return _core_.Point___iadd__(*args, **kwargs)
e811c8ce
RD		 1067
1068 def __isub__(*args, **kwargs):
0df68c9f 1069 """
a95a7133 1070 __isub__(self, Point pt) -> Point
e811c8ce 1071
0df68c9f
RD		 1072 Subtract pt from this object.
1073 """
54f9ee45 1074 return _core_.Point___isub__(*args, **kwargs)
e811c8ce
RD		 1075
1076 def Set(*args, **kwargs):
0df68c9f 1077 """
a95a7133 1078 Set(self, long x, long y)
e811c8ce 1079
0df68c9f
RD		 1080 Set both the x and y properties
1081 """
54f9ee45 1082 return _core_.Point_Set(*args, **kwargs)
e811c8ce
RD		 1083
1084 def Get(*args, **kwargs):
0df68c9f
RD		 1085 """
1086 Get() -> (x,y)
e811c8ce 1087
0df68c9f
RD		 1088 Return the x and y properties as a tuple.
1089 """
54f9ee45 1090 return _core_.Point_Get(*args, **kwargs)
e811c8ce 1091
41e2b43e 1092 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
e811c8ce
RD		 1093 def __str__(self): return str(self.Get())
1094 def __repr__(self): return 'wx.Point'+str(self.Get())
1095 def __len__(self): return len(self.Get())
1096 def __getitem__(self, index): return self.Get()[index]
d14a1e28
RD		 1097 def __setitem__(self, index, val):
1098 if index == 0: self.x = val
1099 elif index == 1: self.y = val
1100 else: raise IndexError
e811c8ce 1101 def __nonzero__(self): return self.Get() != (0,0)
74e96f3d
RD		 1102 __safe_for_unpickling__ = True
1103 def __reduce__(self): return (wx.Point, self.Get())
d14a1e28 1104
2131d850 1105_core_.Point_swigregister(Point)
d14a1e28
RD		 1106
1107#---------------------------------------------------------------------------
1108
1109class Rect(object):
0df68c9f 1110 """
41e2b43e
RD		 1111 A class for representing and manipulating rectangles. It has x, y,
1112 width and height properties. In wxPython most palces that expect a
1113 wx.Rect can also accept a (x,y,width,height) tuple.
0df68c9f 1114 """
0085ce49
RD		 1115 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1116 __repr__ = _swig_repr
1117 def __init__(self, *args, **kwargs):
0df68c9f 1118 """
a95a7133 1119 __init__(self, int x=0, int y=0, int width=0, int height=0) -> Rect
e811c8ce 1120
0df68c9f
RD		 1121 Create a new Rect object.
1122 """
0085ce49
RD		 1123 _core_.Rect_swiginit(self,_core_.new_Rect(*args, **kwargs))
1124 __swig_destroy__ = _core_.delete_Rect
1125 __del__ = lambda self : None;
e811c8ce 1126 def GetX(*args, **kwargs):
a95a7133 1127 """GetX(self) -> int"""
54f9ee45 1128 return _core_.Rect_GetX(*args, **kwargs)
e811c8ce
RD		 1129
1130 def SetX(*args, **kwargs):
a95a7133 1131 """SetX(self, int x)"""
54f9ee45 1132 return _core_.Rect_SetX(*args, **kwargs)
e811c8ce
RD		 1133
1134 def GetY(*args, **kwargs):
a95a7133 1135 """GetY(self) -> int"""
54f9ee45 1136 return _core_.Rect_GetY(*args, **kwargs)
e811c8ce
RD		 1137
1138 def SetY(*args, **kwargs):
a95a7133 1139 """SetY(self, int y)"""
54f9ee45 1140 return _core_.Rect_SetY(*args, **kwargs)
e811c8ce
RD		 1141
1142 def GetWidth(*args, **kwargs):
a95a7133 1143 """GetWidth(self) -> int"""
54f9ee45 1144 return _core_.Rect_GetWidth(*args, **kwargs)
e811c8ce
RD		 1145
1146 def SetWidth(*args, **kwargs):
a95a7133 1147 """SetWidth(self, int w)"""
54f9ee45 1148 return _core_.Rect_SetWidth(*args, **kwargs)
e811c8ce
RD		 1149
1150 def GetHeight(*args, **kwargs):
a95a7133 1151 """GetHeight(self) -> int"""
54f9ee45 1152 return _core_.Rect_GetHeight(*args, **kwargs)
e811c8ce
RD		 1153
1154 def SetHeight(*args, **kwargs):
a95a7133 1155 """SetHeight(self, int h)"""
54f9ee45 1156 return _core_.Rect_SetHeight(*args, **kwargs)
e811c8ce
RD		 1157
1158 def GetPosition(*args, **kwargs):
a95a7133 1159 """GetPosition(self) -> Point"""
54f9ee45 1160 return _core_.Rect_GetPosition(*args, **kwargs)
e811c8ce
RD		 1161
1162 def SetPosition(*args, **kwargs):
a95a7133 1163 """SetPosition(self, Point p)"""
54f9ee45 1164 return _core_.Rect_SetPosition(*args, **kwargs)
e811c8ce
RD		 1165
1166 def GetSize(*args, **kwargs):
a95a7133 1167 """GetSize(self) -> Size"""
54f9ee45 1168 return _core_.Rect_GetSize(*args, **kwargs)
e811c8ce
RD		 1169
1170 def SetSize(*args, **kwargs):
a95a7133 1171 """SetSize(self, Size s)"""
54f9ee45 1172 return _core_.Rect_SetSize(*args, **kwargs)
e811c8ce 1173
aff4cc5c
RD		 1174 def IsEmpty(*args, **kwargs):
1175 """IsEmpty(self) -> bool"""
1176 return _core_.Rect_IsEmpty(*args, **kwargs)
1177
c9c7117a 1178 def GetTopLeft(*args, **kwargs):
a95a7133 1179 """GetTopLeft(self) -> Point"""
54f9ee45 1180 return _core_.Rect_GetTopLeft(*args, **kwargs)
c9c7117a
RD		 1181
1182 def SetTopLeft(*args, **kwargs):
a95a7133 1183 """SetTopLeft(self, Point p)"""
54f9ee45 1184 return _core_.Rect_SetTopLeft(*args, **kwargs)
c9c7117a
RD		 1185
1186 def GetBottomRight(*args, **kwargs):
a95a7133 1187 """GetBottomRight(self) -> Point"""
54f9ee45 1188 return _core_.Rect_GetBottomRight(*args, **kwargs)
c9c7117a
RD		 1189
1190 def SetBottomRight(*args, **kwargs):
a95a7133 1191 """SetBottomRight(self, Point p)"""
54f9ee45 1192 return _core_.Rect_SetBottomRight(*args, **kwargs)
c9c7117a 1193
5acb46e0
RD		 1194 def GetTopRight(*args, **kwargs):
1195 """GetTopRight(self) -> Point"""
1196 return _core_.Rect_GetTopRight(*args, **kwargs)
1197
1198 def SetTopRight(*args, **kwargs):
1199 """SetTopRight(self, Point p)"""
1200 return _core_.Rect_SetTopRight(*args, **kwargs)
1201
1202 def GetBottomLeft(*args, **kwargs):
1203 """GetBottomLeft(self) -> Point"""
1204 return _core_.Rect_GetBottomLeft(*args, **kwargs)
1205
1206 def SetBottomLeft(*args, **kwargs):
1207 """SetBottomLeft(self, Point p)"""
1208 return _core_.Rect_SetBottomLeft(*args, **kwargs)
1209
e811c8ce 1210 def GetLeft(*args, **kwargs):
a95a7133 1211 """GetLeft(self) -> int"""
54f9ee45 1212 return _core_.Rect_GetLeft(*args, **kwargs)
e811c8ce
RD		 1213
1214 def GetTop(*args, **kwargs):
a95a7133 1215 """GetTop(self) -> int"""
54f9ee45 1216 return _core_.Rect_GetTop(*args, **kwargs)
e811c8ce
RD		 1217
1218 def GetBottom(*args, **kwargs):
a95a7133 1219 """GetBottom(self) -> int"""
54f9ee45 1220 return _core_.Rect_GetBottom(*args, **kwargs)
e811c8ce
RD		 1221
1222 def GetRight(*args, **kwargs):
a95a7133 1223 """GetRight(self) -> int"""
54f9ee45 1224 return _core_.Rect_GetRight(*args, **kwargs)
e811c8ce
RD		 1225
1226 def SetLeft(*args, **kwargs):
a95a7133 1227 """SetLeft(self, int left)"""
54f9ee45 1228 return _core_.Rect_SetLeft(*args, **kwargs)
e811c8ce
RD		 1229
1230 def SetRight(*args, **kwargs):
a95a7133 1231 """SetRight(self, int right)"""
54f9ee45 1232 return _core_.Rect_SetRight(*args, **kwargs)
e811c8ce
RD		 1233
1234 def SetTop(*args, **kwargs):
a95a7133 1235 """SetTop(self, int top)"""
54f9ee45 1236 return _core_.Rect_SetTop(*args, **kwargs)
e811c8ce
RD		 1237
1238 def SetBottom(*args, **kwargs):
a95a7133 1239 """SetBottom(self, int bottom)"""
54f9ee45 1240 return _core_.Rect_SetBottom(*args, **kwargs)
e811c8ce
RD		 1241
1242 position = property(GetPosition, SetPosition)
1243 size = property(GetSize, SetSize)
1244 left = property(GetLeft, SetLeft)
1245 right = property(GetRight, SetRight)
1246 top = property(GetTop, SetTop)
1247 bottom = property(GetBottom, SetBottom)
1248
1249 def Inflate(*args, **kwargs):
0df68c9f 1250 """
a95a7133 1251 Inflate(self, int dx, int dy) -> Rect
e811c8ce 1252
8e738329
RD		 1253 Increases the size of the rectangle.
1254
1255 The left border is moved farther left and the right border is moved
1256 farther right by ``dx``. The upper border is moved farther up and the
1257 bottom border is moved farther down by ``dy``. (Note the the width and
1258 height of the rectangle thus change by ``2*dx`` and ``2*dy``,
1259 respectively.) If one or both of ``dx`` and ``dy`` are negative, the
1260 opposite happens: the rectangle size decreases in the respective
1261 direction.
1262
1263 The change is made to the rectangle inplace, if instead you need a
1264 copy that is inflated, preserving the original then make the copy
1265 first::
1266
1267 copy = wx.Rect(*original)
1268 copy.Inflate(10,15)
1269
1270
0df68c9f 1271 """
54f9ee45 1272 return _core_.Rect_Inflate(*args, **kwargs)
e811c8ce
RD		 1273
1274 def Deflate(*args, **kwargs):
0df68c9f 1275 """
a95a7133 1276 Deflate(self, int dx, int dy) -> Rect
e811c8ce 1277
8e738329
RD		 1278 Decrease the rectangle size. This method is the opposite of `Inflate`
1279 in that Deflate(a,b) is equivalent to Inflate(-a,-b). Please refer to
1280 `Inflate` for a full description.
0df68c9f 1281 """
54f9ee45 1282 return _core_.Rect_Deflate(*args, **kwargs)
e811c8ce
RD		 1283
1284 def OffsetXY(*args, **kwargs):
0df68c9f 1285 """
a95a7133 1286 OffsetXY(self, int dx, int dy)
e811c8ce 1287
41e2b43e
RD		 1288 Moves the rectangle by the specified offset. If dx is positive, the
1289 rectangle is moved to the right, if dy is positive, it is moved to the
1290 bottom, otherwise it is moved to the left or top respectively.
0df68c9f 1291 """
54f9ee45 1292 return _core_.Rect_OffsetXY(*args, **kwargs)
e811c8ce
RD		 1293
1294 def Offset(*args, **kwargs):
0df68c9f 1295 """
a95a7133 1296 Offset(self, Point pt)
e811c8ce 1297
b1fcee84 1298 Same as `OffsetXY` but uses dx,dy from Point
0df68c9f 1299 """
54f9ee45 1300 return _core_.Rect_Offset(*args, **kwargs)
e811c8ce
RD		 1301
1302 def Intersect(*args, **kwargs):
0df68c9f 1303 """
a95a7133 1304 Intersect(self, Rect rect) -> Rect
e811c8ce 1305
5cbf236d 1306 Returns the intersectsion of this rectangle and rect.
0df68c9f 1307 """
54f9ee45 1308 return _core_.Rect_Intersect(*args, **kwargs)
e811c8ce 1309
5cbf236d
RD		 1310 def Union(*args, **kwargs):
1311 """
1312 Union(self, Rect rect) -> Rect
1313
1314 Returns the union of this rectangle and rect.
1315 """
1316 return _core_.Rect_Union(*args, **kwargs)
1317
e811c8ce 1318 def __add__(*args, **kwargs):
0df68c9f 1319 """
a95a7133 1320 __add__(self, Rect rect) -> Rect
e811c8ce 1321
0df68c9f
RD		 1322 Add the properties of rect to this rectangle and return the result.
1323 """
54f9ee45 1324 return _core_.Rect___add__(*args, **kwargs)
e811c8ce
RD		 1325
1326 def __iadd__(*args, **kwargs):
0df68c9f 1327 """
a95a7133 1328 __iadd__(self, Rect rect) -> Rect
e811c8ce 1329
0df68c9f
RD		 1330 Add the properties of rect to this rectangle, updating this rectangle.
1331 """
54f9ee45 1332 return _core_.Rect___iadd__(*args, **kwargs)
e811c8ce
RD		 1333
1334 def __eq__(*args, **kwargs):
0df68c9f 1335 """
e9d6f3a4 1336 __eq__(self, PyObject other) -> bool
e811c8ce 1337
e9d6f3a4 1338 Test for equality of wx.Rect objects.
0df68c9f 1339 """
54f9ee45 1340 return _core_.Rect___eq__(*args, **kwargs)
e811c8ce
RD		 1341
1342 def __ne__(*args, **kwargs):
0df68c9f 1343 """
e9d6f3a4 1344 __ne__(self, PyObject other) -> bool
e811c8ce 1345
e9d6f3a4 1346 Test for inequality of wx.Rect objects.
0df68c9f 1347 """
54f9ee45 1348 return _core_.Rect___ne__(*args, **kwargs)
e811c8ce 1349
33d6fd3b 1350 def ContainsXY(*args, **kwargs):
0df68c9f 1351 """
33d6fd3b 1352 ContainsXY(self, int x, int y) -> bool
e811c8ce 1353
33d6fd3b 1354 Return True if the point is inside the rect.
0df68c9f 1355 """
33d6fd3b 1356 return _core_.Rect_ContainsXY(*args, **kwargs)
e811c8ce 1357
33d6fd3b 1358 def Contains(*args, **kwargs):
0df68c9f 1359 """
33d6fd3b 1360 Contains(self, Point pt) -> bool
e811c8ce 1361
33d6fd3b 1362 Return True if the point is inside the rect.
0df68c9f 1363 """
33d6fd3b 1364 return _core_.Rect_Contains(*args, **kwargs)
e811c8ce 1365
33d6fd3b 1366 def ContainsRect(*args, **kwargs):
fc46b7f3 1367 """
33d6fd3b 1368 ContainsRect(self, Rect rect) -> bool
fc46b7f3
RD		 1369
1370 Returns ``True`` if the given rectangle is completely inside this
1371 rectangle or touches its boundary.
1372 """
33d6fd3b
RD		 1373 return _core_.Rect_ContainsRect(*args, **kwargs)
1374
72ef6efb
RD		 1375 #Inside = wx._deprecated(Contains, "Use `Contains` instead.")
1376 #InsideXY = wx._deprecated(ContainsXY, "Use `ContainsXY` instead.")
1377 #InsideRect = wx._deprecated(ContainsRect, "Use `ContainsRect` instead.")
1378 Inside = Contains
1379 InsideXY = ContainsXY
1380 InsideRect = ContainsRect
fc46b7f3 1381
e811c8ce 1382 def Intersects(*args, **kwargs):
0df68c9f 1383 """
a95a7133 1384 Intersects(self, Rect rect) -> bool
e811c8ce 1385
0df68c9f
RD		 1386 Returns True if the rectangles have a non empty intersection.
1387 """
54f9ee45 1388 return _core_.Rect_Intersects(*args, **kwargs)
e811c8ce 1389
b1fcee84
RD		 1390 def CenterIn(*args, **kwargs):
1391 """
1392 CenterIn(self, Rect r, int dir=BOTH) -> Rect
1393
1394 Center this rectangle within the one passed to the method, which is
1395 usually, but not necessarily, the larger one.
1396 """
1397 return _core_.Rect_CenterIn(*args, **kwargs)
1398
1399 CentreIn = CenterIn
54f9ee45
RD		 1400 x = property(_core_.Rect_x_get, _core_.Rect_x_set)
1401 y = property(_core_.Rect_y_get, _core_.Rect_y_set)
1402 width = property(_core_.Rect_width_get, _core_.Rect_width_set)
1403 height = property(_core_.Rect_height_get, _core_.Rect_height_set)
e811c8ce 1404 def Set(*args, **kwargs):
0df68c9f 1405 """
a95a7133 1406 Set(self, int x=0, int y=0, int width=0, int height=0)
e811c8ce 1407
0df68c9f
RD		 1408 Set all rectangle properties.
1409 """
54f9ee45 1410 return _core_.Rect_Set(*args, **kwargs)
e811c8ce
RD		 1411
1412 def Get(*args, **kwargs):
0df68c9f
RD		 1413 """
1414 Get() -> (x,y,width,height)
e811c8ce 1415
0df68c9f
RD		 1416 Return the rectangle properties as a tuple.
1417 """
54f9ee45 1418 return _core_.Rect_Get(*args, **kwargs)
e811c8ce 1419
41e2b43e 1420 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
e811c8ce
RD		 1421 def __str__(self): return str(self.Get())
1422 def __repr__(self): return 'wx.Rect'+str(self.Get())
1423 def __len__(self): return len(self.Get())
1424 def __getitem__(self, index): return self.Get()[index]
d14a1e28
RD		 1425 def __setitem__(self, index, val):
1426 if index == 0: self.x = val
1427 elif index == 1: self.y = val
1428 elif index == 2: self.width = val
1429 elif index == 3: self.height = val
1430 else: raise IndexError
e811c8ce 1431 def __nonzero__(self): return self.Get() != (0,0,0,0)
74e96f3d
RD		 1432 __safe_for_unpickling__ = True
1433 def __reduce__(self): return (wx.Rect, self.Get())
d14a1e28 1434
33d6fd3b
RD		 1435 Bottom = property(GetBottom,SetBottom,doc="See `GetBottom` and `SetBottom`")
1436 BottomRight = property(GetBottomRight,SetBottomRight,doc="See `GetBottomRight` and `SetBottomRight`")
5acb46e0 1437 BottomLeft = property(GetBottomLeft,SetBottomLeft,doc="See `GetBottomLeft` and `SetBottomLeft`")
33d6fd3b
RD		 1438 Height = property(GetHeight,SetHeight,doc="See `GetHeight` and `SetHeight`")
1439 Left = property(GetLeft,SetLeft,doc="See `GetLeft` and `SetLeft`")
1440 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
1441 Right = property(GetRight,SetRight,doc="See `GetRight` and `SetRight`")
1442 Size = property(GetSize,SetSize,doc="See `GetSize` and `SetSize`")
1443 Top = property(GetTop,SetTop,doc="See `GetTop` and `SetTop`")
1444 TopLeft = property(GetTopLeft,SetTopLeft,doc="See `GetTopLeft` and `SetTopLeft`")
5acb46e0 1445 TopRight = property(GetTopRight,SetTopRight,doc="See `GetTopRight` and `SetTopRight`")
33d6fd3b
RD		 1446 Width = property(GetWidth,SetWidth,doc="See `GetWidth` and `SetWidth`")
1447 X = property(GetX,SetX,doc="See `GetX` and `SetX`")
1448 Y = property(GetY,SetY,doc="See `GetY` and `SetY`")
1449 Empty = property(IsEmpty,doc="See `IsEmpty`")
2131d850 1450_core_.Rect_swigregister(Rect)
d14a1e28
RD		 1451
1452def RectPP(*args, **kwargs):
0df68c9f
RD		 1453 """
1454 RectPP(Point topLeft, Point bottomRight) -> Rect
e811c8ce 1455
0df68c9f
RD		 1456 Create a new Rect object from Points representing two corners.
1457 """
54f9ee45 1458 val = _core_.new_RectPP(*args, **kwargs)
d14a1e28
RD		 1459 return val
1460
1461def RectPS(*args, **kwargs):
0df68c9f
RD		 1462 """
1463 RectPS(Point pos, Size size) -> Rect
e811c8ce 1464
0df68c9f
RD		 1465 Create a new Rect from a position and size.
1466 """
54f9ee45 1467 val = _core_.new_RectPS(*args, **kwargs)
d14a1e28
RD		 1468 return val
1469
d3b6e4ff
RD		 1470def RectS(*args, **kwargs):
1471 """
1472 RectS(Size size) -> Rect
1473
1474 Create a new Rect from a size only.
1475 """
1476 val = _core_.new_RectS(*args, **kwargs)
d3b6e4ff
RD		 1477 return val
1478
d14a1e28 1479
e811c8ce 1480def IntersectRect(*args, **kwargs):
0085ce49 1481 """
0df68c9f 1482 IntersectRect(Rect r1, Rect r2) -> Rect
e811c8ce 1483
0df68c9f
RD		 1484 Calculate and return the intersection of r1 and r2.
1485 """
0085ce49 1486 return _core_.IntersectRect(*args, **kwargs)
d14a1e28
RD		 1487#---------------------------------------------------------------------------
1488
1489class Point2D(object):
41e2b43e
RD		 1490 """
1491 wx.Point2Ds represent a point or a vector in a 2d coordinate system
1492 with floating point values.
1493 """
0085ce49
RD		 1494 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1495 __repr__ = _swig_repr
1496 def __init__(self, *args, **kwargs):
0df68c9f 1497 """
a95a7133 1498 __init__(self, double x=0.0, double y=0.0) -> Point2D
e811c8ce 1499
0df68c9f
RD		 1500 Create a w.Point2D object.
1501 """
0085ce49 1502 _core_.Point2D_swiginit(self,_core_.new_Point2D(*args, **kwargs))
b39fe951
RD		 1503 __swig_destroy__ = _core_.delete_Point2D
1504 __del__ = lambda self : None;
e811c8ce 1505 def GetFloor(*args, **kwargs):
fd2dc343
RD		 1506 """
1507 GetFloor() -> (x,y)
1508
1509 Convert to integer
1510 """
54f9ee45 1511 return _core_.Point2D_GetFloor(*args, **kwargs)
e811c8ce
RD		 1512
1513 def GetRounded(*args, **kwargs):
fd2dc343
RD		 1514 """
1515 GetRounded() -> (x,y)
1516
1517 Convert to integer
1518 """
54f9ee45 1519 return _core_.Point2D_GetRounded(*args, **kwargs)
e811c8ce
RD		 1520
1521 def GetVectorLength(*args, **kwargs):
a95a7133 1522 """GetVectorLength(self) -> double"""
54f9ee45 1523 return _core_.Point2D_GetVectorLength(*args, **kwargs)
e811c8ce
RD		 1524
1525 def GetVectorAngle(*args, **kwargs):
a95a7133 1526 """GetVectorAngle(self) -> double"""
54f9ee45 1527 return _core_.Point2D_GetVectorAngle(*args, **kwargs)
e811c8ce
RD		 1528
1529 def SetVectorLength(*args, **kwargs):
a95a7133 1530 """SetVectorLength(self, double length)"""
54f9ee45 1531 return _core_.Point2D_SetVectorLength(*args, **kwargs)
e811c8ce
RD		 1532
1533 def SetVectorAngle(*args, **kwargs):
a95a7133 1534 """SetVectorAngle(self, double degrees)"""
54f9ee45 1535 return _core_.Point2D_SetVectorAngle(*args, **kwargs)
e811c8ce 1536
d14a1e28
RD		 1537 def SetPolarCoordinates(self, angle, length):
1538 self.SetVectorLength(length)
1539 self.SetVectorAngle(angle)
1540 def Normalize(self):
1541 self.SetVectorLength(1.0)
1542
e811c8ce 1543 def GetDistance(*args, **kwargs):
a95a7133 1544 """GetDistance(self, Point2D pt) -> double"""
54f9ee45 1545 return _core_.Point2D_GetDistance(*args, **kwargs)
e811c8ce
RD		 1546
1547 def GetDistanceSquare(*args, **kwargs):
a95a7133 1548 """GetDistanceSquare(self, Point2D pt) -> double"""
54f9ee45 1549 return _core_.Point2D_GetDistanceSquare(*args, **kwargs)
e811c8ce
RD		 1550
1551 def GetDotProduct(*args, **kwargs):
a95a7133 1552 """GetDotProduct(self, Point2D vec) -> double"""
54f9ee45 1553 return _core_.Point2D_GetDotProduct(*args, **kwargs)
e811c8ce
RD		 1554
1555 def GetCrossProduct(*args, **kwargs):
a95a7133 1556 """GetCrossProduct(self, Point2D vec) -> double"""
54f9ee45 1557 return _core_.Point2D_GetCrossProduct(*args, **kwargs)
e811c8ce
RD		 1558
1559 def __neg__(*args, **kwargs):
0df68c9f 1560 """
a95a7133 1561 __neg__(self) -> Point2D
e811c8ce 1562
0df68c9f
RD		 1563 the reflection of this point
1564 """
54f9ee45 1565 return _core_.Point2D___neg__(*args, **kwargs)
e811c8ce
RD		 1566
1567 def __iadd__(*args, **kwargs):
a95a7133 1568 """__iadd__(self, Point2D pt) -> Point2D"""
54f9ee45 1569 return _core_.Point2D___iadd__(*args, **kwargs)
e811c8ce
RD		 1570
1571 def __isub__(*args, **kwargs):
a95a7133 1572 """__isub__(self, Point2D pt) -> Point2D"""
54f9ee45 1573 return _core_.Point2D___isub__(*args, **kwargs)
e811c8ce
RD		 1574
1575 def __imul__(*args, **kwargs):
a95a7133 1576 """__imul__(self, Point2D pt) -> Point2D"""
54f9ee45 1577 return _core_.Point2D___imul__(*args, **kwargs)
e811c8ce
RD		 1578
1579 def __idiv__(*args, **kwargs):
a95a7133 1580 """__idiv__(self, Point2D pt) -> Point2D"""
54f9ee45 1581 return _core_.Point2D___idiv__(*args, **kwargs)
e811c8ce
RD		 1582
1583 def __eq__(*args, **kwargs):
0df68c9f 1584 """
e9d6f3a4 1585 __eq__(self, PyObject other) -> bool
e811c8ce 1586
e9d6f3a4 1587 Test for equality of wx.Point2D objects.
0df68c9f 1588 """
54f9ee45 1589 return _core_.Point2D___eq__(*args, **kwargs)
e811c8ce
RD		 1590
1591 def __ne__(*args, **kwargs):
0df68c9f 1592 """
e9d6f3a4 1593 __ne__(self, PyObject other) -> bool
e811c8ce 1594
e9d6f3a4 1595 Test for inequality of wx.Point2D objects.
0df68c9f 1596 """
54f9ee45 1597 return _core_.Point2D___ne__(*args, **kwargs)
e811c8ce 1598
54f9ee45
RD		 1599 x = property(_core_.Point2D_x_get, _core_.Point2D_x_set)
1600 y = property(_core_.Point2D_y_get, _core_.Point2D_y_set)
e811c8ce 1601 def Set(*args, **kwargs):
a95a7133 1602 """Set(self, double x=0, double y=0)"""
54f9ee45 1603 return _core_.Point2D_Set(*args, **kwargs)
e811c8ce
RD		 1604
1605 def Get(*args, **kwargs):
0df68c9f
RD		 1606 """
1607 Get() -> (x,y)
e811c8ce 1608
0df68c9f
RD		 1609 Return x and y properties as a tuple.
1610 """
54f9ee45 1611 return _core_.Point2D_Get(*args, **kwargs)
e811c8ce 1612
41e2b43e 1613 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
e811c8ce
RD		 1614 def __str__(self): return str(self.Get())
1615 def __repr__(self): return 'wx.Point2D'+str(self.Get())
1616 def __len__(self): return len(self.Get())
1617 def __getitem__(self, index): return self.Get()[index]
d14a1e28 1618 def __setitem__(self, index, val):
e811c8ce
RD		 1619 if index == 0: self.x = val
1620 elif index == 1: self.y = val
d14a1e28 1621 else: raise IndexError
e811c8ce 1622 def __nonzero__(self): return self.Get() != (0.0, 0.0)
74e96f3d
RD		 1623 __safe_for_unpickling__ = True
1624 def __reduce__(self): return (wx.Point2D, self.Get())
d14a1e28 1625
33d6fd3b
RD		 1626 Floor = property(GetFloor,doc="See `GetFloor`")
1627 Rounded = property(GetRounded,doc="See `GetRounded`")
1628 VectorAngle = property(GetVectorAngle,SetVectorAngle,doc="See `GetVectorAngle` and `SetVectorAngle`")
1629 VectorLength = property(GetVectorLength,SetVectorLength,doc="See `GetVectorLength` and `SetVectorLength`")
2131d850 1630_core_.Point2D_swigregister(Point2D)
d14a1e28
RD		 1631
1632def Point2DCopy(*args, **kwargs):
0df68c9f
RD		 1633 """
1634 Point2DCopy(Point2D pt) -> Point2D
e811c8ce 1635
0df68c9f
RD		 1636 Create a w.Point2D object.
1637 """
54f9ee45 1638 val = _core_.new_Point2DCopy(*args, **kwargs)
d14a1e28
RD		 1639 return val
1640
1641def Point2DFromPoint(*args, **kwargs):
0df68c9f
RD		 1642 """
1643 Point2DFromPoint(Point pt) -> Point2D
e811c8ce 1644
0df68c9f
RD		 1645 Create a w.Point2D object.
1646 """
54f9ee45 1647 val = _core_.new_Point2DFromPoint(*args, **kwargs)
d14a1e28
RD		 1648 return val
1649
1650#---------------------------------------------------------------------------
1651
70d7cb34
RD		 1652Inside = _core_.Inside
1653OutLeft = _core_.OutLeft
1654OutRight = _core_.OutRight
1655OutTop = _core_.OutTop
1656OutBottom = _core_.OutBottom
1657class Rect2D(object):
1658 """
1659 wx.Rect2D is a rectangle, with position and size, in a 2D coordinate system
1660 with floating point component values.
1661 """
1662 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1663 __repr__ = _swig_repr
1664 def __init__(self, *args, **kwargs):
1665 """
1666 __init__(self, wxDouble x=0.0, wxDouble y=0.0, wxDouble w=0.0, wxDouble h=0.0) -> Rect2D
1667
1668 wx.Rect2D is a rectangle, with position and size, in a 2D coordinate system
1669 with floating point component values.
1670 """
1671 _core_.Rect2D_swiginit(self,_core_.new_Rect2D(*args, **kwargs))
1672 __swig_destroy__ = _core_.delete_Rect2D
1673 __del__ = lambda self : None;
1674 def GetPosition(*args, **kwargs):
1675 """GetPosition(self) -> Point2D"""
1676 return _core_.Rect2D_GetPosition(*args, **kwargs)
1677
1678 def GetSize(*args, **kwargs):
1679 """GetSize(self) -> Size"""
1680 return _core_.Rect2D_GetSize(*args, **kwargs)
1681
1682 def GetLeft(*args, **kwargs):
1683 """GetLeft(self) -> wxDouble"""
1684 return _core_.Rect2D_GetLeft(*args, **kwargs)
1685
1686 def SetLeft(*args, **kwargs):
1687 """SetLeft(self, wxDouble n)"""
1688 return _core_.Rect2D_SetLeft(*args, **kwargs)
1689
1690 def MoveLeftTo(*args, **kwargs):
1691 """MoveLeftTo(self, wxDouble n)"""
1692 return _core_.Rect2D_MoveLeftTo(*args, **kwargs)
1693
1694 def GetTop(*args, **kwargs):
1695 """GetTop(self) -> wxDouble"""
1696 return _core_.Rect2D_GetTop(*args, **kwargs)
1697
1698 def SetTop(*args, **kwargs):
1699 """SetTop(self, wxDouble n)"""
1700 return _core_.Rect2D_SetTop(*args, **kwargs)
1701
1702 def MoveTopTo(*args, **kwargs):
1703 """MoveTopTo(self, wxDouble n)"""
1704 return _core_.Rect2D_MoveTopTo(*args, **kwargs)
1705
1706 def GetBottom(*args, **kwargs):
1707 """GetBottom(self) -> wxDouble"""
1708 return _core_.Rect2D_GetBottom(*args, **kwargs)
1709
1710 def SetBottom(*args, **kwargs):
1711 """SetBottom(self, wxDouble n)"""
1712 return _core_.Rect2D_SetBottom(*args, **kwargs)
1713
1714 def MoveBottomTo(*args, **kwargs):
1715 """MoveBottomTo(self, wxDouble n)"""
1716 return _core_.Rect2D_MoveBottomTo(*args, **kwargs)
1717
1718 def GetRight(*args, **kwargs):
1719 """GetRight(self) -> wxDouble"""
1720 return _core_.Rect2D_GetRight(*args, **kwargs)
1721
1722 def SetRight(*args, **kwargs):
1723 """SetRight(self, wxDouble n)"""
1724 return _core_.Rect2D_SetRight(*args, **kwargs)
1725
1726 def MoveRightTo(*args, **kwargs):
1727 """MoveRightTo(self, wxDouble n)"""
1728 return _core_.Rect2D_MoveRightTo(*args, **kwargs)
1729
1730 def GetLeftTop(*args, **kwargs):
1731 """GetLeftTop(self) -> Point2D"""
1732 return _core_.Rect2D_GetLeftTop(*args, **kwargs)
1733
1734 def SetLeftTop(*args, **kwargs):
1735 """SetLeftTop(self, Point2D pt)"""
1736 return _core_.Rect2D_SetLeftTop(*args, **kwargs)
1737
1738 def MoveLeftTopTo(*args, **kwargs):
1739 """MoveLeftTopTo(self, Point2D pt)"""
1740 return _core_.Rect2D_MoveLeftTopTo(*args, **kwargs)
1741
1742 def GetLeftBottom(*args, **kwargs):
1743 """GetLeftBottom(self) -> Point2D"""
1744 return _core_.Rect2D_GetLeftBottom(*args, **kwargs)
1745
1746 def SetLeftBottom(*args, **kwargs):
1747 """SetLeftBottom(self, Point2D pt)"""
1748 return _core_.Rect2D_SetLeftBottom(*args, **kwargs)
1749
1750 def MoveLeftBottomTo(*args, **kwargs):
1751 """MoveLeftBottomTo(self, Point2D pt)"""
1752 return _core_.Rect2D_MoveLeftBottomTo(*args, **kwargs)
1753
1754 def GetRightTop(*args, **kwargs):
1755 """GetRightTop(self) -> Point2D"""
1756 return _core_.Rect2D_GetRightTop(*args, **kwargs)
1757
1758 def SetRightTop(*args, **kwargs):
1759 """SetRightTop(self, Point2D pt)"""
1760 return _core_.Rect2D_SetRightTop(*args, **kwargs)
1761
1762 def MoveRightTopTo(*args, **kwargs):
1763 """MoveRightTopTo(self, Point2D pt)"""
1764 return _core_.Rect2D_MoveRightTopTo(*args, **kwargs)
1765
1766 def GetRightBottom(*args, **kwargs):
1767 """GetRightBottom(self) -> Point2D"""
1768 return _core_.Rect2D_GetRightBottom(*args, **kwargs)
1769
1770 def SetRightBottom(*args, **kwargs):
1771 """SetRightBottom(self, Point2D pt)"""
1772 return _core_.Rect2D_SetRightBottom(*args, **kwargs)
1773
1774 def MoveRightBottomTo(*args, **kwargs):
1775 """MoveRightBottomTo(self, Point2D pt)"""
1776 return _core_.Rect2D_MoveRightBottomTo(*args, **kwargs)
1777
1778 def GetCentre(*args, **kwargs):
1779 """GetCentre(self) -> Point2D"""
1780 return _core_.Rect2D_GetCentre(*args, **kwargs)
1781
1782 def SetCentre(*args, **kwargs):
1783 """SetCentre(self, Point2D pt)"""
1784 return _core_.Rect2D_SetCentre(*args, **kwargs)
1785
1786 def MoveCentreTo(*args, **kwargs):
1787 """MoveCentreTo(self, Point2D pt)"""
1788 return _core_.Rect2D_MoveCentreTo(*args, **kwargs)
1789
1790 def GetOutcode(*args, **kwargs):
1791 """GetOutcode(self, Point2D pt) -> int"""
1792 return _core_.Rect2D_GetOutcode(*args, **kwargs)
1793
1794 def Contains(*args, **kwargs):
1795 """Contains(self, Point2D pt) -> bool"""
1796 return _core_.Rect2D_Contains(*args, **kwargs)
1797
1798 def ContainsRect(*args, **kwargs):
1799 """ContainsRect(self, Rect2D rect) -> bool"""
1800 return _core_.Rect2D_ContainsRect(*args, **kwargs)
1801
1802 def IsEmpty(*args, **kwargs):
1803 """IsEmpty(self) -> bool"""
1804 return _core_.Rect2D_IsEmpty(*args, **kwargs)
1805
1806 def HaveEqualSize(*args, **kwargs):
1807 """HaveEqualSize(self, Rect2D rect) -> bool"""
1808 return _core_.Rect2D_HaveEqualSize(*args, **kwargs)
1809
1810 def Inset(*args):
1811 """
1812 Inset(self, wxDouble x, wxDouble y)
1813 Inset(self, wxDouble left, wxDouble top, wxDouble right, wxDouble bottom)
1814 """
1815 return _core_.Rect2D_Inset(*args)
1816
1817 def Offset(*args, **kwargs):
1818 """Offset(self, Point2D pt)"""
1819 return _core_.Rect2D_Offset(*args, **kwargs)
1820
1821 def ConstrainTo(*args, **kwargs):
1822 """ConstrainTo(self, Rect2D rect)"""
1823 return _core_.Rect2D_ConstrainTo(*args, **kwargs)
1824
1825 def Interpolate(*args, **kwargs):
1826 """Interpolate(self, int widthfactor, int heightfactor) -> Point2D"""
1827 return _core_.Rect2D_Interpolate(*args, **kwargs)
1828
1829 def Intersect(*args, **kwargs):
1830 """Intersect(self, Rect2D otherRect)"""
1831 return _core_.Rect2D_Intersect(*args, **kwargs)
1832
1833 def CreateIntersection(*args, **kwargs):
1834 """CreateIntersection(self, Rect2D otherRect) -> Rect2D"""
1835 return _core_.Rect2D_CreateIntersection(*args, **kwargs)
1836
1837 def Intersects(*args, **kwargs):
1838 """Intersects(self, Rect2D rect) -> bool"""
1839 return _core_.Rect2D_Intersects(*args, **kwargs)
1840
1841 def Union(*args, **kwargs):
1842 """Union(self, Rect2D otherRect)"""
1843 return _core_.Rect2D_Union(*args, **kwargs)
1844
1845 def CreateUnion(*args, **kwargs):
1846 """CreateUnion(self, Rect2D otherRect) -> Rect2D"""
1847 return _core_.Rect2D_CreateUnion(*args, **kwargs)
1848
1849 def Scale(*args):
1850 """
1851 Scale(self, wxDouble f)
1852 Scale(self, int num, int denum)
1853 """
1854 return _core_.Rect2D_Scale(*args)
1855
1856 def __eq__(*args, **kwargs):
1857 """
1858 __eq__(self, PyObject other) -> bool
1859
1860 Test for equality of wx.Rect2D objects.
1861 """
1862 return _core_.Rect2D___eq__(*args, **kwargs)
1863
1864 def __ne__(*args, **kwargs):
1865 """
1866 __ne__(self, PyObject other) -> bool
1867
1868 Test for inequality of wx.Rect2D objects.
1869 """
1870 return _core_.Rect2D___ne__(*args, **kwargs)
1871
1872 x = property(_core_.Rect2D_x_get, _core_.Rect2D_x_set)
1873 y = property(_core_.Rect2D_y_get, _core_.Rect2D_y_set)
1874 width = property(_core_.Rect2D_width_get, _core_.Rect2D_width_set)
1875 height = property(_core_.Rect2D_height_get, _core_.Rect2D_height_set)
1876 def Set(*args, **kwargs):
1877 """Set(self, wxDouble x=0, wxDouble y=0, wxDouble width=0, wxDouble height=0)"""
1878 return _core_.Rect2D_Set(*args, **kwargs)
1879
1880 def Get(*args, **kwargs):
1881 """
1882 Get() -> (x,y, width, height)
1883
1884 Return x, y, width and height y properties as a tuple.
1885 """
1886 return _core_.Rect2D_Get(*args, **kwargs)
1887
1888 def __str__(self): return str(self.Get())
1889 def __repr__(self): return 'wx.Rect2D'+str(self.Get())
1890 def __len__(self): return len(self.Get())
1891 def __getitem__(self, index): return self.Get()[index]
1892 def __setitem__(self, index, val):
1893 if index == 0: self.x = val
1894 elif index == 1: self.y = val
1895 elif index == 2: self.width = val
1896 elif index == 3: self.height = val
1897 else: raise IndexError
1898 def __nonzero__(self): return self.Get() != (0.0, 0.0, 0.0, 0.0)
1899 __safe_for_unpickling__ = True
1900 def __reduce__(self): return (wx.Rect2D, self.Get())
1901
1902_core_.Rect2D_swigregister(Rect2D)
1903
1904#---------------------------------------------------------------------------
1905
54f9ee45
RD		 1906FromStart = _core_.FromStart
1907FromCurrent = _core_.FromCurrent
1908FromEnd = _core_.FromEnd
d14a1e28 1909class InputStream(object):
093d3ff1 1910 """Proxy of C++ InputStream class"""
0085ce49
RD		 1911 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1912 __repr__ = _swig_repr
1913 def __init__(self, *args, **kwargs):
a95a7133 1914 """__init__(self, PyObject p) -> InputStream"""
0085ce49
RD		 1915 _core_.InputStream_swiginit(self,_core_.new_InputStream(*args, **kwargs))
1916 __swig_destroy__ = _core_.delete_InputStream
1917 __del__ = lambda self : None;
e811c8ce 1918 def close(*args, **kwargs):
a95a7133 1919 """close(self)"""
54f9ee45 1920 return _core_.InputStream_close(*args, **kwargs)
e811c8ce
RD		 1921
1922 def flush(*args, **kwargs):
a95a7133 1923 """flush(self)"""
54f9ee45 1924 return _core_.InputStream_flush(*args, **kwargs)
e811c8ce
RD		 1925
1926 def eof(*args, **kwargs):
a95a7133 1927 """eof(self) -> bool"""
54f9ee45 1928 return _core_.InputStream_eof(*args, **kwargs)
e811c8ce
RD		 1929
1930 def read(*args, **kwargs):
a95a7133 1931 """read(self, int size=-1) -> PyObject"""
54f9ee45 1932 return _core_.InputStream_read(*args, **kwargs)
e811c8ce
RD		 1933
1934 def readline(*args, **kwargs):
a95a7133 1935 """readline(self, int size=-1) -> PyObject"""
54f9ee45 1936 return _core_.InputStream_readline(*args, **kwargs)
e811c8ce
RD		 1937
1938 def readlines(*args, **kwargs):
a95a7133 1939 """readlines(self, int sizehint=-1) -> PyObject"""
54f9ee45 1940 return _core_.InputStream_readlines(*args, **kwargs)
e811c8ce
RD		 1941
1942 def seek(*args, **kwargs):
a95a7133 1943 """seek(self, int offset, int whence=0)"""
54f9ee45 1944 return _core_.InputStream_seek(*args, **kwargs)
e811c8ce
RD		 1945
1946 def tell(*args, **kwargs):
a95a7133 1947 """tell(self) -> int"""
54f9ee45 1948 return _core_.InputStream_tell(*args, **kwargs)
e811c8ce
RD		 1949
1950 def Peek(*args, **kwargs):
a95a7133 1951 """Peek(self) -> char"""
54f9ee45 1952 return _core_.InputStream_Peek(*args, **kwargs)
e811c8ce
RD		 1953
1954 def GetC(*args, **kwargs):
a95a7133 1955 """GetC(self) -> char"""
54f9ee45 1956 return _core_.InputStream_GetC(*args, **kwargs)
e811c8ce
RD		 1957
1958 def LastRead(*args, **kwargs):
a95a7133 1959 """LastRead(self) -> size_t"""
54f9ee45 1960 return _core_.InputStream_LastRead(*args, **kwargs)
e811c8ce
RD		 1961
1962 def CanRead(*args, **kwargs):
a95a7133 1963 """CanRead(self) -> bool"""
54f9ee45 1964 return _core_.InputStream_CanRead(*args, **kwargs)
e811c8ce
RD		 1965
1966 def Eof(*args, **kwargs):
a95a7133 1967 """Eof(self) -> bool"""
54f9ee45 1968 return _core_.InputStream_Eof(*args, **kwargs)
e811c8ce
RD		 1969
1970 def Ungetch(*args, **kwargs):
a95a7133 1971 """Ungetch(self, char c) -> bool"""
54f9ee45 1972 return _core_.InputStream_Ungetch(*args, **kwargs)
e811c8ce
RD		 1973
1974 def SeekI(*args, **kwargs):
a95a7133 1975 """SeekI(self, long pos, int mode=FromStart) -> long"""
54f9ee45 1976 return _core_.InputStream_SeekI(*args, **kwargs)
e811c8ce
RD		 1977
1978 def TellI(*args, **kwargs):
a95a7133 1979 """TellI(self) -> long"""
54f9ee45 1980 return _core_.InputStream_TellI(*args, **kwargs)
e811c8ce 1981
2131d850 1982_core_.InputStream_swigregister(InputStream)
d14a1e28
RD		 1983DefaultPosition = cvar.DefaultPosition
1984DefaultSize = cvar.DefaultSize
1985
1986class OutputStream(object):
093d3ff1 1987 """Proxy of C++ OutputStream class"""
0085ce49
RD		 1988 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1989 def __init__(self): raise AttributeError, "No constructor defined"
1990 __repr__ = _swig_repr
e811c8ce 1991 def write(*args, **kwargs):
a95a7133 1992 """write(self, PyObject obj)"""
54f9ee45 1993 return _core_.OutputStream_write(*args, **kwargs)
e811c8ce 1994
0085ce49
RD		 1995 def LastWrite(*args, **kwargs):
1996 """LastWrite(self) -> size_t"""
1997 return _core_.OutputStream_LastWrite(*args, **kwargs)
d14a1e28 1998
2131d850 1999_core_.OutputStream_swigregister(OutputStream)
d14a1e28
RD		 2000
2001#---------------------------------------------------------------------------
2002
2003class FSFile(Object):
093d3ff1 2004 """Proxy of C++ FSFile class"""
0085ce49
RD		 2005 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2006 __repr__ = _swig_repr
2007 def __init__(self, *args, **kwargs):
0df68c9f 2008 """
a95a7133 2009 __init__(self, InputStream stream, String loc, String mimetype, String anchor,
196addbf 2010 DateTime modif) -> FSFile
0df68c9f 2011 """
0085ce49 2012 _core_.FSFile_swiginit(self,_core_.new_FSFile(*args, **kwargs))
0085ce49
RD		 2013 __swig_destroy__ = _core_.delete_FSFile
2014 __del__ = lambda self : None;
e811c8ce 2015 def GetStream(*args, **kwargs):
a95a7133 2016 """GetStream(self) -> InputStream"""
54f9ee45 2017 return _core_.FSFile_GetStream(*args, **kwargs)
e811c8ce 2018
97ab0f6a
RD		 2019 def DetachStream(*args, **kwargs):
2020 """DetachStream(self)"""
2021 return _core_.FSFile_DetachStream(*args, **kwargs)
2022
e811c8ce 2023 def GetMimeType(*args, **kwargs):
a95a7133 2024 """GetMimeType(self) -> String"""
54f9ee45 2025 return _core_.FSFile_GetMimeType(*args, **kwargs)
e811c8ce
RD		 2026
2027 def GetLocation(*args, **kwargs):
a95a7133 2028 """GetLocation(self) -> String"""
54f9ee45 2029 return _core_.FSFile_GetLocation(*args, **kwargs)
e811c8ce
RD		 2030
2031 def GetAnchor(*args, **kwargs):
a95a7133 2032 """GetAnchor(self) -> String"""
54f9ee45 2033 return _core_.FSFile_GetAnchor(*args, **kwargs)
e811c8ce
RD		 2034
2035 def GetModificationTime(*args, **kwargs):
a95a7133 2036 """GetModificationTime(self) -> DateTime"""
54f9ee45 2037 return _core_.FSFile_GetModificationTime(*args, **kwargs)
e811c8ce 2038
97ab0f6a
RD		 2039 Anchor = property(GetAnchor,doc="See `GetAnchor`")
2040 Location = property(GetLocation,doc="See `GetLocation`")
2041 MimeType = property(GetMimeType,doc="See `GetMimeType`")
2042 ModificationTime = property(GetModificationTime,doc="See `GetModificationTime`")
2043 Stream = property(GetStream,doc="See `GetStream`")
2131d850 2044_core_.FSFile_swigregister(FSFile)
d14a1e28
RD		 2045
2046class CPPFileSystemHandler(object):
093d3ff1 2047 """Proxy of C++ CPPFileSystemHandler class"""
0085ce49
RD		 2048 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2049 def __init__(self): raise AttributeError, "No constructor defined"
2050 __repr__ = _swig_repr
50f151d7
RD		 2051 __swig_destroy__ = _core_.delete_CPPFileSystemHandler
2052 __del__ = lambda self : None;
2131d850 2053_core_.CPPFileSystemHandler_swigregister(CPPFileSystemHandler)
d14a1e28
RD		 2054
2055class FileSystemHandler(CPPFileSystemHandler):
093d3ff1 2056 """Proxy of C++ FileSystemHandler class"""
0085ce49
RD		 2057 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2058 __repr__ = _swig_repr
2059 def __init__(self, *args, **kwargs):
a95a7133 2060 """__init__(self) -> FileSystemHandler"""
0085ce49 2061 _core_.FileSystemHandler_swiginit(self,_core_.new_FileSystemHandler(*args, **kwargs))
d14a1e28 2062 self._setCallbackInfo(self, FileSystemHandler)
e811c8ce
RD		 2063
2064 def _setCallbackInfo(*args, **kwargs):
a95a7133 2065 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
54f9ee45 2066 return _core_.FileSystemHandler__setCallbackInfo(*args, **kwargs)
e811c8ce
RD		 2067
2068 def CanOpen(*args, **kwargs):
a95a7133 2069 """CanOpen(self, String location) -> bool"""
54f9ee45 2070 return _core_.FileSystemHandler_CanOpen(*args, **kwargs)
e811c8ce
RD		 2071
2072 def OpenFile(*args, **kwargs):
a95a7133 2073 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
54f9ee45 2074 return _core_.FileSystemHandler_OpenFile(*args, **kwargs)
e811c8ce
RD		 2075
2076 def FindFirst(*args, **kwargs):
a95a7133 2077 """FindFirst(self, String spec, int flags=0) -> String"""
54f9ee45 2078 return _core_.FileSystemHandler_FindFirst(*args, **kwargs)
e811c8ce
RD		 2079
2080 def FindNext(*args, **kwargs):
a95a7133 2081 """FindNext(self) -> String"""
54f9ee45 2082 return _core_.FileSystemHandler_FindNext(*args, **kwargs)
e811c8ce
RD		 2083
2084 def GetProtocol(*args, **kwargs):
a95a7133 2085 """GetProtocol(self, String location) -> String"""
54f9ee45 2086 return _core_.FileSystemHandler_GetProtocol(*args, **kwargs)
e811c8ce
RD		 2087
2088 def GetLeftLocation(*args, **kwargs):
a95a7133 2089 """GetLeftLocation(self, String location) -> String"""
54f9ee45 2090 return _core_.FileSystemHandler_GetLeftLocation(*args, **kwargs)
e811c8ce
RD		 2091
2092 def GetAnchor(*args, **kwargs):
a95a7133 2093 """GetAnchor(self, String location) -> String"""
54f9ee45 2094 return _core_.FileSystemHandler_GetAnchor(*args, **kwargs)
e811c8ce
RD		 2095
2096 def GetRightLocation(*args, **kwargs):
a95a7133 2097 """GetRightLocation(self, String location) -> String"""
54f9ee45 2098 return _core_.FileSystemHandler_GetRightLocation(*args, **kwargs)
e811c8ce
RD		 2099
2100 def GetMimeTypeFromExt(*args, **kwargs):
a95a7133 2101 """GetMimeTypeFromExt(self, String location) -> String"""
54f9ee45 2102 return _core_.FileSystemHandler_GetMimeTypeFromExt(*args, **kwargs)
e811c8ce 2103
97ab0f6a
RD		 2104 Anchor = property(GetAnchor,doc="See `GetAnchor`")
2105 LeftLocation = property(GetLeftLocation,doc="See `GetLeftLocation`")
2106 MimeTypeFromExt = property(GetMimeTypeFromExt,doc="See `GetMimeTypeFromExt`")
2107 Protocol = property(GetProtocol,doc="See `GetProtocol`")
2108 RightLocation = property(GetRightLocation,doc="See `GetRightLocation`")
2131d850 2109_core_.FileSystemHandler_swigregister(FileSystemHandler)
d14a1e28
RD		 2110
2111class FileSystem(Object):
093d3ff1 2112 """Proxy of C++ FileSystem class"""
0085ce49
RD		 2113 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2114 __repr__ = _swig_repr
2115 def __init__(self, *args, **kwargs):
a95a7133 2116 """__init__(self) -> FileSystem"""
0085ce49
RD		 2117 _core_.FileSystem_swiginit(self,_core_.new_FileSystem(*args, **kwargs))
2118 __swig_destroy__ = _core_.delete_FileSystem
2119 __del__ = lambda self : None;
e811c8ce 2120 def ChangePathTo(*args, **kwargs):
a95a7133 2121 """ChangePathTo(self, String location, bool is_dir=False)"""
54f9ee45 2122 return _core_.FileSystem_ChangePathTo(*args, **kwargs)
e811c8ce
RD		 2123
2124 def GetPath(*args, **kwargs):
a95a7133 2125 """GetPath(self) -> String"""
54f9ee45 2126 return _core_.FileSystem_GetPath(*args, **kwargs)
e811c8ce
RD		 2127
2128 def OpenFile(*args, **kwargs):
a95a7133 2129 """OpenFile(self, String location) -> FSFile"""
54f9ee45 2130 return _core_.FileSystem_OpenFile(*args, **kwargs)
e811c8ce
RD		 2131
2132 def FindFirst(*args, **kwargs):
a95a7133 2133 """FindFirst(self, String spec, int flags=0) -> String"""
54f9ee45 2134 return _core_.FileSystem_FindFirst(*args, **kwargs)
e811c8ce
RD		 2135
2136 def FindNext(*args, **kwargs):
a95a7133 2137 """FindNext(self) -> String"""
54f9ee45 2138 return _core_.FileSystem_FindNext(*args, **kwargs)
e811c8ce
RD		 2139
2140 def AddHandler(*args, **kwargs):
66c033b4 2141 """AddHandler(CPPFileSystemHandler handler)"""
54f9ee45 2142 return _core_.FileSystem_AddHandler(*args, **kwargs)
e811c8ce
RD		 2143
2144 AddHandler = staticmethod(AddHandler)
97ab0f6a
RD		 2145 def RemoveHandler(*args, **kwargs):
2146 """RemoveHandler(CPPFileSystemHandler handler) -> CPPFileSystemHandler"""
2147 return _core_.FileSystem_RemoveHandler(*args, **kwargs)
2148
2149 RemoveHandler = staticmethod(RemoveHandler)
e811c8ce 2150 def CleanUpHandlers(*args, **kwargs):
66c033b4 2151 """CleanUpHandlers()"""
54f9ee45 2152 return _core_.FileSystem_CleanUpHandlers(*args, **kwargs)
e811c8ce
RD		 2153
2154 CleanUpHandlers = staticmethod(CleanUpHandlers)
2155 def FileNameToURL(*args, **kwargs):
66c033b4 2156 """FileNameToURL(String filename) -> String"""
54f9ee45 2157 return _core_.FileSystem_FileNameToURL(*args, **kwargs)
e811c8ce
RD		 2158
2159 FileNameToURL = staticmethod(FileNameToURL)
2ef75293
RD		 2160 def URLToFileName(*args, **kwargs):
2161 """URLToFileName(String url) -> String"""
2162 return _core_.FileSystem_URLToFileName(*args, **kwargs)
2163
2164 URLToFileName = staticmethod(URLToFileName)
97ab0f6a 2165 Path = property(GetPath,doc="See `GetPath`")
2131d850 2166_core_.FileSystem_swigregister(FileSystem)
d14a1e28 2167
e811c8ce 2168def FileSystem_AddHandler(*args, **kwargs):
0085ce49
RD		 2169 """FileSystem_AddHandler(CPPFileSystemHandler handler)"""
2170 return _core_.FileSystem_AddHandler(*args, **kwargs)
d14a1e28 2171
97ab0f6a
RD		 2172def FileSystem_RemoveHandler(*args, **kwargs):
2173 """FileSystem_RemoveHandler(CPPFileSystemHandler handler) -> CPPFileSystemHandler"""
2174 return _core_.FileSystem_RemoveHandler(*args, **kwargs)
2175
0085ce49
RD		 2176def FileSystem_CleanUpHandlers(*args):
2177 """FileSystem_CleanUpHandlers()"""
2178 return _core_.FileSystem_CleanUpHandlers(*args)
d14a1e28 2179
e811c8ce 2180def FileSystem_FileNameToURL(*args, **kwargs):
0085ce49
RD		 2181 """FileSystem_FileNameToURL(String filename) -> String"""
2182 return _core_.FileSystem_FileNameToURL(*args, **kwargs)
d14a1e28 2183
e811c8ce 2184def FileSystem_URLToFileName(*args, **kwargs):
0085ce49
RD		 2185 """FileSystem_URLToFileName(String url) -> String"""
2186 return _core_.FileSystem_URLToFileName(*args, **kwargs)
2ef75293 2187
d14a1e28 2188class InternetFSHandler(CPPFileSystemHandler):
093d3ff1 2189 """Proxy of C++ InternetFSHandler class"""
0085ce49
RD		 2190 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2191 __repr__ = _swig_repr
2192 def __init__(self, *args, **kwargs):
a95a7133 2193 """__init__(self) -> InternetFSHandler"""
0085ce49 2194 _core_.InternetFSHandler_swiginit(self,_core_.new_InternetFSHandler(*args, **kwargs))
e811c8ce 2195 def CanOpen(*args, **kwargs):
a95a7133 2196 """CanOpen(self, String location) -> bool"""
54f9ee45 2197 return _core_.InternetFSHandler_CanOpen(*args, **kwargs)
e811c8ce
RD		 2198
2199 def OpenFile(*args, **kwargs):
a95a7133 2200 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
54f9ee45 2201 return _core_.InternetFSHandler_OpenFile(*args, **kwargs)
e811c8ce 2202
2131d850 2203_core_.InternetFSHandler_swigregister(InternetFSHandler)
d14a1e28
RD		 2204
2205class ZipFSHandler(CPPFileSystemHandler):
093d3ff1 2206 """Proxy of C++ ZipFSHandler class"""
0085ce49
RD		 2207 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2208 __repr__ = _swig_repr
2209 def __init__(self, *args, **kwargs):
a95a7133 2210 """__init__(self) -> ZipFSHandler"""
0085ce49 2211 _core_.ZipFSHandler_swiginit(self,_core_.new_ZipFSHandler(*args, **kwargs))
e811c8ce 2212 def CanOpen(*args, **kwargs):
a95a7133 2213 """CanOpen(self, String location) -> bool"""
54f9ee45 2214 return _core_.ZipFSHandler_CanOpen(*args, **kwargs)
e811c8ce
RD		 2215
2216 def OpenFile(*args, **kwargs):
a95a7133 2217 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
54f9ee45 2218 return _core_.ZipFSHandler_OpenFile(*args, **kwargs)
e811c8ce
RD		 2219
2220 def FindFirst(*args, **kwargs):
a95a7133 2221 """FindFirst(self, String spec, int flags=0) -> String"""
54f9ee45 2222 return _core_.ZipFSHandler_FindFirst(*args, **kwargs)
e811c8ce
RD		 2223
2224 def FindNext(*args, **kwargs):
a95a7133 2225 """FindNext(self) -> String"""
54f9ee45 2226 return _core_.ZipFSHandler_FindNext(*args, **kwargs)
e811c8ce 2227
2131d850 2228_core_.ZipFSHandler_swigregister(ZipFSHandler)
d14a1e28
RD		 2229
2230
e811c8ce 2231def __wxMemoryFSHandler_AddFile_wxImage(*args, **kwargs):
0085ce49
RD		 2232 """__wxMemoryFSHandler_AddFile_wxImage(String filename, Image image, long type)"""
2233 return _core_.__wxMemoryFSHandler_AddFile_wxImage(*args, **kwargs)
d14a1e28 2234
e811c8ce 2235def __wxMemoryFSHandler_AddFile_wxBitmap(*args, **kwargs):
0085ce49
RD		 2236 """__wxMemoryFSHandler_AddFile_wxBitmap(String filename, Bitmap bitmap, long type)"""
2237 return _core_.__wxMemoryFSHandler_AddFile_wxBitmap(*args, **kwargs)
d14a1e28 2238
e811c8ce 2239def __wxMemoryFSHandler_AddFile_Data(*args, **kwargs):
0085ce49
RD		 2240 """__wxMemoryFSHandler_AddFile_Data(String filename, PyObject data)"""
2241 return _core_.__wxMemoryFSHandler_AddFile_Data(*args, **kwargs)
2ef75293
RD		 2242def MemoryFSHandler_AddFile(filename, dataItem, imgType=-1):
2243 """
2244 Add 'file' to the memory filesystem. The dataItem parameter can
2245 either be a `wx.Bitmap`, `wx.Image` or a string that can contain
2246 arbitrary data. If a bitmap or image is used then the imgType
2247 parameter should specify what kind of image file it should be
2248 written as, wx.BITMAP_TYPE_PNG, etc.
2249 """
2250 if isinstance(dataItem, wx.Image):
2251 __wxMemoryFSHandler_AddFile_wxImage(filename, dataItem, imgType)
2252 elif isinstance(dataItem, wx.Bitmap):
2253 __wxMemoryFSHandler_AddFile_wxBitmap(filename, dataItem, imgType)
2254 elif type(dataItem) == str:
2255 __wxMemoryFSHandler_AddFile_Data(filename, dataItem)
2256 else:
2257 raise TypeError, 'wx.Image, wx.Bitmap or string expected'
d14a1e28
RD		 2258
2259class MemoryFSHandler(CPPFileSystemHandler):
093d3ff1 2260 """Proxy of C++ MemoryFSHandler class"""
0085ce49
RD		 2261 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2262 __repr__ = _swig_repr
2263 def __init__(self, *args, **kwargs):
a95a7133 2264 """__init__(self) -> MemoryFSHandler"""
0085ce49 2265 _core_.MemoryFSHandler_swiginit(self,_core_.new_MemoryFSHandler(*args, **kwargs))
e811c8ce 2266 def RemoveFile(*args, **kwargs):
66c033b4 2267 """RemoveFile(String filename)"""
54f9ee45 2268 return _core_.MemoryFSHandler_RemoveFile(*args, **kwargs)
e811c8ce
RD		 2269
2270 RemoveFile = staticmethod(RemoveFile)
d14a1e28 2271 AddFile = staticmethod(MemoryFSHandler_AddFile)
e811c8ce 2272 def CanOpen(*args, **kwargs):
a95a7133 2273 """CanOpen(self, String location) -> bool"""
54f9ee45 2274 return _core_.MemoryFSHandler_CanOpen(*args, **kwargs)
e811c8ce
RD		 2275
2276 def OpenFile(*args, **kwargs):
a95a7133 2277 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
54f9ee45 2278 return _core_.MemoryFSHandler_OpenFile(*args, **kwargs)
e811c8ce
RD		 2279
2280 def FindFirst(*args, **kwargs):
a95a7133 2281 """FindFirst(self, String spec, int flags=0) -> String"""
54f9ee45 2282 return _core_.MemoryFSHandler_FindFirst(*args, **kwargs)
e811c8ce
RD		 2283
2284 def FindNext(*args, **kwargs):
a95a7133 2285 """FindNext(self) -> String"""
54f9ee45 2286 return _core_.MemoryFSHandler_FindNext(*args, **kwargs)
e811c8ce 2287
2131d850 2288_core_.MemoryFSHandler_swigregister(MemoryFSHandler)
d14a1e28 2289
e811c8ce 2290def MemoryFSHandler_RemoveFile(*args, **kwargs):
0085ce49
RD		 2291 """MemoryFSHandler_RemoveFile(String filename)"""
2292 return _core_.MemoryFSHandler_RemoveFile(*args, **kwargs)
d14a1e28 2293
bcd0d7b6
RD		 2294IMAGE_ALPHA_TRANSPARENT = _core_.IMAGE_ALPHA_TRANSPARENT
2295IMAGE_ALPHA_THRESHOLD = _core_.IMAGE_ALPHA_THRESHOLD
2296IMAGE_ALPHA_OPAQUE = _core_.IMAGE_ALPHA_OPAQUE
f5263701
RD		 2297IMAGE_QUALITY_NORMAL = _core_.IMAGE_QUALITY_NORMAL
2298IMAGE_QUALITY_HIGH = _core_.IMAGE_QUALITY_HIGH
d14a1e28
RD		 2299#---------------------------------------------------------------------------
2300
2301class ImageHandler(Object):
27fb7603
RD		 2302 """
2303 This is the base class for implementing image file loading/saving, and
2304 image creation from data. It is used within `wx.Image` and is not
2305 normally seen by the application.
2306 """
0085ce49
RD		 2307 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2308 def __init__(self): raise AttributeError, "No constructor defined"
2309 __repr__ = _swig_repr
e811c8ce 2310 def GetName(*args, **kwargs):
a95a7133 2311 """GetName(self) -> String"""
54f9ee45 2312 return _core_.ImageHandler_GetName(*args, **kwargs)
e811c8ce
RD		 2313
2314 def GetExtension(*args, **kwargs):
a95a7133 2315 """GetExtension(self) -> String"""
54f9ee45 2316 return _core_.ImageHandler_GetExtension(*args, **kwargs)
e811c8ce
RD		 2317
2318 def GetType(*args, **kwargs):
a95a7133 2319 """GetType(self) -> long"""
54f9ee45 2320 return _core_.ImageHandler_GetType(*args, **kwargs)
e811c8ce
RD		 2321
2322 def GetMimeType(*args, **kwargs):
a95a7133 2323 """GetMimeType(self) -> String"""
54f9ee45 2324 return _core_.ImageHandler_GetMimeType(*args, **kwargs)
e811c8ce
RD		 2325
2326 def CanRead(*args, **kwargs):
a95a7133 2327 """CanRead(self, String name) -> bool"""
54f9ee45 2328 return _core_.ImageHandler_CanRead(*args, **kwargs)
e811c8ce 2329
b02396e8
RD		 2330 def CanReadStream(*args, **kwargs):
2331 """CanReadStream(self, InputStream stream) -> bool"""
2332 return _core_.ImageHandler_CanReadStream(*args, **kwargs)
2333
e811c8ce 2334 def SetName(*args, **kwargs):
a95a7133 2335 """SetName(self, String name)"""
54f9ee45 2336 return _core_.ImageHandler_SetName(*args, **kwargs)
e811c8ce
RD		 2337
2338 def SetExtension(*args, **kwargs):
a95a7133 2339 """SetExtension(self, String extension)"""
54f9ee45 2340 return _core_.ImageHandler_SetExtension(*args, **kwargs)
e811c8ce
RD		 2341
2342 def SetType(*args, **kwargs):
a95a7133 2343 """SetType(self, long type)"""
54f9ee45 2344 return _core_.ImageHandler_SetType(*args, **kwargs)
e811c8ce
RD		 2345
2346 def SetMimeType(*args, **kwargs):
a95a7133 2347 """SetMimeType(self, String mimetype)"""
54f9ee45 2348 return _core_.ImageHandler_SetMimeType(*args, **kwargs)
e811c8ce 2349
97ab0f6a
RD		 2350 Extension = property(GetExtension,SetExtension,doc="See `GetExtension` and `SetExtension`")
2351 MimeType = property(GetMimeType,SetMimeType,doc="See `GetMimeType` and `SetMimeType`")
2352 Name = property(GetName,SetName,doc="See `GetName` and `SetName`")
2353 Type = property(GetType,SetType,doc="See `GetType` and `SetType`")
2131d850 2354_core_.ImageHandler_swigregister(ImageHandler)
d14a1e28 2355
943e8dfd
RD		 2356class PyImageHandler(ImageHandler):
2357 """
2358 This is the base class for implementing image file loading/saving, and
2359 image creation from data, all written in Python. To create a custom
2360 image handler derive a new class from wx.PyImageHandler and provide
2361 the following methods::
2362
2363 def DoCanRead(self, stream) --> bool
2364 '''Check if this handler can read the image on the stream'''
2365
2366 def LoadFile(self, image, stream, verbose, index) --> bool
2367 '''Load image data from the stream and load it into image.'''
2368
2369 def SaveFile(self, image, stream, verbose) --> bool
2370 '''Save the iamge data in image to the stream using
2371 this handler's image file format.'''
2372
2373 def GetImageCount(self, stream) --> int
2374 '''If this image format can hold more than one image,
2375 how many does the image on the stream have?'''
2376
2377 To activate your handler create an instance of it and pass it to
2378 `wx.Image_AddHandler`. Be sure to call `SetName`, `SetType`, and
2379 `SetExtension` from your constructor.
2380
2381 """
0085ce49
RD		 2382 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2383 __repr__ = _swig_repr
2384 def __init__(self, *args, **kwargs):
943e8dfd
RD		 2385 """
2386 __init__(self) -> PyImageHandler
2387
2388 This is the base class for implementing image file loading/saving, and
2389 image creation from data, all written in Python. To create a custom
2390 image handler derive a new class from wx.PyImageHandler and provide
2391 the following methods::
2392
2393 def DoCanRead(self, stream) --> bool
2394 '''Check if this handler can read the image on the stream'''
2395
2396 def LoadFile(self, image, stream, verbose, index) --> bool
2397 '''Load image data from the stream and load it into image.'''
2398
2399 def SaveFile(self, image, stream, verbose) --> bool
2400 '''Save the iamge data in image to the stream using
2401 this handler's image file format.'''
2402
2403 def GetImageCount(self, stream) --> int
2404 '''If this image format can hold more than one image,
2405 how many does the image on the stream have?'''
2406
2407 To activate your handler create an instance of it and pass it to
2408 `wx.Image_AddHandler`. Be sure to call `SetName`, `SetType`, and
2409 `SetExtension` from your constructor.
2410
2411 """
0085ce49 2412 _core_.PyImageHandler_swiginit(self,_core_.new_PyImageHandler(*args, **kwargs))
943e8dfd
RD		 2413 self._SetSelf(self)
2414
2415 def _SetSelf(*args, **kwargs):
2416 """_SetSelf(self, PyObject self)"""
2417 return _core_.PyImageHandler__SetSelf(*args, **kwargs)
2418
2131d850 2419_core_.PyImageHandler_swigregister(PyImageHandler)
943e8dfd 2420
d14a1e28 2421class ImageHistogram(object):
093d3ff1 2422 """Proxy of C++ ImageHistogram class"""
0085ce49
RD		 2423 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2424 __repr__ = _swig_repr
2425 def __init__(self, *args, **kwargs):
a95a7133 2426 """__init__(self) -> ImageHistogram"""
0085ce49 2427 _core_.ImageHistogram_swiginit(self,_core_.new_ImageHistogram(*args, **kwargs))
e811c8ce 2428 def MakeKey(*args, **kwargs):
0df68c9f 2429 """
7a27cf7c 2430 MakeKey(byte r, byte g, byte b) -> unsigned long
e811c8ce 2431
0df68c9f
RD		 2432 Get the key in the histogram for the given RGB values
2433 """
54f9ee45 2434 return _core_.ImageHistogram_MakeKey(*args, **kwargs)
e811c8ce
RD		 2435
2436 MakeKey = staticmethod(MakeKey)
2437 def FindFirstUnusedColour(*args, **kwargs):
fd2dc343
RD		 2438 """
2439 FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)
2440
2441 Find first colour that is not used in the image and has higher RGB
2442 values than startR, startG, startB. Returns a tuple consisting of a
2443 success flag and rgb values.
2444 """
54f9ee45 2445 return _core_.ImageHistogram_FindFirstUnusedColour(*args, **kwargs)
e811c8ce 2446
f1cbd8fa
RD		 2447 def GetCount(*args, **kwargs):
2448 """
2449 GetCount(self, unsigned long key) -> unsigned long
2450
2451 Returns the pixel count for the given key. Use `MakeKey` to create a
2452 key value from a RGB tripple.
2453 """
2454 return _core_.ImageHistogram_GetCount(*args, **kwargs)
2455
2456 def GetCountRGB(*args, **kwargs):
2457 """
7a27cf7c 2458 GetCountRGB(self, byte r, byte g, byte b) -> unsigned long
f1cbd8fa
RD		 2459
2460 Returns the pixel count for the given RGB values.
2461 """
2462 return _core_.ImageHistogram_GetCountRGB(*args, **kwargs)
2463
2464 def GetCountColour(*args, **kwargs):
2465 """
2466 GetCountColour(self, Colour colour) -> unsigned long
2467
2468 Returns the pixel count for the given `wx.Colour` value.
2469 """
2470 return _core_.ImageHistogram_GetCountColour(*args, **kwargs)
2471
2131d850 2472_core_.ImageHistogram_swigregister(ImageHistogram)
d14a1e28 2473
e811c8ce 2474def ImageHistogram_MakeKey(*args, **kwargs):
0085ce49 2475 """
7a27cf7c 2476 ImageHistogram_MakeKey(byte r, byte g, byte b) -> unsigned long
e811c8ce 2477
0df68c9f
RD		 2478 Get the key in the histogram for the given RGB values
2479 """
0085ce49 2480 return _core_.ImageHistogram_MakeKey(*args, **kwargs)
d14a1e28 2481
943e8dfd
RD		 2482class Image_RGBValue(object):
2483 """
2484 An object that contains values for red, green and blue which represent
2485 the value of a color. It is used by `wx.Image.HSVtoRGB` and
2486 `wx.Image.RGBtoHSV`, which converts between HSV color space and RGB
2487 color space.
2488 """
0085ce49
RD		 2489 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2490 __repr__ = _swig_repr
2491 def __init__(self, *args, **kwargs):
943e8dfd
RD		 2492 """
2493 __init__(self, byte r=0, byte g=0, byte b=0) -> Image_RGBValue
2494
2495 Constructor.
2496 """
0085ce49 2497 _core_.Image_RGBValue_swiginit(self,_core_.new_Image_RGBValue(*args, **kwargs))
943e8dfd
RD		 2498 red = property(_core_.Image_RGBValue_red_get, _core_.Image_RGBValue_red_set)
2499 green = property(_core_.Image_RGBValue_green_get, _core_.Image_RGBValue_green_set)
2500 blue = property(_core_.Image_RGBValue_blue_get, _core_.Image_RGBValue_blue_set)
2131d850 2501_core_.Image_RGBValue_swigregister(Image_RGBValue)
943e8dfd
RD		 2502
2503class Image_HSVValue(object):
2504 """
2505 An object that contains values for hue, saturation and value which
2506 represent the value of a color. It is used by `wx.Image.HSVtoRGB` and
2507 `wx.Image.RGBtoHSV`, which +converts between HSV color space and RGB
2508 color space.
2509 """
0085ce49
RD		 2510 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2511 __repr__ = _swig_repr
2512 def __init__(self, *args, **kwargs):
943e8dfd
RD		 2513 """
2514 __init__(self, double h=0.0, double s=0.0, double v=0.0) -> Image_HSVValue
2515
2516 Constructor.
2517 """
0085ce49 2518 _core_.Image_HSVValue_swiginit(self,_core_.new_Image_HSVValue(*args, **kwargs))
943e8dfd
RD		 2519 hue = property(_core_.Image_HSVValue_hue_get, _core_.Image_HSVValue_hue_set)
2520 saturation = property(_core_.Image_HSVValue_saturation_get, _core_.Image_HSVValue_saturation_set)
2521 value = property(_core_.Image_HSVValue_value_get, _core_.Image_HSVValue_value_set)
2131d850 2522_core_.Image_HSVValue_swigregister(Image_HSVValue)
943e8dfd 2523
d14a1e28 2524class Image(Object):
7a27cf7c
RD		 2525 """
2526 A platform-independent image class. An image can be created from
2527 data, or using `wx.Bitmap.ConvertToImage`, or loaded from a file in a
2528 variety of formats. Functions are available to set and get image
2529 bits, so it can be used for basic image manipulation.
2530
2531 A wx.Image cannot be drawn directly to a `wx.DC`. Instead, a
2532 platform-specific `wx.Bitmap` object must be created from it using the
2533 `wx.BitmapFromImage` constructor. This bitmap can then be drawn in a
2534 device context, using `wx.DC.DrawBitmap`.
2535
2536 One colour value of the image may be used as a mask colour which will
2537 lead to the automatic creation of a `wx.Mask` object associated to the
2538 bitmap object.
2539
2540 wx.Image supports alpha channel data, that is in addition to a byte
2541 for the red, green and blue colour components for each pixel it also
2542 stores a byte representing the pixel opacity. An alpha value of 0
2543 corresponds to a transparent pixel (null opacity) while a value of 255
2544 means that the pixel is 100% opaque.
2545
2546 Unlike RGB data, not all images have an alpha channel and before using
2547 `GetAlpha` you should check if this image contains an alpha channel
2548 with `HasAlpha`. Note that currently only images loaded from PNG files
2549 with transparency information will have an alpha channel.
2550 """
0085ce49
RD		 2551 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2552 __repr__ = _swig_repr
2553 def __init__(self, *args, **kwargs):
7a27cf7c
RD		 2554 """
2555 __init__(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> Image
2556
2557 Loads an image from a file.
2558 """
0085ce49
RD		 2559 _core_.Image_swiginit(self,_core_.new_Image(*args, **kwargs))
2560 __swig_destroy__ = _core_.delete_Image
2561 __del__ = lambda self : None;
e811c8ce 2562 def Create(*args, **kwargs):
7a27cf7c
RD		 2563 """
2564 Create(self, int width, int height, bool clear=True)
2565
2566 Creates a fresh image. If clear is ``True``, the new image will be
2567 initialized to black. Otherwise, the image data will be uninitialized.
2568 """
54f9ee45 2569 return _core_.Image_Create(*args, **kwargs)
e811c8ce
RD		 2570
2571 def Destroy(*args, **kwargs):
0df68c9f 2572 """
a95a7133 2573 Destroy(self)
e811c8ce 2574
7a27cf7c 2575 Destroys the image data.
0df68c9f 2576 """
b39fe951
RD		 2577 args[0].this.own(False)
2578 return _core_.Image_Destroy(*args, **kwargs)
e811c8ce
RD		 2579
2580 def Scale(*args, **kwargs):
7a27cf7c 2581 """
f5263701 2582 Scale(self, int width, int height, int quality=IMAGE_QUALITY_NORMAL) -> Image
7a27cf7c
RD		 2583
2584 Returns a scaled version of the image. This is also useful for scaling
2585 bitmaps in general as the only other way to scale bitmaps is to blit a
f5263701
RD		 2586 `wx.MemoryDC` into another `wx.MemoryDC`. The ``quality`` parameter
2587 specifies what method to use for resampling the image. It can be
2588 either wx.IMAGE_QUALITY_NORMAL, which uses the normal default scaling
2589 method of pixel replication, or wx.IMAGE_QUALITY_HIGH which uses
2590 bicubic and box averaging resampling methods for upsampling and
2591 downsampling respectively.
7a27cf7c 2592 """
54f9ee45 2593 return _core_.Image_Scale(*args, **kwargs)
e811c8ce 2594
f5263701
RD		 2595 def ResampleBox(*args, **kwargs):
2596 """ResampleBox(self, int width, int height) -> Image"""
2597 return _core_.Image_ResampleBox(*args, **kwargs)
2598
2599 def ResampleBicubic(*args, **kwargs):
2600 """ResampleBicubic(self, int width, int height) -> Image"""
2601 return _core_.Image_ResampleBicubic(*args, **kwargs)
2602
2603 def Blur(*args, **kwargs):
2604 """
2605 Blur(self, int radius) -> Image
2606
2607 Blurs the image in both horizontal and vertical directions by the
2608 specified pixel ``radius``. This should not be used when using a
2609 single mask colour for transparency.
2610 """
2611 return _core_.Image_Blur(*args, **kwargs)
2612
2613 def BlurHorizontal(*args, **kwargs):
2614 """
2615 BlurHorizontal(self, int radius) -> Image
2616
2617 Blurs the image in the horizontal direction only. This should not be
2618 used when using a single mask colour for transparency.
2619
2620 """
2621 return _core_.Image_BlurHorizontal(*args, **kwargs)
2622
2623 def BlurVertical(*args, **kwargs):
2624 """
2625 BlurVertical(self, int radius) -> Image
2626
2627 Blurs the image in the vertical direction only. This should not be
2628 used when using a single mask colour for transparency.
2629 """
2630 return _core_.Image_BlurVertical(*args, **kwargs)
2631
e811c8ce 2632 def ShrinkBy(*args, **kwargs):
7a27cf7c
RD		 2633 """
2634 ShrinkBy(self, int xFactor, int yFactor) -> Image
2635
2636 Return a version of the image scaled smaller by the given factors.
2637 """
54f9ee45 2638 return _core_.Image_ShrinkBy(*args, **kwargs)
e811c8ce
RD		 2639
2640 def Rescale(*args, **kwargs):
7a27cf7c 2641 """
f5263701 2642 Rescale(self, int width, int height, int quality=IMAGE_QUALITY_NORMAL) -> Image
7a27cf7c
RD		 2643
2644 Changes the size of the image in-place by scaling it: after a call to
2645 this function, the image will have the given width and height.
2646
2647 Returns the (modified) image itself.
2648 """
54f9ee45 2649 return _core_.Image_Rescale(*args, **kwargs)
e811c8ce 2650
aff4cc5c 2651 def Resize(*args, **kwargs):
7a27cf7c
RD		 2652 """
2653 Resize(self, Size size, Point pos, int r=-1, int g=-1, int b=-1) -> Image
2654
2655 Changes the size of the image in-place without scaling it, by adding
2656 either a border with the given colour or cropping as necessary. The
2657 image is pasted into a new image with the given size and background
2658 colour at the position pos relative to the upper left of the new
2659 image. If red = green = blue = -1 then use either the current mask
2660 colour if set or find, use, and set a suitable mask colour for any
2661 newly exposed areas.
2662
2663 Returns the (modified) image itself.
2664 """
aff4cc5c
RD		 2665 return _core_.Image_Resize(*args, **kwargs)
2666
e811c8ce 2667 def SetRGB(*args, **kwargs):
7a27cf7c
RD		 2668 """
2669 SetRGB(self, int x, int y, byte r, byte g, byte b)
2670
2671 Sets the pixel at the given coordinate. This routine performs
2672 bounds-checks for the coordinate so it can be considered a safe way to
2673 manipulate the data, but in some cases this might be too slow so that
2674 the data will have to be set directly. In that case you will have to
2675 get access to the image data using the `GetData` method.
2676 """
54f9ee45 2677 return _core_.Image_SetRGB(*args, **kwargs)
e811c8ce 2678
aff4cc5c 2679 def SetRGBRect(*args, **kwargs):
7a27cf7c
RD		 2680 """
2681 SetRGBRect(self, Rect rect, byte r, byte g, byte b)
2682
2683 Sets the colour of the pixels within the given rectangle. This routine
2684 performs bounds-checks for the rectangle so it can be considered a
2685 safe way to manipulate the data.
2686 """
aff4cc5c
RD		 2687 return _core_.Image_SetRGBRect(*args, **kwargs)
2688
e811c8ce 2689 def GetRed(*args, **kwargs):
7a27cf7c
RD		 2690 """
2691 GetRed(self, int x, int y) -> byte
2692
2693 Returns the red intensity at the given coordinate.
2694 """
54f9ee45 2695 return _core_.Image_GetRed(*args, **kwargs)
e811c8ce
RD		 2696
2697 def GetGreen(*args, **kwargs):
7a27cf7c
RD		 2698 """
2699 GetGreen(self, int x, int y) -> byte
2700
2701 Returns the green intensity at the given coordinate.
2702 """
54f9ee45 2703 return _core_.Image_GetGreen(*args, **kwargs)
e811c8ce
RD		 2704
2705 def GetBlue(*args, **kwargs):
7a27cf7c
RD		 2706 """
2707 GetBlue(self, int x, int y) -> byte
2708
2709 Returns the blue intensity at the given coordinate.
2710 """
54f9ee45 2711 return _core_.Image_GetBlue(*args, **kwargs)
e811c8ce
RD		 2712
2713 def SetAlpha(*args, **kwargs):
7a27cf7c
RD		 2714 """
2715 SetAlpha(self, int x, int y, byte alpha)
2716
2717 Sets the alpha value for the given pixel. This function should only be
2718 called if the image has alpha channel data, use `HasAlpha` to check
2719 for this.
2720 """
54f9ee45 2721 return _core_.Image_SetAlpha(*args, **kwargs)
e811c8ce
RD		 2722
2723 def GetAlpha(*args, **kwargs):
7a27cf7c
RD		 2724 """
2725 GetAlpha(self, int x, int y) -> byte
2726
2727 Returns the alpha value for the given pixel. This function may only be
2728 called for the images with alpha channel, use `HasAlpha` to check for
2729 this.
2730
2731 The returned value is the *opacity* of the image, i.e. the value of 0
2732 corresponds to the fully transparent pixels while the value of 255 to
2733 the fully opaque pixels.
2734 """
54f9ee45 2735 return _core_.Image_GetAlpha(*args, **kwargs)
e811c8ce
RD		 2736
2737 def HasAlpha(*args, **kwargs):
7a27cf7c
RD		 2738 """
2739 HasAlpha(self) -> bool
2740
2741 Returns true if this image has alpha channel, false otherwise.
2742 """
54f9ee45 2743 return _core_.Image_HasAlpha(*args, **kwargs)
e811c8ce 2744
68350608
RD		 2745 def InitAlpha(*args, **kwargs):
2746 """
2747 InitAlpha(self)
2748
2749 Initializes the image alpha channel data. It is an error to call it if
2750 the image already has alpha data. If it doesn't, alpha data will be by
2751 default initialized to all pixels being fully opaque. But if the image
2752 has a a mask colour, all mask pixels will be completely transparent.
2753 """
2754 return _core_.Image_InitAlpha(*args, **kwargs)
2755
bcd0d7b6
RD		 2756 def IsTransparent(*args, **kwargs):
2757 """
7a27cf7c 2758 IsTransparent(self, int x, int y, byte threshold=IMAGE_ALPHA_THRESHOLD) -> bool
bcd0d7b6 2759
7a27cf7c
RD		 2760 Returns ``True`` if this pixel is masked or has an alpha value less
2761 than the spcified threshold.
bcd0d7b6
RD		 2762 """
2763 return _core_.Image_IsTransparent(*args, **kwargs)
2764
e811c8ce 2765 def FindFirstUnusedColour(*args, **kwargs):
fd2dc343
RD		 2766 """
2767 FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)
2768
2769 Find first colour that is not used in the image and has higher RGB
2770 values than startR, startG, startB. Returns a tuple consisting of a
2771 success flag and rgb values.
2772 """
54f9ee45 2773 return _core_.Image_FindFirstUnusedColour(*args, **kwargs)
e811c8ce 2774
4cf4100f
RD		 2775 def ConvertAlphaToMask(*args, **kwargs):
2776 """
bcd0d7b6 2777 ConvertAlphaToMask(self, byte threshold=IMAGE_ALPHA_THRESHOLD) -> bool
4cf4100f 2778
7a27cf7c
RD		 2779 If the image has alpha channel, this method converts it to mask. All
2780 pixels with alpha value less than ``threshold`` are replaced with the
2781 mask colour and the alpha channel is removed. The mask colour is
2782 chosen automatically using `FindFirstUnusedColour`.
4cf4100f
RD		 2783
2784 If the image image doesn't have alpha channel, ConvertAlphaToMask does
2785 nothing.
2786 """
2787 return _core_.Image_ConvertAlphaToMask(*args, **kwargs)
2788
8fb0e70a
RD		 2789 def ConvertColourToAlpha(*args, **kwargs):
2790 """
7a27cf7c 2791 ConvertColourToAlpha(self, byte r, byte g, byte b) -> bool
8fb0e70a
RD		 2792
2793 This method converts an image where the original alpha information is
2794 only available as a shades of a colour (actually shades of grey)
2795 typically when you draw anti-aliased text into a bitmap. The DC
2796 drawing routines draw grey values on the black background although
2797 they actually mean to draw white with differnt alpha values. This
2798 method reverses it, assuming a black (!) background and white text.
2799 The method will then fill up the whole image with the colour given.
2800 """
2801 return _core_.Image_ConvertColourToAlpha(*args, **kwargs)
2802
e811c8ce 2803 def SetMaskFromImage(*args, **kwargs):
7a27cf7c
RD		 2804 """
2805 SetMaskFromImage(self, Image mask, byte mr, byte mg, byte mb) -> bool
2806
2807 Sets the image's mask so that the pixels that have RGB value of
2808 ``(mr,mg,mb)`` in ``mask`` will be masked in this image. This is done
2809 by first finding an unused colour in the image, setting this colour as
2810 the mask colour and then using this colour to draw all pixels in the
2811 image who corresponding pixel in mask has given RGB value.
2812
2813 Returns ``False`` if ``mask`` does not have same dimensions as the
2814 image or if there is no unused colour left. Returns ``True`` if the
2815 mask was successfully applied.
2816
2817 Note that this method involves computing the histogram, which is
2818 computationally intensive operation.
2819 """
54f9ee45 2820 return _core_.Image_SetMaskFromImage(*args, **kwargs)
e811c8ce
RD		 2821
2822 def CanRead(*args, **kwargs):
7a27cf7c
RD		 2823 """
2824 CanRead(String filename) -> bool
2825
2826 Returns True if the image handlers can read this file.
2827 """
54f9ee45 2828 return _core_.Image_CanRead(*args, **kwargs)
e811c8ce
RD		 2829
2830 CanRead = staticmethod(CanRead)
2831 def GetImageCount(*args, **kwargs):
7a27cf7c
RD		 2832 """
2833 GetImageCount(String filename, long type=BITMAP_TYPE_ANY) -> int
2834
2835 If the image file contains more than one image and the image handler
2836 is capable of retrieving these individually, this function will return
2837 the number of available images.
2838 """
54f9ee45 2839 return _core_.Image_GetImageCount(*args, **kwargs)
e811c8ce
RD		 2840
2841 GetImageCount = staticmethod(GetImageCount)
2842 def LoadFile(*args, **kwargs):
7a27cf7c
RD		 2843 """
2844 LoadFile(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> bool
2845
2846 Loads an image from a file. If no handler type is provided, the
2847 library will try to autodetect the format.
2848 """
54f9ee45 2849 return _core_.Image_LoadFile(*args, **kwargs)
e811c8ce
RD		 2850
2851 def LoadMimeFile(*args, **kwargs):
7a27cf7c
RD		 2852 """
2853 LoadMimeFile(self, String name, String mimetype, int index=-1) -> bool
2854
2855 Loads an image from a file, specifying the image type with a MIME type
2856 string.
2857 """
54f9ee45 2858 return _core_.Image_LoadMimeFile(*args, **kwargs)
e811c8ce
RD		 2859
2860 def SaveFile(*args, **kwargs):
7a27cf7c
RD		 2861 """
2862 SaveFile(self, String name, int type) -> bool
2863
2864 Saves an image in the named file.
2865 """
54f9ee45 2866 return _core_.Image_SaveFile(*args, **kwargs)
e811c8ce
RD		 2867
2868 def SaveMimeFile(*args, **kwargs):
7a27cf7c
RD		 2869 """
2870 SaveMimeFile(self, String name, String mimetype) -> bool
2871
2872 Saves an image in the named file.
2873 """
54f9ee45 2874 return _core_.Image_SaveMimeFile(*args, **kwargs)
e811c8ce
RD		 2875
2876 def CanReadStream(*args, **kwargs):
7a27cf7c
RD		 2877 """
2878 CanReadStream(InputStream stream) -> bool
2879
2880 Returns True if the image handlers can read an image file from the
2881 data currently on the input stream, or a readable Python file-like
2882 object.
2883 """
54f9ee45 2884 return _core_.Image_CanReadStream(*args, **kwargs)
e811c8ce
RD		 2885
2886 CanReadStream = staticmethod(CanReadStream)
2887 def LoadStream(*args, **kwargs):
7a27cf7c
RD		 2888 """
2889 LoadStream(self, InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> bool
2890
2891 Loads an image from an input stream or a readable Python file-like
2892 object. If no handler type is provided, the library will try to
2893 autodetect the format.
2894 """
54f9ee45 2895 return _core_.Image_LoadStream(*args, **kwargs)
e811c8ce
RD		 2896
2897 def LoadMimeStream(*args, **kwargs):
7a27cf7c
RD		 2898 """
2899 LoadMimeStream(self, InputStream stream, String mimetype, int index=-1) -> bool
2900
2901 Loads an image from an input stream or a readable Python file-like
2902 object, using a MIME type string to specify the image file format.
2903 """
54f9ee45 2904 return _core_.Image_LoadMimeStream(*args, **kwargs)
e811c8ce 2905
b39fe951 2906 def IsOk(*args, **kwargs):
7a27cf7c 2907 """
b39fe951 2908 IsOk(self) -> bool
7a27cf7c
RD		 2909
2910 Returns true if image data is present.
2911 """
b39fe951 2912 return _core_.Image_IsOk(*args, **kwargs)
e811c8ce 2913
b39fe951 2914 Ok = IsOk
e811c8ce 2915 def GetWidth(*args, **kwargs):
7a27cf7c
RD		 2916 """
2917 GetWidth(self) -> int
2918
2919 Gets the width of the image in pixels.
2920 """
54f9ee45 2921 return _core_.Image_GetWidth(*args, **kwargs)
e811c8ce
RD		 2922
2923 def GetHeight(*args, **kwargs):
7a27cf7c
RD		 2924 """
2925 GetHeight(self) -> int
2926
2927 Gets the height of the image in pixels.
2928 """
54f9ee45 2929 return _core_.Image_GetHeight(*args, **kwargs)
e811c8ce 2930
b2df227b 2931 def GetSize(*args, **kwargs):
7a27cf7c
RD		 2932 """
2933 GetSize(self) -> Size
2934
2935 Returns the size of the image in pixels.
2936 """
54f9ee45 2937 return _core_.Image_GetSize(*args, **kwargs)
b2df227b 2938
e811c8ce 2939 def GetSubImage(*args, **kwargs):
7a27cf7c
RD		 2940 """
2941 GetSubImage(self, Rect rect) -> Image
2942
2943 Returns a sub image of the current one as long as the rect belongs
2944 entirely to the image.
2945 """
54f9ee45 2946 return _core_.Image_GetSubImage(*args, **kwargs)
e811c8ce 2947
aff4cc5c 2948 def Size(*args, **kwargs):
7a27cf7c
RD		 2949 """
2950 Size(self, Size size, Point pos, int r=-1, int g=-1, int b=-1) -> Image
2951
2952 Returns a resized version of this image without scaling it by adding
2953 either a border with the given colour or cropping as necessary. The
2954 image is pasted into a new image with the given size and background
2955 colour at the position ``pos`` relative to the upper left of the new
2956 image. If red = green = blue = -1 then use either the current mask
2957 colour if set or find, use, and set a suitable mask colour for any
2958 newly exposed areas.
2959 """
aff4cc5c
RD		 2960 return _core_.Image_Size(*args, **kwargs)
2961
e811c8ce 2962 def Copy(*args, **kwargs):
7a27cf7c
RD		 2963 """
2964 Copy(self) -> Image
2965
2966 Returns an identical copy of the image.
2967 """
54f9ee45 2968 return _core_.Image_Copy(*args, **kwargs)
e811c8ce
RD		 2969
2970 def Paste(*args, **kwargs):
7a27cf7c
RD		 2971 """
2972 Paste(self, Image image, int x, int y)
2973
2974 Pastes ``image`` into this instance and takes care of the mask colour
2975 and any out of bounds problems.
2976 """
54f9ee45 2977 return _core_.Image_Paste(*args, **kwargs)
e811c8ce
RD		 2978
2979 def GetData(*args, **kwargs):
61d07ac7
RD		 2980 """
2981 GetData(self) -> PyObject
2982
2983 Returns a string containing a copy of the RGB bytes of the image.
2984 """
54f9ee45 2985 return _core_.Image_GetData(*args, **kwargs)
e811c8ce
RD		 2986
2987 def SetData(*args, **kwargs):
61d07ac7
RD		 2988 """
2989 SetData(self, buffer data)
2990
2991 Resets the Image's RGB data from a buffer of RGB bytes. Accepts
2992 either a string or a buffer object holding the data and the length of
2993 the data must be width*height*3.
2994 """
54f9ee45 2995 return _core_.Image_SetData(*args, **kwargs)
e811c8ce
RD		 2996
2997 def GetDataBuffer(*args, **kwargs):
61d07ac7
RD		 2998 """
2999 GetDataBuffer(self) -> PyObject
3000
3001 Returns a writable Python buffer object that is pointing at the RGB
7a27cf7c
RD		 3002 image data buffer inside the wx.Image. You need to ensure that you do
3003 not use this buffer object after the image has been destroyed.
61d07ac7 3004 """
54f9ee45 3005 return _core_.Image_GetDataBuffer(*args, **kwargs)
e811c8ce
RD		 3006
3007 def SetDataBuffer(*args, **kwargs):
61d07ac7
RD		 3008 """
3009 SetDataBuffer(self, buffer data)
3010
3011 Sets the internal image data pointer to point at a Python buffer
7a27cf7c
RD		 3012 object. This can save making an extra copy of the data but you must
3013 ensure that the buffer object lives longer than the wx.Image does.
61d07ac7 3014 """
54f9ee45 3015 return _core_.Image_SetDataBuffer(*args, **kwargs)
e811c8ce
RD		 3016
3017 def GetAlphaData(*args, **kwargs):
61d07ac7
RD		 3018 """
3019 GetAlphaData(self) -> PyObject
3020
3021 Returns a string containing a copy of the alpha bytes of the image.
3022 """
54f9ee45 3023 return _core_.Image_GetAlphaData(*args, **kwargs)
e811c8ce
RD		 3024
3025 def SetAlphaData(*args, **kwargs):
61d07ac7
RD		 3026 """
3027 SetAlphaData(self, buffer alpha)
3028
3029 Resets the Image's alpha data from a buffer of bytes. Accepts either
3030 a string or a buffer object holding the data and the length of the
3031 data must be width*height.
3032 """
54f9ee45 3033 return _core_.Image_SetAlphaData(*args, **kwargs)
e811c8ce
RD		 3034
3035 def GetAlphaBuffer(*args, **kwargs):
fc46b7f3
RD		 3036 """
3037 GetAlphaBuffer(self) -> PyObject
3038
3039 Returns a writable Python buffer object that is pointing at the Alpha
3040 data buffer inside the wx.Image. You need to ensure that you do not
3041 use this buffer object after the image has been destroyed.
3042 """
54f9ee45 3043 return _core_.Image_GetAlphaBuffer(*args, **kwargs)
e811c8ce
RD		 3044
3045 def SetAlphaBuffer(*args, **kwargs):
fc46b7f3
RD		 3046 """
3047 SetAlphaBuffer(self, buffer alpha)
3048
3049 Sets the internal image alpha pointer to point at a Python buffer
3050 object. This can save making an extra copy of the data but you must
3051 ensure that the buffer object lives as long as the wx.Image does.
3052 """
54f9ee45 3053 return _core_.Image_SetAlphaBuffer(*args, **kwargs)
e811c8ce
RD		 3054
3055 def SetMaskColour(*args, **kwargs):
7a27cf7c
RD		 3056 """
3057 SetMaskColour(self, byte r, byte g, byte b)
3058
3059 Sets the mask colour for this image (and tells the image to use the
3060 mask).
3061 """
54f9ee45 3062 return _core_.Image_SetMaskColour(*args, **kwargs)
e811c8ce 3063
aff4cc5c
RD		 3064 def GetOrFindMaskColour(*args, **kwargs):
3065 """
3066 GetOrFindMaskColour() -> (r,g,b)
3067
3068 Get the current mask colour or find a suitable colour.
3069 """
3070 return _core_.Image_GetOrFindMaskColour(*args, **kwargs)
3071
e811c8ce 3072 def GetMaskRed(*args, **kwargs):
7a27cf7c
RD		 3073 """
3074 GetMaskRed(self) -> byte
3075
3076 Gets the red component of the mask colour.
3077 """
54f9ee45 3078 return _core_.Image_GetMaskRed(*args, **kwargs)
e811c8ce
RD		 3079
3080 def GetMaskGreen(*args, **kwargs):
7a27cf7c
RD		 3081 """
3082 GetMaskGreen(self) -> byte
3083
3084 Gets the green component of the mask colour.
3085 """
54f9ee45 3086 return _core_.Image_GetMaskGreen(*args, **kwargs)
e811c8ce
RD		 3087
3088 def GetMaskBlue(*args, **kwargs):
7a27cf7c
RD		 3089 """
3090 GetMaskBlue(self) -> byte
3091
3092 Gets the blue component of the mask colour.
3093 """
54f9ee45 3094 return _core_.Image_GetMaskBlue(*args, **kwargs)
e811c8ce
RD		 3095
3096 def SetMask(*args, **kwargs):
7a27cf7c
RD		 3097 """
3098 SetMask(self, bool mask=True)
3099
3100 Specifies whether there is a mask or not. The area of the mask is
3101 determined by the current mask colour.
3102 """
54f9ee45 3103 return _core_.Image_SetMask(*args, **kwargs)
e811c8ce
RD		 3104
3105 def HasMask(*args, **kwargs):
7a27cf7c
RD		 3106 """
3107 HasMask(self) -> bool
3108
3109 Returns ``True`` if there is a mask active, ``False`` otherwise.
3110 """
54f9ee45 3111 return _core_.Image_HasMask(*args, **kwargs)
e811c8ce
RD		 3112
3113 def Rotate(*args, **kwargs):
0df68c9f 3114 """
a95a7133 3115 Rotate(self, double angle, Point centre_of_rotation, bool interpolating=True,
0df68c9f 3116 Point offset_after_rotation=None) -> Image
7a27cf7c
RD		 3117
3118 Rotates the image about the given point, by ``angle`` radians. Passing
3119 ``True`` to ``interpolating`` results in better image quality, but is
3120 slower. If the image has a mask, then the mask colour is used for the
3121 uncovered pixels in the rotated image background. Otherwise, black
3122 will be used as the fill colour.
3123
3124 Returns the rotated image, leaving this image intact.
0df68c9f 3125 """
54f9ee45 3126 return _core_.Image_Rotate(*args, **kwargs)
e811c8ce
RD		 3127
3128 def Rotate90(*args, **kwargs):
7a27cf7c
RD		 3129 """
3130 Rotate90(self, bool clockwise=True) -> Image
3131
3132 Returns a copy of the image rotated 90 degrees in the direction
3133 indicated by ``clockwise``.
3134 """
54f9ee45 3135 return _core_.Image_Rotate90(*args, **kwargs)
e811c8ce
RD		 3136
3137 def Mirror(*args, **kwargs):
7a27cf7c
RD		 3138 """
3139 Mirror(self, bool horizontally=True) -> Image
3140
3141 Returns a mirrored copy of the image. The parameter ``horizontally``
3142 indicates the orientation.
3143 """
54f9ee45 3144 return _core_.Image_Mirror(*args, **kwargs)
e811c8ce
RD		 3145
3146 def Replace(*args, **kwargs):
0df68c9f 3147 """
7a27cf7c
RD		 3148 Replace(self, byte r1, byte g1, byte b1, byte r2, byte g2, byte b2)
3149
3150 Replaces the colour specified by ``(r1,g1,b1)`` by the colour
3151 ``(r2,g2,b2)``.
0df68c9f 3152 """
54f9ee45 3153 return _core_.Image_Replace(*args, **kwargs)
e811c8ce 3154
32fe5131
RD		 3155 def ConvertToGreyscale(*args, **kwargs):
3156 """
3157 ConvertToGreyscale(self, double lr=0.299, double lg=0.587, double lb=0.114) -> Image
3158
3159 Convert to greyscale image. Uses the luminance component (Y) of the
3160 image. The luma value (YUV) is calculated using (R * lr) + (G * lg) + (B * lb),
3161 defaults to ITU-T BT.601
3162 """
3163 return _core_.Image_ConvertToGreyscale(*args, **kwargs)
3164
e811c8ce 3165 def ConvertToMono(*args, **kwargs):
7a27cf7c
RD		 3166 """
3167 ConvertToMono(self, byte r, byte g, byte b) -> Image
3168
3169 Returns monochromatic version of the image. The returned image has
3170 white colour where the original has ``(r,g,b)`` colour and black
3171 colour everywhere else.
3172 """
54f9ee45 3173 return _core_.Image_ConvertToMono(*args, **kwargs)
e811c8ce
RD		 3174
3175 def SetOption(*args, **kwargs):
7a27cf7c
RD		 3176 """
3177 SetOption(self, String name, String value)
3178
3179 Sets an image handler defined option. For example, when saving as a
3180 JPEG file, the option ``wx.IMAGE_OPTION_QUALITY`` is used, which is a
3181 number between 0 and 100 (0 is terrible, 100 is very good).
3182 """
54f9ee45 3183 return _core_.Image_SetOption(*args, **kwargs)
e811c8ce
RD		 3184
3185 def SetOptionInt(*args, **kwargs):
7a27cf7c
RD		 3186 """
3187 SetOptionInt(self, String name, int value)
3188
3189 Sets an image option as an integer.
3190 """
54f9ee45 3191 return _core_.Image_SetOptionInt(*args, **kwargs)
e811c8ce
RD		 3192
3193 def GetOption(*args, **kwargs):
7a27cf7c
RD		 3194 """
3195 GetOption(self, String name) -> String
3196
3197 Gets the value of an image handler option.
3198 """
54f9ee45 3199 return _core_.Image_GetOption(*args, **kwargs)
e811c8ce
RD		 3200
3201 def GetOptionInt(*args, **kwargs):
7a27cf7c
RD		 3202 """
3203 GetOptionInt(self, String name) -> int
3204
3205 Gets the value of an image handler option as an integer. If the given
3206 option is not present, the function returns 0.
3207 """
54f9ee45 3208 return _core_.Image_GetOptionInt(*args, **kwargs)
e811c8ce
RD		 3209
3210 def HasOption(*args, **kwargs):
7a27cf7c
RD		 3211 """
3212 HasOption(self, String name) -> bool
3213
3214 Returns true if the given option is present.
3215 """
54f9ee45 3216 return _core_.Image_HasOption(*args, **kwargs)
e811c8ce
RD		 3217
3218 def CountColours(*args, **kwargs):
a95a7133 3219 """CountColours(self, unsigned long stopafter=(unsigned long) -1) -> unsigned long"""
54f9ee45 3220 return _core_.Image_CountColours(*args, **kwargs)
e811c8ce
RD		 3221
3222 def ComputeHistogram(*args, **kwargs):
a95a7133 3223 """ComputeHistogram(self, ImageHistogram h) -> unsigned long"""
54f9ee45 3224 return _core_.Image_ComputeHistogram(*args, **kwargs)
e811c8ce
RD		 3225
3226 def AddHandler(*args, **kwargs):
66c033b4 3227 """AddHandler(ImageHandler handler)"""
54f9ee45 3228 return _core_.Image_AddHandler(*args, **kwargs)
e811c8ce
RD		 3229
3230 AddHandler = staticmethod(AddHandler)
3231 def InsertHandler(*args, **kwargs):
66c033b4 3232 """InsertHandler(ImageHandler handler)"""
54f9ee45 3233 return _core_.Image_InsertHandler(*args, **kwargs)
e811c8ce
RD		 3234
3235 InsertHandler = staticmethod(InsertHandler)
3236 def RemoveHandler(*args, **kwargs):
66c033b4 3237 """RemoveHandler(String name) -> bool"""
54f9ee45 3238 return _core_.Image_RemoveHandler(*args, **kwargs)
e811c8ce
RD		 3239
3240 RemoveHandler = staticmethod(RemoveHandler)
0085ce49
RD		 3241 def GetHandlers(*args, **kwargs):
3242 """GetHandlers() -> PyObject"""
3243 return _core_.Image_GetHandlers(*args, **kwargs)
3244
3245 GetHandlers = staticmethod(GetHandlers)
e811c8ce 3246 def GetImageExtWildcard(*args, **kwargs):
7a27cf7c
RD		 3247 """
3248 GetImageExtWildcard() -> String
3249
3250 Iterates all registered wxImageHandler objects, and returns a string
3251 containing file extension masks suitable for passing to file open/save
3252 dialog boxes.
3253 """
54f9ee45 3254 return _core_.Image_GetImageExtWildcard(*args, **kwargs)
e811c8ce
RD		 3255
3256 GetImageExtWildcard = staticmethod(GetImageExtWildcard)
3257 def ConvertToBitmap(*args, **kwargs):
1fbf26be 3258 """ConvertToBitmap(self, int depth=-1) -> Bitmap"""
54f9ee45 3259 return _core_.Image_ConvertToBitmap(*args, **kwargs)
e811c8ce
RD		 3260
3261 def ConvertToMonoBitmap(*args, **kwargs):
7a27cf7c 3262 """ConvertToMonoBitmap(self, byte red, byte green, byte blue) -> Bitmap"""
54f9ee45 3263 return _core_.Image_ConvertToMonoBitmap(*args, **kwargs)
e811c8ce 3264
943e8dfd
RD		 3265 def RotateHue(*args, **kwargs):
3266 """
3267 RotateHue(self, double angle)
3268
3269 Rotates the hue of each pixel of the image. Hue is a double in the
3270 range -1.0..1.0 where -1.0 is -360 degrees and 1.0 is 360 degrees
3271 """
3272 return _core_.Image_RotateHue(*args, **kwargs)
3273
3274 def RGBtoHSV(*args, **kwargs):
3275 """
3276 RGBtoHSV(Image_RGBValue rgb) -> Image_HSVValue
3277
3278 Converts a color in RGB color space to HSV color space.
3279 """
3280 return _core_.Image_RGBtoHSV(*args, **kwargs)
3281
3282 RGBtoHSV = staticmethod(RGBtoHSV)
3283 def HSVtoRGB(*args, **kwargs):
3284 """
3285 HSVtoRGB(Image_HSVValue hsv) -> Image_RGBValue
3286
3287 Converts a color in HSV color space to RGB color space.
3288 """
3289 return _core_.Image_HSVtoRGB(*args, **kwargs)
3290
3291 HSVtoRGB = staticmethod(HSVtoRGB)
b39fe951 3292 def __nonzero__(self): return self.IsOk()
97ab0f6a
RD		 3293 AlphaBuffer = property(GetAlphaBuffer,SetAlphaBuffer,doc="See `GetAlphaBuffer` and `SetAlphaBuffer`")
3294 AlphaData = property(GetAlphaData,SetAlphaData,doc="See `GetAlphaData` and `SetAlphaData`")
3295 Data = property(GetData,SetData,doc="See `GetData` and `SetData`")
3296 DataBuffer = property(GetDataBuffer,SetDataBuffer,doc="See `GetDataBuffer` and `SetDataBuffer`")
3297 Height = property(GetHeight,doc="See `GetHeight`")
3298 MaskBlue = property(GetMaskBlue,doc="See `GetMaskBlue`")
3299 MaskGreen = property(GetMaskGreen,doc="See `GetMaskGreen`")
3300 MaskRed = property(GetMaskRed,doc="See `GetMaskRed`")
97ab0f6a 3301 Width = property(GetWidth,doc="See `GetWidth`")
2131d850 3302_core_.Image_swigregister(Image)
d14a1e28
RD		 3303
3304def ImageFromMime(*args, **kwargs):
7a27cf7c
RD		 3305 """
3306 ImageFromMime(String name, String mimetype, int index=-1) -> Image
3307
3308 Loads an image from a file, using a MIME type string (such as
3309 'image/jpeg') to specify image type.
3310 """
54f9ee45 3311 val = _core_.new_ImageFromMime(*args, **kwargs)
d14a1e28
RD		 3312 return val
3313
3314def ImageFromStream(*args, **kwargs):
7a27cf7c
RD		 3315 """
3316 ImageFromStream(InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> Image
3317
3318 Loads an image from an input stream, or any readable Python file-like
3319 object.
3320 """
54f9ee45 3321 val = _core_.new_ImageFromStream(*args, **kwargs)
d14a1e28
RD		 3322 return val
3323
3324def ImageFromStreamMime(*args, **kwargs):
7a27cf7c
RD		 3325 """
3326 ImageFromStreamMime(InputStream stream, String mimetype, int index=-1) -> Image
3327
3328 Loads an image from an input stream, or any readable Python file-like
3329 object, specifying the image format with a MIME type string.
3330 """
54f9ee45 3331 val = _core_.new_ImageFromStreamMime(*args, **kwargs)
d14a1e28
RD		 3332 return val
3333
66c033b4 3334def EmptyImage(*args, **kwargs):
61d07ac7
RD		 3335 """
3336 EmptyImage(int width=0, int height=0, bool clear=True) -> Image
3337
3338 Construct an empty image of a given size, optionally setting all
3339 pixels to black.
3340 """
66c033b4 3341 val = _core_.new_EmptyImage(*args, **kwargs)
d14a1e28
RD		 3342 return val
3343
3344def ImageFromBitmap(*args, **kwargs):
61d07ac7
RD		 3345 """
3346 ImageFromBitmap(Bitmap bitmap) -> Image
3347
3348 Construct an Image from a `wx.Bitmap`.
3349 """
54f9ee45 3350 val = _core_.new_ImageFromBitmap(*args, **kwargs)
d14a1e28
RD		 3351 return val
3352
3353def ImageFromData(*args, **kwargs):
61d07ac7
RD		 3354 """
3355 ImageFromData(int width, int height, buffer data) -> Image
3356
3357 Construct an Image from a buffer of RGB bytes. Accepts either a
3358 string or a buffer object holding the data and the length of the data
3359 must be width*height*3.
3360 """
54f9ee45 3361 val = _core_.new_ImageFromData(*args, **kwargs)
d14a1e28
RD		 3362 return val
3363
1823fbb4 3364def ImageFromDataWithAlpha(*args, **kwargs):
61d07ac7
RD		 3365 """
3366 ImageFromDataWithAlpha(int width, int height, buffer data, buffer alpha) -> Image
3367
3368 Construct an Image from a buffer of RGB bytes with an Alpha channel.
3369 Accepts either a string or a buffer object holding the data and the
7a27cf7c
RD		 3370 length of the data must be width*height*3 bytes, and the length of the
3371 alpha data must be width*height bytes.
61d07ac7 3372 """
1823fbb4 3373 val = _core_.new_ImageFromDataWithAlpha(*args, **kwargs)
1823fbb4
RD		 3374 return val
3375
e811c8ce 3376def Image_CanRead(*args, **kwargs):
0085ce49 3377 """
7a27cf7c
RD		 3378 Image_CanRead(String filename) -> bool
3379
3380 Returns True if the image handlers can read this file.
3381 """
0085ce49 3382 return _core_.Image_CanRead(*args, **kwargs)
d14a1e28 3383
e811c8ce 3384def Image_GetImageCount(*args, **kwargs):
0085ce49 3385 """
7a27cf7c
RD		 3386 Image_GetImageCount(String filename, long type=BITMAP_TYPE_ANY) -> int
3387
3388 If the image file contains more than one image and the image handler
3389 is capable of retrieving these individually, this function will return
3390 the number of available images.
3391 """
0085ce49 3392 return _core_.Image_GetImageCount(*args, **kwargs)
d14a1e28 3393
e811c8ce 3394def Image_CanReadStream(*args, **kwargs):
0085ce49 3395 """
7a27cf7c
RD		 3396 Image_CanReadStream(InputStream stream) -> bool
3397
3398 Returns True if the image handlers can read an image file from the
3399 data currently on the input stream, or a readable Python file-like
3400 object.
3401 """
0085ce49 3402 return _core_.Image_CanReadStream(*args, **kwargs)
d14a1e28 3403
e811c8ce 3404def Image_AddHandler(*args, **kwargs):
0085ce49
RD		 3405 """Image_AddHandler(ImageHandler handler)"""
3406 return _core_.Image_AddHandler(*args, **kwargs)
d14a1e28 3407
e811c8ce 3408def Image_InsertHandler(*args, **kwargs):
0085ce49
RD		 3409 """Image_InsertHandler(ImageHandler handler)"""
3410 return _core_.Image_InsertHandler(*args, **kwargs)
d14a1e28 3411
e811c8ce 3412def Image_RemoveHandler(*args, **kwargs):
0085ce49
RD		 3413 """Image_RemoveHandler(String name) -> bool"""
3414 return _core_.Image_RemoveHandler(*args, **kwargs)
d14a1e28 3415
0085ce49
RD		 3416def Image_GetHandlers(*args):
3417 """Image_GetHandlers() -> PyObject"""
3418 return _core_.Image_GetHandlers(*args)
3419
3420def Image_GetImageExtWildcard(*args):
3421 """
7a27cf7c
RD		 3422 Image_GetImageExtWildcard() -> String
3423
3424 Iterates all registered wxImageHandler objects, and returns a string
3425 containing file extension masks suitable for passing to file open/save
3426 dialog boxes.
3427 """
0085ce49 3428 return _core_.Image_GetImageExtWildcard(*args)
d14a1e28 3429
943e8dfd 3430def Image_RGBtoHSV(*args, **kwargs):
0085ce49 3431 """
943e8dfd
RD		 3432 Image_RGBtoHSV(Image_RGBValue rgb) -> Image_HSVValue
3433
3434 Converts a color in RGB color space to HSV color space.
3435 """
0085ce49 3436 return _core_.Image_RGBtoHSV(*args, **kwargs)
943e8dfd
RD		 3437
3438def Image_HSVtoRGB(*args, **kwargs):
0085ce49 3439 """
943e8dfd
RD		 3440 Image_HSVtoRGB(Image_HSVValue hsv) -> Image_RGBValue
3441
3442 Converts a color in HSV color space to RGB color space.
3443 """
0085ce49 3444 return _core_.Image_HSVtoRGB(*args, **kwargs)
943e8dfd 3445
fc46b7f3
RD		 3446
3447def _ImageFromBuffer(*args, **kwargs):
3448 """_ImageFromBuffer(int width, int height, buffer data, buffer alpha=None) -> Image"""
3449 return _core_._ImageFromBuffer(*args, **kwargs)
3450def ImageFromBuffer(width, height, dataBuffer, alphaBuffer=None):
3451 """
3452 Creates a `wx.Image` from the data in dataBuffer. The dataBuffer
eec1c382
RD		 3453 parameter must be a Python object that implements the buffer interface,
3454 such as a string, array, etc. The dataBuffer object is expected to
3455 contain a series of RGB bytes and be width*height*3 bytes long. A buffer
3456 object can optionally be supplied for the image's alpha channel data, and
3457 it is expected to be width*height bytes long.
fc46b7f3
RD		 3458
3459 The wx.Image will be created with its data and alpha pointers initialized
3460 to the memory address pointed to by the buffer objects, thus saving the
3461 time needed to copy the image data from the buffer object to the wx.Image.
3462 While this has advantages, it also has the shoot-yourself-in-the-foot
3463 risks associated with sharing a C pointer between two objects.
3464
3465 To help alleviate the risk a reference to the data and alpha buffer
3466 objects are kept with the wx.Image, so that they won't get deleted until
3467 after the wx.Image is deleted. However please be aware that it is not
3468 guaranteed that an object won't move its memory buffer to a new location
3469 when it needs to resize its contents. If that happens then the wx.Image
3470 will end up referring to an invalid memory location and could cause the
3471 application to crash. Therefore care should be taken to not manipulate
3472 the objects used for the data and alpha buffers in a way that would cause
3473 them to change size.
3474 """
fc46b7f3
RD		 3475 image = _core_._ImageFromBuffer(width, height, dataBuffer, alphaBuffer)
3476 image._buffer = dataBuffer
3477 image._alpha = alphaBuffer
3478 return image
3479
5e4ca4a8
RD		 3480def InitAllImageHandlers():
3481 """
3482 The former functionality of InitAllImageHanders is now done internal to
3483 the _core_ extension module and so this function has become a simple NOP.
3484 """
3485 pass
d14a1e28 3486
54f9ee45
RD		 3487IMAGE_RESOLUTION_INCHES = _core_.IMAGE_RESOLUTION_INCHES
3488IMAGE_RESOLUTION_CM = _core_.IMAGE_RESOLUTION_CM
b9d6a5f3
RD		 3489PNG_TYPE_COLOUR = _core_.PNG_TYPE_COLOUR
3490PNG_TYPE_GREY = _core_.PNG_TYPE_GREY
3491PNG_TYPE_GREY_RED = _core_.PNG_TYPE_GREY_RED
54f9ee45
RD		 3492BMP_24BPP = _core_.BMP_24BPP
3493BMP_8BPP = _core_.BMP_8BPP
3494BMP_8BPP_GREY = _core_.BMP_8BPP_GREY
3495BMP_8BPP_GRAY = _core_.BMP_8BPP_GRAY
3496BMP_8BPP_RED = _core_.BMP_8BPP_RED
3497BMP_8BPP_PALETTE = _core_.BMP_8BPP_PALETTE
3498BMP_4BPP = _core_.BMP_4BPP
3499BMP_1BPP = _core_.BMP_1BPP
3500BMP_1BPP_BW = _core_.BMP_1BPP_BW
d14a1e28 3501class BMPHandler(ImageHandler):
27fb7603 3502 """A `wx.ImageHandler` for \*.bmp bitmap files."""
0085ce49
RD		 3503 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3504 __repr__ = _swig_repr
3505 def __init__(self, *args, **kwargs):
27fb7603
RD		 3506 """
3507 __init__(self) -> BMPHandler
3508
3509 A `wx.ImageHandler` for \*.bmp bitmap files.
3510 """
0085ce49 3511 _core_.BMPHandler_swiginit(self,_core_.new_BMPHandler(*args, **kwargs))
2131d850 3512_core_.BMPHandler_swigregister(BMPHandler)
d14a1e28 3513NullImage = cvar.NullImage
0c243d93 3514IMAGE_OPTION_FILENAME = cvar.IMAGE_OPTION_FILENAME
d14a1e28
RD		 3515IMAGE_OPTION_BMP_FORMAT = cvar.IMAGE_OPTION_BMP_FORMAT
3516IMAGE_OPTION_CUR_HOTSPOT_X = cvar.IMAGE_OPTION_CUR_HOTSPOT_X
3517IMAGE_OPTION_CUR_HOTSPOT_Y = cvar.IMAGE_OPTION_CUR_HOTSPOT_Y
3518IMAGE_OPTION_RESOLUTION = cvar.IMAGE_OPTION_RESOLUTION
0c243d93
RD		 3519IMAGE_OPTION_RESOLUTIONX = cvar.IMAGE_OPTION_RESOLUTIONX
3520IMAGE_OPTION_RESOLUTIONY = cvar.IMAGE_OPTION_RESOLUTIONY
d14a1e28 3521IMAGE_OPTION_RESOLUTIONUNIT = cvar.IMAGE_OPTION_RESOLUTIONUNIT
24d7cbea 3522IMAGE_OPTION_QUALITY = cvar.IMAGE_OPTION_QUALITY
0c243d93
RD		 3523IMAGE_OPTION_BITSPERSAMPLE = cvar.IMAGE_OPTION_BITSPERSAMPLE
3524IMAGE_OPTION_SAMPLESPERPIXEL = cvar.IMAGE_OPTION_SAMPLESPERPIXEL
3525IMAGE_OPTION_COMPRESSION = cvar.IMAGE_OPTION_COMPRESSION
3526IMAGE_OPTION_IMAGEDESCRIPTOR = cvar.IMAGE_OPTION_IMAGEDESCRIPTOR
b9d6a5f3
RD		 3527IMAGE_OPTION_PNG_FORMAT = cvar.IMAGE_OPTION_PNG_FORMAT
3528IMAGE_OPTION_PNG_BITDEPTH = cvar.IMAGE_OPTION_PNG_BITDEPTH
d14a1e28
RD		 3529
3530class ICOHandler(BMPHandler):
27fb7603 3531 """A `wx.ImageHandler` for \*.ico icon files."""
0085ce49
RD		 3532 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3533 __repr__ = _swig_repr
3534 def __init__(self, *args, **kwargs):
27fb7603
RD		 3535 """
3536 __init__(self) -> ICOHandler
3537
3538 A `wx.ImageHandler` for \*.ico icon files.
3539 """
0085ce49 3540 _core_.ICOHandler_swiginit(self,_core_.new_ICOHandler(*args, **kwargs))
2131d850 3541_core_.ICOHandler_swigregister(ICOHandler)
d14a1e28
RD		 3542
3543class CURHandler(ICOHandler):
27fb7603 3544 """A `wx.ImageHandler` for \*.cur cursor files."""
0085ce49
RD		 3545 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3546 __repr__ = _swig_repr
3547 def __init__(self, *args, **kwargs):
27fb7603
RD		 3548 """
3549 __init__(self) -> CURHandler
3550
3551 A `wx.ImageHandler` for \*.cur cursor files.
3552 """
0085ce49 3553 _core_.CURHandler_swiginit(self,_core_.new_CURHandler(*args, **kwargs))
2131d850 3554_core_.CURHandler_swigregister(CURHandler)
d14a1e28
RD		 3555
3556class ANIHandler(CURHandler):
27fb7603 3557 """A `wx.ImageHandler` for \*.ani animated cursor files."""
0085ce49
RD		 3558 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3559 __repr__ = _swig_repr
3560 def __init__(self, *args, **kwargs):
27fb7603
RD		 3561 """
3562 __init__(self) -> ANIHandler
3563
3564 A `wx.ImageHandler` for \*.ani animated cursor files.
3565 """
0085ce49 3566 _core_.ANIHandler_swiginit(self,_core_.new_ANIHandler(*args, **kwargs))
2131d850 3567_core_.ANIHandler_swigregister(ANIHandler)
d14a1e28
RD		 3568
3569class PNGHandler(ImageHandler):
27fb7603 3570 """A `wx.ImageHandler` for PNG image files."""
0085ce49
RD		 3571 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3572 __repr__ = _swig_repr
3573 def __init__(self, *args, **kwargs):
27fb7603
RD		 3574 """
3575 __init__(self) -> PNGHandler
3576
3577 A `wx.ImageHandler` for PNG image files.
3578 """
0085ce49 3579 _core_.PNGHandler_swiginit(self,_core_.new_PNGHandler(*args, **kwargs))
2131d850 3580_core_.PNGHandler_swigregister(PNGHandler)
d14a1e28
RD		 3581
3582class GIFHandler(ImageHandler):
27fb7603 3583 """A `wx.ImageHandler` for GIF image files."""
0085ce49
RD		 3584 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3585 __repr__ = _swig_repr
3586 def __init__(self, *args, **kwargs):
27fb7603
RD		 3587 """
3588 __init__(self) -> GIFHandler
3589
3590 A `wx.ImageHandler` for GIF image files.
3591 """
0085ce49 3592 _core_.GIFHandler_swiginit(self,_core_.new_GIFHandler(*args, **kwargs))
2131d850 3593_core_.GIFHandler_swigregister(GIFHandler)
d14a1e28
RD		 3594
3595class PCXHandler(ImageHandler):
27fb7603 3596 """A `wx.ImageHandler` for PCX imager files."""
0085ce49
RD		 3597 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3598 __repr__ = _swig_repr
3599 def __init__(self, *args, **kwargs):
27fb7603
RD		 3600 """
3601 __init__(self) -> PCXHandler
3602
3603 A `wx.ImageHandler` for PCX imager files.
3604 """
0085ce49 3605 _core_.PCXHandler_swiginit(self,_core_.new_PCXHandler(*args, **kwargs))
2131d850 3606_core_.PCXHandler_swigregister(PCXHandler)
d14a1e28
RD		 3607
3608class JPEGHandler(ImageHandler):
27fb7603 3609 """A `wx.ImageHandler` for JPEG/JPG image files."""
0085ce49
RD		 3610 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3611 __repr__ = _swig_repr
3612 def __init__(self, *args, **kwargs):
27fb7603
RD		 3613 """
3614 __init__(self) -> JPEGHandler
3615
3616 A `wx.ImageHandler` for JPEG/JPG image files.
3617 """
0085ce49 3618 _core_.JPEGHandler_swiginit(self,_core_.new_JPEGHandler(*args, **kwargs))
2131d850 3619_core_.JPEGHandler_swigregister(JPEGHandler)
d14a1e28
RD		 3620
3621class PNMHandler(ImageHandler):
27fb7603 3622 """A `wx.ImageHandler` for PNM image files."""
0085ce49
RD		 3623 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3624 __repr__ = _swig_repr
3625 def __init__(self, *args, **kwargs):
27fb7603
RD		 3626 """
3627 __init__(self) -> PNMHandler
3628
3629 A `wx.ImageHandler` for PNM image files.
3630 """
0085ce49 3631 _core_.PNMHandler_swiginit(self,_core_.new_PNMHandler(*args, **kwargs))
2131d850 3632_core_.PNMHandler_swigregister(PNMHandler)
d14a1e28
RD		 3633
3634class XPMHandler(ImageHandler):
27fb7603 3635 """A `wx.ImageHandler` for XPM image."""
0085ce49
RD		 3636 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3637 __repr__ = _swig_repr
3638 def __init__(self, *args, **kwargs):
27fb7603
RD		 3639 """
3640 __init__(self) -> XPMHandler
3641
3642 A `wx.ImageHandler` for XPM image.
3643 """
0085ce49 3644 _core_.XPMHandler_swiginit(self,_core_.new_XPMHandler(*args, **kwargs))
2131d850 3645_core_.XPMHandler_swigregister(XPMHandler)
d14a1e28
RD		 3646
3647class TIFFHandler(ImageHandler):
27fb7603 3648 """A `wx.ImageHandler` for TIFF image files."""
0085ce49
RD		 3649 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3650 __repr__ = _swig_repr
3651 def __init__(self, *args, **kwargs):
27fb7603
RD		 3652 """
3653 __init__(self) -> TIFFHandler
3654
3655 A `wx.ImageHandler` for TIFF image files.
3656 """
0085ce49 3657 _core_.TIFFHandler_swiginit(self,_core_.new_TIFFHandler(*args, **kwargs))
2131d850 3658_core_.TIFFHandler_swigregister(TIFFHandler)
d14a1e28 3659
c0de73ae
RD		 3660QUANTIZE_INCLUDE_WINDOWS_COLOURS = _core_.QUANTIZE_INCLUDE_WINDOWS_COLOURS
3661QUANTIZE_FILL_DESTINATION_IMAGE = _core_.QUANTIZE_FILL_DESTINATION_IMAGE
3662class Quantize(object):
3663 """Performs quantization, or colour reduction, on a wxImage."""
0085ce49
RD		 3664 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3665 def __init__(self): raise AttributeError, "No constructor defined"
3666 __repr__ = _swig_repr
c0de73ae
RD		 3667 def Quantize(*args, **kwargs):
3668 """
3669 Quantize(Image src, Image dest, int desiredNoColours=236, int flags=wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE) -> bool
3670
3671 Reduce the colours in the source image and put the result into the
3672 destination image, setting the palette in the destination if
3673 needed. Both images may be the same, to overwrite the source image.
3674 """
3675 return _core_.Quantize_Quantize(*args, **kwargs)
3676
3677 Quantize = staticmethod(Quantize)
2131d850 3678_core_.Quantize_swigregister(Quantize)
c0de73ae
RD		 3679
3680def Quantize_Quantize(*args, **kwargs):
0085ce49 3681 """
c0de73ae
RD		 3682 Quantize_Quantize(Image src, Image dest, int desiredNoColours=236, int flags=wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE) -> bool
3683
3684 Reduce the colours in the source image and put the result into the
3685 destination image, setting the palette in the destination if
3686 needed. Both images may be the same, to overwrite the source image.
3687 """
0085ce49 3688 return _core_.Quantize_Quantize(*args, **kwargs)
c0de73ae 3689
d14a1e28
RD		 3690#---------------------------------------------------------------------------
3691
3692class EvtHandler(Object):
093d3ff1 3693 """Proxy of C++ EvtHandler class"""
0085ce49
RD		 3694 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3695 __repr__ = _swig_repr
3696 def __init__(self, *args, **kwargs):
a95a7133 3697 """__init__(self) -> EvtHandler"""
0085ce49 3698 _core_.EvtHandler_swiginit(self,_core_.new_EvtHandler(*args, **kwargs))
d49bdf34
RD		 3699 self._setOORInfo(self)
3700
e811c8ce 3701 def GetNextHandler(*args, **kwargs):
a95a7133 3702 """GetNextHandler(self) -> EvtHandler"""
54f9ee45 3703 return _core_.EvtHandler_GetNextHandler(*args, **kwargs)
e811c8ce
RD		 3704
3705 def GetPreviousHandler(*args, **kwargs):
a95a7133 3706 """GetPreviousHandler(self) -> EvtHandler"""
54f9ee45 3707 return _core_.EvtHandler_GetPreviousHandler(*args, **kwargs)
e811c8ce
RD		 3708
3709 def SetNextHandler(*args, **kwargs):
a95a7133 3710 """SetNextHandler(self, EvtHandler handler)"""
54f9ee45 3711 return _core_.EvtHandler_SetNextHandler(*args, **kwargs)
e811c8ce
RD		 3712
3713 def SetPreviousHandler(*args, **kwargs):
a95a7133 3714 """SetPreviousHandler(self, EvtHandler handler)"""
54f9ee45 3715 return _core_.EvtHandler_SetPreviousHandler(*args, **kwargs)
e811c8ce
RD		 3716
3717 def GetEvtHandlerEnabled(*args, **kwargs):
a95a7133 3718 """GetEvtHandlerEnabled(self) -> bool"""
54f9ee45 3719 return _core_.EvtHandler_GetEvtHandlerEnabled(*args, **kwargs)
e811c8ce
RD		 3720
3721 def SetEvtHandlerEnabled(*args, **kwargs):
a95a7133 3722 """SetEvtHandlerEnabled(self, bool enabled)"""
54f9ee45 3723 return _core_.EvtHandler_SetEvtHandlerEnabled(*args, **kwargs)
e811c8ce
RD		 3724
3725 def ProcessEvent(*args, **kwargs):
a95a7133 3726 """ProcessEvent(self, Event event) -> bool"""
54f9ee45 3727 return _core_.EvtHandler_ProcessEvent(*args, **kwargs)
e811c8ce
RD		 3728
3729 def AddPendingEvent(*args, **kwargs):
a95a7133 3730 """AddPendingEvent(self, Event event)"""
54f9ee45 3731 return _core_.EvtHandler_AddPendingEvent(*args, **kwargs)
e811c8ce
RD		 3732
3733 def ProcessPendingEvents(*args, **kwargs):
a95a7133 3734 """ProcessPendingEvents(self)"""
54f9ee45 3735 return _core_.EvtHandler_ProcessPendingEvents(*args, **kwargs)
e811c8ce 3736
b39fe951
RD		 3737 def AllowReentrance(*args, **kwargs):
3738 """AllowReentrance(self, bool allow=True)"""
3739 return _core_.EvtHandler_AllowReentrance(*args, **kwargs)
3740
3741 def IsReentranceAllowed(*args, **kwargs):
3742 """IsReentranceAllowed(self) -> bool"""
3743 return _core_.EvtHandler_IsReentranceAllowed(*args, **kwargs)
3744
3745 def IsEventHandlingInProgress(*args, **kwargs):
3746 """IsEventHandlingInProgress(self) -> bool"""
3747 return _core_.EvtHandler_IsEventHandlingInProgress(*args, **kwargs)
3748
e811c8ce 3749 def Connect(*args, **kwargs):
a95a7133 3750 """Connect(self, int id, int lastId, int eventType, PyObject func)"""
54f9ee45 3751 return _core_.EvtHandler_Connect(*args, **kwargs)
e811c8ce
RD		 3752
3753 def Disconnect(*args, **kwargs):
2131d850 3754 """Disconnect(self, int id, int lastId=-1, EventType eventType=wxEVT_NULL) -> bool"""
54f9ee45 3755 return _core_.EvtHandler_Disconnect(*args, **kwargs)
e811c8ce
RD		 3756
3757 def _setOORInfo(*args, **kwargs):
689b42ee 3758 """_setOORInfo(self, PyObject _self, bool incref=True)"""
7e08d4ef
RD		 3759 val = _core_.EvtHandler__setOORInfo(*args, **kwargs)
3760 args[0].thisown = 0
3761 return val
e811c8ce 3762
d14a1e28
RD		 3763 def Bind(self, event, handler, source=None, id=wx.ID_ANY, id2=wx.ID_ANY):
3764 """
3765 Bind an event to an event handler.
3766
db3e571a
RD		 3767 :param event: One of the EVT_* objects that specifies the
3768 type of event to bind,
d14a1e28 3769
db3e571a
RD		 3770 :param handler: A callable object to be invoked when the
3771 event is delivered to self. Pass None to
3772 disconnect an event handler.
d14a1e28 3773
db3e571a
RD		 3774 :param source: Sometimes the event originates from a
3775 different window than self, but you still
3776 want to catch it in self. (For example, a
3777 button event delivered to a frame.) By
3778 passing the source of the event, the event
3779 handling system is able to differentiate
3780 between the same event type from different
3781 controls.
d14a1e28 3782
db3e571a
RD		 3783 :param id: Used to spcify the event source by ID instead
3784 of instance.
3785
3786 :param id2: Used when it is desirable to bind a handler
3787 to a range of IDs, such as with EVT_MENU_RANGE.
d14a1e28
RD		 3788 """
3789 if source is not None:
3790 id = source.GetId()
3791 event.Bind(self, id, id2, handler)
3792
66c033b4
RD		 3793 def Unbind(self, event, source=None, id=wx.ID_ANY, id2=wx.ID_ANY):
3794 """
3795 Disconencts the event handler binding for event from self.
3796 Returns True if successful.
3797 """
3798 if source is not None:
3799 id = source.GetId()
3800 return event.Unbind(self, id, id2)
d14a1e28 3801
97ab0f6a
RD		 3802 EvtHandlerEnabled = property(GetEvtHandlerEnabled,SetEvtHandlerEnabled,doc="See `GetEvtHandlerEnabled` and `SetEvtHandlerEnabled`")
3803 NextHandler = property(GetNextHandler,SetNextHandler,doc="See `GetNextHandler` and `SetNextHandler`")
3804 PreviousHandler = property(GetPreviousHandler,SetPreviousHandler,doc="See `GetPreviousHandler` and `SetPreviousHandler`")
2131d850 3805_core_.EvtHandler_swigregister(EvtHandler)
d14a1e28
RD		 3806
3807#---------------------------------------------------------------------------
3808
3809class PyEventBinder(object):
3810 """
3811 Instances of this class are used to bind specific events to event
3812 handlers.
3813 """
3814 def __init__(self, evtType, expectedIDs=0):
3815 if expectedIDs not in [0, 1, 2]:
3816 raise ValueError, "Invalid number of expectedIDs"
3817 self.expectedIDs = expectedIDs
3818
3819 if type(evtType) == list or type(evtType) == tuple:
3820 self.evtType = evtType
3821 else:
3822 self.evtType = [evtType]
3823
3824
3825 def Bind(self, target, id1, id2, function):
3826 """Bind this set of event types to target."""
3827 for et in self.evtType:
3828 target.Connect(id1, id2, et, function)
3829
66c033b4
RD		 3830
3831 def Unbind(self, target, id1, id2):
3832 """Remove an event binding."""
3833 success = 0
3834 for et in self.evtType:
3835 success += target.Disconnect(id1, id2, et)
3836 return success != 0
3837
d14a1e28
RD		 3838
3839 def __call__(self, *args):
3840 """
3841 For backwards compatibility with the old EVT_* functions.
3842 Should be called with either (window, func), (window, ID,
3843 func) or (window, ID1, ID2, func) parameters depending on the
3844 type of the event.
3845 """
3846 assert len(args) == 2 + self.expectedIDs
3847 id1 = wx.ID_ANY
3848 id2 = wx.ID_ANY
3849 target = args[0]
3850 if self.expectedIDs == 0:
3851 func = args[1]
3852 elif self.expectedIDs == 1:
3853 id1 = args[1]
3854 func = args[2]
3855 elif self.expectedIDs == 2:
3856 id1 = args[1]
3857 id2 = args[2]
3858 func = args[3]
3859 else:
3860 raise ValueError, "Unexpected number of IDs"
3861
3862 self.Bind(target, id1, id2, func)
3863
3864
3865# These two are square pegs that don't fit the PyEventBinder hole...
3866def EVT_COMMAND(win, id, cmd, func):
3867 win.Connect(id, -1, cmd, func)
3868def EVT_COMMAND_RANGE(win, id1, id2, cmd, func):
3869 win.Connect(id1, id2, cmd, func)
3870
3871
3872#---------------------------------------------------------------------------
3873
3874#---------------------------------------------------------------------------
3875
54f9ee45
RD		 3876EVENT_PROPAGATE_NONE = _core_.EVENT_PROPAGATE_NONE
3877EVENT_PROPAGATE_MAX = _core_.EVENT_PROPAGATE_MAX
d14a1e28 3878
0085ce49 3879def NewEventType(*args):
2131d850 3880 """NewEventType() -> EventType"""
0085ce49 3881 return _core_.NewEventType(*args)
54f9ee45
RD		 3882wxEVT_NULL = _core_.wxEVT_NULL
3883wxEVT_FIRST = _core_.wxEVT_FIRST
3884wxEVT_USER_FIRST = _core_.wxEVT_USER_FIRST
3885wxEVT_COMMAND_BUTTON_CLICKED = _core_.wxEVT_COMMAND_BUTTON_CLICKED
3886wxEVT_COMMAND_CHECKBOX_CLICKED = _core_.wxEVT_COMMAND_CHECKBOX_CLICKED
3887wxEVT_COMMAND_CHOICE_SELECTED = _core_.wxEVT_COMMAND_CHOICE_SELECTED
3888wxEVT_COMMAND_LISTBOX_SELECTED = _core_.wxEVT_COMMAND_LISTBOX_SELECTED
3889wxEVT_COMMAND_LISTBOX_DOUBLECLICKED = _core_.wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
3890wxEVT_COMMAND_CHECKLISTBOX_TOGGLED = _core_.wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
3891wxEVT_COMMAND_MENU_SELECTED = _core_.wxEVT_COMMAND_MENU_SELECTED
3892wxEVT_COMMAND_TOOL_CLICKED = _core_.wxEVT_COMMAND_TOOL_CLICKED
3893wxEVT_COMMAND_SLIDER_UPDATED = _core_.wxEVT_COMMAND_SLIDER_UPDATED
3894wxEVT_COMMAND_RADIOBOX_SELECTED = _core_.wxEVT_COMMAND_RADIOBOX_SELECTED
3895wxEVT_COMMAND_RADIOBUTTON_SELECTED = _core_.wxEVT_COMMAND_RADIOBUTTON_SELECTED
3896wxEVT_COMMAND_SCROLLBAR_UPDATED = _core_.wxEVT_COMMAND_SCROLLBAR_UPDATED
3897wxEVT_COMMAND_VLBOX_SELECTED = _core_.wxEVT_COMMAND_VLBOX_SELECTED
3898wxEVT_COMMAND_COMBOBOX_SELECTED = _core_.wxEVT_COMMAND_COMBOBOX_SELECTED
3899wxEVT_COMMAND_TOOL_RCLICKED = _core_.wxEVT_COMMAND_TOOL_RCLICKED
3900wxEVT_COMMAND_TOOL_ENTER = _core_.wxEVT_COMMAND_TOOL_ENTER
3901wxEVT_LEFT_DOWN = _core_.wxEVT_LEFT_DOWN
3902wxEVT_LEFT_UP = _core_.wxEVT_LEFT_UP
3903wxEVT_MIDDLE_DOWN = _core_.wxEVT_MIDDLE_DOWN
3904wxEVT_MIDDLE_UP = _core_.wxEVT_MIDDLE_UP
3905wxEVT_RIGHT_DOWN = _core_.wxEVT_RIGHT_DOWN
3906wxEVT_RIGHT_UP = _core_.wxEVT_RIGHT_UP
3907wxEVT_MOTION = _core_.wxEVT_MOTION
3908wxEVT_ENTER_WINDOW = _core_.wxEVT_ENTER_WINDOW
3909wxEVT_LEAVE_WINDOW = _core_.wxEVT_LEAVE_WINDOW
3910wxEVT_LEFT_DCLICK = _core_.wxEVT_LEFT_DCLICK
3911wxEVT_MIDDLE_DCLICK = _core_.wxEVT_MIDDLE_DCLICK
3912wxEVT_RIGHT_DCLICK = _core_.wxEVT_RIGHT_DCLICK
3913wxEVT_SET_FOCUS = _core_.wxEVT_SET_FOCUS
3914wxEVT_KILL_FOCUS = _core_.wxEVT_KILL_FOCUS
3915wxEVT_CHILD_FOCUS = _core_.wxEVT_CHILD_FOCUS
3916wxEVT_MOUSEWHEEL = _core_.wxEVT_MOUSEWHEEL
3917wxEVT_NC_LEFT_DOWN = _core_.wxEVT_NC_LEFT_DOWN
3918wxEVT_NC_LEFT_UP = _core_.wxEVT_NC_LEFT_UP
3919wxEVT_NC_MIDDLE_DOWN = _core_.wxEVT_NC_MIDDLE_DOWN
3920wxEVT_NC_MIDDLE_UP = _core_.wxEVT_NC_MIDDLE_UP
3921wxEVT_NC_RIGHT_DOWN = _core_.wxEVT_NC_RIGHT_DOWN
3922wxEVT_NC_RIGHT_UP = _core_.wxEVT_NC_RIGHT_UP
3923wxEVT_NC_MOTION = _core_.wxEVT_NC_MOTION
3924wxEVT_NC_ENTER_WINDOW = _core_.wxEVT_NC_ENTER_WINDOW
3925wxEVT_NC_LEAVE_WINDOW = _core_.wxEVT_NC_LEAVE_WINDOW
3926wxEVT_NC_LEFT_DCLICK = _core_.wxEVT_NC_LEFT_DCLICK
3927wxEVT_NC_MIDDLE_DCLICK = _core_.wxEVT_NC_MIDDLE_DCLICK
3928wxEVT_NC_RIGHT_DCLICK = _core_.wxEVT_NC_RIGHT_DCLICK
3929wxEVT_CHAR = _core_.wxEVT_CHAR
3930wxEVT_CHAR_HOOK = _core_.wxEVT_CHAR_HOOK
3931wxEVT_NAVIGATION_KEY = _core_.wxEVT_NAVIGATION_KEY
3932wxEVT_KEY_DOWN = _core_.wxEVT_KEY_DOWN
3933wxEVT_KEY_UP = _core_.wxEVT_KEY_UP
3934wxEVT_HOTKEY = _core_.wxEVT_HOTKEY
3935wxEVT_SET_CURSOR = _core_.wxEVT_SET_CURSOR
3936wxEVT_SCROLL_TOP = _core_.wxEVT_SCROLL_TOP
3937wxEVT_SCROLL_BOTTOM = _core_.wxEVT_SCROLL_BOTTOM
3938wxEVT_SCROLL_LINEUP = _core_.wxEVT_SCROLL_LINEUP
3939wxEVT_SCROLL_LINEDOWN = _core_.wxEVT_SCROLL_LINEDOWN
3940wxEVT_SCROLL_PAGEUP = _core_.wxEVT_SCROLL_PAGEUP
3941wxEVT_SCROLL_PAGEDOWN = _core_.wxEVT_SCROLL_PAGEDOWN
3942wxEVT_SCROLL_THUMBTRACK = _core_.wxEVT_SCROLL_THUMBTRACK
3943wxEVT_SCROLL_THUMBRELEASE = _core_.wxEVT_SCROLL_THUMBRELEASE
4f433fef
RD		 3944wxEVT_SCROLL_CHANGED = _core_.wxEVT_SCROLL_CHANGED
3945wxEVT_SCROLL_ENDSCROLL = wxEVT_SCROLL_CHANGED
54f9ee45
RD		 3946wxEVT_SCROLLWIN_TOP = _core_.wxEVT_SCROLLWIN_TOP
3947wxEVT_SCROLLWIN_BOTTOM = _core_.wxEVT_SCROLLWIN_BOTTOM
3948wxEVT_SCROLLWIN_LINEUP = _core_.wxEVT_SCROLLWIN_LINEUP
3949wxEVT_SCROLLWIN_LINEDOWN = _core_.wxEVT_SCROLLWIN_LINEDOWN
3950wxEVT_SCROLLWIN_PAGEUP = _core_.wxEVT_SCROLLWIN_PAGEUP
3951wxEVT_SCROLLWIN_PAGEDOWN = _core_.wxEVT_SCROLLWIN_PAGEDOWN
3952wxEVT_SCROLLWIN_THUMBTRACK = _core_.wxEVT_SCROLLWIN_THUMBTRACK
3953wxEVT_SCROLLWIN_THUMBRELEASE = _core_.wxEVT_SCROLLWIN_THUMBRELEASE
3954wxEVT_SIZE = _core_.wxEVT_SIZE
3955wxEVT_MOVE = _core_.wxEVT_MOVE
3956wxEVT_CLOSE_WINDOW = _core_.wxEVT_CLOSE_WINDOW
3957wxEVT_END_SESSION = _core_.wxEVT_END_SESSION
3958wxEVT_QUERY_END_SESSION = _core_.wxEVT_QUERY_END_SESSION
3959wxEVT_ACTIVATE_APP = _core_.wxEVT_ACTIVATE_APP
54f9ee45
RD		 3960wxEVT_ACTIVATE = _core_.wxEVT_ACTIVATE
3961wxEVT_CREATE = _core_.wxEVT_CREATE
3962wxEVT_DESTROY = _core_.wxEVT_DESTROY
3963wxEVT_SHOW = _core_.wxEVT_SHOW
3964wxEVT_ICONIZE = _core_.wxEVT_ICONIZE
3965wxEVT_MAXIMIZE = _core_.wxEVT_MAXIMIZE
3966wxEVT_MOUSE_CAPTURE_CHANGED = _core_.wxEVT_MOUSE_CAPTURE_CHANGED
34e0a3bb 3967wxEVT_MOUSE_CAPTURE_LOST = _core_.wxEVT_MOUSE_CAPTURE_LOST
54f9ee45
RD		 3968wxEVT_PAINT = _core_.wxEVT_PAINT
3969wxEVT_ERASE_BACKGROUND = _core_.wxEVT_ERASE_BACKGROUND
3970wxEVT_NC_PAINT = _core_.wxEVT_NC_PAINT
3971wxEVT_PAINT_ICON = _core_.wxEVT_PAINT_ICON
3972wxEVT_MENU_OPEN = _core_.wxEVT_MENU_OPEN
3973wxEVT_MENU_CLOSE = _core_.wxEVT_MENU_CLOSE
3974wxEVT_MENU_HIGHLIGHT = _core_.wxEVT_MENU_HIGHLIGHT
3975wxEVT_CONTEXT_MENU = _core_.wxEVT_CONTEXT_MENU
3976wxEVT_SYS_COLOUR_CHANGED = _core_.wxEVT_SYS_COLOUR_CHANGED
3977wxEVT_DISPLAY_CHANGED = _core_.wxEVT_DISPLAY_CHANGED
3978wxEVT_SETTING_CHANGED = _core_.wxEVT_SETTING_CHANGED
3979wxEVT_QUERY_NEW_PALETTE = _core_.wxEVT_QUERY_NEW_PALETTE
3980wxEVT_PALETTE_CHANGED = _core_.wxEVT_PALETTE_CHANGED
3981wxEVT_DROP_FILES = _core_.wxEVT_DROP_FILES
3982wxEVT_DRAW_ITEM = _core_.wxEVT_DRAW_ITEM
3983wxEVT_MEASURE_ITEM = _core_.wxEVT_MEASURE_ITEM
3984wxEVT_COMPARE_ITEM = _core_.wxEVT_COMPARE_ITEM
3985wxEVT_INIT_DIALOG = _core_.wxEVT_INIT_DIALOG
3986wxEVT_IDLE = _core_.wxEVT_IDLE
3987wxEVT_UPDATE_UI = _core_.wxEVT_UPDATE_UI
3988wxEVT_SIZING = _core_.wxEVT_SIZING
3989wxEVT_MOVING = _core_.wxEVT_MOVING
88c6b281 3990wxEVT_HIBERNATE = _core_.wxEVT_HIBERNATE
2131d850
RD		 3991wxEVT_COMMAND_TEXT_COPY = _core_.wxEVT_COMMAND_TEXT_COPY
3992wxEVT_COMMAND_TEXT_CUT = _core_.wxEVT_COMMAND_TEXT_CUT
3993wxEVT_COMMAND_TEXT_PASTE = _core_.wxEVT_COMMAND_TEXT_PASTE
54f9ee45
RD		 3994wxEVT_COMMAND_LEFT_CLICK = _core_.wxEVT_COMMAND_LEFT_CLICK
3995wxEVT_COMMAND_LEFT_DCLICK = _core_.wxEVT_COMMAND_LEFT_DCLICK
3996wxEVT_COMMAND_RIGHT_CLICK = _core_.wxEVT_COMMAND_RIGHT_CLICK
3997wxEVT_COMMAND_RIGHT_DCLICK = _core_.wxEVT_COMMAND_RIGHT_DCLICK
3998wxEVT_COMMAND_SET_FOCUS = _core_.wxEVT_COMMAND_SET_FOCUS
3999wxEVT_COMMAND_KILL_FOCUS = _core_.wxEVT_COMMAND_KILL_FOCUS
4000wxEVT_COMMAND_ENTER = _core_.wxEVT_COMMAND_ENTER
d14a1e28
RD		 4001#
4002# Create some event binders
4003EVT_SIZE = wx.PyEventBinder( wxEVT_SIZE )
4004EVT_SIZING = wx.PyEventBinder( wxEVT_SIZING )
4005EVT_MOVE = wx.PyEventBinder( wxEVT_MOVE )
4006EVT_MOVING = wx.PyEventBinder( wxEVT_MOVING )
4007EVT_CLOSE = wx.PyEventBinder( wxEVT_CLOSE_WINDOW )
4008EVT_END_SESSION = wx.PyEventBinder( wxEVT_END_SESSION )
4009EVT_QUERY_END_SESSION = wx.PyEventBinder( wxEVT_QUERY_END_SESSION )
4010EVT_PAINT = wx.PyEventBinder( wxEVT_PAINT )
4011EVT_NC_PAINT = wx.PyEventBinder( wxEVT_NC_PAINT )
4012EVT_ERASE_BACKGROUND = wx.PyEventBinder( wxEVT_ERASE_BACKGROUND )
4013EVT_CHAR = wx.PyEventBinder( wxEVT_CHAR )
4014EVT_KEY_DOWN = wx.PyEventBinder( wxEVT_KEY_DOWN )
4015EVT_KEY_UP = wx.PyEventBinder( wxEVT_KEY_UP )
704eda0c 4016EVT_HOTKEY = wx.PyEventBinder( wxEVT_HOTKEY, 1)
d14a1e28
RD		 4017EVT_CHAR_HOOK = wx.PyEventBinder( wxEVT_CHAR_HOOK )
4018EVT_MENU_OPEN = wx.PyEventBinder( wxEVT_MENU_OPEN )
4019EVT_MENU_CLOSE = wx.PyEventBinder( wxEVT_MENU_CLOSE )
4020EVT_MENU_HIGHLIGHT = wx.PyEventBinder( wxEVT_MENU_HIGHLIGHT, 1)
4021EVT_MENU_HIGHLIGHT_ALL = wx.PyEventBinder( wxEVT_MENU_HIGHLIGHT )
4022EVT_SET_FOCUS = wx.PyEventBinder( wxEVT_SET_FOCUS )
4023EVT_KILL_FOCUS = wx.PyEventBinder( wxEVT_KILL_FOCUS )
4024EVT_CHILD_FOCUS = wx.PyEventBinder( wxEVT_CHILD_FOCUS )
4025EVT_ACTIVATE = wx.PyEventBinder( wxEVT_ACTIVATE )
4026EVT_ACTIVATE_APP = wx.PyEventBinder( wxEVT_ACTIVATE_APP )
704eda0c 4027EVT_HIBERNATE = wx.PyEventBinder( wxEVT_HIBERNATE )
d14a1e28
RD		 4028EVT_END_SESSION = wx.PyEventBinder( wxEVT_END_SESSION )
4029EVT_QUERY_END_SESSION = wx.PyEventBinder( wxEVT_QUERY_END_SESSION )
4030EVT_DROP_FILES = wx.PyEventBinder( wxEVT_DROP_FILES )
4031EVT_INIT_DIALOG = wx.PyEventBinder( wxEVT_INIT_DIALOG )
4032EVT_SYS_COLOUR_CHANGED = wx.PyEventBinder( wxEVT_SYS_COLOUR_CHANGED )
4033EVT_DISPLAY_CHANGED = wx.PyEventBinder( wxEVT_DISPLAY_CHANGED )
4034EVT_SHOW = wx.PyEventBinder( wxEVT_SHOW )
4035EVT_MAXIMIZE = wx.PyEventBinder( wxEVT_MAXIMIZE )
4036EVT_ICONIZE = wx.PyEventBinder( wxEVT_ICONIZE )
4037EVT_NAVIGATION_KEY = wx.PyEventBinder( wxEVT_NAVIGATION_KEY )
4038EVT_PALETTE_CHANGED = wx.PyEventBinder( wxEVT_PALETTE_CHANGED )
4039EVT_QUERY_NEW_PALETTE = wx.PyEventBinder( wxEVT_QUERY_NEW_PALETTE )
4040EVT_WINDOW_CREATE = wx.PyEventBinder( wxEVT_CREATE )
4041EVT_WINDOW_DESTROY = wx.PyEventBinder( wxEVT_DESTROY )
4042EVT_SET_CURSOR = wx.PyEventBinder( wxEVT_SET_CURSOR )
4043EVT_MOUSE_CAPTURE_CHANGED = wx.PyEventBinder( wxEVT_MOUSE_CAPTURE_CHANGED )
34e0a3bb 4044EVT_MOUSE_CAPTURE_LOST = wx.PyEventBinder( wxEVT_MOUSE_CAPTURE_LOST )
d14a1e28
RD		 4045
4046EVT_LEFT_DOWN = wx.PyEventBinder( wxEVT_LEFT_DOWN )
4047EVT_LEFT_UP = wx.PyEventBinder( wxEVT_LEFT_UP )
4048EVT_MIDDLE_DOWN = wx.PyEventBinder( wxEVT_MIDDLE_DOWN )
4049EVT_MIDDLE_UP = wx.PyEventBinder( wxEVT_MIDDLE_UP )
4050EVT_RIGHT_DOWN = wx.PyEventBinder( wxEVT_RIGHT_DOWN )
4051EVT_RIGHT_UP = wx.PyEventBinder( wxEVT_RIGHT_UP )
4052EVT_MOTION = wx.PyEventBinder( wxEVT_MOTION )
4053EVT_LEFT_DCLICK = wx.PyEventBinder( wxEVT_LEFT_DCLICK )
4054EVT_MIDDLE_DCLICK = wx.PyEventBinder( wxEVT_MIDDLE_DCLICK )
4055EVT_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_RIGHT_DCLICK )
4056EVT_LEAVE_WINDOW = wx.PyEventBinder( wxEVT_LEAVE_WINDOW )
4057EVT_ENTER_WINDOW = wx.PyEventBinder( wxEVT_ENTER_WINDOW )
4058EVT_MOUSEWHEEL = wx.PyEventBinder( wxEVT_MOUSEWHEEL )
4059
4060EVT_MOUSE_EVENTS = wx.PyEventBinder([ wxEVT_LEFT_DOWN,
4061 wxEVT_LEFT_UP,
4062 wxEVT_MIDDLE_DOWN,
4063 wxEVT_MIDDLE_UP,
4064 wxEVT_RIGHT_DOWN,
4065 wxEVT_RIGHT_UP,
4066 wxEVT_MOTION,
4067 wxEVT_LEFT_DCLICK,
4068 wxEVT_MIDDLE_DCLICK,
4069 wxEVT_RIGHT_DCLICK,
4070 wxEVT_ENTER_WINDOW,
4071 wxEVT_LEAVE_WINDOW,
4072 wxEVT_MOUSEWHEEL
4073 ])
4074
4075
4076# Scrolling from wxWindow (sent to wxScrolledWindow)
704eda0c 4077EVT_SCROLLWIN = wx.PyEventBinder([ wxEVT_SCROLLWIN_TOP,
d14a1e28
RD		 4078 wxEVT_SCROLLWIN_BOTTOM,
4079 wxEVT_SCROLLWIN_LINEUP,
4080 wxEVT_SCROLLWIN_LINEDOWN,
704eda0c 4081 wxEVT_SCROLLWIN_PAGEUP,
d14a1e28
RD		 4082 wxEVT_SCROLLWIN_PAGEDOWN,
4083 wxEVT_SCROLLWIN_THUMBTRACK,
4084 wxEVT_SCROLLWIN_THUMBRELEASE,
4085 ])
4086
4087EVT_SCROLLWIN_TOP = wx.PyEventBinder( wxEVT_SCROLLWIN_TOP )
4088EVT_SCROLLWIN_BOTTOM = wx.PyEventBinder( wxEVT_SCROLLWIN_BOTTOM )
4089EVT_SCROLLWIN_LINEUP = wx.PyEventBinder( wxEVT_SCROLLWIN_LINEUP )
4090EVT_SCROLLWIN_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLLWIN_LINEDOWN )
4091EVT_SCROLLWIN_PAGEUP = wx.PyEventBinder( wxEVT_SCROLLWIN_PAGEUP )
4092EVT_SCROLLWIN_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLLWIN_PAGEDOWN )
4093EVT_SCROLLWIN_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLLWIN_THUMBTRACK )
4094EVT_SCROLLWIN_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLLWIN_THUMBRELEASE )
4095
27fb7603 4096# Scrolling from wx.Slider and wx.ScrollBar
704eda0c
RD		 4097EVT_SCROLL = wx.PyEventBinder([ wxEVT_SCROLL_TOP,
4098 wxEVT_SCROLL_BOTTOM,
4099 wxEVT_SCROLL_LINEUP,
4100 wxEVT_SCROLL_LINEDOWN,
4101 wxEVT_SCROLL_PAGEUP,
4102 wxEVT_SCROLL_PAGEDOWN,
4103 wxEVT_SCROLL_THUMBTRACK,
4104 wxEVT_SCROLL_THUMBRELEASE,
4f433fef 4105 wxEVT_SCROLL_CHANGED,
d14a1e28
RD		 4106 ])
4107
4108EVT_SCROLL_TOP = wx.PyEventBinder( wxEVT_SCROLL_TOP )
4109EVT_SCROLL_BOTTOM = wx.PyEventBinder( wxEVT_SCROLL_BOTTOM )
4110EVT_SCROLL_LINEUP = wx.PyEventBinder( wxEVT_SCROLL_LINEUP )
4111EVT_SCROLL_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLL_LINEDOWN )
4112EVT_SCROLL_PAGEUP = wx.PyEventBinder( wxEVT_SCROLL_PAGEUP )
4113EVT_SCROLL_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLL_PAGEDOWN )
4114EVT_SCROLL_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLL_THUMBTRACK )
4115EVT_SCROLL_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE )
4f433fef
RD		 4116EVT_SCROLL_CHANGED = wx.PyEventBinder( wxEVT_SCROLL_CHANGED )
4117EVT_SCROLL_ENDSCROLL = EVT_SCROLL_CHANGED
704eda0c 4118
27fb7603 4119# Scrolling from wx.Slider and wx.ScrollBar, with an id
704eda0c
RD		 4120EVT_COMMAND_SCROLL = wx.PyEventBinder([ wxEVT_SCROLL_TOP,
4121 wxEVT_SCROLL_BOTTOM,
4122 wxEVT_SCROLL_LINEUP,
4123 wxEVT_SCROLL_LINEDOWN,
4124 wxEVT_SCROLL_PAGEUP,
4125 wxEVT_SCROLL_PAGEDOWN,
4126 wxEVT_SCROLL_THUMBTRACK,
d14a1e28 4127 wxEVT_SCROLL_THUMBRELEASE,
4f433fef 4128 wxEVT_SCROLL_CHANGED,
d14a1e28
RD		 4129 ], 1)
4130
4131EVT_COMMAND_SCROLL_TOP = wx.PyEventBinder( wxEVT_SCROLL_TOP, 1)
4132EVT_COMMAND_SCROLL_BOTTOM = wx.PyEventBinder( wxEVT_SCROLL_BOTTOM, 1)
4133EVT_COMMAND_SCROLL_LINEUP = wx.PyEventBinder( wxEVT_SCROLL_LINEUP, 1)
4134EVT_COMMAND_SCROLL_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLL_LINEDOWN, 1)
4135EVT_COMMAND_SCROLL_PAGEUP = wx.PyEventBinder( wxEVT_SCROLL_PAGEUP, 1)
4136EVT_COMMAND_SCROLL_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLL_PAGEDOWN, 1)
4137EVT_COMMAND_SCROLL_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLL_THUMBTRACK, 1)
4138EVT_COMMAND_SCROLL_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE, 1)
4f433fef
RD		 4139EVT_COMMAND_SCROLL_CHANGED = wx.PyEventBinder( wxEVT_SCROLL_CHANGED, 1)
4140EVT_COMMAND_SCROLL_ENDSCROLL = EVT_COMMAND_SCROLL_CHANGED
d14a1e28 4141
d14a1e28
RD		 4142EVT_BUTTON = wx.PyEventBinder( wxEVT_COMMAND_BUTTON_CLICKED, 1)
4143EVT_CHECKBOX = wx.PyEventBinder( wxEVT_COMMAND_CHECKBOX_CLICKED, 1)
4144EVT_CHOICE = wx.PyEventBinder( wxEVT_COMMAND_CHOICE_SELECTED, 1)
4145EVT_LISTBOX = wx.PyEventBinder( wxEVT_COMMAND_LISTBOX_SELECTED, 1)
4146EVT_LISTBOX_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, 1)
4147EVT_MENU = wx.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED, 1)
4148EVT_MENU_RANGE = wx.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED, 2)
4149EVT_SLIDER = wx.PyEventBinder( wxEVT_COMMAND_SLIDER_UPDATED, 1)
4150EVT_RADIOBOX = wx.PyEventBinder( wxEVT_COMMAND_RADIOBOX_SELECTED, 1)
4151EVT_RADIOBUTTON = wx.PyEventBinder( wxEVT_COMMAND_RADIOBUTTON_SELECTED, 1)
4152
4153EVT_SCROLLBAR = wx.PyEventBinder( wxEVT_COMMAND_SCROLLBAR_UPDATED, 1)
4154EVT_VLBOX = wx.PyEventBinder( wxEVT_COMMAND_VLBOX_SELECTED, 1)
4155EVT_COMBOBOX = wx.PyEventBinder( wxEVT_COMMAND_COMBOBOX_SELECTED, 1)
4156EVT_TOOL = wx.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED, 1)
4157EVT_TOOL_RANGE = wx.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED, 2)
4158EVT_TOOL_RCLICKED = wx.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED, 1)
4159EVT_TOOL_RCLICKED_RANGE = wx.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED, 2)
4160EVT_TOOL_ENTER = wx.PyEventBinder( wxEVT_COMMAND_TOOL_ENTER, 1)
4161EVT_CHECKLISTBOX = wx.PyEventBinder( wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, 1)
4162
4163
4164EVT_COMMAND_LEFT_CLICK = wx.PyEventBinder( wxEVT_COMMAND_LEFT_CLICK, 1)
4165EVT_COMMAND_LEFT_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_LEFT_DCLICK, 1)
4166EVT_COMMAND_RIGHT_CLICK = wx.PyEventBinder( wxEVT_COMMAND_RIGHT_CLICK, 1)
4167EVT_COMMAND_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_RIGHT_DCLICK, 1)
4168EVT_COMMAND_SET_FOCUS = wx.PyEventBinder( wxEVT_COMMAND_SET_FOCUS, 1)
4169EVT_COMMAND_KILL_FOCUS = wx.PyEventBinder( wxEVT_COMMAND_KILL_FOCUS, 1)
4170EVT_COMMAND_ENTER = wx.PyEventBinder( wxEVT_COMMAND_ENTER, 1)
4171
4172EVT_IDLE = wx.PyEventBinder( wxEVT_IDLE )
4173
4174EVT_UPDATE_UI = wx.PyEventBinder( wxEVT_UPDATE_UI, 1)
4175EVT_UPDATE_UI_RANGE = wx.PyEventBinder( wxEVT_UPDATE_UI, 2)
4176
4177EVT_CONTEXT_MENU = wx.PyEventBinder( wxEVT_CONTEXT_MENU )
4178
2131d850
RD		 4179EVT_TEXT_CUT = wx.PyEventBinder( wxEVT_COMMAND_TEXT_CUT )
4180EVT_TEXT_COPY = wx.PyEventBinder( wxEVT_COMMAND_TEXT_COPY )
4181EVT_TEXT_PASTE = wx.PyEventBinder( wxEVT_COMMAND_TEXT_PASTE )
d14a1e28
RD		 4182
4183
4184#---------------------------------------------------------------------------
4185
4186class Event(Object):
27fb7603
RD		 4187 """
4188 An event is a structure holding information about an event passed to a
4189 callback or member function. wx.Event is an abstract base class for
4190 other event classes
4191 """
0085ce49
RD		 4192 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4193 def __init__(self): raise AttributeError, "No constructor defined"
4194 __repr__ = _swig_repr
4195 __swig_destroy__ = _core_.delete_Event
4196 __del__ = lambda self : None;
e811c8ce 4197 def SetEventType(*args, **kwargs):
27fb7603 4198 """
2131d850 4199 SetEventType(self, EventType typ)
27fb7603
RD		 4200
4201 Sets the specific type of the event.
4202 """
54f9ee45 4203 return _core_.Event_SetEventType(*args, **kwargs)
e811c8ce
RD		 4204
4205 def GetEventType(*args, **kwargs):
27fb7603 4206 """
2131d850 4207 GetEventType(self) -> EventType
27fb7603
RD		 4208
4209 Returns the identifier of the given event type, such as
4210 ``wxEVT_COMMAND_BUTTON_CLICKED``.
4211 """
54f9ee45 4212 return _core_.Event_GetEventType(*args, **kwargs)
e811c8ce
RD		 4213
4214 def GetEventObject(*args, **kwargs):
27fb7603
RD		 4215 """
4216 GetEventObject(self) -> Object
4217
4218 Returns the object (usually a window) associated with the event, if
4219 any.
4220 """
54f9ee45 4221 return _core_.Event_GetEventObject(*args, **kwargs)
e811c8ce
RD		 4222
4223 def SetEventObject(*args, **kwargs):
27fb7603
RD		 4224 """
4225 SetEventObject(self, Object obj)
4226
4227 Sets the originating object, or in other words, obj is normally the
4228 object that is sending the event.
4229 """
54f9ee45 4230 return _core_.Event_SetEventObject(*args, **kwargs)
e811c8ce
RD		 4231
4232 def GetTimestamp(*args, **kwargs):
a95a7133 4233 """GetTimestamp(self) -> long"""
54f9ee45 4234 return _core_.Event_GetTimestamp(*args, **kwargs)
e811c8ce
RD		 4235
4236 def SetTimestamp(*args, **kwargs):
a95a7133 4237 """SetTimestamp(self, long ts=0)"""
54f9ee45 4238 return _core_.Event_SetTimestamp(*args, **kwargs)
e811c8ce
RD		 4239
4240 def GetId(*args, **kwargs):
27fb7603
RD		 4241 """
4242 GetId(self) -> int
4243
4244 Returns the identifier associated with this event, such as a button
4245 command id.
4246 """
54f9ee45 4247 return _core_.Event_GetId(*args, **kwargs)
e811c8ce
RD		 4248
4249 def SetId(*args, **kwargs):
27fb7603
RD		 4250 """
4251 SetId(self, int Id)
4252
4253 Set's the ID for the event. This is usually the ID of the window that
4254 is sending the event, but it can also be a command id from a menu
4255 item, etc.
4256 """
54f9ee45 4257 return _core_.Event_SetId(*args, **kwargs)
e811c8ce
RD		 4258
4259 def IsCommandEvent(*args, **kwargs):
27fb7603
RD		 4260 """
4261 IsCommandEvent(self) -> bool
4262
4263 Returns true if the event is or is derived from `wx.CommandEvent` else
4264 it returns false. Note: Exists only for optimization purposes.
4265 """
54f9ee45 4266 return _core_.Event_IsCommandEvent(*args, **kwargs)
e811c8ce
RD		 4267
4268 def Skip(*args, **kwargs):
51b83b37
RD		 4269 """
4270 Skip(self, bool skip=True)
4271
6b449b19
RD		 4272 This method can be used inside an event handler to control whether
4273 further event handlers bound to this event will be called after the
4274 current one returns. Without Skip() (or equivalently if Skip(False) is
4275 used), the event will not be processed any more. If Skip(True) is
4276 called, the event processing system continues searching for a further
4277 handler function for this event, even though it has been processed
4278 already in the current handler.
51b83b37 4279 """
54f9ee45 4280 return _core_.Event_Skip(*args, **kwargs)
e811c8ce
RD		 4281
4282 def GetSkipped(*args, **kwargs):
27fb7603
RD		 4283 """
4284 GetSkipped(self) -> bool
4285
4286 Returns true if the event handler should be skipped, false otherwise.
4287 :see: `Skip`
4288 """
54f9ee45 4289 return _core_.Event_GetSkipped(*args, **kwargs)
e811c8ce
RD		 4290
4291 def ShouldPropagate(*args, **kwargs):
27fb7603
RD		 4292 """
4293 ShouldPropagate(self) -> bool
4294
4295 Test if this event should be propagated to the parent window or not,
4296 i.e. if the propagation level is currently greater than 0.
4297 """
54f9ee45 4298 return _core_.Event_ShouldPropagate(*args, **kwargs)
e811c8ce
RD		 4299
4300 def StopPropagation(*args, **kwargs):
27fb7603
RD		 4301 """
4302 StopPropagation(self) -> int
4303
4304 Stop the event from propagating to its parent window. Returns the old
4305 propagation level value which may be later passed to
4306 `ResumePropagation` to allow propagating the event again.
4307 """
54f9ee45 4308 return _core_.Event_StopPropagation(*args, **kwargs)
e811c8ce
RD		 4309
4310 def ResumePropagation(*args, **kwargs):
27fb7603
RD		 4311 """
4312 ResumePropagation(self, int propagationLevel)
4313
4314 Resume the event propagation by restoring the propagation level. (For
4315 example, you can use the value returned by an earlier call to
4316 `StopPropagation`.)
4317
4318 """
54f9ee45 4319 return _core_.Event_ResumePropagation(*args, **kwargs)
e811c8ce
RD		 4320
4321 def Clone(*args, **kwargs):
a95a7133 4322 """Clone(self) -> Event"""
54f9ee45 4323 return _core_.Event_Clone(*args, **kwargs)
e811c8ce 4324
97ab0f6a
RD		 4325 EventObject = property(GetEventObject,SetEventObject,doc="See `GetEventObject` and `SetEventObject`")
4326 EventType = property(GetEventType,SetEventType,doc="See `GetEventType` and `SetEventType`")
4327 Id = property(GetId,SetId,doc="See `GetId` and `SetId`")
4328 Skipped = property(GetSkipped,doc="See `GetSkipped`")
4329 Timestamp = property(GetTimestamp,SetTimestamp,doc="See `GetTimestamp` and `SetTimestamp`")
2131d850 4330_core_.Event_swigregister(Event)
d14a1e28
RD		 4331
4332#---------------------------------------------------------------------------
4333
4334class PropagationDisabler(object):
27fb7603
RD		 4335 """
4336 Helper class to temporarily change an event not to propagate. Simply
4337 create an instance of this class and then whe it is destroyed the
4338 propogation of the event will be restored.
4339 """
0085ce49
RD		 4340 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4341 __repr__ = _swig_repr
4342 def __init__(self, *args, **kwargs):
27fb7603
RD		 4343 """
4344 __init__(self, Event event) -> PropagationDisabler
4345
4346 Helper class to temporarily change an event not to propagate. Simply
4347 create an instance of this class and then whe it is destroyed the
4348 propogation of the event will be restored.
4349 """
0085ce49
RD		 4350 _core_.PropagationDisabler_swiginit(self,_core_.new_PropagationDisabler(*args, **kwargs))
4351 __swig_destroy__ = _core_.delete_PropagationDisabler
4352 __del__ = lambda self : None;
2131d850 4353_core_.PropagationDisabler_swigregister(PropagationDisabler)
d14a1e28
RD		 4354
4355class PropagateOnce(object):
27fb7603
RD		 4356 """
4357 A helper class that will temporarily lower propagation level of an
4358 event. Simply create an instance of this class and then whe it is
4359 destroyed the propogation of the event will be restored.
4360 """
0085ce49
RD		 4361 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4362 __repr__ = _swig_repr
4363 def __init__(self, *args, **kwargs):
27fb7603
RD		 4364 """
4365 __init__(self, Event event) -> PropagateOnce
4366
4367 A helper class that will temporarily lower propagation level of an
4368 event. Simply create an instance of this class and then whe it is
4369 destroyed the propogation of the event will be restored.
4370 """
0085ce49
RD		 4371 _core_.PropagateOnce_swiginit(self,_core_.new_PropagateOnce(*args, **kwargs))
4372 __swig_destroy__ = _core_.delete_PropagateOnce
4373 __del__ = lambda self : None;
2131d850 4374_core_.PropagateOnce_swigregister(PropagateOnce)
d14a1e28
RD		 4375
4376#---------------------------------------------------------------------------
4377
4378class CommandEvent(Event):
27fb7603
RD		 4379 """
4380 This event class contains information about command events, which
4381 originate from a variety of simple controls, as well as menus and
4382 toolbars.
4383 """
0085ce49
RD		 4384 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4385 __repr__ = _swig_repr
4386 def __init__(self, *args, **kwargs):
27fb7603 4387 """
2131d850 4388 __init__(self, EventType commandType=wxEVT_NULL, int winid=0) -> CommandEvent
27fb7603
RD		 4389
4390 This event class contains information about command events, which
4391 originate from a variety of simple controls, as well as menus and
4392 toolbars.
4393 """
0085ce49 4394 _core_.CommandEvent_swiginit(self,_core_.new_CommandEvent(*args, **kwargs))
e811c8ce 4395 def GetSelection(*args, **kwargs):
27fb7603
RD		 4396 """
4397 GetSelection(self) -> int
4398
4399 Returns item index for a listbox or choice selection event (not valid
4400 for a deselection).
4401 """
54f9ee45 4402 return _core_.CommandEvent_GetSelection(*args, **kwargs)
e811c8ce
RD		 4403
4404 def SetString(*args, **kwargs):
a95a7133 4405 """SetString(self, String s)"""
54f9ee45 4406 return _core_.CommandEvent_SetString(*args, **kwargs)
e811c8ce
RD		 4407
4408 def GetString(*args, **kwargs):
27fb7603
RD		 4409 """
4410 GetString(self) -> String
4411
4412 Returns item string for a listbox or choice selection event (not valid
4413 for a deselection).
4414 """
54f9ee45 4415 return _core_.CommandEvent_GetString(*args, **kwargs)
e811c8ce
RD		 4416
4417 def IsChecked(*args, **kwargs):
27fb7603
RD		 4418 """
4419 IsChecked(self) -> bool
4420
4421 This method can be used with checkbox and menu events: for the
4422 checkboxes, the method returns true for a selection event and false
4423 for a deselection one. For the menu events, this method indicates if
4424 the menu item just has become checked or unchecked (and thus only
4425 makes sense for checkable menu items).
4426 """
54f9ee45 4427 return _core_.CommandEvent_IsChecked(*args, **kwargs)
e811c8ce 4428
242b7b46 4429 Checked = IsChecked
e811c8ce 4430 def IsSelection(*args, **kwargs):
27fb7603
RD		 4431 """
4432 IsSelection(self) -> bool
4433
4434 For a listbox or similar event, returns true if it is a selection,
4435 false if it is a deselection.
4436 """
54f9ee45 4437 return _core_.CommandEvent_IsSelection(*args, **kwargs)
e811c8ce
RD		 4438
4439 def SetExtraLong(*args, **kwargs):
a95a7133 4440 """SetExtraLong(self, long extraLong)"""
54f9ee45 4441 return _core_.CommandEvent_SetExtraLong(*args, **kwargs)
e811c8ce
RD		 4442
4443 def GetExtraLong(*args, **kwargs):
27fb7603
RD		 4444 """
4445 GetExtraLong(self) -> long
4446
5ba5649b
RD		 4447 Returns extra information dependant on the event objects type. If the
4448 event comes from a listbox selection, it is a boolean determining
4449 whether the event was a selection (true) or a deselection (false). A
4450 listbox deselection only occurs for multiple-selection boxes, and in
4451 this case the index and string values are indeterminate and the
4452 listbox must be examined by the application.
27fb7603 4453 """
54f9ee45 4454 return _core_.CommandEvent_GetExtraLong(*args, **kwargs)
e811c8ce
RD		 4455
4456 def SetInt(*args, **kwargs):
a95a7133 4457 """SetInt(self, int i)"""
54f9ee45 4458 return _core_.CommandEvent_SetInt(*args, **kwargs)
e811c8ce
RD		 4459
4460 def GetInt(*args, **kwargs):
27fb7603 4461 """
01f6b6d3 4462 GetInt(self) -> int
27fb7603 4463
5ba5649b
RD		 4464 Returns the integer identifier corresponding to a listbox, choice or
4465 radiobox selection (only if the event was a selection, not a
4466 deselection), or a boolean value representing the value of a checkbox.
27fb7603 4467 """
54f9ee45 4468 return _core_.CommandEvent_GetInt(*args, **kwargs)
e811c8ce 4469
0085ce49
RD		 4470 def GetClientData(*args, **kwargs):
4471 """
4472 GetClientData(self) -> PyObject
4473
4474 Returns the client data object for a listbox or choice selection event, (if any.)
4475 """
4476 return _core_.CommandEvent_GetClientData(*args, **kwargs)
4477
4478 def SetClientData(*args, **kwargs):
4479 """
4480 SetClientData(self, PyObject clientData)
4481
4482 Associate the given client data with the item at position n.
4483 """
4484 return _core_.CommandEvent_SetClientData(*args, **kwargs)
4485
4486 GetClientObject = GetClientData
4487 SetClientObject = SetClientData
4488
e811c8ce 4489 def Clone(*args, **kwargs):
a95a7133 4490 """Clone(self) -> Event"""
54f9ee45 4491 return _core_.CommandEvent_Clone(*args, **kwargs)
e811c8ce 4492
2bf58437
RD		 4493 ClientData = property(GetClientData,SetClientData,doc="See `GetClientData` and `SetClientData`")
4494 ClientObject = property(GetClientObject,SetClientObject,doc="See `GetClientObject` and `SetClientObject`")
4495 ExtraLong = property(GetExtraLong,SetExtraLong,doc="See `GetExtraLong` and `SetExtraLong`")
4496 Int = property(GetInt,SetInt,doc="See `GetInt` and `SetInt`")
4497 Selection = property(GetSelection,doc="See `GetSelection`")
4498 String = property(GetString,SetString,doc="See `GetString` and `SetString`")
2131d850 4499_core_.CommandEvent_swigregister(CommandEvent)
d14a1e28
RD		 4500
4501#---------------------------------------------------------------------------
4502
4503class NotifyEvent(CommandEvent):
27fb7603
RD		 4504 """
4505 An instance of this class (or one of its derived classes) is sent from
4506 a control when the control's state is being changed and the control
4507 allows that change to be prevented from happening. The event handler
4508 can call `Veto` or `Allow` to tell the control what to do.
4509 """
0085ce49
RD		 4510 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4511 __repr__ = _swig_repr
4512 def __init__(self, *args, **kwargs):
27fb7603 4513 """
2131d850 4514 __init__(self, EventType commandType=wxEVT_NULL, int winid=0) -> NotifyEvent
27fb7603
RD		 4515
4516 An instance of this class (or one of its derived classes) is sent from
4517 a control when the control's state is being changed and the control
4518 allows that change to be prevented from happening. The event handler
4519 can call `Veto` or `Allow` to tell the control what to do.
4520 """
0085ce49 4521 _core_.NotifyEvent_swiginit(self,_core_.new_NotifyEvent(*args, **kwargs))
e811c8ce 4522 def Veto(*args, **kwargs):
27fb7603
RD		 4523 """
4524 Veto(self)
4525
4526 Prevents the change announced by this event from happening.
4527
4528 It is in general a good idea to notify the user about the reasons for
4529 vetoing the change because otherwise the applications behaviour (which
4530 just refuses to do what the user wants) might be quite surprising.
4531 """
54f9ee45 4532 return _core_.NotifyEvent_Veto(*args, **kwargs)
e811c8ce
RD		 4533
4534 def Allow(*args, **kwargs):
27fb7603
RD		 4535 """
4536 Allow(self)
4537
4538 This is the opposite of `Veto`: it explicitly allows the event to be
4539 processed. For most events it is not necessary to call this method as
4540 the events are allowed anyhow but some are forbidden by default (this
4541 will be mentioned in the corresponding event description).
4542 """
54f9ee45 4543 return _core_.NotifyEvent_Allow(*args, **kwargs)
e811c8ce
RD		 4544
4545 def IsAllowed(*args, **kwargs):
27fb7603
RD		 4546 """
4547 IsAllowed(self) -> bool
4548
4549 Returns true if the change is allowed (`Veto` hasn't been called) or
4550 false otherwise (if it was).
4551 """
54f9ee45 4552 return _core_.NotifyEvent_IsAllowed(*args, **kwargs)
e811c8ce 4553
2131d850 4554_core_.NotifyEvent_swigregister(NotifyEvent)
d14a1e28
RD		 4555
4556#---------------------------------------------------------------------------
4557
4558class ScrollEvent(CommandEvent):
27fb7603
RD		 4559 """
4560 A scroll event holds information about events sent from stand-alone
4561 scrollbars and sliders. Note that scrolled windows do not send
4562 instnaces of this event class, but send the `wx.ScrollWinEvent`
4563 instead.
4564 """
0085ce49
RD		 4565 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4566 __repr__ = _swig_repr
4567 def __init__(self, *args, **kwargs):
0df68c9f 4568 """
2131d850 4569 __init__(self, EventType commandType=wxEVT_NULL, int winid=0, int pos=0,
0df68c9f
RD		 4570 int orient=0) -> ScrollEvent
4571 """
0085ce49 4572 _core_.ScrollEvent_swiginit(self,_core_.new_ScrollEvent(*args, **kwargs))
e811c8ce 4573 def GetOrientation(*args, **kwargs):
27fb7603
RD		 4574 """
4575 GetOrientation(self) -> int
4576
4577 Returns wx.HORIZONTAL or wx.VERTICAL, depending on the orientation of
4578 the scrollbar.
4579 """
54f9ee45 4580 return _core_.ScrollEvent_GetOrientation(*args, **kwargs)
e811c8ce
RD		 4581
4582 def GetPosition(*args, **kwargs):
27fb7603
RD		 4583 """
4584 GetPosition(self) -> int
4585
4586 Returns the position of the scrollbar.
4587 """
54f9ee45 4588 return _core_.ScrollEvent_GetPosition(*args, **kwargs)
e811c8ce
RD		 4589
4590 def SetOrientation(*args, **kwargs):
a95a7133 4591 """SetOrientation(self, int orient)"""
54f9ee45 4592 return _core_.ScrollEvent_SetOrientation(*args, **kwargs)
e811c8ce
RD		 4593
4594 def SetPosition(*args, **kwargs):
a95a7133 4595 """SetPosition(self, int pos)"""
54f9ee45 4596 return _core_.ScrollEvent_SetPosition(*args, **kwargs)
e811c8ce 4597
33d6fd3b
RD		 4598 Orientation = property(GetOrientation,SetOrientation,doc="See `GetOrientation` and `SetOrientation`")
4599 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
2131d850 4600_core_.ScrollEvent_swigregister(ScrollEvent)
d14a1e28
RD		 4601
4602#---------------------------------------------------------------------------
4603
4604class ScrollWinEvent(Event):
27fb7603
RD		 4605 """
4606 A wx.ScrollWinEvent holds information about scrolling and is sent from
4607 scrolling windows.
4608 """
0085ce49
RD		 4609 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4610 __repr__ = _swig_repr
4611 def __init__(self, *args, **kwargs):
27fb7603 4612 """
2131d850 4613 __init__(self, EventType commandType=wxEVT_NULL, int pos=0, int orient=0) -> ScrollWinEvent
27fb7603
RD		 4614
4615 A wx.ScrollWinEvent holds information about scrolling and is sent from
4616 scrolling windows.
4617 """
0085ce49 4618 _core_.ScrollWinEvent_swiginit(self,_core_.new_ScrollWinEvent(*args, **kwargs))
e811c8ce 4619 def GetOrientation(*args, **kwargs):
27fb7603
RD		 4620 """
4621 GetOrientation(self) -> int
4622
4623 Returns wx.HORIZONTAL or wx.VERTICAL, depending on the orientation of
4624 the scrollbar.
4625 """
54f9ee45 4626 return _core_.ScrollWinEvent_GetOrientation(*args, **kwargs)
e811c8ce
RD		 4627
4628 def GetPosition(*args, **kwargs):
27fb7603
RD		 4629 """
4630 GetPosition(self) -> int
4631
4632 Returns the position of the scrollbar for the thumb track and release
4633 events. Note that this field can't be used for the other events, you
4634 need to query the window itself for the current position in that case.
4635 """
54f9ee45 4636 return _core_.ScrollWinEvent_GetPosition(*args, **kwargs)
e811c8ce
RD		 4637
4638 def SetOrientation(*args, **kwargs):
a95a7133 4639 """SetOrientation(self, int orient)"""
54f9ee45 4640 return _core_.ScrollWinEvent_SetOrientation(*args, **kwargs)
e811c8ce
RD		 4641
4642 def SetPosition(*args, **kwargs):
a95a7133 4643 """SetPosition(self, int pos)"""
54f9ee45 4644 return _core_.ScrollWinEvent_SetPosition(*args, **kwargs)
e811c8ce 4645
33d6fd3b
RD		 4646 Orientation = property(GetOrientation,SetOrientation,doc="See `GetOrientation` and `SetOrientation`")
4647 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
2131d850 4648_core_.ScrollWinEvent_swigregister(ScrollWinEvent)
d14a1e28
RD		 4649
4650#---------------------------------------------------------------------------
4651
54f9ee45
RD		 4652MOUSE_BTN_ANY = _core_.MOUSE_BTN_ANY
4653MOUSE_BTN_NONE = _core_.MOUSE_BTN_NONE
4654MOUSE_BTN_LEFT = _core_.MOUSE_BTN_LEFT
4655MOUSE_BTN_MIDDLE = _core_.MOUSE_BTN_MIDDLE
4656MOUSE_BTN_RIGHT = _core_.MOUSE_BTN_RIGHT
d14a1e28 4657class MouseEvent(Event):
27fb7603
RD		 4658 """
4659 This event class contains information about the events generated by
4660 the mouse: they include mouse buttons press and release events and
4661 mouse move events.
4662
4663 All mouse events involving the buttons use ``wx.MOUSE_BTN_LEFT`` for
4664 the left mouse button, ``wx.MOUSE_BTN_MIDDLE`` for the middle one and
4665 ``wx.MOUSE_BTN_RIGHT`` for the right one. Note that not all mice have
4666 a middle button so a portable application should avoid relying on the
4667 events from it.
4668
4669 Note the difference between methods like `LeftDown` and `LeftIsDown`:
4670 the former returns true when the event corresponds to the left mouse
4671 button click while the latter returns true if the left mouse button is
4672 currently being pressed. For example, when the user is dragging the
4673 mouse you can use `LeftIsDown` to test whether the left mouse button
4674 is (still) depressed. Also, by convention, if `LeftDown` returns true,
4675 `LeftIsDown` will also return true in wxWidgets whatever the
4676 underlying GUI behaviour is (which is platform-dependent). The same
4677 applies, of course, to other mouse buttons as well.
4678 """
0085ce49
RD		 4679 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4680 __repr__ = _swig_repr
4681 def __init__(self, *args, **kwargs):
27fb7603 4682 """
2131d850 4683 __init__(self, EventType mouseType=wxEVT_NULL) -> MouseEvent
27fb7603
RD		 4684
4685 Constructs a wx.MouseEvent. Valid event types are:
4686
4687 * wxEVT_ENTER_WINDOW
4688 * wxEVT_LEAVE_WINDOW
4689 * wxEVT_LEFT_DOWN
4690 * wxEVT_LEFT_UP
4691 * wxEVT_LEFT_DCLICK
4692 * wxEVT_MIDDLE_DOWN
4693 * wxEVT_MIDDLE_UP
4694 * wxEVT_MIDDLE_DCLICK
4695 * wxEVT_RIGHT_DOWN
4696 * wxEVT_RIGHT_UP
4697 * wxEVT_RIGHT_DCLICK
4698 * wxEVT_MOTION
4699 * wxEVT_MOUSEWHEEL
4700 """
0085ce49 4701 _core_.MouseEvent_swiginit(self,_core_.new_MouseEvent(*args, **kwargs))
e811c8ce 4702 def IsButton(*args, **kwargs):
27fb7603
RD		 4703 """
4704 IsButton(self) -> bool
4705
4706 Returns true if the event was a mouse button event (not necessarily a
4707 button down event - that may be tested using `ButtonDown`).
4708 """
54f9ee45 4709 return _core_.MouseEvent_IsButton(*args, **kwargs)
e811c8ce
RD		 4710
4711 def ButtonDown(*args, **kwargs):
27fb7603
RD		 4712 """
4713 ButtonDown(self, int but=MOUSE_BTN_ANY) -> bool
4714
5ba5649b
RD		 4715 If the argument is omitted, this returns true if the event was any
4716 mouse button down event. Otherwise the argument specifies which
4717 button-down event shold be checked for (see `Button` for the possible
4718 values).
27fb7603 4719 """
54f9ee45 4720 return _core_.MouseEvent_ButtonDown(*args, **kwargs)
e811c8ce
RD		 4721
4722 def ButtonDClick(*args, **kwargs):
27fb7603
RD		 4723 """
4724 ButtonDClick(self, int but=MOUSE_BTN_ANY) -> bool
4725
4726 If the argument is omitted, this returns true if the event was any
4727 mouse double click event. Otherwise the argument specifies which
4728 double click event to check for (see `Button` for the possible
4729 values).
4730 """
54f9ee45 4731 return _core_.MouseEvent_ButtonDClick(*args, **kwargs)
e811c8ce
RD		 4732
4733 def ButtonUp(*args, **kwargs):
27fb7603
RD		 4734 """
4735 ButtonUp(self, int but=MOUSE_BTN_ANY) -> bool
4736
4737 If the argument is omitted, this returns true if the event was any
5ba5649b
RD		 4738 mouse button up event. Otherwise the argument specifies which button
4739 up event to check for (see `Button` for the possible values).
27fb7603 4740 """
54f9ee45 4741 return _core_.MouseEvent_ButtonUp(*args, **kwargs)
e811c8ce
RD		 4742
4743 def Button(*args, **kwargs):
27fb7603
RD		 4744 """
4745 Button(self, int button) -> bool
4746
4747 Returns true if the identified mouse button is changing state. Valid
4748 values of button are:
4749
4750 ==================== =====================================
4751 wx.MOUSE_BTN_LEFT check if left button was pressed
4752 wx.MOUSE_BTN_MIDDLE check if middle button was pressed
4753 wx.MOUSE_BTN_RIGHT check if right button was pressed
4754 wx.MOUSE_BTN_ANY check if any button was pressed
4755 ==================== =====================================
4756
4757 """
54f9ee45 4758 return _core_.MouseEvent_Button(*args, **kwargs)
e811c8ce
RD		 4759
4760 def ButtonIsDown(*args, **kwargs):
a95a7133 4761 """ButtonIsDown(self, int but) -> bool"""
54f9ee45 4762 return _core_.MouseEvent_ButtonIsDown(*args, **kwargs)
e811c8ce
RD		 4763
4764 def GetButton(*args, **kwargs):
27fb7603
RD		 4765 """
4766 GetButton(self) -> int
4767
4768 Returns the mouse button which generated this event or
4769 wx.MOUSE_BTN_NONE if no button is involved (for mouse move, enter or
4770 leave event, for example). Otherwise wx.MOUSE_BTN_LEFT is returned for
4771 the left button down, up and double click events, wx.MOUSE_BTN_MIDDLE
4772 and wx.MOUSE_BTN_RIGHT for the same events for the middle and the
4773 right buttons respectively.
4774 """
54f9ee45 4775 return _core_.MouseEvent_GetButton(*args, **kwargs)
e811c8ce
RD		 4776
4777 def ControlDown(*args, **kwargs):
27fb7603
RD		 4778 """
4779 ControlDown(self) -> bool
4780
4781 Returns true if the control key was down at the time of the event.
4782 """
54f9ee45 4783 return _core_.MouseEvent_ControlDown(*args, **kwargs)
e811c8ce
RD		 4784
4785 def MetaDown(*args, **kwargs):
27fb7603
RD		 4786 """
4787 MetaDown(self) -> bool
4788
4789 Returns true if the Meta key was down at the time of the event.
4790 """
54f9ee45 4791 return _core_.MouseEvent_MetaDown(*args, **kwargs)
e811c8ce
RD		 4792
4793 def AltDown(*args, **kwargs):
27fb7603
RD		 4794 """
4795 AltDown(self) -> bool
4796
4797 Returns true if the Alt key was down at the time of the event.
4798 """
54f9ee45 4799 return _core_.MouseEvent_AltDown(*args, **kwargs)
e811c8ce
RD		 4800
4801 def ShiftDown(*args, **kwargs):
27fb7603
RD		 4802 """
4803 ShiftDown(self) -> bool
4804
4805 Returns true if the Shift key was down at the time of the event.
4806 """
54f9ee45 4807 return _core_.MouseEvent_ShiftDown(*args, **kwargs)
e811c8ce 4808
412d302d
RD		 4809 def CmdDown(*args, **kwargs):
4810 """
4811 CmdDown(self) -> bool
4812
4813 "Cmd" is a pseudo key which is the same as Control for PC and Unix
4814 platforms but the special "Apple" (a.k.a as "Command") key on
5ba5649b 4815 Macs. It often makes sense to use it instead of, say, `ControlDown`
412d302d 4816 because Cmd key is used for the same thing under Mac as Ctrl
27fb7603 4817 elsewhere. The Ctrl key still exists, it's just not used for this
412d302d
RD		 4818 purpose. So for non-Mac platforms this is the same as `ControlDown`
4819 and Macs this is the same as `MetaDown`.
4820 """
4821 return _core_.MouseEvent_CmdDown(*args, **kwargs)
4822
e811c8ce 4823 def LeftDown(*args, **kwargs):
27fb7603
RD		 4824 """
4825 LeftDown(self) -> bool
4826
4827 Returns true if the left mouse button state changed to down.
4828 """
54f9ee45 4829 return _core_.MouseEvent_LeftDown(*args, **kwargs)
e811c8ce
RD		 4830
4831 def MiddleDown(*args, **kwargs):
27fb7603
RD		 4832 """
4833 MiddleDown(self) -> bool
4834
4835 Returns true if the middle mouse button state changed to down.
4836 """
54f9ee45 4837 return _core_.MouseEvent_MiddleDown(*args, **kwargs)
e811c8ce
RD		 4838
4839 def RightDown(*args, **kwargs):
27fb7603
RD		 4840 """
4841 RightDown(self) -> bool
4842
4843 Returns true if the right mouse button state changed to down.
4844 """
54f9ee45 4845 return _core_.MouseEvent_RightDown(*args, **kwargs)
e811c8ce
RD		 4846
4847 def LeftUp(*args, **kwargs):
27fb7603
RD		 4848 """
4849 LeftUp(self) -> bool
4850
4851 Returns true if the left mouse button state changed to up.
4852 """
54f9ee45 4853 return _core_.MouseEvent_LeftUp(*args, **kwargs)
e811c8ce
RD		 4854
4855 def MiddleUp(*args, **kwargs):
27fb7603
RD		 4856 """
4857 MiddleUp(self) -> bool
4858
4859 Returns true if the middle mouse button state changed to up.
4860 """
54f9ee45 4861 return _core_.MouseEvent_MiddleUp(*args, **kwargs)
e811c8ce
RD		 4862
4863 def RightUp(*args, **kwargs):
27fb7603
RD		 4864 """
4865 RightUp(self) -> bool
4866
4867 Returns true if the right mouse button state changed to up.
4868 """
54f9ee45 4869 return _core_.MouseEvent_RightUp(*args, **kwargs)
e811c8ce
RD		 4870
4871 def LeftDClick(*args, **kwargs):
27fb7603
RD		 4872 """
4873 LeftDClick(self) -> bool
4874
4875 Returns true if the event was a left button double click.
4876 """
54f9ee45 4877 return _core_.MouseEvent_LeftDClick(*args, **kwargs)
e811c8ce
RD		 4878
4879 def MiddleDClick(*args, **kwargs):
27fb7603
RD		 4880 """
4881 MiddleDClick(self) -> bool
4882
4883 Returns true if the event was a middle button double click.
4884 """
54f9ee45 4885 return _core_.MouseEvent_MiddleDClick(*args, **kwargs)
e811c8ce
RD		 4886
4887 def RightDClick(*args, **kwargs):
27fb7603
RD		 4888 """
4889 RightDClick(self) -> bool
4890
4891 Returns true if the event was a right button double click.
4892 """
54f9ee45 4893 return _core_.MouseEvent_RightDClick(*args, **kwargs)
e811c8ce
RD		 4894
4895 def LeftIsDown(*args, **kwargs):
27fb7603
RD		 4896 """
4897 LeftIsDown(self) -> bool
4898
4899 Returns true if the left mouse button is currently down, independent
4900 of the current event type.
4901
4902 Please notice that it is not the same as LeftDown which returns true
4903 if the left mouse button was just pressed. Rather, it describes the
4904 state of the mouse button before the event happened.
4905
4906 This event is usually used in the mouse event handlers which process
4907 "move mouse" messages to determine whether the user is (still)
4908 dragging the mouse.
4909 """
54f9ee45 4910 return _core_.MouseEvent_LeftIsDown(*args, **kwargs)
e811c8ce
RD		 4911
4912 def MiddleIsDown(*args, **kwargs):
27fb7603
RD		 4913 """
4914 MiddleIsDown(self) -> bool
4915
4916 Returns true if the middle mouse button is currently down, independent
4917 of the current event type.
4918 """
54f9ee45 4919 return _core_.MouseEvent_MiddleIsDown(*args, **kwargs)
e811c8ce
RD		 4920
4921 def RightIsDown(*args, **kwargs):
27fb7603
RD		 4922 """
4923 RightIsDown(self) -> bool
4924
4925 Returns true if the right mouse button is currently down, independent
4926 of the current event type.
4927 """
54f9ee45 4928 return _core_.MouseEvent_RightIsDown(*args, **kwargs)
e811c8ce
RD		 4929
4930 def Dragging(*args, **kwargs):
27fb7603
RD		 4931 """
4932 Dragging(self) -> bool
4933
4934 Returns true if this was a dragging event (motion while a button is
4935 depressed).
4936 """
54f9ee45 4937 return _core_.MouseEvent_Dragging(*args, **kwargs)
e811c8ce
RD		 4938
4939 def Moving(*args, **kwargs):
27fb7603
RD		 4940 """
4941 Moving(self) -> bool
4942
4943 Returns true if this was a motion event and no mouse buttons were
4944 pressed. If any mouse button is held pressed, then this method returns
4945 false and Dragging returns true.
4946 """
54f9ee45 4947 return _core_.MouseEvent_Moving(*args, **kwargs)
e811c8ce
RD		 4948
4949 def Entering(*args, **kwargs):
27fb7603
RD		 4950 """
4951 Entering(self) -> bool
4952
4953 Returns true if the mouse was entering the window.
4954 """
54f9ee45 4955 return _core_.MouseEvent_Entering(*args, **kwargs)
e811c8ce
RD		 4956
4957 def Leaving(*args, **kwargs):
27fb7603
RD		 4958 """
4959 Leaving(self) -> bool
4960
4961 Returns true if the mouse was leaving the window.
4962 """
54f9ee45 4963 return _core_.MouseEvent_Leaving(*args, **kwargs)
e811c8ce
RD		 4964
4965 def GetPosition(*args, **kwargs):
0df68c9f 4966 """
a95a7133 4967 GetPosition(self) -> Point
e811c8ce 4968
27fb7603
RD		 4969 Returns the pixel position of the mouse in window coordinates when the
4970 event happened.
0df68c9f 4971 """
54f9ee45 4972 return _core_.MouseEvent_GetPosition(*args, **kwargs)
e811c8ce
RD		 4973
4974 def GetPositionTuple(*args, **kwargs):
0df68c9f
RD		 4975 """
4976 GetPositionTuple() -> (x,y)
e811c8ce 4977
27fb7603
RD		 4978 Returns the pixel position of the mouse in window coordinates when the
4979 event happened.
0df68c9f 4980 """
54f9ee45 4981 return _core_.MouseEvent_GetPositionTuple(*args, **kwargs)
e811c8ce
RD		 4982
4983 def GetLogicalPosition(*args, **kwargs):
27fb7603
RD		 4984 """
4985 GetLogicalPosition(self, DC dc) -> Point
4986
4987 Returns the logical mouse position in pixels (i.e. translated
4988 according to the translation set for the DC, which usually indicates
4989 that the window has been scrolled).
4990 """
54f9ee45 4991 return _core_.MouseEvent_GetLogicalPosition(*args, **kwargs)
e811c8ce
RD		 4992
4993 def GetX(*args, **kwargs):
27fb7603
RD		 4994 """
4995 GetX(self) -> int
4996
4997 Returns X coordinate of the physical mouse event position.
4998 """
54f9ee45 4999 return _core_.MouseEvent_GetX(*args, **kwargs)
e811c8ce
RD		 5000
5001 def GetY(*args, **kwargs):
27fb7603
RD		 5002 """
5003 GetY(self) -> int
5004
5005 Returns Y coordinate of the physical mouse event position.
5006 """
54f9ee45 5007 return _core_.MouseEvent_GetY(*args, **kwargs)
e811c8ce
RD		 5008
5009 def GetWheelRotation(*args, **kwargs):
27fb7603
RD		 5010 """
5011 GetWheelRotation(self) -> int
5012
5013 Get wheel rotation, positive or negative indicates direction of
5014 rotation. Current devices all send an event when rotation is equal to
5015 +/-WheelDelta, but this allows for finer resolution devices to be
5016 created in the future. Because of this you shouldn't assume that one
5017 event is equal to 1 line or whatever, but you should be able to either
5018 do partial line scrolling or wait until +/-WheelDelta rotation values
5019 have been accumulated before scrolling.
5020 """
54f9ee45 5021 return _core_.MouseEvent_GetWheelRotation(*args, **kwargs)
e811c8ce
RD		 5022
5023 def GetWheelDelta(*args, **kwargs):
27fb7603
RD		 5024 """
5025 GetWheelDelta(self) -> int
5026
5027 Get wheel delta, normally 120. This is the threshold for action to be
5028 taken, and one such action (for example, scrolling one increment)
5029 should occur for each delta.
5030 """
54f9ee45 5031 return _core_.MouseEvent_GetWheelDelta(*args, **kwargs)
e811c8ce
RD		 5032
5033 def GetLinesPerAction(*args, **kwargs):
27fb7603
RD		 5034 """
5035 GetLinesPerAction(self) -> int
5036
5037 Returns the configured number of lines (or whatever) to be scrolled
5038 per wheel action. Defaults to three.
5039 """
54f9ee45 5040 return _core_.MouseEvent_GetLinesPerAction(*args, **kwargs)
e811c8ce
RD		 5041
5042 def IsPageScroll(*args, **kwargs):
27fb7603
RD		 5043 """
5044 IsPageScroll(self) -> bool
5045
5046 Returns true if the system has been setup to do page scrolling with
5047 the mouse wheel instead of line scrolling.
5048 """
54f9ee45
RD		 5049 return _core_.MouseEvent_IsPageScroll(*args, **kwargs)
5050
5051 m_x = property(_core_.MouseEvent_m_x_get, _core_.MouseEvent_m_x_set)
5052 m_y = property(_core_.MouseEvent_m_y_get, _core_.MouseEvent_m_y_set)
5053 m_leftDown = property(_core_.MouseEvent_m_leftDown_get, _core_.MouseEvent_m_leftDown_set)
5054 m_middleDown = property(_core_.MouseEvent_m_middleDown_get, _core_.MouseEvent_m_middleDown_set)
5055 m_rightDown = property(_core_.MouseEvent_m_rightDown_get, _core_.MouseEvent_m_rightDown_set)
5056 m_controlDown = property(_core_.MouseEvent_m_controlDown_get, _core_.MouseEvent_m_controlDown_set)
5057 m_shiftDown = property(_core_.MouseEvent_m_shiftDown_get, _core_.MouseEvent_m_shiftDown_set)
5058 m_altDown = property(_core_.MouseEvent_m_altDown_get, _core_.MouseEvent_m_altDown_set)
5059 m_metaDown = property(_core_.MouseEvent_m_metaDown_get, _core_.MouseEvent_m_metaDown_set)
5060 m_wheelRotation = property(_core_.MouseEvent_m_wheelRotation_get, _core_.MouseEvent_m_wheelRotation_set)
5061 m_wheelDelta = property(_core_.MouseEvent_m_wheelDelta_get, _core_.MouseEvent_m_wheelDelta_set)
5062 m_linesPerAction = property(_core_.MouseEvent_m_linesPerAction_get, _core_.MouseEvent_m_linesPerAction_set)
57332a5a
RD		 5063 Button = property(GetButton,doc="See `GetButton`")
5064 LinesPerAction = property(GetLinesPerAction,doc="See `GetLinesPerAction`")
5065 LogicalPosition = property(GetLogicalPosition,doc="See `GetLogicalPosition`")
5066 Position = property(GetPosition,doc="See `GetPosition`")
5067 WheelDelta = property(GetWheelDelta,doc="See `GetWheelDelta`")
5068 WheelRotation = property(GetWheelRotation,doc="See `GetWheelRotation`")
5069 X = property(GetX,doc="See `GetX`")
5070 Y = property(GetY,doc="See `GetY`")
2131d850 5071_core_.MouseEvent_swigregister(MouseEvent)
d14a1e28
RD		 5072
5073#---------------------------------------------------------------------------
5074
5075class SetCursorEvent(Event):
5ba5649b
RD		 5076 """
5077 A SetCursorEvent is generated when the mouse cursor is about to be set
5078 as a result of mouse motion. This event gives the application the
5079 chance to perform specific mouse cursor processing based on the
5080 current position of the mouse within the window. Use the `SetCursor`
5081 method to specify the cursor you want to be displayed.
5082 """
0085ce49
RD		 5083 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5084 __repr__ = _swig_repr
5085 def __init__(self, *args, **kwargs):
5ba5649b
RD		 5086 """
5087 __init__(self, int x=0, int y=0) -> SetCursorEvent
5088
5089 Construct a new `wx.SetCursorEvent`.
5090 """
0085ce49 5091 _core_.SetCursorEvent_swiginit(self,_core_.new_SetCursorEvent(*args, **kwargs))
e811c8ce 5092 def GetX(*args, **kwargs):
5ba5649b
RD		 5093 """
5094 GetX(self) -> int
5095
5096 Returns the X coordinate of the mouse in client coordinates.
5097 """
54f9ee45 5098 return _core_.SetCursorEvent_GetX(*args, **kwargs)
e811c8ce
RD		 5099
5100 def GetY(*args, **kwargs):
5ba5649b
RD		 5101 """
5102 GetY(self) -> int
5103
5104 Returns the Y coordinate of the mouse in client coordinates.
5105 """
54f9ee45 5106 return _core_.SetCursorEvent_GetY(*args, **kwargs)
e811c8ce
RD		 5107
5108 def SetCursor(*args, **kwargs):
5ba5649b
RD		 5109 """
5110 SetCursor(self, Cursor cursor)
5111
5112 Sets the cursor associated with this event.
5113 """
54f9ee45 5114 return _core_.SetCursorEvent_SetCursor(*args, **kwargs)
e811c8ce
RD		 5115
5116 def GetCursor(*args, **kwargs):
5ba5649b
RD		 5117 """
5118 GetCursor(self) -> Cursor
5119
5120 Returns a reference to the cursor specified by this event.
5121 """
54f9ee45 5122 return _core_.SetCursorEvent_GetCursor(*args, **kwargs)
e811c8ce
RD		 5123
5124 def HasCursor(*args, **kwargs):
5ba5649b
RD		 5125 """
5126 HasCursor(self) -> bool
5127
5128 Returns true if the cursor specified by this event is a valid cursor.
5129 """
54f9ee45 5130 return _core_.SetCursorEvent_HasCursor(*args, **kwargs)
e811c8ce 5131
33d6fd3b
RD		 5132 Cursor = property(GetCursor,SetCursor,doc="See `GetCursor` and `SetCursor`")
5133 X = property(GetX,doc="See `GetX`")
5134 Y = property(GetY,doc="See `GetY`")
2131d850 5135_core_.SetCursorEvent_swigregister(SetCursorEvent)
d14a1e28
RD		 5136
5137#---------------------------------------------------------------------------
5138
5139class KeyEvent(Event):
5ba5649b
RD		 5140 """
5141 This event class contains information about keypress and character
5142 events. These events are only sent to the widget that currently has
5143 the keyboard focus.
5144
5145 Notice that there are three different kinds of keyboard events in
5146 wxWidgets: key down and up events and char events. The difference
5147 between the first two is clear - the first corresponds to a key press
5148 and the second to a key release - otherwise they are identical. Just
5149 note that if the key is maintained in a pressed state you will
5150 typically get a lot of (automatically generated) down events but only
5151 one up so it is wrong to assume that there is one up event
5152 corresponding to each down one.
5153
5154 Both key events provide untranslated key codes while the char event
5155 carries the translated one. The untranslated code for alphanumeric
5156 keys is always an upper case value. For the other keys it is one of
5157 WXK_XXX values from the keycodes table. The translated key is, in
5158 general, the character the user expects to appear as the result of the
5159 key combination when typing the text into a text entry zone, for
5160 example.
5161
5162 A few examples to clarify this (all assume that CAPS LOCK is unpressed
5163 and the standard US keyboard): when the 'A' key is pressed, the key
5164 down event key code is equal to ASCII A == 65. But the char event key
5165 code is ASCII a == 97. On the other hand, if you press both SHIFT and
5166 'A' keys simultaneously , the key code in key down event will still be
5167 just 'A' while the char event key code parameter will now be 'A' as
5168 well.
5169
5170 Although in this simple case it is clear that the correct key code
5171 could be found in the key down event handler by checking the value
5172 returned by `ShiftDown`, in general you should use EVT_CHAR for this
5173 as for non alphanumeric keys or non-US keyboard layouts the
5174 translation is keyboard-layout dependent and can only be done properly
5175 by the system itself.
5176
5177 Another kind of translation is done when the control key is pressed:
5178 for example, for CTRL-A key press the key down event still carries the
5179 same key code 'A' as usual but the char event will have key code of 1,
5180 the ASCII value of this key combination.
5181
5182 You may discover how the other keys on your system behave
5183 interactively by running the KeyEvents sample in the wxPython demo and
5184 pressing some keys while the blue box at the top has the keyboard
5185 focus.
5186
5187 **Note**: If a key down event is caught and the event handler does not
5188 call event.Skip() then the coresponding char event will not
5189 happen. This is by design and enables the programs that handle both
5190 types of events to be a bit simpler.
5191
5192 **Note for Windows programmers**: The key and char events in wxWidgets
5193 are similar to but slightly different from Windows WM_KEYDOWN and
5194 WM_CHAR events. In particular, Alt-x combination will generate a char
5195 event in wxWidgets (unless it is used as an accelerator).
5196
5197 **Tip**: be sure to call event.Skip() for events that you don't
5198 process in key event function, otherwise menu shortcuts may cease to
5199 work under Windows.
5200
5201 """
0085ce49
RD		 5202 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5203 __repr__ = _swig_repr
5204 def __init__(self, *args, **kwargs):
5ba5649b 5205 """
2131d850 5206 __init__(self, EventType eventType=wxEVT_NULL) -> KeyEvent
5ba5649b
RD		 5207
5208 Construct a new `wx.KeyEvent`. Valid event types are:
5209 *
5210 """
0085ce49 5211 _core_.KeyEvent_swiginit(self,_core_.new_KeyEvent(*args, **kwargs))
b1fcee84
RD		 5212 def GetModifiers(*args, **kwargs):
5213 """
5214 GetModifiers(self) -> int
5215
5216 Returns a bitmask of the current modifier settings. Can be used to
5217 check if the key event has exactly the given modifiers without having
5218 to explicitly check that the other modifiers are not down. For
5219 example::
5220
5221 if event.GetModifers() == wx.MOD_CONTROL:
5222 DoSomething()
5223
5224 """
5225 return _core_.KeyEvent_GetModifiers(*args, **kwargs)
5226
e811c8ce 5227 def ControlDown(*args, **kwargs):
5ba5649b
RD		 5228 """
5229 ControlDown(self) -> bool
5230
5231 Returns ``True`` if the Control key was down at the time of the event.
5232 """
54f9ee45 5233 return _core_.KeyEvent_ControlDown(*args, **kwargs)
e811c8ce
RD		 5234
5235 def MetaDown(*args, **kwargs):
5ba5649b
RD		 5236 """
5237 MetaDown(self) -> bool
5238
5239 Returns ``True`` if the Meta key was down at the time of the event.
5240 """
54f9ee45 5241 return _core_.KeyEvent_MetaDown(*args, **kwargs)
e811c8ce
RD		 5242
5243 def AltDown(*args, **kwargs):
5ba5649b
RD		 5244 """
5245 AltDown(self) -> bool
5246
5247 Returns ``True`` if the Alt key was down at the time of the event.
5248 """
54f9ee45 5249 return _core_.KeyEvent_AltDown(*args, **kwargs)
e811c8ce
RD		 5250
5251 def ShiftDown(*args, **kwargs):
5ba5649b
RD		 5252 """
5253 ShiftDown(self) -> bool
5254
5255 Returns ``True`` if the Shift key was down at the time of the event.
5256 """
54f9ee45 5257 return _core_.KeyEvent_ShiftDown(*args, **kwargs)
e811c8ce 5258
412d302d
RD		 5259 def CmdDown(*args, **kwargs):
5260 """
5261 CmdDown(self) -> bool
5262
5263 "Cmd" is a pseudo key which is the same as Control for PC and Unix
5264 platforms but the special "Apple" (a.k.a as "Command") key on
5ba5649b 5265 Macs. It makes often sense to use it instead of, say, `ControlDown`
412d302d
RD		 5266 because Cmd key is used for the same thing under Mac as Ctrl
5267 elsewhere. The Ctrl still exists, it's just not used for this
5268 purpose. So for non-Mac platforms this is the same as `ControlDown`
5269 and Macs this is the same as `MetaDown`.
5270 """
5271 return _core_.KeyEvent_CmdDown(*args, **kwargs)
5272
e811c8ce 5273 def HasModifiers(*args, **kwargs):
5ba5649b
RD		 5274 """
5275 HasModifiers(self) -> bool
5276
5277 Returns true if either CTRL or ALT keys was down at the time of the
5278 key event. Note that this function does not take into account neither
5279 SHIFT nor META key states (the reason for ignoring the latter is that
5280 it is common for NUMLOCK key to be configured as META under X but the
5281 key presses even while NUMLOCK is on should be still processed
5282 normally).
5283 """
54f9ee45 5284 return _core_.KeyEvent_HasModifiers(*args, **kwargs)
e811c8ce
RD		 5285
5286 def GetKeyCode(*args, **kwargs):
5ba5649b
RD		 5287 """
5288 GetKeyCode(self) -> int
5289
5290 Returns the virtual key code. ASCII events return normal ASCII values,
5291 while non-ASCII events return values such as WXK_LEFT for the left
5292 cursor key. See `wx.KeyEvent` for a full list of the virtual key
5293 codes.
5294
5295 Note that in Unicode build, the returned value is meaningful only if
5296 the user entered a character that can be represented in current
5297 locale's default charset. You can obtain the corresponding Unicode
5298 character using `GetUnicodeKey`.
5299 """
54f9ee45 5300 return _core_.KeyEvent_GetKeyCode(*args, **kwargs)
e811c8ce 5301
19272049 5302 def GetUnicodeKey(*args, **kwargs):
5ba5649b
RD		 5303 """
5304 GetUnicodeKey(self) -> int
5305
5306 Returns the Unicode character corresponding to this key event. This
5307 function is only meaningfule in a Unicode build of wxPython.
5308 """
19272049 5309 return _core_.KeyEvent_GetUnicodeKey(*args, **kwargs)
e811c8ce 5310
19272049 5311 GetUniChar = GetUnicodeKey
b850e7f3
RD		 5312 def SetUnicodeKey(*args, **kwargs):
5313 """
5314 SetUnicodeKey(self, int uniChar)
5315
5316 Set the Unicode value of the key event, but only if this is a Unicode
5317 build of wxPython.
5318 """
5319 return _core_.KeyEvent_SetUnicodeKey(*args, **kwargs)
5320
e811c8ce 5321 def GetRawKeyCode(*args, **kwargs):
5ba5649b
RD		 5322 """
5323 GetRawKeyCode(self) -> unsigned int
5324
5325 Returns the raw key code for this event. This is a platform-dependent
5326 scan code which should only be used in advanced
5327 applications. Currently the raw key codes are not supported by all
5328 ports.
5329 """
54f9ee45 5330 return _core_.KeyEvent_GetRawKeyCode(*args, **kwargs)
e811c8ce
RD		 5331
5332 def GetRawKeyFlags(*args, **kwargs):
5ba5649b
RD		 5333 """
5334 GetRawKeyFlags(self) -> unsigned int
5335
5336 Returns the low level key flags for this event. The flags are
5337 platform-dependent and should only be used in advanced applications.
5338 Currently the raw key flags are not supported by all ports.
5339 """
54f9ee45 5340 return _core_.KeyEvent_GetRawKeyFlags(*args, **kwargs)
e811c8ce
RD		 5341
5342 def GetPosition(*args, **kwargs):
0df68c9f 5343 """
a95a7133 5344 GetPosition(self) -> Point
e811c8ce 5345
5ba5649b 5346 Find the position of the event, if applicable.
0df68c9f 5347 """
54f9ee45 5348 return _core_.KeyEvent_GetPosition(*args, **kwargs)
e811c8ce
RD		 5349
5350 def GetPositionTuple(*args, **kwargs):
0df68c9f
RD		 5351 """
5352 GetPositionTuple() -> (x,y)
e811c8ce 5353
5ba5649b 5354 Find the position of the event, if applicable.
0df68c9f 5355 """
54f9ee45 5356 return _core_.KeyEvent_GetPositionTuple(*args, **kwargs)
e811c8ce
RD		 5357
5358 def GetX(*args, **kwargs):
5ba5649b
RD		 5359 """
5360 GetX(self) -> int
5361
5362 Returns the X position (in client coordinates) of the event, if
5363 applicable.
5364 """
54f9ee45 5365 return _core_.KeyEvent_GetX(*args, **kwargs)
e811c8ce
RD		 5366
5367 def GetY(*args, **kwargs):
5ba5649b
RD		 5368 """
5369 GetY(self) -> int
5370
5371 Returns the Y position (in client coordinates) of the event, if
5372 applicable.
5373 """
54f9ee45
RD		 5374 return _core_.KeyEvent_GetY(*args, **kwargs)
5375
5376 m_x = property(_core_.KeyEvent_m_x_get, _core_.KeyEvent_m_x_set)
5377 m_y = property(_core_.KeyEvent_m_y_get, _core_.KeyEvent_m_y_set)
5378 m_keyCode = property(_core_.KeyEvent_m_keyCode_get, _core_.KeyEvent_m_keyCode_set)
5379 m_controlDown = property(_core_.KeyEvent_m_controlDown_get, _core_.KeyEvent_m_controlDown_set)
5380 m_shiftDown = property(_core_.KeyEvent_m_shiftDown_get, _core_.KeyEvent_m_shiftDown_set)
5381 m_altDown = property(_core_.KeyEvent_m_altDown_get, _core_.KeyEvent_m_altDown_set)
5382 m_metaDown = property(_core_.KeyEvent_m_metaDown_get, _core_.KeyEvent_m_metaDown_set)
5383 m_scanCode = property(_core_.KeyEvent_m_scanCode_get, _core_.KeyEvent_m_scanCode_set)
5384 m_rawCode = property(_core_.KeyEvent_m_rawCode_get, _core_.KeyEvent_m_rawCode_set)
5385 m_rawFlags = property(_core_.KeyEvent_m_rawFlags_get, _core_.KeyEvent_m_rawFlags_set)
97ab0f6a
RD		 5386 KeyCode = property(GetKeyCode,doc="See `GetKeyCode`")
5387 Modifiers = property(GetModifiers,doc="See `GetModifiers`")
5388 Position = property(GetPosition,doc="See `GetPosition`")
5389 RawKeyCode = property(GetRawKeyCode,doc="See `GetRawKeyCode`")
5390 RawKeyFlags = property(GetRawKeyFlags,doc="See `GetRawKeyFlags`")
5391 UnicodeKey = property(GetUnicodeKey,SetUnicodeKey,doc="See `GetUnicodeKey` and `SetUnicodeKey`")
5392 X = property(GetX,doc="See `GetX`")
5393 Y = property(GetY,doc="See `GetY`")
2131d850 5394_core_.KeyEvent_swigregister(KeyEvent)
d14a1e28
RD		 5395
5396#---------------------------------------------------------------------------
5397
5398class SizeEvent(Event):
5ba5649b
RD		 5399 """
5400 A size event holds information about size change events. The EVT_SIZE
5401 handler function will be called when the window it is bound to has
5402 been resized.
5403
5404 Note that the size passed is of the whole window: call
5405 `wx.Window.GetClientSize` for the area which may be used by the
5406 application.
5407
5408 When a window is resized, usually only a small part of the window is
5409 damaged and and that area is all that is in the update region for the
5410 next paint event. However, if your drawing depends on the size of the
5411 window, you may need to clear the DC explicitly and repaint the whole
5412 window. In which case, you may need to call `wx.Window.Refresh` to
5413 invalidate the entire window.
5414
5415 """
0085ce49
RD		 5416 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5417 __repr__ = _swig_repr
5418 def __init__(self, *args, **kwargs):
5ba5649b
RD		 5419 """
5420 __init__(self, Size sz=DefaultSize, int winid=0) -> SizeEvent
5421
5422 Construct a new ``wx.SizeEvent``.
5423 """
0085ce49 5424 _core_.SizeEvent_swiginit(self,_core_.new_SizeEvent(*args, **kwargs))
e811c8ce 5425 def GetSize(*args, **kwargs):
5ba5649b
RD		 5426 """
5427 GetSize(self) -> Size
5428
5429 Returns the entire size of the window generating the size change
5430 event.
5431 """
54f9ee45 5432 return _core_.SizeEvent_GetSize(*args, **kwargs)
e811c8ce
RD		 5433
5434 def GetRect(*args, **kwargs):
a95a7133 5435 """GetRect(self) -> Rect"""
54f9ee45 5436 return _core_.SizeEvent_GetRect(*args, **kwargs)
e811c8ce
RD		 5437
5438 def SetRect(*args, **kwargs):
a95a7133 5439 """SetRect(self, Rect rect)"""
54f9ee45 5440 return _core_.SizeEvent_SetRect(*args, **kwargs)
e811c8ce
RD		 5441
5442 def SetSize(*args, **kwargs):
a95a7133 5443 """SetSize(self, Size size)"""
54f9ee45 5444 return _core_.SizeEvent_SetSize(*args, **kwargs)
e811c8ce 5445
54f9ee45
RD		 5446 m_size = property(_core_.SizeEvent_m_size_get, _core_.SizeEvent_m_size_set)
5447 m_rect = property(_core_.SizeEvent_m_rect_get, _core_.SizeEvent_m_rect_set)
33d6fd3b
RD		 5448 Rect = property(GetRect,SetRect,doc="See `GetRect` and `SetRect`")
5449 Size = property(GetSize,SetSize,doc="See `GetSize` and `SetSize`")
2131d850 5450_core_.SizeEvent_swigregister(SizeEvent)
d14a1e28
RD		 5451
5452#---------------------------------------------------------------------------
5453
5454class MoveEvent(Event):
5ba5649b
RD		 5455 """
5456 This event object is sent for EVT_MOVE event bindings when a window is
5457 moved to a new position.
5458 """
0085ce49
RD		 5459 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5460 __repr__ = _swig_repr
5461 def __init__(self, *args, **kwargs):
5ba5649b
RD		 5462 """
5463 __init__(self, Point pos=DefaultPosition, int winid=0) -> MoveEvent
5464
5465 Constructor.
5466 """
0085ce49 5467 _core_.MoveEvent_swiginit(self,_core_.new_MoveEvent(*args, **kwargs))
e811c8ce 5468 def GetPosition(*args, **kwargs):
5ba5649b
RD		 5469 """
5470 GetPosition(self) -> Point
5471
5472 Returns the position of the window generating the move change event.
5473 """
54f9ee45 5474 return _core_.MoveEvent_GetPosition(*args, **kwargs)
e811c8ce
RD		 5475
5476 def GetRect(*args, **kwargs):
a95a7133 5477 """GetRect(self) -> Rect"""
54f9ee45 5478 return _core_.MoveEvent_GetRect(*args, **kwargs)
e811c8ce
RD		 5479
5480 def SetRect(*args, **kwargs):
a95a7133 5481 """SetRect(self, Rect rect)"""
54f9ee45 5482 return _core_.MoveEvent_SetRect(*args, **kwargs)
e811c8ce
RD		 5483
5484 def SetPosition(*args, **kwargs):
a95a7133 5485 """SetPosition(self, Point pos)"""
54f9ee45 5486 return _core_.MoveEvent_SetPosition(*args, **kwargs)
e811c8ce 5487
7557b9b5
RD		 5488 m_pos = property(GetPosition, SetPosition)
5489 m_rect = property(GetRect, SetRect)
5490
57332a5a
RD		 5491 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
5492 Rect = property(GetRect,SetRect,doc="See `GetRect` and `SetRect`")
2131d850 5493_core_.MoveEvent_swigregister(MoveEvent)
d14a1e28
RD		 5494
5495#---------------------------------------------------------------------------
5496
5497class PaintEvent(Event):
5ba5649b
RD		 5498 """
5499 A paint event is sent when a window's contents needs to be repainted.
5500 Note that in an EVT_PAINT handler the application must *always* create
5501 a `wx.PaintDC` object, even if you do not use it. Otherwise MS
5502 Windows assumes that the window has not been painted yet and will send
5503 the event again, causing endless refreshes.
5504
5505 You can optimize painting by retrieving the rectangles that have been
5506 damaged using `wx.Window.GetUpdateRegion` and/or `wx.RegionIterator`,
5507 and only repainting these rectangles. The rectangles are in terms of
5508 the client area, and are unscrolled, so you will need to do some
5509 calculations using the current view position to obtain logical,
5510 scrolled units.
5511
5512 """
0085ce49
RD		 5513 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5514 __repr__ = _swig_repr
5515 def __init__(self, *args, **kwargs):
a95a7133 5516 """__init__(self, int Id=0) -> PaintEvent"""
0085ce49 5517 _core_.PaintEvent_swiginit(self,_core_.new_PaintEvent(*args, **kwargs))
2131d850 5518_core_.PaintEvent_swigregister(PaintEvent)
d14a1e28
RD		 5519
5520class NcPaintEvent(Event):
093d3ff1 5521 """Proxy of C++ NcPaintEvent class"""
0085ce49
RD		 5522 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5523 __repr__ = _swig_repr
5524 def __init__(self, *args, **kwargs):
a95a7133 5525 """__init__(self, int winid=0) -> NcPaintEvent"""
0085ce49 5526 _core_.NcPaintEvent_swiginit(self,_core_.new_NcPaintEvent(*args, **kwargs))
2131d850 5527_core_.NcPaintEvent_swigregister(NcPaintEvent)
d14a1e28
RD		 5528
5529#---------------------------------------------------------------------------
5530
5531class EraseEvent(Event):
5ba5649b
RD		 5532 """
5533 An erase event is sent whenever the background of a window needs to be
5534 repainted. To intercept this event use the EVT_ERASE_BACKGROUND event
5535 binder. On some platforms, such as GTK+, this event is simulated
5536 (simply generated just before the paint event) and may cause flicker.
5537
5538 To paint a custom background use the `GetDC` method and use the returned
5539 device context if it is not ``None``, otherwise create a temporary
5540 `wx.ClientDC` and draw on that.
5541
5542 """
0085ce49
RD		 5543 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5544 __repr__ = _swig_repr
5545 def __init__(self, *args, **kwargs):
5ba5649b
RD		 5546 """
5547 __init__(self, int Id=0, DC dc=None) -> EraseEvent
5548
5549 Constructor
5550 """
0085ce49 5551 _core_.EraseEvent_swiginit(self,_core_.new_EraseEvent(*args, **kwargs))
e811c8ce 5552 def GetDC(*args, **kwargs):
5ba5649b
RD		 5553 """
5554 GetDC(self) -> DC
5555
5556 Returns the device context the event handler should draw upon. If
5557 ``None`` is returned then create a temporary `wx.ClientDC` and use
5558 that instead.
5559 """
54f9ee45 5560 return _core_.EraseEvent_GetDC(*args, **kwargs)
e811c8ce 5561
97ab0f6a 5562 DC = property(GetDC,doc="See `GetDC`")
2131d850 5563_core_.EraseEvent_swigregister(EraseEvent)
d14a1e28
RD		 5564
5565#---------------------------------------------------------------------------
5566
5567class FocusEvent(Event):
5ba5649b
RD		 5568 """
5569 A focus event is sent when a window's focus changes. The window losing
5570 focus receives an EVT_KILL_FOCUS event while the window gaining it
5571 gets an EVT_SET_FOCUS event.
5572
5573 Notice that the set focus event happens both when the user gives focus
5574 to the window (whether using the mouse or keyboard) and when it is
5575 done from the program itself using `wx.Window.SetFocus`.
5576
5577 """
0085ce49
RD		 5578 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5579 __repr__ = _swig_repr
5580 def __init__(self, *args, **kwargs):
5ba5649b 5581 """
2131d850 5582 __init__(self, EventType type=wxEVT_NULL, int winid=0) -> FocusEvent
5ba5649b
RD		 5583
5584 Constructor
5585 """
0085ce49 5586 _core_.FocusEvent_swiginit(self,_core_.new_FocusEvent(*args, **kwargs))
e811c8ce 5587 def GetWindow(*args, **kwargs):
5ba5649b
RD		 5588 """
5589 GetWindow(self) -> Window
5590
5591 Returns the other window associated with this event, that is the
5592 window which had the focus before for the EVT_SET_FOCUS event and the
5593 window which is going to receive focus for the wxEVT_KILL_FOCUS event.
5594
5595 Warning: the window returned may be None!
5596 """
54f9ee45 5597 return _core_.FocusEvent_GetWindow(*args, **kwargs)
e811c8ce
RD		 5598
5599 def SetWindow(*args, **kwargs):
a95a7133 5600 """SetWindow(self, Window win)"""
54f9ee45 5601 return _core_.FocusEvent_SetWindow(*args, **kwargs)
e811c8ce 5602
97ab0f6a 5603 Window = property(GetWindow,SetWindow,doc="See `GetWindow` and `SetWindow`")
2131d850 5604_core_.FocusEvent_swigregister(FocusEvent)
d14a1e28
RD		 5605
5606#---------------------------------------------------------------------------
5607
5608class ChildFocusEvent(CommandEvent):
5ba5649b 5609 """
33d6fd3b
RD		 5610 A child focus event is sent to a (parent-)window when one of its child
5611 windows gains focus, so that the window could restore the focus back
5612 to its corresponding child if it loses it now and regains later.
5613
5614 Notice that child window is the direct child of the window receiving
5615 the event, and so may not be the actual widget recieving focus if it
5616 is further down the containment heirarchy. Use `wx.Window.FindFocus`
5617 to get the widget that is actually receiving focus.
5ba5649b 5618 """
0085ce49
RD		 5619 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5620 __repr__ = _swig_repr
5621 def __init__(self, *args, **kwargs):
5ba5649b
RD		 5622 """
5623 __init__(self, Window win=None) -> ChildFocusEvent
5624
5625 Constructor
5626 """
0085ce49 5627 _core_.ChildFocusEvent_swiginit(self,_core_.new_ChildFocusEvent(*args, **kwargs))
e811c8ce 5628 def GetWindow(*args, **kwargs):
5ba5649b
RD		 5629 """
5630 GetWindow(self) -> Window
5631
33d6fd3b
RD		 5632 The window, or (grand)parent of the window which has just received the
5633 focus.
5ba5649b 5634 """
54f9ee45 5635 return _core_.ChildFocusEvent_GetWindow(*args, **kwargs)
e811c8ce 5636
2bf58437 5637 Window = property(GetWindow,doc="See `GetWindow`")
2131d850 5638_core_.ChildFocusEvent_swigregister(ChildFocusEvent)
d14a1e28
RD		 5639
5640#---------------------------------------------------------------------------
5641
5642class ActivateEvent(Event):
5ba5649b
RD		 5643 """
5644 An activate event is sent when a top-level window or the entire
5645 application is being activated or deactivated.
5646
5647 A top-level window (a dialog or frame) receives an activate event when
5648 is being activated or deactivated. This is indicated visually by the
5649 title bar changing colour, and a subwindow gaining the keyboard focus.
5650 An application is activated or deactivated when one of its frames
5651 becomes activated, or a frame becomes inactivate resulting in all
5652 application frames being inactive.
5653
5654 Please note that usually you should call event.Skip() in your handlers
5655 for these events so the default handlers will still be called, as not
5656 doing so can result in strange effects.
5657
5658 """
0085ce49
RD		 5659 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5660 __repr__ = _swig_repr
5661 def __init__(self, *args, **kwargs):
5ba5649b 5662 """
2131d850 5663 __init__(self, EventType type=wxEVT_NULL, bool active=True, int Id=0) -> ActivateEvent
5ba5649b
RD		 5664
5665 Constructor
5666 """
0085ce49 5667 _core_.ActivateEvent_swiginit(self,_core_.new_ActivateEvent(*args, **kwargs))
e811c8ce 5668 def GetActive(*args, **kwargs):
5ba5649b
RD		 5669 """
5670 GetActive(self) -> bool
5671
5672 Returns true if the application or window is being activated, false
5673 otherwise.
5674 """
54f9ee45 5675 return _core_.ActivateEvent_GetActive(*args, **kwargs)
e811c8ce 5676
2bf58437 5677 Active = property(GetActive,doc="See `GetActive`")
2131d850 5678_core_.ActivateEvent_swigregister(ActivateEvent)
d14a1e28
RD		 5679
5680#---------------------------------------------------------------------------
5681
5682class InitDialogEvent(Event):
5ba5649b
RD		 5683 """
5684 A wx.InitDialogEvent is sent as a dialog is being initialised, or for
5685 any window when `wx.Window.InitDialog` is called. Handlers for this
5686 event can transfer data to the window, or anything else that should be
5687 done before the user begins editing the form. The default handler
5688 calls `wx.Window.TransferDataToWindow`.
5689 """
0085ce49
RD		 5690 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5691 __repr__ = _swig_repr
5692 def __init__(self, *args, **kwargs):
5ba5649b
RD		 5693 """
5694 __init__(self, int Id=0) -> InitDialogEvent
5695
5696 Constructor
5697 """
0085ce49 5698 _core_.InitDialogEvent_swiginit(self,_core_.new_InitDialogEvent(*args, **kwargs))
2131d850 5699_core_.InitDialogEvent_swigregister(InitDialogEvent)
d14a1e28
RD		 5700
5701#---------------------------------------------------------------------------
5702
5703class MenuEvent(Event):
5ba5649b
RD		 5704 """
5705 This class is used for a variety of menu-related events. Note that
5706 these do not include menu command events, which are handled by sending
5707 `wx.CommandEvent` objects.
5708
5709 The default handler for wx.EVT_MENU_HIGHLIGHT displays menu item help
5710 text in the first field of the status bar.
5711 """
0085ce49
RD		 5712 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5713 __repr__ = _swig_repr
5714 def __init__(self, *args, **kwargs):
5ba5649b 5715 """
2131d850 5716 __init__(self, EventType type=wxEVT_NULL, int winid=0, Menu menu=None) -> MenuEvent
5ba5649b
RD		 5717
5718 Constructor
5719 """
0085ce49 5720 _core_.MenuEvent_swiginit(self,_core_.new_MenuEvent(*args, **kwargs))
e811c8ce 5721 def GetMenuId(*args, **kwargs):
5ba5649b
RD		 5722 """
5723 GetMenuId(self) -> int
5724
5725 Returns the menu identifier associated with the event. This method
5726 should be only used with the HIGHLIGHT events.
5727 """
54f9ee45 5728 return _core_.MenuEvent_GetMenuId(*args, **kwargs)
e811c8ce
RD		 5729
5730 def IsPopup(*args, **kwargs):
5ba5649b
RD		 5731 """
5732 IsPopup(self) -> bool
5733
5734 Returns ``True`` if the menu which is being opened or closed is a
5735 popup menu, ``False`` if it is a normal one. This method should only
5736 be used with the OPEN and CLOSE events.
5737 """
54f9ee45 5738 return _core_.MenuEvent_IsPopup(*args, **kwargs)
e811c8ce
RD		 5739
5740 def GetMenu(*args, **kwargs):
5ba5649b
RD		 5741 """
5742 GetMenu(self) -> Menu
5743
5744 Returns the menu which is being opened or closed. This method should
5745 only be used with the OPEN and CLOSE events.
5746 """
54f9ee45 5747 return _core_.MenuEvent_GetMenu(*args, **kwargs)
e811c8ce 5748
57332a5a
RD		 5749 Menu = property(GetMenu,doc="See `GetMenu`")
5750 MenuId = property(GetMenuId,doc="See `GetMenuId`")
2131d850 5751_core_.MenuEvent_swigregister(MenuEvent)
d14a1e28
RD		 5752
5753#---------------------------------------------------------------------------
5754
5755class CloseEvent(Event):
5ba5649b
RD		 5756 """
5757 This event class contains information about window and session close
5758 events.
5759
5760 The handler function for EVT_CLOSE is called when the user has tried
5761 to close a a frame or dialog box using the window manager controls or
5762 the system menu. It can also be invoked by the application itself
5763 programmatically, for example by calling the `wx.Window.Close`
5764 function.
5765
5766 You should check whether the application is forcing the deletion of
5767 the window using `CanVeto`. If it returns ``False``, you must destroy
5768 the window using `wx.Window.Destroy`. If the return value is ``True``,
5769 it is up to you whether you respond by destroying the window or not.
5770 For example you may wish to display a message dialog prompting to save
5771 files or to cancel the close.
5772
5773 If you don't destroy the window, you should call `Veto` to let the
5774 calling code know that you did not destroy the window. This allows the
5775 `wx.Window.Close` function to return ``True`` or ``False`` depending
5776 on whether the close instruction was honored or not.
5777 """
0085ce49
RD		 5778 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5779 __repr__ = _swig_repr
5780 def __init__(self, *args, **kwargs):
5ba5649b 5781 """
2131d850 5782 __init__(self, EventType type=wxEVT_NULL, int winid=0) -> CloseEvent
5ba5649b
RD		 5783
5784 Constructor.
5785 """
0085ce49 5786 _core_.CloseEvent_swiginit(self,_core_.new_CloseEvent(*args, **kwargs))
e811c8ce 5787 def SetLoggingOff(*args, **kwargs):
5ba5649b
RD		 5788 """
5789 SetLoggingOff(self, bool logOff)
5790
5791 Sets the 'logging off' flag.
5792 """
54f9ee45 5793 return _core_.CloseEvent_SetLoggingOff(*args, **kwargs)
e811c8ce
RD		 5794
5795 def GetLoggingOff(*args, **kwargs):
5ba5649b
RD		 5796 """
5797 GetLoggingOff(self) -> bool
5798
6c75a4cf
RD		 5799 Returns ``True`` if the user is logging off or ``False`` if the
5800 system is shutting down. This method can only be called for end
5801 session and query end session events, it doesn't make sense for close
5802 window event.
5ba5649b 5803 """
54f9ee45 5804 return _core_.CloseEvent_GetLoggingOff(*args, **kwargs)
e811c8ce
RD		 5805
5806 def Veto(*args, **kwargs):
5ba5649b
RD		 5807 """
5808 Veto(self, bool veto=True)
5809
5810 Call this from your event handler to veto a system shutdown or to
5811 signal to the calling application that a window close did not happen.
5812
5813 You can only veto a shutdown or close if `CanVeto` returns true.
5814 """
54f9ee45 5815 return _core_.CloseEvent_Veto(*args, **kwargs)
e811c8ce 5816
5ba5649b
RD		 5817 def GetVeto(*args, **kwargs):
5818 """GetVeto(self) -> bool"""
5819 return _core_.CloseEvent_GetVeto(*args, **kwargs)
5820
e811c8ce 5821 def SetCanVeto(*args, **kwargs):
5ba5649b
RD		 5822 """
5823 SetCanVeto(self, bool canVeto)
5824
5825 Sets the 'can veto' flag.
5826 """
54f9ee45 5827 return _core_.CloseEvent_SetCanVeto(*args, **kwargs)
e811c8ce
RD		 5828
5829 def CanVeto(*args, **kwargs):
5ba5649b
RD		 5830 """
5831 CanVeto(self) -> bool
e811c8ce 5832
5ba5649b
RD		 5833 Returns true if you can veto a system shutdown or a window close
5834 event. Vetoing a window close event is not possible if the calling
5835 code wishes to force the application to exit, and so this function
5836 must be called to check this.
5837 """
5838 return _core_.CloseEvent_CanVeto(*args, **kwargs)
e811c8ce 5839
2bf58437 5840 LoggingOff = property(GetLoggingOff,SetLoggingOff,doc="See `GetLoggingOff` and `SetLoggingOff`")
2131d850 5841_core_.CloseEvent_swigregister(CloseEvent)
d14a1e28
RD		 5842
5843#---------------------------------------------------------------------------
5844
5845class ShowEvent(Event):
5ba5649b 5846 """An EVT_SHOW event is sent when a window is shown or hidden."""
0085ce49
RD		 5847 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5848 __repr__ = _swig_repr
5849 def __init__(self, *args, **kwargs):
5ba5649b
RD		 5850 """
5851 __init__(self, int winid=0, bool show=False) -> ShowEvent
5852
5853 An EVT_SHOW event is sent when a window is shown or hidden.
5854 """
0085ce49 5855 _core_.ShowEvent_swiginit(self,_core_.new_ShowEvent(*args, **kwargs))
e811c8ce 5856 def SetShow(*args, **kwargs):
a95a7133 5857 """SetShow(self, bool show)"""
54f9ee45 5858 return _core_.ShowEvent_SetShow(*args, **kwargs)
e811c8ce
RD		 5859
5860 def GetShow(*args, **kwargs):
a95a7133 5861 """GetShow(self) -> bool"""
54f9ee45 5862 return _core_.ShowEvent_GetShow(*args, **kwargs)
e811c8ce 5863
33d6fd3b 5864 Show = property(GetShow,SetShow,doc="See `GetShow` and `SetShow`")
2131d850 5865_core_.ShowEvent_swigregister(ShowEvent)
d14a1e28
RD		 5866
5867#---------------------------------------------------------------------------
5868
5869class IconizeEvent(Event):
5ba5649b
RD		 5870 """
5871 An EVT_ICONIZE event is sent when a frame is iconized (minimized) or
5872 restored.
5873 """
0085ce49
RD		 5874 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5875 __repr__ = _swig_repr
5876 def __init__(self, *args, **kwargs):
5ba5649b
RD		 5877 """
5878 __init__(self, int id=0, bool iconized=True) -> IconizeEvent
5879
5880 An EVT_ICONIZE event is sent when a frame is iconized (minimized) or
5881 restored.
5882 """
0085ce49 5883 _core_.IconizeEvent_swiginit(self,_core_.new_IconizeEvent(*args, **kwargs))
e811c8ce 5884 def Iconized(*args, **kwargs):
5ba5649b
RD		 5885 """
5886 Iconized(self) -> bool
5887
5888 Returns ``True`` if the frame has been iconized, ``False`` if it has
5889 been restored.
5890 """
54f9ee45 5891 return _core_.IconizeEvent_Iconized(*args, **kwargs)
e811c8ce 5892
2131d850 5893_core_.IconizeEvent_swigregister(IconizeEvent)
d14a1e28
RD		 5894
5895#---------------------------------------------------------------------------
5896
5897class MaximizeEvent(Event):
5ba5649b 5898 """An EVT_MAXIMIZE event is sent when a frame is maximized or restored."""
0085ce49
RD		 5899 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5900 __repr__ = _swig_repr
5901 def __init__(self, *args, **kwargs):
5ba5649b
RD		 5902 """
5903 __init__(self, int id=0) -> MaximizeEvent
5904
5905 An EVT_MAXIMIZE event is sent when a frame is maximized or restored.
5906 """
0085ce49 5907 _core_.MaximizeEvent_swiginit(self,_core_.new_MaximizeEvent(*args, **kwargs))
2131d850 5908_core_.MaximizeEvent_swigregister(MaximizeEvent)
d14a1e28
RD		 5909
5910#---------------------------------------------------------------------------
5911
5912class DropFilesEvent(Event):
5ba5649b
RD		 5913 """
5914 This class is used for drop files events, that is, when files have
5915 been dropped onto the window. This functionality is only available
5916 under Windows. The window must have previously been enabled for
5917 dropping by calling `wx.Window.DragAcceptFiles`.
5918
5919 Important note: this is a separate implementation to the more general
5920 drag and drop implementation using `wx.FileDropTarget`, and etc. This
5921 implementation uses the older, Windows message-based approach of
5922 dropping files.
5923
5924 Use wx.EVT_DROP_FILES to bind an event handler to receive file drop
5925 events.
5926
5927 """
0085ce49
RD		 5928 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5929 def __init__(self): raise AttributeError, "No constructor defined"
5930 __repr__ = _swig_repr
e811c8ce 5931 def GetPosition(*args, **kwargs):
5ba5649b
RD		 5932 """
5933 GetPosition(self) -> Point
5934
5935 Returns the position at which the files were dropped.
5936 """
54f9ee45 5937 return _core_.DropFilesEvent_GetPosition(*args, **kwargs)
e811c8ce
RD		 5938
5939 def GetNumberOfFiles(*args, **kwargs):
5ba5649b
RD		 5940 """
5941 GetNumberOfFiles(self) -> int
5942
5943 Returns the number of files dropped.
5944 """
54f9ee45 5945 return _core_.DropFilesEvent_GetNumberOfFiles(*args, **kwargs)
e811c8ce
RD		 5946
5947 def GetFiles(*args, **kwargs):
5ba5649b
RD		 5948 """
5949 GetFiles(self) -> PyObject
5950
5951 Returns a list of the filenames that were dropped.
5952 """
54f9ee45 5953 return _core_.DropFilesEvent_GetFiles(*args, **kwargs)
e811c8ce 5954
2bf58437
RD		 5955 Files = property(GetFiles,doc="See `GetFiles`")
5956 NumberOfFiles = property(GetNumberOfFiles,doc="See `GetNumberOfFiles`")
5957 Position = property(GetPosition,doc="See `GetPosition`")
2131d850 5958_core_.DropFilesEvent_swigregister(DropFilesEvent)
d14a1e28
RD		 5959
5960#---------------------------------------------------------------------------
5961
54f9ee45
RD		 5962UPDATE_UI_PROCESS_ALL = _core_.UPDATE_UI_PROCESS_ALL
5963UPDATE_UI_PROCESS_SPECIFIED = _core_.UPDATE_UI_PROCESS_SPECIFIED
d14a1e28 5964class UpdateUIEvent(CommandEvent):
5ba5649b
RD		 5965 """
5966 This class is used for EVT_UPDATE_UI pseudo-events which are sent by
5967 wxWidgets to give an application the chance to update various user
5968 interface elements.
5969
5970 Without update UI events, an application has to work hard to
5971 check/uncheck, enable/disable, and set the text for elements such as
5972 menu items and toolbar buttons. The code for doing this has to be
5973 mixed up with the code that is invoked when an action is invoked for a
5974 menu item or button.
5975
5976 With update UI events, you define an event handler to look at the
5977 state of the application and change UI elements accordingly. wxWidgets
5978 will call your handler functions in idle time, so you don't have to
5979 worry where to call this code. In addition to being a clearer and more
5980 declarative method, it also means you don't have to worry whether
5981 you're updating a toolbar or menubar identifier. The same handler can
5982 update a menu item and toolbar button, if the ID values are the same.
5983
5984 Instead of directly manipulating the menu or button, you call
5985 functions in the event object, such as `Check`. wxWidgets will
5986 determine whether such a call has been made, and which UI element to
5987 update.
5988
5989 These events will work for popup menus as well as menubars. Just
5990 before a menu is popped up, `wx.Menu.UpdateUI` is called to process
5991 any UI events for the window that owns the menu.
5992
5993 If you find that the overhead of UI update processing is affecting
5994 your application, you can do one or both of the following:
5995
5996 1. Call `wx.UpdateUIEvent.SetMode` with a value of
5997 wx.UPDATE_UI_PROCESS_SPECIFIED, and set the extra style
5998 wx.WS_EX_PROCESS_UPDATE_EVENTS for every window that should
5999 receive update events. No other windows will receive update
6000 events.
6001
6002 2. Call `wx.UpdateUIEvent.SetUpdateInterval` with a millisecond
6003 value to set the delay between updates. You may need to call
6004 `wx.Window.UpdateWindowUI` at critical points, for example when
6005 a dialog is about to be shown, in case the user sees a slight
6006 delay before windows are updated.
6007
6008 Note that although events are sent in idle time, defining a EVT_IDLE
6009 handler for a window does not affect this because the events are sent
6010 from an internal idle handler.
6011
6012 wxWidgets tries to optimize update events on some platforms. On
6013 Windows and GTK+, events for menubar items are only sent when the menu
6014 is about to be shown, and not in idle time.
6015
6016 """
0085ce49
RD		 6017 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6018 __repr__ = _swig_repr
6019 def __init__(self, *args, **kwargs):
5ba5649b
RD		 6020 """
6021 __init__(self, int commandId=0) -> UpdateUIEvent
6022
6023 Constructor
6024 """
0085ce49 6025 _core_.UpdateUIEvent_swiginit(self,_core_.new_UpdateUIEvent(*args, **kwargs))
e811c8ce 6026 def GetChecked(*args, **kwargs):
5ba5649b
RD		 6027 """
6028 GetChecked(self) -> bool
6029
6030 Returns ``True`` if the UI element should be checked.
6031 """
54f9ee45 6032 return _core_.UpdateUIEvent_GetChecked(*args, **kwargs)
e811c8ce
RD		 6033
6034 def GetEnabled(*args, **kwargs):
5ba5649b
RD		 6035 """
6036 GetEnabled(self) -> bool
6037
6038 Returns ``True`` if the UI element should be enabled.
6039 """
54f9ee45 6040 return _core_.UpdateUIEvent_GetEnabled(*args, **kwargs)
e811c8ce 6041
b1fcee84
RD		 6042 def GetShown(*args, **kwargs):
6043 """
6044 GetShown(self) -> bool
6045
6046 Returns ``True`` if the UI element should be shown.
6047 """
6048 return _core_.UpdateUIEvent_GetShown(*args, **kwargs)
6049
e811c8ce 6050 def GetText(*args, **kwargs):
5ba5649b
RD		 6051 """
6052 GetText(self) -> String
6053
6054 Returns the text that should be set for the UI element.
6055 """
54f9ee45 6056 return _core_.UpdateUIEvent_GetText(*args, **kwargs)
e811c8ce
RD		 6057
6058 def GetSetText(*args, **kwargs):
5ba5649b
RD		 6059 """
6060 GetSetText(self) -> bool
6061
6062 Returns ``True`` if the application has called `SetText`. For
6063 wxWidgets internal use only.
6064 """
54f9ee45 6065 return _core_.UpdateUIEvent_GetSetText(*args, **kwargs)
e811c8ce
RD		 6066
6067 def GetSetChecked(*args, **kwargs):
5ba5649b
RD		 6068 """
6069 GetSetChecked(self) -> bool
6070
6071 Returns ``True`` if the application has called `Check`. For wxWidgets
6072 internal use only.
6073 """
54f9ee45 6074 return _core_.UpdateUIEvent_GetSetChecked(*args, **kwargs)
e811c8ce
RD		 6075
6076 def GetSetEnabled(*args, **kwargs):
5ba5649b
RD		 6077 """
6078 GetSetEnabled(self) -> bool
6079
6080 Returns ``True`` if the application has called `Enable`. For wxWidgets
6081 internal use only.
6082 """
54f9ee45 6083 return _core_.UpdateUIEvent_GetSetEnabled(*args, **kwargs)
e811c8ce 6084
b1fcee84
RD		 6085 def GetSetShown(*args, **kwargs):
6086 """
6087 GetSetShown(self) -> bool
6088
6089 Returns ``True`` if the application has called `Show`. For wxWidgets
6090 internal use only.
6091 """
6092 return _core_.UpdateUIEvent_GetSetShown(*args, **kwargs)
6093
e811c8ce 6094 def Check(*args, **kwargs):
5ba5649b
RD		 6095 """
6096 Check(self, bool check)
6097
6098 Check or uncheck the UI element.
6099 """
54f9ee45 6100 return _core_.UpdateUIEvent_Check(*args, **kwargs)
e811c8ce
RD		 6101
6102 def Enable(*args, **kwargs):
5ba5649b
RD		 6103 """
6104 Enable(self, bool enable)
6105
6106 Enable or disable the UI element.
6107 """
54f9ee45 6108 return _core_.UpdateUIEvent_Enable(*args, **kwargs)
e811c8ce 6109
b1fcee84
RD		 6110 def Show(*args, **kwargs):
6111 """
6112 Show(self, bool show)
6113
6114 Show or hide the UI element.
6115 """
6116 return _core_.UpdateUIEvent_Show(*args, **kwargs)
6117
e811c8ce 6118 def SetText(*args, **kwargs):
5ba5649b
RD		 6119 """
6120 SetText(self, String text)
6121
6122 Sets the text for this UI element.
6123 """
54f9ee45 6124 return _core_.UpdateUIEvent_SetText(*args, **kwargs)
e811c8ce
RD		 6125
6126 def SetUpdateInterval(*args, **kwargs):
5ba5649b
RD		 6127 """
6128 SetUpdateInterval(long updateInterval)
6129
6130 Sets the interval between updates in milliseconds. Set to -1 to
6131 disable updates, or to 0 to update as frequently as possible. The
6132 default is 0.
6133
6134 Use this to reduce the overhead of UI update events if your
6135 application has a lot of windows. If you set the value to -1 or
6136 greater than 0, you may also need to call `wx.Window.UpdateWindowUI`
6137 at appropriate points in your application, such as when a dialog is
6138 about to be shown.
6139 """
54f9ee45 6140 return _core_.UpdateUIEvent_SetUpdateInterval(*args, **kwargs)
e811c8ce
RD		 6141
6142 SetUpdateInterval = staticmethod(SetUpdateInterval)
6143 def GetUpdateInterval(*args, **kwargs):
5ba5649b
RD		 6144 """
6145 GetUpdateInterval() -> long
6146
6147 Returns the current interval between updates in milliseconds. -1
6148 disables updates, 0 updates as frequently as possible.
6149 """
54f9ee45 6150 return _core_.UpdateUIEvent_GetUpdateInterval(*args, **kwargs)
e811c8ce
RD		 6151
6152 GetUpdateInterval = staticmethod(GetUpdateInterval)
6153 def CanUpdate(*args, **kwargs):
5ba5649b
RD		 6154 """
6155 CanUpdate(Window win) -> bool
6156
6157 Returns ``True`` if it is appropriate to update (send UI update events
6158 to) this window.
6159
6160 This function looks at the mode used (see `wx.UpdateUIEvent.SetMode`),
6161 the wx.WS_EX_PROCESS_UPDATE_EVENTS flag in window, the time update
6162 events were last sent in idle time, and the update interval, to
6163 determine whether events should be sent to this window now. By default
6164 this will always return true because the update mode is initially
6165 wx.UPDATE_UI_PROCESS_ALL and the interval is set to 0; so update
6166 events will be sent as often as possible. You can reduce the frequency
6167 that events are sent by changing the mode and/or setting an update
6168 interval.
6169
6170 """
54f9ee45 6171 return _core_.UpdateUIEvent_CanUpdate(*args, **kwargs)
e811c8ce
RD		 6172
6173 CanUpdate = staticmethod(CanUpdate)
6174 def ResetUpdateTime(*args, **kwargs):
5ba5649b
RD		 6175 """
6176 ResetUpdateTime()
6177
6178 Used internally to reset the last-updated time to the current time. It
6179 is assumed that update events are normally sent in idle time, so this
6180 is called at the end of idle processing.
6181 """
54f9ee45 6182 return _core_.UpdateUIEvent_ResetUpdateTime(*args, **kwargs)
e811c8ce
RD		 6183
6184 ResetUpdateTime = staticmethod(ResetUpdateTime)
6185 def SetMode(*args, **kwargs):
5ba5649b
RD		 6186 """
6187 SetMode(int mode)
6188
6189 Specify how wxWidgets will send update events: to all windows, or only
6190 to those which specify that they will process the events.
6191
6192 The mode may be one of the following values:
6193
6194 ============================= ==========================================
6195 wxUPDATE_UI_PROCESS_ALL Send UI update events to all windows. This
6196 is the default setting.
6197 wxUPDATE_UI_PROCESS_SPECIFIED Send UI update events only to windows that
6198 have the wx.WS_EX_PROCESS_UI_UPDATES extra
6199 style set.
6200 ============================= ==========================================
6201
6202 """
54f9ee45 6203 return _core_.UpdateUIEvent_SetMode(*args, **kwargs)
e811c8ce
RD		 6204
6205 SetMode = staticmethod(SetMode)
6206 def GetMode(*args, **kwargs):
5ba5649b
RD		 6207 """
6208 GetMode() -> int
6209
6210 Returns a value specifying how wxWidgets will send update events: to
6211 all windows, or only to those which specify that they will process the
6212 events.
6213 """
54f9ee45 6214 return _core_.UpdateUIEvent_GetMode(*args, **kwargs)
e811c8ce
RD		 6215
6216 GetMode = staticmethod(GetMode)
dba7934c
RD		 6217 Checked = property(GetChecked,Check,doc="See `GetChecked`")
6218 Enabled = property(GetEnabled,Enable,doc="See `GetEnabled`")
6219 Shown = property(GetShown,Show,doc="See `GetShown`")
6220 Text = property(GetText,SetText,doc="See `GetText` and `SetText`")
2131d850 6221_core_.UpdateUIEvent_swigregister(UpdateUIEvent)
d14a1e28 6222
e811c8ce 6223def UpdateUIEvent_SetUpdateInterval(*args, **kwargs):
0085ce49 6224 """
5ba5649b
RD		 6225 UpdateUIEvent_SetUpdateInterval(long updateInterval)
6226
6227 Sets the interval between updates in milliseconds. Set to -1 to
6228 disable updates, or to 0 to update as frequently as possible. The
6229 default is 0.
6230
6231 Use this to reduce the overhead of UI update events if your
6232 application has a lot of windows. If you set the value to -1 or
6233 greater than 0, you may also need to call `wx.Window.UpdateWindowUI`
6234 at appropriate points in your application, such as when a dialog is
6235 about to be shown.
6236 """
0085ce49 6237 return _core_.UpdateUIEvent_SetUpdateInterval(*args, **kwargs)
d14a1e28 6238
0085ce49
RD		 6239def UpdateUIEvent_GetUpdateInterval(*args):
6240 """
5ba5649b
RD		 6241 UpdateUIEvent_GetUpdateInterval() -> long
6242
6243 Returns the current interval between updates in milliseconds. -1
6244 disables updates, 0 updates as frequently as possible.
6245 """
0085ce49 6246 return _core_.UpdateUIEvent_GetUpdateInterval(*args)
d14a1e28 6247
e811c8ce 6248def UpdateUIEvent_CanUpdate(*args, **kwargs):
0085ce49 6249 """
5ba5649b
RD		 6250 UpdateUIEvent_CanUpdate(Window win) -> bool
6251
6252 Returns ``True`` if it is appropriate to update (send UI update events
6253 to) this window.
6254
6255 This function looks at the mode used (see `wx.UpdateUIEvent.SetMode`),
6256 the wx.WS_EX_PROCESS_UPDATE_EVENTS flag in window, the time update
6257 events were last sent in idle time, and the update interval, to
6258 determine whether events should be sent to this window now. By default
6259 this will always return true because the update mode is initially
6260 wx.UPDATE_UI_PROCESS_ALL and the interval is set to 0; so update
6261 events will be sent as often as possible. You can reduce the frequency
6262 that events are sent by changing the mode and/or setting an update
6263 interval.
6264
6265 """
0085ce49 6266 return _core_.UpdateUIEvent_CanUpdate(*args, **kwargs)
d14a1e28 6267
0085ce49
RD		 6268def UpdateUIEvent_ResetUpdateTime(*args):
6269 """
5ba5649b
RD		 6270 UpdateUIEvent_ResetUpdateTime()
6271
6272 Used internally to reset the last-updated time to the current time. It
6273 is assumed that update events are normally sent in idle time, so this
6274 is called at the end of idle processing.
6275 """
0085ce49 6276 return _core_.UpdateUIEvent_ResetUpdateTime(*args)
d14a1e28 6277
e811c8ce 6278def UpdateUIEvent_SetMode(*args, **kwargs):
0085ce49 6279 """
5ba5649b
RD		 6280 UpdateUIEvent_SetMode(int mode)
6281
6282 Specify how wxWidgets will send update events: to all windows, or only
6283 to those which specify that they will process the events.
6284
6285 The mode may be one of the following values:
6286
6287 ============================= ==========================================
6288 wxUPDATE_UI_PROCESS_ALL Send UI update events to all windows. This
6289 is the default setting.
6290 wxUPDATE_UI_PROCESS_SPECIFIED Send UI update events only to windows that
6291 have the wx.WS_EX_PROCESS_UI_UPDATES extra
6292 style set.
6293 ============================= ==========================================
6294
6295 """
0085ce49 6296 return _core_.UpdateUIEvent_SetMode(*args, **kwargs)
d14a1e28 6297
0085ce49
RD		 6298def UpdateUIEvent_GetMode(*args):
6299 """
5ba5649b
RD		 6300 UpdateUIEvent_GetMode() -> int
6301
6302 Returns a value specifying how wxWidgets will send update events: to
6303 all windows, or only to those which specify that they will process the
6304 events.
6305 """
0085ce49 6306 return _core_.UpdateUIEvent_GetMode(*args)
d14a1e28
RD		 6307
6308#---------------------------------------------------------------------------
6309
6310class SysColourChangedEvent(Event):
5ba5649b
RD		 6311 """
6312 This class is used for EVT_SYS_COLOUR_CHANGED, which are generated
6313 when the user changes the colour settings using the control
6314 panel. This is only applicable under Windows.
6315
6316 The default event handler for this event propagates the event to child
6317 windows, since Windows only sends the events to top-level windows. If
6318 intercepting this event for a top-level window, remember to call
6319 `Skip` so the the base class handler will still be executed, or to
6320 pass the event on to the window's children explicitly.
6321
6322 """
0085ce49
RD		 6323 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6324 __repr__ = _swig_repr
6325 def __init__(self, *args, **kwargs):
5ba5649b
RD		 6326 """
6327 __init__(self) -> SysColourChangedEvent
6328
6329 Constructor
6330 """
0085ce49 6331 _core_.SysColourChangedEvent_swiginit(self,_core_.new_SysColourChangedEvent(*args, **kwargs))
2131d850 6332_core_.SysColourChangedEvent_swigregister(SysColourChangedEvent)
d14a1e28
RD		 6333
6334#---------------------------------------------------------------------------
6335
6336class MouseCaptureChangedEvent(Event):
5ba5649b
RD		 6337 """
6338 An mouse capture changed event (EVT_MOUSE_CAPTURE_CHANGED) is sent to
6339 a window that loses its mouse capture. This is called even if
6340 `wx.Window.ReleaseMouse` was called by the application code. Handling
6341 this event allows an application to cater for unexpected capture
6342 releases which might otherwise confuse mouse handling code.
6343
6344 This event is implemented under Windows only.
6345 """
0085ce49
RD		 6346 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6347 __repr__ = _swig_repr
6348 def __init__(self, *args, **kwargs):
5ba5649b
RD		 6349 """
6350 __init__(self, int winid=0, Window gainedCapture=None) -> MouseCaptureChangedEvent
6351
6352 Constructor
6353 """
0085ce49 6354 _core_.MouseCaptureChangedEvent_swiginit(self,_core_.new_MouseCaptureChangedEvent(*args, **kwargs))
e811c8ce 6355 def GetCapturedWindow(*args, **kwargs):
5ba5649b
RD		 6356 """
6357 GetCapturedWindow(self) -> Window
6358
6359 Returns the window that gained the capture, or ``None`` if it was a
6360 non-wxWidgets window.
6361 """
54f9ee45 6362 return _core_.MouseCaptureChangedEvent_GetCapturedWindow(*args, **kwargs)
e811c8ce 6363
57332a5a 6364 CapturedWindow = property(GetCapturedWindow,doc="See `GetCapturedWindow`")
2131d850 6365_core_.MouseCaptureChangedEvent_swigregister(MouseCaptureChangedEvent)
d14a1e28
RD		 6366
6367#---------------------------------------------------------------------------
6368
34e0a3bb
RD		 6369class MouseCaptureLostEvent(Event):
6370 """
6371 A mouse capture lost event is sent to a window that obtained mouse
6372 capture, which was subsequently loss due to "external" event, for
6373 example when a dialog box is shown or if another application captures
6374 the mouse.
6375
6376 If this happens, this event is sent to all windows that are on the
6377 capture stack (i.e. a window that called `wx.Window.CaptureMouse`, but
6378 didn't call `wx.Window.ReleaseMouse` yet). The event is *not* sent
6379 if the capture changes because of a call to CaptureMouse or
6380 ReleaseMouse.
6381
6382 This event is currently emitted under Windows only.
6383
6384 """
6385 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6386 __repr__ = _swig_repr
6387 def __init__(self, *args, **kwargs):
6388 """
6389 __init__(self, int winid=0) -> MouseCaptureLostEvent
6390
6391 A mouse capture lost event is sent to a window that obtained mouse
6392 capture, which was subsequently loss due to "external" event, for
6393 example when a dialog box is shown or if another application captures
6394 the mouse.
6395
6396 If this happens, this event is sent to all windows that are on the
6397 capture stack (i.e. a window that called `wx.Window.CaptureMouse`, but
6398 didn't call `wx.Window.ReleaseMouse` yet). The event is *not* sent
6399 if the capture changes because of a call to CaptureMouse or
6400 ReleaseMouse.
6401
6402 This event is currently emitted under Windows only.
6403
6404 """
6405 _core_.MouseCaptureLostEvent_swiginit(self,_core_.new_MouseCaptureLostEvent(*args, **kwargs))
6406_core_.MouseCaptureLostEvent_swigregister(MouseCaptureLostEvent)
6407
6408#---------------------------------------------------------------------------
6409
d14a1e28 6410class DisplayChangedEvent(Event):
5ba5649b
RD		 6411 """
6412 An EVT_DISPLAY_CHANGED event is sent to all windows when the display
6413 resolution has changed.
6414
6415 This event is implemented under Windows only.
6416 """
0085ce49
RD		 6417 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6418 __repr__ = _swig_repr
6419 def __init__(self, *args, **kwargs):
a95a7133 6420 """__init__(self) -> DisplayChangedEvent"""
0085ce49 6421 _core_.DisplayChangedEvent_swiginit(self,_core_.new_DisplayChangedEvent(*args, **kwargs))
2131d850 6422_core_.DisplayChangedEvent_swigregister(DisplayChangedEvent)
d14a1e28
RD		 6423
6424#---------------------------------------------------------------------------
6425
6426class PaletteChangedEvent(Event):
5ba5649b
RD		 6427 """
6428 An EVT_PALETTE_CHANGED event is sent when the system palette has
6429 changed, thereby giving each window a chance to redo their own to
6430 match.
6431
6432 This event is implemented under Windows only.
6433 """
0085ce49
RD		 6434 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6435 __repr__ = _swig_repr
6436 def __init__(self, *args, **kwargs):
5ba5649b
RD		 6437 """
6438 __init__(self, int id=0) -> PaletteChangedEvent
6439
6440 An EVT_PALETTE_CHANGED event is sent when the system palette has
6441 changed, thereby giving each window a chance to redo their own to
6442 match.
6443
6444 This event is implemented under Windows only.
6445 """
0085ce49 6446 _core_.PaletteChangedEvent_swiginit(self,_core_.new_PaletteChangedEvent(*args, **kwargs))
e811c8ce 6447 def SetChangedWindow(*args, **kwargs):
a95a7133 6448 """SetChangedWindow(self, Window win)"""
54f9ee45 6449 return _core_.PaletteChangedEvent_SetChangedWindow(*args, **kwargs)
e811c8ce
RD		 6450
6451 def GetChangedWindow(*args, **kwargs):
a95a7133 6452 """GetChangedWindow(self) -> Window"""
54f9ee45 6453 return _core_.PaletteChangedEvent_GetChangedWindow(*args, **kwargs)
e811c8ce 6454
33d6fd3b 6455 ChangedWindow = property(GetChangedWindow,SetChangedWindow,doc="See `GetChangedWindow` and `SetChangedWindow`")
2131d850 6456_core_.PaletteChangedEvent_swigregister(PaletteChangedEvent)
d14a1e28
RD		 6457
6458#---------------------------------------------------------------------------
6459
6460class QueryNewPaletteEvent(Event):
5ba5649b
RD		 6461 """
6462 An EVT_QUERY_NEW_PALETE event indicates the window is getting keyboard
6463 focus and should re-do its palette.
6464
6465 This event is implemented under Windows only.
6466 """
0085ce49
RD		 6467 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6468 __repr__ = _swig_repr
6469 def __init__(self, *args, **kwargs):
5ba5649b
RD		 6470 """
6471 __init__(self, int winid=0) -> QueryNewPaletteEvent
6472
6473 Constructor.
6474 """
0085ce49 6475 _core_.QueryNewPaletteEvent_swiginit(self,_core_.new_QueryNewPaletteEvent(*args, **kwargs))
e811c8ce 6476 def SetPaletteRealized(*args, **kwargs):
5ba5649b
RD		 6477 """
6478 SetPaletteRealized(self, bool realized)
6479
6480 App should set this if it changes the palette.
6481 """
54f9ee45 6482 return _core_.QueryNewPaletteEvent_SetPaletteRealized(*args, **kwargs)
e811c8ce
RD		 6483
6484 def GetPaletteRealized(*args, **kwargs):
a95a7133 6485 """GetPaletteRealized(self) -> bool"""
54f9ee45 6486 return _core_.QueryNewPaletteEvent_GetPaletteRealized(*args, **kwargs)
e811c8ce 6487
33d6fd3b 6488 PaletteRealized = property(GetPaletteRealized,SetPaletteRealized,doc="See `GetPaletteRealized` and `SetPaletteRealized`")
2131d850 6489_core_.QueryNewPaletteEvent_swigregister(QueryNewPaletteEvent)
d14a1e28
RD		 6490
6491#---------------------------------------------------------------------------
6492
6493class NavigationKeyEvent(Event):
5ba5649b
RD		 6494 """
6495 EVT_NAVIGATION_KEY events are used to control moving the focus between
6496 widgets, otherwise known as tab-traversal. You woudl normally not
6497 catch navigation events in applications as there are already
6498 appropriate handlers in `wx.Dialog` and `wx.Panel`, but you may find
6499 it useful to send navigation events in certain situations to change
6500 the focus in certain ways, although it's probably easier to just call
6501 `wx.Window.Navigate`.
6502 """
0085ce49
RD		 6503 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6504 __repr__ = _swig_repr
6505 def __init__(self, *args, **kwargs):
a95a7133 6506 """__init__(self) -> NavigationKeyEvent"""
0085ce49 6507 _core_.NavigationKeyEvent_swiginit(self,_core_.new_NavigationKeyEvent(*args, **kwargs))
e811c8ce 6508 def GetDirection(*args, **kwargs):
5ba5649b
RD		 6509 """
6510 GetDirection(self) -> bool
6511
6512 Returns ``True`` if the direction is forward, ``False`` otherwise.
6513 """
54f9ee45 6514 return _core_.NavigationKeyEvent_GetDirection(*args, **kwargs)
e811c8ce
RD		 6515
6516 def SetDirection(*args, **kwargs):
5ba5649b
RD		 6517 """
6518 SetDirection(self, bool forward)
6519
6520 Specify the direction that the navigation should take. Usually the
6521 difference between using Tab and Shift-Tab.
6522 """
54f9ee45 6523 return _core_.NavigationKeyEvent_SetDirection(*args, **kwargs)
e811c8ce
RD		 6524
6525 def IsWindowChange(*args, **kwargs):
5ba5649b
RD		 6526 """
6527 IsWindowChange(self) -> bool
6528
6529 Returns ``True`` if window change is allowed.
6530 """
54f9ee45 6531 return _core_.NavigationKeyEvent_IsWindowChange(*args, **kwargs)
e811c8ce
RD		 6532
6533 def SetWindowChange(*args, **kwargs):
5ba5649b
RD		 6534 """
6535 SetWindowChange(self, bool ischange)
6536
6537 Specify if the navigation should be able to change parent windows.
6538 For example, changing notebook pages, etc. This is usually implemented
6539 by using Control-Tab.
6540 """
54f9ee45 6541 return _core_.NavigationKeyEvent_SetWindowChange(*args, **kwargs)
e811c8ce 6542
68350608 6543 def IsFromTab(*args, **kwargs):
5ba5649b
RD		 6544 """
6545 IsFromTab(self) -> bool
6546
6547 Returns ``True`` if the navigation event is originated from the Tab
6548 key.
6549 """
68350608
RD		 6550 return _core_.NavigationKeyEvent_IsFromTab(*args, **kwargs)
6551
6552 def SetFromTab(*args, **kwargs):
5ba5649b
RD		 6553 """
6554 SetFromTab(self, bool bIs)
6555
6556 Set to true under MSW if the event was generated using the tab key.
6557 This is required for proper navogation over radio buttons.
6558 """
68350608
RD		 6559 return _core_.NavigationKeyEvent_SetFromTab(*args, **kwargs)
6560
908b74cd 6561 def SetFlags(*args, **kwargs):
5ba5649b
RD		 6562 """
6563 SetFlags(self, long flags)
6564
6565 Set the navigation flags to a combination of the following:
6566
6567 * wx.NavigationKeyEvent.IsBackward
6568 * wx.NavigationKeyEvent.IsForward
6569 * wx.NavigationKeyEvent.WinChange
6570 * wx.NavigationKeyEvent.FromTab
6571
6572 """
908b74cd
RD		 6573 return _core_.NavigationKeyEvent_SetFlags(*args, **kwargs)
6574
e811c8ce 6575 def GetCurrentFocus(*args, **kwargs):
5ba5649b
RD		 6576 """
6577 GetCurrentFocus(self) -> Window
6578
6579 Returns the child window which currenty has the focus. May be
6580 ``None``.
6581 """
54f9ee45 6582 return _core_.NavigationKeyEvent_GetCurrentFocus(*args, **kwargs)
e811c8ce
RD		 6583
6584 def SetCurrentFocus(*args, **kwargs):
5ba5649b
RD		 6585 """
6586 SetCurrentFocus(self, Window win)
6587
6588 Set the window that has the focus.
6589 """
54f9ee45 6590 return _core_.NavigationKeyEvent_SetCurrentFocus(*args, **kwargs)
e811c8ce 6591
b0f7404b 6592 IsBackward = _core_.NavigationKeyEvent_IsBackward
908b74cd
RD		 6593 IsForward = _core_.NavigationKeyEvent_IsForward
6594 WinChange = _core_.NavigationKeyEvent_WinChange
68350608 6595 FromTab = _core_.NavigationKeyEvent_FromTab
57332a5a
RD		 6596 CurrentFocus = property(GetCurrentFocus,SetCurrentFocus,doc="See `GetCurrentFocus` and `SetCurrentFocus`")
6597 Direction = property(GetDirection,SetDirection,doc="See `GetDirection` and `SetDirection`")
2131d850 6598_core_.NavigationKeyEvent_swigregister(NavigationKeyEvent)
d14a1e28
RD		 6599
6600#---------------------------------------------------------------------------
6601
6602class WindowCreateEvent(CommandEvent):
5ba5649b
RD		 6603 """
6604 The EVT_WINDOW_CREATE event is sent as soon as the window object (the
6605 underlying GUI object) exists.
6606 """
0085ce49
RD		 6607 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6608 __repr__ = _swig_repr
6609 def __init__(self, *args, **kwargs):
5ba5649b
RD		 6610 """
6611 __init__(self, Window win=None) -> WindowCreateEvent
6612
6613 The EVT_WINDOW_CREATE event is sent as soon as the window object (the
6614 underlying GUI object) exists.
6615 """
0085ce49 6616 _core_.WindowCreateEvent_swiginit(self,_core_.new_WindowCreateEvent(*args, **kwargs))
e811c8ce 6617 def GetWindow(*args, **kwargs):
5ba5649b
RD		 6618 """
6619 GetWindow(self) -> Window
6620
6621 Returns the window that this event refers to.
6622 """
54f9ee45 6623 return _core_.WindowCreateEvent_GetWindow(*args, **kwargs)
e811c8ce 6624
dba7934c 6625 Window = property(GetWindow,doc="See `GetWindow`")
2131d850 6626_core_.WindowCreateEvent_swigregister(WindowCreateEvent)
d14a1e28
RD		 6627
6628class WindowDestroyEvent(CommandEvent):
5ba5649b 6629 """
943e8dfd
RD		 6630 The EVT_WINDOW_DESTROY event is sent from the `wx.Window` destructor
6631 when the GUI window is destroyed.
6632
6633 When a class derived from `wx.Window` is destroyed its destructor will
6634 have already run by the time this event is sent. Therefore this event
6635 will not usually be received at all by the window itself. Since it is
6636 received after the destructor has run, an object should not try to
6637 handle its own wx.WindowDestroyEvent, but it can be used to get
6638 notification of the destruction of another window.
5ba5649b 6639 """
0085ce49
RD		 6640 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6641 __repr__ = _swig_repr
6642 def __init__(self, *args, **kwargs):
5ba5649b
RD		 6643 """
6644 __init__(self, Window win=None) -> WindowDestroyEvent
6645
943e8dfd
RD		 6646 The EVT_WINDOW_DESTROY event is sent from the `wx.Window` destructor
6647 when the GUI window is destroyed.
6648
6649 When a class derived from `wx.Window` is destroyed its destructor will
6650 have already run by the time this event is sent. Therefore this event
6651 will not usually be received at all by the window itself. Since it is
6652 received after the destructor has run, an object should not try to
6653 handle its own wx.WindowDestroyEvent, but it can be used to get
6654 notification of the destruction of another window.
5ba5649b 6655 """
0085ce49 6656 _core_.WindowDestroyEvent_swiginit(self,_core_.new_WindowDestroyEvent(*args, **kwargs))
e811c8ce 6657 def GetWindow(*args, **kwargs):
5ba5649b
RD		 6658 """
6659 GetWindow(self) -> Window
6660
6661 Returns the window that this event refers to.
6662 """
54f9ee45 6663 return _core_.WindowDestroyEvent_GetWindow(*args, **kwargs)
e811c8ce 6664
dba7934c 6665 Window = property(GetWindow,doc="See `GetWindow`")
2131d850 6666_core_.WindowDestroyEvent_swigregister(WindowDestroyEvent)
d14a1e28
RD		 6667
6668#---------------------------------------------------------------------------
6669
6670class ContextMenuEvent(CommandEvent):
5ba5649b
RD		 6671 """
6672 This class is used for context menu events (EVT_CONTECT_MENU,) sent to
6673 give the application a chance to show a context (popup) menu.
6674 """
0085ce49
RD		 6675 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6676 __repr__ = _swig_repr
6677 def __init__(self, *args, **kwargs):
5ba5649b 6678 """
2131d850 6679 __init__(self, EventType type=wxEVT_NULL, int winid=0, Point pt=DefaultPosition) -> ContextMenuEvent
5ba5649b
RD		 6680
6681 Constructor.
6682 """
0085ce49 6683 _core_.ContextMenuEvent_swiginit(self,_core_.new_ContextMenuEvent(*args, **kwargs))
e811c8ce 6684 def GetPosition(*args, **kwargs):
5ba5649b
RD		 6685 """
6686 GetPosition(self) -> Point
6687
6688 Returns the position (in screen coordinants) at which the menu should
6689 be shown.
6690 """
54f9ee45 6691 return _core_.ContextMenuEvent_GetPosition(*args, **kwargs)
e811c8ce
RD		 6692
6693 def SetPosition(*args, **kwargs):
5ba5649b
RD		 6694 """
6695 SetPosition(self, Point pos)
6696
6697 Sets the position at which the menu should be shown.
6698 """
54f9ee45 6699 return _core_.ContextMenuEvent_SetPosition(*args, **kwargs)
e811c8ce 6700
2bf58437 6701 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
2131d850 6702_core_.ContextMenuEvent_swigregister(ContextMenuEvent)
d14a1e28
RD		 6703
6704#---------------------------------------------------------------------------
6705
54f9ee45
RD		 6706IDLE_PROCESS_ALL = _core_.IDLE_PROCESS_ALL
6707IDLE_PROCESS_SPECIFIED = _core_.IDLE_PROCESS_SPECIFIED
d14a1e28 6708class IdleEvent(Event):
5ba5649b
RD		 6709 """
6710 This class is used for EVT_IDLE events, which are generated and sent
6711 when the application *becomes* idle. In other words, the when the
6712 event queue becomes empty then idle events are sent to all windows (by
6713 default) and as long as none of them call `RequestMore` then there are
6714 no more idle events until after the system event queue has some normal
6715 events and then becomes empty again.
6716
6717 By default, idle events are sent to all windows. If this is causing a
6718 significant overhead in your application, you can call
6719 `wx.IdleEvent.SetMode` with the value wx.IDLE_PROCESS_SPECIFIED, and
6720 set the wx.WS_EX_PROCESS_IDLE extra window style for every window
6721 which should receive idle events. Then idle events will only be sent
6722 to those windows and not to any others.
6723 """
0085ce49
RD		 6724 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6725 __repr__ = _swig_repr
6726 def __init__(self, *args, **kwargs):
5ba5649b
RD		 6727 """
6728 __init__(self) -> IdleEvent
6729
6730 Constructor
6731 """
0085ce49 6732 _core_.IdleEvent_swiginit(self,_core_.new_IdleEvent(*args, **kwargs))
e811c8ce 6733 def RequestMore(*args, **kwargs):
5ba5649b
RD		 6734 """
6735 RequestMore(self, bool needMore=True)
6736
6737 Tells wxWidgets that more processing is required. This function can be
6738 called by an EVT_IDLE handler for a window to indicate that the
6739 application should forward the EVT_IDLE event once more to the
6740 application windows. If no window calls this function during its
6741 EVT_IDLE handler, then the application will remain in a passive event
6742 loop until a new event is posted to the application by the windowing
6743 system.
6744 """
54f9ee45 6745 return _core_.IdleEvent_RequestMore(*args, **kwargs)
e811c8ce
RD		 6746
6747 def MoreRequested(*args, **kwargs):
5ba5649b
RD		 6748 """
6749 MoreRequested(self) -> bool
6750
6751 Returns ``True`` if the OnIdle function processing this event
6752 requested more processing time.
6753 """
54f9ee45 6754 return _core_.IdleEvent_MoreRequested(*args, **kwargs)
e811c8ce
RD		 6755
6756 def SetMode(*args, **kwargs):
5ba5649b
RD		 6757 """
6758 SetMode(int mode)
6759
6760 Static method for specifying how wxWidgets will send idle events: to
6761 all windows, or only to those which specify that they will process the
6762 events.
6763
6764 The mode can be one of the following values:
6765
6766 ========================= ========================================
6767 wx.IDLE_PROCESS_ALL Send idle events to all windows
6768 wx.IDLE_PROCESS_SPECIFIED Send idle events only to windows that have
6769 the wx.WS_EX_PROCESS_IDLE extra style
6770 flag set.
6771 ========================= ========================================
6772
6773 """
54f9ee45 6774 return _core_.IdleEvent_SetMode(*args, **kwargs)
e811c8ce
RD		 6775
6776 SetMode = staticmethod(SetMode)
6777 def GetMode(*args, **kwargs):
5ba5649b
RD		 6778 """
6779 GetMode() -> int
6780
6781 Static method returning a value specifying how wxWidgets will send
6782 idle events: to all windows, or only to those which specify that they
6783 will process the events.
6784 """
54f9ee45 6785 return _core_.IdleEvent_GetMode(*args, **kwargs)
e811c8ce
RD		 6786
6787 GetMode = staticmethod(GetMode)
6788 def CanSend(*args, **kwargs):
5ba5649b
RD		 6789 """
6790 CanSend(Window win) -> bool
6791
6792 Returns ``True`` if it is appropriate to send idle events to this
6793 window.
6794
6795 This function looks at the mode used (see `wx.IdleEvent.SetMode`), and
6796 the wx.WS_EX_PROCESS_IDLE style in window to determine whether idle
6797 events should be sent to this window now. By default this will always
6798 return ``True`` because the update mode is initially
6799 wx.IDLE_PROCESS_ALL. You can change the mode to only send idle events
6800 to windows with the wx.WS_EX_PROCESS_IDLE extra window style set.
6801 """
54f9ee45 6802 return _core_.IdleEvent_CanSend(*args, **kwargs)
e811c8ce
RD		 6803
6804 CanSend = staticmethod(CanSend)
2131d850 6805_core_.IdleEvent_swigregister(IdleEvent)
d14a1e28 6806
e811c8ce 6807def IdleEvent_SetMode(*args, **kwargs):
0085ce49 6808 """
5ba5649b
RD		 6809 IdleEvent_SetMode(int mode)
6810
6811 Static method for specifying how wxWidgets will send idle events: to
6812 all windows, or only to those which specify that they will process the
6813 events.
6814
6815 The mode can be one of the following values:
6816
6817 ========================= ========================================
6818 wx.IDLE_PROCESS_ALL Send idle events to all windows
6819 wx.IDLE_PROCESS_SPECIFIED Send idle events only to windows that have
6820 the wx.WS_EX_PROCESS_IDLE extra style
6821 flag set.
6822 ========================= ========================================
6823
6824 """
0085ce49 6825 return _core_.IdleEvent_SetMode(*args, **kwargs)
d14a1e28 6826
0085ce49
RD		 6827def IdleEvent_GetMode(*args):
6828 """
5ba5649b
RD		 6829 IdleEvent_GetMode() -> int
6830
6831 Static method returning a value specifying how wxWidgets will send
6832 idle events: to all windows, or only to those which specify that they
6833 will process the events.
6834 """
0085ce49 6835 return _core_.IdleEvent_GetMode(*args)
d14a1e28 6836
e811c8ce 6837def IdleEvent_CanSend(*args, **kwargs):
0085ce49 6838 """
5ba5649b
RD		 6839 IdleEvent_CanSend(Window win) -> bool
6840
6841 Returns ``True`` if it is appropriate to send idle events to this
6842 window.
6843
6844 This function looks at the mode used (see `wx.IdleEvent.SetMode`), and
6845 the wx.WS_EX_PROCESS_IDLE style in window to determine whether idle
6846 events should be sent to this window now. By default this will always
6847 return ``True`` because the update mode is initially
6848 wx.IDLE_PROCESS_ALL. You can change the mode to only send idle events
6849 to windows with the wx.WS_EX_PROCESS_IDLE extra window style set.
6850 """
0085ce49 6851 return _core_.IdleEvent_CanSend(*args, **kwargs)
d14a1e28
RD		 6852
6853#---------------------------------------------------------------------------
6854
2131d850
RD		 6855class ClipboardTextEvent(CommandEvent):
6856 """
6857 A Clipboard Text event is sent when a window intercepts a text
6858 copy/cut/paste message, i.e. the user has cut/copied/pasted data
6859 from/into a text control via ctrl-C/X/V, ctrl/shift-del/insert, a
6860 popup menu command, etc. NOTE : under windows these events are *NOT*
6861 generated automatically for a Rich Edit text control.
6862 """
6863 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6864 __repr__ = _swig_repr
6865 def __init__(self, *args, **kwargs):
6866 """
6867 __init__(self, EventType type=wxEVT_NULL, int winid=0) -> ClipboardTextEvent
6868
6869 A Clipboard Text event is sent when a window intercepts a text
6870 copy/cut/paste message, i.e. the user has cut/copied/pasted data
6871 from/into a text control via ctrl-C/X/V, ctrl/shift-del/insert, a
6872 popup menu command, etc. NOTE : under windows these events are *NOT*
6873 generated automatically for a Rich Edit text control.
6874 """
6875 _core_.ClipboardTextEvent_swiginit(self,_core_.new_ClipboardTextEvent(*args, **kwargs))
6876_core_.ClipboardTextEvent_swigregister(ClipboardTextEvent)
6877
6878#---------------------------------------------------------------------------
6879
d14a1e28 6880class PyEvent(Event):
5ba5649b
RD		 6881 """
6882 wx.PyEvent can be used as a base class for implementing custom event
6883 types in Python. You should derived from this class instead of
6884 `wx.Event` because this class is Python-aware and is able to transport
6885 its Python bits safely through the wxWidgets event system and have
6886 them still be there when the event handler is invoked.
6887
6888 :see: `wx.PyCommandEvent`
6889
6890 """
0085ce49
RD		 6891 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6892 __repr__ = _swig_repr
6893 def __init__(self, *args, **kwargs):
2131d850 6894 """__init__(self, int winid=0, EventType eventType=wxEVT_NULL) -> PyEvent"""
0085ce49 6895 _core_.PyEvent_swiginit(self,_core_.new_PyEvent(*args, **kwargs))
5ba5649b 6896 self._SetSelf(self)
e811c8ce 6897
0085ce49
RD		 6898 __swig_destroy__ = _core_.delete_PyEvent
6899 __del__ = lambda self : None;
5ba5649b
RD		 6900 def _SetSelf(*args, **kwargs):
6901 """_SetSelf(self, PyObject self)"""
6902 return _core_.PyEvent__SetSelf(*args, **kwargs)
e811c8ce 6903
5ba5649b
RD		 6904 def _GetSelf(*args, **kwargs):
6905 """_GetSelf(self) -> PyObject"""
6906 return _core_.PyEvent__GetSelf(*args, **kwargs)
e811c8ce 6907
2131d850 6908_core_.PyEvent_swigregister(PyEvent)
d14a1e28
RD		 6909
6910class PyCommandEvent(CommandEvent):
5ba5649b
RD		 6911 """
6912 wx.PyCommandEvent can be used as a base class for implementing custom
6913 event types in Python, where the event shoudl travel up to parent
6914 windows looking for a handler. You should derived from this class
6915 instead of `wx.CommandEvent` because this class is Python-aware and is
6916 able to transport its Python bits safely through the wxWidgets event
6917 system and have them still be there when the event handler is invoked.
6918
6919 :see: `wx.PyEvent`
6920
6921 """
0085ce49
RD		 6922 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6923 __repr__ = _swig_repr
6924 def __init__(self, *args, **kwargs):
2131d850 6925 """__init__(self, EventType eventType=wxEVT_NULL, int id=0) -> PyCommandEvent"""
0085ce49 6926 _core_.PyCommandEvent_swiginit(self,_core_.new_PyCommandEvent(*args, **kwargs))
5ba5649b 6927 self._SetSelf(self)
e811c8ce 6928
0085ce49
RD		 6929 __swig_destroy__ = _core_.delete_PyCommandEvent
6930 __del__ = lambda self : None;
5ba5649b
RD		 6931 def _SetSelf(*args, **kwargs):
6932 """_SetSelf(self, PyObject self)"""
6933 return _core_.PyCommandEvent__SetSelf(*args, **kwargs)
e811c8ce 6934
5ba5649b
RD		 6935 def _GetSelf(*args, **kwargs):
6936 """_GetSelf(self) -> PyObject"""
6937 return _core_.PyCommandEvent__GetSelf(*args, **kwargs)
e811c8ce 6938
2131d850 6939_core_.PyCommandEvent_swigregister(PyCommandEvent)
d14a1e28 6940
53aa7709 6941class DateEvent(CommandEvent):
5ba5649b
RD		 6942 """
6943 This event class holds information about a date change event and is
6944 used together with `wx.DatePickerCtrl`. It also serves as a base class
6945 for `wx.calendar.CalendarEvent`. Bind these event types with
6946 EVT_DATE_CHANGED.
6947 """
0085ce49
RD		 6948 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6949 __repr__ = _swig_repr
6950 def __init__(self, *args, **kwargs):
2131d850 6951 """__init__(self, Window win, DateTime dt, EventType type) -> DateEvent"""
0085ce49 6952 _core_.DateEvent_swiginit(self,_core_.new_DateEvent(*args, **kwargs))
53aa7709 6953 def GetDate(*args, **kwargs):
5ba5649b
RD		 6954 """
6955 GetDate(self) -> DateTime
6956
6957 Returns the date.
6958 """
53aa7709
RD		 6959 return _core_.DateEvent_GetDate(*args, **kwargs)
6960
6961 def SetDate(*args, **kwargs):
5ba5649b
RD		 6962 """
6963 SetDate(self, DateTime date)
6964
6965 Sets the date carried by the event, normally only used by the library
6966 internally.
6967 """
53aa7709
RD		 6968 return _core_.DateEvent_SetDate(*args, **kwargs)
6969
2bf58437 6970 Date = property(GetDate,SetDate,doc="See `GetDate` and `SetDate`")
2131d850 6971_core_.DateEvent_swigregister(DateEvent)
53aa7709
RD		 6972
6973wxEVT_DATE_CHANGED = _core_.wxEVT_DATE_CHANGED
6974EVT_DATE_CHANGED = wx.PyEventBinder( wxEVT_DATE_CHANGED, 1 )
6975
d14a1e28
RD		 6976#---------------------------------------------------------------------------
6977
54f9ee45
RD		 6978PYAPP_ASSERT_SUPPRESS = _core_.PYAPP_ASSERT_SUPPRESS
6979PYAPP_ASSERT_EXCEPTION = _core_.PYAPP_ASSERT_EXCEPTION
6980PYAPP_ASSERT_DIALOG = _core_.PYAPP_ASSERT_DIALOG
6981PYAPP_ASSERT_LOG = _core_.PYAPP_ASSERT_LOG
6982PRINT_WINDOWS = _core_.PRINT_WINDOWS
6983PRINT_POSTSCRIPT = _core_.PRINT_POSTSCRIPT
d14a1e28 6984class PyApp(EvtHandler):
66c033b4
RD		 6985 """
6986 The ``wx.PyApp`` class is an *implementation detail*, please use the
6987 `wx.App` class (or some other derived class) instead.
6988 """
0085ce49
RD		 6989 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6990 __repr__ = _swig_repr
6991 def __init__(self, *args, **kwargs):
98e665d3 6992 """
a95a7133 6993 __init__(self) -> PyApp
98e665d3
RD		 6994
6995 Create a new application object, starting the bootstrap process.
6996 """
0085ce49 6997 _core_.PyApp_swiginit(self,_core_.new_PyApp(*args, **kwargs))
70b7a5fe
RD		 6998 self._setCallbackInfo(self, PyApp, False)
6999 self._setOORInfo(self, False)
e811c8ce 7000
0085ce49
RD		 7001 __swig_destroy__ = _core_.delete_PyApp
7002 __del__ = lambda self : None;
e811c8ce 7003 def _setCallbackInfo(*args, **kwargs):
70b7a5fe 7004 """_setCallbackInfo(self, PyObject self, PyObject _class, bool incref)"""
54f9ee45 7005 return _core_.PyApp__setCallbackInfo(*args, **kwargs)
e811c8ce
RD		 7006
7007 def GetAppName(*args, **kwargs):
0df68c9f 7008 """
a95a7133 7009 GetAppName(self) -> String
6c3b4aae 7010
0df68c9f
RD		 7011 Get the application name.
7012 """
54f9ee45 7013 return _core_.PyApp_GetAppName(*args, **kwargs)
e811c8ce
RD		 7014
7015 def SetAppName(*args, **kwargs):
0df68c9f 7016 """
a95a7133 7017 SetAppName(self, String name)
6c3b4aae 7018
66c033b4
RD		 7019 Set the application name. This value may be used automatically by
7020 `wx.Config` and such.
0df68c9f 7021 """
54f9ee45 7022 return _core_.PyApp_SetAppName(*args, **kwargs)
e811c8ce
RD		 7023
7024 def GetClassName(*args, **kwargs):
0df68c9f 7025 """
a95a7133 7026 GetClassName(self) -> String
e811c8ce 7027
0df68c9f
RD		 7028 Get the application's class name.
7029 """
54f9ee45 7030 return _core_.PyApp_GetClassName(*args, **kwargs)
e811c8ce
RD		 7031
7032 def SetClassName(*args, **kwargs):
0df68c9f 7033 """
a95a7133 7034 SetClassName(self, String name)
6c3b4aae 7035
66c033b4
RD		 7036 Set the application's class name. This value may be used for
7037 X-resources if applicable for the platform
0df68c9f 7038 """
54f9ee45 7039 return _core_.PyApp_SetClassName(*args, **kwargs)
e811c8ce
RD		 7040
7041 def GetVendorName(*args, **kwargs):
0df68c9f 7042 """
a95a7133 7043 GetVendorName(self) -> String
6c3b4aae 7044
0df68c9f
RD		 7045 Get the application's vendor name.
7046 """
54f9ee45 7047 return _core_.PyApp_GetVendorName(*args, **kwargs)
e811c8ce
RD		 7048
7049 def SetVendorName(*args, **kwargs):
0df68c9f 7050 """
a95a7133 7051 SetVendorName(self, String name)
6c3b4aae 7052
66c033b4
RD		 7053 Set the application's vendor name. This value may be used
7054 automatically by `wx.Config` and such.
0df68c9f 7055 """
54f9ee45 7056 return _core_.PyApp_SetVendorName(*args, **kwargs)
e811c8ce
RD		 7057
7058 def GetTraits(*args, **kwargs):
0df68c9f 7059 """
a95a7133 7060 GetTraits(self) -> wxAppTraits
6c3b4aae 7061
66c033b4
RD		 7062 Return (and create if necessary) the app traits object to which we
7063 delegate for everything which either should be configurable by the
7064 user (then he can change the default behaviour simply by overriding
7065 CreateTraits() and returning his own traits object) or which is
7066 GUI/console dependent as then wx.AppTraits allows us to abstract the
7067 differences behind the common facade.
7068
7069 :todo: Add support for overriding CreateAppTraits in wxPython.
0df68c9f 7070 """
54f9ee45 7071 return _core_.PyApp_GetTraits(*args, **kwargs)
e811c8ce
RD		 7072
7073 def ProcessPendingEvents(*args, **kwargs):
0df68c9f 7074 """
a95a7133 7075 ProcessPendingEvents(self)
6c3b4aae 7076
66c033b4
RD		 7077 Process all events in the Pending Events list -- it is necessary to
7078 call this function to process posted events. This normally happens
7079 during each event loop iteration.
0df68c9f 7080 """
54f9ee45 7081 return _core_.PyApp_ProcessPendingEvents(*args, **kwargs)
e811c8ce
RD		 7082
7083 def Yield(*args, **kwargs):
0df68c9f 7084 """
a95a7133 7085 Yield(self, bool onlyIfNeeded=False) -> bool
6c3b4aae 7086
66c033b4
RD		 7087 Process all currently pending events right now, instead of waiting
7088 until return to the event loop. It is an error to call ``Yield``
7089 recursively unless the value of ``onlyIfNeeded`` is True.
6c3b4aae 7090
66c033b4 7091 :warning: This function is dangerous as it can lead to unexpected
41e2b43e
RD		 7092 reentrancies (i.e. when called from an event handler it may
7093 result in calling the same event handler again), use with
7094 extreme care or, better, don't use at all!
0df68c9f 7095
66c033b4 7096 :see: `wx.Yield`, `wx.YieldIfNeeded`, `wx.SafeYield`
41e2b43e 7097
0df68c9f 7098 """
54f9ee45 7099 return _core_.PyApp_Yield(*args, **kwargs)
e811c8ce
RD		 7100
7101 def WakeUpIdle(*args, **kwargs):
0df68c9f 7102 """
a95a7133 7103 WakeUpIdle(self)
6c3b4aae 7104
66c033b4
RD		 7105 Make sure that idle events are sent again.
7106 :see: `wx.WakeUpIdle`
0df68c9f 7107 """
54f9ee45 7108 return _core_.PyApp_WakeUpIdle(*args, **kwargs)
e811c8ce 7109
1fc3b23a
RD		 7110 def IsMainLoopRunning(*args, **kwargs):
7111 """
7112 IsMainLoopRunning() -> bool
7113
7114 Returns True if we're running the main loop, i.e. if the events can
7115 currently be dispatched.
7116 """
7117 return _core_.PyApp_IsMainLoopRunning(*args, **kwargs)
7118
7119 IsMainLoopRunning = staticmethod(IsMainLoopRunning)
e811c8ce 7120 def MainLoop(*args, **kwargs):
0df68c9f 7121 """
a95a7133 7122 MainLoop(self) -> int
6c3b4aae 7123
66c033b4
RD		 7124 Execute the main GUI loop, the function doesn't normally return until
7125 all top level windows have been closed and destroyed.
0df68c9f 7126 """
54f9ee45 7127 return _core_.PyApp_MainLoop(*args, **kwargs)
e811c8ce
RD		 7128
7129 def Exit(*args, **kwargs):
0df68c9f 7130 """
a95a7133 7131 Exit(self)
6c3b4aae 7132
0df68c9f 7133 Exit the main loop thus terminating the application.
66c033b4 7134 :see: `wx.Exit`
0df68c9f 7135 """
54f9ee45 7136 return _core_.PyApp_Exit(*args, **kwargs)
e811c8ce 7137
97ab0f6a
RD		 7138 def GetLayoutDirection(*args, **kwargs):
7139 """
994453b8 7140 GetLayoutDirection(self) -> int
97ab0f6a
RD		 7141
7142 Return the layout direction for the current locale.
7143 """
7144 return _core_.PyApp_GetLayoutDirection(*args, **kwargs)
7145
e811c8ce 7146 def ExitMainLoop(*args, **kwargs):
0df68c9f 7147 """
a95a7133 7148 ExitMainLoop(self)
6c3b4aae 7149
66c033b4
RD		 7150 Exit the main GUI loop during the next iteration of the main
7151 loop, (i.e. it does not stop the program immediately!)
0df68c9f 7152 """
54f9ee45 7153 return _core_.PyApp_ExitMainLoop(*args, **kwargs)
e811c8ce
RD		 7154
7155 def Pending(*args, **kwargs):
0df68c9f 7156 """
a95a7133 7157 Pending(self) -> bool
6c3b4aae 7158
0df68c9f
RD		 7159 Returns True if there are unprocessed events in the event queue.
7160 """
54f9ee45 7161 return _core_.PyApp_Pending(*args, **kwargs)
e811c8ce
RD		 7162
7163 def Dispatch(*args, **kwargs):
0df68c9f 7164 """
a95a7133 7165 Dispatch(self) -> bool
6c3b4aae 7166
0df68c9f
RD		 7167 Process the first event in the event queue (blocks until an event
7168 appears if there are none currently)
7169 """
54f9ee45 7170 return _core_.PyApp_Dispatch(*args, **kwargs)
e811c8ce
RD		 7171
7172 def ProcessIdle(*args, **kwargs):
0df68c9f 7173 """
a95a7133 7174 ProcessIdle(self) -> bool
6c3b4aae 7175
66c033b4
RD		 7176 Called from the MainLoop when the application becomes idle (there are
7177 no pending events) and sends a `wx.IdleEvent` to all interested
7178 parties. Returns True if more idle events are needed, False if not.
0df68c9f 7179 """
54f9ee45 7180 return _core_.PyApp_ProcessIdle(*args, **kwargs)
e811c8ce
RD		 7181
7182 def SendIdleEvents(*args, **kwargs):
0df68c9f 7183 """
a95a7133 7184 SendIdleEvents(self, Window win, IdleEvent event) -> bool
e811c8ce 7185
66c033b4
RD		 7186 Send idle event to window and all subwindows. Returns True if more
7187 idle time is requested.
0df68c9f 7188 """
54f9ee45 7189 return _core_.PyApp_SendIdleEvents(*args, **kwargs)
e811c8ce
RD		 7190
7191 def IsActive(*args, **kwargs):
0df68c9f 7192 """
a95a7133 7193 IsActive(self) -> bool
6c3b4aae 7194
0df68c9f
RD		 7195 Return True if our app has focus.
7196 """
54f9ee45 7197 return _core_.PyApp_IsActive(*args, **kwargs)
e811c8ce
RD		 7198
7199 def SetTopWindow(*args, **kwargs):
0df68c9f 7200 """
a95a7133 7201 SetTopWindow(self, Window win)
6c3b4aae 7202
66c033b4 7203 Set the *main* top level window
0df68c9f 7204 """
54f9ee45 7205 return _core_.PyApp_SetTopWindow(*args, **kwargs)
e811c8ce
RD		 7206
7207 def GetTopWindow(*args, **kwargs):
0df68c9f 7208 """
a95a7133 7209 GetTopWindow(self) -> Window
6c3b4aae 7210
66c033b4
RD		 7211 Return the *main* top level window (if it hadn't been set previously
7212 with SetTopWindow(), will return just some top level window and, if
7213 there not any, will return None)
0df68c9f 7214 """
54f9ee45 7215 return _core_.PyApp_GetTopWindow(*args, **kwargs)
e811c8ce
RD		 7216
7217 def SetExitOnFrameDelete(*args, **kwargs):
0df68c9f 7218 """
a95a7133 7219 SetExitOnFrameDelete(self, bool flag)
0df68c9f 7220
66c033b4
RD		 7221 Control the exit behaviour: by default, the program will exit the main
7222 loop (and so, usually, terminate) when the last top-level program
7223 window is deleted. Beware that if you disable this behaviour (with
7224 SetExitOnFrameDelete(False)), you'll have to call ExitMainLoop()
7225 explicitly from somewhere.
0df68c9f 7226 """
54f9ee45 7227 return _core_.PyApp_SetExitOnFrameDelete(*args, **kwargs)
e811c8ce
RD		 7228
7229 def GetExitOnFrameDelete(*args, **kwargs):
0df68c9f 7230 """
a95a7133 7231 GetExitOnFrameDelete(self) -> bool
6c3b4aae 7232
0df68c9f
RD		 7233 Get the current exit behaviour setting.
7234 """
54f9ee45 7235 return _core_.PyApp_GetExitOnFrameDelete(*args, **kwargs)
e811c8ce
RD		 7236
7237 def SetUseBestVisual(*args, **kwargs):
0df68c9f 7238 """
a95a7133 7239 SetUseBestVisual(self, bool flag)
6c3b4aae 7240
66c033b4
RD		 7241 Set whether the app should try to use the best available visual on
7242 systems where more than one is available, (Sun, SGI, XFree86 4, etc.)
0df68c9f 7243 """
54f9ee45 7244 return _core_.PyApp_SetUseBestVisual(*args, **kwargs)
e811c8ce
RD		 7245
7246 def GetUseBestVisual(*args, **kwargs):
0df68c9f 7247 """
a95a7133 7248 GetUseBestVisual(self) -> bool
6c3b4aae 7249
0df68c9f
RD		 7250 Get current UseBestVisual setting.
7251 """
54f9ee45 7252 return _core_.PyApp_GetUseBestVisual(*args, **kwargs)
e811c8ce
RD		 7253
7254 def SetPrintMode(*args, **kwargs):
a95a7133 7255 """SetPrintMode(self, int mode)"""
54f9ee45 7256 return _core_.PyApp_SetPrintMode(*args, **kwargs)
e811c8ce
RD		 7257
7258 def GetPrintMode(*args, **kwargs):
a95a7133 7259 """GetPrintMode(self) -> int"""
54f9ee45 7260 return _core_.PyApp_GetPrintMode(*args, **kwargs)
e811c8ce 7261
e811c8ce 7262 def SetAssertMode(*args, **kwargs):
0df68c9f 7263 """
a95a7133 7264 SetAssertMode(self, int mode)
6c3b4aae 7265
41e2b43e 7266 Set the OnAssert behaviour for debug and hybrid builds.
0df68c9f 7267 """
54f9ee45 7268 return _core_.PyApp_SetAssertMode(*args, **kwargs)
e811c8ce 7269
6c3b4aae 7270 def GetAssertMode(*args, **kwargs):
0df68c9f 7271 """
a95a7133 7272 GetAssertMode(self) -> int
6c3b4aae 7273
0df68c9f
RD		 7274 Get the current OnAssert behaviour setting.
7275 """
54f9ee45 7276 return _core_.PyApp_GetAssertMode(*args, **kwargs)
6c3b4aae 7277
e811c8ce 7278 def GetMacSupportPCMenuShortcuts(*args, **kwargs):
66c033b4 7279 """GetMacSupportPCMenuShortcuts() -> bool"""
54f9ee45 7280 return _core_.PyApp_GetMacSupportPCMenuShortcuts(*args, **kwargs)
e811c8ce
RD		 7281
7282 GetMacSupportPCMenuShortcuts = staticmethod(GetMacSupportPCMenuShortcuts)
7283 def GetMacAboutMenuItemId(*args, **kwargs):
66c033b4 7284 """GetMacAboutMenuItemId() -> long"""
54f9ee45 7285 return _core_.PyApp_GetMacAboutMenuItemId(*args, **kwargs)
e811c8ce
RD		 7286
7287 GetMacAboutMenuItemId = staticmethod(GetMacAboutMenuItemId)
7288 def GetMacPreferencesMenuItemId(*args, **kwargs):
66c033b4 7289 """GetMacPreferencesMenuItemId() -> long"""
54f9ee45 7290 return _core_.PyApp_GetMacPreferencesMenuItemId(*args, **kwargs)
e811c8ce
RD		 7291
7292 GetMacPreferencesMenuItemId = staticmethod(GetMacPreferencesMenuItemId)
7293 def GetMacExitMenuItemId(*args, **kwargs):
66c033b4 7294 """GetMacExitMenuItemId() -> long"""
54f9ee45 7295 return _core_.PyApp_GetMacExitMenuItemId(*args, **kwargs)
e811c8ce
RD		 7296
7297 GetMacExitMenuItemId = staticmethod(GetMacExitMenuItemId)
7298 def GetMacHelpMenuTitleName(*args, **kwargs):
66c033b4 7299 """GetMacHelpMenuTitleName() -> String"""
54f9ee45 7300 return _core_.PyApp_GetMacHelpMenuTitleName(*args, **kwargs)
e811c8ce
RD		 7301
7302 GetMacHelpMenuTitleName = staticmethod(GetMacHelpMenuTitleName)
7303 def SetMacSupportPCMenuShortcuts(*args, **kwargs):
66c033b4 7304 """SetMacSupportPCMenuShortcuts(bool val)"""
54f9ee45 7305 return _core_.PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs)
e811c8ce
RD		 7306
7307 SetMacSupportPCMenuShortcuts = staticmethod(SetMacSupportPCMenuShortcuts)
7308 def SetMacAboutMenuItemId(*args, **kwargs):
66c033b4 7309 """SetMacAboutMenuItemId(long val)"""
54f9ee45 7310 return _core_.PyApp_SetMacAboutMenuItemId(*args, **kwargs)
e811c8ce
RD		 7311
7312 SetMacAboutMenuItemId = staticmethod(SetMacAboutMenuItemId)
7313 def SetMacPreferencesMenuItemId(*args, **kwargs):
66c033b4 7314 """SetMacPreferencesMenuItemId(long val)"""
54f9ee45 7315 return _core_.PyApp_SetMacPreferencesMenuItemId(*args, **kwargs)
e811c8ce
RD		 7316
7317 SetMacPreferencesMenuItemId = staticmethod(SetMacPreferencesMenuItemId)
7318 def SetMacExitMenuItemId(*args, **kwargs):
66c033b4 7319 """SetMacExitMenuItemId(long val)"""
54f9ee45 7320 return _core_.PyApp_SetMacExitMenuItemId(*args, **kwargs)
e811c8ce
RD		 7321
7322 SetMacExitMenuItemId = staticmethod(SetMacExitMenuItemId)
7323 def SetMacHelpMenuTitleName(*args, **kwargs):
66c033b4 7324 """SetMacHelpMenuTitleName(String val)"""
54f9ee45 7325 return _core_.PyApp_SetMacHelpMenuTitleName(*args, **kwargs)
e811c8ce
RD		 7326
7327 SetMacHelpMenuTitleName = staticmethod(SetMacHelpMenuTitleName)
7328 def _BootstrapApp(*args, **kwargs):
0df68c9f 7329 """
a95a7133 7330 _BootstrapApp(self)
6c3b4aae 7331
0df68c9f
RD		 7332 For internal use only
7333 """
54f9ee45 7334 return _core_.PyApp__BootstrapApp(*args, **kwargs)
e811c8ce
RD		 7335
7336 def GetComCtl32Version(*args, **kwargs):
0df68c9f 7337 """
66c033b4 7338 GetComCtl32Version() -> int
6c3b4aae 7339
66c033b4
RD		 7340 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
7341 it wasn't found at all. Raises an exception on non-Windows platforms.
0df68c9f 7342 """
54f9ee45 7343 return _core_.PyApp_GetComCtl32Version(*args, **kwargs)
e811c8ce
RD		 7344
7345 GetComCtl32Version = staticmethod(GetComCtl32Version)
33d6fd3b 7346 def IsDisplayAvailable(*args, **kwargs):
fc46b7f3 7347 """
33d6fd3b 7348 IsDisplayAvailable() -> bool
fc46b7f3
RD		 7349
7350 Tests if it is possible to create a GUI in the current environment.
7351 This will mean different things on the different platforms.
7352
7353 * On X Windows systems this function will return ``False`` if it is
7354 not able to open a connection to the X display, which can happen
7355 if $DISPLAY is not set, or is not set correctly.
7356
7357 * On Mac OS X a ``False`` return value will mean that wx is not
7358 able to access the window manager, which can happen if logged in
7359 remotely or if running from the normal version of python instead
7360 of the framework version, (i.e., pythonw.)
7361
7362 * On MS Windows...
7363
7364 """
33d6fd3b
RD		 7365 return _core_.PyApp_IsDisplayAvailable(*args, **kwargs)
7366
7367 IsDisplayAvailable = staticmethod(IsDisplayAvailable)
7368 AppName = property(GetAppName,SetAppName,doc="See `GetAppName` and `SetAppName`")
7369 AssertMode = property(GetAssertMode,SetAssertMode,doc="See `GetAssertMode` and `SetAssertMode`")
7370 ClassName = property(GetClassName,SetClassName,doc="See `GetClassName` and `SetClassName`")
7371 ExitOnFrameDelete = property(GetExitOnFrameDelete,SetExitOnFrameDelete,doc="See `GetExitOnFrameDelete` and `SetExitOnFrameDelete`")
7372 LayoutDirection = property(GetLayoutDirection,doc="See `GetLayoutDirection`")
7373 PrintMode = property(GetPrintMode,SetPrintMode,doc="See `GetPrintMode` and `SetPrintMode`")
7374 TopWindow = property(GetTopWindow,SetTopWindow,doc="See `GetTopWindow` and `SetTopWindow`")
7375 Traits = property(GetTraits,doc="See `GetTraits`")
7376 UseBestVisual = property(GetUseBestVisual,SetUseBestVisual,doc="See `GetUseBestVisual` and `SetUseBestVisual`")
7377 VendorName = property(GetVendorName,SetVendorName,doc="See `GetVendorName` and `SetVendorName`")
7378 Active = property(IsActive)
2131d850 7379_core_.PyApp_swigregister(PyApp)
d14a1e28 7380
0085ce49
RD		 7381def PyApp_IsMainLoopRunning(*args):
7382 """
1fc3b23a
RD		 7383 PyApp_IsMainLoopRunning() -> bool
7384
7385 Returns True if we're running the main loop, i.e. if the events can
7386 currently be dispatched.
7387 """
0085ce49 7388 return _core_.PyApp_IsMainLoopRunning(*args)
1fc3b23a 7389
0085ce49
RD		 7390def PyApp_GetMacSupportPCMenuShortcuts(*args):
7391 """PyApp_GetMacSupportPCMenuShortcuts() -> bool"""
7392 return _core_.PyApp_GetMacSupportPCMenuShortcuts(*args)
d14a1e28 7393
0085ce49
RD		 7394def PyApp_GetMacAboutMenuItemId(*args):
7395 """PyApp_GetMacAboutMenuItemId() -> long"""
7396 return _core_.PyApp_GetMacAboutMenuItemId(*args)
d14a1e28 7397
0085ce49
RD		 7398def PyApp_GetMacPreferencesMenuItemId(*args):
7399 """PyApp_GetMacPreferencesMenuItemId() -> long"""
7400 return _core_.PyApp_GetMacPreferencesMenuItemId(*args)
d14a1e28 7401
0085ce49
RD		 7402def PyApp_GetMacExitMenuItemId(*args):
7403 """PyApp_GetMacExitMenuItemId() -> long"""
7404 return _core_.PyApp_GetMacExitMenuItemId(*args)
d14a1e28 7405
0085ce49
RD		 7406def PyApp_GetMacHelpMenuTitleName(*args):
7407 """PyApp_GetMacHelpMenuTitleName() -> String"""
7408 return _core_.PyApp_GetMacHelpMenuTitleName(*args)
d14a1e28 7409
e811c8ce 7410def PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs):
0085ce49
RD		 7411 """PyApp_SetMacSupportPCMenuShortcuts(bool val)"""
7412 return _core_.PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs)
d14a1e28 7413
e811c8ce 7414def PyApp_SetMacAboutMenuItemId(*args, **kwargs):
0085ce49
RD		 7415 """PyApp_SetMacAboutMenuItemId(long val)"""
7416 return _core_.PyApp_SetMacAboutMenuItemId(*args, **kwargs)
d14a1e28 7417
e811c8ce 7418def PyApp_SetMacPreferencesMenuItemId(*args, **kwargs):
0085ce49
RD		 7419 """PyApp_SetMacPreferencesMenuItemId(long val)"""
7420 return _core_.PyApp_SetMacPreferencesMenuItemId(*args, **kwargs)
d14a1e28 7421
e811c8ce 7422def PyApp_SetMacExitMenuItemId(*args, **kwargs):
0085ce49
RD		 7423 """PyApp_SetMacExitMenuItemId(long val)"""
7424 return _core_.PyApp_SetMacExitMenuItemId(*args, **kwargs)
d14a1e28 7425
e811c8ce 7426def PyApp_SetMacHelpMenuTitleName(*args, **kwargs):
0085ce49
RD		 7427 """PyApp_SetMacHelpMenuTitleName(String val)"""
7428 return _core_.PyApp_SetMacHelpMenuTitleName(*args, **kwargs)
d14a1e28 7429
0085ce49
RD		 7430def PyApp_GetComCtl32Version(*args):
7431 """
0df68c9f 7432 PyApp_GetComCtl32Version() -> int
6c3b4aae 7433
66c033b4
RD		 7434 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
7435 it wasn't found at all. Raises an exception on non-Windows platforms.
0df68c9f 7436 """
0085ce49 7437 return _core_.PyApp_GetComCtl32Version(*args)
d14a1e28 7438
33d6fd3b 7439def PyApp_IsDisplayAvailable(*args):
fc46b7f3 7440 """
33d6fd3b 7441 PyApp_IsDisplayAvailable() -> bool
fc46b7f3
RD		 7442
7443 Tests if it is possible to create a GUI in the current environment.
7444 This will mean different things on the different platforms.
7445
7446 * On X Windows systems this function will return ``False`` if it is
7447 not able to open a connection to the X display, which can happen
7448 if $DISPLAY is not set, or is not set correctly.
7449
7450 * On Mac OS X a ``False`` return value will mean that wx is not
7451 able to access the window manager, which can happen if logged in
7452 remotely or if running from the normal version of python instead
7453 of the framework version, (i.e., pythonw.)
7454
7455 * On MS Windows...
7456
7457 """
33d6fd3b 7458 return _core_.PyApp_IsDisplayAvailable(*args)
fc46b7f3 7459
d14a1e28
RD		 7460#---------------------------------------------------------------------------
7461
7462
0085ce49
RD		 7463def Exit(*args):
7464 """
0df68c9f 7465 Exit()
6c3b4aae 7466
0df68c9f
RD		 7467 Force an exit of the application. Convenience for wx.GetApp().Exit()
7468 """
0085ce49 7469 return _core_.Exit(*args)
d14a1e28 7470
0085ce49
RD		 7471def Yield(*args):
7472 """
0df68c9f 7473 Yield() -> bool
6c3b4aae 7474
0df68c9f
RD		 7475 Yield to other apps/messages. Convenience for wx.GetApp().Yield()
7476 """
0085ce49 7477 return _core_.Yield(*args)
d14a1e28 7478
0085ce49
RD		 7479def YieldIfNeeded(*args):
7480 """
0df68c9f 7481 YieldIfNeeded() -> bool
6c3b4aae 7482
0df68c9f
RD		 7483 Yield to other apps/messages. Convenience for wx.GetApp().Yield(True)
7484 """
0085ce49 7485 return _core_.YieldIfNeeded(*args)
d14a1e28 7486
e811c8ce 7487def SafeYield(*args, **kwargs):
0085ce49 7488 """
0df68c9f 7489 SafeYield(Window win=None, bool onlyIfNeeded=False) -> bool
6c3b4aae 7490
66c033b4
RD		 7491 This function is similar to `wx.Yield`, except that it disables the
7492 user input to all program windows before calling `wx.Yield` and
7493 re-enables it again afterwards. If ``win`` is not None, this window
7494 will remain enabled, allowing the implementation of some limited user
7495 interaction.
6c3b4aae 7496
66c033b4 7497 :Returns: the result of the call to `wx.Yield`.
0df68c9f 7498 """
0085ce49 7499 return _core_.SafeYield(*args, **kwargs)
d14a1e28 7500
0085ce49
RD		 7501def WakeUpIdle(*args):
7502 """
0df68c9f 7503 WakeUpIdle()
6c3b4aae 7504
66c033b4
RD		 7505 Cause the message queue to become empty again, so idle events will be
7506 sent.
0df68c9f 7507 """
0085ce49 7508 return _core_.WakeUpIdle(*args)
d14a1e28 7509
e811c8ce 7510def PostEvent(*args, **kwargs):
0085ce49 7511 """
0df68c9f 7512 PostEvent(EvtHandler dest, Event event)
6c3b4aae 7513
66c033b4
RD		 7514 Send an event to a window or other wx.EvtHandler to be processed
7515 later.
0df68c9f 7516 """
0085ce49 7517 return _core_.PostEvent(*args, **kwargs)
d14a1e28 7518
0085ce49
RD		 7519def App_CleanUp(*args):
7520 """
0df68c9f 7521 App_CleanUp()
6c3b4aae 7522
41e2b43e 7523 For internal use only, it is used to cleanup after wxWidgets when
66c033b4 7524 Python shuts down.
0df68c9f 7525 """
0085ce49 7526 return _core_.App_CleanUp(*args)
d14a1e28 7527
0085ce49
RD		 7528def GetApp(*args):
7529 """
0df68c9f 7530 GetApp() -> PyApp
6c3b4aae 7531
196addbf 7532 Return a reference to the current wx.App object.
0df68c9f 7533 """
0085ce49 7534 return _core_.GetApp(*args)
5cbf236d
RD		 7535
7536def SetDefaultPyEncoding(*args, **kwargs):
0085ce49 7537 """
5cbf236d
RD		 7538 SetDefaultPyEncoding(string encoding)
7539
7540 Sets the encoding that wxPython will use when it needs to convert a
7541 Python string or unicode object to or from a wxString.
e505d15e
RD		 7542
7543 The default encoding is the value of ``locale.getdefaultlocale()[1]``
7544 but please be aware that the default encoding within the same locale
7545 may be slightly different on different platforms. For example, please
7546 see http://www.alanwood.net/demos/charsetdiffs.html for differences
7547 between the common latin/roman encodings.
5cbf236d 7548 """
0085ce49 7549 return _core_.SetDefaultPyEncoding(*args, **kwargs)
5cbf236d 7550
0085ce49
RD		 7551def GetDefaultPyEncoding(*args):
7552 """
5cbf236d
RD		 7553 GetDefaultPyEncoding() -> string
7554
7555 Gets the current encoding that wxPython will use when it needs to
7556 convert a Python string or unicode object to or from a wxString.
7557 """
0085ce49 7558 return _core_.GetDefaultPyEncoding(*args)
d14a1e28
RD		 7559#----------------------------------------------------------------------
7560
7561class PyOnDemandOutputWindow:
6c3b4aae
RD		 7562 """
7563 A class that can be used for redirecting Python's stdout and
7564 stderr streams. It will do nothing until something is wrriten to
7565 the stream at which point it will create a Frame with a text area
7566 and write the text there.
7567 """
d14a1e28
RD		 7568 def __init__(self, title = "wxPython: stdout/stderr"):
7569 self.frame = None
7570 self.title = title
412d302d
RD		 7571 self.pos = wx.DefaultPosition
7572 self.size = (450, 300)
d14a1e28
RD		 7573 self.parent = None
7574
7575 def SetParent(self, parent):
6c3b4aae 7576 """Set the window to be used as the popup Frame's parent."""
d14a1e28
RD		 7577 self.parent = parent
7578
6c3b4aae
RD		 7579
7580 def CreateOutputWindow(self, st):
412d302d
RD		 7581 self.frame = wx.Frame(self.parent, -1, self.title, self.pos, self.size,
7582 style=wx.DEFAULT_FRAME_STYLE)
196addbf 7583 self.text = wx.TextCtrl(self.frame, -1, "",
412d302d 7584 style=wx.TE_MULTILINE|wx.TE_READONLY)
d1e20054 7585 self.text.AppendText(st)
6c3b4aae 7586 self.frame.Show(True)
2131d850 7587 self.frame.Bind(wx.EVT_CLOSE, self.OnCloseWindow)
6c3b4aae 7588
d14a1e28 7589
7409c0c6
RD		 7590 def OnCloseWindow(self, event):
7591 if self.frame is not None:
7592 self.frame.Destroy()
7593 self.frame = None
7594 self.text = None
7595
7596
d14a1e28 7597 # These methods provide the file-like output behaviour.
6c3b4aae
RD		 7598 def write(self, text):
7599 """
7600 Create the output window if needed and write the string to it.
7601 If not called in the context of the gui thread then uses
7602 CallAfter to do the work there.
7603 """
7604 if self.frame is None:
7605 if not wx.Thread_IsMain():
7606 wx.CallAfter(self.CreateOutputWindow, text)
7607 else:
7608 self.CreateOutputWindow(text)
7609 else:
7610 if not wx.Thread_IsMain():
7611 wx.CallAfter(self.text.AppendText, text)
7612 else:
7613 self.text.AppendText(text)
7614
d14a1e28
RD		 7615
7616 def close(self):
6c3b4aae
RD		 7617 if self.frame is not None:
7618 wx.CallAfter(self.frame.Close)
7619
d14a1e28 7620
19272049
RD		 7621 def flush(self):
7622 pass
7623
7624
d14a1e28
RD		 7625
7626#----------------------------------------------------------------------
d14a1e28
RD		 7627
7628_defRedirect = (wx.Platform == '__WXMSW__' or wx.Platform == '__WXMAC__')
fc46b7f3 7629
d14a1e28 7630class App(wx.PyApp):
6c3b4aae 7631 """
66c033b4
RD		 7632 The ``wx.App`` class represents the application and is used to:
7633
7634 * bootstrap the wxPython system and initialize the underlying
7635 gui toolkit
7636 * set and get application-wide properties
7637 * implement the windowing system main message or event loop,
7638 and to dispatch events to window instances
7639 * etc.
7640
7641 Every application must have a ``wx.App`` instance, and all
7642 creation of UI objects should be delayed until after the
03e37cd5
RD		 7643 ``wx.App`` object has been created in order to ensure that the gui
7644 platform and wxWidgets have been fully initialized.
66c033b4
RD		 7645
7646 Normally you would derive from this class and implement an
7647 ``OnInit`` method that creates a frame and then calls
7648 ``self.SetTopWindow(frame)``.
7649
03e37cd5 7650 :see: `wx.PySimpleApp` for a simpler app class that can be used
1c0f361b 7651 directly.
6c3b4aae 7652 """
66c033b4 7653
d14a1e28
RD		 7654 outputWindowClass = PyOnDemandOutputWindow
7655
03e37cd5
RD		 7656 def __init__(self, redirect=_defRedirect, filename=None,
7657 useBestVisual=False, clearSigInt=True):
66c033b4
RD		 7658 """
7659 Construct a ``wx.App`` object.
7660
03e37cd5
RD		 7661 :param redirect: Should ``sys.stdout`` and ``sys.stderr`` be
7662 redirected? Defaults to True on Windows and Mac, False
7663 otherwise. If `filename` is None then output will be
7664 redirected to a window that pops up as needed. (You can
7665 control what kind of window is created for the output by
7666 resetting the class variable ``outputWindowClass`` to a
7667 class of your choosing.)
66c033b4 7668
03e37cd5
RD		 7669 :param filename: The name of a file to redirect output to, if
7670 redirect is True.
66c033b4
RD		 7671
7672 :param useBestVisual: Should the app try to use the best
03e37cd5
RD		 7673 available visual provided by the system (only relevant on
7674 systems that have more than one visual.) This parameter
7675 must be used instead of calling `SetUseBestVisual` later
7676 on because it must be set before the underlying GUI
7677 toolkit is initialized.
7678
7679 :param clearSigInt: Should SIGINT be cleared? This allows the
7680 app to terminate upon a Ctrl-C in the console like other
7681 GUI apps will.
66c033b4
RD		 7682
7683 :note: You should override OnInit to do applicaition
7684 initialization to ensure that the system, toolkit and
7685 wxWidgets are fully initialized.
7686 """
fc46b7f3 7687
d14a1e28
RD		 7688 wx.PyApp.__init__(self)
7689
fc46b7f3 7690 # make sure we can create a GUI
33d6fd3b 7691 if not self.IsDisplayAvailable():
fc46b7f3
RD		 7692
7693 if wx.Platform == "__WXMAC__":
7694 msg = """This program needs access to the screen.
7695Please run with 'pythonw', not 'python', and only when you are logged
7696in on the main display of your Mac."""
7697
7698 elif wx.Platform == "__WXGTK__":
7699 msg ="Unable to access the X Display, is $DISPLAY set properly?"
d14a1e28 7700
fc46b7f3
RD		 7701 else:
7702 msg = "Unable to create GUI"
7703 # TODO: more description is needed for wxMSW...
7704
7705 raise SystemExit(msg)
7706
d14a1e28
RD		 7707 # This has to be done before OnInit
7708 self.SetUseBestVisual(useBestVisual)
7709
7710 # Set the default handler for SIGINT. This fixes a problem
7711 # where if Ctrl-C is pressed in the console that started this
7712 # app then it will not appear to do anything, (not even send
7713 # KeyboardInterrupt???) but will later segfault on exit. By
7714 # setting the default handler then the app will exit, as
7715 # expected (depending on platform.)
03e37cd5
RD		 7716 if clearSigInt:
7717 try:
7718 import signal
7719 signal.signal(signal.SIGINT, signal.SIG_DFL)
7720 except:
7721 pass
d14a1e28
RD		 7722
7723 # Save and redirect the stdio to a window?
7724 self.stdioWin = None
7725 self.saveStdio = (_sys.stdout, _sys.stderr)
7726 if redirect:
7727 self.RedirectStdio(filename)
7728
8fb0e70a
RD		 7729 # Use Python's install prefix as the default
7730 wx.StandardPaths.Get().SetInstallPrefix(_sys.prefix)
7731
d14a1e28
RD		 7732 # This finishes the initialization of wxWindows and then calls
7733 # the OnInit that should be present in the derived class
7734 self._BootstrapApp()
7735
7736
01f6b6d3
RD		 7737 def OnPreInit(self):
7738 """
7739 Things that must be done after _BootstrapApp has done its
7740 thing, but would be nice if they were already done by the time
7741 that OnInit is called.
7742 """
7743 wx.StockGDI._initStockObjects()
7744
7745
02b455f2
RD		 7746 def __del__(self, destroy=wx.PyApp.__del__):
7747 self.RestoreStdio() # Just in case the MainLoop was overridden
7748 destroy(self)
d14a1e28 7749
70b7a5fe 7750 def Destroy(self):
b39fe951 7751 self.this.own(False)
70b7a5fe 7752 wx.PyApp.Destroy(self)
d14a1e28
RD		 7753
7754 def SetTopWindow(self, frame):
1e0c8722 7755 """Set the \"main\" top level window"""
d14a1e28
RD		 7756 if self.stdioWin:
7757 self.stdioWin.SetParent(frame)
7758 wx.PyApp.SetTopWindow(self, frame)
7759
7760
7761 def MainLoop(self):
1e0c8722 7762 """Execute the main GUI event loop"""
d14a1e28
RD		 7763 wx.PyApp.MainLoop(self)
7764 self.RestoreStdio()
7765
7766
7409c0c6 7767 def RedirectStdio(self, filename=None):
1e0c8722 7768 """Redirect sys.stdout and sys.stderr to a file or a popup window."""
d14a1e28
RD		 7769 if filename:
7770 _sys.stdout = _sys.stderr = open(filename, 'a')
7771 else:
7772 self.stdioWin = self.outputWindowClass()
7773 _sys.stdout = _sys.stderr = self.stdioWin
7774
7775
7776 def RestoreStdio(self):
02b455f2
RD		 7777 try:
7778 _sys.stdout, _sys.stderr = self.saveStdio
7779 except:
7780 pass
d14a1e28
RD		 7781
7782
412d302d
RD		 7783 def SetOutputWindowAttributes(self, title=None, pos=None, size=None):
7784 """
7785 Set the title, position and/or size of the output window if
f5b96ee1
RD		 7786 the stdio has been redirected. This should be called before
7787 any output would cause the output window to be created.
412d302d
RD		 7788 """
7789 if self.stdioWin:
7790 if title is not None:
7791 self.stdioWin.title = title
7792 if pos is not None:
7793 self.stdioWin.pos = pos
7794 if size is not None:
7795 self.stdioWin.size = size
7796
7797
7798
d14a1e28 7799
66c033b4 7800# change from wx.PyApp_XX to wx.App_XX
54f9ee45
RD		 7801App_GetMacSupportPCMenuShortcuts = _core_.PyApp_GetMacSupportPCMenuShortcuts
7802App_GetMacAboutMenuItemId = _core_.PyApp_GetMacAboutMenuItemId
7803App_GetMacPreferencesMenuItemId = _core_.PyApp_GetMacPreferencesMenuItemId
7804App_GetMacExitMenuItemId = _core_.PyApp_GetMacExitMenuItemId
7805App_GetMacHelpMenuTitleName = _core_.PyApp_GetMacHelpMenuTitleName
7806App_SetMacSupportPCMenuShortcuts = _core_.PyApp_SetMacSupportPCMenuShortcuts
7807App_SetMacAboutMenuItemId = _core_.PyApp_SetMacAboutMenuItemId
7808App_SetMacPreferencesMenuItemId = _core_.PyApp_SetMacPreferencesMenuItemId
7809App_SetMacExitMenuItemId = _core_.PyApp_SetMacExitMenuItemId
7810App_SetMacHelpMenuTitleName = _core_.PyApp_SetMacHelpMenuTitleName
7811App_GetComCtl32Version = _core_.PyApp_GetComCtl32Version
d14a1e28
RD		 7812
7813#----------------------------------------------------------------------------
7814
7815class PySimpleApp(wx.App):
6c3b4aae
RD		 7816 """
7817 A simple application class. You can just create one of these and
7818 then then make your top level windows later, and not have to worry
66c033b4
RD		 7819 about OnInit. For example::
7820
7821 app = wx.PySimpleApp()
7822 frame = wx.Frame(None, title='Hello World')
7823 frame.Show()
7824 app.MainLoop()
7825
7826 :see: `wx.App`
7827 """
6c3b4aae 7828
03e37cd5
RD		 7829 def __init__(self, redirect=False, filename=None,
7830 useBestVisual=False, clearSigInt=True):
66c033b4
RD		 7831 """
7832 :see: `wx.App.__init__`
7833 """
03e37cd5 7834 wx.App.__init__(self, redirect, filename, useBestVisual, clearSigInt)
6c3b4aae 7835
d14a1e28 7836 def OnInit(self):
d14a1e28
RD		 7837 return True
7838
7839
66c033b4 7840
6c3b4aae 7841# Is anybody using this one?
d14a1e28
RD		 7842class PyWidgetTester(wx.App):
7843 def __init__(self, size = (250, 100)):
7844 self.size = size
7845 wx.App.__init__(self, 0)
7846
7847 def OnInit(self):
196addbf 7848 self.frame = wx.Frame(None, -1, "Widget Tester", pos=(0,0), size=self.size)
d14a1e28
RD		 7849 self.SetTopWindow(self.frame)
7850 return True
7851
66c033b4
RD		 7852 def SetWidget(self, widgetClass, *args, **kwargs):
7853 w = widgetClass(self.frame, *args, **kwargs)
d14a1e28
RD		 7854 self.frame.Show(True)
7855
7856#----------------------------------------------------------------------------
7857# DO NOT hold any other references to this object. This is how we
66c033b4 7858# know when to cleanup system resources that wxWidgets is holding. When
d14a1e28 7859# the sys module is unloaded, the refcount on sys.__wxPythonCleanup
66c033b4 7860# goes to zero and it calls the wx.App_CleanUp function.
d14a1e28
RD		 7861
7862class __wxPyCleanup:
7863 def __init__(self):
54f9ee45 7864 self.cleanup = _core_.App_CleanUp
d14a1e28
RD		 7865 def __del__(self):
7866 self.cleanup()
7867
7868_sys.__wxPythonCleanup = __wxPyCleanup()
7869
7870## # another possible solution, but it gets called too early...
66c033b4
RD		 7871## import atexit
7872## atexit.register(_core_.wxApp_CleanUp)
d14a1e28
RD		 7873
7874
7875#----------------------------------------------------------------------------
7876
7877#---------------------------------------------------------------------------
2ef75293
RD		 7878
7879class EventLoop(object):
093d3ff1 7880 """Proxy of C++ EventLoop class"""
0085ce49
RD		 7881 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7882 __repr__ = _swig_repr
7883 def __init__(self, *args, **kwargs):
2ef75293 7884 """__init__(self) -> EventLoop"""
0085ce49
RD		 7885 _core_.EventLoop_swiginit(self,_core_.new_EventLoop(*args, **kwargs))
7886 __swig_destroy__ = _core_.delete_EventLoop
7887 __del__ = lambda self : None;
2ef75293
RD		 7888 def Run(*args, **kwargs):
7889 """Run(self) -> int"""
7890 return _core_.EventLoop_Run(*args, **kwargs)
7891
7892 def Exit(*args, **kwargs):
7893 """Exit(self, int rc=0)"""
7894 return _core_.EventLoop_Exit(*args, **kwargs)
7895
7896 def Pending(*args, **kwargs):
7897 """Pending(self) -> bool"""
7898 return _core_.EventLoop_Pending(*args, **kwargs)
7899
7900 def Dispatch(*args, **kwargs):
7901 """Dispatch(self) -> bool"""
7902 return _core_.EventLoop_Dispatch(*args, **kwargs)
7903
7904 def IsRunning(*args, **kwargs):
7905 """IsRunning(self) -> bool"""
7906 return _core_.EventLoop_IsRunning(*args, **kwargs)
7907
7908 def GetActive(*args, **kwargs):
7909 """GetActive() -> EventLoop"""
7910 return _core_.EventLoop_GetActive(*args, **kwargs)
7911
7912 GetActive = staticmethod(GetActive)
7913 def SetActive(*args, **kwargs):
7914 """SetActive(EventLoop loop)"""
7915 return _core_.EventLoop_SetActive(*args, **kwargs)
7916
7917 SetActive = staticmethod(SetActive)
2131d850 7918_core_.EventLoop_swigregister(EventLoop)
2ef75293 7919
0085ce49
RD		 7920def EventLoop_GetActive(*args):
7921 """EventLoop_GetActive() -> EventLoop"""
7922 return _core_.EventLoop_GetActive(*args)
2ef75293
RD		 7923
7924def EventLoop_SetActive(*args, **kwargs):
0085ce49
RD		 7925 """EventLoop_SetActive(EventLoop loop)"""
7926 return _core_.EventLoop_SetActive(*args, **kwargs)
2ef75293 7927
091f5bed
RD		 7928class EventLoopActivator(object):
7929 """Proxy of C++ EventLoopActivator class"""
0085ce49
RD		 7930 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7931 __repr__ = _swig_repr
7932 def __init__(self, *args, **kwargs):
091f5bed 7933 """__init__(self, EventLoop evtLoop) -> EventLoopActivator"""
0085ce49
RD		 7934 _core_.EventLoopActivator_swiginit(self,_core_.new_EventLoopActivator(*args, **kwargs))
7935 __swig_destroy__ = _core_.delete_EventLoopActivator
7936 __del__ = lambda self : None;
2131d850 7937_core_.EventLoopActivator_swigregister(EventLoopActivator)
091f5bed 7938
2ef75293 7939#---------------------------------------------------------------------------
d14a1e28 7940
eec1c382
RD		 7941ACCEL_ALT = _core_.ACCEL_ALT
7942ACCEL_CTRL = _core_.ACCEL_CTRL
7943ACCEL_SHIFT = _core_.ACCEL_SHIFT
7944ACCEL_NORMAL = _core_.ACCEL_NORMAL
7945ACCEL_CMD = _core_.ACCEL_CMD
1e0c8722 7946class AcceleratorEntry(object):
66c033b4
RD		 7947 """
7948 A class used to define items in an `wx.AcceleratorTable`. wxPython
7949 programs can choose to use wx.AcceleratorEntry objects, but using a
7950 list of 3-tuple of integers (flags, keyCode, cmdID) usually works just
41e2b43e 7951 as well. See `__init__` for of the tuple values.
66c033b4
RD		 7952
7953 :see: `wx.AcceleratorTable`
7954 """
0085ce49
RD		 7955 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7956 __repr__ = _swig_repr
7957 def __init__(self, *args, **kwargs):
66c033b4
RD		 7958 """
7959 __init__(self, int flags=0, int keyCode=0, int cmdID=0) -> AcceleratorEntry
7960
7961 Construct a wx.AcceleratorEntry.
66c033b4 7962 """
0085ce49
RD		 7963 _core_.AcceleratorEntry_swiginit(self,_core_.new_AcceleratorEntry(*args, **kwargs))
7964 __swig_destroy__ = _core_.delete_AcceleratorEntry
7965 __del__ = lambda self : None;
1e0c8722 7966 def Set(*args, **kwargs):
66c033b4
RD		 7967 """
7968 Set(self, int flags, int keyCode, int cmd)
1e0c8722 7969
66c033b4
RD		 7970 (Re)set the attributes of a wx.AcceleratorEntry.
7971 :see `__init__`
7972 """
7973 return _core_.AcceleratorEntry_Set(*args, **kwargs)
1e0c8722 7974
97ab0f6a
RD		 7975 def Create(*args, **kwargs):
7976 """
7977 Create(String str) -> AcceleratorEntry
7978
7979 Create accelerator corresponding to the specified string, or None if
7980 it coulnd't be parsed.
7981 """
7982 return _core_.AcceleratorEntry_Create(*args, **kwargs)
7983
7984 Create = staticmethod(Create)
1e0c8722 7985 def GetFlags(*args, **kwargs):
66c033b4
RD		 7986 """
7987 GetFlags(self) -> int
7988
7989 Get the AcceleratorEntry's flags.
7990 """
54f9ee45 7991 return _core_.AcceleratorEntry_GetFlags(*args, **kwargs)
1e0c8722
RD		 7992
7993 def GetKeyCode(*args, **kwargs):
66c033b4
RD		 7994 """
7995 GetKeyCode(self) -> int
7996
7997 Get the AcceleratorEntry's keycode.
7998 """
54f9ee45 7999 return _core_.AcceleratorEntry_GetKeyCode(*args, **kwargs)
1e0c8722
RD		 8000
8001 def GetCommand(*args, **kwargs):
66c033b4
RD		 8002 """
8003 GetCommand(self) -> int
8004
8005 Get the AcceleratorEntry's command ID.
8006 """
54f9ee45 8007 return _core_.AcceleratorEntry_GetCommand(*args, **kwargs)
1e0c8722 8008
97ab0f6a
RD		 8009 def IsOk(*args, **kwargs):
8010 """IsOk(self) -> bool"""
8011 return _core_.AcceleratorEntry_IsOk(*args, **kwargs)
8012
8013 def ToString(*args, **kwargs):
8014 """
8015 ToString(self) -> String
8016
8017 Returns a string representation for the this accelerator. The string
8018 is formatted using the <flags>-<keycode> format where <flags> maybe a
8019 hyphen-separed list of "shift|alt|ctrl"
8020
8021 """
8022 return _core_.AcceleratorEntry_ToString(*args, **kwargs)
8023
8024 def FromString(*args, **kwargs):
8025 """
8026 FromString(self, String str) -> bool
8027
8028 Returns true if the given string correctly initialized this object.
8029 """
8030 return _core_.AcceleratorEntry_FromString(*args, **kwargs)
8031
2bf58437
RD		 8032 Command = property(GetCommand,doc="See `GetCommand`")
8033 Flags = property(GetFlags,doc="See `GetFlags`")
8034 KeyCode = property(GetKeyCode,doc="See `GetKeyCode`")
2131d850 8035_core_.AcceleratorEntry_swigregister(AcceleratorEntry)
1e0c8722 8036
97ab0f6a
RD		 8037def AcceleratorEntry_Create(*args, **kwargs):
8038 """
8039 AcceleratorEntry_Create(String str) -> AcceleratorEntry
8040
8041 Create accelerator corresponding to the specified string, or None if
8042 it coulnd't be parsed.
8043 """
8044 return _core_.AcceleratorEntry_Create(*args, **kwargs)
8045
1e0c8722 8046class AcceleratorTable(Object):
66c033b4
RD		 8047 """
8048 An accelerator table allows the application to specify a table of
8049 keyboard shortcuts for menus or other commands. On Windows, menu or
8050 button commands are supported; on GTK, only menu commands are
8051 supported.
66c033b4 8052 """
0085ce49
RD		 8053 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
8054 __repr__ = _swig_repr
8055 def __init__(self, *args, **kwargs):
0df68c9f
RD		 8056 """
8057 __init__(entries) -> AcceleratorTable
1e0c8722 8058
66c033b4
RD		 8059 Construct an AcceleratorTable from a list of `wx.AcceleratorEntry`
8060 items or or of 3-tuples (flags, keyCode, cmdID)
8061
8062 :see: `wx.AcceleratorEntry`
0df68c9f 8063 """
0085ce49
RD		 8064 _core_.AcceleratorTable_swiginit(self,_core_.new_AcceleratorTable(*args, **kwargs))
8065 __swig_destroy__ = _core_.delete_AcceleratorTable
8066 __del__ = lambda self : None;
b39fe951
RD		 8067 def IsOk(*args, **kwargs):
8068 """IsOk(self) -> bool"""
8069 return _core_.AcceleratorTable_IsOk(*args, **kwargs)
1e0c8722 8070
b39fe951 8071 Ok = IsOk
2131d850 8072_core_.AcceleratorTable_swigregister(AcceleratorTable)
1e0c8722
RD		 8073
8074
8075def GetAccelFromString(*args, **kwargs):
0085ce49
RD		 8076 """GetAccelFromString(String label) -> AcceleratorEntry"""
8077 return _core_.GetAccelFromString(*args, **kwargs)
1e0c8722
RD		 8078#---------------------------------------------------------------------------
8079
74a57fcd
RD		 8080class VisualAttributes(object):
8081 """struct containing all the visual attributes of a control"""
0085ce49
RD		 8082 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
8083 __repr__ = _swig_repr
8084 def __init__(self, *args, **kwargs):
74a57fcd 8085 """
a95a7133 8086 __init__(self) -> VisualAttributes
74a57fcd
RD		 8087
8088 struct containing all the visual attributes of a control
8089 """
0085ce49
RD		 8090 _core_.VisualAttributes_swiginit(self,_core_.new_VisualAttributes(*args, **kwargs))
8091 __swig_destroy__ = _core_.delete_VisualAttributes
8092 __del__ = lambda self : None;
54f9ee45
RD		 8093 font = property(_core_.VisualAttributes_font_get, _core_.VisualAttributes_font_set)
8094 colFg = property(_core_.VisualAttributes_colFg_get, _core_.VisualAttributes_colFg_set)
8095 colBg = property(_core_.VisualAttributes_colBg_get, _core_.VisualAttributes_colBg_set)
2131d850 8096_core_.VisualAttributes_swigregister(VisualAttributes)
74a57fcd
RD		 8097NullAcceleratorTable = cvar.NullAcceleratorTable
8098PanelNameStr = cvar.PanelNameStr
8099
54f9ee45
RD		 8100WINDOW_VARIANT_NORMAL = _core_.WINDOW_VARIANT_NORMAL
8101WINDOW_VARIANT_SMALL = _core_.WINDOW_VARIANT_SMALL
8102WINDOW_VARIANT_MINI = _core_.WINDOW_VARIANT_MINI
8103WINDOW_VARIANT_LARGE = _core_.WINDOW_VARIANT_LARGE
8104WINDOW_VARIANT_MAX = _core_.WINDOW_VARIANT_MAX
d14a1e28 8105class Window(EvtHandler):
15afbcd0
RD		 8106 """
8107 wx.Window is the base class for all windows and represents any visible
8108 object on the screen. All controls, top level windows and so on are
8109 wx.Windows. Sizers and device contexts are not however, as they don't
8110 appear on screen themselves.
8111
8112 """
0085ce49
RD		 8113 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
8114 __repr__ = _swig_repr
8115 def __init__(self, *args, **kwargs):
0df68c9f 8116 """
a95a7133 8117 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
74a57fcd 8118 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> Window
15afbcd0
RD		 8119
8120 Construct and show a generic Window.
0df68c9f 8121 """
0085ce49 8122 _core_.Window_swiginit(self,_core_.new_Window(*args, **kwargs))
d14a1e28 8123 self._setOORInfo(self)
d14a1e28 8124
e811c8ce 8125 def Create(*args, **kwargs):
0df68c9f 8126 """
a95a7133 8127 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
74a57fcd 8128 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> bool
15afbcd0
RD		 8129
8130 Create the GUI part of the Window for 2-phase creation mode.
0df68c9f 8131 """
54f9ee45 8132 return _core_.Window_Create(*args, **kwargs)
d14a1e28 8133
e811c8ce 8134 def Close(*args, **kwargs):
15afbcd0 8135 """
a95a7133 8136 Close(self, bool force=False) -> bool
15afbcd0
RD		 8137
8138 This function simply generates a EVT_CLOSE event whose handler usually
8139 tries to close the window. It doesn't close the window itself,
8140 however. If force is False (the default) then the window's close
8141 handler will be allowed to veto the destruction of the window.
15afbcd0 8142 """
54f9ee45 8143 return _core_.Window_Close(*args, **kwargs)
d14a1e28 8144
e811c8ce 8145 def Destroy(*args, **kwargs):
0df68c9f 8146 """
a95a7133 8147 Destroy(self) -> bool
d14a1e28 8148
15afbcd0
RD		 8149 Destroys the window safely. Frames and dialogs are not destroyed
8150 immediately when this function is called -- they are added to a list
8151 of windows to be deleted on idle time, when all the window's events
8152 have been processed. This prevents problems with events being sent to
8153 non-existent windows.
8154
8155 Returns True if the window has either been successfully deleted, or it
8156 has been added to the list of windows pending real deletion.
0df68c9f 8157 """
b39fe951
RD		 8158 args[0].this.own(False)
8159 return _core_.Window_Destroy(*args, **kwargs)
d14a1e28 8160
e811c8ce 8161 def DestroyChildren(*args, **kwargs):
15afbcd0 8162 """
a95a7133 8163 DestroyChildren(self) -> bool
15afbcd0 8164
41e2b43e
RD		 8165 Destroys all children of a window. Called automatically by the
8166 destructor.
15afbcd0 8167 """
54f9ee45 8168 return _core_.Window_DestroyChildren(*args, **kwargs)
d14a1e28 8169
e811c8ce 8170 def IsBeingDeleted(*args, **kwargs):
15afbcd0 8171 """
a95a7133 8172 IsBeingDeleted(self) -> bool
15afbcd0
RD		 8173
8174 Is the window in the process of being deleted?
8175 """
54f9ee45 8176 return _core_.Window_IsBeingDeleted(*args, **kwargs)
d14a1e28 8177
e811c8ce 8178 def SetLabel(*args, **kwargs):
15afbcd0 8179 """
a95a7133 8180 SetLabel(self, String label)
15afbcd0
RD		 8181
8182 Set the text which the window shows in its label if applicable.
8183 """
54f9ee45 8184 return _core_.Window_SetLabel(*args, **kwargs)
d14a1e28 8185
e811c8ce 8186 def GetLabel(*args, **kwargs):
15afbcd0 8187 """
a95a7133 8188 GetLabel(self) -> String
15afbcd0 8189
41e2b43e
RD		 8190 Generic way of getting a label from any window, for identification
8191 purposes. The interpretation of this function differs from class to
8192 class. For frames and dialogs, the value returned is the title. For
8193 buttons or static text controls, it is the button text. This function
8194 can be useful for meta-programs such as testing tools or special-needs
8195 access programs)which need to identify windows by name.
15afbcd0 8196 """
54f9ee45 8197 return _core_.Window_GetLabel(*args, **kwargs)
d14a1e28 8198
e811c8ce 8199 def SetName(*args, **kwargs):
15afbcd0 8200 """
a95a7133 8201 SetName(self, String name)
15afbcd0 8202
41e2b43e
RD		 8203 Sets the window's name. The window name is used for ressource setting
8204 in X, it is not the same as the window title/label
15afbcd0 8205 """
54f9ee45 8206 return _core_.Window_SetName(*args, **kwargs)
d14a1e28 8207
e811c8ce 8208 def GetName(*args, **kwargs):
15afbcd0 8209 """
a95a7133 8210 GetName(self) -> String
15afbcd0 8211
41e2b43e
RD		 8212 Returns the windows name. This name is not guaranteed to be unique;
8213 it is up to the programmer to supply an appropriate name in the window
8214 constructor or via wx.Window.SetName.
15afbcd0 8215 """
54f9ee45 8216 return _core_.Window_GetName(*args, **kwargs)
d14a1e28 8217
4276dc52
RD		 8218 def SetWindowVariant(*args, **kwargs):
8219 """
a95a7133 8220 SetWindowVariant(self, int variant)
4276dc52 8221
41e2b43e
RD		 8222 Sets the variant of the window/font size to use for this window, if
8223 the platform supports variants, for example, wxMac.
4276dc52 8224 """
54f9ee45 8225 return _core_.Window_SetWindowVariant(*args, **kwargs)
4276dc52
RD		 8226
8227 def GetWindowVariant(*args, **kwargs):
a95a7133 8228 """GetWindowVariant(self) -> int"""
54f9ee45 8229 return _core_.Window_GetWindowVariant(*args, **kwargs)
4276dc52 8230
e811c8ce 8231 def SetId(*args, **kwargs):
15afbcd0 8232 """
a95a7133 8233 SetId(self, int winid)
15afbcd0
RD		 8234
8235 Sets the identifier of the window. Each window has an integer
8236 identifier. If the application has not provided one, an identifier
8237 will be generated. Normally, the identifier should be provided on
8238 creation and should not be modified subsequently.
8239 """
54f9ee45 8240 return _core_.Window_SetId(*args, **kwargs)
d14a1e28 8241
e811c8ce 8242 def GetId(*args, **kwargs):
15afbcd0 8243 """
a95a7133 8244 GetId(self) -> int
15afbcd0
RD		 8245
8246 Returns the identifier of the window. Each window has an integer
8247 identifier. If the application has not provided one (or the default Id
8248 -1 is used) then an unique identifier with a negative value will be
8249 generated.
8250 """
54f9ee45 8251 return _core_.Window_GetId(*args, **kwargs)
d14a1e28 8252
e811c8ce 8253 def NewControlId(*args, **kwargs):
15afbcd0 8254 """
66c033b4 8255 NewControlId() -> int
15afbcd0
RD		 8256
8257 Generate a control id for the controls which were not given one.
8258 """
54f9ee45 8259 return _core_.Window_NewControlId(*args, **kwargs)
d14a1e28 8260
e811c8ce
RD		 8261 NewControlId = staticmethod(NewControlId)
8262 def NextControlId(*args, **kwargs):
15afbcd0 8263 """
66c033b4 8264 NextControlId(int winid) -> int
15afbcd0
RD		 8265
8266 Get the id of the control following the one with the given
41e2b43e 8267 autogenerated) id
15afbcd0 8268 """
54f9ee45 8269 return _core_.Window_NextControlId(*args, **kwargs)
d14a1e28 8270
e811c8ce
RD		 8271 NextControlId = staticmethod(NextControlId)
8272 def PrevControlId(*args, **kwargs):
15afbcd0 8273 """
66c033b4 8274 PrevControlId(int winid) -> int
15afbcd0
RD		 8275
8276 Get the id of the control preceding the one with the given
41e2b43e 8277 autogenerated) id
15afbcd0 8278 """
54f9ee45 8279 return _core_.Window_PrevControlId(*args, **kwargs)
d14a1e28 8280
e811c8ce 8281 PrevControlId = staticmethod(PrevControlId)
97ab0f6a
RD		 8282 def GetLayoutDirection(*args, **kwargs):
8283 """
994453b8 8284 GetLayoutDirection(self) -> int
97ab0f6a
RD		 8285
8286 Get the layout direction (LTR or RTL) for this window. Returns
8287 ``wx.Layout_Default`` if layout direction is not supported.
8288 """
8289 return _core_.Window_GetLayoutDirection(*args, **kwargs)
8290
8291 def SetLayoutDirection(*args, **kwargs):
8292 """
994453b8 8293 SetLayoutDirection(self, int dir)
97ab0f6a
RD		 8294
8295 Set the layout direction (LTR or RTL) for this window.
8296 """
8297 return _core_.Window_SetLayoutDirection(*args, **kwargs)
8298
8299 def AdjustForLayoutDirection(*args, **kwargs):
8300 """
8301 AdjustForLayoutDirection(self, int x, int width, int widthTotal) -> int
8302
8303 Mirror coordinates for RTL layout if this window uses it and if the
8304 mirroring is not done automatically like Win32.
8305 """
8306 return _core_.Window_AdjustForLayoutDirection(*args, **kwargs)
8307
e811c8ce 8308 def SetSize(*args, **kwargs):
15afbcd0 8309 """
a95a7133 8310 SetSize(self, Size size)
15afbcd0
RD		 8311
8312 Sets the size of the window in pixels.
8313 """
54f9ee45 8314 return _core_.Window_SetSize(*args, **kwargs)
d14a1e28 8315
e811c8ce 8316 def SetDimensions(*args, **kwargs):
15afbcd0 8317 """
a95a7133 8318 SetDimensions(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)
15afbcd0
RD		 8319
8320 Sets the position and size of the window in pixels. The sizeFlags
8321 parameter indicates the interpretation of the other params if they are
e505d15e
RD		 8322 equal to -1.
8323
8324 ======================== ======================================
8325 wx.SIZE_AUTO A -1 indicates that a class-specific
8326 default should be used.
8327 wx.SIZE_USE_EXISTING Axisting dimensions should be used if
8328 -1 values are supplied.
8329 wxSIZE_ALLOW_MINUS_ONE Allow dimensions of -1 and less to be
8330 interpreted as real dimensions, not
8331 default values.
8332 ======================== ======================================
8333
15afbcd0 8334 """
54f9ee45 8335 return _core_.Window_SetDimensions(*args, **kwargs)
d14a1e28 8336
e811c8ce 8337 def SetRect(*args, **kwargs):
15afbcd0 8338 """
a95a7133 8339 SetRect(self, Rect rect, int sizeFlags=SIZE_AUTO)
15afbcd0
RD		 8340
8341 Sets the position and size of the window in pixels using a wx.Rect.
8342 """
54f9ee45 8343 return _core_.Window_SetRect(*args, **kwargs)
d14a1e28 8344
e811c8ce 8345 def SetSizeWH(*args, **kwargs):
15afbcd0 8346 """
a95a7133 8347 SetSizeWH(self, int width, int height)
15afbcd0
RD		 8348
8349 Sets the size of the window in pixels.
8350 """
54f9ee45 8351 return _core_.Window_SetSizeWH(*args, **kwargs)
d14a1e28 8352
e811c8ce 8353 def Move(*args, **kwargs):
15afbcd0 8354 """
a95a7133 8355 Move(self, Point pt, int flags=SIZE_USE_EXISTING)
15afbcd0
RD		 8356
8357 Moves the window to the given position.
8358 """
54f9ee45 8359 return _core_.Window_Move(*args, **kwargs)
d14a1e28 8360
e811c8ce
RD		 8361 SetPosition = Move
8362 def MoveXY(*args, **kwargs):
15afbcd0 8363 """
a95a7133 8364 MoveXY(self, int x, int y, int flags=SIZE_USE_EXISTING)
15afbcd0
RD		 8365
8366 Moves the window to the given position.
8367 """
54f9ee45 8368 return _core_.Window_MoveXY(*args, **kwargs)
e811c8ce 8369
f8167d6e
RD		 8370 def SetBestFittingSize(*args, **kwargs):
8371 """
8372 SetBestFittingSize(self, Size size=DefaultSize)
8373
8374 A 'Smart' SetSize that will fill in default size components with the
8375 window's *best size* values. Also set's the minsize for use with sizers.
8376 """
8377 return _core_.Window_SetBestFittingSize(*args, **kwargs)
8378
e811c8ce 8379 def Raise(*args, **kwargs):
15afbcd0 8380 """
a95a7133 8381 Raise(self)
15afbcd0 8382
943e8dfd
RD		 8383 Raises the window to the top of the window hierarchy. In current
8384 version of wxWidgets this works both for manage and child windows.
15afbcd0 8385 """
54f9ee45 8386 return _core_.Window_Raise(*args, **kwargs)
e811c8ce
RD		 8387
8388 def Lower(*args, **kwargs):
15afbcd0 8389 """
a95a7133 8390 Lower(self)
15afbcd0 8391
943e8dfd
RD		 8392 Lowers the window to the bottom of the window hierarchy. In current
8393 version of wxWidgets this works both for manage and child windows.
15afbcd0 8394 """
54f9ee45 8395 return _core_.Window_Lower(*args, **kwargs)
e811c8ce
RD		 8396
8397 def SetClientSize(*args, **kwargs):
15afbcd0 8398 """
a95a7133 8399 SetClientSize(self, Size size)
15afbcd0
RD		 8400
8401 This sets the size of the window client area in pixels. Using this
8402 function to size a window tends to be more device-independent than
8403 wx.Window.SetSize, since the application need not worry about what
8404 dimensions the border or title bar have when trying to fit the window
8405 around panel items, for example.
8406 """
54f9ee45 8407 return _core_.Window_SetClientSize(*args, **kwargs)
e811c8ce
RD		 8408
8409 def SetClientSizeWH(*args, **kwargs):
15afbcd0 8410 """
a95a7133 8411 SetClientSizeWH(self, int width, int height)
15afbcd0
RD		 8412
8413 This sets the size of the window client area in pixels. Using this
8414 function to size a window tends to be more device-independent than
8415 wx.Window.SetSize, since the application need not worry about what
8416 dimensions the border or title bar have when trying to fit the window
8417 around panel items, for example.
8418 """
54f9ee45 8419 return _core_.Window_SetClientSizeWH(*args, **kwargs)
e811c8ce
RD		 8420
8421 def SetClientRect(*args, **kwargs):
15afbcd0 8422 """
a95a7133 8423 SetClientRect(self, Rect rect)
15afbcd0
RD		 8424
8425 This sets the size of the window client area in pixels. Using this
8426 function to size a window tends to be more device-independent than
8427 wx.Window.SetSize, since the application need not worry about what
8428 dimensions the border or title bar have when trying to fit the window
8429 around panel items, for example.
8430 """
54f9ee45 8431 return _core_.Window_SetClientRect(*args, **kwargs)
e811c8ce
RD		 8432
8433 def GetPosition(*args, **kwargs):
0df68c9f 8434 """
a95a7133 8435 GetPosition(self) -> Point
e811c8ce 8436
75219dcb
RD		 8437 Get the window's position. Notice that the position is in client
8438 coordinates for child windows and screen coordinates for the top level
8439 ones, use `GetScreenPosition` if you need screen coordinates for all
8440 kinds of windows.
0df68c9f 8441 """
54f9ee45 8442 return _core_.Window_GetPosition(*args, **kwargs)
e811c8ce
RD		 8443
8444 def GetPositionTuple(*args, **kwargs):
0df68c9f
RD		 8445 """
8446 GetPositionTuple() -> (x,y)
e811c8ce 8447
75219dcb
RD		 8448 Get the window's position. Notice that the position is in client
8449 coordinates for child windows and screen coordinates for the top level
8450 ones, use `GetScreenPosition` if you need screen coordinates for all
8451 kinds of windows.
0df68c9f 8452 """
54f9ee45 8453 return _core_.Window_GetPositionTuple(*args, **kwargs)
e811c8ce 8454
75219dcb
RD		 8455 def GetScreenPosition(*args, **kwargs):
8456 """
8457 GetScreenPosition(self) -> Point
8458
8459 Get the position of the window in screen coordinantes.
8460 """
8461 return _core_.Window_GetScreenPosition(*args, **kwargs)
8462
8463 def GetScreenPositionTuple(*args, **kwargs):
8464 """
8465 GetScreenPositionTuple() -> (x,y)
8466
8467 Get the position of the window in screen coordinantes.
8468 """
8469 return _core_.Window_GetScreenPositionTuple(*args, **kwargs)
8470
8471 def GetScreenRect(*args, **kwargs):
8472 """
8473 GetScreenRect(self) -> Rect
8474
8475 Returns the size and position of the window in screen coordinantes as
8476 a `wx.Rect` object.
8477 """
8478 return _core_.Window_GetScreenRect(*args, **kwargs)
8479
e811c8ce 8480 def GetSize(*args, **kwargs):
0df68c9f 8481 """
a95a7133 8482 GetSize(self) -> Size
e811c8ce 8483
0df68c9f
RD		 8484 Get the window size.
8485 """
54f9ee45 8486 return _core_.Window_GetSize(*args, **kwargs)
e811c8ce
RD		 8487
8488 def GetSizeTuple(*args, **kwargs):
0df68c9f
RD		 8489 """
8490 GetSizeTuple() -> (width, height)
e811c8ce 8491
0df68c9f
RD		 8492 Get the window size.
8493 """
54f9ee45 8494 return _core_.Window_GetSizeTuple(*args, **kwargs)
e811c8ce
RD		 8495
8496 def GetRect(*args, **kwargs):
15afbcd0 8497 """
a95a7133 8498 GetRect(self) -> Rect
15afbcd0 8499
75219dcb 8500 Returns the size and position of the window as a `wx.Rect` object.
15afbcd0 8501 """
54f9ee45 8502 return _core_.Window_GetRect(*args, **kwargs)
e811c8ce
RD		 8503
8504 def GetClientSize(*args, **kwargs):
0df68c9f 8505 """
a95a7133 8506 GetClientSize(self) -> Size
e811c8ce 8507
15afbcd0
RD		 8508 This gets the size of the window's 'client area' in pixels. The client
8509 area is the area which may be drawn on by the programmer, excluding
8510 title bar, border, scrollbars, etc.
0df68c9f 8511 """
54f9ee45 8512 return _core_.Window_GetClientSize(*args, **kwargs)
e811c8ce
RD		 8513
8514 def GetClientSizeTuple(*args, **kwargs):
0df68c9f
RD		 8515 """
8516 GetClientSizeTuple() -> (width, height)
e811c8ce 8517
15afbcd0
RD		 8518 This gets the size of the window's 'client area' in pixels. The client
8519 area is the area which may be drawn on by the programmer, excluding
8520 title bar, border, scrollbars, etc.
0df68c9f 8521 """
54f9ee45 8522 return _core_.Window_GetClientSizeTuple(*args, **kwargs)
e811c8ce
RD		 8523
8524 def GetClientAreaOrigin(*args, **kwargs):
15afbcd0 8525 """
a95a7133 8526 GetClientAreaOrigin(self) -> Point
15afbcd0
RD		 8527
8528 Get the origin of the client area of the window relative to the
8529 window's top left corner (the client area may be shifted because of
8530 the borders, scrollbars, other decorations...)
8531 """
54f9ee45 8532 return _core_.Window_GetClientAreaOrigin(*args, **kwargs)
e811c8ce
RD		 8533
8534 def GetClientRect(*args, **kwargs):
15afbcd0 8535 """
a95a7133 8536 GetClientRect(self) -> Rect
15afbcd0 8537
61863841 8538 Get the client area position and size as a `wx.Rect` object.
15afbcd0 8539 """
54f9ee45 8540 return _core_.Window_GetClientRect(*args, **kwargs)
e811c8ce
RD		 8541
8542 def GetBestSize(*args, **kwargs):
0df68c9f 8543 """
a95a7133 8544 GetBestSize(self) -> Size
e811c8ce 8545
248ed943 8546 This function returns the best acceptable minimal size for the
41e2b43e
RD		 8547 window, if applicable. For example, for a static text control, it will
8548 be the minimal size such that the control label is not truncated. For
8549 windows containing subwindows (suzh aswx.Panel), the size returned by
8550 this function will be the same as the size the window would have had
8551 after calling Fit.
0df68c9f 8552 """
54f9ee45 8553 return _core_.Window_GetBestSize(*args, **kwargs)
e811c8ce
RD		 8554
8555 def GetBestSizeTuple(*args, **kwargs):
0df68c9f
RD		 8556 """
8557 GetBestSizeTuple() -> (width, height)
e811c8ce 8558
248ed943 8559 This function returns the best acceptable minimal size for the
41e2b43e
RD		 8560 window, if applicable. For example, for a static text control, it will
8561 be the minimal size such that the control label is not truncated. For
8562 windows containing subwindows (suzh aswx.Panel), the size returned by
8563 this function will be the same as the size the window would have had
8564 after calling Fit.
0df68c9f 8565 """
54f9ee45 8566 return _core_.Window_GetBestSizeTuple(*args, **kwargs)
e811c8ce 8567
dfbb5885
RD		 8568 def InvalidateBestSize(*args, **kwargs):
8569 """
8570 InvalidateBestSize(self)
8571
8572 Reset the cached best size value so it will be recalculated the next
8573 time it is needed.
8574 """
8575 return _core_.Window_InvalidateBestSize(*args, **kwargs)
8576
e2813725
RD		 8577 def CacheBestSize(*args, **kwargs):
8578 """
8579 CacheBestSize(self, Size size)
8580
8581 Cache the best size so it doesn't need to be calculated again, (at least until
8582 some properties of the window change.)
8583 """
8584 return _core_.Window_CacheBestSize(*args, **kwargs)
8585
dfbb5885
RD		 8586 def GetBestFittingSize(*args, **kwargs):
8587 """
8588 GetBestFittingSize(self) -> Size
8589
8590 This function will merge the window's best size into the window's
8591 minimum size, giving priority to the min size components, and returns
8592 the results.
8593
8594 """
8595 return _core_.Window_GetBestFittingSize(*args, **kwargs)
8596
e811c8ce 8597 def GetAdjustedBestSize(*args, **kwargs):
15afbcd0 8598 """
a95a7133 8599 GetAdjustedBestSize(self) -> Size
15afbcd0
RD		 8600
8601 This method is similar to GetBestSize, except in one
8602 thing. GetBestSize should return the minimum untruncated size of the
8603 window, while this method will return the largest of BestSize and any
8604 user specified minimum size. ie. it is the minimum size the window
8605 should currently be drawn at, not the minimal size it can possibly
8606 tolerate.
8607 """
54f9ee45 8608 return _core_.Window_GetAdjustedBestSize(*args, **kwargs)
e811c8ce
RD		 8609
8610 def Center(*args, **kwargs):
15afbcd0 8611 """
a95a7133 8612 Center(self, int direction=BOTH)
15afbcd0
RD		 8613
8614 Centers the window. The parameter specifies the direction for
8615 cetering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may
8616 also include wx.CENTER_ON_SCREEN flag if you want to center the window
8617 on the entire screen and not on its parent window. If it is a
8618 top-level window and has no parent then it will always be centered
8619 relative to the screen.
8620 """
54f9ee45 8621 return _core_.Window_Center(*args, **kwargs)
e811c8ce
RD		 8622
8623 Centre = Center
e811c8ce 8624 def CenterOnParent(*args, **kwargs):
15afbcd0 8625 """
a95a7133 8626 CenterOnParent(self, int dir=BOTH)
15afbcd0
RD		 8627
8628 Center with respect to the the parent window
8629 """
54f9ee45 8630 return _core_.Window_CenterOnParent(*args, **kwargs)
e811c8ce
RD		 8631
8632 CentreOnParent = CenterOnParent
8633 def Fit(*args, **kwargs):
15afbcd0 8634 """
a95a7133 8635 Fit(self)
15afbcd0
RD		 8636
8637 Sizes the window so that it fits around its subwindows. This function
8638 won't do anything if there are no subwindows and will only really work
8639 correctly if sizers are used for the subwindows layout. Also, if the
8640 window has exactly one subwindow it is better (faster and the result
8641 is more precise as Fit adds some margin to account for fuzziness of
8642 its calculations) to call window.SetClientSize(child.GetSize())
8643 instead of calling Fit.
8644 """
54f9ee45 8645 return _core_.Window_Fit(*args, **kwargs)
e811c8ce
RD		 8646
8647 def FitInside(*args, **kwargs):
15afbcd0 8648 """
a95a7133 8649 FitInside(self)
15afbcd0
RD		 8650
8651 Similar to Fit, but sizes the interior (virtual) size of a
8652 window. Mainly useful with scrolled windows to reset scrollbars after
8653 sizing changes that do not trigger a size event, and/or scrolled
8654 windows without an interior sizer. This function similarly won't do
8655 anything if there are no subwindows.
8656 """
54f9ee45 8657 return _core_.Window_FitInside(*args, **kwargs)
e811c8ce 8658
f16ab95d 8659 def SetSizeHints(*args, **kwargs):
0df68c9f 8660 """
a95a7133 8661 SetSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1,
0df68c9f 8662 int incH=-1)
15afbcd0
RD		 8663
8664 Allows specification of minimum and maximum window sizes, and window
8665 size increments. If a pair of values is not set (or set to -1), the
8666 default values will be used. If this function is called, the user
908b74cd
RD		 8667 will not be able to size the window outside the given bounds (if it is
8668 a top-level window.) Sizers will also inspect the minimum window size
8669 and will use that value if set when calculating layout.
8670
8671 The resizing increments are only significant under Motif or Xt.
0df68c9f 8672 """
f16ab95d 8673 return _core_.Window_SetSizeHints(*args, **kwargs)
e811c8ce 8674
f16ab95d
RD		 8675 def SetSizeHintsSz(*args, **kwargs):
8676 """
8677 SetSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize, Size incSize=DefaultSize)
8678
8679 Allows specification of minimum and maximum window sizes, and window
8680 size increments. If a pair of values is not set (or set to -1), the
8681 default values will be used. If this function is called, the user
8682 will not be able to size the window outside the given bounds (if it is
8683 a top-level window.) Sizers will also inspect the minimum window size
8684 and will use that value if set when calculating layout.
8685
8686 The resizing increments are only significant under Motif or Xt.
8687 """
8688 return _core_.Window_SetSizeHintsSz(*args, **kwargs)
8689
8690 def SetVirtualSizeHints(*args, **kwargs):
15afbcd0 8691 """
908b74cd 8692 SetVirtualSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1)
15afbcd0
RD		 8693
8694 Allows specification of minimum and maximum virtual window sizes. If a
8695 pair of values is not set (or set to -1), the default values will be
8696 used. If this function is called, the user will not be able to size
8697 the virtual area of the window outside the given bounds.
8698 """
f16ab95d
RD		 8699 return _core_.Window_SetVirtualSizeHints(*args, **kwargs)
8700
8701 def SetVirtualSizeHintsSz(*args, **kwargs):
8702 """
8703 SetVirtualSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize)
8704
8705 Allows specification of minimum and maximum virtual window sizes. If a
8706 pair of values is not set (or set to -1), the default values will be
8707 used. If this function is called, the user will not be able to size
8708 the virtual area of the window outside the given bounds.
8709 """
8710 return _core_.Window_SetVirtualSizeHintsSz(*args, **kwargs)
e811c8ce 8711
908b74cd
RD		 8712 def GetMaxSize(*args, **kwargs):
8713 """GetMaxSize(self) -> Size"""
8714 return _core_.Window_GetMaxSize(*args, **kwargs)
8715
8716 def GetMinSize(*args, **kwargs):
8717 """GetMinSize(self) -> Size"""
8718 return _core_.Window_GetMinSize(*args, **kwargs)
8719
8720 def SetMinSize(*args, **kwargs):
8721 """
8722 SetMinSize(self, Size minSize)
8723
8724 A more convenient method than `SetSizeHints` for setting just the
8725 min size.
8726 """
8727 return _core_.Window_SetMinSize(*args, **kwargs)
8728
8729 def SetMaxSize(*args, **kwargs):
8730 """
8731 SetMaxSize(self, Size maxSize)
8732
8733 A more convenient method than `SetSizeHints` for setting just the
8734 max size.
8735 """
8736 return _core_.Window_SetMaxSize(*args, **kwargs)
8737
e811c8ce 8738 def GetMinWidth(*args, **kwargs):
a95a7133 8739 """GetMinWidth(self) -> int"""
54f9ee45 8740 return _core_.Window_GetMinWidth(*args, **kwargs)
e811c8ce
RD		 8741
8742 def GetMinHeight(*args, **kwargs):
a95a7133 8743 """GetMinHeight(self) -> int"""
54f9ee45 8744 return _core_.Window_GetMinHeight(*args, **kwargs)
e811c8ce
RD		 8745
8746 def GetMaxWidth(*args, **kwargs):
a95a7133 8747 """GetMaxWidth(self) -> int"""
54f9ee45 8748 return _core_.Window_GetMaxWidth(*args, **kwargs)
e811c8ce
RD		 8749
8750 def GetMaxHeight(*args, **kwargs):
a95a7133 8751 """GetMaxHeight(self) -> int"""
54f9ee45 8752 return _core_.Window_GetMaxHeight(*args, **kwargs)
e811c8ce 8753
e811c8ce 8754 def SetVirtualSize(*args, **kwargs):
0df68c9f 8755 """
a95a7133 8756 SetVirtualSize(self, Size size)
e811c8ce 8757
15afbcd0
RD		 8758 Set the the virtual size of a window in pixels. For most windows this
8759 is just the client area of the window, but for some like scrolled
8760 windows it is more or less independent of the screen window size.
0df68c9f 8761 """
54f9ee45 8762 return _core_.Window_SetVirtualSize(*args, **kwargs)
e811c8ce
RD		 8763
8764 def SetVirtualSizeWH(*args, **kwargs):
0df68c9f 8765 """
a95a7133 8766 SetVirtualSizeWH(self, int w, int h)
e811c8ce 8767
15afbcd0
RD		 8768 Set the the virtual size of a window in pixels. For most windows this
8769 is just the client area of the window, but for some like scrolled
8770 windows it is more or less independent of the screen window size.
0df68c9f 8771 """
54f9ee45 8772 return _core_.Window_SetVirtualSizeWH(*args, **kwargs)
e811c8ce
RD		 8773
8774 def GetVirtualSize(*args, **kwargs):
0df68c9f 8775 """
a95a7133 8776 GetVirtualSize(self) -> Size
e811c8ce 8777
15afbcd0
RD		 8778 Get the the virtual size of the window in pixels. For most windows
8779 this is just the client area of the window, but for some like scrolled
8780 windows it is more or less independent of the screen window size.
0df68c9f 8781 """
54f9ee45 8782 return _core_.Window_GetVirtualSize(*args, **kwargs)
e811c8ce
RD		 8783
8784 def GetVirtualSizeTuple(*args, **kwargs):
0df68c9f
RD		 8785 """
8786 GetVirtualSizeTuple() -> (width, height)
e811c8ce 8787
15afbcd0
RD		 8788 Get the the virtual size of the window in pixels. For most windows
8789 this is just the client area of the window, but for some like scrolled
8790 windows it is more or less independent of the screen window size.
0df68c9f 8791 """
54f9ee45 8792 return _core_.Window_GetVirtualSizeTuple(*args, **kwargs)
e811c8ce
RD		 8793
8794 def GetBestVirtualSize(*args, **kwargs):
15afbcd0 8795 """
a95a7133 8796 GetBestVirtualSize(self) -> Size
15afbcd0
RD		 8797
8798 Return the largest of ClientSize and BestSize (as determined by a
8799 sizer, interior children, or other means)
8800 """
54f9ee45 8801 return _core_.Window_GetBestVirtualSize(*args, **kwargs)
e811c8ce
RD		 8802
8803 def Show(*args, **kwargs):
15afbcd0 8804 """
a95a7133 8805 Show(self, bool show=True) -> bool
15afbcd0
RD		 8806
8807 Shows or hides the window. You may need to call Raise for a top level
8808 window if you want to bring it to top, although this is not needed if
8809 Show is called immediately after the frame creation. Returns True if
8810 the window has been shown or hidden or False if nothing was done
8811 because it already was in the requested state.
8812 """
54f9ee45 8813 return _core_.Window_Show(*args, **kwargs)
e811c8ce
RD		 8814
8815 def Hide(*args, **kwargs):
15afbcd0 8816 """
a95a7133 8817 Hide(self) -> bool
15afbcd0
RD		 8818
8819 Equivalent to calling Show(False).
8820 """
54f9ee45 8821 return _core_.Window_Hide(*args, **kwargs)
e811c8ce
RD		 8822
8823 def Enable(*args, **kwargs):
15afbcd0 8824 """
a95a7133 8825 Enable(self, bool enable=True) -> bool
15afbcd0
RD		 8826
8827 Enable or disable the window for user input. Note that when a parent
8828 window is disabled, all of its children are disabled as well and they
8829 are reenabled again when the parent is. Returns true if the window
8830 has been enabled or disabled, false if nothing was done, i.e. if the
8831 window had already been in the specified state.
8832 """
54f9ee45 8833 return _core_.Window_Enable(*args, **kwargs)
e811c8ce
RD		 8834
8835 def Disable(*args, **kwargs):
15afbcd0 8836 """
a95a7133 8837 Disable(self) -> bool
15afbcd0
RD		 8838
8839 Disables the window, same as Enable(false).
8840 """
54f9ee45 8841 return _core_.Window_Disable(*args, **kwargs)
e811c8ce
RD		 8842
8843 def IsShown(*args, **kwargs):
15afbcd0 8844 """
a95a7133 8845 IsShown(self) -> bool
15afbcd0
RD		 8846
8847 Returns true if the window is shown, false if it has been hidden.
8848 """
54f9ee45 8849 return _core_.Window_IsShown(*args, **kwargs)
e811c8ce
RD		 8850
8851 def IsEnabled(*args, **kwargs):
15afbcd0 8852 """
a95a7133 8853 IsEnabled(self) -> bool
15afbcd0
RD		 8854
8855 Returns true if the window is enabled for input, false otherwise.
8856 """
54f9ee45 8857 return _core_.Window_IsEnabled(*args, **kwargs)
e811c8ce 8858
33d6fd3b
RD		 8859 def IsShownOnScreen(*args, **kwargs):
8860 """
8861 IsShownOnScreen(self) -> bool
8862
8863 Returns ``True`` if the window is physically visible on the screen,
8864 i.e. it is shown and all its parents up to the toplevel window are
8865 shown as well.
8866 """
8867 return _core_.Window_IsShownOnScreen(*args, **kwargs)
8868
e811c8ce 8869 def SetWindowStyleFlag(*args, **kwargs):
15afbcd0 8870 """
a95a7133 8871 SetWindowStyleFlag(self, long style)
15afbcd0 8872
41e2b43e
RD		 8873 Sets the style of the window. Please note that some styles cannot be
8874 changed after the window creation and that Refresh() might need to be
8875 called after changing the others for the change to take place
8876 immediately.
15afbcd0 8877 """
54f9ee45 8878 return _core_.Window_SetWindowStyleFlag(*args, **kwargs)
e811c8ce
RD		 8879
8880 def GetWindowStyleFlag(*args, **kwargs):
15afbcd0 8881 """
a95a7133 8882 GetWindowStyleFlag(self) -> long
e811c8ce 8883
15afbcd0
RD		 8884 Gets the window style that was passed to the constructor or Create
8885 method.
8886 """
54f9ee45 8887 return _core_.Window_GetWindowStyleFlag(*args, **kwargs)
e811c8ce 8888
15afbcd0 8889 SetWindowStyle = SetWindowStyleFlag; GetWindowStyle = GetWindowStyleFlag
e811c8ce 8890 def HasFlag(*args, **kwargs):
15afbcd0 8891 """
a95a7133 8892 HasFlag(self, int flag) -> bool
15afbcd0
RD		 8893
8894 Test if the given style is set for this window.
8895 """
54f9ee45 8896 return _core_.Window_HasFlag(*args, **kwargs)
e811c8ce
RD		 8897
8898 def IsRetained(*args, **kwargs):
15afbcd0 8899 """
a95a7133 8900 IsRetained(self) -> bool
15afbcd0
RD		 8901
8902 Returns true if the window is retained, false otherwise. Retained
8903 windows are only available on X platforms.
8904 """
54f9ee45 8905 return _core_.Window_IsRetained(*args, **kwargs)
e811c8ce
RD		 8906
8907 def SetExtraStyle(*args, **kwargs):
15afbcd0 8908 """
a95a7133 8909 SetExtraStyle(self, long exStyle)
15afbcd0
RD		 8910
8911 Sets the extra style bits for the window. Extra styles are the less
8912 often used style bits which can't be set with the constructor or with
8913 SetWindowStyleFlag()
8914 """
54f9ee45 8915 return _core_.Window_SetExtraStyle(*args, **kwargs)
e811c8ce
RD		 8916
8917 def GetExtraStyle(*args, **kwargs):
15afbcd0 8918 """
a95a7133 8919 GetExtraStyle(self) -> long
15afbcd0
RD		 8920
8921 Returns the extra style bits for the window.
8922 """
54f9ee45 8923 return _core_.Window_GetExtraStyle(*args, **kwargs)
e811c8ce
RD		 8924
8925 def MakeModal(*args, **kwargs):
15afbcd0 8926 """
a95a7133 8927 MakeModal(self, bool modal=True)
15afbcd0
RD		 8928
8929 Disables all other windows in the application so that the user can
8930 only interact with this window. Passing False will reverse this
8931 effect.
8932 """
54f9ee45 8933 return _core_.Window_MakeModal(*args, **kwargs)
e811c8ce
RD		 8934
8935 def SetThemeEnabled(*args, **kwargs):
15afbcd0 8936 """
a95a7133 8937 SetThemeEnabled(self, bool enableTheme)
15afbcd0
RD		 8938
8939 This function tells a window if it should use the system's "theme"
8940 code to draw the windows' background instead if its own background
8941 drawing code. This will only have an effect on platforms that support
8942 the notion of themes in user defined windows. One such platform is
8943 GTK+ where windows can have (very colourful) backgrounds defined by a
8944 user's selected theme.
8945
8946 Dialogs, notebook pages and the status bar have this flag set to true
8947 by default so that the default look and feel is simulated best.
8948 """
54f9ee45 8949 return _core_.Window_SetThemeEnabled(*args, **kwargs)
e811c8ce
RD		 8950
8951 def GetThemeEnabled(*args, **kwargs):
15afbcd0 8952 """
a95a7133 8953 GetThemeEnabled(self) -> bool
e811c8ce 8954
15afbcd0
RD		 8955 Return the themeEnabled flag.
8956 """
54f9ee45 8957 return _core_.Window_GetThemeEnabled(*args, **kwargs)
e811c8ce
RD		 8958
8959 def SetFocus(*args, **kwargs):
15afbcd0 8960 """
a95a7133 8961 SetFocus(self)
15afbcd0
RD		 8962
8963 Set's the focus to this window, allowing it to receive keyboard input.
8964 """
54f9ee45 8965 return _core_.Window_SetFocus(*args, **kwargs)
e811c8ce
RD		 8966
8967 def SetFocusFromKbd(*args, **kwargs):
15afbcd0 8968 """
a95a7133 8969 SetFocusFromKbd(self)
15afbcd0
RD		 8970
8971 Set focus to this window as the result of a keyboard action. Normally
8972 only called internally.
8973 """
54f9ee45 8974 return _core_.Window_SetFocusFromKbd(*args, **kwargs)
e811c8ce
RD		 8975
8976 def FindFocus(*args, **kwargs):
15afbcd0 8977 """
66c033b4 8978 FindFocus() -> Window
15afbcd0
RD		 8979
8980 Returns the window or control that currently has the keyboard focus,
8981 or None.
8982 """
54f9ee45 8983 return _core_.Window_FindFocus(*args, **kwargs)
e811c8ce
RD		 8984
8985 FindFocus = staticmethod(FindFocus)
8986 def AcceptsFocus(*args, **kwargs):
15afbcd0 8987 """
a95a7133 8988 AcceptsFocus(self) -> bool
15afbcd0
RD		 8989
8990 Can this window have focus?
8991 """
54f9ee45 8992 return _core_.Window_AcceptsFocus(*args, **kwargs)
e811c8ce
RD		 8993
8994 def AcceptsFocusFromKeyboard(*args, **kwargs):
15afbcd0 8995 """
a95a7133 8996 AcceptsFocusFromKeyboard(self) -> bool
15afbcd0
RD		 8997
8998 Can this window be given focus by keyboard navigation? if not, the
8999 only way to give it focus (provided it accepts it at all) is to click
9000 it.
9001 """
54f9ee45 9002 return _core_.Window_AcceptsFocusFromKeyboard(*args, **kwargs)
e811c8ce 9003
908b74cd
RD		 9004 def Navigate(*args, **kwargs):
9005 """
9006 Navigate(self, int flags=NavigationKeyEvent.IsForward) -> bool
9007
fd2dc343
RD		 9008 Does keyboard navigation from this window to another, by sending a
9009 `wx.NavigationKeyEvent`.
908b74cd
RD		 9010 """
9011 return _core_.Window_Navigate(*args, **kwargs)
9012
7f98d120
RD		 9013 def MoveAfterInTabOrder(*args, **kwargs):
9014 """
9015 MoveAfterInTabOrder(self, Window win)
9016
9017 Moves this window in the tab navigation order after the specified
9018 sibling window. This means that when the user presses the TAB key on
9019 that other window, the focus switches to this window.
9020
9021 The default tab order is the same as creation order. This function
9022 and `MoveBeforeInTabOrder` allow to change it after creating all the
9023 windows.
9024
9025 """
9026 return _core_.Window_MoveAfterInTabOrder(*args, **kwargs)
9027
9028 def MoveBeforeInTabOrder(*args, **kwargs):
9029 """
9030 MoveBeforeInTabOrder(self, Window win)
9031
9032 Same as `MoveAfterInTabOrder` except that it inserts this window just
9033 before win instead of putting it right after it.
9034 """
9035 return _core_.Window_MoveBeforeInTabOrder(*args, **kwargs)
9036
e811c8ce 9037 def GetChildren(*args, **kwargs):
15afbcd0 9038 """
a95a7133 9039 GetChildren(self) -> PyObject
15afbcd0
RD		 9040
9041 Returns a list of the window's children. NOTE: Currently this is a
9042 copy of the child window list maintained by the window, so the return
9043 value of this function is only valid as long as the window's children
9044 do not change.
9045 """
54f9ee45 9046 return _core_.Window_GetChildren(*args, **kwargs)
e811c8ce
RD		 9047
9048 def GetParent(*args, **kwargs):
15afbcd0 9049 """
a95a7133 9050 GetParent(self) -> Window
15afbcd0
RD		 9051
9052 Returns the parent window of this window, or None if there isn't one.
9053 """
54f9ee45 9054 return _core_.Window_GetParent(*args, **kwargs)
e811c8ce
RD		 9055
9056 def GetGrandParent(*args, **kwargs):
15afbcd0 9057 """
a95a7133 9058 GetGrandParent(self) -> Window
15afbcd0 9059
41e2b43e
RD		 9060 Returns the parent of the parent of this window, or None if there
9061 isn't one.
15afbcd0 9062 """
54f9ee45 9063 return _core_.Window_GetGrandParent(*args, **kwargs)
e811c8ce
RD		 9064
9065 def IsTopLevel(*args, **kwargs):
15afbcd0 9066 """
a95a7133 9067 IsTopLevel(self) -> bool
15afbcd0
RD		 9068
9069 Returns true if the given window is a top-level one. Currently all
9070 frames and dialogs are always considered to be top-level windows (even
9071 if they have a parent window).
9072 """
54f9ee45 9073 return _core_.Window_IsTopLevel(*args, **kwargs)
e811c8ce
RD		 9074
9075 def Reparent(*args, **kwargs):
15afbcd0 9076 """
a95a7133 9077 Reparent(self, Window newParent) -> bool
15afbcd0
RD		 9078
9079 Reparents the window, i.e the window will be removed from its current
9080 parent window (e.g. a non-standard toolbar in a wxFrame) and then
9081 re-inserted into another. Available on Windows and GTK. Returns True
9082 if the parent was changed, False otherwise (error or newParent ==
9083 oldParent)
9084 """
54f9ee45 9085 return _core_.Window_Reparent(*args, **kwargs)
e811c8ce
RD		 9086
9087 def AddChild(*args, **kwargs):
15afbcd0 9088 """
a95a7133 9089 AddChild(self, Window child)
15afbcd0
RD		 9090
9091 Adds a child window. This is called automatically by window creation
9092 functions so should not be required by the application programmer.
9093 """
54f9ee45 9094 return _core_.Window_AddChild(*args, **kwargs)
e811c8ce
RD		 9095
9096 def RemoveChild(*args, **kwargs):
15afbcd0 9097 """
a95a7133 9098 RemoveChild(self, Window child)
15afbcd0
RD		 9099
9100 Removes a child window. This is called automatically by window
9101 deletion functions so should not be required by the application
9102 programmer.
9103 """
54f9ee45 9104 return _core_.Window_RemoveChild(*args, **kwargs)
e811c8ce 9105
704eda0c
RD		 9106 def SetDoubleBuffered(*args, **kwargs):
9107 """
9108 SetDoubleBuffered(self, bool on)
9109
9110 Currently wxGTK2 only.
9111 """
9112 return _core_.Window_SetDoubleBuffered(*args, **kwargs)
9113
e811c8ce 9114 def FindWindowById(*args, **kwargs):
15afbcd0 9115 """
a95a7133 9116 FindWindowById(self, long winid) -> Window
15afbcd0
RD		 9117
9118 Find a chld of this window by window ID
9119 """
54f9ee45 9120 return _core_.Window_FindWindowById(*args, **kwargs)
e811c8ce
RD		 9121
9122 def FindWindowByName(*args, **kwargs):
15afbcd0 9123 """
a95a7133 9124 FindWindowByName(self, String name) -> Window
15afbcd0
RD		 9125
9126 Find a child of this window by name
9127 """
54f9ee45 9128 return _core_.Window_FindWindowByName(*args, **kwargs)
e811c8ce
RD		 9129
9130 def GetEventHandler(*args, **kwargs):
15afbcd0 9131 """
a95a7133 9132 GetEventHandler(self) -> EvtHandler
15afbcd0
RD		 9133
9134 Returns the event handler for this window. By default, the window is
9135 its own event handler.
9136 """
54f9ee45 9137 return _core_.Window_GetEventHandler(*args, **kwargs)
e811c8ce
RD		 9138
9139 def SetEventHandler(*args, **kwargs):
15afbcd0 9140 """
a95a7133 9141 SetEventHandler(self, EvtHandler handler)
15afbcd0
RD		 9142
9143 Sets the event handler for this window. An event handler is an object
d49bdf34
RD		 9144 that is capable of processing the events sent to a window. (In other
9145 words, is able to dispatch the events to handler function.) By
9146 default, the window is its own event handler, but an application may
9147 wish to substitute another, for example to allow central
9148 implementation of event-handling for a variety of different window
9149 classes.
15afbcd0 9150
41e2b43e 9151 It is usually better to use `wx.Window.PushEventHandler` since this sets
15afbcd0 9152 up a chain of event handlers, where an event not handled by one event
d49bdf34 9153 handler is handed off to the next one in the chain.
15afbcd0 9154 """
54f9ee45 9155 return _core_.Window_SetEventHandler(*args, **kwargs)
e811c8ce
RD		 9156
9157 def PushEventHandler(*args, **kwargs):
15afbcd0 9158 """
a95a7133 9159 PushEventHandler(self, EvtHandler handler)
15afbcd0
RD		 9160
9161 Pushes this event handler onto the event handler stack for the window.
9162 An event handler is an object that is capable of processing the events
d49bdf34
RD		 9163 sent to a window. (In other words, is able to dispatch the events to
9164 handler function.) By default, the window is its own event handler,
9165 but an application may wish to substitute another, for example to
9166 allow central implementation of event-handling for a variety of
9167 different window classes.
15afbcd0
RD		 9168
9169 wx.Window.PushEventHandler allows an application to set up a chain of
9170 event handlers, where an event not handled by one event handler is
d49bdf34
RD		 9171 handed to the next one in the chain. Use `wx.Window.PopEventHandler`
9172 to remove the event handler. Ownership of the handler is *not* given
9173 to the window, so you should be sure to pop the handler before the
9174 window is destroyed and either let PopEventHandler destroy it, or call
9175 its Destroy method yourself.
15afbcd0 9176 """
54f9ee45 9177 return _core_.Window_PushEventHandler(*args, **kwargs)
e811c8ce
RD		 9178
9179 def PopEventHandler(*args, **kwargs):
15afbcd0 9180 """
a95a7133 9181 PopEventHandler(self, bool deleteHandler=False) -> EvtHandler
15afbcd0
RD		 9182
9183 Removes and returns the top-most event handler on the event handler
9184 stack. If deleteHandler is True then the wx.EvtHandler object will be
d49bdf34 9185 destroyed after it is popped, and ``None`` will be returned instead.
15afbcd0 9186 """
54f9ee45 9187 return _core_.Window_PopEventHandler(*args, **kwargs)
e811c8ce
RD		 9188
9189 def RemoveEventHandler(*args, **kwargs):
15afbcd0 9190 """
a95a7133 9191 RemoveEventHandler(self, EvtHandler handler) -> bool
15afbcd0 9192
41e2b43e 9193 Find the given handler in the event handler chain and remove (but not
d49bdf34 9194 delete) it from the event handler chain, returns True if it was found
41e2b43e
RD		 9195 and False otherwise (this also results in an assert failure so this
9196 function should only be called when the handler is supposed to be
9197 there.)
15afbcd0 9198 """
54f9ee45 9199 return _core_.Window_RemoveEventHandler(*args, **kwargs)
e811c8ce
RD		 9200
9201 def SetValidator(*args, **kwargs):
15afbcd0 9202 """
a95a7133 9203 SetValidator(self, Validator validator)
15afbcd0
RD		 9204
9205 Deletes the current validator (if any) and sets the window validator,
9206 having called wx.Validator.Clone to create a new validator of this
9207 type.
9208 """
54f9ee45 9209 return _core_.Window_SetValidator(*args, **kwargs)
e811c8ce
RD		 9210
9211 def GetValidator(*args, **kwargs):
15afbcd0 9212 """
a95a7133 9213 GetValidator(self) -> Validator
15afbcd0
RD		 9214
9215 Returns a pointer to the current validator for the window, or None if
9216 there is none.
9217 """
54f9ee45 9218 return _core_.Window_GetValidator(*args, **kwargs)
e811c8ce 9219
74a57fcd
RD		 9220 def Validate(*args, **kwargs):
9221 """
a95a7133 9222 Validate(self) -> bool
74a57fcd
RD		 9223
9224 Validates the current values of the child controls using their
41e2b43e
RD		 9225 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
9226 style flag set, the method will also call Validate() of all child
9227 windows. Returns false if any of the validations failed.
74a57fcd 9228 """
54f9ee45 9229 return _core_.Window_Validate(*args, **kwargs)
74a57fcd
RD		 9230
9231 def TransferDataToWindow(*args, **kwargs):
9232 """
a95a7133 9233 TransferDataToWindow(self) -> bool
74a57fcd 9234
41e2b43e
RD		 9235 Transfers values to child controls from data areas specified by their
9236 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
9237 style flag set, the method will also call TransferDataToWindow() of
9238 all child windows.
74a57fcd 9239 """
54f9ee45 9240 return _core_.Window_TransferDataToWindow(*args, **kwargs)
74a57fcd
RD		 9241
9242 def TransferDataFromWindow(*args, **kwargs):
9243 """
a95a7133 9244 TransferDataFromWindow(self) -> bool
74a57fcd 9245
41e2b43e
RD		 9246 Transfers values from child controls to data areas specified by their
9247 validators. Returns false if a transfer failed. If the window has
9248 wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will
9249 also call TransferDataFromWindow() of all child windows.
74a57fcd 9250 """
54f9ee45 9251 return _core_.Window_TransferDataFromWindow(*args, **kwargs)
74a57fcd
RD		 9252
9253 def InitDialog(*args, **kwargs):
9254 """
a95a7133 9255 InitDialog(self)
74a57fcd 9256
41e2b43e
RD		 9257 Sends an EVT_INIT_DIALOG event, whose handler usually transfers data
9258 to the dialog via validators.
74a57fcd 9259 """
54f9ee45 9260 return _core_.Window_InitDialog(*args, **kwargs)
74a57fcd 9261
e811c8ce 9262 def SetAcceleratorTable(*args, **kwargs):
15afbcd0 9263 """
a95a7133 9264 SetAcceleratorTable(self, AcceleratorTable accel)
15afbcd0
RD		 9265
9266 Sets the accelerator table for this window.
9267 """
54f9ee45 9268 return _core_.Window_SetAcceleratorTable(*args, **kwargs)
e811c8ce
RD		 9269
9270 def GetAcceleratorTable(*args, **kwargs):
15afbcd0 9271 """
a95a7133 9272 GetAcceleratorTable(self) -> AcceleratorTable
15afbcd0
RD		 9273
9274 Gets the accelerator table for this window.
9275 """
54f9ee45 9276 return _core_.Window_GetAcceleratorTable(*args, **kwargs)
e811c8ce
RD		 9277
9278 def RegisterHotKey(*args, **kwargs):
15afbcd0 9279 """
a95a7133 9280 RegisterHotKey(self, int hotkeyId, int modifiers, int keycode) -> bool
15afbcd0
RD		 9281
9282 Registers a system wide hotkey. Every time the user presses the hotkey
9283 registered here, this window will receive a hotkey event. It will
9284 receive the event even if the application is in the background and
9285 does not have the input focus because the user is working with some
9286 other application. To bind an event handler function to this hotkey
9287 use EVT_HOTKEY with an id equal to hotkeyId. Returns True if the
9288 hotkey was registered successfully.
9289 """
54f9ee45 9290 return _core_.Window_RegisterHotKey(*args, **kwargs)
e811c8ce
RD		 9291
9292 def UnregisterHotKey(*args, **kwargs):
15afbcd0 9293 """
a95a7133 9294 UnregisterHotKey(self, int hotkeyId) -> bool
15afbcd0
RD		 9295
9296 Unregisters a system wide hotkey.
9297 """
54f9ee45 9298 return _core_.Window_UnregisterHotKey(*args, **kwargs)
e811c8ce
RD		 9299
9300 def ConvertDialogPointToPixels(*args, **kwargs):
15afbcd0 9301 """
a95a7133 9302 ConvertDialogPointToPixels(self, Point pt) -> Point
15afbcd0
RD		 9303
9304 Converts a point or size from dialog units to pixels. Dialog units
9305 are used for maintaining a dialog's proportions even if the font
9306 changes. For the x dimension, the dialog units are multiplied by the
9307 average character width and then divided by 4. For the y dimension,
9308 the dialog units are multiplied by the average character height and
9309 then divided by 8.
9310 """
54f9ee45 9311 return _core_.Window_ConvertDialogPointToPixels(*args, **kwargs)
e811c8ce
RD		 9312
9313 def ConvertDialogSizeToPixels(*args, **kwargs):
15afbcd0 9314 """
a95a7133 9315 ConvertDialogSizeToPixels(self, Size sz) -> Size
15afbcd0
RD		 9316
9317 Converts a point or size from dialog units to pixels. Dialog units
9318 are used for maintaining a dialog's proportions even if the font
9319 changes. For the x dimension, the dialog units are multiplied by the
9320 average character width and then divided by 4. For the y dimension,
9321 the dialog units are multiplied by the average character height and
9322 then divided by 8.
9323 """
54f9ee45 9324 return _core_.Window_ConvertDialogSizeToPixels(*args, **kwargs)
e811c8ce
RD		 9325
9326 def DLG_PNT(*args, **kwargs):
15afbcd0 9327 """
a95a7133 9328 DLG_PNT(self, Point pt) -> Point
15afbcd0
RD		 9329
9330 Converts a point or size from dialog units to pixels. Dialog units
9331 are used for maintaining a dialog's proportions even if the font
9332 changes. For the x dimension, the dialog units are multiplied by the
9333 average character width and then divided by 4. For the y dimension,
9334 the dialog units are multiplied by the average character height and
9335 then divided by 8.
9336 """
54f9ee45 9337 return _core_.Window_DLG_PNT(*args, **kwargs)
e811c8ce
RD		 9338
9339 def DLG_SZE(*args, **kwargs):
15afbcd0 9340 """
a95a7133 9341 DLG_SZE(self, Size sz) -> Size
15afbcd0
RD		 9342
9343 Converts a point or size from dialog units to pixels. Dialog units
9344 are used for maintaining a dialog's proportions even if the font
9345 changes. For the x dimension, the dialog units are multiplied by the
9346 average character width and then divided by 4. For the y dimension,
9347 the dialog units are multiplied by the average character height and
9348 then divided by 8.
9349 """
54f9ee45 9350 return _core_.Window_DLG_SZE(*args, **kwargs)
e811c8ce
RD		 9351
9352 def ConvertPixelPointToDialog(*args, **kwargs):
a95a7133 9353 """ConvertPixelPointToDialog(self, Point pt) -> Point"""
54f9ee45 9354 return _core_.Window_ConvertPixelPointToDialog(*args, **kwargs)
e811c8ce
RD		 9355
9356 def ConvertPixelSizeToDialog(*args, **kwargs):
a95a7133 9357 """ConvertPixelSizeToDialog(self, Size sz) -> Size"""
54f9ee45 9358 return _core_.Window_ConvertPixelSizeToDialog(*args, **kwargs)
e811c8ce
RD		 9359
9360 def WarpPointer(*args, **kwargs):
15afbcd0 9361 """
a95a7133 9362 WarpPointer(self, int x, int y)
15afbcd0
RD		 9363
9364 Moves the pointer to the given position on the window.
9365
9366 NOTE: This function is not supported under Mac because Apple Human
9367 Interface Guidelines forbid moving the mouse cursor programmatically.
9368 """
54f9ee45 9369 return _core_.Window_WarpPointer(*args, **kwargs)
e811c8ce
RD		 9370
9371 def CaptureMouse(*args, **kwargs):
15afbcd0 9372 """
a95a7133 9373 CaptureMouse(self)
15afbcd0
RD		 9374
9375 Directs all mouse input to this window. Call wx.Window.ReleaseMouse to
9376 release the capture.
9377
9378 Note that wxWindows maintains the stack of windows having captured the
9379 mouse and when the mouse is released the capture returns to the window
9380 which had had captured it previously and it is only really released if
9381 there were no previous window. In particular, this means that you must
34e0a3bb
RD		 9382 release the mouse as many times as you capture it, unless the window
9383 receives the `wx.MouseCaptureLostEvent` event.
9384
9385 Any application which captures the mouse in the beginning of some
9386 operation *must* handle `wx.MouseCaptureLostEvent` and cancel this
9387 operation when it receives the event. The event handler must not
9388 recapture mouse.
15afbcd0 9389 """
54f9ee45 9390 return _core_.Window_CaptureMouse(*args, **kwargs)
e811c8ce
RD		 9391
9392 def ReleaseMouse(*args, **kwargs):
15afbcd0 9393 """
a95a7133 9394 ReleaseMouse(self)
15afbcd0
RD		 9395
9396 Releases mouse input captured with wx.Window.CaptureMouse.
9397 """
54f9ee45 9398 return _core_.Window_ReleaseMouse(*args, **kwargs)
e811c8ce
RD		 9399
9400 def GetCapture(*args, **kwargs):
15afbcd0 9401 """
66c033b4 9402 GetCapture() -> Window
15afbcd0
RD		 9403
9404 Returns the window which currently captures the mouse or None
9405 """
54f9ee45 9406 return _core_.Window_GetCapture(*args, **kwargs)
e811c8ce
RD		 9407
9408 GetCapture = staticmethod(GetCapture)
9409 def HasCapture(*args, **kwargs):
15afbcd0 9410 """
a95a7133 9411 HasCapture(self) -> bool
15afbcd0
RD		 9412
9413 Returns true if this window has the current mouse capture.
9414 """
54f9ee45 9415 return _core_.Window_HasCapture(*args, **kwargs)
e811c8ce
RD		 9416
9417 def Refresh(*args, **kwargs):
15afbcd0 9418 """
a95a7133 9419 Refresh(self, bool eraseBackground=True, Rect rect=None)
15afbcd0
RD		 9420
9421 Mark the specified rectangle (or the whole window) as "dirty" so it
9422 will be repainted. Causes an EVT_PAINT event to be generated and sent
9423 to the window.
9424 """
54f9ee45 9425 return _core_.Window_Refresh(*args, **kwargs)
e811c8ce
RD		 9426
9427 def RefreshRect(*args, **kwargs):
15afbcd0 9428 """
fef4c27a 9429 RefreshRect(self, Rect rect, bool eraseBackground=True)
15afbcd0
RD		 9430
9431 Redraws the contents of the given rectangle: the area inside it will
9432 be repainted. This is the same as Refresh but has a nicer syntax.
9433 """
54f9ee45 9434 return _core_.Window_RefreshRect(*args, **kwargs)
e811c8ce
RD		 9435
9436 def Update(*args, **kwargs):
15afbcd0 9437 """
a95a7133 9438 Update(self)
15afbcd0
RD		 9439
9440 Calling this method immediately repaints the invalidated area of the
9441 window instead of waiting for the EVT_PAINT event to happen, (normally
9442 this would usually only happen when the flow of control returns to the
9443 event loop.) Notice that this function doesn't refresh the window and
9b940138 9444 does nothing if the window has been already repainted. Use `Refresh`
15afbcd0
RD		 9445 first if you want to immediately redraw the window (or some portion of
9446 it) unconditionally.
9447 """
54f9ee45 9448 return _core_.Window_Update(*args, **kwargs)
e811c8ce
RD		 9449
9450 def ClearBackground(*args, **kwargs):
15afbcd0 9451 """
a95a7133 9452 ClearBackground(self)
15afbcd0
RD		 9453
9454 Clears the window by filling it with the current background
9455 colour. Does not cause an erase background event to be generated.
9456 """
54f9ee45 9457 return _core_.Window_ClearBackground(*args, **kwargs)
e811c8ce
RD		 9458
9459 def Freeze(*args, **kwargs):
15afbcd0 9460 """
a95a7133 9461 Freeze(self)
15afbcd0 9462
41e2b43e
RD		 9463 Freezes the window or, in other words, prevents any updates from
9464 taking place on screen, the window is not redrawn at all. Thaw must be
9465 called to reenable window redrawing. Calls to Freeze/Thaw may be
9466 nested, with the actual Thaw being delayed until all the nesting has
9467 been undone.
15afbcd0
RD		 9468
9469 This method is useful for visual appearance optimization (for example,
9470 it is a good idea to use it before inserting large amount of text into
9471 a wxTextCtrl under wxGTK) but is not implemented on all platforms nor
9472 for all controls so it is mostly just a hint to wxWindows and not a
9473 mandatory directive.
9474 """
54f9ee45 9475 return _core_.Window_Freeze(*args, **kwargs)
e811c8ce 9476
33d6fd3b
RD		 9477 def IsFrozen(*args, **kwargs):
9478 """
9479 IsFrozen(self) -> bool
9480
9481 Returns ``True`` if the window has been frozen and not thawed yet.
9482
9483 :see: `Freeze` and `Thaw`
9484 """
9485 return _core_.Window_IsFrozen(*args, **kwargs)
9486
e811c8ce 9487 def Thaw(*args, **kwargs):
15afbcd0 9488 """
a95a7133 9489 Thaw(self)
15afbcd0 9490
4276dc52 9491 Reenables window updating after a previous call to Freeze. Calls to
41e2b43e
RD		 9492 Freeze/Thaw may be nested, so Thaw must be called the same number of
9493 times that Freeze was before the window will be updated.
15afbcd0 9494 """
54f9ee45 9495 return _core_.Window_Thaw(*args, **kwargs)
e811c8ce
RD		 9496
9497 def PrepareDC(*args, **kwargs):
15afbcd0 9498 """
a95a7133 9499 PrepareDC(self, DC dc)
15afbcd0
RD		 9500
9501 Call this function to prepare the device context for drawing a
9502 scrolled image. It sets the device origin according to the current
9503 scroll position.
9504 """
54f9ee45 9505 return _core_.Window_PrepareDC(*args, **kwargs)
e811c8ce 9506
b39fe951
RD		 9507 def IsDoubleBuffered(*args, **kwargs):
9508 """
9509 IsDoubleBuffered(self) -> bool
9510
9511 Returns ``True`` if the window contents is double-buffered by the
9512 system, i.e. if any drawing done on the window is really done on a
9513 temporary backing surface and transferred to the screen all at once
9514 later.
9515 """
9516 return _core_.Window_IsDoubleBuffered(*args, **kwargs)
9517
e811c8ce 9518 def GetUpdateRegion(*args, **kwargs):
15afbcd0 9519 """
a95a7133 9520 GetUpdateRegion(self) -> Region
15afbcd0
RD		 9521
9522 Returns the region specifying which parts of the window have been
9523 damaged. Should only be called within an EVT_PAINT handler.
9524 """
54f9ee45 9525 return _core_.Window_GetUpdateRegion(*args, **kwargs)
e811c8ce
RD		 9526
9527 def GetUpdateClientRect(*args, **kwargs):
15afbcd0 9528 """
a95a7133 9529 GetUpdateClientRect(self) -> Rect
15afbcd0
RD		 9530
9531 Get the update rectangle region bounding box in client coords.
9532 """
54f9ee45 9533 return _core_.Window_GetUpdateClientRect(*args, **kwargs)
e811c8ce
RD		 9534
9535 def IsExposed(*args, **kwargs):
15afbcd0 9536 """
a95a7133 9537 IsExposed(self, int x, int y, int w=1, int h=1) -> bool
15afbcd0
RD		 9538
9539 Returns true if the given point or rectangle area has been exposed
9540 since the last repaint. Call this in an paint event handler to
9541 optimize redrawing by only redrawing those areas, which have been
9542 exposed.
9543 """
54f9ee45 9544 return _core_.Window_IsExposed(*args, **kwargs)
e811c8ce
RD		 9545
9546 def IsExposedPoint(*args, **kwargs):
15afbcd0 9547 """
a95a7133 9548 IsExposedPoint(self, Point pt) -> bool
15afbcd0
RD		 9549
9550 Returns true if the given point or rectangle area has been exposed
9551 since the last repaint. Call this in an paint event handler to
9552 optimize redrawing by only redrawing those areas, which have been
9553 exposed.
9554 """
54f9ee45 9555 return _core_.Window_IsExposedPoint(*args, **kwargs)
e811c8ce 9556
4276dc52 9557 def IsExposedRect(*args, **kwargs):
15afbcd0 9558 """
a95a7133 9559 IsExposedRect(self, Rect rect) -> bool
15afbcd0
RD		 9560
9561 Returns true if the given point or rectangle area has been exposed
9562 since the last repaint. Call this in an paint event handler to
9563 optimize redrawing by only redrawing those areas, which have been
9564 exposed.
9565 """
54f9ee45 9566 return _core_.Window_IsExposedRect(*args, **kwargs)
e811c8ce 9567
74a57fcd
RD		 9568 def GetDefaultAttributes(*args, **kwargs):
9569 """
a95a7133 9570 GetDefaultAttributes(self) -> VisualAttributes
74a57fcd 9571
41e2b43e
RD		 9572 Get the default attributes for an instance of this class. This is
9573 useful if you want to use the same font or colour in your own control
9574 as in a standard control -- which is a much better idea than hard
9575 coding specific colours or fonts which might look completely out of
db3e571a 9576 place on the user's system, especially if it uses themes.
74a57fcd 9577 """
54f9ee45 9578 return _core_.Window_GetDefaultAttributes(*args, **kwargs)
74a57fcd
RD		 9579
9580 def GetClassDefaultAttributes(*args, **kwargs):
9581 """
66c033b4 9582 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
74a57fcd 9583
41e2b43e
RD		 9584 Get the default attributes for this class. This is useful if you want
9585 to use the same font or colour in your own control as in a standard
9586 control -- which is a much better idea than hard coding specific
db3e571a
RD		 9587 colours or fonts which might look completely out of place on the
9588 user's system, especially if it uses themes.
74a57fcd
RD		 9589
9590 The variant parameter is only relevant under Mac currently and is
41e2b43e 9591 ignore under other platforms. Under Mac, it will change the size of
db3e571a
RD		 9592 the returned font. See `wx.Window.SetWindowVariant` for more about
9593 this.
74a57fcd 9594 """
54f9ee45 9595 return _core_.Window_GetClassDefaultAttributes(*args, **kwargs)
74a57fcd
RD		 9596
9597 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
e811c8ce 9598 def SetBackgroundColour(*args, **kwargs):
15afbcd0 9599 """
a95a7133 9600 SetBackgroundColour(self, Colour colour) -> bool
15afbcd0
RD		 9601
9602 Sets the background colour of the window. Returns True if the colour
9603 was changed. The background colour is usually painted by the default
9604 EVT_ERASE_BACKGROUND event handler function under Windows and
f8167d6e
RD		 9605 automatically under GTK. Using `wx.NullColour` will reset the window
9606 to the default background colour.
15afbcd0 9607
db3e571a 9608 Note that setting the background colour may not cause an immediate
f8167d6e 9609 refresh, so you may wish to call `ClearBackground` or `Refresh` after
15afbcd0
RD		 9610 calling this function.
9611
f8167d6e
RD		 9612 Using this function will disable attempts to use themes for this
9613 window, if the system supports them. Use with care since usually the
9614 themes represent the appearance chosen by the user to be used for all
9615 applications on the system.
15afbcd0 9616 """
54f9ee45 9617 return _core_.Window_SetBackgroundColour(*args, **kwargs)
e811c8ce 9618
412d302d
RD		 9619 def SetOwnBackgroundColour(*args, **kwargs):
9620 """SetOwnBackgroundColour(self, Colour colour)"""
9621 return _core_.Window_SetOwnBackgroundColour(*args, **kwargs)
b2df227b 9622
e811c8ce 9623 def SetForegroundColour(*args, **kwargs):
15afbcd0 9624 """
a95a7133 9625 SetForegroundColour(self, Colour colour) -> bool
15afbcd0
RD		 9626
9627 Sets the foreground colour of the window. Returns True is the colour
9628 was changed. The interpretation of foreground colour is dependent on
9629 the window class; it may be the text colour or other colour, or it may
9630 not be used at all.
9631 """
54f9ee45 9632 return _core_.Window_SetForegroundColour(*args, **kwargs)
e811c8ce 9633
fa47d7a7
VS		 9634 def SetOwnForegroundColour(*args, **kwargs):
9635 """SetOwnForegroundColour(self, Colour colour)"""
9636 return _core_.Window_SetOwnForegroundColour(*args, **kwargs)
b2df227b 9637
e811c8ce 9638 def GetBackgroundColour(*args, **kwargs):
15afbcd0 9639 """
a95a7133 9640 GetBackgroundColour(self) -> Colour
15afbcd0
RD		 9641
9642 Returns the background colour of the window.
9643 """
54f9ee45 9644 return _core_.Window_GetBackgroundColour(*args, **kwargs)
e811c8ce
RD		 9645
9646 def GetForegroundColour(*args, **kwargs):
15afbcd0 9647 """
a95a7133 9648 GetForegroundColour(self) -> Colour
15afbcd0
RD		 9649
9650 Returns the foreground colour of the window. The interpretation of
9651 foreground colour is dependent on the window class; it may be the text
9652 colour or other colour, or it may not be used at all.
9653 """
54f9ee45 9654 return _core_.Window_GetForegroundColour(*args, **kwargs)
e811c8ce 9655
562ecc31
RD		 9656 def InheritsBackgroundColour(*args, **kwargs):
9657 """InheritsBackgroundColour(self) -> bool"""
9658 return _core_.Window_InheritsBackgroundColour(*args, **kwargs)
9659
9660 def UseBgCol(*args, **kwargs):
9661 """UseBgCol(self) -> bool"""
9662 return _core_.Window_UseBgCol(*args, **kwargs)
9663
7bc1e663
RD		 9664 def SetBackgroundStyle(*args, **kwargs):
9665 """
9666 SetBackgroundStyle(self, int style) -> bool
9667
9668 Returns the background style of the window. The background style
9669 indicates how the background of the window is drawn.
9670
9671 ====================== ========================================
9672 wx.BG_STYLE_SYSTEM The background colour or pattern should
9673 be determined by the system
9674 wx.BG_STYLE_COLOUR The background should be a solid colour
9675 wx.BG_STYLE_CUSTOM The background will be implemented by the
9676 application.
9677 ====================== ========================================
9678
9679 On GTK+, use of wx.BG_STYLE_CUSTOM allows the flicker-free drawing of
9680 a custom background, such as a tiled bitmap. Currently the style has
9681 no effect on other platforms.
9682
9683 :see: `GetBackgroundStyle`, `SetBackgroundColour`
9684 """
9685 return _core_.Window_SetBackgroundStyle(*args, **kwargs)
9686
9687 def GetBackgroundStyle(*args, **kwargs):
9688 """
9689 GetBackgroundStyle(self) -> int
9690
9691 Returns the background style of the window.
9692
9693 :see: `SetBackgroundStyle`
9694 """
9695 return _core_.Window_GetBackgroundStyle(*args, **kwargs)
9696
51b83b37
RD		 9697 def HasTransparentBackground(*args, **kwargs):
9698 """
9699 HasTransparentBackground(self) -> bool
9700
9701 Returns True if this window's background is transparent (as, for
9702 example, for `wx.StaticText`) and should show the parent window's
9703 background.
9704
9705 This method is mostly used internally by the library itself and you
9706 normally shouldn't have to call it. You may, however, have to override
9707 it in your custom control classes to ensure that background is painted
9708 correctly.
9709 """
9710 return _core_.Window_HasTransparentBackground(*args, **kwargs)
9711
e811c8ce 9712 def SetCursor(*args, **kwargs):
15afbcd0 9713 """
a95a7133 9714 SetCursor(self, Cursor cursor) -> bool
15afbcd0
RD		 9715
9716 Sets the window's cursor. Notice that the window cursor also sets it
9717 for the children of the window implicitly.
9718
9719 The cursor may be wx.NullCursor in which case the window cursor will
9720 be reset back to default.
9721 """
54f9ee45 9722 return _core_.Window_SetCursor(*args, **kwargs)
e811c8ce
RD		 9723
9724 def GetCursor(*args, **kwargs):
15afbcd0 9725 """
a95a7133 9726 GetCursor(self) -> Cursor
15afbcd0
RD		 9727
9728 Return the cursor associated with this window.
9729 """
54f9ee45 9730 return _core_.Window_GetCursor(*args, **kwargs)
e811c8ce
RD		 9731
9732 def SetFont(*args, **kwargs):
15afbcd0 9733 """
a95a7133 9734 SetFont(self, Font font) -> bool
15afbcd0
RD		 9735
9736 Sets the font for this window.
9737 """
54f9ee45 9738 return _core_.Window_SetFont(*args, **kwargs)
e811c8ce 9739
fa47d7a7
VS		 9740 def SetOwnFont(*args, **kwargs):
9741 """SetOwnFont(self, Font font)"""
9742 return _core_.Window_SetOwnFont(*args, **kwargs)
b2df227b 9743
e811c8ce 9744 def GetFont(*args, **kwargs):
15afbcd0 9745 """
a95a7133 9746 GetFont(self) -> Font
15afbcd0 9747
4276dc52 9748 Returns the default font used for this window.
15afbcd0 9749 """
54f9ee45 9750 return _core_.Window_GetFont(*args, **kwargs)
e811c8ce
RD		 9751
9752 def SetCaret(*args, **kwargs):
15afbcd0 9753 """
a95a7133 9754 SetCaret(self, Caret caret)
15afbcd0
RD		 9755
9756 Sets the caret associated with the window.
9757 """
54f9ee45 9758 return _core_.Window_SetCaret(*args, **kwargs)
e811c8ce
RD		 9759
9760 def GetCaret(*args, **kwargs):
15afbcd0 9761 """
a95a7133 9762 GetCaret(self) -> Caret
15afbcd0
RD		 9763
9764 Returns the caret associated with the window.
9765 """
54f9ee45 9766 return _core_.Window_GetCaret(*args, **kwargs)
e811c8ce
RD		 9767
9768 def GetCharHeight(*args, **kwargs):
15afbcd0 9769 """
a95a7133 9770 GetCharHeight(self) -> int
15afbcd0
RD		 9771
9772 Get the (average) character size for the current font.
9773 """
54f9ee45 9774 return _core_.Window_GetCharHeight(*args, **kwargs)
e811c8ce
RD		 9775
9776 def GetCharWidth(*args, **kwargs):
15afbcd0 9777 """
a95a7133 9778 GetCharWidth(self) -> int
15afbcd0
RD		 9779
9780 Get the (average) character size for the current font.
9781 """
54f9ee45 9782 return _core_.Window_GetCharWidth(*args, **kwargs)
e811c8ce
RD		 9783
9784 def GetTextExtent(*args, **kwargs):
fd2dc343
RD		 9785 """
9786 GetTextExtent(String string) -> (width, height)
9787
9788 Get the width and height of the text using the current font.
9789 """
54f9ee45 9790 return _core_.Window_GetTextExtent(*args, **kwargs)
e811c8ce
RD		 9791
9792 def GetFullTextExtent(*args, **kwargs):
0df68c9f 9793 """
196addbf 9794 GetFullTextExtent(String string, Font font=None) ->
0df68c9f 9795 (width, height, descent, externalLeading)
e811c8ce 9796
15afbcd0
RD		 9797 Get the width, height, decent and leading of the text using the
9798 current or specified font.
0df68c9f 9799 """
54f9ee45 9800 return _core_.Window_GetFullTextExtent(*args, **kwargs)
e811c8ce
RD		 9801
9802 def ClientToScreenXY(*args, **kwargs):
15afbcd0
RD		 9803 """
9804 ClientToScreenXY(int x, int y) -> (x,y)
9805
9806 Converts to screen coordinates from coordinates relative to this window.
9807 """
54f9ee45 9808 return _core_.Window_ClientToScreenXY(*args, **kwargs)
e811c8ce
RD		 9809
9810 def ScreenToClientXY(*args, **kwargs):
15afbcd0
RD		 9811 """
9812 ScreenToClientXY(int x, int y) -> (x,y)
9813
9814 Converts from screen to client window coordinates.
9815 """
54f9ee45 9816 return _core_.Window_ScreenToClientXY(*args, **kwargs)
e811c8ce
RD		 9817
9818 def ClientToScreen(*args, **kwargs):
15afbcd0 9819 """
a95a7133 9820 ClientToScreen(self, Point pt) -> Point
15afbcd0
RD		 9821
9822 Converts to screen coordinates from coordinates relative to this window.
9823 """
54f9ee45 9824 return _core_.Window_ClientToScreen(*args, **kwargs)
e811c8ce
RD		 9825
9826 def ScreenToClient(*args, **kwargs):
15afbcd0 9827 """
a95a7133 9828 ScreenToClient(self, Point pt) -> Point
15afbcd0
RD		 9829
9830 Converts from screen to client window coordinates.
9831 """
54f9ee45 9832 return _core_.Window_ScreenToClient(*args, **kwargs)
e811c8ce
RD		 9833
9834 def HitTestXY(*args, **kwargs):
15afbcd0 9835 """
a95a7133 9836 HitTestXY(self, int x, int y) -> int
15afbcd0
RD		 9837
9838 Test where the given (in client coords) point lies
9839 """
54f9ee45 9840 return _core_.Window_HitTestXY(*args, **kwargs)
e811c8ce
RD		 9841
9842 def HitTest(*args, **kwargs):
15afbcd0 9843 """
a95a7133 9844 HitTest(self, Point pt) -> int
15afbcd0
RD		 9845
9846 Test where the given (in client coords) point lies
9847 """
54f9ee45 9848 return _core_.Window_HitTest(*args, **kwargs)
e811c8ce 9849
15afbcd0
RD		 9850 def GetBorder(*args):
9851 """
a95a7133
RD		 9852 GetBorder(self, long flags) -> int
9853 GetBorder(self) -> int
e811c8ce 9854
15afbcd0
RD		 9855 Get border for the flags of this window
9856 """
54f9ee45 9857 return _core_.Window_GetBorder(*args)
e811c8ce
RD		 9858
9859 def UpdateWindowUI(*args, **kwargs):
15afbcd0 9860 """
a95a7133 9861 UpdateWindowUI(self, long flags=UPDATE_UI_NONE)
15afbcd0
RD		 9862
9863 This function sends EVT_UPDATE_UI events to the window. The particular
9864 implementation depends on the window; for example a wx.ToolBar will
9865 send an update UI event for each toolbar button, and a wx.Frame will
9866 send an update UI event for each menubar menu item. You can call this
9867 function from your application to ensure that your UI is up-to-date at
9868 a particular point in time (as far as your EVT_UPDATE_UI handlers are
9869 concerned). This may be necessary if you have called
5ba5649b 9870 `wx.UpdateUIEvent.SetMode` or `wx.UpdateUIEvent.SetUpdateInterval` to
15afbcd0
RD		 9871 limit the overhead that wxWindows incurs by sending update UI events
9872 in idle time.
15afbcd0 9873 """
54f9ee45 9874 return _core_.Window_UpdateWindowUI(*args, **kwargs)
e811c8ce
RD		 9875
9876 def PopupMenuXY(*args, **kwargs):
15afbcd0 9877 """
b0503257 9878 PopupMenuXY(self, Menu menu, int x=-1, int y=-1) -> bool
15afbcd0 9879
b0503257
RD		 9880 Pops up the given menu at the specified coordinates, relative to this window,
9881 and returns control when the user has dismissed the menu. If a menu item is
9882 selected, the corresponding menu event is generated and will be processed as
9883 usual. If the default position is given then the current position of the
9884 mouse cursor will be used.
15afbcd0 9885 """
54f9ee45 9886 return _core_.Window_PopupMenuXY(*args, **kwargs)
e811c8ce 9887
15afbcd0
RD		 9888 def PopupMenu(*args, **kwargs):
9889 """
b0503257 9890 PopupMenu(self, Menu menu, Point pos=DefaultPosition) -> bool
15afbcd0 9891
b0503257
RD		 9892 Pops up the given menu at the specified coordinates, relative to this window,
9893 and returns control when the user has dismissed the menu. If a menu item is
9894 selected, the corresponding menu event is generated and will be processed as
9895 usual. If the default position is given then the current position of the
9896 mouse cursor will be used.
15afbcd0 9897 """
54f9ee45 9898 return _core_.Window_PopupMenu(*args, **kwargs)
15afbcd0 9899
10044bf1
RD		 9900 def HasMultiplePages(*args, **kwargs):
9901 """HasMultiplePages(self) -> bool"""
9902 return _core_.Window_HasMultiplePages(*args, **kwargs)
9903
15afbcd0
RD		 9904 def GetHandle(*args, **kwargs):
9905 """
a95a7133 9906 GetHandle(self) -> long
15afbcd0
RD		 9907
9908 Returns the platform-specific handle (as a long integer) of the
9909 physical window. Currently on wxMac it returns the handle of the
9910 toplevel parent of the window.
9911 """
54f9ee45 9912 return _core_.Window_GetHandle(*args, **kwargs)
15afbcd0 9913
7e63a440
RD		 9914 def AssociateHandle(*args, **kwargs):
9915 """
9916 AssociateHandle(self, long handle)
9917
9918 Associate the window with a new native handle
9919 """
9920 return _core_.Window_AssociateHandle(*args, **kwargs)
9921
9922 def DissociateHandle(*args, **kwargs):
9923 """
9924 DissociateHandle(self)
9925
9926 Dissociate the current native handle from the window
9927 """
9928 return _core_.Window_DissociateHandle(*args, **kwargs)
9929
15afbcd0
RD		 9930 def HasScrollbar(*args, **kwargs):
9931 """
a95a7133 9932 HasScrollbar(self, int orient) -> bool
15afbcd0
RD		 9933
9934 Does the window have the scrollbar for this orientation?
9935 """
54f9ee45 9936 return _core_.Window_HasScrollbar(*args, **kwargs)
15afbcd0
RD		 9937
9938 def SetScrollbar(*args, **kwargs):
9939 """
41e2b43e 9940 SetScrollbar(self, int orientation, int position, int thumbSize, int range,
15afbcd0
RD		 9941 bool refresh=True)
9942
9943 Sets the scrollbar properties of a built-in scrollbar.
15afbcd0 9944 """
54f9ee45 9945 return _core_.Window_SetScrollbar(*args, **kwargs)
e811c8ce
RD		 9946
9947 def SetScrollPos(*args, **kwargs):
15afbcd0 9948 """
a95a7133 9949 SetScrollPos(self, int orientation, int pos, bool refresh=True)
15afbcd0
RD		 9950
9951 Sets the position of one of the built-in scrollbars.
9952 """
54f9ee45 9953 return _core_.Window_SetScrollPos(*args, **kwargs)
e811c8ce
RD		 9954
9955 def GetScrollPos(*args, **kwargs):
15afbcd0 9956 """
a95a7133 9957 GetScrollPos(self, int orientation) -> int
15afbcd0
RD		 9958
9959 Returns the built-in scrollbar position.
9960 """
54f9ee45 9961 return _core_.Window_GetScrollPos(*args, **kwargs)
e811c8ce
RD		 9962
9963 def GetScrollThumb(*args, **kwargs):
15afbcd0 9964 """
a95a7133 9965 GetScrollThumb(self, int orientation) -> int
15afbcd0
RD		 9966
9967 Returns the built-in scrollbar thumb size.
9968 """
54f9ee45 9969 return _core_.Window_GetScrollThumb(*args, **kwargs)
e811c8ce
RD		 9970
9971 def GetScrollRange(*args, **kwargs):
15afbcd0 9972 """
a95a7133 9973 GetScrollRange(self, int orientation) -> int
15afbcd0
RD		 9974
9975 Returns the built-in scrollbar range.
9976 """
54f9ee45 9977 return _core_.Window_GetScrollRange(*args, **kwargs)
e811c8ce
RD		 9978
9979 def ScrollWindow(*args, **kwargs):
15afbcd0 9980 """
a95a7133 9981 ScrollWindow(self, int dx, int dy, Rect rect=None)
15afbcd0
RD		 9982
9983 Physically scrolls the pixels in the window and move child windows
9984 accordingly. Use this function to optimise your scrolling
9985 implementations, to minimise the area that must be redrawn. Note that
9986 it is rarely required to call this function from a user program.
15afbcd0 9987 """
54f9ee45 9988 return _core_.Window_ScrollWindow(*args, **kwargs)
e811c8ce
RD		 9989
9990 def ScrollLines(*args, **kwargs):
15afbcd0 9991 """
a95a7133 9992 ScrollLines(self, int lines) -> bool
15afbcd0
RD		 9993
9994 If the platform and window class supports it, scrolls the window by
9995 the given number of lines down, if lines is positive, or up if lines
9996 is negative. Returns True if the window was scrolled, False if it was
9997 already on top/bottom and nothing was done.
9998 """
54f9ee45 9999 return _core_.Window_ScrollLines(*args, **kwargs)
e811c8ce
RD		 10000
10001 def ScrollPages(*args, **kwargs):
15afbcd0 10002 """
a95a7133 10003 ScrollPages(self, int pages) -> bool
15afbcd0 10004
41e2b43e 10005 If the platform and window class supports it, scrolls the window by
15afbcd0
RD		 10006 the given number of pages down, if pages is positive, or up if pages
10007 is negative. Returns True if the window was scrolled, False if it was
10008 already on top/bottom and nothing was done.
10009 """
54f9ee45 10010 return _core_.Window_ScrollPages(*args, **kwargs)
e811c8ce
RD		 10011
10012 def LineUp(*args, **kwargs):
15afbcd0 10013 """
a95a7133 10014 LineUp(self) -> bool
15afbcd0
RD		 10015
10016 This is just a wrapper for ScrollLines(-1).
10017 """
54f9ee45 10018 return _core_.Window_LineUp(*args, **kwargs)
e811c8ce
RD		 10019
10020 def LineDown(*args, **kwargs):
15afbcd0 10021 """
a95a7133 10022 LineDown(self) -> bool
15afbcd0
RD		 10023
10024 This is just a wrapper for ScrollLines(1).
10025 """
54f9ee45 10026 return _core_.Window_LineDown(*args, **kwargs)
e811c8ce
RD		 10027
10028 def PageUp(*args, **kwargs):
15afbcd0 10029 """
a95a7133 10030 PageUp(self) -> bool
15afbcd0
RD		 10031
10032 This is just a wrapper for ScrollPages(-1).
10033 """
54f9ee45 10034 return _core_.Window_PageUp(*args, **kwargs)
e811c8ce
RD		 10035
10036 def PageDown(*args, **kwargs):
15afbcd0 10037 """
a95a7133 10038 PageDown(self) -> bool
15afbcd0
RD		 10039
10040 This is just a wrapper for ScrollPages(1).
10041 """
54f9ee45 10042 return _core_.Window_PageDown(*args, **kwargs)
e811c8ce
RD		 10043
10044 def SetHelpText(*args, **kwargs):
15afbcd0 10045 """
a95a7133 10046 SetHelpText(self, String text)
15afbcd0
RD		 10047
10048 Sets the help text to be used as context-sensitive help for this
10049 window. Note that the text is actually stored by the current
f52cbe90 10050 `wx.HelpProvider` implementation, and not in the window object itself.
15afbcd0 10051 """
54f9ee45 10052 return _core_.Window_SetHelpText(*args, **kwargs)
e811c8ce
RD		 10053
10054 def SetHelpTextForId(*args, **kwargs):
15afbcd0 10055 """
a95a7133 10056 SetHelpTextForId(self, String text)
15afbcd0
RD		 10057
10058 Associate this help text with all windows with the same id as this
10059 one.
10060 """
54f9ee45 10061 return _core_.Window_SetHelpTextForId(*args, **kwargs)
e811c8ce 10062
b850e7f3
RD		 10063 def GetHelpTextAtPoint(*args, **kwargs):
10064 """
10065 GetHelpTextAtPoint(self, Point pt, wxHelpEvent::Origin origin) -> String
10066
10067 Get the help string associated with the given position in this window.
10068
10069 Notice that pt may be invalid if event origin is keyboard or unknown
10070 and this method should return the global window help text then
10071
10072 """
10073 return _core_.Window_GetHelpTextAtPoint(*args, **kwargs)
10074
e811c8ce 10075 def GetHelpText(*args, **kwargs):
15afbcd0 10076 """
a95a7133 10077 GetHelpText(self) -> String
15afbcd0
RD		 10078
10079 Gets the help text to be used as context-sensitive help for this
10080 window. Note that the text is actually stored by the current
f52cbe90 10081 `wx.HelpProvider` implementation, and not in the window object itself.
15afbcd0 10082 """
54f9ee45 10083 return _core_.Window_GetHelpText(*args, **kwargs)
e811c8ce
RD		 10084
10085 def SetToolTipString(*args, **kwargs):
15afbcd0 10086 """
a95a7133 10087 SetToolTipString(self, String tip)
15afbcd0
RD		 10088
10089 Attach a tooltip to the window.
10090 """
54f9ee45 10091 return _core_.Window_SetToolTipString(*args, **kwargs)
e811c8ce
RD		 10092
10093 def SetToolTip(*args, **kwargs):
15afbcd0 10094 """
a95a7133 10095 SetToolTip(self, ToolTip tip)
15afbcd0
RD		 10096
10097 Attach a tooltip to the window.
10098 """
54f9ee45 10099 return _core_.Window_SetToolTip(*args, **kwargs)
e811c8ce
RD		 10100
10101 def GetToolTip(*args, **kwargs):
15afbcd0 10102 """
a95a7133 10103 GetToolTip(self) -> ToolTip
15afbcd0
RD		 10104
10105 get the associated tooltip or None if none
10106 """
54f9ee45 10107 return _core_.Window_GetToolTip(*args, **kwargs)
e811c8ce
RD		 10108
10109 def SetDropTarget(*args, **kwargs):
15afbcd0 10110 """
a95a7133 10111 SetDropTarget(self, DropTarget dropTarget)
15afbcd0
RD		 10112
10113 Associates a drop target with this window. If the window already has
10114 a drop target, it is deleted.
10115 """
54f9ee45 10116 return _core_.Window_SetDropTarget(*args, **kwargs)
e811c8ce
RD		 10117
10118 def GetDropTarget(*args, **kwargs):
15afbcd0 10119 """
a95a7133 10120 GetDropTarget(self) -> DropTarget
15afbcd0
RD		 10121
10122 Returns the associated drop target, which may be None.
10123 """
54f9ee45 10124 return _core_.Window_GetDropTarget(*args, **kwargs)
e811c8ce 10125
5ba5649b
RD		 10126 def DragAcceptFiles(*args, **kwargs):
10127 """
10128 DragAcceptFiles(self, bool accept)
10129
10130 Enables or disables eligibility for drop file events, EVT_DROP_FILES.
10131 Only functional on Windows.
10132 """
10133 return _core_.Window_DragAcceptFiles(*args, **kwargs)
10134
e811c8ce 10135 def SetConstraints(*args, **kwargs):
15afbcd0 10136 """
a95a7133 10137 SetConstraints(self, LayoutConstraints constraints)
15afbcd0
RD		 10138
10139 Sets the window to have the given layout constraints. If an existing
10140 layout constraints object is already owned by the window, it will be
10141 deleted. Pass None to disassociate and delete the window's current
10142 constraints.
10143
10144 You must call SetAutoLayout to tell a window to use the constraints
10145 automatically in its default EVT_SIZE handler; otherwise, you must
10146 handle EVT_SIZE yourself and call Layout() explicitly. When setting
10147 both a wx.LayoutConstraints and a wx.Sizer, only the sizer will have
10148 effect.
10149 """
54f9ee45 10150 return _core_.Window_SetConstraints(*args, **kwargs)
e811c8ce
RD		 10151
10152 def GetConstraints(*args, **kwargs):
15afbcd0 10153 """
a95a7133 10154 GetConstraints(self) -> LayoutConstraints
15afbcd0
RD		 10155
10156 Returns a pointer to the window's layout constraints, or None if there
10157 are none.
10158 """
54f9ee45 10159 return _core_.Window_GetConstraints(*args, **kwargs)
e811c8ce
RD		 10160
10161 def SetAutoLayout(*args, **kwargs):
15afbcd0 10162 """
a95a7133 10163 SetAutoLayout(self, bool autoLayout)
15afbcd0
RD		 10164
10165 Determines whether the Layout function will be called automatically
b1fcee84
RD		 10166 when the window is resized. lease note that this only happens for the
10167 windows usually used to contain children, namely `wx.Panel` and
10168 `wx.TopLevelWindow` (and the classes deriving from them).
10169
10170 This method is called implicitly by `SetSizer` but if you use
10171 `SetConstraints` you should call it manually or otherwise the window
10172 layout won't be correctly updated when its size changes.
15afbcd0 10173 """
54f9ee45 10174 return _core_.Window_SetAutoLayout(*args, **kwargs)
e811c8ce
RD		 10175
10176 def GetAutoLayout(*args, **kwargs):
15afbcd0 10177 """
a95a7133 10178 GetAutoLayout(self) -> bool
15afbcd0
RD		 10179
10180 Returns the current autoLayout setting
10181 """
54f9ee45 10182 return _core_.Window_GetAutoLayout(*args, **kwargs)
e811c8ce
RD		 10183
10184 def Layout(*args, **kwargs):
15afbcd0 10185 """
a95a7133 10186 Layout(self) -> bool
15afbcd0
RD		 10187
10188 Invokes the constraint-based layout algorithm or the sizer-based
10189 algorithm for this window. See SetAutoLayout: when auto layout is on,
10190 this function gets called automatically by the default EVT_SIZE
10191 handler when the window is resized.
10192 """
54f9ee45 10193 return _core_.Window_Layout(*args, **kwargs)
e811c8ce
RD		 10194
10195 def SetSizer(*args, **kwargs):
15afbcd0 10196 """
a95a7133 10197 SetSizer(self, Sizer sizer, bool deleteOld=True)
15afbcd0
RD		 10198
10199 Sets the window to have the given layout sizer. The window will then
10200 own the object, and will take care of its deletion. If an existing
10201 layout sizer object is already owned by the window, it will be deleted
10202 if the deleteOld parameter is true. Note that this function will also
10203 call SetAutoLayout implicitly with a True parameter if the sizer is
ae8162c8 10204 non-None, and False otherwise.
15afbcd0 10205 """
54f9ee45 10206 return _core_.Window_SetSizer(*args, **kwargs)
e811c8ce
RD		 10207
10208 def SetSizerAndFit(*args, **kwargs):
15afbcd0 10209 """
a95a7133 10210 SetSizerAndFit(self, Sizer sizer, bool deleteOld=True)
15afbcd0
RD		 10211
10212 The same as SetSizer, except it also sets the size hints for the
10213 window based on the sizer's minimum size.
10214 """
54f9ee45 10215 return _core_.Window_SetSizerAndFit(*args, **kwargs)
e811c8ce
RD		 10216
10217 def GetSizer(*args, **kwargs):
15afbcd0 10218 """
a95a7133 10219 GetSizer(self) -> Sizer
15afbcd0
RD		 10220
10221 Return the sizer associated with the window by a previous call to
10222 SetSizer or None if there isn't one.
10223 """
54f9ee45 10224 return _core_.Window_GetSizer(*args, **kwargs)
e811c8ce
RD		 10225
10226 def SetContainingSizer(*args, **kwargs):
15afbcd0 10227 """
a95a7133 10228 SetContainingSizer(self, Sizer sizer)
15afbcd0
RD		 10229
10230 This normally does not need to be called by application code. It is
10231 called internally when a window is added to a sizer, and is used so
10232 the window can remove itself from the sizer when it is destroyed.
10233 """
54f9ee45 10234 return _core_.Window_SetContainingSizer(*args, **kwargs)
e811c8ce
RD		 10235
10236 def GetContainingSizer(*args, **kwargs):
15afbcd0 10237 """
a95a7133 10238 GetContainingSizer(self) -> Sizer
15afbcd0
RD		 10239
10240 Return the sizer that this window is a member of, if any, otherwise None.
10241 """
54f9ee45 10242 return _core_.Window_GetContainingSizer(*args, **kwargs)
e811c8ce 10243
a95a7133
RD		 10244 def InheritAttributes(*args, **kwargs):
10245 """
10246 InheritAttributes(self)
10247
41e2b43e
RD		 10248 This function is (or should be, in case of custom controls) called
10249 during window creation to intelligently set up the window visual
10250 attributes, that is the font and the foreground and background
10251 colours.
10252
10253 By 'intelligently' the following is meant: by default, all windows use
10254 their own default attributes. However if some of the parent's
10255 attributes are explicitly changed (that is, using SetFont and not
fa47d7a7 10256 SetOwnFont) and if the corresponding attribute hadn't been
41e2b43e
RD		 10257 explicitly set for this window itself, then this window takes the same
10258 value as used by the parent. In addition, if the window overrides
10259 ShouldInheritColours to return false, the colours will not be changed
10260 no matter what and only the font might.
10261
34621cc5 10262 This rather complicated logic is necessary in order to accommodate the
ec9b55ca 10263 different usage scenarios. The most common one is when all default
41e2b43e
RD		 10264 attributes are used and in this case, nothing should be inherited as
10265 in modern GUIs different controls use different fonts (and colours)
10266 than their siblings so they can't inherit the same value from the
10267 parent. However it was also deemed desirable to allow to simply change
10268 the attributes of all children at once by just changing the font or
10269 colour of their common parent, hence in this case we do inherit the
10270 parents attributes.
10271
a95a7133 10272 """
54f9ee45 10273 return _core_.Window_InheritAttributes(*args, **kwargs)
a95a7133
RD		 10274
10275 def ShouldInheritColours(*args, **kwargs):
10276 """
10277 ShouldInheritColours(self) -> bool
10278
10279 Return true from here to allow the colours of this window to be
41e2b43e
RD		 10280 changed by InheritAttributes, returning false forbids inheriting them
10281 from the parent window.
a95a7133 10282
41e2b43e
RD		 10283 The base class version returns false, but this method is overridden in
10284 wxControl where it returns true.
a95a7133 10285 """
54f9ee45 10286 return _core_.Window_ShouldInheritColours(*args, **kwargs)
a95a7133 10287
fc46b7f3
RD		 10288 def CanSetTransparent(*args, **kwargs):
10289 """
10290 CanSetTransparent(self) -> bool
10291
10292 Returns ``True`` if the platform supports setting the transparency for
10293 this window. Note that this method will err on the side of caution,
10294 so it is possible that this will return ``False`` when it is in fact
10295 possible to set the transparency.
10296
10297 NOTE: On X-windows systems the X server must have the composite
10298 extension loaded, and there must be a composite manager program (such
10299 as xcompmgr) running.
10300 """
10301 return _core_.Window_CanSetTransparent(*args, **kwargs)
10302
10303 def SetTransparent(*args, **kwargs):
10304 """
10305 SetTransparent(self, byte alpha) -> bool
10306
10307 Attempt to set the transparency of this window to the ``alpha`` value,
10308 returns True on success. The ``alpha`` value is an integer in the
10309 range of 0 to 255, where 0 is fully transparent and 255 is fully
10310 opaque.
10311 """
10312 return _core_.Window_SetTransparent(*args, **kwargs)
10313
e811c8ce 10314 def PostCreate(self, pre):
15afbcd0
RD		 10315 """
10316 Phase 3 of the 2-phase create <wink!>
10317 Call this method after precreating the window with the 2-phase create method.
10318 """
e811c8ce
RD		 10319 self.this = pre.this
10320 self.thisown = pre.thisown
10321 pre.thisown = 0
10322 if hasattr(self, '_setOORInfo'):
10323 self._setOORInfo(self)
10324 if hasattr(self, '_setCallbackInfo'):
10325 self._setCallbackInfo(self, self.__class__)
10326
7e08d4ef 10327 def SendSizeEvent(self):
453fb36b 10328 self.GetEventHandler().ProcessEvent(wx.SizeEvent((-1,-1)))
7e08d4ef 10329
2bf58437
RD		 10330 AcceleratorTable = property(GetAcceleratorTable,SetAcceleratorTable,doc="See `GetAcceleratorTable` and `SetAcceleratorTable`")
10331 AdjustedBestSize = property(GetAdjustedBestSize,doc="See `GetAdjustedBestSize`")
10332 AutoLayout = property(GetAutoLayout,SetAutoLayout,doc="See `GetAutoLayout` and `SetAutoLayout`")
10333 BackgroundColour = property(GetBackgroundColour,SetBackgroundColour,doc="See `GetBackgroundColour` and `SetBackgroundColour`")
10334 BackgroundStyle = property(GetBackgroundStyle,SetBackgroundStyle,doc="See `GetBackgroundStyle` and `SetBackgroundStyle`")
10335 BestFittingSize = property(GetBestFittingSize,SetBestFittingSize,doc="See `GetBestFittingSize` and `SetBestFittingSize`")
10336 BestSize = property(GetBestSize,doc="See `GetBestSize`")
10337 BestVirtualSize = property(GetBestVirtualSize,doc="See `GetBestVirtualSize`")
10338 Border = property(GetBorder,doc="See `GetBorder`")
10339 Caret = property(GetCaret,SetCaret,doc="See `GetCaret` and `SetCaret`")
10340 CharHeight = property(GetCharHeight,doc="See `GetCharHeight`")
10341 CharWidth = property(GetCharWidth,doc="See `GetCharWidth`")
10342 Children = property(GetChildren,doc="See `GetChildren`")
10343 ClientAreaOrigin = property(GetClientAreaOrigin,doc="See `GetClientAreaOrigin`")
10344 ClientRect = property(GetClientRect,SetClientRect,doc="See `GetClientRect` and `SetClientRect`")
10345 ClientSize = property(GetClientSize,SetClientSize,doc="See `GetClientSize` and `SetClientSize`")
10346 Constraints = property(GetConstraints,SetConstraints,doc="See `GetConstraints` and `SetConstraints`")
10347 ContainingSizer = property(GetContainingSizer,SetContainingSizer,doc="See `GetContainingSizer` and `SetContainingSizer`")
10348 Cursor = property(GetCursor,SetCursor,doc="See `GetCursor` and `SetCursor`")
10349 DefaultAttributes = property(GetDefaultAttributes,doc="See `GetDefaultAttributes`")
10350 DropTarget = property(GetDropTarget,SetDropTarget,doc="See `GetDropTarget` and `SetDropTarget`")
10351 EventHandler = property(GetEventHandler,SetEventHandler,doc="See `GetEventHandler` and `SetEventHandler`")
10352 ExtraStyle = property(GetExtraStyle,SetExtraStyle,doc="See `GetExtraStyle` and `SetExtraStyle`")
10353 Font = property(GetFont,SetFont,doc="See `GetFont` and `SetFont`")
10354 ForegroundColour = property(GetForegroundColour,SetForegroundColour,doc="See `GetForegroundColour` and `SetForegroundColour`")
2bf58437
RD		 10355 GrandParent = property(GetGrandParent,doc="See `GetGrandParent`")
10356 Handle = property(GetHandle,doc="See `GetHandle`")
10357 HelpText = property(GetHelpText,SetHelpText,doc="See `GetHelpText` and `SetHelpText`")
2bf58437
RD		 10358 Id = property(GetId,SetId,doc="See `GetId` and `SetId`")
10359 Label = property(GetLabel,SetLabel,doc="See `GetLabel` and `SetLabel`")
994453b8 10360 LayoutDirection = property(GetLayoutDirection,SetLayoutDirection,doc="See `GetLayoutDirection` and `SetLayoutDirection`")
2bf58437
RD		 10361 MaxHeight = property(GetMaxHeight,doc="See `GetMaxHeight`")
10362 MaxSize = property(GetMaxSize,SetMaxSize,doc="See `GetMaxSize` and `SetMaxSize`")
10363 MaxWidth = property(GetMaxWidth,doc="See `GetMaxWidth`")
10364 MinHeight = property(GetMinHeight,doc="See `GetMinHeight`")
10365 MinSize = property(GetMinSize,SetMinSize,doc="See `GetMinSize` and `SetMinSize`")
10366 MinWidth = property(GetMinWidth,doc="See `GetMinWidth`")
10367 Name = property(GetName,SetName,doc="See `GetName` and `SetName`")
10368 Parent = property(GetParent,doc="See `GetParent`")
10369 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
10370 Rect = property(GetRect,SetRect,doc="See `GetRect` and `SetRect`")
10371 ScreenPosition = property(GetScreenPosition,doc="See `GetScreenPosition`")
10372 ScreenRect = property(GetScreenRect,doc="See `GetScreenRect`")
2bf58437
RD		 10373 Size = property(GetSize,SetSize,doc="See `GetSize` and `SetSize`")
10374 Sizer = property(GetSizer,SetSizer,doc="See `GetSizer` and `SetSizer`")
2bf58437
RD		 10375 ThemeEnabled = property(GetThemeEnabled,SetThemeEnabled,doc="See `GetThemeEnabled` and `SetThemeEnabled`")
10376 ToolTip = property(GetToolTip,SetToolTip,doc="See `GetToolTip` and `SetToolTip`")
10377 UpdateClientRect = property(GetUpdateClientRect,doc="See `GetUpdateClientRect`")
10378 UpdateRegion = property(GetUpdateRegion,doc="See `GetUpdateRegion`")
10379 Validator = property(GetValidator,SetValidator,doc="See `GetValidator` and `SetValidator`")
10380 VirtualSize = property(GetVirtualSize,SetVirtualSize,doc="See `GetVirtualSize` and `SetVirtualSize`")
10381 WindowStyle = property(GetWindowStyle,SetWindowStyle,doc="See `GetWindowStyle` and `SetWindowStyle`")
10382 WindowStyleFlag = property(GetWindowStyleFlag,SetWindowStyleFlag,doc="See `GetWindowStyleFlag` and `SetWindowStyleFlag`")
10383 WindowVariant = property(GetWindowVariant,SetWindowVariant,doc="See `GetWindowVariant` and `SetWindowVariant`")
97ab0f6a
RD		 10384 Shown = property(IsShown,Show,doc="See `IsShown` and `Show`")
10385 Enabled = property(IsEnabled,Enable,doc="See `IsEnabled` and `Enable`")
10386 TopLevel = property(IsTopLevel,doc="See `IsTopLevel`")
2131d850 10387_core_.Window_swigregister(Window)
e811c8ce
RD		 10388
10389def PreWindow(*args, **kwargs):
15afbcd0
RD		 10390 """
10391 PreWindow() -> Window
10392
10393 Precreate a Window for 2-phase creation.
10394 """
54f9ee45 10395 val = _core_.new_PreWindow(*args, **kwargs)
e811c8ce
RD		 10396 return val
10397
0085ce49
RD		 10398def Window_NewControlId(*args):
10399 """
15afbcd0
RD		 10400 Window_NewControlId() -> int
10401
10402 Generate a control id for the controls which were not given one.
10403 """
0085ce49 10404 return _core_.Window_NewControlId(*args)
e811c8ce
RD		 10405
10406def Window_NextControlId(*args, **kwargs):
0085ce49 10407 """
15afbcd0
RD		 10408 Window_NextControlId(int winid) -> int
10409
10410 Get the id of the control following the one with the given
41e2b43e 10411 autogenerated) id
15afbcd0 10412 """
0085ce49 10413 return _core_.Window_NextControlId(*args, **kwargs)
e811c8ce
RD		 10414
10415def Window_PrevControlId(*args, **kwargs):
0085ce49 10416 """
15afbcd0
RD		 10417 Window_PrevControlId(int winid) -> int
10418
10419 Get the id of the control preceding the one with the given
41e2b43e 10420 autogenerated) id
15afbcd0 10421 """
0085ce49 10422 return _core_.Window_PrevControlId(*args, **kwargs)
e811c8ce 10423
0085ce49
RD		 10424def Window_FindFocus(*args):
10425 """
15afbcd0
RD		 10426 Window_FindFocus() -> Window
10427
10428 Returns the window or control that currently has the keyboard focus,
10429 or None.
10430 """
0085ce49 10431 return _core_.Window_FindFocus(*args)
e811c8ce 10432
0085ce49
RD		 10433def Window_GetCapture(*args):
10434 """
15afbcd0
RD		 10435 Window_GetCapture() -> Window
10436
10437 Returns the window which currently captures the mouse or None
10438 """
0085ce49 10439 return _core_.Window_GetCapture(*args)
e811c8ce 10440
74a57fcd 10441def Window_GetClassDefaultAttributes(*args, **kwargs):
0085ce49 10442 """
74a57fcd
RD		 10443 Window_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
10444
41e2b43e
RD		 10445 Get the default attributes for this class. This is useful if you want
10446 to use the same font or colour in your own control as in a standard
10447 control -- which is a much better idea than hard coding specific
db3e571a
RD		 10448 colours or fonts which might look completely out of place on the
10449 user's system, especially if it uses themes.
74a57fcd
RD		 10450
10451 The variant parameter is only relevant under Mac currently and is
41e2b43e 10452 ignore under other platforms. Under Mac, it will change the size of
db3e571a
RD		 10453 the returned font. See `wx.Window.SetWindowVariant` for more about
10454 this.
74a57fcd 10455 """
0085ce49 10456 return _core_.Window_GetClassDefaultAttributes(*args, **kwargs)
74a57fcd 10457
e811c8ce 10458def DLG_PNT(win, point_or_x, y=None):
15afbcd0
RD		 10459 """
10460 Convenience function for converting a Point or (x,y) in
10461 dialog units to pixel units.
10462 """
e811c8ce
RD		 10463 if y is None:
10464 return win.ConvertDialogPointToPixels(point_or_x)
10465 else:
fd3f2efe 10466 return win.ConvertDialogPointToPixels(wx.Point(point_or_x, y))
e811c8ce
RD		 10467
10468def DLG_SZE(win, size_width, height=None):
15afbcd0
RD		 10469 """
10470 Convenience function for converting a Size or (w,h) in
10471 dialog units to pixel units.
10472 """
e811c8ce
RD		 10473 if height is None:
10474 return win.ConvertDialogSizeToPixels(size_width)
10475 else:
fd3f2efe 10476 return win.ConvertDialogSizeToPixels(wx.Size(size_width, height))
e811c8ce
RD		 10477
10478
10479def FindWindowById(*args, **kwargs):
0085ce49 10480 """
15afbcd0
RD		 10481 FindWindowById(long id, Window parent=None) -> Window
10482
10483 Find the first window in the application with the given id. If parent
10484 is None, the search will start from all top-level frames and dialog
10485 boxes; if non-None, the search will be limited to the given window
10486 hierarchy. The search is recursive in both cases.
10487 """
0085ce49 10488 return _core_.FindWindowById(*args, **kwargs)
e811c8ce
RD		 10489
10490def FindWindowByName(*args, **kwargs):
0085ce49 10491 """
15afbcd0
RD		 10492 FindWindowByName(String name, Window parent=None) -> Window
10493
10494 Find a window by its name (as given in a window constructor or Create
10495 function call). If parent is None, the search will start from all
10496 top-level frames and dialog boxes; if non-None, the search will be
10497 limited to the given window hierarchy. The search is recursive in both
10498 cases.
10499
10500 If no window with such name is found, wx.FindWindowByLabel is called.
10501 """
0085ce49 10502 return _core_.FindWindowByName(*args, **kwargs)
e811c8ce
RD		 10503
10504def FindWindowByLabel(*args, **kwargs):
0085ce49 10505 """
15afbcd0
RD		 10506 FindWindowByLabel(String label, Window parent=None) -> Window
10507
10508 Find a window by its label. Depending on the type of window, the label
10509 may be a window title or panel item label. If parent is None, the
10510 search will start from all top-level frames and dialog boxes; if
10511 non-None, the search will be limited to the given window
10512 hierarchy. The search is recursive in both cases.
10513 """
0085ce49 10514 return _core_.FindWindowByLabel(*args, **kwargs)
e811c8ce
RD		 10515
10516def Window_FromHWND(*args, **kwargs):
0085ce49
RD		 10517 """Window_FromHWND(Window parent, unsigned long _hWnd) -> Window"""
10518 return _core_.Window_FromHWND(*args, **kwargs)
b6b0383e 10519
0085ce49
RD		 10520def GetTopLevelWindows(*args):
10521 """
b6b0383e
RD		 10522 GetTopLevelWindows() -> PyObject
10523
10524 Returns a list of the the application's top-level windows, (frames,
10525 dialogs, etc.) NOTE: Currently this is a copy of the list maintained
10526 by wxWidgets, and so it is only valid as long as no top-level windows
10527 are closed or new top-level windows are created.
10528
10529 """
0085ce49 10530 return _core_.GetTopLevelWindows(*args)
e811c8ce
RD		 10531#---------------------------------------------------------------------------
10532
10533class Validator(EvtHandler):
093d3ff1 10534 """Proxy of C++ Validator class"""
0085ce49
RD		 10535 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10536 __repr__ = _swig_repr
10537 def __init__(self, *args, **kwargs):
a95a7133 10538 """__init__(self) -> Validator"""
0085ce49 10539 _core_.Validator_swiginit(self,_core_.new_Validator(*args, **kwargs))
d14a1e28 10540 self._setOORInfo(self)
e811c8ce
RD		 10541
10542 def Clone(*args, **kwargs):
a95a7133 10543 """Clone(self) -> Validator"""
54f9ee45 10544 return _core_.Validator_Clone(*args, **kwargs)
e811c8ce
RD		 10545
10546 def Validate(*args, **kwargs):
a95a7133 10547 """Validate(self, Window parent) -> bool"""
54f9ee45 10548 return _core_.Validator_Validate(*args, **kwargs)
e811c8ce
RD		 10549
10550 def TransferToWindow(*args, **kwargs):
a95a7133 10551 """TransferToWindow(self) -> bool"""
54f9ee45 10552 return _core_.Validator_TransferToWindow(*args, **kwargs)
e811c8ce
RD		 10553
10554 def TransferFromWindow(*args, **kwargs):
a95a7133 10555 """TransferFromWindow(self) -> bool"""
54f9ee45 10556 return _core_.Validator_TransferFromWindow(*args, **kwargs)
e811c8ce
RD		 10557
10558 def GetWindow(*args, **kwargs):
a95a7133 10559 """GetWindow(self) -> Window"""
54f9ee45 10560 return _core_.Validator_GetWindow(*args, **kwargs)
e811c8ce
RD		 10561
10562 def SetWindow(*args, **kwargs):
a95a7133 10563 """SetWindow(self, Window window)"""
54f9ee45 10564 return _core_.Validator_SetWindow(*args, **kwargs)
e811c8ce
RD		 10565
10566 def IsSilent(*args, **kwargs):
66c033b4 10567 """IsSilent() -> bool"""
54f9ee45 10568 return _core_.Validator_IsSilent(*args, **kwargs)
e811c8ce
RD		 10569
10570 IsSilent = staticmethod(IsSilent)
10571 def SetBellOnError(*args, **kwargs):
66c033b4 10572 """SetBellOnError(int doIt=True)"""
54f9ee45 10573 return _core_.Validator_SetBellOnError(*args, **kwargs)
e811c8ce
RD		 10574
10575 SetBellOnError = staticmethod(SetBellOnError)
dba7934c 10576 Window = property(GetWindow,SetWindow,doc="See `GetWindow` and `SetWindow`")
2131d850 10577_core_.Validator_swigregister(Validator)
e811c8ce 10578
0085ce49
RD		 10579def Validator_IsSilent(*args):
10580 """Validator_IsSilent() -> bool"""
10581 return _core_.Validator_IsSilent(*args)
e811c8ce
RD		 10582
10583def Validator_SetBellOnError(*args, **kwargs):
0085ce49
RD		 10584 """Validator_SetBellOnError(int doIt=True)"""
10585 return _core_.Validator_SetBellOnError(*args, **kwargs)
e811c8ce
RD		 10586
10587class PyValidator(Validator):
093d3ff1 10588 """Proxy of C++ PyValidator class"""
0085ce49
RD		 10589 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10590 __repr__ = _swig_repr
10591 def __init__(self, *args, **kwargs):
a95a7133 10592 """__init__(self) -> PyValidator"""
0085ce49 10593 _core_.PyValidator_swiginit(self,_core_.new_PyValidator(*args, **kwargs))
e811c8ce
RD		 10594
10595 self._setCallbackInfo(self, PyValidator, 1)
10596 self._setOORInfo(self)
10597
10598 def _setCallbackInfo(*args, **kwargs):
a95a7133 10599 """_setCallbackInfo(self, PyObject self, PyObject _class, int incref=True)"""
54f9ee45 10600 return _core_.PyValidator__setCallbackInfo(*args, **kwargs)
e811c8ce 10601
2131d850 10602_core_.PyValidator_swigregister(PyValidator)
e811c8ce
RD		 10603
10604#---------------------------------------------------------------------------
10605
10606class Menu(EvtHandler):
093d3ff1 10607 """Proxy of C++ Menu class"""
0085ce49
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):
a95a7133 10611 """__init__(self, String title=EmptyString, long style=0) -> Menu"""
0085ce49 10612 _core_.Menu_swiginit(self,_core_.new_Menu(*args, **kwargs))
e811c8ce
RD		 10613 self._setOORInfo(self)
10614
10615 def Append(*args, **kwargs):
97ab0f6a
RD		 10616 """
10617 Append(self, int id, String text=EmptyString, String help=EmptyString,
10618 int kind=ITEM_NORMAL) -> MenuItem
10619 """
54f9ee45 10620 return _core_.Menu_Append(*args, **kwargs)
e811c8ce
RD		 10621
10622 def AppendSeparator(*args, **kwargs):
a95a7133 10623 """AppendSeparator(self) -> MenuItem"""
54f9ee45 10624 return _core_.Menu_AppendSeparator(*args, **kwargs)
e811c8ce
RD		 10625
10626 def AppendCheckItem(*args, **kwargs):
a95a7133 10627 """AppendCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
54f9ee45 10628 return _core_.Menu_AppendCheckItem(*args, **kwargs)
e811c8ce
RD		 10629
10630 def AppendRadioItem(*args, **kwargs):
a95a7133 10631 """AppendRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
54f9ee45 10632 return _core_.Menu_AppendRadioItem(*args, **kwargs)
e811c8ce
RD		 10633
10634 def AppendMenu(*args, **kwargs):
a95a7133 10635 """AppendMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
54f9ee45 10636 return _core_.Menu_AppendMenu(*args, **kwargs)
e811c8ce 10637
50efceee
RD		 10638 def AppendSubMenu(*args, **kwargs):
10639 """AppendSubMenu(self, Menu submenu, String text, String help=EmptyString) -> MenuItem"""
10640 return _core_.Menu_AppendSubMenu(*args, **kwargs)
10641
e811c8ce 10642 def AppendItem(*args, **kwargs):
a95a7133 10643 """AppendItem(self, MenuItem item) -> MenuItem"""
54f9ee45 10644 return _core_.Menu_AppendItem(*args, **kwargs)
e811c8ce 10645
e811c8ce 10646 def InsertItem(*args, **kwargs):
a95a7133 10647 """InsertItem(self, size_t pos, MenuItem item) -> MenuItem"""
54f9ee45 10648 return _core_.Menu_InsertItem(*args, **kwargs)
e811c8ce 10649
0085ce49
RD		 10650 def PrependItem(*args, **kwargs):
10651 """PrependItem(self, MenuItem item) -> MenuItem"""
10652 return _core_.Menu_PrependItem(*args, **kwargs)
10653
10654 def Break(*args, **kwargs):
10655 """Break(self)"""
10656 return _core_.Menu_Break(*args, **kwargs)
10657
e811c8ce 10658 def Insert(*args, **kwargs):
0df68c9f 10659 """
97ab0f6a 10660 Insert(self, size_t pos, int id, String text=EmptyString, String help=EmptyString,
a41e16b6 10661 int kind=ITEM_NORMAL) -> MenuItem
0df68c9f 10662 """
54f9ee45 10663 return _core_.Menu_Insert(*args, **kwargs)
e811c8ce
RD		 10664
10665 def InsertSeparator(*args, **kwargs):
a95a7133 10666 """InsertSeparator(self, size_t pos) -> MenuItem"""
54f9ee45 10667 return _core_.Menu_InsertSeparator(*args, **kwargs)
e811c8ce
RD		 10668
10669 def InsertCheckItem(*args, **kwargs):
a95a7133 10670 """InsertCheckItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
54f9ee45 10671 return _core_.Menu_InsertCheckItem(*args, **kwargs)
e811c8ce
RD		 10672
10673 def InsertRadioItem(*args, **kwargs):
a95a7133 10674 """InsertRadioItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
54f9ee45 10675 return _core_.Menu_InsertRadioItem(*args, **kwargs)
e811c8ce
RD		 10676
10677 def InsertMenu(*args, **kwargs):
a95a7133 10678 """InsertMenu(self, size_t pos, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
54f9ee45 10679 return _core_.Menu_InsertMenu(*args, **kwargs)
e811c8ce 10680
e811c8ce 10681 def Prepend(*args, **kwargs):
97ab0f6a
RD		 10682 """
10683 Prepend(self, int id, String text=EmptyString, String help=EmptyString,
10684 int kind=ITEM_NORMAL) -> MenuItem
10685 """
54f9ee45 10686 return _core_.Menu_Prepend(*args, **kwargs)
e811c8ce
RD		 10687
10688 def PrependSeparator(*args, **kwargs):
a95a7133 10689 """PrependSeparator(self) -> MenuItem"""
54f9ee45 10690 return _core_.Menu_PrependSeparator(*args, **kwargs)
e811c8ce
RD		 10691
10692 def PrependCheckItem(*args, **kwargs):
a95a7133 10693 """PrependCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
54f9ee45 10694 return _core_.Menu_PrependCheckItem(*args, **kwargs)
e811c8ce
RD		 10695
10696 def PrependRadioItem(*args, **kwargs):
a95a7133 10697 """PrependRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
54f9ee45 10698 return _core_.Menu_PrependRadioItem(*args, **kwargs)
e811c8ce
RD		 10699
10700 def PrependMenu(*args, **kwargs):
a95a7133 10701 """PrependMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
54f9ee45 10702 return _core_.Menu_PrependMenu(*args, **kwargs)
e811c8ce
RD		 10703
10704 def Remove(*args, **kwargs):
a95a7133 10705 """Remove(self, int id) -> MenuItem"""
54f9ee45 10706 return _core_.Menu_Remove(*args, **kwargs)
e811c8ce
RD		 10707
10708 def RemoveItem(*args, **kwargs):
a95a7133 10709 """RemoveItem(self, MenuItem item) -> MenuItem"""
54f9ee45 10710 return _core_.Menu_RemoveItem(*args, **kwargs)
e811c8ce
RD		 10711
10712 def Delete(*args, **kwargs):
a95a7133 10713 """Delete(self, int id) -> bool"""
54f9ee45 10714 return _core_.Menu_Delete(*args, **kwargs)
e811c8ce
RD		 10715
10716 def DeleteItem(*args, **kwargs):
a95a7133 10717 """DeleteItem(self, MenuItem item) -> bool"""
54f9ee45 10718 return _core_.Menu_DeleteItem(*args, **kwargs)
e811c8ce
RD		 10719
10720 def Destroy(*args, **kwargs):
0df68c9f 10721 """
a95a7133 10722 Destroy(self)
e811c8ce 10723
0df68c9f
RD		 10724 Deletes the C++ object this Python object is a proxy for.
10725 """
b39fe951
RD		 10726 args[0].this.own(False)
10727 return _core_.Menu_Destroy(*args, **kwargs)
e811c8ce
RD		 10728
10729 def DestroyId(*args, **kwargs):
b39fe951
RD		 10730 """DestroyId(self, int id) -> bool"""
10731 return _core_.Menu_DestroyId(*args, **kwargs)
e811c8ce
RD		 10732
10733 def DestroyItem(*args, **kwargs):
b39fe951
RD		 10734 """DestroyItem(self, MenuItem item) -> bool"""
10735 return _core_.Menu_DestroyItem(*args, **kwargs)
e811c8ce
RD		 10736
10737 def GetMenuItemCount(*args, **kwargs):
a95a7133 10738 """GetMenuItemCount(self) -> size_t"""
54f9ee45 10739 return _core_.Menu_GetMenuItemCount(*args, **kwargs)
e811c8ce
RD		 10740
10741 def GetMenuItems(*args, **kwargs):
a95a7133 10742 """GetMenuItems(self) -> PyObject"""
54f9ee45 10743 return _core_.Menu_GetMenuItems(*args, **kwargs)
e811c8ce
RD		 10744
10745 def FindItem(*args, **kwargs):
a95a7133 10746 """FindItem(self, String item) -> int"""
54f9ee45 10747 return _core_.Menu_FindItem(*args, **kwargs)
e811c8ce
RD		 10748
10749 def FindItemById(*args, **kwargs):
a95a7133 10750 """FindItemById(self, int id) -> MenuItem"""
54f9ee45 10751 return _core_.Menu_FindItemById(*args, **kwargs)
e811c8ce
RD		 10752
10753 def FindItemByPosition(*args, **kwargs):
a95a7133 10754 """FindItemByPosition(self, size_t position) -> MenuItem"""
54f9ee45 10755 return _core_.Menu_FindItemByPosition(*args, **kwargs)
e811c8ce
RD		 10756
10757 def Enable(*args, **kwargs):
a95a7133 10758 """Enable(self, int id, bool enable)"""
54f9ee45 10759 return _core_.Menu_Enable(*args, **kwargs)
e811c8ce
RD		 10760
10761 def IsEnabled(*args, **kwargs):
a95a7133 10762 """IsEnabled(self, int id) -> bool"""
54f9ee45 10763 return _core_.Menu_IsEnabled(*args, **kwargs)
e811c8ce
RD		 10764
10765 def Check(*args, **kwargs):
a95a7133 10766 """Check(self, int id, bool check)"""
54f9ee45 10767 return _core_.Menu_Check(*args, **kwargs)
e811c8ce
RD		 10768
10769 def IsChecked(*args, **kwargs):
a95a7133 10770 """IsChecked(self, int id) -> bool"""
54f9ee45 10771 return _core_.Menu_IsChecked(*args, **kwargs)
e811c8ce
RD		 10772
10773 def SetLabel(*args, **kwargs):
a95a7133 10774 """SetLabel(self, int id, String label)"""
54f9ee45 10775 return _core_.Menu_SetLabel(*args, **kwargs)
e811c8ce
RD		 10776
10777 def GetLabel(*args, **kwargs):
a95a7133 10778 """GetLabel(self, int id) -> String"""
54f9ee45 10779 return _core_.Menu_GetLabel(*args, **kwargs)
e811c8ce
RD		 10780
10781 def SetHelpString(*args, **kwargs):
a95a7133 10782 """SetHelpString(self, int id, String helpString)"""
54f9ee45 10783 return _core_.Menu_SetHelpString(*args, **kwargs)
e811c8ce
RD		 10784
10785 def GetHelpString(*args, **kwargs):
a95a7133 10786 """GetHelpString(self, int id) -> String"""
54f9ee45 10787 return _core_.Menu_GetHelpString(*args, **kwargs)
e811c8ce
RD		 10788
10789 def SetTitle(*args, **kwargs):
a95a7133 10790 """SetTitle(self, String title)"""
54f9ee45 10791 return _core_.Menu_SetTitle(*args, **kwargs)
e811c8ce
RD		 10792
10793 def GetTitle(*args, **kwargs):
a95a7133 10794 """GetTitle(self) -> String"""
54f9ee45 10795 return _core_.Menu_GetTitle(*args, **kwargs)
e811c8ce
RD		 10796
10797 def SetEventHandler(*args, **kwargs):
a95a7133 10798 """SetEventHandler(self, EvtHandler handler)"""
54f9ee45 10799 return _core_.Menu_SetEventHandler(*args, **kwargs)
e811c8ce
RD		 10800
10801 def GetEventHandler(*args, **kwargs):
a95a7133 10802 """GetEventHandler(self) -> EvtHandler"""
54f9ee45 10803 return _core_.Menu_GetEventHandler(*args, **kwargs)
e811c8ce
RD		 10804
10805 def SetInvokingWindow(*args, **kwargs):
a95a7133 10806 """SetInvokingWindow(self, Window win)"""
54f9ee45 10807 return _core_.Menu_SetInvokingWindow(*args, **kwargs)
e811c8ce
RD		 10808
10809 def GetInvokingWindow(*args, **kwargs):
a95a7133 10810 """GetInvokingWindow(self) -> Window"""
54f9ee45 10811 return _core_.Menu_GetInvokingWindow(*args, **kwargs)
e811c8ce
RD		 10812
10813 def GetStyle(*args, **kwargs):
a95a7133 10814 """GetStyle(self) -> long"""
54f9ee45 10815 return _core_.Menu_GetStyle(*args, **kwargs)
e811c8ce
RD		 10816
10817 def UpdateUI(*args, **kwargs):
a95a7133 10818 """UpdateUI(self, EvtHandler source=None)"""
54f9ee45 10819 return _core_.Menu_UpdateUI(*args, **kwargs)
e811c8ce
RD		 10820
10821 def GetMenuBar(*args, **kwargs):
a95a7133 10822 """GetMenuBar(self) -> MenuBar"""
54f9ee45 10823 return _core_.Menu_GetMenuBar(*args, **kwargs)
e811c8ce
RD		 10824
10825 def Attach(*args, **kwargs):
a95a7133 10826 """Attach(self, wxMenuBarBase menubar)"""
54f9ee45 10827 return _core_.Menu_Attach(*args, **kwargs)
e811c8ce
RD		 10828
10829 def Detach(*args, **kwargs):
a95a7133 10830 """Detach(self)"""
54f9ee45 10831 return _core_.Menu_Detach(*args, **kwargs)
e811c8ce
RD		 10832
10833 def IsAttached(*args, **kwargs):
a95a7133 10834 """IsAttached(self) -> bool"""
54f9ee45 10835 return _core_.Menu_IsAttached(*args, **kwargs)
e811c8ce
RD		 10836
10837 def SetParent(*args, **kwargs):
a95a7133 10838 """SetParent(self, Menu parent)"""
54f9ee45 10839 return _core_.Menu_SetParent(*args, **kwargs)
e811c8ce
RD		 10840
10841 def GetParent(*args, **kwargs):
a95a7133 10842 """GetParent(self) -> Menu"""
54f9ee45 10843 return _core_.Menu_GetParent(*args, **kwargs)
e811c8ce 10844
57332a5a
RD		 10845 EventHandler = property(GetEventHandler,SetEventHandler,doc="See `GetEventHandler` and `SetEventHandler`")
10846 HelpString = property(GetHelpString,SetHelpString,doc="See `GetHelpString` and `SetHelpString`")
10847 InvokingWindow = property(GetInvokingWindow,SetInvokingWindow,doc="See `GetInvokingWindow` and `SetInvokingWindow`")
10848 MenuBar = property(GetMenuBar,doc="See `GetMenuBar`")
10849 MenuItemCount = property(GetMenuItemCount,doc="See `GetMenuItemCount`")
10850 MenuItems = property(GetMenuItems,doc="See `GetMenuItems`")
10851 Parent = property(GetParent,SetParent,doc="See `GetParent` and `SetParent`")
10852 Style = property(GetStyle,doc="See `GetStyle`")
10853 Title = property(GetTitle,SetTitle,doc="See `GetTitle` and `SetTitle`")
2131d850 10854_core_.Menu_swigregister(Menu)
d14a1e28
RD		 10855DefaultValidator = cvar.DefaultValidator
10856
10857#---------------------------------------------------------------------------
10858
10859class MenuBar(Window):
093d3ff1 10860 """Proxy of C++ MenuBar class"""
0085ce49
RD		 10861 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10862 __repr__ = _swig_repr
10863 def __init__(self, *args, **kwargs):
a95a7133 10864 """__init__(self, long style=0) -> MenuBar"""
0085ce49 10865 _core_.MenuBar_swiginit(self,_core_.new_MenuBar(*args, **kwargs))
d14a1e28 10866 self._setOORInfo(self)
e811c8ce
RD		 10867
10868 def Append(*args, **kwargs):
a95a7133 10869 """Append(self, Menu menu, String title) -> bool"""
54f9ee45 10870 return _core_.MenuBar_Append(*args, **kwargs)
e811c8ce
RD		 10871
10872 def Insert(*args, **kwargs):
a95a7133 10873 """Insert(self, size_t pos, Menu menu, String title) -> bool"""
54f9ee45 10874 return _core_.MenuBar_Insert(*args, **kwargs)
e811c8ce
RD		 10875
10876 def GetMenuCount(*args, **kwargs):
a95a7133 10877 """GetMenuCount(self) -> size_t"""
54f9ee45 10878 return _core_.MenuBar_GetMenuCount(*args, **kwargs)
e811c8ce
RD		 10879
10880 def GetMenu(*args, **kwargs):
a95a7133 10881 """GetMenu(self, size_t pos) -> Menu"""
54f9ee45 10882 return _core_.MenuBar_GetMenu(*args, **kwargs)
e811c8ce
RD		 10883
10884 def Replace(*args, **kwargs):
a95a7133 10885 """Replace(self, size_t pos, Menu menu, String title) -> Menu"""
54f9ee45 10886 return _core_.MenuBar_Replace(*args, **kwargs)
e811c8ce
RD		 10887
10888 def Remove(*args, **kwargs):
a95a7133 10889 """Remove(self, size_t pos) -> Menu"""
54f9ee45 10890 return _core_.MenuBar_Remove(*args, **kwargs)
e811c8ce
RD		 10891
10892 def EnableTop(*args, **kwargs):
a95a7133 10893 """EnableTop(self, size_t pos, bool enable)"""
54f9ee45 10894 return _core_.MenuBar_EnableTop(*args, **kwargs)
e811c8ce
RD		 10895
10896 def IsEnabledTop(*args, **kwargs):
a95a7133 10897 """IsEnabledTop(self, size_t pos) -> bool"""
54f9ee45 10898 return _core_.MenuBar_IsEnabledTop(*args, **kwargs)
e811c8ce
RD		 10899
10900 def SetLabelTop(*args, **kwargs):
a95a7133 10901 """SetLabelTop(self, size_t pos, String label)"""
54f9ee45 10902 return _core_.MenuBar_SetLabelTop(*args, **kwargs)
e811c8ce
RD		 10903
10904 def GetLabelTop(*args, **kwargs):
a95a7133 10905 """GetLabelTop(self, size_t pos) -> String"""
54f9ee45 10906 return _core_.MenuBar_GetLabelTop(*args, **kwargs)
e811c8ce
RD		 10907
10908 def FindMenuItem(*args, **kwargs):
a95a7133 10909 """FindMenuItem(self, String menu, String item) -> int"""
54f9ee45 10910 return _core_.MenuBar_FindMenuItem(*args, **kwargs)
e811c8ce
RD		 10911
10912 def FindItemById(*args, **kwargs):
a95a7133 10913 """FindItemById(self, int id) -> MenuItem"""
54f9ee45 10914 return _core_.MenuBar_FindItemById(*args, **kwargs)
e811c8ce
RD		 10915
10916 def FindMenu(*args, **kwargs):
a95a7133 10917 """FindMenu(self, String title) -> int"""
54f9ee45 10918 return _core_.MenuBar_FindMenu(*args, **kwargs)
e811c8ce
RD		 10919
10920 def Enable(*args, **kwargs):
a95a7133 10921 """Enable(self, int id, bool enable)"""
54f9ee45 10922 return _core_.MenuBar_Enable(*args, **kwargs)
e811c8ce
RD		 10923
10924 def Check(*args, **kwargs):
a95a7133 10925 """Check(self, int id, bool check)"""
54f9ee45 10926 return _core_.MenuBar_Check(*args, **kwargs)
e811c8ce
RD		 10927
10928 def IsChecked(*args, **kwargs):
a95a7133 10929 """IsChecked(self, int id) -> bool"""
54f9ee45 10930 return _core_.MenuBar_IsChecked(*args, **kwargs)
e811c8ce
RD		 10931
10932 def IsEnabled(*args, **kwargs):
a95a7133 10933 """IsEnabled(self, int id) -> bool"""
54f9ee45 10934 return _core_.MenuBar_IsEnabled(*args, **kwargs)
e811c8ce
RD		 10935
10936 def SetLabel(*args, **kwargs):
a95a7133 10937 """SetLabel(self, int id, String label)"""
54f9ee45 10938 return _core_.MenuBar_SetLabel(*args, **kwargs)
e811c8ce
RD		 10939
10940 def GetLabel(*args, **kwargs):
a95a7133 10941 """GetLabel(self, int id) -> String"""
54f9ee45 10942 return _core_.MenuBar_GetLabel(*args, **kwargs)
e811c8ce
RD		 10943
10944 def SetHelpString(*args, **kwargs):
a95a7133 10945 """SetHelpString(self, int id, String helpString)"""
54f9ee45 10946 return _core_.MenuBar_SetHelpString(*args, **kwargs)
e811c8ce
RD		 10947
10948 def GetHelpString(*args, **kwargs):
a95a7133 10949 """GetHelpString(self, int id) -> String"""
54f9ee45 10950 return _core_.MenuBar_GetHelpString(*args, **kwargs)
e811c8ce
RD		 10951
10952 def GetFrame(*args, **kwargs):
a95a7133 10953 """GetFrame(self) -> wxFrame"""
54f9ee45 10954 return _core_.MenuBar_GetFrame(*args, **kwargs)
e811c8ce
RD		 10955
10956 def IsAttached(*args, **kwargs):
a95a7133 10957 """IsAttached(self) -> bool"""
54f9ee45 10958 return _core_.MenuBar_IsAttached(*args, **kwargs)
e811c8ce
RD		 10959
10960 def Attach(*args, **kwargs):
a95a7133 10961 """Attach(self, wxFrame frame)"""
54f9ee45 10962 return _core_.MenuBar_Attach(*args, **kwargs)
e811c8ce
RD		 10963
10964 def Detach(*args, **kwargs):
a95a7133 10965 """Detach(self)"""
54f9ee45 10966 return _core_.MenuBar_Detach(*args, **kwargs)
e811c8ce 10967
587d0f36
RD		 10968 def UpdateMenus(*args, **kwargs):
10969 """UpdateMenus(self)"""
10970 return _core_.MenuBar_UpdateMenus(*args, **kwargs)
10971
4f433fef
RD		 10972 def SetAutoWindowMenu(*args, **kwargs):
10973 """SetAutoWindowMenu(bool enable)"""
10974 return _core_.MenuBar_SetAutoWindowMenu(*args, **kwargs)
10975
10976 SetAutoWindowMenu = staticmethod(SetAutoWindowMenu)
10977 def GetAutoWindowMenu(*args, **kwargs):
10978 """GetAutoWindowMenu() -> bool"""
10979 return _core_.MenuBar_GetAutoWindowMenu(*args, **kwargs)
10980
10981 GetAutoWindowMenu = staticmethod(GetAutoWindowMenu)
97ab0f6a
RD		 10982 def GetMenus(self):
10983 """Return a list of (menu, label) items for the menus in the MenuBar. """
10984 return [(self.GetMenu(i), self.GetLabelTop(i))
10985 for i in range(self.GetMenuCount())]
10986
10987 def SetMenus(self, items):
10988 """Clear and add new menus to the MenuBar from a list of (menu, label) items. """
10989 for i in range(self.GetMenuCount()-1, -1, -1):
10990 self.Remove(i)
10991 for m, l in items:
10992 self.Append(m, l)
10993
57332a5a
RD		 10994 Frame = property(GetFrame,doc="See `GetFrame`")
10995 Menu = property(GetMenu,doc="See `GetMenu`")
10996 MenuCount = property(GetMenuCount,doc="See `GetMenuCount`")
10997 Menus = property(GetMenus,SetMenus,doc="See `GetMenus` and `SetMenus`")
2131d850 10998_core_.MenuBar_swigregister(MenuBar)
d14a1e28 10999
4f433fef 11000def MenuBar_SetAutoWindowMenu(*args, **kwargs):
0085ce49
RD		 11001 """MenuBar_SetAutoWindowMenu(bool enable)"""
11002 return _core_.MenuBar_SetAutoWindowMenu(*args, **kwargs)
4f433fef 11003
0085ce49
RD		 11004def MenuBar_GetAutoWindowMenu(*args):
11005 """MenuBar_GetAutoWindowMenu() -> bool"""
11006 return _core_.MenuBar_GetAutoWindowMenu(*args)
4f433fef 11007
d14a1e28
RD		 11008#---------------------------------------------------------------------------
11009
11010class MenuItem(Object):
093d3ff1 11011 """Proxy of C++ MenuItem class"""
0085ce49
RD		 11012 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11013 __repr__ = _swig_repr
11014 def __init__(self, *args, **kwargs):
0df68c9f 11015 """
a95a7133 11016 __init__(self, Menu parentMenu=None, int id=ID_ANY, String text=EmptyString,
196addbf
RD		 11017 String help=EmptyString, int kind=ITEM_NORMAL,
11018 Menu subMenu=None) -> MenuItem
0df68c9f 11019 """
0085ce49
RD		 11020 _core_.MenuItem_swiginit(self,_core_.new_MenuItem(*args, **kwargs))
11021 __swig_destroy__ = _core_.delete_MenuItem
11022 __del__ = lambda self : None;
e811c8ce 11023 def GetMenu(*args, **kwargs):
a95a7133 11024 """GetMenu(self) -> Menu"""
54f9ee45 11025 return _core_.MenuItem_GetMenu(*args, **kwargs)
e811c8ce
RD		 11026
11027 def SetMenu(*args, **kwargs):
a95a7133 11028 """SetMenu(self, Menu menu)"""
54f9ee45 11029 return _core_.MenuItem_SetMenu(*args, **kwargs)
e811c8ce
RD		 11030
11031 def SetId(*args, **kwargs):
a95a7133 11032 """SetId(self, int id)"""
54f9ee45 11033 return _core_.MenuItem_SetId(*args, **kwargs)
e811c8ce
RD		 11034
11035 def GetId(*args, **kwargs):
a95a7133 11036 """GetId(self) -> int"""
54f9ee45 11037 return _core_.MenuItem_GetId(*args, **kwargs)
e811c8ce
RD		 11038
11039 def IsSeparator(*args, **kwargs):
a95a7133 11040 """IsSeparator(self) -> bool"""
54f9ee45 11041 return _core_.MenuItem_IsSeparator(*args, **kwargs)
e811c8ce
RD		 11042
11043 def SetText(*args, **kwargs):
a95a7133 11044 """SetText(self, String str)"""
54f9ee45 11045 return _core_.MenuItem_SetText(*args, **kwargs)
e811c8ce
RD		 11046
11047 def GetLabel(*args, **kwargs):
a95a7133 11048 """GetLabel(self) -> String"""
54f9ee45 11049 return _core_.MenuItem_GetLabel(*args, **kwargs)
e811c8ce
RD		 11050
11051 def GetText(*args, **kwargs):
a95a7133 11052 """GetText(self) -> String"""
54f9ee45 11053 return _core_.MenuItem_GetText(*args, **kwargs)
e811c8ce
RD		 11054
11055 def GetLabelFromText(*args, **kwargs):
66c033b4 11056 """GetLabelFromText(String text) -> String"""
54f9ee45 11057 return _core_.MenuItem_GetLabelFromText(*args, **kwargs)
e811c8ce
RD		 11058
11059 GetLabelFromText = staticmethod(GetLabelFromText)
11060 def GetKind(*args, **kwargs):
a95a7133 11061 """GetKind(self) -> int"""
54f9ee45 11062 return _core_.MenuItem_GetKind(*args, **kwargs)
e811c8ce 11063
a95a7133
RD		 11064 def SetKind(*args, **kwargs):
11065 """SetKind(self, int kind)"""
54f9ee45 11066 return _core_.MenuItem_SetKind(*args, **kwargs)
a95a7133 11067
e811c8ce 11068 def SetCheckable(*args, **kwargs):
a95a7133 11069 """SetCheckable(self, bool checkable)"""
54f9ee45 11070 return _core_.MenuItem_SetCheckable(*args, **kwargs)
e811c8ce
RD		 11071
11072 def IsCheckable(*args, **kwargs):
a95a7133 11073 """IsCheckable(self) -> bool"""
54f9ee45 11074 return _core_.MenuItem_IsCheckable(*args, **kwargs)
e811c8ce
RD		 11075
11076 def IsSubMenu(*args, **kwargs):
a95a7133 11077 """IsSubMenu(self) -> bool"""
54f9ee45 11078 return _core_.MenuItem_IsSubMenu(*args, **kwargs)
e811c8ce
RD		 11079
11080 def SetSubMenu(*args, **kwargs):
a95a7133 11081 """SetSubMenu(self, Menu menu)"""
54f9ee45 11082 return _core_.MenuItem_SetSubMenu(*args, **kwargs)
e811c8ce
RD		 11083
11084 def GetSubMenu(*args, **kwargs):
a95a7133 11085 """GetSubMenu(self) -> Menu"""
54f9ee45 11086 return _core_.MenuItem_GetSubMenu(*args, **kwargs)
e811c8ce
RD		 11087
11088 def Enable(*args, **kwargs):
a95a7133 11089 """Enable(self, bool enable=True)"""
54f9ee45 11090 return _core_.MenuItem_Enable(*args, **kwargs)
e811c8ce
RD		 11091
11092 def IsEnabled(*args, **kwargs):
a95a7133 11093 """IsEnabled(self) -> bool"""
54f9ee45 11094 return _core_.MenuItem_IsEnabled(*args, **kwargs)
e811c8ce
RD		 11095
11096 def Check(*args, **kwargs):
a95a7133 11097 """Check(self, bool check=True)"""
54f9ee45 11098 return _core_.MenuItem_Check(*args, **kwargs)
e811c8ce
RD		 11099
11100 def IsChecked(*args, **kwargs):
a95a7133 11101 """IsChecked(self) -> bool"""
54f9ee45 11102 return _core_.MenuItem_IsChecked(*args, **kwargs)
e811c8ce
RD		 11103
11104 def Toggle(*args, **kwargs):
a95a7133 11105 """Toggle(self)"""
54f9ee45 11106 return _core_.MenuItem_Toggle(*args, **kwargs)
e811c8ce
RD		 11107
11108 def SetHelp(*args, **kwargs):
a95a7133 11109 """SetHelp(self, String str)"""
54f9ee45 11110 return _core_.MenuItem_SetHelp(*args, **kwargs)
e811c8ce
RD		 11111
11112 def GetHelp(*args, **kwargs):
a95a7133 11113 """GetHelp(self) -> String"""
54f9ee45 11114 return _core_.MenuItem_GetHelp(*args, **kwargs)
e811c8ce
RD		 11115
11116 def GetAccel(*args, **kwargs):
a95a7133 11117 """GetAccel(self) -> AcceleratorEntry"""
54f9ee45 11118 return _core_.MenuItem_GetAccel(*args, **kwargs)
e811c8ce
RD		 11119
11120 def SetAccel(*args, **kwargs):
a95a7133 11121 """SetAccel(self, AcceleratorEntry accel)"""
54f9ee45 11122 return _core_.MenuItem_SetAccel(*args, **kwargs)
e811c8ce 11123
091f5bed
RD		 11124 def SetBitmap(*args, **kwargs):
11125 """SetBitmap(self, Bitmap bitmap)"""
11126 return _core_.MenuItem_SetBitmap(*args, **kwargs)
11127
11128 def GetBitmap(*args, **kwargs):
11129 """GetBitmap(self) -> Bitmap"""
11130 return _core_.MenuItem_GetBitmap(*args, **kwargs)
11131
c1280d1e
RD		 11132 def SetFont(*args, **kwargs):
11133 """SetFont(self, Font font)"""
11134 return _core_.MenuItem_SetFont(*args, **kwargs)
11135
11136 def GetFont(*args, **kwargs):
11137 """GetFont(self) -> Font"""
11138 return _core_.MenuItem_GetFont(*args, **kwargs)
11139
11140 def SetTextColour(*args, **kwargs):
11141 """SetTextColour(self, Colour colText)"""
11142 return _core_.MenuItem_SetTextColour(*args, **kwargs)
11143
11144 def GetTextColour(*args, **kwargs):
11145 """GetTextColour(self) -> Colour"""
11146 return _core_.MenuItem_GetTextColour(*args, **kwargs)
11147
11148 def SetBackgroundColour(*args, **kwargs):
11149 """SetBackgroundColour(self, Colour colBack)"""
11150 return _core_.MenuItem_SetBackgroundColour(*args, **kwargs)
11151
11152 def GetBackgroundColour(*args, **kwargs):
11153 """GetBackgroundColour(self) -> Colour"""
11154 return _core_.MenuItem_GetBackgroundColour(*args, **kwargs)
11155
11156 def SetBitmaps(*args, **kwargs):
11157 """SetBitmaps(self, Bitmap bmpChecked, Bitmap bmpUnchecked=wxNullBitmap)"""
11158 return _core_.MenuItem_SetBitmaps(*args, **kwargs)
11159
11160 def SetDisabledBitmap(*args, **kwargs):
11161 """SetDisabledBitmap(self, Bitmap bmpDisabled)"""
11162 return _core_.MenuItem_SetDisabledBitmap(*args, **kwargs)
11163
11164 def GetDisabledBitmap(*args, **kwargs):
11165 """GetDisabledBitmap(self) -> Bitmap"""
11166 return _core_.MenuItem_GetDisabledBitmap(*args, **kwargs)
11167
11168 def SetMarginWidth(*args, **kwargs):
11169 """SetMarginWidth(self, int nWidth)"""
11170 return _core_.MenuItem_SetMarginWidth(*args, **kwargs)
11171
11172 def GetMarginWidth(*args, **kwargs):
11173 """GetMarginWidth(self) -> int"""
11174 return _core_.MenuItem_GetMarginWidth(*args, **kwargs)
11175
e811c8ce 11176 def GetDefaultMarginWidth(*args, **kwargs):
66c033b4 11177 """GetDefaultMarginWidth() -> int"""
54f9ee45 11178 return _core_.MenuItem_GetDefaultMarginWidth(*args, **kwargs)
e811c8ce
RD		 11179
11180 GetDefaultMarginWidth = staticmethod(GetDefaultMarginWidth)
c1280d1e
RD		 11181 def IsOwnerDrawn(*args, **kwargs):
11182 """IsOwnerDrawn(self) -> bool"""
11183 return _core_.MenuItem_IsOwnerDrawn(*args, **kwargs)
11184
11185 def SetOwnerDrawn(*args, **kwargs):
11186 """SetOwnerDrawn(self, bool ownerDrawn=True)"""
11187 return _core_.MenuItem_SetOwnerDrawn(*args, **kwargs)
11188
11189 def ResetOwnerDrawn(*args, **kwargs):
11190 """ResetOwnerDrawn(self)"""
11191 return _core_.MenuItem_ResetOwnerDrawn(*args, **kwargs)
11192
57332a5a
RD		 11193 Accel = property(GetAccel,SetAccel,doc="See `GetAccel` and `SetAccel`")
11194 BackgroundColour = property(GetBackgroundColour,SetBackgroundColour,doc="See `GetBackgroundColour` and `SetBackgroundColour`")
11195 Bitmap = property(GetBitmap,SetBitmap,doc="See `GetBitmap` and `SetBitmap`")
11196 DisabledBitmap = property(GetDisabledBitmap,SetDisabledBitmap,doc="See `GetDisabledBitmap` and `SetDisabledBitmap`")
11197 Font = property(GetFont,SetFont,doc="See `GetFont` and `SetFont`")
11198 Help = property(GetHelp,SetHelp,doc="See `GetHelp` and `SetHelp`")
11199 Id = property(GetId,SetId,doc="See `GetId` and `SetId`")
11200 Kind = property(GetKind,SetKind,doc="See `GetKind` and `SetKind`")
11201 Label = property(GetLabel,doc="See `GetLabel`")
11202 MarginWidth = property(GetMarginWidth,SetMarginWidth,doc="See `GetMarginWidth` and `SetMarginWidth`")
11203 Menu = property(GetMenu,SetMenu,doc="See `GetMenu` and `SetMenu`")
11204 SubMenu = property(GetSubMenu,SetSubMenu,doc="See `GetSubMenu` and `SetSubMenu`")
11205 Text = property(GetText,SetText,doc="See `GetText` and `SetText`")
11206 TextColour = property(GetTextColour,SetTextColour,doc="See `GetTextColour` and `SetTextColour`")
2131d850 11207_core_.MenuItem_swigregister(MenuItem)
d14a1e28 11208
e811c8ce 11209def MenuItem_GetLabelFromText(*args, **kwargs):
0085ce49
RD		 11210 """MenuItem_GetLabelFromText(String text) -> String"""
11211 return _core_.MenuItem_GetLabelFromText(*args, **kwargs)
d14a1e28 11212
0085ce49
RD		 11213def MenuItem_GetDefaultMarginWidth(*args):
11214 """MenuItem_GetDefaultMarginWidth() -> int"""
11215 return _core_.MenuItem_GetDefaultMarginWidth(*args)
d14a1e28
RD		 11216
11217#---------------------------------------------------------------------------
11218
11219class Control(Window):
15afbcd0
RD		 11220 """
11221 This is the base class for a control or 'widget'.
11222
41e2b43e
RD		 11223 A control is generally a small window which processes user input
11224 and/or displays one or more item of data.
15afbcd0 11225 """
0085ce49
RD		 11226 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11227 __repr__ = _swig_repr
11228 def __init__(self, *args, **kwargs):
0df68c9f 11229 """
248ed943
RD		 11230 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
11231 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
b2dc1044 11232 String name=ControlNameStr) -> Control
15afbcd0 11233
41e2b43e
RD		 11234 Create a Control. Normally you should only call this from a subclass'
11235 __init__ as a plain old wx.Control is not very useful.
0df68c9f 11236 """
0085ce49 11237 _core_.Control_swiginit(self,_core_.new_Control(*args, **kwargs))
d14a1e28 11238 self._setOORInfo(self)
e811c8ce
RD		 11239
11240 def Create(*args, **kwargs):
0df68c9f 11241 """
248ed943
RD		 11242 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
11243 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
b2dc1044 11244 String name=ControlNameStr) -> bool
15afbcd0
RD		 11245
11246 Do the 2nd phase and create the GUI control.
0df68c9f 11247 """
54f9ee45 11248 return _core_.Control_Create(*args, **kwargs)
e811c8ce 11249
10044bf1
RD		 11250 def GetAlignment(*args, **kwargs):
11251 """
11252 GetAlignment(self) -> int
11253
11254 Get the control alignment (left/right/centre, top/bottom/centre)
11255 """
11256 return _core_.Control_GetAlignment(*args, **kwargs)
11257
34e0a3bb 11258 def GetLabelText(*args, **kwargs):
10044bf1 11259 """
10044bf1
RD		 11260 GetLabelText(self) -> String
11261
11262 Get just the text of the label, without mnemonic characters ('&')
11263 """
34e0a3bb 11264 return _core_.Control_GetLabelText(*args, **kwargs)
10044bf1 11265
e811c8ce 11266 def Command(*args, **kwargs):
15afbcd0 11267 """
a95a7133 11268 Command(self, CommandEvent event)
15afbcd0 11269
41e2b43e
RD		 11270 Simulates the effect of the user issuing a command to the item.
11271
11272 :see: `wx.CommandEvent`
11273
15afbcd0 11274 """
54f9ee45 11275 return _core_.Control_Command(*args, **kwargs)
e811c8ce 11276
74a57fcd 11277 def GetClassDefaultAttributes(*args, **kwargs):
110da5b0
RD		 11278 """
11279 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
11280
11281 Get the default attributes for this class. This is useful if you want
11282 to use the same font or colour in your own control as in a standard
11283 control -- which is a much better idea than hard coding specific
11284 colours or fonts which might look completely out of place on the
11285 user's system, especially if it uses themes.
11286
11287 The variant parameter is only relevant under Mac currently and is
11288 ignore under other platforms. Under Mac, it will change the size of
11289 the returned font. See `wx.Window.SetWindowVariant` for more about
11290 this.
11291 """
54f9ee45 11292 return _core_.Control_GetClassDefaultAttributes(*args, **kwargs)
74a57fcd
RD		 11293
11294 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
2bf58437 11295 Alignment = property(GetAlignment,doc="See `GetAlignment`")
2bf58437 11296 LabelText = property(GetLabelText,doc="See `GetLabelText`")
2131d850 11297_core_.Control_swigregister(Control)
b2dc1044 11298ControlNameStr = cvar.ControlNameStr
d14a1e28
RD		 11299
11300def PreControl(*args, **kwargs):
15afbcd0
RD		 11301 """
11302 PreControl() -> Control
11303
11304 Precreate a Control control for 2-phase creation
11305 """
54f9ee45 11306 val = _core_.new_PreControl(*args, **kwargs)
d14a1e28
RD		 11307 return val
11308
74a57fcd 11309def Control_GetClassDefaultAttributes(*args, **kwargs):
0085ce49 11310 """
110da5b0
RD		 11311 Control_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
11312
11313 Get the default attributes for this class. This is useful if you want
11314 to use the same font or colour in your own control as in a standard
11315 control -- which is a much better idea than hard coding specific
11316 colours or fonts which might look completely out of place on the
11317 user's system, especially if it uses themes.
11318
11319 The variant parameter is only relevant under Mac currently and is
11320 ignore under other platforms. Under Mac, it will change the size of
11321 the returned font. See `wx.Window.SetWindowVariant` for more about
11322 this.
11323 """
0085ce49 11324 return _core_.Control_GetClassDefaultAttributes(*args, **kwargs)
74a57fcd 11325
d14a1e28
RD		 11326#---------------------------------------------------------------------------
11327
11328class ItemContainer(object):
15afbcd0 11329 """
53aa7709
RD		 11330 The wx.ItemContainer class defines an interface which is implemented
11331 by all controls which have string subitems, each of which may be
11332 selected, such as `wx.ListBox`, `wx.CheckListBox`, `wx.Choice` as well
11333 as `wx.ComboBox` which implements an extended interface deriving from
41e2b43e 11334 this one.
15afbcd0 11335
41e2b43e
RD		 11336 It defines the methods for accessing the control's items and although
11337 each of the derived classes implements them differently, they still
11338 all conform to the same interface.
15afbcd0 11339
41e2b43e
RD		 11340 The items in a wx.ItemContainer have (non empty) string labels and,
11341 optionally, client data associated with them.
15afbcd0
RD		 11342
11343 """
0085ce49
RD		 11344 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11345 def __init__(self): raise AttributeError, "No constructor defined"
11346 __repr__ = _swig_repr
e811c8ce 11347 def Append(*args, **kwargs):
15afbcd0 11348 """
a95a7133 11349 Append(self, String item, PyObject clientData=None) -> int
15afbcd0 11350
41e2b43e
RD		 11351 Adds the item to the control, associating the given data with the item
11352 if not None. The return value is the index of the newly added item
11353 which may be different from the last one if the control is sorted (e.g.
11354 has wx.LB_SORT or wx.CB_SORT style).
15afbcd0 11355 """
54f9ee45 11356 return _core_.ItemContainer_Append(*args, **kwargs)
e811c8ce
RD		 11357
11358 def AppendItems(*args, **kwargs):
15afbcd0 11359 """
f5b96ee1 11360 AppendItems(self, List strings)
15afbcd0 11361
41e2b43e
RD		 11362 Apend several items at once to the control. Notice that calling this
11363 method may be much faster than appending the items one by one if you
11364 need to add a lot of items.
15afbcd0 11365 """
54f9ee45 11366 return _core_.ItemContainer_AppendItems(*args, **kwargs)
e811c8ce
RD		 11367
11368 def Insert(*args, **kwargs):
15afbcd0 11369 """
50f151d7 11370 Insert(self, String item, unsigned int pos, PyObject clientData=None) -> int
15afbcd0 11371
41e2b43e 11372 Insert an item into the control before the item at the ``pos`` index,
15afbcd0
RD		 11373 optionally associating some data object with the item.
11374 """
54f9ee45 11375 return _core_.ItemContainer_Insert(*args, **kwargs)
e811c8ce
RD		 11376
11377 def Clear(*args, **kwargs):
15afbcd0 11378 """
a95a7133 11379 Clear(self)
15afbcd0
RD		 11380
11381 Removes all items from the control.
11382 """
54f9ee45 11383 return _core_.ItemContainer_Clear(*args, **kwargs)
e811c8ce
RD		 11384
11385 def Delete(*args, **kwargs):
15afbcd0 11386 """
50f151d7 11387 Delete(self, unsigned int n)
15afbcd0 11388
41e2b43e
RD		 11389 Deletes the item at the zero-based index 'n' from the control. Note
11390 that it is an error (signalled by a `wx.PyAssertionError` exception if
11391 enabled) to remove an item with the index negative or greater or equal
11392 than the number of items in the control.
15afbcd0 11393 """
54f9ee45 11394 return _core_.ItemContainer_Delete(*args, **kwargs)
e811c8ce 11395
53aa7709
RD		 11396 def GetClientData(*args, **kwargs):
11397 """
50f151d7 11398 GetClientData(self, unsigned int n) -> PyObject
53aa7709
RD		 11399
11400 Returns the client data associated with the given item, (if any.)
11401 """
11402 return _core_.ItemContainer_GetClientData(*args, **kwargs)
11403
11404 def SetClientData(*args, **kwargs):
11405 """
50f151d7 11406 SetClientData(self, unsigned int n, PyObject clientData)
53aa7709
RD		 11407
11408 Associate the given client data with the item at position n.
11409 """
11410 return _core_.ItemContainer_SetClientData(*args, **kwargs)
11411
e811c8ce 11412 def GetCount(*args, **kwargs):
15afbcd0 11413 """
50f151d7 11414 GetCount(self) -> unsigned int
15afbcd0
RD		 11415
11416 Returns the number of items in the control.
11417 """
54f9ee45 11418 return _core_.ItemContainer_GetCount(*args, **kwargs)
e811c8ce
RD		 11419
11420 def IsEmpty(*args, **kwargs):
15afbcd0 11421 """
a95a7133 11422 IsEmpty(self) -> bool
15afbcd0
RD		 11423
11424 Returns True if the control is empty or False if it has some items.
11425 """
54f9ee45 11426 return _core_.ItemContainer_IsEmpty(*args, **kwargs)
e811c8ce
RD		 11427
11428 def GetString(*args, **kwargs):
15afbcd0 11429 """
50f151d7 11430 GetString(self, unsigned int n) -> String
15afbcd0
RD		 11431
11432 Returns the label of the item with the given index.
11433 """
54f9ee45 11434 return _core_.ItemContainer_GetString(*args, **kwargs)
e811c8ce
RD		 11435
11436 def GetStrings(*args, **kwargs):
a95a7133 11437 """GetStrings(self) -> wxArrayString"""
54f9ee45 11438 return _core_.ItemContainer_GetStrings(*args, **kwargs)
e811c8ce
RD		 11439
11440 def SetString(*args, **kwargs):
15afbcd0 11441 """
50f151d7 11442 SetString(self, unsigned int n, String s)
15afbcd0
RD		 11443
11444 Sets the label for the given item.
11445 """
54f9ee45 11446 return _core_.ItemContainer_SetString(*args, **kwargs)
e811c8ce
RD		 11447
11448 def FindString(*args, **kwargs):
15afbcd0 11449 """
a95a7133 11450 FindString(self, String s) -> int
15afbcd0
RD		 11451
11452 Finds an item whose label matches the given string. Returns the
41e2b43e
RD		 11453 zero-based position of the item, or ``wx.NOT_FOUND`` if the string was not
11454 found.
15afbcd0 11455 """
54f9ee45 11456 return _core_.ItemContainer_FindString(*args, **kwargs)
e811c8ce 11457
53aa7709 11458 def SetSelection(*args, **kwargs):
15afbcd0 11459 """
53aa7709 11460 SetSelection(self, int n)
15afbcd0
RD		 11461
11462 Sets the item at index 'n' to be the selected item.
11463 """
53aa7709 11464 return _core_.ItemContainer_SetSelection(*args, **kwargs)
e811c8ce
RD		 11465
11466 def GetSelection(*args, **kwargs):
15afbcd0 11467 """
a95a7133 11468 GetSelection(self) -> int
15afbcd0 11469
41e2b43e
RD		 11470 Returns the index of the selected item or ``wx.NOT_FOUND`` if no item
11471 is selected.
15afbcd0 11472 """
54f9ee45 11473 return _core_.ItemContainer_GetSelection(*args, **kwargs)
e811c8ce 11474
53aa7709
RD		 11475 def SetStringSelection(*args, **kwargs):
11476 """SetStringSelection(self, String s) -> bool"""
11477 return _core_.ItemContainer_SetStringSelection(*args, **kwargs)
11478
e811c8ce 11479 def GetStringSelection(*args, **kwargs):
15afbcd0 11480 """
a95a7133 11481 GetStringSelection(self) -> String
15afbcd0 11482
41e2b43e
RD		 11483 Returns the label of the selected item or an empty string if no item
11484 is selected.
15afbcd0 11485 """
54f9ee45 11486 return _core_.ItemContainer_GetStringSelection(*args, **kwargs)
e811c8ce 11487
53aa7709 11488 def Select(*args, **kwargs):
15afbcd0 11489 """
53aa7709 11490 Select(self, int n)
15afbcd0 11491
53aa7709
RD		 11492 This is the same as `SetSelection` and exists only because it is
11493 slightly more natural for controls which support multiple selection.
15afbcd0 11494 """
53aa7709 11495 return _core_.ItemContainer_Select(*args, **kwargs)
e811c8ce 11496
97ab0f6a
RD		 11497 def GetItems(self):
11498 """Return a list of the strings in the control"""
11499 return [self.GetString(i) for i in xrange(self.GetCount())]
11500
11501 def SetItems(self, items):
11502 """Clear and set the strings in the control from a list"""
11503 self.Clear()
11504 for i in items:
11505 self.Append(i)
11506
11507 Count = property(GetCount,doc="See `GetCount`")
11508 Items = property(GetItems,SetItems,doc="See `GetItems` and `SetItems`")
11509 Selection = property(GetSelection,SetSelection,doc="See `GetSelection` and `SetSelection`")
11510 StringSelection = property(GetStringSelection,SetStringSelection,doc="See `GetStringSelection` and `SetStringSelection`")
11511 Strings = property(GetStrings,doc="See `GetStrings`")
2131d850 11512_core_.ItemContainer_swigregister(ItemContainer)
d14a1e28
RD		 11513
11514#---------------------------------------------------------------------------
11515
11516class ControlWithItems(Control,ItemContainer):
15afbcd0 11517 """
41e2b43e
RD		 11518 wx.ControlWithItems combines the ``wx.ItemContainer`` class with the
11519 wx.Control class, and is used for the base class of various controls
11520 that have items.
15afbcd0 11521 """
0085ce49
RD		 11522 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11523 def __init__(self): raise AttributeError, "No constructor defined"
11524 __repr__ = _swig_repr
2131d850 11525_core_.ControlWithItems_swigregister(ControlWithItems)
d14a1e28
RD		 11526
11527#---------------------------------------------------------------------------
11528
11529class SizerItem(Object):
248ed943
RD		 11530 """
11531 The wx.SizerItem class is used to track the position, size and other
01f6b6d3
RD		 11532 attributes of each item managed by a `wx.Sizer`. It is not usually
11533 necessary to use this class because the sizer elements can also be
11534 identified by their positions or window or sizer references but
11535 sometimes it may be more convenient to use wx.SizerItem directly.
11536 Also, custom classes derived from `wx.PySizer` will probably need to
11537 use the collection of wx.SizerItems held by wx.Sizer when calculating
11538 layout.
248ed943
RD		 11539
11540 :see: `wx.Sizer`, `wx.GBSizerItem`
11541 """
0085ce49
RD		 11542 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11543 __repr__ = _swig_repr
11544 def __init__(self, *args, **kwargs):
248ed943
RD		 11545 """
11546 __init__(self) -> SizerItem
11547
11548 Constructs an empty wx.SizerItem. Either a window, sizer or spacer
11549 size will need to be set before this item can be used in a Sizer.
11550
11551 You will probably never need to create a wx.SizerItem directly as they
11552 are created automatically when the sizer's Add, Insert or Prepend
11553 methods are called.
11554
11555 :see: `wx.SizerItemSpacer`, `wx.SizerItemWindow`, `wx.SizerItemSizer`
11556 """
0085ce49
RD		 11557 _core_.SizerItem_swiginit(self,_core_.new_SizerItem(*args, **kwargs))
11558 __swig_destroy__ = _core_.delete_SizerItem
11559 __del__ = lambda self : None;
e811c8ce 11560 def DeleteWindows(*args, **kwargs):
248ed943
RD		 11561 """
11562 DeleteWindows(self)
11563
11564 Destroy the window or the windows in a subsizer, depending on the type
11565 of item.
11566 """
54f9ee45 11567 return _core_.SizerItem_DeleteWindows(*args, **kwargs)
e811c8ce
RD		 11568
11569 def DetachSizer(*args, **kwargs):
248ed943
RD		 11570 """
11571 DetachSizer(self)
11572
11573 Enable deleting the SizerItem without destroying the contained sizer.
11574 """
54f9ee45 11575 return _core_.SizerItem_DetachSizer(*args, **kwargs)
e811c8ce
RD		 11576
11577 def GetSize(*args, **kwargs):
248ed943
RD		 11578 """
11579 GetSize(self) -> Size
11580
11581 Get the current size of the item, as set in the last Layout.
11582 """
54f9ee45 11583 return _core_.SizerItem_GetSize(*args, **kwargs)
e811c8ce
RD		 11584
11585 def CalcMin(*args, **kwargs):
248ed943
RD		 11586 """
11587 CalcMin(self) -> Size
11588
11589 Calculates the minimum desired size for the item, including any space
11590 needed by borders.
11591 """
54f9ee45 11592 return _core_.SizerItem_CalcMin(*args, **kwargs)
e811c8ce
RD		 11593
11594 def SetDimension(*args, **kwargs):
248ed943
RD		 11595 """
11596 SetDimension(self, Point pos, Size size)
11597
11598 Set the position and size of the space allocated for this item by the
11599 sizer, and adjust the position and size of the item (window or
11600 subsizer) to be within that space taking alignment and borders into
11601 account.
11602 """
54f9ee45 11603 return _core_.SizerItem_SetDimension(*args, **kwargs)
e811c8ce
RD		 11604
11605 def GetMinSize(*args, **kwargs):
248ed943
RD		 11606 """
11607 GetMinSize(self) -> Size
11608
11609 Get the minimum size needed for the item.
11610 """
54f9ee45 11611 return _core_.SizerItem_GetMinSize(*args, **kwargs)
e811c8ce 11612
dfbb5885
RD		 11613 def GetMinSizeWithBorder(*args, **kwargs):
11614 """
11615 GetMinSizeWithBorder(self) -> Size
11616
11617 Get the minimum size needed for the item with space for the borders
11618 added, if needed.
11619 """
11620 return _core_.SizerItem_GetMinSizeWithBorder(*args, **kwargs)
11621
e811c8ce 11622 def SetInitSize(*args, **kwargs):
a95a7133 11623 """SetInitSize(self, int x, int y)"""
54f9ee45 11624 return _core_.SizerItem_SetInitSize(*args, **kwargs)
e811c8ce
RD		 11625
11626 def SetRatioWH(*args, **kwargs):
248ed943
RD		 11627 """
11628 SetRatioWH(self, int width, int height)
11629
11630 Set the ratio item attribute.
11631 """
54f9ee45 11632 return _core_.SizerItem_SetRatioWH(*args, **kwargs)
e811c8ce
RD		 11633
11634 def SetRatioSize(*args, **kwargs):
248ed943
RD		 11635 """
11636 SetRatioSize(self, Size size)
11637
11638 Set the ratio item attribute.
11639 """
54f9ee45 11640 return _core_.SizerItem_SetRatioSize(*args, **kwargs)
e811c8ce
RD		 11641
11642 def SetRatio(*args, **kwargs):
248ed943
RD		 11643 """
11644 SetRatio(self, float ratio)
11645
11646 Set the ratio item attribute.
11647 """
54f9ee45 11648 return _core_.SizerItem_SetRatio(*args, **kwargs)
e811c8ce
RD		 11649
11650 def GetRatio(*args, **kwargs):
248ed943
RD		 11651 """
11652 GetRatio(self) -> float
11653
11654 Set the ratio item attribute.
11655 """
54f9ee45 11656 return _core_.SizerItem_GetRatio(*args, **kwargs)
e811c8ce 11657
d3b6e4ff
RD		 11658 def GetRect(*args, **kwargs):
11659 """
11660 GetRect(self) -> Rect
11661
11662 Returns the rectangle that the sizer item should occupy
11663 """
11664 return _core_.SizerItem_GetRect(*args, **kwargs)
11665
e811c8ce 11666 def IsWindow(*args, **kwargs):
248ed943
RD		 11667 """
11668 IsWindow(self) -> bool
11669
11670 Is this sizer item a window?
11671 """
54f9ee45 11672 return _core_.SizerItem_IsWindow(*args, **kwargs)
e811c8ce
RD		 11673
11674 def IsSizer(*args, **kwargs):
248ed943
RD		 11675 """
11676 IsSizer(self) -> bool
11677
11678 Is this sizer item a subsizer?
11679 """
54f9ee45 11680 return _core_.SizerItem_IsSizer(*args, **kwargs)
e811c8ce
RD		 11681
11682 def IsSpacer(*args, **kwargs):
248ed943
RD		 11683 """
11684 IsSpacer(self) -> bool
11685
11686 Is this sizer item a spacer?
11687 """
54f9ee45 11688 return _core_.SizerItem_IsSpacer(*args, **kwargs)
e811c8ce
RD		 11689
11690 def SetProportion(*args, **kwargs):
248ed943
RD		 11691 """
11692 SetProportion(self, int proportion)
11693
11694 Set the proportion value for this item.
11695 """
54f9ee45 11696 return _core_.SizerItem_SetProportion(*args, **kwargs)
e811c8ce
RD		 11697
11698 def GetProportion(*args, **kwargs):
248ed943
RD		 11699 """
11700 GetProportion(self) -> int
11701
11702 Get the proportion value for this item.
11703 """
54f9ee45 11704 return _core_.SizerItem_GetProportion(*args, **kwargs)
e811c8ce 11705
248ed943
RD		 11706 SetOption = wx._deprecated(SetProportion, "Please use `SetProportion` instead.")
11707 GetOption = wx._deprecated(GetProportion, "Please use `GetProportion` instead.")
e811c8ce 11708 def SetFlag(*args, **kwargs):
248ed943
RD		 11709 """
11710 SetFlag(self, int flag)
11711
11712 Set the flag value for this item.
11713 """
54f9ee45 11714 return _core_.SizerItem_SetFlag(*args, **kwargs)
e811c8ce
RD		 11715
11716 def GetFlag(*args, **kwargs):
248ed943
RD		 11717 """
11718 GetFlag(self) -> int
11719
11720 Get the flag value for this item.
11721 """
54f9ee45 11722 return _core_.SizerItem_GetFlag(*args, **kwargs)
e811c8ce
RD		 11723
11724 def SetBorder(*args, **kwargs):
248ed943
RD		 11725 """
11726 SetBorder(self, int border)
11727
11728 Set the border value for this item.
11729 """
54f9ee45 11730 return _core_.SizerItem_SetBorder(*args, **kwargs)
e811c8ce
RD		 11731
11732 def GetBorder(*args, **kwargs):
248ed943
RD		 11733 """
11734 GetBorder(self) -> int
11735
11736 Get the border value for this item.
11737 """
54f9ee45 11738 return _core_.SizerItem_GetBorder(*args, **kwargs)
e811c8ce
RD		 11739
11740 def GetWindow(*args, **kwargs):
248ed943
RD		 11741 """
11742 GetWindow(self) -> Window
11743
11744 Get the window (if any) that is managed by this sizer item.
11745 """
54f9ee45 11746 return _core_.SizerItem_GetWindow(*args, **kwargs)
e811c8ce
RD		 11747
11748 def SetWindow(*args, **kwargs):
248ed943
RD		 11749 """
11750 SetWindow(self, Window window)
11751
11752 Set the window to be managed by this sizer item.
11753 """
54f9ee45 11754 return _core_.SizerItem_SetWindow(*args, **kwargs)
e811c8ce
RD		 11755
11756 def GetSizer(*args, **kwargs):
248ed943
RD		 11757 """
11758 GetSizer(self) -> Sizer
11759
11760 Get the subsizer (if any) that is managed by this sizer item.
11761 """
54f9ee45 11762 return _core_.SizerItem_GetSizer(*args, **kwargs)
e811c8ce
RD		 11763
11764 def SetSizer(*args, **kwargs):
248ed943
RD		 11765 """
11766 SetSizer(self, Sizer sizer)
11767
11768 Set the subsizer to be managed by this sizer item.
11769 """
54f9ee45 11770 return _core_.SizerItem_SetSizer(*args, **kwargs)
e811c8ce
RD		 11771
11772 def GetSpacer(*args, **kwargs):
248ed943
RD		 11773 """
11774 GetSpacer(self) -> Size
11775
11776 Get the size of the spacer managed by this sizer item.
11777 """
54f9ee45 11778 return _core_.SizerItem_GetSpacer(*args, **kwargs)
e811c8ce
RD		 11779
11780 def SetSpacer(*args, **kwargs):
248ed943
RD		 11781 """
11782 SetSpacer(self, Size size)
11783
11784 Set the size of the spacer to be managed by this sizer item.
11785 """
54f9ee45 11786 return _core_.SizerItem_SetSpacer(*args, **kwargs)
e811c8ce
RD		 11787
11788 def Show(*args, **kwargs):
248ed943
RD		 11789 """
11790 Show(self, bool show)
11791
11792 Set the show item attribute, which sizers use to determine if the item
11793 is to be made part of the layout or not. If the item is tracking a
11794 window then it is shown or hidden as needed.
11795 """
54f9ee45 11796 return _core_.SizerItem_Show(*args, **kwargs)
e811c8ce
RD		 11797
11798 def IsShown(*args, **kwargs):
248ed943
RD		 11799 """
11800 IsShown(self) -> bool
11801
11802 Is the item to be shown in the layout?
11803 """
54f9ee45 11804 return _core_.SizerItem_IsShown(*args, **kwargs)
e811c8ce
RD		 11805
11806 def GetPosition(*args, **kwargs):
248ed943
RD		 11807 """
11808 GetPosition(self) -> Point
11809
11810 Returns the current position of the item, as set in the last Layout.
11811 """
54f9ee45 11812 return _core_.SizerItem_GetPosition(*args, **kwargs)
e811c8ce
RD		 11813
11814 def GetUserData(*args, **kwargs):
248ed943
RD		 11815 """
11816 GetUserData(self) -> PyObject
11817
11818 Returns the userData associated with this sizer item, or None if there
11819 isn't any.
11820 """
54f9ee45 11821 return _core_.SizerItem_GetUserData(*args, **kwargs)
e811c8ce 11822
091f5bed
RD		 11823 def SetUserData(*args, **kwargs):
11824 """
11825 SetUserData(self, PyObject userData)
11826
11827 Associate a Python object with this sizer item.
11828 """
11829 return _core_.SizerItem_SetUserData(*args, **kwargs)
11830
33d6fd3b
RD		 11831 Border = property(GetBorder,SetBorder,doc="See `GetBorder` and `SetBorder`")
11832 Flag = property(GetFlag,SetFlag,doc="See `GetFlag` and `SetFlag`")
11833 MinSize = property(GetMinSize,doc="See `GetMinSize`")
11834 MinSizeWithBorder = property(GetMinSizeWithBorder,doc="See `GetMinSizeWithBorder`")
11835 Position = property(GetPosition,doc="See `GetPosition`")
11836 Proportion = property(GetProportion,SetProportion,doc="See `GetProportion` and `SetProportion`")
11837 Ratio = property(GetRatio,SetRatio,doc="See `GetRatio` and `SetRatio`")
11838 Rect = property(GetRect,doc="See `GetRect`")
11839 Size = property(GetSize,doc="See `GetSize`")
11840 Sizer = property(GetSizer,SetSizer,doc="See `GetSizer` and `SetSizer`")
11841 Spacer = property(GetSpacer,SetSpacer,doc="See `GetSpacer` and `SetSpacer`")
11842 UserData = property(GetUserData,SetUserData,doc="See `GetUserData` and `SetUserData`")
11843 Window = property(GetWindow,SetWindow,doc="See `GetWindow` and `SetWindow`")
2131d850 11844_core_.SizerItem_swigregister(SizerItem)
d14a1e28 11845
248ed943 11846def SizerItemWindow(*args, **kwargs):
0df68c9f 11847 """
248ed943
RD		 11848 SizerItemWindow(Window window, int proportion, int flag, int border,
11849 PyObject userData=None) -> SizerItem
11850
11851 Constructs a `wx.SizerItem` for tracking a window.
0df68c9f 11852 """
248ed943 11853 val = _core_.new_SizerItemWindow(*args, **kwargs)
d14a1e28
RD		 11854 return val
11855
248ed943 11856def SizerItemSpacer(*args, **kwargs):
0df68c9f 11857 """
248ed943
RD		 11858 SizerItemSpacer(int width, int height, int proportion, int flag, int border,
11859 PyObject userData=None) -> SizerItem
11860
11861 Constructs a `wx.SizerItem` for tracking a spacer.
0df68c9f 11862 """
248ed943 11863 val = _core_.new_SizerItemSpacer(*args, **kwargs)
d14a1e28
RD		 11864 return val
11865
11866def SizerItemSizer(*args, **kwargs):
0df68c9f
RD		 11867 """
11868 SizerItemSizer(Sizer sizer, int proportion, int flag, int border,
248ed943
RD		 11869 PyObject userData=None) -> SizerItem
11870
11871 Constructs a `wx.SizerItem` for tracking a subsizer
0df68c9f 11872 """
54f9ee45 11873 val = _core_.new_SizerItemSizer(*args, **kwargs)
d14a1e28
RD		 11874 return val
11875
11876class Sizer(Object):
248ed943
RD		 11877 """
11878 wx.Sizer is the abstract base class used for laying out subwindows in
11879 a window. You cannot use wx.Sizer directly; instead, you will have to
11880 use one of the sizer classes derived from it such as `wx.BoxSizer`,
1d5ee749
RD		 11881 `wx.StaticBoxSizer`, `wx.GridSizer`, `wx.FlexGridSizer` and
11882 `wx.GridBagSizer`.
248ed943
RD		 11883
11884 The concept implemented by sizers in wxWidgets is closely related to
11885 layout tools in other GUI toolkits, such as Java's AWT, the GTK
11886 toolkit or the Qt toolkit. It is based upon the idea of the individual
11887 subwindows reporting their minimal required size and their ability to
11888 get stretched if the size of the parent window has changed. This will
11889 most often mean that the programmer does not set the original size of
11890 a dialog in the beginning, rather the dialog will assigned a sizer and
11891 this sizer will be queried about the recommended size. The sizer in
11892 turn will query its children, which can be normal windows or contorls,
11893 empty space or other sizers, so that a hierarchy of sizers can be
11894 constructed. Note that wxSizer does not derive from wxWindow and thus
11895 do not interfere with tab ordering and requires very little resources
11896 compared to a real window on screen.
11897
11898 What makes sizers so well fitted for use in wxWidgets is the fact that
11899 every control reports its own minimal size and the algorithm can
11900 handle differences in font sizes or different window (dialog item)
11901 sizes on different platforms without problems. If for example the
11902 standard font as well as the overall design of Mac widgets requires
11903 more space than on Windows, then the initial size of a dialog using a
11904 sizer will automatically be bigger on Mac than on Windows.
11905 """
0085ce49
RD		 11906 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11907 def __init__(self): raise AttributeError, "No constructor defined"
11908 __repr__ = _swig_repr
11909 __swig_destroy__ = _core_.delete_Sizer
11910 __del__ = lambda self : None;
e811c8ce 11911 def _setOORInfo(*args, **kwargs):
a95a7133 11912 """_setOORInfo(self, PyObject _self)"""
54f9ee45 11913 return _core_.Sizer__setOORInfo(*args, **kwargs)
e811c8ce
RD		 11914
11915 def Add(*args, **kwargs):
0df68c9f 11916 """
248ed943 11917 Add(self, item, int proportion=0, int flag=0, int border=0,
d3b6e4ff 11918 PyObject userData=None) -> wx.SizerItem
248ed943
RD		 11919
11920 Appends a child item to the sizer.
0df68c9f 11921 """
54f9ee45 11922 return _core_.Sizer_Add(*args, **kwargs)
e811c8ce
RD		 11923
11924 def Insert(*args, **kwargs):
0df68c9f 11925 """
248ed943 11926 Insert(self, int before, item, int proportion=0, int flag=0, int border=0,
d3b6e4ff 11927 PyObject userData=None) -> wx.SizerItem
248ed943
RD		 11928
11929 Inserts a new item into the list of items managed by this sizer before
11930 the item at index *before*. See `Add` for a description of the parameters.
0df68c9f 11931 """
54f9ee45 11932 return _core_.Sizer_Insert(*args, **kwargs)
e811c8ce
RD		 11933
11934 def Prepend(*args, **kwargs):
0df68c9f 11935 """
248ed943 11936 Prepend(self, item, int proportion=0, int flag=0, int border=0,
d3b6e4ff 11937 PyObject userData=None) -> wx.SizerItem
248ed943
RD		 11938
11939 Adds a new item to the begining of the list of sizer items managed by
11940 this sizer. See `Add` for a description of the parameters.
0df68c9f 11941 """
54f9ee45 11942 return _core_.Sizer_Prepend(*args, **kwargs)
e811c8ce
RD		 11943
11944 def Remove(*args, **kwargs):
248ed943
RD		 11945 """
11946 Remove(self, item) -> bool
11947
11948 Removes an item from the sizer and destroys it. This method does not
11949 cause any layout or resizing to take place, call `Layout` to update
11950 the layout on screen after removing a child from the sizer. The
11951 *item* parameter can be either a window, a sizer, or the zero-based
11952 index of an item to remove. Returns True if the child item was found
11953 and removed.
11954 """
54f9ee45 11955 return _core_.Sizer_Remove(*args, **kwargs)
e811c8ce 11956
1c0f361b 11957 def Detach(*args, **kwargs):
248ed943
RD		 11958 """
11959 Detach(self, item) -> bool
11960
11961 Detaches an item from the sizer without destroying it. This method
11962 does not cause any layout or resizing to take place, call `Layout` to
11963 do so. The *item* parameter can be either a window, a sizer, or the
11964 zero-based index of the item to be detached. Returns True if the child item
11965 was found and detached.
11966 """
1c0f361b
RD		 11967 return _core_.Sizer_Detach(*args, **kwargs)
11968
d3b6e4ff
RD		 11969 def GetItem(*args, **kwargs):
11970 """
11971 GetItem(self, item) -> wx.SizerItem
11972
11973 Returns the `wx.SizerItem` which holds the *item* given. The *item*
11974 parameter can be either a window, a sizer, or the zero-based index of
4d170c95 11975 the item to be found.
d3b6e4ff
RD		 11976 """
11977 return _core_.Sizer_GetItem(*args, **kwargs)
11978
e811c8ce 11979 def _SetItemMinSize(*args, **kwargs):
a95a7133 11980 """_SetItemMinSize(self, PyObject item, Size size)"""
54f9ee45 11981 return _core_.Sizer__SetItemMinSize(*args, **kwargs)
e811c8ce 11982
97ab0f6a
RD		 11983 def _ReplaceWin(*args, **kwargs):
11984 """_ReplaceWin(self, Window oldwin, Window newwin, bool recursive=False) -> bool"""
11985 return _core_.Sizer__ReplaceWin(*args, **kwargs)
11986
11987 def _ReplaceSizer(*args, **kwargs):
11988 """_ReplaceSizer(self, Sizer oldsz, Sizer newsz, bool recursive=False) -> bool"""
11989 return _core_.Sizer__ReplaceSizer(*args, **kwargs)
11990
11991 def _ReplaceItem(*args, **kwargs):
11992 """_ReplaceItem(self, size_t index, SizerItem newitem) -> bool"""
11993 return _core_.Sizer__ReplaceItem(*args, **kwargs)
11994
11995 def Replace(self, olditem, item, recursive=False):
11996 """
11997 Detaches the given ``olditem`` from the sizer and replaces it with
11998 ``item`` which can be a window, sizer, or `wx.SizerItem`. The
11999 detached child is destroyed only if it is not a window, (because
12000 windows are owned by their parent, not the sizer.) The
12001 ``recursive`` parameter can be used to search for the given
12002 element recursivly in subsizers.
12003
12004 This method does not cause any layout or resizing to take place,
12005 call `Layout` to do so.
12006
12007 Returns ``True`` if the child item was found and removed.
12008 """
12009 if isinstance(olditem, wx.Window):
12010 return self._ReplaceWin(olditem, item, recursive)
12011 elif isinstnace(olditem, wx.Sizer):
12012 return self._ReplaceSizer(olditem, item, recursive)
12013 elif isinstnace(olditem, int):
12014 return self._ReplaceItem(olditem, item)
12015 else:
12016 raise TypeError("Expected Window, Sizer, or integer for first parameter.")
12017
12018 def SetContainingWindow(*args, **kwargs):
12019 """
12020 SetContainingWindow(self, Window window)
12021
12022 Set (or unset) the window this sizer is used in.
12023 """
12024 return _core_.Sizer_SetContainingWindow(*args, **kwargs)
12025
12026 def GetContainingWindow(*args, **kwargs):
12027 """
12028 GetContainingWindow(self) -> Window
12029
12030 Get the window this sizer is used in.
12031 """
12032 return _core_.Sizer_GetContainingWindow(*args, **kwargs)
12033
248ed943
RD		 12034 def SetItemMinSize(self, item, *args):
12035 """
12036 SetItemMinSize(self, item, Size size)
12037
12038 Sets the minimum size that will be allocated for an item in the sizer.
12039 The *item* parameter can be either a window, a sizer, or the
12040 zero-based index of the item. If a window or sizer is given then it
12041 will be searched for recursivly in subsizers if neccessary.
12042 """
12043 if len(args) == 2:
12044 # for backward compatibility accept separate width,height args too
12045 return self._SetItemMinSize(item, args)
12046 else:
12047 return self._SetItemMinSize(item, args[0])
12048
e811c8ce 12049 def AddItem(*args, **kwargs):
248ed943
RD		 12050 """
12051 AddItem(self, SizerItem item)
12052
12053 Adds a `wx.SizerItem` to the sizer.
12054 """
54f9ee45 12055 return _core_.Sizer_AddItem(*args, **kwargs)
e811c8ce
RD		 12056
12057 def InsertItem(*args, **kwargs):
248ed943
RD		 12058 """
12059 InsertItem(self, int index, SizerItem item)
12060
12061 Inserts a `wx.SizerItem` to the sizer at the position given by *index*.
12062 """
54f9ee45 12063 return _core_.Sizer_InsertItem(*args, **kwargs)
e811c8ce
RD		 12064
12065 def PrependItem(*args, **kwargs):
248ed943
RD		 12066 """
12067 PrependItem(self, SizerItem item)
12068
12069 Prepends a `wx.SizerItem` to the sizer.
12070 """
54f9ee45 12071 return _core_.Sizer_PrependItem(*args, **kwargs)
e811c8ce 12072
248ed943 12073 def AddMany(self, items):
66c033b4
RD		 12074 """
12075 AddMany is a convenience method for adding several items
12076 to a sizer at one time. Simply pass it a list of tuples,
12077 where each tuple consists of the parameters that you
12078 would normally pass to the `Add` method.
12079 """
248ed943
RD		 12080 for item in items:
12081 if type(item) != type(()) or (len(item) == 2 and type(item[0]) == type(1)):
12082 item = (item, )
12083 self.Add(*item)
d14a1e28 12084
ae5bc7f3
RD		 12085 def AddSpacer(self, *args, **kw):
12086 """AddSpacer(int size) --> SizerItem
12087
12088 Add a spacer that is (size,size) pixels.
12089 """
12090 if args and type(args[0]) == int:
12091 return self.Add( (args[0],args[0] ), 0)
12092 else: # otherwise stay compatible with old AddSpacer
12093 return self.Add(*args, **kw)
12094 def PrependSpacer(self, *args, **kw):
12095 """PrependSpacer(int size) --> SizerItem
12096
12097 Prepend a spacer that is (size, size) pixels."""
12098 if args and type(args[0]) == int:
12099 return self.Prepend( (args[0],args[0] ), 0)
12100 else: # otherwise stay compatible with old PrependSpacer
12101 return self.Prepend(*args, **kw)
12102 def InsertSpacer(self, index, *args, **kw):
12103 """InsertSpacer(int index, int size) --> SizerItem
12104
12105 Insert a spacer at position index that is (size, size) pixels."""
12106 if args and type(args[0]) == int:
12107 return self.Insert( index, (args[0],args[0] ), 0)
12108 else: # otherwise stay compatible with old InsertSpacer
12109 return self.Insert(index, *args, **kw)
12110
12111
12112 def AddStretchSpacer(self, prop=1):
12113 """AddStretchSpacer(int prop=1) --> SizerItem
12114
12115 Add a stretchable spacer."""
12116 return self.Add((0,0), prop)
12117 def PrependStretchSpacer(self, prop=1):
12118 """PrependStretchSpacer(int prop=1) --> SizerItem
12119
12120 Prepend a stretchable spacer."""
12121 return self.Prepend((0,0), prop)
12122 def InsertStretchSpacer(self, index, prop=1):
12123 """InsertStretchSpacer(int index, int prop=1) --> SizerItem
12124
12125 Insert a stretchable spacer."""
12126 return self.Insert(index, (0,0), prop)
12127
12128
74e96f3d 12129 # for backwards compatibility only, please do not use in new code
b9d6a5f3
RD		 12130 def AddWindow(self, *args, **kw):
12131 """Compatibility alias for `Add`."""
12132 return self.Add(*args, **kw)
12133 def AddSizer(self, *args, **kw):
12134 """Compatibility alias for `Add`."""
12135 return self.Add(*args, **kw)
b9d6a5f3
RD		 12136
12137 def PrependWindow(self, *args, **kw):
12138 """Compatibility alias for `Prepend`."""
12139 return self.Prepend(*args, **kw)
12140 def PrependSizer(self, *args, **kw):
12141 """Compatibility alias for `Prepend`."""
12142 return self.Prepend(*args, **kw)
b9d6a5f3
RD		 12143
12144 def InsertWindow(self, *args, **kw):
12145 """Compatibility alias for `Insert`."""
12146 return self.Insert(*args, **kw)
12147 def InsertSizer(self, *args, **kw):
12148 """Compatibility alias for `Insert`."""
b9d6a5f3
RD		 12149 return self.Insert(*args, **kw)
12150
12151 def RemoveWindow(self, *args, **kw):
12152 """Compatibility alias for `Remove`."""
12153 return self.Remove(*args, **kw)
12154 def RemoveSizer(self, *args, **kw):
12155 """Compatibility alias for `Remove`."""
12156 return self.Remove(*args, **kw)
12157 def RemovePos(self, *args, **kw):
12158 """Compatibility alias for `Remove`."""
12159 return self.Remove(*args, **kw)
d14a1e28
RD		 12160
12161
e811c8ce 12162 def SetDimension(*args, **kwargs):
248ed943
RD		 12163 """
12164 SetDimension(self, int x, int y, int width, int height)
12165
12166 Call this to force the sizer to take the given dimension and thus
12167 force the items owned by the sizer to resize themselves according to
12168 the rules defined by the parameter in the `Add`, `Insert` or `Prepend`
12169 methods.
12170 """
54f9ee45 12171 return _core_.Sizer_SetDimension(*args, **kwargs)
e811c8ce
RD		 12172
12173 def SetMinSize(*args, **kwargs):
248ed943
RD		 12174 """
12175 SetMinSize(self, Size size)
12176
12177 Call this to give the sizer a minimal size. Normally, the sizer will
12178 calculate its minimal size based purely on how much space its children
12179 need. After calling this method `GetMinSize` will return either the
12180 minimal size as requested by its children or the minimal size set
12181 here, depending on which is bigger.
12182 """
54f9ee45 12183 return _core_.Sizer_SetMinSize(*args, **kwargs)
e811c8ce
RD		 12184
12185 def GetSize(*args, **kwargs):
248ed943
RD		 12186 """
12187 GetSize(self) -> Size
12188
12189 Returns the current size of the space managed by the sizer.
12190 """
54f9ee45 12191 return _core_.Sizer_GetSize(*args, **kwargs)
e811c8ce
RD		 12192
12193 def GetPosition(*args, **kwargs):
248ed943
RD		 12194 """
12195 GetPosition(self) -> Point
12196
12197 Returns the current position of the sizer's managed space.
12198 """
54f9ee45 12199 return _core_.Sizer_GetPosition(*args, **kwargs)
e811c8ce
RD		 12200
12201 def GetMinSize(*args, **kwargs):
248ed943
RD		 12202 """
12203 GetMinSize(self) -> Size
12204
12205 Returns the minimal size of the sizer. This is either the combined
12206 minimal size of all the children and their borders or the minimal size
12207 set by SetMinSize, depending on which is bigger.
12208 """
54f9ee45 12209 return _core_.Sizer_GetMinSize(*args, **kwargs)
e811c8ce 12210
d14a1e28 12211 def GetSizeTuple(self):
1c0f361b 12212 return self.GetSize().Get()
d14a1e28 12213 def GetPositionTuple(self):
1c0f361b 12214 return self.GetPosition().Get()
d14a1e28 12215 def GetMinSizeTuple(self):
1c0f361b 12216 return self.GetMinSize().Get()
d14a1e28 12217
e811c8ce 12218 def RecalcSizes(*args, **kwargs):
248ed943
RD		 12219 """
12220 RecalcSizes(self)
12221
12222 Using the sizes calculated by `CalcMin` reposition and resize all the
12223 items managed by this sizer. You should not need to call this directly as
12224 it is called by `Layout`.
12225 """
54f9ee45 12226 return _core_.Sizer_RecalcSizes(*args, **kwargs)
e811c8ce
RD		 12227
12228 def CalcMin(*args, **kwargs):
248ed943
RD		 12229 """
12230 CalcMin(self) -> Size
12231
12232 This method is where the sizer will do the actual calculation of its
12233 children's minimal sizes. You should not need to call this directly as
12234 it is called by `Layout`.
12235 """
54f9ee45 12236 return _core_.Sizer_CalcMin(*args, **kwargs)
e811c8ce
RD		 12237
12238 def Layout(*args, **kwargs):
248ed943
RD		 12239 """
12240 Layout(self)
12241
12242 This method will force the recalculation and layout of the items
12243 controlled by the sizer using the current space allocated to the
12244 sizer. Normally this is called automatically from the owning window's
12245 EVT_SIZE handler, but it is also useful to call it from user code when
12246 one of the items in a sizer change size, or items are added or
12247 removed.
12248 """
54f9ee45 12249 return _core_.Sizer_Layout(*args, **kwargs)
e811c8ce
RD		 12250
12251 def Fit(*args, **kwargs):
248ed943
RD		 12252 """
12253 Fit(self, Window window) -> Size
12254
12255 Tell the sizer to resize the *window* to match the sizer's minimal
12256 size. This is commonly done in the constructor of the window itself in
12257 order to set its initial size to match the needs of the children as
12258 determined by the sizer. Returns the new size.
12259
12260 For a top level window this is the total window size, not the client size.
12261 """
54f9ee45 12262 return _core_.Sizer_Fit(*args, **kwargs)
e811c8ce
RD		 12263
12264 def FitInside(*args, **kwargs):
248ed943
RD		 12265 """
12266 FitInside(self, Window window)
12267
12268 Tell the sizer to resize the *virtual size* of the *window* to match the
12269 sizer's minimal size. This will not alter the on screen size of the
12270 window, but may cause the addition/removal/alteration of scrollbars
12271 required to view the virtual area in windows which manage it.
12272
12273 :see: `wx.ScrolledWindow.SetScrollbars`, `SetVirtualSizeHints`
12274
12275 """
54f9ee45 12276 return _core_.Sizer_FitInside(*args, **kwargs)
e811c8ce
RD		 12277
12278 def SetSizeHints(*args, **kwargs):
248ed943
RD		 12279 """
12280 SetSizeHints(self, Window window)
12281
12282 Tell the sizer to set (and `Fit`) the minimal size of the *window* to
12283 match the sizer's minimal size. This is commonly done in the
12284 constructor of the window itself if the window is resizable (as are
12285 many dialogs under Unix and frames on probably all platforms) in order
12286 to prevent the window from being sized smaller than the minimal size
12287 required by the sizer.
12288 """
54f9ee45 12289 return _core_.Sizer_SetSizeHints(*args, **kwargs)
e811c8ce
RD		 12290
12291 def SetVirtualSizeHints(*args, **kwargs):
248ed943
RD		 12292 """
12293 SetVirtualSizeHints(self, Window window)
12294
12295 Tell the sizer to set the minimal size of the window virtual area to
12296 match the sizer's minimal size. For windows with managed scrollbars
12297 this will set them appropriately.
12298
12299 :see: `wx.ScrolledWindow.SetScrollbars`
12300
12301 """
54f9ee45 12302 return _core_.Sizer_SetVirtualSizeHints(*args, **kwargs)
e811c8ce
RD		 12303
12304 def Clear(*args, **kwargs):
248ed943
RD		 12305 """
12306 Clear(self, bool deleteWindows=False)
12307
12308 Clear all items from the sizer, optionally destroying the window items
12309 as well.
12310 """
54f9ee45 12311 return _core_.Sizer_Clear(*args, **kwargs)
e811c8ce
RD		 12312
12313 def DeleteWindows(*args, **kwargs):
248ed943
RD		 12314 """
12315 DeleteWindows(self)
12316
12317 Destroy all windows managed by the sizer.
12318 """
54f9ee45 12319 return _core_.Sizer_DeleteWindows(*args, **kwargs)
e811c8ce
RD		 12320
12321 def GetChildren(*args, **kwargs):
248ed943 12322 """
51b83b37 12323 GetChildren(self) -> list
248ed943
RD		 12324
12325 Returns a list of all the `wx.SizerItem` objects managed by the sizer.
12326 """
54f9ee45 12327 return _core_.Sizer_GetChildren(*args, **kwargs)
e811c8ce
RD		 12328
12329 def Show(*args, **kwargs):
248ed943 12330 """
ae8162c8 12331 Show(self, item, bool show=True, bool recursive=false) -> bool
e811c8ce 12332
248ed943
RD		 12333 Shows or hides an item managed by the sizer. To make a sizer item
12334 disappear or reappear, use Show followed by `Layout`. The *item*
12335 parameter can be either a window, a sizer, or the zero-based index of
7e63a440
RD		 12336 the item. Use the recursive parameter to show or hide an item in a
12337 subsizer. Returns True if the item was found.
248ed943
RD		 12338 """
12339 return _core_.Sizer_Show(*args, **kwargs)
e811c8ce
RD		 12340
12341 def IsShown(*args, **kwargs):
248ed943
RD		 12342 """
12343 IsShown(self, item)
12344
b1fcee84 12345 Determines if the item is currently shown. To make a sizer
248ed943
RD		 12346 item disappear or reappear, use Show followed by `Layout`. The *item*
12347 parameter can be either a window, a sizer, or the zero-based index of
12348 the item.
12349 """
54f9ee45 12350 return _core_.Sizer_IsShown(*args, **kwargs)
e811c8ce 12351
7e63a440 12352 def Hide(self, item, recursive=False):
248ed943 12353 """
27fb7603 12354 A convenience method for `Show` (item, False, recursive).
248ed943 12355 """
06759a38 12356 return self.Show(item, False, recursive)
248ed943 12357
e811c8ce 12358 def ShowItems(*args, **kwargs):
248ed943
RD		 12359 """
12360 ShowItems(self, bool show)
12361
84f85550 12362 Recursively call `wx.SizerItem.Show` on all sizer items.
248ed943 12363 """
54f9ee45 12364 return _core_.Sizer_ShowItems(*args, **kwargs)
e811c8ce 12365
33d6fd3b
RD		 12366 Children = property(GetChildren,doc="See `GetChildren`")
12367 ContainingWindow = property(GetContainingWindow,SetContainingWindow,doc="See `GetContainingWindow` and `SetContainingWindow`")
12368 MinSize = property(GetMinSize,SetMinSize,doc="See `GetMinSize` and `SetMinSize`")
12369 Position = property(GetPosition,doc="See `GetPosition`")
12370 Size = property(GetSize,doc="See `GetSize`")
2131d850 12371_core_.Sizer_swigregister(Sizer)
d14a1e28
RD		 12372
12373class PySizer(Sizer):
248ed943
RD		 12374 """
12375 wx.PySizer is a special version of `wx.Sizer` that has been
12376 instrumented to allow the C++ virtual methods to be overloaded in
12377 Python derived classes. You would derive from this class if you are
12378 wanting to implement a custom sizer in Python code. Simply implement
12379 `CalcMin` and `RecalcSizes` in the derived class and you're all set.
12380 For example::
12381
12382 class MySizer(wx.PySizer):
12383 def __init__(self):
12384 wx.PySizer.__init__(self)
12385
12386 def CalcMin(self):
12387 for item in self.GetChildren():
12388 # calculate the total minimum width and height needed
12389 # by all items in the sizer according to this sizer's
12390 # layout algorithm.
12391 ...
12392 return wx.Size(width, height)
12393
12394 def RecalcSizes(self):
12395 # find the space allotted to this sizer
12396 pos = self.GetPosition()
12397 size = self.GetSize()
12398 for item in self.GetChildren():
12399 # Recalculate (if necessary) the position and size of
12400 # each item and then call item.SetDimension to do the
12401 # actual positioning and sizing of the items within the
12402 # space alloted to this sizer.
12403 ...
12404 item.SetDimension(itemPos, itemSize)
12405
12406
12407 When `Layout` is called it first calls `CalcMin` followed by
12408 `RecalcSizes` so you can optimize a bit by saving the results of
e505d15e 12409 `CalcMin` and reusing them in `RecalcSizes`.
248ed943
RD		 12410
12411 :see: `wx.SizerItem`, `wx.Sizer.GetChildren`
12412
12413
12414 """
0085ce49
RD		 12415 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12416 __repr__ = _swig_repr
12417 def __init__(self, *args, **kwargs):
248ed943
RD		 12418 """
12419 __init__(self) -> PySizer
12420
12421 Creates a wx.PySizer. Must be called from the __init__ in the derived
12422 class.
12423 """
0085ce49 12424 _core_.PySizer_swiginit(self,_core_.new_PySizer(*args, **kwargs))
d14a1e28 12425 self._setCallbackInfo(self, PySizer);self._setOORInfo(self)
e811c8ce
RD		 12426
12427 def _setCallbackInfo(*args, **kwargs):
a95a7133 12428 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
54f9ee45 12429 return _core_.PySizer__setCallbackInfo(*args, **kwargs)
e811c8ce 12430
2131d850 12431_core_.PySizer_swigregister(PySizer)
d14a1e28
RD		 12432
12433#---------------------------------------------------------------------------
12434
12435class BoxSizer(Sizer):
248ed943
RD		 12436 """
12437 The basic idea behind a box sizer is that windows will most often be
12438 laid out in rather simple basic geometry, typically in a row or a
12439 column or nested hierarchies of either. A wx.BoxSizer will lay out
12440 its items in a simple row or column, depending on the orientation
12441 parameter passed to the constructor.
12442 """
0085ce49
RD		 12443 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12444 __repr__ = _swig_repr
12445 def __init__(self, *args, **kwargs):
248ed943
RD		 12446 """
12447 __init__(self, int orient=HORIZONTAL) -> BoxSizer
12448
12449 Constructor for a wx.BoxSizer. *orient* may be one of ``wx.VERTICAL``
12450 or ``wx.HORIZONTAL`` for creating either a column sizer or a row
12451 sizer.
12452 """
0085ce49 12453 _core_.BoxSizer_swiginit(self,_core_.new_BoxSizer(*args, **kwargs))
d14a1e28 12454 self._setOORInfo(self)
e811c8ce
RD		 12455
12456 def GetOrientation(*args, **kwargs):
248ed943
RD		 12457 """
12458 GetOrientation(self) -> int
12459
12460 Returns the current orientation of the sizer.
12461 """
54f9ee45 12462 return _core_.BoxSizer_GetOrientation(*args, **kwargs)
e811c8ce
RD		 12463
12464 def SetOrientation(*args, **kwargs):
248ed943
RD		 12465 """
12466 SetOrientation(self, int orient)
e811c8ce 12467
248ed943
RD		 12468 Resets the orientation of the sizer.
12469 """
12470 return _core_.BoxSizer_SetOrientation(*args, **kwargs)
e811c8ce 12471
2bf58437 12472 Orientation = property(GetOrientation,SetOrientation,doc="See `GetOrientation` and `SetOrientation`")
2131d850 12473_core_.BoxSizer_swigregister(BoxSizer)
d14a1e28
RD		 12474
12475#---------------------------------------------------------------------------
12476
12477class StaticBoxSizer(BoxSizer):
248ed943
RD		 12478 """
12479 wx.StaticBoxSizer derives from and functions identically to the
12480 `wx.BoxSizer` and adds a `wx.StaticBox` around the items that the sizer
12481 manages. Note that this static box must be created separately and
12482 passed to the sizer constructor.
12483 """
0085ce49
RD		 12484 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12485 __repr__ = _swig_repr
12486 def __init__(self, *args, **kwargs):
248ed943
RD		 12487 """
12488 __init__(self, StaticBox box, int orient=HORIZONTAL) -> StaticBoxSizer
12489
12490 Constructor. It takes an associated static box and the orientation
12491 *orient* as parameters - orient can be either of ``wx.VERTICAL`` or
12492 ``wx.HORIZONTAL``.
12493 """
0085ce49 12494 _core_.StaticBoxSizer_swiginit(self,_core_.new_StaticBoxSizer(*args, **kwargs))
d14a1e28 12495 self._setOORInfo(self)
e811c8ce
RD		 12496
12497 def GetStaticBox(*args, **kwargs):
248ed943
RD		 12498 """
12499 GetStaticBox(self) -> StaticBox
e811c8ce 12500
248ed943
RD		 12501 Returns the static box associated with this sizer.
12502 """
12503 return _core_.StaticBoxSizer_GetStaticBox(*args, **kwargs)
e811c8ce 12504
33d6fd3b 12505 StaticBox = property(GetStaticBox,doc="See `GetStaticBox`")
2131d850 12506_core_.StaticBoxSizer_swigregister(StaticBoxSizer)
d14a1e28
RD		 12507
12508#---------------------------------------------------------------------------
12509
12510class GridSizer(Sizer):
248ed943
RD		 12511 """
12512 A grid sizer is a sizer which lays out its children in a
12513 two-dimensional table with all cells having the same size. In other
12514 words, the width of each cell within the grid is the width of the
12515 widest item added to the sizer and the height of each grid cell is the
12516 height of the tallest item. An optional vertical and/or horizontal
12517 gap between items can also be specified (in pixels.)
12518
12519 Items are placed in the cells of the grid in the order they are added,
12520 in row-major order. In other words, the first row is filled first,
12521 then the second, and so on until all items have been added. (If
12522 neccessary, additional rows will be added as items are added.) If you
12523 need to have greater control over the cells that items are placed in
12524 then use the `wx.GridBagSizer`.
12525
12526 """
0085ce49
RD		 12527 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12528 __repr__ = _swig_repr
12529 def __init__(self, *args, **kwargs):
248ed943
RD		 12530 """
12531 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> GridSizer
12532
12533 Constructor for a wx.GridSizer. *rows* and *cols* determine the number
12534 of columns and rows in the sizer - if either of the parameters is
12535 zero, it will be calculated to from the total number of children in
12536 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
12537 define extra space between all children.
12538 """
0085ce49 12539 _core_.GridSizer_swiginit(self,_core_.new_GridSizer(*args, **kwargs))
d14a1e28 12540 self._setOORInfo(self)
e811c8ce 12541
e811c8ce 12542 def SetCols(*args, **kwargs):
248ed943
RD		 12543 """
12544 SetCols(self, int cols)
12545
12546 Sets the number of columns in the sizer.
12547 """
54f9ee45 12548 return _core_.GridSizer_SetCols(*args, **kwargs)
e811c8ce
RD		 12549
12550 def SetRows(*args, **kwargs):
248ed943
RD		 12551 """
12552 SetRows(self, int rows)
12553
12554 Sets the number of rows in the sizer.
12555 """
54f9ee45 12556 return _core_.GridSizer_SetRows(*args, **kwargs)
e811c8ce
RD		 12557
12558 def SetVGap(*args, **kwargs):
248ed943
RD		 12559 """
12560 SetVGap(self, int gap)
12561
12562 Sets the vertical gap (in pixels) between the cells in the sizer.
12563 """
54f9ee45 12564 return _core_.GridSizer_SetVGap(*args, **kwargs)
e811c8ce
RD		 12565
12566 def SetHGap(*args, **kwargs):
248ed943
RD		 12567 """
12568 SetHGap(self, int gap)
12569
12570 Sets the horizontal gap (in pixels) between cells in the sizer
12571 """
54f9ee45 12572 return _core_.GridSizer_SetHGap(*args, **kwargs)
e811c8ce
RD		 12573
12574 def GetCols(*args, **kwargs):
248ed943
RD		 12575 """
12576 GetCols(self) -> int
12577
12578 Returns the number of columns in the sizer.
12579 """
54f9ee45 12580 return _core_.GridSizer_GetCols(*args, **kwargs)
e811c8ce
RD		 12581
12582 def GetRows(*args, **kwargs):
248ed943
RD		 12583 """
12584 GetRows(self) -> int
12585
12586 Returns the number of rows in the sizer.
12587 """
54f9ee45 12588 return _core_.GridSizer_GetRows(*args, **kwargs)
e811c8ce
RD		 12589
12590 def GetVGap(*args, **kwargs):
248ed943
RD		 12591 """
12592 GetVGap(self) -> int
12593
12594 Returns the vertical gap (in pixels) between the cells in the sizer.
12595 """
54f9ee45 12596 return _core_.GridSizer_GetVGap(*args, **kwargs)
e811c8ce
RD		 12597
12598 def GetHGap(*args, **kwargs):
248ed943
RD		 12599 """
12600 GetHGap(self) -> int
12601
12602 Returns the horizontal gap (in pixels) between cells in the sizer.
12603 """
54f9ee45 12604 return _core_.GridSizer_GetHGap(*args, **kwargs)
e811c8ce 12605
0085ce49
RD		 12606 def CalcRowsCols(self):
12607 """
12608 CalcRowsCols() -> (rows, cols)
12609
12610 Calculates how many rows and columns will be in the sizer based
12611 on the current number of items and also the rows, cols specified
12612 in the constructor.
12613 """
12614 nitems = len(self.GetChildren())
12615 rows = self.GetRows()
12616 cols = self.GetCols()
12617 assert rows != 0 or cols != 0, "Grid sizer must have either rows or columns fixed"
12618 if cols != 0:
12619 rows = (nitems + cols - 1) / cols
12620 elif rows != 0:
12621 cols = (nitems + rows - 1) / rows
12622 return (rows, cols)
d14a1e28 12623
97ab0f6a
RD		 12624 Cols = property(GetCols,SetCols,doc="See `GetCols` and `SetCols`")
12625 HGap = property(GetHGap,SetHGap,doc="See `GetHGap` and `SetHGap`")
12626 Rows = property(GetRows,SetRows,doc="See `GetRows` and `SetRows`")
12627 VGap = property(GetVGap,SetVGap,doc="See `GetVGap` and `SetVGap`")
2131d850 12628_core_.GridSizer_swigregister(GridSizer)
d14a1e28
RD		 12629
12630#---------------------------------------------------------------------------
12631
54f9ee45
RD		 12632FLEX_GROWMODE_NONE = _core_.FLEX_GROWMODE_NONE
12633FLEX_GROWMODE_SPECIFIED = _core_.FLEX_GROWMODE_SPECIFIED
12634FLEX_GROWMODE_ALL = _core_.FLEX_GROWMODE_ALL
d14a1e28 12635class FlexGridSizer(GridSizer):
248ed943
RD		 12636 """
12637 A flex grid sizer is a sizer which lays out its children in a
12638 two-dimensional table with all table cells in one row having the same
12639 height and all cells in one column having the same width, but all
12640 rows or all columns are not necessarily the same height or width as in
12641 the `wx.GridSizer`.
12642
12643 wx.FlexGridSizer can also size items equally in one direction but
12644 unequally ("flexibly") in the other. If the sizer is only flexible
12645 in one direction (this can be changed using `SetFlexibleDirection`), it
12646 needs to be decided how the sizer should grow in the other ("non
12647 flexible") direction in order to fill the available space. The
12648 `SetNonFlexibleGrowMode` method serves this purpose.
12649
12650
12651 """
0085ce49
RD		 12652 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12653 __repr__ = _swig_repr
12654 def __init__(self, *args, **kwargs):
248ed943
RD		 12655 """
12656 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> FlexGridSizer
12657
12658 Constructor for a wx.FlexGridSizer. *rows* and *cols* determine the
12659 number of columns and rows in the sizer - if either of the parameters
12660 is zero, it will be calculated to from the total number of children in
12661 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
12662 define extra space between all children.
12663 """
0085ce49 12664 _core_.FlexGridSizer_swiginit(self,_core_.new_FlexGridSizer(*args, **kwargs))
d14a1e28 12665 self._setOORInfo(self)
e811c8ce 12666
248ed943
RD		 12667 def AddGrowableRow(*args, **kwargs):
12668 """
12669 AddGrowableRow(self, size_t idx, int proportion=0)
e811c8ce 12670
248ed943
RD		 12671 Specifies that row *idx* (starting from zero) should be grown if there
12672 is extra space available to the sizer.
e811c8ce 12673
248ed943
RD		 12674 The *proportion* parameter has the same meaning as the stretch factor
12675 for the box sizers except that if all proportions are 0, then all
12676 columns are resized equally (instead of not being resized at all).
12677 """
54f9ee45 12678 return _core_.FlexGridSizer_AddGrowableRow(*args, **kwargs)
e811c8ce
RD		 12679
12680 def RemoveGrowableRow(*args, **kwargs):
248ed943
RD		 12681 """
12682 RemoveGrowableRow(self, size_t idx)
12683
12684 Specifies that row *idx* is no longer growable.
12685 """
54f9ee45 12686 return _core_.FlexGridSizer_RemoveGrowableRow(*args, **kwargs)
e811c8ce
RD		 12687
12688 def AddGrowableCol(*args, **kwargs):
248ed943
RD		 12689 """
12690 AddGrowableCol(self, size_t idx, int proportion=0)
12691
12692 Specifies that column *idx* (starting from zero) should be grown if
12693 there is extra space available to the sizer.
12694
12695 The *proportion* parameter has the same meaning as the stretch factor
12696 for the box sizers except that if all proportions are 0, then all
12697 columns are resized equally (instead of not being resized at all).
12698 """
54f9ee45 12699 return _core_.FlexGridSizer_AddGrowableCol(*args, **kwargs)
e811c8ce
RD		 12700
12701 def RemoveGrowableCol(*args, **kwargs):
248ed943
RD		 12702 """
12703 RemoveGrowableCol(self, size_t idx)
12704
12705 Specifies that column *idx* is no longer growable.
12706 """
54f9ee45 12707 return _core_.FlexGridSizer_RemoveGrowableCol(*args, **kwargs)
e811c8ce
RD		 12708
12709 def SetFlexibleDirection(*args, **kwargs):
248ed943
RD		 12710 """
12711 SetFlexibleDirection(self, int direction)
12712
12713 Specifies whether the sizer should flexibly resize its columns, rows,
12714 or both. Argument *direction* can be one of the following values. Any
12715 other value is ignored.
12716
12717 ============== =======================================
12718 wx.VERTICAL Rows are flexibly sized.
12719 wx.HORIZONTAL Columns are flexibly sized.
12720 wx.BOTH Both rows and columns are flexibly sized
12721 (this is the default value).
12722 ============== =======================================
12723
12724 Note that this method does not trigger relayout.
12725
12726 """
54f9ee45 12727 return _core_.FlexGridSizer_SetFlexibleDirection(*args, **kwargs)
e811c8ce
RD		 12728
12729 def GetFlexibleDirection(*args, **kwargs):
248ed943
RD		 12730 """
12731 GetFlexibleDirection(self) -> int
12732
12733 Returns a value that specifies whether the sizer
12734 flexibly resizes its columns, rows, or both (default).
12735
12736 :see: `SetFlexibleDirection`
12737 """
54f9ee45 12738 return _core_.FlexGridSizer_GetFlexibleDirection(*args, **kwargs)
e811c8ce
RD		 12739
12740 def SetNonFlexibleGrowMode(*args, **kwargs):
248ed943
RD		 12741 """
12742 SetNonFlexibleGrowMode(self, int mode)
12743
12744 Specifies how the sizer should grow in the non-flexible direction if
12745 there is one (so `SetFlexibleDirection` must have been called
12746 previously). Argument *mode* can be one of the following values:
12747
12748 ========================== =================================================
12749 wx.FLEX_GROWMODE_NONE Sizer doesn't grow in the non flexible direction.
12750 wx.FLEX_GROWMODE_SPECIFIED Sizer honors growable columns/rows set with
12751 `AddGrowableCol` and `AddGrowableRow`. In this
12752 case equal sizing applies to minimum sizes of
12753 columns or rows (this is the default value).
12754 wx.FLEX_GROWMODE_ALL Sizer equally stretches all columns or rows in
12755 the non flexible direction, whether they are
12756 growable or not in the flexbile direction.
12757 ========================== =================================================
12758
12759 Note that this method does not trigger relayout.
248ed943 12760 """
54f9ee45 12761 return _core_.FlexGridSizer_SetNonFlexibleGrowMode(*args, **kwargs)
e811c8ce
RD		 12762
12763 def GetNonFlexibleGrowMode(*args, **kwargs):
248ed943
RD		 12764 """
12765 GetNonFlexibleGrowMode(self) -> int
12766
12767 Returns the value that specifies how the sizer grows in the
12768 non-flexible direction if there is one.
12769
12770 :see: `SetNonFlexibleGrowMode`
12771 """
54f9ee45 12772 return _core_.FlexGridSizer_GetNonFlexibleGrowMode(*args, **kwargs)
e811c8ce
RD		 12773
12774 def GetRowHeights(*args, **kwargs):
fd2dc343
RD		 12775 """
12776 GetRowHeights(self) -> list
12777
12778 Returns a list of integers representing the heights of each of the
12779 rows in the sizer.
12780 """
54f9ee45 12781 return _core_.FlexGridSizer_GetRowHeights(*args, **kwargs)
e811c8ce
RD		 12782
12783 def GetColWidths(*args, **kwargs):
fd2dc343
RD		 12784 """
12785 GetColWidths(self) -> list
12786
12787 Returns a list of integers representing the widths of each of the
12788 columns in the sizer.
12789 """
54f9ee45 12790 return _core_.FlexGridSizer_GetColWidths(*args, **kwargs)
e811c8ce 12791
97ab0f6a
RD		 12792 ColWidths = property(GetColWidths,doc="See `GetColWidths`")
12793 FlexibleDirection = property(GetFlexibleDirection,SetFlexibleDirection,doc="See `GetFlexibleDirection` and `SetFlexibleDirection`")
12794 NonFlexibleGrowMode = property(GetNonFlexibleGrowMode,SetNonFlexibleGrowMode,doc="See `GetNonFlexibleGrowMode` and `SetNonFlexibleGrowMode`")
12795 RowHeights = property(GetRowHeights,doc="See `GetRowHeights`")
2131d850 12796_core_.FlexGridSizer_swigregister(FlexGridSizer)
d14a1e28 12797
e505d15e
RD		 12798class StdDialogButtonSizer(BoxSizer):
12799 """
12800 A special sizer that knows how to order and position standard buttons
12801 in order to conform to the current platform's standards. You simply
12802 need to add each `wx.Button` to the sizer, and be sure to create the
53aa7709 12803 buttons using the standard ID's. Then call `Realize` and the sizer
e505d15e
RD		 12804 will take care of the rest.
12805
12806 """
0085ce49
RD		 12807 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12808 __repr__ = _swig_repr
12809 def __init__(self, *args, **kwargs):
e505d15e 12810 """__init__(self) -> StdDialogButtonSizer"""
0085ce49 12811 _core_.StdDialogButtonSizer_swiginit(self,_core_.new_StdDialogButtonSizer(*args, **kwargs))
e505d15e
RD		 12812 def AddButton(*args, **kwargs):
12813 """
12814 AddButton(self, wxButton button)
12815
12816 Use this to add the buttons to this sizer. Do not use the `Add`
12817 method in the base class.
12818 """
12819 return _core_.StdDialogButtonSizer_AddButton(*args, **kwargs)
12820
53aa7709 12821 def Realize(*args, **kwargs):
e505d15e 12822 """
53aa7709 12823 Realize(self)
e505d15e
RD		 12824
12825 This funciton needs to be called after all the buttons have been added
12826 to the sizer. It will reorder them and position them in a platform
12827 specifc manner.
12828 """
53aa7709 12829 return _core_.StdDialogButtonSizer_Realize(*args, **kwargs)
51b83b37
RD		 12830
12831 def SetAffirmativeButton(*args, **kwargs):
12832 """SetAffirmativeButton(self, wxButton button)"""
12833 return _core_.StdDialogButtonSizer_SetAffirmativeButton(*args, **kwargs)
12834
12835 def SetNegativeButton(*args, **kwargs):
12836 """SetNegativeButton(self, wxButton button)"""
12837 return _core_.StdDialogButtonSizer_SetNegativeButton(*args, **kwargs)
12838
12839 def SetCancelButton(*args, **kwargs):
12840 """SetCancelButton(self, wxButton button)"""
12841 return _core_.StdDialogButtonSizer_SetCancelButton(*args, **kwargs)
e505d15e
RD		 12842
12843 def GetAffirmativeButton(*args, **kwargs):
12844 """GetAffirmativeButton(self) -> wxButton"""
12845 return _core_.StdDialogButtonSizer_GetAffirmativeButton(*args, **kwargs)
12846
12847 def GetApplyButton(*args, **kwargs):
12848 """GetApplyButton(self) -> wxButton"""
12849 return _core_.StdDialogButtonSizer_GetApplyButton(*args, **kwargs)
12850
12851 def GetNegativeButton(*args, **kwargs):
12852 """GetNegativeButton(self) -> wxButton"""
12853 return _core_.StdDialogButtonSizer_GetNegativeButton(*args, **kwargs)
12854
12855 def GetCancelButton(*args, **kwargs):
12856 """GetCancelButton(self) -> wxButton"""
12857 return _core_.StdDialogButtonSizer_GetCancelButton(*args, **kwargs)
12858
12859 def GetHelpButton(*args, **kwargs):
12860 """GetHelpButton(self) -> wxButton"""
12861 return _core_.StdDialogButtonSizer_GetHelpButton(*args, **kwargs)
12862
33d6fd3b
RD		 12863 AffirmativeButton = property(GetAffirmativeButton,SetAffirmativeButton,doc="See `GetAffirmativeButton` and `SetAffirmativeButton`")
12864 ApplyButton = property(GetApplyButton,doc="See `GetApplyButton`")
12865 CancelButton = property(GetCancelButton,SetCancelButton,doc="See `GetCancelButton` and `SetCancelButton`")
12866 HelpButton = property(GetHelpButton,doc="See `GetHelpButton`")
12867 NegativeButton = property(GetNegativeButton,SetNegativeButton,doc="See `GetNegativeButton` and `SetNegativeButton`")
2131d850 12868_core_.StdDialogButtonSizer_swigregister(StdDialogButtonSizer)
e505d15e 12869
d14a1e28
RD		 12870#---------------------------------------------------------------------------
12871
12872class GBPosition(object):
248ed943
RD		 12873 """
12874 This class represents the position of an item in a virtual grid of
12875 rows and columns managed by a `wx.GridBagSizer`. wxPython has
12876 typemaps that will automatically convert from a 2-element sequence of
12877 integers to a wx.GBPosition, so you can use the more pythonic
12878 representation of the position nearly transparently in Python code.
12879 """
0085ce49
RD		 12880 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12881 __repr__ = _swig_repr
12882 def __init__(self, *args, **kwargs):
248ed943
RD		 12883 """
12884 __init__(self, int row=0, int col=0) -> GBPosition
12885
12886 This class represents the position of an item in a virtual grid of
12887 rows and columns managed by a `wx.GridBagSizer`. wxPython has
12888 typemaps that will automatically convert from a 2-element sequence of
12889 integers to a wx.GBPosition, so you can use the more pythonic
12890 representation of the position nearly transparently in Python code.
12891 """
0085ce49
RD		 12892 _core_.GBPosition_swiginit(self,_core_.new_GBPosition(*args, **kwargs))
12893 __swig_destroy__ = _core_.delete_GBPosition
12894 __del__ = lambda self : None;
e811c8ce 12895 def GetRow(*args, **kwargs):
a95a7133 12896 """GetRow(self) -> int"""
54f9ee45 12897 return _core_.GBPosition_GetRow(*args, **kwargs)
e811c8ce
RD		 12898
12899 def GetCol(*args, **kwargs):
a95a7133 12900 """GetCol(self) -> int"""
54f9ee45 12901 return _core_.GBPosition_GetCol(*args, **kwargs)
e811c8ce
RD		 12902
12903 def SetRow(*args, **kwargs):
a95a7133 12904 """SetRow(self, int row)"""
54f9ee45 12905 return _core_.GBPosition_SetRow(*args, **kwargs)
e811c8ce
RD		 12906
12907 def SetCol(*args, **kwargs):
a95a7133 12908 """SetCol(self, int col)"""
54f9ee45 12909 return _core_.GBPosition_SetCol(*args, **kwargs)
e811c8ce
RD		 12910
12911 def __eq__(*args, **kwargs):
e9d6f3a4
RD		 12912 """
12913 __eq__(self, PyObject other) -> bool
12914
12915 Compare GBPosition for equality.
12916 """
54f9ee45 12917 return _core_.GBPosition___eq__(*args, **kwargs)
e811c8ce
RD		 12918
12919 def __ne__(*args, **kwargs):
e9d6f3a4
RD		 12920 """
12921 __ne__(self, PyObject other) -> bool
12922
12923 Compare GBPosition for inequality.
12924 """
54f9ee45 12925 return _core_.GBPosition___ne__(*args, **kwargs)
e811c8ce
RD		 12926
12927 def Set(*args, **kwargs):
a95a7133 12928 """Set(self, int row=0, int col=0)"""
54f9ee45 12929 return _core_.GBPosition_Set(*args, **kwargs)
e811c8ce
RD		 12930
12931 def Get(*args, **kwargs):
a95a7133 12932 """Get(self) -> PyObject"""
54f9ee45 12933 return _core_.GBPosition_Get(*args, **kwargs)
e811c8ce 12934
41e2b43e 12935 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
e811c8ce
RD		 12936 def __str__(self): return str(self.Get())
12937 def __repr__(self): return 'wx.GBPosition'+str(self.Get())
12938 def __len__(self): return len(self.Get())
12939 def __getitem__(self, index): return self.Get()[index]
d14a1e28
RD		 12940 def __setitem__(self, index, val):
12941 if index == 0: self.SetRow(val)
12942 elif index == 1: self.SetCol(val)
12943 else: raise IndexError
e811c8ce 12944 def __nonzero__(self): return self.Get() != (0,0)
74e96f3d
RD		 12945 __safe_for_unpickling__ = True
12946 def __reduce__(self): return (wx.GBPosition, self.Get())
d14a1e28
RD		 12947
12948 row = property(GetRow, SetRow)
12949 col = property(GetCol, SetCol)
12950
2131d850 12951_core_.GBPosition_swigregister(GBPosition)
d14a1e28
RD		 12952
12953class GBSpan(object):
248ed943
RD		 12954 """
12955 This class is used to hold the row and column spanning attributes of
12956 items in a `wx.GridBagSizer`. wxPython has typemaps that will
12957 automatically convert from a 2-element sequence of integers to a
12958 wx.GBSpan, so you can use the more pythonic representation of the span
12959 nearly transparently in Python code.
12960
12961 """
0085ce49
RD		 12962 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12963 __repr__ = _swig_repr
12964 def __init__(self, *args, **kwargs):
248ed943
RD		 12965 """
12966 __init__(self, int rowspan=1, int colspan=1) -> GBSpan
12967
12968 Construct a new wxGBSpan, optionally setting the rowspan and
12969 colspan. The default is (1,1). (Meaning that the item occupies one
12970 cell in each direction.
12971 """
0085ce49
RD		 12972 _core_.GBSpan_swiginit(self,_core_.new_GBSpan(*args, **kwargs))
12973 __swig_destroy__ = _core_.delete_GBSpan
12974 __del__ = lambda self : None;
e811c8ce 12975 def GetRowspan(*args, **kwargs):
a95a7133 12976 """GetRowspan(self) -> int"""
54f9ee45 12977 return _core_.GBSpan_GetRowspan(*args, **kwargs)
e811c8ce
RD		 12978
12979 def GetColspan(*args, **kwargs):
a95a7133 12980 """GetColspan(self) -> int"""
54f9ee45 12981 return _core_.GBSpan_GetColspan(*args, **kwargs)
e811c8ce
RD		 12982
12983 def SetRowspan(*args, **kwargs):
a95a7133 12984 """SetRowspan(self, int rowspan)"""
54f9ee45 12985 return _core_.GBSpan_SetRowspan(*args, **kwargs)
e811c8ce
RD		 12986
12987 def SetColspan(*args, **kwargs):
a95a7133 12988 """SetColspan(self, int colspan)"""
54f9ee45 12989 return _core_.GBSpan_SetColspan(*args, **kwargs)
e811c8ce
RD		 12990
12991 def __eq__(*args, **kwargs):
e9d6f3a4
RD		 12992 """
12993 __eq__(self, PyObject other) -> bool
12994
12995 Compare wxGBSpan for equality.
12996 """
54f9ee45 12997 return _core_.GBSpan___eq__(*args, **kwargs)
e811c8ce
RD		 12998
12999 def __ne__(*args, **kwargs):
e9d6f3a4
RD		 13000 """
13001 __ne__(self, PyObject other) -> bool
13002
13003 Compare GBSpan for inequality.
13004 """
54f9ee45 13005 return _core_.GBSpan___ne__(*args, **kwargs)
e811c8ce
RD		 13006
13007 def Set(*args, **kwargs):
a95a7133 13008 """Set(self, int rowspan=1, int colspan=1)"""
54f9ee45 13009 return _core_.GBSpan_Set(*args, **kwargs)
e811c8ce
RD		 13010
13011 def Get(*args, **kwargs):
a95a7133 13012 """Get(self) -> PyObject"""
54f9ee45 13013 return _core_.GBSpan_Get(*args, **kwargs)
e811c8ce 13014
41e2b43e 13015 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
e811c8ce
RD		 13016 def __str__(self): return str(self.Get())
13017 def __repr__(self): return 'wx.GBSpan'+str(self.Get())
13018 def __len__(self): return len(self.Get())
13019 def __getitem__(self, index): return self.Get()[index]
d14a1e28
RD		 13020 def __setitem__(self, index, val):
13021 if index == 0: self.SetRowspan(val)
13022 elif index == 1: self.SetColspan(val)
13023 else: raise IndexError
e811c8ce 13024 def __nonzero__(self): return self.Get() != (0,0)
74e96f3d
RD		 13025 __safe_for_unpickling__ = True
13026 def __reduce__(self): return (wx.GBSpan, self.Get())
d14a1e28
RD		 13027
13028 rowspan = property(GetRowspan, SetRowspan)
13029 colspan = property(GetColspan, SetColspan)
13030
2131d850 13031_core_.GBSpan_swigregister(GBSpan)
d14a1e28
RD		 13032
13033class GBSizerItem(SizerItem):
248ed943
RD		 13034 """
13035 The wx.GBSizerItem class is used to track the additional data about
13036 items in a `wx.GridBagSizer` such as the item's position in the grid
13037 and how many rows or columns it spans.
13038
13039 """
0085ce49
RD		 13040 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
13041 __repr__ = _swig_repr
13042 def __init__(self, *args, **kwargs):
248ed943
RD		 13043 """
13044 __init__(self) -> GBSizerItem
13045
13046 Constructs an empty wx.GBSizerItem. Either a window, sizer or spacer
13047 size will need to be set, as well as a position and span before this
13048 item can be used in a Sizer.
13049
13050 You will probably never need to create a wx.GBSizerItem directly as they
13051 are created automatically when the sizer's Add method is called.
13052 """
0085ce49
RD		 13053 _core_.GBSizerItem_swiginit(self,_core_.new_GBSizerItem(*args, **kwargs))
13054 __swig_destroy__ = _core_.delete_GBSizerItem
13055 __del__ = lambda self : None;
e811c8ce 13056 def GetPos(*args, **kwargs):
248ed943
RD		 13057 """
13058 GetPos(self) -> GBPosition
13059
13060 Get the grid position of the item
13061 """
54f9ee45 13062 return _core_.GBSizerItem_GetPos(*args, **kwargs)
e811c8ce
RD		 13063
13064 def GetPosTuple(self): return self.GetPos().Get()
13065 def GetSpan(*args, **kwargs):
248ed943
RD		 13066 """
13067 GetSpan(self) -> GBSpan
13068
13069 Get the row and column spanning of the item
13070 """
54f9ee45 13071 return _core_.GBSizerItem_GetSpan(*args, **kwargs)
e811c8ce
RD		 13072
13073 def GetSpanTuple(self): return self.GetSpan().Get()
13074 def SetPos(*args, **kwargs):
248ed943
RD		 13075 """
13076 SetPos(self, GBPosition pos) -> bool
13077
13078 If the item is already a member of a sizer then first ensure that
13079 there is no other item that would intersect with this one at the new
13080 position, then set the new position. Returns True if the change is
13081 successful and after the next Layout() the item will be moved.
13082 """
54f9ee45 13083 return _core_.GBSizerItem_SetPos(*args, **kwargs)
e811c8ce
RD		 13084
13085 def SetSpan(*args, **kwargs):
248ed943
RD		 13086 """
13087 SetSpan(self, GBSpan span) -> bool
13088
13089 If the item is already a member of a sizer then first ensure that
13090 there is no other item that would intersect with this one with its new
13091 spanning size, then set the new spanning. Returns True if the change
13092 is successful and after the next Layout() the item will be resized.
13093
13094 """
54f9ee45 13095 return _core_.GBSizerItem_SetSpan(*args, **kwargs)
e811c8ce 13096
248ed943 13097 def Intersects(*args, **kwargs):
0df68c9f 13098 """
a95a7133 13099 Intersects(self, GBSizerItem other) -> bool
248ed943
RD		 13100
13101 Returns True if this item and the other item instersect.
0df68c9f 13102 """
248ed943
RD		 13103 return _core_.GBSizerItem_Intersects(*args, **kwargs)
13104
13105 def IntersectsPos(*args, **kwargs):
13106 """
13107 IntersectsPos(self, GBPosition pos, GBSpan span) -> bool
13108
13109 Returns True if the given pos/span would intersect with this item.
13110 """
13111 return _core_.GBSizerItem_IntersectsPos(*args, **kwargs)
e811c8ce
RD		 13112
13113 def GetEndPos(*args, **kwargs):
248ed943
RD		 13114 """
13115 GetEndPos(self) -> GBPosition
13116
13117 Get the row and column of the endpoint of this item.
13118 """
54f9ee45 13119 return _core_.GBSizerItem_GetEndPos(*args, **kwargs)
e811c8ce
RD		 13120
13121 def GetGBSizer(*args, **kwargs):
248ed943
RD		 13122 """
13123 GetGBSizer(self) -> GridBagSizer
13124
13125 Get the sizer this item is a member of.
13126 """
54f9ee45 13127 return _core_.GBSizerItem_GetGBSizer(*args, **kwargs)
e811c8ce
RD		 13128
13129 def SetGBSizer(*args, **kwargs):
248ed943
RD		 13130 """
13131 SetGBSizer(self, GridBagSizer sizer)
13132
13133 Set the sizer this item is a member of.
13134 """
54f9ee45 13135 return _core_.GBSizerItem_SetGBSizer(*args, **kwargs)
e811c8ce 13136
97ab0f6a
RD		 13137 EndPos = property(GetEndPos,doc="See `GetEndPos`")
13138 GBSizer = property(GetGBSizer,SetGBSizer,doc="See `GetGBSizer` and `SetGBSizer`")
13139 Pos = property(GetPos,SetPos,doc="See `GetPos` and `SetPos`")
13140 Span = property(GetSpan,SetSpan,doc="See `GetSpan` and `SetSpan`")
2131d850 13141_core_.GBSizerItem_swigregister(GBSizerItem)
d14a1e28
RD		 13142DefaultSpan = cvar.DefaultSpan
13143
13144def GBSizerItemWindow(*args, **kwargs):
0df68c9f
RD		 13145 """
13146 GBSizerItemWindow(Window window, GBPosition pos, GBSpan span, int flag,
248ed943
RD		 13147 int border, PyObject userData=None) -> GBSizerItem
13148
13149 Construct a `wx.GBSizerItem` for a window.
0df68c9f 13150 """
54f9ee45 13151 val = _core_.new_GBSizerItemWindow(*args, **kwargs)
d14a1e28
RD		 13152 return val
13153
13154def GBSizerItemSizer(*args, **kwargs):
0df68c9f
RD		 13155 """
13156 GBSizerItemSizer(Sizer sizer, GBPosition pos, GBSpan span, int flag,
248ed943
RD		 13157 int border, PyObject userData=None) -> GBSizerItem
13158
13159 Construct a `wx.GBSizerItem` for a sizer
0df68c9f 13160 """
54f9ee45 13161 val = _core_.new_GBSizerItemSizer(*args, **kwargs)
d14a1e28
RD		 13162 return val
13163
13164def GBSizerItemSpacer(*args, **kwargs):
0df68c9f
RD		 13165 """
13166 GBSizerItemSpacer(int width, int height, GBPosition pos, GBSpan span,
248ed943
RD		 13167 int flag, int border, PyObject userData=None) -> GBSizerItem
13168
13169 Construct a `wx.GBSizerItem` for a spacer.
0df68c9f 13170 """
54f9ee45 13171 val = _core_.new_GBSizerItemSpacer(*args, **kwargs)
d14a1e28
RD		 13172 return val
13173
13174class GridBagSizer(FlexGridSizer):
248ed943
RD		 13175 """
13176 A `wx.Sizer` that can lay out items in a virtual grid like a
13177 `wx.FlexGridSizer` but in this case explicit positioning of the items
13178 is allowed using `wx.GBPosition`, and items can optionally span more
13179 than one row and/or column using `wx.GBSpan`. The total size of the
13180 virtual grid is determined by the largest row and column that items are
13181 positioned at, adjusted for spanning.
13182
13183 """
0085ce49
RD		 13184 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
13185 __repr__ = _swig_repr
13186 def __init__(self, *args, **kwargs):
248ed943
RD		 13187 """
13188 __init__(self, int vgap=0, int hgap=0) -> GridBagSizer
13189
13190 Constructor, with optional parameters to specify the gap between the
13191 rows and columns.
13192 """
0085ce49 13193 _core_.GridBagSizer_swiginit(self,_core_.new_GridBagSizer(*args, **kwargs))
1823fbb4
RD		 13194 self._setOORInfo(self)
13195
e811c8ce 13196 def Add(*args, **kwargs):
0df68c9f 13197 """
248ed943 13198 Add(self, item, GBPosition pos, GBSpan span=DefaultSpan, int flag=0,
d3b6e4ff 13199 int border=0, userData=None) -> wx.GBSizerItem
248ed943
RD		 13200
13201 Adds an item to the sizer at the grid cell *pos*, optionally spanning
13202 more than one row or column as specified with *span*. The remaining
13203 args behave similarly to `wx.Sizer.Add`.
13204
13205 Returns True if the item was successfully placed at the given cell
13206 position, False if something was already there.
13207
0df68c9f 13208 """
54f9ee45 13209 return _core_.GridBagSizer_Add(*args, **kwargs)
e811c8ce
RD		 13210
13211 def AddItem(*args, **kwargs):
248ed943 13212 """
d3b6e4ff 13213 Add(self, GBSizerItem item) -> wx.GBSizerItem
248ed943
RD		 13214
13215 Add an item to the sizer using a `wx.GBSizerItem`. Returns True if
13216 the item was successfully placed at its given cell position, False if
13217 something was already there.
13218 """
54f9ee45 13219 return _core_.GridBagSizer_AddItem(*args, **kwargs)
e811c8ce 13220
84f85550
RD		 13221 def GetCellSize(*args, **kwargs):
13222 """
13223 GetCellSize(self, int row, int col) -> Size
13224
13225 Get the size of the specified cell, including hgap and
13226 vgap. Only valid after a Layout.
13227 """
13228 return _core_.GridBagSizer_GetCellSize(*args, **kwargs)
13229
e811c8ce 13230 def GetEmptyCellSize(*args, **kwargs):
248ed943
RD		 13231 """
13232 GetEmptyCellSize(self) -> Size
13233
13234 Get the size used for cells in the grid with no item.
13235 """
54f9ee45 13236 return _core_.GridBagSizer_GetEmptyCellSize(*args, **kwargs)
e811c8ce
RD		 13237
13238 def SetEmptyCellSize(*args, **kwargs):
248ed943
RD		 13239 """
13240 SetEmptyCellSize(self, Size sz)
13241
13242 Set the size used for cells in the grid with no item.
13243 """
54f9ee45 13244 return _core_.GridBagSizer_SetEmptyCellSize(*args, **kwargs)
e811c8ce
RD		 13245
13246 def GetItemPosition(*args):
0df68c9f 13247 """
248ed943
RD		 13248 GetItemPosition(self, item) -> GBPosition
13249
13250 Get the grid position of the specified *item* where *item* is either a
13251 window or subsizer that is a member of this sizer, or a zero-based
13252 index of an item.
0df68c9f 13253 """
54f9ee45 13254 return _core_.GridBagSizer_GetItemPosition(*args)
e811c8ce
RD		 13255
13256 def SetItemPosition(*args):
0df68c9f 13257 """
248ed943
RD		 13258 SetItemPosition(self, item, GBPosition pos) -> bool
13259
13260 Set the grid position of the specified *item* where *item* is either a
13261 window or subsizer that is a member of this sizer, or a zero-based
13262 index of an item. Returns True on success. If the move is not
13263 allowed (because an item is already there) then False is returned.
13264
0df68c9f 13265 """
54f9ee45 13266 return _core_.GridBagSizer_SetItemPosition(*args)
e811c8ce
RD		 13267
13268 def GetItemSpan(*args):
0df68c9f 13269 """
248ed943
RD		 13270 GetItemSpan(self, item) -> GBSpan
13271
13272 Get the row/col spanning of the specified *item* where *item* is
13273 either a window or subsizer that is a member of this sizer, or a
13274 zero-based index of an item.
0df68c9f 13275 """
54f9ee45 13276 return _core_.GridBagSizer_GetItemSpan(*args)
e811c8ce
RD		 13277
13278 def SetItemSpan(*args):
0df68c9f 13279 """
248ed943
RD		 13280 SetItemSpan(self, item, GBSpan span) -> bool
13281
13282 Set the row/col spanning of the specified *item* where *item* is
13283 either a window or subsizer that is a member of this sizer, or a
13284 zero-based index of an item. Returns True on success. If the move is
13285 not allowed (because an item is already there) then False is returned.
0df68c9f 13286 """
54f9ee45 13287 return _core_.GridBagSizer_SetItemSpan(*args)
e811c8ce
RD		 13288
13289 def FindItem(*args):
0df68c9f 13290 """
248ed943
RD		 13291 FindItem(self, item) -> GBSizerItem
13292
13293 Find the sizer item for the given window or subsizer, returns None if
13294 not found. (non-recursive)
0df68c9f 13295 """
54f9ee45 13296 return _core_.GridBagSizer_FindItem(*args)
e811c8ce
RD		 13297
13298 def FindItemAtPosition(*args, **kwargs):
248ed943
RD		 13299 """
13300 FindItemAtPosition(self, GBPosition pos) -> GBSizerItem
13301
13302 Return the sizer item for the given grid cell, or None if there is no
13303 item at that position. (non-recursive)
13304 """
54f9ee45 13305 return _core_.GridBagSizer_FindItemAtPosition(*args, **kwargs)
e811c8ce
RD		 13306
13307 def FindItemAtPoint(*args, **kwargs):
248ed943
RD		 13308 """
13309 FindItemAtPoint(self, Point pt) -> GBSizerItem
13310
13311 Return the sizer item located at the point given in *pt*, or None if
13312 there is no item at that point. The (x,y) coordinates in pt correspond
13313 to the client coordinates of the window using the sizer for
13314 layout. (non-recursive)
13315 """
54f9ee45 13316 return _core_.GridBagSizer_FindItemAtPoint(*args, **kwargs)
e811c8ce 13317
248ed943
RD		 13318 def CheckForIntersection(*args, **kwargs):
13319 """
13320 CheckForIntersection(self, GBSizerItem item, GBSizerItem excludeItem=None) -> bool
e811c8ce 13321
248ed943
RD		 13322 Look at all items and see if any intersect (or would overlap) the
13323 given *item*. Returns True if so, False if there would be no overlap.
13324 If an *excludeItem* is given then it will not be checked for
13325 intersection, for example it may be the item we are checking the
13326 position of.
e811c8ce 13327
248ed943
RD		 13328 """
13329 return _core_.GridBagSizer_CheckForIntersection(*args, **kwargs)
e811c8ce 13330
248ed943 13331 def CheckForIntersectionPos(*args, **kwargs):
0df68c9f 13332 """
248ed943
RD		 13333 CheckForIntersectionPos(self, GBPosition pos, GBSpan span, GBSizerItem excludeItem=None) -> bool
13334
13335 Look at all items and see if any intersect (or would overlap) the
13336 given position and span. Returns True if so, False if there would be
13337 no overlap. If an *excludeItem* is given then it will not be checked
13338 for intersection, for example it may be the item we are checking the
13339 position of.
0df68c9f 13340 """
248ed943 13341 return _core_.GridBagSizer_CheckForIntersectionPos(*args, **kwargs)
e811c8ce 13342
2131d850 13343_core_.GridBagSizer_swigregister(GridBagSizer)
d14a1e28
RD		 13344
13345#---------------------------------------------------------------------------
13346
54f9ee45
RD		 13347Left = _core_.Left
13348Top = _core_.Top
13349Right = _core_.Right
13350Bottom = _core_.Bottom
13351Width = _core_.Width
13352Height = _core_.Height
13353Centre = _core_.Centre
13354Center = _core_.Center
13355CentreX = _core_.CentreX
13356CentreY = _core_.CentreY
13357Unconstrained = _core_.Unconstrained
13358AsIs = _core_.AsIs
13359PercentOf = _core_.PercentOf
13360Above = _core_.Above
13361Below = _core_.Below
13362LeftOf = _core_.LeftOf
13363RightOf = _core_.RightOf
13364SameAs = _core_.SameAs
13365Absolute = _core_.Absolute
d14a1e28 13366class IndividualLayoutConstraint(Object):
15afbcd0 13367 """
41e2b43e
RD		 13368 Objects of this class are stored in the `wx.LayoutConstraints` class as
13369 one of eight possible constraints that a window can be involved in.
13370 You will never need to create an instance of
13371 wx.IndividualLayoutConstraint, rather you should create a
13372 `wx.LayoutConstraints` instance and use the individual contstraints
15afbcd0 13373 that it contains.
15afbcd0 13374 """
0085ce49
RD		 13375 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
13376 def __init__(self): raise AttributeError, "No constructor defined"
13377 __repr__ = _swig_repr
e811c8ce 13378 def Set(*args, **kwargs):
41e2b43e
RD		 13379 """
13380 Set(self, int rel, Window otherW, int otherE, int val=0, int marg=wxLAYOUT_DEFAULT_MARGIN)
13381
13382 Sets the properties of the constraint. Normally called by one of the
13383 convenience functions such as Above, RightOf, SameAs.
13384 """
54f9ee45 13385 return _core_.IndividualLayoutConstraint_Set(*args, **kwargs)
e811c8ce
RD		 13386
13387 def LeftOf(*args, **kwargs):
15afbcd0 13388 """
a95a7133 13389 LeftOf(self, Window sibling, int marg=0)
15afbcd0 13390
41e2b43e
RD		 13391 Constrains this edge to be to the left of the given window, with an
13392 optional margin. Implicitly, this is relative to the left edge of the
13393 other window.
15afbcd0 13394 """
54f9ee45 13395 return _core_.IndividualLayoutConstraint_LeftOf(*args, **kwargs)
e811c8ce
RD		 13396
13397 def RightOf(*args, **kwargs):
15afbcd0 13398 """
a95a7133 13399 RightOf(self, Window sibling, int marg=0)
15afbcd0 13400
41e2b43e
RD		 13401 Constrains this edge to be to the right of the given window, with an
13402 optional margin. Implicitly, this is relative to the right edge of the
13403 other window.
15afbcd0 13404 """
54f9ee45 13405 return _core_.IndividualLayoutConstraint_RightOf(*args, **kwargs)
e811c8ce
RD		 13406
13407 def Above(*args, **kwargs):
15afbcd0 13408 """
a95a7133 13409 Above(self, Window sibling, int marg=0)
15afbcd0 13410
41e2b43e
RD		 13411 Constrains this edge to be above the given window, with an optional
13412 margin. Implicitly, this is relative to the top edge of the other
13413 window.
15afbcd0 13414 """
54f9ee45 13415 return _core_.IndividualLayoutConstraint_Above(*args, **kwargs)
e811c8ce
RD		 13416
13417 def Below(*args, **kwargs):
15afbcd0 13418 """
a95a7133 13419 Below(self, Window sibling, int marg=0)
15afbcd0 13420
41e2b43e
RD		 13421 Constrains this edge to be below the given window, with an optional
13422 margin. Implicitly, this is relative to the bottom edge of the other
13423 window.
15afbcd0 13424 """
54f9ee45 13425 return _core_.IndividualLayoutConstraint_Below(*args, **kwargs)
e811c8ce
RD		 13426
13427 def SameAs(*args, **kwargs):
15afbcd0 13428 """
a95a7133 13429 SameAs(self, Window otherW, int edge, int marg=0)
15afbcd0 13430
41e2b43e
RD		 13431 Constrains this edge or dimension to be to the same as the edge of the
13432 given window, with an optional margin.
15afbcd0 13433 """
54f9ee45 13434 return _core_.IndividualLayoutConstraint_SameAs(*args, **kwargs)
e811c8ce
RD		 13435
13436 def PercentOf(*args, **kwargs):
15afbcd0 13437 """
a95a7133 13438 PercentOf(self, Window otherW, int wh, int per)
15afbcd0 13439
41e2b43e
RD		 13440 Constrains this edge or dimension to be to a percentage of the given
13441 window, with an optional margin.
15afbcd0 13442 """
54f9ee45 13443 return _core_.IndividualLayoutConstraint_PercentOf(*args, **kwargs)
e811c8ce
RD		 13444
13445 def Absolute(*args, **kwargs):
15afbcd0 13446 """
a95a7133 13447 Absolute(self, int val)
15afbcd0 13448
41e2b43e 13449 Constrains this edge or dimension to be the given absolute value.
15afbcd0 13450 """
54f9ee45 13451 return _core_.IndividualLayoutConstraint_Absolute(*args, **kwargs)
e811c8ce
RD		 13452
13453 def Unconstrained(*args, **kwargs):
15afbcd0 13454 """
a95a7133 13455 Unconstrained(self)
15afbcd0 13456
41e2b43e
RD		 13457 Sets this edge or dimension to be unconstrained, that is, dependent on
13458 other edges and dimensions from which this value can be deduced.
15afbcd0 13459 """
54f9ee45 13460 return _core_.IndividualLayoutConstraint_Unconstrained(*args, **kwargs)
e811c8ce
RD		 13461
13462 def AsIs(*args, **kwargs):
15afbcd0 13463 """
a95a7133 13464 AsIs(self)
15afbcd0 13465
41e2b43e
RD		 13466 Sets this edge or constraint to be whatever the window's value is at
13467 the moment. If either of the width and height constraints are *as is*,
13468 the window will not be resized, but moved instead. This is important
13469 when considering panel items which are intended to have a default
13470 size, such as a button, which may take its size from the size of the
13471 button label.
15afbcd0 13472 """
54f9ee45 13473 return _core_.IndividualLayoutConstraint_AsIs(*args, **kwargs)
e811c8ce
RD		 13474
13475 def GetOtherWindow(*args, **kwargs):
a95a7133 13476 """GetOtherWindow(self) -> Window"""
54f9ee45 13477 return _core_.IndividualLayoutConstraint_GetOtherWindow(*args, **kwargs)
e811c8ce
RD		 13478
13479 def GetMyEdge(*args, **kwargs):
a95a7133 13480 """GetMyEdge(self) -> int"""
54f9ee45 13481 return _core_.IndividualLayoutConstraint_GetMyEdge(*args, **kwargs)
e811c8ce
RD		 13482
13483 def SetEdge(*args, **kwargs):
a95a7133 13484 """SetEdge(self, int which)"""
54f9ee45 13485 return _core_.IndividualLayoutConstraint_SetEdge(*args, **kwargs)
e811c8ce
RD		 13486
13487 def SetValue(*args, **kwargs):
a95a7133 13488 """SetValue(self, int v)"""
54f9ee45 13489 return _core_.IndividualLayoutConstraint_SetValue(*args, **kwargs)
e811c8ce
RD		 13490
13491 def GetMargin(*args, **kwargs):
a95a7133 13492 """GetMargin(self) -> int"""
54f9ee45 13493 return _core_.IndividualLayoutConstraint_GetMargin(*args, **kwargs)
e811c8ce
RD		 13494
13495 def SetMargin(*args, **kwargs):
a95a7133 13496 """SetMargin(self, int m)"""
54f9ee45 13497 return _core_.IndividualLayoutConstraint_SetMargin(*args, **kwargs)
e811c8ce
RD		 13498
13499 def GetValue(*args, **kwargs):
a95a7133 13500 """GetValue(self) -> int"""
54f9ee45 13501 return _core_.IndividualLayoutConstraint_GetValue(*args, **kwargs)
e811c8ce
RD		 13502
13503 def GetPercent(*args, **kwargs):
a95a7133 13504 """GetPercent(self) -> int"""
54f9ee45 13505 return _core_.IndividualLayoutConstraint_GetPercent(*args, **kwargs)
e811c8ce
RD		 13506
13507 def GetOtherEdge(*args, **kwargs):
a95a7133 13508 """GetOtherEdge(self) -> int"""
54f9ee45 13509 return _core_.IndividualLayoutConstraint_GetOtherEdge(*args, **kwargs)
e811c8ce
RD		 13510
13511 def GetDone(*args, **kwargs):
a95a7133 13512 """GetDone(self) -> bool"""
54f9ee45 13513 return _core_.IndividualLayoutConstraint_GetDone(*args, **kwargs)
e811c8ce
RD		 13514
13515 def SetDone(*args, **kwargs):
a95a7133 13516 """SetDone(self, bool d)"""
54f9ee45 13517 return _core_.IndividualLayoutConstraint_SetDone(*args, **kwargs)
e811c8ce
RD		 13518
13519 def GetRelationship(*args, **kwargs):
a95a7133 13520 """GetRelationship(self) -> int"""
54f9ee45 13521 return _core_.IndividualLayoutConstraint_GetRelationship(*args, **kwargs)
e811c8ce
RD		 13522
13523 def SetRelationship(*args, **kwargs):
a95a7133 13524 """SetRelationship(self, int r)"""
54f9ee45 13525 return _core_.IndividualLayoutConstraint_SetRelationship(*args, **kwargs)
e811c8ce
RD		 13526
13527 def ResetIfWin(*args, **kwargs):
15afbcd0 13528 """
a95a7133 13529 ResetIfWin(self, Window otherW) -> bool
15afbcd0
RD		 13530
13531 Reset constraint if it mentions otherWin
13532 """
54f9ee45 13533 return _core_.IndividualLayoutConstraint_ResetIfWin(*args, **kwargs)
e811c8ce
RD		 13534
13535 def SatisfyConstraint(*args, **kwargs):
15afbcd0 13536 """
a95a7133 13537 SatisfyConstraint(self, LayoutConstraints constraints, Window win) -> bool
15afbcd0
RD		 13538
13539 Try to satisfy constraint
13540 """
54f9ee45 13541 return _core_.IndividualLayoutConstraint_SatisfyConstraint(*args, **kwargs)
e811c8ce
RD		 13542
13543 def GetEdge(*args, **kwargs):
15afbcd0 13544 """
a95a7133 13545 GetEdge(self, int which, Window thisWin, Window other) -> int
15afbcd0
RD		 13546
13547 Get the value of this edge or dimension, or if this
13548 is not determinable, -1.
13549 """
54f9ee45 13550 return _core_.IndividualLayoutConstraint_GetEdge(*args, **kwargs)
e811c8ce 13551
97ab0f6a
RD		 13552 Done = property(GetDone,SetDone,doc="See `GetDone` and `SetDone`")
13553 Margin = property(GetMargin,SetMargin,doc="See `GetMargin` and `SetMargin`")
13554 MyEdge = property(GetMyEdge,doc="See `GetMyEdge`")
13555 OtherEdge = property(GetOtherEdge,doc="See `GetOtherEdge`")
13556 OtherWindow = property(GetOtherWindow,doc="See `GetOtherWindow`")
13557 Percent = property(GetPercent,doc="See `GetPercent`")
13558 Relationship = property(GetRelationship,SetRelationship,doc="See `GetRelationship` and `SetRelationship`")
13559 Value = property(GetValue,SetValue,doc="See `GetValue` and `SetValue`")
2131d850 13560_core_.IndividualLayoutConstraint_swigregister(IndividualLayoutConstraint)
d14a1e28
RD		 13561
13562class LayoutConstraints(Object):
15afbcd0 13563 """
41e2b43e
RD		 13564 **Note:** constraints are now deprecated and you should use sizers
13565 instead.
15afbcd0 13566
41e2b43e
RD		 13567 Objects of this class can be associated with a window to define its
13568 layout constraints, with respect to siblings or its parent.
15afbcd0
RD		 13569
13570 The class consists of the following eight constraints of class
13571 wx.IndividualLayoutConstraint, some or all of which should be accessed
13572 directly to set the appropriate constraints.
13573
13574 * left: represents the left hand edge of the window
13575 * right: represents the right hand edge of the window
13576 * top: represents the top edge of the window
13577 * bottom: represents the bottom edge of the window
13578 * width: represents the width of the window
13579 * height: represents the height of the window
13580 * centreX: represents the horizontal centre point of the window
13581 * centreY: represents the vertical centre point of the window
13582
41e2b43e
RD		 13583 Most constraints are initially set to have the relationship
13584 wxUnconstrained, which means that their values should be calculated by
13585 looking at known constraints. The exceptions are width and height,
13586 which are set to wxAsIs to ensure that if the user does not specify a
13587 constraint, the existing width and height will be used, to be
13588 compatible with panel items which often have take a default size. If
13589 the constraint is ``wx.AsIs``, the dimension will not be changed.
13590
13591 :see: `wx.IndividualLayoutConstraint`, `wx.Window.SetConstraints`
15afbcd0
RD		 13592
13593 """
0085ce49
RD		 13594 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
13595 __repr__ = _swig_repr
54f9ee45
RD		 13596 left = property(_core_.LayoutConstraints_left_get)
13597 top = property(_core_.LayoutConstraints_top_get)
13598 right = property(_core_.LayoutConstraints_right_get)
13599 bottom = property(_core_.LayoutConstraints_bottom_get)
13600 width = property(_core_.LayoutConstraints_width_get)
13601 height = property(_core_.LayoutConstraints_height_get)
13602 centreX = property(_core_.LayoutConstraints_centreX_get)
13603 centreY = property(_core_.LayoutConstraints_centreY_get)
0085ce49 13604 def __init__(self, *args, **kwargs):
a95a7133 13605 """__init__(self) -> LayoutConstraints"""
0085ce49
RD		 13606 _core_.LayoutConstraints_swiginit(self,_core_.new_LayoutConstraints(*args, **kwargs))
13607 __swig_destroy__ = _core_.delete_LayoutConstraints
13608 __del__ = lambda self : None;
e811c8ce 13609 def SatisfyConstraints(*args, **kwargs):
6c3b4aae 13610 """SatisfyConstraints(Window win) -> (areSatisfied, noChanges)"""
54f9ee45 13611 return _core_.LayoutConstraints_SatisfyConstraints(*args, **kwargs)
e811c8ce
RD		 13612
13613 def AreSatisfied(*args, **kwargs):
a95a7133 13614 """AreSatisfied(self) -> bool"""
54f9ee45 13615 return _core_.LayoutConstraints_AreSatisfied(*args, **kwargs)
e811c8ce 13616
2131d850 13617_core_.LayoutConstraints_swigregister(LayoutConstraints)
d14a1e28
RD		 13618
13619#----------------------------------------------------------------------------
13620
322913ce 13621# Use Python's bool constants if available, make some if not
d14a1e28
RD		 13622try:
13623 True
13624except NameError:
322913ce
RD		 13625 __builtins__.True = 1==1
13626 __builtins__.False = 1==0
4f89f6a3
RD		 13627 def bool(value): return not not value
13628 __builtins__.bool = bool
d14a1e28 13629
d14a1e28
RD		 13630
13631
13632# workarounds for bad wxRTTI names
13633__wxPyPtrTypeMap['wxGauge95'] = 'wxGauge'
13634__wxPyPtrTypeMap['wxSlider95'] = 'wxSlider'
13635__wxPyPtrTypeMap['wxStatusBar95'] = 'wxStatusBar'
13636
13637
13638#----------------------------------------------------------------------------
13639# Load version numbers from __version__... Ensure that major and minor
7bc1e663 13640# versions are the same for both wxPython and wxWidgets.
d14a1e28
RD		 13641
13642from __version__ import *
13643__version__ = VERSION_STRING
13644
7bc1e663
RD		 13645assert MAJOR_VERSION == _core_.MAJOR_VERSION, "wxPython/wxWidgets version mismatch"
13646assert MINOR_VERSION == _core_.MINOR_VERSION, "wxPython/wxWidgets version mismatch"
54f9ee45 13647if RELEASE_VERSION != _core_.RELEASE_VERSION:
d14a1e28 13648 import warnings
7bc1e663 13649 warnings.warn("wxPython/wxWidgets release number mismatch")
d14a1e28
RD		 13650
13651#----------------------------------------------------------------------------
13652
70b7a5fe
RD		 13653# Set wxPython's default string<-->unicode conversion encoding from
13654# the locale, but only if Python's default hasn't been changed. (We
13655# assume that if the user has customized it already then that is the
13656# encoding we need to use as well.)
13657#
13658# The encoding selected here is used when string or unicode objects
13659# need to be converted in order to pass them to wxWidgets. Please be
13660# aware that the default encoding within the same locale may be
13661# slightly different on different platforms. For example, please see
e505d15e
RD		 13662# http://www.alanwood.net/demos/charsetdiffs.html for differences
13663# between the common latin/roman encodings.
396fb509
RD		 13664
13665default = _sys.getdefaultencoding()
13666if default == 'ascii':
13667 import locale
13668 import codecs
13669 try:
13670 default = locale.getdefaultlocale()[1]
13671 codecs.lookup(default)
70b7a5fe 13672 except (ValueError, LookupError, TypeError):
396fb509
RD		 13673 default = _sys.getdefaultencoding()
13674 del locale
13675 del codecs
5cbf236d
RD		 13676if default:
13677 wx.SetDefaultPyEncoding(default)
13678del default
5cbf236d
RD		 13679
13680#----------------------------------------------------------------------------
13681
d14a1e28
RD		 13682class PyDeadObjectError(AttributeError):
13683 pass
13684
d14a1e28
RD		 13685class _wxPyDeadObject(object):
13686 """
13687 Instances of wx objects that are OOR capable will have their __class__
13688 changed to this class when the C++ object is deleted. This should help
13689 prevent crashes due to referencing a bogus C++ pointer.
13690 """
13691 reprStr = "wxPython wrapper for DELETED %s object! (The C++ object no longer exists.)"
13692 attrStr = "The C++ part of the %s object has been deleted, attribute access no longer allowed."
13693
3a04f143 13694 def __repr__(self):
d14a1e28
RD		 13695 if not hasattr(self, "_name"):
13696 self._name = "[unknown]"
13697 return self.reprStr % self._name
13698
3a04f143 13699 def __getattr__(self, *args):
d14a1e28
RD		 13700 if not hasattr(self, "_name"):
13701 self._name = "[unknown]"
3a04f143
RD		 13702 raise PyDeadObjectError(self.attrStr % self._name)
13703
13704 def __nonzero__(self):
13705 return 0
13706
13707
13708
13709class PyUnbornObjectError(AttributeError):
13710 pass
13711
13712class _wxPyUnbornObject(object):
13713 """
54f9ee45 13714 Some stock objects are created when the wx._core module is
3a04f143
RD		 13715 imported, but their C++ instance is not created until the wx.App
13716 object is created and initialized. These object instances will
13717 temporarily have their __class__ changed to this class so an
13718 exception will be raised if they are used before the C++ instance
13719 is ready.
13720 """
13721
13722 reprStr = "wxPython wrapper for UNBORN object! (The C++ object is not initialized yet.)"
13723 attrStr = "The C++ part of this object has not been initialized, attribute access not allowed."
13724
13725 def __repr__(self):
13726 #if not hasattr(self, "_name"):
13727 # self._name = "[unknown]"
13728 return self.reprStr #% self._name
13729
13730 def __getattr__(self, *args):
13731 #if not hasattr(self, "_name"):
13732 # self._name = "[unknown]"
13733 raise PyUnbornObjectError(self.attrStr) # % self._name )
d14a1e28
RD		 13734
13735 def __nonzero__(self):
13736 return 0
13737
13738
13739#----------------------------------------------------------------------------
d14a1e28
RD		 13740
13741def CallAfter(callable, *args, **kw):
13742 """
13743 Call the specified function after the current and pending event
13744 handlers have been completed. This is also good for making GUI
61863841
RD		 13745 method calls from non-GUI threads. Any extra positional or
13746 keyword args are passed on to the callable when it is called.
13747
846c181b 13748 :see: `wx.CallLater`
d14a1e28
RD		 13749 """
13750 app = wx.GetApp()
dfbb5885 13751 assert app is not None, 'No wx.App created yet'
d14a1e28 13752
148275d3
RD		 13753 if not hasattr(app, "_CallAfterId"):
13754 app._CallAfterId = wx.NewEventType()
13755 app.Connect(-1, -1, app._CallAfterId,
13756 lambda event: event.callable(*event.args, **event.kw) )
d14a1e28 13757 evt = wx.PyEvent()
148275d3 13758 evt.SetEventType(app._CallAfterId)
d14a1e28
RD		 13759 evt.callable = callable
13760 evt.args = args
13761 evt.kw = kw
13762 wx.PostEvent(app, evt)
13763
d14a1e28
RD		 13764#----------------------------------------------------------------------------
13765
13766
846c181b 13767class CallLater:
d14a1e28 13768 """
8ac8dba0 13769 A convenience class for `wx.Timer`, that calls the given callable
d14a1e28
RD		 13770 object once after the given amount of milliseconds, passing any
13771 positional or keyword args. The return value of the callable is
61863841 13772 availbale after it has been run with the `GetResult` method.
d14a1e28
RD		 13773
13774 If you don't need to get the return value or restart the timer
13775 then there is no need to hold a reference to this object. It will
13776 hold a reference to itself while the timer is running (the timer
13777 has a reference to self.Notify) but the cycle will be broken when
846c181b 13778 the timer completes, automatically cleaning up the wx.CallLater
d14a1e28 13779 object.
61863841
RD		 13780
13781 :see: `wx.CallAfter`
d14a1e28
RD		 13782 """
13783 def __init__(self, millis, callable, *args, **kwargs):
13784 self.millis = millis
13785 self.callable = callable
13786 self.SetArgs(*args, **kwargs)
13787 self.runCount = 0
4276dc52 13788 self.running = False
d14a1e28
RD		 13789 self.hasRun = False
13790 self.result = None
13791 self.timer = None
13792 self.Start()
13793
13794 def __del__(self):
13795 self.Stop()
13796
13797
13798 def Start(self, millis=None, *args, **kwargs):
13799 """
13800 (Re)start the timer
13801 """
13802 self.hasRun = False
13803 if millis is not None:
13804 self.millis = millis
13805 if args or kwargs:
13806 self.SetArgs(*args, **kwargs)
13807 self.Stop()
13808 self.timer = wx.PyTimer(self.Notify)
13809 self.timer.Start(self.millis, wx.TIMER_ONE_SHOT)
4276dc52 13810 self.running = True
d14a1e28
RD		 13811 Restart = Start
13812
13813
13814 def Stop(self):
13815 """
13816 Stop and destroy the timer.
13817 """
13818 if self.timer is not None:
13819 self.timer.Stop()
13820 self.timer = None
13821
13822
13823 def GetInterval(self):
13824 if self.timer is not None:
13825 return self.timer.GetInterval()
13826 else:
13827 return 0
13828
13829
13830 def IsRunning(self):
13831 return self.timer is not None and self.timer.IsRunning()
13832
13833
13834 def SetArgs(self, *args, **kwargs):
13835 """
13836 (Re)set the args passed to the callable object. This is
13837 useful in conjunction with Restart if you want to schedule a
13838 new call to the same callable object but with different
13839 parameters.
13840 """
13841 self.args = args
13842 self.kwargs = kwargs
13843
13844
13845 def HasRun(self):
13846 return self.hasRun
13847
13848 def GetResult(self):
13849 return self.result
13850
13851 def Notify(self):
13852 """
13853 The timer has expired so call the callable.
13854 """
13855 if self.callable and getattr(self.callable, 'im_self', True):
13856 self.runCount += 1
4276dc52 13857 self.running = False
d14a1e28
RD		 13858 self.result = self.callable(*self.args, **self.kwargs)
13859 self.hasRun = True
4276dc52
RD		 13860 if not self.running:
13861 # if it wasn't restarted, then cleanup
13862 wx.CallAfter(self.Stop)
d14a1e28 13863
97ab0f6a
RD		 13864 Interval = property(GetInterval)
13865 Result = property(GetResult)
d14a1e28 13866
a95a7133 13867
846c181b 13868class FutureCall(CallLater):
b39fe951 13869 """A compatibility alias for `CallLater`."""
846c181b 13870
a95a7133
RD		 13871#----------------------------------------------------------------------------
13872# Control which items in this module should be documented by epydoc.
13873# We allow only classes and functions, which will help reduce the size
13874# of the docs by filtering out the zillions of constants, EVT objects,
13875# and etc that don't make much sense by themselves, but are instead
13876# documented (or will be) as part of the classes/functions/methods
13877# where they should be used.
13878
66c033b4
RD		 13879class __DocFilter:
13880 """
13881 A filter for epydoc that only allows non-Ptr classes and
34e0a3bb 13882 functions, in order to reduce the clutter in the API docs.
66c033b4
RD		 13883 """
13884 def __init__(self, globals):
13885 self._globals = globals
13886
13887 def __call__(self, name):
13888 import types
13889 obj = self._globals.get(name, None)
34e0a3bb
RD		 13890
13891 # only document classes and function
66c033b4
RD		 13892 if type(obj) not in [type, types.ClassType, types.FunctionType, types.BuiltinFunctionType]:
13893 return False
34e0a3bb
RD		 13894
13895 # skip other things that are private or will be documented as part of somethign else
0085ce49 13896 if name.startswith('_') or name.startswith('EVT') or name.endswith('_swigregister') or name.endswith('Ptr') :
66c033b4 13897 return False
34e0a3bb
RD		 13898
13899 # skip functions that are duplicates of static functions in a class
13900 if name.find('_') != -1:
13901 cls = self._globals.get(name.split('_')[0], None)
13902 methname = name.split('_')[1]
13903 if hasattr(cls, methname) and type(getattr(cls, methname)) is types.FunctionType:
13904 return False
13905
66c033b4 13906 return True
a95a7133 13907
d14a1e28
RD		 13908#----------------------------------------------------------------------------
13909#----------------------------------------------------------------------------
13910
13911# Import other modules in this package that should show up in the
13912# "core" wx namespace
54f9ee45
RD		 13913from _gdi import *
13914from _windows import *
13915from _controls import *
13916from _misc import *
d14a1e28
RD		 13917
13918#----------------------------------------------------------------------------
13919#----------------------------------------------------------------------------
13920
13921
32fe5131 13922
wxWidgets (Impactor)