]> git.saurik.com Git - wxWidgets.git/blame - wxPython/src/gtk/_core.py
Buffered DCs now take non-const bitmaps
[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
8f514ab4
RD
711 def IsSameAs(*args, **kwargs):
712 """
713 IsSameAs(self, Object p) -> bool
714
715 For wx.Objects that use C++ reference counting internally, this method
716 can be used to determine if two objects are referencing the same data
717 object.
718 """
719 return _core_.Object_IsSameAs(*args, **kwargs)
720
33d6fd3b 721 ClassName = property(GetClassName,doc="See `GetClassName`")
2131d850 722_core_.Object_swigregister(Object)
54f9ee45 723_wxPySetDictionary = _core_._wxPySetDictionary
54f9ee45 724cvar = _core_.cvar
196addbf 725EmptyString = cvar.EmptyString
d14a1e28
RD
726
727#---------------------------------------------------------------------------
728
54f9ee45
RD
729BITMAP_TYPE_INVALID = _core_.BITMAP_TYPE_INVALID
730BITMAP_TYPE_BMP = _core_.BITMAP_TYPE_BMP
731BITMAP_TYPE_ICO = _core_.BITMAP_TYPE_ICO
732BITMAP_TYPE_CUR = _core_.BITMAP_TYPE_CUR
733BITMAP_TYPE_XBM = _core_.BITMAP_TYPE_XBM
734BITMAP_TYPE_XBM_DATA = _core_.BITMAP_TYPE_XBM_DATA
735BITMAP_TYPE_XPM = _core_.BITMAP_TYPE_XPM
736BITMAP_TYPE_XPM_DATA = _core_.BITMAP_TYPE_XPM_DATA
737BITMAP_TYPE_TIF = _core_.BITMAP_TYPE_TIF
738BITMAP_TYPE_GIF = _core_.BITMAP_TYPE_GIF
739BITMAP_TYPE_PNG = _core_.BITMAP_TYPE_PNG
740BITMAP_TYPE_JPEG = _core_.BITMAP_TYPE_JPEG
741BITMAP_TYPE_PNM = _core_.BITMAP_TYPE_PNM
742BITMAP_TYPE_PCX = _core_.BITMAP_TYPE_PCX
743BITMAP_TYPE_PICT = _core_.BITMAP_TYPE_PICT
744BITMAP_TYPE_ICON = _core_.BITMAP_TYPE_ICON
745BITMAP_TYPE_ANI = _core_.BITMAP_TYPE_ANI
746BITMAP_TYPE_IFF = _core_.BITMAP_TYPE_IFF
8f514ab4 747BITMAP_TYPE_TGA = _core_.BITMAP_TYPE_TGA
54f9ee45
RD
748BITMAP_TYPE_MACCURSOR = _core_.BITMAP_TYPE_MACCURSOR
749BITMAP_TYPE_ANY = _core_.BITMAP_TYPE_ANY
750CURSOR_NONE = _core_.CURSOR_NONE
751CURSOR_ARROW = _core_.CURSOR_ARROW
752CURSOR_RIGHT_ARROW = _core_.CURSOR_RIGHT_ARROW
753CURSOR_BULLSEYE = _core_.CURSOR_BULLSEYE
754CURSOR_CHAR = _core_.CURSOR_CHAR
755CURSOR_CROSS = _core_.CURSOR_CROSS
756CURSOR_HAND = _core_.CURSOR_HAND
757CURSOR_IBEAM = _core_.CURSOR_IBEAM
758CURSOR_LEFT_BUTTON = _core_.CURSOR_LEFT_BUTTON
759CURSOR_MAGNIFIER = _core_.CURSOR_MAGNIFIER
760CURSOR_MIDDLE_BUTTON = _core_.CURSOR_MIDDLE_BUTTON
761CURSOR_NO_ENTRY = _core_.CURSOR_NO_ENTRY
762CURSOR_PAINT_BRUSH = _core_.CURSOR_PAINT_BRUSH
763CURSOR_PENCIL = _core_.CURSOR_PENCIL
764CURSOR_POINT_LEFT = _core_.CURSOR_POINT_LEFT
765CURSOR_POINT_RIGHT = _core_.CURSOR_POINT_RIGHT
766CURSOR_QUESTION_ARROW = _core_.CURSOR_QUESTION_ARROW
767CURSOR_RIGHT_BUTTON = _core_.CURSOR_RIGHT_BUTTON
768CURSOR_SIZENESW = _core_.CURSOR_SIZENESW
769CURSOR_SIZENS = _core_.CURSOR_SIZENS
770CURSOR_SIZENWSE = _core_.CURSOR_SIZENWSE
771CURSOR_SIZEWE = _core_.CURSOR_SIZEWE
772CURSOR_SIZING = _core_.CURSOR_SIZING
773CURSOR_SPRAYCAN = _core_.CURSOR_SPRAYCAN
774CURSOR_WAIT = _core_.CURSOR_WAIT
775CURSOR_WATCH = _core_.CURSOR_WATCH
776CURSOR_BLANK = _core_.CURSOR_BLANK
777CURSOR_DEFAULT = _core_.CURSOR_DEFAULT
778CURSOR_COPY_ARROW = _core_.CURSOR_COPY_ARROW
779CURSOR_ARROWWAIT = _core_.CURSOR_ARROWWAIT
780CURSOR_MAX = _core_.CURSOR_MAX
d14a1e28
RD
781#---------------------------------------------------------------------------
782
783class Size(object):
0df68c9f 784 """
41e2b43e 785 wx.Size is a useful data structure used to represent the size of
0085ce49
RD
786 something. It simply contains integer width and height
787 properties. In most places in wxPython where a wx.Size is
093d3ff1 788 expected a (width, height) tuple can be used instead.
0df68c9f 789 """
0085ce49
RD
790 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
791 __repr__ = _swig_repr
54f9ee45
RD
792 width = property(_core_.Size_width_get, _core_.Size_width_set)
793 height = property(_core_.Size_height_get, _core_.Size_height_set)
242b7b46 794 x = width; y = height
0085ce49 795 def __init__(self, *args, **kwargs):
0df68c9f 796 """
a95a7133 797 __init__(self, int w=0, int h=0) -> Size
e811c8ce 798
0df68c9f
RD
799 Creates a size object.
800 """
0085ce49
RD
801 _core_.Size_swiginit(self,_core_.new_Size(*args, **kwargs))
802 __swig_destroy__ = _core_.delete_Size
803 __del__ = lambda self : None;
e811c8ce 804 def __eq__(*args, **kwargs):
0df68c9f 805 """
e9d6f3a4 806 __eq__(self, PyObject other) -> bool
e811c8ce 807
0df68c9f
RD
808 Test for equality of wx.Size objects.
809 """
54f9ee45 810 return _core_.Size___eq__(*args, **kwargs)
e811c8ce
RD
811
812 def __ne__(*args, **kwargs):
0df68c9f 813 """
e9d6f3a4 814 __ne__(self, PyObject other) -> bool
e811c8ce 815
e9d6f3a4 816 Test for inequality of wx.Size objects.
0df68c9f 817 """
54f9ee45 818 return _core_.Size___ne__(*args, **kwargs)
e811c8ce
RD
819
820 def __add__(*args, **kwargs):
0df68c9f 821 """
a95a7133 822 __add__(self, Size sz) -> Size
e811c8ce 823
0df68c9f
RD
824 Add sz's proprties to this and return the result.
825 """
54f9ee45 826 return _core_.Size___add__(*args, **kwargs)
e811c8ce
RD
827
828 def __sub__(*args, **kwargs):
0df68c9f 829 """
a95a7133 830 __sub__(self, Size sz) -> Size
e811c8ce 831
0df68c9f
RD
832 Subtract sz's properties from this and return the result.
833 """
54f9ee45 834 return _core_.Size___sub__(*args, **kwargs)
e811c8ce
RD
835
836 def IncTo(*args, **kwargs):
0df68c9f 837 """
a95a7133 838 IncTo(self, Size sz)
e811c8ce 839
0df68c9f
RD
840 Increments this object so that both of its dimensions are not less
841 than the corresponding dimensions of the size.
842 """
54f9ee45 843 return _core_.Size_IncTo(*args, **kwargs)
e811c8ce
RD
844
845 def DecTo(*args, **kwargs):
0df68c9f 846 """
a95a7133 847 DecTo(self, Size sz)
e811c8ce 848
0df68c9f
RD
849 Decrements this object so that both of its dimensions are not greater
850 than the corresponding dimensions of the size.
851 """
54f9ee45 852 return _core_.Size_DecTo(*args, **kwargs)
e811c8ce 853
f5263701
RD
854 def IncBy(*args, **kwargs):
855 """IncBy(self, int dx, int dy)"""
856 return _core_.Size_IncBy(*args, **kwargs)
857
858 def DecBy(*args, **kwargs):
859 """DecBy(self, int dx, int dy)"""
860 return _core_.Size_DecBy(*args, **kwargs)
861
10044bf1
RD
862 def Scale(*args, **kwargs):
863 """
864 Scale(self, float xscale, float yscale)
865
866 Scales the dimensions of this object by the given factors.
867 """
868 return _core_.Size_Scale(*args, **kwargs)
869
e811c8ce 870 def Set(*args, **kwargs):
0df68c9f 871 """
a95a7133 872 Set(self, int w, int h)
e811c8ce 873
0df68c9f
RD
874 Set both width and height.
875 """
54f9ee45 876 return _core_.Size_Set(*args, **kwargs)
e811c8ce
RD
877
878 def SetWidth(*args, **kwargs):
a95a7133 879 """SetWidth(self, int w)"""
54f9ee45 880 return _core_.Size_SetWidth(*args, **kwargs)
e811c8ce
RD
881
882 def SetHeight(*args, **kwargs):
a95a7133 883 """SetHeight(self, int h)"""
54f9ee45 884 return _core_.Size_SetHeight(*args, **kwargs)
e811c8ce
RD
885
886 def GetWidth(*args, **kwargs):
a95a7133 887 """GetWidth(self) -> int"""
54f9ee45 888 return _core_.Size_GetWidth(*args, **kwargs)
e811c8ce
RD
889
890 def GetHeight(*args, **kwargs):
a95a7133 891 """GetHeight(self) -> int"""
54f9ee45 892 return _core_.Size_GetHeight(*args, **kwargs)
e811c8ce 893
74a57fcd
RD
894 def IsFullySpecified(*args, **kwargs):
895 """
a95a7133 896 IsFullySpecified(self) -> bool
74a57fcd
RD
897
898 Returns True if both components of the size are non-default values.
899 """
54f9ee45 900 return _core_.Size_IsFullySpecified(*args, **kwargs)
74a57fcd
RD
901
902 def SetDefaults(*args, **kwargs):
903 """
a95a7133 904 SetDefaults(self, Size size)
74a57fcd 905
41e2b43e
RD
906 Combine this size with the other one replacing the default components
907 of this object (i.e. equal to -1) with those of the other.
74a57fcd 908 """
54f9ee45 909 return _core_.Size_SetDefaults(*args, **kwargs)
74a57fcd 910
e811c8ce 911 def Get(*args, **kwargs):
0df68c9f
RD
912 """
913 Get() -> (width,height)
e811c8ce 914
0df68c9f
RD
915 Returns the width and height properties as a tuple.
916 """
54f9ee45 917 return _core_.Size_Get(*args, **kwargs)
e811c8ce 918
41e2b43e 919 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
e811c8ce
RD
920 def __str__(self): return str(self.Get())
921 def __repr__(self): return 'wx.Size'+str(self.Get())
922 def __len__(self): return len(self.Get())
923 def __getitem__(self, index): return self.Get()[index]
d14a1e28
RD
924 def __setitem__(self, index, val):
925 if index == 0: self.width = val
926 elif index == 1: self.height = val
927 else: raise IndexError
e811c8ce 928 def __nonzero__(self): return self.Get() != (0,0)
74e96f3d
RD
929 __safe_for_unpickling__ = True
930 def __reduce__(self): return (wx.Size, self.Get())
d14a1e28 931
2131d850 932_core_.Size_swigregister(Size)
d14a1e28
RD
933
934#---------------------------------------------------------------------------
935
936class RealPoint(object):
0df68c9f 937 """
41e2b43e
RD
938 A data structure for representing a point or position with floating
939 point x and y properties. In wxPython most places that expect a
940 wx.RealPoint can also accept a (x,y) tuple.
0df68c9f 941 """
0085ce49
RD
942 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
943 __repr__ = _swig_repr
54f9ee45
RD
944 x = property(_core_.RealPoint_x_get, _core_.RealPoint_x_set)
945 y = property(_core_.RealPoint_y_get, _core_.RealPoint_y_set)
0085ce49 946 def __init__(self, *args, **kwargs):
0df68c9f 947 """
a95a7133 948 __init__(self, double x=0.0, double y=0.0) -> RealPoint
e811c8ce 949
0df68c9f
RD
950 Create a wx.RealPoint object
951 """
0085ce49
RD
952 _core_.RealPoint_swiginit(self,_core_.new_RealPoint(*args, **kwargs))
953 __swig_destroy__ = _core_.delete_RealPoint
954 __del__ = lambda self : None;
e811c8ce 955 def __eq__(*args, **kwargs):
0df68c9f 956 """
e9d6f3a4 957 __eq__(self, PyObject other) -> bool
e811c8ce 958
0df68c9f
RD
959 Test for equality of wx.RealPoint objects.
960 """
54f9ee45 961 return _core_.RealPoint___eq__(*args, **kwargs)
e811c8ce
RD
962
963 def __ne__(*args, **kwargs):
0df68c9f 964 """
e9d6f3a4 965 __ne__(self, PyObject other) -> bool
e811c8ce 966
0df68c9f
RD
967 Test for inequality of wx.RealPoint objects.
968 """
54f9ee45 969 return _core_.RealPoint___ne__(*args, **kwargs)
e811c8ce
RD
970
971 def __add__(*args, **kwargs):
0df68c9f 972 """
a95a7133 973 __add__(self, RealPoint pt) -> RealPoint
e811c8ce 974
0df68c9f
RD
975 Add pt's proprties to this and return the result.
976 """
54f9ee45 977 return _core_.RealPoint___add__(*args, **kwargs)
e811c8ce
RD
978
979 def __sub__(*args, **kwargs):
0df68c9f 980 """
a95a7133 981 __sub__(self, RealPoint pt) -> RealPoint
e811c8ce 982
0df68c9f
RD
983 Subtract pt's proprties from this and return the result
984 """
54f9ee45 985 return _core_.RealPoint___sub__(*args, **kwargs)
e811c8ce
RD
986
987 def Set(*args, **kwargs):
0df68c9f 988 """
a95a7133 989 Set(self, double x, double y)
e811c8ce 990
0df68c9f
RD
991 Set both the x and y properties
992 """
54f9ee45 993 return _core_.RealPoint_Set(*args, **kwargs)
e811c8ce
RD
994
995 def Get(*args, **kwargs):
0df68c9f
RD
996 """
997 Get() -> (x,y)
e811c8ce 998
0df68c9f
RD
999 Return the x and y properties as a tuple.
1000 """
54f9ee45 1001 return _core_.RealPoint_Get(*args, **kwargs)
e811c8ce 1002
41e2b43e 1003 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
e811c8ce
RD
1004 def __str__(self): return str(self.Get())
1005 def __repr__(self): return 'wx.RealPoint'+str(self.Get())
1006 def __len__(self): return len(self.Get())
1007 def __getitem__(self, index): return self.Get()[index]
d14a1e28 1008 def __setitem__(self, index, val):
e811c8ce
RD
1009 if index == 0: self.x = val
1010 elif index == 1: self.y = val
d14a1e28 1011 else: raise IndexError
e811c8ce 1012 def __nonzero__(self): return self.Get() != (0.0, 0.0)
74e96f3d
RD
1013 __safe_for_unpickling__ = True
1014 def __reduce__(self): return (wx.RealPoint, self.Get())
d14a1e28 1015
2131d850 1016_core_.RealPoint_swigregister(RealPoint)
d14a1e28
RD
1017
1018#---------------------------------------------------------------------------
1019
1020class Point(object):
0df68c9f 1021 """
41e2b43e
RD
1022 A data structure for representing a point or position with integer x
1023 and y properties. Most places in wxPython that expect a wx.Point can
1024 also accept a (x,y) tuple.
0df68c9f 1025 """
0085ce49
RD
1026 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1027 __repr__ = _swig_repr
54f9ee45
RD
1028 x = property(_core_.Point_x_get, _core_.Point_x_set)
1029 y = property(_core_.Point_y_get, _core_.Point_y_set)
0085ce49 1030 def __init__(self, *args, **kwargs):
0df68c9f 1031 """
a95a7133 1032 __init__(self, int x=0, int y=0) -> Point
e811c8ce 1033
0df68c9f
RD
1034 Create a wx.Point object
1035 """
0085ce49
RD
1036 _core_.Point_swiginit(self,_core_.new_Point(*args, **kwargs))
1037 __swig_destroy__ = _core_.delete_Point
1038 __del__ = lambda self : None;
e811c8ce 1039 def __eq__(*args, **kwargs):
0df68c9f 1040 """
e9d6f3a4 1041 __eq__(self, PyObject other) -> bool
e811c8ce 1042
0df68c9f
RD
1043 Test for equality of wx.Point objects.
1044 """
54f9ee45 1045 return _core_.Point___eq__(*args, **kwargs)
e811c8ce
RD
1046
1047 def __ne__(*args, **kwargs):
0df68c9f 1048 """
e9d6f3a4 1049 __ne__(self, PyObject other) -> bool
e811c8ce 1050
0df68c9f
RD
1051 Test for inequality of wx.Point objects.
1052 """
54f9ee45 1053 return _core_.Point___ne__(*args, **kwargs)
e811c8ce
RD
1054
1055 def __add__(*args, **kwargs):
0df68c9f 1056 """
a95a7133 1057 __add__(self, Point pt) -> Point
e811c8ce 1058
0df68c9f
RD
1059 Add pt's proprties to this and return the result.
1060 """
54f9ee45 1061 return _core_.Point___add__(*args, **kwargs)
e811c8ce
RD
1062
1063 def __sub__(*args, **kwargs):
0df68c9f 1064 """
a95a7133 1065 __sub__(self, Point pt) -> Point
e811c8ce 1066
0df68c9f
RD
1067 Subtract pt's proprties from this and return the result
1068 """
54f9ee45 1069 return _core_.Point___sub__(*args, **kwargs)
e811c8ce
RD
1070
1071 def __iadd__(*args, **kwargs):
0df68c9f 1072 """
a95a7133 1073 __iadd__(self, Point pt) -> Point
e811c8ce 1074
0df68c9f
RD
1075 Add pt to this object.
1076 """
54f9ee45 1077 return _core_.Point___iadd__(*args, **kwargs)
e811c8ce
RD
1078
1079 def __isub__(*args, **kwargs):
0df68c9f 1080 """
a95a7133 1081 __isub__(self, Point pt) -> Point
e811c8ce 1082
0df68c9f
RD
1083 Subtract pt from this object.
1084 """
54f9ee45 1085 return _core_.Point___isub__(*args, **kwargs)
e811c8ce
RD
1086
1087 def Set(*args, **kwargs):
0df68c9f 1088 """
a95a7133 1089 Set(self, long x, long y)
e811c8ce 1090
0df68c9f
RD
1091 Set both the x and y properties
1092 """
54f9ee45 1093 return _core_.Point_Set(*args, **kwargs)
e811c8ce
RD
1094
1095 def Get(*args, **kwargs):
0df68c9f
RD
1096 """
1097 Get() -> (x,y)
e811c8ce 1098
0df68c9f
RD
1099 Return the x and y properties as a tuple.
1100 """
54f9ee45 1101 return _core_.Point_Get(*args, **kwargs)
e811c8ce 1102
41e2b43e 1103 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
e811c8ce
RD
1104 def __str__(self): return str(self.Get())
1105 def __repr__(self): return 'wx.Point'+str(self.Get())
1106 def __len__(self): return len(self.Get())
1107 def __getitem__(self, index): return self.Get()[index]
d14a1e28
RD
1108 def __setitem__(self, index, val):
1109 if index == 0: self.x = val
1110 elif index == 1: self.y = val
1111 else: raise IndexError
e811c8ce 1112 def __nonzero__(self): return self.Get() != (0,0)
74e96f3d
RD
1113 __safe_for_unpickling__ = True
1114 def __reduce__(self): return (wx.Point, self.Get())
d14a1e28 1115
2131d850 1116_core_.Point_swigregister(Point)
d14a1e28
RD
1117
1118#---------------------------------------------------------------------------
1119
1120class Rect(object):
0df68c9f 1121 """
41e2b43e
RD
1122 A class for representing and manipulating rectangles. It has x, y,
1123 width and height properties. In wxPython most palces that expect a
1124 wx.Rect can also accept a (x,y,width,height) tuple.
0df68c9f 1125 """
0085ce49
RD
1126 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1127 __repr__ = _swig_repr
1128 def __init__(self, *args, **kwargs):
0df68c9f 1129 """
a95a7133 1130 __init__(self, int x=0, int y=0, int width=0, int height=0) -> Rect
e811c8ce 1131
0df68c9f
RD
1132 Create a new Rect object.
1133 """
0085ce49
RD
1134 _core_.Rect_swiginit(self,_core_.new_Rect(*args, **kwargs))
1135 __swig_destroy__ = _core_.delete_Rect
1136 __del__ = lambda self : None;
e811c8ce 1137 def GetX(*args, **kwargs):
a95a7133 1138 """GetX(self) -> int"""
54f9ee45 1139 return _core_.Rect_GetX(*args, **kwargs)
e811c8ce
RD
1140
1141 def SetX(*args, **kwargs):
a95a7133 1142 """SetX(self, int x)"""
54f9ee45 1143 return _core_.Rect_SetX(*args, **kwargs)
e811c8ce
RD
1144
1145 def GetY(*args, **kwargs):
a95a7133 1146 """GetY(self) -> int"""
54f9ee45 1147 return _core_.Rect_GetY(*args, **kwargs)
e811c8ce
RD
1148
1149 def SetY(*args, **kwargs):
a95a7133 1150 """SetY(self, int y)"""
54f9ee45 1151 return _core_.Rect_SetY(*args, **kwargs)
e811c8ce
RD
1152
1153 def GetWidth(*args, **kwargs):
a95a7133 1154 """GetWidth(self) -> int"""
54f9ee45 1155 return _core_.Rect_GetWidth(*args, **kwargs)
e811c8ce
RD
1156
1157 def SetWidth(*args, **kwargs):
a95a7133 1158 """SetWidth(self, int w)"""
54f9ee45 1159 return _core_.Rect_SetWidth(*args, **kwargs)
e811c8ce
RD
1160
1161 def GetHeight(*args, **kwargs):
a95a7133 1162 """GetHeight(self) -> int"""
54f9ee45 1163 return _core_.Rect_GetHeight(*args, **kwargs)
e811c8ce
RD
1164
1165 def SetHeight(*args, **kwargs):
a95a7133 1166 """SetHeight(self, int h)"""
54f9ee45 1167 return _core_.Rect_SetHeight(*args, **kwargs)
e811c8ce
RD
1168
1169 def GetPosition(*args, **kwargs):
a95a7133 1170 """GetPosition(self) -> Point"""
54f9ee45 1171 return _core_.Rect_GetPosition(*args, **kwargs)
e811c8ce
RD
1172
1173 def SetPosition(*args, **kwargs):
a95a7133 1174 """SetPosition(self, Point p)"""
54f9ee45 1175 return _core_.Rect_SetPosition(*args, **kwargs)
e811c8ce
RD
1176
1177 def GetSize(*args, **kwargs):
a95a7133 1178 """GetSize(self) -> Size"""
54f9ee45 1179 return _core_.Rect_GetSize(*args, **kwargs)
e811c8ce
RD
1180
1181 def SetSize(*args, **kwargs):
a95a7133 1182 """SetSize(self, Size s)"""
54f9ee45 1183 return _core_.Rect_SetSize(*args, **kwargs)
e811c8ce 1184
aff4cc5c
RD
1185 def IsEmpty(*args, **kwargs):
1186 """IsEmpty(self) -> bool"""
1187 return _core_.Rect_IsEmpty(*args, **kwargs)
1188
c9c7117a 1189 def GetTopLeft(*args, **kwargs):
a95a7133 1190 """GetTopLeft(self) -> Point"""
54f9ee45 1191 return _core_.Rect_GetTopLeft(*args, **kwargs)
c9c7117a
RD
1192
1193 def SetTopLeft(*args, **kwargs):
a95a7133 1194 """SetTopLeft(self, Point p)"""
54f9ee45 1195 return _core_.Rect_SetTopLeft(*args, **kwargs)
c9c7117a
RD
1196
1197 def GetBottomRight(*args, **kwargs):
a95a7133 1198 """GetBottomRight(self) -> Point"""
54f9ee45 1199 return _core_.Rect_GetBottomRight(*args, **kwargs)
c9c7117a
RD
1200
1201 def SetBottomRight(*args, **kwargs):
a95a7133 1202 """SetBottomRight(self, Point p)"""
54f9ee45 1203 return _core_.Rect_SetBottomRight(*args, **kwargs)
c9c7117a 1204
5acb46e0
RD
1205 def GetTopRight(*args, **kwargs):
1206 """GetTopRight(self) -> Point"""
1207 return _core_.Rect_GetTopRight(*args, **kwargs)
1208
1209 def SetTopRight(*args, **kwargs):
1210 """SetTopRight(self, Point p)"""
1211 return _core_.Rect_SetTopRight(*args, **kwargs)
1212
1213 def GetBottomLeft(*args, **kwargs):
1214 """GetBottomLeft(self) -> Point"""
1215 return _core_.Rect_GetBottomLeft(*args, **kwargs)
1216
1217 def SetBottomLeft(*args, **kwargs):
1218 """SetBottomLeft(self, Point p)"""
1219 return _core_.Rect_SetBottomLeft(*args, **kwargs)
1220
e811c8ce 1221 def GetLeft(*args, **kwargs):
a95a7133 1222 """GetLeft(self) -> int"""
54f9ee45 1223 return _core_.Rect_GetLeft(*args, **kwargs)
e811c8ce
RD
1224
1225 def GetTop(*args, **kwargs):
a95a7133 1226 """GetTop(self) -> int"""
54f9ee45 1227 return _core_.Rect_GetTop(*args, **kwargs)
e811c8ce
RD
1228
1229 def GetBottom(*args, **kwargs):
a95a7133 1230 """GetBottom(self) -> int"""
54f9ee45 1231 return _core_.Rect_GetBottom(*args, **kwargs)
e811c8ce
RD
1232
1233 def GetRight(*args, **kwargs):
a95a7133 1234 """GetRight(self) -> int"""
54f9ee45 1235 return _core_.Rect_GetRight(*args, **kwargs)
e811c8ce
RD
1236
1237 def SetLeft(*args, **kwargs):
a95a7133 1238 """SetLeft(self, int left)"""
54f9ee45 1239 return _core_.Rect_SetLeft(*args, **kwargs)
e811c8ce
RD
1240
1241 def SetRight(*args, **kwargs):
a95a7133 1242 """SetRight(self, int right)"""
54f9ee45 1243 return _core_.Rect_SetRight(*args, **kwargs)
e811c8ce
RD
1244
1245 def SetTop(*args, **kwargs):
a95a7133 1246 """SetTop(self, int top)"""
54f9ee45 1247 return _core_.Rect_SetTop(*args, **kwargs)
e811c8ce
RD
1248
1249 def SetBottom(*args, **kwargs):
a95a7133 1250 """SetBottom(self, int bottom)"""
54f9ee45 1251 return _core_.Rect_SetBottom(*args, **kwargs)
e811c8ce
RD
1252
1253 position = property(GetPosition, SetPosition)
1254 size = property(GetSize, SetSize)
1255 left = property(GetLeft, SetLeft)
1256 right = property(GetRight, SetRight)
1257 top = property(GetTop, SetTop)
1258 bottom = property(GetBottom, SetBottom)
1259
1260 def Inflate(*args, **kwargs):
0df68c9f 1261 """
a95a7133 1262 Inflate(self, int dx, int dy) -> Rect
e811c8ce 1263
8e738329
RD
1264 Increases the size of the rectangle.
1265
1266 The left border is moved farther left and the right border is moved
1267 farther right by ``dx``. The upper border is moved farther up and the
1268 bottom border is moved farther down by ``dy``. (Note the the width and
1269 height of the rectangle thus change by ``2*dx`` and ``2*dy``,
1270 respectively.) If one or both of ``dx`` and ``dy`` are negative, the
1271 opposite happens: the rectangle size decreases in the respective
1272 direction.
1273
1274 The change is made to the rectangle inplace, if instead you need a
1275 copy that is inflated, preserving the original then make the copy
1276 first::
1277
1278 copy = wx.Rect(*original)
1279 copy.Inflate(10,15)
1280
1281
0df68c9f 1282 """
54f9ee45 1283 return _core_.Rect_Inflate(*args, **kwargs)
e811c8ce
RD
1284
1285 def Deflate(*args, **kwargs):
0df68c9f 1286 """
a95a7133 1287 Deflate(self, int dx, int dy) -> Rect
e811c8ce 1288
8e738329
RD
1289 Decrease the rectangle size. This method is the opposite of `Inflate`
1290 in that Deflate(a,b) is equivalent to Inflate(-a,-b). Please refer to
1291 `Inflate` for a full description.
0df68c9f 1292 """
54f9ee45 1293 return _core_.Rect_Deflate(*args, **kwargs)
e811c8ce
RD
1294
1295 def OffsetXY(*args, **kwargs):
0df68c9f 1296 """
a95a7133 1297 OffsetXY(self, int dx, int dy)
e811c8ce 1298
41e2b43e
RD
1299 Moves the rectangle by the specified offset. If dx is positive, the
1300 rectangle is moved to the right, if dy is positive, it is moved to the
1301 bottom, otherwise it is moved to the left or top respectively.
0df68c9f 1302 """
54f9ee45 1303 return _core_.Rect_OffsetXY(*args, **kwargs)
e811c8ce
RD
1304
1305 def Offset(*args, **kwargs):
0df68c9f 1306 """
a95a7133 1307 Offset(self, Point pt)
e811c8ce 1308
b1fcee84 1309 Same as `OffsetXY` but uses dx,dy from Point
0df68c9f 1310 """
54f9ee45 1311 return _core_.Rect_Offset(*args, **kwargs)
e811c8ce
RD
1312
1313 def Intersect(*args, **kwargs):
0df68c9f 1314 """
a95a7133 1315 Intersect(self, Rect rect) -> Rect
e811c8ce 1316
5cbf236d 1317 Returns the intersectsion of this rectangle and rect.
0df68c9f 1318 """
54f9ee45 1319 return _core_.Rect_Intersect(*args, **kwargs)
e811c8ce 1320
5cbf236d
RD
1321 def Union(*args, **kwargs):
1322 """
1323 Union(self, Rect rect) -> Rect
1324
1325 Returns the union of this rectangle and rect.
1326 """
1327 return _core_.Rect_Union(*args, **kwargs)
1328
e811c8ce 1329 def __add__(*args, **kwargs):
0df68c9f 1330 """
a95a7133 1331 __add__(self, Rect rect) -> Rect
e811c8ce 1332
0df68c9f
RD
1333 Add the properties of rect to this rectangle and return the result.
1334 """
54f9ee45 1335 return _core_.Rect___add__(*args, **kwargs)
e811c8ce
RD
1336
1337 def __iadd__(*args, **kwargs):
0df68c9f 1338 """
a95a7133 1339 __iadd__(self, Rect rect) -> Rect
e811c8ce 1340
0df68c9f
RD
1341 Add the properties of rect to this rectangle, updating this rectangle.
1342 """
54f9ee45 1343 return _core_.Rect___iadd__(*args, **kwargs)
e811c8ce
RD
1344
1345 def __eq__(*args, **kwargs):
0df68c9f 1346 """
e9d6f3a4 1347 __eq__(self, PyObject other) -> bool
e811c8ce 1348
e9d6f3a4 1349 Test for equality of wx.Rect objects.
0df68c9f 1350 """
54f9ee45 1351 return _core_.Rect___eq__(*args, **kwargs)
e811c8ce
RD
1352
1353 def __ne__(*args, **kwargs):
0df68c9f 1354 """
e9d6f3a4 1355 __ne__(self, PyObject other) -> bool
e811c8ce 1356
e9d6f3a4 1357 Test for inequality of wx.Rect objects.
0df68c9f 1358 """
54f9ee45 1359 return _core_.Rect___ne__(*args, **kwargs)
e811c8ce 1360
33d6fd3b 1361 def ContainsXY(*args, **kwargs):
0df68c9f 1362 """
33d6fd3b 1363 ContainsXY(self, int x, int y) -> bool
e811c8ce 1364
33d6fd3b 1365 Return True if the point is inside the rect.
0df68c9f 1366 """
33d6fd3b 1367 return _core_.Rect_ContainsXY(*args, **kwargs)
e811c8ce 1368
33d6fd3b 1369 def Contains(*args, **kwargs):
0df68c9f 1370 """
33d6fd3b 1371 Contains(self, Point pt) -> bool
e811c8ce 1372
33d6fd3b 1373 Return True if the point is inside the rect.
0df68c9f 1374 """
33d6fd3b 1375 return _core_.Rect_Contains(*args, **kwargs)
e811c8ce 1376
33d6fd3b 1377 def ContainsRect(*args, **kwargs):
fc46b7f3 1378 """
33d6fd3b 1379 ContainsRect(self, Rect rect) -> bool
fc46b7f3
RD
1380
1381 Returns ``True`` if the given rectangle is completely inside this
1382 rectangle or touches its boundary.
1383 """
33d6fd3b
RD
1384 return _core_.Rect_ContainsRect(*args, **kwargs)
1385
72ef6efb
RD
1386 #Inside = wx._deprecated(Contains, "Use `Contains` instead.")
1387 #InsideXY = wx._deprecated(ContainsXY, "Use `ContainsXY` instead.")
1388 #InsideRect = wx._deprecated(ContainsRect, "Use `ContainsRect` instead.")
1389 Inside = Contains
1390 InsideXY = ContainsXY
1391 InsideRect = ContainsRect
fc46b7f3 1392
e811c8ce 1393 def Intersects(*args, **kwargs):
0df68c9f 1394 """
a95a7133 1395 Intersects(self, Rect rect) -> bool
e811c8ce 1396
0df68c9f
RD
1397 Returns True if the rectangles have a non empty intersection.
1398 """
54f9ee45 1399 return _core_.Rect_Intersects(*args, **kwargs)
e811c8ce 1400
b1fcee84
RD
1401 def CenterIn(*args, **kwargs):
1402 """
1403 CenterIn(self, Rect r, int dir=BOTH) -> Rect
1404
1405 Center this rectangle within the one passed to the method, which is
1406 usually, but not necessarily, the larger one.
1407 """
1408 return _core_.Rect_CenterIn(*args, **kwargs)
1409
1410 CentreIn = CenterIn
54f9ee45
RD
1411 x = property(_core_.Rect_x_get, _core_.Rect_x_set)
1412 y = property(_core_.Rect_y_get, _core_.Rect_y_set)
1413 width = property(_core_.Rect_width_get, _core_.Rect_width_set)
1414 height = property(_core_.Rect_height_get, _core_.Rect_height_set)
e811c8ce 1415 def Set(*args, **kwargs):
0df68c9f 1416 """
a95a7133 1417 Set(self, int x=0, int y=0, int width=0, int height=0)
e811c8ce 1418
0df68c9f
RD
1419 Set all rectangle properties.
1420 """
54f9ee45 1421 return _core_.Rect_Set(*args, **kwargs)
e811c8ce
RD
1422
1423 def Get(*args, **kwargs):
0df68c9f
RD
1424 """
1425 Get() -> (x,y,width,height)
e811c8ce 1426
0df68c9f
RD
1427 Return the rectangle properties as a tuple.
1428 """
54f9ee45 1429 return _core_.Rect_Get(*args, **kwargs)
e811c8ce 1430
41e2b43e 1431 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
e811c8ce
RD
1432 def __str__(self): return str(self.Get())
1433 def __repr__(self): return 'wx.Rect'+str(self.Get())
1434 def __len__(self): return len(self.Get())
1435 def __getitem__(self, index): return self.Get()[index]
d14a1e28
RD
1436 def __setitem__(self, index, val):
1437 if index == 0: self.x = val
1438 elif index == 1: self.y = val
1439 elif index == 2: self.width = val
1440 elif index == 3: self.height = val
1441 else: raise IndexError
e811c8ce 1442 def __nonzero__(self): return self.Get() != (0,0,0,0)
74e96f3d
RD
1443 __safe_for_unpickling__ = True
1444 def __reduce__(self): return (wx.Rect, self.Get())
d14a1e28 1445
33d6fd3b
RD
1446 Bottom = property(GetBottom,SetBottom,doc="See `GetBottom` and `SetBottom`")
1447 BottomRight = property(GetBottomRight,SetBottomRight,doc="See `GetBottomRight` and `SetBottomRight`")
5acb46e0 1448 BottomLeft = property(GetBottomLeft,SetBottomLeft,doc="See `GetBottomLeft` and `SetBottomLeft`")
33d6fd3b
RD
1449 Height = property(GetHeight,SetHeight,doc="See `GetHeight` and `SetHeight`")
1450 Left = property(GetLeft,SetLeft,doc="See `GetLeft` and `SetLeft`")
1451 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
1452 Right = property(GetRight,SetRight,doc="See `GetRight` and `SetRight`")
1453 Size = property(GetSize,SetSize,doc="See `GetSize` and `SetSize`")
1454 Top = property(GetTop,SetTop,doc="See `GetTop` and `SetTop`")
1455 TopLeft = property(GetTopLeft,SetTopLeft,doc="See `GetTopLeft` and `SetTopLeft`")
5acb46e0 1456 TopRight = property(GetTopRight,SetTopRight,doc="See `GetTopRight` and `SetTopRight`")
33d6fd3b
RD
1457 Width = property(GetWidth,SetWidth,doc="See `GetWidth` and `SetWidth`")
1458 X = property(GetX,SetX,doc="See `GetX` and `SetX`")
1459 Y = property(GetY,SetY,doc="See `GetY` and `SetY`")
1460 Empty = property(IsEmpty,doc="See `IsEmpty`")
2131d850 1461_core_.Rect_swigregister(Rect)
d14a1e28
RD
1462
1463def RectPP(*args, **kwargs):
0df68c9f
RD
1464 """
1465 RectPP(Point topLeft, Point bottomRight) -> Rect
e811c8ce 1466
0df68c9f
RD
1467 Create a new Rect object from Points representing two corners.
1468 """
54f9ee45 1469 val = _core_.new_RectPP(*args, **kwargs)
d14a1e28
RD
1470 return val
1471
1472def RectPS(*args, **kwargs):
0df68c9f
RD
1473 """
1474 RectPS(Point pos, Size size) -> Rect
e811c8ce 1475
0df68c9f
RD
1476 Create a new Rect from a position and size.
1477 """
54f9ee45 1478 val = _core_.new_RectPS(*args, **kwargs)
d14a1e28
RD
1479 return val
1480
d3b6e4ff
RD
1481def RectS(*args, **kwargs):
1482 """
1483 RectS(Size size) -> Rect
1484
1485 Create a new Rect from a size only.
1486 """
1487 val = _core_.new_RectS(*args, **kwargs)
d3b6e4ff
RD
1488 return val
1489
d14a1e28 1490
e811c8ce 1491def IntersectRect(*args, **kwargs):
0085ce49 1492 """
0df68c9f 1493 IntersectRect(Rect r1, Rect r2) -> Rect
e811c8ce 1494
0df68c9f
RD
1495 Calculate and return the intersection of r1 and r2.
1496 """
0085ce49 1497 return _core_.IntersectRect(*args, **kwargs)
d14a1e28
RD
1498#---------------------------------------------------------------------------
1499
1500class Point2D(object):
41e2b43e
RD
1501 """
1502 wx.Point2Ds represent a point or a vector in a 2d coordinate system
1503 with floating point values.
1504 """
0085ce49
RD
1505 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1506 __repr__ = _swig_repr
1507 def __init__(self, *args, **kwargs):
0df68c9f 1508 """
a95a7133 1509 __init__(self, double x=0.0, double y=0.0) -> Point2D
e811c8ce 1510
0df68c9f
RD
1511 Create a w.Point2D object.
1512 """
0085ce49 1513 _core_.Point2D_swiginit(self,_core_.new_Point2D(*args, **kwargs))
b39fe951
RD
1514 __swig_destroy__ = _core_.delete_Point2D
1515 __del__ = lambda self : None;
e811c8ce 1516 def GetFloor(*args, **kwargs):
fd2dc343
RD
1517 """
1518 GetFloor() -> (x,y)
1519
1520 Convert to integer
1521 """
54f9ee45 1522 return _core_.Point2D_GetFloor(*args, **kwargs)
e811c8ce
RD
1523
1524 def GetRounded(*args, **kwargs):
fd2dc343
RD
1525 """
1526 GetRounded() -> (x,y)
1527
1528 Convert to integer
1529 """
54f9ee45 1530 return _core_.Point2D_GetRounded(*args, **kwargs)
e811c8ce
RD
1531
1532 def GetVectorLength(*args, **kwargs):
a95a7133 1533 """GetVectorLength(self) -> double"""
54f9ee45 1534 return _core_.Point2D_GetVectorLength(*args, **kwargs)
e811c8ce
RD
1535
1536 def GetVectorAngle(*args, **kwargs):
a95a7133 1537 """GetVectorAngle(self) -> double"""
54f9ee45 1538 return _core_.Point2D_GetVectorAngle(*args, **kwargs)
e811c8ce
RD
1539
1540 def SetVectorLength(*args, **kwargs):
a95a7133 1541 """SetVectorLength(self, double length)"""
54f9ee45 1542 return _core_.Point2D_SetVectorLength(*args, **kwargs)
e811c8ce
RD
1543
1544 def SetVectorAngle(*args, **kwargs):
a95a7133 1545 """SetVectorAngle(self, double degrees)"""
54f9ee45 1546 return _core_.Point2D_SetVectorAngle(*args, **kwargs)
e811c8ce 1547
d14a1e28
RD
1548 def SetPolarCoordinates(self, angle, length):
1549 self.SetVectorLength(length)
1550 self.SetVectorAngle(angle)
1551 def Normalize(self):
1552 self.SetVectorLength(1.0)
1553
e811c8ce 1554 def GetDistance(*args, **kwargs):
a95a7133 1555 """GetDistance(self, Point2D pt) -> double"""
54f9ee45 1556 return _core_.Point2D_GetDistance(*args, **kwargs)
e811c8ce
RD
1557
1558 def GetDistanceSquare(*args, **kwargs):
a95a7133 1559 """GetDistanceSquare(self, Point2D pt) -> double"""
54f9ee45 1560 return _core_.Point2D_GetDistanceSquare(*args, **kwargs)
e811c8ce
RD
1561
1562 def GetDotProduct(*args, **kwargs):
a95a7133 1563 """GetDotProduct(self, Point2D vec) -> double"""
54f9ee45 1564 return _core_.Point2D_GetDotProduct(*args, **kwargs)
e811c8ce
RD
1565
1566 def GetCrossProduct(*args, **kwargs):
a95a7133 1567 """GetCrossProduct(self, Point2D vec) -> double"""
54f9ee45 1568 return _core_.Point2D_GetCrossProduct(*args, **kwargs)
e811c8ce
RD
1569
1570 def __neg__(*args, **kwargs):
0df68c9f 1571 """
a95a7133 1572 __neg__(self) -> Point2D
e811c8ce 1573
0df68c9f
RD
1574 the reflection of this point
1575 """
54f9ee45 1576 return _core_.Point2D___neg__(*args, **kwargs)
e811c8ce
RD
1577
1578 def __iadd__(*args, **kwargs):
a95a7133 1579 """__iadd__(self, Point2D pt) -> Point2D"""
54f9ee45 1580 return _core_.Point2D___iadd__(*args, **kwargs)
e811c8ce
RD
1581
1582 def __isub__(*args, **kwargs):
a95a7133 1583 """__isub__(self, Point2D pt) -> Point2D"""
54f9ee45 1584 return _core_.Point2D___isub__(*args, **kwargs)
e811c8ce
RD
1585
1586 def __imul__(*args, **kwargs):
a95a7133 1587 """__imul__(self, Point2D pt) -> Point2D"""
54f9ee45 1588 return _core_.Point2D___imul__(*args, **kwargs)
e811c8ce
RD
1589
1590 def __idiv__(*args, **kwargs):
a95a7133 1591 """__idiv__(self, Point2D pt) -> Point2D"""
54f9ee45 1592 return _core_.Point2D___idiv__(*args, **kwargs)
e811c8ce
RD
1593
1594 def __eq__(*args, **kwargs):
0df68c9f 1595 """
e9d6f3a4 1596 __eq__(self, PyObject other) -> bool
e811c8ce 1597
e9d6f3a4 1598 Test for equality of wx.Point2D objects.
0df68c9f 1599 """
54f9ee45 1600 return _core_.Point2D___eq__(*args, **kwargs)
e811c8ce
RD
1601
1602 def __ne__(*args, **kwargs):
0df68c9f 1603 """
e9d6f3a4 1604 __ne__(self, PyObject other) -> bool
e811c8ce 1605
e9d6f3a4 1606 Test for inequality of wx.Point2D objects.
0df68c9f 1607 """
54f9ee45 1608 return _core_.Point2D___ne__(*args, **kwargs)
e811c8ce 1609
54f9ee45
RD
1610 x = property(_core_.Point2D_x_get, _core_.Point2D_x_set)
1611 y = property(_core_.Point2D_y_get, _core_.Point2D_y_set)
e811c8ce 1612 def Set(*args, **kwargs):
a95a7133 1613 """Set(self, double x=0, double y=0)"""
54f9ee45 1614 return _core_.Point2D_Set(*args, **kwargs)
e811c8ce
RD
1615
1616 def Get(*args, **kwargs):
0df68c9f
RD
1617 """
1618 Get() -> (x,y)
e811c8ce 1619
0df68c9f
RD
1620 Return x and y properties as a tuple.
1621 """
54f9ee45 1622 return _core_.Point2D_Get(*args, **kwargs)
e811c8ce 1623
41e2b43e 1624 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
e811c8ce
RD
1625 def __str__(self): return str(self.Get())
1626 def __repr__(self): return 'wx.Point2D'+str(self.Get())
1627 def __len__(self): return len(self.Get())
1628 def __getitem__(self, index): return self.Get()[index]
d14a1e28 1629 def __setitem__(self, index, val):
e811c8ce
RD
1630 if index == 0: self.x = val
1631 elif index == 1: self.y = val
d14a1e28 1632 else: raise IndexError
e811c8ce 1633 def __nonzero__(self): return self.Get() != (0.0, 0.0)
74e96f3d
RD
1634 __safe_for_unpickling__ = True
1635 def __reduce__(self): return (wx.Point2D, self.Get())
d14a1e28 1636
33d6fd3b
RD
1637 Floor = property(GetFloor,doc="See `GetFloor`")
1638 Rounded = property(GetRounded,doc="See `GetRounded`")
1639 VectorAngle = property(GetVectorAngle,SetVectorAngle,doc="See `GetVectorAngle` and `SetVectorAngle`")
1640 VectorLength = property(GetVectorLength,SetVectorLength,doc="See `GetVectorLength` and `SetVectorLength`")
2131d850 1641_core_.Point2D_swigregister(Point2D)
d14a1e28
RD
1642
1643def Point2DCopy(*args, **kwargs):
0df68c9f
RD
1644 """
1645 Point2DCopy(Point2D pt) -> Point2D
e811c8ce 1646
0df68c9f
RD
1647 Create a w.Point2D object.
1648 """
54f9ee45 1649 val = _core_.new_Point2DCopy(*args, **kwargs)
d14a1e28
RD
1650 return val
1651
1652def Point2DFromPoint(*args, **kwargs):
0df68c9f
RD
1653 """
1654 Point2DFromPoint(Point pt) -> Point2D
e811c8ce 1655
0df68c9f
RD
1656 Create a w.Point2D object.
1657 """
54f9ee45 1658 val = _core_.new_Point2DFromPoint(*args, **kwargs)
d14a1e28
RD
1659 return val
1660
1661#---------------------------------------------------------------------------
1662
70d7cb34
RD
1663Inside = _core_.Inside
1664OutLeft = _core_.OutLeft
1665OutRight = _core_.OutRight
1666OutTop = _core_.OutTop
1667OutBottom = _core_.OutBottom
1668class Rect2D(object):
1669 """
1670 wx.Rect2D is a rectangle, with position and size, in a 2D coordinate system
1671 with floating point component values.
1672 """
1673 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1674 __repr__ = _swig_repr
1675 def __init__(self, *args, **kwargs):
1676 """
1677 __init__(self, wxDouble x=0.0, wxDouble y=0.0, wxDouble w=0.0, wxDouble h=0.0) -> Rect2D
1678
1679 wx.Rect2D is a rectangle, with position and size, in a 2D coordinate system
1680 with floating point component values.
1681 """
1682 _core_.Rect2D_swiginit(self,_core_.new_Rect2D(*args, **kwargs))
1683 __swig_destroy__ = _core_.delete_Rect2D
1684 __del__ = lambda self : None;
1685 def GetPosition(*args, **kwargs):
1686 """GetPosition(self) -> Point2D"""
1687 return _core_.Rect2D_GetPosition(*args, **kwargs)
1688
1689 def GetSize(*args, **kwargs):
1690 """GetSize(self) -> Size"""
1691 return _core_.Rect2D_GetSize(*args, **kwargs)
1692
1693 def GetLeft(*args, **kwargs):
1694 """GetLeft(self) -> wxDouble"""
1695 return _core_.Rect2D_GetLeft(*args, **kwargs)
1696
1697 def SetLeft(*args, **kwargs):
1698 """SetLeft(self, wxDouble n)"""
1699 return _core_.Rect2D_SetLeft(*args, **kwargs)
1700
1701 def MoveLeftTo(*args, **kwargs):
1702 """MoveLeftTo(self, wxDouble n)"""
1703 return _core_.Rect2D_MoveLeftTo(*args, **kwargs)
1704
1705 def GetTop(*args, **kwargs):
1706 """GetTop(self) -> wxDouble"""
1707 return _core_.Rect2D_GetTop(*args, **kwargs)
1708
1709 def SetTop(*args, **kwargs):
1710 """SetTop(self, wxDouble n)"""
1711 return _core_.Rect2D_SetTop(*args, **kwargs)
1712
1713 def MoveTopTo(*args, **kwargs):
1714 """MoveTopTo(self, wxDouble n)"""
1715 return _core_.Rect2D_MoveTopTo(*args, **kwargs)
1716
1717 def GetBottom(*args, **kwargs):
1718 """GetBottom(self) -> wxDouble"""
1719 return _core_.Rect2D_GetBottom(*args, **kwargs)
1720
1721 def SetBottom(*args, **kwargs):
1722 """SetBottom(self, wxDouble n)"""
1723 return _core_.Rect2D_SetBottom(*args, **kwargs)
1724
1725 def MoveBottomTo(*args, **kwargs):
1726 """MoveBottomTo(self, wxDouble n)"""
1727 return _core_.Rect2D_MoveBottomTo(*args, **kwargs)
1728
1729 def GetRight(*args, **kwargs):
1730 """GetRight(self) -> wxDouble"""
1731 return _core_.Rect2D_GetRight(*args, **kwargs)
1732
1733 def SetRight(*args, **kwargs):
1734 """SetRight(self, wxDouble n)"""
1735 return _core_.Rect2D_SetRight(*args, **kwargs)
1736
1737 def MoveRightTo(*args, **kwargs):
1738 """MoveRightTo(self, wxDouble n)"""
1739 return _core_.Rect2D_MoveRightTo(*args, **kwargs)
1740
1741 def GetLeftTop(*args, **kwargs):
1742 """GetLeftTop(self) -> Point2D"""
1743 return _core_.Rect2D_GetLeftTop(*args, **kwargs)
1744
1745 def SetLeftTop(*args, **kwargs):
1746 """SetLeftTop(self, Point2D pt)"""
1747 return _core_.Rect2D_SetLeftTop(*args, **kwargs)
1748
1749 def MoveLeftTopTo(*args, **kwargs):
1750 """MoveLeftTopTo(self, Point2D pt)"""
1751 return _core_.Rect2D_MoveLeftTopTo(*args, **kwargs)
1752
1753 def GetLeftBottom(*args, **kwargs):
1754 """GetLeftBottom(self) -> Point2D"""
1755 return _core_.Rect2D_GetLeftBottom(*args, **kwargs)
1756
1757 def SetLeftBottom(*args, **kwargs):
1758 """SetLeftBottom(self, Point2D pt)"""
1759 return _core_.Rect2D_SetLeftBottom(*args, **kwargs)
1760
1761 def MoveLeftBottomTo(*args, **kwargs):
1762 """MoveLeftBottomTo(self, Point2D pt)"""
1763 return _core_.Rect2D_MoveLeftBottomTo(*args, **kwargs)
1764
1765 def GetRightTop(*args, **kwargs):
1766 """GetRightTop(self) -> Point2D"""
1767 return _core_.Rect2D_GetRightTop(*args, **kwargs)
1768
1769 def SetRightTop(*args, **kwargs):
1770 """SetRightTop(self, Point2D pt)"""
1771 return _core_.Rect2D_SetRightTop(*args, **kwargs)
1772
1773 def MoveRightTopTo(*args, **kwargs):
1774 """MoveRightTopTo(self, Point2D pt)"""
1775 return _core_.Rect2D_MoveRightTopTo(*args, **kwargs)
1776
1777 def GetRightBottom(*args, **kwargs):
1778 """GetRightBottom(self) -> Point2D"""
1779 return _core_.Rect2D_GetRightBottom(*args, **kwargs)
1780
1781 def SetRightBottom(*args, **kwargs):
1782 """SetRightBottom(self, Point2D pt)"""
1783 return _core_.Rect2D_SetRightBottom(*args, **kwargs)
1784
1785 def MoveRightBottomTo(*args, **kwargs):
1786 """MoveRightBottomTo(self, Point2D pt)"""
1787 return _core_.Rect2D_MoveRightBottomTo(*args, **kwargs)
1788
1789 def GetCentre(*args, **kwargs):
1790 """GetCentre(self) -> Point2D"""
1791 return _core_.Rect2D_GetCentre(*args, **kwargs)
1792
1793 def SetCentre(*args, **kwargs):
1794 """SetCentre(self, Point2D pt)"""
1795 return _core_.Rect2D_SetCentre(*args, **kwargs)
1796
1797 def MoveCentreTo(*args, **kwargs):
1798 """MoveCentreTo(self, Point2D pt)"""
1799 return _core_.Rect2D_MoveCentreTo(*args, **kwargs)
1800
1801 def GetOutcode(*args, **kwargs):
1802 """GetOutcode(self, Point2D pt) -> int"""
1803 return _core_.Rect2D_GetOutcode(*args, **kwargs)
1804
1805 def Contains(*args, **kwargs):
1806 """Contains(self, Point2D pt) -> bool"""
1807 return _core_.Rect2D_Contains(*args, **kwargs)
1808
1809 def ContainsRect(*args, **kwargs):
1810 """ContainsRect(self, Rect2D rect) -> bool"""
1811 return _core_.Rect2D_ContainsRect(*args, **kwargs)
1812
1813 def IsEmpty(*args, **kwargs):
1814 """IsEmpty(self) -> bool"""
1815 return _core_.Rect2D_IsEmpty(*args, **kwargs)
1816
1817 def HaveEqualSize(*args, **kwargs):
1818 """HaveEqualSize(self, Rect2D rect) -> bool"""
1819 return _core_.Rect2D_HaveEqualSize(*args, **kwargs)
1820
1821 def Inset(*args):
1822 """
1823 Inset(self, wxDouble x, wxDouble y)
1824 Inset(self, wxDouble left, wxDouble top, wxDouble right, wxDouble bottom)
1825 """
1826 return _core_.Rect2D_Inset(*args)
1827
1828 def Offset(*args, **kwargs):
1829 """Offset(self, Point2D pt)"""
1830 return _core_.Rect2D_Offset(*args, **kwargs)
1831
1832 def ConstrainTo(*args, **kwargs):
1833 """ConstrainTo(self, Rect2D rect)"""
1834 return _core_.Rect2D_ConstrainTo(*args, **kwargs)
1835
1836 def Interpolate(*args, **kwargs):
1837 """Interpolate(self, int widthfactor, int heightfactor) -> Point2D"""
1838 return _core_.Rect2D_Interpolate(*args, **kwargs)
1839
1840 def Intersect(*args, **kwargs):
1841 """Intersect(self, Rect2D otherRect)"""
1842 return _core_.Rect2D_Intersect(*args, **kwargs)
1843
1844 def CreateIntersection(*args, **kwargs):
1845 """CreateIntersection(self, Rect2D otherRect) -> Rect2D"""
1846 return _core_.Rect2D_CreateIntersection(*args, **kwargs)
1847
1848 def Intersects(*args, **kwargs):
1849 """Intersects(self, Rect2D rect) -> bool"""
1850 return _core_.Rect2D_Intersects(*args, **kwargs)
1851
1852 def Union(*args, **kwargs):
1853 """Union(self, Rect2D otherRect)"""
1854 return _core_.Rect2D_Union(*args, **kwargs)
1855
1856 def CreateUnion(*args, **kwargs):
1857 """CreateUnion(self, Rect2D otherRect) -> Rect2D"""
1858 return _core_.Rect2D_CreateUnion(*args, **kwargs)
1859
1860 def Scale(*args):
1861 """
1862 Scale(self, wxDouble f)
1863 Scale(self, int num, int denum)
1864 """
1865 return _core_.Rect2D_Scale(*args)
1866
1867 def __eq__(*args, **kwargs):
1868 """
1869 __eq__(self, PyObject other) -> bool
1870
1871 Test for equality of wx.Rect2D objects.
1872 """
1873 return _core_.Rect2D___eq__(*args, **kwargs)
1874
1875 def __ne__(*args, **kwargs):
1876 """
1877 __ne__(self, PyObject other) -> bool
1878
1879 Test for inequality of wx.Rect2D objects.
1880 """
1881 return _core_.Rect2D___ne__(*args, **kwargs)
1882
1883 x = property(_core_.Rect2D_x_get, _core_.Rect2D_x_set)
1884 y = property(_core_.Rect2D_y_get, _core_.Rect2D_y_set)
1885 width = property(_core_.Rect2D_width_get, _core_.Rect2D_width_set)
1886 height = property(_core_.Rect2D_height_get, _core_.Rect2D_height_set)
1887 def Set(*args, **kwargs):
1888 """Set(self, wxDouble x=0, wxDouble y=0, wxDouble width=0, wxDouble height=0)"""
1889 return _core_.Rect2D_Set(*args, **kwargs)
1890
1891 def Get(*args, **kwargs):
1892 """
1893 Get() -> (x,y, width, height)
1894
1895 Return x, y, width and height y properties as a tuple.
1896 """
1897 return _core_.Rect2D_Get(*args, **kwargs)
1898
1899 def __str__(self): return str(self.Get())
1900 def __repr__(self): return 'wx.Rect2D'+str(self.Get())
1901 def __len__(self): return len(self.Get())
1902 def __getitem__(self, index): return self.Get()[index]
1903 def __setitem__(self, index, val):
1904 if index == 0: self.x = val
1905 elif index == 1: self.y = val
1906 elif index == 2: self.width = val
1907 elif index == 3: self.height = val
1908 else: raise IndexError
1909 def __nonzero__(self): return self.Get() != (0.0, 0.0, 0.0, 0.0)
1910 __safe_for_unpickling__ = True
1911 def __reduce__(self): return (wx.Rect2D, self.Get())
1912
1913_core_.Rect2D_swigregister(Rect2D)
1914
1915#---------------------------------------------------------------------------
1916
54f9ee45
RD
1917FromStart = _core_.FromStart
1918FromCurrent = _core_.FromCurrent
1919FromEnd = _core_.FromEnd
d14a1e28 1920class InputStream(object):
093d3ff1 1921 """Proxy of C++ InputStream class"""
0085ce49
RD
1922 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1923 __repr__ = _swig_repr
1924 def __init__(self, *args, **kwargs):
a95a7133 1925 """__init__(self, PyObject p) -> InputStream"""
0085ce49
RD
1926 _core_.InputStream_swiginit(self,_core_.new_InputStream(*args, **kwargs))
1927 __swig_destroy__ = _core_.delete_InputStream
1928 __del__ = lambda self : None;
e811c8ce 1929 def close(*args, **kwargs):
a95a7133 1930 """close(self)"""
54f9ee45 1931 return _core_.InputStream_close(*args, **kwargs)
e811c8ce
RD
1932
1933 def flush(*args, **kwargs):
a95a7133 1934 """flush(self)"""
54f9ee45 1935 return _core_.InputStream_flush(*args, **kwargs)
e811c8ce
RD
1936
1937 def eof(*args, **kwargs):
a95a7133 1938 """eof(self) -> bool"""
54f9ee45 1939 return _core_.InputStream_eof(*args, **kwargs)
e811c8ce
RD
1940
1941 def read(*args, **kwargs):
a95a7133 1942 """read(self, int size=-1) -> PyObject"""
54f9ee45 1943 return _core_.InputStream_read(*args, **kwargs)
e811c8ce
RD
1944
1945 def readline(*args, **kwargs):
a95a7133 1946 """readline(self, int size=-1) -> PyObject"""
54f9ee45 1947 return _core_.InputStream_readline(*args, **kwargs)
e811c8ce
RD
1948
1949 def readlines(*args, **kwargs):
a95a7133 1950 """readlines(self, int sizehint=-1) -> PyObject"""
54f9ee45 1951 return _core_.InputStream_readlines(*args, **kwargs)
e811c8ce
RD
1952
1953 def seek(*args, **kwargs):
a95a7133 1954 """seek(self, int offset, int whence=0)"""
54f9ee45 1955 return _core_.InputStream_seek(*args, **kwargs)
e811c8ce
RD
1956
1957 def tell(*args, **kwargs):
a95a7133 1958 """tell(self) -> int"""
54f9ee45 1959 return _core_.InputStream_tell(*args, **kwargs)
e811c8ce
RD
1960
1961 def Peek(*args, **kwargs):
a95a7133 1962 """Peek(self) -> char"""
54f9ee45 1963 return _core_.InputStream_Peek(*args, **kwargs)
e811c8ce
RD
1964
1965 def GetC(*args, **kwargs):
a95a7133 1966 """GetC(self) -> char"""
54f9ee45 1967 return _core_.InputStream_GetC(*args, **kwargs)
e811c8ce
RD
1968
1969 def LastRead(*args, **kwargs):
a95a7133 1970 """LastRead(self) -> size_t"""
54f9ee45 1971 return _core_.InputStream_LastRead(*args, **kwargs)
e811c8ce
RD
1972
1973 def CanRead(*args, **kwargs):
a95a7133 1974 """CanRead(self) -> bool"""
54f9ee45 1975 return _core_.InputStream_CanRead(*args, **kwargs)
e811c8ce
RD
1976
1977 def Eof(*args, **kwargs):
a95a7133 1978 """Eof(self) -> bool"""
54f9ee45 1979 return _core_.InputStream_Eof(*args, **kwargs)
e811c8ce
RD
1980
1981 def Ungetch(*args, **kwargs):
a95a7133 1982 """Ungetch(self, char c) -> bool"""
54f9ee45 1983 return _core_.InputStream_Ungetch(*args, **kwargs)
e811c8ce
RD
1984
1985 def SeekI(*args, **kwargs):
a95a7133 1986 """SeekI(self, long pos, int mode=FromStart) -> long"""
54f9ee45 1987 return _core_.InputStream_SeekI(*args, **kwargs)
e811c8ce
RD
1988
1989 def TellI(*args, **kwargs):
a95a7133 1990 """TellI(self) -> long"""
54f9ee45 1991 return _core_.InputStream_TellI(*args, **kwargs)
e811c8ce 1992
2131d850 1993_core_.InputStream_swigregister(InputStream)
d14a1e28
RD
1994DefaultPosition = cvar.DefaultPosition
1995DefaultSize = cvar.DefaultSize
1996
1997class OutputStream(object):
093d3ff1 1998 """Proxy of C++ OutputStream class"""
0085ce49
RD
1999 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2000 def __init__(self): raise AttributeError, "No constructor defined"
2001 __repr__ = _swig_repr
e811c8ce 2002 def write(*args, **kwargs):
a95a7133 2003 """write(self, PyObject obj)"""
54f9ee45 2004 return _core_.OutputStream_write(*args, **kwargs)
e811c8ce 2005
0085ce49
RD
2006 def LastWrite(*args, **kwargs):
2007 """LastWrite(self) -> size_t"""
2008 return _core_.OutputStream_LastWrite(*args, **kwargs)
d14a1e28 2009
2131d850 2010_core_.OutputStream_swigregister(OutputStream)
d14a1e28
RD
2011
2012#---------------------------------------------------------------------------
2013
2014class FSFile(Object):
093d3ff1 2015 """Proxy of C++ FSFile class"""
0085ce49
RD
2016 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2017 __repr__ = _swig_repr
2018 def __init__(self, *args, **kwargs):
0df68c9f 2019 """
a95a7133 2020 __init__(self, InputStream stream, String loc, String mimetype, String anchor,
196addbf 2021 DateTime modif) -> FSFile
0df68c9f 2022 """
0085ce49 2023 _core_.FSFile_swiginit(self,_core_.new_FSFile(*args, **kwargs))
0085ce49
RD
2024 __swig_destroy__ = _core_.delete_FSFile
2025 __del__ = lambda self : None;
e811c8ce 2026 def GetStream(*args, **kwargs):
a95a7133 2027 """GetStream(self) -> InputStream"""
54f9ee45 2028 return _core_.FSFile_GetStream(*args, **kwargs)
e811c8ce 2029
97ab0f6a
RD
2030 def DetachStream(*args, **kwargs):
2031 """DetachStream(self)"""
2032 return _core_.FSFile_DetachStream(*args, **kwargs)
2033
e811c8ce 2034 def GetMimeType(*args, **kwargs):
a95a7133 2035 """GetMimeType(self) -> String"""
54f9ee45 2036 return _core_.FSFile_GetMimeType(*args, **kwargs)
e811c8ce
RD
2037
2038 def GetLocation(*args, **kwargs):
a95a7133 2039 """GetLocation(self) -> String"""
54f9ee45 2040 return _core_.FSFile_GetLocation(*args, **kwargs)
e811c8ce
RD
2041
2042 def GetAnchor(*args, **kwargs):
a95a7133 2043 """GetAnchor(self) -> String"""
54f9ee45 2044 return _core_.FSFile_GetAnchor(*args, **kwargs)
e811c8ce
RD
2045
2046 def GetModificationTime(*args, **kwargs):
a95a7133 2047 """GetModificationTime(self) -> DateTime"""
54f9ee45 2048 return _core_.FSFile_GetModificationTime(*args, **kwargs)
e811c8ce 2049
97ab0f6a
RD
2050 Anchor = property(GetAnchor,doc="See `GetAnchor`")
2051 Location = property(GetLocation,doc="See `GetLocation`")
2052 MimeType = property(GetMimeType,doc="See `GetMimeType`")
2053 ModificationTime = property(GetModificationTime,doc="See `GetModificationTime`")
2054 Stream = property(GetStream,doc="See `GetStream`")
2131d850 2055_core_.FSFile_swigregister(FSFile)
d14a1e28
RD
2056
2057class CPPFileSystemHandler(object):
093d3ff1 2058 """Proxy of C++ CPPFileSystemHandler class"""
0085ce49
RD
2059 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2060 def __init__(self): raise AttributeError, "No constructor defined"
2061 __repr__ = _swig_repr
50f151d7
RD
2062 __swig_destroy__ = _core_.delete_CPPFileSystemHandler
2063 __del__ = lambda self : None;
2131d850 2064_core_.CPPFileSystemHandler_swigregister(CPPFileSystemHandler)
d14a1e28
RD
2065
2066class FileSystemHandler(CPPFileSystemHandler):
093d3ff1 2067 """Proxy of C++ FileSystemHandler class"""
0085ce49
RD
2068 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2069 __repr__ = _swig_repr
2070 def __init__(self, *args, **kwargs):
a95a7133 2071 """__init__(self) -> FileSystemHandler"""
0085ce49 2072 _core_.FileSystemHandler_swiginit(self,_core_.new_FileSystemHandler(*args, **kwargs))
d14a1e28 2073 self._setCallbackInfo(self, FileSystemHandler)
e811c8ce
RD
2074
2075 def _setCallbackInfo(*args, **kwargs):
a95a7133 2076 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
54f9ee45 2077 return _core_.FileSystemHandler__setCallbackInfo(*args, **kwargs)
e811c8ce
RD
2078
2079 def CanOpen(*args, **kwargs):
a95a7133 2080 """CanOpen(self, String location) -> bool"""
54f9ee45 2081 return _core_.FileSystemHandler_CanOpen(*args, **kwargs)
e811c8ce
RD
2082
2083 def OpenFile(*args, **kwargs):
a95a7133 2084 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
54f9ee45 2085 return _core_.FileSystemHandler_OpenFile(*args, **kwargs)
e811c8ce
RD
2086
2087 def FindFirst(*args, **kwargs):
a95a7133 2088 """FindFirst(self, String spec, int flags=0) -> String"""
54f9ee45 2089 return _core_.FileSystemHandler_FindFirst(*args, **kwargs)
e811c8ce
RD
2090
2091 def FindNext(*args, **kwargs):
a95a7133 2092 """FindNext(self) -> String"""
54f9ee45 2093 return _core_.FileSystemHandler_FindNext(*args, **kwargs)
e811c8ce
RD
2094
2095 def GetProtocol(*args, **kwargs):
a95a7133 2096 """GetProtocol(self, String location) -> String"""
54f9ee45 2097 return _core_.FileSystemHandler_GetProtocol(*args, **kwargs)
e811c8ce
RD
2098
2099 def GetLeftLocation(*args, **kwargs):
a95a7133 2100 """GetLeftLocation(self, String location) -> String"""
54f9ee45 2101 return _core_.FileSystemHandler_GetLeftLocation(*args, **kwargs)
e811c8ce
RD
2102
2103 def GetAnchor(*args, **kwargs):
a95a7133 2104 """GetAnchor(self, String location) -> String"""
54f9ee45 2105 return _core_.FileSystemHandler_GetAnchor(*args, **kwargs)
e811c8ce
RD
2106
2107 def GetRightLocation(*args, **kwargs):
a95a7133 2108 """GetRightLocation(self, String location) -> String"""
54f9ee45 2109 return _core_.FileSystemHandler_GetRightLocation(*args, **kwargs)
e811c8ce
RD
2110
2111 def GetMimeTypeFromExt(*args, **kwargs):
a95a7133 2112 """GetMimeTypeFromExt(self, String location) -> String"""
54f9ee45 2113 return _core_.FileSystemHandler_GetMimeTypeFromExt(*args, **kwargs)
e811c8ce 2114
97ab0f6a
RD
2115 Anchor = property(GetAnchor,doc="See `GetAnchor`")
2116 LeftLocation = property(GetLeftLocation,doc="See `GetLeftLocation`")
2117 MimeTypeFromExt = property(GetMimeTypeFromExt,doc="See `GetMimeTypeFromExt`")
2118 Protocol = property(GetProtocol,doc="See `GetProtocol`")
2119 RightLocation = property(GetRightLocation,doc="See `GetRightLocation`")
2131d850 2120_core_.FileSystemHandler_swigregister(FileSystemHandler)
d14a1e28
RD
2121
2122class FileSystem(Object):
093d3ff1 2123 """Proxy of C++ FileSystem class"""
0085ce49
RD
2124 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2125 __repr__ = _swig_repr
2126 def __init__(self, *args, **kwargs):
a95a7133 2127 """__init__(self) -> FileSystem"""
0085ce49
RD
2128 _core_.FileSystem_swiginit(self,_core_.new_FileSystem(*args, **kwargs))
2129 __swig_destroy__ = _core_.delete_FileSystem
2130 __del__ = lambda self : None;
e811c8ce 2131 def ChangePathTo(*args, **kwargs):
a95a7133 2132 """ChangePathTo(self, String location, bool is_dir=False)"""
54f9ee45 2133 return _core_.FileSystem_ChangePathTo(*args, **kwargs)
e811c8ce
RD
2134
2135 def GetPath(*args, **kwargs):
a95a7133 2136 """GetPath(self) -> String"""
54f9ee45 2137 return _core_.FileSystem_GetPath(*args, **kwargs)
e811c8ce
RD
2138
2139 def OpenFile(*args, **kwargs):
a95a7133 2140 """OpenFile(self, String location) -> FSFile"""
54f9ee45 2141 return _core_.FileSystem_OpenFile(*args, **kwargs)
e811c8ce
RD
2142
2143 def FindFirst(*args, **kwargs):
a95a7133 2144 """FindFirst(self, String spec, int flags=0) -> String"""
54f9ee45 2145 return _core_.FileSystem_FindFirst(*args, **kwargs)
e811c8ce
RD
2146
2147 def FindNext(*args, **kwargs):
a95a7133 2148 """FindNext(self) -> String"""
54f9ee45 2149 return _core_.FileSystem_FindNext(*args, **kwargs)
e811c8ce
RD
2150
2151 def AddHandler(*args, **kwargs):
66c033b4 2152 """AddHandler(CPPFileSystemHandler handler)"""
54f9ee45 2153 return _core_.FileSystem_AddHandler(*args, **kwargs)
e811c8ce
RD
2154
2155 AddHandler = staticmethod(AddHandler)
97ab0f6a
RD
2156 def RemoveHandler(*args, **kwargs):
2157 """RemoveHandler(CPPFileSystemHandler handler) -> CPPFileSystemHandler"""
2158 return _core_.FileSystem_RemoveHandler(*args, **kwargs)
2159
2160 RemoveHandler = staticmethod(RemoveHandler)
e811c8ce 2161 def CleanUpHandlers(*args, **kwargs):
66c033b4 2162 """CleanUpHandlers()"""
54f9ee45 2163 return _core_.FileSystem_CleanUpHandlers(*args, **kwargs)
e811c8ce
RD
2164
2165 CleanUpHandlers = staticmethod(CleanUpHandlers)
2166 def FileNameToURL(*args, **kwargs):
66c033b4 2167 """FileNameToURL(String filename) -> String"""
54f9ee45 2168 return _core_.FileSystem_FileNameToURL(*args, **kwargs)
e811c8ce
RD
2169
2170 FileNameToURL = staticmethod(FileNameToURL)
2ef75293
RD
2171 def URLToFileName(*args, **kwargs):
2172 """URLToFileName(String url) -> String"""
2173 return _core_.FileSystem_URLToFileName(*args, **kwargs)
2174
2175 URLToFileName = staticmethod(URLToFileName)
97ab0f6a 2176 Path = property(GetPath,doc="See `GetPath`")
2131d850 2177_core_.FileSystem_swigregister(FileSystem)
d14a1e28 2178
e811c8ce 2179def FileSystem_AddHandler(*args, **kwargs):
0085ce49
RD
2180 """FileSystem_AddHandler(CPPFileSystemHandler handler)"""
2181 return _core_.FileSystem_AddHandler(*args, **kwargs)
d14a1e28 2182
97ab0f6a
RD
2183def FileSystem_RemoveHandler(*args, **kwargs):
2184 """FileSystem_RemoveHandler(CPPFileSystemHandler handler) -> CPPFileSystemHandler"""
2185 return _core_.FileSystem_RemoveHandler(*args, **kwargs)
2186
0085ce49
RD
2187def FileSystem_CleanUpHandlers(*args):
2188 """FileSystem_CleanUpHandlers()"""
2189 return _core_.FileSystem_CleanUpHandlers(*args)
d14a1e28 2190
e811c8ce 2191def FileSystem_FileNameToURL(*args, **kwargs):
0085ce49
RD
2192 """FileSystem_FileNameToURL(String filename) -> String"""
2193 return _core_.FileSystem_FileNameToURL(*args, **kwargs)
d14a1e28 2194
e811c8ce 2195def FileSystem_URLToFileName(*args, **kwargs):
0085ce49
RD
2196 """FileSystem_URLToFileName(String url) -> String"""
2197 return _core_.FileSystem_URLToFileName(*args, **kwargs)
2ef75293 2198
d14a1e28 2199class InternetFSHandler(CPPFileSystemHandler):
093d3ff1 2200 """Proxy of C++ InternetFSHandler class"""
0085ce49
RD
2201 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2202 __repr__ = _swig_repr
2203 def __init__(self, *args, **kwargs):
a95a7133 2204 """__init__(self) -> InternetFSHandler"""
0085ce49 2205 _core_.InternetFSHandler_swiginit(self,_core_.new_InternetFSHandler(*args, **kwargs))
e811c8ce 2206 def CanOpen(*args, **kwargs):
a95a7133 2207 """CanOpen(self, String location) -> bool"""
54f9ee45 2208 return _core_.InternetFSHandler_CanOpen(*args, **kwargs)
e811c8ce
RD
2209
2210 def OpenFile(*args, **kwargs):
a95a7133 2211 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
54f9ee45 2212 return _core_.InternetFSHandler_OpenFile(*args, **kwargs)
e811c8ce 2213
2131d850 2214_core_.InternetFSHandler_swigregister(InternetFSHandler)
d14a1e28
RD
2215
2216class ZipFSHandler(CPPFileSystemHandler):
093d3ff1 2217 """Proxy of C++ ZipFSHandler class"""
0085ce49
RD
2218 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2219 __repr__ = _swig_repr
2220 def __init__(self, *args, **kwargs):
a95a7133 2221 """__init__(self) -> ZipFSHandler"""
0085ce49 2222 _core_.ZipFSHandler_swiginit(self,_core_.new_ZipFSHandler(*args, **kwargs))
e811c8ce 2223 def CanOpen(*args, **kwargs):
a95a7133 2224 """CanOpen(self, String location) -> bool"""
54f9ee45 2225 return _core_.ZipFSHandler_CanOpen(*args, **kwargs)
e811c8ce
RD
2226
2227 def OpenFile(*args, **kwargs):
a95a7133 2228 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
54f9ee45 2229 return _core_.ZipFSHandler_OpenFile(*args, **kwargs)
e811c8ce
RD
2230
2231 def FindFirst(*args, **kwargs):
a95a7133 2232 """FindFirst(self, String spec, int flags=0) -> String"""
54f9ee45 2233 return _core_.ZipFSHandler_FindFirst(*args, **kwargs)
e811c8ce
RD
2234
2235 def FindNext(*args, **kwargs):
a95a7133 2236 """FindNext(self) -> String"""
54f9ee45 2237 return _core_.ZipFSHandler_FindNext(*args, **kwargs)
e811c8ce 2238
2131d850 2239_core_.ZipFSHandler_swigregister(ZipFSHandler)
d14a1e28
RD
2240
2241
e811c8ce 2242def __wxMemoryFSHandler_AddFile_wxImage(*args, **kwargs):
0085ce49
RD
2243 """__wxMemoryFSHandler_AddFile_wxImage(String filename, Image image, long type)"""
2244 return _core_.__wxMemoryFSHandler_AddFile_wxImage(*args, **kwargs)
d14a1e28 2245
e811c8ce 2246def __wxMemoryFSHandler_AddFile_wxBitmap(*args, **kwargs):
0085ce49
RD
2247 """__wxMemoryFSHandler_AddFile_wxBitmap(String filename, Bitmap bitmap, long type)"""
2248 return _core_.__wxMemoryFSHandler_AddFile_wxBitmap(*args, **kwargs)
d14a1e28 2249
e811c8ce 2250def __wxMemoryFSHandler_AddFile_Data(*args, **kwargs):
0085ce49
RD
2251 """__wxMemoryFSHandler_AddFile_Data(String filename, PyObject data)"""
2252 return _core_.__wxMemoryFSHandler_AddFile_Data(*args, **kwargs)
2ef75293
RD
2253def MemoryFSHandler_AddFile(filename, dataItem, imgType=-1):
2254 """
2255 Add 'file' to the memory filesystem. The dataItem parameter can
2256 either be a `wx.Bitmap`, `wx.Image` or a string that can contain
2257 arbitrary data. If a bitmap or image is used then the imgType
2258 parameter should specify what kind of image file it should be
2259 written as, wx.BITMAP_TYPE_PNG, etc.
2260 """
2261 if isinstance(dataItem, wx.Image):
2262 __wxMemoryFSHandler_AddFile_wxImage(filename, dataItem, imgType)
2263 elif isinstance(dataItem, wx.Bitmap):
2264 __wxMemoryFSHandler_AddFile_wxBitmap(filename, dataItem, imgType)
2265 elif type(dataItem) == str:
2266 __wxMemoryFSHandler_AddFile_Data(filename, dataItem)
2267 else:
2268 raise TypeError, 'wx.Image, wx.Bitmap or string expected'
d14a1e28
RD
2269
2270class MemoryFSHandler(CPPFileSystemHandler):
093d3ff1 2271 """Proxy of C++ MemoryFSHandler class"""
0085ce49
RD
2272 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2273 __repr__ = _swig_repr
2274 def __init__(self, *args, **kwargs):
a95a7133 2275 """__init__(self) -> MemoryFSHandler"""
0085ce49 2276 _core_.MemoryFSHandler_swiginit(self,_core_.new_MemoryFSHandler(*args, **kwargs))
e811c8ce 2277 def RemoveFile(*args, **kwargs):
66c033b4 2278 """RemoveFile(String filename)"""
54f9ee45 2279 return _core_.MemoryFSHandler_RemoveFile(*args, **kwargs)
e811c8ce
RD
2280
2281 RemoveFile = staticmethod(RemoveFile)
d14a1e28 2282 AddFile = staticmethod(MemoryFSHandler_AddFile)
e811c8ce 2283 def CanOpen(*args, **kwargs):
a95a7133 2284 """CanOpen(self, String location) -> bool"""
54f9ee45 2285 return _core_.MemoryFSHandler_CanOpen(*args, **kwargs)
e811c8ce
RD
2286
2287 def OpenFile(*args, **kwargs):
a95a7133 2288 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
54f9ee45 2289 return _core_.MemoryFSHandler_OpenFile(*args, **kwargs)
e811c8ce
RD
2290
2291 def FindFirst(*args, **kwargs):
a95a7133 2292 """FindFirst(self, String spec, int flags=0) -> String"""
54f9ee45 2293 return _core_.MemoryFSHandler_FindFirst(*args, **kwargs)
e811c8ce
RD
2294
2295 def FindNext(*args, **kwargs):
a95a7133 2296 """FindNext(self) -> String"""
54f9ee45 2297 return _core_.MemoryFSHandler_FindNext(*args, **kwargs)
e811c8ce 2298
2131d850 2299_core_.MemoryFSHandler_swigregister(MemoryFSHandler)
d14a1e28 2300
e811c8ce 2301def MemoryFSHandler_RemoveFile(*args, **kwargs):
0085ce49
RD
2302 """MemoryFSHandler_RemoveFile(String filename)"""
2303 return _core_.MemoryFSHandler_RemoveFile(*args, **kwargs)
d14a1e28 2304
bcd0d7b6
RD
2305IMAGE_ALPHA_TRANSPARENT = _core_.IMAGE_ALPHA_TRANSPARENT
2306IMAGE_ALPHA_THRESHOLD = _core_.IMAGE_ALPHA_THRESHOLD
2307IMAGE_ALPHA_OPAQUE = _core_.IMAGE_ALPHA_OPAQUE
f5263701
RD
2308IMAGE_QUALITY_NORMAL = _core_.IMAGE_QUALITY_NORMAL
2309IMAGE_QUALITY_HIGH = _core_.IMAGE_QUALITY_HIGH
d14a1e28
RD
2310#---------------------------------------------------------------------------
2311
2312class ImageHandler(Object):
27fb7603
RD
2313 """
2314 This is the base class for implementing image file loading/saving, and
2315 image creation from data. It is used within `wx.Image` and is not
2316 normally seen by the application.
2317 """
0085ce49
RD
2318 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2319 def __init__(self): raise AttributeError, "No constructor defined"
2320 __repr__ = _swig_repr
e811c8ce 2321 def GetName(*args, **kwargs):
a95a7133 2322 """GetName(self) -> String"""
54f9ee45 2323 return _core_.ImageHandler_GetName(*args, **kwargs)
e811c8ce
RD
2324
2325 def GetExtension(*args, **kwargs):
a95a7133 2326 """GetExtension(self) -> String"""
54f9ee45 2327 return _core_.ImageHandler_GetExtension(*args, **kwargs)
e811c8ce
RD
2328
2329 def GetType(*args, **kwargs):
a95a7133 2330 """GetType(self) -> long"""
54f9ee45 2331 return _core_.ImageHandler_GetType(*args, **kwargs)
e811c8ce
RD
2332
2333 def GetMimeType(*args, **kwargs):
a95a7133 2334 """GetMimeType(self) -> String"""
54f9ee45 2335 return _core_.ImageHandler_GetMimeType(*args, **kwargs)
e811c8ce
RD
2336
2337 def CanRead(*args, **kwargs):
a95a7133 2338 """CanRead(self, String name) -> bool"""
54f9ee45 2339 return _core_.ImageHandler_CanRead(*args, **kwargs)
e811c8ce 2340
b02396e8
RD
2341 def CanReadStream(*args, **kwargs):
2342 """CanReadStream(self, InputStream stream) -> bool"""
2343 return _core_.ImageHandler_CanReadStream(*args, **kwargs)
2344
e811c8ce 2345 def SetName(*args, **kwargs):
a95a7133 2346 """SetName(self, String name)"""
54f9ee45 2347 return _core_.ImageHandler_SetName(*args, **kwargs)
e811c8ce
RD
2348
2349 def SetExtension(*args, **kwargs):
a95a7133 2350 """SetExtension(self, String extension)"""
54f9ee45 2351 return _core_.ImageHandler_SetExtension(*args, **kwargs)
e811c8ce
RD
2352
2353 def SetType(*args, **kwargs):
a95a7133 2354 """SetType(self, long type)"""
54f9ee45 2355 return _core_.ImageHandler_SetType(*args, **kwargs)
e811c8ce
RD
2356
2357 def SetMimeType(*args, **kwargs):
a95a7133 2358 """SetMimeType(self, String mimetype)"""
54f9ee45 2359 return _core_.ImageHandler_SetMimeType(*args, **kwargs)
e811c8ce 2360
97ab0f6a
RD
2361 Extension = property(GetExtension,SetExtension,doc="See `GetExtension` and `SetExtension`")
2362 MimeType = property(GetMimeType,SetMimeType,doc="See `GetMimeType` and `SetMimeType`")
2363 Name = property(GetName,SetName,doc="See `GetName` and `SetName`")
2364 Type = property(GetType,SetType,doc="See `GetType` and `SetType`")
2131d850 2365_core_.ImageHandler_swigregister(ImageHandler)
d14a1e28 2366
943e8dfd
RD
2367class PyImageHandler(ImageHandler):
2368 """
2369 This is the base class for implementing image file loading/saving, and
2370 image creation from data, all written in Python. To create a custom
2371 image handler derive a new class from wx.PyImageHandler and provide
2372 the following methods::
2373
2374 def DoCanRead(self, stream) --> bool
2375 '''Check if this handler can read the image on the stream'''
2376
2377 def LoadFile(self, image, stream, verbose, index) --> bool
2378 '''Load image data from the stream and load it into image.'''
2379
2380 def SaveFile(self, image, stream, verbose) --> bool
2381 '''Save the iamge data in image to the stream using
2382 this handler's image file format.'''
2383
2384 def GetImageCount(self, stream) --> int
2385 '''If this image format can hold more than one image,
2386 how many does the image on the stream have?'''
2387
2388 To activate your handler create an instance of it and pass it to
2389 `wx.Image_AddHandler`. Be sure to call `SetName`, `SetType`, and
2390 `SetExtension` from your constructor.
2391
2392 """
0085ce49
RD
2393 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2394 __repr__ = _swig_repr
2395 def __init__(self, *args, **kwargs):
943e8dfd
RD
2396 """
2397 __init__(self) -> PyImageHandler
2398
2399 This is the base class for implementing image file loading/saving, and
2400 image creation from data, all written in Python. To create a custom
2401 image handler derive a new class from wx.PyImageHandler and provide
2402 the following methods::
2403
2404 def DoCanRead(self, stream) --> bool
2405 '''Check if this handler can read the image on the stream'''
2406
2407 def LoadFile(self, image, stream, verbose, index) --> bool
2408 '''Load image data from the stream and load it into image.'''
2409
2410 def SaveFile(self, image, stream, verbose) --> bool
2411 '''Save the iamge data in image to the stream using
2412 this handler's image file format.'''
2413
2414 def GetImageCount(self, stream) --> int
2415 '''If this image format can hold more than one image,
2416 how many does the image on the stream have?'''
2417
2418 To activate your handler create an instance of it and pass it to
2419 `wx.Image_AddHandler`. Be sure to call `SetName`, `SetType`, and
2420 `SetExtension` from your constructor.
2421
2422 """
0085ce49 2423 _core_.PyImageHandler_swiginit(self,_core_.new_PyImageHandler(*args, **kwargs))
943e8dfd
RD
2424 self._SetSelf(self)
2425
2426 def _SetSelf(*args, **kwargs):
2427 """_SetSelf(self, PyObject self)"""
2428 return _core_.PyImageHandler__SetSelf(*args, **kwargs)
2429
2131d850 2430_core_.PyImageHandler_swigregister(PyImageHandler)
943e8dfd 2431
d14a1e28 2432class ImageHistogram(object):
093d3ff1 2433 """Proxy of C++ ImageHistogram class"""
0085ce49
RD
2434 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2435 __repr__ = _swig_repr
2436 def __init__(self, *args, **kwargs):
a95a7133 2437 """__init__(self) -> ImageHistogram"""
0085ce49 2438 _core_.ImageHistogram_swiginit(self,_core_.new_ImageHistogram(*args, **kwargs))
e811c8ce 2439 def MakeKey(*args, **kwargs):
0df68c9f 2440 """
7a27cf7c 2441 MakeKey(byte r, byte g, byte b) -> unsigned long
e811c8ce 2442
0df68c9f
RD
2443 Get the key in the histogram for the given RGB values
2444 """
54f9ee45 2445 return _core_.ImageHistogram_MakeKey(*args, **kwargs)
e811c8ce
RD
2446
2447 MakeKey = staticmethod(MakeKey)
2448 def FindFirstUnusedColour(*args, **kwargs):
fd2dc343
RD
2449 """
2450 FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)
2451
2452 Find first colour that is not used in the image and has higher RGB
2453 values than startR, startG, startB. Returns a tuple consisting of a
2454 success flag and rgb values.
2455 """
54f9ee45 2456 return _core_.ImageHistogram_FindFirstUnusedColour(*args, **kwargs)
e811c8ce 2457
f1cbd8fa
RD
2458 def GetCount(*args, **kwargs):
2459 """
2460 GetCount(self, unsigned long key) -> unsigned long
2461
2462 Returns the pixel count for the given key. Use `MakeKey` to create a
2463 key value from a RGB tripple.
2464 """
2465 return _core_.ImageHistogram_GetCount(*args, **kwargs)
2466
2467 def GetCountRGB(*args, **kwargs):
2468 """
7a27cf7c 2469 GetCountRGB(self, byte r, byte g, byte b) -> unsigned long
f1cbd8fa
RD
2470
2471 Returns the pixel count for the given RGB values.
2472 """
2473 return _core_.ImageHistogram_GetCountRGB(*args, **kwargs)
2474
2475 def GetCountColour(*args, **kwargs):
2476 """
2477 GetCountColour(self, Colour colour) -> unsigned long
2478
2479 Returns the pixel count for the given `wx.Colour` value.
2480 """
2481 return _core_.ImageHistogram_GetCountColour(*args, **kwargs)
2482
2131d850 2483_core_.ImageHistogram_swigregister(ImageHistogram)
d14a1e28 2484
e811c8ce 2485def ImageHistogram_MakeKey(*args, **kwargs):
0085ce49 2486 """
7a27cf7c 2487 ImageHistogram_MakeKey(byte r, byte g, byte b) -> unsigned long
e811c8ce 2488
0df68c9f
RD
2489 Get the key in the histogram for the given RGB values
2490 """
0085ce49 2491 return _core_.ImageHistogram_MakeKey(*args, **kwargs)
d14a1e28 2492
943e8dfd
RD
2493class Image_RGBValue(object):
2494 """
2495 An object that contains values for red, green and blue which represent
2496 the value of a color. It is used by `wx.Image.HSVtoRGB` and
2497 `wx.Image.RGBtoHSV`, which converts between HSV color space and RGB
2498 color space.
2499 """
0085ce49
RD
2500 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2501 __repr__ = _swig_repr
2502 def __init__(self, *args, **kwargs):
943e8dfd
RD
2503 """
2504 __init__(self, byte r=0, byte g=0, byte b=0) -> Image_RGBValue
2505
2506 Constructor.
2507 """
0085ce49 2508 _core_.Image_RGBValue_swiginit(self,_core_.new_Image_RGBValue(*args, **kwargs))
943e8dfd
RD
2509 red = property(_core_.Image_RGBValue_red_get, _core_.Image_RGBValue_red_set)
2510 green = property(_core_.Image_RGBValue_green_get, _core_.Image_RGBValue_green_set)
2511 blue = property(_core_.Image_RGBValue_blue_get, _core_.Image_RGBValue_blue_set)
2131d850 2512_core_.Image_RGBValue_swigregister(Image_RGBValue)
943e8dfd
RD
2513
2514class Image_HSVValue(object):
2515 """
2516 An object that contains values for hue, saturation and value which
2517 represent the value of a color. It is used by `wx.Image.HSVtoRGB` and
2518 `wx.Image.RGBtoHSV`, which +converts between HSV color space and RGB
2519 color space.
2520 """
0085ce49
RD
2521 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2522 __repr__ = _swig_repr
2523 def __init__(self, *args, **kwargs):
943e8dfd
RD
2524 """
2525 __init__(self, double h=0.0, double s=0.0, double v=0.0) -> Image_HSVValue
2526
2527 Constructor.
2528 """
0085ce49 2529 _core_.Image_HSVValue_swiginit(self,_core_.new_Image_HSVValue(*args, **kwargs))
943e8dfd
RD
2530 hue = property(_core_.Image_HSVValue_hue_get, _core_.Image_HSVValue_hue_set)
2531 saturation = property(_core_.Image_HSVValue_saturation_get, _core_.Image_HSVValue_saturation_set)
2532 value = property(_core_.Image_HSVValue_value_get, _core_.Image_HSVValue_value_set)
2131d850 2533_core_.Image_HSVValue_swigregister(Image_HSVValue)
943e8dfd 2534
d14a1e28 2535class Image(Object):
7a27cf7c
RD
2536 """
2537 A platform-independent image class. An image can be created from
2538 data, or using `wx.Bitmap.ConvertToImage`, or loaded from a file in a
2539 variety of formats. Functions are available to set and get image
2540 bits, so it can be used for basic image manipulation.
2541
2542 A wx.Image cannot be drawn directly to a `wx.DC`. Instead, a
2543 platform-specific `wx.Bitmap` object must be created from it using the
2544 `wx.BitmapFromImage` constructor. This bitmap can then be drawn in a
2545 device context, using `wx.DC.DrawBitmap`.
2546
2547 One colour value of the image may be used as a mask colour which will
2548 lead to the automatic creation of a `wx.Mask` object associated to the
2549 bitmap object.
2550
2551 wx.Image supports alpha channel data, that is in addition to a byte
2552 for the red, green and blue colour components for each pixel it also
2553 stores a byte representing the pixel opacity. An alpha value of 0
2554 corresponds to a transparent pixel (null opacity) while a value of 255
2555 means that the pixel is 100% opaque.
2556
2557 Unlike RGB data, not all images have an alpha channel and before using
2558 `GetAlpha` you should check if this image contains an alpha channel
2559 with `HasAlpha`. Note that currently only images loaded from PNG files
2560 with transparency information will have an alpha channel.
2561 """
0085ce49
RD
2562 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2563 __repr__ = _swig_repr
2564 def __init__(self, *args, **kwargs):
7a27cf7c
RD
2565 """
2566 __init__(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> Image
2567
2568 Loads an image from a file.
2569 """
0085ce49
RD
2570 _core_.Image_swiginit(self,_core_.new_Image(*args, **kwargs))
2571 __swig_destroy__ = _core_.delete_Image
2572 __del__ = lambda self : None;
e811c8ce 2573 def Create(*args, **kwargs):
7a27cf7c
RD
2574 """
2575 Create(self, int width, int height, bool clear=True)
2576
2577 Creates a fresh image. If clear is ``True``, the new image will be
2578 initialized to black. Otherwise, the image data will be uninitialized.
2579 """
54f9ee45 2580 return _core_.Image_Create(*args, **kwargs)
e811c8ce
RD
2581
2582 def Destroy(*args, **kwargs):
0df68c9f 2583 """
a95a7133 2584 Destroy(self)
e811c8ce 2585
7a27cf7c 2586 Destroys the image data.
0df68c9f 2587 """
b39fe951
RD
2588 args[0].this.own(False)
2589 return _core_.Image_Destroy(*args, **kwargs)
e811c8ce
RD
2590
2591 def Scale(*args, **kwargs):
7a27cf7c 2592 """
f5263701 2593 Scale(self, int width, int height, int quality=IMAGE_QUALITY_NORMAL) -> Image
7a27cf7c
RD
2594
2595 Returns a scaled version of the image. This is also useful for scaling
2596 bitmaps in general as the only other way to scale bitmaps is to blit a
f5263701
RD
2597 `wx.MemoryDC` into another `wx.MemoryDC`. The ``quality`` parameter
2598 specifies what method to use for resampling the image. It can be
2599 either wx.IMAGE_QUALITY_NORMAL, which uses the normal default scaling
2600 method of pixel replication, or wx.IMAGE_QUALITY_HIGH which uses
2601 bicubic and box averaging resampling methods for upsampling and
2602 downsampling respectively.
7a27cf7c 2603 """
54f9ee45 2604 return _core_.Image_Scale(*args, **kwargs)
e811c8ce 2605
f5263701
RD
2606 def ResampleBox(*args, **kwargs):
2607 """ResampleBox(self, int width, int height) -> Image"""
2608 return _core_.Image_ResampleBox(*args, **kwargs)
2609
2610 def ResampleBicubic(*args, **kwargs):
2611 """ResampleBicubic(self, int width, int height) -> Image"""
2612 return _core_.Image_ResampleBicubic(*args, **kwargs)
2613
2614 def Blur(*args, **kwargs):
2615 """
2616 Blur(self, int radius) -> Image
2617
2618 Blurs the image in both horizontal and vertical directions by the
2619 specified pixel ``radius``. This should not be used when using a
2620 single mask colour for transparency.
2621 """
2622 return _core_.Image_Blur(*args, **kwargs)
2623
2624 def BlurHorizontal(*args, **kwargs):
2625 """
2626 BlurHorizontal(self, int radius) -> Image
2627
2628 Blurs the image in the horizontal direction only. This should not be
2629 used when using a single mask colour for transparency.
2630
2631 """
2632 return _core_.Image_BlurHorizontal(*args, **kwargs)
2633
2634 def BlurVertical(*args, **kwargs):
2635 """
2636 BlurVertical(self, int radius) -> Image
2637
2638 Blurs the image in the vertical direction only. This should not be
2639 used when using a single mask colour for transparency.
2640 """
2641 return _core_.Image_BlurVertical(*args, **kwargs)
2642
e811c8ce 2643 def ShrinkBy(*args, **kwargs):
7a27cf7c
RD
2644 """
2645 ShrinkBy(self, int xFactor, int yFactor) -> Image
2646
2647 Return a version of the image scaled smaller by the given factors.
2648 """
54f9ee45 2649 return _core_.Image_ShrinkBy(*args, **kwargs)
e811c8ce
RD
2650
2651 def Rescale(*args, **kwargs):
7a27cf7c 2652 """
f5263701 2653 Rescale(self, int width, int height, int quality=IMAGE_QUALITY_NORMAL) -> Image
7a27cf7c
RD
2654
2655 Changes the size of the image in-place by scaling it: after a call to
2656 this function, the image will have the given width and height.
2657
2658 Returns the (modified) image itself.
2659 """
54f9ee45 2660 return _core_.Image_Rescale(*args, **kwargs)
e811c8ce 2661
aff4cc5c 2662 def Resize(*args, **kwargs):
7a27cf7c
RD
2663 """
2664 Resize(self, Size size, Point pos, int r=-1, int g=-1, int b=-1) -> Image
2665
2666 Changes the size of the image in-place without scaling it, by adding
2667 either a border with the given colour or cropping as necessary. The
2668 image is pasted into a new image with the given size and background
2669 colour at the position pos relative to the upper left of the new
2670 image. If red = green = blue = -1 then use either the current mask
2671 colour if set or find, use, and set a suitable mask colour for any
2672 newly exposed areas.
2673
2674 Returns the (modified) image itself.
2675 """
aff4cc5c
RD
2676 return _core_.Image_Resize(*args, **kwargs)
2677
e811c8ce 2678 def SetRGB(*args, **kwargs):
7a27cf7c
RD
2679 """
2680 SetRGB(self, int x, int y, byte r, byte g, byte b)
2681
2682 Sets the pixel at the given coordinate. This routine performs
2683 bounds-checks for the coordinate so it can be considered a safe way to
2684 manipulate the data, but in some cases this might be too slow so that
2685 the data will have to be set directly. In that case you will have to
2686 get access to the image data using the `GetData` method.
2687 """
54f9ee45 2688 return _core_.Image_SetRGB(*args, **kwargs)
e811c8ce 2689
aff4cc5c 2690 def SetRGBRect(*args, **kwargs):
7a27cf7c
RD
2691 """
2692 SetRGBRect(self, Rect rect, byte r, byte g, byte b)
2693
2694 Sets the colour of the pixels within the given rectangle. This routine
2695 performs bounds-checks for the rectangle so it can be considered a
2696 safe way to manipulate the data.
2697 """
aff4cc5c
RD
2698 return _core_.Image_SetRGBRect(*args, **kwargs)
2699
e811c8ce 2700 def GetRed(*args, **kwargs):
7a27cf7c
RD
2701 """
2702 GetRed(self, int x, int y) -> byte
2703
2704 Returns the red intensity at the given coordinate.
2705 """
54f9ee45 2706 return _core_.Image_GetRed(*args, **kwargs)
e811c8ce
RD
2707
2708 def GetGreen(*args, **kwargs):
7a27cf7c
RD
2709 """
2710 GetGreen(self, int x, int y) -> byte
2711
2712 Returns the green intensity at the given coordinate.
2713 """
54f9ee45 2714 return _core_.Image_GetGreen(*args, **kwargs)
e811c8ce
RD
2715
2716 def GetBlue(*args, **kwargs):
7a27cf7c
RD
2717 """
2718 GetBlue(self, int x, int y) -> byte
2719
2720 Returns the blue intensity at the given coordinate.
2721 """
54f9ee45 2722 return _core_.Image_GetBlue(*args, **kwargs)
e811c8ce
RD
2723
2724 def SetAlpha(*args, **kwargs):
7a27cf7c
RD
2725 """
2726 SetAlpha(self, int x, int y, byte alpha)
2727
2728 Sets the alpha value for the given pixel. This function should only be
2729 called if the image has alpha channel data, use `HasAlpha` to check
2730 for this.
2731 """
54f9ee45 2732 return _core_.Image_SetAlpha(*args, **kwargs)
e811c8ce
RD
2733
2734 def GetAlpha(*args, **kwargs):
7a27cf7c
RD
2735 """
2736 GetAlpha(self, int x, int y) -> byte
2737
2738 Returns the alpha value for the given pixel. This function may only be
2739 called for the images with alpha channel, use `HasAlpha` to check for
2740 this.
2741
2742 The returned value is the *opacity* of the image, i.e. the value of 0
2743 corresponds to the fully transparent pixels while the value of 255 to
2744 the fully opaque pixels.
2745 """
54f9ee45 2746 return _core_.Image_GetAlpha(*args, **kwargs)
e811c8ce
RD
2747
2748 def HasAlpha(*args, **kwargs):
7a27cf7c
RD
2749 """
2750 HasAlpha(self) -> bool
2751
2752 Returns true if this image has alpha channel, false otherwise.
2753 """
54f9ee45 2754 return _core_.Image_HasAlpha(*args, **kwargs)
e811c8ce 2755
68350608
RD
2756 def InitAlpha(*args, **kwargs):
2757 """
2758 InitAlpha(self)
2759
2760 Initializes the image alpha channel data. It is an error to call it if
2761 the image already has alpha data. If it doesn't, alpha data will be by
2762 default initialized to all pixels being fully opaque. But if the image
2763 has a a mask colour, all mask pixels will be completely transparent.
2764 """
2765 return _core_.Image_InitAlpha(*args, **kwargs)
2766
bcd0d7b6
RD
2767 def IsTransparent(*args, **kwargs):
2768 """
7a27cf7c 2769 IsTransparent(self, int x, int y, byte threshold=IMAGE_ALPHA_THRESHOLD) -> bool
bcd0d7b6 2770
7a27cf7c
RD
2771 Returns ``True`` if this pixel is masked or has an alpha value less
2772 than the spcified threshold.
bcd0d7b6
RD
2773 """
2774 return _core_.Image_IsTransparent(*args, **kwargs)
2775
e811c8ce 2776 def FindFirstUnusedColour(*args, **kwargs):
fd2dc343
RD
2777 """
2778 FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)
2779
2780 Find first colour that is not used in the image and has higher RGB
2781 values than startR, startG, startB. Returns a tuple consisting of a
2782 success flag and rgb values.
2783 """
54f9ee45 2784 return _core_.Image_FindFirstUnusedColour(*args, **kwargs)
e811c8ce 2785
4cf4100f
RD
2786 def ConvertAlphaToMask(*args, **kwargs):
2787 """
bcd0d7b6 2788 ConvertAlphaToMask(self, byte threshold=IMAGE_ALPHA_THRESHOLD) -> bool
4cf4100f 2789
7a27cf7c
RD
2790 If the image has alpha channel, this method converts it to mask. All
2791 pixels with alpha value less than ``threshold`` are replaced with the
2792 mask colour and the alpha channel is removed. The mask colour is
2793 chosen automatically using `FindFirstUnusedColour`.
4cf4100f
RD
2794
2795 If the image image doesn't have alpha channel, ConvertAlphaToMask does
2796 nothing.
2797 """
2798 return _core_.Image_ConvertAlphaToMask(*args, **kwargs)
2799
8fb0e70a
RD
2800 def ConvertColourToAlpha(*args, **kwargs):
2801 """
7a27cf7c 2802 ConvertColourToAlpha(self, byte r, byte g, byte b) -> bool
8fb0e70a
RD
2803
2804 This method converts an image where the original alpha information is
2805 only available as a shades of a colour (actually shades of grey)
2806 typically when you draw anti-aliased text into a bitmap. The DC
2807 drawing routines draw grey values on the black background although
2808 they actually mean to draw white with differnt alpha values. This
2809 method reverses it, assuming a black (!) background and white text.
2810 The method will then fill up the whole image with the colour given.
2811 """
2812 return _core_.Image_ConvertColourToAlpha(*args, **kwargs)
2813
e811c8ce 2814 def SetMaskFromImage(*args, **kwargs):
7a27cf7c
RD
2815 """
2816 SetMaskFromImage(self, Image mask, byte mr, byte mg, byte mb) -> bool
2817
2818 Sets the image's mask so that the pixels that have RGB value of
2819 ``(mr,mg,mb)`` in ``mask`` will be masked in this image. This is done
2820 by first finding an unused colour in the image, setting this colour as
2821 the mask colour and then using this colour to draw all pixels in the
2822 image who corresponding pixel in mask has given RGB value.
2823
2824 Returns ``False`` if ``mask`` does not have same dimensions as the
2825 image or if there is no unused colour left. Returns ``True`` if the
2826 mask was successfully applied.
2827
2828 Note that this method involves computing the histogram, which is
2829 computationally intensive operation.
2830 """
54f9ee45 2831 return _core_.Image_SetMaskFromImage(*args, **kwargs)
e811c8ce
RD
2832
2833 def CanRead(*args, **kwargs):
7a27cf7c
RD
2834 """
2835 CanRead(String filename) -> bool
2836
2837 Returns True if the image handlers can read this file.
2838 """
54f9ee45 2839 return _core_.Image_CanRead(*args, **kwargs)
e811c8ce
RD
2840
2841 CanRead = staticmethod(CanRead)
2842 def GetImageCount(*args, **kwargs):
7a27cf7c
RD
2843 """
2844 GetImageCount(String filename, long type=BITMAP_TYPE_ANY) -> int
2845
2846 If the image file contains more than one image and the image handler
2847 is capable of retrieving these individually, this function will return
2848 the number of available images.
2849 """
54f9ee45 2850 return _core_.Image_GetImageCount(*args, **kwargs)
e811c8ce
RD
2851
2852 GetImageCount = staticmethod(GetImageCount)
2853 def LoadFile(*args, **kwargs):
7a27cf7c
RD
2854 """
2855 LoadFile(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> bool
2856
2857 Loads an image from a file. If no handler type is provided, the
2858 library will try to autodetect the format.
2859 """
54f9ee45 2860 return _core_.Image_LoadFile(*args, **kwargs)
e811c8ce
RD
2861
2862 def LoadMimeFile(*args, **kwargs):
7a27cf7c
RD
2863 """
2864 LoadMimeFile(self, String name, String mimetype, int index=-1) -> bool
2865
2866 Loads an image from a file, specifying the image type with a MIME type
2867 string.
2868 """
54f9ee45 2869 return _core_.Image_LoadMimeFile(*args, **kwargs)
e811c8ce
RD
2870
2871 def SaveFile(*args, **kwargs):
7a27cf7c
RD
2872 """
2873 SaveFile(self, String name, int type) -> bool
2874
2875 Saves an image in the named file.
2876 """
54f9ee45 2877 return _core_.Image_SaveFile(*args, **kwargs)
e811c8ce
RD
2878
2879 def SaveMimeFile(*args, **kwargs):
7a27cf7c
RD
2880 """
2881 SaveMimeFile(self, String name, String mimetype) -> bool
2882
2883 Saves an image in the named file.
2884 """
54f9ee45 2885 return _core_.Image_SaveMimeFile(*args, **kwargs)
e811c8ce
RD
2886
2887 def CanReadStream(*args, **kwargs):
7a27cf7c
RD
2888 """
2889 CanReadStream(InputStream stream) -> bool
2890
2891 Returns True if the image handlers can read an image file from the
2892 data currently on the input stream, or a readable Python file-like
2893 object.
2894 """
54f9ee45 2895 return _core_.Image_CanReadStream(*args, **kwargs)
e811c8ce
RD
2896
2897 CanReadStream = staticmethod(CanReadStream)
2898 def LoadStream(*args, **kwargs):
7a27cf7c
RD
2899 """
2900 LoadStream(self, InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> bool
2901
2902 Loads an image from an input stream or a readable Python file-like
2903 object. If no handler type is provided, the library will try to
2904 autodetect the format.
2905 """
54f9ee45 2906 return _core_.Image_LoadStream(*args, **kwargs)
e811c8ce
RD
2907
2908 def LoadMimeStream(*args, **kwargs):
7a27cf7c
RD
2909 """
2910 LoadMimeStream(self, InputStream stream, String mimetype, int index=-1) -> bool
2911
2912 Loads an image from an input stream or a readable Python file-like
2913 object, using a MIME type string to specify the image file format.
2914 """
54f9ee45 2915 return _core_.Image_LoadMimeStream(*args, **kwargs)
e811c8ce 2916
b39fe951 2917 def IsOk(*args, **kwargs):
7a27cf7c 2918 """
b39fe951 2919 IsOk(self) -> bool
7a27cf7c
RD
2920
2921 Returns true if image data is present.
2922 """
b39fe951 2923 return _core_.Image_IsOk(*args, **kwargs)
e811c8ce 2924
b39fe951 2925 Ok = IsOk
e811c8ce 2926 def GetWidth(*args, **kwargs):
7a27cf7c
RD
2927 """
2928 GetWidth(self) -> int
2929
2930 Gets the width of the image in pixels.
2931 """
54f9ee45 2932 return _core_.Image_GetWidth(*args, **kwargs)
e811c8ce
RD
2933
2934 def GetHeight(*args, **kwargs):
7a27cf7c
RD
2935 """
2936 GetHeight(self) -> int
2937
2938 Gets the height of the image in pixels.
2939 """
54f9ee45 2940 return _core_.Image_GetHeight(*args, **kwargs)
e811c8ce 2941
b2df227b 2942 def GetSize(*args, **kwargs):
7a27cf7c
RD
2943 """
2944 GetSize(self) -> Size
2945
2946 Returns the size of the image in pixels.
2947 """
54f9ee45 2948 return _core_.Image_GetSize(*args, **kwargs)
b2df227b 2949
e811c8ce 2950 def GetSubImage(*args, **kwargs):
7a27cf7c
RD
2951 """
2952 GetSubImage(self, Rect rect) -> Image
2953
2954 Returns a sub image of the current one as long as the rect belongs
2955 entirely to the image.
2956 """
54f9ee45 2957 return _core_.Image_GetSubImage(*args, **kwargs)
e811c8ce 2958
aff4cc5c 2959 def Size(*args, **kwargs):
7a27cf7c
RD
2960 """
2961 Size(self, Size size, Point pos, int r=-1, int g=-1, int b=-1) -> Image
2962
2963 Returns a resized version of this image without scaling it by adding
2964 either a border with the given colour or cropping as necessary. The
2965 image is pasted into a new image with the given size and background
2966 colour at the position ``pos`` relative to the upper left of the new
2967 image. If red = green = blue = -1 then use either the current mask
2968 colour if set or find, use, and set a suitable mask colour for any
2969 newly exposed areas.
2970 """
aff4cc5c
RD
2971 return _core_.Image_Size(*args, **kwargs)
2972
e811c8ce 2973 def Copy(*args, **kwargs):
7a27cf7c
RD
2974 """
2975 Copy(self) -> Image
2976
2977 Returns an identical copy of the image.
2978 """
54f9ee45 2979 return _core_.Image_Copy(*args, **kwargs)
e811c8ce
RD
2980
2981 def Paste(*args, **kwargs):
7a27cf7c
RD
2982 """
2983 Paste(self, Image image, int x, int y)
2984
2985 Pastes ``image`` into this instance and takes care of the mask colour
2986 and any out of bounds problems.
2987 """
54f9ee45 2988 return _core_.Image_Paste(*args, **kwargs)
e811c8ce
RD
2989
2990 def GetData(*args, **kwargs):
61d07ac7
RD
2991 """
2992 GetData(self) -> PyObject
2993
2994 Returns a string containing a copy of the RGB bytes of the image.
2995 """
54f9ee45 2996 return _core_.Image_GetData(*args, **kwargs)
e811c8ce
RD
2997
2998 def SetData(*args, **kwargs):
61d07ac7
RD
2999 """
3000 SetData(self, buffer data)
3001
3002 Resets the Image's RGB data from a buffer of RGB bytes. Accepts
3003 either a string or a buffer object holding the data and the length of
3004 the data must be width*height*3.
3005 """
54f9ee45 3006 return _core_.Image_SetData(*args, **kwargs)
e811c8ce
RD
3007
3008 def GetDataBuffer(*args, **kwargs):
61d07ac7
RD
3009 """
3010 GetDataBuffer(self) -> PyObject
3011
3012 Returns a writable Python buffer object that is pointing at the RGB
7a27cf7c
RD
3013 image data buffer inside the wx.Image. You need to ensure that you do
3014 not use this buffer object after the image has been destroyed.
61d07ac7 3015 """
54f9ee45 3016 return _core_.Image_GetDataBuffer(*args, **kwargs)
e811c8ce
RD
3017
3018 def SetDataBuffer(*args, **kwargs):
61d07ac7
RD
3019 """
3020 SetDataBuffer(self, buffer data)
3021
3022 Sets the internal image data pointer to point at a Python buffer
7a27cf7c
RD
3023 object. This can save making an extra copy of the data but you must
3024 ensure that the buffer object lives longer than the wx.Image does.
61d07ac7 3025 """
54f9ee45 3026 return _core_.Image_SetDataBuffer(*args, **kwargs)
e811c8ce
RD
3027
3028 def GetAlphaData(*args, **kwargs):
61d07ac7
RD
3029 """
3030 GetAlphaData(self) -> PyObject
3031
3032 Returns a string containing a copy of the alpha bytes of the image.
3033 """
54f9ee45 3034 return _core_.Image_GetAlphaData(*args, **kwargs)
e811c8ce
RD
3035
3036 def SetAlphaData(*args, **kwargs):
61d07ac7
RD
3037 """
3038 SetAlphaData(self, buffer alpha)
3039
3040 Resets the Image's alpha data from a buffer of bytes. Accepts either
3041 a string or a buffer object holding the data and the length of the
3042 data must be width*height.
3043 """
54f9ee45 3044 return _core_.Image_SetAlphaData(*args, **kwargs)
e811c8ce
RD
3045
3046 def GetAlphaBuffer(*args, **kwargs):
fc46b7f3
RD
3047 """
3048 GetAlphaBuffer(self) -> PyObject
3049
3050 Returns a writable Python buffer object that is pointing at the Alpha
3051 data buffer inside the wx.Image. You need to ensure that you do not
3052 use this buffer object after the image has been destroyed.
3053 """
54f9ee45 3054 return _core_.Image_GetAlphaBuffer(*args, **kwargs)
e811c8ce
RD
3055
3056 def SetAlphaBuffer(*args, **kwargs):
fc46b7f3
RD
3057 """
3058 SetAlphaBuffer(self, buffer alpha)
3059
3060 Sets the internal image alpha pointer to point at a Python buffer
3061 object. This can save making an extra copy of the data but you must
3062 ensure that the buffer object lives as long as the wx.Image does.
3063 """
54f9ee45 3064 return _core_.Image_SetAlphaBuffer(*args, **kwargs)
e811c8ce
RD
3065
3066 def SetMaskColour(*args, **kwargs):
7a27cf7c
RD
3067 """
3068 SetMaskColour(self, byte r, byte g, byte b)
3069
3070 Sets the mask colour for this image (and tells the image to use the
3071 mask).
3072 """
54f9ee45 3073 return _core_.Image_SetMaskColour(*args, **kwargs)
e811c8ce 3074
aff4cc5c
RD
3075 def GetOrFindMaskColour(*args, **kwargs):
3076 """
3077 GetOrFindMaskColour() -> (r,g,b)
3078
3079 Get the current mask colour or find a suitable colour.
3080 """
3081 return _core_.Image_GetOrFindMaskColour(*args, **kwargs)
3082
e811c8ce 3083 def GetMaskRed(*args, **kwargs):
7a27cf7c
RD
3084 """
3085 GetMaskRed(self) -> byte
3086
3087 Gets the red component of the mask colour.
3088 """
54f9ee45 3089 return _core_.Image_GetMaskRed(*args, **kwargs)
e811c8ce
RD
3090
3091 def GetMaskGreen(*args, **kwargs):
7a27cf7c
RD
3092 """
3093 GetMaskGreen(self) -> byte
3094
3095 Gets the green component of the mask colour.
3096 """
54f9ee45 3097 return _core_.Image_GetMaskGreen(*args, **kwargs)
e811c8ce
RD
3098
3099 def GetMaskBlue(*args, **kwargs):
7a27cf7c
RD
3100 """
3101 GetMaskBlue(self) -> byte
3102
3103 Gets the blue component of the mask colour.
3104 """
54f9ee45 3105 return _core_.Image_GetMaskBlue(*args, **kwargs)
e811c8ce
RD
3106
3107 def SetMask(*args, **kwargs):
7a27cf7c
RD
3108 """
3109 SetMask(self, bool mask=True)
3110
3111 Specifies whether there is a mask or not. The area of the mask is
3112 determined by the current mask colour.
3113 """
54f9ee45 3114 return _core_.Image_SetMask(*args, **kwargs)
e811c8ce
RD
3115
3116 def HasMask(*args, **kwargs):
7a27cf7c
RD
3117 """
3118 HasMask(self) -> bool
3119
3120 Returns ``True`` if there is a mask active, ``False`` otherwise.
3121 """
54f9ee45 3122 return _core_.Image_HasMask(*args, **kwargs)
e811c8ce
RD
3123
3124 def Rotate(*args, **kwargs):
0df68c9f 3125 """
a95a7133 3126 Rotate(self, double angle, Point centre_of_rotation, bool interpolating=True,
0df68c9f 3127 Point offset_after_rotation=None) -> Image
7a27cf7c
RD
3128
3129 Rotates the image about the given point, by ``angle`` radians. Passing
3130 ``True`` to ``interpolating`` results in better image quality, but is
3131 slower. If the image has a mask, then the mask colour is used for the
3132 uncovered pixels in the rotated image background. Otherwise, black
3133 will be used as the fill colour.
3134
3135 Returns the rotated image, leaving this image intact.
0df68c9f 3136 """
54f9ee45 3137 return _core_.Image_Rotate(*args, **kwargs)
e811c8ce
RD
3138
3139 def Rotate90(*args, **kwargs):
7a27cf7c
RD
3140 """
3141 Rotate90(self, bool clockwise=True) -> Image
3142
3143 Returns a copy of the image rotated 90 degrees in the direction
3144 indicated by ``clockwise``.
3145 """
54f9ee45 3146 return _core_.Image_Rotate90(*args, **kwargs)
e811c8ce
RD
3147
3148 def Mirror(*args, **kwargs):
7a27cf7c
RD
3149 """
3150 Mirror(self, bool horizontally=True) -> Image
3151
3152 Returns a mirrored copy of the image. The parameter ``horizontally``
3153 indicates the orientation.
3154 """
54f9ee45 3155 return _core_.Image_Mirror(*args, **kwargs)
e811c8ce
RD
3156
3157 def Replace(*args, **kwargs):
0df68c9f 3158 """
7a27cf7c
RD
3159 Replace(self, byte r1, byte g1, byte b1, byte r2, byte g2, byte b2)
3160
3161 Replaces the colour specified by ``(r1,g1,b1)`` by the colour
3162 ``(r2,g2,b2)``.
0df68c9f 3163 """
54f9ee45 3164 return _core_.Image_Replace(*args, **kwargs)
e811c8ce 3165
32fe5131
RD
3166 def ConvertToGreyscale(*args, **kwargs):
3167 """
3168 ConvertToGreyscale(self, double lr=0.299, double lg=0.587, double lb=0.114) -> Image
3169
3170 Convert to greyscale image. Uses the luminance component (Y) of the
3171 image. The luma value (YUV) is calculated using (R * lr) + (G * lg) + (B * lb),
3172 defaults to ITU-T BT.601
3173 """
3174 return _core_.Image_ConvertToGreyscale(*args, **kwargs)
3175
e811c8ce 3176 def ConvertToMono(*args, **kwargs):
7a27cf7c
RD
3177 """
3178 ConvertToMono(self, byte r, byte g, byte b) -> Image
3179
3180 Returns monochromatic version of the image. The returned image has
3181 white colour where the original has ``(r,g,b)`` colour and black
3182 colour everywhere else.
3183 """
54f9ee45 3184 return _core_.Image_ConvertToMono(*args, **kwargs)
e811c8ce
RD
3185
3186 def SetOption(*args, **kwargs):
7a27cf7c
RD
3187 """
3188 SetOption(self, String name, String value)
3189
3190 Sets an image handler defined option. For example, when saving as a
3191 JPEG file, the option ``wx.IMAGE_OPTION_QUALITY`` is used, which is a
3192 number between 0 and 100 (0 is terrible, 100 is very good).
3193 """
54f9ee45 3194 return _core_.Image_SetOption(*args, **kwargs)
e811c8ce
RD
3195
3196 def SetOptionInt(*args, **kwargs):
7a27cf7c
RD
3197 """
3198 SetOptionInt(self, String name, int value)
3199
3200 Sets an image option as an integer.
3201 """
54f9ee45 3202 return _core_.Image_SetOptionInt(*args, **kwargs)
e811c8ce
RD
3203
3204 def GetOption(*args, **kwargs):
7a27cf7c
RD
3205 """
3206 GetOption(self, String name) -> String
3207
3208 Gets the value of an image handler option.
3209 """
54f9ee45 3210 return _core_.Image_GetOption(*args, **kwargs)
e811c8ce
RD
3211
3212 def GetOptionInt(*args, **kwargs):
7a27cf7c
RD
3213 """
3214 GetOptionInt(self, String name) -> int
3215
3216 Gets the value of an image handler option as an integer. If the given
3217 option is not present, the function returns 0.
3218 """
54f9ee45 3219 return _core_.Image_GetOptionInt(*args, **kwargs)
e811c8ce
RD
3220
3221 def HasOption(*args, **kwargs):
7a27cf7c
RD
3222 """
3223 HasOption(self, String name) -> bool
3224
3225 Returns true if the given option is present.
3226 """
54f9ee45 3227 return _core_.Image_HasOption(*args, **kwargs)
e811c8ce
RD
3228
3229 def CountColours(*args, **kwargs):
a95a7133 3230 """CountColours(self, unsigned long stopafter=(unsigned long) -1) -> unsigned long"""
54f9ee45 3231 return _core_.Image_CountColours(*args, **kwargs)
e811c8ce
RD
3232
3233 def ComputeHistogram(*args, **kwargs):
a95a7133 3234 """ComputeHistogram(self, ImageHistogram h) -> unsigned long"""
54f9ee45 3235 return _core_.Image_ComputeHistogram(*args, **kwargs)
e811c8ce
RD
3236
3237 def AddHandler(*args, **kwargs):
66c033b4 3238 """AddHandler(ImageHandler handler)"""
54f9ee45 3239 return _core_.Image_AddHandler(*args, **kwargs)
e811c8ce
RD
3240
3241 AddHandler = staticmethod(AddHandler)
3242 def InsertHandler(*args, **kwargs):
66c033b4 3243 """InsertHandler(ImageHandler handler)"""
54f9ee45 3244 return _core_.Image_InsertHandler(*args, **kwargs)
e811c8ce
RD
3245
3246 InsertHandler = staticmethod(InsertHandler)
3247 def RemoveHandler(*args, **kwargs):
66c033b4 3248 """RemoveHandler(String name) -> bool"""
54f9ee45 3249 return _core_.Image_RemoveHandler(*args, **kwargs)
e811c8ce
RD
3250
3251 RemoveHandler = staticmethod(RemoveHandler)
0085ce49
RD
3252 def GetHandlers(*args, **kwargs):
3253 """GetHandlers() -> PyObject"""
3254 return _core_.Image_GetHandlers(*args, **kwargs)
3255
3256 GetHandlers = staticmethod(GetHandlers)
e811c8ce 3257 def GetImageExtWildcard(*args, **kwargs):
7a27cf7c
RD
3258 """
3259 GetImageExtWildcard() -> String
3260
3261 Iterates all registered wxImageHandler objects, and returns a string
3262 containing file extension masks suitable for passing to file open/save
3263 dialog boxes.
3264 """
54f9ee45 3265 return _core_.Image_GetImageExtWildcard(*args, **kwargs)
e811c8ce
RD
3266
3267 GetImageExtWildcard = staticmethod(GetImageExtWildcard)
3268 def ConvertToBitmap(*args, **kwargs):
1fbf26be 3269 """ConvertToBitmap(self, int depth=-1) -> Bitmap"""
54f9ee45 3270 return _core_.Image_ConvertToBitmap(*args, **kwargs)
e811c8ce
RD
3271
3272 def ConvertToMonoBitmap(*args, **kwargs):
7a27cf7c 3273 """ConvertToMonoBitmap(self, byte red, byte green, byte blue) -> Bitmap"""
54f9ee45 3274 return _core_.Image_ConvertToMonoBitmap(*args, **kwargs)
e811c8ce 3275
943e8dfd
RD
3276 def RotateHue(*args, **kwargs):
3277 """
3278 RotateHue(self, double angle)
3279
3280 Rotates the hue of each pixel of the image. Hue is a double in the
3281 range -1.0..1.0 where -1.0 is -360 degrees and 1.0 is 360 degrees
3282 """
3283 return _core_.Image_RotateHue(*args, **kwargs)
3284
3285 def RGBtoHSV(*args, **kwargs):
3286 """
3287 RGBtoHSV(Image_RGBValue rgb) -> Image_HSVValue
3288
3289 Converts a color in RGB color space to HSV color space.
3290 """
3291 return _core_.Image_RGBtoHSV(*args, **kwargs)
3292
3293 RGBtoHSV = staticmethod(RGBtoHSV)
3294 def HSVtoRGB(*args, **kwargs):
3295 """
3296 HSVtoRGB(Image_HSVValue hsv) -> Image_RGBValue
3297
3298 Converts a color in HSV color space to RGB color space.
3299 """
3300 return _core_.Image_HSVtoRGB(*args, **kwargs)
3301
3302 HSVtoRGB = staticmethod(HSVtoRGB)
b39fe951 3303 def __nonzero__(self): return self.IsOk()
97ab0f6a
RD
3304 AlphaBuffer = property(GetAlphaBuffer,SetAlphaBuffer,doc="See `GetAlphaBuffer` and `SetAlphaBuffer`")
3305 AlphaData = property(GetAlphaData,SetAlphaData,doc="See `GetAlphaData` and `SetAlphaData`")
3306 Data = property(GetData,SetData,doc="See `GetData` and `SetData`")
3307 DataBuffer = property(GetDataBuffer,SetDataBuffer,doc="See `GetDataBuffer` and `SetDataBuffer`")
3308 Height = property(GetHeight,doc="See `GetHeight`")
3309 MaskBlue = property(GetMaskBlue,doc="See `GetMaskBlue`")
3310 MaskGreen = property(GetMaskGreen,doc="See `GetMaskGreen`")
3311 MaskRed = property(GetMaskRed,doc="See `GetMaskRed`")
97ab0f6a 3312 Width = property(GetWidth,doc="See `GetWidth`")
2131d850 3313_core_.Image_swigregister(Image)
d14a1e28
RD
3314
3315def ImageFromMime(*args, **kwargs):
7a27cf7c
RD
3316 """
3317 ImageFromMime(String name, String mimetype, int index=-1) -> Image
3318
3319 Loads an image from a file, using a MIME type string (such as
3320 'image/jpeg') to specify image type.
3321 """
54f9ee45 3322 val = _core_.new_ImageFromMime(*args, **kwargs)
d14a1e28
RD
3323 return val
3324
3325def ImageFromStream(*args, **kwargs):
7a27cf7c
RD
3326 """
3327 ImageFromStream(InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> Image
3328
3329 Loads an image from an input stream, or any readable Python file-like
3330 object.
3331 """
54f9ee45 3332 val = _core_.new_ImageFromStream(*args, **kwargs)
d14a1e28
RD
3333 return val
3334
3335def ImageFromStreamMime(*args, **kwargs):
7a27cf7c
RD
3336 """
3337 ImageFromStreamMime(InputStream stream, String mimetype, int index=-1) -> Image
3338
3339 Loads an image from an input stream, or any readable Python file-like
3340 object, specifying the image format with a MIME type string.
3341 """
54f9ee45 3342 val = _core_.new_ImageFromStreamMime(*args, **kwargs)
d14a1e28
RD
3343 return val
3344
66c033b4 3345def EmptyImage(*args, **kwargs):
61d07ac7
RD
3346 """
3347 EmptyImage(int width=0, int height=0, bool clear=True) -> Image
3348
3349 Construct an empty image of a given size, optionally setting all
3350 pixels to black.
3351 """
66c033b4 3352 val = _core_.new_EmptyImage(*args, **kwargs)
d14a1e28
RD
3353 return val
3354
3355def ImageFromBitmap(*args, **kwargs):
61d07ac7
RD
3356 """
3357 ImageFromBitmap(Bitmap bitmap) -> Image
3358
3359 Construct an Image from a `wx.Bitmap`.
3360 """
54f9ee45 3361 val = _core_.new_ImageFromBitmap(*args, **kwargs)
d14a1e28
RD
3362 return val
3363
3364def ImageFromData(*args, **kwargs):
61d07ac7
RD
3365 """
3366 ImageFromData(int width, int height, buffer data) -> Image
3367
3368 Construct an Image from a buffer of RGB bytes. Accepts either a
3369 string or a buffer object holding the data and the length of the data
3370 must be width*height*3.
3371 """
54f9ee45 3372 val = _core_.new_ImageFromData(*args, **kwargs)
d14a1e28
RD
3373 return val
3374
1823fbb4 3375def ImageFromDataWithAlpha(*args, **kwargs):
61d07ac7
RD
3376 """
3377 ImageFromDataWithAlpha(int width, int height, buffer data, buffer alpha) -> Image
3378
3379 Construct an Image from a buffer of RGB bytes with an Alpha channel.
3380 Accepts either a string or a buffer object holding the data and the
7a27cf7c
RD
3381 length of the data must be width*height*3 bytes, and the length of the
3382 alpha data must be width*height bytes.
61d07ac7 3383 """
1823fbb4 3384 val = _core_.new_ImageFromDataWithAlpha(*args, **kwargs)
1823fbb4
RD
3385 return val
3386
e811c8ce 3387def Image_CanRead(*args, **kwargs):
0085ce49 3388 """
7a27cf7c
RD
3389 Image_CanRead(String filename) -> bool
3390
3391 Returns True if the image handlers can read this file.
3392 """
0085ce49 3393 return _core_.Image_CanRead(*args, **kwargs)
d14a1e28 3394
e811c8ce 3395def Image_GetImageCount(*args, **kwargs):
0085ce49 3396 """
7a27cf7c
RD
3397 Image_GetImageCount(String filename, long type=BITMAP_TYPE_ANY) -> int
3398
3399 If the image file contains more than one image and the image handler
3400 is capable of retrieving these individually, this function will return
3401 the number of available images.
3402 """
0085ce49 3403 return _core_.Image_GetImageCount(*args, **kwargs)
d14a1e28 3404
e811c8ce 3405def Image_CanReadStream(*args, **kwargs):
0085ce49 3406 """
7a27cf7c
RD
3407 Image_CanReadStream(InputStream stream) -> bool
3408
3409 Returns True if the image handlers can read an image file from the
3410 data currently on the input stream, or a readable Python file-like
3411 object.
3412 """
0085ce49 3413 return _core_.Image_CanReadStream(*args, **kwargs)
d14a1e28 3414
e811c8ce 3415def Image_AddHandler(*args, **kwargs):
0085ce49
RD
3416 """Image_AddHandler(ImageHandler handler)"""
3417 return _core_.Image_AddHandler(*args, **kwargs)
d14a1e28 3418
e811c8ce 3419def Image_InsertHandler(*args, **kwargs):
0085ce49
RD
3420 """Image_InsertHandler(ImageHandler handler)"""
3421 return _core_.Image_InsertHandler(*args, **kwargs)
d14a1e28 3422
e811c8ce 3423def Image_RemoveHandler(*args, **kwargs):
0085ce49
RD
3424 """Image_RemoveHandler(String name) -> bool"""
3425 return _core_.Image_RemoveHandler(*args, **kwargs)
d14a1e28 3426
0085ce49
RD
3427def Image_GetHandlers(*args):
3428 """Image_GetHandlers() -> PyObject"""
3429 return _core_.Image_GetHandlers(*args)
3430
3431def Image_GetImageExtWildcard(*args):
3432 """
7a27cf7c
RD
3433 Image_GetImageExtWildcard() -> String
3434
3435 Iterates all registered wxImageHandler objects, and returns a string
3436 containing file extension masks suitable for passing to file open/save
3437 dialog boxes.
3438 """
0085ce49 3439 return _core_.Image_GetImageExtWildcard(*args)
d14a1e28 3440
943e8dfd 3441def Image_RGBtoHSV(*args, **kwargs):
0085ce49 3442 """
943e8dfd
RD
3443 Image_RGBtoHSV(Image_RGBValue rgb) -> Image_HSVValue
3444
3445 Converts a color in RGB color space to HSV color space.
3446 """
0085ce49 3447 return _core_.Image_RGBtoHSV(*args, **kwargs)
943e8dfd
RD
3448
3449def Image_HSVtoRGB(*args, **kwargs):
0085ce49 3450 """
943e8dfd
RD
3451 Image_HSVtoRGB(Image_HSVValue hsv) -> Image_RGBValue
3452
3453 Converts a color in HSV color space to RGB color space.
3454 """
0085ce49 3455 return _core_.Image_HSVtoRGB(*args, **kwargs)
943e8dfd 3456
fc46b7f3
RD
3457
3458def _ImageFromBuffer(*args, **kwargs):
3459 """_ImageFromBuffer(int width, int height, buffer data, buffer alpha=None) -> Image"""
3460 return _core_._ImageFromBuffer(*args, **kwargs)
3461def ImageFromBuffer(width, height, dataBuffer, alphaBuffer=None):
3462 """
3463 Creates a `wx.Image` from the data in dataBuffer. The dataBuffer
eec1c382
RD
3464 parameter must be a Python object that implements the buffer interface,
3465 such as a string, array, etc. The dataBuffer object is expected to
3466 contain a series of RGB bytes and be width*height*3 bytes long. A buffer
3467 object can optionally be supplied for the image's alpha channel data, and
3468 it is expected to be width*height bytes long.
fc46b7f3
RD
3469
3470 The wx.Image will be created with its data and alpha pointers initialized
3471 to the memory address pointed to by the buffer objects, thus saving the
3472 time needed to copy the image data from the buffer object to the wx.Image.
3473 While this has advantages, it also has the shoot-yourself-in-the-foot
3474 risks associated with sharing a C pointer between two objects.
3475
3476 To help alleviate the risk a reference to the data and alpha buffer
3477 objects are kept with the wx.Image, so that they won't get deleted until
3478 after the wx.Image is deleted. However please be aware that it is not
3479 guaranteed that an object won't move its memory buffer to a new location
3480 when it needs to resize its contents. If that happens then the wx.Image
3481 will end up referring to an invalid memory location and could cause the
3482 application to crash. Therefore care should be taken to not manipulate
3483 the objects used for the data and alpha buffers in a way that would cause
3484 them to change size.
3485 """
fc46b7f3
RD
3486 image = _core_._ImageFromBuffer(width, height, dataBuffer, alphaBuffer)
3487 image._buffer = dataBuffer
3488 image._alpha = alphaBuffer
3489 return image
3490
5e4ca4a8
RD
3491def InitAllImageHandlers():
3492 """
3493 The former functionality of InitAllImageHanders is now done internal to
3494 the _core_ extension module and so this function has become a simple NOP.
3495 """
3496 pass
d14a1e28 3497
54f9ee45
RD
3498IMAGE_RESOLUTION_INCHES = _core_.IMAGE_RESOLUTION_INCHES
3499IMAGE_RESOLUTION_CM = _core_.IMAGE_RESOLUTION_CM
b9d6a5f3
RD
3500PNG_TYPE_COLOUR = _core_.PNG_TYPE_COLOUR
3501PNG_TYPE_GREY = _core_.PNG_TYPE_GREY
3502PNG_TYPE_GREY_RED = _core_.PNG_TYPE_GREY_RED
54f9ee45
RD
3503BMP_24BPP = _core_.BMP_24BPP
3504BMP_8BPP = _core_.BMP_8BPP
3505BMP_8BPP_GREY = _core_.BMP_8BPP_GREY
3506BMP_8BPP_GRAY = _core_.BMP_8BPP_GRAY
3507BMP_8BPP_RED = _core_.BMP_8BPP_RED
3508BMP_8BPP_PALETTE = _core_.BMP_8BPP_PALETTE
3509BMP_4BPP = _core_.BMP_4BPP
3510BMP_1BPP = _core_.BMP_1BPP
3511BMP_1BPP_BW = _core_.BMP_1BPP_BW
d14a1e28 3512class BMPHandler(ImageHandler):
27fb7603 3513 """A `wx.ImageHandler` for \*.bmp bitmap files."""
0085ce49
RD
3514 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3515 __repr__ = _swig_repr
3516 def __init__(self, *args, **kwargs):
27fb7603
RD
3517 """
3518 __init__(self) -> BMPHandler
3519
3520 A `wx.ImageHandler` for \*.bmp bitmap files.
3521 """
0085ce49 3522 _core_.BMPHandler_swiginit(self,_core_.new_BMPHandler(*args, **kwargs))
2131d850 3523_core_.BMPHandler_swigregister(BMPHandler)
d14a1e28 3524NullImage = cvar.NullImage
0c243d93 3525IMAGE_OPTION_FILENAME = cvar.IMAGE_OPTION_FILENAME
d14a1e28
RD
3526IMAGE_OPTION_BMP_FORMAT = cvar.IMAGE_OPTION_BMP_FORMAT
3527IMAGE_OPTION_CUR_HOTSPOT_X = cvar.IMAGE_OPTION_CUR_HOTSPOT_X
3528IMAGE_OPTION_CUR_HOTSPOT_Y = cvar.IMAGE_OPTION_CUR_HOTSPOT_Y
3529IMAGE_OPTION_RESOLUTION = cvar.IMAGE_OPTION_RESOLUTION
0c243d93
RD
3530IMAGE_OPTION_RESOLUTIONX = cvar.IMAGE_OPTION_RESOLUTIONX
3531IMAGE_OPTION_RESOLUTIONY = cvar.IMAGE_OPTION_RESOLUTIONY
d14a1e28 3532IMAGE_OPTION_RESOLUTIONUNIT = cvar.IMAGE_OPTION_RESOLUTIONUNIT
24d7cbea 3533IMAGE_OPTION_QUALITY = cvar.IMAGE_OPTION_QUALITY
0c243d93
RD
3534IMAGE_OPTION_BITSPERSAMPLE = cvar.IMAGE_OPTION_BITSPERSAMPLE
3535IMAGE_OPTION_SAMPLESPERPIXEL = cvar.IMAGE_OPTION_SAMPLESPERPIXEL
3536IMAGE_OPTION_COMPRESSION = cvar.IMAGE_OPTION_COMPRESSION
3537IMAGE_OPTION_IMAGEDESCRIPTOR = cvar.IMAGE_OPTION_IMAGEDESCRIPTOR
b9d6a5f3
RD
3538IMAGE_OPTION_PNG_FORMAT = cvar.IMAGE_OPTION_PNG_FORMAT
3539IMAGE_OPTION_PNG_BITDEPTH = cvar.IMAGE_OPTION_PNG_BITDEPTH
d14a1e28
RD
3540
3541class ICOHandler(BMPHandler):
27fb7603 3542 """A `wx.ImageHandler` for \*.ico icon files."""
0085ce49
RD
3543 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3544 __repr__ = _swig_repr
3545 def __init__(self, *args, **kwargs):
27fb7603
RD
3546 """
3547 __init__(self) -> ICOHandler
3548
3549 A `wx.ImageHandler` for \*.ico icon files.
3550 """
0085ce49 3551 _core_.ICOHandler_swiginit(self,_core_.new_ICOHandler(*args, **kwargs))
2131d850 3552_core_.ICOHandler_swigregister(ICOHandler)
d14a1e28
RD
3553
3554class CURHandler(ICOHandler):
27fb7603 3555 """A `wx.ImageHandler` for \*.cur cursor files."""
0085ce49
RD
3556 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3557 __repr__ = _swig_repr
3558 def __init__(self, *args, **kwargs):
27fb7603
RD
3559 """
3560 __init__(self) -> CURHandler
3561
3562 A `wx.ImageHandler` for \*.cur cursor files.
3563 """
0085ce49 3564 _core_.CURHandler_swiginit(self,_core_.new_CURHandler(*args, **kwargs))
2131d850 3565_core_.CURHandler_swigregister(CURHandler)
d14a1e28
RD
3566
3567class ANIHandler(CURHandler):
27fb7603 3568 """A `wx.ImageHandler` for \*.ani animated cursor files."""
0085ce49
RD
3569 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3570 __repr__ = _swig_repr
3571 def __init__(self, *args, **kwargs):
27fb7603
RD
3572 """
3573 __init__(self) -> ANIHandler
3574
3575 A `wx.ImageHandler` for \*.ani animated cursor files.
3576 """
0085ce49 3577 _core_.ANIHandler_swiginit(self,_core_.new_ANIHandler(*args, **kwargs))
2131d850 3578_core_.ANIHandler_swigregister(ANIHandler)
d14a1e28
RD
3579
3580class PNGHandler(ImageHandler):
27fb7603 3581 """A `wx.ImageHandler` for PNG image files."""
0085ce49
RD
3582 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3583 __repr__ = _swig_repr
3584 def __init__(self, *args, **kwargs):
27fb7603
RD
3585 """
3586 __init__(self) -> PNGHandler
3587
3588 A `wx.ImageHandler` for PNG image files.
3589 """
0085ce49 3590 _core_.PNGHandler_swiginit(self,_core_.new_PNGHandler(*args, **kwargs))
2131d850 3591_core_.PNGHandler_swigregister(PNGHandler)
d14a1e28
RD
3592
3593class GIFHandler(ImageHandler):
27fb7603 3594 """A `wx.ImageHandler` for GIF image files."""
0085ce49
RD
3595 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3596 __repr__ = _swig_repr
3597 def __init__(self, *args, **kwargs):
27fb7603
RD
3598 """
3599 __init__(self) -> GIFHandler
3600
3601 A `wx.ImageHandler` for GIF image files.
3602 """
0085ce49 3603 _core_.GIFHandler_swiginit(self,_core_.new_GIFHandler(*args, **kwargs))
2131d850 3604_core_.GIFHandler_swigregister(GIFHandler)
d14a1e28
RD
3605
3606class PCXHandler(ImageHandler):
27fb7603 3607 """A `wx.ImageHandler` for PCX imager files."""
0085ce49
RD
3608 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3609 __repr__ = _swig_repr
3610 def __init__(self, *args, **kwargs):
27fb7603
RD
3611 """
3612 __init__(self) -> PCXHandler
3613
3614 A `wx.ImageHandler` for PCX imager files.
3615 """
0085ce49 3616 _core_.PCXHandler_swiginit(self,_core_.new_PCXHandler(*args, **kwargs))
2131d850 3617_core_.PCXHandler_swigregister(PCXHandler)
d14a1e28
RD
3618
3619class JPEGHandler(ImageHandler):
27fb7603 3620 """A `wx.ImageHandler` for JPEG/JPG image files."""
0085ce49
RD
3621 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3622 __repr__ = _swig_repr
3623 def __init__(self, *args, **kwargs):
27fb7603
RD
3624 """
3625 __init__(self) -> JPEGHandler
3626
3627 A `wx.ImageHandler` for JPEG/JPG image files.
3628 """
0085ce49 3629 _core_.JPEGHandler_swiginit(self,_core_.new_JPEGHandler(*args, **kwargs))
2131d850 3630_core_.JPEGHandler_swigregister(JPEGHandler)
d14a1e28
RD
3631
3632class PNMHandler(ImageHandler):
27fb7603 3633 """A `wx.ImageHandler` for PNM image files."""
0085ce49
RD
3634 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3635 __repr__ = _swig_repr
3636 def __init__(self, *args, **kwargs):
27fb7603
RD
3637 """
3638 __init__(self) -> PNMHandler
3639
3640 A `wx.ImageHandler` for PNM image files.
3641 """
0085ce49 3642 _core_.PNMHandler_swiginit(self,_core_.new_PNMHandler(*args, **kwargs))
2131d850 3643_core_.PNMHandler_swigregister(PNMHandler)
d14a1e28
RD
3644
3645class XPMHandler(ImageHandler):
27fb7603 3646 """A `wx.ImageHandler` for XPM image."""
0085ce49
RD
3647 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3648 __repr__ = _swig_repr
3649 def __init__(self, *args, **kwargs):
27fb7603
RD
3650 """
3651 __init__(self) -> XPMHandler
3652
3653 A `wx.ImageHandler` for XPM image.
3654 """
0085ce49 3655 _core_.XPMHandler_swiginit(self,_core_.new_XPMHandler(*args, **kwargs))
2131d850 3656_core_.XPMHandler_swigregister(XPMHandler)
d14a1e28
RD
3657
3658class TIFFHandler(ImageHandler):
27fb7603 3659 """A `wx.ImageHandler` for TIFF image files."""
0085ce49
RD
3660 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3661 __repr__ = _swig_repr
3662 def __init__(self, *args, **kwargs):
27fb7603
RD
3663 """
3664 __init__(self) -> TIFFHandler
3665
3666 A `wx.ImageHandler` for TIFF image files.
3667 """
0085ce49 3668 _core_.TIFFHandler_swiginit(self,_core_.new_TIFFHandler(*args, **kwargs))
2131d850 3669_core_.TIFFHandler_swigregister(TIFFHandler)
d14a1e28 3670
580080c5
RD
3671class TGAHandler(ImageHandler):
3672 """A `wx.ImageHandler` for TGA image files."""
3673 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3674 __repr__ = _swig_repr
3675 def __init__(self, *args, **kwargs):
3676 """
3677 __init__(self) -> TGAHandler
3678
3679 A `wx.ImageHandler` for TGA image files.
3680 """
3681 _core_.TGAHandler_swiginit(self,_core_.new_TGAHandler(*args, **kwargs))
3682_core_.TGAHandler_swigregister(TGAHandler)
3683
c0de73ae
RD
3684QUANTIZE_INCLUDE_WINDOWS_COLOURS = _core_.QUANTIZE_INCLUDE_WINDOWS_COLOURS
3685QUANTIZE_FILL_DESTINATION_IMAGE = _core_.QUANTIZE_FILL_DESTINATION_IMAGE
3686class Quantize(object):
3687 """Performs quantization, or colour reduction, on a wxImage."""
0085ce49
RD
3688 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3689 def __init__(self): raise AttributeError, "No constructor defined"
3690 __repr__ = _swig_repr
c0de73ae
RD
3691 def Quantize(*args, **kwargs):
3692 """
3693 Quantize(Image src, Image dest, int desiredNoColours=236, int flags=wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE) -> bool
3694
3695 Reduce the colours in the source image and put the result into the
3696 destination image, setting the palette in the destination if
3697 needed. Both images may be the same, to overwrite the source image.
3698 """
3699 return _core_.Quantize_Quantize(*args, **kwargs)
3700
3701 Quantize = staticmethod(Quantize)
2131d850 3702_core_.Quantize_swigregister(Quantize)
c0de73ae
RD
3703
3704def Quantize_Quantize(*args, **kwargs):
0085ce49 3705 """
c0de73ae
RD
3706 Quantize_Quantize(Image src, Image dest, int desiredNoColours=236, int flags=wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE) -> bool
3707
3708 Reduce the colours in the source image and put the result into the
3709 destination image, setting the palette in the destination if
3710 needed. Both images may be the same, to overwrite the source image.
3711 """
0085ce49 3712 return _core_.Quantize_Quantize(*args, **kwargs)
c0de73ae 3713
d14a1e28
RD
3714#---------------------------------------------------------------------------
3715
3716class EvtHandler(Object):
093d3ff1 3717 """Proxy of C++ EvtHandler class"""
0085ce49
RD
3718 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3719 __repr__ = _swig_repr
3720 def __init__(self, *args, **kwargs):
a95a7133 3721 """__init__(self) -> EvtHandler"""
0085ce49 3722 _core_.EvtHandler_swiginit(self,_core_.new_EvtHandler(*args, **kwargs))
d49bdf34
RD
3723 self._setOORInfo(self)
3724
e811c8ce 3725 def GetNextHandler(*args, **kwargs):
a95a7133 3726 """GetNextHandler(self) -> EvtHandler"""
54f9ee45 3727 return _core_.EvtHandler_GetNextHandler(*args, **kwargs)
e811c8ce
RD
3728
3729 def GetPreviousHandler(*args, **kwargs):
a95a7133 3730 """GetPreviousHandler(self) -> EvtHandler"""
54f9ee45 3731 return _core_.EvtHandler_GetPreviousHandler(*args, **kwargs)
e811c8ce
RD
3732
3733 def SetNextHandler(*args, **kwargs):
a95a7133 3734 """SetNextHandler(self, EvtHandler handler)"""
54f9ee45 3735 return _core_.EvtHandler_SetNextHandler(*args, **kwargs)
e811c8ce
RD
3736
3737 def SetPreviousHandler(*args, **kwargs):
a95a7133 3738 """SetPreviousHandler(self, EvtHandler handler)"""
54f9ee45 3739 return _core_.EvtHandler_SetPreviousHandler(*args, **kwargs)
e811c8ce
RD
3740
3741 def GetEvtHandlerEnabled(*args, **kwargs):
a95a7133 3742 """GetEvtHandlerEnabled(self) -> bool"""
54f9ee45 3743 return _core_.EvtHandler_GetEvtHandlerEnabled(*args, **kwargs)
e811c8ce
RD
3744
3745 def SetEvtHandlerEnabled(*args, **kwargs):
a95a7133 3746 """SetEvtHandlerEnabled(self, bool enabled)"""
54f9ee45 3747 return _core_.EvtHandler_SetEvtHandlerEnabled(*args, **kwargs)
e811c8ce
RD
3748
3749 def ProcessEvent(*args, **kwargs):
a95a7133 3750 """ProcessEvent(self, Event event) -> bool"""
54f9ee45 3751 return _core_.EvtHandler_ProcessEvent(*args, **kwargs)
e811c8ce
RD
3752
3753 def AddPendingEvent(*args, **kwargs):
a95a7133 3754 """AddPendingEvent(self, Event event)"""
54f9ee45 3755 return _core_.EvtHandler_AddPendingEvent(*args, **kwargs)
e811c8ce
RD
3756
3757 def ProcessPendingEvents(*args, **kwargs):
a95a7133 3758 """ProcessPendingEvents(self)"""
54f9ee45 3759 return _core_.EvtHandler_ProcessPendingEvents(*args, **kwargs)
e811c8ce 3760
b39fe951
RD
3761 def AllowReentrance(*args, **kwargs):
3762 """AllowReentrance(self, bool allow=True)"""
3763 return _core_.EvtHandler_AllowReentrance(*args, **kwargs)
3764
3765 def IsReentranceAllowed(*args, **kwargs):
3766 """IsReentranceAllowed(self) -> bool"""
3767 return _core_.EvtHandler_IsReentranceAllowed(*args, **kwargs)
3768
3769 def IsEventHandlingInProgress(*args, **kwargs):
3770 """IsEventHandlingInProgress(self) -> bool"""
3771 return _core_.EvtHandler_IsEventHandlingInProgress(*args, **kwargs)
3772
e811c8ce 3773 def Connect(*args, **kwargs):
a95a7133 3774 """Connect(self, int id, int lastId, int eventType, PyObject func)"""
54f9ee45 3775 return _core_.EvtHandler_Connect(*args, **kwargs)
e811c8ce
RD
3776
3777 def Disconnect(*args, **kwargs):
2131d850 3778 """Disconnect(self, int id, int lastId=-1, EventType eventType=wxEVT_NULL) -> bool"""
54f9ee45 3779 return _core_.EvtHandler_Disconnect(*args, **kwargs)
e811c8ce
RD
3780
3781 def _setOORInfo(*args, **kwargs):
689b42ee 3782 """_setOORInfo(self, PyObject _self, bool incref=True)"""
7e08d4ef
RD
3783 val = _core_.EvtHandler__setOORInfo(*args, **kwargs)
3784 args[0].thisown = 0
3785 return val
e811c8ce 3786
d14a1e28
RD
3787 def Bind(self, event, handler, source=None, id=wx.ID_ANY, id2=wx.ID_ANY):
3788 """
3789 Bind an event to an event handler.
3790
db3e571a
RD
3791 :param event: One of the EVT_* objects that specifies the
3792 type of event to bind,
d14a1e28 3793
db3e571a
RD
3794 :param handler: A callable object to be invoked when the
3795 event is delivered to self. Pass None to
3796 disconnect an event handler.
d14a1e28 3797
db3e571a
RD
3798 :param source: Sometimes the event originates from a
3799 different window than self, but you still
3800 want to catch it in self. (For example, a
3801 button event delivered to a frame.) By
3802 passing the source of the event, the event
3803 handling system is able to differentiate
3804 between the same event type from different
3805 controls.
d14a1e28 3806
db3e571a
RD
3807 :param id: Used to spcify the event source by ID instead
3808 of instance.
3809
3810 :param id2: Used when it is desirable to bind a handler
3811 to a range of IDs, such as with EVT_MENU_RANGE.
d14a1e28
RD
3812 """
3813 if source is not None:
3814 id = source.GetId()
3815 event.Bind(self, id, id2, handler)
3816
66c033b4
RD
3817 def Unbind(self, event, source=None, id=wx.ID_ANY, id2=wx.ID_ANY):
3818 """
3819 Disconencts the event handler binding for event from self.
3820 Returns True if successful.
3821 """
3822 if source is not None:
3823 id = source.GetId()
3824 return event.Unbind(self, id, id2)
d14a1e28 3825
97ab0f6a
RD
3826 EvtHandlerEnabled = property(GetEvtHandlerEnabled,SetEvtHandlerEnabled,doc="See `GetEvtHandlerEnabled` and `SetEvtHandlerEnabled`")
3827 NextHandler = property(GetNextHandler,SetNextHandler,doc="See `GetNextHandler` and `SetNextHandler`")
3828 PreviousHandler = property(GetPreviousHandler,SetPreviousHandler,doc="See `GetPreviousHandler` and `SetPreviousHandler`")
2131d850 3829_core_.EvtHandler_swigregister(EvtHandler)
d14a1e28
RD
3830
3831#---------------------------------------------------------------------------
3832
3833class PyEventBinder(object):
3834 """
3835 Instances of this class are used to bind specific events to event
3836 handlers.
3837 """
3838 def __init__(self, evtType, expectedIDs=0):
3839 if expectedIDs not in [0, 1, 2]:
3840 raise ValueError, "Invalid number of expectedIDs"
3841 self.expectedIDs = expectedIDs
3842
3843 if type(evtType) == list or type(evtType) == tuple:
3844 self.evtType = evtType
3845 else:
3846 self.evtType = [evtType]
3847
3848
3849 def Bind(self, target, id1, id2, function):
3850 """Bind this set of event types to target."""
3851 for et in self.evtType:
3852 target.Connect(id1, id2, et, function)
3853
66c033b4
RD
3854
3855 def Unbind(self, target, id1, id2):
3856 """Remove an event binding."""
3857 success = 0
3858 for et in self.evtType:
3859 success += target.Disconnect(id1, id2, et)
3860 return success != 0
3861
d14a1e28
RD
3862
3863 def __call__(self, *args):
3864 """
3865 For backwards compatibility with the old EVT_* functions.
3866 Should be called with either (window, func), (window, ID,
3867 func) or (window, ID1, ID2, func) parameters depending on the
3868 type of the event.
3869 """
3870 assert len(args) == 2 + self.expectedIDs
3871 id1 = wx.ID_ANY
3872 id2 = wx.ID_ANY
3873 target = args[0]
3874 if self.expectedIDs == 0:
3875 func = args[1]
3876 elif self.expectedIDs == 1:
3877 id1 = args[1]
3878 func = args[2]
3879 elif self.expectedIDs == 2:
3880 id1 = args[1]
3881 id2 = args[2]
3882 func = args[3]
3883 else:
3884 raise ValueError, "Unexpected number of IDs"
3885
3886 self.Bind(target, id1, id2, func)
3887
3888
3889# These two are square pegs that don't fit the PyEventBinder hole...
3890def EVT_COMMAND(win, id, cmd, func):
3891 win.Connect(id, -1, cmd, func)
3892def EVT_COMMAND_RANGE(win, id1, id2, cmd, func):
3893 win.Connect(id1, id2, cmd, func)
3894
3895
3896#---------------------------------------------------------------------------
3897
3898#---------------------------------------------------------------------------
3899
54f9ee45
RD
3900EVENT_PROPAGATE_NONE = _core_.EVENT_PROPAGATE_NONE
3901EVENT_PROPAGATE_MAX = _core_.EVENT_PROPAGATE_MAX
d14a1e28 3902
0085ce49 3903def NewEventType(*args):
2131d850 3904 """NewEventType() -> EventType"""
0085ce49 3905 return _core_.NewEventType(*args)
54f9ee45
RD
3906wxEVT_NULL = _core_.wxEVT_NULL
3907wxEVT_FIRST = _core_.wxEVT_FIRST
3908wxEVT_USER_FIRST = _core_.wxEVT_USER_FIRST
3909wxEVT_COMMAND_BUTTON_CLICKED = _core_.wxEVT_COMMAND_BUTTON_CLICKED
3910wxEVT_COMMAND_CHECKBOX_CLICKED = _core_.wxEVT_COMMAND_CHECKBOX_CLICKED
3911wxEVT_COMMAND_CHOICE_SELECTED = _core_.wxEVT_COMMAND_CHOICE_SELECTED
3912wxEVT_COMMAND_LISTBOX_SELECTED = _core_.wxEVT_COMMAND_LISTBOX_SELECTED
3913wxEVT_COMMAND_LISTBOX_DOUBLECLICKED = _core_.wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
3914wxEVT_COMMAND_CHECKLISTBOX_TOGGLED = _core_.wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
3915wxEVT_COMMAND_MENU_SELECTED = _core_.wxEVT_COMMAND_MENU_SELECTED
3916wxEVT_COMMAND_TOOL_CLICKED = _core_.wxEVT_COMMAND_TOOL_CLICKED
3917wxEVT_COMMAND_SLIDER_UPDATED = _core_.wxEVT_COMMAND_SLIDER_UPDATED
3918wxEVT_COMMAND_RADIOBOX_SELECTED = _core_.wxEVT_COMMAND_RADIOBOX_SELECTED
3919wxEVT_COMMAND_RADIOBUTTON_SELECTED = _core_.wxEVT_COMMAND_RADIOBUTTON_SELECTED
3920wxEVT_COMMAND_SCROLLBAR_UPDATED = _core_.wxEVT_COMMAND_SCROLLBAR_UPDATED
3921wxEVT_COMMAND_VLBOX_SELECTED = _core_.wxEVT_COMMAND_VLBOX_SELECTED
3922wxEVT_COMMAND_COMBOBOX_SELECTED = _core_.wxEVT_COMMAND_COMBOBOX_SELECTED
3923wxEVT_COMMAND_TOOL_RCLICKED = _core_.wxEVT_COMMAND_TOOL_RCLICKED
3924wxEVT_COMMAND_TOOL_ENTER = _core_.wxEVT_COMMAND_TOOL_ENTER
3925wxEVT_LEFT_DOWN = _core_.wxEVT_LEFT_DOWN
3926wxEVT_LEFT_UP = _core_.wxEVT_LEFT_UP
3927wxEVT_MIDDLE_DOWN = _core_.wxEVT_MIDDLE_DOWN
3928wxEVT_MIDDLE_UP = _core_.wxEVT_MIDDLE_UP
3929wxEVT_RIGHT_DOWN = _core_.wxEVT_RIGHT_DOWN
3930wxEVT_RIGHT_UP = _core_.wxEVT_RIGHT_UP
3931wxEVT_MOTION = _core_.wxEVT_MOTION
3932wxEVT_ENTER_WINDOW = _core_.wxEVT_ENTER_WINDOW
3933wxEVT_LEAVE_WINDOW = _core_.wxEVT_LEAVE_WINDOW
3934wxEVT_LEFT_DCLICK = _core_.wxEVT_LEFT_DCLICK
3935wxEVT_MIDDLE_DCLICK = _core_.wxEVT_MIDDLE_DCLICK
3936wxEVT_RIGHT_DCLICK = _core_.wxEVT_RIGHT_DCLICK
3937wxEVT_SET_FOCUS = _core_.wxEVT_SET_FOCUS
3938wxEVT_KILL_FOCUS = _core_.wxEVT_KILL_FOCUS
3939wxEVT_CHILD_FOCUS = _core_.wxEVT_CHILD_FOCUS
3940wxEVT_MOUSEWHEEL = _core_.wxEVT_MOUSEWHEEL
3941wxEVT_NC_LEFT_DOWN = _core_.wxEVT_NC_LEFT_DOWN
3942wxEVT_NC_LEFT_UP = _core_.wxEVT_NC_LEFT_UP
3943wxEVT_NC_MIDDLE_DOWN = _core_.wxEVT_NC_MIDDLE_DOWN
3944wxEVT_NC_MIDDLE_UP = _core_.wxEVT_NC_MIDDLE_UP
3945wxEVT_NC_RIGHT_DOWN = _core_.wxEVT_NC_RIGHT_DOWN
3946wxEVT_NC_RIGHT_UP = _core_.wxEVT_NC_RIGHT_UP
3947wxEVT_NC_MOTION = _core_.wxEVT_NC_MOTION
3948wxEVT_NC_ENTER_WINDOW = _core_.wxEVT_NC_ENTER_WINDOW
3949wxEVT_NC_LEAVE_WINDOW = _core_.wxEVT_NC_LEAVE_WINDOW
3950wxEVT_NC_LEFT_DCLICK = _core_.wxEVT_NC_LEFT_DCLICK
3951wxEVT_NC_MIDDLE_DCLICK = _core_.wxEVT_NC_MIDDLE_DCLICK
3952wxEVT_NC_RIGHT_DCLICK = _core_.wxEVT_NC_RIGHT_DCLICK
3953wxEVT_CHAR = _core_.wxEVT_CHAR
3954wxEVT_CHAR_HOOK = _core_.wxEVT_CHAR_HOOK
3955wxEVT_NAVIGATION_KEY = _core_.wxEVT_NAVIGATION_KEY
3956wxEVT_KEY_DOWN = _core_.wxEVT_KEY_DOWN
3957wxEVT_KEY_UP = _core_.wxEVT_KEY_UP
3958wxEVT_HOTKEY = _core_.wxEVT_HOTKEY
3959wxEVT_SET_CURSOR = _core_.wxEVT_SET_CURSOR
3960wxEVT_SCROLL_TOP = _core_.wxEVT_SCROLL_TOP
3961wxEVT_SCROLL_BOTTOM = _core_.wxEVT_SCROLL_BOTTOM
3962wxEVT_SCROLL_LINEUP = _core_.wxEVT_SCROLL_LINEUP
3963wxEVT_SCROLL_LINEDOWN = _core_.wxEVT_SCROLL_LINEDOWN
3964wxEVT_SCROLL_PAGEUP = _core_.wxEVT_SCROLL_PAGEUP
3965wxEVT_SCROLL_PAGEDOWN = _core_.wxEVT_SCROLL_PAGEDOWN
3966wxEVT_SCROLL_THUMBTRACK = _core_.wxEVT_SCROLL_THUMBTRACK
3967wxEVT_SCROLL_THUMBRELEASE = _core_.wxEVT_SCROLL_THUMBRELEASE
4f433fef
RD
3968wxEVT_SCROLL_CHANGED = _core_.wxEVT_SCROLL_CHANGED
3969wxEVT_SCROLL_ENDSCROLL = wxEVT_SCROLL_CHANGED
54f9ee45
RD
3970wxEVT_SCROLLWIN_TOP = _core_.wxEVT_SCROLLWIN_TOP
3971wxEVT_SCROLLWIN_BOTTOM = _core_.wxEVT_SCROLLWIN_BOTTOM
3972wxEVT_SCROLLWIN_LINEUP = _core_.wxEVT_SCROLLWIN_LINEUP
3973wxEVT_SCROLLWIN_LINEDOWN = _core_.wxEVT_SCROLLWIN_LINEDOWN
3974wxEVT_SCROLLWIN_PAGEUP = _core_.wxEVT_SCROLLWIN_PAGEUP
3975wxEVT_SCROLLWIN_PAGEDOWN = _core_.wxEVT_SCROLLWIN_PAGEDOWN
3976wxEVT_SCROLLWIN_THUMBTRACK = _core_.wxEVT_SCROLLWIN_THUMBTRACK
3977wxEVT_SCROLLWIN_THUMBRELEASE = _core_.wxEVT_SCROLLWIN_THUMBRELEASE
3978wxEVT_SIZE = _core_.wxEVT_SIZE
3979wxEVT_MOVE = _core_.wxEVT_MOVE
3980wxEVT_CLOSE_WINDOW = _core_.wxEVT_CLOSE_WINDOW
3981wxEVT_END_SESSION = _core_.wxEVT_END_SESSION
3982wxEVT_QUERY_END_SESSION = _core_.wxEVT_QUERY_END_SESSION
3983wxEVT_ACTIVATE_APP = _core_.wxEVT_ACTIVATE_APP
54f9ee45
RD
3984wxEVT_ACTIVATE = _core_.wxEVT_ACTIVATE
3985wxEVT_CREATE = _core_.wxEVT_CREATE
3986wxEVT_DESTROY = _core_.wxEVT_DESTROY
3987wxEVT_SHOW = _core_.wxEVT_SHOW
3988wxEVT_ICONIZE = _core_.wxEVT_ICONIZE
3989wxEVT_MAXIMIZE = _core_.wxEVT_MAXIMIZE
3990wxEVT_MOUSE_CAPTURE_CHANGED = _core_.wxEVT_MOUSE_CAPTURE_CHANGED
34e0a3bb 3991wxEVT_MOUSE_CAPTURE_LOST = _core_.wxEVT_MOUSE_CAPTURE_LOST
54f9ee45
RD
3992wxEVT_PAINT = _core_.wxEVT_PAINT
3993wxEVT_ERASE_BACKGROUND = _core_.wxEVT_ERASE_BACKGROUND
3994wxEVT_NC_PAINT = _core_.wxEVT_NC_PAINT
3995wxEVT_PAINT_ICON = _core_.wxEVT_PAINT_ICON
3996wxEVT_MENU_OPEN = _core_.wxEVT_MENU_OPEN
3997wxEVT_MENU_CLOSE = _core_.wxEVT_MENU_CLOSE
3998wxEVT_MENU_HIGHLIGHT = _core_.wxEVT_MENU_HIGHLIGHT
3999wxEVT_CONTEXT_MENU = _core_.wxEVT_CONTEXT_MENU
4000wxEVT_SYS_COLOUR_CHANGED = _core_.wxEVT_SYS_COLOUR_CHANGED
4001wxEVT_DISPLAY_CHANGED = _core_.wxEVT_DISPLAY_CHANGED
4002wxEVT_SETTING_CHANGED = _core_.wxEVT_SETTING_CHANGED
4003wxEVT_QUERY_NEW_PALETTE = _core_.wxEVT_QUERY_NEW_PALETTE
4004wxEVT_PALETTE_CHANGED = _core_.wxEVT_PALETTE_CHANGED
4005wxEVT_DROP_FILES = _core_.wxEVT_DROP_FILES
4006wxEVT_DRAW_ITEM = _core_.wxEVT_DRAW_ITEM
4007wxEVT_MEASURE_ITEM = _core_.wxEVT_MEASURE_ITEM
4008wxEVT_COMPARE_ITEM = _core_.wxEVT_COMPARE_ITEM
4009wxEVT_INIT_DIALOG = _core_.wxEVT_INIT_DIALOG
4010wxEVT_IDLE = _core_.wxEVT_IDLE
4011wxEVT_UPDATE_UI = _core_.wxEVT_UPDATE_UI
4012wxEVT_SIZING = _core_.wxEVT_SIZING
4013wxEVT_MOVING = _core_.wxEVT_MOVING
88c6b281 4014wxEVT_HIBERNATE = _core_.wxEVT_HIBERNATE
2131d850
RD
4015wxEVT_COMMAND_TEXT_COPY = _core_.wxEVT_COMMAND_TEXT_COPY
4016wxEVT_COMMAND_TEXT_CUT = _core_.wxEVT_COMMAND_TEXT_CUT
4017wxEVT_COMMAND_TEXT_PASTE = _core_.wxEVT_COMMAND_TEXT_PASTE
54f9ee45
RD
4018wxEVT_COMMAND_LEFT_CLICK = _core_.wxEVT_COMMAND_LEFT_CLICK
4019wxEVT_COMMAND_LEFT_DCLICK = _core_.wxEVT_COMMAND_LEFT_DCLICK
4020wxEVT_COMMAND_RIGHT_CLICK = _core_.wxEVT_COMMAND_RIGHT_CLICK
4021wxEVT_COMMAND_RIGHT_DCLICK = _core_.wxEVT_COMMAND_RIGHT_DCLICK
4022wxEVT_COMMAND_SET_FOCUS = _core_.wxEVT_COMMAND_SET_FOCUS
4023wxEVT_COMMAND_KILL_FOCUS = _core_.wxEVT_COMMAND_KILL_FOCUS
4024wxEVT_COMMAND_ENTER = _core_.wxEVT_COMMAND_ENTER
d14a1e28
RD
4025#
4026# Create some event binders
4027EVT_SIZE = wx.PyEventBinder( wxEVT_SIZE )
4028EVT_SIZING = wx.PyEventBinder( wxEVT_SIZING )
4029EVT_MOVE = wx.PyEventBinder( wxEVT_MOVE )
4030EVT_MOVING = wx.PyEventBinder( wxEVT_MOVING )
4031EVT_CLOSE = wx.PyEventBinder( wxEVT_CLOSE_WINDOW )
4032EVT_END_SESSION = wx.PyEventBinder( wxEVT_END_SESSION )
4033EVT_QUERY_END_SESSION = wx.PyEventBinder( wxEVT_QUERY_END_SESSION )
4034EVT_PAINT = wx.PyEventBinder( wxEVT_PAINT )
4035EVT_NC_PAINT = wx.PyEventBinder( wxEVT_NC_PAINT )
4036EVT_ERASE_BACKGROUND = wx.PyEventBinder( wxEVT_ERASE_BACKGROUND )
4037EVT_CHAR = wx.PyEventBinder( wxEVT_CHAR )
4038EVT_KEY_DOWN = wx.PyEventBinder( wxEVT_KEY_DOWN )
4039EVT_KEY_UP = wx.PyEventBinder( wxEVT_KEY_UP )
704eda0c 4040EVT_HOTKEY = wx.PyEventBinder( wxEVT_HOTKEY, 1)
d14a1e28
RD
4041EVT_CHAR_HOOK = wx.PyEventBinder( wxEVT_CHAR_HOOK )
4042EVT_MENU_OPEN = wx.PyEventBinder( wxEVT_MENU_OPEN )
4043EVT_MENU_CLOSE = wx.PyEventBinder( wxEVT_MENU_CLOSE )
4044EVT_MENU_HIGHLIGHT = wx.PyEventBinder( wxEVT_MENU_HIGHLIGHT, 1)
4045EVT_MENU_HIGHLIGHT_ALL = wx.PyEventBinder( wxEVT_MENU_HIGHLIGHT )
4046EVT_SET_FOCUS = wx.PyEventBinder( wxEVT_SET_FOCUS )
4047EVT_KILL_FOCUS = wx.PyEventBinder( wxEVT_KILL_FOCUS )
4048EVT_CHILD_FOCUS = wx.PyEventBinder( wxEVT_CHILD_FOCUS )
4049EVT_ACTIVATE = wx.PyEventBinder( wxEVT_ACTIVATE )
4050EVT_ACTIVATE_APP = wx.PyEventBinder( wxEVT_ACTIVATE_APP )
704eda0c 4051EVT_HIBERNATE = wx.PyEventBinder( wxEVT_HIBERNATE )
d14a1e28
RD
4052EVT_END_SESSION = wx.PyEventBinder( wxEVT_END_SESSION )
4053EVT_QUERY_END_SESSION = wx.PyEventBinder( wxEVT_QUERY_END_SESSION )
4054EVT_DROP_FILES = wx.PyEventBinder( wxEVT_DROP_FILES )
4055EVT_INIT_DIALOG = wx.PyEventBinder( wxEVT_INIT_DIALOG )
4056EVT_SYS_COLOUR_CHANGED = wx.PyEventBinder( wxEVT_SYS_COLOUR_CHANGED )
4057EVT_DISPLAY_CHANGED = wx.PyEventBinder( wxEVT_DISPLAY_CHANGED )
4058EVT_SHOW = wx.PyEventBinder( wxEVT_SHOW )
4059EVT_MAXIMIZE = wx.PyEventBinder( wxEVT_MAXIMIZE )
4060EVT_ICONIZE = wx.PyEventBinder( wxEVT_ICONIZE )
4061EVT_NAVIGATION_KEY = wx.PyEventBinder( wxEVT_NAVIGATION_KEY )
4062EVT_PALETTE_CHANGED = wx.PyEventBinder( wxEVT_PALETTE_CHANGED )
4063EVT_QUERY_NEW_PALETTE = wx.PyEventBinder( wxEVT_QUERY_NEW_PALETTE )
4064EVT_WINDOW_CREATE = wx.PyEventBinder( wxEVT_CREATE )
4065EVT_WINDOW_DESTROY = wx.PyEventBinder( wxEVT_DESTROY )
4066EVT_SET_CURSOR = wx.PyEventBinder( wxEVT_SET_CURSOR )
4067EVT_MOUSE_CAPTURE_CHANGED = wx.PyEventBinder( wxEVT_MOUSE_CAPTURE_CHANGED )
34e0a3bb 4068EVT_MOUSE_CAPTURE_LOST = wx.PyEventBinder( wxEVT_MOUSE_CAPTURE_LOST )
d14a1e28
RD
4069
4070EVT_LEFT_DOWN = wx.PyEventBinder( wxEVT_LEFT_DOWN )
4071EVT_LEFT_UP = wx.PyEventBinder( wxEVT_LEFT_UP )
4072EVT_MIDDLE_DOWN = wx.PyEventBinder( wxEVT_MIDDLE_DOWN )
4073EVT_MIDDLE_UP = wx.PyEventBinder( wxEVT_MIDDLE_UP )
4074EVT_RIGHT_DOWN = wx.PyEventBinder( wxEVT_RIGHT_DOWN )
4075EVT_RIGHT_UP = wx.PyEventBinder( wxEVT_RIGHT_UP )
4076EVT_MOTION = wx.PyEventBinder( wxEVT_MOTION )
4077EVT_LEFT_DCLICK = wx.PyEventBinder( wxEVT_LEFT_DCLICK )
4078EVT_MIDDLE_DCLICK = wx.PyEventBinder( wxEVT_MIDDLE_DCLICK )
4079EVT_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_RIGHT_DCLICK )
4080EVT_LEAVE_WINDOW = wx.PyEventBinder( wxEVT_LEAVE_WINDOW )
4081EVT_ENTER_WINDOW = wx.PyEventBinder( wxEVT_ENTER_WINDOW )
4082EVT_MOUSEWHEEL = wx.PyEventBinder( wxEVT_MOUSEWHEEL )
4083
4084EVT_MOUSE_EVENTS = wx.PyEventBinder([ wxEVT_LEFT_DOWN,
4085 wxEVT_LEFT_UP,
4086 wxEVT_MIDDLE_DOWN,
4087 wxEVT_MIDDLE_UP,
4088 wxEVT_RIGHT_DOWN,
4089 wxEVT_RIGHT_UP,
4090 wxEVT_MOTION,
4091 wxEVT_LEFT_DCLICK,
4092 wxEVT_MIDDLE_DCLICK,
4093 wxEVT_RIGHT_DCLICK,
4094 wxEVT_ENTER_WINDOW,
4095 wxEVT_LEAVE_WINDOW,
4096 wxEVT_MOUSEWHEEL
4097 ])
4098
4099
4100# Scrolling from wxWindow (sent to wxScrolledWindow)
704eda0c 4101EVT_SCROLLWIN = wx.PyEventBinder([ wxEVT_SCROLLWIN_TOP,
d14a1e28
RD
4102 wxEVT_SCROLLWIN_BOTTOM,
4103 wxEVT_SCROLLWIN_LINEUP,
4104 wxEVT_SCROLLWIN_LINEDOWN,
704eda0c 4105 wxEVT_SCROLLWIN_PAGEUP,
d14a1e28
RD
4106 wxEVT_SCROLLWIN_PAGEDOWN,
4107 wxEVT_SCROLLWIN_THUMBTRACK,
4108 wxEVT_SCROLLWIN_THUMBRELEASE,
4109 ])
4110
4111EVT_SCROLLWIN_TOP = wx.PyEventBinder( wxEVT_SCROLLWIN_TOP )
4112EVT_SCROLLWIN_BOTTOM = wx.PyEventBinder( wxEVT_SCROLLWIN_BOTTOM )
4113EVT_SCROLLWIN_LINEUP = wx.PyEventBinder( wxEVT_SCROLLWIN_LINEUP )
4114EVT_SCROLLWIN_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLLWIN_LINEDOWN )
4115EVT_SCROLLWIN_PAGEUP = wx.PyEventBinder( wxEVT_SCROLLWIN_PAGEUP )
4116EVT_SCROLLWIN_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLLWIN_PAGEDOWN )
4117EVT_SCROLLWIN_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLLWIN_THUMBTRACK )
4118EVT_SCROLLWIN_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLLWIN_THUMBRELEASE )
4119
27fb7603 4120# Scrolling from wx.Slider and wx.ScrollBar
704eda0c
RD
4121EVT_SCROLL = wx.PyEventBinder([ wxEVT_SCROLL_TOP,
4122 wxEVT_SCROLL_BOTTOM,
4123 wxEVT_SCROLL_LINEUP,
4124 wxEVT_SCROLL_LINEDOWN,
4125 wxEVT_SCROLL_PAGEUP,
4126 wxEVT_SCROLL_PAGEDOWN,
4127 wxEVT_SCROLL_THUMBTRACK,
4128 wxEVT_SCROLL_THUMBRELEASE,
4f433fef 4129 wxEVT_SCROLL_CHANGED,
d14a1e28
RD
4130 ])
4131
4132EVT_SCROLL_TOP = wx.PyEventBinder( wxEVT_SCROLL_TOP )
4133EVT_SCROLL_BOTTOM = wx.PyEventBinder( wxEVT_SCROLL_BOTTOM )
4134EVT_SCROLL_LINEUP = wx.PyEventBinder( wxEVT_SCROLL_LINEUP )
4135EVT_SCROLL_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLL_LINEDOWN )
4136EVT_SCROLL_PAGEUP = wx.PyEventBinder( wxEVT_SCROLL_PAGEUP )
4137EVT_SCROLL_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLL_PAGEDOWN )
4138EVT_SCROLL_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLL_THUMBTRACK )
4139EVT_SCROLL_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE )
4f433fef
RD
4140EVT_SCROLL_CHANGED = wx.PyEventBinder( wxEVT_SCROLL_CHANGED )
4141EVT_SCROLL_ENDSCROLL = EVT_SCROLL_CHANGED
704eda0c 4142
27fb7603 4143# Scrolling from wx.Slider and wx.ScrollBar, with an id
704eda0c
RD
4144EVT_COMMAND_SCROLL = wx.PyEventBinder([ wxEVT_SCROLL_TOP,
4145 wxEVT_SCROLL_BOTTOM,
4146 wxEVT_SCROLL_LINEUP,
4147 wxEVT_SCROLL_LINEDOWN,
4148 wxEVT_SCROLL_PAGEUP,
4149 wxEVT_SCROLL_PAGEDOWN,
4150 wxEVT_SCROLL_THUMBTRACK,
d14a1e28 4151 wxEVT_SCROLL_THUMBRELEASE,
4f433fef 4152 wxEVT_SCROLL_CHANGED,
d14a1e28
RD
4153 ], 1)
4154
4155EVT_COMMAND_SCROLL_TOP = wx.PyEventBinder( wxEVT_SCROLL_TOP, 1)
4156EVT_COMMAND_SCROLL_BOTTOM = wx.PyEventBinder( wxEVT_SCROLL_BOTTOM, 1)
4157EVT_COMMAND_SCROLL_LINEUP = wx.PyEventBinder( wxEVT_SCROLL_LINEUP, 1)
4158EVT_COMMAND_SCROLL_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLL_LINEDOWN, 1)
4159EVT_COMMAND_SCROLL_PAGEUP = wx.PyEventBinder( wxEVT_SCROLL_PAGEUP, 1)
4160EVT_COMMAND_SCROLL_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLL_PAGEDOWN, 1)
4161EVT_COMMAND_SCROLL_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLL_THUMBTRACK, 1)
4162EVT_COMMAND_SCROLL_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE, 1)
4f433fef
RD
4163EVT_COMMAND_SCROLL_CHANGED = wx.PyEventBinder( wxEVT_SCROLL_CHANGED, 1)
4164EVT_COMMAND_SCROLL_ENDSCROLL = EVT_COMMAND_SCROLL_CHANGED
d14a1e28 4165
d14a1e28
RD
4166EVT_BUTTON = wx.PyEventBinder( wxEVT_COMMAND_BUTTON_CLICKED, 1)
4167EVT_CHECKBOX = wx.PyEventBinder( wxEVT_COMMAND_CHECKBOX_CLICKED, 1)
4168EVT_CHOICE = wx.PyEventBinder( wxEVT_COMMAND_CHOICE_SELECTED, 1)
4169EVT_LISTBOX = wx.PyEventBinder( wxEVT_COMMAND_LISTBOX_SELECTED, 1)
4170EVT_LISTBOX_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, 1)
4171EVT_MENU = wx.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED, 1)
4172EVT_MENU_RANGE = wx.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED, 2)
4173EVT_SLIDER = wx.PyEventBinder( wxEVT_COMMAND_SLIDER_UPDATED, 1)
4174EVT_RADIOBOX = wx.PyEventBinder( wxEVT_COMMAND_RADIOBOX_SELECTED, 1)
4175EVT_RADIOBUTTON = wx.PyEventBinder( wxEVT_COMMAND_RADIOBUTTON_SELECTED, 1)
4176
4177EVT_SCROLLBAR = wx.PyEventBinder( wxEVT_COMMAND_SCROLLBAR_UPDATED, 1)
4178EVT_VLBOX = wx.PyEventBinder( wxEVT_COMMAND_VLBOX_SELECTED, 1)
4179EVT_COMBOBOX = wx.PyEventBinder( wxEVT_COMMAND_COMBOBOX_SELECTED, 1)
4180EVT_TOOL = wx.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED, 1)
4181EVT_TOOL_RANGE = wx.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED, 2)
4182EVT_TOOL_RCLICKED = wx.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED, 1)
4183EVT_TOOL_RCLICKED_RANGE = wx.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED, 2)
4184EVT_TOOL_ENTER = wx.PyEventBinder( wxEVT_COMMAND_TOOL_ENTER, 1)
4185EVT_CHECKLISTBOX = wx.PyEventBinder( wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, 1)
4186
4187
4188EVT_COMMAND_LEFT_CLICK = wx.PyEventBinder( wxEVT_COMMAND_LEFT_CLICK, 1)
4189EVT_COMMAND_LEFT_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_LEFT_DCLICK, 1)
4190EVT_COMMAND_RIGHT_CLICK = wx.PyEventBinder( wxEVT_COMMAND_RIGHT_CLICK, 1)
4191EVT_COMMAND_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_RIGHT_DCLICK, 1)
4192EVT_COMMAND_SET_FOCUS = wx.PyEventBinder( wxEVT_COMMAND_SET_FOCUS, 1)
4193EVT_COMMAND_KILL_FOCUS = wx.PyEventBinder( wxEVT_COMMAND_KILL_FOCUS, 1)
4194EVT_COMMAND_ENTER = wx.PyEventBinder( wxEVT_COMMAND_ENTER, 1)
4195
4196EVT_IDLE = wx.PyEventBinder( wxEVT_IDLE )
4197
4198EVT_UPDATE_UI = wx.PyEventBinder( wxEVT_UPDATE_UI, 1)
4199EVT_UPDATE_UI_RANGE = wx.PyEventBinder( wxEVT_UPDATE_UI, 2)
4200
4201EVT_CONTEXT_MENU = wx.PyEventBinder( wxEVT_CONTEXT_MENU )
4202
2131d850
RD
4203EVT_TEXT_CUT = wx.PyEventBinder( wxEVT_COMMAND_TEXT_CUT )
4204EVT_TEXT_COPY = wx.PyEventBinder( wxEVT_COMMAND_TEXT_COPY )
4205EVT_TEXT_PASTE = wx.PyEventBinder( wxEVT_COMMAND_TEXT_PASTE )
d14a1e28
RD
4206
4207
4208#---------------------------------------------------------------------------
4209
4210class Event(Object):
27fb7603
RD
4211 """
4212 An event is a structure holding information about an event passed to a
4213 callback or member function. wx.Event is an abstract base class for
4214 other event classes
4215 """
0085ce49
RD
4216 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4217 def __init__(self): raise AttributeError, "No constructor defined"
4218 __repr__ = _swig_repr
4219 __swig_destroy__ = _core_.delete_Event
4220 __del__ = lambda self : None;
e811c8ce 4221 def SetEventType(*args, **kwargs):
27fb7603 4222 """
2131d850 4223 SetEventType(self, EventType typ)
27fb7603
RD
4224
4225 Sets the specific type of the event.
4226 """
54f9ee45 4227 return _core_.Event_SetEventType(*args, **kwargs)
e811c8ce
RD
4228
4229 def GetEventType(*args, **kwargs):
27fb7603 4230 """
2131d850 4231 GetEventType(self) -> EventType
27fb7603
RD
4232
4233 Returns the identifier of the given event type, such as
4234 ``wxEVT_COMMAND_BUTTON_CLICKED``.
4235 """
54f9ee45 4236 return _core_.Event_GetEventType(*args, **kwargs)
e811c8ce
RD
4237
4238 def GetEventObject(*args, **kwargs):
27fb7603
RD
4239 """
4240 GetEventObject(self) -> Object
4241
4242 Returns the object (usually a window) associated with the event, if
4243 any.
4244 """
54f9ee45 4245 return _core_.Event_GetEventObject(*args, **kwargs)
e811c8ce
RD
4246
4247 def SetEventObject(*args, **kwargs):
27fb7603
RD
4248 """
4249 SetEventObject(self, Object obj)
4250
4251 Sets the originating object, or in other words, obj is normally the
4252 object that is sending the event.
4253 """
54f9ee45 4254 return _core_.Event_SetEventObject(*args, **kwargs)
e811c8ce
RD
4255
4256 def GetTimestamp(*args, **kwargs):
a95a7133 4257 """GetTimestamp(self) -> long"""
54f9ee45 4258 return _core_.Event_GetTimestamp(*args, **kwargs)
e811c8ce
RD
4259
4260 def SetTimestamp(*args, **kwargs):
a95a7133 4261 """SetTimestamp(self, long ts=0)"""
54f9ee45 4262 return _core_.Event_SetTimestamp(*args, **kwargs)
e811c8ce
RD
4263
4264 def GetId(*args, **kwargs):
27fb7603
RD
4265 """
4266 GetId(self) -> int
4267
4268 Returns the identifier associated with this event, such as a button
4269 command id.
4270 """
54f9ee45 4271 return _core_.Event_GetId(*args, **kwargs)
e811c8ce
RD
4272
4273 def SetId(*args, **kwargs):
27fb7603
RD
4274 """
4275 SetId(self, int Id)
4276
4277 Set's the ID for the event. This is usually the ID of the window that
4278 is sending the event, but it can also be a command id from a menu
4279 item, etc.
4280 """
54f9ee45 4281 return _core_.Event_SetId(*args, **kwargs)
e811c8ce
RD
4282
4283 def IsCommandEvent(*args, **kwargs):
27fb7603
RD
4284 """
4285 IsCommandEvent(self) -> bool
4286
4287 Returns true if the event is or is derived from `wx.CommandEvent` else
4288 it returns false. Note: Exists only for optimization purposes.
4289 """
54f9ee45 4290 return _core_.Event_IsCommandEvent(*args, **kwargs)
e811c8ce
RD
4291
4292 def Skip(*args, **kwargs):
51b83b37
RD
4293 """
4294 Skip(self, bool skip=True)
4295
6b449b19
RD
4296 This method can be used inside an event handler to control whether
4297 further event handlers bound to this event will be called after the
4298 current one returns. Without Skip() (or equivalently if Skip(False) is
4299 used), the event will not be processed any more. If Skip(True) is
4300 called, the event processing system continues searching for a further
4301 handler function for this event, even though it has been processed
4302 already in the current handler.
51b83b37 4303 """
54f9ee45 4304 return _core_.Event_Skip(*args, **kwargs)
e811c8ce
RD
4305
4306 def GetSkipped(*args, **kwargs):
27fb7603
RD
4307 """
4308 GetSkipped(self) -> bool
4309
4310 Returns true if the event handler should be skipped, false otherwise.
4311 :see: `Skip`
4312 """
54f9ee45 4313 return _core_.Event_GetSkipped(*args, **kwargs)
e811c8ce
RD
4314
4315 def ShouldPropagate(*args, **kwargs):
27fb7603
RD
4316 """
4317 ShouldPropagate(self) -> bool
4318
4319 Test if this event should be propagated to the parent window or not,
4320 i.e. if the propagation level is currently greater than 0.
4321 """
54f9ee45 4322 return _core_.Event_ShouldPropagate(*args, **kwargs)
e811c8ce
RD
4323
4324 def StopPropagation(*args, **kwargs):
27fb7603
RD
4325 """
4326 StopPropagation(self) -> int
4327
4328 Stop the event from propagating to its parent window. Returns the old
4329 propagation level value which may be later passed to
4330 `ResumePropagation` to allow propagating the event again.
4331 """
54f9ee45 4332 return _core_.Event_StopPropagation(*args, **kwargs)
e811c8ce
RD
4333
4334 def ResumePropagation(*args, **kwargs):
27fb7603
RD
4335 """
4336 ResumePropagation(self, int propagationLevel)
4337
4338 Resume the event propagation by restoring the propagation level. (For
4339 example, you can use the value returned by an earlier call to
4340 `StopPropagation`.)
4341
4342 """
54f9ee45 4343 return _core_.Event_ResumePropagation(*args, **kwargs)
e811c8ce
RD
4344
4345 def Clone(*args, **kwargs):
a95a7133 4346 """Clone(self) -> Event"""
54f9ee45 4347 return _core_.Event_Clone(*args, **kwargs)
e811c8ce 4348
97ab0f6a
RD
4349 EventObject = property(GetEventObject,SetEventObject,doc="See `GetEventObject` and `SetEventObject`")
4350 EventType = property(GetEventType,SetEventType,doc="See `GetEventType` and `SetEventType`")
4351 Id = property(GetId,SetId,doc="See `GetId` and `SetId`")
4352 Skipped = property(GetSkipped,doc="See `GetSkipped`")
4353 Timestamp = property(GetTimestamp,SetTimestamp,doc="See `GetTimestamp` and `SetTimestamp`")
2131d850 4354_core_.Event_swigregister(Event)
d14a1e28
RD
4355
4356#---------------------------------------------------------------------------
4357
4358class PropagationDisabler(object):
27fb7603
RD
4359 """
4360 Helper class to temporarily change an event not to propagate. Simply
4361 create an instance of this class and then whe it is destroyed the
4362 propogation of the event will be restored.
4363 """
0085ce49
RD
4364 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4365 __repr__ = _swig_repr
4366 def __init__(self, *args, **kwargs):
27fb7603
RD
4367 """
4368 __init__(self, Event event) -> PropagationDisabler
4369
4370 Helper class to temporarily change an event not to propagate. Simply
4371 create an instance of this class and then whe it is destroyed the
4372 propogation of the event will be restored.
4373 """
0085ce49
RD
4374 _core_.PropagationDisabler_swiginit(self,_core_.new_PropagationDisabler(*args, **kwargs))
4375 __swig_destroy__ = _core_.delete_PropagationDisabler
4376 __del__ = lambda self : None;
2131d850 4377_core_.PropagationDisabler_swigregister(PropagationDisabler)
d14a1e28
RD
4378
4379class PropagateOnce(object):
27fb7603
RD
4380 """
4381 A helper class that will temporarily lower propagation level of an
4382 event. Simply create an instance of this class and then whe it is
4383 destroyed the propogation of the event will be restored.
4384 """
0085ce49
RD
4385 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4386 __repr__ = _swig_repr
4387 def __init__(self, *args, **kwargs):
27fb7603
RD
4388 """
4389 __init__(self, Event event) -> PropagateOnce
4390
4391 A helper class that will temporarily lower propagation level of an
4392 event. Simply create an instance of this class and then whe it is
4393 destroyed the propogation of the event will be restored.
4394 """
0085ce49
RD
4395 _core_.PropagateOnce_swiginit(self,_core_.new_PropagateOnce(*args, **kwargs))
4396 __swig_destroy__ = _core_.delete_PropagateOnce
4397 __del__ = lambda self : None;
2131d850 4398_core_.PropagateOnce_swigregister(PropagateOnce)
d14a1e28
RD
4399
4400#---------------------------------------------------------------------------
4401
4402class CommandEvent(Event):
27fb7603
RD
4403 """
4404 This event class contains information about command events, which
4405 originate from a variety of simple controls, as well as menus and
4406 toolbars.
4407 """
0085ce49
RD
4408 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4409 __repr__ = _swig_repr
4410 def __init__(self, *args, **kwargs):
27fb7603 4411 """
2131d850 4412 __init__(self, EventType commandType=wxEVT_NULL, int winid=0) -> CommandEvent
27fb7603
RD
4413
4414 This event class contains information about command events, which
4415 originate from a variety of simple controls, as well as menus and
4416 toolbars.
4417 """
0085ce49 4418 _core_.CommandEvent_swiginit(self,_core_.new_CommandEvent(*args, **kwargs))
e811c8ce 4419 def GetSelection(*args, **kwargs):
27fb7603
RD
4420 """
4421 GetSelection(self) -> int
4422
4423 Returns item index for a listbox or choice selection event (not valid
4424 for a deselection).
4425 """
54f9ee45 4426 return _core_.CommandEvent_GetSelection(*args, **kwargs)
e811c8ce
RD
4427
4428 def SetString(*args, **kwargs):
a95a7133 4429 """SetString(self, String s)"""
54f9ee45 4430 return _core_.CommandEvent_SetString(*args, **kwargs)
e811c8ce
RD
4431
4432 def GetString(*args, **kwargs):
27fb7603
RD
4433 """
4434 GetString(self) -> String
4435
4436 Returns item string for a listbox or choice selection event (not valid
4437 for a deselection).
4438 """
54f9ee45 4439 return _core_.CommandEvent_GetString(*args, **kwargs)
e811c8ce
RD
4440
4441 def IsChecked(*args, **kwargs):
27fb7603
RD
4442 """
4443 IsChecked(self) -> bool
4444
4445 This method can be used with checkbox and menu events: for the
4446 checkboxes, the method returns true for a selection event and false
4447 for a deselection one. For the menu events, this method indicates if
4448 the menu item just has become checked or unchecked (and thus only
4449 makes sense for checkable menu items).
4450 """
54f9ee45 4451 return _core_.CommandEvent_IsChecked(*args, **kwargs)
e811c8ce 4452
242b7b46 4453 Checked = IsChecked
e811c8ce 4454 def IsSelection(*args, **kwargs):
27fb7603
RD
4455 """
4456 IsSelection(self) -> bool
4457
4458 For a listbox or similar event, returns true if it is a selection,
4459 false if it is a deselection.
4460 """
54f9ee45 4461 return _core_.CommandEvent_IsSelection(*args, **kwargs)
e811c8ce
RD
4462
4463 def SetExtraLong(*args, **kwargs):
a95a7133 4464 """SetExtraLong(self, long extraLong)"""
54f9ee45 4465 return _core_.CommandEvent_SetExtraLong(*args, **kwargs)
e811c8ce
RD
4466
4467 def GetExtraLong(*args, **kwargs):
27fb7603
RD
4468 """
4469 GetExtraLong(self) -> long
4470
5ba5649b
RD
4471 Returns extra information dependant on the event objects type. If the
4472 event comes from a listbox selection, it is a boolean determining
4473 whether the event was a selection (true) or a deselection (false). A
4474 listbox deselection only occurs for multiple-selection boxes, and in
4475 this case the index and string values are indeterminate and the
4476 listbox must be examined by the application.
27fb7603 4477 """
54f9ee45 4478 return _core_.CommandEvent_GetExtraLong(*args, **kwargs)
e811c8ce
RD
4479
4480 def SetInt(*args, **kwargs):
a95a7133 4481 """SetInt(self, int i)"""
54f9ee45 4482 return _core_.CommandEvent_SetInt(*args, **kwargs)
e811c8ce
RD
4483
4484 def GetInt(*args, **kwargs):
27fb7603 4485 """
01f6b6d3 4486 GetInt(self) -> int
27fb7603 4487
5ba5649b
RD
4488 Returns the integer identifier corresponding to a listbox, choice or
4489 radiobox selection (only if the event was a selection, not a
4490 deselection), or a boolean value representing the value of a checkbox.
27fb7603 4491 """
54f9ee45 4492 return _core_.CommandEvent_GetInt(*args, **kwargs)
e811c8ce 4493
0085ce49
RD
4494 def GetClientData(*args, **kwargs):
4495 """
4496 GetClientData(self) -> PyObject
4497
4498 Returns the client data object for a listbox or choice selection event, (if any.)
4499 """
4500 return _core_.CommandEvent_GetClientData(*args, **kwargs)
4501
4502 def SetClientData(*args, **kwargs):
4503 """
4504 SetClientData(self, PyObject clientData)
4505
4506 Associate the given client data with the item at position n.
4507 """
4508 return _core_.CommandEvent_SetClientData(*args, **kwargs)
4509
4510 GetClientObject = GetClientData
4511 SetClientObject = SetClientData
4512
e811c8ce 4513 def Clone(*args, **kwargs):
a95a7133 4514 """Clone(self) -> Event"""
54f9ee45 4515 return _core_.CommandEvent_Clone(*args, **kwargs)
e811c8ce 4516
2bf58437
RD
4517 ClientData = property(GetClientData,SetClientData,doc="See `GetClientData` and `SetClientData`")
4518 ClientObject = property(GetClientObject,SetClientObject,doc="See `GetClientObject` and `SetClientObject`")
4519 ExtraLong = property(GetExtraLong,SetExtraLong,doc="See `GetExtraLong` and `SetExtraLong`")
4520 Int = property(GetInt,SetInt,doc="See `GetInt` and `SetInt`")
4521 Selection = property(GetSelection,doc="See `GetSelection`")
4522 String = property(GetString,SetString,doc="See `GetString` and `SetString`")
2131d850 4523_core_.CommandEvent_swigregister(CommandEvent)
d14a1e28
RD
4524
4525#---------------------------------------------------------------------------
4526
4527class NotifyEvent(CommandEvent):
27fb7603
RD
4528 """
4529 An instance of this class (or one of its derived classes) is sent from
4530 a control when the control's state is being changed and the control
4531 allows that change to be prevented from happening. The event handler
4532 can call `Veto` or `Allow` to tell the control what to do.
4533 """
0085ce49
RD
4534 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4535 __repr__ = _swig_repr
4536 def __init__(self, *args, **kwargs):
27fb7603 4537 """
2131d850 4538 __init__(self, EventType commandType=wxEVT_NULL, int winid=0) -> NotifyEvent
27fb7603
RD
4539
4540 An instance of this class (or one of its derived classes) is sent from
4541 a control when the control's state is being changed and the control
4542 allows that change to be prevented from happening. The event handler
4543 can call `Veto` or `Allow` to tell the control what to do.
4544 """
0085ce49 4545 _core_.NotifyEvent_swiginit(self,_core_.new_NotifyEvent(*args, **kwargs))
e811c8ce 4546 def Veto(*args, **kwargs):
27fb7603
RD
4547 """
4548 Veto(self)
4549
4550 Prevents the change announced by this event from happening.
4551
4552 It is in general a good idea to notify the user about the reasons for
4553 vetoing the change because otherwise the applications behaviour (which
4554 just refuses to do what the user wants) might be quite surprising.
4555 """
54f9ee45 4556 return _core_.NotifyEvent_Veto(*args, **kwargs)
e811c8ce
RD
4557
4558 def Allow(*args, **kwargs):
27fb7603
RD
4559 """
4560 Allow(self)
4561
4562 This is the opposite of `Veto`: it explicitly allows the event to be
4563 processed. For most events it is not necessary to call this method as
4564 the events are allowed anyhow but some are forbidden by default (this
4565 will be mentioned in the corresponding event description).
4566 """
54f9ee45 4567 return _core_.NotifyEvent_Allow(*args, **kwargs)
e811c8ce
RD
4568
4569 def IsAllowed(*args, **kwargs):
27fb7603
RD
4570 """
4571 IsAllowed(self) -> bool
4572
4573 Returns true if the change is allowed (`Veto` hasn't been called) or
4574 false otherwise (if it was).
4575 """
54f9ee45 4576 return _core_.NotifyEvent_IsAllowed(*args, **kwargs)
e811c8ce 4577
2131d850 4578_core_.NotifyEvent_swigregister(NotifyEvent)
d14a1e28
RD
4579
4580#---------------------------------------------------------------------------
4581
4582class ScrollEvent(CommandEvent):
27fb7603
RD
4583 """
4584 A scroll event holds information about events sent from stand-alone
4585 scrollbars and sliders. Note that scrolled windows do not send
4586 instnaces of this event class, but send the `wx.ScrollWinEvent`
4587 instead.
4588 """
0085ce49
RD
4589 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4590 __repr__ = _swig_repr
4591 def __init__(self, *args, **kwargs):
0df68c9f 4592 """
2131d850 4593 __init__(self, EventType commandType=wxEVT_NULL, int winid=0, int pos=0,
0df68c9f
RD
4594 int orient=0) -> ScrollEvent
4595 """
0085ce49 4596 _core_.ScrollEvent_swiginit(self,_core_.new_ScrollEvent(*args, **kwargs))
e811c8ce 4597 def GetOrientation(*args, **kwargs):
27fb7603
RD
4598 """
4599 GetOrientation(self) -> int
4600
4601 Returns wx.HORIZONTAL or wx.VERTICAL, depending on the orientation of
4602 the scrollbar.
4603 """
54f9ee45 4604 return _core_.ScrollEvent_GetOrientation(*args, **kwargs)
e811c8ce
RD
4605
4606 def GetPosition(*args, **kwargs):
27fb7603
RD
4607 """
4608 GetPosition(self) -> int
4609
4610 Returns the position of the scrollbar.
4611 """
54f9ee45 4612 return _core_.ScrollEvent_GetPosition(*args, **kwargs)
e811c8ce
RD
4613
4614 def SetOrientation(*args, **kwargs):
a95a7133 4615 """SetOrientation(self, int orient)"""
54f9ee45 4616 return _core_.ScrollEvent_SetOrientation(*args, **kwargs)
e811c8ce
RD
4617
4618 def SetPosition(*args, **kwargs):
a95a7133 4619 """SetPosition(self, int pos)"""
54f9ee45 4620 return _core_.ScrollEvent_SetPosition(*args, **kwargs)
e811c8ce 4621
33d6fd3b
RD
4622 Orientation = property(GetOrientation,SetOrientation,doc="See `GetOrientation` and `SetOrientation`")
4623 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
2131d850 4624_core_.ScrollEvent_swigregister(ScrollEvent)
d14a1e28
RD
4625
4626#---------------------------------------------------------------------------
4627
4628class ScrollWinEvent(Event):
27fb7603
RD
4629 """
4630 A wx.ScrollWinEvent holds information about scrolling and is sent from
4631 scrolling windows.
4632 """
0085ce49
RD
4633 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4634 __repr__ = _swig_repr
4635 def __init__(self, *args, **kwargs):
27fb7603 4636 """
2131d850 4637 __init__(self, EventType commandType=wxEVT_NULL, int pos=0, int orient=0) -> ScrollWinEvent
27fb7603
RD
4638
4639 A wx.ScrollWinEvent holds information about scrolling and is sent from
4640 scrolling windows.
4641 """
0085ce49 4642 _core_.ScrollWinEvent_swiginit(self,_core_.new_ScrollWinEvent(*args, **kwargs))
e811c8ce 4643 def GetOrientation(*args, **kwargs):
27fb7603
RD
4644 """
4645 GetOrientation(self) -> int
4646
4647 Returns wx.HORIZONTAL or wx.VERTICAL, depending on the orientation of
4648 the scrollbar.
4649 """
54f9ee45 4650 return _core_.ScrollWinEvent_GetOrientation(*args, **kwargs)
e811c8ce
RD
4651
4652 def GetPosition(*args, **kwargs):
27fb7603
RD
4653 """
4654 GetPosition(self) -> int
4655
4656 Returns the position of the scrollbar for the thumb track and release
4657 events. Note that this field can't be used for the other events, you
4658 need to query the window itself for the current position in that case.
4659 """
54f9ee45 4660 return _core_.ScrollWinEvent_GetPosition(*args, **kwargs)
e811c8ce
RD
4661
4662 def SetOrientation(*args, **kwargs):
a95a7133 4663 """SetOrientation(self, int orient)"""
54f9ee45 4664 return _core_.ScrollWinEvent_SetOrientation(*args, **kwargs)
e811c8ce
RD
4665
4666 def SetPosition(*args, **kwargs):
a95a7133 4667 """SetPosition(self, int pos)"""
54f9ee45 4668 return _core_.ScrollWinEvent_SetPosition(*args, **kwargs)
e811c8ce 4669
33d6fd3b
RD
4670 Orientation = property(GetOrientation,SetOrientation,doc="See `GetOrientation` and `SetOrientation`")
4671 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
2131d850 4672_core_.ScrollWinEvent_swigregister(ScrollWinEvent)
d14a1e28
RD
4673
4674#---------------------------------------------------------------------------
4675
54f9ee45
RD
4676MOUSE_BTN_ANY = _core_.MOUSE_BTN_ANY
4677MOUSE_BTN_NONE = _core_.MOUSE_BTN_NONE
4678MOUSE_BTN_LEFT = _core_.MOUSE_BTN_LEFT
4679MOUSE_BTN_MIDDLE = _core_.MOUSE_BTN_MIDDLE
4680MOUSE_BTN_RIGHT = _core_.MOUSE_BTN_RIGHT
d14a1e28 4681class MouseEvent(Event):
27fb7603
RD
4682 """
4683 This event class contains information about the events generated by
4684 the mouse: they include mouse buttons press and release events and
4685 mouse move events.
4686
4687 All mouse events involving the buttons use ``wx.MOUSE_BTN_LEFT`` for
4688 the left mouse button, ``wx.MOUSE_BTN_MIDDLE`` for the middle one and
4689 ``wx.MOUSE_BTN_RIGHT`` for the right one. Note that not all mice have
4690 a middle button so a portable application should avoid relying on the
4691 events from it.
4692
4693 Note the difference between methods like `LeftDown` and `LeftIsDown`:
4694 the former returns true when the event corresponds to the left mouse
4695 button click while the latter returns true if the left mouse button is
4696 currently being pressed. For example, when the user is dragging the
4697 mouse you can use `LeftIsDown` to test whether the left mouse button
4698 is (still) depressed. Also, by convention, if `LeftDown` returns true,
4699 `LeftIsDown` will also return true in wxWidgets whatever the
4700 underlying GUI behaviour is (which is platform-dependent). The same
4701 applies, of course, to other mouse buttons as well.
4702 """
0085ce49
RD
4703 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4704 __repr__ = _swig_repr
4705 def __init__(self, *args, **kwargs):
27fb7603 4706 """
2131d850 4707 __init__(self, EventType mouseType=wxEVT_NULL) -> MouseEvent
27fb7603
RD
4708
4709 Constructs a wx.MouseEvent. Valid event types are:
4710
4711 * wxEVT_ENTER_WINDOW
4712 * wxEVT_LEAVE_WINDOW
4713 * wxEVT_LEFT_DOWN
4714 * wxEVT_LEFT_UP
4715 * wxEVT_LEFT_DCLICK
4716 * wxEVT_MIDDLE_DOWN
4717 * wxEVT_MIDDLE_UP
4718 * wxEVT_MIDDLE_DCLICK
4719 * wxEVT_RIGHT_DOWN
4720 * wxEVT_RIGHT_UP
4721 * wxEVT_RIGHT_DCLICK
4722 * wxEVT_MOTION
4723 * wxEVT_MOUSEWHEEL
4724 """
0085ce49 4725 _core_.MouseEvent_swiginit(self,_core_.new_MouseEvent(*args, **kwargs))
e811c8ce 4726 def IsButton(*args, **kwargs):
27fb7603
RD
4727 """
4728 IsButton(self) -> bool
4729
4730 Returns true if the event was a mouse button event (not necessarily a
4731 button down event - that may be tested using `ButtonDown`).
4732 """
54f9ee45 4733 return _core_.MouseEvent_IsButton(*args, **kwargs)
e811c8ce
RD
4734
4735 def ButtonDown(*args, **kwargs):
27fb7603
RD
4736 """
4737 ButtonDown(self, int but=MOUSE_BTN_ANY) -> bool
4738
5ba5649b
RD
4739 If the argument is omitted, this returns true if the event was any
4740 mouse button down event. Otherwise the argument specifies which
4741 button-down event shold be checked for (see `Button` for the possible
4742 values).
27fb7603 4743 """
54f9ee45 4744 return _core_.MouseEvent_ButtonDown(*args, **kwargs)
e811c8ce
RD
4745
4746 def ButtonDClick(*args, **kwargs):
27fb7603
RD
4747 """
4748 ButtonDClick(self, int but=MOUSE_BTN_ANY) -> bool
4749
4750 If the argument is omitted, this returns true if the event was any
4751 mouse double click event. Otherwise the argument specifies which
4752 double click event to check for (see `Button` for the possible
4753 values).
4754 """
54f9ee45 4755 return _core_.MouseEvent_ButtonDClick(*args, **kwargs)
e811c8ce
RD
4756
4757 def ButtonUp(*args, **kwargs):
27fb7603
RD
4758 """
4759 ButtonUp(self, int but=MOUSE_BTN_ANY) -> bool
4760
4761 If the argument is omitted, this returns true if the event was any
5ba5649b
RD
4762 mouse button up event. Otherwise the argument specifies which button
4763 up event to check for (see `Button` for the possible values).
27fb7603 4764 """
54f9ee45 4765 return _core_.MouseEvent_ButtonUp(*args, **kwargs)
e811c8ce
RD
4766
4767 def Button(*args, **kwargs):
27fb7603
RD
4768 """
4769 Button(self, int button) -> bool
4770
4771 Returns true if the identified mouse button is changing state. Valid
4772 values of button are:
4773
4774 ==================== =====================================
4775 wx.MOUSE_BTN_LEFT check if left button was pressed
4776 wx.MOUSE_BTN_MIDDLE check if middle button was pressed
4777 wx.MOUSE_BTN_RIGHT check if right button was pressed
4778 wx.MOUSE_BTN_ANY check if any button was pressed
4779 ==================== =====================================
4780
4781 """
54f9ee45 4782 return _core_.MouseEvent_Button(*args, **kwargs)
e811c8ce
RD
4783
4784 def ButtonIsDown(*args, **kwargs):
a95a7133 4785 """ButtonIsDown(self, int but) -> bool"""
54f9ee45 4786 return _core_.MouseEvent_ButtonIsDown(*args, **kwargs)
e811c8ce
RD
4787
4788 def GetButton(*args, **kwargs):
27fb7603
RD
4789 """
4790 GetButton(self) -> int
4791
4792 Returns the mouse button which generated this event or
4793 wx.MOUSE_BTN_NONE if no button is involved (for mouse move, enter or
4794 leave event, for example). Otherwise wx.MOUSE_BTN_LEFT is returned for
4795 the left button down, up and double click events, wx.MOUSE_BTN_MIDDLE
4796 and wx.MOUSE_BTN_RIGHT for the same events for the middle and the
4797 right buttons respectively.
4798 """
54f9ee45 4799 return _core_.MouseEvent_GetButton(*args, **kwargs)
e811c8ce
RD
4800
4801 def ControlDown(*args, **kwargs):
27fb7603
RD
4802 """
4803 ControlDown(self) -> bool
4804
4805 Returns true if the control key was down at the time of the event.
4806 """
54f9ee45 4807 return _core_.MouseEvent_ControlDown(*args, **kwargs)
e811c8ce
RD
4808
4809 def MetaDown(*args, **kwargs):
27fb7603
RD
4810 """
4811 MetaDown(self) -> bool
4812
4813 Returns true if the Meta key was down at the time of the event.
4814 """
54f9ee45 4815 return _core_.MouseEvent_MetaDown(*args, **kwargs)
e811c8ce
RD
4816
4817 def AltDown(*args, **kwargs):
27fb7603
RD
4818 """
4819 AltDown(self) -> bool
4820
4821 Returns true if the Alt key was down at the time of the event.
4822 """
54f9ee45 4823 return _core_.MouseEvent_AltDown(*args, **kwargs)
e811c8ce
RD
4824
4825 def ShiftDown(*args, **kwargs):
27fb7603
RD
4826 """
4827 ShiftDown(self) -> bool
4828
4829 Returns true if the Shift key was down at the time of the event.
4830 """
54f9ee45 4831 return _core_.MouseEvent_ShiftDown(*args, **kwargs)
e811c8ce 4832
412d302d
RD
4833 def CmdDown(*args, **kwargs):
4834 """
4835 CmdDown(self) -> bool
4836
4837 "Cmd" is a pseudo key which is the same as Control for PC and Unix
4838 platforms but the special "Apple" (a.k.a as "Command") key on
5ba5649b 4839 Macs. It often makes sense to use it instead of, say, `ControlDown`
412d302d 4840 because Cmd key is used for the same thing under Mac as Ctrl
27fb7603 4841 elsewhere. The Ctrl key still exists, it's just not used for this
412d302d
RD
4842 purpose. So for non-Mac platforms this is the same as `ControlDown`
4843 and Macs this is the same as `MetaDown`.
4844 """
4845 return _core_.MouseEvent_CmdDown(*args, **kwargs)
4846
e811c8ce 4847 def LeftDown(*args, **kwargs):
27fb7603
RD
4848 """
4849 LeftDown(self) -> bool
4850
4851 Returns true if the left mouse button state changed to down.
4852 """
54f9ee45 4853 return _core_.MouseEvent_LeftDown(*args, **kwargs)
e811c8ce
RD
4854
4855 def MiddleDown(*args, **kwargs):
27fb7603
RD
4856 """
4857 MiddleDown(self) -> bool
4858
4859 Returns true if the middle mouse button state changed to down.
4860 """
54f9ee45 4861 return _core_.MouseEvent_MiddleDown(*args, **kwargs)
e811c8ce
RD
4862
4863 def RightDown(*args, **kwargs):
27fb7603
RD
4864 """
4865 RightDown(self) -> bool
4866
4867 Returns true if the right mouse button state changed to down.
4868 """
54f9ee45 4869 return _core_.MouseEvent_RightDown(*args, **kwargs)
e811c8ce
RD
4870
4871 def LeftUp(*args, **kwargs):
27fb7603
RD
4872 """
4873 LeftUp(self) -> bool
4874
4875 Returns true if the left mouse button state changed to up.
4876 """
54f9ee45 4877 return _core_.MouseEvent_LeftUp(*args, **kwargs)
e811c8ce
RD
4878
4879 def MiddleUp(*args, **kwargs):
27fb7603
RD
4880 """
4881 MiddleUp(self) -> bool
4882
4883 Returns true if the middle mouse button state changed to up.
4884 """
54f9ee45 4885 return _core_.MouseEvent_MiddleUp(*args, **kwargs)
e811c8ce
RD
4886
4887 def RightUp(*args, **kwargs):
27fb7603
RD
4888 """
4889 RightUp(self) -> bool
4890
4891 Returns true if the right mouse button state changed to up.
4892 """
54f9ee45 4893 return _core_.MouseEvent_RightUp(*args, **kwargs)
e811c8ce
RD
4894
4895 def LeftDClick(*args, **kwargs):
27fb7603
RD
4896 """
4897 LeftDClick(self) -> bool
4898
4899 Returns true if the event was a left button double click.
4900 """
54f9ee45 4901 return _core_.MouseEvent_LeftDClick(*args, **kwargs)
e811c8ce
RD
4902
4903 def MiddleDClick(*args, **kwargs):
27fb7603
RD
4904 """
4905 MiddleDClick(self) -> bool
4906
4907 Returns true if the event was a middle button double click.
4908 """
54f9ee45 4909 return _core_.MouseEvent_MiddleDClick(*args, **kwargs)
e811c8ce
RD
4910
4911 def RightDClick(*args, **kwargs):
27fb7603
RD
4912 """
4913 RightDClick(self) -> bool
4914
4915 Returns true if the event was a right button double click.
4916 """
54f9ee45 4917 return _core_.MouseEvent_RightDClick(*args, **kwargs)
e811c8ce
RD
4918
4919 def LeftIsDown(*args, **kwargs):
27fb7603
RD
4920 """
4921 LeftIsDown(self) -> bool
4922
4923 Returns true if the left mouse button is currently down, independent
4924 of the current event type.
4925
4926 Please notice that it is not the same as LeftDown which returns true
4927 if the left mouse button was just pressed. Rather, it describes the
4928 state of the mouse button before the event happened.
4929
4930 This event is usually used in the mouse event handlers which process
4931 "move mouse" messages to determine whether the user is (still)
4932 dragging the mouse.
4933 """
54f9ee45 4934 return _core_.MouseEvent_LeftIsDown(*args, **kwargs)
e811c8ce
RD
4935
4936 def MiddleIsDown(*args, **kwargs):
27fb7603
RD
4937 """
4938 MiddleIsDown(self) -> bool
4939
4940 Returns true if the middle mouse button is currently down, independent
4941 of the current event type.
4942 """
54f9ee45 4943 return _core_.MouseEvent_MiddleIsDown(*args, **kwargs)
e811c8ce
RD
4944
4945 def RightIsDown(*args, **kwargs):
27fb7603
RD
4946 """
4947 RightIsDown(self) -> bool
4948
4949 Returns true if the right mouse button is currently down, independent
4950 of the current event type.
4951 """
54f9ee45 4952 return _core_.MouseEvent_RightIsDown(*args, **kwargs)
e811c8ce
RD
4953
4954 def Dragging(*args, **kwargs):
27fb7603
RD
4955 """
4956 Dragging(self) -> bool
4957
4958 Returns true if this was a dragging event (motion while a button is
4959 depressed).
4960 """
54f9ee45 4961 return _core_.MouseEvent_Dragging(*args, **kwargs)
e811c8ce
RD
4962
4963 def Moving(*args, **kwargs):
27fb7603
RD
4964 """
4965 Moving(self) -> bool
4966
4967 Returns true if this was a motion event and no mouse buttons were
4968 pressed. If any mouse button is held pressed, then this method returns
4969 false and Dragging returns true.
4970 """
54f9ee45 4971 return _core_.MouseEvent_Moving(*args, **kwargs)
e811c8ce
RD
4972
4973 def Entering(*args, **kwargs):
27fb7603
RD
4974 """
4975 Entering(self) -> bool
4976
4977 Returns true if the mouse was entering the window.
4978 """
54f9ee45 4979 return _core_.MouseEvent_Entering(*args, **kwargs)
e811c8ce
RD
4980
4981 def Leaving(*args, **kwargs):
27fb7603
RD
4982 """
4983 Leaving(self) -> bool
4984
4985 Returns true if the mouse was leaving the window.
4986 """
54f9ee45 4987 return _core_.MouseEvent_Leaving(*args, **kwargs)
e811c8ce
RD
4988
4989 def GetPosition(*args, **kwargs):
0df68c9f 4990 """
a95a7133 4991 GetPosition(self) -> Point
e811c8ce 4992
27fb7603
RD
4993 Returns the pixel position of the mouse in window coordinates when the
4994 event happened.
0df68c9f 4995 """
54f9ee45 4996 return _core_.MouseEvent_GetPosition(*args, **kwargs)
e811c8ce
RD
4997
4998 def GetPositionTuple(*args, **kwargs):
0df68c9f
RD
4999 """
5000 GetPositionTuple() -> (x,y)
e811c8ce 5001
27fb7603
RD
5002 Returns the pixel position of the mouse in window coordinates when the
5003 event happened.
0df68c9f 5004 """
54f9ee45 5005 return _core_.MouseEvent_GetPositionTuple(*args, **kwargs)
e811c8ce
RD
5006
5007 def GetLogicalPosition(*args, **kwargs):
27fb7603
RD
5008 """
5009 GetLogicalPosition(self, DC dc) -> Point
5010
5011 Returns the logical mouse position in pixels (i.e. translated
5012 according to the translation set for the DC, which usually indicates
5013 that the window has been scrolled).
5014 """
54f9ee45 5015 return _core_.MouseEvent_GetLogicalPosition(*args, **kwargs)
e811c8ce
RD
5016
5017 def GetX(*args, **kwargs):
27fb7603
RD
5018 """
5019 GetX(self) -> int
5020
5021 Returns X coordinate of the physical mouse event position.
5022 """
54f9ee45 5023 return _core_.MouseEvent_GetX(*args, **kwargs)
e811c8ce
RD
5024
5025 def GetY(*args, **kwargs):
27fb7603
RD
5026 """
5027 GetY(self) -> int
5028
5029 Returns Y coordinate of the physical mouse event position.
5030 """
54f9ee45 5031 return _core_.MouseEvent_GetY(*args, **kwargs)
e811c8ce
RD
5032
5033 def GetWheelRotation(*args, **kwargs):
27fb7603
RD
5034 """
5035 GetWheelRotation(self) -> int
5036
5037 Get wheel rotation, positive or negative indicates direction of
5038 rotation. Current devices all send an event when rotation is equal to
5039 +/-WheelDelta, but this allows for finer resolution devices to be
5040 created in the future. Because of this you shouldn't assume that one
5041 event is equal to 1 line or whatever, but you should be able to either
5042 do partial line scrolling or wait until +/-WheelDelta rotation values
5043 have been accumulated before scrolling.
5044 """
54f9ee45 5045 return _core_.MouseEvent_GetWheelRotation(*args, **kwargs)
e811c8ce
RD
5046
5047 def GetWheelDelta(*args, **kwargs):
27fb7603
RD
5048 """
5049 GetWheelDelta(self) -> int
5050
5051 Get wheel delta, normally 120. This is the threshold for action to be
5052 taken, and one such action (for example, scrolling one increment)
5053 should occur for each delta.
5054 """
54f9ee45 5055 return _core_.MouseEvent_GetWheelDelta(*args, **kwargs)
e811c8ce
RD
5056
5057 def GetLinesPerAction(*args, **kwargs):
27fb7603
RD
5058 """
5059 GetLinesPerAction(self) -> int
5060
5061 Returns the configured number of lines (or whatever) to be scrolled
5062 per wheel action. Defaults to three.
5063 """
54f9ee45 5064 return _core_.MouseEvent_GetLinesPerAction(*args, **kwargs)
e811c8ce
RD
5065
5066 def IsPageScroll(*args, **kwargs):
27fb7603
RD
5067 """
5068 IsPageScroll(self) -> bool
5069
5070 Returns true if the system has been setup to do page scrolling with
5071 the mouse wheel instead of line scrolling.
5072 """
54f9ee45
RD
5073 return _core_.MouseEvent_IsPageScroll(*args, **kwargs)
5074
5075 m_x = property(_core_.MouseEvent_m_x_get, _core_.MouseEvent_m_x_set)
5076 m_y = property(_core_.MouseEvent_m_y_get, _core_.MouseEvent_m_y_set)
5077 m_leftDown = property(_core_.MouseEvent_m_leftDown_get, _core_.MouseEvent_m_leftDown_set)
5078 m_middleDown = property(_core_.MouseEvent_m_middleDown_get, _core_.MouseEvent_m_middleDown_set)
5079 m_rightDown = property(_core_.MouseEvent_m_rightDown_get, _core_.MouseEvent_m_rightDown_set)
5080 m_controlDown = property(_core_.MouseEvent_m_controlDown_get, _core_.MouseEvent_m_controlDown_set)
5081 m_shiftDown = property(_core_.MouseEvent_m_shiftDown_get, _core_.MouseEvent_m_shiftDown_set)
5082 m_altDown = property(_core_.MouseEvent_m_altDown_get, _core_.MouseEvent_m_altDown_set)
5083 m_metaDown = property(_core_.MouseEvent_m_metaDown_get, _core_.MouseEvent_m_metaDown_set)
5084 m_wheelRotation = property(_core_.MouseEvent_m_wheelRotation_get, _core_.MouseEvent_m_wheelRotation_set)
5085 m_wheelDelta = property(_core_.MouseEvent_m_wheelDelta_get, _core_.MouseEvent_m_wheelDelta_set)
5086 m_linesPerAction = property(_core_.MouseEvent_m_linesPerAction_get, _core_.MouseEvent_m_linesPerAction_set)
57332a5a
RD
5087 Button = property(GetButton,doc="See `GetButton`")
5088 LinesPerAction = property(GetLinesPerAction,doc="See `GetLinesPerAction`")
5089 LogicalPosition = property(GetLogicalPosition,doc="See `GetLogicalPosition`")
5090 Position = property(GetPosition,doc="See `GetPosition`")
5091 WheelDelta = property(GetWheelDelta,doc="See `GetWheelDelta`")
5092 WheelRotation = property(GetWheelRotation,doc="See `GetWheelRotation`")
5093 X = property(GetX,doc="See `GetX`")
5094 Y = property(GetY,doc="See `GetY`")
2131d850 5095_core_.MouseEvent_swigregister(MouseEvent)
d14a1e28
RD
5096
5097#---------------------------------------------------------------------------
5098
5099class SetCursorEvent(Event):
5ba5649b
RD
5100 """
5101 A SetCursorEvent is generated when the mouse cursor is about to be set
5102 as a result of mouse motion. This event gives the application the
5103 chance to perform specific mouse cursor processing based on the
5104 current position of the mouse within the window. Use the `SetCursor`
5105 method to specify the cursor you want to be displayed.
5106 """
0085ce49
RD
5107 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5108 __repr__ = _swig_repr
5109 def __init__(self, *args, **kwargs):
5ba5649b
RD
5110 """
5111 __init__(self, int x=0, int y=0) -> SetCursorEvent
5112
5113 Construct a new `wx.SetCursorEvent`.
5114 """
0085ce49 5115 _core_.SetCursorEvent_swiginit(self,_core_.new_SetCursorEvent(*args, **kwargs))
e811c8ce 5116 def GetX(*args, **kwargs):
5ba5649b
RD
5117 """
5118 GetX(self) -> int
5119
5120 Returns the X coordinate of the mouse in client coordinates.
5121 """
54f9ee45 5122 return _core_.SetCursorEvent_GetX(*args, **kwargs)
e811c8ce
RD
5123
5124 def GetY(*args, **kwargs):
5ba5649b
RD
5125 """
5126 GetY(self) -> int
5127
5128 Returns the Y coordinate of the mouse in client coordinates.
5129 """
54f9ee45 5130 return _core_.SetCursorEvent_GetY(*args, **kwargs)
e811c8ce
RD
5131
5132 def SetCursor(*args, **kwargs):
5ba5649b
RD
5133 """
5134 SetCursor(self, Cursor cursor)
5135
5136 Sets the cursor associated with this event.
5137 """
54f9ee45 5138 return _core_.SetCursorEvent_SetCursor(*args, **kwargs)
e811c8ce
RD
5139
5140 def GetCursor(*args, **kwargs):
5ba5649b
RD
5141 """
5142 GetCursor(self) -> Cursor
5143
5144 Returns a reference to the cursor specified by this event.
5145 """
54f9ee45 5146 return _core_.SetCursorEvent_GetCursor(*args, **kwargs)
e811c8ce
RD
5147
5148 def HasCursor(*args, **kwargs):
5ba5649b
RD
5149 """
5150 HasCursor(self) -> bool
5151
5152 Returns true if the cursor specified by this event is a valid cursor.
5153 """
54f9ee45 5154 return _core_.SetCursorEvent_HasCursor(*args, **kwargs)
e811c8ce 5155
33d6fd3b
RD
5156 Cursor = property(GetCursor,SetCursor,doc="See `GetCursor` and `SetCursor`")
5157 X = property(GetX,doc="See `GetX`")
5158 Y = property(GetY,doc="See `GetY`")
2131d850 5159_core_.SetCursorEvent_swigregister(SetCursorEvent)
d14a1e28
RD
5160
5161#---------------------------------------------------------------------------
5162
5163class KeyEvent(Event):
5ba5649b
RD
5164 """
5165 This event class contains information about keypress and character
5166 events. These events are only sent to the widget that currently has
5167 the keyboard focus.
5168
5169 Notice that there are three different kinds of keyboard events in
5170 wxWidgets: key down and up events and char events. The difference
5171 between the first two is clear - the first corresponds to a key press
5172 and the second to a key release - otherwise they are identical. Just
5173 note that if the key is maintained in a pressed state you will
5174 typically get a lot of (automatically generated) down events but only
5175 one up so it is wrong to assume that there is one up event
5176 corresponding to each down one.
5177
5178 Both key events provide untranslated key codes while the char event
5179 carries the translated one. The untranslated code for alphanumeric
5180 keys is always an upper case value. For the other keys it is one of
5181 WXK_XXX values from the keycodes table. The translated key is, in
5182 general, the character the user expects to appear as the result of the
5183 key combination when typing the text into a text entry zone, for
5184 example.
5185
5186 A few examples to clarify this (all assume that CAPS LOCK is unpressed
5187 and the standard US keyboard): when the 'A' key is pressed, the key
5188 down event key code is equal to ASCII A == 65. But the char event key
5189 code is ASCII a == 97. On the other hand, if you press both SHIFT and
5190 'A' keys simultaneously , the key code in key down event will still be
5191 just 'A' while the char event key code parameter will now be 'A' as
5192 well.
5193
5194 Although in this simple case it is clear that the correct key code
5195 could be found in the key down event handler by checking the value
5196 returned by `ShiftDown`, in general you should use EVT_CHAR for this
5197 as for non alphanumeric keys or non-US keyboard layouts the
5198 translation is keyboard-layout dependent and can only be done properly
5199 by the system itself.
5200
5201 Another kind of translation is done when the control key is pressed:
5202 for example, for CTRL-A key press the key down event still carries the
5203 same key code 'A' as usual but the char event will have key code of 1,
5204 the ASCII value of this key combination.
5205
5206 You may discover how the other keys on your system behave
5207 interactively by running the KeyEvents sample in the wxPython demo and
5208 pressing some keys while the blue box at the top has the keyboard
5209 focus.
5210
5211 **Note**: If a key down event is caught and the event handler does not
5212 call event.Skip() then the coresponding char event will not
5213 happen. This is by design and enables the programs that handle both
5214 types of events to be a bit simpler.
5215
5216 **Note for Windows programmers**: The key and char events in wxWidgets
5217 are similar to but slightly different from Windows WM_KEYDOWN and
5218 WM_CHAR events. In particular, Alt-x combination will generate a char
5219 event in wxWidgets (unless it is used as an accelerator).
5220
5221 **Tip**: be sure to call event.Skip() for events that you don't
5222 process in key event function, otherwise menu shortcuts may cease to
5223 work under Windows.
5224
5225 """
0085ce49
RD
5226 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5227 __repr__ = _swig_repr
5228 def __init__(self, *args, **kwargs):
5ba5649b 5229 """
2131d850 5230 __init__(self, EventType eventType=wxEVT_NULL) -> KeyEvent
5ba5649b
RD
5231
5232 Construct a new `wx.KeyEvent`. Valid event types are:
5233 *
5234 """
0085ce49 5235 _core_.KeyEvent_swiginit(self,_core_.new_KeyEvent(*args, **kwargs))
b1fcee84
RD
5236 def GetModifiers(*args, **kwargs):
5237 """
5238 GetModifiers(self) -> int
5239
5240 Returns a bitmask of the current modifier settings. Can be used to
5241 check if the key event has exactly the given modifiers without having
5242 to explicitly check that the other modifiers are not down. For
5243 example::
5244
5245 if event.GetModifers() == wx.MOD_CONTROL:
5246 DoSomething()
5247
5248 """
5249 return _core_.KeyEvent_GetModifiers(*args, **kwargs)
5250
e811c8ce 5251 def ControlDown(*args, **kwargs):
5ba5649b
RD
5252 """
5253 ControlDown(self) -> bool
5254
5255 Returns ``True`` if the Control key was down at the time of the event.
5256 """
54f9ee45 5257 return _core_.KeyEvent_ControlDown(*args, **kwargs)
e811c8ce
RD
5258
5259 def MetaDown(*args, **kwargs):
5ba5649b
RD
5260 """
5261 MetaDown(self) -> bool
5262
5263 Returns ``True`` if the Meta key was down at the time of the event.
5264 """
54f9ee45 5265 return _core_.KeyEvent_MetaDown(*args, **kwargs)
e811c8ce
RD
5266
5267 def AltDown(*args, **kwargs):
5ba5649b
RD
5268 """
5269 AltDown(self) -> bool
5270
5271 Returns ``True`` if the Alt key was down at the time of the event.
5272 """
54f9ee45 5273 return _core_.KeyEvent_AltDown(*args, **kwargs)
e811c8ce
RD
5274
5275 def ShiftDown(*args, **kwargs):
5ba5649b
RD
5276 """
5277 ShiftDown(self) -> bool
5278
5279 Returns ``True`` if the Shift key was down at the time of the event.
5280 """
54f9ee45 5281 return _core_.KeyEvent_ShiftDown(*args, **kwargs)
e811c8ce 5282
412d302d
RD
5283 def CmdDown(*args, **kwargs):
5284 """
5285 CmdDown(self) -> bool
5286
5287 "Cmd" is a pseudo key which is the same as Control for PC and Unix
5288 platforms but the special "Apple" (a.k.a as "Command") key on
5ba5649b 5289 Macs. It makes often sense to use it instead of, say, `ControlDown`
412d302d
RD
5290 because Cmd key is used for the same thing under Mac as Ctrl
5291 elsewhere. The Ctrl still exists, it's just not used for this
5292 purpose. So for non-Mac platforms this is the same as `ControlDown`
5293 and Macs this is the same as `MetaDown`.
5294 """
5295 return _core_.KeyEvent_CmdDown(*args, **kwargs)
5296
e811c8ce 5297 def HasModifiers(*args, **kwargs):
5ba5649b
RD
5298 """
5299 HasModifiers(self) -> bool
5300
5301 Returns true if either CTRL or ALT keys was down at the time of the
5302 key event. Note that this function does not take into account neither
5303 SHIFT nor META key states (the reason for ignoring the latter is that
5304 it is common for NUMLOCK key to be configured as META under X but the
5305 key presses even while NUMLOCK is on should be still processed
5306 normally).
5307 """
54f9ee45 5308 return _core_.KeyEvent_HasModifiers(*args, **kwargs)
e811c8ce
RD
5309
5310 def GetKeyCode(*args, **kwargs):
5ba5649b
RD
5311 """
5312 GetKeyCode(self) -> int
5313
5314 Returns the virtual key code. ASCII events return normal ASCII values,
5315 while non-ASCII events return values such as WXK_LEFT for the left
5316 cursor key. See `wx.KeyEvent` for a full list of the virtual key
5317 codes.
5318
5319 Note that in Unicode build, the returned value is meaningful only if
5320 the user entered a character that can be represented in current
5321 locale's default charset. You can obtain the corresponding Unicode
5322 character using `GetUnicodeKey`.
5323 """
54f9ee45 5324 return _core_.KeyEvent_GetKeyCode(*args, **kwargs)
e811c8ce 5325
19272049 5326 def GetUnicodeKey(*args, **kwargs):
5ba5649b
RD
5327 """
5328 GetUnicodeKey(self) -> int
5329
5330 Returns the Unicode character corresponding to this key event. This
5331 function is only meaningfule in a Unicode build of wxPython.
5332 """
19272049 5333 return _core_.KeyEvent_GetUnicodeKey(*args, **kwargs)
e811c8ce 5334
19272049 5335 GetUniChar = GetUnicodeKey
b850e7f3
RD
5336 def SetUnicodeKey(*args, **kwargs):
5337 """
5338 SetUnicodeKey(self, int uniChar)
5339
5340 Set the Unicode value of the key event, but only if this is a Unicode
5341 build of wxPython.
5342 """
5343 return _core_.KeyEvent_SetUnicodeKey(*args, **kwargs)
5344
e811c8ce 5345 def GetRawKeyCode(*args, **kwargs):
5ba5649b
RD
5346 """
5347 GetRawKeyCode(self) -> unsigned int
5348
5349 Returns the raw key code for this event. This is a platform-dependent
5350 scan code which should only be used in advanced
5351 applications. Currently the raw key codes are not supported by all
5352 ports.
5353 """
54f9ee45 5354 return _core_.KeyEvent_GetRawKeyCode(*args, **kwargs)
e811c8ce
RD
5355
5356 def GetRawKeyFlags(*args, **kwargs):
5ba5649b
RD
5357 """
5358 GetRawKeyFlags(self) -> unsigned int
5359
5360 Returns the low level key flags for this event. The flags are
5361 platform-dependent and should only be used in advanced applications.
5362 Currently the raw key flags are not supported by all ports.
5363 """
54f9ee45 5364 return _core_.KeyEvent_GetRawKeyFlags(*args, **kwargs)
e811c8ce
RD
5365
5366 def GetPosition(*args, **kwargs):
0df68c9f 5367 """
a95a7133 5368 GetPosition(self) -> Point
e811c8ce 5369
5ba5649b 5370 Find the position of the event, if applicable.
0df68c9f 5371 """
54f9ee45 5372 return _core_.KeyEvent_GetPosition(*args, **kwargs)
e811c8ce
RD
5373
5374 def GetPositionTuple(*args, **kwargs):
0df68c9f
RD
5375 """
5376 GetPositionTuple() -> (x,y)
e811c8ce 5377
5ba5649b 5378 Find the position of the event, if applicable.
0df68c9f 5379 """
54f9ee45 5380 return _core_.KeyEvent_GetPositionTuple(*args, **kwargs)
e811c8ce
RD
5381
5382 def GetX(*args, **kwargs):
5ba5649b
RD
5383 """
5384 GetX(self) -> int
5385
5386 Returns the X position (in client coordinates) of the event, if
5387 applicable.
5388 """
54f9ee45 5389 return _core_.KeyEvent_GetX(*args, **kwargs)
e811c8ce
RD
5390
5391 def GetY(*args, **kwargs):
5ba5649b
RD
5392 """
5393 GetY(self) -> int
5394
5395 Returns the Y position (in client coordinates) of the event, if
5396 applicable.
5397 """
54f9ee45
RD
5398 return _core_.KeyEvent_GetY(*args, **kwargs)
5399
5400 m_x = property(_core_.KeyEvent_m_x_get, _core_.KeyEvent_m_x_set)
5401 m_y = property(_core_.KeyEvent_m_y_get, _core_.KeyEvent_m_y_set)
5402 m_keyCode = property(_core_.KeyEvent_m_keyCode_get, _core_.KeyEvent_m_keyCode_set)
5403 m_controlDown = property(_core_.KeyEvent_m_controlDown_get, _core_.KeyEvent_m_controlDown_set)
5404 m_shiftDown = property(_core_.KeyEvent_m_shiftDown_get, _core_.KeyEvent_m_shiftDown_set)
5405 m_altDown = property(_core_.KeyEvent_m_altDown_get, _core_.KeyEvent_m_altDown_set)
5406 m_metaDown = property(_core_.KeyEvent_m_metaDown_get, _core_.KeyEvent_m_metaDown_set)
5407 m_scanCode = property(_core_.KeyEvent_m_scanCode_get, _core_.KeyEvent_m_scanCode_set)
5408 m_rawCode = property(_core_.KeyEvent_m_rawCode_get, _core_.KeyEvent_m_rawCode_set)
5409 m_rawFlags = property(_core_.KeyEvent_m_rawFlags_get, _core_.KeyEvent_m_rawFlags_set)
97ab0f6a
RD
5410 KeyCode = property(GetKeyCode,doc="See `GetKeyCode`")
5411 Modifiers = property(GetModifiers,doc="See `GetModifiers`")
5412 Position = property(GetPosition,doc="See `GetPosition`")
5413 RawKeyCode = property(GetRawKeyCode,doc="See `GetRawKeyCode`")
5414 RawKeyFlags = property(GetRawKeyFlags,doc="See `GetRawKeyFlags`")
5415 UnicodeKey = property(GetUnicodeKey,SetUnicodeKey,doc="See `GetUnicodeKey` and `SetUnicodeKey`")
5416 X = property(GetX,doc="See `GetX`")
5417 Y = property(GetY,doc="See `GetY`")
2131d850 5418_core_.KeyEvent_swigregister(KeyEvent)
d14a1e28
RD
5419
5420#---------------------------------------------------------------------------
5421
5422class SizeEvent(Event):
5ba5649b
RD
5423 """
5424 A size event holds information about size change events. The EVT_SIZE
5425 handler function will be called when the window it is bound to has
5426 been resized.
5427
5428 Note that the size passed is of the whole window: call
5429 `wx.Window.GetClientSize` for the area which may be used by the
5430 application.
5431
5432 When a window is resized, usually only a small part of the window is
5433 damaged and and that area is all that is in the update region for the
5434 next paint event. However, if your drawing depends on the size of the
5435 window, you may need to clear the DC explicitly and repaint the whole
5436 window. In which case, you may need to call `wx.Window.Refresh` to
5437 invalidate the entire window.
5438
5439 """
0085ce49
RD
5440 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5441 __repr__ = _swig_repr
5442 def __init__(self, *args, **kwargs):
5ba5649b
RD
5443 """
5444 __init__(self, Size sz=DefaultSize, int winid=0) -> SizeEvent
5445
5446 Construct a new ``wx.SizeEvent``.
5447 """
0085ce49 5448 _core_.SizeEvent_swiginit(self,_core_.new_SizeEvent(*args, **kwargs))
e811c8ce 5449 def GetSize(*args, **kwargs):
5ba5649b
RD
5450 """
5451 GetSize(self) -> Size
5452
5453 Returns the entire size of the window generating the size change
5454 event.
5455 """
54f9ee45 5456 return _core_.SizeEvent_GetSize(*args, **kwargs)
e811c8ce
RD
5457
5458 def GetRect(*args, **kwargs):
a95a7133 5459 """GetRect(self) -> Rect"""
54f9ee45 5460 return _core_.SizeEvent_GetRect(*args, **kwargs)
e811c8ce
RD
5461
5462 def SetRect(*args, **kwargs):
a95a7133 5463 """SetRect(self, Rect rect)"""
54f9ee45 5464 return _core_.SizeEvent_SetRect(*args, **kwargs)
e811c8ce
RD
5465
5466 def SetSize(*args, **kwargs):
a95a7133 5467 """SetSize(self, Size size)"""
54f9ee45 5468 return _core_.SizeEvent_SetSize(*args, **kwargs)
e811c8ce 5469
54f9ee45
RD
5470 m_size = property(_core_.SizeEvent_m_size_get, _core_.SizeEvent_m_size_set)
5471 m_rect = property(_core_.SizeEvent_m_rect_get, _core_.SizeEvent_m_rect_set)
33d6fd3b
RD
5472 Rect = property(GetRect,SetRect,doc="See `GetRect` and `SetRect`")
5473 Size = property(GetSize,SetSize,doc="See `GetSize` and `SetSize`")
2131d850 5474_core_.SizeEvent_swigregister(SizeEvent)
d14a1e28
RD
5475
5476#---------------------------------------------------------------------------
5477
5478class MoveEvent(Event):
5ba5649b
RD
5479 """
5480 This event object is sent for EVT_MOVE event bindings when a window is
5481 moved to a new position.
5482 """
0085ce49
RD
5483 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5484 __repr__ = _swig_repr
5485 def __init__(self, *args, **kwargs):
5ba5649b
RD
5486 """
5487 __init__(self, Point pos=DefaultPosition, int winid=0) -> MoveEvent
5488
5489 Constructor.
5490 """
0085ce49 5491 _core_.MoveEvent_swiginit(self,_core_.new_MoveEvent(*args, **kwargs))
e811c8ce 5492 def GetPosition(*args, **kwargs):
5ba5649b
RD
5493 """
5494 GetPosition(self) -> Point
5495
5496 Returns the position of the window generating the move change event.
5497 """
54f9ee45 5498 return _core_.MoveEvent_GetPosition(*args, **kwargs)
e811c8ce
RD
5499
5500 def GetRect(*args, **kwargs):
a95a7133 5501 """GetRect(self) -> Rect"""
54f9ee45 5502 return _core_.MoveEvent_GetRect(*args, **kwargs)
e811c8ce
RD
5503
5504 def SetRect(*args, **kwargs):
a95a7133 5505 """SetRect(self, Rect rect)"""
54f9ee45 5506 return _core_.MoveEvent_SetRect(*args, **kwargs)
e811c8ce
RD
5507
5508 def SetPosition(*args, **kwargs):
a95a7133 5509 """SetPosition(self, Point pos)"""
54f9ee45 5510 return _core_.MoveEvent_SetPosition(*args, **kwargs)
e811c8ce 5511
7557b9b5
RD
5512 m_pos = property(GetPosition, SetPosition)
5513 m_rect = property(GetRect, SetRect)
5514
57332a5a
RD
5515 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
5516 Rect = property(GetRect,SetRect,doc="See `GetRect` and `SetRect`")
2131d850 5517_core_.MoveEvent_swigregister(MoveEvent)
d14a1e28
RD
5518
5519#---------------------------------------------------------------------------
5520
5521class PaintEvent(Event):
5ba5649b
RD
5522 """
5523 A paint event is sent when a window's contents needs to be repainted.
5524 Note that in an EVT_PAINT handler the application must *always* create
5525 a `wx.PaintDC` object, even if you do not use it. Otherwise MS
5526 Windows assumes that the window has not been painted yet and will send
5527 the event again, causing endless refreshes.
5528
5529 You can optimize painting by retrieving the rectangles that have been
5530 damaged using `wx.Window.GetUpdateRegion` and/or `wx.RegionIterator`,
5531 and only repainting these rectangles. The rectangles are in terms of
5532 the client area, and are unscrolled, so you will need to do some
5533 calculations using the current view position to obtain logical,
5534 scrolled units.
5535
5536 """
0085ce49
RD
5537 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5538 __repr__ = _swig_repr
5539 def __init__(self, *args, **kwargs):
a95a7133 5540 """__init__(self, int Id=0) -> PaintEvent"""
0085ce49 5541 _core_.PaintEvent_swiginit(self,_core_.new_PaintEvent(*args, **kwargs))
2131d850 5542_core_.PaintEvent_swigregister(PaintEvent)
d14a1e28
RD
5543
5544class NcPaintEvent(Event):
093d3ff1 5545 """Proxy of C++ NcPaintEvent class"""
0085ce49
RD
5546 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5547 __repr__ = _swig_repr
5548 def __init__(self, *args, **kwargs):
a95a7133 5549 """__init__(self, int winid=0) -> NcPaintEvent"""
0085ce49 5550 _core_.NcPaintEvent_swiginit(self,_core_.new_NcPaintEvent(*args, **kwargs))
2131d850 5551_core_.NcPaintEvent_swigregister(NcPaintEvent)
d14a1e28
RD
5552
5553#---------------------------------------------------------------------------
5554
5555class EraseEvent(Event):
5ba5649b
RD
5556 """
5557 An erase event is sent whenever the background of a window needs to be
5558 repainted. To intercept this event use the EVT_ERASE_BACKGROUND event
5559 binder. On some platforms, such as GTK+, this event is simulated
5560 (simply generated just before the paint event) and may cause flicker.
5561
5562 To paint a custom background use the `GetDC` method and use the returned
5563 device context if it is not ``None``, otherwise create a temporary
5564 `wx.ClientDC` and draw on that.
5565
5566 """
0085ce49
RD
5567 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5568 __repr__ = _swig_repr
5569 def __init__(self, *args, **kwargs):
5ba5649b
RD
5570 """
5571 __init__(self, int Id=0, DC dc=None) -> EraseEvent
5572
5573 Constructor
5574 """
0085ce49 5575 _core_.EraseEvent_swiginit(self,_core_.new_EraseEvent(*args, **kwargs))
e811c8ce 5576 def GetDC(*args, **kwargs):
5ba5649b
RD
5577 """
5578 GetDC(self) -> DC
5579
5580 Returns the device context the event handler should draw upon. If
5581 ``None`` is returned then create a temporary `wx.ClientDC` and use
5582 that instead.
5583 """
54f9ee45 5584 return _core_.EraseEvent_GetDC(*args, **kwargs)
e811c8ce 5585
97ab0f6a 5586 DC = property(GetDC,doc="See `GetDC`")
2131d850 5587_core_.EraseEvent_swigregister(EraseEvent)
d14a1e28
RD
5588
5589#---------------------------------------------------------------------------
5590
5591class FocusEvent(Event):
5ba5649b
RD
5592 """
5593 A focus event is sent when a window's focus changes. The window losing
5594 focus receives an EVT_KILL_FOCUS event while the window gaining it
5595 gets an EVT_SET_FOCUS event.
5596
5597 Notice that the set focus event happens both when the user gives focus
5598 to the window (whether using the mouse or keyboard) and when it is
5599 done from the program itself using `wx.Window.SetFocus`.
5600
5601 """
0085ce49
RD
5602 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5603 __repr__ = _swig_repr
5604 def __init__(self, *args, **kwargs):
5ba5649b 5605 """
2131d850 5606 __init__(self, EventType type=wxEVT_NULL, int winid=0) -> FocusEvent
5ba5649b
RD
5607
5608 Constructor
5609 """
0085ce49 5610 _core_.FocusEvent_swiginit(self,_core_.new_FocusEvent(*args, **kwargs))
e811c8ce 5611 def GetWindow(*args, **kwargs):
5ba5649b
RD
5612 """
5613 GetWindow(self) -> Window
5614
5615 Returns the other window associated with this event, that is the
5616 window which had the focus before for the EVT_SET_FOCUS event and the
5617 window which is going to receive focus for the wxEVT_KILL_FOCUS event.
5618
5619 Warning: the window returned may be None!
5620 """
54f9ee45 5621 return _core_.FocusEvent_GetWindow(*args, **kwargs)
e811c8ce
RD
5622
5623 def SetWindow(*args, **kwargs):
a95a7133 5624 """SetWindow(self, Window win)"""
54f9ee45 5625 return _core_.FocusEvent_SetWindow(*args, **kwargs)
e811c8ce 5626
97ab0f6a 5627 Window = property(GetWindow,SetWindow,doc="See `GetWindow` and `SetWindow`")
2131d850 5628_core_.FocusEvent_swigregister(FocusEvent)
d14a1e28
RD
5629
5630#---------------------------------------------------------------------------
5631
5632class ChildFocusEvent(CommandEvent):
5ba5649b 5633 """
33d6fd3b
RD
5634 A child focus event is sent to a (parent-)window when one of its child
5635 windows gains focus, so that the window could restore the focus back
5636 to its corresponding child if it loses it now and regains later.
5637
5638 Notice that child window is the direct child of the window receiving
5639 the event, and so may not be the actual widget recieving focus if it
5640 is further down the containment heirarchy. Use `wx.Window.FindFocus`
5641 to get the widget that is actually receiving focus.
5ba5649b 5642 """
0085ce49
RD
5643 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5644 __repr__ = _swig_repr
5645 def __init__(self, *args, **kwargs):
5ba5649b
RD
5646 """
5647 __init__(self, Window win=None) -> ChildFocusEvent
5648
5649 Constructor
5650 """
0085ce49 5651 _core_.ChildFocusEvent_swiginit(self,_core_.new_ChildFocusEvent(*args, **kwargs))
e811c8ce 5652 def GetWindow(*args, **kwargs):
5ba5649b
RD
5653 """
5654 GetWindow(self) -> Window
5655
33d6fd3b
RD
5656 The window, or (grand)parent of the window which has just received the
5657 focus.
5ba5649b 5658 """
54f9ee45 5659 return _core_.ChildFocusEvent_GetWindow(*args, **kwargs)
e811c8ce 5660
2bf58437 5661 Window = property(GetWindow,doc="See `GetWindow`")
2131d850 5662_core_.ChildFocusEvent_swigregister(ChildFocusEvent)
d14a1e28
RD
5663
5664#---------------------------------------------------------------------------
5665
5666class ActivateEvent(Event):
5ba5649b
RD
5667 """
5668 An activate event is sent when a top-level window or the entire
5669 application is being activated or deactivated.
5670
5671 A top-level window (a dialog or frame) receives an activate event when
5672 is being activated or deactivated. This is indicated visually by the
5673 title bar changing colour, and a subwindow gaining the keyboard focus.
5674 An application is activated or deactivated when one of its frames
5675 becomes activated, or a frame becomes inactivate resulting in all
5676 application frames being inactive.
5677
5678 Please note that usually you should call event.Skip() in your handlers
5679 for these events so the default handlers will still be called, as not
5680 doing so can result in strange effects.
5681
5682 """
0085ce49
RD
5683 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5684 __repr__ = _swig_repr
5685 def __init__(self, *args, **kwargs):
5ba5649b 5686 """
2131d850 5687 __init__(self, EventType type=wxEVT_NULL, bool active=True, int Id=0) -> ActivateEvent
5ba5649b
RD
5688
5689 Constructor
5690 """
0085ce49 5691 _core_.ActivateEvent_swiginit(self,_core_.new_ActivateEvent(*args, **kwargs))
e811c8ce 5692 def GetActive(*args, **kwargs):
5ba5649b
RD
5693 """
5694 GetActive(self) -> bool
5695
5696 Returns true if the application or window is being activated, false
5697 otherwise.
5698 """
54f9ee45 5699 return _core_.ActivateEvent_GetActive(*args, **kwargs)
e811c8ce 5700
2bf58437 5701 Active = property(GetActive,doc="See `GetActive`")
2131d850 5702_core_.ActivateEvent_swigregister(ActivateEvent)
d14a1e28
RD
5703
5704#---------------------------------------------------------------------------
5705
5706class InitDialogEvent(Event):
5ba5649b
RD
5707 """
5708 A wx.InitDialogEvent is sent as a dialog is being initialised, or for
5709 any window when `wx.Window.InitDialog` is called. Handlers for this
5710 event can transfer data to the window, or anything else that should be
5711 done before the user begins editing the form. The default handler
5712 calls `wx.Window.TransferDataToWindow`.
5713 """
0085ce49
RD
5714 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5715 __repr__ = _swig_repr
5716 def __init__(self, *args, **kwargs):
5ba5649b
RD
5717 """
5718 __init__(self, int Id=0) -> InitDialogEvent
5719
5720 Constructor
5721 """
0085ce49 5722 _core_.InitDialogEvent_swiginit(self,_core_.new_InitDialogEvent(*args, **kwargs))
2131d850 5723_core_.InitDialogEvent_swigregister(InitDialogEvent)
d14a1e28
RD
5724
5725#---------------------------------------------------------------------------
5726
5727class MenuEvent(Event):
5ba5649b
RD
5728 """
5729 This class is used for a variety of menu-related events. Note that
5730 these do not include menu command events, which are handled by sending
5731 `wx.CommandEvent` objects.
5732
5733 The default handler for wx.EVT_MENU_HIGHLIGHT displays menu item help
5734 text in the first field of the status bar.
5735 """
0085ce49
RD
5736 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5737 __repr__ = _swig_repr
5738 def __init__(self, *args, **kwargs):
5ba5649b 5739 """
2131d850 5740 __init__(self, EventType type=wxEVT_NULL, int winid=0, Menu menu=None) -> MenuEvent
5ba5649b
RD
5741
5742 Constructor
5743 """
0085ce49 5744 _core_.MenuEvent_swiginit(self,_core_.new_MenuEvent(*args, **kwargs))
e811c8ce 5745 def GetMenuId(*args, **kwargs):
5ba5649b
RD
5746 """
5747 GetMenuId(self) -> int
5748
5749 Returns the menu identifier associated with the event. This method
5750 should be only used with the HIGHLIGHT events.
5751 """
54f9ee45 5752 return _core_.MenuEvent_GetMenuId(*args, **kwargs)
e811c8ce
RD
5753
5754 def IsPopup(*args, **kwargs):
5ba5649b
RD
5755 """
5756 IsPopup(self) -> bool
5757
5758 Returns ``True`` if the menu which is being opened or closed is a
5759 popup menu, ``False`` if it is a normal one. This method should only
5760 be used with the OPEN and CLOSE events.
5761 """
54f9ee45 5762 return _core_.MenuEvent_IsPopup(*args, **kwargs)
e811c8ce
RD
5763
5764 def GetMenu(*args, **kwargs):
5ba5649b
RD
5765 """
5766 GetMenu(self) -> Menu
5767
5768 Returns the menu which is being opened or closed. This method should
5769 only be used with the OPEN and CLOSE events.
5770 """
54f9ee45 5771 return _core_.MenuEvent_GetMenu(*args, **kwargs)
e811c8ce 5772
57332a5a
RD
5773 Menu = property(GetMenu,doc="See `GetMenu`")
5774 MenuId = property(GetMenuId,doc="See `GetMenuId`")
2131d850 5775_core_.MenuEvent_swigregister(MenuEvent)
d14a1e28
RD
5776
5777#---------------------------------------------------------------------------
5778
5779class CloseEvent(Event):
5ba5649b
RD
5780 """
5781 This event class contains information about window and session close
5782 events.
5783
5784 The handler function for EVT_CLOSE is called when the user has tried
5785 to close a a frame or dialog box using the window manager controls or
5786 the system menu. It can also be invoked by the application itself
5787 programmatically, for example by calling the `wx.Window.Close`
5788 function.
5789
5790 You should check whether the application is forcing the deletion of
5791 the window using `CanVeto`. If it returns ``False``, you must destroy
5792 the window using `wx.Window.Destroy`. If the return value is ``True``,
5793 it is up to you whether you respond by destroying the window or not.
5794 For example you may wish to display a message dialog prompting to save
5795 files or to cancel the close.
5796
5797 If you don't destroy the window, you should call `Veto` to let the
5798 calling code know that you did not destroy the window. This allows the
5799 `wx.Window.Close` function to return ``True`` or ``False`` depending
5800 on whether the close instruction was honored or not.
5801 """
0085ce49
RD
5802 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5803 __repr__ = _swig_repr
5804 def __init__(self, *args, **kwargs):
5ba5649b 5805 """
2131d850 5806 __init__(self, EventType type=wxEVT_NULL, int winid=0) -> CloseEvent
5ba5649b
RD
5807
5808 Constructor.
5809 """
0085ce49 5810 _core_.CloseEvent_swiginit(self,_core_.new_CloseEvent(*args, **kwargs))
e811c8ce 5811 def SetLoggingOff(*args, **kwargs):
5ba5649b
RD
5812 """
5813 SetLoggingOff(self, bool logOff)
5814
5815 Sets the 'logging off' flag.
5816 """
54f9ee45 5817 return _core_.CloseEvent_SetLoggingOff(*args, **kwargs)
e811c8ce
RD
5818
5819 def GetLoggingOff(*args, **kwargs):
5ba5649b
RD
5820 """
5821 GetLoggingOff(self) -> bool
5822
6c75a4cf
RD
5823 Returns ``True`` if the user is logging off or ``False`` if the
5824 system is shutting down. This method can only be called for end
5825 session and query end session events, it doesn't make sense for close
5826 window event.
5ba5649b 5827 """
54f9ee45 5828 return _core_.CloseEvent_GetLoggingOff(*args, **kwargs)
e811c8ce
RD
5829
5830 def Veto(*args, **kwargs):
5ba5649b
RD
5831 """
5832 Veto(self, bool veto=True)
5833
5834 Call this from your event handler to veto a system shutdown or to
5835 signal to the calling application that a window close did not happen.
5836
5837 You can only veto a shutdown or close if `CanVeto` returns true.
5838 """
54f9ee45 5839 return _core_.CloseEvent_Veto(*args, **kwargs)
e811c8ce 5840
5ba5649b
RD
5841 def GetVeto(*args, **kwargs):
5842 """GetVeto(self) -> bool"""
5843 return _core_.CloseEvent_GetVeto(*args, **kwargs)
5844
e811c8ce 5845 def SetCanVeto(*args, **kwargs):
5ba5649b
RD
5846 """
5847 SetCanVeto(self, bool canVeto)
5848
5849 Sets the 'can veto' flag.
5850 """
54f9ee45 5851 return _core_.CloseEvent_SetCanVeto(*args, **kwargs)
e811c8ce
RD
5852
5853 def CanVeto(*args, **kwargs):
5ba5649b
RD
5854 """
5855 CanVeto(self) -> bool
e811c8ce 5856
5ba5649b
RD
5857 Returns true if you can veto a system shutdown or a window close
5858 event. Vetoing a window close event is not possible if the calling
5859 code wishes to force the application to exit, and so this function
5860 must be called to check this.
5861 """
5862 return _core_.CloseEvent_CanVeto(*args, **kwargs)
e811c8ce 5863
2bf58437 5864 LoggingOff = property(GetLoggingOff,SetLoggingOff,doc="See `GetLoggingOff` and `SetLoggingOff`")
2131d850 5865_core_.CloseEvent_swigregister(CloseEvent)
d14a1e28
RD
5866
5867#---------------------------------------------------------------------------
5868
5869class ShowEvent(Event):
5ba5649b 5870 """An EVT_SHOW event is sent when a window is shown or hidden."""
0085ce49
RD
5871 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5872 __repr__ = _swig_repr
5873 def __init__(self, *args, **kwargs):
5ba5649b
RD
5874 """
5875 __init__(self, int winid=0, bool show=False) -> ShowEvent
5876
5877 An EVT_SHOW event is sent when a window is shown or hidden.
5878 """
0085ce49 5879 _core_.ShowEvent_swiginit(self,_core_.new_ShowEvent(*args, **kwargs))
e811c8ce 5880 def SetShow(*args, **kwargs):
a95a7133 5881 """SetShow(self, bool show)"""
54f9ee45 5882 return _core_.ShowEvent_SetShow(*args, **kwargs)
e811c8ce
RD
5883
5884 def GetShow(*args, **kwargs):
a95a7133 5885 """GetShow(self) -> bool"""
54f9ee45 5886 return _core_.ShowEvent_GetShow(*args, **kwargs)
e811c8ce 5887
33d6fd3b 5888 Show = property(GetShow,SetShow,doc="See `GetShow` and `SetShow`")
2131d850 5889_core_.ShowEvent_swigregister(ShowEvent)
d14a1e28
RD
5890
5891#---------------------------------------------------------------------------
5892
5893class IconizeEvent(Event):
5ba5649b
RD
5894 """
5895 An EVT_ICONIZE event is sent when a frame is iconized (minimized) or
5896 restored.
5897 """
0085ce49
RD
5898 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5899 __repr__ = _swig_repr
5900 def __init__(self, *args, **kwargs):
5ba5649b
RD
5901 """
5902 __init__(self, int id=0, bool iconized=True) -> IconizeEvent
5903
5904 An EVT_ICONIZE event is sent when a frame is iconized (minimized) or
5905 restored.
5906 """
0085ce49 5907 _core_.IconizeEvent_swiginit(self,_core_.new_IconizeEvent(*args, **kwargs))
e811c8ce 5908 def Iconized(*args, **kwargs):
5ba5649b
RD
5909 """
5910 Iconized(self) -> bool
5911
5912 Returns ``True`` if the frame has been iconized, ``False`` if it has
5913 been restored.
5914 """
54f9ee45 5915 return _core_.IconizeEvent_Iconized(*args, **kwargs)
e811c8ce 5916
2131d850 5917_core_.IconizeEvent_swigregister(IconizeEvent)
d14a1e28
RD
5918
5919#---------------------------------------------------------------------------
5920
5921class MaximizeEvent(Event):
5ba5649b 5922 """An EVT_MAXIMIZE event is sent when a frame is maximized or restored."""
0085ce49
RD
5923 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5924 __repr__ = _swig_repr
5925 def __init__(self, *args, **kwargs):
5ba5649b
RD
5926 """
5927 __init__(self, int id=0) -> MaximizeEvent
5928
5929 An EVT_MAXIMIZE event is sent when a frame is maximized or restored.
5930 """
0085ce49 5931 _core_.MaximizeEvent_swiginit(self,_core_.new_MaximizeEvent(*args, **kwargs))
2131d850 5932_core_.MaximizeEvent_swigregister(MaximizeEvent)
d14a1e28
RD
5933
5934#---------------------------------------------------------------------------
5935
5936class DropFilesEvent(Event):
5ba5649b
RD
5937 """
5938 This class is used for drop files events, that is, when files have
5939 been dropped onto the window. This functionality is only available
5940 under Windows. The window must have previously been enabled for
5941 dropping by calling `wx.Window.DragAcceptFiles`.
5942
5943 Important note: this is a separate implementation to the more general
5944 drag and drop implementation using `wx.FileDropTarget`, and etc. This
5945 implementation uses the older, Windows message-based approach of
5946 dropping files.
5947
5948 Use wx.EVT_DROP_FILES to bind an event handler to receive file drop
5949 events.
5950
5951 """
0085ce49
RD
5952 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5953 def __init__(self): raise AttributeError, "No constructor defined"
5954 __repr__ = _swig_repr
e811c8ce 5955 def GetPosition(*args, **kwargs):
5ba5649b
RD
5956 """
5957 GetPosition(self) -> Point
5958
5959 Returns the position at which the files were dropped.
5960 """
54f9ee45 5961 return _core_.DropFilesEvent_GetPosition(*args, **kwargs)
e811c8ce
RD
5962
5963 def GetNumberOfFiles(*args, **kwargs):
5ba5649b
RD
5964 """
5965 GetNumberOfFiles(self) -> int
5966
5967 Returns the number of files dropped.
5968 """
54f9ee45 5969 return _core_.DropFilesEvent_GetNumberOfFiles(*args, **kwargs)
e811c8ce
RD
5970
5971 def GetFiles(*args, **kwargs):
5ba5649b
RD
5972 """
5973 GetFiles(self) -> PyObject
5974
5975 Returns a list of the filenames that were dropped.
5976 """
54f9ee45 5977 return _core_.DropFilesEvent_GetFiles(*args, **kwargs)
e811c8ce 5978
2bf58437
RD
5979 Files = property(GetFiles,doc="See `GetFiles`")
5980 NumberOfFiles = property(GetNumberOfFiles,doc="See `GetNumberOfFiles`")
5981 Position = property(GetPosition,doc="See `GetPosition`")
2131d850 5982_core_.DropFilesEvent_swigregister(DropFilesEvent)
d14a1e28
RD
5983
5984#---------------------------------------------------------------------------
5985
54f9ee45
RD
5986UPDATE_UI_PROCESS_ALL = _core_.UPDATE_UI_PROCESS_ALL
5987UPDATE_UI_PROCESS_SPECIFIED = _core_.UPDATE_UI_PROCESS_SPECIFIED
d14a1e28 5988class UpdateUIEvent(CommandEvent):
5ba5649b
RD
5989 """
5990 This class is used for EVT_UPDATE_UI pseudo-events which are sent by
5991 wxWidgets to give an application the chance to update various user
5992 interface elements.
5993
5994 Without update UI events, an application has to work hard to
5995 check/uncheck, enable/disable, and set the text for elements such as
5996 menu items and toolbar buttons. The code for doing this has to be
5997 mixed up with the code that is invoked when an action is invoked for a
5998 menu item or button.
5999
6000 With update UI events, you define an event handler to look at the
6001 state of the application and change UI elements accordingly. wxWidgets
6002 will call your handler functions in idle time, so you don't have to
6003 worry where to call this code. In addition to being a clearer and more
6004 declarative method, it also means you don't have to worry whether
6005 you're updating a toolbar or menubar identifier. The same handler can
6006 update a menu item and toolbar button, if the ID values are the same.
6007
6008 Instead of directly manipulating the menu or button, you call
6009 functions in the event object, such as `Check`. wxWidgets will
6010 determine whether such a call has been made, and which UI element to
6011 update.
6012
6013 These events will work for popup menus as well as menubars. Just
6014 before a menu is popped up, `wx.Menu.UpdateUI` is called to process
6015 any UI events for the window that owns the menu.
6016
6017 If you find that the overhead of UI update processing is affecting
6018 your application, you can do one or both of the following:
6019
6020 1. Call `wx.UpdateUIEvent.SetMode` with a value of
6021 wx.UPDATE_UI_PROCESS_SPECIFIED, and set the extra style
6022 wx.WS_EX_PROCESS_UPDATE_EVENTS for every window that should
6023 receive update events. No other windows will receive update
6024 events.
6025
6026 2. Call `wx.UpdateUIEvent.SetUpdateInterval` with a millisecond
6027 value to set the delay between updates. You may need to call
6028 `wx.Window.UpdateWindowUI` at critical points, for example when
6029 a dialog is about to be shown, in case the user sees a slight
6030 delay before windows are updated.
6031
6032 Note that although events are sent in idle time, defining a EVT_IDLE
6033 handler for a window does not affect this because the events are sent
6034 from an internal idle handler.
6035
6036 wxWidgets tries to optimize update events on some platforms. On
6037 Windows and GTK+, events for menubar items are only sent when the menu
6038 is about to be shown, and not in idle time.
6039
6040 """
0085ce49
RD
6041 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6042 __repr__ = _swig_repr
6043 def __init__(self, *args, **kwargs):
5ba5649b
RD
6044 """
6045 __init__(self, int commandId=0) -> UpdateUIEvent
6046
6047 Constructor
6048 """
0085ce49 6049 _core_.UpdateUIEvent_swiginit(self,_core_.new_UpdateUIEvent(*args, **kwargs))
e811c8ce 6050 def GetChecked(*args, **kwargs):
5ba5649b
RD
6051 """
6052 GetChecked(self) -> bool
6053
6054 Returns ``True`` if the UI element should be checked.
6055 """
54f9ee45 6056 return _core_.UpdateUIEvent_GetChecked(*args, **kwargs)
e811c8ce
RD
6057
6058 def GetEnabled(*args, **kwargs):
5ba5649b
RD
6059 """
6060 GetEnabled(self) -> bool
6061
6062 Returns ``True`` if the UI element should be enabled.
6063 """
54f9ee45 6064 return _core_.UpdateUIEvent_GetEnabled(*args, **kwargs)
e811c8ce 6065
b1fcee84
RD
6066 def GetShown(*args, **kwargs):
6067 """
6068 GetShown(self) -> bool
6069
6070 Returns ``True`` if the UI element should be shown.
6071 """
6072 return _core_.UpdateUIEvent_GetShown(*args, **kwargs)
6073
e811c8ce 6074 def GetText(*args, **kwargs):
5ba5649b
RD
6075 """
6076 GetText(self) -> String
6077
6078 Returns the text that should be set for the UI element.
6079 """
54f9ee45 6080 return _core_.UpdateUIEvent_GetText(*args, **kwargs)
e811c8ce
RD
6081
6082 def GetSetText(*args, **kwargs):
5ba5649b
RD
6083 """
6084 GetSetText(self) -> bool
6085
6086 Returns ``True`` if the application has called `SetText`. For
6087 wxWidgets internal use only.
6088 """
54f9ee45 6089 return _core_.UpdateUIEvent_GetSetText(*args, **kwargs)
e811c8ce
RD
6090
6091 def GetSetChecked(*args, **kwargs):
5ba5649b
RD
6092 """
6093 GetSetChecked(self) -> bool
6094
6095 Returns ``True`` if the application has called `Check`. For wxWidgets
6096 internal use only.
6097 """
54f9ee45 6098 return _core_.UpdateUIEvent_GetSetChecked(*args, **kwargs)
e811c8ce
RD
6099
6100 def GetSetEnabled(*args, **kwargs):
5ba5649b
RD
6101 """
6102 GetSetEnabled(self) -> bool
6103
6104 Returns ``True`` if the application has called `Enable`. For wxWidgets
6105 internal use only.
6106 """
54f9ee45 6107 return _core_.UpdateUIEvent_GetSetEnabled(*args, **kwargs)
e811c8ce 6108
b1fcee84
RD
6109 def GetSetShown(*args, **kwargs):
6110 """
6111 GetSetShown(self) -> bool
6112
6113 Returns ``True`` if the application has called `Show`. For wxWidgets
6114 internal use only.
6115 """
6116 return _core_.UpdateUIEvent_GetSetShown(*args, **kwargs)
6117
e811c8ce 6118 def Check(*args, **kwargs):
5ba5649b
RD
6119 """
6120 Check(self, bool check)
6121
6122 Check or uncheck the UI element.
6123 """
54f9ee45 6124 return _core_.UpdateUIEvent_Check(*args, **kwargs)
e811c8ce
RD
6125
6126 def Enable(*args, **kwargs):
5ba5649b
RD
6127 """
6128 Enable(self, bool enable)
6129
6130 Enable or disable the UI element.
6131 """
54f9ee45 6132 return _core_.UpdateUIEvent_Enable(*args, **kwargs)
e811c8ce 6133
b1fcee84
RD
6134 def Show(*args, **kwargs):
6135 """
6136 Show(self, bool show)
6137
6138 Show or hide the UI element.
6139 """
6140 return _core_.UpdateUIEvent_Show(*args, **kwargs)
6141
e811c8ce 6142 def SetText(*args, **kwargs):
5ba5649b
RD
6143 """
6144 SetText(self, String text)
6145
6146 Sets the text for this UI element.
6147 """
54f9ee45 6148 return _core_.UpdateUIEvent_SetText(*args, **kwargs)
e811c8ce
RD
6149
6150 def SetUpdateInterval(*args, **kwargs):
5ba5649b
RD
6151 """
6152 SetUpdateInterval(long updateInterval)
6153
6154 Sets the interval between updates in milliseconds. Set to -1 to
6155 disable updates, or to 0 to update as frequently as possible. The
6156 default is 0.
6157
6158 Use this to reduce the overhead of UI update events if your
6159 application has a lot of windows. If you set the value to -1 or
6160 greater than 0, you may also need to call `wx.Window.UpdateWindowUI`
6161 at appropriate points in your application, such as when a dialog is
6162 about to be shown.
6163 """
54f9ee45 6164 return _core_.UpdateUIEvent_SetUpdateInterval(*args, **kwargs)
e811c8ce
RD
6165
6166 SetUpdateInterval = staticmethod(SetUpdateInterval)
6167 def GetUpdateInterval(*args, **kwargs):
5ba5649b
RD
6168 """
6169 GetUpdateInterval() -> long
6170
6171 Returns the current interval between updates in milliseconds. -1
6172 disables updates, 0 updates as frequently as possible.
6173 """
54f9ee45 6174 return _core_.UpdateUIEvent_GetUpdateInterval(*args, **kwargs)
e811c8ce
RD
6175
6176 GetUpdateInterval = staticmethod(GetUpdateInterval)
6177 def CanUpdate(*args, **kwargs):
5ba5649b
RD
6178 """
6179 CanUpdate(Window win) -> bool
6180
6181 Returns ``True`` if it is appropriate to update (send UI update events
6182 to) this window.
6183
6184 This function looks at the mode used (see `wx.UpdateUIEvent.SetMode`),
6185 the wx.WS_EX_PROCESS_UPDATE_EVENTS flag in window, the time update
6186 events were last sent in idle time, and the update interval, to
6187 determine whether events should be sent to this window now. By default
6188 this will always return true because the update mode is initially
6189 wx.UPDATE_UI_PROCESS_ALL and the interval is set to 0; so update
6190 events will be sent as often as possible. You can reduce the frequency
6191 that events are sent by changing the mode and/or setting an update
6192 interval.
6193
6194 """
54f9ee45 6195 return _core_.UpdateUIEvent_CanUpdate(*args, **kwargs)
e811c8ce
RD
6196
6197 CanUpdate = staticmethod(CanUpdate)
6198 def ResetUpdateTime(*args, **kwargs):
5ba5649b
RD
6199 """
6200 ResetUpdateTime()
6201
6202 Used internally to reset the last-updated time to the current time. It
6203 is assumed that update events are normally sent in idle time, so this
6204 is called at the end of idle processing.
6205 """
54f9ee45 6206 return _core_.UpdateUIEvent_ResetUpdateTime(*args, **kwargs)
e811c8ce
RD
6207
6208 ResetUpdateTime = staticmethod(ResetUpdateTime)
6209 def SetMode(*args, **kwargs):
5ba5649b
RD
6210 """
6211 SetMode(int mode)
6212
6213 Specify how wxWidgets will send update events: to all windows, or only
6214 to those which specify that they will process the events.
6215
6216 The mode may be one of the following values:
6217
6218 ============================= ==========================================
6219 wxUPDATE_UI_PROCESS_ALL Send UI update events to all windows. This
6220 is the default setting.
6221 wxUPDATE_UI_PROCESS_SPECIFIED Send UI update events only to windows that
6222 have the wx.WS_EX_PROCESS_UI_UPDATES extra
6223 style set.
6224 ============================= ==========================================
6225
6226 """
54f9ee45 6227 return _core_.UpdateUIEvent_SetMode(*args, **kwargs)
e811c8ce
RD
6228
6229 SetMode = staticmethod(SetMode)
6230 def GetMode(*args, **kwargs):
5ba5649b
RD
6231 """
6232 GetMode() -> int
6233
6234 Returns a value specifying how wxWidgets will send update events: to
6235 all windows, or only to those which specify that they will process the
6236 events.
6237 """
54f9ee45 6238 return _core_.UpdateUIEvent_GetMode(*args, **kwargs)
e811c8ce
RD
6239
6240 GetMode = staticmethod(GetMode)
dba7934c
RD
6241 Checked = property(GetChecked,Check,doc="See `GetChecked`")
6242 Enabled = property(GetEnabled,Enable,doc="See `GetEnabled`")
6243 Shown = property(GetShown,Show,doc="See `GetShown`")
6244 Text = property(GetText,SetText,doc="See `GetText` and `SetText`")
2131d850 6245_core_.UpdateUIEvent_swigregister(UpdateUIEvent)
d14a1e28 6246
e811c8ce 6247def UpdateUIEvent_SetUpdateInterval(*args, **kwargs):
0085ce49 6248 """
5ba5649b
RD
6249 UpdateUIEvent_SetUpdateInterval(long updateInterval)
6250
6251 Sets the interval between updates in milliseconds. Set to -1 to
6252 disable updates, or to 0 to update as frequently as possible. The
6253 default is 0.
6254
6255 Use this to reduce the overhead of UI update events if your
6256 application has a lot of windows. If you set the value to -1 or
6257 greater than 0, you may also need to call `wx.Window.UpdateWindowUI`
6258 at appropriate points in your application, such as when a dialog is
6259 about to be shown.
6260 """
0085ce49 6261 return _core_.UpdateUIEvent_SetUpdateInterval(*args, **kwargs)
d14a1e28 6262
0085ce49
RD
6263def UpdateUIEvent_GetUpdateInterval(*args):
6264 """
5ba5649b
RD
6265 UpdateUIEvent_GetUpdateInterval() -> long
6266
6267 Returns the current interval between updates in milliseconds. -1
6268 disables updates, 0 updates as frequently as possible.
6269 """
0085ce49 6270 return _core_.UpdateUIEvent_GetUpdateInterval(*args)
d14a1e28 6271
e811c8ce 6272def UpdateUIEvent_CanUpdate(*args, **kwargs):
0085ce49 6273 """
5ba5649b
RD
6274 UpdateUIEvent_CanUpdate(Window win) -> bool
6275
6276 Returns ``True`` if it is appropriate to update (send UI update events
6277 to) this window.
6278
6279 This function looks at the mode used (see `wx.UpdateUIEvent.SetMode`),
6280 the wx.WS_EX_PROCESS_UPDATE_EVENTS flag in window, the time update
6281 events were last sent in idle time, and the update interval, to
6282 determine whether events should be sent to this window now. By default
6283 this will always return true because the update mode is initially
6284 wx.UPDATE_UI_PROCESS_ALL and the interval is set to 0; so update
6285 events will be sent as often as possible. You can reduce the frequency
6286 that events are sent by changing the mode and/or setting an update
6287 interval.
6288
6289 """
0085ce49 6290 return _core_.UpdateUIEvent_CanUpdate(*args, **kwargs)
d14a1e28 6291
0085ce49
RD
6292def UpdateUIEvent_ResetUpdateTime(*args):
6293 """
5ba5649b
RD
6294 UpdateUIEvent_ResetUpdateTime()
6295
6296 Used internally to reset the last-updated time to the current time. It
6297 is assumed that update events are normally sent in idle time, so this
6298 is called at the end of idle processing.
6299 """
0085ce49 6300 return _core_.UpdateUIEvent_ResetUpdateTime(*args)
d14a1e28 6301
e811c8ce 6302def UpdateUIEvent_SetMode(*args, **kwargs):
0085ce49 6303 """
5ba5649b
RD
6304 UpdateUIEvent_SetMode(int mode)
6305
6306 Specify how wxWidgets will send update events: to all windows, or only
6307 to those which specify that they will process the events.
6308
6309 The mode may be one of the following values:
6310
6311 ============================= ==========================================
6312 wxUPDATE_UI_PROCESS_ALL Send UI update events to all windows. This
6313 is the default setting.
6314 wxUPDATE_UI_PROCESS_SPECIFIED Send UI update events only to windows that
6315 have the wx.WS_EX_PROCESS_UI_UPDATES extra
6316 style set.
6317 ============================= ==========================================
6318
6319 """
0085ce49 6320 return _core_.UpdateUIEvent_SetMode(*args, **kwargs)
d14a1e28 6321
0085ce49
RD
6322def UpdateUIEvent_GetMode(*args):
6323 """
5ba5649b
RD
6324 UpdateUIEvent_GetMode() -> int
6325
6326 Returns a value specifying how wxWidgets will send update events: to
6327 all windows, or only to those which specify that they will process the
6328 events.
6329 """
0085ce49 6330 return _core_.UpdateUIEvent_GetMode(*args)
d14a1e28
RD
6331
6332#---------------------------------------------------------------------------
6333
6334class SysColourChangedEvent(Event):
5ba5649b
RD
6335 """
6336 This class is used for EVT_SYS_COLOUR_CHANGED, which are generated
6337 when the user changes the colour settings using the control
6338 panel. This is only applicable under Windows.
6339
6340 The default event handler for this event propagates the event to child
6341 windows, since Windows only sends the events to top-level windows. If
6342 intercepting this event for a top-level window, remember to call
6343 `Skip` so the the base class handler will still be executed, or to
6344 pass the event on to the window's children explicitly.
6345
6346 """
0085ce49
RD
6347 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6348 __repr__ = _swig_repr
6349 def __init__(self, *args, **kwargs):
5ba5649b
RD
6350 """
6351 __init__(self) -> SysColourChangedEvent
6352
6353 Constructor
6354 """
0085ce49 6355 _core_.SysColourChangedEvent_swiginit(self,_core_.new_SysColourChangedEvent(*args, **kwargs))
2131d850 6356_core_.SysColourChangedEvent_swigregister(SysColourChangedEvent)
d14a1e28
RD
6357
6358#---------------------------------------------------------------------------
6359
6360class MouseCaptureChangedEvent(Event):
5ba5649b
RD
6361 """
6362 An mouse capture changed event (EVT_MOUSE_CAPTURE_CHANGED) is sent to
6363 a window that loses its mouse capture. This is called even if
6364 `wx.Window.ReleaseMouse` was called by the application code. Handling
6365 this event allows an application to cater for unexpected capture
6366 releases which might otherwise confuse mouse handling code.
6367
6368 This event is implemented under Windows only.
6369 """
0085ce49
RD
6370 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6371 __repr__ = _swig_repr
6372 def __init__(self, *args, **kwargs):
5ba5649b
RD
6373 """
6374 __init__(self, int winid=0, Window gainedCapture=None) -> MouseCaptureChangedEvent
6375
6376 Constructor
6377 """
0085ce49 6378 _core_.MouseCaptureChangedEvent_swiginit(self,_core_.new_MouseCaptureChangedEvent(*args, **kwargs))
e811c8ce 6379 def GetCapturedWindow(*args, **kwargs):
5ba5649b
RD
6380 """
6381 GetCapturedWindow(self) -> Window
6382
6383 Returns the window that gained the capture, or ``None`` if it was a
6384 non-wxWidgets window.
6385 """
54f9ee45 6386 return _core_.MouseCaptureChangedEvent_GetCapturedWindow(*args, **kwargs)
e811c8ce 6387
57332a5a 6388 CapturedWindow = property(GetCapturedWindow,doc="See `GetCapturedWindow`")
2131d850 6389_core_.MouseCaptureChangedEvent_swigregister(MouseCaptureChangedEvent)
d14a1e28
RD
6390
6391#---------------------------------------------------------------------------
6392
34e0a3bb
RD
6393class MouseCaptureLostEvent(Event):
6394 """
6395 A mouse capture lost event is sent to a window that obtained mouse
6396 capture, which was subsequently loss due to "external" event, for
6397 example when a dialog box is shown or if another application captures
6398 the mouse.
6399
6400 If this happens, this event is sent to all windows that are on the
6401 capture stack (i.e. a window that called `wx.Window.CaptureMouse`, but
6402 didn't call `wx.Window.ReleaseMouse` yet). The event is *not* sent
6403 if the capture changes because of a call to CaptureMouse or
6404 ReleaseMouse.
6405
6406 This event is currently emitted under Windows only.
6407
6408 """
6409 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6410 __repr__ = _swig_repr
6411 def __init__(self, *args, **kwargs):
6412 """
6413 __init__(self, int winid=0) -> MouseCaptureLostEvent
6414
6415 A mouse capture lost event is sent to a window that obtained mouse
6416 capture, which was subsequently loss due to "external" event, for
6417 example when a dialog box is shown or if another application captures
6418 the mouse.
6419
6420 If this happens, this event is sent to all windows that are on the
6421 capture stack (i.e. a window that called `wx.Window.CaptureMouse`, but
6422 didn't call `wx.Window.ReleaseMouse` yet). The event is *not* sent
6423 if the capture changes because of a call to CaptureMouse or
6424 ReleaseMouse.
6425
6426 This event is currently emitted under Windows only.
6427
6428 """
6429 _core_.MouseCaptureLostEvent_swiginit(self,_core_.new_MouseCaptureLostEvent(*args, **kwargs))
6430_core_.MouseCaptureLostEvent_swigregister(MouseCaptureLostEvent)
6431
6432#---------------------------------------------------------------------------
6433
d14a1e28 6434class DisplayChangedEvent(Event):
5ba5649b
RD
6435 """
6436 An EVT_DISPLAY_CHANGED event is sent to all windows when the display
6437 resolution has changed.
6438
6439 This event is implemented under Windows only.
6440 """
0085ce49
RD
6441 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6442 __repr__ = _swig_repr
6443 def __init__(self, *args, **kwargs):
a95a7133 6444 """__init__(self) -> DisplayChangedEvent"""
0085ce49 6445 _core_.DisplayChangedEvent_swiginit(self,_core_.new_DisplayChangedEvent(*args, **kwargs))
2131d850 6446_core_.DisplayChangedEvent_swigregister(DisplayChangedEvent)
d14a1e28
RD
6447
6448#---------------------------------------------------------------------------
6449
6450class PaletteChangedEvent(Event):
5ba5649b
RD
6451 """
6452 An EVT_PALETTE_CHANGED event is sent when the system palette has
6453 changed, thereby giving each window a chance to redo their own to
6454 match.
6455
6456 This event is implemented under Windows only.
6457 """
0085ce49
RD
6458 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6459 __repr__ = _swig_repr
6460 def __init__(self, *args, **kwargs):
5ba5649b
RD
6461 """
6462 __init__(self, int id=0) -> PaletteChangedEvent
6463
6464 An EVT_PALETTE_CHANGED event is sent when the system palette has
6465 changed, thereby giving each window a chance to redo their own to
6466 match.
6467
6468 This event is implemented under Windows only.
6469 """
0085ce49 6470 _core_.PaletteChangedEvent_swiginit(self,_core_.new_PaletteChangedEvent(*args, **kwargs))
e811c8ce 6471 def SetChangedWindow(*args, **kwargs):
a95a7133 6472 """SetChangedWindow(self, Window win)"""
54f9ee45 6473 return _core_.PaletteChangedEvent_SetChangedWindow(*args, **kwargs)
e811c8ce
RD
6474
6475 def GetChangedWindow(*args, **kwargs):
a95a7133 6476 """GetChangedWindow(self) -> Window"""
54f9ee45 6477 return _core_.PaletteChangedEvent_GetChangedWindow(*args, **kwargs)
e811c8ce 6478
33d6fd3b 6479 ChangedWindow = property(GetChangedWindow,SetChangedWindow,doc="See `GetChangedWindow` and `SetChangedWindow`")
2131d850 6480_core_.PaletteChangedEvent_swigregister(PaletteChangedEvent)
d14a1e28
RD
6481
6482#---------------------------------------------------------------------------
6483
6484class QueryNewPaletteEvent(Event):
5ba5649b
RD
6485 """
6486 An EVT_QUERY_NEW_PALETE event indicates the window is getting keyboard
6487 focus and should re-do its palette.
6488
6489 This event is implemented under Windows only.
6490 """
0085ce49
RD
6491 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6492 __repr__ = _swig_repr
6493 def __init__(self, *args, **kwargs):
5ba5649b
RD
6494 """
6495 __init__(self, int winid=0) -> QueryNewPaletteEvent
6496
6497 Constructor.
6498 """
0085ce49 6499 _core_.QueryNewPaletteEvent_swiginit(self,_core_.new_QueryNewPaletteEvent(*args, **kwargs))
e811c8ce 6500 def SetPaletteRealized(*args, **kwargs):
5ba5649b
RD
6501 """
6502 SetPaletteRealized(self, bool realized)
6503
6504 App should set this if it changes the palette.
6505 """
54f9ee45 6506 return _core_.QueryNewPaletteEvent_SetPaletteRealized(*args, **kwargs)
e811c8ce
RD
6507
6508 def GetPaletteRealized(*args, **kwargs):
a95a7133 6509 """GetPaletteRealized(self) -> bool"""
54f9ee45 6510 return _core_.QueryNewPaletteEvent_GetPaletteRealized(*args, **kwargs)
e811c8ce 6511
33d6fd3b 6512 PaletteRealized = property(GetPaletteRealized,SetPaletteRealized,doc="See `GetPaletteRealized` and `SetPaletteRealized`")
2131d850 6513_core_.QueryNewPaletteEvent_swigregister(QueryNewPaletteEvent)
d14a1e28
RD
6514
6515#---------------------------------------------------------------------------
6516
6517class NavigationKeyEvent(Event):
5ba5649b
RD
6518 """
6519 EVT_NAVIGATION_KEY events are used to control moving the focus between
6520 widgets, otherwise known as tab-traversal. You woudl normally not
6521 catch navigation events in applications as there are already
6522 appropriate handlers in `wx.Dialog` and `wx.Panel`, but you may find
6523 it useful to send navigation events in certain situations to change
6524 the focus in certain ways, although it's probably easier to just call
6525 `wx.Window.Navigate`.
6526 """
0085ce49
RD
6527 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6528 __repr__ = _swig_repr
6529 def __init__(self, *args, **kwargs):
a95a7133 6530 """__init__(self) -> NavigationKeyEvent"""
0085ce49 6531 _core_.NavigationKeyEvent_swiginit(self,_core_.new_NavigationKeyEvent(*args, **kwargs))
e811c8ce 6532 def GetDirection(*args, **kwargs):
5ba5649b
RD
6533 """
6534 GetDirection(self) -> bool
6535
6536 Returns ``True`` if the direction is forward, ``False`` otherwise.
6537 """
54f9ee45 6538 return _core_.NavigationKeyEvent_GetDirection(*args, **kwargs)
e811c8ce
RD
6539
6540 def SetDirection(*args, **kwargs):
5ba5649b
RD
6541 """
6542 SetDirection(self, bool forward)
6543
6544 Specify the direction that the navigation should take. Usually the
6545 difference between using Tab and Shift-Tab.
6546 """
54f9ee45 6547 return _core_.NavigationKeyEvent_SetDirection(*args, **kwargs)
e811c8ce
RD
6548
6549 def IsWindowChange(*args, **kwargs):
5ba5649b
RD
6550 """
6551 IsWindowChange(self) -> bool
6552
6553 Returns ``True`` if window change is allowed.
6554 """
54f9ee45 6555 return _core_.NavigationKeyEvent_IsWindowChange(*args, **kwargs)
e811c8ce
RD
6556
6557 def SetWindowChange(*args, **kwargs):
5ba5649b
RD
6558 """
6559 SetWindowChange(self, bool ischange)
6560
6561 Specify if the navigation should be able to change parent windows.
6562 For example, changing notebook pages, etc. This is usually implemented
6563 by using Control-Tab.
6564 """
54f9ee45 6565 return _core_.NavigationKeyEvent_SetWindowChange(*args, **kwargs)
e811c8ce 6566
68350608 6567 def IsFromTab(*args, **kwargs):
5ba5649b
RD
6568 """
6569 IsFromTab(self) -> bool
6570
6571 Returns ``True`` if the navigation event is originated from the Tab
6572 key.
6573 """
68350608
RD
6574 return _core_.NavigationKeyEvent_IsFromTab(*args, **kwargs)
6575
6576 def SetFromTab(*args, **kwargs):
5ba5649b
RD
6577 """
6578 SetFromTab(self, bool bIs)
6579
6580 Set to true under MSW if the event was generated using the tab key.
6581 This is required for proper navogation over radio buttons.
6582 """
68350608
RD
6583 return _core_.NavigationKeyEvent_SetFromTab(*args, **kwargs)
6584
908b74cd 6585 def SetFlags(*args, **kwargs):
5ba5649b
RD
6586 """
6587 SetFlags(self, long flags)
6588
6589 Set the navigation flags to a combination of the following:
6590
6591 * wx.NavigationKeyEvent.IsBackward
6592 * wx.NavigationKeyEvent.IsForward
6593 * wx.NavigationKeyEvent.WinChange
6594 * wx.NavigationKeyEvent.FromTab
6595
6596 """
908b74cd
RD
6597 return _core_.NavigationKeyEvent_SetFlags(*args, **kwargs)
6598
e811c8ce 6599 def GetCurrentFocus(*args, **kwargs):
5ba5649b
RD
6600 """
6601 GetCurrentFocus(self) -> Window
6602
6603 Returns the child window which currenty has the focus. May be
6604 ``None``.
6605 """
54f9ee45 6606 return _core_.NavigationKeyEvent_GetCurrentFocus(*args, **kwargs)
e811c8ce
RD
6607
6608 def SetCurrentFocus(*args, **kwargs):
5ba5649b
RD
6609 """
6610 SetCurrentFocus(self, Window win)
6611
6612 Set the window that has the focus.
6613 """
54f9ee45 6614 return _core_.NavigationKeyEvent_SetCurrentFocus(*args, **kwargs)
e811c8ce 6615
b0f7404b 6616 IsBackward = _core_.NavigationKeyEvent_IsBackward
908b74cd
RD
6617 IsForward = _core_.NavigationKeyEvent_IsForward
6618 WinChange = _core_.NavigationKeyEvent_WinChange
68350608 6619 FromTab = _core_.NavigationKeyEvent_FromTab
57332a5a
RD
6620 CurrentFocus = property(GetCurrentFocus,SetCurrentFocus,doc="See `GetCurrentFocus` and `SetCurrentFocus`")
6621 Direction = property(GetDirection,SetDirection,doc="See `GetDirection` and `SetDirection`")
2131d850 6622_core_.NavigationKeyEvent_swigregister(NavigationKeyEvent)
d14a1e28
RD
6623
6624#---------------------------------------------------------------------------
6625
6626class WindowCreateEvent(CommandEvent):
5ba5649b
RD
6627 """
6628 The EVT_WINDOW_CREATE event is sent as soon as the window object (the
6629 underlying GUI object) exists.
6630 """
0085ce49
RD
6631 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6632 __repr__ = _swig_repr
6633 def __init__(self, *args, **kwargs):
5ba5649b
RD
6634 """
6635 __init__(self, Window win=None) -> WindowCreateEvent
6636
6637 The EVT_WINDOW_CREATE event is sent as soon as the window object (the
6638 underlying GUI object) exists.
6639 """
0085ce49 6640 _core_.WindowCreateEvent_swiginit(self,_core_.new_WindowCreateEvent(*args, **kwargs))
e811c8ce 6641 def GetWindow(*args, **kwargs):
5ba5649b
RD
6642 """
6643 GetWindow(self) -> Window
6644
6645 Returns the window that this event refers to.
6646 """
54f9ee45 6647 return _core_.WindowCreateEvent_GetWindow(*args, **kwargs)
e811c8ce 6648
dba7934c 6649 Window = property(GetWindow,doc="See `GetWindow`")
2131d850 6650_core_.WindowCreateEvent_swigregister(WindowCreateEvent)
d14a1e28
RD
6651
6652class WindowDestroyEvent(CommandEvent):
5ba5649b 6653 """
943e8dfd
RD
6654 The EVT_WINDOW_DESTROY event is sent from the `wx.Window` destructor
6655 when the GUI window is destroyed.
6656
6657 When a class derived from `wx.Window` is destroyed its destructor will
6658 have already run by the time this event is sent. Therefore this event
6659 will not usually be received at all by the window itself. Since it is
6660 received after the destructor has run, an object should not try to
6661 handle its own wx.WindowDestroyEvent, but it can be used to get
6662 notification of the destruction of another window.
5ba5649b 6663 """
0085ce49
RD
6664 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6665 __repr__ = _swig_repr
6666 def __init__(self, *args, **kwargs):
5ba5649b
RD
6667 """
6668 __init__(self, Window win=None) -> WindowDestroyEvent
6669
943e8dfd
RD
6670 The EVT_WINDOW_DESTROY event is sent from the `wx.Window` destructor
6671 when the GUI window is destroyed.
6672
6673 When a class derived from `wx.Window` is destroyed its destructor will
6674 have already run by the time this event is sent. Therefore this event
6675 will not usually be received at all by the window itself. Since it is
6676 received after the destructor has run, an object should not try to
6677 handle its own wx.WindowDestroyEvent, but it can be used to get
6678 notification of the destruction of another window.
5ba5649b 6679 """
0085ce49 6680 _core_.WindowDestroyEvent_swiginit(self,_core_.new_WindowDestroyEvent(*args, **kwargs))
e811c8ce 6681 def GetWindow(*args, **kwargs):
5ba5649b
RD
6682 """
6683 GetWindow(self) -> Window
6684
6685 Returns the window that this event refers to.
6686 """
54f9ee45 6687 return _core_.WindowDestroyEvent_GetWindow(*args, **kwargs)
e811c8ce 6688
dba7934c 6689 Window = property(GetWindow,doc="See `GetWindow`")
2131d850 6690_core_.WindowDestroyEvent_swigregister(WindowDestroyEvent)
d14a1e28
RD
6691
6692#---------------------------------------------------------------------------
6693
6694class ContextMenuEvent(CommandEvent):
5ba5649b
RD
6695 """
6696 This class is used for context menu events (EVT_CONTECT_MENU,) sent to
6697 give the application a chance to show a context (popup) menu.
6698 """
0085ce49
RD
6699 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6700 __repr__ = _swig_repr
6701 def __init__(self, *args, **kwargs):
5ba5649b 6702 """
2131d850 6703 __init__(self, EventType type=wxEVT_NULL, int winid=0, Point pt=DefaultPosition) -> ContextMenuEvent
5ba5649b
RD
6704
6705 Constructor.
6706 """
0085ce49 6707 _core_.ContextMenuEvent_swiginit(self,_core_.new_ContextMenuEvent(*args, **kwargs))
e811c8ce 6708 def GetPosition(*args, **kwargs):
5ba5649b
RD
6709 """
6710 GetPosition(self) -> Point
6711
6712 Returns the position (in screen coordinants) at which the menu should
6713 be shown.
6714 """
54f9ee45 6715 return _core_.ContextMenuEvent_GetPosition(*args, **kwargs)
e811c8ce
RD
6716
6717 def SetPosition(*args, **kwargs):
5ba5649b
RD
6718 """
6719 SetPosition(self, Point pos)
6720
6721 Sets the position at which the menu should be shown.
6722 """
54f9ee45 6723 return _core_.ContextMenuEvent_SetPosition(*args, **kwargs)
e811c8ce 6724
2bf58437 6725 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
2131d850 6726_core_.ContextMenuEvent_swigregister(ContextMenuEvent)
d14a1e28
RD
6727
6728#---------------------------------------------------------------------------
6729
54f9ee45
RD
6730IDLE_PROCESS_ALL = _core_.IDLE_PROCESS_ALL
6731IDLE_PROCESS_SPECIFIED = _core_.IDLE_PROCESS_SPECIFIED
d14a1e28 6732class IdleEvent(Event):
5ba5649b
RD
6733 """
6734 This class is used for EVT_IDLE events, which are generated and sent
6735 when the application *becomes* idle. In other words, the when the
6736 event queue becomes empty then idle events are sent to all windows (by
6737 default) and as long as none of them call `RequestMore` then there are
6738 no more idle events until after the system event queue has some normal
6739 events and then becomes empty again.
6740
6741 By default, idle events are sent to all windows. If this is causing a
6742 significant overhead in your application, you can call
6743 `wx.IdleEvent.SetMode` with the value wx.IDLE_PROCESS_SPECIFIED, and
6744 set the wx.WS_EX_PROCESS_IDLE extra window style for every window
6745 which should receive idle events. Then idle events will only be sent
6746 to those windows and not to any others.
6747 """
0085ce49
RD
6748 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6749 __repr__ = _swig_repr
6750 def __init__(self, *args, **kwargs):
5ba5649b
RD
6751 """
6752 __init__(self) -> IdleEvent
6753
6754 Constructor
6755 """
0085ce49 6756 _core_.IdleEvent_swiginit(self,_core_.new_IdleEvent(*args, **kwargs))
e811c8ce 6757 def RequestMore(*args, **kwargs):
5ba5649b
RD
6758 """
6759 RequestMore(self, bool needMore=True)
6760
6761 Tells wxWidgets that more processing is required. This function can be
6762 called by an EVT_IDLE handler for a window to indicate that the
6763 application should forward the EVT_IDLE event once more to the
6764 application windows. If no window calls this function during its
6765 EVT_IDLE handler, then the application will remain in a passive event
6766 loop until a new event is posted to the application by the windowing
6767 system.
6768 """
54f9ee45 6769 return _core_.IdleEvent_RequestMore(*args, **kwargs)
e811c8ce
RD
6770
6771 def MoreRequested(*args, **kwargs):
5ba5649b
RD
6772 """
6773 MoreRequested(self) -> bool
6774
6775 Returns ``True`` if the OnIdle function processing this event
6776 requested more processing time.
6777 """
54f9ee45 6778 return _core_.IdleEvent_MoreRequested(*args, **kwargs)
e811c8ce
RD
6779
6780 def SetMode(*args, **kwargs):
5ba5649b
RD
6781 """
6782 SetMode(int mode)
6783
6784 Static method for specifying how wxWidgets will send idle events: to
6785 all windows, or only to those which specify that they will process the
6786 events.
6787
6788 The mode can be one of the following values:
6789
6790 ========================= ========================================
6791 wx.IDLE_PROCESS_ALL Send idle events to all windows
6792 wx.IDLE_PROCESS_SPECIFIED Send idle events only to windows that have
6793 the wx.WS_EX_PROCESS_IDLE extra style
6794 flag set.
6795 ========================= ========================================
6796
6797 """
54f9ee45 6798 return _core_.IdleEvent_SetMode(*args, **kwargs)
e811c8ce
RD
6799
6800 SetMode = staticmethod(SetMode)
6801 def GetMode(*args, **kwargs):
5ba5649b
RD
6802 """
6803 GetMode() -> int
6804
6805 Static method returning a value specifying how wxWidgets will send
6806 idle events: to all windows, or only to those which specify that they
6807 will process the events.
6808 """
54f9ee45 6809 return _core_.IdleEvent_GetMode(*args, **kwargs)
e811c8ce
RD
6810
6811 GetMode = staticmethod(GetMode)
6812 def CanSend(*args, **kwargs):
5ba5649b
RD
6813 """
6814 CanSend(Window win) -> bool
6815
6816 Returns ``True`` if it is appropriate to send idle events to this
6817 window.
6818
6819 This function looks at the mode used (see `wx.IdleEvent.SetMode`), and
6820 the wx.WS_EX_PROCESS_IDLE style in window to determine whether idle
6821 events should be sent to this window now. By default this will always
6822 return ``True`` because the update mode is initially
6823 wx.IDLE_PROCESS_ALL. You can change the mode to only send idle events
6824 to windows with the wx.WS_EX_PROCESS_IDLE extra window style set.
6825 """
54f9ee45 6826 return _core_.IdleEvent_CanSend(*args, **kwargs)
e811c8ce
RD
6827
6828 CanSend = staticmethod(CanSend)
2131d850 6829_core_.IdleEvent_swigregister(IdleEvent)
d14a1e28 6830
e811c8ce 6831def IdleEvent_SetMode(*args, **kwargs):
0085ce49 6832 """
5ba5649b
RD
6833 IdleEvent_SetMode(int mode)
6834
6835 Static method for specifying how wxWidgets will send idle events: to
6836 all windows, or only to those which specify that they will process the
6837 events.
6838
6839 The mode can be one of the following values:
6840
6841 ========================= ========================================
6842 wx.IDLE_PROCESS_ALL Send idle events to all windows
6843 wx.IDLE_PROCESS_SPECIFIED Send idle events only to windows that have
6844 the wx.WS_EX_PROCESS_IDLE extra style
6845 flag set.
6846 ========================= ========================================
6847
6848 """
0085ce49 6849 return _core_.IdleEvent_SetMode(*args, **kwargs)
d14a1e28 6850
0085ce49
RD
6851def IdleEvent_GetMode(*args):
6852 """
5ba5649b
RD
6853 IdleEvent_GetMode() -> int
6854
6855 Static method returning a value specifying how wxWidgets will send
6856 idle events: to all windows, or only to those which specify that they
6857 will process the events.
6858 """
0085ce49 6859 return _core_.IdleEvent_GetMode(*args)
d14a1e28 6860
e811c8ce 6861def IdleEvent_CanSend(*args, **kwargs):
0085ce49 6862 """
5ba5649b
RD
6863 IdleEvent_CanSend(Window win) -> bool
6864
6865 Returns ``True`` if it is appropriate to send idle events to this
6866 window.
6867
6868 This function looks at the mode used (see `wx.IdleEvent.SetMode`), and
6869 the wx.WS_EX_PROCESS_IDLE style in window to determine whether idle
6870 events should be sent to this window now. By default this will always
6871 return ``True`` because the update mode is initially
6872 wx.IDLE_PROCESS_ALL. You can change the mode to only send idle events
6873 to windows with the wx.WS_EX_PROCESS_IDLE extra window style set.
6874 """
0085ce49 6875 return _core_.IdleEvent_CanSend(*args, **kwargs)
d14a1e28
RD
6876
6877#---------------------------------------------------------------------------
6878
2131d850
RD
6879class ClipboardTextEvent(CommandEvent):
6880 """
6881 A Clipboard Text event is sent when a window intercepts a text
6882 copy/cut/paste message, i.e. the user has cut/copied/pasted data
6883 from/into a text control via ctrl-C/X/V, ctrl/shift-del/insert, a
6884 popup menu command, etc. NOTE : under windows these events are *NOT*
6885 generated automatically for a Rich Edit text control.
6886 """
6887 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6888 __repr__ = _swig_repr
6889 def __init__(self, *args, **kwargs):
6890 """
6891 __init__(self, EventType type=wxEVT_NULL, int winid=0) -> ClipboardTextEvent
6892
6893 A Clipboard Text event is sent when a window intercepts a text
6894 copy/cut/paste message, i.e. the user has cut/copied/pasted data
6895 from/into a text control via ctrl-C/X/V, ctrl/shift-del/insert, a
6896 popup menu command, etc. NOTE : under windows these events are *NOT*
6897 generated automatically for a Rich Edit text control.
6898 """
6899 _core_.ClipboardTextEvent_swiginit(self,_core_.new_ClipboardTextEvent(*args, **kwargs))
6900_core_.ClipboardTextEvent_swigregister(ClipboardTextEvent)
6901
6902#---------------------------------------------------------------------------
6903
d14a1e28 6904class PyEvent(Event):
5ba5649b
RD
6905 """
6906 wx.PyEvent can be used as a base class for implementing custom event
6907 types in Python. You should derived from this class instead of
6908 `wx.Event` because this class is Python-aware and is able to transport
6909 its Python bits safely through the wxWidgets event system and have
6910 them still be there when the event handler is invoked.
6911
6912 :see: `wx.PyCommandEvent`
6913
6914 """
0085ce49
RD
6915 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6916 __repr__ = _swig_repr
6917 def __init__(self, *args, **kwargs):
2131d850 6918 """__init__(self, int winid=0, EventType eventType=wxEVT_NULL) -> PyEvent"""
0085ce49 6919 _core_.PyEvent_swiginit(self,_core_.new_PyEvent(*args, **kwargs))
5ba5649b 6920 self._SetSelf(self)
e811c8ce 6921
0085ce49
RD
6922 __swig_destroy__ = _core_.delete_PyEvent
6923 __del__ = lambda self : None;
5ba5649b
RD
6924 def _SetSelf(*args, **kwargs):
6925 """_SetSelf(self, PyObject self)"""
6926 return _core_.PyEvent__SetSelf(*args, **kwargs)
e811c8ce 6927
5ba5649b
RD
6928 def _GetSelf(*args, **kwargs):
6929 """_GetSelf(self) -> PyObject"""
6930 return _core_.PyEvent__GetSelf(*args, **kwargs)
e811c8ce 6931
2131d850 6932_core_.PyEvent_swigregister(PyEvent)
d14a1e28
RD
6933
6934class PyCommandEvent(CommandEvent):
5ba5649b
RD
6935 """
6936 wx.PyCommandEvent can be used as a base class for implementing custom
6937 event types in Python, where the event shoudl travel up to parent
6938 windows looking for a handler. You should derived from this class
6939 instead of `wx.CommandEvent` because this class is Python-aware and is
6940 able to transport its Python bits safely through the wxWidgets event
6941 system and have them still be there when the event handler is invoked.
6942
6943 :see: `wx.PyEvent`
6944
6945 """
0085ce49
RD
6946 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6947 __repr__ = _swig_repr
6948 def __init__(self, *args, **kwargs):
2131d850 6949 """__init__(self, EventType eventType=wxEVT_NULL, int id=0) -> PyCommandEvent"""
0085ce49 6950 _core_.PyCommandEvent_swiginit(self,_core_.new_PyCommandEvent(*args, **kwargs))
5ba5649b 6951 self._SetSelf(self)
e811c8ce 6952
0085ce49
RD
6953 __swig_destroy__ = _core_.delete_PyCommandEvent
6954 __del__ = lambda self : None;
5ba5649b
RD
6955 def _SetSelf(*args, **kwargs):
6956 """_SetSelf(self, PyObject self)"""
6957 return _core_.PyCommandEvent__SetSelf(*args, **kwargs)
e811c8ce 6958
5ba5649b
RD
6959 def _GetSelf(*args, **kwargs):
6960 """_GetSelf(self) -> PyObject"""
6961 return _core_.PyCommandEvent__GetSelf(*args, **kwargs)
e811c8ce 6962
2131d850 6963_core_.PyCommandEvent_swigregister(PyCommandEvent)
d14a1e28 6964
53aa7709 6965class DateEvent(CommandEvent):
5ba5649b
RD
6966 """
6967 This event class holds information about a date change event and is
6968 used together with `wx.DatePickerCtrl`. It also serves as a base class
6969 for `wx.calendar.CalendarEvent`. Bind these event types with
6970 EVT_DATE_CHANGED.
6971 """
0085ce49
RD
6972 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6973 __repr__ = _swig_repr
6974 def __init__(self, *args, **kwargs):
2131d850 6975 """__init__(self, Window win, DateTime dt, EventType type) -> DateEvent"""
0085ce49 6976 _core_.DateEvent_swiginit(self,_core_.new_DateEvent(*args, **kwargs))
53aa7709 6977 def GetDate(*args, **kwargs):
5ba5649b
RD
6978 """
6979 GetDate(self) -> DateTime
6980
6981 Returns the date.
6982 """
53aa7709
RD
6983 return _core_.DateEvent_GetDate(*args, **kwargs)
6984
6985 def SetDate(*args, **kwargs):
5ba5649b
RD
6986 """
6987 SetDate(self, DateTime date)
6988
6989 Sets the date carried by the event, normally only used by the library
6990 internally.
6991 """
53aa7709
RD
6992 return _core_.DateEvent_SetDate(*args, **kwargs)
6993
2bf58437 6994 Date = property(GetDate,SetDate,doc="See `GetDate` and `SetDate`")
2131d850 6995_core_.DateEvent_swigregister(DateEvent)
53aa7709
RD
6996
6997wxEVT_DATE_CHANGED = _core_.wxEVT_DATE_CHANGED
6998EVT_DATE_CHANGED = wx.PyEventBinder( wxEVT_DATE_CHANGED, 1 )
6999
d14a1e28
RD
7000#---------------------------------------------------------------------------
7001
54f9ee45
RD
7002PYAPP_ASSERT_SUPPRESS = _core_.PYAPP_ASSERT_SUPPRESS
7003PYAPP_ASSERT_EXCEPTION = _core_.PYAPP_ASSERT_EXCEPTION
7004PYAPP_ASSERT_DIALOG = _core_.PYAPP_ASSERT_DIALOG
7005PYAPP_ASSERT_LOG = _core_.PYAPP_ASSERT_LOG
7006PRINT_WINDOWS = _core_.PRINT_WINDOWS
7007PRINT_POSTSCRIPT = _core_.PRINT_POSTSCRIPT
d14a1e28 7008class PyApp(EvtHandler):
66c033b4
RD
7009 """
7010 The ``wx.PyApp`` class is an *implementation detail*, please use the
7011 `wx.App` class (or some other derived class) instead.
7012 """
0085ce49
RD
7013 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7014 __repr__ = _swig_repr
7015 def __init__(self, *args, **kwargs):
98e665d3 7016 """
a95a7133 7017 __init__(self) -> PyApp
98e665d3
RD
7018
7019 Create a new application object, starting the bootstrap process.
7020 """
0085ce49 7021 _core_.PyApp_swiginit(self,_core_.new_PyApp(*args, **kwargs))
70b7a5fe
RD
7022 self._setCallbackInfo(self, PyApp, False)
7023 self._setOORInfo(self, False)
e811c8ce 7024
0085ce49
RD
7025 __swig_destroy__ = _core_.delete_PyApp
7026 __del__ = lambda self : None;
e811c8ce 7027 def _setCallbackInfo(*args, **kwargs):
70b7a5fe 7028 """_setCallbackInfo(self, PyObject self, PyObject _class, bool incref)"""
54f9ee45 7029 return _core_.PyApp__setCallbackInfo(*args, **kwargs)
e811c8ce
RD
7030
7031 def GetAppName(*args, **kwargs):
0df68c9f 7032 """
a95a7133 7033 GetAppName(self) -> String
6c3b4aae 7034
0df68c9f
RD
7035 Get the application name.
7036 """
54f9ee45 7037 return _core_.PyApp_GetAppName(*args, **kwargs)
e811c8ce
RD
7038
7039 def SetAppName(*args, **kwargs):
0df68c9f 7040 """
a95a7133 7041 SetAppName(self, String name)
6c3b4aae 7042
66c033b4
RD
7043 Set the application name. This value may be used automatically by
7044 `wx.Config` and such.
0df68c9f 7045 """
54f9ee45 7046 return _core_.PyApp_SetAppName(*args, **kwargs)
e811c8ce
RD
7047
7048 def GetClassName(*args, **kwargs):
0df68c9f 7049 """
a95a7133 7050 GetClassName(self) -> String
e811c8ce 7051
0df68c9f
RD
7052 Get the application's class name.
7053 """
54f9ee45 7054 return _core_.PyApp_GetClassName(*args, **kwargs)
e811c8ce
RD
7055
7056 def SetClassName(*args, **kwargs):
0df68c9f 7057 """
a95a7133 7058 SetClassName(self, String name)
6c3b4aae 7059
66c033b4
RD
7060 Set the application's class name. This value may be used for
7061 X-resources if applicable for the platform
0df68c9f 7062 """
54f9ee45 7063 return _core_.PyApp_SetClassName(*args, **kwargs)
e811c8ce
RD
7064
7065 def GetVendorName(*args, **kwargs):
0df68c9f 7066 """
a95a7133 7067 GetVendorName(self) -> String
6c3b4aae 7068
0df68c9f
RD
7069 Get the application's vendor name.
7070 """
54f9ee45 7071 return _core_.PyApp_GetVendorName(*args, **kwargs)
e811c8ce
RD
7072
7073 def SetVendorName(*args, **kwargs):
0df68c9f 7074 """
a95a7133 7075 SetVendorName(self, String name)
6c3b4aae 7076
66c033b4
RD
7077 Set the application's vendor name. This value may be used
7078 automatically by `wx.Config` and such.
0df68c9f 7079 """
54f9ee45 7080 return _core_.PyApp_SetVendorName(*args, **kwargs)
e811c8ce
RD
7081
7082 def GetTraits(*args, **kwargs):
0df68c9f 7083 """
a95a7133 7084 GetTraits(self) -> wxAppTraits
6c3b4aae 7085
66c033b4
RD
7086 Return (and create if necessary) the app traits object to which we
7087 delegate for everything which either should be configurable by the
7088 user (then he can change the default behaviour simply by overriding
7089 CreateTraits() and returning his own traits object) or which is
7090 GUI/console dependent as then wx.AppTraits allows us to abstract the
7091 differences behind the common facade.
7092
7093 :todo: Add support for overriding CreateAppTraits in wxPython.
0df68c9f 7094 """
54f9ee45 7095 return _core_.PyApp_GetTraits(*args, **kwargs)
e811c8ce
RD
7096
7097 def ProcessPendingEvents(*args, **kwargs):
0df68c9f 7098 """
a95a7133 7099 ProcessPendingEvents(self)
6c3b4aae 7100
66c033b4
RD
7101 Process all events in the Pending Events list -- it is necessary to
7102 call this function to process posted events. This normally happens
7103 during each event loop iteration.
0df68c9f 7104 """
54f9ee45 7105 return _core_.PyApp_ProcessPendingEvents(*args, **kwargs)
e811c8ce
RD
7106
7107 def Yield(*args, **kwargs):
0df68c9f 7108 """
a95a7133 7109 Yield(self, bool onlyIfNeeded=False) -> bool
6c3b4aae 7110
66c033b4
RD
7111 Process all currently pending events right now, instead of waiting
7112 until return to the event loop. It is an error to call ``Yield``
7113 recursively unless the value of ``onlyIfNeeded`` is True.
6c3b4aae 7114
66c033b4 7115 :warning: This function is dangerous as it can lead to unexpected
41e2b43e
RD
7116 reentrancies (i.e. when called from an event handler it may
7117 result in calling the same event handler again), use with
7118 extreme care or, better, don't use at all!
0df68c9f 7119
66c033b4 7120 :see: `wx.Yield`, `wx.YieldIfNeeded`, `wx.SafeYield`
41e2b43e 7121
0df68c9f 7122 """
54f9ee45 7123 return _core_.PyApp_Yield(*args, **kwargs)
e811c8ce
RD
7124
7125 def WakeUpIdle(*args, **kwargs):
0df68c9f 7126 """
a95a7133 7127 WakeUpIdle(self)
6c3b4aae 7128
66c033b4
RD
7129 Make sure that idle events are sent again.
7130 :see: `wx.WakeUpIdle`
0df68c9f 7131 """
54f9ee45 7132 return _core_.PyApp_WakeUpIdle(*args, **kwargs)
e811c8ce 7133
1fc3b23a
RD
7134 def IsMainLoopRunning(*args, **kwargs):
7135 """
7136 IsMainLoopRunning() -> bool
7137
7138 Returns True if we're running the main loop, i.e. if the events can
7139 currently be dispatched.
7140 """
7141 return _core_.PyApp_IsMainLoopRunning(*args, **kwargs)
7142
7143 IsMainLoopRunning = staticmethod(IsMainLoopRunning)
e811c8ce 7144 def MainLoop(*args, **kwargs):
0df68c9f 7145 """
a95a7133 7146 MainLoop(self) -> int
6c3b4aae 7147
66c033b4
RD
7148 Execute the main GUI loop, the function doesn't normally return until
7149 all top level windows have been closed and destroyed.
0df68c9f 7150 """
54f9ee45 7151 return _core_.PyApp_MainLoop(*args, **kwargs)
e811c8ce
RD
7152
7153 def Exit(*args, **kwargs):
0df68c9f 7154 """
a95a7133 7155 Exit(self)
6c3b4aae 7156
0df68c9f 7157 Exit the main loop thus terminating the application.
66c033b4 7158 :see: `wx.Exit`
0df68c9f 7159 """
54f9ee45 7160 return _core_.PyApp_Exit(*args, **kwargs)
e811c8ce 7161
97ab0f6a
RD
7162 def GetLayoutDirection(*args, **kwargs):
7163 """
994453b8 7164 GetLayoutDirection(self) -> int
97ab0f6a
RD
7165
7166 Return the layout direction for the current locale.
7167 """
7168 return _core_.PyApp_GetLayoutDirection(*args, **kwargs)
7169
e811c8ce 7170 def ExitMainLoop(*args, **kwargs):
0df68c9f 7171 """
a95a7133 7172 ExitMainLoop(self)
6c3b4aae 7173
66c033b4
RD
7174 Exit the main GUI loop during the next iteration of the main
7175 loop, (i.e. it does not stop the program immediately!)
0df68c9f 7176 """
54f9ee45 7177 return _core_.PyApp_ExitMainLoop(*args, **kwargs)
e811c8ce
RD
7178
7179 def Pending(*args, **kwargs):
0df68c9f 7180 """
a95a7133 7181 Pending(self) -> bool
6c3b4aae 7182
0df68c9f
RD
7183 Returns True if there are unprocessed events in the event queue.
7184 """
54f9ee45 7185 return _core_.PyApp_Pending(*args, **kwargs)
e811c8ce
RD
7186
7187 def Dispatch(*args, **kwargs):
0df68c9f 7188 """
a95a7133 7189 Dispatch(self) -> bool
6c3b4aae 7190
0df68c9f
RD
7191 Process the first event in the event queue (blocks until an event
7192 appears if there are none currently)
7193 """
54f9ee45 7194 return _core_.PyApp_Dispatch(*args, **kwargs)
e811c8ce
RD
7195
7196 def ProcessIdle(*args, **kwargs):
0df68c9f 7197 """
a95a7133 7198 ProcessIdle(self) -> bool
6c3b4aae 7199
66c033b4
RD
7200 Called from the MainLoop when the application becomes idle (there are
7201 no pending events) and sends a `wx.IdleEvent` to all interested
7202 parties. Returns True if more idle events are needed, False if not.
0df68c9f 7203 """
54f9ee45 7204 return _core_.PyApp_ProcessIdle(*args, **kwargs)
e811c8ce
RD
7205
7206 def SendIdleEvents(*args, **kwargs):
0df68c9f 7207 """
a95a7133 7208 SendIdleEvents(self, Window win, IdleEvent event) -> bool
e811c8ce 7209
66c033b4
RD
7210 Send idle event to window and all subwindows. Returns True if more
7211 idle time is requested.
0df68c9f 7212 """
54f9ee45 7213 return _core_.PyApp_SendIdleEvents(*args, **kwargs)
e811c8ce
RD
7214
7215 def IsActive(*args, **kwargs):
0df68c9f 7216 """
a95a7133 7217 IsActive(self) -> bool
6c3b4aae 7218
0df68c9f
RD
7219 Return True if our app has focus.
7220 """
54f9ee45 7221 return _core_.PyApp_IsActive(*args, **kwargs)
e811c8ce
RD
7222
7223 def SetTopWindow(*args, **kwargs):
0df68c9f 7224 """
a95a7133 7225 SetTopWindow(self, Window win)
6c3b4aae 7226
66c033b4 7227 Set the *main* top level window
0df68c9f 7228 """
54f9ee45 7229 return _core_.PyApp_SetTopWindow(*args, **kwargs)
e811c8ce
RD
7230
7231 def GetTopWindow(*args, **kwargs):
0df68c9f 7232 """
a95a7133 7233 GetTopWindow(self) -> Window
6c3b4aae 7234
66c033b4
RD
7235 Return the *main* top level window (if it hadn't been set previously
7236 with SetTopWindow(), will return just some top level window and, if
7237 there not any, will return None)
0df68c9f 7238 """
54f9ee45 7239 return _core_.PyApp_GetTopWindow(*args, **kwargs)
e811c8ce
RD
7240
7241 def SetExitOnFrameDelete(*args, **kwargs):
0df68c9f 7242 """
a95a7133 7243 SetExitOnFrameDelete(self, bool flag)
0df68c9f 7244
66c033b4
RD
7245 Control the exit behaviour: by default, the program will exit the main
7246 loop (and so, usually, terminate) when the last top-level program
7247 window is deleted. Beware that if you disable this behaviour (with
7248 SetExitOnFrameDelete(False)), you'll have to call ExitMainLoop()
7249 explicitly from somewhere.
0df68c9f 7250 """
54f9ee45 7251 return _core_.PyApp_SetExitOnFrameDelete(*args, **kwargs)
e811c8ce
RD
7252
7253 def GetExitOnFrameDelete(*args, **kwargs):
0df68c9f 7254 """
a95a7133 7255 GetExitOnFrameDelete(self) -> bool
6c3b4aae 7256
0df68c9f
RD
7257 Get the current exit behaviour setting.
7258 """
54f9ee45 7259 return _core_.PyApp_GetExitOnFrameDelete(*args, **kwargs)
e811c8ce
RD
7260
7261 def SetUseBestVisual(*args, **kwargs):
0df68c9f 7262 """
a95a7133 7263 SetUseBestVisual(self, bool flag)
6c3b4aae 7264
66c033b4
RD
7265 Set whether the app should try to use the best available visual on
7266 systems where more than one is available, (Sun, SGI, XFree86 4, etc.)
0df68c9f 7267 """
54f9ee45 7268 return _core_.PyApp_SetUseBestVisual(*args, **kwargs)
e811c8ce
RD
7269
7270 def GetUseBestVisual(*args, **kwargs):
0df68c9f 7271 """
a95a7133 7272 GetUseBestVisual(self) -> bool
6c3b4aae 7273
0df68c9f
RD
7274 Get current UseBestVisual setting.
7275 """
54f9ee45 7276 return _core_.PyApp_GetUseBestVisual(*args, **kwargs)
e811c8ce
RD
7277
7278 def SetPrintMode(*args, **kwargs):
a95a7133 7279 """SetPrintMode(self, int mode)"""
54f9ee45 7280 return _core_.PyApp_SetPrintMode(*args, **kwargs)
e811c8ce
RD
7281
7282 def GetPrintMode(*args, **kwargs):
a95a7133 7283 """GetPrintMode(self) -> int"""
54f9ee45 7284 return _core_.PyApp_GetPrintMode(*args, **kwargs)
e811c8ce 7285
e811c8ce 7286 def SetAssertMode(*args, **kwargs):
0df68c9f 7287 """
a95a7133 7288 SetAssertMode(self, int mode)
6c3b4aae 7289
41e2b43e 7290 Set the OnAssert behaviour for debug and hybrid builds.
0df68c9f 7291 """
54f9ee45 7292 return _core_.PyApp_SetAssertMode(*args, **kwargs)
e811c8ce 7293
6c3b4aae 7294 def GetAssertMode(*args, **kwargs):
0df68c9f 7295 """
a95a7133 7296 GetAssertMode(self) -> int
6c3b4aae 7297
0df68c9f
RD
7298 Get the current OnAssert behaviour setting.
7299 """
54f9ee45 7300 return _core_.PyApp_GetAssertMode(*args, **kwargs)
6c3b4aae 7301
e811c8ce 7302 def GetMacSupportPCMenuShortcuts(*args, **kwargs):
66c033b4 7303 """GetMacSupportPCMenuShortcuts() -> bool"""
54f9ee45 7304 return _core_.PyApp_GetMacSupportPCMenuShortcuts(*args, **kwargs)
e811c8ce
RD
7305
7306 GetMacSupportPCMenuShortcuts = staticmethod(GetMacSupportPCMenuShortcuts)
7307 def GetMacAboutMenuItemId(*args, **kwargs):
66c033b4 7308 """GetMacAboutMenuItemId() -> long"""
54f9ee45 7309 return _core_.PyApp_GetMacAboutMenuItemId(*args, **kwargs)
e811c8ce
RD
7310
7311 GetMacAboutMenuItemId = staticmethod(GetMacAboutMenuItemId)
7312 def GetMacPreferencesMenuItemId(*args, **kwargs):
66c033b4 7313 """GetMacPreferencesMenuItemId() -> long"""
54f9ee45 7314 return _core_.PyApp_GetMacPreferencesMenuItemId(*args, **kwargs)
e811c8ce
RD
7315
7316 GetMacPreferencesMenuItemId = staticmethod(GetMacPreferencesMenuItemId)
7317 def GetMacExitMenuItemId(*args, **kwargs):
66c033b4 7318 """GetMacExitMenuItemId() -> long"""
54f9ee45 7319 return _core_.PyApp_GetMacExitMenuItemId(*args, **kwargs)
e811c8ce
RD
7320
7321 GetMacExitMenuItemId = staticmethod(GetMacExitMenuItemId)
7322 def GetMacHelpMenuTitleName(*args, **kwargs):
66c033b4 7323 """GetMacHelpMenuTitleName() -> String"""
54f9ee45 7324 return _core_.PyApp_GetMacHelpMenuTitleName(*args, **kwargs)
e811c8ce
RD
7325
7326 GetMacHelpMenuTitleName = staticmethod(GetMacHelpMenuTitleName)
7327 def SetMacSupportPCMenuShortcuts(*args, **kwargs):
66c033b4 7328 """SetMacSupportPCMenuShortcuts(bool val)"""
54f9ee45 7329 return _core_.PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs)
e811c8ce
RD
7330
7331 SetMacSupportPCMenuShortcuts = staticmethod(SetMacSupportPCMenuShortcuts)
7332 def SetMacAboutMenuItemId(*args, **kwargs):
66c033b4 7333 """SetMacAboutMenuItemId(long val)"""
54f9ee45 7334 return _core_.PyApp_SetMacAboutMenuItemId(*args, **kwargs)
e811c8ce
RD
7335
7336 SetMacAboutMenuItemId = staticmethod(SetMacAboutMenuItemId)
7337 def SetMacPreferencesMenuItemId(*args, **kwargs):
66c033b4 7338 """SetMacPreferencesMenuItemId(long val)"""
54f9ee45 7339 return _core_.PyApp_SetMacPreferencesMenuItemId(*args, **kwargs)
e811c8ce
RD
7340
7341 SetMacPreferencesMenuItemId = staticmethod(SetMacPreferencesMenuItemId)
7342 def SetMacExitMenuItemId(*args, **kwargs):
66c033b4 7343 """SetMacExitMenuItemId(long val)"""
54f9ee45 7344 return _core_.PyApp_SetMacExitMenuItemId(*args, **kwargs)
e811c8ce
RD
7345
7346 SetMacExitMenuItemId = staticmethod(SetMacExitMenuItemId)
7347 def SetMacHelpMenuTitleName(*args, **kwargs):
66c033b4 7348 """SetMacHelpMenuTitleName(String val)"""
54f9ee45 7349 return _core_.PyApp_SetMacHelpMenuTitleName(*args, **kwargs)
e811c8ce
RD
7350
7351 SetMacHelpMenuTitleName = staticmethod(SetMacHelpMenuTitleName)
7352 def _BootstrapApp(*args, **kwargs):
0df68c9f 7353 """
a95a7133 7354 _BootstrapApp(self)
6c3b4aae 7355
0df68c9f
RD
7356 For internal use only
7357 """
54f9ee45 7358 return _core_.PyApp__BootstrapApp(*args, **kwargs)
e811c8ce
RD
7359
7360 def GetComCtl32Version(*args, **kwargs):
0df68c9f 7361 """
66c033b4 7362 GetComCtl32Version() -> int
6c3b4aae 7363
66c033b4
RD
7364 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
7365 it wasn't found at all. Raises an exception on non-Windows platforms.
0df68c9f 7366 """
54f9ee45 7367 return _core_.PyApp_GetComCtl32Version(*args, **kwargs)
e811c8ce
RD
7368
7369 GetComCtl32Version = staticmethod(GetComCtl32Version)
33d6fd3b 7370 def IsDisplayAvailable(*args, **kwargs):
fc46b7f3 7371 """
33d6fd3b 7372 IsDisplayAvailable() -> bool
fc46b7f3
RD
7373
7374 Tests if it is possible to create a GUI in the current environment.
7375 This will mean different things on the different platforms.
7376
7377 * On X Windows systems this function will return ``False`` if it is
7378 not able to open a connection to the X display, which can happen
7379 if $DISPLAY is not set, or is not set correctly.
7380
7381 * On Mac OS X a ``False`` return value will mean that wx is not
7382 able to access the window manager, which can happen if logged in
7383 remotely or if running from the normal version of python instead
7384 of the framework version, (i.e., pythonw.)
7385
7386 * On MS Windows...
7387
7388 """
33d6fd3b
RD
7389 return _core_.PyApp_IsDisplayAvailable(*args, **kwargs)
7390
7391 IsDisplayAvailable = staticmethod(IsDisplayAvailable)
7392 AppName = property(GetAppName,SetAppName,doc="See `GetAppName` and `SetAppName`")
7393 AssertMode = property(GetAssertMode,SetAssertMode,doc="See `GetAssertMode` and `SetAssertMode`")
7394 ClassName = property(GetClassName,SetClassName,doc="See `GetClassName` and `SetClassName`")
7395 ExitOnFrameDelete = property(GetExitOnFrameDelete,SetExitOnFrameDelete,doc="See `GetExitOnFrameDelete` and `SetExitOnFrameDelete`")
7396 LayoutDirection = property(GetLayoutDirection,doc="See `GetLayoutDirection`")
7397 PrintMode = property(GetPrintMode,SetPrintMode,doc="See `GetPrintMode` and `SetPrintMode`")
7398 TopWindow = property(GetTopWindow,SetTopWindow,doc="See `GetTopWindow` and `SetTopWindow`")
7399 Traits = property(GetTraits,doc="See `GetTraits`")
7400 UseBestVisual = property(GetUseBestVisual,SetUseBestVisual,doc="See `GetUseBestVisual` and `SetUseBestVisual`")
7401 VendorName = property(GetVendorName,SetVendorName,doc="See `GetVendorName` and `SetVendorName`")
7402 Active = property(IsActive)
2131d850 7403_core_.PyApp_swigregister(PyApp)
d14a1e28 7404
0085ce49
RD
7405def PyApp_IsMainLoopRunning(*args):
7406 """
1fc3b23a
RD
7407 PyApp_IsMainLoopRunning() -> bool
7408
7409 Returns True if we're running the main loop, i.e. if the events can
7410 currently be dispatched.
7411 """
0085ce49 7412 return _core_.PyApp_IsMainLoopRunning(*args)
1fc3b23a 7413
0085ce49
RD
7414def PyApp_GetMacSupportPCMenuShortcuts(*args):
7415 """PyApp_GetMacSupportPCMenuShortcuts() -> bool"""
7416 return _core_.PyApp_GetMacSupportPCMenuShortcuts(*args)
d14a1e28 7417
0085ce49
RD
7418def PyApp_GetMacAboutMenuItemId(*args):
7419 """PyApp_GetMacAboutMenuItemId() -> long"""
7420 return _core_.PyApp_GetMacAboutMenuItemId(*args)
d14a1e28 7421
0085ce49
RD
7422def PyApp_GetMacPreferencesMenuItemId(*args):
7423 """PyApp_GetMacPreferencesMenuItemId() -> long"""
7424 return _core_.PyApp_GetMacPreferencesMenuItemId(*args)
d14a1e28 7425
0085ce49
RD
7426def PyApp_GetMacExitMenuItemId(*args):
7427 """PyApp_GetMacExitMenuItemId() -> long"""
7428 return _core_.PyApp_GetMacExitMenuItemId(*args)
d14a1e28 7429
0085ce49
RD
7430def PyApp_GetMacHelpMenuTitleName(*args):
7431 """PyApp_GetMacHelpMenuTitleName() -> String"""
7432 return _core_.PyApp_GetMacHelpMenuTitleName(*args)
d14a1e28 7433
e811c8ce 7434def PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs):
0085ce49
RD
7435 """PyApp_SetMacSupportPCMenuShortcuts(bool val)"""
7436 return _core_.PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs)
d14a1e28 7437
e811c8ce 7438def PyApp_SetMacAboutMenuItemId(*args, **kwargs):
0085ce49
RD
7439 """PyApp_SetMacAboutMenuItemId(long val)"""
7440 return _core_.PyApp_SetMacAboutMenuItemId(*args, **kwargs)
d14a1e28 7441
e811c8ce 7442def PyApp_SetMacPreferencesMenuItemId(*args, **kwargs):
0085ce49
RD
7443 """PyApp_SetMacPreferencesMenuItemId(long val)"""
7444 return _core_.PyApp_SetMacPreferencesMenuItemId(*args, **kwargs)
d14a1e28 7445
e811c8ce 7446def PyApp_SetMacExitMenuItemId(*args, **kwargs):
0085ce49
RD
7447 """PyApp_SetMacExitMenuItemId(long val)"""
7448 return _core_.PyApp_SetMacExitMenuItemId(*args, **kwargs)
d14a1e28 7449
e811c8ce 7450def PyApp_SetMacHelpMenuTitleName(*args, **kwargs):
0085ce49
RD
7451 """PyApp_SetMacHelpMenuTitleName(String val)"""
7452 return _core_.PyApp_SetMacHelpMenuTitleName(*args, **kwargs)
d14a1e28 7453
0085ce49
RD
7454def PyApp_GetComCtl32Version(*args):
7455 """
0df68c9f 7456 PyApp_GetComCtl32Version() -> int
6c3b4aae 7457
66c033b4
RD
7458 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
7459 it wasn't found at all. Raises an exception on non-Windows platforms.
0df68c9f 7460 """
0085ce49 7461 return _core_.PyApp_GetComCtl32Version(*args)
d14a1e28 7462
33d6fd3b 7463def PyApp_IsDisplayAvailable(*args):
fc46b7f3 7464 """
33d6fd3b 7465 PyApp_IsDisplayAvailable() -> bool
fc46b7f3
RD
7466
7467 Tests if it is possible to create a GUI in the current environment.
7468 This will mean different things on the different platforms.
7469
7470 * On X Windows systems this function will return ``False`` if it is
7471 not able to open a connection to the X display, which can happen
7472 if $DISPLAY is not set, or is not set correctly.
7473
7474 * On Mac OS X a ``False`` return value will mean that wx is not
7475 able to access the window manager, which can happen if logged in
7476 remotely or if running from the normal version of python instead
7477 of the framework version, (i.e., pythonw.)
7478
7479 * On MS Windows...
7480
7481 """
33d6fd3b 7482 return _core_.PyApp_IsDisplayAvailable(*args)
fc46b7f3 7483
d14a1e28
RD
7484#---------------------------------------------------------------------------
7485
7486
0085ce49
RD
7487def Exit(*args):
7488 """
0df68c9f 7489 Exit()
6c3b4aae 7490
0df68c9f
RD
7491 Force an exit of the application. Convenience for wx.GetApp().Exit()
7492 """
0085ce49 7493 return _core_.Exit(*args)
d14a1e28 7494
0085ce49
RD
7495def Yield(*args):
7496 """
0df68c9f 7497 Yield() -> bool
6c3b4aae 7498
0df68c9f
RD
7499 Yield to other apps/messages. Convenience for wx.GetApp().Yield()
7500 """
0085ce49 7501 return _core_.Yield(*args)
d14a1e28 7502
0085ce49
RD
7503def YieldIfNeeded(*args):
7504 """
0df68c9f 7505 YieldIfNeeded() -> bool
6c3b4aae 7506
0df68c9f
RD
7507 Yield to other apps/messages. Convenience for wx.GetApp().Yield(True)
7508 """
0085ce49 7509 return _core_.YieldIfNeeded(*args)
d14a1e28 7510
e811c8ce 7511def SafeYield(*args, **kwargs):
0085ce49 7512 """
0df68c9f 7513 SafeYield(Window win=None, bool onlyIfNeeded=False) -> bool
6c3b4aae 7514
66c033b4
RD
7515 This function is similar to `wx.Yield`, except that it disables the
7516 user input to all program windows before calling `wx.Yield` and
7517 re-enables it again afterwards. If ``win`` is not None, this window
7518 will remain enabled, allowing the implementation of some limited user
7519 interaction.
6c3b4aae 7520
66c033b4 7521 :Returns: the result of the call to `wx.Yield`.
0df68c9f 7522 """
0085ce49 7523 return _core_.SafeYield(*args, **kwargs)
d14a1e28 7524
0085ce49
RD
7525def WakeUpIdle(*args):
7526 """
0df68c9f 7527 WakeUpIdle()
6c3b4aae 7528
66c033b4
RD
7529 Cause the message queue to become empty again, so idle events will be
7530 sent.
0df68c9f 7531 """
0085ce49 7532 return _core_.WakeUpIdle(*args)
d14a1e28 7533
e811c8ce 7534def PostEvent(*args, **kwargs):
0085ce49 7535 """
0df68c9f 7536 PostEvent(EvtHandler dest, Event event)
6c3b4aae 7537
66c033b4
RD
7538 Send an event to a window or other wx.EvtHandler to be processed
7539 later.
0df68c9f 7540 """
0085ce49 7541 return _core_.PostEvent(*args, **kwargs)
d14a1e28 7542
0085ce49
RD
7543def App_CleanUp(*args):
7544 """
0df68c9f 7545 App_CleanUp()
6c3b4aae 7546
41e2b43e 7547 For internal use only, it is used to cleanup after wxWidgets when
66c033b4 7548 Python shuts down.
0df68c9f 7549 """
0085ce49 7550 return _core_.App_CleanUp(*args)
d14a1e28 7551
0085ce49
RD
7552def GetApp(*args):
7553 """
0df68c9f 7554 GetApp() -> PyApp
6c3b4aae 7555
196addbf 7556 Return a reference to the current wx.App object.
0df68c9f 7557 """
0085ce49 7558 return _core_.GetApp(*args)
5cbf236d
RD
7559
7560def SetDefaultPyEncoding(*args, **kwargs):
0085ce49 7561 """
5cbf236d
RD
7562 SetDefaultPyEncoding(string encoding)
7563
7564 Sets the encoding that wxPython will use when it needs to convert a
7565 Python string or unicode object to or from a wxString.
e505d15e
RD
7566
7567 The default encoding is the value of ``locale.getdefaultlocale()[1]``
7568 but please be aware that the default encoding within the same locale
7569 may be slightly different on different platforms. For example, please
7570 see http://www.alanwood.net/demos/charsetdiffs.html for differences
7571 between the common latin/roman encodings.
5cbf236d 7572 """
0085ce49 7573 return _core_.SetDefaultPyEncoding(*args, **kwargs)
5cbf236d 7574
0085ce49
RD
7575def GetDefaultPyEncoding(*args):
7576 """
5cbf236d
RD
7577 GetDefaultPyEncoding() -> string
7578
7579 Gets the current encoding that wxPython will use when it needs to
7580 convert a Python string or unicode object to or from a wxString.
7581 """
0085ce49 7582 return _core_.GetDefaultPyEncoding(*args)
d14a1e28
RD
7583#----------------------------------------------------------------------
7584
7585class PyOnDemandOutputWindow:
6c3b4aae
RD
7586 """
7587 A class that can be used for redirecting Python's stdout and
7588 stderr streams. It will do nothing until something is wrriten to
7589 the stream at which point it will create a Frame with a text area
7590 and write the text there.
7591 """
d14a1e28
RD
7592 def __init__(self, title = "wxPython: stdout/stderr"):
7593 self.frame = None
7594 self.title = title
412d302d
RD
7595 self.pos = wx.DefaultPosition
7596 self.size = (450, 300)
d14a1e28
RD
7597 self.parent = None
7598
7599 def SetParent(self, parent):
6c3b4aae 7600 """Set the window to be used as the popup Frame's parent."""
d14a1e28
RD
7601 self.parent = parent
7602
6c3b4aae
RD
7603
7604 def CreateOutputWindow(self, st):
412d302d
RD
7605 self.frame = wx.Frame(self.parent, -1, self.title, self.pos, self.size,
7606 style=wx.DEFAULT_FRAME_STYLE)
196addbf 7607 self.text = wx.TextCtrl(self.frame, -1, "",
412d302d 7608 style=wx.TE_MULTILINE|wx.TE_READONLY)
d1e20054 7609 self.text.AppendText(st)
6c3b4aae 7610 self.frame.Show(True)
2131d850 7611 self.frame.Bind(wx.EVT_CLOSE, self.OnCloseWindow)
6c3b4aae 7612
d14a1e28 7613
7409c0c6
RD
7614 def OnCloseWindow(self, event):
7615 if self.frame is not None:
7616 self.frame.Destroy()
7617 self.frame = None
7618 self.text = None
7619
7620
d14a1e28 7621 # These methods provide the file-like output behaviour.
6c3b4aae
RD
7622 def write(self, text):
7623 """
7624 Create the output window if needed and write the string to it.
7625 If not called in the context of the gui thread then uses
7626 CallAfter to do the work there.
7627 """
7628 if self.frame is None:
7629 if not wx.Thread_IsMain():
7630 wx.CallAfter(self.CreateOutputWindow, text)
7631 else:
7632 self.CreateOutputWindow(text)
7633 else:
7634 if not wx.Thread_IsMain():
7635 wx.CallAfter(self.text.AppendText, text)
7636 else:
7637 self.text.AppendText(text)
7638
d14a1e28
RD
7639
7640 def close(self):
6c3b4aae
RD
7641 if self.frame is not None:
7642 wx.CallAfter(self.frame.Close)
7643
d14a1e28 7644
19272049
RD
7645 def flush(self):
7646 pass
7647
7648
d14a1e28
RD
7649
7650#----------------------------------------------------------------------
d14a1e28
RD
7651
7652_defRedirect = (wx.Platform == '__WXMSW__' or wx.Platform == '__WXMAC__')
fc46b7f3 7653
d14a1e28 7654class App(wx.PyApp):
6c3b4aae 7655 """
66c033b4
RD
7656 The ``wx.App`` class represents the application and is used to:
7657
7658 * bootstrap the wxPython system and initialize the underlying
7659 gui toolkit
7660 * set and get application-wide properties
7661 * implement the windowing system main message or event loop,
7662 and to dispatch events to window instances
7663 * etc.
7664
7665 Every application must have a ``wx.App`` instance, and all
7666 creation of UI objects should be delayed until after the
03e37cd5
RD
7667 ``wx.App`` object has been created in order to ensure that the gui
7668 platform and wxWidgets have been fully initialized.
66c033b4
RD
7669
7670 Normally you would derive from this class and implement an
7671 ``OnInit`` method that creates a frame and then calls
7672 ``self.SetTopWindow(frame)``.
7673
03e37cd5 7674 :see: `wx.PySimpleApp` for a simpler app class that can be used
1c0f361b 7675 directly.
6c3b4aae 7676 """
66c033b4 7677
d14a1e28
RD
7678 outputWindowClass = PyOnDemandOutputWindow
7679
03e37cd5
RD
7680 def __init__(self, redirect=_defRedirect, filename=None,
7681 useBestVisual=False, clearSigInt=True):
66c033b4
RD
7682 """
7683 Construct a ``wx.App`` object.
7684
03e37cd5
RD
7685 :param redirect: Should ``sys.stdout`` and ``sys.stderr`` be
7686 redirected? Defaults to True on Windows and Mac, False
7687 otherwise. If `filename` is None then output will be
7688 redirected to a window that pops up as needed. (You can
7689 control what kind of window is created for the output by
7690 resetting the class variable ``outputWindowClass`` to a
7691 class of your choosing.)
66c033b4 7692
03e37cd5
RD
7693 :param filename: The name of a file to redirect output to, if
7694 redirect is True.
66c033b4
RD
7695
7696 :param useBestVisual: Should the app try to use the best
03e37cd5
RD
7697 available visual provided by the system (only relevant on
7698 systems that have more than one visual.) This parameter
7699 must be used instead of calling `SetUseBestVisual` later
7700 on because it must be set before the underlying GUI
7701 toolkit is initialized.
7702
7703 :param clearSigInt: Should SIGINT be cleared? This allows the
7704 app to terminate upon a Ctrl-C in the console like other
7705 GUI apps will.
66c033b4
RD
7706
7707 :note: You should override OnInit to do applicaition
7708 initialization to ensure that the system, toolkit and
7709 wxWidgets are fully initialized.
7710 """
fc46b7f3 7711
d14a1e28
RD
7712 wx.PyApp.__init__(self)
7713
fc46b7f3 7714 # make sure we can create a GUI
33d6fd3b 7715 if not self.IsDisplayAvailable():
fc46b7f3
RD
7716
7717 if wx.Platform == "__WXMAC__":
7718 msg = """This program needs access to the screen.
7719Please run with 'pythonw', not 'python', and only when you are logged
7720in on the main display of your Mac."""
7721
7722 elif wx.Platform == "__WXGTK__":
7723 msg ="Unable to access the X Display, is $DISPLAY set properly?"
d14a1e28 7724
fc46b7f3
RD
7725 else:
7726 msg = "Unable to create GUI"
7727 # TODO: more description is needed for wxMSW...
7728
7729 raise SystemExit(msg)
7730
d14a1e28
RD
7731 # This has to be done before OnInit
7732 self.SetUseBestVisual(useBestVisual)
7733
7734 # Set the default handler for SIGINT. This fixes a problem
7735 # where if Ctrl-C is pressed in the console that started this
7736 # app then it will not appear to do anything, (not even send
7737 # KeyboardInterrupt???) but will later segfault on exit. By
7738 # setting the default handler then the app will exit, as
7739 # expected (depending on platform.)
03e37cd5
RD
7740 if clearSigInt:
7741 try:
7742 import signal
7743 signal.signal(signal.SIGINT, signal.SIG_DFL)
7744 except:
7745 pass
d14a1e28
RD
7746
7747 # Save and redirect the stdio to a window?
7748 self.stdioWin = None
7749 self.saveStdio = (_sys.stdout, _sys.stderr)
7750 if redirect:
7751 self.RedirectStdio(filename)
7752
8fb0e70a
RD
7753 # Use Python's install prefix as the default
7754 wx.StandardPaths.Get().SetInstallPrefix(_sys.prefix)
7755
d14a1e28
RD
7756 # This finishes the initialization of wxWindows and then calls
7757 # the OnInit that should be present in the derived class
7758 self._BootstrapApp()
7759
7760
01f6b6d3
RD
7761 def OnPreInit(self):
7762 """
7763 Things that must be done after _BootstrapApp has done its
7764 thing, but would be nice if they were already done by the time
7765 that OnInit is called.
7766 """
7767 wx.StockGDI._initStockObjects()
7768
7769
02b455f2
RD
7770 def __del__(self, destroy=wx.PyApp.__del__):
7771 self.RestoreStdio() # Just in case the MainLoop was overridden
7772 destroy(self)
d14a1e28 7773
70b7a5fe 7774 def Destroy(self):
b39fe951 7775 self.this.own(False)
70b7a5fe 7776 wx.PyApp.Destroy(self)
d14a1e28
RD
7777
7778 def SetTopWindow(self, frame):
1e0c8722 7779 """Set the \"main\" top level window"""
d14a1e28
RD
7780 if self.stdioWin:
7781 self.stdioWin.SetParent(frame)
7782 wx.PyApp.SetTopWindow(self, frame)
7783
7784
7785 def MainLoop(self):
1e0c8722 7786 """Execute the main GUI event loop"""
d14a1e28
RD
7787 wx.PyApp.MainLoop(self)
7788 self.RestoreStdio()
7789
7790
7409c0c6 7791 def RedirectStdio(self, filename=None):
1e0c8722 7792 """Redirect sys.stdout and sys.stderr to a file or a popup window."""
d14a1e28
RD
7793 if filename:
7794 _sys.stdout = _sys.stderr = open(filename, 'a')
7795 else:
7796 self.stdioWin = self.outputWindowClass()
7797 _sys.stdout = _sys.stderr = self.stdioWin
7798
7799
7800 def RestoreStdio(self):
02b455f2
RD
7801 try:
7802 _sys.stdout, _sys.stderr = self.saveStdio
7803 except:
7804 pass
d14a1e28
RD
7805
7806
412d302d
RD
7807 def SetOutputWindowAttributes(self, title=None, pos=None, size=None):
7808 """
7809 Set the title, position and/or size of the output window if
f5b96ee1
RD
7810 the stdio has been redirected. This should be called before
7811 any output would cause the output window to be created.
412d302d
RD
7812 """
7813 if self.stdioWin:
7814 if title is not None:
7815 self.stdioWin.title = title
7816 if pos is not None:
7817 self.stdioWin.pos = pos
7818 if size is not None:
7819 self.stdioWin.size = size
7820
7821
7822
d14a1e28 7823
66c033b4 7824# change from wx.PyApp_XX to wx.App_XX
54f9ee45
RD
7825App_GetMacSupportPCMenuShortcuts = _core_.PyApp_GetMacSupportPCMenuShortcuts
7826App_GetMacAboutMenuItemId = _core_.PyApp_GetMacAboutMenuItemId
7827App_GetMacPreferencesMenuItemId = _core_.PyApp_GetMacPreferencesMenuItemId
7828App_GetMacExitMenuItemId = _core_.PyApp_GetMacExitMenuItemId
7829App_GetMacHelpMenuTitleName = _core_.PyApp_GetMacHelpMenuTitleName
7830App_SetMacSupportPCMenuShortcuts = _core_.PyApp_SetMacSupportPCMenuShortcuts
7831App_SetMacAboutMenuItemId = _core_.PyApp_SetMacAboutMenuItemId
7832App_SetMacPreferencesMenuItemId = _core_.PyApp_SetMacPreferencesMenuItemId
7833App_SetMacExitMenuItemId = _core_.PyApp_SetMacExitMenuItemId
7834App_SetMacHelpMenuTitleName = _core_.PyApp_SetMacHelpMenuTitleName
7835App_GetComCtl32Version = _core_.PyApp_GetComCtl32Version
d14a1e28
RD
7836
7837#----------------------------------------------------------------------------
7838
7839class PySimpleApp(wx.App):
6c3b4aae
RD
7840 """
7841 A simple application class. You can just create one of these and
7842 then then make your top level windows later, and not have to worry
66c033b4
RD
7843 about OnInit. For example::
7844
7845 app = wx.PySimpleApp()
7846 frame = wx.Frame(None, title='Hello World')
7847 frame.Show()
7848 app.MainLoop()
7849
7850 :see: `wx.App`
7851 """
6c3b4aae 7852
03e37cd5
RD
7853 def __init__(self, redirect=False, filename=None,
7854 useBestVisual=False, clearSigInt=True):
66c033b4
RD
7855 """
7856 :see: `wx.App.__init__`
7857 """
03e37cd5 7858 wx.App.__init__(self, redirect, filename, useBestVisual, clearSigInt)
6c3b4aae 7859
d14a1e28 7860 def OnInit(self):
d14a1e28
RD
7861 return True
7862
7863
66c033b4 7864
6c3b4aae 7865# Is anybody using this one?
d14a1e28
RD
7866class PyWidgetTester(wx.App):
7867 def __init__(self, size = (250, 100)):
7868 self.size = size
7869 wx.App.__init__(self, 0)
7870
7871 def OnInit(self):
196addbf 7872 self.frame = wx.Frame(None, -1, "Widget Tester", pos=(0,0), size=self.size)
d14a1e28
RD
7873 self.SetTopWindow(self.frame)
7874 return True
7875
66c033b4
RD
7876 def SetWidget(self, widgetClass, *args, **kwargs):
7877 w = widgetClass(self.frame, *args, **kwargs)
d14a1e28
RD
7878 self.frame.Show(True)
7879
7880#----------------------------------------------------------------------------
7881# DO NOT hold any other references to this object. This is how we
66c033b4 7882# know when to cleanup system resources that wxWidgets is holding. When
d14a1e28 7883# the sys module is unloaded, the refcount on sys.__wxPythonCleanup
66c033b4 7884# goes to zero and it calls the wx.App_CleanUp function.
d14a1e28
RD
7885
7886class __wxPyCleanup:
7887 def __init__(self):
54f9ee45 7888 self.cleanup = _core_.App_CleanUp
d14a1e28
RD
7889 def __del__(self):
7890 self.cleanup()
7891
7892_sys.__wxPythonCleanup = __wxPyCleanup()
7893
7894## # another possible solution, but it gets called too early...
66c033b4
RD
7895## import atexit
7896## atexit.register(_core_.wxApp_CleanUp)
d14a1e28
RD
7897
7898
7899#----------------------------------------------------------------------------
7900
7901#---------------------------------------------------------------------------
2ef75293
RD
7902
7903class EventLoop(object):
093d3ff1 7904 """Proxy of C++ EventLoop class"""
0085ce49
RD
7905 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7906 __repr__ = _swig_repr
7907 def __init__(self, *args, **kwargs):
2ef75293 7908 """__init__(self) -> EventLoop"""
0085ce49
RD
7909 _core_.EventLoop_swiginit(self,_core_.new_EventLoop(*args, **kwargs))
7910 __swig_destroy__ = _core_.delete_EventLoop
7911 __del__ = lambda self : None;
2ef75293
RD
7912 def Run(*args, **kwargs):
7913 """Run(self) -> int"""
7914 return _core_.EventLoop_Run(*args, **kwargs)
7915
7916 def Exit(*args, **kwargs):
7917 """Exit(self, int rc=0)"""
7918 return _core_.EventLoop_Exit(*args, **kwargs)
7919
7920 def Pending(*args, **kwargs):
7921 """Pending(self) -> bool"""
7922 return _core_.EventLoop_Pending(*args, **kwargs)
7923
7924 def Dispatch(*args, **kwargs):
7925 """Dispatch(self) -> bool"""
7926 return _core_.EventLoop_Dispatch(*args, **kwargs)
7927
7928 def IsRunning(*args, **kwargs):
7929 """IsRunning(self) -> bool"""
7930 return _core_.EventLoop_IsRunning(*args, **kwargs)
7931
7932 def GetActive(*args, **kwargs):
7933 """GetActive() -> EventLoop"""
7934 return _core_.EventLoop_GetActive(*args, **kwargs)
7935
7936 GetActive = staticmethod(GetActive)
7937 def SetActive(*args, **kwargs):
7938 """SetActive(EventLoop loop)"""
7939 return _core_.EventLoop_SetActive(*args, **kwargs)
7940
7941 SetActive = staticmethod(SetActive)
2131d850 7942_core_.EventLoop_swigregister(EventLoop)
2ef75293 7943
0085ce49
RD
7944def EventLoop_GetActive(*args):
7945 """EventLoop_GetActive() -> EventLoop"""
7946 return _core_.EventLoop_GetActive(*args)
2ef75293
RD
7947
7948def EventLoop_SetActive(*args, **kwargs):
0085ce49
RD
7949 """EventLoop_SetActive(EventLoop loop)"""
7950 return _core_.EventLoop_SetActive(*args, **kwargs)
2ef75293 7951
091f5bed
RD
7952class EventLoopActivator(object):
7953 """Proxy of C++ EventLoopActivator class"""
0085ce49
RD
7954 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7955 __repr__ = _swig_repr
7956 def __init__(self, *args, **kwargs):
091f5bed 7957 """__init__(self, EventLoop evtLoop) -> EventLoopActivator"""
0085ce49
RD
7958 _core_.EventLoopActivator_swiginit(self,_core_.new_EventLoopActivator(*args, **kwargs))
7959 __swig_destroy__ = _core_.delete_EventLoopActivator
7960 __del__ = lambda self : None;
2131d850 7961_core_.EventLoopActivator_swigregister(EventLoopActivator)
091f5bed 7962
2ef75293 7963#---------------------------------------------------------------------------
d14a1e28 7964
eec1c382
RD
7965ACCEL_ALT = _core_.ACCEL_ALT
7966ACCEL_CTRL = _core_.ACCEL_CTRL
7967ACCEL_SHIFT = _core_.ACCEL_SHIFT
7968ACCEL_NORMAL = _core_.ACCEL_NORMAL
7969ACCEL_CMD = _core_.ACCEL_CMD
1e0c8722 7970class AcceleratorEntry(object):
66c033b4
RD
7971 """
7972 A class used to define items in an `wx.AcceleratorTable`. wxPython
7973 programs can choose to use wx.AcceleratorEntry objects, but using a
7974 list of 3-tuple of integers (flags, keyCode, cmdID) usually works just
41e2b43e 7975 as well. See `__init__` for of the tuple values.
66c033b4
RD
7976
7977 :see: `wx.AcceleratorTable`
7978 """
0085ce49
RD
7979 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7980 __repr__ = _swig_repr
7981 def __init__(self, *args, **kwargs):
66c033b4
RD
7982 """
7983 __init__(self, int flags=0, int keyCode=0, int cmdID=0) -> AcceleratorEntry
7984
7985 Construct a wx.AcceleratorEntry.
66c033b4 7986 """
0085ce49
RD
7987 _core_.AcceleratorEntry_swiginit(self,_core_.new_AcceleratorEntry(*args, **kwargs))
7988 __swig_destroy__ = _core_.delete_AcceleratorEntry
7989 __del__ = lambda self : None;
1e0c8722 7990 def Set(*args, **kwargs):
66c033b4
RD
7991 """
7992 Set(self, int flags, int keyCode, int cmd)
1e0c8722 7993
66c033b4
RD
7994 (Re)set the attributes of a wx.AcceleratorEntry.
7995 :see `__init__`
7996 """
7997 return _core_.AcceleratorEntry_Set(*args, **kwargs)
1e0c8722 7998
97ab0f6a
RD
7999 def Create(*args, **kwargs):
8000 """
8001 Create(String str) -> AcceleratorEntry
8002
8003 Create accelerator corresponding to the specified string, or None if
8004 it coulnd't be parsed.
8005 """
8006 return _core_.AcceleratorEntry_Create(*args, **kwargs)
8007
8008 Create = staticmethod(Create)
1e0c8722 8009 def GetFlags(*args, **kwargs):
66c033b4
RD
8010 """
8011 GetFlags(self) -> int
8012
8013 Get the AcceleratorEntry's flags.
8014 """
54f9ee45 8015 return _core_.AcceleratorEntry_GetFlags(*args, **kwargs)
1e0c8722
RD
8016
8017 def GetKeyCode(*args, **kwargs):
66c033b4
RD
8018 """
8019 GetKeyCode(self) -> int
8020
8021 Get the AcceleratorEntry's keycode.
8022 """
54f9ee45 8023 return _core_.AcceleratorEntry_GetKeyCode(*args, **kwargs)
1e0c8722
RD
8024
8025 def GetCommand(*args, **kwargs):
66c033b4
RD
8026 """
8027 GetCommand(self) -> int
8028
8029 Get the AcceleratorEntry's command ID.
8030 """
54f9ee45 8031 return _core_.AcceleratorEntry_GetCommand(*args, **kwargs)
1e0c8722 8032
97ab0f6a
RD
8033 def IsOk(*args, **kwargs):
8034 """IsOk(self) -> bool"""
8035 return _core_.AcceleratorEntry_IsOk(*args, **kwargs)
8036
8037 def ToString(*args, **kwargs):
8038 """
8039 ToString(self) -> String
8040
8041 Returns a string representation for the this accelerator. The string
8042 is formatted using the <flags>-<keycode> format where <flags> maybe a
8043 hyphen-separed list of "shift|alt|ctrl"
8044
8045 """
8046 return _core_.AcceleratorEntry_ToString(*args, **kwargs)
8047
8048 def FromString(*args, **kwargs):
8049 """
8050 FromString(self, String str) -> bool
8051
8052 Returns true if the given string correctly initialized this object.
8053 """
8054 return _core_.AcceleratorEntry_FromString(*args, **kwargs)
8055
2bf58437
RD
8056 Command = property(GetCommand,doc="See `GetCommand`")
8057 Flags = property(GetFlags,doc="See `GetFlags`")
8058 KeyCode = property(GetKeyCode,doc="See `GetKeyCode`")
2131d850 8059_core_.AcceleratorEntry_swigregister(AcceleratorEntry)
1e0c8722 8060
97ab0f6a
RD
8061def AcceleratorEntry_Create(*args, **kwargs):
8062 """
8063 AcceleratorEntry_Create(String str) -> AcceleratorEntry
8064
8065 Create accelerator corresponding to the specified string, or None if
8066 it coulnd't be parsed.
8067 """
8068 return _core_.AcceleratorEntry_Create(*args, **kwargs)
8069
1e0c8722 8070class AcceleratorTable(Object):
66c033b4
RD
8071 """
8072 An accelerator table allows the application to specify a table of
8073 keyboard shortcuts for menus or other commands. On Windows, menu or
8074 button commands are supported; on GTK, only menu commands are
8075 supported.
66c033b4 8076 """
0085ce49
RD
8077 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
8078 __repr__ = _swig_repr
8079 def __init__(self, *args, **kwargs):
0df68c9f
RD
8080 """
8081 __init__(entries) -> AcceleratorTable
1e0c8722 8082
66c033b4
RD
8083 Construct an AcceleratorTable from a list of `wx.AcceleratorEntry`
8084 items or or of 3-tuples (flags, keyCode, cmdID)
8085
8086 :see: `wx.AcceleratorEntry`
0df68c9f 8087 """
0085ce49
RD
8088 _core_.AcceleratorTable_swiginit(self,_core_.new_AcceleratorTable(*args, **kwargs))
8089 __swig_destroy__ = _core_.delete_AcceleratorTable
8090 __del__ = lambda self : None;
b39fe951
RD
8091 def IsOk(*args, **kwargs):
8092 """IsOk(self) -> bool"""
8093 return _core_.AcceleratorTable_IsOk(*args, **kwargs)
1e0c8722 8094
b39fe951 8095 Ok = IsOk
2131d850 8096_core_.AcceleratorTable_swigregister(AcceleratorTable)
1e0c8722
RD
8097
8098
8099def GetAccelFromString(*args, **kwargs):
0085ce49
RD
8100 """GetAccelFromString(String label) -> AcceleratorEntry"""
8101 return _core_.GetAccelFromString(*args, **kwargs)
1e0c8722
RD
8102#---------------------------------------------------------------------------
8103
74a57fcd
RD
8104class VisualAttributes(object):
8105 """struct containing all the visual attributes of a control"""
0085ce49
RD
8106 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
8107 __repr__ = _swig_repr
8108 def __init__(self, *args, **kwargs):
74a57fcd 8109 """
a95a7133 8110 __init__(self) -> VisualAttributes
74a57fcd
RD
8111
8112 struct containing all the visual attributes of a control
8113 """
0085ce49
RD
8114 _core_.VisualAttributes_swiginit(self,_core_.new_VisualAttributes(*args, **kwargs))
8115 __swig_destroy__ = _core_.delete_VisualAttributes
8116 __del__ = lambda self : None;
54f9ee45
RD
8117 font = property(_core_.VisualAttributes_font_get, _core_.VisualAttributes_font_set)
8118 colFg = property(_core_.VisualAttributes_colFg_get, _core_.VisualAttributes_colFg_set)
8119 colBg = property(_core_.VisualAttributes_colBg_get, _core_.VisualAttributes_colBg_set)
2131d850 8120_core_.VisualAttributes_swigregister(VisualAttributes)
74a57fcd
RD
8121NullAcceleratorTable = cvar.NullAcceleratorTable
8122PanelNameStr = cvar.PanelNameStr
8123
54f9ee45
RD
8124WINDOW_VARIANT_NORMAL = _core_.WINDOW_VARIANT_NORMAL
8125WINDOW_VARIANT_SMALL = _core_.WINDOW_VARIANT_SMALL
8126WINDOW_VARIANT_MINI = _core_.WINDOW_VARIANT_MINI
8127WINDOW_VARIANT_LARGE = _core_.WINDOW_VARIANT_LARGE
8128WINDOW_VARIANT_MAX = _core_.WINDOW_VARIANT_MAX
d14a1e28 8129class Window(EvtHandler):
15afbcd0
RD
8130 """
8131 wx.Window is the base class for all windows and represents any visible
8132 object on the screen. All controls, top level windows and so on are
8133 wx.Windows. Sizers and device contexts are not however, as they don't
8134 appear on screen themselves.
8135
8136 """
0085ce49
RD
8137 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
8138 __repr__ = _swig_repr
8139 def __init__(self, *args, **kwargs):
0df68c9f 8140 """
a95a7133 8141 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
74a57fcd 8142 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> Window
15afbcd0
RD
8143
8144 Construct and show a generic Window.
0df68c9f 8145 """
0085ce49 8146 _core_.Window_swiginit(self,_core_.new_Window(*args, **kwargs))
d14a1e28 8147 self._setOORInfo(self)
d14a1e28 8148
e811c8ce 8149 def Create(*args, **kwargs):
0df68c9f 8150 """
a95a7133 8151 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
74a57fcd 8152 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> bool
15afbcd0
RD
8153
8154 Create the GUI part of the Window for 2-phase creation mode.
0df68c9f 8155 """
54f9ee45 8156 return _core_.Window_Create(*args, **kwargs)
d14a1e28 8157
e811c8ce 8158 def Close(*args, **kwargs):
15afbcd0 8159 """
a95a7133 8160 Close(self, bool force=False) -> bool
15afbcd0
RD
8161
8162 This function simply generates a EVT_CLOSE event whose handler usually
8163 tries to close the window. It doesn't close the window itself,
8164 however. If force is False (the default) then the window's close
8165 handler will be allowed to veto the destruction of the window.
15afbcd0 8166 """
54f9ee45 8167 return _core_.Window_Close(*args, **kwargs)
d14a1e28 8168
e811c8ce 8169 def Destroy(*args, **kwargs):
0df68c9f 8170 """
a95a7133 8171 Destroy(self) -> bool
d14a1e28 8172
15afbcd0
RD
8173 Destroys the window safely. Frames and dialogs are not destroyed
8174 immediately when this function is called -- they are added to a list
8175 of windows to be deleted on idle time, when all the window's events
8176 have been processed. This prevents problems with events being sent to
8177 non-existent windows.
8178
8179 Returns True if the window has either been successfully deleted, or it
8180 has been added to the list of windows pending real deletion.
0df68c9f 8181 """
b39fe951
RD
8182 args[0].this.own(False)
8183 return _core_.Window_Destroy(*args, **kwargs)
d14a1e28 8184
e811c8ce 8185 def DestroyChildren(*args, **kwargs):
15afbcd0 8186 """
a95a7133 8187 DestroyChildren(self) -> bool
15afbcd0 8188
41e2b43e
RD
8189 Destroys all children of a window. Called automatically by the
8190 destructor.
15afbcd0 8191 """
54f9ee45 8192 return _core_.Window_DestroyChildren(*args, **kwargs)
d14a1e28 8193
e811c8ce 8194 def IsBeingDeleted(*args, **kwargs):
15afbcd0 8195 """
a95a7133 8196 IsBeingDeleted(self) -> bool
15afbcd0
RD
8197
8198 Is the window in the process of being deleted?
8199 """
54f9ee45 8200 return _core_.Window_IsBeingDeleted(*args, **kwargs)
d14a1e28 8201
e811c8ce 8202 def SetLabel(*args, **kwargs):
15afbcd0 8203 """
a95a7133 8204 SetLabel(self, String label)
15afbcd0
RD
8205
8206 Set the text which the window shows in its label if applicable.
8207 """
54f9ee45 8208 return _core_.Window_SetLabel(*args, **kwargs)
d14a1e28 8209
e811c8ce 8210 def GetLabel(*args, **kwargs):
15afbcd0 8211 """
a95a7133 8212 GetLabel(self) -> String
15afbcd0 8213
41e2b43e
RD
8214 Generic way of getting a label from any window, for identification
8215 purposes. The interpretation of this function differs from class to
8216 class. For frames and dialogs, the value returned is the title. For
8217 buttons or static text controls, it is the button text. This function
8218 can be useful for meta-programs such as testing tools or special-needs
8219 access programs)which need to identify windows by name.
15afbcd0 8220 """
54f9ee45 8221 return _core_.Window_GetLabel(*args, **kwargs)
d14a1e28 8222
e811c8ce 8223 def SetName(*args, **kwargs):
15afbcd0 8224 """
a95a7133 8225 SetName(self, String name)
15afbcd0 8226
41e2b43e
RD
8227 Sets the window's name. The window name is used for ressource setting
8228 in X, it is not the same as the window title/label
15afbcd0 8229 """
54f9ee45 8230 return _core_.Window_SetName(*args, **kwargs)
d14a1e28 8231
e811c8ce 8232 def GetName(*args, **kwargs):
15afbcd0 8233 """
a95a7133 8234 GetName(self) -> String
15afbcd0 8235
41e2b43e
RD
8236 Returns the windows name. This name is not guaranteed to be unique;
8237 it is up to the programmer to supply an appropriate name in the window
8238 constructor or via wx.Window.SetName.
15afbcd0 8239 """
54f9ee45 8240 return _core_.Window_GetName(*args, **kwargs)
d14a1e28 8241
4276dc52
RD
8242 def SetWindowVariant(*args, **kwargs):
8243 """
a95a7133 8244 SetWindowVariant(self, int variant)
4276dc52 8245
41e2b43e
RD
8246 Sets the variant of the window/font size to use for this window, if
8247 the platform supports variants, for example, wxMac.
4276dc52 8248 """
54f9ee45 8249 return _core_.Window_SetWindowVariant(*args, **kwargs)
4276dc52
RD
8250
8251 def GetWindowVariant(*args, **kwargs):
a95a7133 8252 """GetWindowVariant(self) -> int"""
54f9ee45 8253 return _core_.Window_GetWindowVariant(*args, **kwargs)
4276dc52 8254
e811c8ce 8255 def SetId(*args, **kwargs):
15afbcd0 8256 """
a95a7133 8257 SetId(self, int winid)
15afbcd0
RD
8258
8259 Sets the identifier of the window. Each window has an integer
8260 identifier. If the application has not provided one, an identifier
8261 will be generated. Normally, the identifier should be provided on
8262 creation and should not be modified subsequently.
8263 """
54f9ee45 8264 return _core_.Window_SetId(*args, **kwargs)
d14a1e28 8265
e811c8ce 8266 def GetId(*args, **kwargs):
15afbcd0 8267 """
a95a7133 8268 GetId(self) -> int
15afbcd0
RD
8269
8270 Returns the identifier of the window. Each window has an integer
8271 identifier. If the application has not provided one (or the default Id
8272 -1 is used) then an unique identifier with a negative value will be
8273 generated.
8274 """
54f9ee45 8275 return _core_.Window_GetId(*args, **kwargs)
d14a1e28 8276
e811c8ce 8277 def NewControlId(*args, **kwargs):
15afbcd0 8278 """
66c033b4 8279 NewControlId() -> int
15afbcd0
RD
8280
8281 Generate a control id for the controls which were not given one.
8282 """
54f9ee45 8283 return _core_.Window_NewControlId(*args, **kwargs)
d14a1e28 8284
e811c8ce
RD
8285 NewControlId = staticmethod(NewControlId)
8286 def NextControlId(*args, **kwargs):
15afbcd0 8287 """
66c033b4 8288 NextControlId(int winid) -> int
15afbcd0
RD
8289
8290 Get the id of the control following the one with the given
41e2b43e 8291 autogenerated) id
15afbcd0 8292 """
54f9ee45 8293 return _core_.Window_NextControlId(*args, **kwargs)
d14a1e28 8294
e811c8ce
RD
8295 NextControlId = staticmethod(NextControlId)
8296 def PrevControlId(*args, **kwargs):
15afbcd0 8297 """
66c033b4 8298 PrevControlId(int winid) -> int
15afbcd0
RD
8299
8300 Get the id of the control preceding the one with the given
41e2b43e 8301 autogenerated) id
15afbcd0 8302 """
54f9ee45 8303 return _core_.Window_PrevControlId(*args, **kwargs)
d14a1e28 8304
e811c8ce 8305 PrevControlId = staticmethod(PrevControlId)
97ab0f6a
RD
8306 def GetLayoutDirection(*args, **kwargs):
8307 """
994453b8 8308 GetLayoutDirection(self) -> int
97ab0f6a
RD
8309
8310 Get the layout direction (LTR or RTL) for this window. Returns
8311 ``wx.Layout_Default`` if layout direction is not supported.
8312 """
8313 return _core_.Window_GetLayoutDirection(*args, **kwargs)
8314
8315 def SetLayoutDirection(*args, **kwargs):
8316 """
994453b8 8317 SetLayoutDirection(self, int dir)
97ab0f6a
RD
8318
8319 Set the layout direction (LTR or RTL) for this window.
8320 """
8321 return _core_.Window_SetLayoutDirection(*args, **kwargs)
8322
8323 def AdjustForLayoutDirection(*args, **kwargs):
8324 """
8325 AdjustForLayoutDirection(self, int x, int width, int widthTotal) -> int
8326
8327 Mirror coordinates for RTL layout if this window uses it and if the
8328 mirroring is not done automatically like Win32.
8329 """
8330 return _core_.Window_AdjustForLayoutDirection(*args, **kwargs)
8331
e811c8ce 8332 def SetSize(*args, **kwargs):
15afbcd0 8333 """
a95a7133 8334 SetSize(self, Size size)
15afbcd0
RD
8335
8336 Sets the size of the window in pixels.
8337 """
54f9ee45 8338 return _core_.Window_SetSize(*args, **kwargs)
d14a1e28 8339
e811c8ce 8340 def SetDimensions(*args, **kwargs):
15afbcd0 8341 """
a95a7133 8342 SetDimensions(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)
15afbcd0
RD
8343
8344 Sets the position and size of the window in pixels. The sizeFlags
8345 parameter indicates the interpretation of the other params if they are
e505d15e
RD
8346 equal to -1.
8347
8348 ======================== ======================================
8349 wx.SIZE_AUTO A -1 indicates that a class-specific
8350 default should be used.
8351 wx.SIZE_USE_EXISTING Axisting dimensions should be used if
8352 -1 values are supplied.
8353 wxSIZE_ALLOW_MINUS_ONE Allow dimensions of -1 and less to be
8354 interpreted as real dimensions, not
8355 default values.
8356 ======================== ======================================
8357
15afbcd0 8358 """
54f9ee45 8359 return _core_.Window_SetDimensions(*args, **kwargs)
d14a1e28 8360
e811c8ce 8361 def SetRect(*args, **kwargs):
15afbcd0 8362 """
a95a7133 8363 SetRect(self, Rect rect, int sizeFlags=SIZE_AUTO)
15afbcd0
RD
8364
8365 Sets the position and size of the window in pixels using a wx.Rect.
8366 """
54f9ee45 8367 return _core_.Window_SetRect(*args, **kwargs)
d14a1e28 8368
e811c8ce 8369 def SetSizeWH(*args, **kwargs):
15afbcd0 8370 """
a95a7133 8371 SetSizeWH(self, int width, int height)
15afbcd0
RD
8372
8373 Sets the size of the window in pixels.
8374 """
54f9ee45 8375 return _core_.Window_SetSizeWH(*args, **kwargs)
d14a1e28 8376
e811c8ce 8377 def Move(*args, **kwargs):
15afbcd0 8378 """
a95a7133 8379 Move(self, Point pt, int flags=SIZE_USE_EXISTING)
15afbcd0
RD
8380
8381 Moves the window to the given position.
8382 """
54f9ee45 8383 return _core_.Window_Move(*args, **kwargs)
d14a1e28 8384
e811c8ce
RD
8385 SetPosition = Move
8386 def MoveXY(*args, **kwargs):
15afbcd0 8387 """
a95a7133 8388 MoveXY(self, int x, int y, int flags=SIZE_USE_EXISTING)
15afbcd0
RD
8389
8390 Moves the window to the given position.
8391 """
54f9ee45 8392 return _core_.Window_MoveXY(*args, **kwargs)
e811c8ce 8393
580080c5 8394 def SetInitialSize(*args, **kwargs):
f8167d6e 8395 """
580080c5 8396 SetInitialSize(self, Size size=DefaultSize)
f8167d6e
RD
8397
8398 A 'Smart' SetSize that will fill in default size components with the
8399 window's *best size* values. Also set's the minsize for use with sizers.
8400 """
580080c5 8401 return _core_.Window_SetInitialSize(*args, **kwargs)
f8167d6e 8402
580080c5 8403 SetBestFittingSize = wx._deprecated(SetInitialSize, 'Use `SetInitialSize`')
e811c8ce 8404 def Raise(*args, **kwargs):
15afbcd0 8405 """
a95a7133 8406 Raise(self)
15afbcd0 8407
943e8dfd
RD
8408 Raises the window to the top of the window hierarchy. In current
8409 version of wxWidgets this works both for manage and child windows.
15afbcd0 8410 """
54f9ee45 8411 return _core_.Window_Raise(*args, **kwargs)
e811c8ce
RD
8412
8413 def Lower(*args, **kwargs):
15afbcd0 8414 """
a95a7133 8415 Lower(self)
15afbcd0 8416
943e8dfd
RD
8417 Lowers the window to the bottom of the window hierarchy. In current
8418 version of wxWidgets this works both for manage and child windows.
15afbcd0 8419 """
54f9ee45 8420 return _core_.Window_Lower(*args, **kwargs)
e811c8ce
RD
8421
8422 def SetClientSize(*args, **kwargs):
15afbcd0 8423 """
a95a7133 8424 SetClientSize(self, Size size)
15afbcd0
RD
8425
8426 This sets the size of the window client area in pixels. Using this
8427 function to size a window tends to be more device-independent than
8428 wx.Window.SetSize, since the application need not worry about what
8429 dimensions the border or title bar have when trying to fit the window
8430 around panel items, for example.
8431 """
54f9ee45 8432 return _core_.Window_SetClientSize(*args, **kwargs)
e811c8ce
RD
8433
8434 def SetClientSizeWH(*args, **kwargs):
15afbcd0 8435 """
a95a7133 8436 SetClientSizeWH(self, int width, int height)
15afbcd0
RD
8437
8438 This sets the size of the window client area in pixels. Using this
8439 function to size a window tends to be more device-independent than
8440 wx.Window.SetSize, since the application need not worry about what
8441 dimensions the border or title bar have when trying to fit the window
8442 around panel items, for example.
8443 """
54f9ee45 8444 return _core_.Window_SetClientSizeWH(*args, **kwargs)
e811c8ce
RD
8445
8446 def SetClientRect(*args, **kwargs):
15afbcd0 8447 """
a95a7133 8448 SetClientRect(self, Rect rect)
15afbcd0
RD
8449
8450 This sets the size of the window client area in pixels. Using this
8451 function to size a window tends to be more device-independent than
8452 wx.Window.SetSize, since the application need not worry about what
8453 dimensions the border or title bar have when trying to fit the window
8454 around panel items, for example.
8455 """
54f9ee45 8456 return _core_.Window_SetClientRect(*args, **kwargs)
e811c8ce
RD
8457
8458 def GetPosition(*args, **kwargs):
0df68c9f 8459 """
a95a7133 8460 GetPosition(self) -> Point
e811c8ce 8461
75219dcb
RD
8462 Get the window's position. Notice that the position is in client
8463 coordinates for child windows and screen coordinates for the top level
8464 ones, use `GetScreenPosition` if you need screen coordinates for all
8465 kinds of windows.
0df68c9f 8466 """
54f9ee45 8467 return _core_.Window_GetPosition(*args, **kwargs)
e811c8ce
RD
8468
8469 def GetPositionTuple(*args, **kwargs):
0df68c9f
RD
8470 """
8471 GetPositionTuple() -> (x,y)
e811c8ce 8472
75219dcb
RD
8473 Get the window's position. Notice that the position is in client
8474 coordinates for child windows and screen coordinates for the top level
8475 ones, use `GetScreenPosition` if you need screen coordinates for all
8476 kinds of windows.
0df68c9f 8477 """
54f9ee45 8478 return _core_.Window_GetPositionTuple(*args, **kwargs)
e811c8ce 8479
75219dcb
RD
8480 def GetScreenPosition(*args, **kwargs):
8481 """
8482 GetScreenPosition(self) -> Point
8483
8484 Get the position of the window in screen coordinantes.
8485 """
8486 return _core_.Window_GetScreenPosition(*args, **kwargs)
8487
8488 def GetScreenPositionTuple(*args, **kwargs):
8489 """
8490 GetScreenPositionTuple() -> (x,y)
8491
8492 Get the position of the window in screen coordinantes.
8493 """
8494 return _core_.Window_GetScreenPositionTuple(*args, **kwargs)
8495
8496 def GetScreenRect(*args, **kwargs):
8497 """
8498 GetScreenRect(self) -> Rect
8499
8500 Returns the size and position of the window in screen coordinantes as
8501 a `wx.Rect` object.
8502 """
8503 return _core_.Window_GetScreenRect(*args, **kwargs)
8504
e811c8ce 8505 def GetSize(*args, **kwargs):
0df68c9f 8506 """
a95a7133 8507 GetSize(self) -> Size
e811c8ce 8508
0df68c9f
RD
8509 Get the window size.
8510 """
54f9ee45 8511 return _core_.Window_GetSize(*args, **kwargs)
e811c8ce
RD
8512
8513 def GetSizeTuple(*args, **kwargs):
0df68c9f
RD
8514 """
8515 GetSizeTuple() -> (width, height)
e811c8ce 8516
0df68c9f
RD
8517 Get the window size.
8518 """
54f9ee45 8519 return _core_.Window_GetSizeTuple(*args, **kwargs)
e811c8ce
RD
8520
8521 def GetRect(*args, **kwargs):
15afbcd0 8522 """
a95a7133 8523 GetRect(self) -> Rect
15afbcd0 8524
75219dcb 8525 Returns the size and position of the window as a `wx.Rect` object.
15afbcd0 8526 """
54f9ee45 8527 return _core_.Window_GetRect(*args, **kwargs)
e811c8ce
RD
8528
8529 def GetClientSize(*args, **kwargs):
0df68c9f 8530 """
a95a7133 8531 GetClientSize(self) -> Size
e811c8ce 8532
15afbcd0
RD
8533 This gets the size of the window's 'client area' in pixels. The client
8534 area is the area which may be drawn on by the programmer, excluding
8535 title bar, border, scrollbars, etc.
0df68c9f 8536 """
54f9ee45 8537 return _core_.Window_GetClientSize(*args, **kwargs)
e811c8ce
RD
8538
8539 def GetClientSizeTuple(*args, **kwargs):
0df68c9f
RD
8540 """
8541 GetClientSizeTuple() -> (width, height)
e811c8ce 8542
15afbcd0
RD
8543 This gets the size of the window's 'client area' in pixels. The client
8544 area is the area which may be drawn on by the programmer, excluding
8545 title bar, border, scrollbars, etc.
0df68c9f 8546 """
54f9ee45 8547 return _core_.Window_GetClientSizeTuple(*args, **kwargs)
e811c8ce
RD
8548
8549 def GetClientAreaOrigin(*args, **kwargs):
15afbcd0 8550 """
a95a7133 8551 GetClientAreaOrigin(self) -> Point
15afbcd0
RD
8552
8553 Get the origin of the client area of the window relative to the
8554 window's top left corner (the client area may be shifted because of
8555 the borders, scrollbars, other decorations...)
8556 """
54f9ee45 8557 return _core_.Window_GetClientAreaOrigin(*args, **kwargs)
e811c8ce
RD
8558
8559 def GetClientRect(*args, **kwargs):
15afbcd0 8560 """
a95a7133 8561 GetClientRect(self) -> Rect
15afbcd0 8562
61863841 8563 Get the client area position and size as a `wx.Rect` object.
15afbcd0 8564 """
54f9ee45 8565 return _core_.Window_GetClientRect(*args, **kwargs)
e811c8ce
RD
8566
8567 def GetBestSize(*args, **kwargs):
0df68c9f 8568 """
a95a7133 8569 GetBestSize(self) -> Size
e811c8ce 8570
248ed943 8571 This function returns the best acceptable minimal size for the
41e2b43e
RD
8572 window, if applicable. For example, for a static text control, it will
8573 be the minimal size such that the control label is not truncated. For
8574 windows containing subwindows (suzh aswx.Panel), the size returned by
8575 this function will be the same as the size the window would have had
8576 after calling Fit.
0df68c9f 8577 """
54f9ee45 8578 return _core_.Window_GetBestSize(*args, **kwargs)
e811c8ce
RD
8579
8580 def GetBestSizeTuple(*args, **kwargs):
0df68c9f
RD
8581 """
8582 GetBestSizeTuple() -> (width, height)
e811c8ce 8583
248ed943 8584 This function returns the best acceptable minimal size for the
41e2b43e
RD
8585 window, if applicable. For example, for a static text control, it will
8586 be the minimal size such that the control label is not truncated. For
8587 windows containing subwindows (suzh aswx.Panel), the size returned by
8588 this function will be the same as the size the window would have had
8589 after calling Fit.
0df68c9f 8590 """
54f9ee45 8591 return _core_.Window_GetBestSizeTuple(*args, **kwargs)
e811c8ce 8592
dfbb5885
RD
8593 def InvalidateBestSize(*args, **kwargs):
8594 """
8595 InvalidateBestSize(self)
8596
8597 Reset the cached best size value so it will be recalculated the next
8598 time it is needed.
8599 """
8600 return _core_.Window_InvalidateBestSize(*args, **kwargs)
8601
e2813725
RD
8602 def CacheBestSize(*args, **kwargs):
8603 """
8604 CacheBestSize(self, Size size)
8605
8606 Cache the best size so it doesn't need to be calculated again, (at least until
8607 some properties of the window change.)
8608 """
8609 return _core_.Window_CacheBestSize(*args, **kwargs)
8610
580080c5 8611 def GetEffectiveMinSize(*args, **kwargs):
dfbb5885 8612 """
580080c5 8613 GetEffectiveMinSize(self) -> Size
dfbb5885
RD
8614
8615 This function will merge the window's best size into the window's
8616 minimum size, giving priority to the min size components, and returns
8617 the results.
8618
8619 """
580080c5 8620 return _core_.Window_GetEffectiveMinSize(*args, **kwargs)
dfbb5885 8621
0d82d64e 8622 GetBestFittingSize = wx._deprecated(GetEffectiveMinSize, 'Use `GetEffectiveMinSize` instead.')
8f514ab4
RD
8623 def GetAdjustedBestSize(self):
8624 s = self.GetBestSize()
8625 return wx.Size(max(s.width, self.GetMinWidth()),
8626 max(s.height, self.GetMinHeight()))
580080c5 8627 GetAdjustedBestSize = wx._deprecated(GetAdjustedBestSize, 'Use `GetEffectiveMinSize` instead.')
e811c8ce
RD
8628
8629 def Center(*args, **kwargs):
15afbcd0 8630 """
a95a7133 8631 Center(self, int direction=BOTH)
15afbcd0
RD
8632
8633 Centers the window. The parameter specifies the direction for
8634 cetering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may
8635 also include wx.CENTER_ON_SCREEN flag if you want to center the window
8636 on the entire screen and not on its parent window. If it is a
8637 top-level window and has no parent then it will always be centered
8638 relative to the screen.
8639 """
54f9ee45 8640 return _core_.Window_Center(*args, **kwargs)
e811c8ce
RD
8641
8642 Centre = Center
e811c8ce 8643 def CenterOnParent(*args, **kwargs):
15afbcd0 8644 """
a95a7133 8645 CenterOnParent(self, int dir=BOTH)
15afbcd0
RD
8646
8647 Center with respect to the the parent window
8648 """
54f9ee45 8649 return _core_.Window_CenterOnParent(*args, **kwargs)
e811c8ce
RD
8650
8651 CentreOnParent = CenterOnParent
8652 def Fit(*args, **kwargs):
15afbcd0 8653 """
a95a7133 8654 Fit(self)
15afbcd0
RD
8655
8656 Sizes the window so that it fits around its subwindows. This function
8657 won't do anything if there are no subwindows and will only really work
8658 correctly if sizers are used for the subwindows layout. Also, if the
8659 window has exactly one subwindow it is better (faster and the result
8660 is more precise as Fit adds some margin to account for fuzziness of
8661 its calculations) to call window.SetClientSize(child.GetSize())
8662 instead of calling Fit.
8663 """
54f9ee45 8664 return _core_.Window_Fit(*args, **kwargs)
e811c8ce
RD
8665
8666 def FitInside(*args, **kwargs):
15afbcd0 8667 """
a95a7133 8668 FitInside(self)
15afbcd0
RD
8669
8670 Similar to Fit, but sizes the interior (virtual) size of a
8671 window. Mainly useful with scrolled windows to reset scrollbars after
8672 sizing changes that do not trigger a size event, and/or scrolled
8673 windows without an interior sizer. This function similarly won't do
8674 anything if there are no subwindows.
8675 """
54f9ee45 8676 return _core_.Window_FitInside(*args, **kwargs)
e811c8ce 8677
f16ab95d 8678 def SetSizeHints(*args, **kwargs):
0df68c9f 8679 """
a95a7133 8680 SetSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1,
0df68c9f 8681 int incH=-1)
15afbcd0
RD
8682
8683 Allows specification of minimum and maximum window sizes, and window
8684 size increments. If a pair of values is not set (or set to -1), the
8685 default values will be used. If this function is called, the user
908b74cd
RD
8686 will not be able to size the window outside the given bounds (if it is
8687 a top-level window.) Sizers will also inspect the minimum window size
8688 and will use that value if set when calculating layout.
8689
8690 The resizing increments are only significant under Motif or Xt.
0df68c9f 8691 """
f16ab95d 8692 return _core_.Window_SetSizeHints(*args, **kwargs)
e811c8ce 8693
f16ab95d
RD
8694 def SetSizeHintsSz(*args, **kwargs):
8695 """
8696 SetSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize, Size incSize=DefaultSize)
8697
8698 Allows specification of minimum and maximum window sizes, and window
8699 size increments. If a pair of values is not set (or set to -1), the
8700 default values will be used. If this function is called, the user
8701 will not be able to size the window outside the given bounds (if it is
8702 a top-level window.) Sizers will also inspect the minimum window size
8703 and will use that value if set when calculating layout.
8704
8705 The resizing increments are only significant under Motif or Xt.
8706 """
8707 return _core_.Window_SetSizeHintsSz(*args, **kwargs)
8708
8709 def SetVirtualSizeHints(*args, **kwargs):
15afbcd0 8710 """
908b74cd 8711 SetVirtualSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1)
15afbcd0
RD
8712
8713 Allows specification of minimum and maximum virtual window sizes. If a
8714 pair of values is not set (or set to -1), the default values will be
8715 used. If this function is called, the user will not be able to size
8716 the virtual area of the window outside the given bounds.
8717 """
f16ab95d
RD
8718 return _core_.Window_SetVirtualSizeHints(*args, **kwargs)
8719
8720 def SetVirtualSizeHintsSz(*args, **kwargs):
8721 """
8722 SetVirtualSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize)
8723
8724 Allows specification of minimum and maximum virtual window sizes. If a
8725 pair of values is not set (or set to -1), the default values will be
8726 used. If this function is called, the user will not be able to size
8727 the virtual area of the window outside the given bounds.
8728 """
8729 return _core_.Window_SetVirtualSizeHintsSz(*args, **kwargs)
e811c8ce 8730
908b74cd
RD
8731 def GetMaxSize(*args, **kwargs):
8732 """GetMaxSize(self) -> Size"""
8733 return _core_.Window_GetMaxSize(*args, **kwargs)
8734
8735 def GetMinSize(*args, **kwargs):
8736 """GetMinSize(self) -> Size"""
8737 return _core_.Window_GetMinSize(*args, **kwargs)
8738
8739 def SetMinSize(*args, **kwargs):
8740 """
8741 SetMinSize(self, Size minSize)
8742
8743 A more convenient method than `SetSizeHints` for setting just the
8744 min size.
8745 """
8746 return _core_.Window_SetMinSize(*args, **kwargs)
8747
8748 def SetMaxSize(*args, **kwargs):
8749 """
8750 SetMaxSize(self, Size maxSize)
8751
8752 A more convenient method than `SetSizeHints` for setting just the
8753 max size.
8754 """
8755 return _core_.Window_SetMaxSize(*args, **kwargs)
8756
e811c8ce 8757 def GetMinWidth(*args, **kwargs):
a95a7133 8758 """GetMinWidth(self) -> int"""
54f9ee45 8759 return _core_.Window_GetMinWidth(*args, **kwargs)
e811c8ce
RD
8760
8761 def GetMinHeight(*args, **kwargs):
a95a7133 8762 """GetMinHeight(self) -> int"""
54f9ee45 8763 return _core_.Window_GetMinHeight(*args, **kwargs)
e811c8ce
RD
8764
8765 def GetMaxWidth(*args, **kwargs):
a95a7133 8766 """GetMaxWidth(self) -> int"""
54f9ee45 8767 return _core_.Window_GetMaxWidth(*args, **kwargs)
e811c8ce
RD
8768
8769 def GetMaxHeight(*args, **kwargs):
a95a7133 8770 """GetMaxHeight(self) -> int"""
54f9ee45 8771 return _core_.Window_GetMaxHeight(*args, **kwargs)
e811c8ce 8772
e811c8ce 8773 def SetVirtualSize(*args, **kwargs):
0df68c9f 8774 """
a95a7133 8775 SetVirtualSize(self, Size size)
e811c8ce 8776
15afbcd0
RD
8777 Set the the virtual size of a window in pixels. For most windows this
8778 is just the client area of the window, but for some like scrolled
8779 windows it is more or less independent of the screen window size.
0df68c9f 8780 """
54f9ee45 8781 return _core_.Window_SetVirtualSize(*args, **kwargs)
e811c8ce
RD
8782
8783 def SetVirtualSizeWH(*args, **kwargs):
0df68c9f 8784 """
a95a7133 8785 SetVirtualSizeWH(self, int w, int h)
e811c8ce 8786
15afbcd0
RD
8787 Set the the virtual size of a window in pixels. For most windows this
8788 is just the client area of the window, but for some like scrolled
8789 windows it is more or less independent of the screen window size.
0df68c9f 8790 """
54f9ee45 8791 return _core_.Window_SetVirtualSizeWH(*args, **kwargs)
e811c8ce
RD
8792
8793 def GetVirtualSize(*args, **kwargs):
0df68c9f 8794 """
a95a7133 8795 GetVirtualSize(self) -> Size
e811c8ce 8796
15afbcd0
RD
8797 Get the the virtual size of the window in pixels. For most windows
8798 this is just the client area of the window, but for some like scrolled
8799 windows it is more or less independent of the screen window size.
0df68c9f 8800 """
54f9ee45 8801 return _core_.Window_GetVirtualSize(*args, **kwargs)
e811c8ce
RD
8802
8803 def GetVirtualSizeTuple(*args, **kwargs):
0df68c9f
RD
8804 """
8805 GetVirtualSizeTuple() -> (width, height)
e811c8ce 8806
15afbcd0
RD
8807 Get the the virtual size of the window in pixels. For most windows
8808 this is just the client area of the window, but for some like scrolled
8809 windows it is more or less independent of the screen window size.
0df68c9f 8810 """
54f9ee45 8811 return _core_.Window_GetVirtualSizeTuple(*args, **kwargs)
e811c8ce
RD
8812
8813 def GetBestVirtualSize(*args, **kwargs):
15afbcd0 8814 """
a95a7133 8815 GetBestVirtualSize(self) -> Size
15afbcd0
RD
8816
8817 Return the largest of ClientSize and BestSize (as determined by a
8818 sizer, interior children, or other means)
8819 """
54f9ee45 8820 return _core_.Window_GetBestVirtualSize(*args, **kwargs)
e811c8ce
RD
8821
8822 def Show(*args, **kwargs):
15afbcd0 8823 """
a95a7133 8824 Show(self, bool show=True) -> bool
15afbcd0
RD
8825
8826 Shows or hides the window. You may need to call Raise for a top level
8827 window if you want to bring it to top, although this is not needed if
8828 Show is called immediately after the frame creation. Returns True if
8829 the window has been shown or hidden or False if nothing was done
8830 because it already was in the requested state.
8831 """
54f9ee45 8832 return _core_.Window_Show(*args, **kwargs)
e811c8ce
RD
8833
8834 def Hide(*args, **kwargs):
15afbcd0 8835 """
a95a7133 8836 Hide(self) -> bool
15afbcd0
RD
8837
8838 Equivalent to calling Show(False).
8839 """
54f9ee45 8840 return _core_.Window_Hide(*args, **kwargs)
e811c8ce
RD
8841
8842 def Enable(*args, **kwargs):
15afbcd0 8843 """
a95a7133 8844 Enable(self, bool enable=True) -> bool
15afbcd0
RD
8845
8846 Enable or disable the window for user input. Note that when a parent
8847 window is disabled, all of its children are disabled as well and they
8848 are reenabled again when the parent is. Returns true if the window
8849 has been enabled or disabled, false if nothing was done, i.e. if the
8850 window had already been in the specified state.
8851 """
54f9ee45 8852 return _core_.Window_Enable(*args, **kwargs)
e811c8ce
RD
8853
8854 def Disable(*args, **kwargs):
15afbcd0 8855 """
a95a7133 8856 Disable(self) -> bool
15afbcd0
RD
8857
8858 Disables the window, same as Enable(false).
8859 """
54f9ee45 8860 return _core_.Window_Disable(*args, **kwargs)
e811c8ce
RD
8861
8862 def IsShown(*args, **kwargs):
15afbcd0 8863 """
a95a7133 8864 IsShown(self) -> bool
15afbcd0
RD
8865
8866 Returns true if the window is shown, false if it has been hidden.
8867 """
54f9ee45 8868 return _core_.Window_IsShown(*args, **kwargs)
e811c8ce
RD
8869
8870 def IsEnabled(*args, **kwargs):
15afbcd0 8871 """
a95a7133 8872 IsEnabled(self) -> bool
15afbcd0
RD
8873
8874 Returns true if the window is enabled for input, false otherwise.
8875 """
54f9ee45 8876 return _core_.Window_IsEnabled(*args, **kwargs)
e811c8ce 8877
33d6fd3b
RD
8878 def IsShownOnScreen(*args, **kwargs):
8879 """
8880 IsShownOnScreen(self) -> bool
8881
8882 Returns ``True`` if the window is physically visible on the screen,
8883 i.e. it is shown and all its parents up to the toplevel window are
8884 shown as well.
8885 """
8886 return _core_.Window_IsShownOnScreen(*args, **kwargs)
8887
e811c8ce 8888 def SetWindowStyleFlag(*args, **kwargs):
15afbcd0 8889 """
a95a7133 8890 SetWindowStyleFlag(self, long style)
15afbcd0 8891
41e2b43e
RD
8892 Sets the style of the window. Please note that some styles cannot be
8893 changed after the window creation and that Refresh() might need to be
8894 called after changing the others for the change to take place
8895 immediately.
15afbcd0 8896 """
54f9ee45 8897 return _core_.Window_SetWindowStyleFlag(*args, **kwargs)
e811c8ce
RD
8898
8899 def GetWindowStyleFlag(*args, **kwargs):
15afbcd0 8900 """
a95a7133 8901 GetWindowStyleFlag(self) -> long
e811c8ce 8902
15afbcd0
RD
8903 Gets the window style that was passed to the constructor or Create
8904 method.
8905 """
54f9ee45 8906 return _core_.Window_GetWindowStyleFlag(*args, **kwargs)
e811c8ce 8907
15afbcd0 8908 SetWindowStyle = SetWindowStyleFlag; GetWindowStyle = GetWindowStyleFlag
e811c8ce 8909 def HasFlag(*args, **kwargs):
15afbcd0 8910 """
a95a7133 8911 HasFlag(self, int flag) -> bool
15afbcd0
RD
8912
8913 Test if the given style is set for this window.
8914 """
54f9ee45 8915 return _core_.Window_HasFlag(*args, **kwargs)
e811c8ce
RD
8916
8917 def IsRetained(*args, **kwargs):
15afbcd0 8918 """
a95a7133 8919 IsRetained(self) -> bool
15afbcd0
RD
8920
8921 Returns true if the window is retained, false otherwise. Retained
8922 windows are only available on X platforms.
8923 """
54f9ee45 8924 return _core_.Window_IsRetained(*args, **kwargs)
e811c8ce
RD
8925
8926 def SetExtraStyle(*args, **kwargs):
15afbcd0 8927 """
a95a7133 8928 SetExtraStyle(self, long exStyle)
15afbcd0
RD
8929
8930 Sets the extra style bits for the window. Extra styles are the less
8931 often used style bits which can't be set with the constructor or with
8932 SetWindowStyleFlag()
8933 """
54f9ee45 8934 return _core_.Window_SetExtraStyle(*args, **kwargs)
e811c8ce
RD
8935
8936 def GetExtraStyle(*args, **kwargs):
15afbcd0 8937 """
a95a7133 8938 GetExtraStyle(self) -> long
15afbcd0
RD
8939
8940 Returns the extra style bits for the window.
8941 """
54f9ee45 8942 return _core_.Window_GetExtraStyle(*args, **kwargs)
e811c8ce
RD
8943
8944 def MakeModal(*args, **kwargs):
15afbcd0 8945 """
a95a7133 8946 MakeModal(self, bool modal=True)
15afbcd0
RD
8947
8948 Disables all other windows in the application so that the user can
8949 only interact with this window. Passing False will reverse this
8950 effect.
8951 """
54f9ee45 8952 return _core_.Window_MakeModal(*args, **kwargs)
e811c8ce
RD
8953
8954 def SetThemeEnabled(*args, **kwargs):
15afbcd0 8955 """
a95a7133 8956 SetThemeEnabled(self, bool enableTheme)
15afbcd0
RD
8957
8958 This function tells a window if it should use the system's "theme"
8959 code to draw the windows' background instead if its own background
8960 drawing code. This will only have an effect on platforms that support
8961 the notion of themes in user defined windows. One such platform is
8962 GTK+ where windows can have (very colourful) backgrounds defined by a
8963 user's selected theme.
8964
8965 Dialogs, notebook pages and the status bar have this flag set to true
8966 by default so that the default look and feel is simulated best.
8967 """
54f9ee45 8968 return _core_.Window_SetThemeEnabled(*args, **kwargs)
e811c8ce
RD
8969
8970 def GetThemeEnabled(*args, **kwargs):
15afbcd0 8971 """
a95a7133 8972 GetThemeEnabled(self) -> bool
e811c8ce 8973
15afbcd0
RD
8974 Return the themeEnabled flag.
8975 """
54f9ee45 8976 return _core_.Window_GetThemeEnabled(*args, **kwargs)
e811c8ce
RD
8977
8978 def SetFocus(*args, **kwargs):
15afbcd0 8979 """
a95a7133 8980 SetFocus(self)
15afbcd0
RD
8981
8982 Set's the focus to this window, allowing it to receive keyboard input.
8983 """
54f9ee45 8984 return _core_.Window_SetFocus(*args, **kwargs)
e811c8ce
RD
8985
8986 def SetFocusFromKbd(*args, **kwargs):
15afbcd0 8987 """
a95a7133 8988 SetFocusFromKbd(self)
15afbcd0
RD
8989
8990 Set focus to this window as the result of a keyboard action. Normally
8991 only called internally.
8992 """
54f9ee45 8993 return _core_.Window_SetFocusFromKbd(*args, **kwargs)
e811c8ce
RD
8994
8995 def FindFocus(*args, **kwargs):
15afbcd0 8996 """
66c033b4 8997 FindFocus() -> Window
15afbcd0
RD
8998
8999 Returns the window or control that currently has the keyboard focus,
9000 or None.
9001 """
54f9ee45 9002 return _core_.Window_FindFocus(*args, **kwargs)
e811c8ce
RD
9003
9004 FindFocus = staticmethod(FindFocus)
9005 def AcceptsFocus(*args, **kwargs):
15afbcd0 9006 """
a95a7133 9007 AcceptsFocus(self) -> bool
15afbcd0
RD
9008
9009 Can this window have focus?
9010 """
54f9ee45 9011 return _core_.Window_AcceptsFocus(*args, **kwargs)
e811c8ce
RD
9012
9013 def AcceptsFocusFromKeyboard(*args, **kwargs):
15afbcd0 9014 """
a95a7133 9015 AcceptsFocusFromKeyboard(self) -> bool
15afbcd0
RD
9016
9017 Can this window be given focus by keyboard navigation? if not, the
9018 only way to give it focus (provided it accepts it at all) is to click
9019 it.
9020 """
54f9ee45 9021 return _core_.Window_AcceptsFocusFromKeyboard(*args, **kwargs)
e811c8ce 9022
908b74cd
RD
9023 def Navigate(*args, **kwargs):
9024 """
9025 Navigate(self, int flags=NavigationKeyEvent.IsForward) -> bool
9026
fd2dc343
RD
9027 Does keyboard navigation from this window to another, by sending a
9028 `wx.NavigationKeyEvent`.
908b74cd
RD
9029 """
9030 return _core_.Window_Navigate(*args, **kwargs)
9031
7f98d120
RD
9032 def MoveAfterInTabOrder(*args, **kwargs):
9033 """
9034 MoveAfterInTabOrder(self, Window win)
9035
9036 Moves this window in the tab navigation order after the specified
9037 sibling window. This means that when the user presses the TAB key on
9038 that other window, the focus switches to this window.
9039
9040 The default tab order is the same as creation order. This function
9041 and `MoveBeforeInTabOrder` allow to change it after creating all the
9042 windows.
9043
9044 """
9045 return _core_.Window_MoveAfterInTabOrder(*args, **kwargs)
9046
9047 def MoveBeforeInTabOrder(*args, **kwargs):
9048 """
9049 MoveBeforeInTabOrder(self, Window win)
9050
9051 Same as `MoveAfterInTabOrder` except that it inserts this window just
9052 before win instead of putting it right after it.
9053 """
9054 return _core_.Window_MoveBeforeInTabOrder(*args, **kwargs)
9055
e811c8ce 9056 def GetChildren(*args, **kwargs):
15afbcd0 9057 """
a95a7133 9058 GetChildren(self) -> PyObject
15afbcd0
RD
9059
9060 Returns a list of the window's children. NOTE: Currently this is a
9061 copy of the child window list maintained by the window, so the return
9062 value of this function is only valid as long as the window's children
9063 do not change.
9064 """
54f9ee45 9065 return _core_.Window_GetChildren(*args, **kwargs)
e811c8ce
RD
9066
9067 def GetParent(*args, **kwargs):
15afbcd0 9068 """
a95a7133 9069 GetParent(self) -> Window
15afbcd0
RD
9070
9071 Returns the parent window of this window, or None if there isn't one.
9072 """
54f9ee45 9073 return _core_.Window_GetParent(*args, **kwargs)
e811c8ce
RD
9074
9075 def GetGrandParent(*args, **kwargs):
15afbcd0 9076 """
a95a7133 9077 GetGrandParent(self) -> Window
15afbcd0 9078
41e2b43e
RD
9079 Returns the parent of the parent of this window, or None if there
9080 isn't one.
15afbcd0 9081 """
54f9ee45 9082 return _core_.Window_GetGrandParent(*args, **kwargs)
e811c8ce
RD
9083
9084 def IsTopLevel(*args, **kwargs):
15afbcd0 9085 """
a95a7133 9086 IsTopLevel(self) -> bool
15afbcd0
RD
9087
9088 Returns true if the given window is a top-level one. Currently all
9089 frames and dialogs are always considered to be top-level windows (even
9090 if they have a parent window).
9091 """
54f9ee45 9092 return _core_.Window_IsTopLevel(*args, **kwargs)
e811c8ce
RD
9093
9094 def Reparent(*args, **kwargs):
15afbcd0 9095 """
a95a7133 9096 Reparent(self, Window newParent) -> bool
15afbcd0
RD
9097
9098 Reparents the window, i.e the window will be removed from its current
9099 parent window (e.g. a non-standard toolbar in a wxFrame) and then
9100 re-inserted into another. Available on Windows and GTK. Returns True
9101 if the parent was changed, False otherwise (error or newParent ==
9102 oldParent)
9103 """
54f9ee45 9104 return _core_.Window_Reparent(*args, **kwargs)
e811c8ce
RD
9105
9106 def AddChild(*args, **kwargs):
15afbcd0 9107 """
a95a7133 9108 AddChild(self, Window child)
15afbcd0
RD
9109
9110 Adds a child window. This is called automatically by window creation
9111 functions so should not be required by the application programmer.
9112 """
54f9ee45 9113 return _core_.Window_AddChild(*args, **kwargs)
e811c8ce
RD
9114
9115 def RemoveChild(*args, **kwargs):
15afbcd0 9116 """
a95a7133 9117 RemoveChild(self, Window child)
15afbcd0
RD
9118
9119 Removes a child window. This is called automatically by window
9120 deletion functions so should not be required by the application
9121 programmer.
9122 """
54f9ee45 9123 return _core_.Window_RemoveChild(*args, **kwargs)
e811c8ce 9124
704eda0c
RD
9125 def SetDoubleBuffered(*args, **kwargs):
9126 """
9127 SetDoubleBuffered(self, bool on)
9128
9129 Currently wxGTK2 only.
9130 """
9131 return _core_.Window_SetDoubleBuffered(*args, **kwargs)
9132
e811c8ce 9133 def FindWindowById(*args, **kwargs):
15afbcd0 9134 """
a95a7133 9135 FindWindowById(self, long winid) -> Window
15afbcd0
RD
9136
9137 Find a chld of this window by window ID
9138 """
54f9ee45 9139 return _core_.Window_FindWindowById(*args, **kwargs)
e811c8ce
RD
9140
9141 def FindWindowByName(*args, **kwargs):
15afbcd0 9142 """
a95a7133 9143 FindWindowByName(self, String name) -> Window
15afbcd0
RD
9144
9145 Find a child of this window by name
9146 """
54f9ee45 9147 return _core_.Window_FindWindowByName(*args, **kwargs)
e811c8ce
RD
9148
9149 def GetEventHandler(*args, **kwargs):
15afbcd0 9150 """
a95a7133 9151 GetEventHandler(self) -> EvtHandler
15afbcd0
RD
9152
9153 Returns the event handler for this window. By default, the window is
9154 its own event handler.
9155 """
54f9ee45 9156 return _core_.Window_GetEventHandler(*args, **kwargs)
e811c8ce
RD
9157
9158 def SetEventHandler(*args, **kwargs):
15afbcd0 9159 """
a95a7133 9160 SetEventHandler(self, EvtHandler handler)
15afbcd0
RD
9161
9162 Sets the event handler for this window. An event handler is an object
d49bdf34
RD
9163 that is capable of processing the events sent to a window. (In other
9164 words, is able to dispatch the events to handler function.) By
9165 default, the window is its own event handler, but an application may
9166 wish to substitute another, for example to allow central
9167 implementation of event-handling for a variety of different window
9168 classes.
15afbcd0 9169
41e2b43e 9170 It is usually better to use `wx.Window.PushEventHandler` since this sets
15afbcd0 9171 up a chain of event handlers, where an event not handled by one event
d49bdf34 9172 handler is handed off to the next one in the chain.
15afbcd0 9173 """
54f9ee45 9174 return _core_.Window_SetEventHandler(*args, **kwargs)
e811c8ce
RD
9175
9176 def PushEventHandler(*args, **kwargs):
15afbcd0 9177 """
a95a7133 9178 PushEventHandler(self, EvtHandler handler)
15afbcd0
RD
9179
9180 Pushes this event handler onto the event handler stack for the window.
9181 An event handler is an object that is capable of processing the events
d49bdf34
RD
9182 sent to a window. (In other words, is able to dispatch the events to
9183 handler function.) By default, the window is its own event handler,
9184 but an application may wish to substitute another, for example to
9185 allow central implementation of event-handling for a variety of
9186 different window classes.
15afbcd0
RD
9187
9188 wx.Window.PushEventHandler allows an application to set up a chain of
9189 event handlers, where an event not handled by one event handler is
d49bdf34
RD
9190 handed to the next one in the chain. Use `wx.Window.PopEventHandler`
9191 to remove the event handler. Ownership of the handler is *not* given
9192 to the window, so you should be sure to pop the handler before the
9193 window is destroyed and either let PopEventHandler destroy it, or call
9194 its Destroy method yourself.
15afbcd0 9195 """
54f9ee45 9196 return _core_.Window_PushEventHandler(*args, **kwargs)
e811c8ce
RD
9197
9198 def PopEventHandler(*args, **kwargs):
15afbcd0 9199 """
a95a7133 9200 PopEventHandler(self, bool deleteHandler=False) -> EvtHandler
15afbcd0
RD
9201
9202 Removes and returns the top-most event handler on the event handler
9203 stack. If deleteHandler is True then the wx.EvtHandler object will be
d49bdf34 9204 destroyed after it is popped, and ``None`` will be returned instead.
15afbcd0 9205 """
54f9ee45 9206 return _core_.Window_PopEventHandler(*args, **kwargs)
e811c8ce
RD
9207
9208 def RemoveEventHandler(*args, **kwargs):
15afbcd0 9209 """
a95a7133 9210 RemoveEventHandler(self, EvtHandler handler) -> bool
15afbcd0 9211
41e2b43e 9212 Find the given handler in the event handler chain and remove (but not
d49bdf34 9213 delete) it from the event handler chain, returns True if it was found
41e2b43e
RD
9214 and False otherwise (this also results in an assert failure so this
9215 function should only be called when the handler is supposed to be
9216 there.)
15afbcd0 9217 """
54f9ee45 9218 return _core_.Window_RemoveEventHandler(*args, **kwargs)
e811c8ce
RD
9219
9220 def SetValidator(*args, **kwargs):
15afbcd0 9221 """
a95a7133 9222 SetValidator(self, Validator validator)
15afbcd0
RD
9223
9224 Deletes the current validator (if any) and sets the window validator,
9225 having called wx.Validator.Clone to create a new validator of this
9226 type.
9227 """
54f9ee45 9228 return _core_.Window_SetValidator(*args, **kwargs)
e811c8ce
RD
9229
9230 def GetValidator(*args, **kwargs):
15afbcd0 9231 """
a95a7133 9232 GetValidator(self) -> Validator
15afbcd0
RD
9233
9234 Returns a pointer to the current validator for the window, or None if
9235 there is none.
9236 """
54f9ee45 9237 return _core_.Window_GetValidator(*args, **kwargs)
e811c8ce 9238
74a57fcd
RD
9239 def Validate(*args, **kwargs):
9240 """
a95a7133 9241 Validate(self) -> bool
74a57fcd
RD
9242
9243 Validates the current values of the child controls using their
41e2b43e
RD
9244 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
9245 style flag set, the method will also call Validate() of all child
9246 windows. Returns false if any of the validations failed.
74a57fcd 9247 """
54f9ee45 9248 return _core_.Window_Validate(*args, **kwargs)
74a57fcd
RD
9249
9250 def TransferDataToWindow(*args, **kwargs):
9251 """
a95a7133 9252 TransferDataToWindow(self) -> bool
74a57fcd 9253
41e2b43e
RD
9254 Transfers values to child controls from data areas specified by their
9255 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
9256 style flag set, the method will also call TransferDataToWindow() of
9257 all child windows.
74a57fcd 9258 """
54f9ee45 9259 return _core_.Window_TransferDataToWindow(*args, **kwargs)
74a57fcd
RD
9260
9261 def TransferDataFromWindow(*args, **kwargs):
9262 """
a95a7133 9263 TransferDataFromWindow(self) -> bool
74a57fcd 9264
41e2b43e
RD
9265 Transfers values from child controls to data areas specified by their
9266 validators. Returns false if a transfer failed. If the window has
9267 wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will
9268 also call TransferDataFromWindow() of all child windows.
74a57fcd 9269 """
54f9ee45 9270 return _core_.Window_TransferDataFromWindow(*args, **kwargs)
74a57fcd
RD
9271
9272 def InitDialog(*args, **kwargs):
9273 """
a95a7133 9274 InitDialog(self)
74a57fcd 9275
41e2b43e
RD
9276 Sends an EVT_INIT_DIALOG event, whose handler usually transfers data
9277 to the dialog via validators.
74a57fcd 9278 """
54f9ee45 9279 return _core_.Window_InitDialog(*args, **kwargs)
74a57fcd 9280
e811c8ce 9281 def SetAcceleratorTable(*args, **kwargs):
15afbcd0 9282 """
a95a7133 9283 SetAcceleratorTable(self, AcceleratorTable accel)
15afbcd0
RD
9284
9285 Sets the accelerator table for this window.
9286 """
54f9ee45 9287 return _core_.Window_SetAcceleratorTable(*args, **kwargs)
e811c8ce
RD
9288
9289 def GetAcceleratorTable(*args, **kwargs):
15afbcd0 9290 """
a95a7133 9291 GetAcceleratorTable(self) -> AcceleratorTable
15afbcd0
RD
9292
9293 Gets the accelerator table for this window.
9294 """
54f9ee45 9295 return _core_.Window_GetAcceleratorTable(*args, **kwargs)
e811c8ce
RD
9296
9297 def RegisterHotKey(*args, **kwargs):
15afbcd0 9298 """
a95a7133 9299 RegisterHotKey(self, int hotkeyId, int modifiers, int keycode) -> bool
15afbcd0
RD
9300
9301 Registers a system wide hotkey. Every time the user presses the hotkey
9302 registered here, this window will receive a hotkey event. It will
9303 receive the event even if the application is in the background and
9304 does not have the input focus because the user is working with some
9305 other application. To bind an event handler function to this hotkey
9306 use EVT_HOTKEY with an id equal to hotkeyId. Returns True if the
9307 hotkey was registered successfully.
9308 """
54f9ee45 9309 return _core_.Window_RegisterHotKey(*args, **kwargs)
e811c8ce
RD
9310
9311 def UnregisterHotKey(*args, **kwargs):
15afbcd0 9312 """
a95a7133 9313 UnregisterHotKey(self, int hotkeyId) -> bool
15afbcd0
RD
9314
9315 Unregisters a system wide hotkey.
9316 """
54f9ee45 9317 return _core_.Window_UnregisterHotKey(*args, **kwargs)
e811c8ce
RD
9318
9319 def ConvertDialogPointToPixels(*args, **kwargs):
15afbcd0 9320 """
a95a7133 9321 ConvertDialogPointToPixels(self, Point pt) -> Point
15afbcd0
RD
9322
9323 Converts a point or size from dialog units to pixels. Dialog units
9324 are used for maintaining a dialog's proportions even if the font
9325 changes. For the x dimension, the dialog units are multiplied by the
9326 average character width and then divided by 4. For the y dimension,
9327 the dialog units are multiplied by the average character height and
9328 then divided by 8.
9329 """
54f9ee45 9330 return _core_.Window_ConvertDialogPointToPixels(*args, **kwargs)
e811c8ce
RD
9331
9332 def ConvertDialogSizeToPixels(*args, **kwargs):
15afbcd0 9333 """
a95a7133 9334 ConvertDialogSizeToPixels(self, Size sz) -> Size
15afbcd0
RD
9335
9336 Converts a point or size from dialog units to pixels. Dialog units
9337 are used for maintaining a dialog's proportions even if the font
9338 changes. For the x dimension, the dialog units are multiplied by the
9339 average character width and then divided by 4. For the y dimension,
9340 the dialog units are multiplied by the average character height and
9341 then divided by 8.
9342 """
54f9ee45 9343 return _core_.Window_ConvertDialogSizeToPixels(*args, **kwargs)
e811c8ce
RD
9344
9345 def DLG_PNT(*args, **kwargs):
15afbcd0 9346 """
a95a7133 9347 DLG_PNT(self, Point pt) -> Point
15afbcd0
RD
9348
9349 Converts a point or size from dialog units to pixels. Dialog units
9350 are used for maintaining a dialog's proportions even if the font
9351 changes. For the x dimension, the dialog units are multiplied by the
9352 average character width and then divided by 4. For the y dimension,
9353 the dialog units are multiplied by the average character height and
9354 then divided by 8.
9355 """
54f9ee45 9356 return _core_.Window_DLG_PNT(*args, **kwargs)
e811c8ce
RD
9357
9358 def DLG_SZE(*args, **kwargs):
15afbcd0 9359 """
a95a7133 9360 DLG_SZE(self, Size sz) -> Size
15afbcd0
RD
9361
9362 Converts a point or size from dialog units to pixels. Dialog units
9363 are used for maintaining a dialog's proportions even if the font
9364 changes. For the x dimension, the dialog units are multiplied by the
9365 average character width and then divided by 4. For the y dimension,
9366 the dialog units are multiplied by the average character height and
9367 then divided by 8.
9368 """
54f9ee45 9369 return _core_.Window_DLG_SZE(*args, **kwargs)
e811c8ce
RD
9370
9371 def ConvertPixelPointToDialog(*args, **kwargs):
a95a7133 9372 """ConvertPixelPointToDialog(self, Point pt) -> Point"""
54f9ee45 9373 return _core_.Window_ConvertPixelPointToDialog(*args, **kwargs)
e811c8ce
RD
9374
9375 def ConvertPixelSizeToDialog(*args, **kwargs):
a95a7133 9376 """ConvertPixelSizeToDialog(self, Size sz) -> Size"""
54f9ee45 9377 return _core_.Window_ConvertPixelSizeToDialog(*args, **kwargs)
e811c8ce
RD
9378
9379 def WarpPointer(*args, **kwargs):
15afbcd0 9380 """
a95a7133 9381 WarpPointer(self, int x, int y)
15afbcd0
RD
9382
9383 Moves the pointer to the given position on the window.
9384
9385 NOTE: This function is not supported under Mac because Apple Human
9386 Interface Guidelines forbid moving the mouse cursor programmatically.
9387 """
54f9ee45 9388 return _core_.Window_WarpPointer(*args, **kwargs)
e811c8ce
RD
9389
9390 def CaptureMouse(*args, **kwargs):
15afbcd0 9391 """
a95a7133 9392 CaptureMouse(self)
15afbcd0
RD
9393
9394 Directs all mouse input to this window. Call wx.Window.ReleaseMouse to
9395 release the capture.
9396
9397 Note that wxWindows maintains the stack of windows having captured the
9398 mouse and when the mouse is released the capture returns to the window
9399 which had had captured it previously and it is only really released if
9400 there were no previous window. In particular, this means that you must
34e0a3bb
RD
9401 release the mouse as many times as you capture it, unless the window
9402 receives the `wx.MouseCaptureLostEvent` event.
9403
9404 Any application which captures the mouse in the beginning of some
9405 operation *must* handle `wx.MouseCaptureLostEvent` and cancel this
9406 operation when it receives the event. The event handler must not
9407 recapture mouse.
15afbcd0 9408 """
54f9ee45 9409 return _core_.Window_CaptureMouse(*args, **kwargs)
e811c8ce
RD
9410
9411 def ReleaseMouse(*args, **kwargs):
15afbcd0 9412 """
a95a7133 9413 ReleaseMouse(self)
15afbcd0
RD
9414
9415 Releases mouse input captured with wx.Window.CaptureMouse.
9416 """
54f9ee45 9417 return _core_.Window_ReleaseMouse(*args, **kwargs)
e811c8ce
RD
9418
9419 def GetCapture(*args, **kwargs):
15afbcd0 9420 """
66c033b4 9421 GetCapture() -> Window
15afbcd0
RD
9422
9423 Returns the window which currently captures the mouse or None
9424 """
54f9ee45 9425 return _core_.Window_GetCapture(*args, **kwargs)
e811c8ce
RD
9426
9427 GetCapture = staticmethod(GetCapture)
9428 def HasCapture(*args, **kwargs):
15afbcd0 9429 """
a95a7133 9430 HasCapture(self) -> bool
15afbcd0
RD
9431
9432 Returns true if this window has the current mouse capture.
9433 """
54f9ee45 9434 return _core_.Window_HasCapture(*args, **kwargs)
e811c8ce
RD
9435
9436 def Refresh(*args, **kwargs):
15afbcd0 9437 """
a95a7133 9438 Refresh(self, bool eraseBackground=True, Rect rect=None)
15afbcd0
RD
9439
9440 Mark the specified rectangle (or the whole window) as "dirty" so it
9441 will be repainted. Causes an EVT_PAINT event to be generated and sent
9442 to the window.
9443 """
54f9ee45 9444 return _core_.Window_Refresh(*args, **kwargs)
e811c8ce
RD
9445
9446 def RefreshRect(*args, **kwargs):
15afbcd0 9447 """
fef4c27a 9448 RefreshRect(self, Rect rect, bool eraseBackground=True)
15afbcd0
RD
9449
9450 Redraws the contents of the given rectangle: the area inside it will
9451 be repainted. This is the same as Refresh but has a nicer syntax.
9452 """
54f9ee45 9453 return _core_.Window_RefreshRect(*args, **kwargs)
e811c8ce
RD
9454
9455 def Update(*args, **kwargs):
15afbcd0 9456 """
a95a7133 9457 Update(self)
15afbcd0
RD
9458
9459 Calling this method immediately repaints the invalidated area of the
9460 window instead of waiting for the EVT_PAINT event to happen, (normally
9461 this would usually only happen when the flow of control returns to the
9462 event loop.) Notice that this function doesn't refresh the window and
9b940138 9463 does nothing if the window has been already repainted. Use `Refresh`
15afbcd0
RD
9464 first if you want to immediately redraw the window (or some portion of
9465 it) unconditionally.
9466 """
54f9ee45 9467 return _core_.Window_Update(*args, **kwargs)
e811c8ce
RD
9468
9469 def ClearBackground(*args, **kwargs):
15afbcd0 9470 """
a95a7133 9471 ClearBackground(self)
15afbcd0
RD
9472
9473 Clears the window by filling it with the current background
9474 colour. Does not cause an erase background event to be generated.
9475 """
54f9ee45 9476 return _core_.Window_ClearBackground(*args, **kwargs)
e811c8ce
RD
9477
9478 def Freeze(*args, **kwargs):
15afbcd0 9479 """
a95a7133 9480 Freeze(self)
15afbcd0 9481
41e2b43e
RD
9482 Freezes the window or, in other words, prevents any updates from
9483 taking place on screen, the window is not redrawn at all. Thaw must be
9484 called to reenable window redrawing. Calls to Freeze/Thaw may be
9485 nested, with the actual Thaw being delayed until all the nesting has
9486 been undone.
15afbcd0
RD
9487
9488 This method is useful for visual appearance optimization (for example,
9489 it is a good idea to use it before inserting large amount of text into
9490 a wxTextCtrl under wxGTK) but is not implemented on all platforms nor
9491 for all controls so it is mostly just a hint to wxWindows and not a
9492 mandatory directive.
9493 """
54f9ee45 9494 return _core_.Window_Freeze(*args, **kwargs)
e811c8ce 9495
33d6fd3b
RD
9496 def IsFrozen(*args, **kwargs):
9497 """
9498 IsFrozen(self) -> bool
9499
9500 Returns ``True`` if the window has been frozen and not thawed yet.
9501
9502 :see: `Freeze` and `Thaw`
9503 """
9504 return _core_.Window_IsFrozen(*args, **kwargs)
9505
e811c8ce 9506 def Thaw(*args, **kwargs):
15afbcd0 9507 """
a95a7133 9508 Thaw(self)
15afbcd0 9509
4276dc52 9510 Reenables window updating after a previous call to Freeze. Calls to
41e2b43e
RD
9511 Freeze/Thaw may be nested, so Thaw must be called the same number of
9512 times that Freeze was before the window will be updated.
15afbcd0 9513 """
54f9ee45 9514 return _core_.Window_Thaw(*args, **kwargs)
e811c8ce
RD
9515
9516 def PrepareDC(*args, **kwargs):
15afbcd0 9517 """
a95a7133 9518 PrepareDC(self, DC dc)
15afbcd0
RD
9519
9520 Call this function to prepare the device context for drawing a
9521 scrolled image. It sets the device origin according to the current
9522 scroll position.
9523 """
54f9ee45 9524 return _core_.Window_PrepareDC(*args, **kwargs)
e811c8ce 9525
b39fe951
RD
9526 def IsDoubleBuffered(*args, **kwargs):
9527 """
9528 IsDoubleBuffered(self) -> bool
9529
9530 Returns ``True`` if the window contents is double-buffered by the
9531 system, i.e. if any drawing done on the window is really done on a
9532 temporary backing surface and transferred to the screen all at once
9533 later.
9534 """
9535 return _core_.Window_IsDoubleBuffered(*args, **kwargs)
9536
e811c8ce 9537 def GetUpdateRegion(*args, **kwargs):
15afbcd0 9538 """
a95a7133 9539 GetUpdateRegion(self) -> Region
15afbcd0
RD
9540
9541 Returns the region specifying which parts of the window have been
9542 damaged. Should only be called within an EVT_PAINT handler.
9543 """
54f9ee45 9544 return _core_.Window_GetUpdateRegion(*args, **kwargs)
e811c8ce
RD
9545
9546 def GetUpdateClientRect(*args, **kwargs):
15afbcd0 9547 """
a95a7133 9548 GetUpdateClientRect(self) -> Rect
15afbcd0
RD
9549
9550 Get the update rectangle region bounding box in client coords.
9551 """
54f9ee45 9552 return _core_.Window_GetUpdateClientRect(*args, **kwargs)
e811c8ce
RD
9553
9554 def IsExposed(*args, **kwargs):
15afbcd0 9555 """
a95a7133 9556 IsExposed(self, int x, int y, int w=1, int h=1) -> bool
15afbcd0
RD
9557
9558 Returns true if the given point or rectangle area has been exposed
9559 since the last repaint. Call this in an paint event handler to
9560 optimize redrawing by only redrawing those areas, which have been
9561 exposed.
9562 """
54f9ee45 9563 return _core_.Window_IsExposed(*args, **kwargs)
e811c8ce
RD
9564
9565 def IsExposedPoint(*args, **kwargs):
15afbcd0 9566 """
a95a7133 9567 IsExposedPoint(self, Point pt) -> bool
15afbcd0
RD
9568
9569 Returns true if the given point or rectangle area has been exposed
9570 since the last repaint. Call this in an paint event handler to
9571 optimize redrawing by only redrawing those areas, which have been
9572 exposed.
9573 """
54f9ee45 9574 return _core_.Window_IsExposedPoint(*args, **kwargs)
e811c8ce 9575
4276dc52 9576 def IsExposedRect(*args, **kwargs):
15afbcd0 9577 """
a95a7133 9578 IsExposedRect(self, Rect rect) -> bool
15afbcd0
RD
9579
9580 Returns true if the given point or rectangle area has been exposed
9581 since the last repaint. Call this in an paint event handler to
9582 optimize redrawing by only redrawing those areas, which have been
9583 exposed.
9584 """
54f9ee45 9585 return _core_.Window_IsExposedRect(*args, **kwargs)
e811c8ce 9586
74a57fcd
RD
9587 def GetDefaultAttributes(*args, **kwargs):
9588 """
a95a7133 9589 GetDefaultAttributes(self) -> VisualAttributes
74a57fcd 9590
41e2b43e
RD
9591 Get the default attributes for an instance of this class. This is
9592 useful if you want to use the same font or colour in your own control
9593 as in a standard control -- which is a much better idea than hard
9594 coding specific colours or fonts which might look completely out of
db3e571a 9595 place on the user's system, especially if it uses themes.
74a57fcd 9596 """
54f9ee45 9597 return _core_.Window_GetDefaultAttributes(*args, **kwargs)
74a57fcd
RD
9598
9599 def GetClassDefaultAttributes(*args, **kwargs):
9600 """
66c033b4 9601 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
74a57fcd 9602
41e2b43e
RD
9603 Get the default attributes for this class. This is useful if you want
9604 to use the same font or colour in your own control as in a standard
9605 control -- which is a much better idea than hard coding specific
db3e571a
RD
9606 colours or fonts which might look completely out of place on the
9607 user's system, especially if it uses themes.
74a57fcd
RD
9608
9609 The variant parameter is only relevant under Mac currently and is
41e2b43e 9610 ignore under other platforms. Under Mac, it will change the size of
db3e571a
RD
9611 the returned font. See `wx.Window.SetWindowVariant` for more about
9612 this.
74a57fcd 9613 """
54f9ee45 9614 return _core_.Window_GetClassDefaultAttributes(*args, **kwargs)
74a57fcd
RD
9615
9616 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
e811c8ce 9617 def SetBackgroundColour(*args, **kwargs):
15afbcd0 9618 """
a95a7133 9619 SetBackgroundColour(self, Colour colour) -> bool
15afbcd0
RD
9620
9621 Sets the background colour of the window. Returns True if the colour
9622 was changed. The background colour is usually painted by the default
9623 EVT_ERASE_BACKGROUND event handler function under Windows and
f8167d6e
RD
9624 automatically under GTK. Using `wx.NullColour` will reset the window
9625 to the default background colour.
15afbcd0 9626
db3e571a 9627 Note that setting the background colour may not cause an immediate
f8167d6e 9628 refresh, so you may wish to call `ClearBackground` or `Refresh` after
15afbcd0
RD
9629 calling this function.
9630
f8167d6e
RD
9631 Using this function will disable attempts to use themes for this
9632 window, if the system supports them. Use with care since usually the
9633 themes represent the appearance chosen by the user to be used for all
9634 applications on the system.
15afbcd0 9635 """
54f9ee45 9636 return _core_.Window_SetBackgroundColour(*args, **kwargs)
e811c8ce 9637
412d302d
RD
9638 def SetOwnBackgroundColour(*args, **kwargs):
9639 """SetOwnBackgroundColour(self, Colour colour)"""
9640 return _core_.Window_SetOwnBackgroundColour(*args, **kwargs)
b2df227b 9641
e811c8ce 9642 def SetForegroundColour(*args, **kwargs):
15afbcd0 9643 """
a95a7133 9644 SetForegroundColour(self, Colour colour) -> bool
15afbcd0
RD
9645
9646 Sets the foreground colour of the window. Returns True is the colour
9647 was changed. The interpretation of foreground colour is dependent on
9648 the window class; it may be the text colour or other colour, or it may
9649 not be used at all.
9650 """
54f9ee45 9651 return _core_.Window_SetForegroundColour(*args, **kwargs)
e811c8ce 9652
fa47d7a7
VS
9653 def SetOwnForegroundColour(*args, **kwargs):
9654 """SetOwnForegroundColour(self, Colour colour)"""
9655 return _core_.Window_SetOwnForegroundColour(*args, **kwargs)
b2df227b 9656
e811c8ce 9657 def GetBackgroundColour(*args, **kwargs):
15afbcd0 9658 """
a95a7133 9659 GetBackgroundColour(self) -> Colour
15afbcd0
RD
9660
9661 Returns the background colour of the window.
9662 """
54f9ee45 9663 return _core_.Window_GetBackgroundColour(*args, **kwargs)
e811c8ce
RD
9664
9665 def GetForegroundColour(*args, **kwargs):
15afbcd0 9666 """
a95a7133 9667 GetForegroundColour(self) -> Colour
15afbcd0
RD
9668
9669 Returns the foreground colour of the window. The interpretation of
9670 foreground colour is dependent on the window class; it may be the text
9671 colour or other colour, or it may not be used at all.
9672 """
54f9ee45 9673 return _core_.Window_GetForegroundColour(*args, **kwargs)
e811c8ce 9674
562ecc31
RD
9675 def InheritsBackgroundColour(*args, **kwargs):
9676 """InheritsBackgroundColour(self) -> bool"""
9677 return _core_.Window_InheritsBackgroundColour(*args, **kwargs)
9678
9679 def UseBgCol(*args, **kwargs):
9680 """UseBgCol(self) -> bool"""
9681 return _core_.Window_UseBgCol(*args, **kwargs)
9682
7bc1e663
RD
9683 def SetBackgroundStyle(*args, **kwargs):
9684 """
9685 SetBackgroundStyle(self, int style) -> bool
9686
9687 Returns the background style of the window. The background style
9688 indicates how the background of the window is drawn.
9689
9690 ====================== ========================================
9691 wx.BG_STYLE_SYSTEM The background colour or pattern should
9692 be determined by the system
9693 wx.BG_STYLE_COLOUR The background should be a solid colour
9694 wx.BG_STYLE_CUSTOM The background will be implemented by the
9695 application.
9696 ====================== ========================================
9697
9698 On GTK+, use of wx.BG_STYLE_CUSTOM allows the flicker-free drawing of
9699 a custom background, such as a tiled bitmap. Currently the style has
9700 no effect on other platforms.
9701
9702 :see: `GetBackgroundStyle`, `SetBackgroundColour`
9703 """
9704 return _core_.Window_SetBackgroundStyle(*args, **kwargs)
9705
9706 def GetBackgroundStyle(*args, **kwargs):
9707 """
9708 GetBackgroundStyle(self) -> int
9709
9710 Returns the background style of the window.
9711
9712 :see: `SetBackgroundStyle`
9713 """
9714 return _core_.Window_GetBackgroundStyle(*args, **kwargs)
9715
51b83b37
RD
9716 def HasTransparentBackground(*args, **kwargs):
9717 """
9718 HasTransparentBackground(self) -> bool
9719
9720 Returns True if this window's background is transparent (as, for
9721 example, for `wx.StaticText`) and should show the parent window's
9722 background.
9723
9724 This method is mostly used internally by the library itself and you
9725 normally shouldn't have to call it. You may, however, have to override
9726 it in your custom control classes to ensure that background is painted
9727 correctly.
9728 """
9729 return _core_.Window_HasTransparentBackground(*args, **kwargs)
9730
e811c8ce 9731 def SetCursor(*args, **kwargs):
15afbcd0 9732 """
a95a7133 9733 SetCursor(self, Cursor cursor) -> bool
15afbcd0
RD
9734
9735 Sets the window's cursor. Notice that the window cursor also sets it
9736 for the children of the window implicitly.
9737
9738 The cursor may be wx.NullCursor in which case the window cursor will
9739 be reset back to default.
9740 """
54f9ee45 9741 return _core_.Window_SetCursor(*args, **kwargs)
e811c8ce
RD
9742
9743 def GetCursor(*args, **kwargs):
15afbcd0 9744 """
a95a7133 9745 GetCursor(self) -> Cursor
15afbcd0
RD
9746
9747 Return the cursor associated with this window.
9748 """
54f9ee45 9749 return _core_.Window_GetCursor(*args, **kwargs)
e811c8ce
RD
9750
9751 def SetFont(*args, **kwargs):
15afbcd0 9752 """
a95a7133 9753 SetFont(self, Font font) -> bool
15afbcd0
RD
9754
9755 Sets the font for this window.
9756 """
54f9ee45 9757 return _core_.Window_SetFont(*args, **kwargs)
e811c8ce 9758
fa47d7a7
VS
9759 def SetOwnFont(*args, **kwargs):
9760 """SetOwnFont(self, Font font)"""
9761 return _core_.Window_SetOwnFont(*args, **kwargs)
b2df227b 9762
e811c8ce 9763 def GetFont(*args, **kwargs):
15afbcd0 9764 """
a95a7133 9765 GetFont(self) -> Font
15afbcd0 9766
4276dc52 9767 Returns the default font used for this window.
15afbcd0 9768 """
54f9ee45 9769 return _core_.Window_GetFont(*args, **kwargs)
e811c8ce
RD
9770
9771 def SetCaret(*args, **kwargs):
15afbcd0 9772 """
a95a7133 9773 SetCaret(self, Caret caret)
15afbcd0
RD
9774
9775 Sets the caret associated with the window.
9776 """
54f9ee45 9777 return _core_.Window_SetCaret(*args, **kwargs)
e811c8ce
RD
9778
9779 def GetCaret(*args, **kwargs):
15afbcd0 9780 """
a95a7133 9781 GetCaret(self) -> Caret
15afbcd0
RD
9782
9783 Returns the caret associated with the window.
9784 """
54f9ee45 9785 return _core_.Window_GetCaret(*args, **kwargs)
e811c8ce
RD
9786
9787 def GetCharHeight(*args, **kwargs):
15afbcd0 9788 """
a95a7133 9789 GetCharHeight(self) -> int
15afbcd0
RD
9790
9791 Get the (average) character size for the current font.
9792 """
54f9ee45 9793 return _core_.Window_GetCharHeight(*args, **kwargs)
e811c8ce
RD
9794
9795 def GetCharWidth(*args, **kwargs):
15afbcd0 9796 """
a95a7133 9797 GetCharWidth(self) -> int
15afbcd0
RD
9798
9799 Get the (average) character size for the current font.
9800 """
54f9ee45 9801 return _core_.Window_GetCharWidth(*args, **kwargs)
e811c8ce
RD
9802
9803 def GetTextExtent(*args, **kwargs):
fd2dc343
RD
9804 """
9805 GetTextExtent(String string) -> (width, height)
9806
9807 Get the width and height of the text using the current font.
9808 """
54f9ee45 9809 return _core_.Window_GetTextExtent(*args, **kwargs)
e811c8ce
RD
9810
9811 def GetFullTextExtent(*args, **kwargs):
0df68c9f 9812 """
196addbf 9813 GetFullTextExtent(String string, Font font=None) ->
0df68c9f 9814 (width, height, descent, externalLeading)
e811c8ce 9815
15afbcd0
RD
9816 Get the width, height, decent and leading of the text using the
9817 current or specified font.
0df68c9f 9818 """
54f9ee45 9819 return _core_.Window_GetFullTextExtent(*args, **kwargs)
e811c8ce
RD
9820
9821 def ClientToScreenXY(*args, **kwargs):
15afbcd0
RD
9822 """
9823 ClientToScreenXY(int x, int y) -> (x,y)
9824
9825 Converts to screen coordinates from coordinates relative to this window.
9826 """
54f9ee45 9827 return _core_.Window_ClientToScreenXY(*args, **kwargs)
e811c8ce
RD
9828
9829 def ScreenToClientXY(*args, **kwargs):
15afbcd0
RD
9830 """
9831 ScreenToClientXY(int x, int y) -> (x,y)
9832
9833 Converts from screen to client window coordinates.
9834 """
54f9ee45 9835 return _core_.Window_ScreenToClientXY(*args, **kwargs)
e811c8ce
RD
9836
9837 def ClientToScreen(*args, **kwargs):
15afbcd0 9838 """
a95a7133 9839 ClientToScreen(self, Point pt) -> Point
15afbcd0
RD
9840
9841 Converts to screen coordinates from coordinates relative to this window.
9842 """
54f9ee45 9843 return _core_.Window_ClientToScreen(*args, **kwargs)
e811c8ce
RD
9844
9845 def ScreenToClient(*args, **kwargs):
15afbcd0 9846 """
a95a7133 9847 ScreenToClient(self, Point pt) -> Point
15afbcd0
RD
9848
9849 Converts from screen to client window coordinates.
9850 """
54f9ee45 9851 return _core_.Window_ScreenToClient(*args, **kwargs)
e811c8ce
RD
9852
9853 def HitTestXY(*args, **kwargs):
15afbcd0 9854 """
a95a7133 9855 HitTestXY(self, int x, int y) -> int
15afbcd0
RD
9856
9857 Test where the given (in client coords) point lies
9858 """
54f9ee45 9859 return _core_.Window_HitTestXY(*args, **kwargs)
e811c8ce
RD
9860
9861 def HitTest(*args, **kwargs):
15afbcd0 9862 """
a95a7133 9863 HitTest(self, Point pt) -> int
15afbcd0
RD
9864
9865 Test where the given (in client coords) point lies
9866 """
54f9ee45 9867 return _core_.Window_HitTest(*args, **kwargs)
e811c8ce 9868
15afbcd0
RD
9869 def GetBorder(*args):
9870 """
a95a7133
RD
9871 GetBorder(self, long flags) -> int
9872 GetBorder(self) -> int
e811c8ce 9873
15afbcd0
RD
9874 Get border for the flags of this window
9875 """
54f9ee45 9876 return _core_.Window_GetBorder(*args)
e811c8ce
RD
9877
9878 def UpdateWindowUI(*args, **kwargs):
15afbcd0 9879 """
a95a7133 9880 UpdateWindowUI(self, long flags=UPDATE_UI_NONE)
15afbcd0
RD
9881
9882 This function sends EVT_UPDATE_UI events to the window. The particular
9883 implementation depends on the window; for example a wx.ToolBar will
9884 send an update UI event for each toolbar button, and a wx.Frame will
9885 send an update UI event for each menubar menu item. You can call this
9886 function from your application to ensure that your UI is up-to-date at
9887 a particular point in time (as far as your EVT_UPDATE_UI handlers are
9888 concerned). This may be necessary if you have called
5ba5649b 9889 `wx.UpdateUIEvent.SetMode` or `wx.UpdateUIEvent.SetUpdateInterval` to
15afbcd0
RD
9890 limit the overhead that wxWindows incurs by sending update UI events
9891 in idle time.
15afbcd0 9892 """
54f9ee45 9893 return _core_.Window_UpdateWindowUI(*args, **kwargs)
e811c8ce
RD
9894
9895 def PopupMenuXY(*args, **kwargs):
15afbcd0 9896 """
b0503257 9897 PopupMenuXY(self, Menu menu, int x=-1, int y=-1) -> bool
15afbcd0 9898
b0503257
RD
9899 Pops up the given menu at the specified coordinates, relative to this window,
9900 and returns control when the user has dismissed the menu. If a menu item is
9901 selected, the corresponding menu event is generated and will be processed as
9902 usual. If the default position is given then the current position of the
9903 mouse cursor will be used.
15afbcd0 9904 """
54f9ee45 9905 return _core_.Window_PopupMenuXY(*args, **kwargs)
e811c8ce 9906
15afbcd0
RD
9907 def PopupMenu(*args, **kwargs):
9908 """
b0503257 9909 PopupMenu(self, Menu menu, Point pos=DefaultPosition) -> bool
15afbcd0 9910
b0503257
RD
9911 Pops up the given menu at the specified coordinates, relative to this window,
9912 and returns control when the user has dismissed the menu. If a menu item is
9913 selected, the corresponding menu event is generated and will be processed as
9914 usual. If the default position is given then the current position of the
9915 mouse cursor will be used.
15afbcd0 9916 """
54f9ee45 9917 return _core_.Window_PopupMenu(*args, **kwargs)
15afbcd0 9918
10044bf1
RD
9919 def HasMultiplePages(*args, **kwargs):
9920 """HasMultiplePages(self) -> bool"""
9921 return _core_.Window_HasMultiplePages(*args, **kwargs)
9922
15afbcd0
RD
9923 def GetHandle(*args, **kwargs):
9924 """
a95a7133 9925 GetHandle(self) -> long
15afbcd0
RD
9926
9927 Returns the platform-specific handle (as a long integer) of the
9928 physical window. Currently on wxMac it returns the handle of the
9929 toplevel parent of the window.
9930 """
54f9ee45 9931 return _core_.Window_GetHandle(*args, **kwargs)
15afbcd0 9932
7e63a440
RD
9933 def AssociateHandle(*args, **kwargs):
9934 """
9935 AssociateHandle(self, long handle)
9936
9937 Associate the window with a new native handle
9938 """
9939 return _core_.Window_AssociateHandle(*args, **kwargs)
9940
9941 def DissociateHandle(*args, **kwargs):
9942 """
9943 DissociateHandle(self)
9944
9945 Dissociate the current native handle from the window
9946 """
9947 return _core_.Window_DissociateHandle(*args, **kwargs)
9948
15afbcd0
RD
9949 def HasScrollbar(*args, **kwargs):
9950 """
a95a7133 9951 HasScrollbar(self, int orient) -> bool
15afbcd0
RD
9952
9953 Does the window have the scrollbar for this orientation?
9954 """
54f9ee45 9955 return _core_.Window_HasScrollbar(*args, **kwargs)
15afbcd0
RD
9956
9957 def SetScrollbar(*args, **kwargs):
9958 """
41e2b43e 9959 SetScrollbar(self, int orientation, int position, int thumbSize, int range,
15afbcd0
RD
9960 bool refresh=True)
9961
9962 Sets the scrollbar properties of a built-in scrollbar.
15afbcd0 9963 """
54f9ee45 9964 return _core_.Window_SetScrollbar(*args, **kwargs)
e811c8ce
RD
9965
9966 def SetScrollPos(*args, **kwargs):
15afbcd0 9967 """
a95a7133 9968 SetScrollPos(self, int orientation, int pos, bool refresh=True)
15afbcd0
RD
9969
9970 Sets the position of one of the built-in scrollbars.
9971 """
54f9ee45 9972 return _core_.Window_SetScrollPos(*args, **kwargs)
e811c8ce
RD
9973
9974 def GetScrollPos(*args, **kwargs):
15afbcd0 9975 """
a95a7133 9976 GetScrollPos(self, int orientation) -> int
15afbcd0
RD
9977
9978 Returns the built-in scrollbar position.
9979 """
54f9ee45 9980 return _core_.Window_GetScrollPos(*args, **kwargs)
e811c8ce
RD
9981
9982 def GetScrollThumb(*args, **kwargs):
15afbcd0 9983 """
a95a7133 9984 GetScrollThumb(self, int orientation) -> int
15afbcd0
RD
9985
9986 Returns the built-in scrollbar thumb size.
9987 """
54f9ee45 9988 return _core_.Window_GetScrollThumb(*args, **kwargs)
e811c8ce
RD
9989
9990 def GetScrollRange(*args, **kwargs):
15afbcd0 9991 """
a95a7133 9992 GetScrollRange(self, int orientation) -> int
15afbcd0
RD
9993
9994 Returns the built-in scrollbar range.
9995 """
54f9ee45 9996 return _core_.Window_GetScrollRange(*args, **kwargs)
e811c8ce
RD
9997
9998 def ScrollWindow(*args, **kwargs):
15afbcd0 9999 """
a95a7133 10000 ScrollWindow(self, int dx, int dy, Rect rect=None)
15afbcd0
RD
10001
10002 Physically scrolls the pixels in the window and move child windows
10003 accordingly. Use this function to optimise your scrolling
10004 implementations, to minimise the area that must be redrawn. Note that
10005 it is rarely required to call this function from a user program.
15afbcd0 10006 """
54f9ee45 10007 return _core_.Window_ScrollWindow(*args, **kwargs)
e811c8ce
RD
10008
10009 def ScrollLines(*args, **kwargs):
15afbcd0 10010 """
a95a7133 10011 ScrollLines(self, int lines) -> bool
15afbcd0
RD
10012
10013 If the platform and window class supports it, scrolls the window by
10014 the given number of lines down, if lines is positive, or up if lines
10015 is negative. Returns True if the window was scrolled, False if it was
10016 already on top/bottom and nothing was done.
10017 """
54f9ee45 10018 return _core_.Window_ScrollLines(*args, **kwargs)
e811c8ce
RD
10019
10020 def ScrollPages(*args, **kwargs):
15afbcd0 10021 """
a95a7133 10022 ScrollPages(self, int pages) -> bool
15afbcd0 10023
41e2b43e 10024 If the platform and window class supports it, scrolls the window by
15afbcd0
RD
10025 the given number of pages down, if pages is positive, or up if pages
10026 is negative. Returns True if the window was scrolled, False if it was
10027 already on top/bottom and nothing was done.
10028 """
54f9ee45 10029 return _core_.Window_ScrollPages(*args, **kwargs)
e811c8ce
RD
10030
10031 def LineUp(*args, **kwargs):
15afbcd0 10032 """
a95a7133 10033 LineUp(self) -> bool
15afbcd0
RD
10034
10035 This is just a wrapper for ScrollLines(-1).
10036 """
54f9ee45 10037 return _core_.Window_LineUp(*args, **kwargs)
e811c8ce
RD
10038
10039 def LineDown(*args, **kwargs):
15afbcd0 10040 """
a95a7133 10041 LineDown(self) -> bool
15afbcd0
RD
10042
10043 This is just a wrapper for ScrollLines(1).
10044 """
54f9ee45 10045 return _core_.Window_LineDown(*args, **kwargs)
e811c8ce
RD
10046
10047 def PageUp(*args, **kwargs):
15afbcd0 10048 """
a95a7133 10049 PageUp(self) -> bool
15afbcd0
RD
10050
10051 This is just a wrapper for ScrollPages(-1).
10052 """
54f9ee45 10053 return _core_.Window_PageUp(*args, **kwargs)
e811c8ce
RD
10054
10055 def PageDown(*args, **kwargs):
15afbcd0 10056 """
a95a7133 10057 PageDown(self) -> bool
15afbcd0
RD
10058
10059 This is just a wrapper for ScrollPages(1).
10060 """
54f9ee45 10061 return _core_.Window_PageDown(*args, **kwargs)
e811c8ce
RD
10062
10063 def SetHelpText(*args, **kwargs):
15afbcd0 10064 """
a95a7133 10065 SetHelpText(self, String text)
15afbcd0
RD
10066
10067 Sets the help text to be used as context-sensitive help for this
10068 window. Note that the text is actually stored by the current
f52cbe90 10069 `wx.HelpProvider` implementation, and not in the window object itself.
15afbcd0 10070 """
54f9ee45 10071 return _core_.Window_SetHelpText(*args, **kwargs)
e811c8ce
RD
10072
10073 def SetHelpTextForId(*args, **kwargs):
15afbcd0 10074 """
a95a7133 10075 SetHelpTextForId(self, String text)
15afbcd0
RD
10076
10077 Associate this help text with all windows with the same id as this
10078 one.
10079 """
54f9ee45 10080 return _core_.Window_SetHelpTextForId(*args, **kwargs)
e811c8ce 10081
b850e7f3
RD
10082 def GetHelpTextAtPoint(*args, **kwargs):
10083 """
10084 GetHelpTextAtPoint(self, Point pt, wxHelpEvent::Origin origin) -> String
10085
10086 Get the help string associated with the given position in this window.
10087
10088 Notice that pt may be invalid if event origin is keyboard or unknown
10089 and this method should return the global window help text then
10090
10091 """
10092 return _core_.Window_GetHelpTextAtPoint(*args, **kwargs)
10093
e811c8ce 10094 def GetHelpText(*args, **kwargs):
15afbcd0 10095 """
a95a7133 10096 GetHelpText(self) -> String
15afbcd0
RD
10097
10098 Gets the help text to be used as context-sensitive help for this
10099 window. Note that the text is actually stored by the current
f52cbe90 10100 `wx.HelpProvider` implementation, and not in the window object itself.
15afbcd0 10101 """
54f9ee45 10102 return _core_.Window_GetHelpText(*args, **kwargs)
e811c8ce
RD
10103
10104 def SetToolTipString(*args, **kwargs):
15afbcd0 10105 """
a95a7133 10106 SetToolTipString(self, String tip)
15afbcd0
RD
10107
10108 Attach a tooltip to the window.
10109 """
54f9ee45 10110 return _core_.Window_SetToolTipString(*args, **kwargs)
e811c8ce
RD
10111
10112 def SetToolTip(*args, **kwargs):
15afbcd0 10113 """
a95a7133 10114 SetToolTip(self, ToolTip tip)
15afbcd0
RD
10115
10116 Attach a tooltip to the window.
10117 """
54f9ee45 10118 return _core_.Window_SetToolTip(*args, **kwargs)
e811c8ce
RD
10119
10120 def GetToolTip(*args, **kwargs):
15afbcd0 10121 """
a95a7133 10122 GetToolTip(self) -> ToolTip
15afbcd0
RD
10123
10124 get the associated tooltip or None if none
10125 """
54f9ee45 10126 return _core_.Window_GetToolTip(*args, **kwargs)
e811c8ce
RD
10127
10128 def SetDropTarget(*args, **kwargs):
15afbcd0 10129 """
a95a7133 10130 SetDropTarget(self, DropTarget dropTarget)
15afbcd0
RD
10131
10132 Associates a drop target with this window. If the window already has
10133 a drop target, it is deleted.
10134 """
54f9ee45 10135 return _core_.Window_SetDropTarget(*args, **kwargs)
e811c8ce
RD
10136
10137 def GetDropTarget(*args, **kwargs):
15afbcd0 10138 """
a95a7133 10139 GetDropTarget(self) -> DropTarget
15afbcd0
RD
10140
10141 Returns the associated drop target, which may be None.
10142 """
54f9ee45 10143 return _core_.Window_GetDropTarget(*args, **kwargs)
e811c8ce 10144
5ba5649b
RD
10145 def DragAcceptFiles(*args, **kwargs):
10146 """
10147 DragAcceptFiles(self, bool accept)
10148
10149 Enables or disables eligibility for drop file events, EVT_DROP_FILES.
10150 Only functional on Windows.
10151 """
10152 return _core_.Window_DragAcceptFiles(*args, **kwargs)
10153
e811c8ce 10154 def SetConstraints(*args, **kwargs):
15afbcd0 10155 """
a95a7133 10156 SetConstraints(self, LayoutConstraints constraints)
15afbcd0
RD
10157
10158 Sets the window to have the given layout constraints. If an existing
10159 layout constraints object is already owned by the window, it will be
10160 deleted. Pass None to disassociate and delete the window's current
10161 constraints.
10162
10163 You must call SetAutoLayout to tell a window to use the constraints
10164 automatically in its default EVT_SIZE handler; otherwise, you must
10165 handle EVT_SIZE yourself and call Layout() explicitly. When setting
10166 both a wx.LayoutConstraints and a wx.Sizer, only the sizer will have
10167 effect.
10168 """
54f9ee45 10169 return _core_.Window_SetConstraints(*args, **kwargs)
e811c8ce
RD
10170
10171 def GetConstraints(*args, **kwargs):
15afbcd0 10172 """
a95a7133 10173 GetConstraints(self) -> LayoutConstraints
15afbcd0
RD
10174
10175 Returns a pointer to the window's layout constraints, or None if there
10176 are none.
10177 """
54f9ee45 10178 return _core_.Window_GetConstraints(*args, **kwargs)
e811c8ce
RD
10179
10180 def SetAutoLayout(*args, **kwargs):
15afbcd0 10181 """
a95a7133 10182 SetAutoLayout(self, bool autoLayout)
15afbcd0
RD
10183
10184 Determines whether the Layout function will be called automatically
b1fcee84
RD
10185 when the window is resized. lease note that this only happens for the
10186 windows usually used to contain children, namely `wx.Panel` and
10187 `wx.TopLevelWindow` (and the classes deriving from them).
10188
10189 This method is called implicitly by `SetSizer` but if you use
10190 `SetConstraints` you should call it manually or otherwise the window
10191 layout won't be correctly updated when its size changes.
15afbcd0 10192 """
54f9ee45 10193 return _core_.Window_SetAutoLayout(*args, **kwargs)
e811c8ce
RD
10194
10195 def GetAutoLayout(*args, **kwargs):
15afbcd0 10196 """
a95a7133 10197 GetAutoLayout(self) -> bool
15afbcd0
RD
10198
10199 Returns the current autoLayout setting
10200 """
54f9ee45 10201 return _core_.Window_GetAutoLayout(*args, **kwargs)
e811c8ce
RD
10202
10203 def Layout(*args, **kwargs):
15afbcd0 10204 """
a95a7133 10205 Layout(self) -> bool
15afbcd0
RD
10206
10207 Invokes the constraint-based layout algorithm or the sizer-based
10208 algorithm for this window. See SetAutoLayout: when auto layout is on,
10209 this function gets called automatically by the default EVT_SIZE
10210 handler when the window is resized.
10211 """
54f9ee45 10212 return _core_.Window_Layout(*args, **kwargs)
e811c8ce
RD
10213
10214 def SetSizer(*args, **kwargs):
15afbcd0 10215 """
a95a7133 10216 SetSizer(self, Sizer sizer, bool deleteOld=True)
15afbcd0
RD
10217
10218 Sets the window to have the given layout sizer. The window will then
10219 own the object, and will take care of its deletion. If an existing
10220 layout sizer object is already owned by the window, it will be deleted
10221 if the deleteOld parameter is true. Note that this function will also
10222 call SetAutoLayout implicitly with a True parameter if the sizer is
ae8162c8 10223 non-None, and False otherwise.
15afbcd0 10224 """
54f9ee45 10225 return _core_.Window_SetSizer(*args, **kwargs)
e811c8ce
RD
10226
10227 def SetSizerAndFit(*args, **kwargs):
15afbcd0 10228 """
a95a7133 10229 SetSizerAndFit(self, Sizer sizer, bool deleteOld=True)
15afbcd0
RD
10230
10231 The same as SetSizer, except it also sets the size hints for the
10232 window based on the sizer's minimum size.
10233 """
54f9ee45 10234 return _core_.Window_SetSizerAndFit(*args, **kwargs)
e811c8ce
RD
10235
10236 def GetSizer(*args, **kwargs):
15afbcd0 10237 """
a95a7133 10238 GetSizer(self) -> Sizer
15afbcd0
RD
10239
10240 Return the sizer associated with the window by a previous call to
10241 SetSizer or None if there isn't one.
10242 """
54f9ee45 10243 return _core_.Window_GetSizer(*args, **kwargs)
e811c8ce
RD
10244
10245 def SetContainingSizer(*args, **kwargs):
15afbcd0 10246 """
a95a7133 10247 SetContainingSizer(self, Sizer sizer)
15afbcd0
RD
10248
10249 This normally does not need to be called by application code. It is
10250 called internally when a window is added to a sizer, and is used so
10251 the window can remove itself from the sizer when it is destroyed.
10252 """
54f9ee45 10253 return _core_.Window_SetContainingSizer(*args, **kwargs)
e811c8ce
RD
10254
10255 def GetContainingSizer(*args, **kwargs):
15afbcd0 10256 """
a95a7133 10257 GetContainingSizer(self) -> Sizer
15afbcd0
RD
10258
10259 Return the sizer that this window is a member of, if any, otherwise None.
10260 """
54f9ee45 10261 return _core_.Window_GetContainingSizer(*args, **kwargs)
e811c8ce 10262
a95a7133
RD
10263 def InheritAttributes(*args, **kwargs):
10264 """
10265 InheritAttributes(self)
10266
41e2b43e
RD
10267 This function is (or should be, in case of custom controls) called
10268 during window creation to intelligently set up the window visual
10269 attributes, that is the font and the foreground and background
10270 colours.
10271
10272 By 'intelligently' the following is meant: by default, all windows use
10273 their own default attributes. However if some of the parent's
10274 attributes are explicitly changed (that is, using SetFont and not
fa47d7a7 10275 SetOwnFont) and if the corresponding attribute hadn't been
41e2b43e
RD
10276 explicitly set for this window itself, then this window takes the same
10277 value as used by the parent. In addition, if the window overrides
10278 ShouldInheritColours to return false, the colours will not be changed
10279 no matter what and only the font might.
10280
34621cc5 10281 This rather complicated logic is necessary in order to accommodate the
ec9b55ca 10282 different usage scenarios. The most common one is when all default
41e2b43e
RD
10283 attributes are used and in this case, nothing should be inherited as
10284 in modern GUIs different controls use different fonts (and colours)
10285 than their siblings so they can't inherit the same value from the
10286 parent. However it was also deemed desirable to allow to simply change
10287 the attributes of all children at once by just changing the font or
10288 colour of their common parent, hence in this case we do inherit the
10289 parents attributes.
10290
a95a7133 10291 """
54f9ee45 10292 return _core_.Window_InheritAttributes(*args, **kwargs)
a95a7133
RD
10293
10294 def ShouldInheritColours(*args, **kwargs):
10295 """
10296 ShouldInheritColours(self) -> bool
10297
10298 Return true from here to allow the colours of this window to be
41e2b43e
RD
10299 changed by InheritAttributes, returning false forbids inheriting them
10300 from the parent window.
a95a7133 10301
41e2b43e
RD
10302 The base class version returns false, but this method is overridden in
10303 wxControl where it returns true.
a95a7133 10304 """
54f9ee45 10305 return _core_.Window_ShouldInheritColours(*args, **kwargs)
a95a7133 10306
fc46b7f3
RD
10307 def CanSetTransparent(*args, **kwargs):
10308 """
10309 CanSetTransparent(self) -> bool
10310
10311 Returns ``True`` if the platform supports setting the transparency for
10312 this window. Note that this method will err on the side of caution,
10313 so it is possible that this will return ``False`` when it is in fact
10314 possible to set the transparency.
10315
10316 NOTE: On X-windows systems the X server must have the composite
10317 extension loaded, and there must be a composite manager program (such
10318 as xcompmgr) running.
10319 """
10320 return _core_.Window_CanSetTransparent(*args, **kwargs)
10321
10322 def SetTransparent(*args, **kwargs):
10323 """
10324 SetTransparent(self, byte alpha) -> bool
10325
10326 Attempt to set the transparency of this window to the ``alpha`` value,
10327 returns True on success. The ``alpha`` value is an integer in the
10328 range of 0 to 255, where 0 is fully transparent and 255 is fully
10329 opaque.
10330 """
10331 return _core_.Window_SetTransparent(*args, **kwargs)
10332
e811c8ce 10333 def PostCreate(self, pre):
15afbcd0
RD
10334 """
10335 Phase 3 of the 2-phase create <wink!>
10336 Call this method after precreating the window with the 2-phase create method.
10337 """
e811c8ce
RD
10338 self.this = pre.this
10339 self.thisown = pre.thisown
10340 pre.thisown = 0
10341 if hasattr(self, '_setOORInfo'):
10342 self._setOORInfo(self)
10343 if hasattr(self, '_setCallbackInfo'):
10344 self._setCallbackInfo(self, self.__class__)
10345
7e08d4ef 10346 def SendSizeEvent(self):
453fb36b 10347 self.GetEventHandler().ProcessEvent(wx.SizeEvent((-1,-1)))
7e08d4ef 10348
2bf58437
RD
10349 AcceleratorTable = property(GetAcceleratorTable,SetAcceleratorTable,doc="See `GetAcceleratorTable` and `SetAcceleratorTable`")
10350 AdjustedBestSize = property(GetAdjustedBestSize,doc="See `GetAdjustedBestSize`")
10351 AutoLayout = property(GetAutoLayout,SetAutoLayout,doc="See `GetAutoLayout` and `SetAutoLayout`")
10352 BackgroundColour = property(GetBackgroundColour,SetBackgroundColour,doc="See `GetBackgroundColour` and `SetBackgroundColour`")
10353 BackgroundStyle = property(GetBackgroundStyle,SetBackgroundStyle,doc="See `GetBackgroundStyle` and `SetBackgroundStyle`")
580080c5 10354 EffectiveMinSize = property(GetEffectiveMinSize,doc="See `GetEffectiveMinSize`")
2bf58437
RD
10355 BestSize = property(GetBestSize,doc="See `GetBestSize`")
10356 BestVirtualSize = property(GetBestVirtualSize,doc="See `GetBestVirtualSize`")
10357 Border = property(GetBorder,doc="See `GetBorder`")
10358 Caret = property(GetCaret,SetCaret,doc="See `GetCaret` and `SetCaret`")
10359 CharHeight = property(GetCharHeight,doc="See `GetCharHeight`")
10360 CharWidth = property(GetCharWidth,doc="See `GetCharWidth`")
10361 Children = property(GetChildren,doc="See `GetChildren`")
10362 ClientAreaOrigin = property(GetClientAreaOrigin,doc="See `GetClientAreaOrigin`")
10363 ClientRect = property(GetClientRect,SetClientRect,doc="See `GetClientRect` and `SetClientRect`")
10364 ClientSize = property(GetClientSize,SetClientSize,doc="See `GetClientSize` and `SetClientSize`")
10365 Constraints = property(GetConstraints,SetConstraints,doc="See `GetConstraints` and `SetConstraints`")
10366 ContainingSizer = property(GetContainingSizer,SetContainingSizer,doc="See `GetContainingSizer` and `SetContainingSizer`")
10367 Cursor = property(GetCursor,SetCursor,doc="See `GetCursor` and `SetCursor`")
10368 DefaultAttributes = property(GetDefaultAttributes,doc="See `GetDefaultAttributes`")
10369 DropTarget = property(GetDropTarget,SetDropTarget,doc="See `GetDropTarget` and `SetDropTarget`")
10370 EventHandler = property(GetEventHandler,SetEventHandler,doc="See `GetEventHandler` and `SetEventHandler`")
10371 ExtraStyle = property(GetExtraStyle,SetExtraStyle,doc="See `GetExtraStyle` and `SetExtraStyle`")
10372 Font = property(GetFont,SetFont,doc="See `GetFont` and `SetFont`")
10373 ForegroundColour = property(GetForegroundColour,SetForegroundColour,doc="See `GetForegroundColour` and `SetForegroundColour`")
2bf58437
RD
10374 GrandParent = property(GetGrandParent,doc="See `GetGrandParent`")
10375 Handle = property(GetHandle,doc="See `GetHandle`")
10376 HelpText = property(GetHelpText,SetHelpText,doc="See `GetHelpText` and `SetHelpText`")
2bf58437
RD
10377 Id = property(GetId,SetId,doc="See `GetId` and `SetId`")
10378 Label = property(GetLabel,SetLabel,doc="See `GetLabel` and `SetLabel`")
994453b8 10379 LayoutDirection = property(GetLayoutDirection,SetLayoutDirection,doc="See `GetLayoutDirection` and `SetLayoutDirection`")
2bf58437
RD
10380 MaxHeight = property(GetMaxHeight,doc="See `GetMaxHeight`")
10381 MaxSize = property(GetMaxSize,SetMaxSize,doc="See `GetMaxSize` and `SetMaxSize`")
10382 MaxWidth = property(GetMaxWidth,doc="See `GetMaxWidth`")
10383 MinHeight = property(GetMinHeight,doc="See `GetMinHeight`")
10384 MinSize = property(GetMinSize,SetMinSize,doc="See `GetMinSize` and `SetMinSize`")
10385 MinWidth = property(GetMinWidth,doc="See `GetMinWidth`")
10386 Name = property(GetName,SetName,doc="See `GetName` and `SetName`")
10387 Parent = property(GetParent,doc="See `GetParent`")
10388 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
10389 Rect = property(GetRect,SetRect,doc="See `GetRect` and `SetRect`")
10390 ScreenPosition = property(GetScreenPosition,doc="See `GetScreenPosition`")
10391 ScreenRect = property(GetScreenRect,doc="See `GetScreenRect`")
2bf58437
RD
10392 Size = property(GetSize,SetSize,doc="See `GetSize` and `SetSize`")
10393 Sizer = property(GetSizer,SetSizer,doc="See `GetSizer` and `SetSizer`")
2bf58437
RD
10394 ThemeEnabled = property(GetThemeEnabled,SetThemeEnabled,doc="See `GetThemeEnabled` and `SetThemeEnabled`")
10395 ToolTip = property(GetToolTip,SetToolTip,doc="See `GetToolTip` and `SetToolTip`")
10396 UpdateClientRect = property(GetUpdateClientRect,doc="See `GetUpdateClientRect`")
10397 UpdateRegion = property(GetUpdateRegion,doc="See `GetUpdateRegion`")
10398 Validator = property(GetValidator,SetValidator,doc="See `GetValidator` and `SetValidator`")
10399 VirtualSize = property(GetVirtualSize,SetVirtualSize,doc="See `GetVirtualSize` and `SetVirtualSize`")
10400 WindowStyle = property(GetWindowStyle,SetWindowStyle,doc="See `GetWindowStyle` and `SetWindowStyle`")
10401 WindowStyleFlag = property(GetWindowStyleFlag,SetWindowStyleFlag,doc="See `GetWindowStyleFlag` and `SetWindowStyleFlag`")
10402 WindowVariant = property(GetWindowVariant,SetWindowVariant,doc="See `GetWindowVariant` and `SetWindowVariant`")
97ab0f6a
RD
10403 Shown = property(IsShown,Show,doc="See `IsShown` and `Show`")
10404 Enabled = property(IsEnabled,Enable,doc="See `IsEnabled` and `Enable`")
10405 TopLevel = property(IsTopLevel,doc="See `IsTopLevel`")
2131d850 10406_core_.Window_swigregister(Window)
e811c8ce
RD
10407
10408def PreWindow(*args, **kwargs):
15afbcd0
RD
10409 """
10410 PreWindow() -> Window
10411
10412 Precreate a Window for 2-phase creation.
10413 """
54f9ee45 10414 val = _core_.new_PreWindow(*args, **kwargs)
e811c8ce
RD
10415 return val
10416
0085ce49
RD
10417def Window_NewControlId(*args):
10418 """
15afbcd0
RD
10419 Window_NewControlId() -> int
10420
10421 Generate a control id for the controls which were not given one.
10422 """
0085ce49 10423 return _core_.Window_NewControlId(*args)
e811c8ce
RD
10424
10425def Window_NextControlId(*args, **kwargs):
0085ce49 10426 """
15afbcd0
RD
10427 Window_NextControlId(int winid) -> int
10428
10429 Get the id of the control following the one with the given
41e2b43e 10430 autogenerated) id
15afbcd0 10431 """
0085ce49 10432 return _core_.Window_NextControlId(*args, **kwargs)
e811c8ce
RD
10433
10434def Window_PrevControlId(*args, **kwargs):
0085ce49 10435 """
15afbcd0
RD
10436 Window_PrevControlId(int winid) -> int
10437
10438 Get the id of the control preceding the one with the given
41e2b43e 10439 autogenerated) id
15afbcd0 10440 """
0085ce49 10441 return _core_.Window_PrevControlId(*args, **kwargs)
e811c8ce 10442
0085ce49
RD
10443def Window_FindFocus(*args):
10444 """
15afbcd0
RD
10445 Window_FindFocus() -> Window
10446
10447 Returns the window or control that currently has the keyboard focus,
10448 or None.
10449 """
0085ce49 10450 return _core_.Window_FindFocus(*args)
e811c8ce 10451
0085ce49
RD
10452def Window_GetCapture(*args):
10453 """
15afbcd0
RD
10454 Window_GetCapture() -> Window
10455
10456 Returns the window which currently captures the mouse or None
10457 """
0085ce49 10458 return _core_.Window_GetCapture(*args)
e811c8ce 10459
74a57fcd 10460def Window_GetClassDefaultAttributes(*args, **kwargs):
0085ce49 10461 """
74a57fcd
RD
10462 Window_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
10463
41e2b43e
RD
10464 Get the default attributes for this class. This is useful if you want
10465 to use the same font or colour in your own control as in a standard
10466 control -- which is a much better idea than hard coding specific
db3e571a
RD
10467 colours or fonts which might look completely out of place on the
10468 user's system, especially if it uses themes.
74a57fcd
RD
10469
10470 The variant parameter is only relevant under Mac currently and is
41e2b43e 10471 ignore under other platforms. Under Mac, it will change the size of
db3e571a
RD
10472 the returned font. See `wx.Window.SetWindowVariant` for more about
10473 this.
74a57fcd 10474 """
0085ce49 10475 return _core_.Window_GetClassDefaultAttributes(*args, **kwargs)
74a57fcd 10476
e811c8ce 10477def DLG_PNT(win, point_or_x, y=None):
15afbcd0
RD
10478 """
10479 Convenience function for converting a Point or (x,y) in
10480 dialog units to pixel units.
10481 """
e811c8ce
RD
10482 if y is None:
10483 return win.ConvertDialogPointToPixels(point_or_x)
10484 else:
fd3f2efe 10485 return win.ConvertDialogPointToPixels(wx.Point(point_or_x, y))
e811c8ce
RD
10486
10487def DLG_SZE(win, size_width, height=None):
15afbcd0
RD
10488 """
10489 Convenience function for converting a Size or (w,h) in
10490 dialog units to pixel units.
10491 """
e811c8ce
RD
10492 if height is None:
10493 return win.ConvertDialogSizeToPixels(size_width)
10494 else:
fd3f2efe 10495 return win.ConvertDialogSizeToPixels(wx.Size(size_width, height))
e811c8ce
RD
10496
10497
10498def FindWindowById(*args, **kwargs):
0085ce49 10499 """
15afbcd0
RD
10500 FindWindowById(long id, Window parent=None) -> Window
10501
10502 Find the first window in the application with the given id. If parent
10503 is None, the search will start from all top-level frames and dialog
10504 boxes; if non-None, the search will be limited to the given window
10505 hierarchy. The search is recursive in both cases.
10506 """
0085ce49 10507 return _core_.FindWindowById(*args, **kwargs)
e811c8ce
RD
10508
10509def FindWindowByName(*args, **kwargs):
0085ce49 10510 """
15afbcd0
RD
10511 FindWindowByName(String name, Window parent=None) -> Window
10512
10513 Find a window by its name (as given in a window constructor or Create
10514 function call). If parent is None, the search will start from all
10515 top-level frames and dialog boxes; if non-None, the search will be
10516 limited to the given window hierarchy. The search is recursive in both
10517 cases.
10518
10519 If no window with such name is found, wx.FindWindowByLabel is called.
10520 """
0085ce49 10521 return _core_.FindWindowByName(*args, **kwargs)
e811c8ce
RD
10522
10523def FindWindowByLabel(*args, **kwargs):
0085ce49 10524 """
15afbcd0
RD
10525 FindWindowByLabel(String label, Window parent=None) -> Window
10526
10527 Find a window by its label. Depending on the type of window, the label
10528 may be a window title or panel item label. If parent is None, the
10529 search will start from all top-level frames and dialog boxes; if
10530 non-None, the search will be limited to the given window
10531 hierarchy. The search is recursive in both cases.
10532 """
0085ce49 10533 return _core_.FindWindowByLabel(*args, **kwargs)
e811c8ce
RD
10534
10535def Window_FromHWND(*args, **kwargs):
0085ce49
RD
10536 """Window_FromHWND(Window parent, unsigned long _hWnd) -> Window"""
10537 return _core_.Window_FromHWND(*args, **kwargs)
b6b0383e 10538
0085ce49
RD
10539def GetTopLevelWindows(*args):
10540 """
b6b0383e
RD
10541 GetTopLevelWindows() -> PyObject
10542
10543 Returns a list of the the application's top-level windows, (frames,
10544 dialogs, etc.) NOTE: Currently this is a copy of the list maintained
10545 by wxWidgets, and so it is only valid as long as no top-level windows
10546 are closed or new top-level windows are created.
10547
10548 """
0085ce49 10549 return _core_.GetTopLevelWindows(*args)
e811c8ce
RD
10550#---------------------------------------------------------------------------
10551
10552class Validator(EvtHandler):
093d3ff1 10553 """Proxy of C++ Validator class"""
0085ce49
RD
10554 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10555 __repr__ = _swig_repr
10556 def __init__(self, *args, **kwargs):
a95a7133 10557 """__init__(self) -> Validator"""
0085ce49 10558 _core_.Validator_swiginit(self,_core_.new_Validator(*args, **kwargs))
d14a1e28 10559 self._setOORInfo(self)
e811c8ce
RD
10560
10561 def Clone(*args, **kwargs):
a95a7133 10562 """Clone(self) -> Validator"""
54f9ee45 10563 return _core_.Validator_Clone(*args, **kwargs)
e811c8ce
RD
10564
10565 def Validate(*args, **kwargs):
a95a7133 10566 """Validate(self, Window parent) -> bool"""
54f9ee45 10567 return _core_.Validator_Validate(*args, **kwargs)
e811c8ce
RD
10568
10569 def TransferToWindow(*args, **kwargs):
a95a7133 10570 """TransferToWindow(self) -> bool"""
54f9ee45 10571 return _core_.Validator_TransferToWindow(*args, **kwargs)
e811c8ce
RD
10572
10573 def TransferFromWindow(*args, **kwargs):
a95a7133 10574 """TransferFromWindow(self) -> bool"""
54f9ee45 10575 return _core_.Validator_TransferFromWindow(*args, **kwargs)
e811c8ce
RD
10576
10577 def GetWindow(*args, **kwargs):
a95a7133 10578 """GetWindow(self) -> Window"""
54f9ee45 10579 return _core_.Validator_GetWindow(*args, **kwargs)
e811c8ce
RD
10580
10581 def SetWindow(*args, **kwargs):
a95a7133 10582 """SetWindow(self, Window window)"""
54f9ee45 10583 return _core_.Validator_SetWindow(*args, **kwargs)
e811c8ce
RD
10584
10585 def IsSilent(*args, **kwargs):
66c033b4 10586 """IsSilent() -> bool"""
54f9ee45 10587 return _core_.Validator_IsSilent(*args, **kwargs)
e811c8ce
RD
10588
10589 IsSilent = staticmethod(IsSilent)
10590 def SetBellOnError(*args, **kwargs):
66c033b4 10591 """SetBellOnError(int doIt=True)"""
54f9ee45 10592 return _core_.Validator_SetBellOnError(*args, **kwargs)
e811c8ce
RD
10593
10594 SetBellOnError = staticmethod(SetBellOnError)
dba7934c 10595 Window = property(GetWindow,SetWindow,doc="See `GetWindow` and `SetWindow`")
2131d850 10596_core_.Validator_swigregister(Validator)
e811c8ce 10597
0085ce49
RD
10598def Validator_IsSilent(*args):
10599 """Validator_IsSilent() -> bool"""
10600 return _core_.Validator_IsSilent(*args)
e811c8ce
RD
10601
10602def Validator_SetBellOnError(*args, **kwargs):
0085ce49
RD
10603 """Validator_SetBellOnError(int doIt=True)"""
10604 return _core_.Validator_SetBellOnError(*args, **kwargs)
e811c8ce
RD
10605
10606class PyValidator(Validator):
093d3ff1 10607 """Proxy of C++ PyValidator 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) -> PyValidator"""
0085ce49 10612 _core_.PyValidator_swiginit(self,_core_.new_PyValidator(*args, **kwargs))
e811c8ce
RD
10613
10614 self._setCallbackInfo(self, PyValidator, 1)
10615 self._setOORInfo(self)
10616
10617 def _setCallbackInfo(*args, **kwargs):
a95a7133 10618 """_setCallbackInfo(self, PyObject self, PyObject _class, int incref=True)"""
54f9ee45 10619 return _core_.PyValidator__setCallbackInfo(*args, **kwargs)
e811c8ce 10620
2131d850 10621_core_.PyValidator_swigregister(PyValidator)
e811c8ce
RD
10622
10623#---------------------------------------------------------------------------
10624
10625class Menu(EvtHandler):
093d3ff1 10626 """Proxy of C++ Menu class"""
0085ce49
RD
10627 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10628 __repr__ = _swig_repr
10629 def __init__(self, *args, **kwargs):
a95a7133 10630 """__init__(self, String title=EmptyString, long style=0) -> Menu"""
0085ce49 10631 _core_.Menu_swiginit(self,_core_.new_Menu(*args, **kwargs))
e811c8ce
RD
10632 self._setOORInfo(self)
10633
10634 def Append(*args, **kwargs):
97ab0f6a
RD
10635 """
10636 Append(self, int id, String text=EmptyString, String help=EmptyString,
10637 int kind=ITEM_NORMAL) -> MenuItem
10638 """
54f9ee45 10639 return _core_.Menu_Append(*args, **kwargs)
e811c8ce
RD
10640
10641 def AppendSeparator(*args, **kwargs):
a95a7133 10642 """AppendSeparator(self) -> MenuItem"""
54f9ee45 10643 return _core_.Menu_AppendSeparator(*args, **kwargs)
e811c8ce
RD
10644
10645 def AppendCheckItem(*args, **kwargs):
a95a7133 10646 """AppendCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
54f9ee45 10647 return _core_.Menu_AppendCheckItem(*args, **kwargs)
e811c8ce
RD
10648
10649 def AppendRadioItem(*args, **kwargs):
a95a7133 10650 """AppendRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
54f9ee45 10651 return _core_.Menu_AppendRadioItem(*args, **kwargs)
e811c8ce
RD
10652
10653 def AppendMenu(*args, **kwargs):
a95a7133 10654 """AppendMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
54f9ee45 10655 return _core_.Menu_AppendMenu(*args, **kwargs)
e811c8ce 10656
50efceee
RD
10657 def AppendSubMenu(*args, **kwargs):
10658 """AppendSubMenu(self, Menu submenu, String text, String help=EmptyString) -> MenuItem"""
10659 return _core_.Menu_AppendSubMenu(*args, **kwargs)
10660
e811c8ce 10661 def AppendItem(*args, **kwargs):
a95a7133 10662 """AppendItem(self, MenuItem item) -> MenuItem"""
54f9ee45 10663 return _core_.Menu_AppendItem(*args, **kwargs)
e811c8ce 10664
e811c8ce 10665 def InsertItem(*args, **kwargs):
a95a7133 10666 """InsertItem(self, size_t pos, MenuItem item) -> MenuItem"""
54f9ee45 10667 return _core_.Menu_InsertItem(*args, **kwargs)
e811c8ce 10668
0085ce49
RD
10669 def PrependItem(*args, **kwargs):
10670 """PrependItem(self, MenuItem item) -> MenuItem"""
10671 return _core_.Menu_PrependItem(*args, **kwargs)
10672
10673 def Break(*args, **kwargs):
10674 """Break(self)"""
10675 return _core_.Menu_Break(*args, **kwargs)
10676
e811c8ce 10677 def Insert(*args, **kwargs):
0df68c9f 10678 """
97ab0f6a 10679 Insert(self, size_t pos, int id, String text=EmptyString, String help=EmptyString,
a41e16b6 10680 int kind=ITEM_NORMAL) -> MenuItem
0df68c9f 10681 """
54f9ee45 10682 return _core_.Menu_Insert(*args, **kwargs)
e811c8ce
RD
10683
10684 def InsertSeparator(*args, **kwargs):
a95a7133 10685 """InsertSeparator(self, size_t pos) -> MenuItem"""
54f9ee45 10686 return _core_.Menu_InsertSeparator(*args, **kwargs)
e811c8ce
RD
10687
10688 def InsertCheckItem(*args, **kwargs):
a95a7133 10689 """InsertCheckItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
54f9ee45 10690 return _core_.Menu_InsertCheckItem(*args, **kwargs)
e811c8ce
RD
10691
10692 def InsertRadioItem(*args, **kwargs):
a95a7133 10693 """InsertRadioItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
54f9ee45 10694 return _core_.Menu_InsertRadioItem(*args, **kwargs)
e811c8ce
RD
10695
10696 def InsertMenu(*args, **kwargs):
a95a7133 10697 """InsertMenu(self, size_t pos, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
54f9ee45 10698 return _core_.Menu_InsertMenu(*args, **kwargs)
e811c8ce 10699
e811c8ce 10700 def Prepend(*args, **kwargs):
97ab0f6a
RD
10701 """
10702 Prepend(self, int id, String text=EmptyString, String help=EmptyString,
10703 int kind=ITEM_NORMAL) -> MenuItem
10704 """
54f9ee45 10705 return _core_.Menu_Prepend(*args, **kwargs)
e811c8ce
RD
10706
10707 def PrependSeparator(*args, **kwargs):
a95a7133 10708 """PrependSeparator(self) -> MenuItem"""
54f9ee45 10709 return _core_.Menu_PrependSeparator(*args, **kwargs)
e811c8ce
RD
10710
10711 def PrependCheckItem(*args, **kwargs):
a95a7133 10712 """PrependCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
54f9ee45 10713 return _core_.Menu_PrependCheckItem(*args, **kwargs)
e811c8ce
RD
10714
10715 def PrependRadioItem(*args, **kwargs):
a95a7133 10716 """PrependRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
54f9ee45 10717 return _core_.Menu_PrependRadioItem(*args, **kwargs)
e811c8ce
RD
10718
10719 def PrependMenu(*args, **kwargs):
a95a7133 10720 """PrependMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
54f9ee45 10721 return _core_.Menu_PrependMenu(*args, **kwargs)
e811c8ce
RD
10722
10723 def Remove(*args, **kwargs):
a95a7133 10724 """Remove(self, int id) -> MenuItem"""
54f9ee45 10725 return _core_.Menu_Remove(*args, **kwargs)
e811c8ce
RD
10726
10727 def RemoveItem(*args, **kwargs):
a95a7133 10728 """RemoveItem(self, MenuItem item) -> MenuItem"""
54f9ee45 10729 return _core_.Menu_RemoveItem(*args, **kwargs)
e811c8ce
RD
10730
10731 def Delete(*args, **kwargs):
a95a7133 10732 """Delete(self, int id) -> bool"""
54f9ee45 10733 return _core_.Menu_Delete(*args, **kwargs)
e811c8ce
RD
10734
10735 def DeleteItem(*args, **kwargs):
a95a7133 10736 """DeleteItem(self, MenuItem item) -> bool"""
54f9ee45 10737 return _core_.Menu_DeleteItem(*args, **kwargs)
e811c8ce
RD
10738
10739 def Destroy(*args, **kwargs):
0df68c9f 10740 """
a95a7133 10741 Destroy(self)
e811c8ce 10742
0df68c9f
RD
10743 Deletes the C++ object this Python object is a proxy for.
10744 """
b39fe951
RD
10745 args[0].this.own(False)
10746 return _core_.Menu_Destroy(*args, **kwargs)
e811c8ce
RD
10747
10748 def DestroyId(*args, **kwargs):
b39fe951
RD
10749 """DestroyId(self, int id) -> bool"""
10750 return _core_.Menu_DestroyId(*args, **kwargs)
e811c8ce
RD
10751
10752 def DestroyItem(*args, **kwargs):
b39fe951
RD
10753 """DestroyItem(self, MenuItem item) -> bool"""
10754 return _core_.Menu_DestroyItem(*args, **kwargs)
e811c8ce
RD
10755
10756 def GetMenuItemCount(*args, **kwargs):
a95a7133 10757 """GetMenuItemCount(self) -> size_t"""
54f9ee45 10758 return _core_.Menu_GetMenuItemCount(*args, **kwargs)
e811c8ce
RD
10759
10760 def GetMenuItems(*args, **kwargs):
a95a7133 10761 """GetMenuItems(self) -> PyObject"""
54f9ee45 10762 return _core_.Menu_GetMenuItems(*args, **kwargs)
e811c8ce
RD
10763
10764 def FindItem(*args, **kwargs):
a95a7133 10765 """FindItem(self, String item) -> int"""
54f9ee45 10766 return _core_.Menu_FindItem(*args, **kwargs)
e811c8ce
RD
10767
10768 def FindItemById(*args, **kwargs):
a95a7133 10769 """FindItemById(self, int id) -> MenuItem"""
54f9ee45 10770 return _core_.Menu_FindItemById(*args, **kwargs)
e811c8ce
RD
10771
10772 def FindItemByPosition(*args, **kwargs):
a95a7133 10773 """FindItemByPosition(self, size_t position) -> MenuItem"""
54f9ee45 10774 return _core_.Menu_FindItemByPosition(*args, **kwargs)
e811c8ce
RD
10775
10776 def Enable(*args, **kwargs):
a95a7133 10777 """Enable(self, int id, bool enable)"""
54f9ee45 10778 return _core_.Menu_Enable(*args, **kwargs)
e811c8ce
RD
10779
10780 def IsEnabled(*args, **kwargs):
a95a7133 10781 """IsEnabled(self, int id) -> bool"""
54f9ee45 10782 return _core_.Menu_IsEnabled(*args, **kwargs)
e811c8ce
RD
10783
10784 def Check(*args, **kwargs):
a95a7133 10785 """Check(self, int id, bool check)"""
54f9ee45 10786 return _core_.Menu_Check(*args, **kwargs)
e811c8ce
RD
10787
10788 def IsChecked(*args, **kwargs):
a95a7133 10789 """IsChecked(self, int id) -> bool"""
54f9ee45 10790 return _core_.Menu_IsChecked(*args, **kwargs)
e811c8ce
RD
10791
10792 def SetLabel(*args, **kwargs):
a95a7133 10793 """SetLabel(self, int id, String label)"""
54f9ee45 10794 return _core_.Menu_SetLabel(*args, **kwargs)
e811c8ce
RD
10795
10796 def GetLabel(*args, **kwargs):
a95a7133 10797 """GetLabel(self, int id) -> String"""
54f9ee45 10798 return _core_.Menu_GetLabel(*args, **kwargs)
e811c8ce
RD
10799
10800 def SetHelpString(*args, **kwargs):
a95a7133 10801 """SetHelpString(self, int id, String helpString)"""
54f9ee45 10802 return _core_.Menu_SetHelpString(*args, **kwargs)
e811c8ce
RD
10803
10804 def GetHelpString(*args, **kwargs):
a95a7133 10805 """GetHelpString(self, int id) -> String"""
54f9ee45 10806 return _core_.Menu_GetHelpString(*args, **kwargs)
e811c8ce
RD
10807
10808 def SetTitle(*args, **kwargs):
a95a7133 10809 """SetTitle(self, String title)"""
54f9ee45 10810 return _core_.Menu_SetTitle(*args, **kwargs)
e811c8ce
RD
10811
10812 def GetTitle(*args, **kwargs):
a95a7133 10813 """GetTitle(self) -> String"""
54f9ee45 10814 return _core_.Menu_GetTitle(*args, **kwargs)
e811c8ce
RD
10815
10816 def SetEventHandler(*args, **kwargs):
a95a7133 10817 """SetEventHandler(self, EvtHandler handler)"""
54f9ee45 10818 return _core_.Menu_SetEventHandler(*args, **kwargs)
e811c8ce
RD
10819
10820 def GetEventHandler(*args, **kwargs):
a95a7133 10821 """GetEventHandler(self) -> EvtHandler"""
54f9ee45 10822 return _core_.Menu_GetEventHandler(*args, **kwargs)
e811c8ce
RD
10823
10824 def SetInvokingWindow(*args, **kwargs):
a95a7133 10825 """SetInvokingWindow(self, Window win)"""
54f9ee45 10826 return _core_.Menu_SetInvokingWindow(*args, **kwargs)
e811c8ce
RD
10827
10828 def GetInvokingWindow(*args, **kwargs):
a95a7133 10829 """GetInvokingWindow(self) -> Window"""
54f9ee45 10830 return _core_.Menu_GetInvokingWindow(*args, **kwargs)
e811c8ce
RD
10831
10832 def GetStyle(*args, **kwargs):
a95a7133 10833 """GetStyle(self) -> long"""
54f9ee45 10834 return _core_.Menu_GetStyle(*args, **kwargs)
e811c8ce
RD
10835
10836 def UpdateUI(*args, **kwargs):
a95a7133 10837 """UpdateUI(self, EvtHandler source=None)"""
54f9ee45 10838 return _core_.Menu_UpdateUI(*args, **kwargs)
e811c8ce
RD
10839
10840 def GetMenuBar(*args, **kwargs):
a95a7133 10841 """GetMenuBar(self) -> MenuBar"""
54f9ee45 10842 return _core_.Menu_GetMenuBar(*args, **kwargs)
e811c8ce
RD
10843
10844 def Attach(*args, **kwargs):
a95a7133 10845 """Attach(self, wxMenuBarBase menubar)"""
54f9ee45 10846 return _core_.Menu_Attach(*args, **kwargs)
e811c8ce
RD
10847
10848 def Detach(*args, **kwargs):
a95a7133 10849 """Detach(self)"""
54f9ee45 10850 return _core_.Menu_Detach(*args, **kwargs)
e811c8ce
RD
10851
10852 def IsAttached(*args, **kwargs):
a95a7133 10853 """IsAttached(self) -> bool"""
54f9ee45 10854 return _core_.Menu_IsAttached(*args, **kwargs)
e811c8ce
RD
10855
10856 def SetParent(*args, **kwargs):
a95a7133 10857 """SetParent(self, Menu parent)"""
54f9ee45 10858 return _core_.Menu_SetParent(*args, **kwargs)
e811c8ce
RD
10859
10860 def GetParent(*args, **kwargs):
a95a7133 10861 """GetParent(self) -> Menu"""
54f9ee45 10862 return _core_.Menu_GetParent(*args, **kwargs)
e811c8ce 10863
57332a5a
RD
10864 EventHandler = property(GetEventHandler,SetEventHandler,doc="See `GetEventHandler` and `SetEventHandler`")
10865 HelpString = property(GetHelpString,SetHelpString,doc="See `GetHelpString` and `SetHelpString`")
10866 InvokingWindow = property(GetInvokingWindow,SetInvokingWindow,doc="See `GetInvokingWindow` and `SetInvokingWindow`")
10867 MenuBar = property(GetMenuBar,doc="See `GetMenuBar`")
10868 MenuItemCount = property(GetMenuItemCount,doc="See `GetMenuItemCount`")
10869 MenuItems = property(GetMenuItems,doc="See `GetMenuItems`")
10870 Parent = property(GetParent,SetParent,doc="See `GetParent` and `SetParent`")
10871 Style = property(GetStyle,doc="See `GetStyle`")
10872 Title = property(GetTitle,SetTitle,doc="See `GetTitle` and `SetTitle`")
2131d850 10873_core_.Menu_swigregister(Menu)
d14a1e28
RD
10874DefaultValidator = cvar.DefaultValidator
10875
10876#---------------------------------------------------------------------------
10877
10878class MenuBar(Window):
093d3ff1 10879 """Proxy of C++ MenuBar class"""
0085ce49
RD
10880 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10881 __repr__ = _swig_repr
10882 def __init__(self, *args, **kwargs):
a95a7133 10883 """__init__(self, long style=0) -> MenuBar"""
0085ce49 10884 _core_.MenuBar_swiginit(self,_core_.new_MenuBar(*args, **kwargs))
d14a1e28 10885 self._setOORInfo(self)
e811c8ce
RD
10886
10887 def Append(*args, **kwargs):
a95a7133 10888 """Append(self, Menu menu, String title) -> bool"""
54f9ee45 10889 return _core_.MenuBar_Append(*args, **kwargs)
e811c8ce
RD
10890
10891 def Insert(*args, **kwargs):
a95a7133 10892 """Insert(self, size_t pos, Menu menu, String title) -> bool"""
54f9ee45 10893 return _core_.MenuBar_Insert(*args, **kwargs)
e811c8ce
RD
10894
10895 def GetMenuCount(*args, **kwargs):
a95a7133 10896 """GetMenuCount(self) -> size_t"""
54f9ee45 10897 return _core_.MenuBar_GetMenuCount(*args, **kwargs)
e811c8ce
RD
10898
10899 def GetMenu(*args, **kwargs):
a95a7133 10900 """GetMenu(self, size_t pos) -> Menu"""
54f9ee45 10901 return _core_.MenuBar_GetMenu(*args, **kwargs)
e811c8ce
RD
10902
10903 def Replace(*args, **kwargs):
a95a7133 10904 """Replace(self, size_t pos, Menu menu, String title) -> Menu"""
54f9ee45 10905 return _core_.MenuBar_Replace(*args, **kwargs)
e811c8ce
RD
10906
10907 def Remove(*args, **kwargs):
a95a7133 10908 """Remove(self, size_t pos) -> Menu"""
54f9ee45 10909 return _core_.MenuBar_Remove(*args, **kwargs)
e811c8ce
RD
10910
10911 def EnableTop(*args, **kwargs):
a95a7133 10912 """EnableTop(self, size_t pos, bool enable)"""
54f9ee45 10913 return _core_.MenuBar_EnableTop(*args, **kwargs)
e811c8ce
RD
10914
10915 def IsEnabledTop(*args, **kwargs):
a95a7133 10916 """IsEnabledTop(self, size_t pos) -> bool"""
54f9ee45 10917 return _core_.MenuBar_IsEnabledTop(*args, **kwargs)
e811c8ce
RD
10918
10919 def SetLabelTop(*args, **kwargs):
a95a7133 10920 """SetLabelTop(self, size_t pos, String label)"""
54f9ee45 10921 return _core_.MenuBar_SetLabelTop(*args, **kwargs)
e811c8ce
RD
10922
10923 def GetLabelTop(*args, **kwargs):
a95a7133 10924 """GetLabelTop(self, size_t pos) -> String"""
54f9ee45 10925 return _core_.MenuBar_GetLabelTop(*args, **kwargs)
e811c8ce
RD
10926
10927 def FindMenuItem(*args, **kwargs):
a95a7133 10928 """FindMenuItem(self, String menu, String item) -> int"""
54f9ee45 10929 return _core_.MenuBar_FindMenuItem(*args, **kwargs)
e811c8ce
RD
10930
10931 def FindItemById(*args, **kwargs):
a95a7133 10932 """FindItemById(self, int id) -> MenuItem"""
54f9ee45 10933 return _core_.MenuBar_FindItemById(*args, **kwargs)
e811c8ce
RD
10934
10935 def FindMenu(*args, **kwargs):
a95a7133 10936 """FindMenu(self, String title) -> int"""
54f9ee45 10937 return _core_.MenuBar_FindMenu(*args, **kwargs)
e811c8ce
RD
10938
10939 def Enable(*args, **kwargs):
a95a7133 10940 """Enable(self, int id, bool enable)"""
54f9ee45 10941 return _core_.MenuBar_Enable(*args, **kwargs)
e811c8ce
RD
10942
10943 def Check(*args, **kwargs):
a95a7133 10944 """Check(self, int id, bool check)"""
54f9ee45 10945 return _core_.MenuBar_Check(*args, **kwargs)
e811c8ce
RD
10946
10947 def IsChecked(*args, **kwargs):
a95a7133 10948 """IsChecked(self, int id) -> bool"""
54f9ee45 10949 return _core_.MenuBar_IsChecked(*args, **kwargs)
e811c8ce
RD
10950
10951 def IsEnabled(*args, **kwargs):
a95a7133 10952 """IsEnabled(self, int id) -> bool"""
54f9ee45 10953 return _core_.MenuBar_IsEnabled(*args, **kwargs)
e811c8ce
RD
10954
10955 def SetLabel(*args, **kwargs):
a95a7133 10956 """SetLabel(self, int id, String label)"""
54f9ee45 10957 return _core_.MenuBar_SetLabel(*args, **kwargs)
e811c8ce
RD
10958
10959 def GetLabel(*args, **kwargs):
a95a7133 10960 """GetLabel(self, int id) -> String"""
54f9ee45 10961 return _core_.MenuBar_GetLabel(*args, **kwargs)
e811c8ce
RD
10962
10963 def SetHelpString(*args, **kwargs):
a95a7133 10964 """SetHelpString(self, int id, String helpString)"""
54f9ee45 10965 return _core_.MenuBar_SetHelpString(*args, **kwargs)
e811c8ce
RD
10966
10967 def GetHelpString(*args, **kwargs):
a95a7133 10968 """GetHelpString(self, int id) -> String"""
54f9ee45 10969 return _core_.MenuBar_GetHelpString(*args, **kwargs)
e811c8ce
RD
10970
10971 def GetFrame(*args, **kwargs):
a95a7133 10972 """GetFrame(self) -> wxFrame"""
54f9ee45 10973 return _core_.MenuBar_GetFrame(*args, **kwargs)
e811c8ce
RD
10974
10975 def IsAttached(*args, **kwargs):
a95a7133 10976 """IsAttached(self) -> bool"""
54f9ee45 10977 return _core_.MenuBar_IsAttached(*args, **kwargs)
e811c8ce
RD
10978
10979 def Attach(*args, **kwargs):
a95a7133 10980 """Attach(self, wxFrame frame)"""
54f9ee45 10981 return _core_.MenuBar_Attach(*args, **kwargs)
e811c8ce
RD
10982
10983 def Detach(*args, **kwargs):
a95a7133 10984 """Detach(self)"""
54f9ee45 10985 return _core_.MenuBar_Detach(*args, **kwargs)
e811c8ce 10986
587d0f36
RD
10987 def UpdateMenus(*args, **kwargs):
10988 """UpdateMenus(self)"""
10989 return _core_.MenuBar_UpdateMenus(*args, **kwargs)
10990
4f433fef
RD
10991 def SetAutoWindowMenu(*args, **kwargs):
10992 """SetAutoWindowMenu(bool enable)"""
10993 return _core_.MenuBar_SetAutoWindowMenu(*args, **kwargs)
10994
10995 SetAutoWindowMenu = staticmethod(SetAutoWindowMenu)
10996 def GetAutoWindowMenu(*args, **kwargs):
10997 """GetAutoWindowMenu() -> bool"""
10998 return _core_.MenuBar_GetAutoWindowMenu(*args, **kwargs)
10999
11000 GetAutoWindowMenu = staticmethod(GetAutoWindowMenu)
97ab0f6a
RD
11001 def GetMenus(self):
11002 """Return a list of (menu, label) items for the menus in the MenuBar. """
11003 return [(self.GetMenu(i), self.GetLabelTop(i))
11004 for i in range(self.GetMenuCount())]
11005
11006 def SetMenus(self, items):
11007 """Clear and add new menus to the MenuBar from a list of (menu, label) items. """
11008 for i in range(self.GetMenuCount()-1, -1, -1):
11009 self.Remove(i)
11010 for m, l in items:
11011 self.Append(m, l)
11012
57332a5a
RD
11013 Frame = property(GetFrame,doc="See `GetFrame`")
11014 Menu = property(GetMenu,doc="See `GetMenu`")
11015 MenuCount = property(GetMenuCount,doc="See `GetMenuCount`")
11016 Menus = property(GetMenus,SetMenus,doc="See `GetMenus` and `SetMenus`")
2131d850 11017_core_.MenuBar_swigregister(MenuBar)
d14a1e28 11018
4f433fef 11019def MenuBar_SetAutoWindowMenu(*args, **kwargs):
0085ce49
RD
11020 """MenuBar_SetAutoWindowMenu(bool enable)"""
11021 return _core_.MenuBar_SetAutoWindowMenu(*args, **kwargs)
4f433fef 11022
0085ce49
RD
11023def MenuBar_GetAutoWindowMenu(*args):
11024 """MenuBar_GetAutoWindowMenu() -> bool"""
11025 return _core_.MenuBar_GetAutoWindowMenu(*args)
4f433fef 11026
d14a1e28
RD
11027#---------------------------------------------------------------------------
11028
11029class MenuItem(Object):
093d3ff1 11030 """Proxy of C++ MenuItem class"""
0085ce49
RD
11031 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11032 __repr__ = _swig_repr
11033 def __init__(self, *args, **kwargs):
0df68c9f 11034 """
a95a7133 11035 __init__(self, Menu parentMenu=None, int id=ID_ANY, String text=EmptyString,
196addbf
RD
11036 String help=EmptyString, int kind=ITEM_NORMAL,
11037 Menu subMenu=None) -> MenuItem
0df68c9f 11038 """
0085ce49
RD
11039 _core_.MenuItem_swiginit(self,_core_.new_MenuItem(*args, **kwargs))
11040 __swig_destroy__ = _core_.delete_MenuItem
11041 __del__ = lambda self : None;
e811c8ce 11042 def GetMenu(*args, **kwargs):
a95a7133 11043 """GetMenu(self) -> Menu"""
54f9ee45 11044 return _core_.MenuItem_GetMenu(*args, **kwargs)
e811c8ce
RD
11045
11046 def SetMenu(*args, **kwargs):
a95a7133 11047 """SetMenu(self, Menu menu)"""
54f9ee45 11048 return _core_.MenuItem_SetMenu(*args, **kwargs)
e811c8ce
RD
11049
11050 def SetId(*args, **kwargs):
a95a7133 11051 """SetId(self, int id)"""
54f9ee45 11052 return _core_.MenuItem_SetId(*args, **kwargs)
e811c8ce
RD
11053
11054 def GetId(*args, **kwargs):
a95a7133 11055 """GetId(self) -> int"""
54f9ee45 11056 return _core_.MenuItem_GetId(*args, **kwargs)
e811c8ce
RD
11057
11058 def IsSeparator(*args, **kwargs):
a95a7133 11059 """IsSeparator(self) -> bool"""
54f9ee45 11060 return _core_.MenuItem_IsSeparator(*args, **kwargs)
e811c8ce
RD
11061
11062 def SetText(*args, **kwargs):
a95a7133 11063 """SetText(self, String str)"""
54f9ee45 11064 return _core_.MenuItem_SetText(*args, **kwargs)
e811c8ce
RD
11065
11066 def GetLabel(*args, **kwargs):
a95a7133 11067 """GetLabel(self) -> String"""
54f9ee45 11068 return _core_.MenuItem_GetLabel(*args, **kwargs)
e811c8ce
RD
11069
11070 def GetText(*args, **kwargs):
a95a7133 11071 """GetText(self) -> String"""
54f9ee45 11072 return _core_.MenuItem_GetText(*args, **kwargs)
e811c8ce
RD
11073
11074 def GetLabelFromText(*args, **kwargs):
66c033b4 11075 """GetLabelFromText(String text) -> String"""
54f9ee45 11076 return _core_.MenuItem_GetLabelFromText(*args, **kwargs)
e811c8ce
RD
11077
11078 GetLabelFromText = staticmethod(GetLabelFromText)
11079 def GetKind(*args, **kwargs):
a95a7133 11080 """GetKind(self) -> int"""
54f9ee45 11081 return _core_.MenuItem_GetKind(*args, **kwargs)
e811c8ce 11082
a95a7133
RD
11083 def SetKind(*args, **kwargs):
11084 """SetKind(self, int kind)"""
54f9ee45 11085 return _core_.MenuItem_SetKind(*args, **kwargs)
a95a7133 11086
e811c8ce 11087 def SetCheckable(*args, **kwargs):
a95a7133 11088 """SetCheckable(self, bool checkable)"""
54f9ee45 11089 return _core_.MenuItem_SetCheckable(*args, **kwargs)
e811c8ce
RD
11090
11091 def IsCheckable(*args, **kwargs):
a95a7133 11092 """IsCheckable(self) -> bool"""
54f9ee45 11093 return _core_.MenuItem_IsCheckable(*args, **kwargs)
e811c8ce
RD
11094
11095 def IsSubMenu(*args, **kwargs):
a95a7133 11096 """IsSubMenu(self) -> bool"""
54f9ee45 11097 return _core_.MenuItem_IsSubMenu(*args, **kwargs)
e811c8ce
RD
11098
11099 def SetSubMenu(*args, **kwargs):
a95a7133 11100 """SetSubMenu(self, Menu menu)"""
54f9ee45 11101 return _core_.MenuItem_SetSubMenu(*args, **kwargs)
e811c8ce
RD
11102
11103 def GetSubMenu(*args, **kwargs):
a95a7133 11104 """GetSubMenu(self) -> Menu"""
54f9ee45 11105 return _core_.MenuItem_GetSubMenu(*args, **kwargs)
e811c8ce
RD
11106
11107 def Enable(*args, **kwargs):
a95a7133 11108 """Enable(self, bool enable=True)"""
54f9ee45 11109 return _core_.MenuItem_Enable(*args, **kwargs)
e811c8ce
RD
11110
11111 def IsEnabled(*args, **kwargs):
a95a7133 11112 """IsEnabled(self) -> bool"""
54f9ee45 11113 return _core_.MenuItem_IsEnabled(*args, **kwargs)
e811c8ce
RD
11114
11115 def Check(*args, **kwargs):
a95a7133 11116 """Check(self, bool check=True)"""
54f9ee45 11117 return _core_.MenuItem_Check(*args, **kwargs)
e811c8ce
RD
11118
11119 def IsChecked(*args, **kwargs):
a95a7133 11120 """IsChecked(self) -> bool"""
54f9ee45 11121 return _core_.MenuItem_IsChecked(*args, **kwargs)
e811c8ce
RD
11122
11123 def Toggle(*args, **kwargs):
a95a7133 11124 """Toggle(self)"""
54f9ee45 11125 return _core_.MenuItem_Toggle(*args, **kwargs)
e811c8ce
RD
11126
11127 def SetHelp(*args, **kwargs):
a95a7133 11128 """SetHelp(self, String str)"""
54f9ee45 11129 return _core_.MenuItem_SetHelp(*args, **kwargs)
e811c8ce
RD
11130
11131 def GetHelp(*args, **kwargs):
a95a7133 11132 """GetHelp(self) -> String"""
54f9ee45 11133 return _core_.MenuItem_GetHelp(*args, **kwargs)
e811c8ce
RD
11134
11135 def GetAccel(*args, **kwargs):
a95a7133 11136 """GetAccel(self) -> AcceleratorEntry"""
54f9ee45 11137 return _core_.MenuItem_GetAccel(*args, **kwargs)
e811c8ce
RD
11138
11139 def SetAccel(*args, **kwargs):
a95a7133 11140 """SetAccel(self, AcceleratorEntry accel)"""
54f9ee45 11141 return _core_.MenuItem_SetAccel(*args, **kwargs)
e811c8ce 11142
091f5bed
RD
11143 def SetBitmap(*args, **kwargs):
11144 """SetBitmap(self, Bitmap bitmap)"""
11145 return _core_.MenuItem_SetBitmap(*args, **kwargs)
11146
11147 def GetBitmap(*args, **kwargs):
11148 """GetBitmap(self) -> Bitmap"""
11149 return _core_.MenuItem_GetBitmap(*args, **kwargs)
11150
c1280d1e
RD
11151 def SetFont(*args, **kwargs):
11152 """SetFont(self, Font font)"""
11153 return _core_.MenuItem_SetFont(*args, **kwargs)
11154
11155 def GetFont(*args, **kwargs):
11156 """GetFont(self) -> Font"""
11157 return _core_.MenuItem_GetFont(*args, **kwargs)
11158
11159 def SetTextColour(*args, **kwargs):
11160 """SetTextColour(self, Colour colText)"""
11161 return _core_.MenuItem_SetTextColour(*args, **kwargs)
11162
11163 def GetTextColour(*args, **kwargs):
11164 """GetTextColour(self) -> Colour"""
11165 return _core_.MenuItem_GetTextColour(*args, **kwargs)
11166
11167 def SetBackgroundColour(*args, **kwargs):
11168 """SetBackgroundColour(self, Colour colBack)"""
11169 return _core_.MenuItem_SetBackgroundColour(*args, **kwargs)
11170
11171 def GetBackgroundColour(*args, **kwargs):
11172 """GetBackgroundColour(self) -> Colour"""
11173 return _core_.MenuItem_GetBackgroundColour(*args, **kwargs)
11174
11175 def SetBitmaps(*args, **kwargs):
11176 """SetBitmaps(self, Bitmap bmpChecked, Bitmap bmpUnchecked=wxNullBitmap)"""
11177 return _core_.MenuItem_SetBitmaps(*args, **kwargs)
11178
11179 def SetDisabledBitmap(*args, **kwargs):
11180 """SetDisabledBitmap(self, Bitmap bmpDisabled)"""
11181 return _core_.MenuItem_SetDisabledBitmap(*args, **kwargs)
11182
11183 def GetDisabledBitmap(*args, **kwargs):
11184 """GetDisabledBitmap(self) -> Bitmap"""
11185 return _core_.MenuItem_GetDisabledBitmap(*args, **kwargs)
11186
11187 def SetMarginWidth(*args, **kwargs):
11188 """SetMarginWidth(self, int nWidth)"""
11189 return _core_.MenuItem_SetMarginWidth(*args, **kwargs)
11190
11191 def GetMarginWidth(*args, **kwargs):
11192 """GetMarginWidth(self) -> int"""
11193 return _core_.MenuItem_GetMarginWidth(*args, **kwargs)
11194
e811c8ce 11195 def GetDefaultMarginWidth(*args, **kwargs):
66c033b4 11196 """GetDefaultMarginWidth() -> int"""
54f9ee45 11197 return _core_.MenuItem_GetDefaultMarginWidth(*args, **kwargs)
e811c8ce
RD
11198
11199 GetDefaultMarginWidth = staticmethod(GetDefaultMarginWidth)
c1280d1e
RD
11200 def IsOwnerDrawn(*args, **kwargs):
11201 """IsOwnerDrawn(self) -> bool"""
11202 return _core_.MenuItem_IsOwnerDrawn(*args, **kwargs)
11203
11204 def SetOwnerDrawn(*args, **kwargs):
11205 """SetOwnerDrawn(self, bool ownerDrawn=True)"""
11206 return _core_.MenuItem_SetOwnerDrawn(*args, **kwargs)
11207
11208 def ResetOwnerDrawn(*args, **kwargs):
11209 """ResetOwnerDrawn(self)"""
11210 return _core_.MenuItem_ResetOwnerDrawn(*args, **kwargs)
11211
57332a5a
RD
11212 Accel = property(GetAccel,SetAccel,doc="See `GetAccel` and `SetAccel`")
11213 BackgroundColour = property(GetBackgroundColour,SetBackgroundColour,doc="See `GetBackgroundColour` and `SetBackgroundColour`")
11214 Bitmap = property(GetBitmap,SetBitmap,doc="See `GetBitmap` and `SetBitmap`")
11215 DisabledBitmap = property(GetDisabledBitmap,SetDisabledBitmap,doc="See `GetDisabledBitmap` and `SetDisabledBitmap`")
11216 Font = property(GetFont,SetFont,doc="See `GetFont` and `SetFont`")
11217 Help = property(GetHelp,SetHelp,doc="See `GetHelp` and `SetHelp`")
11218 Id = property(GetId,SetId,doc="See `GetId` and `SetId`")
11219 Kind = property(GetKind,SetKind,doc="See `GetKind` and `SetKind`")
11220 Label = property(GetLabel,doc="See `GetLabel`")
11221 MarginWidth = property(GetMarginWidth,SetMarginWidth,doc="See `GetMarginWidth` and `SetMarginWidth`")
11222 Menu = property(GetMenu,SetMenu,doc="See `GetMenu` and `SetMenu`")
11223 SubMenu = property(GetSubMenu,SetSubMenu,doc="See `GetSubMenu` and `SetSubMenu`")
11224 Text = property(GetText,SetText,doc="See `GetText` and `SetText`")
11225 TextColour = property(GetTextColour,SetTextColour,doc="See `GetTextColour` and `SetTextColour`")
2131d850 11226_core_.MenuItem_swigregister(MenuItem)
d14a1e28 11227
e811c8ce 11228def MenuItem_GetLabelFromText(*args, **kwargs):
0085ce49
RD
11229 """MenuItem_GetLabelFromText(String text) -> String"""
11230 return _core_.MenuItem_GetLabelFromText(*args, **kwargs)
d14a1e28 11231
0085ce49
RD
11232def MenuItem_GetDefaultMarginWidth(*args):
11233 """MenuItem_GetDefaultMarginWidth() -> int"""
11234 return _core_.MenuItem_GetDefaultMarginWidth(*args)
d14a1e28
RD
11235
11236#---------------------------------------------------------------------------
11237
11238class Control(Window):
15afbcd0
RD
11239 """
11240 This is the base class for a control or 'widget'.
11241
41e2b43e
RD
11242 A control is generally a small window which processes user input
11243 and/or displays one or more item of data.
15afbcd0 11244 """
0085ce49
RD
11245 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11246 __repr__ = _swig_repr
11247 def __init__(self, *args, **kwargs):
0df68c9f 11248 """
248ed943
RD
11249 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
11250 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
b2dc1044 11251 String name=ControlNameStr) -> Control
15afbcd0 11252
41e2b43e
RD
11253 Create a Control. Normally you should only call this from a subclass'
11254 __init__ as a plain old wx.Control is not very useful.
0df68c9f 11255 """
0085ce49 11256 _core_.Control_swiginit(self,_core_.new_Control(*args, **kwargs))
d14a1e28 11257 self._setOORInfo(self)
e811c8ce
RD
11258
11259 def Create(*args, **kwargs):
0df68c9f 11260 """
248ed943
RD
11261 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
11262 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
b2dc1044 11263 String name=ControlNameStr) -> bool
15afbcd0
RD
11264
11265 Do the 2nd phase and create the GUI control.
0df68c9f 11266 """
54f9ee45 11267 return _core_.Control_Create(*args, **kwargs)
e811c8ce 11268
10044bf1
RD
11269 def GetAlignment(*args, **kwargs):
11270 """
11271 GetAlignment(self) -> int
11272
11273 Get the control alignment (left/right/centre, top/bottom/centre)
11274 """
11275 return _core_.Control_GetAlignment(*args, **kwargs)
11276
34e0a3bb 11277 def GetLabelText(*args, **kwargs):
10044bf1 11278 """
10044bf1
RD
11279 GetLabelText(self) -> String
11280
11281 Get just the text of the label, without mnemonic characters ('&')
11282 """
34e0a3bb 11283 return _core_.Control_GetLabelText(*args, **kwargs)
10044bf1 11284
e811c8ce 11285 def Command(*args, **kwargs):
15afbcd0 11286 """
a95a7133 11287 Command(self, CommandEvent event)
15afbcd0 11288
41e2b43e
RD
11289 Simulates the effect of the user issuing a command to the item.
11290
11291 :see: `wx.CommandEvent`
11292
15afbcd0 11293 """
54f9ee45 11294 return _core_.Control_Command(*args, **kwargs)
e811c8ce 11295
74a57fcd 11296 def GetClassDefaultAttributes(*args, **kwargs):
110da5b0
RD
11297 """
11298 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
11299
11300 Get the default attributes for this class. This is useful if you want
11301 to use the same font or colour in your own control as in a standard
11302 control -- which is a much better idea than hard coding specific
11303 colours or fonts which might look completely out of place on the
11304 user's system, especially if it uses themes.
11305
11306 The variant parameter is only relevant under Mac currently and is
11307 ignore under other platforms. Under Mac, it will change the size of
11308 the returned font. See `wx.Window.SetWindowVariant` for more about
11309 this.
11310 """
54f9ee45 11311 return _core_.Control_GetClassDefaultAttributes(*args, **kwargs)
74a57fcd
RD
11312
11313 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
2bf58437 11314 Alignment = property(GetAlignment,doc="See `GetAlignment`")
2bf58437 11315 LabelText = property(GetLabelText,doc="See `GetLabelText`")
2131d850 11316_core_.Control_swigregister(Control)
b2dc1044 11317ControlNameStr = cvar.ControlNameStr
d14a1e28
RD
11318
11319def PreControl(*args, **kwargs):
15afbcd0
RD
11320 """
11321 PreControl() -> Control
11322
11323 Precreate a Control control for 2-phase creation
11324 """
54f9ee45 11325 val = _core_.new_PreControl(*args, **kwargs)
d14a1e28
RD
11326 return val
11327
74a57fcd 11328def Control_GetClassDefaultAttributes(*args, **kwargs):
0085ce49 11329 """
110da5b0
RD
11330 Control_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
11331
11332 Get the default attributes for this class. This is useful if you want
11333 to use the same font or colour in your own control as in a standard
11334 control -- which is a much better idea than hard coding specific
11335 colours or fonts which might look completely out of place on the
11336 user's system, especially if it uses themes.
11337
11338 The variant parameter is only relevant under Mac currently and is
11339 ignore under other platforms. Under Mac, it will change the size of
11340 the returned font. See `wx.Window.SetWindowVariant` for more about
11341 this.
11342 """
0085ce49 11343 return _core_.Control_GetClassDefaultAttributes(*args, **kwargs)
74a57fcd 11344
d14a1e28
RD
11345#---------------------------------------------------------------------------
11346
11347class ItemContainer(object):
15afbcd0 11348 """
53aa7709
RD
11349 The wx.ItemContainer class defines an interface which is implemented
11350 by all controls which have string subitems, each of which may be
11351 selected, such as `wx.ListBox`, `wx.CheckListBox`, `wx.Choice` as well
11352 as `wx.ComboBox` which implements an extended interface deriving from
41e2b43e 11353 this one.
15afbcd0 11354
41e2b43e
RD
11355 It defines the methods for accessing the control's items and although
11356 each of the derived classes implements them differently, they still
11357 all conform to the same interface.
15afbcd0 11358
41e2b43e
RD
11359 The items in a wx.ItemContainer have (non empty) string labels and,
11360 optionally, client data associated with them.
15afbcd0
RD
11361
11362 """
0085ce49
RD
11363 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11364 def __init__(self): raise AttributeError, "No constructor defined"
11365 __repr__ = _swig_repr
e811c8ce 11366 def Append(*args, **kwargs):
15afbcd0 11367 """
a95a7133 11368 Append(self, String item, PyObject clientData=None) -> int
15afbcd0 11369
41e2b43e
RD
11370 Adds the item to the control, associating the given data with the item
11371 if not None. The return value is the index of the newly added item
11372 which may be different from the last one if the control is sorted (e.g.
11373 has wx.LB_SORT or wx.CB_SORT style).
15afbcd0 11374 """
54f9ee45 11375 return _core_.ItemContainer_Append(*args, **kwargs)
e811c8ce
RD
11376
11377 def AppendItems(*args, **kwargs):
15afbcd0 11378 """
f5b96ee1 11379 AppendItems(self, List strings)
15afbcd0 11380
41e2b43e
RD
11381 Apend several items at once to the control. Notice that calling this
11382 method may be much faster than appending the items one by one if you
11383 need to add a lot of items.
15afbcd0 11384 """
54f9ee45 11385 return _core_.ItemContainer_AppendItems(*args, **kwargs)
e811c8ce
RD
11386
11387 def Insert(*args, **kwargs):
15afbcd0 11388 """
50f151d7 11389 Insert(self, String item, unsigned int pos, PyObject clientData=None) -> int
15afbcd0 11390
41e2b43e 11391 Insert an item into the control before the item at the ``pos`` index,
15afbcd0
RD
11392 optionally associating some data object with the item.
11393 """
54f9ee45 11394 return _core_.ItemContainer_Insert(*args, **kwargs)
e811c8ce
RD
11395
11396 def Clear(*args, **kwargs):
15afbcd0 11397 """
a95a7133 11398 Clear(self)
15afbcd0
RD
11399
11400 Removes all items from the control.
11401 """
54f9ee45 11402 return _core_.ItemContainer_Clear(*args, **kwargs)
e811c8ce
RD
11403
11404 def Delete(*args, **kwargs):
15afbcd0 11405 """
50f151d7 11406 Delete(self, unsigned int n)
15afbcd0 11407
41e2b43e
RD
11408 Deletes the item at the zero-based index 'n' from the control. Note
11409 that it is an error (signalled by a `wx.PyAssertionError` exception if
11410 enabled) to remove an item with the index negative or greater or equal
11411 than the number of items in the control.
15afbcd0 11412 """
54f9ee45 11413 return _core_.ItemContainer_Delete(*args, **kwargs)
e811c8ce 11414
53aa7709
RD
11415 def GetClientData(*args, **kwargs):
11416 """
50f151d7 11417 GetClientData(self, unsigned int n) -> PyObject
53aa7709
RD
11418
11419 Returns the client data associated with the given item, (if any.)
11420 """
11421 return _core_.ItemContainer_GetClientData(*args, **kwargs)
11422
11423 def SetClientData(*args, **kwargs):
11424 """
50f151d7 11425 SetClientData(self, unsigned int n, PyObject clientData)
53aa7709
RD
11426
11427 Associate the given client data with the item at position n.
11428 """
11429 return _core_.ItemContainer_SetClientData(*args, **kwargs)
11430
e811c8ce 11431 def GetCount(*args, **kwargs):
15afbcd0 11432 """
50f151d7 11433 GetCount(self) -> unsigned int
15afbcd0
RD
11434
11435 Returns the number of items in the control.
11436 """
54f9ee45 11437 return _core_.ItemContainer_GetCount(*args, **kwargs)
e811c8ce
RD
11438
11439 def IsEmpty(*args, **kwargs):
15afbcd0 11440 """
a95a7133 11441 IsEmpty(self) -> bool
15afbcd0
RD
11442
11443 Returns True if the control is empty or False if it has some items.
11444 """
54f9ee45 11445 return _core_.ItemContainer_IsEmpty(*args, **kwargs)
e811c8ce
RD
11446
11447 def GetString(*args, **kwargs):
15afbcd0 11448 """
50f151d7 11449 GetString(self, unsigned int n) -> String
15afbcd0
RD
11450
11451 Returns the label of the item with the given index.
11452 """
54f9ee45 11453 return _core_.ItemContainer_GetString(*args, **kwargs)
e811c8ce
RD
11454
11455 def GetStrings(*args, **kwargs):
a95a7133 11456 """GetStrings(self) -> wxArrayString"""
54f9ee45 11457 return _core_.ItemContainer_GetStrings(*args, **kwargs)
e811c8ce
RD
11458
11459 def SetString(*args, **kwargs):
15afbcd0 11460 """
50f151d7 11461 SetString(self, unsigned int n, String s)
15afbcd0
RD
11462
11463 Sets the label for the given item.
11464 """
54f9ee45 11465 return _core_.ItemContainer_SetString(*args, **kwargs)
e811c8ce
RD
11466
11467 def FindString(*args, **kwargs):
15afbcd0 11468 """
a95a7133 11469 FindString(self, String s) -> int
15afbcd0
RD
11470
11471 Finds an item whose label matches the given string. Returns the
41e2b43e
RD
11472 zero-based position of the item, or ``wx.NOT_FOUND`` if the string was not
11473 found.
15afbcd0 11474 """
54f9ee45 11475 return _core_.ItemContainer_FindString(*args, **kwargs)
e811c8ce 11476
53aa7709 11477 def SetSelection(*args, **kwargs):
15afbcd0 11478 """
53aa7709 11479 SetSelection(self, int n)
15afbcd0
RD
11480
11481 Sets the item at index 'n' to be the selected item.
11482 """
53aa7709 11483 return _core_.ItemContainer_SetSelection(*args, **kwargs)
e811c8ce
RD
11484
11485 def GetSelection(*args, **kwargs):
15afbcd0 11486 """
a95a7133 11487 GetSelection(self) -> int
15afbcd0 11488
41e2b43e
RD
11489 Returns the index of the selected item or ``wx.NOT_FOUND`` if no item
11490 is selected.
15afbcd0 11491 """
54f9ee45 11492 return _core_.ItemContainer_GetSelection(*args, **kwargs)
e811c8ce 11493
53aa7709
RD
11494 def SetStringSelection(*args, **kwargs):
11495 """SetStringSelection(self, String s) -> bool"""
11496 return _core_.ItemContainer_SetStringSelection(*args, **kwargs)
11497
e811c8ce 11498 def GetStringSelection(*args, **kwargs):
15afbcd0 11499 """
a95a7133 11500 GetStringSelection(self) -> String
15afbcd0 11501
41e2b43e
RD
11502 Returns the label of the selected item or an empty string if no item
11503 is selected.
15afbcd0 11504 """
54f9ee45 11505 return _core_.ItemContainer_GetStringSelection(*args, **kwargs)
e811c8ce 11506
53aa7709 11507 def Select(*args, **kwargs):
15afbcd0 11508 """
53aa7709 11509 Select(self, int n)
15afbcd0 11510
53aa7709
RD
11511 This is the same as `SetSelection` and exists only because it is
11512 slightly more natural for controls which support multiple selection.
15afbcd0 11513 """
53aa7709 11514 return _core_.ItemContainer_Select(*args, **kwargs)
e811c8ce 11515
97ab0f6a
RD
11516 def GetItems(self):
11517 """Return a list of the strings in the control"""
11518 return [self.GetString(i) for i in xrange(self.GetCount())]
11519
11520 def SetItems(self, items):
11521 """Clear and set the strings in the control from a list"""
11522 self.Clear()
11523 for i in items:
11524 self.Append(i)
11525
11526 Count = property(GetCount,doc="See `GetCount`")
11527 Items = property(GetItems,SetItems,doc="See `GetItems` and `SetItems`")
11528 Selection = property(GetSelection,SetSelection,doc="See `GetSelection` and `SetSelection`")
11529 StringSelection = property(GetStringSelection,SetStringSelection,doc="See `GetStringSelection` and `SetStringSelection`")
11530 Strings = property(GetStrings,doc="See `GetStrings`")
2131d850 11531_core_.ItemContainer_swigregister(ItemContainer)
d14a1e28
RD
11532
11533#---------------------------------------------------------------------------
11534
11535class ControlWithItems(Control,ItemContainer):
15afbcd0 11536 """
41e2b43e
RD
11537 wx.ControlWithItems combines the ``wx.ItemContainer`` class with the
11538 wx.Control class, and is used for the base class of various controls
11539 that have items.
15afbcd0 11540 """
0085ce49
RD
11541 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11542 def __init__(self): raise AttributeError, "No constructor defined"
11543 __repr__ = _swig_repr
2131d850 11544_core_.ControlWithItems_swigregister(ControlWithItems)
d14a1e28
RD
11545
11546#---------------------------------------------------------------------------
11547
11548class SizerItem(Object):
248ed943
RD
11549 """
11550 The wx.SizerItem class is used to track the position, size and other
01f6b6d3
RD
11551 attributes of each item managed by a `wx.Sizer`. It is not usually
11552 necessary to use this class because the sizer elements can also be
11553 identified by their positions or window or sizer references but
11554 sometimes it may be more convenient to use wx.SizerItem directly.
11555 Also, custom classes derived from `wx.PySizer` will probably need to
11556 use the collection of wx.SizerItems held by wx.Sizer when calculating
11557 layout.
248ed943
RD
11558
11559 :see: `wx.Sizer`, `wx.GBSizerItem`
11560 """
0085ce49
RD
11561 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11562 __repr__ = _swig_repr
11563 def __init__(self, *args, **kwargs):
248ed943
RD
11564 """
11565 __init__(self) -> SizerItem
11566
11567 Constructs an empty wx.SizerItem. Either a window, sizer or spacer
11568 size will need to be set before this item can be used in a Sizer.
11569
11570 You will probably never need to create a wx.SizerItem directly as they
11571 are created automatically when the sizer's Add, Insert or Prepend
11572 methods are called.
11573
11574 :see: `wx.SizerItemSpacer`, `wx.SizerItemWindow`, `wx.SizerItemSizer`
11575 """
0085ce49
RD
11576 _core_.SizerItem_swiginit(self,_core_.new_SizerItem(*args, **kwargs))
11577 __swig_destroy__ = _core_.delete_SizerItem
11578 __del__ = lambda self : None;
e811c8ce 11579 def DeleteWindows(*args, **kwargs):
248ed943
RD
11580 """
11581 DeleteWindows(self)
11582
11583 Destroy the window or the windows in a subsizer, depending on the type
11584 of item.
11585 """
54f9ee45 11586 return _core_.SizerItem_DeleteWindows(*args, **kwargs)
e811c8ce
RD
11587
11588 def DetachSizer(*args, **kwargs):
248ed943
RD
11589 """
11590 DetachSizer(self)
11591
11592 Enable deleting the SizerItem without destroying the contained sizer.
11593 """
54f9ee45 11594 return _core_.SizerItem_DetachSizer(*args, **kwargs)
e811c8ce
RD
11595
11596 def GetSize(*args, **kwargs):
248ed943
RD
11597 """
11598 GetSize(self) -> Size
11599
11600 Get the current size of the item, as set in the last Layout.
11601 """
54f9ee45 11602 return _core_.SizerItem_GetSize(*args, **kwargs)
e811c8ce
RD
11603
11604 def CalcMin(*args, **kwargs):
248ed943
RD
11605 """
11606 CalcMin(self) -> Size
11607
11608 Calculates the minimum desired size for the item, including any space
11609 needed by borders.
11610 """
54f9ee45 11611 return _core_.SizerItem_CalcMin(*args, **kwargs)
e811c8ce
RD
11612
11613 def SetDimension(*args, **kwargs):
248ed943
RD
11614 """
11615 SetDimension(self, Point pos, Size size)
11616
11617 Set the position and size of the space allocated for this item by the
11618 sizer, and adjust the position and size of the item (window or
11619 subsizer) to be within that space taking alignment and borders into
11620 account.
11621 """
54f9ee45 11622 return _core_.SizerItem_SetDimension(*args, **kwargs)
e811c8ce
RD
11623
11624 def GetMinSize(*args, **kwargs):
248ed943
RD
11625 """
11626 GetMinSize(self) -> Size
11627
11628 Get the minimum size needed for the item.
11629 """
54f9ee45 11630 return _core_.SizerItem_GetMinSize(*args, **kwargs)
e811c8ce 11631
dfbb5885
RD
11632 def GetMinSizeWithBorder(*args, **kwargs):
11633 """
11634 GetMinSizeWithBorder(self) -> Size
11635
11636 Get the minimum size needed for the item with space for the borders
11637 added, if needed.
11638 """
11639 return _core_.SizerItem_GetMinSizeWithBorder(*args, **kwargs)
11640
e811c8ce 11641 def SetInitSize(*args, **kwargs):
a95a7133 11642 """SetInitSize(self, int x, int y)"""
54f9ee45 11643 return _core_.SizerItem_SetInitSize(*args, **kwargs)
e811c8ce
RD
11644
11645 def SetRatioWH(*args, **kwargs):
248ed943
RD
11646 """
11647 SetRatioWH(self, int width, int height)
11648
11649 Set the ratio item attribute.
11650 """
54f9ee45 11651 return _core_.SizerItem_SetRatioWH(*args, **kwargs)
e811c8ce
RD
11652
11653 def SetRatioSize(*args, **kwargs):
248ed943
RD
11654 """
11655 SetRatioSize(self, Size size)
11656
11657 Set the ratio item attribute.
11658 """
54f9ee45 11659 return _core_.SizerItem_SetRatioSize(*args, **kwargs)
e811c8ce
RD
11660
11661 def SetRatio(*args, **kwargs):
248ed943
RD
11662 """
11663 SetRatio(self, float ratio)
11664
11665 Set the ratio item attribute.
11666 """
54f9ee45 11667 return _core_.SizerItem_SetRatio(*args, **kwargs)
e811c8ce
RD
11668
11669 def GetRatio(*args, **kwargs):
248ed943
RD
11670 """
11671 GetRatio(self) -> float
11672
11673 Set the ratio item attribute.
11674 """
54f9ee45 11675 return _core_.SizerItem_GetRatio(*args, **kwargs)
e811c8ce 11676
d3b6e4ff
RD
11677 def GetRect(*args, **kwargs):
11678 """
11679 GetRect(self) -> Rect
11680
11681 Returns the rectangle that the sizer item should occupy
11682 """
11683 return _core_.SizerItem_GetRect(*args, **kwargs)
11684
e811c8ce 11685 def IsWindow(*args, **kwargs):
248ed943
RD
11686 """
11687 IsWindow(self) -> bool
11688
11689 Is this sizer item a window?
11690 """
54f9ee45 11691 return _core_.SizerItem_IsWindow(*args, **kwargs)
e811c8ce
RD
11692
11693 def IsSizer(*args, **kwargs):
248ed943
RD
11694 """
11695 IsSizer(self) -> bool
11696
11697 Is this sizer item a subsizer?
11698 """
54f9ee45 11699 return _core_.SizerItem_IsSizer(*args, **kwargs)
e811c8ce
RD
11700
11701 def IsSpacer(*args, **kwargs):
248ed943
RD
11702 """
11703 IsSpacer(self) -> bool
11704
11705 Is this sizer item a spacer?
11706 """
54f9ee45 11707 return _core_.SizerItem_IsSpacer(*args, **kwargs)
e811c8ce
RD
11708
11709 def SetProportion(*args, **kwargs):
248ed943
RD
11710 """
11711 SetProportion(self, int proportion)
11712
11713 Set the proportion value for this item.
11714 """
54f9ee45 11715 return _core_.SizerItem_SetProportion(*args, **kwargs)
e811c8ce
RD
11716
11717 def GetProportion(*args, **kwargs):
248ed943
RD
11718 """
11719 GetProportion(self) -> int
11720
11721 Get the proportion value for this item.
11722 """
54f9ee45 11723 return _core_.SizerItem_GetProportion(*args, **kwargs)
e811c8ce 11724
248ed943
RD
11725 SetOption = wx._deprecated(SetProportion, "Please use `SetProportion` instead.")
11726 GetOption = wx._deprecated(GetProportion, "Please use `GetProportion` instead.")
e811c8ce 11727 def SetFlag(*args, **kwargs):
248ed943
RD
11728 """
11729 SetFlag(self, int flag)
11730
11731 Set the flag value for this item.
11732 """
54f9ee45 11733 return _core_.SizerItem_SetFlag(*args, **kwargs)
e811c8ce
RD
11734
11735 def GetFlag(*args, **kwargs):
248ed943
RD
11736 """
11737 GetFlag(self) -> int
11738
11739 Get the flag value for this item.
11740 """
54f9ee45 11741 return _core_.SizerItem_GetFlag(*args, **kwargs)
e811c8ce
RD
11742
11743 def SetBorder(*args, **kwargs):
248ed943
RD
11744 """
11745 SetBorder(self, int border)
11746
11747 Set the border value for this item.
11748 """
54f9ee45 11749 return _core_.SizerItem_SetBorder(*args, **kwargs)
e811c8ce
RD
11750
11751 def GetBorder(*args, **kwargs):
248ed943
RD
11752 """
11753 GetBorder(self) -> int
11754
11755 Get the border value for this item.
11756 """
54f9ee45 11757 return _core_.SizerItem_GetBorder(*args, **kwargs)
e811c8ce
RD
11758
11759 def GetWindow(*args, **kwargs):
248ed943
RD
11760 """
11761 GetWindow(self) -> Window
11762
11763 Get the window (if any) that is managed by this sizer item.
11764 """
54f9ee45 11765 return _core_.SizerItem_GetWindow(*args, **kwargs)
e811c8ce
RD
11766
11767 def SetWindow(*args, **kwargs):
248ed943
RD
11768 """
11769 SetWindow(self, Window window)
11770
11771 Set the window to be managed by this sizer item.
11772 """
54f9ee45 11773 return _core_.SizerItem_SetWindow(*args, **kwargs)
e811c8ce
RD
11774
11775 def GetSizer(*args, **kwargs):
248ed943
RD
11776 """
11777 GetSizer(self) -> Sizer
11778
11779 Get the subsizer (if any) that is managed by this sizer item.
11780 """
54f9ee45 11781 return _core_.SizerItem_GetSizer(*args, **kwargs)
e811c8ce
RD
11782
11783 def SetSizer(*args, **kwargs):
248ed943
RD
11784 """
11785 SetSizer(self, Sizer sizer)
11786
11787 Set the subsizer to be managed by this sizer item.
11788 """
54f9ee45 11789 return _core_.SizerItem_SetSizer(*args, **kwargs)
e811c8ce
RD
11790
11791 def GetSpacer(*args, **kwargs):
248ed943
RD
11792 """
11793 GetSpacer(self) -> Size
11794
11795 Get the size of the spacer managed by this sizer item.
11796 """
54f9ee45 11797 return _core_.SizerItem_GetSpacer(*args, **kwargs)
e811c8ce
RD
11798
11799 def SetSpacer(*args, **kwargs):
248ed943
RD
11800 """
11801 SetSpacer(self, Size size)
11802
11803 Set the size of the spacer to be managed by this sizer item.
11804 """
54f9ee45 11805 return _core_.SizerItem_SetSpacer(*args, **kwargs)
e811c8ce
RD
11806
11807 def Show(*args, **kwargs):
248ed943
RD
11808 """
11809 Show(self, bool show)
11810
11811 Set the show item attribute, which sizers use to determine if the item
11812 is to be made part of the layout or not. If the item is tracking a
11813 window then it is shown or hidden as needed.
11814 """
54f9ee45 11815 return _core_.SizerItem_Show(*args, **kwargs)
e811c8ce
RD
11816
11817 def IsShown(*args, **kwargs):
248ed943
RD
11818 """
11819 IsShown(self) -> bool
11820
11821 Is the item to be shown in the layout?
11822 """
54f9ee45 11823 return _core_.SizerItem_IsShown(*args, **kwargs)
e811c8ce
RD
11824
11825 def GetPosition(*args, **kwargs):
248ed943
RD
11826 """
11827 GetPosition(self) -> Point
11828
11829 Returns the current position of the item, as set in the last Layout.
11830 """
54f9ee45 11831 return _core_.SizerItem_GetPosition(*args, **kwargs)
e811c8ce
RD
11832
11833 def GetUserData(*args, **kwargs):
248ed943
RD
11834 """
11835 GetUserData(self) -> PyObject
11836
11837 Returns the userData associated with this sizer item, or None if there
11838 isn't any.
11839 """
54f9ee45 11840 return _core_.SizerItem_GetUserData(*args, **kwargs)
e811c8ce 11841
091f5bed
RD
11842 def SetUserData(*args, **kwargs):
11843 """
11844 SetUserData(self, PyObject userData)
11845
11846 Associate a Python object with this sizer item.
11847 """
11848 return _core_.SizerItem_SetUserData(*args, **kwargs)
11849
33d6fd3b
RD
11850 Border = property(GetBorder,SetBorder,doc="See `GetBorder` and `SetBorder`")
11851 Flag = property(GetFlag,SetFlag,doc="See `GetFlag` and `SetFlag`")
11852 MinSize = property(GetMinSize,doc="See `GetMinSize`")
11853 MinSizeWithBorder = property(GetMinSizeWithBorder,doc="See `GetMinSizeWithBorder`")
11854 Position = property(GetPosition,doc="See `GetPosition`")
11855 Proportion = property(GetProportion,SetProportion,doc="See `GetProportion` and `SetProportion`")
11856 Ratio = property(GetRatio,SetRatio,doc="See `GetRatio` and `SetRatio`")
11857 Rect = property(GetRect,doc="See `GetRect`")
11858 Size = property(GetSize,doc="See `GetSize`")
11859 Sizer = property(GetSizer,SetSizer,doc="See `GetSizer` and `SetSizer`")
11860 Spacer = property(GetSpacer,SetSpacer,doc="See `GetSpacer` and `SetSpacer`")
11861 UserData = property(GetUserData,SetUserData,doc="See `GetUserData` and `SetUserData`")
11862 Window = property(GetWindow,SetWindow,doc="See `GetWindow` and `SetWindow`")
2131d850 11863_core_.SizerItem_swigregister(SizerItem)
d14a1e28 11864
248ed943 11865def SizerItemWindow(*args, **kwargs):
0df68c9f 11866 """
248ed943
RD
11867 SizerItemWindow(Window window, int proportion, int flag, int border,
11868 PyObject userData=None) -> SizerItem
11869
11870 Constructs a `wx.SizerItem` for tracking a window.
0df68c9f 11871 """
248ed943 11872 val = _core_.new_SizerItemWindow(*args, **kwargs)
d14a1e28
RD
11873 return val
11874
248ed943 11875def SizerItemSpacer(*args, **kwargs):
0df68c9f 11876 """
248ed943
RD
11877 SizerItemSpacer(int width, int height, int proportion, int flag, int border,
11878 PyObject userData=None) -> SizerItem
11879
11880 Constructs a `wx.SizerItem` for tracking a spacer.
0df68c9f 11881 """
248ed943 11882 val = _core_.new_SizerItemSpacer(*args, **kwargs)
d14a1e28
RD
11883 return val
11884
11885def SizerItemSizer(*args, **kwargs):
0df68c9f
RD
11886 """
11887 SizerItemSizer(Sizer sizer, int proportion, int flag, int border,
248ed943
RD
11888 PyObject userData=None) -> SizerItem
11889
11890 Constructs a `wx.SizerItem` for tracking a subsizer
0df68c9f 11891 """
54f9ee45 11892 val = _core_.new_SizerItemSizer(*args, **kwargs)
d14a1e28
RD
11893 return val
11894
11895class Sizer(Object):
248ed943
RD
11896 """
11897 wx.Sizer is the abstract base class used for laying out subwindows in
11898 a window. You cannot use wx.Sizer directly; instead, you will have to
11899 use one of the sizer classes derived from it such as `wx.BoxSizer`,
1d5ee749
RD
11900 `wx.StaticBoxSizer`, `wx.GridSizer`, `wx.FlexGridSizer` and
11901 `wx.GridBagSizer`.
248ed943
RD
11902
11903 The concept implemented by sizers in wxWidgets is closely related to
11904 layout tools in other GUI toolkits, such as Java's AWT, the GTK
11905 toolkit or the Qt toolkit. It is based upon the idea of the individual
11906 subwindows reporting their minimal required size and their ability to
11907 get stretched if the size of the parent window has changed. This will
11908 most often mean that the programmer does not set the original size of
11909 a dialog in the beginning, rather the dialog will assigned a sizer and
11910 this sizer will be queried about the recommended size. The sizer in
11911 turn will query its children, which can be normal windows or contorls,
11912 empty space or other sizers, so that a hierarchy of sizers can be
11913 constructed. Note that wxSizer does not derive from wxWindow and thus
11914 do not interfere with tab ordering and requires very little resources
11915 compared to a real window on screen.
11916
11917 What makes sizers so well fitted for use in wxWidgets is the fact that
11918 every control reports its own minimal size and the algorithm can
11919 handle differences in font sizes or different window (dialog item)
11920 sizes on different platforms without problems. If for example the
11921 standard font as well as the overall design of Mac widgets requires
11922 more space than on Windows, then the initial size of a dialog using a
11923 sizer will automatically be bigger on Mac than on Windows.
11924 """
0085ce49
RD
11925 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11926 def __init__(self): raise AttributeError, "No constructor defined"
11927 __repr__ = _swig_repr
11928 __swig_destroy__ = _core_.delete_Sizer
11929 __del__ = lambda self : None;
e811c8ce 11930 def _setOORInfo(*args, **kwargs):
a95a7133 11931 """_setOORInfo(self, PyObject _self)"""
54f9ee45 11932 return _core_.Sizer__setOORInfo(*args, **kwargs)
e811c8ce
RD
11933
11934 def Add(*args, **kwargs):
0df68c9f 11935 """
248ed943 11936 Add(self, item, int proportion=0, int flag=0, int border=0,
d3b6e4ff 11937 PyObject userData=None) -> wx.SizerItem
248ed943
RD
11938
11939 Appends a child item to the sizer.
0df68c9f 11940 """
54f9ee45 11941 return _core_.Sizer_Add(*args, **kwargs)
e811c8ce
RD
11942
11943 def Insert(*args, **kwargs):
0df68c9f 11944 """
248ed943 11945 Insert(self, int before, item, int proportion=0, int flag=0, int border=0,
d3b6e4ff 11946 PyObject userData=None) -> wx.SizerItem
248ed943
RD
11947
11948 Inserts a new item into the list of items managed by this sizer before
11949 the item at index *before*. See `Add` for a description of the parameters.
0df68c9f 11950 """
54f9ee45 11951 return _core_.Sizer_Insert(*args, **kwargs)
e811c8ce
RD
11952
11953 def Prepend(*args, **kwargs):
0df68c9f 11954 """
248ed943 11955 Prepend(self, item, int proportion=0, int flag=0, int border=0,
d3b6e4ff 11956 PyObject userData=None) -> wx.SizerItem
248ed943
RD
11957
11958 Adds a new item to the begining of the list of sizer items managed by
11959 this sizer. See `Add` for a description of the parameters.
0df68c9f 11960 """
54f9ee45 11961 return _core_.Sizer_Prepend(*args, **kwargs)
e811c8ce
RD
11962
11963 def Remove(*args, **kwargs):
248ed943
RD
11964 """
11965 Remove(self, item) -> bool
11966
11967 Removes an item from the sizer and destroys it. This method does not
11968 cause any layout or resizing to take place, call `Layout` to update
11969 the layout on screen after removing a child from the sizer. The
11970 *item* parameter can be either a window, a sizer, or the zero-based
11971 index of an item to remove. Returns True if the child item was found
11972 and removed.
11973 """
54f9ee45 11974 return _core_.Sizer_Remove(*args, **kwargs)
e811c8ce 11975
1c0f361b 11976 def Detach(*args, **kwargs):
248ed943
RD
11977 """
11978 Detach(self, item) -> bool
11979
11980 Detaches an item from the sizer without destroying it. This method
11981 does not cause any layout or resizing to take place, call `Layout` to
11982 do so. The *item* parameter can be either a window, a sizer, or the
11983 zero-based index of the item to be detached. Returns True if the child item
11984 was found and detached.
11985 """
1c0f361b
RD
11986 return _core_.Sizer_Detach(*args, **kwargs)
11987
d3b6e4ff
RD
11988 def GetItem(*args, **kwargs):
11989 """
11990 GetItem(self, item) -> wx.SizerItem
11991
11992 Returns the `wx.SizerItem` which holds the *item* given. The *item*
11993 parameter can be either a window, a sizer, or the zero-based index of
4d170c95 11994 the item to be found.
d3b6e4ff
RD
11995 """
11996 return _core_.Sizer_GetItem(*args, **kwargs)
11997
e811c8ce 11998 def _SetItemMinSize(*args, **kwargs):
a95a7133 11999 """_SetItemMinSize(self, PyObject item, Size size)"""
54f9ee45 12000 return _core_.Sizer__SetItemMinSize(*args, **kwargs)
e811c8ce 12001
97ab0f6a
RD
12002 def _ReplaceWin(*args, **kwargs):
12003 """_ReplaceWin(self, Window oldwin, Window newwin, bool recursive=False) -> bool"""
12004 return _core_.Sizer__ReplaceWin(*args, **kwargs)
12005
12006 def _ReplaceSizer(*args, **kwargs):
12007 """_ReplaceSizer(self, Sizer oldsz, Sizer newsz, bool recursive=False) -> bool"""
12008 return _core_.Sizer__ReplaceSizer(*args, **kwargs)
12009
12010 def _ReplaceItem(*args, **kwargs):
12011 """_ReplaceItem(self, size_t index, SizerItem newitem) -> bool"""
12012 return _core_.Sizer__ReplaceItem(*args, **kwargs)
12013
12014 def Replace(self, olditem, item, recursive=False):
12015 """
12016 Detaches the given ``olditem`` from the sizer and replaces it with
12017 ``item`` which can be a window, sizer, or `wx.SizerItem`. The
12018 detached child is destroyed only if it is not a window, (because
12019 windows are owned by their parent, not the sizer.) The
12020 ``recursive`` parameter can be used to search for the given
12021 element recursivly in subsizers.
12022
12023 This method does not cause any layout or resizing to take place,
12024 call `Layout` to do so.
12025
12026 Returns ``True`` if the child item was found and removed.
12027 """
12028 if isinstance(olditem, wx.Window):
12029 return self._ReplaceWin(olditem, item, recursive)
12030 elif isinstnace(olditem, wx.Sizer):
12031 return self._ReplaceSizer(olditem, item, recursive)
12032 elif isinstnace(olditem, int):
12033 return self._ReplaceItem(olditem, item)
12034 else:
12035 raise TypeError("Expected Window, Sizer, or integer for first parameter.")
12036
12037 def SetContainingWindow(*args, **kwargs):
12038 """
12039 SetContainingWindow(self, Window window)
12040
12041 Set (or unset) the window this sizer is used in.
12042 """
12043 return _core_.Sizer_SetContainingWindow(*args, **kwargs)
12044
12045 def GetContainingWindow(*args, **kwargs):
12046 """
12047 GetContainingWindow(self) -> Window
12048
12049 Get the window this sizer is used in.
12050 """
12051 return _core_.Sizer_GetContainingWindow(*args, **kwargs)
12052
248ed943
RD
12053 def SetItemMinSize(self, item, *args):
12054 """
12055 SetItemMinSize(self, item, Size size)
12056
12057 Sets the minimum size that will be allocated for an item in the sizer.
12058 The *item* parameter can be either a window, a sizer, or the
12059 zero-based index of the item. If a window or sizer is given then it
12060 will be searched for recursivly in subsizers if neccessary.
12061 """
12062 if len(args) == 2:
12063 # for backward compatibility accept separate width,height args too
12064 return self._SetItemMinSize(item, args)
12065 else:
12066 return self._SetItemMinSize(item, args[0])
12067
e811c8ce 12068 def AddItem(*args, **kwargs):
248ed943
RD
12069 """
12070 AddItem(self, SizerItem item)
12071
12072 Adds a `wx.SizerItem` to the sizer.
12073 """
54f9ee45 12074 return _core_.Sizer_AddItem(*args, **kwargs)
e811c8ce
RD
12075
12076 def InsertItem(*args, **kwargs):
248ed943
RD
12077 """
12078 InsertItem(self, int index, SizerItem item)
12079
12080 Inserts a `wx.SizerItem` to the sizer at the position given by *index*.
12081 """
54f9ee45 12082 return _core_.Sizer_InsertItem(*args, **kwargs)
e811c8ce
RD
12083
12084 def PrependItem(*args, **kwargs):
248ed943
RD
12085 """
12086 PrependItem(self, SizerItem item)
12087
12088 Prepends a `wx.SizerItem` to the sizer.
12089 """
54f9ee45 12090 return _core_.Sizer_PrependItem(*args, **kwargs)
e811c8ce 12091
248ed943 12092 def AddMany(self, items):
66c033b4
RD
12093 """
12094 AddMany is a convenience method for adding several items
12095 to a sizer at one time. Simply pass it a list of tuples,
12096 where each tuple consists of the parameters that you
12097 would normally pass to the `Add` method.
12098 """
248ed943
RD
12099 for item in items:
12100 if type(item) != type(()) or (len(item) == 2 and type(item[0]) == type(1)):
12101 item = (item, )
12102 self.Add(*item)
d14a1e28 12103
ae5bc7f3
RD
12104 def AddSpacer(self, *args, **kw):
12105 """AddSpacer(int size) --> SizerItem
12106
12107 Add a spacer that is (size,size) pixels.
12108 """
12109 if args and type(args[0]) == int:
12110 return self.Add( (args[0],args[0] ), 0)
12111 else: # otherwise stay compatible with old AddSpacer
12112 return self.Add(*args, **kw)
12113 def PrependSpacer(self, *args, **kw):
12114 """PrependSpacer(int size) --> SizerItem
12115
12116 Prepend a spacer that is (size, size) pixels."""
12117 if args and type(args[0]) == int:
12118 return self.Prepend( (args[0],args[0] ), 0)
12119 else: # otherwise stay compatible with old PrependSpacer
12120 return self.Prepend(*args, **kw)
12121 def InsertSpacer(self, index, *args, **kw):
12122 """InsertSpacer(int index, int size) --> SizerItem
12123
12124 Insert a spacer at position index that is (size, size) pixels."""
12125 if args and type(args[0]) == int:
12126 return self.Insert( index, (args[0],args[0] ), 0)
12127 else: # otherwise stay compatible with old InsertSpacer
12128 return self.Insert(index, *args, **kw)
12129
12130
12131 def AddStretchSpacer(self, prop=1):
12132 """AddStretchSpacer(int prop=1) --> SizerItem
12133
12134 Add a stretchable spacer."""
12135 return self.Add((0,0), prop)
12136 def PrependStretchSpacer(self, prop=1):
12137 """PrependStretchSpacer(int prop=1) --> SizerItem
12138
12139 Prepend a stretchable spacer."""
12140 return self.Prepend((0,0), prop)
12141 def InsertStretchSpacer(self, index, prop=1):
12142 """InsertStretchSpacer(int index, int prop=1) --> SizerItem
12143
12144 Insert a stretchable spacer."""
12145 return self.Insert(index, (0,0), prop)
12146
12147
74e96f3d 12148 # for backwards compatibility only, please do not use in new code
b9d6a5f3
RD
12149 def AddWindow(self, *args, **kw):
12150 """Compatibility alias for `Add`."""
12151 return self.Add(*args, **kw)
12152 def AddSizer(self, *args, **kw):
12153 """Compatibility alias for `Add`."""
12154 return self.Add(*args, **kw)
b9d6a5f3
RD
12155
12156 def PrependWindow(self, *args, **kw):
12157 """Compatibility alias for `Prepend`."""
12158 return self.Prepend(*args, **kw)
12159 def PrependSizer(self, *args, **kw):
12160 """Compatibility alias for `Prepend`."""
12161 return self.Prepend(*args, **kw)
b9d6a5f3
RD
12162
12163 def InsertWindow(self, *args, **kw):
12164 """Compatibility alias for `Insert`."""
12165 return self.Insert(*args, **kw)
12166 def InsertSizer(self, *args, **kw):
12167 """Compatibility alias for `Insert`."""
b9d6a5f3
RD
12168 return self.Insert(*args, **kw)
12169
12170 def RemoveWindow(self, *args, **kw):
12171 """Compatibility alias for `Remove`."""
12172 return self.Remove(*args, **kw)
12173 def RemoveSizer(self, *args, **kw):
12174 """Compatibility alias for `Remove`."""
12175 return self.Remove(*args, **kw)
12176 def RemovePos(self, *args, **kw):
12177 """Compatibility alias for `Remove`."""
12178 return self.Remove(*args, **kw)
d14a1e28
RD
12179
12180
e811c8ce 12181 def SetDimension(*args, **kwargs):
248ed943
RD
12182 """
12183 SetDimension(self, int x, int y, int width, int height)
12184
12185 Call this to force the sizer to take the given dimension and thus
12186 force the items owned by the sizer to resize themselves according to
12187 the rules defined by the parameter in the `Add`, `Insert` or `Prepend`
12188 methods.
12189 """
54f9ee45 12190 return _core_.Sizer_SetDimension(*args, **kwargs)
e811c8ce
RD
12191
12192 def SetMinSize(*args, **kwargs):
248ed943
RD
12193 """
12194 SetMinSize(self, Size size)
12195
12196 Call this to give the sizer a minimal size. Normally, the sizer will
12197 calculate its minimal size based purely on how much space its children
12198 need. After calling this method `GetMinSize` will return either the
12199 minimal size as requested by its children or the minimal size set
12200 here, depending on which is bigger.
12201 """
54f9ee45 12202 return _core_.Sizer_SetMinSize(*args, **kwargs)
e811c8ce
RD
12203
12204 def GetSize(*args, **kwargs):
248ed943
RD
12205 """
12206 GetSize(self) -> Size
12207
12208 Returns the current size of the space managed by the sizer.
12209 """
54f9ee45 12210 return _core_.Sizer_GetSize(*args, **kwargs)
e811c8ce
RD
12211
12212 def GetPosition(*args, **kwargs):
248ed943
RD
12213 """
12214 GetPosition(self) -> Point
12215
12216 Returns the current position of the sizer's managed space.
12217 """
54f9ee45 12218 return _core_.Sizer_GetPosition(*args, **kwargs)
e811c8ce
RD
12219
12220 def GetMinSize(*args, **kwargs):
248ed943
RD
12221 """
12222 GetMinSize(self) -> Size
12223
12224 Returns the minimal size of the sizer. This is either the combined
12225 minimal size of all the children and their borders or the minimal size
12226 set by SetMinSize, depending on which is bigger.
12227 """
54f9ee45 12228 return _core_.Sizer_GetMinSize(*args, **kwargs)
e811c8ce 12229
d14a1e28 12230 def GetSizeTuple(self):
1c0f361b 12231 return self.GetSize().Get()
d14a1e28 12232 def GetPositionTuple(self):
1c0f361b 12233 return self.GetPosition().Get()
d14a1e28 12234 def GetMinSizeTuple(self):
1c0f361b 12235 return self.GetMinSize().Get()
d14a1e28 12236
e811c8ce 12237 def RecalcSizes(*args, **kwargs):
248ed943
RD
12238 """
12239 RecalcSizes(self)
12240
12241 Using the sizes calculated by `CalcMin` reposition and resize all the
12242 items managed by this sizer. You should not need to call this directly as
12243 it is called by `Layout`.
12244 """
54f9ee45 12245 return _core_.Sizer_RecalcSizes(*args, **kwargs)
e811c8ce
RD
12246
12247 def CalcMin(*args, **kwargs):
248ed943
RD
12248 """
12249 CalcMin(self) -> Size
12250
12251 This method is where the sizer will do the actual calculation of its
12252 children's minimal sizes. You should not need to call this directly as
12253 it is called by `Layout`.
12254 """
54f9ee45 12255 return _core_.Sizer_CalcMin(*args, **kwargs)
e811c8ce
RD
12256
12257 def Layout(*args, **kwargs):
248ed943
RD
12258 """
12259 Layout(self)
12260
12261 This method will force the recalculation and layout of the items
12262 controlled by the sizer using the current space allocated to the
12263 sizer. Normally this is called automatically from the owning window's
12264 EVT_SIZE handler, but it is also useful to call it from user code when
12265 one of the items in a sizer change size, or items are added or
12266 removed.
12267 """
54f9ee45 12268 return _core_.Sizer_Layout(*args, **kwargs)
e811c8ce
RD
12269
12270 def Fit(*args, **kwargs):
248ed943
RD
12271 """
12272 Fit(self, Window window) -> Size
12273
12274 Tell the sizer to resize the *window* to match the sizer's minimal
12275 size. This is commonly done in the constructor of the window itself in
12276 order to set its initial size to match the needs of the children as
12277 determined by the sizer. Returns the new size.
12278
12279 For a top level window this is the total window size, not the client size.
12280 """
54f9ee45 12281 return _core_.Sizer_Fit(*args, **kwargs)
e811c8ce
RD
12282
12283 def FitInside(*args, **kwargs):
248ed943
RD
12284 """
12285 FitInside(self, Window window)
12286
12287 Tell the sizer to resize the *virtual size* of the *window* to match the
12288 sizer's minimal size. This will not alter the on screen size of the
12289 window, but may cause the addition/removal/alteration of scrollbars
12290 required to view the virtual area in windows which manage it.
12291
12292 :see: `wx.ScrolledWindow.SetScrollbars`, `SetVirtualSizeHints`
12293
12294 """
54f9ee45 12295 return _core_.Sizer_FitInside(*args, **kwargs)
e811c8ce
RD
12296
12297 def SetSizeHints(*args, **kwargs):
248ed943
RD
12298 """
12299 SetSizeHints(self, Window window)
12300
12301 Tell the sizer to set (and `Fit`) the minimal size of the *window* to
12302 match the sizer's minimal size. This is commonly done in the
12303 constructor of the window itself if the window is resizable (as are
12304 many dialogs under Unix and frames on probably all platforms) in order
12305 to prevent the window from being sized smaller than the minimal size
12306 required by the sizer.
12307 """
54f9ee45 12308 return _core_.Sizer_SetSizeHints(*args, **kwargs)
e811c8ce
RD
12309
12310 def SetVirtualSizeHints(*args, **kwargs):
248ed943
RD
12311 """
12312 SetVirtualSizeHints(self, Window window)
12313
12314 Tell the sizer to set the minimal size of the window virtual area to
12315 match the sizer's minimal size. For windows with managed scrollbars
12316 this will set them appropriately.
12317
12318 :see: `wx.ScrolledWindow.SetScrollbars`
12319
12320 """
54f9ee45 12321 return _core_.Sizer_SetVirtualSizeHints(*args, **kwargs)
e811c8ce
RD
12322
12323 def Clear(*args, **kwargs):
248ed943
RD
12324 """
12325 Clear(self, bool deleteWindows=False)
12326
12327 Clear all items from the sizer, optionally destroying the window items
12328 as well.
12329 """
54f9ee45 12330 return _core_.Sizer_Clear(*args, **kwargs)
e811c8ce
RD
12331
12332 def DeleteWindows(*args, **kwargs):
248ed943
RD
12333 """
12334 DeleteWindows(self)
12335
12336 Destroy all windows managed by the sizer.
12337 """
54f9ee45 12338 return _core_.Sizer_DeleteWindows(*args, **kwargs)
e811c8ce
RD
12339
12340 def GetChildren(*args, **kwargs):
248ed943 12341 """
51b83b37 12342 GetChildren(self) -> list
248ed943
RD
12343
12344 Returns a list of all the `wx.SizerItem` objects managed by the sizer.
12345 """
54f9ee45 12346 return _core_.Sizer_GetChildren(*args, **kwargs)
e811c8ce
RD
12347
12348 def Show(*args, **kwargs):
248ed943 12349 """
ae8162c8 12350 Show(self, item, bool show=True, bool recursive=false) -> bool
e811c8ce 12351
248ed943
RD
12352 Shows or hides an item managed by the sizer. To make a sizer item
12353 disappear or reappear, use Show followed by `Layout`. The *item*
12354 parameter can be either a window, a sizer, or the zero-based index of
7e63a440
RD
12355 the item. Use the recursive parameter to show or hide an item in a
12356 subsizer. Returns True if the item was found.
248ed943
RD
12357 """
12358 return _core_.Sizer_Show(*args, **kwargs)
e811c8ce
RD
12359
12360 def IsShown(*args, **kwargs):
248ed943
RD
12361 """
12362 IsShown(self, item)
12363
b1fcee84 12364 Determines if the item is currently shown. To make a sizer
248ed943
RD
12365 item disappear or reappear, use Show followed by `Layout`. The *item*
12366 parameter can be either a window, a sizer, or the zero-based index of
12367 the item.
12368 """
54f9ee45 12369 return _core_.Sizer_IsShown(*args, **kwargs)
e811c8ce 12370
7e63a440 12371 def Hide(self, item, recursive=False):
248ed943 12372 """
27fb7603 12373 A convenience method for `Show` (item, False, recursive).
248ed943 12374 """
06759a38 12375 return self.Show(item, False, recursive)
248ed943 12376
e811c8ce 12377 def ShowItems(*args, **kwargs):
248ed943
RD
12378 """
12379 ShowItems(self, bool show)
12380
84f85550 12381 Recursively call `wx.SizerItem.Show` on all sizer items.
248ed943 12382 """
54f9ee45 12383 return _core_.Sizer_ShowItems(*args, **kwargs)
e811c8ce 12384
33d6fd3b
RD
12385 Children = property(GetChildren,doc="See `GetChildren`")
12386 ContainingWindow = property(GetContainingWindow,SetContainingWindow,doc="See `GetContainingWindow` and `SetContainingWindow`")
12387 MinSize = property(GetMinSize,SetMinSize,doc="See `GetMinSize` and `SetMinSize`")
12388 Position = property(GetPosition,doc="See `GetPosition`")
12389 Size = property(GetSize,doc="See `GetSize`")
2131d850 12390_core_.Sizer_swigregister(Sizer)
d14a1e28
RD
12391
12392class PySizer(Sizer):
248ed943
RD
12393 """
12394 wx.PySizer is a special version of `wx.Sizer` that has been
12395 instrumented to allow the C++ virtual methods to be overloaded in
12396 Python derived classes. You would derive from this class if you are
12397 wanting to implement a custom sizer in Python code. Simply implement
12398 `CalcMin` and `RecalcSizes` in the derived class and you're all set.
12399 For example::
12400
12401 class MySizer(wx.PySizer):
12402 def __init__(self):
12403 wx.PySizer.__init__(self)
12404
12405 def CalcMin(self):
12406 for item in self.GetChildren():
12407 # calculate the total minimum width and height needed
12408 # by all items in the sizer according to this sizer's
12409 # layout algorithm.
12410 ...
12411 return wx.Size(width, height)
12412
12413 def RecalcSizes(self):
12414 # find the space allotted to this sizer
12415 pos = self.GetPosition()
12416 size = self.GetSize()
12417 for item in self.GetChildren():
12418 # Recalculate (if necessary) the position and size of
12419 # each item and then call item.SetDimension to do the
12420 # actual positioning and sizing of the items within the
12421 # space alloted to this sizer.
12422 ...
12423 item.SetDimension(itemPos, itemSize)
12424
12425
12426 When `Layout` is called it first calls `CalcMin` followed by
12427 `RecalcSizes` so you can optimize a bit by saving the results of
e505d15e 12428 `CalcMin` and reusing them in `RecalcSizes`.
248ed943
RD
12429
12430 :see: `wx.SizerItem`, `wx.Sizer.GetChildren`
12431
12432
12433 """
0085ce49
RD
12434 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12435 __repr__ = _swig_repr
12436 def __init__(self, *args, **kwargs):
248ed943
RD
12437 """
12438 __init__(self) -> PySizer
12439
12440 Creates a wx.PySizer. Must be called from the __init__ in the derived
12441 class.
12442 """
0085ce49 12443 _core_.PySizer_swiginit(self,_core_.new_PySizer(*args, **kwargs))
d14a1e28 12444 self._setCallbackInfo(self, PySizer);self._setOORInfo(self)
e811c8ce
RD
12445
12446 def _setCallbackInfo(*args, **kwargs):
a95a7133 12447 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
54f9ee45 12448 return _core_.PySizer__setCallbackInfo(*args, **kwargs)
e811c8ce 12449
2131d850 12450_core_.PySizer_swigregister(PySizer)
d14a1e28
RD
12451
12452#---------------------------------------------------------------------------
12453
12454class BoxSizer(Sizer):
248ed943
RD
12455 """
12456 The basic idea behind a box sizer is that windows will most often be
12457 laid out in rather simple basic geometry, typically in a row or a
12458 column or nested hierarchies of either. A wx.BoxSizer will lay out
12459 its items in a simple row or column, depending on the orientation
12460 parameter passed to the constructor.
12461 """
0085ce49
RD
12462 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12463 __repr__ = _swig_repr
12464 def __init__(self, *args, **kwargs):
248ed943
RD
12465 """
12466 __init__(self, int orient=HORIZONTAL) -> BoxSizer
12467
12468 Constructor for a wx.BoxSizer. *orient* may be one of ``wx.VERTICAL``
12469 or ``wx.HORIZONTAL`` for creating either a column sizer or a row
12470 sizer.
12471 """
0085ce49 12472 _core_.BoxSizer_swiginit(self,_core_.new_BoxSizer(*args, **kwargs))
d14a1e28 12473 self._setOORInfo(self)
e811c8ce
RD
12474
12475 def GetOrientation(*args, **kwargs):
248ed943
RD
12476 """
12477 GetOrientation(self) -> int
12478
12479 Returns the current orientation of the sizer.
12480 """
54f9ee45 12481 return _core_.BoxSizer_GetOrientation(*args, **kwargs)
e811c8ce
RD
12482
12483 def SetOrientation(*args, **kwargs):
248ed943
RD
12484 """
12485 SetOrientation(self, int orient)
e811c8ce 12486
248ed943
RD
12487 Resets the orientation of the sizer.
12488 """
12489 return _core_.BoxSizer_SetOrientation(*args, **kwargs)
e811c8ce 12490
2bf58437 12491 Orientation = property(GetOrientation,SetOrientation,doc="See `GetOrientation` and `SetOrientation`")
2131d850 12492_core_.BoxSizer_swigregister(BoxSizer)
d14a1e28
RD
12493
12494#---------------------------------------------------------------------------
12495
12496class StaticBoxSizer(BoxSizer):
248ed943
RD
12497 """
12498 wx.StaticBoxSizer derives from and functions identically to the
12499 `wx.BoxSizer` and adds a `wx.StaticBox` around the items that the sizer
12500 manages. Note that this static box must be created separately and
12501 passed to the sizer constructor.
12502 """
0085ce49
RD
12503 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12504 __repr__ = _swig_repr
12505 def __init__(self, *args, **kwargs):
248ed943
RD
12506 """
12507 __init__(self, StaticBox box, int orient=HORIZONTAL) -> StaticBoxSizer
12508
12509 Constructor. It takes an associated static box and the orientation
12510 *orient* as parameters - orient can be either of ``wx.VERTICAL`` or
12511 ``wx.HORIZONTAL``.
12512 """
0085ce49 12513 _core_.StaticBoxSizer_swiginit(self,_core_.new_StaticBoxSizer(*args, **kwargs))
d14a1e28 12514 self._setOORInfo(self)
e811c8ce
RD
12515
12516 def GetStaticBox(*args, **kwargs):
248ed943
RD
12517 """
12518 GetStaticBox(self) -> StaticBox
e811c8ce 12519
248ed943
RD
12520 Returns the static box associated with this sizer.
12521 """
12522 return _core_.StaticBoxSizer_GetStaticBox(*args, **kwargs)
e811c8ce 12523
33d6fd3b 12524 StaticBox = property(GetStaticBox,doc="See `GetStaticBox`")
2131d850 12525_core_.StaticBoxSizer_swigregister(StaticBoxSizer)
d14a1e28
RD
12526
12527#---------------------------------------------------------------------------
12528
12529class GridSizer(Sizer):
248ed943
RD
12530 """
12531 A grid sizer is a sizer which lays out its children in a
12532 two-dimensional table with all cells having the same size. In other
12533 words, the width of each cell within the grid is the width of the
12534 widest item added to the sizer and the height of each grid cell is the
12535 height of the tallest item. An optional vertical and/or horizontal
12536 gap between items can also be specified (in pixels.)
12537
12538 Items are placed in the cells of the grid in the order they are added,
12539 in row-major order. In other words, the first row is filled first,
12540 then the second, and so on until all items have been added. (If
12541 neccessary, additional rows will be added as items are added.) If you
12542 need to have greater control over the cells that items are placed in
12543 then use the `wx.GridBagSizer`.
12544
12545 """
0085ce49
RD
12546 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12547 __repr__ = _swig_repr
12548 def __init__(self, *args, **kwargs):
248ed943
RD
12549 """
12550 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> GridSizer
12551
12552 Constructor for a wx.GridSizer. *rows* and *cols* determine the number
12553 of columns and rows in the sizer - if either of the parameters is
12554 zero, it will be calculated to from the total number of children in
12555 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
12556 define extra space between all children.
12557 """
0085ce49 12558 _core_.GridSizer_swiginit(self,_core_.new_GridSizer(*args, **kwargs))
d14a1e28 12559 self._setOORInfo(self)
e811c8ce 12560
e811c8ce 12561 def SetCols(*args, **kwargs):
248ed943
RD
12562 """
12563 SetCols(self, int cols)
12564
12565 Sets the number of columns in the sizer.
12566 """
54f9ee45 12567 return _core_.GridSizer_SetCols(*args, **kwargs)
e811c8ce
RD
12568
12569 def SetRows(*args, **kwargs):
248ed943
RD
12570 """
12571 SetRows(self, int rows)
12572
12573 Sets the number of rows in the sizer.
12574 """
54f9ee45 12575 return _core_.GridSizer_SetRows(*args, **kwargs)
e811c8ce
RD
12576
12577 def SetVGap(*args, **kwargs):
248ed943
RD
12578 """
12579 SetVGap(self, int gap)
12580
12581 Sets the vertical gap (in pixels) between the cells in the sizer.
12582 """
54f9ee45 12583 return _core_.GridSizer_SetVGap(*args, **kwargs)
e811c8ce
RD
12584
12585 def SetHGap(*args, **kwargs):
248ed943
RD
12586 """
12587 SetHGap(self, int gap)
12588
12589 Sets the horizontal gap (in pixels) between cells in the sizer
12590 """
54f9ee45 12591 return _core_.GridSizer_SetHGap(*args, **kwargs)
e811c8ce
RD
12592
12593 def GetCols(*args, **kwargs):
248ed943
RD
12594 """
12595 GetCols(self) -> int
12596
12597 Returns the number of columns in the sizer.
12598 """
54f9ee45 12599 return _core_.GridSizer_GetCols(*args, **kwargs)
e811c8ce
RD
12600
12601 def GetRows(*args, **kwargs):
248ed943
RD
12602 """
12603 GetRows(self) -> int
12604
12605 Returns the number of rows in the sizer.
12606 """
54f9ee45 12607 return _core_.GridSizer_GetRows(*args, **kwargs)
e811c8ce
RD
12608
12609 def GetVGap(*args, **kwargs):
248ed943
RD
12610 """
12611 GetVGap(self) -> int
12612
12613 Returns the vertical gap (in pixels) between the cells in the sizer.
12614 """
54f9ee45 12615 return _core_.GridSizer_GetVGap(*args, **kwargs)
e811c8ce
RD
12616
12617 def GetHGap(*args, **kwargs):
248ed943
RD
12618 """
12619 GetHGap(self) -> int
12620
12621 Returns the horizontal gap (in pixels) between cells in the sizer.
12622 """
54f9ee45 12623 return _core_.GridSizer_GetHGap(*args, **kwargs)
e811c8ce 12624
0085ce49
RD
12625 def CalcRowsCols(self):
12626 """
12627 CalcRowsCols() -> (rows, cols)
12628
12629 Calculates how many rows and columns will be in the sizer based
12630 on the current number of items and also the rows, cols specified
12631 in the constructor.
12632 """
12633 nitems = len(self.GetChildren())
12634 rows = self.GetRows()
12635 cols = self.GetCols()
12636 assert rows != 0 or cols != 0, "Grid sizer must have either rows or columns fixed"
12637 if cols != 0:
12638 rows = (nitems + cols - 1) / cols
12639 elif rows != 0:
12640 cols = (nitems + rows - 1) / rows
12641 return (rows, cols)
d14a1e28 12642
97ab0f6a
RD
12643 Cols = property(GetCols,SetCols,doc="See `GetCols` and `SetCols`")
12644 HGap = property(GetHGap,SetHGap,doc="See `GetHGap` and `SetHGap`")
12645 Rows = property(GetRows,SetRows,doc="See `GetRows` and `SetRows`")
12646 VGap = property(GetVGap,SetVGap,doc="See `GetVGap` and `SetVGap`")
2131d850 12647_core_.GridSizer_swigregister(GridSizer)
d14a1e28
RD
12648
12649#---------------------------------------------------------------------------
12650
54f9ee45
RD
12651FLEX_GROWMODE_NONE = _core_.FLEX_GROWMODE_NONE
12652FLEX_GROWMODE_SPECIFIED = _core_.FLEX_GROWMODE_SPECIFIED
12653FLEX_GROWMODE_ALL = _core_.FLEX_GROWMODE_ALL
d14a1e28 12654class FlexGridSizer(GridSizer):
248ed943
RD
12655 """
12656 A flex grid sizer is a sizer which lays out its children in a
12657 two-dimensional table with all table cells in one row having the same
12658 height and all cells in one column having the same width, but all
12659 rows or all columns are not necessarily the same height or width as in
12660 the `wx.GridSizer`.
12661
12662 wx.FlexGridSizer can also size items equally in one direction but
12663 unequally ("flexibly") in the other. If the sizer is only flexible
12664 in one direction (this can be changed using `SetFlexibleDirection`), it
12665 needs to be decided how the sizer should grow in the other ("non
12666 flexible") direction in order to fill the available space. The
12667 `SetNonFlexibleGrowMode` method serves this purpose.
12668
12669
12670 """
0085ce49
RD
12671 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12672 __repr__ = _swig_repr
12673 def __init__(self, *args, **kwargs):
248ed943
RD
12674 """
12675 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> FlexGridSizer
12676
12677 Constructor for a wx.FlexGridSizer. *rows* and *cols* determine the
12678 number of columns and rows in the sizer - if either of the parameters
12679 is zero, it will be calculated to from the total number of children in
12680 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
12681 define extra space between all children.
12682 """
0085ce49 12683 _core_.FlexGridSizer_swiginit(self,_core_.new_FlexGridSizer(*args, **kwargs))
d14a1e28 12684 self._setOORInfo(self)
e811c8ce 12685
248ed943
RD
12686 def AddGrowableRow(*args, **kwargs):
12687 """
12688 AddGrowableRow(self, size_t idx, int proportion=0)
e811c8ce 12689
248ed943
RD
12690 Specifies that row *idx* (starting from zero) should be grown if there
12691 is extra space available to the sizer.
e811c8ce 12692
248ed943
RD
12693 The *proportion* parameter has the same meaning as the stretch factor
12694 for the box sizers except that if all proportions are 0, then all
12695 columns are resized equally (instead of not being resized at all).
12696 """
54f9ee45 12697 return _core_.FlexGridSizer_AddGrowableRow(*args, **kwargs)
e811c8ce
RD
12698
12699 def RemoveGrowableRow(*args, **kwargs):
248ed943
RD
12700 """
12701 RemoveGrowableRow(self, size_t idx)
12702
12703 Specifies that row *idx* is no longer growable.
12704 """
54f9ee45 12705 return _core_.FlexGridSizer_RemoveGrowableRow(*args, **kwargs)
e811c8ce
RD
12706
12707 def AddGrowableCol(*args, **kwargs):
248ed943
RD
12708 """
12709 AddGrowableCol(self, size_t idx, int proportion=0)
12710
12711 Specifies that column *idx* (starting from zero) should be grown if
12712 there is extra space available to the sizer.
12713
12714 The *proportion* parameter has the same meaning as the stretch factor
12715 for the box sizers except that if all proportions are 0, then all
12716 columns are resized equally (instead of not being resized at all).
12717 """
54f9ee45 12718 return _core_.FlexGridSizer_AddGrowableCol(*args, **kwargs)
e811c8ce
RD
12719
12720 def RemoveGrowableCol(*args, **kwargs):
248ed943
RD
12721 """
12722 RemoveGrowableCol(self, size_t idx)
12723
12724 Specifies that column *idx* is no longer growable.
12725 """
54f9ee45 12726 return _core_.FlexGridSizer_RemoveGrowableCol(*args, **kwargs)
e811c8ce
RD
12727
12728 def SetFlexibleDirection(*args, **kwargs):
248ed943
RD
12729 """
12730 SetFlexibleDirection(self, int direction)
12731
12732 Specifies whether the sizer should flexibly resize its columns, rows,
12733 or both. Argument *direction* can be one of the following values. Any
12734 other value is ignored.
12735
12736 ============== =======================================
12737 wx.VERTICAL Rows are flexibly sized.
12738 wx.HORIZONTAL Columns are flexibly sized.
12739 wx.BOTH Both rows and columns are flexibly sized
12740 (this is the default value).
12741 ============== =======================================
12742
12743 Note that this method does not trigger relayout.
12744
12745 """
54f9ee45 12746 return _core_.FlexGridSizer_SetFlexibleDirection(*args, **kwargs)
e811c8ce
RD
12747
12748 def GetFlexibleDirection(*args, **kwargs):
248ed943
RD
12749 """
12750 GetFlexibleDirection(self) -> int
12751
12752 Returns a value that specifies whether the sizer
12753 flexibly resizes its columns, rows, or both (default).
12754
12755 :see: `SetFlexibleDirection`
12756 """
54f9ee45 12757 return _core_.FlexGridSizer_GetFlexibleDirection(*args, **kwargs)
e811c8ce
RD
12758
12759 def SetNonFlexibleGrowMode(*args, **kwargs):
248ed943
RD
12760 """
12761 SetNonFlexibleGrowMode(self, int mode)
12762
12763 Specifies how the sizer should grow in the non-flexible direction if
12764 there is one (so `SetFlexibleDirection` must have been called
12765 previously). Argument *mode* can be one of the following values:
12766
12767 ========================== =================================================
12768 wx.FLEX_GROWMODE_NONE Sizer doesn't grow in the non flexible direction.
12769 wx.FLEX_GROWMODE_SPECIFIED Sizer honors growable columns/rows set with
12770 `AddGrowableCol` and `AddGrowableRow`. In this
12771 case equal sizing applies to minimum sizes of
12772 columns or rows (this is the default value).
12773 wx.FLEX_GROWMODE_ALL Sizer equally stretches all columns or rows in
12774 the non flexible direction, whether they are
12775 growable or not in the flexbile direction.
12776 ========================== =================================================
12777
12778 Note that this method does not trigger relayout.
248ed943 12779 """
54f9ee45 12780 return _core_.FlexGridSizer_SetNonFlexibleGrowMode(*args, **kwargs)
e811c8ce
RD
12781
12782 def GetNonFlexibleGrowMode(*args, **kwargs):
248ed943
RD
12783 """
12784 GetNonFlexibleGrowMode(self) -> int
12785
12786 Returns the value that specifies how the sizer grows in the
12787 non-flexible direction if there is one.
12788
12789 :see: `SetNonFlexibleGrowMode`
12790 """
54f9ee45 12791 return _core_.FlexGridSizer_GetNonFlexibleGrowMode(*args, **kwargs)
e811c8ce
RD
12792
12793 def GetRowHeights(*args, **kwargs):
fd2dc343
RD
12794 """
12795 GetRowHeights(self) -> list
12796
12797 Returns a list of integers representing the heights of each of the
12798 rows in the sizer.
12799 """
54f9ee45 12800 return _core_.FlexGridSizer_GetRowHeights(*args, **kwargs)
e811c8ce
RD
12801
12802 def GetColWidths(*args, **kwargs):
fd2dc343
RD
12803 """
12804 GetColWidths(self) -> list
12805
12806 Returns a list of integers representing the widths of each of the
12807 columns in the sizer.
12808 """
54f9ee45 12809 return _core_.FlexGridSizer_GetColWidths(*args, **kwargs)
e811c8ce 12810
97ab0f6a
RD
12811 ColWidths = property(GetColWidths,doc="See `GetColWidths`")
12812 FlexibleDirection = property(GetFlexibleDirection,SetFlexibleDirection,doc="See `GetFlexibleDirection` and `SetFlexibleDirection`")
12813 NonFlexibleGrowMode = property(GetNonFlexibleGrowMode,SetNonFlexibleGrowMode,doc="See `GetNonFlexibleGrowMode` and `SetNonFlexibleGrowMode`")
12814 RowHeights = property(GetRowHeights,doc="See `GetRowHeights`")
2131d850 12815_core_.FlexGridSizer_swigregister(FlexGridSizer)
d14a1e28 12816
e505d15e
RD
12817class StdDialogButtonSizer(BoxSizer):
12818 """
12819 A special sizer that knows how to order and position standard buttons
12820 in order to conform to the current platform's standards. You simply
12821 need to add each `wx.Button` to the sizer, and be sure to create the
53aa7709 12822 buttons using the standard ID's. Then call `Realize` and the sizer
e505d15e
RD
12823 will take care of the rest.
12824
12825 """
0085ce49
RD
12826 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12827 __repr__ = _swig_repr
12828 def __init__(self, *args, **kwargs):
e505d15e 12829 """__init__(self) -> StdDialogButtonSizer"""
0085ce49 12830 _core_.StdDialogButtonSizer_swiginit(self,_core_.new_StdDialogButtonSizer(*args, **kwargs))
e505d15e
RD
12831 def AddButton(*args, **kwargs):
12832 """
12833 AddButton(self, wxButton button)
12834
12835 Use this to add the buttons to this sizer. Do not use the `Add`
12836 method in the base class.
12837 """
12838 return _core_.StdDialogButtonSizer_AddButton(*args, **kwargs)
12839
53aa7709 12840 def Realize(*args, **kwargs):
e505d15e 12841 """
53aa7709 12842 Realize(self)
e505d15e
RD
12843
12844 This funciton needs to be called after all the buttons have been added
12845 to the sizer. It will reorder them and position them in a platform
12846 specifc manner.
12847 """
53aa7709 12848 return _core_.StdDialogButtonSizer_Realize(*args, **kwargs)
51b83b37
RD
12849
12850 def SetAffirmativeButton(*args, **kwargs):
12851 """SetAffirmativeButton(self, wxButton button)"""
12852 return _core_.StdDialogButtonSizer_SetAffirmativeButton(*args, **kwargs)
12853
12854 def SetNegativeButton(*args, **kwargs):
12855 """SetNegativeButton(self, wxButton button)"""
12856 return _core_.StdDialogButtonSizer_SetNegativeButton(*args, **kwargs)
12857
12858 def SetCancelButton(*args, **kwargs):
12859 """SetCancelButton(self, wxButton button)"""
12860 return _core_.StdDialogButtonSizer_SetCancelButton(*args, **kwargs)
e505d15e
RD
12861
12862 def GetAffirmativeButton(*args, **kwargs):
12863 """GetAffirmativeButton(self) -> wxButton"""
12864 return _core_.StdDialogButtonSizer_GetAffirmativeButton(*args, **kwargs)
12865
12866 def GetApplyButton(*args, **kwargs):
12867 """GetApplyButton(self) -> wxButton"""
12868 return _core_.StdDialogButtonSizer_GetApplyButton(*args, **kwargs)
12869
12870 def GetNegativeButton(*args, **kwargs):
12871 """GetNegativeButton(self) -> wxButton"""
12872 return _core_.StdDialogButtonSizer_GetNegativeButton(*args, **kwargs)
12873
12874 def GetCancelButton(*args, **kwargs):
12875 """GetCancelButton(self) -> wxButton"""
12876 return _core_.StdDialogButtonSizer_GetCancelButton(*args, **kwargs)
12877
12878 def GetHelpButton(*args, **kwargs):
12879 """GetHelpButton(self) -> wxButton"""
12880 return _core_.StdDialogButtonSizer_GetHelpButton(*args, **kwargs)
12881
33d6fd3b
RD
12882 AffirmativeButton = property(GetAffirmativeButton,SetAffirmativeButton,doc="See `GetAffirmativeButton` and `SetAffirmativeButton`")
12883 ApplyButton = property(GetApplyButton,doc="See `GetApplyButton`")
12884 CancelButton = property(GetCancelButton,SetCancelButton,doc="See `GetCancelButton` and `SetCancelButton`")
12885 HelpButton = property(GetHelpButton,doc="See `GetHelpButton`")
12886 NegativeButton = property(GetNegativeButton,SetNegativeButton,doc="See `GetNegativeButton` and `SetNegativeButton`")
2131d850 12887_core_.StdDialogButtonSizer_swigregister(StdDialogButtonSizer)
e505d15e 12888
d14a1e28
RD
12889#---------------------------------------------------------------------------
12890
12891class GBPosition(object):
248ed943
RD
12892 """
12893 This class represents the position of an item in a virtual grid of
12894 rows and columns managed by a `wx.GridBagSizer`. wxPython has
12895 typemaps that will automatically convert from a 2-element sequence of
12896 integers to a wx.GBPosition, so you can use the more pythonic
12897 representation of the position nearly transparently in Python code.
12898 """
0085ce49
RD
12899 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12900 __repr__ = _swig_repr
12901 def __init__(self, *args, **kwargs):
248ed943
RD
12902 """
12903 __init__(self, int row=0, int col=0) -> GBPosition
12904
12905 This class represents the position of an item in a virtual grid of
12906 rows and columns managed by a `wx.GridBagSizer`. wxPython has
12907 typemaps that will automatically convert from a 2-element sequence of
12908 integers to a wx.GBPosition, so you can use the more pythonic
12909 representation of the position nearly transparently in Python code.
12910 """
0085ce49
RD
12911 _core_.GBPosition_swiginit(self,_core_.new_GBPosition(*args, **kwargs))
12912 __swig_destroy__ = _core_.delete_GBPosition
12913 __del__ = lambda self : None;
e811c8ce 12914 def GetRow(*args, **kwargs):
a95a7133 12915 """GetRow(self) -> int"""
54f9ee45 12916 return _core_.GBPosition_GetRow(*args, **kwargs)
e811c8ce
RD
12917
12918 def GetCol(*args, **kwargs):
a95a7133 12919 """GetCol(self) -> int"""
54f9ee45 12920 return _core_.GBPosition_GetCol(*args, **kwargs)
e811c8ce
RD
12921
12922 def SetRow(*args, **kwargs):
a95a7133 12923 """SetRow(self, int row)"""
54f9ee45 12924 return _core_.GBPosition_SetRow(*args, **kwargs)
e811c8ce
RD
12925
12926 def SetCol(*args, **kwargs):
a95a7133 12927 """SetCol(self, int col)"""
54f9ee45 12928 return _core_.GBPosition_SetCol(*args, **kwargs)
e811c8ce
RD
12929
12930 def __eq__(*args, **kwargs):
e9d6f3a4
RD
12931 """
12932 __eq__(self, PyObject other) -> bool
12933
12934 Compare GBPosition for equality.
12935 """
54f9ee45 12936 return _core_.GBPosition___eq__(*args, **kwargs)
e811c8ce
RD
12937
12938 def __ne__(*args, **kwargs):
e9d6f3a4
RD
12939 """
12940 __ne__(self, PyObject other) -> bool
12941
12942 Compare GBPosition for inequality.
12943 """
54f9ee45 12944 return _core_.GBPosition___ne__(*args, **kwargs)
e811c8ce
RD
12945
12946 def Set(*args, **kwargs):
a95a7133 12947 """Set(self, int row=0, int col=0)"""
54f9ee45 12948 return _core_.GBPosition_Set(*args, **kwargs)
e811c8ce
RD
12949
12950 def Get(*args, **kwargs):
a95a7133 12951 """Get(self) -> PyObject"""
54f9ee45 12952 return _core_.GBPosition_Get(*args, **kwargs)
e811c8ce 12953
41e2b43e 12954 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
e811c8ce
RD
12955 def __str__(self): return str(self.Get())
12956 def __repr__(self): return 'wx.GBPosition'+str(self.Get())
12957 def __len__(self): return len(self.Get())
12958 def __getitem__(self, index): return self.Get()[index]
d14a1e28
RD
12959 def __setitem__(self, index, val):
12960 if index == 0: self.SetRow(val)
12961 elif index == 1: self.SetCol(val)
12962 else: raise IndexError
e811c8ce 12963 def __nonzero__(self): return self.Get() != (0,0)
74e96f3d
RD
12964 __safe_for_unpickling__ = True
12965 def __reduce__(self): return (wx.GBPosition, self.Get())
d14a1e28
RD
12966
12967 row = property(GetRow, SetRow)
12968 col = property(GetCol, SetCol)
12969
2131d850 12970_core_.GBPosition_swigregister(GBPosition)
d14a1e28
RD
12971
12972class GBSpan(object):
248ed943
RD
12973 """
12974 This class is used to hold the row and column spanning attributes of
12975 items in a `wx.GridBagSizer`. wxPython has typemaps that will
12976 automatically convert from a 2-element sequence of integers to a
12977 wx.GBSpan, so you can use the more pythonic representation of the span
12978 nearly transparently in Python code.
12979
12980 """
0085ce49
RD
12981 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12982 __repr__ = _swig_repr
12983 def __init__(self, *args, **kwargs):
248ed943
RD
12984 """
12985 __init__(self, int rowspan=1, int colspan=1) -> GBSpan
12986
12987 Construct a new wxGBSpan, optionally setting the rowspan and
12988 colspan. The default is (1,1). (Meaning that the item occupies one
12989 cell in each direction.
12990 """
0085ce49
RD
12991 _core_.GBSpan_swiginit(self,_core_.new_GBSpan(*args, **kwargs))
12992 __swig_destroy__ = _core_.delete_GBSpan
12993 __del__ = lambda self : None;
e811c8ce 12994 def GetRowspan(*args, **kwargs):
a95a7133 12995 """GetRowspan(self) -> int"""
54f9ee45 12996 return _core_.GBSpan_GetRowspan(*args, **kwargs)
e811c8ce
RD
12997
12998 def GetColspan(*args, **kwargs):
a95a7133 12999 """GetColspan(self) -> int"""
54f9ee45 13000 return _core_.GBSpan_GetColspan(*args, **kwargs)
e811c8ce
RD
13001
13002 def SetRowspan(*args, **kwargs):
a95a7133 13003 """SetRowspan(self, int rowspan)"""
54f9ee45 13004 return _core_.GBSpan_SetRowspan(*args, **kwargs)
e811c8ce
RD
13005
13006 def SetColspan(*args, **kwargs):
a95a7133 13007 """SetColspan(self, int colspan)"""
54f9ee45 13008 return _core_.GBSpan_SetColspan(*args, **kwargs)
e811c8ce
RD
13009
13010 def __eq__(*args, **kwargs):
e9d6f3a4
RD
13011 """
13012 __eq__(self, PyObject other) -> bool
13013
13014 Compare wxGBSpan for equality.
13015 """
54f9ee45 13016 return _core_.GBSpan___eq__(*args, **kwargs)
e811c8ce
RD
13017
13018 def __ne__(*args, **kwargs):
e9d6f3a4
RD
13019 """
13020 __ne__(self, PyObject other) -> bool
13021
13022 Compare GBSpan for inequality.
13023 """
54f9ee45 13024 return _core_.GBSpan___ne__(*args, **kwargs)
e811c8ce
RD
13025
13026 def Set(*args, **kwargs):
a95a7133 13027 """Set(self, int rowspan=1, int colspan=1)"""
54f9ee45 13028 return _core_.GBSpan_Set(*args, **kwargs)
e811c8ce
RD
13029
13030 def Get(*args, **kwargs):
a95a7133 13031 """Get(self) -> PyObject"""
54f9ee45 13032 return _core_.GBSpan_Get(*args, **kwargs)
e811c8ce 13033
41e2b43e 13034 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
e811c8ce
RD
13035 def __str__(self): return str(self.Get())
13036 def __repr__(self): return 'wx.GBSpan'+str(self.Get())
13037 def __len__(self): return len(self.Get())
13038 def __getitem__(self, index): return self.Get()[index]
d14a1e28
RD
13039 def __setitem__(self, index, val):
13040 if index == 0: self.SetRowspan(val)
13041 elif index == 1: self.SetColspan(val)
13042 else: raise IndexError
e811c8ce 13043 def __nonzero__(self): return self.Get() != (0,0)
74e96f3d
RD
13044 __safe_for_unpickling__ = True
13045 def __reduce__(self): return (wx.GBSpan, self.Get())
d14a1e28
RD
13046
13047 rowspan = property(GetRowspan, SetRowspan)
13048 colspan = property(GetColspan, SetColspan)
13049
2131d850 13050_core_.GBSpan_swigregister(GBSpan)
d14a1e28
RD
13051
13052class GBSizerItem(SizerItem):
248ed943
RD
13053 """
13054 The wx.GBSizerItem class is used to track the additional data about
13055 items in a `wx.GridBagSizer` such as the item's position in the grid
13056 and how many rows or columns it spans.
13057
13058 """
0085ce49
RD
13059 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
13060 __repr__ = _swig_repr
13061 def __init__(self, *args, **kwargs):
248ed943
RD
13062 """
13063 __init__(self) -> GBSizerItem
13064
13065 Constructs an empty wx.GBSizerItem. Either a window, sizer or spacer
13066 size will need to be set, as well as a position and span before this
13067 item can be used in a Sizer.
13068
13069 You will probably never need to create a wx.GBSizerItem directly as they
13070 are created automatically when the sizer's Add method is called.
13071 """
0085ce49
RD
13072 _core_.GBSizerItem_swiginit(self,_core_.new_GBSizerItem(*args, **kwargs))
13073 __swig_destroy__ = _core_.delete_GBSizerItem
13074 __del__ = lambda self : None;
e811c8ce 13075 def GetPos(*args, **kwargs):
248ed943
RD
13076 """
13077 GetPos(self) -> GBPosition
13078
13079 Get the grid position of the item
13080 """
54f9ee45 13081 return _core_.GBSizerItem_GetPos(*args, **kwargs)
e811c8ce
RD
13082
13083 def GetPosTuple(self): return self.GetPos().Get()
13084 def GetSpan(*args, **kwargs):
248ed943
RD
13085 """
13086 GetSpan(self) -> GBSpan
13087
13088 Get the row and column spanning of the item
13089 """
54f9ee45 13090 return _core_.GBSizerItem_GetSpan(*args, **kwargs)
e811c8ce
RD
13091
13092 def GetSpanTuple(self): return self.GetSpan().Get()
13093 def SetPos(*args, **kwargs):
248ed943
RD
13094 """
13095 SetPos(self, GBPosition pos) -> bool
13096
13097 If the item is already a member of a sizer then first ensure that
13098 there is no other item that would intersect with this one at the new
13099 position, then set the new position. Returns True if the change is
13100 successful and after the next Layout() the item will be moved.
13101 """
54f9ee45 13102 return _core_.GBSizerItem_SetPos(*args, **kwargs)
e811c8ce
RD
13103
13104 def SetSpan(*args, **kwargs):
248ed943
RD
13105 """
13106 SetSpan(self, GBSpan span) -> bool
13107
13108 If the item is already a member of a sizer then first ensure that
13109 there is no other item that would intersect with this one with its new
13110 spanning size, then set the new spanning. Returns True if the change
13111 is successful and after the next Layout() the item will be resized.
13112
13113 """
54f9ee45 13114 return _core_.GBSizerItem_SetSpan(*args, **kwargs)
e811c8ce 13115
248ed943 13116 def Intersects(*args, **kwargs):
0df68c9f 13117 """
a95a7133 13118 Intersects(self, GBSizerItem other) -> bool
248ed943
RD
13119
13120 Returns True if this item and the other item instersect.
0df68c9f 13121 """
248ed943
RD
13122 return _core_.GBSizerItem_Intersects(*args, **kwargs)
13123
13124 def IntersectsPos(*args, **kwargs):
13125 """
13126 IntersectsPos(self, GBPosition pos, GBSpan span) -> bool
13127
13128 Returns True if the given pos/span would intersect with this item.
13129 """
13130 return _core_.GBSizerItem_IntersectsPos(*args, **kwargs)
e811c8ce
RD
13131
13132 def GetEndPos(*args, **kwargs):
248ed943
RD
13133 """
13134 GetEndPos(self) -> GBPosition
13135
13136 Get the row and column of the endpoint of this item.
13137 """
54f9ee45 13138 return _core_.GBSizerItem_GetEndPos(*args, **kwargs)
e811c8ce
RD
13139
13140 def GetGBSizer(*args, **kwargs):
248ed943
RD
13141 """
13142 GetGBSizer(self) -> GridBagSizer
13143
13144 Get the sizer this item is a member of.
13145 """
54f9ee45 13146 return _core_.GBSizerItem_GetGBSizer(*args, **kwargs)
e811c8ce
RD
13147
13148 def SetGBSizer(*args, **kwargs):
248ed943
RD
13149 """
13150 SetGBSizer(self, GridBagSizer sizer)
13151
13152 Set the sizer this item is a member of.
13153 """
54f9ee45 13154 return _core_.GBSizerItem_SetGBSizer(*args, **kwargs)
e811c8ce 13155
97ab0f6a
RD
13156 EndPos = property(GetEndPos,doc="See `GetEndPos`")
13157 GBSizer = property(GetGBSizer,SetGBSizer,doc="See `GetGBSizer` and `SetGBSizer`")
13158 Pos = property(GetPos,SetPos,doc="See `GetPos` and `SetPos`")
13159 Span = property(GetSpan,SetSpan,doc="See `GetSpan` and `SetSpan`")
2131d850 13160_core_.GBSizerItem_swigregister(GBSizerItem)
d14a1e28
RD
13161DefaultSpan = cvar.DefaultSpan
13162
13163def GBSizerItemWindow(*args, **kwargs):
0df68c9f
RD
13164 """
13165 GBSizerItemWindow(Window window, GBPosition pos, GBSpan span, int flag,
248ed943
RD
13166 int border, PyObject userData=None) -> GBSizerItem
13167
13168 Construct a `wx.GBSizerItem` for a window.
0df68c9f 13169 """
54f9ee45 13170 val = _core_.new_GBSizerItemWindow(*args, **kwargs)
d14a1e28
RD
13171 return val
13172
13173def GBSizerItemSizer(*args, **kwargs):
0df68c9f
RD
13174 """
13175 GBSizerItemSizer(Sizer sizer, GBPosition pos, GBSpan span, int flag,
248ed943
RD
13176 int border, PyObject userData=None) -> GBSizerItem
13177
13178 Construct a `wx.GBSizerItem` for a sizer
0df68c9f 13179 """
54f9ee45 13180 val = _core_.new_GBSizerItemSizer(*args, **kwargs)
d14a1e28
RD
13181 return val
13182
13183def GBSizerItemSpacer(*args, **kwargs):
0df68c9f
RD
13184 """
13185 GBSizerItemSpacer(int width, int height, GBPosition pos, GBSpan span,
248ed943
RD
13186 int flag, int border, PyObject userData=None) -> GBSizerItem
13187
13188 Construct a `wx.GBSizerItem` for a spacer.
0df68c9f 13189 """
54f9ee45 13190 val = _core_.new_GBSizerItemSpacer(*args, **kwargs)
d14a1e28
RD
13191 return val
13192
13193class GridBagSizer(FlexGridSizer):
248ed943
RD
13194 """
13195 A `wx.Sizer` that can lay out items in a virtual grid like a
13196 `wx.FlexGridSizer` but in this case explicit positioning of the items
13197 is allowed using `wx.GBPosition`, and items can optionally span more
13198 than one row and/or column using `wx.GBSpan`. The total size of the
13199 virtual grid is determined by the largest row and column that items are
13200 positioned at, adjusted for spanning.
13201
13202 """
0085ce49
RD
13203 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
13204 __repr__ = _swig_repr
13205 def __init__(self, *args, **kwargs):
248ed943
RD
13206 """
13207 __init__(self, int vgap=0, int hgap=0) -> GridBagSizer
13208
13209 Constructor, with optional parameters to specify the gap between the
13210 rows and columns.
13211 """
0085ce49 13212 _core_.GridBagSizer_swiginit(self,_core_.new_GridBagSizer(*args, **kwargs))
1823fbb4
RD
13213 self._setOORInfo(self)
13214
e811c8ce 13215 def Add(*args, **kwargs):
0df68c9f 13216 """
248ed943 13217 Add(self, item, GBPosition pos, GBSpan span=DefaultSpan, int flag=0,
d3b6e4ff 13218 int border=0, userData=None) -> wx.GBSizerItem
248ed943
RD
13219
13220 Adds an item to the sizer at the grid cell *pos*, optionally spanning
13221 more than one row or column as specified with *span*. The remaining
13222 args behave similarly to `wx.Sizer.Add`.
13223
13224 Returns True if the item was successfully placed at the given cell
13225 position, False if something was already there.
13226
0df68c9f 13227 """
54f9ee45 13228 return _core_.GridBagSizer_Add(*args, **kwargs)
e811c8ce
RD
13229
13230 def AddItem(*args, **kwargs):
248ed943 13231 """
d3b6e4ff 13232 Add(self, GBSizerItem item) -> wx.GBSizerItem
248ed943
RD
13233
13234 Add an item to the sizer using a `wx.GBSizerItem`. Returns True if
13235 the item was successfully placed at its given cell position, False if
13236 something was already there.
13237 """
54f9ee45 13238 return _core_.GridBagSizer_AddItem(*args, **kwargs)
e811c8ce 13239
84f85550
RD
13240 def GetCellSize(*args, **kwargs):
13241 """
13242 GetCellSize(self, int row, int col) -> Size
13243
13244 Get the size of the specified cell, including hgap and
13245 vgap. Only valid after a Layout.
13246 """
13247 return _core_.GridBagSizer_GetCellSize(*args, **kwargs)
13248
e811c8ce 13249 def GetEmptyCellSize(*args, **kwargs):
248ed943
RD
13250 """
13251 GetEmptyCellSize(self) -> Size
13252
13253 Get the size used for cells in the grid with no item.
13254 """
54f9ee45 13255 return _core_.GridBagSizer_GetEmptyCellSize(*args, **kwargs)
e811c8ce
RD
13256
13257 def SetEmptyCellSize(*args, **kwargs):
248ed943
RD
13258 """
13259 SetEmptyCellSize(self, Size sz)
13260
13261 Set the size used for cells in the grid with no item.
13262 """
54f9ee45 13263 return _core_.GridBagSizer_SetEmptyCellSize(*args, **kwargs)
e811c8ce
RD
13264
13265 def GetItemPosition(*args):
0df68c9f 13266 """
248ed943
RD
13267 GetItemPosition(self, item) -> GBPosition
13268
13269 Get the grid position of the specified *item* where *item* is either a
13270 window or subsizer that is a member of this sizer, or a zero-based
13271 index of an item.
0df68c9f 13272 """
54f9ee45 13273 return _core_.GridBagSizer_GetItemPosition(*args)
e811c8ce
RD
13274
13275 def SetItemPosition(*args):
0df68c9f 13276 """
248ed943
RD
13277 SetItemPosition(self, item, GBPosition pos) -> bool
13278
13279 Set the grid position of the specified *item* where *item* is either a
13280 window or subsizer that is a member of this sizer, or a zero-based
13281 index of an item. Returns True on success. If the move is not
13282 allowed (because an item is already there) then False is returned.
13283
0df68c9f 13284 """
54f9ee45 13285 return _core_.GridBagSizer_SetItemPosition(*args)
e811c8ce
RD
13286
13287 def GetItemSpan(*args):
0df68c9f 13288 """
248ed943
RD
13289 GetItemSpan(self, item) -> GBSpan
13290
13291 Get the row/col spanning of the specified *item* where *item* is
13292 either a window or subsizer that is a member of this sizer, or a
13293 zero-based index of an item.
0df68c9f 13294 """
54f9ee45 13295 return _core_.GridBagSizer_GetItemSpan(*args)
e811c8ce
RD
13296
13297 def SetItemSpan(*args):
0df68c9f 13298 """
248ed943
RD
13299 SetItemSpan(self, item, GBSpan span) -> bool
13300
13301 Set the row/col spanning of the specified *item* where *item* is
13302 either a window or subsizer that is a member of this sizer, or a
13303 zero-based index of an item. Returns True on success. If the move is
13304 not allowed (because an item is already there) then False is returned.
0df68c9f 13305 """
54f9ee45 13306 return _core_.GridBagSizer_SetItemSpan(*args)
e811c8ce
RD
13307
13308 def FindItem(*args):
0df68c9f 13309 """
248ed943
RD
13310 FindItem(self, item) -> GBSizerItem
13311
13312 Find the sizer item for the given window or subsizer, returns None if
13313 not found. (non-recursive)
0df68c9f 13314 """
54f9ee45 13315 return _core_.GridBagSizer_FindItem(*args)
e811c8ce
RD
13316
13317 def FindItemAtPosition(*args, **kwargs):
248ed943
RD
13318 """
13319 FindItemAtPosition(self, GBPosition pos) -> GBSizerItem
13320
13321 Return the sizer item for the given grid cell, or None if there is no
13322 item at that position. (non-recursive)
13323 """
54f9ee45 13324 return _core_.GridBagSizer_FindItemAtPosition(*args, **kwargs)
e811c8ce
RD
13325
13326 def FindItemAtPoint(*args, **kwargs):
248ed943
RD
13327 """
13328 FindItemAtPoint(self, Point pt) -> GBSizerItem
13329
13330 Return the sizer item located at the point given in *pt*, or None if
13331 there is no item at that point. The (x,y) coordinates in pt correspond
13332 to the client coordinates of the window using the sizer for
13333 layout. (non-recursive)
13334 """
54f9ee45 13335 return _core_.GridBagSizer_FindItemAtPoint(*args, **kwargs)
e811c8ce 13336
248ed943
RD
13337 def CheckForIntersection(*args, **kwargs):
13338 """
13339 CheckForIntersection(self, GBSizerItem item, GBSizerItem excludeItem=None) -> bool
e811c8ce 13340
248ed943
RD
13341 Look at all items and see if any intersect (or would overlap) the
13342 given *item*. Returns True if so, False if there would be no overlap.
13343 If an *excludeItem* is given then it will not be checked for
13344 intersection, for example it may be the item we are checking the
13345 position of.
e811c8ce 13346
248ed943
RD
13347 """
13348 return _core_.GridBagSizer_CheckForIntersection(*args, **kwargs)
e811c8ce 13349
248ed943 13350 def CheckForIntersectionPos(*args, **kwargs):
0df68c9f 13351 """
248ed943
RD
13352 CheckForIntersectionPos(self, GBPosition pos, GBSpan span, GBSizerItem excludeItem=None) -> bool
13353
13354 Look at all items and see if any intersect (or would overlap) the
13355 given position and span. Returns True if so, False if there would be
13356 no overlap. If an *excludeItem* is given then it will not be checked
13357 for intersection, for example it may be the item we are checking the
13358 position of.
0df68c9f 13359 """
248ed943 13360 return _core_.GridBagSizer_CheckForIntersectionPos(*args, **kwargs)
e811c8ce 13361
2131d850 13362_core_.GridBagSizer_swigregister(GridBagSizer)
d14a1e28
RD
13363
13364#---------------------------------------------------------------------------
13365
54f9ee45
RD
13366Left = _core_.Left
13367Top = _core_.Top
13368Right = _core_.Right
13369Bottom = _core_.Bottom
13370Width = _core_.Width
13371Height = _core_.Height
13372Centre = _core_.Centre
13373Center = _core_.Center
13374CentreX = _core_.CentreX
13375CentreY = _core_.CentreY
13376Unconstrained = _core_.Unconstrained
13377AsIs = _core_.AsIs
13378PercentOf = _core_.PercentOf
13379Above = _core_.Above
13380Below = _core_.Below
13381LeftOf = _core_.LeftOf
13382RightOf = _core_.RightOf
13383SameAs = _core_.SameAs
13384Absolute = _core_.Absolute
d14a1e28 13385class IndividualLayoutConstraint(Object):
15afbcd0 13386 """
41e2b43e
RD
13387 Objects of this class are stored in the `wx.LayoutConstraints` class as
13388 one of eight possible constraints that a window can be involved in.
13389 You will never need to create an instance of
13390 wx.IndividualLayoutConstraint, rather you should create a
13391 `wx.LayoutConstraints` instance and use the individual contstraints
15afbcd0 13392 that it contains.
15afbcd0 13393 """
0085ce49
RD
13394 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
13395 def __init__(self): raise AttributeError, "No constructor defined"
13396 __repr__ = _swig_repr
e811c8ce 13397 def Set(*args, **kwargs):
41e2b43e
RD
13398 """
13399 Set(self, int rel, Window otherW, int otherE, int val=0, int marg=wxLAYOUT_DEFAULT_MARGIN)
13400
13401 Sets the properties of the constraint. Normally called by one of the
13402 convenience functions such as Above, RightOf, SameAs.
13403 """
54f9ee45 13404 return _core_.IndividualLayoutConstraint_Set(*args, **kwargs)
e811c8ce
RD
13405
13406 def LeftOf(*args, **kwargs):
15afbcd0 13407 """
a95a7133 13408 LeftOf(self, Window sibling, int marg=0)
15afbcd0 13409
41e2b43e
RD
13410 Constrains this edge to be to the left of the given window, with an
13411 optional margin. Implicitly, this is relative to the left edge of the
13412 other window.
15afbcd0 13413 """
54f9ee45 13414 return _core_.IndividualLayoutConstraint_LeftOf(*args, **kwargs)
e811c8ce
RD
13415
13416 def RightOf(*args, **kwargs):
15afbcd0 13417 """
a95a7133 13418 RightOf(self, Window sibling, int marg=0)
15afbcd0 13419
41e2b43e
RD
13420 Constrains this edge to be to the right of the given window, with an
13421 optional margin. Implicitly, this is relative to the right edge of the
13422 other window.
15afbcd0 13423 """
54f9ee45 13424 return _core_.IndividualLayoutConstraint_RightOf(*args, **kwargs)
e811c8ce
RD
13425
13426 def Above(*args, **kwargs):
15afbcd0 13427 """
a95a7133 13428 Above(self, Window sibling, int marg=0)
15afbcd0 13429
41e2b43e
RD
13430 Constrains this edge to be above the given window, with an optional
13431 margin. Implicitly, this is relative to the top edge of the other
13432 window.
15afbcd0 13433 """
54f9ee45 13434 return _core_.IndividualLayoutConstraint_Above(*args, **kwargs)
e811c8ce
RD
13435
13436 def Below(*args, **kwargs):
15afbcd0 13437 """
a95a7133 13438 Below(self, Window sibling, int marg=0)
15afbcd0 13439
41e2b43e
RD
13440 Constrains this edge to be below the given window, with an optional
13441 margin. Implicitly, this is relative to the bottom edge of the other
13442 window.
15afbcd0 13443 """
54f9ee45 13444 return _core_.IndividualLayoutConstraint_Below(*args, **kwargs)
e811c8ce
RD
13445
13446 def SameAs(*args, **kwargs):
15afbcd0 13447 """
a95a7133 13448 SameAs(self, Window otherW, int edge, int marg=0)
15afbcd0 13449
41e2b43e
RD
13450 Constrains this edge or dimension to be to the same as the edge of the
13451 given window, with an optional margin.
15afbcd0 13452 """
54f9ee45 13453 return _core_.IndividualLayoutConstraint_SameAs(*args, **kwargs)
e811c8ce
RD
13454
13455 def PercentOf(*args, **kwargs):
15afbcd0 13456 """
a95a7133 13457 PercentOf(self, Window otherW, int wh, int per)
15afbcd0 13458
41e2b43e
RD
13459 Constrains this edge or dimension to be to a percentage of the given
13460 window, with an optional margin.
15afbcd0 13461 """
54f9ee45 13462 return _core_.IndividualLayoutConstraint_PercentOf(*args, **kwargs)
e811c8ce
RD
13463
13464 def Absolute(*args, **kwargs):
15afbcd0 13465 """
a95a7133 13466 Absolute(self, int val)
15afbcd0 13467
41e2b43e 13468 Constrains this edge or dimension to be the given absolute value.
15afbcd0 13469 """
54f9ee45 13470 return _core_.IndividualLayoutConstraint_Absolute(*args, **kwargs)
e811c8ce
RD
13471
13472 def Unconstrained(*args, **kwargs):
15afbcd0 13473 """
a95a7133 13474 Unconstrained(self)
15afbcd0 13475
41e2b43e
RD
13476 Sets this edge or dimension to be unconstrained, that is, dependent on
13477 other edges and dimensions from which this value can be deduced.
15afbcd0 13478 """
54f9ee45 13479 return _core_.IndividualLayoutConstraint_Unconstrained(*args, **kwargs)
e811c8ce
RD
13480
13481 def AsIs(*args, **kwargs):
15afbcd0 13482 """
a95a7133 13483 AsIs(self)
15afbcd0 13484
41e2b43e
RD
13485 Sets this edge or constraint to be whatever the window's value is at
13486 the moment. If either of the width and height constraints are *as is*,
13487 the window will not be resized, but moved instead. This is important
13488 when considering panel items which are intended to have a default
13489 size, such as a button, which may take its size from the size of the
13490 button label.
15afbcd0 13491 """
54f9ee45 13492 return _core_.IndividualLayoutConstraint_AsIs(*args, **kwargs)
e811c8ce
RD
13493
13494 def GetOtherWindow(*args, **kwargs):
a95a7133 13495 """GetOtherWindow(self) -> Window"""
54f9ee45 13496 return _core_.IndividualLayoutConstraint_GetOtherWindow(*args, **kwargs)
e811c8ce
RD
13497
13498 def GetMyEdge(*args, **kwargs):
a95a7133 13499 """GetMyEdge(self) -> int"""
54f9ee45 13500 return _core_.IndividualLayoutConstraint_GetMyEdge(*args, **kwargs)
e811c8ce
RD
13501
13502 def SetEdge(*args, **kwargs):
a95a7133 13503 """SetEdge(self, int which)"""
54f9ee45 13504 return _core_.IndividualLayoutConstraint_SetEdge(*args, **kwargs)
e811c8ce
RD
13505
13506 def SetValue(*args, **kwargs):
a95a7133 13507 """SetValue(self, int v)"""
54f9ee45 13508 return _core_.IndividualLayoutConstraint_SetValue(*args, **kwargs)
e811c8ce
RD
13509
13510 def GetMargin(*args, **kwargs):
a95a7133 13511 """GetMargin(self) -> int"""
54f9ee45 13512 return _core_.IndividualLayoutConstraint_GetMargin(*args, **kwargs)
e811c8ce
RD
13513
13514 def SetMargin(*args, **kwargs):
a95a7133 13515 """SetMargin(self, int m)"""
54f9ee45 13516 return _core_.IndividualLayoutConstraint_SetMargin(*args, **kwargs)
e811c8ce
RD
13517
13518 def GetValue(*args, **kwargs):
a95a7133 13519 """GetValue(self) -> int"""
54f9ee45 13520 return _core_.IndividualLayoutConstraint_GetValue(*args, **kwargs)
e811c8ce
RD
13521
13522 def GetPercent(*args, **kwargs):
a95a7133 13523 """GetPercent(self) -> int"""
54f9ee45 13524 return _core_.IndividualLayoutConstraint_GetPercent(*args, **kwargs)
e811c8ce
RD
13525
13526 def GetOtherEdge(*args, **kwargs):
a95a7133 13527 """GetOtherEdge(self) -> int"""
54f9ee45 13528 return _core_.IndividualLayoutConstraint_GetOtherEdge(*args, **kwargs)
e811c8ce
RD
13529
13530 def GetDone(*args, **kwargs):
a95a7133 13531 """GetDone(self) -> bool"""
54f9ee45 13532 return _core_.IndividualLayoutConstraint_GetDone(*args, **kwargs)
e811c8ce
RD
13533
13534 def SetDone(*args, **kwargs):
a95a7133 13535 """SetDone(self, bool d)"""
54f9ee45 13536 return _core_.IndividualLayoutConstraint_SetDone(*args, **kwargs)
e811c8ce
RD
13537
13538 def GetRelationship(*args, **kwargs):
a95a7133 13539 """GetRelationship(self) -> int"""
54f9ee45 13540 return _core_.IndividualLayoutConstraint_GetRelationship(*args, **kwargs)
e811c8ce
RD
13541
13542 def SetRelationship(*args, **kwargs):
a95a7133 13543 """SetRelationship(self, int r)"""
54f9ee45 13544 return _core_.IndividualLayoutConstraint_SetRelationship(*args, **kwargs)
e811c8ce
RD
13545
13546 def ResetIfWin(*args, **kwargs):
15afbcd0 13547 """
a95a7133 13548 ResetIfWin(self, Window otherW) -> bool
15afbcd0
RD
13549
13550 Reset constraint if it mentions otherWin
13551 """
54f9ee45 13552 return _core_.IndividualLayoutConstraint_ResetIfWin(*args, **kwargs)
e811c8ce
RD
13553
13554 def SatisfyConstraint(*args, **kwargs):
15afbcd0 13555 """
a95a7133 13556 SatisfyConstraint(self, LayoutConstraints constraints, Window win) -> bool
15afbcd0
RD
13557
13558 Try to satisfy constraint
13559 """
54f9ee45 13560 return _core_.IndividualLayoutConstraint_SatisfyConstraint(*args, **kwargs)
e811c8ce
RD
13561
13562 def GetEdge(*args, **kwargs):
15afbcd0 13563 """
a95a7133 13564 GetEdge(self, int which, Window thisWin, Window other) -> int
15afbcd0
RD
13565
13566 Get the value of this edge or dimension, or if this
13567 is not determinable, -1.
13568 """
54f9ee45 13569 return _core_.IndividualLayoutConstraint_GetEdge(*args, **kwargs)
e811c8ce 13570
97ab0f6a
RD
13571 Done = property(GetDone,SetDone,doc="See `GetDone` and `SetDone`")
13572 Margin = property(GetMargin,SetMargin,doc="See `GetMargin` and `SetMargin`")
13573 MyEdge = property(GetMyEdge,doc="See `GetMyEdge`")
13574 OtherEdge = property(GetOtherEdge,doc="See `GetOtherEdge`")
13575 OtherWindow = property(GetOtherWindow,doc="See `GetOtherWindow`")
13576 Percent = property(GetPercent,doc="See `GetPercent`")
13577 Relationship = property(GetRelationship,SetRelationship,doc="See `GetRelationship` and `SetRelationship`")
13578 Value = property(GetValue,SetValue,doc="See `GetValue` and `SetValue`")
2131d850 13579_core_.IndividualLayoutConstraint_swigregister(IndividualLayoutConstraint)
d14a1e28
RD
13580
13581class LayoutConstraints(Object):
15afbcd0 13582 """
41e2b43e
RD
13583 **Note:** constraints are now deprecated and you should use sizers
13584 instead.
15afbcd0 13585
41e2b43e
RD
13586 Objects of this class can be associated with a window to define its
13587 layout constraints, with respect to siblings or its parent.
15afbcd0
RD
13588
13589 The class consists of the following eight constraints of class
13590 wx.IndividualLayoutConstraint, some or all of which should be accessed
13591 directly to set the appropriate constraints.
13592
13593 * left: represents the left hand edge of the window
13594 * right: represents the right hand edge of the window
13595 * top: represents the top edge of the window
13596 * bottom: represents the bottom edge of the window
13597 * width: represents the width of the window
13598 * height: represents the height of the window
13599 * centreX: represents the horizontal centre point of the window
13600 * centreY: represents the vertical centre point of the window
13601
41e2b43e
RD
13602 Most constraints are initially set to have the relationship
13603 wxUnconstrained, which means that their values should be calculated by
13604 looking at known constraints. The exceptions are width and height,
13605 which are set to wxAsIs to ensure that if the user does not specify a
13606 constraint, the existing width and height will be used, to be
13607 compatible with panel items which often have take a default size. If
13608 the constraint is ``wx.AsIs``, the dimension will not be changed.
13609
13610 :see: `wx.IndividualLayoutConstraint`, `wx.Window.SetConstraints`
15afbcd0
RD
13611
13612 """
0085ce49
RD
13613 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
13614 __repr__ = _swig_repr
54f9ee45
RD
13615 left = property(_core_.LayoutConstraints_left_get)
13616 top = property(_core_.LayoutConstraints_top_get)
13617 right = property(_core_.LayoutConstraints_right_get)
13618 bottom = property(_core_.LayoutConstraints_bottom_get)
13619 width = property(_core_.LayoutConstraints_width_get)
13620 height = property(_core_.LayoutConstraints_height_get)
13621 centreX = property(_core_.LayoutConstraints_centreX_get)
13622 centreY = property(_core_.LayoutConstraints_centreY_get)
0085ce49 13623 def __init__(self, *args, **kwargs):
a95a7133 13624 """__init__(self) -> LayoutConstraints"""
0085ce49
RD
13625 _core_.LayoutConstraints_swiginit(self,_core_.new_LayoutConstraints(*args, **kwargs))
13626 __swig_destroy__ = _core_.delete_LayoutConstraints
13627 __del__ = lambda self : None;
e811c8ce 13628 def SatisfyConstraints(*args, **kwargs):
6c3b4aae 13629 """SatisfyConstraints(Window win) -> (areSatisfied, noChanges)"""
54f9ee45 13630 return _core_.LayoutConstraints_SatisfyConstraints(*args, **kwargs)
e811c8ce
RD
13631
13632 def AreSatisfied(*args, **kwargs):
a95a7133 13633 """AreSatisfied(self) -> bool"""
54f9ee45 13634 return _core_.LayoutConstraints_AreSatisfied(*args, **kwargs)
e811c8ce 13635
2131d850 13636_core_.LayoutConstraints_swigregister(LayoutConstraints)
d14a1e28
RD
13637
13638#----------------------------------------------------------------------------
13639
322913ce 13640# Use Python's bool constants if available, make some if not
d14a1e28
RD
13641try:
13642 True
13643except NameError:
322913ce
RD
13644 __builtins__.True = 1==1
13645 __builtins__.False = 1==0
4f89f6a3
RD
13646 def bool(value): return not not value
13647 __builtins__.bool = bool
d14a1e28 13648
d14a1e28
RD
13649
13650
13651# workarounds for bad wxRTTI names
13652__wxPyPtrTypeMap['wxGauge95'] = 'wxGauge'
13653__wxPyPtrTypeMap['wxSlider95'] = 'wxSlider'
13654__wxPyPtrTypeMap['wxStatusBar95'] = 'wxStatusBar'
13655
13656
13657#----------------------------------------------------------------------------
13658# Load version numbers from __version__... Ensure that major and minor
7bc1e663 13659# versions are the same for both wxPython and wxWidgets.
d14a1e28
RD
13660
13661from __version__ import *
13662__version__ = VERSION_STRING
13663
7bc1e663
RD
13664assert MAJOR_VERSION == _core_.MAJOR_VERSION, "wxPython/wxWidgets version mismatch"
13665assert MINOR_VERSION == _core_.MINOR_VERSION, "wxPython/wxWidgets version mismatch"
54f9ee45 13666if RELEASE_VERSION != _core_.RELEASE_VERSION:
d14a1e28 13667 import warnings
7bc1e663 13668 warnings.warn("wxPython/wxWidgets release number mismatch")
d14a1e28
RD
13669
13670#----------------------------------------------------------------------------
13671
70b7a5fe
RD
13672# Set wxPython's default string<-->unicode conversion encoding from
13673# the locale, but only if Python's default hasn't been changed. (We
13674# assume that if the user has customized it already then that is the
13675# encoding we need to use as well.)
13676#
13677# The encoding selected here is used when string or unicode objects
13678# need to be converted in order to pass them to wxWidgets. Please be
13679# aware that the default encoding within the same locale may be
13680# slightly different on different platforms. For example, please see
e505d15e
RD
13681# http://www.alanwood.net/demos/charsetdiffs.html for differences
13682# between the common latin/roman encodings.
396fb509
RD
13683
13684default = _sys.getdefaultencoding()
13685if default == 'ascii':
13686 import locale
13687 import codecs
13688 try:
13689 default = locale.getdefaultlocale()[1]
13690 codecs.lookup(default)
70b7a5fe 13691 except (ValueError, LookupError, TypeError):
396fb509
RD
13692 default = _sys.getdefaultencoding()
13693 del locale
13694 del codecs
5cbf236d
RD
13695if default:
13696 wx.SetDefaultPyEncoding(default)
13697del default
5cbf236d
RD
13698
13699#----------------------------------------------------------------------------
13700
d14a1e28
RD
13701class PyDeadObjectError(AttributeError):
13702 pass
13703
d14a1e28
RD
13704class _wxPyDeadObject(object):
13705 """
13706 Instances of wx objects that are OOR capable will have their __class__
13707 changed to this class when the C++ object is deleted. This should help
13708 prevent crashes due to referencing a bogus C++ pointer.
13709 """
13710 reprStr = "wxPython wrapper for DELETED %s object! (The C++ object no longer exists.)"
13711 attrStr = "The C++ part of the %s object has been deleted, attribute access no longer allowed."
13712
3a04f143 13713 def __repr__(self):
d14a1e28
RD
13714 if not hasattr(self, "_name"):
13715 self._name = "[unknown]"
13716 return self.reprStr % self._name
13717
3a04f143 13718 def __getattr__(self, *args):
d14a1e28
RD
13719 if not hasattr(self, "_name"):
13720 self._name = "[unknown]"
3a04f143
RD
13721 raise PyDeadObjectError(self.attrStr % self._name)
13722
13723 def __nonzero__(self):
13724 return 0
13725
13726
13727
13728class PyUnbornObjectError(AttributeError):
13729 pass
13730
13731class _wxPyUnbornObject(object):
13732 """
54f9ee45 13733 Some stock objects are created when the wx._core module is
3a04f143
RD
13734 imported, but their C++ instance is not created until the wx.App
13735 object is created and initialized. These object instances will
13736 temporarily have their __class__ changed to this class so an
13737 exception will be raised if they are used before the C++ instance
13738 is ready.
13739 """
13740
13741 reprStr = "wxPython wrapper for UNBORN object! (The C++ object is not initialized yet.)"
13742 attrStr = "The C++ part of this object has not been initialized, attribute access not allowed."
13743
13744 def __repr__(self):
13745 #if not hasattr(self, "_name"):
13746 # self._name = "[unknown]"
13747 return self.reprStr #% self._name
13748
13749 def __getattr__(self, *args):
13750 #if not hasattr(self, "_name"):
13751 # self._name = "[unknown]"
13752 raise PyUnbornObjectError(self.attrStr) # % self._name )
d14a1e28
RD
13753
13754 def __nonzero__(self):
13755 return 0
13756
13757
13758#----------------------------------------------------------------------------
d14a1e28
RD
13759
13760def CallAfter(callable, *args, **kw):
13761 """
13762 Call the specified function after the current and pending event
13763 handlers have been completed. This is also good for making GUI
61863841
RD
13764 method calls from non-GUI threads. Any extra positional or
13765 keyword args are passed on to the callable when it is called.
13766
846c181b 13767 :see: `wx.CallLater`
d14a1e28
RD
13768 """
13769 app = wx.GetApp()
dfbb5885 13770 assert app is not None, 'No wx.App created yet'
d14a1e28 13771
148275d3
RD
13772 if not hasattr(app, "_CallAfterId"):
13773 app._CallAfterId = wx.NewEventType()
13774 app.Connect(-1, -1, app._CallAfterId,
13775 lambda event: event.callable(*event.args, **event.kw) )
d14a1e28 13776 evt = wx.PyEvent()
148275d3 13777 evt.SetEventType(app._CallAfterId)
d14a1e28
RD
13778 evt.callable = callable
13779 evt.args = args
13780 evt.kw = kw
13781 wx.PostEvent(app, evt)
13782
d14a1e28
RD
13783#----------------------------------------------------------------------------
13784
13785
846c181b 13786class CallLater:
d14a1e28 13787 """
8ac8dba0 13788 A convenience class for `wx.Timer`, that calls the given callable
d14a1e28
RD
13789 object once after the given amount of milliseconds, passing any
13790 positional or keyword args. The return value of the callable is
61863841 13791 availbale after it has been run with the `GetResult` method.
d14a1e28
RD
13792
13793 If you don't need to get the return value or restart the timer
13794 then there is no need to hold a reference to this object. It will
13795 hold a reference to itself while the timer is running (the timer
13796 has a reference to self.Notify) but the cycle will be broken when
846c181b 13797 the timer completes, automatically cleaning up the wx.CallLater
d14a1e28 13798 object.
61863841
RD
13799
13800 :see: `wx.CallAfter`
d14a1e28
RD
13801 """
13802 def __init__(self, millis, callable, *args, **kwargs):
13803 self.millis = millis
13804 self.callable = callable
13805 self.SetArgs(*args, **kwargs)
13806 self.runCount = 0
4276dc52 13807 self.running = False
d14a1e28
RD
13808 self.hasRun = False
13809 self.result = None
13810 self.timer = None
13811 self.Start()
13812
13813 def __del__(self):
13814 self.Stop()
13815
13816
13817 def Start(self, millis=None, *args, **kwargs):
13818 """
13819 (Re)start the timer
13820 """
13821 self.hasRun = False
13822 if millis is not None:
13823 self.millis = millis
13824 if args or kwargs:
13825 self.SetArgs(*args, **kwargs)
13826 self.Stop()
13827 self.timer = wx.PyTimer(self.Notify)
13828 self.timer.Start(self.millis, wx.TIMER_ONE_SHOT)
4276dc52 13829 self.running = True
d14a1e28
RD
13830 Restart = Start
13831
13832
13833 def Stop(self):
13834 """
13835 Stop and destroy the timer.
13836 """
13837 if self.timer is not None:
13838 self.timer.Stop()
13839 self.timer = None
13840
13841
13842 def GetInterval(self):
13843 if self.timer is not None:
13844 return self.timer.GetInterval()
13845 else:
13846 return 0
13847
13848
13849 def IsRunning(self):
13850 return self.timer is not None and self.timer.IsRunning()
13851
13852
13853 def SetArgs(self, *args, **kwargs):
13854 """
13855 (Re)set the args passed to the callable object. This is
13856 useful in conjunction with Restart if you want to schedule a
13857 new call to the same callable object but with different
13858 parameters.
13859 """
13860 self.args = args
13861 self.kwargs = kwargs
13862
13863
13864 def HasRun(self):
13865 return self.hasRun
13866
13867 def GetResult(self):
13868 return self.result
13869
13870 def Notify(self):
13871 """
13872 The timer has expired so call the callable.
13873 """
13874 if self.callable and getattr(self.callable, 'im_self', True):
13875 self.runCount += 1
4276dc52 13876 self.running = False
d14a1e28
RD
13877 self.result = self.callable(*self.args, **self.kwargs)
13878 self.hasRun = True
4276dc52
RD
13879 if not self.running:
13880 # if it wasn't restarted, then cleanup
13881 wx.CallAfter(self.Stop)
d14a1e28 13882
97ab0f6a
RD
13883 Interval = property(GetInterval)
13884 Result = property(GetResult)
d14a1e28 13885
a95a7133 13886
846c181b 13887class FutureCall(CallLater):
b39fe951 13888 """A compatibility alias for `CallLater`."""
846c181b 13889
a95a7133
RD
13890#----------------------------------------------------------------------------
13891# Control which items in this module should be documented by epydoc.
13892# We allow only classes and functions, which will help reduce the size
13893# of the docs by filtering out the zillions of constants, EVT objects,
13894# and etc that don't make much sense by themselves, but are instead
13895# documented (or will be) as part of the classes/functions/methods
13896# where they should be used.
13897
66c033b4
RD
13898class __DocFilter:
13899 """
13900 A filter for epydoc that only allows non-Ptr classes and
34e0a3bb 13901 functions, in order to reduce the clutter in the API docs.
66c033b4
RD
13902 """
13903 def __init__(self, globals):
13904 self._globals = globals
13905
13906 def __call__(self, name):
13907 import types
13908 obj = self._globals.get(name, None)
34e0a3bb
RD
13909
13910 # only document classes and function
66c033b4
RD
13911 if type(obj) not in [type, types.ClassType, types.FunctionType, types.BuiltinFunctionType]:
13912 return False
34e0a3bb
RD
13913
13914 # skip other things that are private or will be documented as part of somethign else
0085ce49 13915 if name.startswith('_') or name.startswith('EVT') or name.endswith('_swigregister') or name.endswith('Ptr') :
66c033b4 13916 return False
34e0a3bb
RD
13917
13918 # skip functions that are duplicates of static functions in a class
13919 if name.find('_') != -1:
13920 cls = self._globals.get(name.split('_')[0], None)
13921 methname = name.split('_')[1]
13922 if hasattr(cls, methname) and type(getattr(cls, methname)) is types.FunctionType:
13923 return False
13924
66c033b4 13925 return True
a95a7133 13926
d14a1e28
RD
13927#----------------------------------------------------------------------------
13928#----------------------------------------------------------------------------
13929
13930# Import other modules in this package that should show up in the
13931# "core" wx namespace
54f9ee45
RD
13932from _gdi import *
13933from _windows import *
13934from _controls import *
13935from _misc import *
d14a1e28
RD
13936
13937#----------------------------------------------------------------------------
13938#----------------------------------------------------------------------------
13939
13940
32fe5131 13941