]> git.saurik.com Git - wxWidgets.git/blame - wxPython/src/gtk/_core.py
Try using locale.getpreferredencoding
[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))
c25f90f6 2073 FileSystemHandler._setCallbackInfo(self, 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
RD
3760
3761 def Connect(*args, **kwargs):
a95a7133 3762 """Connect(self, int id, int lastId, int eventType, PyObject func)"""
54f9ee45 3763 return _core_.EvtHandler_Connect(*args, **kwargs)
e811c8ce
RD
3764
3765 def Disconnect(*args, **kwargs):
2131d850 3766 """Disconnect(self, int id, int lastId=-1, EventType eventType=wxEVT_NULL) -> bool"""
54f9ee45 3767 return _core_.EvtHandler_Disconnect(*args, **kwargs)
e811c8ce
RD
3768
3769 def _setOORInfo(*args, **kwargs):
689b42ee 3770 """_setOORInfo(self, PyObject _self, bool incref=True)"""
7e08d4ef 3771 val = _core_.EvtHandler__setOORInfo(*args, **kwargs)
15665b47 3772 args[0].this.own(False)
7e08d4ef 3773 return val
e811c8ce 3774
d14a1e28
RD
3775 def Bind(self, event, handler, source=None, id=wx.ID_ANY, id2=wx.ID_ANY):
3776 """
3777 Bind an event to an event handler.
3778
db3e571a
RD
3779 :param event: One of the EVT_* objects that specifies the
3780 type of event to bind,
d14a1e28 3781
db3e571a
RD
3782 :param handler: A callable object to be invoked when the
3783 event is delivered to self. Pass None to
3784 disconnect an event handler.
d14a1e28 3785
db3e571a
RD
3786 :param source: Sometimes the event originates from a
3787 different window than self, but you still
3788 want to catch it in self. (For example, a
3789 button event delivered to a frame.) By
3790 passing the source of the event, the event
3791 handling system is able to differentiate
3792 between the same event type from different
3793 controls.
d14a1e28 3794
db3e571a
RD
3795 :param id: Used to spcify the event source by ID instead
3796 of instance.
3797
3798 :param id2: Used when it is desirable to bind a handler
3799 to a range of IDs, such as with EVT_MENU_RANGE.
d14a1e28
RD
3800 """
3801 if source is not None:
3802 id = source.GetId()
3803 event.Bind(self, id, id2, handler)
3804
66c033b4
RD
3805 def Unbind(self, event, source=None, id=wx.ID_ANY, id2=wx.ID_ANY):
3806 """
3807 Disconencts the event handler binding for event from self.
3808 Returns True if successful.
3809 """
3810 if source is not None:
3811 id = source.GetId()
3812 return event.Unbind(self, id, id2)
d14a1e28 3813
97ab0f6a
RD
3814 EvtHandlerEnabled = property(GetEvtHandlerEnabled,SetEvtHandlerEnabled,doc="See `GetEvtHandlerEnabled` and `SetEvtHandlerEnabled`")
3815 NextHandler = property(GetNextHandler,SetNextHandler,doc="See `GetNextHandler` and `SetNextHandler`")
3816 PreviousHandler = property(GetPreviousHandler,SetPreviousHandler,doc="See `GetPreviousHandler` and `SetPreviousHandler`")
2131d850 3817_core_.EvtHandler_swigregister(EvtHandler)
d14a1e28
RD
3818
3819#---------------------------------------------------------------------------
3820
3821class PyEventBinder(object):
3822 """
3823 Instances of this class are used to bind specific events to event
3824 handlers.
3825 """
3826 def __init__(self, evtType, expectedIDs=0):
3827 if expectedIDs not in [0, 1, 2]:
3828 raise ValueError, "Invalid number of expectedIDs"
3829 self.expectedIDs = expectedIDs
3830
3831 if type(evtType) == list or type(evtType) == tuple:
3832 self.evtType = evtType
3833 else:
3834 self.evtType = [evtType]
3835
3836
3837 def Bind(self, target, id1, id2, function):
3838 """Bind this set of event types to target."""
3839 for et in self.evtType:
3840 target.Connect(id1, id2, et, function)
3841
66c033b4
RD
3842
3843 def Unbind(self, target, id1, id2):
3844 """Remove an event binding."""
3845 success = 0
3846 for et in self.evtType:
3847 success += target.Disconnect(id1, id2, et)
3848 return success != 0
3849
d14a1e28
RD
3850
3851 def __call__(self, *args):
3852 """
3853 For backwards compatibility with the old EVT_* functions.
3854 Should be called with either (window, func), (window, ID,
3855 func) or (window, ID1, ID2, func) parameters depending on the
3856 type of the event.
3857 """
3858 assert len(args) == 2 + self.expectedIDs
3859 id1 = wx.ID_ANY
3860 id2 = wx.ID_ANY
3861 target = args[0]
3862 if self.expectedIDs == 0:
3863 func = args[1]
3864 elif self.expectedIDs == 1:
3865 id1 = args[1]
3866 func = args[2]
3867 elif self.expectedIDs == 2:
3868 id1 = args[1]
3869 id2 = args[2]
3870 func = args[3]
3871 else:
3872 raise ValueError, "Unexpected number of IDs"
3873
3874 self.Bind(target, id1, id2, func)
3875
3876
3877# These two are square pegs that don't fit the PyEventBinder hole...
3878def EVT_COMMAND(win, id, cmd, func):
3879 win.Connect(id, -1, cmd, func)
3880def EVT_COMMAND_RANGE(win, id1, id2, cmd, func):
3881 win.Connect(id1, id2, cmd, func)
3882
3883
3884#---------------------------------------------------------------------------
3885
3886#---------------------------------------------------------------------------
3887
54f9ee45
RD
3888EVENT_PROPAGATE_NONE = _core_.EVENT_PROPAGATE_NONE
3889EVENT_PROPAGATE_MAX = _core_.EVENT_PROPAGATE_MAX
d14a1e28 3890
0085ce49 3891def NewEventType(*args):
2131d850 3892 """NewEventType() -> EventType"""
0085ce49 3893 return _core_.NewEventType(*args)
54f9ee45
RD
3894wxEVT_NULL = _core_.wxEVT_NULL
3895wxEVT_FIRST = _core_.wxEVT_FIRST
3896wxEVT_USER_FIRST = _core_.wxEVT_USER_FIRST
3897wxEVT_COMMAND_BUTTON_CLICKED = _core_.wxEVT_COMMAND_BUTTON_CLICKED
3898wxEVT_COMMAND_CHECKBOX_CLICKED = _core_.wxEVT_COMMAND_CHECKBOX_CLICKED
3899wxEVT_COMMAND_CHOICE_SELECTED = _core_.wxEVT_COMMAND_CHOICE_SELECTED
3900wxEVT_COMMAND_LISTBOX_SELECTED = _core_.wxEVT_COMMAND_LISTBOX_SELECTED
3901wxEVT_COMMAND_LISTBOX_DOUBLECLICKED = _core_.wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
3902wxEVT_COMMAND_CHECKLISTBOX_TOGGLED = _core_.wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
3903wxEVT_COMMAND_MENU_SELECTED = _core_.wxEVT_COMMAND_MENU_SELECTED
3904wxEVT_COMMAND_TOOL_CLICKED = _core_.wxEVT_COMMAND_TOOL_CLICKED
3905wxEVT_COMMAND_SLIDER_UPDATED = _core_.wxEVT_COMMAND_SLIDER_UPDATED
3906wxEVT_COMMAND_RADIOBOX_SELECTED = _core_.wxEVT_COMMAND_RADIOBOX_SELECTED
3907wxEVT_COMMAND_RADIOBUTTON_SELECTED = _core_.wxEVT_COMMAND_RADIOBUTTON_SELECTED
3908wxEVT_COMMAND_SCROLLBAR_UPDATED = _core_.wxEVT_COMMAND_SCROLLBAR_UPDATED
3909wxEVT_COMMAND_VLBOX_SELECTED = _core_.wxEVT_COMMAND_VLBOX_SELECTED
3910wxEVT_COMMAND_COMBOBOX_SELECTED = _core_.wxEVT_COMMAND_COMBOBOX_SELECTED
3911wxEVT_COMMAND_TOOL_RCLICKED = _core_.wxEVT_COMMAND_TOOL_RCLICKED
3912wxEVT_COMMAND_TOOL_ENTER = _core_.wxEVT_COMMAND_TOOL_ENTER
3913wxEVT_LEFT_DOWN = _core_.wxEVT_LEFT_DOWN
3914wxEVT_LEFT_UP = _core_.wxEVT_LEFT_UP
3915wxEVT_MIDDLE_DOWN = _core_.wxEVT_MIDDLE_DOWN
3916wxEVT_MIDDLE_UP = _core_.wxEVT_MIDDLE_UP
3917wxEVT_RIGHT_DOWN = _core_.wxEVT_RIGHT_DOWN
3918wxEVT_RIGHT_UP = _core_.wxEVT_RIGHT_UP
3919wxEVT_MOTION = _core_.wxEVT_MOTION
3920wxEVT_ENTER_WINDOW = _core_.wxEVT_ENTER_WINDOW
3921wxEVT_LEAVE_WINDOW = _core_.wxEVT_LEAVE_WINDOW
3922wxEVT_LEFT_DCLICK = _core_.wxEVT_LEFT_DCLICK
3923wxEVT_MIDDLE_DCLICK = _core_.wxEVT_MIDDLE_DCLICK
3924wxEVT_RIGHT_DCLICK = _core_.wxEVT_RIGHT_DCLICK
3925wxEVT_SET_FOCUS = _core_.wxEVT_SET_FOCUS
3926wxEVT_KILL_FOCUS = _core_.wxEVT_KILL_FOCUS
3927wxEVT_CHILD_FOCUS = _core_.wxEVT_CHILD_FOCUS
3928wxEVT_MOUSEWHEEL = _core_.wxEVT_MOUSEWHEEL
3929wxEVT_NC_LEFT_DOWN = _core_.wxEVT_NC_LEFT_DOWN
3930wxEVT_NC_LEFT_UP = _core_.wxEVT_NC_LEFT_UP
3931wxEVT_NC_MIDDLE_DOWN = _core_.wxEVT_NC_MIDDLE_DOWN
3932wxEVT_NC_MIDDLE_UP = _core_.wxEVT_NC_MIDDLE_UP
3933wxEVT_NC_RIGHT_DOWN = _core_.wxEVT_NC_RIGHT_DOWN
3934wxEVT_NC_RIGHT_UP = _core_.wxEVT_NC_RIGHT_UP
3935wxEVT_NC_MOTION = _core_.wxEVT_NC_MOTION
3936wxEVT_NC_ENTER_WINDOW = _core_.wxEVT_NC_ENTER_WINDOW
3937wxEVT_NC_LEAVE_WINDOW = _core_.wxEVT_NC_LEAVE_WINDOW
3938wxEVT_NC_LEFT_DCLICK = _core_.wxEVT_NC_LEFT_DCLICK
3939wxEVT_NC_MIDDLE_DCLICK = _core_.wxEVT_NC_MIDDLE_DCLICK
3940wxEVT_NC_RIGHT_DCLICK = _core_.wxEVT_NC_RIGHT_DCLICK
3941wxEVT_CHAR = _core_.wxEVT_CHAR
3942wxEVT_CHAR_HOOK = _core_.wxEVT_CHAR_HOOK
3943wxEVT_NAVIGATION_KEY = _core_.wxEVT_NAVIGATION_KEY
3944wxEVT_KEY_DOWN = _core_.wxEVT_KEY_DOWN
3945wxEVT_KEY_UP = _core_.wxEVT_KEY_UP
3946wxEVT_HOTKEY = _core_.wxEVT_HOTKEY
3947wxEVT_SET_CURSOR = _core_.wxEVT_SET_CURSOR
3948wxEVT_SCROLL_TOP = _core_.wxEVT_SCROLL_TOP
3949wxEVT_SCROLL_BOTTOM = _core_.wxEVT_SCROLL_BOTTOM
3950wxEVT_SCROLL_LINEUP = _core_.wxEVT_SCROLL_LINEUP
3951wxEVT_SCROLL_LINEDOWN = _core_.wxEVT_SCROLL_LINEDOWN
3952wxEVT_SCROLL_PAGEUP = _core_.wxEVT_SCROLL_PAGEUP
3953wxEVT_SCROLL_PAGEDOWN = _core_.wxEVT_SCROLL_PAGEDOWN
3954wxEVT_SCROLL_THUMBTRACK = _core_.wxEVT_SCROLL_THUMBTRACK
3955wxEVT_SCROLL_THUMBRELEASE = _core_.wxEVT_SCROLL_THUMBRELEASE
4f433fef
RD
3956wxEVT_SCROLL_CHANGED = _core_.wxEVT_SCROLL_CHANGED
3957wxEVT_SCROLL_ENDSCROLL = wxEVT_SCROLL_CHANGED
54f9ee45
RD
3958wxEVT_SCROLLWIN_TOP = _core_.wxEVT_SCROLLWIN_TOP
3959wxEVT_SCROLLWIN_BOTTOM = _core_.wxEVT_SCROLLWIN_BOTTOM
3960wxEVT_SCROLLWIN_LINEUP = _core_.wxEVT_SCROLLWIN_LINEUP
3961wxEVT_SCROLLWIN_LINEDOWN = _core_.wxEVT_SCROLLWIN_LINEDOWN
3962wxEVT_SCROLLWIN_PAGEUP = _core_.wxEVT_SCROLLWIN_PAGEUP
3963wxEVT_SCROLLWIN_PAGEDOWN = _core_.wxEVT_SCROLLWIN_PAGEDOWN
3964wxEVT_SCROLLWIN_THUMBTRACK = _core_.wxEVT_SCROLLWIN_THUMBTRACK
3965wxEVT_SCROLLWIN_THUMBRELEASE = _core_.wxEVT_SCROLLWIN_THUMBRELEASE
3966wxEVT_SIZE = _core_.wxEVT_SIZE
3967wxEVT_MOVE = _core_.wxEVT_MOVE
3968wxEVT_CLOSE_WINDOW = _core_.wxEVT_CLOSE_WINDOW
3969wxEVT_END_SESSION = _core_.wxEVT_END_SESSION
3970wxEVT_QUERY_END_SESSION = _core_.wxEVT_QUERY_END_SESSION
3971wxEVT_ACTIVATE_APP = _core_.wxEVT_ACTIVATE_APP
54f9ee45
RD
3972wxEVT_ACTIVATE = _core_.wxEVT_ACTIVATE
3973wxEVT_CREATE = _core_.wxEVT_CREATE
3974wxEVT_DESTROY = _core_.wxEVT_DESTROY
3975wxEVT_SHOW = _core_.wxEVT_SHOW
3976wxEVT_ICONIZE = _core_.wxEVT_ICONIZE
3977wxEVT_MAXIMIZE = _core_.wxEVT_MAXIMIZE
3978wxEVT_MOUSE_CAPTURE_CHANGED = _core_.wxEVT_MOUSE_CAPTURE_CHANGED
34e0a3bb 3979wxEVT_MOUSE_CAPTURE_LOST = _core_.wxEVT_MOUSE_CAPTURE_LOST
54f9ee45
RD
3980wxEVT_PAINT = _core_.wxEVT_PAINT
3981wxEVT_ERASE_BACKGROUND = _core_.wxEVT_ERASE_BACKGROUND
3982wxEVT_NC_PAINT = _core_.wxEVT_NC_PAINT
3983wxEVT_PAINT_ICON = _core_.wxEVT_PAINT_ICON
3984wxEVT_MENU_OPEN = _core_.wxEVT_MENU_OPEN
3985wxEVT_MENU_CLOSE = _core_.wxEVT_MENU_CLOSE
3986wxEVT_MENU_HIGHLIGHT = _core_.wxEVT_MENU_HIGHLIGHT
3987wxEVT_CONTEXT_MENU = _core_.wxEVT_CONTEXT_MENU
3988wxEVT_SYS_COLOUR_CHANGED = _core_.wxEVT_SYS_COLOUR_CHANGED
3989wxEVT_DISPLAY_CHANGED = _core_.wxEVT_DISPLAY_CHANGED
3990wxEVT_SETTING_CHANGED = _core_.wxEVT_SETTING_CHANGED
3991wxEVT_QUERY_NEW_PALETTE = _core_.wxEVT_QUERY_NEW_PALETTE
3992wxEVT_PALETTE_CHANGED = _core_.wxEVT_PALETTE_CHANGED
3993wxEVT_DROP_FILES = _core_.wxEVT_DROP_FILES
3994wxEVT_DRAW_ITEM = _core_.wxEVT_DRAW_ITEM
3995wxEVT_MEASURE_ITEM = _core_.wxEVT_MEASURE_ITEM
3996wxEVT_COMPARE_ITEM = _core_.wxEVT_COMPARE_ITEM
3997wxEVT_INIT_DIALOG = _core_.wxEVT_INIT_DIALOG
3998wxEVT_IDLE = _core_.wxEVT_IDLE
3999wxEVT_UPDATE_UI = _core_.wxEVT_UPDATE_UI
4000wxEVT_SIZING = _core_.wxEVT_SIZING
4001wxEVT_MOVING = _core_.wxEVT_MOVING
88c6b281 4002wxEVT_HIBERNATE = _core_.wxEVT_HIBERNATE
2131d850
RD
4003wxEVT_COMMAND_TEXT_COPY = _core_.wxEVT_COMMAND_TEXT_COPY
4004wxEVT_COMMAND_TEXT_CUT = _core_.wxEVT_COMMAND_TEXT_CUT
4005wxEVT_COMMAND_TEXT_PASTE = _core_.wxEVT_COMMAND_TEXT_PASTE
54f9ee45
RD
4006wxEVT_COMMAND_LEFT_CLICK = _core_.wxEVT_COMMAND_LEFT_CLICK
4007wxEVT_COMMAND_LEFT_DCLICK = _core_.wxEVT_COMMAND_LEFT_DCLICK
4008wxEVT_COMMAND_RIGHT_CLICK = _core_.wxEVT_COMMAND_RIGHT_CLICK
4009wxEVT_COMMAND_RIGHT_DCLICK = _core_.wxEVT_COMMAND_RIGHT_DCLICK
4010wxEVT_COMMAND_SET_FOCUS = _core_.wxEVT_COMMAND_SET_FOCUS
4011wxEVT_COMMAND_KILL_FOCUS = _core_.wxEVT_COMMAND_KILL_FOCUS
4012wxEVT_COMMAND_ENTER = _core_.wxEVT_COMMAND_ENTER
d14a1e28
RD
4013#
4014# Create some event binders
4015EVT_SIZE = wx.PyEventBinder( wxEVT_SIZE )
4016EVT_SIZING = wx.PyEventBinder( wxEVT_SIZING )
4017EVT_MOVE = wx.PyEventBinder( wxEVT_MOVE )
4018EVT_MOVING = wx.PyEventBinder( wxEVT_MOVING )
4019EVT_CLOSE = wx.PyEventBinder( wxEVT_CLOSE_WINDOW )
4020EVT_END_SESSION = wx.PyEventBinder( wxEVT_END_SESSION )
4021EVT_QUERY_END_SESSION = wx.PyEventBinder( wxEVT_QUERY_END_SESSION )
4022EVT_PAINT = wx.PyEventBinder( wxEVT_PAINT )
4023EVT_NC_PAINT = wx.PyEventBinder( wxEVT_NC_PAINT )
4024EVT_ERASE_BACKGROUND = wx.PyEventBinder( wxEVT_ERASE_BACKGROUND )
4025EVT_CHAR = wx.PyEventBinder( wxEVT_CHAR )
4026EVT_KEY_DOWN = wx.PyEventBinder( wxEVT_KEY_DOWN )
4027EVT_KEY_UP = wx.PyEventBinder( wxEVT_KEY_UP )
704eda0c 4028EVT_HOTKEY = wx.PyEventBinder( wxEVT_HOTKEY, 1)
d14a1e28
RD
4029EVT_CHAR_HOOK = wx.PyEventBinder( wxEVT_CHAR_HOOK )
4030EVT_MENU_OPEN = wx.PyEventBinder( wxEVT_MENU_OPEN )
4031EVT_MENU_CLOSE = wx.PyEventBinder( wxEVT_MENU_CLOSE )
4032EVT_MENU_HIGHLIGHT = wx.PyEventBinder( wxEVT_MENU_HIGHLIGHT, 1)
4033EVT_MENU_HIGHLIGHT_ALL = wx.PyEventBinder( wxEVT_MENU_HIGHLIGHT )
4034EVT_SET_FOCUS = wx.PyEventBinder( wxEVT_SET_FOCUS )
4035EVT_KILL_FOCUS = wx.PyEventBinder( wxEVT_KILL_FOCUS )
4036EVT_CHILD_FOCUS = wx.PyEventBinder( wxEVT_CHILD_FOCUS )
4037EVT_ACTIVATE = wx.PyEventBinder( wxEVT_ACTIVATE )
4038EVT_ACTIVATE_APP = wx.PyEventBinder( wxEVT_ACTIVATE_APP )
704eda0c 4039EVT_HIBERNATE = wx.PyEventBinder( wxEVT_HIBERNATE )
d14a1e28
RD
4040EVT_END_SESSION = wx.PyEventBinder( wxEVT_END_SESSION )
4041EVT_QUERY_END_SESSION = wx.PyEventBinder( wxEVT_QUERY_END_SESSION )
4042EVT_DROP_FILES = wx.PyEventBinder( wxEVT_DROP_FILES )
4043EVT_INIT_DIALOG = wx.PyEventBinder( wxEVT_INIT_DIALOG )
4044EVT_SYS_COLOUR_CHANGED = wx.PyEventBinder( wxEVT_SYS_COLOUR_CHANGED )
4045EVT_DISPLAY_CHANGED = wx.PyEventBinder( wxEVT_DISPLAY_CHANGED )
4046EVT_SHOW = wx.PyEventBinder( wxEVT_SHOW )
4047EVT_MAXIMIZE = wx.PyEventBinder( wxEVT_MAXIMIZE )
4048EVT_ICONIZE = wx.PyEventBinder( wxEVT_ICONIZE )
4049EVT_NAVIGATION_KEY = wx.PyEventBinder( wxEVT_NAVIGATION_KEY )
4050EVT_PALETTE_CHANGED = wx.PyEventBinder( wxEVT_PALETTE_CHANGED )
4051EVT_QUERY_NEW_PALETTE = wx.PyEventBinder( wxEVT_QUERY_NEW_PALETTE )
4052EVT_WINDOW_CREATE = wx.PyEventBinder( wxEVT_CREATE )
4053EVT_WINDOW_DESTROY = wx.PyEventBinder( wxEVT_DESTROY )
4054EVT_SET_CURSOR = wx.PyEventBinder( wxEVT_SET_CURSOR )
4055EVT_MOUSE_CAPTURE_CHANGED = wx.PyEventBinder( wxEVT_MOUSE_CAPTURE_CHANGED )
34e0a3bb 4056EVT_MOUSE_CAPTURE_LOST = wx.PyEventBinder( wxEVT_MOUSE_CAPTURE_LOST )
d14a1e28
RD
4057
4058EVT_LEFT_DOWN = wx.PyEventBinder( wxEVT_LEFT_DOWN )
4059EVT_LEFT_UP = wx.PyEventBinder( wxEVT_LEFT_UP )
4060EVT_MIDDLE_DOWN = wx.PyEventBinder( wxEVT_MIDDLE_DOWN )
4061EVT_MIDDLE_UP = wx.PyEventBinder( wxEVT_MIDDLE_UP )
4062EVT_RIGHT_DOWN = wx.PyEventBinder( wxEVT_RIGHT_DOWN )
4063EVT_RIGHT_UP = wx.PyEventBinder( wxEVT_RIGHT_UP )
4064EVT_MOTION = wx.PyEventBinder( wxEVT_MOTION )
4065EVT_LEFT_DCLICK = wx.PyEventBinder( wxEVT_LEFT_DCLICK )
4066EVT_MIDDLE_DCLICK = wx.PyEventBinder( wxEVT_MIDDLE_DCLICK )
4067EVT_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_RIGHT_DCLICK )
4068EVT_LEAVE_WINDOW = wx.PyEventBinder( wxEVT_LEAVE_WINDOW )
4069EVT_ENTER_WINDOW = wx.PyEventBinder( wxEVT_ENTER_WINDOW )
4070EVT_MOUSEWHEEL = wx.PyEventBinder( wxEVT_MOUSEWHEEL )
4071
4072EVT_MOUSE_EVENTS = wx.PyEventBinder([ wxEVT_LEFT_DOWN,
4073 wxEVT_LEFT_UP,
4074 wxEVT_MIDDLE_DOWN,
4075 wxEVT_MIDDLE_UP,
4076 wxEVT_RIGHT_DOWN,
4077 wxEVT_RIGHT_UP,
4078 wxEVT_MOTION,
4079 wxEVT_LEFT_DCLICK,
4080 wxEVT_MIDDLE_DCLICK,
4081 wxEVT_RIGHT_DCLICK,
4082 wxEVT_ENTER_WINDOW,
4083 wxEVT_LEAVE_WINDOW,
4084 wxEVT_MOUSEWHEEL
4085 ])
4086
4087
4088# Scrolling from wxWindow (sent to wxScrolledWindow)
704eda0c 4089EVT_SCROLLWIN = wx.PyEventBinder([ wxEVT_SCROLLWIN_TOP,
d14a1e28
RD
4090 wxEVT_SCROLLWIN_BOTTOM,
4091 wxEVT_SCROLLWIN_LINEUP,
4092 wxEVT_SCROLLWIN_LINEDOWN,
704eda0c 4093 wxEVT_SCROLLWIN_PAGEUP,
d14a1e28
RD
4094 wxEVT_SCROLLWIN_PAGEDOWN,
4095 wxEVT_SCROLLWIN_THUMBTRACK,
4096 wxEVT_SCROLLWIN_THUMBRELEASE,
4097 ])
4098
4099EVT_SCROLLWIN_TOP = wx.PyEventBinder( wxEVT_SCROLLWIN_TOP )
4100EVT_SCROLLWIN_BOTTOM = wx.PyEventBinder( wxEVT_SCROLLWIN_BOTTOM )
4101EVT_SCROLLWIN_LINEUP = wx.PyEventBinder( wxEVT_SCROLLWIN_LINEUP )
4102EVT_SCROLLWIN_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLLWIN_LINEDOWN )
4103EVT_SCROLLWIN_PAGEUP = wx.PyEventBinder( wxEVT_SCROLLWIN_PAGEUP )
4104EVT_SCROLLWIN_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLLWIN_PAGEDOWN )
4105EVT_SCROLLWIN_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLLWIN_THUMBTRACK )
4106EVT_SCROLLWIN_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLLWIN_THUMBRELEASE )
4107
27fb7603 4108# Scrolling from wx.Slider and wx.ScrollBar
704eda0c
RD
4109EVT_SCROLL = wx.PyEventBinder([ wxEVT_SCROLL_TOP,
4110 wxEVT_SCROLL_BOTTOM,
4111 wxEVT_SCROLL_LINEUP,
4112 wxEVT_SCROLL_LINEDOWN,
4113 wxEVT_SCROLL_PAGEUP,
4114 wxEVT_SCROLL_PAGEDOWN,
4115 wxEVT_SCROLL_THUMBTRACK,
4116 wxEVT_SCROLL_THUMBRELEASE,
4f433fef 4117 wxEVT_SCROLL_CHANGED,
d14a1e28
RD
4118 ])
4119
4120EVT_SCROLL_TOP = wx.PyEventBinder( wxEVT_SCROLL_TOP )
4121EVT_SCROLL_BOTTOM = wx.PyEventBinder( wxEVT_SCROLL_BOTTOM )
4122EVT_SCROLL_LINEUP = wx.PyEventBinder( wxEVT_SCROLL_LINEUP )
4123EVT_SCROLL_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLL_LINEDOWN )
4124EVT_SCROLL_PAGEUP = wx.PyEventBinder( wxEVT_SCROLL_PAGEUP )
4125EVT_SCROLL_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLL_PAGEDOWN )
4126EVT_SCROLL_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLL_THUMBTRACK )
4127EVT_SCROLL_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE )
4f433fef
RD
4128EVT_SCROLL_CHANGED = wx.PyEventBinder( wxEVT_SCROLL_CHANGED )
4129EVT_SCROLL_ENDSCROLL = EVT_SCROLL_CHANGED
704eda0c 4130
27fb7603 4131# Scrolling from wx.Slider and wx.ScrollBar, with an id
704eda0c
RD
4132EVT_COMMAND_SCROLL = wx.PyEventBinder([ wxEVT_SCROLL_TOP,
4133 wxEVT_SCROLL_BOTTOM,
4134 wxEVT_SCROLL_LINEUP,
4135 wxEVT_SCROLL_LINEDOWN,
4136 wxEVT_SCROLL_PAGEUP,
4137 wxEVT_SCROLL_PAGEDOWN,
4138 wxEVT_SCROLL_THUMBTRACK,
d14a1e28 4139 wxEVT_SCROLL_THUMBRELEASE,
4f433fef 4140 wxEVT_SCROLL_CHANGED,
d14a1e28
RD
4141 ], 1)
4142
4143EVT_COMMAND_SCROLL_TOP = wx.PyEventBinder( wxEVT_SCROLL_TOP, 1)
4144EVT_COMMAND_SCROLL_BOTTOM = wx.PyEventBinder( wxEVT_SCROLL_BOTTOM, 1)
4145EVT_COMMAND_SCROLL_LINEUP = wx.PyEventBinder( wxEVT_SCROLL_LINEUP, 1)
4146EVT_COMMAND_SCROLL_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLL_LINEDOWN, 1)
4147EVT_COMMAND_SCROLL_PAGEUP = wx.PyEventBinder( wxEVT_SCROLL_PAGEUP, 1)
4148EVT_COMMAND_SCROLL_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLL_PAGEDOWN, 1)
4149EVT_COMMAND_SCROLL_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLL_THUMBTRACK, 1)
4150EVT_COMMAND_SCROLL_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE, 1)
4f433fef
RD
4151EVT_COMMAND_SCROLL_CHANGED = wx.PyEventBinder( wxEVT_SCROLL_CHANGED, 1)
4152EVT_COMMAND_SCROLL_ENDSCROLL = EVT_COMMAND_SCROLL_CHANGED
d14a1e28 4153
d14a1e28
RD
4154EVT_BUTTON = wx.PyEventBinder( wxEVT_COMMAND_BUTTON_CLICKED, 1)
4155EVT_CHECKBOX = wx.PyEventBinder( wxEVT_COMMAND_CHECKBOX_CLICKED, 1)
4156EVT_CHOICE = wx.PyEventBinder( wxEVT_COMMAND_CHOICE_SELECTED, 1)
4157EVT_LISTBOX = wx.PyEventBinder( wxEVT_COMMAND_LISTBOX_SELECTED, 1)
4158EVT_LISTBOX_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, 1)
4159EVT_MENU = wx.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED, 1)
4160EVT_MENU_RANGE = wx.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED, 2)
4161EVT_SLIDER = wx.PyEventBinder( wxEVT_COMMAND_SLIDER_UPDATED, 1)
4162EVT_RADIOBOX = wx.PyEventBinder( wxEVT_COMMAND_RADIOBOX_SELECTED, 1)
4163EVT_RADIOBUTTON = wx.PyEventBinder( wxEVT_COMMAND_RADIOBUTTON_SELECTED, 1)
4164
4165EVT_SCROLLBAR = wx.PyEventBinder( wxEVT_COMMAND_SCROLLBAR_UPDATED, 1)
4166EVT_VLBOX = wx.PyEventBinder( wxEVT_COMMAND_VLBOX_SELECTED, 1)
4167EVT_COMBOBOX = wx.PyEventBinder( wxEVT_COMMAND_COMBOBOX_SELECTED, 1)
4168EVT_TOOL = wx.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED, 1)
4169EVT_TOOL_RANGE = wx.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED, 2)
4170EVT_TOOL_RCLICKED = wx.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED, 1)
4171EVT_TOOL_RCLICKED_RANGE = wx.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED, 2)
4172EVT_TOOL_ENTER = wx.PyEventBinder( wxEVT_COMMAND_TOOL_ENTER, 1)
4173EVT_CHECKLISTBOX = wx.PyEventBinder( wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, 1)
4174
4175
4176EVT_COMMAND_LEFT_CLICK = wx.PyEventBinder( wxEVT_COMMAND_LEFT_CLICK, 1)
4177EVT_COMMAND_LEFT_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_LEFT_DCLICK, 1)
4178EVT_COMMAND_RIGHT_CLICK = wx.PyEventBinder( wxEVT_COMMAND_RIGHT_CLICK, 1)
4179EVT_COMMAND_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_RIGHT_DCLICK, 1)
4180EVT_COMMAND_SET_FOCUS = wx.PyEventBinder( wxEVT_COMMAND_SET_FOCUS, 1)
4181EVT_COMMAND_KILL_FOCUS = wx.PyEventBinder( wxEVT_COMMAND_KILL_FOCUS, 1)
4182EVT_COMMAND_ENTER = wx.PyEventBinder( wxEVT_COMMAND_ENTER, 1)
4183
4184EVT_IDLE = wx.PyEventBinder( wxEVT_IDLE )
4185
4186EVT_UPDATE_UI = wx.PyEventBinder( wxEVT_UPDATE_UI, 1)
4187EVT_UPDATE_UI_RANGE = wx.PyEventBinder( wxEVT_UPDATE_UI, 2)
4188
4189EVT_CONTEXT_MENU = wx.PyEventBinder( wxEVT_CONTEXT_MENU )
4190
2131d850
RD
4191EVT_TEXT_CUT = wx.PyEventBinder( wxEVT_COMMAND_TEXT_CUT )
4192EVT_TEXT_COPY = wx.PyEventBinder( wxEVT_COMMAND_TEXT_COPY )
4193EVT_TEXT_PASTE = wx.PyEventBinder( wxEVT_COMMAND_TEXT_PASTE )
d14a1e28
RD
4194
4195
4196#---------------------------------------------------------------------------
4197
4198class Event(Object):
27fb7603
RD
4199 """
4200 An event is a structure holding information about an event passed to a
4201 callback or member function. wx.Event is an abstract base class for
4202 other event classes
4203 """
0085ce49
RD
4204 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4205 def __init__(self): raise AttributeError, "No constructor defined"
4206 __repr__ = _swig_repr
4207 __swig_destroy__ = _core_.delete_Event
4208 __del__ = lambda self : None;
e811c8ce 4209 def SetEventType(*args, **kwargs):
27fb7603 4210 """
2131d850 4211 SetEventType(self, EventType typ)
27fb7603
RD
4212
4213 Sets the specific type of the event.
4214 """
54f9ee45 4215 return _core_.Event_SetEventType(*args, **kwargs)
e811c8ce
RD
4216
4217 def GetEventType(*args, **kwargs):
27fb7603 4218 """
2131d850 4219 GetEventType(self) -> EventType
27fb7603
RD
4220
4221 Returns the identifier of the given event type, such as
4222 ``wxEVT_COMMAND_BUTTON_CLICKED``.
4223 """
54f9ee45 4224 return _core_.Event_GetEventType(*args, **kwargs)
e811c8ce
RD
4225
4226 def GetEventObject(*args, **kwargs):
27fb7603
RD
4227 """
4228 GetEventObject(self) -> Object
4229
4230 Returns the object (usually a window) associated with the event, if
4231 any.
4232 """
54f9ee45 4233 return _core_.Event_GetEventObject(*args, **kwargs)
e811c8ce
RD
4234
4235 def SetEventObject(*args, **kwargs):
27fb7603
RD
4236 """
4237 SetEventObject(self, Object obj)
4238
4239 Sets the originating object, or in other words, obj is normally the
4240 object that is sending the event.
4241 """
54f9ee45 4242 return _core_.Event_SetEventObject(*args, **kwargs)
e811c8ce
RD
4243
4244 def GetTimestamp(*args, **kwargs):
a95a7133 4245 """GetTimestamp(self) -> long"""
54f9ee45 4246 return _core_.Event_GetTimestamp(*args, **kwargs)
e811c8ce
RD
4247
4248 def SetTimestamp(*args, **kwargs):
a95a7133 4249 """SetTimestamp(self, long ts=0)"""
54f9ee45 4250 return _core_.Event_SetTimestamp(*args, **kwargs)
e811c8ce
RD
4251
4252 def GetId(*args, **kwargs):
27fb7603
RD
4253 """
4254 GetId(self) -> int
4255
4256 Returns the identifier associated with this event, such as a button
4257 command id.
4258 """
54f9ee45 4259 return _core_.Event_GetId(*args, **kwargs)
e811c8ce
RD
4260
4261 def SetId(*args, **kwargs):
27fb7603
RD
4262 """
4263 SetId(self, int Id)
4264
4265 Set's the ID for the event. This is usually the ID of the window that
4266 is sending the event, but it can also be a command id from a menu
4267 item, etc.
4268 """
54f9ee45 4269 return _core_.Event_SetId(*args, **kwargs)
e811c8ce
RD
4270
4271 def IsCommandEvent(*args, **kwargs):
27fb7603
RD
4272 """
4273 IsCommandEvent(self) -> bool
4274
4275 Returns true if the event is or is derived from `wx.CommandEvent` else
4276 it returns false. Note: Exists only for optimization purposes.
4277 """
54f9ee45 4278 return _core_.Event_IsCommandEvent(*args, **kwargs)
e811c8ce
RD
4279
4280 def Skip(*args, **kwargs):
51b83b37
RD
4281 """
4282 Skip(self, bool skip=True)
4283
6b449b19
RD
4284 This method can be used inside an event handler to control whether
4285 further event handlers bound to this event will be called after the
4286 current one returns. Without Skip() (or equivalently if Skip(False) is
4287 used), the event will not be processed any more. If Skip(True) is
4288 called, the event processing system continues searching for a further
4289 handler function for this event, even though it has been processed
4290 already in the current handler.
51b83b37 4291 """
54f9ee45 4292 return _core_.Event_Skip(*args, **kwargs)
e811c8ce
RD
4293
4294 def GetSkipped(*args, **kwargs):
27fb7603
RD
4295 """
4296 GetSkipped(self) -> bool
4297
4298 Returns true if the event handler should be skipped, false otherwise.
4299 :see: `Skip`
4300 """
54f9ee45 4301 return _core_.Event_GetSkipped(*args, **kwargs)
e811c8ce
RD
4302
4303 def ShouldPropagate(*args, **kwargs):
27fb7603
RD
4304 """
4305 ShouldPropagate(self) -> bool
4306
4307 Test if this event should be propagated to the parent window or not,
4308 i.e. if the propagation level is currently greater than 0.
4309 """
54f9ee45 4310 return _core_.Event_ShouldPropagate(*args, **kwargs)
e811c8ce
RD
4311
4312 def StopPropagation(*args, **kwargs):
27fb7603
RD
4313 """
4314 StopPropagation(self) -> int
4315
4316 Stop the event from propagating to its parent window. Returns the old
4317 propagation level value which may be later passed to
4318 `ResumePropagation` to allow propagating the event again.
4319 """
54f9ee45 4320 return _core_.Event_StopPropagation(*args, **kwargs)
e811c8ce
RD
4321
4322 def ResumePropagation(*args, **kwargs):
27fb7603
RD
4323 """
4324 ResumePropagation(self, int propagationLevel)
4325
4326 Resume the event propagation by restoring the propagation level. (For
4327 example, you can use the value returned by an earlier call to
4328 `StopPropagation`.)
4329
4330 """
54f9ee45 4331 return _core_.Event_ResumePropagation(*args, **kwargs)
e811c8ce
RD
4332
4333 def Clone(*args, **kwargs):
a95a7133 4334 """Clone(self) -> Event"""
54f9ee45 4335 return _core_.Event_Clone(*args, **kwargs)
e811c8ce 4336
97ab0f6a
RD
4337 EventObject = property(GetEventObject,SetEventObject,doc="See `GetEventObject` and `SetEventObject`")
4338 EventType = property(GetEventType,SetEventType,doc="See `GetEventType` and `SetEventType`")
4339 Id = property(GetId,SetId,doc="See `GetId` and `SetId`")
4340 Skipped = property(GetSkipped,doc="See `GetSkipped`")
4341 Timestamp = property(GetTimestamp,SetTimestamp,doc="See `GetTimestamp` and `SetTimestamp`")
2131d850 4342_core_.Event_swigregister(Event)
d14a1e28
RD
4343
4344#---------------------------------------------------------------------------
4345
4346class PropagationDisabler(object):
27fb7603
RD
4347 """
4348 Helper class to temporarily change an event not to propagate. Simply
4349 create an instance of this class and then whe it is destroyed the
4350 propogation of the event will be restored.
4351 """
0085ce49
RD
4352 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4353 __repr__ = _swig_repr
4354 def __init__(self, *args, **kwargs):
27fb7603
RD
4355 """
4356 __init__(self, Event event) -> PropagationDisabler
4357
4358 Helper class to temporarily change an event not to propagate. Simply
4359 create an instance of this class and then whe it is destroyed the
4360 propogation of the event will be restored.
4361 """
0085ce49
RD
4362 _core_.PropagationDisabler_swiginit(self,_core_.new_PropagationDisabler(*args, **kwargs))
4363 __swig_destroy__ = _core_.delete_PropagationDisabler
4364 __del__ = lambda self : None;
2131d850 4365_core_.PropagationDisabler_swigregister(PropagationDisabler)
d14a1e28
RD
4366
4367class PropagateOnce(object):
27fb7603
RD
4368 """
4369 A helper class that will temporarily lower propagation level of an
4370 event. Simply create an instance of this class and then whe it is
4371 destroyed the propogation of the event will be restored.
4372 """
0085ce49
RD
4373 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4374 __repr__ = _swig_repr
4375 def __init__(self, *args, **kwargs):
27fb7603
RD
4376 """
4377 __init__(self, Event event) -> PropagateOnce
4378
4379 A helper class that will temporarily lower propagation level of an
4380 event. Simply create an instance of this class and then whe it is
4381 destroyed the propogation of the event will be restored.
4382 """
0085ce49
RD
4383 _core_.PropagateOnce_swiginit(self,_core_.new_PropagateOnce(*args, **kwargs))
4384 __swig_destroy__ = _core_.delete_PropagateOnce
4385 __del__ = lambda self : None;
2131d850 4386_core_.PropagateOnce_swigregister(PropagateOnce)
d14a1e28
RD
4387
4388#---------------------------------------------------------------------------
4389
4390class CommandEvent(Event):
27fb7603
RD
4391 """
4392 This event class contains information about command events, which
4393 originate from a variety of simple controls, as well as menus and
4394 toolbars.
4395 """
0085ce49
RD
4396 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4397 __repr__ = _swig_repr
4398 def __init__(self, *args, **kwargs):
27fb7603 4399 """
2131d850 4400 __init__(self, EventType commandType=wxEVT_NULL, int winid=0) -> CommandEvent
27fb7603
RD
4401
4402 This event class contains information about command events, which
4403 originate from a variety of simple controls, as well as menus and
4404 toolbars.
4405 """
0085ce49 4406 _core_.CommandEvent_swiginit(self,_core_.new_CommandEvent(*args, **kwargs))
e811c8ce 4407 def GetSelection(*args, **kwargs):
27fb7603
RD
4408 """
4409 GetSelection(self) -> int
4410
4411 Returns item index for a listbox or choice selection event (not valid
4412 for a deselection).
4413 """
54f9ee45 4414 return _core_.CommandEvent_GetSelection(*args, **kwargs)
e811c8ce
RD
4415
4416 def SetString(*args, **kwargs):
a95a7133 4417 """SetString(self, String s)"""
54f9ee45 4418 return _core_.CommandEvent_SetString(*args, **kwargs)
e811c8ce
RD
4419
4420 def GetString(*args, **kwargs):
27fb7603
RD
4421 """
4422 GetString(self) -> String
4423
4424 Returns item string for a listbox or choice selection event (not valid
4425 for a deselection).
4426 """
54f9ee45 4427 return _core_.CommandEvent_GetString(*args, **kwargs)
e811c8ce
RD
4428
4429 def IsChecked(*args, **kwargs):
27fb7603
RD
4430 """
4431 IsChecked(self) -> bool
4432
4433 This method can be used with checkbox and menu events: for the
4434 checkboxes, the method returns true for a selection event and false
4435 for a deselection one. For the menu events, this method indicates if
4436 the menu item just has become checked or unchecked (and thus only
4437 makes sense for checkable menu items).
4438 """
54f9ee45 4439 return _core_.CommandEvent_IsChecked(*args, **kwargs)
e811c8ce 4440
242b7b46 4441 Checked = IsChecked
e811c8ce 4442 def IsSelection(*args, **kwargs):
27fb7603
RD
4443 """
4444 IsSelection(self) -> bool
4445
4446 For a listbox or similar event, returns true if it is a selection,
4447 false if it is a deselection.
4448 """
54f9ee45 4449 return _core_.CommandEvent_IsSelection(*args, **kwargs)
e811c8ce
RD
4450
4451 def SetExtraLong(*args, **kwargs):
a95a7133 4452 """SetExtraLong(self, long extraLong)"""
54f9ee45 4453 return _core_.CommandEvent_SetExtraLong(*args, **kwargs)
e811c8ce
RD
4454
4455 def GetExtraLong(*args, **kwargs):
27fb7603
RD
4456 """
4457 GetExtraLong(self) -> long
4458
5ba5649b
RD
4459 Returns extra information dependant on the event objects type. If the
4460 event comes from a listbox selection, it is a boolean determining
4461 whether the event was a selection (true) or a deselection (false). A
4462 listbox deselection only occurs for multiple-selection boxes, and in
4463 this case the index and string values are indeterminate and the
4464 listbox must be examined by the application.
27fb7603 4465 """
54f9ee45 4466 return _core_.CommandEvent_GetExtraLong(*args, **kwargs)
e811c8ce
RD
4467
4468 def SetInt(*args, **kwargs):
a95a7133 4469 """SetInt(self, int i)"""
54f9ee45 4470 return _core_.CommandEvent_SetInt(*args, **kwargs)
e811c8ce
RD
4471
4472 def GetInt(*args, **kwargs):
27fb7603 4473 """
01f6b6d3 4474 GetInt(self) -> int
27fb7603 4475
5ba5649b
RD
4476 Returns the integer identifier corresponding to a listbox, choice or
4477 radiobox selection (only if the event was a selection, not a
4478 deselection), or a boolean value representing the value of a checkbox.
27fb7603 4479 """
54f9ee45 4480 return _core_.CommandEvent_GetInt(*args, **kwargs)
e811c8ce 4481
0085ce49
RD
4482 def GetClientData(*args, **kwargs):
4483 """
4484 GetClientData(self) -> PyObject
4485
4486 Returns the client data object for a listbox or choice selection event, (if any.)
4487 """
4488 return _core_.CommandEvent_GetClientData(*args, **kwargs)
4489
4490 def SetClientData(*args, **kwargs):
4491 """
4492 SetClientData(self, PyObject clientData)
4493
4494 Associate the given client data with the item at position n.
4495 """
4496 return _core_.CommandEvent_SetClientData(*args, **kwargs)
4497
4498 GetClientObject = GetClientData
4499 SetClientObject = SetClientData
4500
e811c8ce 4501 def Clone(*args, **kwargs):
a95a7133 4502 """Clone(self) -> Event"""
54f9ee45 4503 return _core_.CommandEvent_Clone(*args, **kwargs)
e811c8ce 4504
2bf58437
RD
4505 ClientData = property(GetClientData,SetClientData,doc="See `GetClientData` and `SetClientData`")
4506 ClientObject = property(GetClientObject,SetClientObject,doc="See `GetClientObject` and `SetClientObject`")
4507 ExtraLong = property(GetExtraLong,SetExtraLong,doc="See `GetExtraLong` and `SetExtraLong`")
4508 Int = property(GetInt,SetInt,doc="See `GetInt` and `SetInt`")
4509 Selection = property(GetSelection,doc="See `GetSelection`")
4510 String = property(GetString,SetString,doc="See `GetString` and `SetString`")
2131d850 4511_core_.CommandEvent_swigregister(CommandEvent)
d14a1e28
RD
4512
4513#---------------------------------------------------------------------------
4514
4515class NotifyEvent(CommandEvent):
27fb7603
RD
4516 """
4517 An instance of this class (or one of its derived classes) is sent from
4518 a control when the control's state is being changed and the control
4519 allows that change to be prevented from happening. The event handler
4520 can call `Veto` or `Allow` to tell the control what to do.
4521 """
0085ce49
RD
4522 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4523 __repr__ = _swig_repr
4524 def __init__(self, *args, **kwargs):
27fb7603 4525 """
2131d850 4526 __init__(self, EventType commandType=wxEVT_NULL, int winid=0) -> NotifyEvent
27fb7603
RD
4527
4528 An instance of this class (or one of its derived classes) is sent from
4529 a control when the control's state is being changed and the control
4530 allows that change to be prevented from happening. The event handler
4531 can call `Veto` or `Allow` to tell the control what to do.
4532 """
0085ce49 4533 _core_.NotifyEvent_swiginit(self,_core_.new_NotifyEvent(*args, **kwargs))
e811c8ce 4534 def Veto(*args, **kwargs):
27fb7603
RD
4535 """
4536 Veto(self)
4537
4538 Prevents the change announced by this event from happening.
4539
4540 It is in general a good idea to notify the user about the reasons for
4541 vetoing the change because otherwise the applications behaviour (which
4542 just refuses to do what the user wants) might be quite surprising.
4543 """
54f9ee45 4544 return _core_.NotifyEvent_Veto(*args, **kwargs)
e811c8ce
RD
4545
4546 def Allow(*args, **kwargs):
27fb7603
RD
4547 """
4548 Allow(self)
4549
4550 This is the opposite of `Veto`: it explicitly allows the event to be
4551 processed. For most events it is not necessary to call this method as
4552 the events are allowed anyhow but some are forbidden by default (this
4553 will be mentioned in the corresponding event description).
4554 """
54f9ee45 4555 return _core_.NotifyEvent_Allow(*args, **kwargs)
e811c8ce
RD
4556
4557 def IsAllowed(*args, **kwargs):
27fb7603
RD
4558 """
4559 IsAllowed(self) -> bool
4560
4561 Returns true if the change is allowed (`Veto` hasn't been called) or
4562 false otherwise (if it was).
4563 """
54f9ee45 4564 return _core_.NotifyEvent_IsAllowed(*args, **kwargs)
e811c8ce 4565
2131d850 4566_core_.NotifyEvent_swigregister(NotifyEvent)
d14a1e28
RD
4567
4568#---------------------------------------------------------------------------
4569
4570class ScrollEvent(CommandEvent):
27fb7603
RD
4571 """
4572 A scroll event holds information about events sent from stand-alone
4573 scrollbars and sliders. Note that scrolled windows do not send
4574 instnaces of this event class, but send the `wx.ScrollWinEvent`
4575 instead.
4576 """
0085ce49
RD
4577 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4578 __repr__ = _swig_repr
4579 def __init__(self, *args, **kwargs):
0df68c9f 4580 """
2131d850 4581 __init__(self, EventType commandType=wxEVT_NULL, int winid=0, int pos=0,
0df68c9f
RD
4582 int orient=0) -> ScrollEvent
4583 """
0085ce49 4584 _core_.ScrollEvent_swiginit(self,_core_.new_ScrollEvent(*args, **kwargs))
e811c8ce 4585 def GetOrientation(*args, **kwargs):
27fb7603
RD
4586 """
4587 GetOrientation(self) -> int
4588
4589 Returns wx.HORIZONTAL or wx.VERTICAL, depending on the orientation of
4590 the scrollbar.
4591 """
54f9ee45 4592 return _core_.ScrollEvent_GetOrientation(*args, **kwargs)
e811c8ce
RD
4593
4594 def GetPosition(*args, **kwargs):
27fb7603
RD
4595 """
4596 GetPosition(self) -> int
4597
4598 Returns the position of the scrollbar.
4599 """
54f9ee45 4600 return _core_.ScrollEvent_GetPosition(*args, **kwargs)
e811c8ce
RD
4601
4602 def SetOrientation(*args, **kwargs):
a95a7133 4603 """SetOrientation(self, int orient)"""
54f9ee45 4604 return _core_.ScrollEvent_SetOrientation(*args, **kwargs)
e811c8ce
RD
4605
4606 def SetPosition(*args, **kwargs):
a95a7133 4607 """SetPosition(self, int pos)"""
54f9ee45 4608 return _core_.ScrollEvent_SetPosition(*args, **kwargs)
e811c8ce 4609
33d6fd3b
RD
4610 Orientation = property(GetOrientation,SetOrientation,doc="See `GetOrientation` and `SetOrientation`")
4611 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
2131d850 4612_core_.ScrollEvent_swigregister(ScrollEvent)
d14a1e28
RD
4613
4614#---------------------------------------------------------------------------
4615
4616class ScrollWinEvent(Event):
27fb7603
RD
4617 """
4618 A wx.ScrollWinEvent holds information about scrolling and is sent from
4619 scrolling windows.
4620 """
0085ce49
RD
4621 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4622 __repr__ = _swig_repr
4623 def __init__(self, *args, **kwargs):
27fb7603 4624 """
2131d850 4625 __init__(self, EventType commandType=wxEVT_NULL, int pos=0, int orient=0) -> ScrollWinEvent
27fb7603
RD
4626
4627 A wx.ScrollWinEvent holds information about scrolling and is sent from
4628 scrolling windows.
4629 """
0085ce49 4630 _core_.ScrollWinEvent_swiginit(self,_core_.new_ScrollWinEvent(*args, **kwargs))
e811c8ce 4631 def GetOrientation(*args, **kwargs):
27fb7603
RD
4632 """
4633 GetOrientation(self) -> int
4634
4635 Returns wx.HORIZONTAL or wx.VERTICAL, depending on the orientation of
4636 the scrollbar.
4637 """
54f9ee45 4638 return _core_.ScrollWinEvent_GetOrientation(*args, **kwargs)
e811c8ce
RD
4639
4640 def GetPosition(*args, **kwargs):
27fb7603
RD
4641 """
4642 GetPosition(self) -> int
4643
4644 Returns the position of the scrollbar for the thumb track and release
4645 events. Note that this field can't be used for the other events, you
4646 need to query the window itself for the current position in that case.
4647 """
54f9ee45 4648 return _core_.ScrollWinEvent_GetPosition(*args, **kwargs)
e811c8ce
RD
4649
4650 def SetOrientation(*args, **kwargs):
a95a7133 4651 """SetOrientation(self, int orient)"""
54f9ee45 4652 return _core_.ScrollWinEvent_SetOrientation(*args, **kwargs)
e811c8ce
RD
4653
4654 def SetPosition(*args, **kwargs):
a95a7133 4655 """SetPosition(self, int pos)"""
54f9ee45 4656 return _core_.ScrollWinEvent_SetPosition(*args, **kwargs)
e811c8ce 4657
33d6fd3b
RD
4658 Orientation = property(GetOrientation,SetOrientation,doc="See `GetOrientation` and `SetOrientation`")
4659 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
2131d850 4660_core_.ScrollWinEvent_swigregister(ScrollWinEvent)
d14a1e28
RD
4661
4662#---------------------------------------------------------------------------
4663
54f9ee45
RD
4664MOUSE_BTN_ANY = _core_.MOUSE_BTN_ANY
4665MOUSE_BTN_NONE = _core_.MOUSE_BTN_NONE
4666MOUSE_BTN_LEFT = _core_.MOUSE_BTN_LEFT
4667MOUSE_BTN_MIDDLE = _core_.MOUSE_BTN_MIDDLE
4668MOUSE_BTN_RIGHT = _core_.MOUSE_BTN_RIGHT
d14a1e28 4669class MouseEvent(Event):
27fb7603
RD
4670 """
4671 This event class contains information about the events generated by
4672 the mouse: they include mouse buttons press and release events and
4673 mouse move events.
4674
4675 All mouse events involving the buttons use ``wx.MOUSE_BTN_LEFT`` for
4676 the left mouse button, ``wx.MOUSE_BTN_MIDDLE`` for the middle one and
4677 ``wx.MOUSE_BTN_RIGHT`` for the right one. Note that not all mice have
4678 a middle button so a portable application should avoid relying on the
4679 events from it.
4680
4681 Note the difference between methods like `LeftDown` and `LeftIsDown`:
4682 the former returns true when the event corresponds to the left mouse
4683 button click while the latter returns true if the left mouse button is
4684 currently being pressed. For example, when the user is dragging the
4685 mouse you can use `LeftIsDown` to test whether the left mouse button
4686 is (still) depressed. Also, by convention, if `LeftDown` returns true,
4687 `LeftIsDown` will also return true in wxWidgets whatever the
4688 underlying GUI behaviour is (which is platform-dependent). The same
4689 applies, of course, to other mouse buttons as well.
4690 """
0085ce49
RD
4691 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4692 __repr__ = _swig_repr
4693 def __init__(self, *args, **kwargs):
27fb7603 4694 """
2131d850 4695 __init__(self, EventType mouseType=wxEVT_NULL) -> MouseEvent
27fb7603
RD
4696
4697 Constructs a wx.MouseEvent. Valid event types are:
4698
4699 * wxEVT_ENTER_WINDOW
4700 * wxEVT_LEAVE_WINDOW
4701 * wxEVT_LEFT_DOWN
4702 * wxEVT_LEFT_UP
4703 * wxEVT_LEFT_DCLICK
4704 * wxEVT_MIDDLE_DOWN
4705 * wxEVT_MIDDLE_UP
4706 * wxEVT_MIDDLE_DCLICK
4707 * wxEVT_RIGHT_DOWN
4708 * wxEVT_RIGHT_UP
4709 * wxEVT_RIGHT_DCLICK
4710 * wxEVT_MOTION
4711 * wxEVT_MOUSEWHEEL
4712 """
0085ce49 4713 _core_.MouseEvent_swiginit(self,_core_.new_MouseEvent(*args, **kwargs))
e811c8ce 4714 def IsButton(*args, **kwargs):
27fb7603
RD
4715 """
4716 IsButton(self) -> bool
4717
4718 Returns true if the event was a mouse button event (not necessarily a
4719 button down event - that may be tested using `ButtonDown`).
4720 """
54f9ee45 4721 return _core_.MouseEvent_IsButton(*args, **kwargs)
e811c8ce
RD
4722
4723 def ButtonDown(*args, **kwargs):
27fb7603
RD
4724 """
4725 ButtonDown(self, int but=MOUSE_BTN_ANY) -> bool
4726
5ba5649b
RD
4727 If the argument is omitted, this returns true if the event was any
4728 mouse button down event. Otherwise the argument specifies which
4729 button-down event shold be checked for (see `Button` for the possible
4730 values).
27fb7603 4731 """
54f9ee45 4732 return _core_.MouseEvent_ButtonDown(*args, **kwargs)
e811c8ce
RD
4733
4734 def ButtonDClick(*args, **kwargs):
27fb7603
RD
4735 """
4736 ButtonDClick(self, int but=MOUSE_BTN_ANY) -> bool
4737
4738 If the argument is omitted, this returns true if the event was any
4739 mouse double click event. Otherwise the argument specifies which
4740 double click event to check for (see `Button` for the possible
4741 values).
4742 """
54f9ee45 4743 return _core_.MouseEvent_ButtonDClick(*args, **kwargs)
e811c8ce
RD
4744
4745 def ButtonUp(*args, **kwargs):
27fb7603
RD
4746 """
4747 ButtonUp(self, int but=MOUSE_BTN_ANY) -> bool
4748
4749 If the argument is omitted, this returns true if the event was any
5ba5649b
RD
4750 mouse button up event. Otherwise the argument specifies which button
4751 up event to check for (see `Button` for the possible values).
27fb7603 4752 """
54f9ee45 4753 return _core_.MouseEvent_ButtonUp(*args, **kwargs)
e811c8ce
RD
4754
4755 def Button(*args, **kwargs):
27fb7603
RD
4756 """
4757 Button(self, int button) -> bool
4758
4759 Returns true if the identified mouse button is changing state. Valid
4760 values of button are:
4761
4762 ==================== =====================================
4763 wx.MOUSE_BTN_LEFT check if left button was pressed
4764 wx.MOUSE_BTN_MIDDLE check if middle button was pressed
4765 wx.MOUSE_BTN_RIGHT check if right button was pressed
4766 wx.MOUSE_BTN_ANY check if any button was pressed
4767 ==================== =====================================
4768
4769 """
54f9ee45 4770 return _core_.MouseEvent_Button(*args, **kwargs)
e811c8ce
RD
4771
4772 def ButtonIsDown(*args, **kwargs):
a95a7133 4773 """ButtonIsDown(self, int but) -> bool"""
54f9ee45 4774 return _core_.MouseEvent_ButtonIsDown(*args, **kwargs)
e811c8ce
RD
4775
4776 def GetButton(*args, **kwargs):
27fb7603
RD
4777 """
4778 GetButton(self) -> int
4779
4780 Returns the mouse button which generated this event or
4781 wx.MOUSE_BTN_NONE if no button is involved (for mouse move, enter or
4782 leave event, for example). Otherwise wx.MOUSE_BTN_LEFT is returned for
4783 the left button down, up and double click events, wx.MOUSE_BTN_MIDDLE
4784 and wx.MOUSE_BTN_RIGHT for the same events for the middle and the
4785 right buttons respectively.
4786 """
54f9ee45 4787 return _core_.MouseEvent_GetButton(*args, **kwargs)
e811c8ce
RD
4788
4789 def ControlDown(*args, **kwargs):
27fb7603
RD
4790 """
4791 ControlDown(self) -> bool
4792
4793 Returns true if the control key was down at the time of the event.
4794 """
54f9ee45 4795 return _core_.MouseEvent_ControlDown(*args, **kwargs)
e811c8ce
RD
4796
4797 def MetaDown(*args, **kwargs):
27fb7603
RD
4798 """
4799 MetaDown(self) -> bool
4800
4801 Returns true if the Meta key was down at the time of the event.
4802 """
54f9ee45 4803 return _core_.MouseEvent_MetaDown(*args, **kwargs)
e811c8ce
RD
4804
4805 def AltDown(*args, **kwargs):
27fb7603
RD
4806 """
4807 AltDown(self) -> bool
4808
4809 Returns true if the Alt key was down at the time of the event.
4810 """
54f9ee45 4811 return _core_.MouseEvent_AltDown(*args, **kwargs)
e811c8ce
RD
4812
4813 def ShiftDown(*args, **kwargs):
27fb7603
RD
4814 """
4815 ShiftDown(self) -> bool
4816
4817 Returns true if the Shift key was down at the time of the event.
4818 """
54f9ee45 4819 return _core_.MouseEvent_ShiftDown(*args, **kwargs)
e811c8ce 4820
412d302d
RD
4821 def CmdDown(*args, **kwargs):
4822 """
4823 CmdDown(self) -> bool
4824
4825 "Cmd" is a pseudo key which is the same as Control for PC and Unix
4826 platforms but the special "Apple" (a.k.a as "Command") key on
5ba5649b 4827 Macs. It often makes sense to use it instead of, say, `ControlDown`
412d302d 4828 because Cmd key is used for the same thing under Mac as Ctrl
27fb7603 4829 elsewhere. The Ctrl key still exists, it's just not used for this
412d302d
RD
4830 purpose. So for non-Mac platforms this is the same as `ControlDown`
4831 and Macs this is the same as `MetaDown`.
4832 """
4833 return _core_.MouseEvent_CmdDown(*args, **kwargs)
4834
e811c8ce 4835 def LeftDown(*args, **kwargs):
27fb7603
RD
4836 """
4837 LeftDown(self) -> bool
4838
4839 Returns true if the left mouse button state changed to down.
4840 """
54f9ee45 4841 return _core_.MouseEvent_LeftDown(*args, **kwargs)
e811c8ce
RD
4842
4843 def MiddleDown(*args, **kwargs):
27fb7603
RD
4844 """
4845 MiddleDown(self) -> bool
4846
4847 Returns true if the middle mouse button state changed to down.
4848 """
54f9ee45 4849 return _core_.MouseEvent_MiddleDown(*args, **kwargs)
e811c8ce
RD
4850
4851 def RightDown(*args, **kwargs):
27fb7603
RD
4852 """
4853 RightDown(self) -> bool
4854
4855 Returns true if the right mouse button state changed to down.
4856 """
54f9ee45 4857 return _core_.MouseEvent_RightDown(*args, **kwargs)
e811c8ce
RD
4858
4859 def LeftUp(*args, **kwargs):
27fb7603
RD
4860 """
4861 LeftUp(self) -> bool
4862
4863 Returns true if the left mouse button state changed to up.
4864 """
54f9ee45 4865 return _core_.MouseEvent_LeftUp(*args, **kwargs)
e811c8ce
RD
4866
4867 def MiddleUp(*args, **kwargs):
27fb7603
RD
4868 """
4869 MiddleUp(self) -> bool
4870
4871 Returns true if the middle mouse button state changed to up.
4872 """
54f9ee45 4873 return _core_.MouseEvent_MiddleUp(*args, **kwargs)
e811c8ce
RD
4874
4875 def RightUp(*args, **kwargs):
27fb7603
RD
4876 """
4877 RightUp(self) -> bool
4878
4879 Returns true if the right mouse button state changed to up.
4880 """
54f9ee45 4881 return _core_.MouseEvent_RightUp(*args, **kwargs)
e811c8ce
RD
4882
4883 def LeftDClick(*args, **kwargs):
27fb7603
RD
4884 """
4885 LeftDClick(self) -> bool
4886
4887 Returns true if the event was a left button double click.
4888 """
54f9ee45 4889 return _core_.MouseEvent_LeftDClick(*args, **kwargs)
e811c8ce
RD
4890
4891 def MiddleDClick(*args, **kwargs):
27fb7603
RD
4892 """
4893 MiddleDClick(self) -> bool
4894
4895 Returns true if the event was a middle button double click.
4896 """
54f9ee45 4897 return _core_.MouseEvent_MiddleDClick(*args, **kwargs)
e811c8ce
RD
4898
4899 def RightDClick(*args, **kwargs):
27fb7603
RD
4900 """
4901 RightDClick(self) -> bool
4902
4903 Returns true if the event was a right button double click.
4904 """
54f9ee45 4905 return _core_.MouseEvent_RightDClick(*args, **kwargs)
e811c8ce
RD
4906
4907 def LeftIsDown(*args, **kwargs):
27fb7603
RD
4908 """
4909 LeftIsDown(self) -> bool
4910
4911 Returns true if the left mouse button is currently down, independent
4912 of the current event type.
4913
4914 Please notice that it is not the same as LeftDown which returns true
4915 if the left mouse button was just pressed. Rather, it describes the
4916 state of the mouse button before the event happened.
4917
4918 This event is usually used in the mouse event handlers which process
4919 "move mouse" messages to determine whether the user is (still)
4920 dragging the mouse.
4921 """
54f9ee45 4922 return _core_.MouseEvent_LeftIsDown(*args, **kwargs)
e811c8ce
RD
4923
4924 def MiddleIsDown(*args, **kwargs):
27fb7603
RD
4925 """
4926 MiddleIsDown(self) -> bool
4927
4928 Returns true if the middle mouse button is currently down, independent
4929 of the current event type.
4930 """
54f9ee45 4931 return _core_.MouseEvent_MiddleIsDown(*args, **kwargs)
e811c8ce
RD
4932
4933 def RightIsDown(*args, **kwargs):
27fb7603
RD
4934 """
4935 RightIsDown(self) -> bool
4936
4937 Returns true if the right mouse button is currently down, independent
4938 of the current event type.
4939 """
54f9ee45 4940 return _core_.MouseEvent_RightIsDown(*args, **kwargs)
e811c8ce
RD
4941
4942 def Dragging(*args, **kwargs):
27fb7603
RD
4943 """
4944 Dragging(self) -> bool
4945
4946 Returns true if this was a dragging event (motion while a button is
4947 depressed).
4948 """
54f9ee45 4949 return _core_.MouseEvent_Dragging(*args, **kwargs)
e811c8ce
RD
4950
4951 def Moving(*args, **kwargs):
27fb7603
RD
4952 """
4953 Moving(self) -> bool
4954
4955 Returns true if this was a motion event and no mouse buttons were
4956 pressed. If any mouse button is held pressed, then this method returns
4957 false and Dragging returns true.
4958 """
54f9ee45 4959 return _core_.MouseEvent_Moving(*args, **kwargs)
e811c8ce
RD
4960
4961 def Entering(*args, **kwargs):
27fb7603
RD
4962 """
4963 Entering(self) -> bool
4964
4965 Returns true if the mouse was entering the window.
4966 """
54f9ee45 4967 return _core_.MouseEvent_Entering(*args, **kwargs)
e811c8ce
RD
4968
4969 def Leaving(*args, **kwargs):
27fb7603
RD
4970 """
4971 Leaving(self) -> bool
4972
4973 Returns true if the mouse was leaving the window.
4974 """
54f9ee45 4975 return _core_.MouseEvent_Leaving(*args, **kwargs)
e811c8ce
RD
4976
4977 def GetPosition(*args, **kwargs):
0df68c9f 4978 """
a95a7133 4979 GetPosition(self) -> Point
e811c8ce 4980
27fb7603
RD
4981 Returns the pixel position of the mouse in window coordinates when the
4982 event happened.
0df68c9f 4983 """
54f9ee45 4984 return _core_.MouseEvent_GetPosition(*args, **kwargs)
e811c8ce
RD
4985
4986 def GetPositionTuple(*args, **kwargs):
0df68c9f
RD
4987 """
4988 GetPositionTuple() -> (x,y)
e811c8ce 4989
27fb7603
RD
4990 Returns the pixel position of the mouse in window coordinates when the
4991 event happened.
0df68c9f 4992 """
54f9ee45 4993 return _core_.MouseEvent_GetPositionTuple(*args, **kwargs)
e811c8ce
RD
4994
4995 def GetLogicalPosition(*args, **kwargs):
27fb7603
RD
4996 """
4997 GetLogicalPosition(self, DC dc) -> Point
4998
4999 Returns the logical mouse position in pixels (i.e. translated
5000 according to the translation set for the DC, which usually indicates
5001 that the window has been scrolled).
5002 """
54f9ee45 5003 return _core_.MouseEvent_GetLogicalPosition(*args, **kwargs)
e811c8ce
RD
5004
5005 def GetX(*args, **kwargs):
27fb7603
RD
5006 """
5007 GetX(self) -> int
5008
5009 Returns X coordinate of the physical mouse event position.
5010 """
54f9ee45 5011 return _core_.MouseEvent_GetX(*args, **kwargs)
e811c8ce
RD
5012
5013 def GetY(*args, **kwargs):
27fb7603
RD
5014 """
5015 GetY(self) -> int
5016
5017 Returns Y coordinate of the physical mouse event position.
5018 """
54f9ee45 5019 return _core_.MouseEvent_GetY(*args, **kwargs)
e811c8ce
RD
5020
5021 def GetWheelRotation(*args, **kwargs):
27fb7603
RD
5022 """
5023 GetWheelRotation(self) -> int
5024
5025 Get wheel rotation, positive or negative indicates direction of
5026 rotation. Current devices all send an event when rotation is equal to
5027 +/-WheelDelta, but this allows for finer resolution devices to be
5028 created in the future. Because of this you shouldn't assume that one
5029 event is equal to 1 line or whatever, but you should be able to either
5030 do partial line scrolling or wait until +/-WheelDelta rotation values
5031 have been accumulated before scrolling.
5032 """
54f9ee45 5033 return _core_.MouseEvent_GetWheelRotation(*args, **kwargs)
e811c8ce
RD
5034
5035 def GetWheelDelta(*args, **kwargs):
27fb7603
RD
5036 """
5037 GetWheelDelta(self) -> int
5038
5039 Get wheel delta, normally 120. This is the threshold for action to be
5040 taken, and one such action (for example, scrolling one increment)
5041 should occur for each delta.
5042 """
54f9ee45 5043 return _core_.MouseEvent_GetWheelDelta(*args, **kwargs)
e811c8ce
RD
5044
5045 def GetLinesPerAction(*args, **kwargs):
27fb7603
RD
5046 """
5047 GetLinesPerAction(self) -> int
5048
5049 Returns the configured number of lines (or whatever) to be scrolled
5050 per wheel action. Defaults to three.
5051 """
54f9ee45 5052 return _core_.MouseEvent_GetLinesPerAction(*args, **kwargs)
e811c8ce
RD
5053
5054 def IsPageScroll(*args, **kwargs):
27fb7603
RD
5055 """
5056 IsPageScroll(self) -> bool
5057
5058 Returns true if the system has been setup to do page scrolling with
5059 the mouse wheel instead of line scrolling.
5060 """
54f9ee45
RD
5061 return _core_.MouseEvent_IsPageScroll(*args, **kwargs)
5062
5063 m_x = property(_core_.MouseEvent_m_x_get, _core_.MouseEvent_m_x_set)
5064 m_y = property(_core_.MouseEvent_m_y_get, _core_.MouseEvent_m_y_set)
5065 m_leftDown = property(_core_.MouseEvent_m_leftDown_get, _core_.MouseEvent_m_leftDown_set)
5066 m_middleDown = property(_core_.MouseEvent_m_middleDown_get, _core_.MouseEvent_m_middleDown_set)
5067 m_rightDown = property(_core_.MouseEvent_m_rightDown_get, _core_.MouseEvent_m_rightDown_set)
5068 m_controlDown = property(_core_.MouseEvent_m_controlDown_get, _core_.MouseEvent_m_controlDown_set)
5069 m_shiftDown = property(_core_.MouseEvent_m_shiftDown_get, _core_.MouseEvent_m_shiftDown_set)
5070 m_altDown = property(_core_.MouseEvent_m_altDown_get, _core_.MouseEvent_m_altDown_set)
5071 m_metaDown = property(_core_.MouseEvent_m_metaDown_get, _core_.MouseEvent_m_metaDown_set)
5072 m_wheelRotation = property(_core_.MouseEvent_m_wheelRotation_get, _core_.MouseEvent_m_wheelRotation_set)
5073 m_wheelDelta = property(_core_.MouseEvent_m_wheelDelta_get, _core_.MouseEvent_m_wheelDelta_set)
5074 m_linesPerAction = property(_core_.MouseEvent_m_linesPerAction_get, _core_.MouseEvent_m_linesPerAction_set)
57332a5a
RD
5075 Button = property(GetButton,doc="See `GetButton`")
5076 LinesPerAction = property(GetLinesPerAction,doc="See `GetLinesPerAction`")
5077 LogicalPosition = property(GetLogicalPosition,doc="See `GetLogicalPosition`")
5078 Position = property(GetPosition,doc="See `GetPosition`")
5079 WheelDelta = property(GetWheelDelta,doc="See `GetWheelDelta`")
5080 WheelRotation = property(GetWheelRotation,doc="See `GetWheelRotation`")
5081 X = property(GetX,doc="See `GetX`")
5082 Y = property(GetY,doc="See `GetY`")
2131d850 5083_core_.MouseEvent_swigregister(MouseEvent)
d14a1e28
RD
5084
5085#---------------------------------------------------------------------------
5086
5087class SetCursorEvent(Event):
5ba5649b
RD
5088 """
5089 A SetCursorEvent is generated when the mouse cursor is about to be set
5090 as a result of mouse motion. This event gives the application the
5091 chance to perform specific mouse cursor processing based on the
5092 current position of the mouse within the window. Use the `SetCursor`
5093 method to specify the cursor you want to be displayed.
5094 """
0085ce49
RD
5095 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5096 __repr__ = _swig_repr
5097 def __init__(self, *args, **kwargs):
5ba5649b
RD
5098 """
5099 __init__(self, int x=0, int y=0) -> SetCursorEvent
5100
5101 Construct a new `wx.SetCursorEvent`.
5102 """
0085ce49 5103 _core_.SetCursorEvent_swiginit(self,_core_.new_SetCursorEvent(*args, **kwargs))
e811c8ce 5104 def GetX(*args, **kwargs):
5ba5649b
RD
5105 """
5106 GetX(self) -> int
5107
5108 Returns the X coordinate of the mouse in client coordinates.
5109 """
54f9ee45 5110 return _core_.SetCursorEvent_GetX(*args, **kwargs)
e811c8ce
RD
5111
5112 def GetY(*args, **kwargs):
5ba5649b
RD
5113 """
5114 GetY(self) -> int
5115
5116 Returns the Y coordinate of the mouse in client coordinates.
5117 """
54f9ee45 5118 return _core_.SetCursorEvent_GetY(*args, **kwargs)
e811c8ce
RD
5119
5120 def SetCursor(*args, **kwargs):
5ba5649b
RD
5121 """
5122 SetCursor(self, Cursor cursor)
5123
5124 Sets the cursor associated with this event.
5125 """
54f9ee45 5126 return _core_.SetCursorEvent_SetCursor(*args, **kwargs)
e811c8ce
RD
5127
5128 def GetCursor(*args, **kwargs):
5ba5649b
RD
5129 """
5130 GetCursor(self) -> Cursor
5131
5132 Returns a reference to the cursor specified by this event.
5133 """
54f9ee45 5134 return _core_.SetCursorEvent_GetCursor(*args, **kwargs)
e811c8ce
RD
5135
5136 def HasCursor(*args, **kwargs):
5ba5649b
RD
5137 """
5138 HasCursor(self) -> bool
5139
5140 Returns true if the cursor specified by this event is a valid cursor.
5141 """
54f9ee45 5142 return _core_.SetCursorEvent_HasCursor(*args, **kwargs)
e811c8ce 5143
33d6fd3b
RD
5144 Cursor = property(GetCursor,SetCursor,doc="See `GetCursor` and `SetCursor`")
5145 X = property(GetX,doc="See `GetX`")
5146 Y = property(GetY,doc="See `GetY`")
2131d850 5147_core_.SetCursorEvent_swigregister(SetCursorEvent)
d14a1e28
RD
5148
5149#---------------------------------------------------------------------------
5150
5151class KeyEvent(Event):
5ba5649b
RD
5152 """
5153 This event class contains information about keypress and character
5154 events. These events are only sent to the widget that currently has
5155 the keyboard focus.
5156
5157 Notice that there are three different kinds of keyboard events in
5158 wxWidgets: key down and up events and char events. The difference
5159 between the first two is clear - the first corresponds to a key press
5160 and the second to a key release - otherwise they are identical. Just
5161 note that if the key is maintained in a pressed state you will
5162 typically get a lot of (automatically generated) down events but only
5163 one up so it is wrong to assume that there is one up event
5164 corresponding to each down one.
5165
5166 Both key events provide untranslated key codes while the char event
5167 carries the translated one. The untranslated code for alphanumeric
5168 keys is always an upper case value. For the other keys it is one of
5169 WXK_XXX values from the keycodes table. The translated key is, in
5170 general, the character the user expects to appear as the result of the
5171 key combination when typing the text into a text entry zone, for
5172 example.
5173
5174 A few examples to clarify this (all assume that CAPS LOCK is unpressed
5175 and the standard US keyboard): when the 'A' key is pressed, the key
5176 down event key code is equal to ASCII A == 65. But the char event key
5177 code is ASCII a == 97. On the other hand, if you press both SHIFT and
5178 'A' keys simultaneously , the key code in key down event will still be
5179 just 'A' while the char event key code parameter will now be 'A' as
5180 well.
5181
5182 Although in this simple case it is clear that the correct key code
5183 could be found in the key down event handler by checking the value
5184 returned by `ShiftDown`, in general you should use EVT_CHAR for this
5185 as for non alphanumeric keys or non-US keyboard layouts the
5186 translation is keyboard-layout dependent and can only be done properly
5187 by the system itself.
5188
5189 Another kind of translation is done when the control key is pressed:
5190 for example, for CTRL-A key press the key down event still carries the
5191 same key code 'A' as usual but the char event will have key code of 1,
5192 the ASCII value of this key combination.
5193
5194 You may discover how the other keys on your system behave
5195 interactively by running the KeyEvents sample in the wxPython demo and
5196 pressing some keys while the blue box at the top has the keyboard
5197 focus.
5198
5199 **Note**: If a key down event is caught and the event handler does not
5200 call event.Skip() then the coresponding char event will not
5201 happen. This is by design and enables the programs that handle both
5202 types of events to be a bit simpler.
5203
5204 **Note for Windows programmers**: The key and char events in wxWidgets
5205 are similar to but slightly different from Windows WM_KEYDOWN and
5206 WM_CHAR events. In particular, Alt-x combination will generate a char
5207 event in wxWidgets (unless it is used as an accelerator).
5208
5209 **Tip**: be sure to call event.Skip() for events that you don't
5210 process in key event function, otherwise menu shortcuts may cease to
5211 work under Windows.
5212
5213 """
0085ce49
RD
5214 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5215 __repr__ = _swig_repr
5216 def __init__(self, *args, **kwargs):
5ba5649b 5217 """
2131d850 5218 __init__(self, EventType eventType=wxEVT_NULL) -> KeyEvent
5ba5649b
RD
5219
5220 Construct a new `wx.KeyEvent`. Valid event types are:
5221 *
5222 """
0085ce49 5223 _core_.KeyEvent_swiginit(self,_core_.new_KeyEvent(*args, **kwargs))
b1fcee84
RD
5224 def GetModifiers(*args, **kwargs):
5225 """
5226 GetModifiers(self) -> int
5227
5228 Returns a bitmask of the current modifier settings. Can be used to
5229 check if the key event has exactly the given modifiers without having
5230 to explicitly check that the other modifiers are not down. For
5231 example::
5232
5233 if event.GetModifers() == wx.MOD_CONTROL:
5234 DoSomething()
5235
5236 """
5237 return _core_.KeyEvent_GetModifiers(*args, **kwargs)
5238
e811c8ce 5239 def ControlDown(*args, **kwargs):
5ba5649b
RD
5240 """
5241 ControlDown(self) -> bool
5242
5243 Returns ``True`` if the Control key was down at the time of the event.
5244 """
54f9ee45 5245 return _core_.KeyEvent_ControlDown(*args, **kwargs)
e811c8ce
RD
5246
5247 def MetaDown(*args, **kwargs):
5ba5649b
RD
5248 """
5249 MetaDown(self) -> bool
5250
5251 Returns ``True`` if the Meta key was down at the time of the event.
5252 """
54f9ee45 5253 return _core_.KeyEvent_MetaDown(*args, **kwargs)
e811c8ce
RD
5254
5255 def AltDown(*args, **kwargs):
5ba5649b
RD
5256 """
5257 AltDown(self) -> bool
5258
5259 Returns ``True`` if the Alt key was down at the time of the event.
5260 """
54f9ee45 5261 return _core_.KeyEvent_AltDown(*args, **kwargs)
e811c8ce
RD
5262
5263 def ShiftDown(*args, **kwargs):
5ba5649b
RD
5264 """
5265 ShiftDown(self) -> bool
5266
5267 Returns ``True`` if the Shift key was down at the time of the event.
5268 """
54f9ee45 5269 return _core_.KeyEvent_ShiftDown(*args, **kwargs)
e811c8ce 5270
412d302d
RD
5271 def CmdDown(*args, **kwargs):
5272 """
5273 CmdDown(self) -> bool
5274
5275 "Cmd" is a pseudo key which is the same as Control for PC and Unix
5276 platforms but the special "Apple" (a.k.a as "Command") key on
5ba5649b 5277 Macs. It makes often sense to use it instead of, say, `ControlDown`
412d302d
RD
5278 because Cmd key is used for the same thing under Mac as Ctrl
5279 elsewhere. The Ctrl still exists, it's just not used for this
5280 purpose. So for non-Mac platforms this is the same as `ControlDown`
5281 and Macs this is the same as `MetaDown`.
5282 """
5283 return _core_.KeyEvent_CmdDown(*args, **kwargs)
5284
e811c8ce 5285 def HasModifiers(*args, **kwargs):
5ba5649b
RD
5286 """
5287 HasModifiers(self) -> bool
5288
5289 Returns true if either CTRL or ALT keys was down at the time of the
5290 key event. Note that this function does not take into account neither
5291 SHIFT nor META key states (the reason for ignoring the latter is that
5292 it is common for NUMLOCK key to be configured as META under X but the
5293 key presses even while NUMLOCK is on should be still processed
5294 normally).
5295 """
54f9ee45 5296 return _core_.KeyEvent_HasModifiers(*args, **kwargs)
e811c8ce
RD
5297
5298 def GetKeyCode(*args, **kwargs):
5ba5649b
RD
5299 """
5300 GetKeyCode(self) -> int
5301
5302 Returns the virtual key code. ASCII events return normal ASCII values,
5303 while non-ASCII events return values such as WXK_LEFT for the left
5304 cursor key. See `wx.KeyEvent` for a full list of the virtual key
5305 codes.
5306
5307 Note that in Unicode build, the returned value is meaningful only if
5308 the user entered a character that can be represented in current
5309 locale's default charset. You can obtain the corresponding Unicode
5310 character using `GetUnicodeKey`.
5311 """
54f9ee45 5312 return _core_.KeyEvent_GetKeyCode(*args, **kwargs)
e811c8ce 5313
19272049 5314 def GetUnicodeKey(*args, **kwargs):
5ba5649b
RD
5315 """
5316 GetUnicodeKey(self) -> int
5317
5318 Returns the Unicode character corresponding to this key event. This
5319 function is only meaningfule in a Unicode build of wxPython.
5320 """
19272049 5321 return _core_.KeyEvent_GetUnicodeKey(*args, **kwargs)
e811c8ce 5322
19272049 5323 GetUniChar = GetUnicodeKey
b850e7f3
RD
5324 def SetUnicodeKey(*args, **kwargs):
5325 """
5326 SetUnicodeKey(self, int uniChar)
5327
5328 Set the Unicode value of the key event, but only if this is a Unicode
5329 build of wxPython.
5330 """
5331 return _core_.KeyEvent_SetUnicodeKey(*args, **kwargs)
5332
e811c8ce 5333 def GetRawKeyCode(*args, **kwargs):
5ba5649b
RD
5334 """
5335 GetRawKeyCode(self) -> unsigned int
5336
5337 Returns the raw key code for this event. This is a platform-dependent
5338 scan code which should only be used in advanced
5339 applications. Currently the raw key codes are not supported by all
5340 ports.
5341 """
54f9ee45 5342 return _core_.KeyEvent_GetRawKeyCode(*args, **kwargs)
e811c8ce
RD
5343
5344 def GetRawKeyFlags(*args, **kwargs):
5ba5649b
RD
5345 """
5346 GetRawKeyFlags(self) -> unsigned int
5347
5348 Returns the low level key flags for this event. The flags are
5349 platform-dependent and should only be used in advanced applications.
5350 Currently the raw key flags are not supported by all ports.
5351 """
54f9ee45 5352 return _core_.KeyEvent_GetRawKeyFlags(*args, **kwargs)
e811c8ce
RD
5353
5354 def GetPosition(*args, **kwargs):
0df68c9f 5355 """
a95a7133 5356 GetPosition(self) -> Point
e811c8ce 5357
5ba5649b 5358 Find the position of the event, if applicable.
0df68c9f 5359 """
54f9ee45 5360 return _core_.KeyEvent_GetPosition(*args, **kwargs)
e811c8ce
RD
5361
5362 def GetPositionTuple(*args, **kwargs):
0df68c9f
RD
5363 """
5364 GetPositionTuple() -> (x,y)
e811c8ce 5365
5ba5649b 5366 Find the position of the event, if applicable.
0df68c9f 5367 """
54f9ee45 5368 return _core_.KeyEvent_GetPositionTuple(*args, **kwargs)
e811c8ce
RD
5369
5370 def GetX(*args, **kwargs):
5ba5649b
RD
5371 """
5372 GetX(self) -> int
5373
5374 Returns the X position (in client coordinates) of the event, if
5375 applicable.
5376 """
54f9ee45 5377 return _core_.KeyEvent_GetX(*args, **kwargs)
e811c8ce
RD
5378
5379 def GetY(*args, **kwargs):
5ba5649b
RD
5380 """
5381 GetY(self) -> int
5382
5383 Returns the Y position (in client coordinates) of the event, if
5384 applicable.
5385 """
54f9ee45
RD
5386 return _core_.KeyEvent_GetY(*args, **kwargs)
5387
5388 m_x = property(_core_.KeyEvent_m_x_get, _core_.KeyEvent_m_x_set)
5389 m_y = property(_core_.KeyEvent_m_y_get, _core_.KeyEvent_m_y_set)
5390 m_keyCode = property(_core_.KeyEvent_m_keyCode_get, _core_.KeyEvent_m_keyCode_set)
5391 m_controlDown = property(_core_.KeyEvent_m_controlDown_get, _core_.KeyEvent_m_controlDown_set)
5392 m_shiftDown = property(_core_.KeyEvent_m_shiftDown_get, _core_.KeyEvent_m_shiftDown_set)
5393 m_altDown = property(_core_.KeyEvent_m_altDown_get, _core_.KeyEvent_m_altDown_set)
5394 m_metaDown = property(_core_.KeyEvent_m_metaDown_get, _core_.KeyEvent_m_metaDown_set)
5395 m_scanCode = property(_core_.KeyEvent_m_scanCode_get, _core_.KeyEvent_m_scanCode_set)
5396 m_rawCode = property(_core_.KeyEvent_m_rawCode_get, _core_.KeyEvent_m_rawCode_set)
5397 m_rawFlags = property(_core_.KeyEvent_m_rawFlags_get, _core_.KeyEvent_m_rawFlags_set)
97ab0f6a
RD
5398 KeyCode = property(GetKeyCode,doc="See `GetKeyCode`")
5399 Modifiers = property(GetModifiers,doc="See `GetModifiers`")
5400 Position = property(GetPosition,doc="See `GetPosition`")
5401 RawKeyCode = property(GetRawKeyCode,doc="See `GetRawKeyCode`")
5402 RawKeyFlags = property(GetRawKeyFlags,doc="See `GetRawKeyFlags`")
5403 UnicodeKey = property(GetUnicodeKey,SetUnicodeKey,doc="See `GetUnicodeKey` and `SetUnicodeKey`")
5404 X = property(GetX,doc="See `GetX`")
5405 Y = property(GetY,doc="See `GetY`")
2131d850 5406_core_.KeyEvent_swigregister(KeyEvent)
d14a1e28
RD
5407
5408#---------------------------------------------------------------------------
5409
5410class SizeEvent(Event):
5ba5649b
RD
5411 """
5412 A size event holds information about size change events. The EVT_SIZE
5413 handler function will be called when the window it is bound to has
5414 been resized.
5415
5416 Note that the size passed is of the whole window: call
5417 `wx.Window.GetClientSize` for the area which may be used by the
5418 application.
5419
5420 When a window is resized, usually only a small part of the window is
5421 damaged and and that area is all that is in the update region for the
5422 next paint event. However, if your drawing depends on the size of the
5423 window, you may need to clear the DC explicitly and repaint the whole
5424 window. In which case, you may need to call `wx.Window.Refresh` to
5425 invalidate the entire window.
5426
5427 """
0085ce49
RD
5428 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5429 __repr__ = _swig_repr
5430 def __init__(self, *args, **kwargs):
5ba5649b
RD
5431 """
5432 __init__(self, Size sz=DefaultSize, int winid=0) -> SizeEvent
5433
5434 Construct a new ``wx.SizeEvent``.
5435 """
0085ce49 5436 _core_.SizeEvent_swiginit(self,_core_.new_SizeEvent(*args, **kwargs))
e811c8ce 5437 def GetSize(*args, **kwargs):
5ba5649b
RD
5438 """
5439 GetSize(self) -> Size
5440
5441 Returns the entire size of the window generating the size change
5442 event.
5443 """
54f9ee45 5444 return _core_.SizeEvent_GetSize(*args, **kwargs)
e811c8ce
RD
5445
5446 def GetRect(*args, **kwargs):
a95a7133 5447 """GetRect(self) -> Rect"""
54f9ee45 5448 return _core_.SizeEvent_GetRect(*args, **kwargs)
e811c8ce
RD
5449
5450 def SetRect(*args, **kwargs):
a95a7133 5451 """SetRect(self, Rect rect)"""
54f9ee45 5452 return _core_.SizeEvent_SetRect(*args, **kwargs)
e811c8ce
RD
5453
5454 def SetSize(*args, **kwargs):
a95a7133 5455 """SetSize(self, Size size)"""
54f9ee45 5456 return _core_.SizeEvent_SetSize(*args, **kwargs)
e811c8ce 5457
54f9ee45
RD
5458 m_size = property(_core_.SizeEvent_m_size_get, _core_.SizeEvent_m_size_set)
5459 m_rect = property(_core_.SizeEvent_m_rect_get, _core_.SizeEvent_m_rect_set)
33d6fd3b
RD
5460 Rect = property(GetRect,SetRect,doc="See `GetRect` and `SetRect`")
5461 Size = property(GetSize,SetSize,doc="See `GetSize` and `SetSize`")
2131d850 5462_core_.SizeEvent_swigregister(SizeEvent)
d14a1e28
RD
5463
5464#---------------------------------------------------------------------------
5465
5466class MoveEvent(Event):
5ba5649b
RD
5467 """
5468 This event object is sent for EVT_MOVE event bindings when a window is
5469 moved to a new position.
5470 """
0085ce49
RD
5471 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5472 __repr__ = _swig_repr
5473 def __init__(self, *args, **kwargs):
5ba5649b
RD
5474 """
5475 __init__(self, Point pos=DefaultPosition, int winid=0) -> MoveEvent
5476
5477 Constructor.
5478 """
0085ce49 5479 _core_.MoveEvent_swiginit(self,_core_.new_MoveEvent(*args, **kwargs))
e811c8ce 5480 def GetPosition(*args, **kwargs):
5ba5649b
RD
5481 """
5482 GetPosition(self) -> Point
5483
5484 Returns the position of the window generating the move change event.
5485 """
54f9ee45 5486 return _core_.MoveEvent_GetPosition(*args, **kwargs)
e811c8ce
RD
5487
5488 def GetRect(*args, **kwargs):
a95a7133 5489 """GetRect(self) -> Rect"""
54f9ee45 5490 return _core_.MoveEvent_GetRect(*args, **kwargs)
e811c8ce
RD
5491
5492 def SetRect(*args, **kwargs):
a95a7133 5493 """SetRect(self, Rect rect)"""
54f9ee45 5494 return _core_.MoveEvent_SetRect(*args, **kwargs)
e811c8ce
RD
5495
5496 def SetPosition(*args, **kwargs):
a95a7133 5497 """SetPosition(self, Point pos)"""
54f9ee45 5498 return _core_.MoveEvent_SetPosition(*args, **kwargs)
e811c8ce 5499
7557b9b5
RD
5500 m_pos = property(GetPosition, SetPosition)
5501 m_rect = property(GetRect, SetRect)
5502
57332a5a
RD
5503 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
5504 Rect = property(GetRect,SetRect,doc="See `GetRect` and `SetRect`")
2131d850 5505_core_.MoveEvent_swigregister(MoveEvent)
d14a1e28
RD
5506
5507#---------------------------------------------------------------------------
5508
5509class PaintEvent(Event):
5ba5649b
RD
5510 """
5511 A paint event is sent when a window's contents needs to be repainted.
5512 Note that in an EVT_PAINT handler the application must *always* create
5513 a `wx.PaintDC` object, even if you do not use it. Otherwise MS
5514 Windows assumes that the window has not been painted yet and will send
5515 the event again, causing endless refreshes.
5516
5517 You can optimize painting by retrieving the rectangles that have been
5518 damaged using `wx.Window.GetUpdateRegion` and/or `wx.RegionIterator`,
5519 and only repainting these rectangles. The rectangles are in terms of
5520 the client area, and are unscrolled, so you will need to do some
5521 calculations using the current view position to obtain logical,
5522 scrolled units.
5523
5524 """
0085ce49
RD
5525 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5526 __repr__ = _swig_repr
5527 def __init__(self, *args, **kwargs):
a95a7133 5528 """__init__(self, int Id=0) -> PaintEvent"""
0085ce49 5529 _core_.PaintEvent_swiginit(self,_core_.new_PaintEvent(*args, **kwargs))
2131d850 5530_core_.PaintEvent_swigregister(PaintEvent)
d14a1e28
RD
5531
5532class NcPaintEvent(Event):
093d3ff1 5533 """Proxy of C++ NcPaintEvent class"""
0085ce49
RD
5534 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5535 __repr__ = _swig_repr
5536 def __init__(self, *args, **kwargs):
a95a7133 5537 """__init__(self, int winid=0) -> NcPaintEvent"""
0085ce49 5538 _core_.NcPaintEvent_swiginit(self,_core_.new_NcPaintEvent(*args, **kwargs))
2131d850 5539_core_.NcPaintEvent_swigregister(NcPaintEvent)
d14a1e28
RD
5540
5541#---------------------------------------------------------------------------
5542
5543class EraseEvent(Event):
5ba5649b
RD
5544 """
5545 An erase event is sent whenever the background of a window needs to be
5546 repainted. To intercept this event use the EVT_ERASE_BACKGROUND event
5547 binder. On some platforms, such as GTK+, this event is simulated
5548 (simply generated just before the paint event) and may cause flicker.
5549
5550 To paint a custom background use the `GetDC` method and use the returned
5551 device context if it is not ``None``, otherwise create a temporary
5552 `wx.ClientDC` and draw on that.
5553
5554 """
0085ce49
RD
5555 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5556 __repr__ = _swig_repr
5557 def __init__(self, *args, **kwargs):
5ba5649b
RD
5558 """
5559 __init__(self, int Id=0, DC dc=None) -> EraseEvent
5560
5561 Constructor
5562 """
0085ce49 5563 _core_.EraseEvent_swiginit(self,_core_.new_EraseEvent(*args, **kwargs))
e811c8ce 5564 def GetDC(*args, **kwargs):
5ba5649b
RD
5565 """
5566 GetDC(self) -> DC
5567
5568 Returns the device context the event handler should draw upon. If
5569 ``None`` is returned then create a temporary `wx.ClientDC` and use
5570 that instead.
5571 """
54f9ee45 5572 return _core_.EraseEvent_GetDC(*args, **kwargs)
e811c8ce 5573
97ab0f6a 5574 DC = property(GetDC,doc="See `GetDC`")
2131d850 5575_core_.EraseEvent_swigregister(EraseEvent)
d14a1e28
RD
5576
5577#---------------------------------------------------------------------------
5578
5579class FocusEvent(Event):
5ba5649b
RD
5580 """
5581 A focus event is sent when a window's focus changes. The window losing
5582 focus receives an EVT_KILL_FOCUS event while the window gaining it
5583 gets an EVT_SET_FOCUS event.
5584
5585 Notice that the set focus event happens both when the user gives focus
5586 to the window (whether using the mouse or keyboard) and when it is
5587 done from the program itself using `wx.Window.SetFocus`.
5588
5589 """
0085ce49
RD
5590 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5591 __repr__ = _swig_repr
5592 def __init__(self, *args, **kwargs):
5ba5649b 5593 """
2131d850 5594 __init__(self, EventType type=wxEVT_NULL, int winid=0) -> FocusEvent
5ba5649b
RD
5595
5596 Constructor
5597 """
0085ce49 5598 _core_.FocusEvent_swiginit(self,_core_.new_FocusEvent(*args, **kwargs))
e811c8ce 5599 def GetWindow(*args, **kwargs):
5ba5649b
RD
5600 """
5601 GetWindow(self) -> Window
5602
5603 Returns the other window associated with this event, that is the
5604 window which had the focus before for the EVT_SET_FOCUS event and the
5605 window which is going to receive focus for the wxEVT_KILL_FOCUS event.
5606
5607 Warning: the window returned may be None!
5608 """
54f9ee45 5609 return _core_.FocusEvent_GetWindow(*args, **kwargs)
e811c8ce
RD
5610
5611 def SetWindow(*args, **kwargs):
a95a7133 5612 """SetWindow(self, Window win)"""
54f9ee45 5613 return _core_.FocusEvent_SetWindow(*args, **kwargs)
e811c8ce 5614
97ab0f6a 5615 Window = property(GetWindow,SetWindow,doc="See `GetWindow` and `SetWindow`")
2131d850 5616_core_.FocusEvent_swigregister(FocusEvent)
d14a1e28
RD
5617
5618#---------------------------------------------------------------------------
5619
5620class ChildFocusEvent(CommandEvent):
5ba5649b 5621 """
33d6fd3b
RD
5622 A child focus event is sent to a (parent-)window when one of its child
5623 windows gains focus, so that the window could restore the focus back
5624 to its corresponding child if it loses it now and regains later.
5625
5626 Notice that child window is the direct child of the window receiving
5627 the event, and so may not be the actual widget recieving focus if it
5628 is further down the containment heirarchy. Use `wx.Window.FindFocus`
5629 to get the widget that is actually receiving focus.
5ba5649b 5630 """
0085ce49
RD
5631 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5632 __repr__ = _swig_repr
5633 def __init__(self, *args, **kwargs):
5ba5649b
RD
5634 """
5635 __init__(self, Window win=None) -> ChildFocusEvent
5636
5637 Constructor
5638 """
0085ce49 5639 _core_.ChildFocusEvent_swiginit(self,_core_.new_ChildFocusEvent(*args, **kwargs))
e811c8ce 5640 def GetWindow(*args, **kwargs):
5ba5649b
RD
5641 """
5642 GetWindow(self) -> Window
5643
33d6fd3b
RD
5644 The window, or (grand)parent of the window which has just received the
5645 focus.
5ba5649b 5646 """
54f9ee45 5647 return _core_.ChildFocusEvent_GetWindow(*args, **kwargs)
e811c8ce 5648
2bf58437 5649 Window = property(GetWindow,doc="See `GetWindow`")
2131d850 5650_core_.ChildFocusEvent_swigregister(ChildFocusEvent)
d14a1e28
RD
5651
5652#---------------------------------------------------------------------------
5653
5654class ActivateEvent(Event):
5ba5649b
RD
5655 """
5656 An activate event is sent when a top-level window or the entire
5657 application is being activated or deactivated.
5658
5659 A top-level window (a dialog or frame) receives an activate event when
5660 is being activated or deactivated. This is indicated visually by the
5661 title bar changing colour, and a subwindow gaining the keyboard focus.
5662 An application is activated or deactivated when one of its frames
5663 becomes activated, or a frame becomes inactivate resulting in all
5664 application frames being inactive.
5665
5666 Please note that usually you should call event.Skip() in your handlers
5667 for these events so the default handlers will still be called, as not
5668 doing so can result in strange effects.
5669
5670 """
0085ce49
RD
5671 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5672 __repr__ = _swig_repr
5673 def __init__(self, *args, **kwargs):
5ba5649b 5674 """
2131d850 5675 __init__(self, EventType type=wxEVT_NULL, bool active=True, int Id=0) -> ActivateEvent
5ba5649b
RD
5676
5677 Constructor
5678 """
0085ce49 5679 _core_.ActivateEvent_swiginit(self,_core_.new_ActivateEvent(*args, **kwargs))
e811c8ce 5680 def GetActive(*args, **kwargs):
5ba5649b
RD
5681 """
5682 GetActive(self) -> bool
5683
5684 Returns true if the application or window is being activated, false
5685 otherwise.
5686 """
54f9ee45 5687 return _core_.ActivateEvent_GetActive(*args, **kwargs)
e811c8ce 5688
2bf58437 5689 Active = property(GetActive,doc="See `GetActive`")
2131d850 5690_core_.ActivateEvent_swigregister(ActivateEvent)
d14a1e28
RD
5691
5692#---------------------------------------------------------------------------
5693
5694class InitDialogEvent(Event):
5ba5649b
RD
5695 """
5696 A wx.InitDialogEvent is sent as a dialog is being initialised, or for
5697 any window when `wx.Window.InitDialog` is called. Handlers for this
5698 event can transfer data to the window, or anything else that should be
5699 done before the user begins editing the form. The default handler
5700 calls `wx.Window.TransferDataToWindow`.
5701 """
0085ce49
RD
5702 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5703 __repr__ = _swig_repr
5704 def __init__(self, *args, **kwargs):
5ba5649b
RD
5705 """
5706 __init__(self, int Id=0) -> InitDialogEvent
5707
5708 Constructor
5709 """
0085ce49 5710 _core_.InitDialogEvent_swiginit(self,_core_.new_InitDialogEvent(*args, **kwargs))
2131d850 5711_core_.InitDialogEvent_swigregister(InitDialogEvent)
d14a1e28
RD
5712
5713#---------------------------------------------------------------------------
5714
5715class MenuEvent(Event):
5ba5649b
RD
5716 """
5717 This class is used for a variety of menu-related events. Note that
5718 these do not include menu command events, which are handled by sending
5719 `wx.CommandEvent` objects.
5720
5721 The default handler for wx.EVT_MENU_HIGHLIGHT displays menu item help
5722 text in the first field of the status bar.
5723 """
0085ce49
RD
5724 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5725 __repr__ = _swig_repr
5726 def __init__(self, *args, **kwargs):
5ba5649b 5727 """
2131d850 5728 __init__(self, EventType type=wxEVT_NULL, int winid=0, Menu menu=None) -> MenuEvent
5ba5649b
RD
5729
5730 Constructor
5731 """
0085ce49 5732 _core_.MenuEvent_swiginit(self,_core_.new_MenuEvent(*args, **kwargs))
e811c8ce 5733 def GetMenuId(*args, **kwargs):
5ba5649b
RD
5734 """
5735 GetMenuId(self) -> int
5736
5737 Returns the menu identifier associated with the event. This method
5738 should be only used with the HIGHLIGHT events.
5739 """
54f9ee45 5740 return _core_.MenuEvent_GetMenuId(*args, **kwargs)
e811c8ce
RD
5741
5742 def IsPopup(*args, **kwargs):
5ba5649b
RD
5743 """
5744 IsPopup(self) -> bool
5745
5746 Returns ``True`` if the menu which is being opened or closed is a
5747 popup menu, ``False`` if it is a normal one. This method should only
5748 be used with the OPEN and CLOSE events.
5749 """
54f9ee45 5750 return _core_.MenuEvent_IsPopup(*args, **kwargs)
e811c8ce
RD
5751
5752 def GetMenu(*args, **kwargs):
5ba5649b
RD
5753 """
5754 GetMenu(self) -> Menu
5755
5756 Returns the menu which is being opened or closed. This method should
5757 only be used with the OPEN and CLOSE events.
5758 """
54f9ee45 5759 return _core_.MenuEvent_GetMenu(*args, **kwargs)
e811c8ce 5760
57332a5a
RD
5761 Menu = property(GetMenu,doc="See `GetMenu`")
5762 MenuId = property(GetMenuId,doc="See `GetMenuId`")
2131d850 5763_core_.MenuEvent_swigregister(MenuEvent)
d14a1e28
RD
5764
5765#---------------------------------------------------------------------------
5766
5767class CloseEvent(Event):
5ba5649b
RD
5768 """
5769 This event class contains information about window and session close
5770 events.
5771
5772 The handler function for EVT_CLOSE is called when the user has tried
5773 to close a a frame or dialog box using the window manager controls or
5774 the system menu. It can also be invoked by the application itself
5775 programmatically, for example by calling the `wx.Window.Close`
5776 function.
5777
5778 You should check whether the application is forcing the deletion of
5779 the window using `CanVeto`. If it returns ``False``, you must destroy
5780 the window using `wx.Window.Destroy`. If the return value is ``True``,
5781 it is up to you whether you respond by destroying the window or not.
5782 For example you may wish to display a message dialog prompting to save
5783 files or to cancel the close.
5784
5785 If you don't destroy the window, you should call `Veto` to let the
5786 calling code know that you did not destroy the window. This allows the
5787 `wx.Window.Close` function to return ``True`` or ``False`` depending
5788 on whether the close instruction was honored or not.
5789 """
0085ce49
RD
5790 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5791 __repr__ = _swig_repr
5792 def __init__(self, *args, **kwargs):
5ba5649b 5793 """
2131d850 5794 __init__(self, EventType type=wxEVT_NULL, int winid=0) -> CloseEvent
5ba5649b
RD
5795
5796 Constructor.
5797 """
0085ce49 5798 _core_.CloseEvent_swiginit(self,_core_.new_CloseEvent(*args, **kwargs))
e811c8ce 5799 def SetLoggingOff(*args, **kwargs):
5ba5649b
RD
5800 """
5801 SetLoggingOff(self, bool logOff)
5802
5803 Sets the 'logging off' flag.
5804 """
54f9ee45 5805 return _core_.CloseEvent_SetLoggingOff(*args, **kwargs)
e811c8ce
RD
5806
5807 def GetLoggingOff(*args, **kwargs):
5ba5649b
RD
5808 """
5809 GetLoggingOff(self) -> bool
5810
6c75a4cf
RD
5811 Returns ``True`` if the user is logging off or ``False`` if the
5812 system is shutting down. This method can only be called for end
5813 session and query end session events, it doesn't make sense for close
5814 window event.
5ba5649b 5815 """
54f9ee45 5816 return _core_.CloseEvent_GetLoggingOff(*args, **kwargs)
e811c8ce
RD
5817
5818 def Veto(*args, **kwargs):
5ba5649b
RD
5819 """
5820 Veto(self, bool veto=True)
5821
5822 Call this from your event handler to veto a system shutdown or to
5823 signal to the calling application that a window close did not happen.
5824
5825 You can only veto a shutdown or close if `CanVeto` returns true.
5826 """
54f9ee45 5827 return _core_.CloseEvent_Veto(*args, **kwargs)
e811c8ce 5828
5ba5649b
RD
5829 def GetVeto(*args, **kwargs):
5830 """GetVeto(self) -> bool"""
5831 return _core_.CloseEvent_GetVeto(*args, **kwargs)
5832
e811c8ce 5833 def SetCanVeto(*args, **kwargs):
5ba5649b
RD
5834 """
5835 SetCanVeto(self, bool canVeto)
5836
5837 Sets the 'can veto' flag.
5838 """
54f9ee45 5839 return _core_.CloseEvent_SetCanVeto(*args, **kwargs)
e811c8ce
RD
5840
5841 def CanVeto(*args, **kwargs):
5ba5649b
RD
5842 """
5843 CanVeto(self) -> bool
e811c8ce 5844
5ba5649b
RD
5845 Returns true if you can veto a system shutdown or a window close
5846 event. Vetoing a window close event is not possible if the calling
5847 code wishes to force the application to exit, and so this function
5848 must be called to check this.
5849 """
5850 return _core_.CloseEvent_CanVeto(*args, **kwargs)
e811c8ce 5851
2bf58437 5852 LoggingOff = property(GetLoggingOff,SetLoggingOff,doc="See `GetLoggingOff` and `SetLoggingOff`")
2131d850 5853_core_.CloseEvent_swigregister(CloseEvent)
d14a1e28
RD
5854
5855#---------------------------------------------------------------------------
5856
5857class ShowEvent(Event):
5ba5649b 5858 """An EVT_SHOW event is sent when a window is shown or hidden."""
0085ce49
RD
5859 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5860 __repr__ = _swig_repr
5861 def __init__(self, *args, **kwargs):
5ba5649b
RD
5862 """
5863 __init__(self, int winid=0, bool show=False) -> ShowEvent
5864
5865 An EVT_SHOW event is sent when a window is shown or hidden.
5866 """
0085ce49 5867 _core_.ShowEvent_swiginit(self,_core_.new_ShowEvent(*args, **kwargs))
e811c8ce 5868 def SetShow(*args, **kwargs):
a95a7133 5869 """SetShow(self, bool show)"""
54f9ee45 5870 return _core_.ShowEvent_SetShow(*args, **kwargs)
e811c8ce
RD
5871
5872 def GetShow(*args, **kwargs):
a95a7133 5873 """GetShow(self) -> bool"""
54f9ee45 5874 return _core_.ShowEvent_GetShow(*args, **kwargs)
e811c8ce 5875
33d6fd3b 5876 Show = property(GetShow,SetShow,doc="See `GetShow` and `SetShow`")
2131d850 5877_core_.ShowEvent_swigregister(ShowEvent)
d14a1e28
RD
5878
5879#---------------------------------------------------------------------------
5880
5881class IconizeEvent(Event):
5ba5649b
RD
5882 """
5883 An EVT_ICONIZE event is sent when a frame is iconized (minimized) or
5884 restored.
5885 """
0085ce49
RD
5886 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5887 __repr__ = _swig_repr
5888 def __init__(self, *args, **kwargs):
5ba5649b
RD
5889 """
5890 __init__(self, int id=0, bool iconized=True) -> IconizeEvent
5891
5892 An EVT_ICONIZE event is sent when a frame is iconized (minimized) or
5893 restored.
5894 """
0085ce49 5895 _core_.IconizeEvent_swiginit(self,_core_.new_IconizeEvent(*args, **kwargs))
e811c8ce 5896 def Iconized(*args, **kwargs):
5ba5649b
RD
5897 """
5898 Iconized(self) -> bool
5899
5900 Returns ``True`` if the frame has been iconized, ``False`` if it has
5901 been restored.
5902 """
54f9ee45 5903 return _core_.IconizeEvent_Iconized(*args, **kwargs)
e811c8ce 5904
2131d850 5905_core_.IconizeEvent_swigregister(IconizeEvent)
d14a1e28
RD
5906
5907#---------------------------------------------------------------------------
5908
5909class MaximizeEvent(Event):
5ba5649b 5910 """An EVT_MAXIMIZE event is sent when a frame is maximized or restored."""
0085ce49
RD
5911 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5912 __repr__ = _swig_repr
5913 def __init__(self, *args, **kwargs):
5ba5649b
RD
5914 """
5915 __init__(self, int id=0) -> MaximizeEvent
5916
5917 An EVT_MAXIMIZE event is sent when a frame is maximized or restored.
5918 """
0085ce49 5919 _core_.MaximizeEvent_swiginit(self,_core_.new_MaximizeEvent(*args, **kwargs))
2131d850 5920_core_.MaximizeEvent_swigregister(MaximizeEvent)
d14a1e28
RD
5921
5922#---------------------------------------------------------------------------
5923
5924class DropFilesEvent(Event):
5ba5649b
RD
5925 """
5926 This class is used for drop files events, that is, when files have
5927 been dropped onto the window. This functionality is only available
5928 under Windows. The window must have previously been enabled for
5929 dropping by calling `wx.Window.DragAcceptFiles`.
5930
5931 Important note: this is a separate implementation to the more general
5932 drag and drop implementation using `wx.FileDropTarget`, and etc. This
5933 implementation uses the older, Windows message-based approach of
5934 dropping files.
5935
5936 Use wx.EVT_DROP_FILES to bind an event handler to receive file drop
5937 events.
5938
5939 """
0085ce49
RD
5940 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5941 def __init__(self): raise AttributeError, "No constructor defined"
5942 __repr__ = _swig_repr
e811c8ce 5943 def GetPosition(*args, **kwargs):
5ba5649b
RD
5944 """
5945 GetPosition(self) -> Point
5946
5947 Returns the position at which the files were dropped.
5948 """
54f9ee45 5949 return _core_.DropFilesEvent_GetPosition(*args, **kwargs)
e811c8ce
RD
5950
5951 def GetNumberOfFiles(*args, **kwargs):
5ba5649b
RD
5952 """
5953 GetNumberOfFiles(self) -> int
5954
5955 Returns the number of files dropped.
5956 """
54f9ee45 5957 return _core_.DropFilesEvent_GetNumberOfFiles(*args, **kwargs)
e811c8ce
RD
5958
5959 def GetFiles(*args, **kwargs):
5ba5649b
RD
5960 """
5961 GetFiles(self) -> PyObject
5962
5963 Returns a list of the filenames that were dropped.
5964 """
54f9ee45 5965 return _core_.DropFilesEvent_GetFiles(*args, **kwargs)
e811c8ce 5966
2bf58437
RD
5967 Files = property(GetFiles,doc="See `GetFiles`")
5968 NumberOfFiles = property(GetNumberOfFiles,doc="See `GetNumberOfFiles`")
5969 Position = property(GetPosition,doc="See `GetPosition`")
2131d850 5970_core_.DropFilesEvent_swigregister(DropFilesEvent)
d14a1e28
RD
5971
5972#---------------------------------------------------------------------------
5973
54f9ee45
RD
5974UPDATE_UI_PROCESS_ALL = _core_.UPDATE_UI_PROCESS_ALL
5975UPDATE_UI_PROCESS_SPECIFIED = _core_.UPDATE_UI_PROCESS_SPECIFIED
d14a1e28 5976class UpdateUIEvent(CommandEvent):
5ba5649b
RD
5977 """
5978 This class is used for EVT_UPDATE_UI pseudo-events which are sent by
5979 wxWidgets to give an application the chance to update various user
5980 interface elements.
5981
5982 Without update UI events, an application has to work hard to
5983 check/uncheck, enable/disable, and set the text for elements such as
5984 menu items and toolbar buttons. The code for doing this has to be
5985 mixed up with the code that is invoked when an action is invoked for a
5986 menu item or button.
5987
5988 With update UI events, you define an event handler to look at the
5989 state of the application and change UI elements accordingly. wxWidgets
5990 will call your handler functions in idle time, so you don't have to
5991 worry where to call this code. In addition to being a clearer and more
5992 declarative method, it also means you don't have to worry whether
5993 you're updating a toolbar or menubar identifier. The same handler can
5994 update a menu item and toolbar button, if the ID values are the same.
5995
5996 Instead of directly manipulating the menu or button, you call
5997 functions in the event object, such as `Check`. wxWidgets will
5998 determine whether such a call has been made, and which UI element to
5999 update.
6000
6001 These events will work for popup menus as well as menubars. Just
6002 before a menu is popped up, `wx.Menu.UpdateUI` is called to process
6003 any UI events for the window that owns the menu.
6004
6005 If you find that the overhead of UI update processing is affecting
6006 your application, you can do one or both of the following:
6007
6008 1. Call `wx.UpdateUIEvent.SetMode` with a value of
6009 wx.UPDATE_UI_PROCESS_SPECIFIED, and set the extra style
6010 wx.WS_EX_PROCESS_UPDATE_EVENTS for every window that should
6011 receive update events. No other windows will receive update
6012 events.
6013
6014 2. Call `wx.UpdateUIEvent.SetUpdateInterval` with a millisecond
6015 value to set the delay between updates. You may need to call
6016 `wx.Window.UpdateWindowUI` at critical points, for example when
6017 a dialog is about to be shown, in case the user sees a slight
6018 delay before windows are updated.
6019
6020 Note that although events are sent in idle time, defining a EVT_IDLE
6021 handler for a window does not affect this because the events are sent
6022 from an internal idle handler.
6023
6024 wxWidgets tries to optimize update events on some platforms. On
6025 Windows and GTK+, events for menubar items are only sent when the menu
6026 is about to be shown, and not in idle time.
6027
6028 """
0085ce49
RD
6029 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6030 __repr__ = _swig_repr
6031 def __init__(self, *args, **kwargs):
5ba5649b
RD
6032 """
6033 __init__(self, int commandId=0) -> UpdateUIEvent
6034
6035 Constructor
6036 """
0085ce49 6037 _core_.UpdateUIEvent_swiginit(self,_core_.new_UpdateUIEvent(*args, **kwargs))
e811c8ce 6038 def GetChecked(*args, **kwargs):
5ba5649b
RD
6039 """
6040 GetChecked(self) -> bool
6041
6042 Returns ``True`` if the UI element should be checked.
6043 """
54f9ee45 6044 return _core_.UpdateUIEvent_GetChecked(*args, **kwargs)
e811c8ce
RD
6045
6046 def GetEnabled(*args, **kwargs):
5ba5649b
RD
6047 """
6048 GetEnabled(self) -> bool
6049
6050 Returns ``True`` if the UI element should be enabled.
6051 """
54f9ee45 6052 return _core_.UpdateUIEvent_GetEnabled(*args, **kwargs)
e811c8ce 6053
b1fcee84
RD
6054 def GetShown(*args, **kwargs):
6055 """
6056 GetShown(self) -> bool
6057
6058 Returns ``True`` if the UI element should be shown.
6059 """
6060 return _core_.UpdateUIEvent_GetShown(*args, **kwargs)
6061
e811c8ce 6062 def GetText(*args, **kwargs):
5ba5649b
RD
6063 """
6064 GetText(self) -> String
6065
6066 Returns the text that should be set for the UI element.
6067 """
54f9ee45 6068 return _core_.UpdateUIEvent_GetText(*args, **kwargs)
e811c8ce
RD
6069
6070 def GetSetText(*args, **kwargs):
5ba5649b
RD
6071 """
6072 GetSetText(self) -> bool
6073
6074 Returns ``True`` if the application has called `SetText`. For
6075 wxWidgets internal use only.
6076 """
54f9ee45 6077 return _core_.UpdateUIEvent_GetSetText(*args, **kwargs)
e811c8ce
RD
6078
6079 def GetSetChecked(*args, **kwargs):
5ba5649b
RD
6080 """
6081 GetSetChecked(self) -> bool
6082
6083 Returns ``True`` if the application has called `Check`. For wxWidgets
6084 internal use only.
6085 """
54f9ee45 6086 return _core_.UpdateUIEvent_GetSetChecked(*args, **kwargs)
e811c8ce
RD
6087
6088 def GetSetEnabled(*args, **kwargs):
5ba5649b
RD
6089 """
6090 GetSetEnabled(self) -> bool
6091
6092 Returns ``True`` if the application has called `Enable`. For wxWidgets
6093 internal use only.
6094 """
54f9ee45 6095 return _core_.UpdateUIEvent_GetSetEnabled(*args, **kwargs)
e811c8ce 6096
b1fcee84
RD
6097 def GetSetShown(*args, **kwargs):
6098 """
6099 GetSetShown(self) -> bool
6100
6101 Returns ``True`` if the application has called `Show`. For wxWidgets
6102 internal use only.
6103 """
6104 return _core_.UpdateUIEvent_GetSetShown(*args, **kwargs)
6105
e811c8ce 6106 def Check(*args, **kwargs):
5ba5649b
RD
6107 """
6108 Check(self, bool check)
6109
6110 Check or uncheck the UI element.
6111 """
54f9ee45 6112 return _core_.UpdateUIEvent_Check(*args, **kwargs)
e811c8ce
RD
6113
6114 def Enable(*args, **kwargs):
5ba5649b
RD
6115 """
6116 Enable(self, bool enable)
6117
6118 Enable or disable the UI element.
6119 """
54f9ee45 6120 return _core_.UpdateUIEvent_Enable(*args, **kwargs)
e811c8ce 6121
b1fcee84
RD
6122 def Show(*args, **kwargs):
6123 """
6124 Show(self, bool show)
6125
6126 Show or hide the UI element.
6127 """
6128 return _core_.UpdateUIEvent_Show(*args, **kwargs)
6129
e811c8ce 6130 def SetText(*args, **kwargs):
5ba5649b
RD
6131 """
6132 SetText(self, String text)
6133
6134 Sets the text for this UI element.
6135 """
54f9ee45 6136 return _core_.UpdateUIEvent_SetText(*args, **kwargs)
e811c8ce
RD
6137
6138 def SetUpdateInterval(*args, **kwargs):
5ba5649b
RD
6139 """
6140 SetUpdateInterval(long updateInterval)
6141
6142 Sets the interval between updates in milliseconds. Set to -1 to
6143 disable updates, or to 0 to update as frequently as possible. The
6144 default is 0.
6145
6146 Use this to reduce the overhead of UI update events if your
6147 application has a lot of windows. If you set the value to -1 or
6148 greater than 0, you may also need to call `wx.Window.UpdateWindowUI`
6149 at appropriate points in your application, such as when a dialog is
6150 about to be shown.
6151 """
54f9ee45 6152 return _core_.UpdateUIEvent_SetUpdateInterval(*args, **kwargs)
e811c8ce
RD
6153
6154 SetUpdateInterval = staticmethod(SetUpdateInterval)
6155 def GetUpdateInterval(*args, **kwargs):
5ba5649b
RD
6156 """
6157 GetUpdateInterval() -> long
6158
6159 Returns the current interval between updates in milliseconds. -1
6160 disables updates, 0 updates as frequently as possible.
6161 """
54f9ee45 6162 return _core_.UpdateUIEvent_GetUpdateInterval(*args, **kwargs)
e811c8ce
RD
6163
6164 GetUpdateInterval = staticmethod(GetUpdateInterval)
6165 def CanUpdate(*args, **kwargs):
5ba5649b
RD
6166 """
6167 CanUpdate(Window win) -> bool
6168
6169 Returns ``True`` if it is appropriate to update (send UI update events
6170 to) this window.
6171
6172 This function looks at the mode used (see `wx.UpdateUIEvent.SetMode`),
6173 the wx.WS_EX_PROCESS_UPDATE_EVENTS flag in window, the time update
6174 events were last sent in idle time, and the update interval, to
6175 determine whether events should be sent to this window now. By default
6176 this will always return true because the update mode is initially
6177 wx.UPDATE_UI_PROCESS_ALL and the interval is set to 0; so update
6178 events will be sent as often as possible. You can reduce the frequency
6179 that events are sent by changing the mode and/or setting an update
6180 interval.
6181
6182 """
54f9ee45 6183 return _core_.UpdateUIEvent_CanUpdate(*args, **kwargs)
e811c8ce
RD
6184
6185 CanUpdate = staticmethod(CanUpdate)
6186 def ResetUpdateTime(*args, **kwargs):
5ba5649b
RD
6187 """
6188 ResetUpdateTime()
6189
6190 Used internally to reset the last-updated time to the current time. It
6191 is assumed that update events are normally sent in idle time, so this
6192 is called at the end of idle processing.
6193 """
54f9ee45 6194 return _core_.UpdateUIEvent_ResetUpdateTime(*args, **kwargs)
e811c8ce
RD
6195
6196 ResetUpdateTime = staticmethod(ResetUpdateTime)
6197 def SetMode(*args, **kwargs):
5ba5649b
RD
6198 """
6199 SetMode(int mode)
6200
6201 Specify how wxWidgets will send update events: to all windows, or only
6202 to those which specify that they will process the events.
6203
6204 The mode may be one of the following values:
6205
6206 ============================= ==========================================
6207 wxUPDATE_UI_PROCESS_ALL Send UI update events to all windows. This
6208 is the default setting.
6209 wxUPDATE_UI_PROCESS_SPECIFIED Send UI update events only to windows that
6210 have the wx.WS_EX_PROCESS_UI_UPDATES extra
6211 style set.
6212 ============================= ==========================================
6213
6214 """
54f9ee45 6215 return _core_.UpdateUIEvent_SetMode(*args, **kwargs)
e811c8ce
RD
6216
6217 SetMode = staticmethod(SetMode)
6218 def GetMode(*args, **kwargs):
5ba5649b
RD
6219 """
6220 GetMode() -> int
6221
6222 Returns a value specifying how wxWidgets will send update events: to
6223 all windows, or only to those which specify that they will process the
6224 events.
6225 """
54f9ee45 6226 return _core_.UpdateUIEvent_GetMode(*args, **kwargs)
e811c8ce
RD
6227
6228 GetMode = staticmethod(GetMode)
dba7934c
RD
6229 Checked = property(GetChecked,Check,doc="See `GetChecked`")
6230 Enabled = property(GetEnabled,Enable,doc="See `GetEnabled`")
6231 Shown = property(GetShown,Show,doc="See `GetShown`")
6232 Text = property(GetText,SetText,doc="See `GetText` and `SetText`")
2131d850 6233_core_.UpdateUIEvent_swigregister(UpdateUIEvent)
d14a1e28 6234
e811c8ce 6235def UpdateUIEvent_SetUpdateInterval(*args, **kwargs):
0085ce49 6236 """
5ba5649b
RD
6237 UpdateUIEvent_SetUpdateInterval(long updateInterval)
6238
6239 Sets the interval between updates in milliseconds. Set to -1 to
6240 disable updates, or to 0 to update as frequently as possible. The
6241 default is 0.
6242
6243 Use this to reduce the overhead of UI update events if your
6244 application has a lot of windows. If you set the value to -1 or
6245 greater than 0, you may also need to call `wx.Window.UpdateWindowUI`
6246 at appropriate points in your application, such as when a dialog is
6247 about to be shown.
6248 """
0085ce49 6249 return _core_.UpdateUIEvent_SetUpdateInterval(*args, **kwargs)
d14a1e28 6250
0085ce49
RD
6251def UpdateUIEvent_GetUpdateInterval(*args):
6252 """
5ba5649b
RD
6253 UpdateUIEvent_GetUpdateInterval() -> long
6254
6255 Returns the current interval between updates in milliseconds. -1
6256 disables updates, 0 updates as frequently as possible.
6257 """
0085ce49 6258 return _core_.UpdateUIEvent_GetUpdateInterval(*args)
d14a1e28 6259
e811c8ce 6260def UpdateUIEvent_CanUpdate(*args, **kwargs):
0085ce49 6261 """
5ba5649b
RD
6262 UpdateUIEvent_CanUpdate(Window win) -> bool
6263
6264 Returns ``True`` if it is appropriate to update (send UI update events
6265 to) this window.
6266
6267 This function looks at the mode used (see `wx.UpdateUIEvent.SetMode`),
6268 the wx.WS_EX_PROCESS_UPDATE_EVENTS flag in window, the time update
6269 events were last sent in idle time, and the update interval, to
6270 determine whether events should be sent to this window now. By default
6271 this will always return true because the update mode is initially
6272 wx.UPDATE_UI_PROCESS_ALL and the interval is set to 0; so update
6273 events will be sent as often as possible. You can reduce the frequency
6274 that events are sent by changing the mode and/or setting an update
6275 interval.
6276
6277 """
0085ce49 6278 return _core_.UpdateUIEvent_CanUpdate(*args, **kwargs)
d14a1e28 6279
0085ce49
RD
6280def UpdateUIEvent_ResetUpdateTime(*args):
6281 """
5ba5649b
RD
6282 UpdateUIEvent_ResetUpdateTime()
6283
6284 Used internally to reset the last-updated time to the current time. It
6285 is assumed that update events are normally sent in idle time, so this
6286 is called at the end of idle processing.
6287 """
0085ce49 6288 return _core_.UpdateUIEvent_ResetUpdateTime(*args)
d14a1e28 6289
e811c8ce 6290def UpdateUIEvent_SetMode(*args, **kwargs):
0085ce49 6291 """
5ba5649b
RD
6292 UpdateUIEvent_SetMode(int mode)
6293
6294 Specify how wxWidgets will send update events: to all windows, or only
6295 to those which specify that they will process the events.
6296
6297 The mode may be one of the following values:
6298
6299 ============================= ==========================================
6300 wxUPDATE_UI_PROCESS_ALL Send UI update events to all windows. This
6301 is the default setting.
6302 wxUPDATE_UI_PROCESS_SPECIFIED Send UI update events only to windows that
6303 have the wx.WS_EX_PROCESS_UI_UPDATES extra
6304 style set.
6305 ============================= ==========================================
6306
6307 """
0085ce49 6308 return _core_.UpdateUIEvent_SetMode(*args, **kwargs)
d14a1e28 6309
0085ce49
RD
6310def UpdateUIEvent_GetMode(*args):
6311 """
5ba5649b
RD
6312 UpdateUIEvent_GetMode() -> int
6313
6314 Returns a value specifying how wxWidgets will send update events: to
6315 all windows, or only to those which specify that they will process the
6316 events.
6317 """
0085ce49 6318 return _core_.UpdateUIEvent_GetMode(*args)
d14a1e28
RD
6319
6320#---------------------------------------------------------------------------
6321
6322class SysColourChangedEvent(Event):
5ba5649b
RD
6323 """
6324 This class is used for EVT_SYS_COLOUR_CHANGED, which are generated
6325 when the user changes the colour settings using the control
6326 panel. This is only applicable under Windows.
6327
6328 The default event handler for this event propagates the event to child
6329 windows, since Windows only sends the events to top-level windows. If
6330 intercepting this event for a top-level window, remember to call
6331 `Skip` so the the base class handler will still be executed, or to
6332 pass the event on to the window's children explicitly.
6333
6334 """
0085ce49
RD
6335 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6336 __repr__ = _swig_repr
6337 def __init__(self, *args, **kwargs):
5ba5649b
RD
6338 """
6339 __init__(self) -> SysColourChangedEvent
6340
6341 Constructor
6342 """
0085ce49 6343 _core_.SysColourChangedEvent_swiginit(self,_core_.new_SysColourChangedEvent(*args, **kwargs))
2131d850 6344_core_.SysColourChangedEvent_swigregister(SysColourChangedEvent)
d14a1e28
RD
6345
6346#---------------------------------------------------------------------------
6347
6348class MouseCaptureChangedEvent(Event):
5ba5649b
RD
6349 """
6350 An mouse capture changed event (EVT_MOUSE_CAPTURE_CHANGED) is sent to
6351 a window that loses its mouse capture. This is called even if
6352 `wx.Window.ReleaseMouse` was called by the application code. Handling
6353 this event allows an application to cater for unexpected capture
6354 releases which might otherwise confuse mouse handling code.
6355
6356 This event is implemented under Windows only.
6357 """
0085ce49
RD
6358 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6359 __repr__ = _swig_repr
6360 def __init__(self, *args, **kwargs):
5ba5649b
RD
6361 """
6362 __init__(self, int winid=0, Window gainedCapture=None) -> MouseCaptureChangedEvent
6363
6364 Constructor
6365 """
0085ce49 6366 _core_.MouseCaptureChangedEvent_swiginit(self,_core_.new_MouseCaptureChangedEvent(*args, **kwargs))
e811c8ce 6367 def GetCapturedWindow(*args, **kwargs):
5ba5649b
RD
6368 """
6369 GetCapturedWindow(self) -> Window
6370
6371 Returns the window that gained the capture, or ``None`` if it was a
6372 non-wxWidgets window.
6373 """
54f9ee45 6374 return _core_.MouseCaptureChangedEvent_GetCapturedWindow(*args, **kwargs)
e811c8ce 6375
57332a5a 6376 CapturedWindow = property(GetCapturedWindow,doc="See `GetCapturedWindow`")
2131d850 6377_core_.MouseCaptureChangedEvent_swigregister(MouseCaptureChangedEvent)
d14a1e28
RD
6378
6379#---------------------------------------------------------------------------
6380
34e0a3bb
RD
6381class MouseCaptureLostEvent(Event):
6382 """
6383 A mouse capture lost event is sent to a window that obtained mouse
6384 capture, which was subsequently loss due to "external" event, for
6385 example when a dialog box is shown or if another application captures
6386 the mouse.
6387
6388 If this happens, this event is sent to all windows that are on the
6389 capture stack (i.e. a window that called `wx.Window.CaptureMouse`, but
6390 didn't call `wx.Window.ReleaseMouse` yet). The event is *not* sent
6391 if the capture changes because of a call to CaptureMouse or
6392 ReleaseMouse.
6393
6394 This event is currently emitted under Windows only.
6395
6396 """
6397 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6398 __repr__ = _swig_repr
6399 def __init__(self, *args, **kwargs):
6400 """
6401 __init__(self, int winid=0) -> MouseCaptureLostEvent
6402
6403 A mouse capture lost event is sent to a window that obtained mouse
6404 capture, which was subsequently loss due to "external" event, for
6405 example when a dialog box is shown or if another application captures
6406 the mouse.
6407
6408 If this happens, this event is sent to all windows that are on the
6409 capture stack (i.e. a window that called `wx.Window.CaptureMouse`, but
6410 didn't call `wx.Window.ReleaseMouse` yet). The event is *not* sent
6411 if the capture changes because of a call to CaptureMouse or
6412 ReleaseMouse.
6413
6414 This event is currently emitted under Windows only.
6415
6416 """
6417 _core_.MouseCaptureLostEvent_swiginit(self,_core_.new_MouseCaptureLostEvent(*args, **kwargs))
6418_core_.MouseCaptureLostEvent_swigregister(MouseCaptureLostEvent)
6419
6420#---------------------------------------------------------------------------
6421
d14a1e28 6422class DisplayChangedEvent(Event):
5ba5649b
RD
6423 """
6424 An EVT_DISPLAY_CHANGED event is sent to all windows when the display
6425 resolution has changed.
6426
6427 This event is implemented under Windows only.
6428 """
0085ce49
RD
6429 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6430 __repr__ = _swig_repr
6431 def __init__(self, *args, **kwargs):
a95a7133 6432 """__init__(self) -> DisplayChangedEvent"""
0085ce49 6433 _core_.DisplayChangedEvent_swiginit(self,_core_.new_DisplayChangedEvent(*args, **kwargs))
2131d850 6434_core_.DisplayChangedEvent_swigregister(DisplayChangedEvent)
d14a1e28
RD
6435
6436#---------------------------------------------------------------------------
6437
6438class PaletteChangedEvent(Event):
5ba5649b
RD
6439 """
6440 An EVT_PALETTE_CHANGED event is sent when the system palette has
6441 changed, thereby giving each window a chance to redo their own to
6442 match.
6443
6444 This event is implemented under Windows only.
6445 """
0085ce49
RD
6446 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6447 __repr__ = _swig_repr
6448 def __init__(self, *args, **kwargs):
5ba5649b
RD
6449 """
6450 __init__(self, int id=0) -> PaletteChangedEvent
6451
6452 An EVT_PALETTE_CHANGED event is sent when the system palette has
6453 changed, thereby giving each window a chance to redo their own to
6454 match.
6455
6456 This event is implemented under Windows only.
6457 """
0085ce49 6458 _core_.PaletteChangedEvent_swiginit(self,_core_.new_PaletteChangedEvent(*args, **kwargs))
e811c8ce 6459 def SetChangedWindow(*args, **kwargs):
a95a7133 6460 """SetChangedWindow(self, Window win)"""
54f9ee45 6461 return _core_.PaletteChangedEvent_SetChangedWindow(*args, **kwargs)
e811c8ce
RD
6462
6463 def GetChangedWindow(*args, **kwargs):
a95a7133 6464 """GetChangedWindow(self) -> Window"""
54f9ee45 6465 return _core_.PaletteChangedEvent_GetChangedWindow(*args, **kwargs)
e811c8ce 6466
33d6fd3b 6467 ChangedWindow = property(GetChangedWindow,SetChangedWindow,doc="See `GetChangedWindow` and `SetChangedWindow`")
2131d850 6468_core_.PaletteChangedEvent_swigregister(PaletteChangedEvent)
d14a1e28
RD
6469
6470#---------------------------------------------------------------------------
6471
6472class QueryNewPaletteEvent(Event):
5ba5649b
RD
6473 """
6474 An EVT_QUERY_NEW_PALETE event indicates the window is getting keyboard
6475 focus and should re-do its palette.
6476
6477 This event is implemented under Windows only.
6478 """
0085ce49
RD
6479 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6480 __repr__ = _swig_repr
6481 def __init__(self, *args, **kwargs):
5ba5649b
RD
6482 """
6483 __init__(self, int winid=0) -> QueryNewPaletteEvent
6484
6485 Constructor.
6486 """
0085ce49 6487 _core_.QueryNewPaletteEvent_swiginit(self,_core_.new_QueryNewPaletteEvent(*args, **kwargs))
e811c8ce 6488 def SetPaletteRealized(*args, **kwargs):
5ba5649b
RD
6489 """
6490 SetPaletteRealized(self, bool realized)
6491
6492 App should set this if it changes the palette.
6493 """
54f9ee45 6494 return _core_.QueryNewPaletteEvent_SetPaletteRealized(*args, **kwargs)
e811c8ce
RD
6495
6496 def GetPaletteRealized(*args, **kwargs):
a95a7133 6497 """GetPaletteRealized(self) -> bool"""
54f9ee45 6498 return _core_.QueryNewPaletteEvent_GetPaletteRealized(*args, **kwargs)
e811c8ce 6499
33d6fd3b 6500 PaletteRealized = property(GetPaletteRealized,SetPaletteRealized,doc="See `GetPaletteRealized` and `SetPaletteRealized`")
2131d850 6501_core_.QueryNewPaletteEvent_swigregister(QueryNewPaletteEvent)
d14a1e28
RD
6502
6503#---------------------------------------------------------------------------
6504
6505class NavigationKeyEvent(Event):
5ba5649b
RD
6506 """
6507 EVT_NAVIGATION_KEY events are used to control moving the focus between
6508 widgets, otherwise known as tab-traversal. You woudl normally not
6509 catch navigation events in applications as there are already
6510 appropriate handlers in `wx.Dialog` and `wx.Panel`, but you may find
6511 it useful to send navigation events in certain situations to change
6512 the focus in certain ways, although it's probably easier to just call
6513 `wx.Window.Navigate`.
6514 """
0085ce49
RD
6515 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6516 __repr__ = _swig_repr
6517 def __init__(self, *args, **kwargs):
a95a7133 6518 """__init__(self) -> NavigationKeyEvent"""
0085ce49 6519 _core_.NavigationKeyEvent_swiginit(self,_core_.new_NavigationKeyEvent(*args, **kwargs))
e811c8ce 6520 def GetDirection(*args, **kwargs):
5ba5649b
RD
6521 """
6522 GetDirection(self) -> bool
6523
6524 Returns ``True`` if the direction is forward, ``False`` otherwise.
6525 """
54f9ee45 6526 return _core_.NavigationKeyEvent_GetDirection(*args, **kwargs)
e811c8ce
RD
6527
6528 def SetDirection(*args, **kwargs):
5ba5649b
RD
6529 """
6530 SetDirection(self, bool forward)
6531
6532 Specify the direction that the navigation should take. Usually the
6533 difference between using Tab and Shift-Tab.
6534 """
54f9ee45 6535 return _core_.NavigationKeyEvent_SetDirection(*args, **kwargs)
e811c8ce
RD
6536
6537 def IsWindowChange(*args, **kwargs):
5ba5649b
RD
6538 """
6539 IsWindowChange(self) -> bool
6540
6541 Returns ``True`` if window change is allowed.
6542 """
54f9ee45 6543 return _core_.NavigationKeyEvent_IsWindowChange(*args, **kwargs)
e811c8ce
RD
6544
6545 def SetWindowChange(*args, **kwargs):
5ba5649b
RD
6546 """
6547 SetWindowChange(self, bool ischange)
6548
6549 Specify if the navigation should be able to change parent windows.
6550 For example, changing notebook pages, etc. This is usually implemented
6551 by using Control-Tab.
6552 """
54f9ee45 6553 return _core_.NavigationKeyEvent_SetWindowChange(*args, **kwargs)
e811c8ce 6554
68350608 6555 def IsFromTab(*args, **kwargs):
5ba5649b
RD
6556 """
6557 IsFromTab(self) -> bool
6558
6559 Returns ``True`` if the navigation event is originated from the Tab
6560 key.
6561 """
68350608
RD
6562 return _core_.NavigationKeyEvent_IsFromTab(*args, **kwargs)
6563
6564 def SetFromTab(*args, **kwargs):
5ba5649b
RD
6565 """
6566 SetFromTab(self, bool bIs)
6567
6568 Set to true under MSW if the event was generated using the tab key.
6569 This is required for proper navogation over radio buttons.
6570 """
68350608
RD
6571 return _core_.NavigationKeyEvent_SetFromTab(*args, **kwargs)
6572
908b74cd 6573 def SetFlags(*args, **kwargs):
5ba5649b
RD
6574 """
6575 SetFlags(self, long flags)
6576
6577 Set the navigation flags to a combination of the following:
6578
6579 * wx.NavigationKeyEvent.IsBackward
6580 * wx.NavigationKeyEvent.IsForward
6581 * wx.NavigationKeyEvent.WinChange
6582 * wx.NavigationKeyEvent.FromTab
6583
6584 """
908b74cd
RD
6585 return _core_.NavigationKeyEvent_SetFlags(*args, **kwargs)
6586
e811c8ce 6587 def GetCurrentFocus(*args, **kwargs):
5ba5649b
RD
6588 """
6589 GetCurrentFocus(self) -> Window
6590
6591 Returns the child window which currenty has the focus. May be
6592 ``None``.
6593 """
54f9ee45 6594 return _core_.NavigationKeyEvent_GetCurrentFocus(*args, **kwargs)
e811c8ce
RD
6595
6596 def SetCurrentFocus(*args, **kwargs):
5ba5649b
RD
6597 """
6598 SetCurrentFocus(self, Window win)
6599
6600 Set the window that has the focus.
6601 """
54f9ee45 6602 return _core_.NavigationKeyEvent_SetCurrentFocus(*args, **kwargs)
e811c8ce 6603
b0f7404b 6604 IsBackward = _core_.NavigationKeyEvent_IsBackward
908b74cd
RD
6605 IsForward = _core_.NavigationKeyEvent_IsForward
6606 WinChange = _core_.NavigationKeyEvent_WinChange
68350608 6607 FromTab = _core_.NavigationKeyEvent_FromTab
57332a5a
RD
6608 CurrentFocus = property(GetCurrentFocus,SetCurrentFocus,doc="See `GetCurrentFocus` and `SetCurrentFocus`")
6609 Direction = property(GetDirection,SetDirection,doc="See `GetDirection` and `SetDirection`")
2131d850 6610_core_.NavigationKeyEvent_swigregister(NavigationKeyEvent)
d14a1e28
RD
6611
6612#---------------------------------------------------------------------------
6613
6614class WindowCreateEvent(CommandEvent):
5ba5649b
RD
6615 """
6616 The EVT_WINDOW_CREATE event is sent as soon as the window object (the
6617 underlying GUI object) exists.
6618 """
0085ce49
RD
6619 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6620 __repr__ = _swig_repr
6621 def __init__(self, *args, **kwargs):
5ba5649b
RD
6622 """
6623 __init__(self, Window win=None) -> WindowCreateEvent
6624
6625 The EVT_WINDOW_CREATE event is sent as soon as the window object (the
6626 underlying GUI object) exists.
6627 """
0085ce49 6628 _core_.WindowCreateEvent_swiginit(self,_core_.new_WindowCreateEvent(*args, **kwargs))
e811c8ce 6629 def GetWindow(*args, **kwargs):
5ba5649b
RD
6630 """
6631 GetWindow(self) -> Window
6632
6633 Returns the window that this event refers to.
6634 """
54f9ee45 6635 return _core_.WindowCreateEvent_GetWindow(*args, **kwargs)
e811c8ce 6636
dba7934c 6637 Window = property(GetWindow,doc="See `GetWindow`")
2131d850 6638_core_.WindowCreateEvent_swigregister(WindowCreateEvent)
d14a1e28
RD
6639
6640class WindowDestroyEvent(CommandEvent):
5ba5649b 6641 """
943e8dfd
RD
6642 The EVT_WINDOW_DESTROY event is sent from the `wx.Window` destructor
6643 when the GUI window is destroyed.
6644
6645 When a class derived from `wx.Window` is destroyed its destructor will
6646 have already run by the time this event is sent. Therefore this event
6647 will not usually be received at all by the window itself. Since it is
6648 received after the destructor has run, an object should not try to
6649 handle its own wx.WindowDestroyEvent, but it can be used to get
6650 notification of the destruction of another window.
5ba5649b 6651 """
0085ce49
RD
6652 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6653 __repr__ = _swig_repr
6654 def __init__(self, *args, **kwargs):
5ba5649b
RD
6655 """
6656 __init__(self, Window win=None) -> WindowDestroyEvent
6657
943e8dfd
RD
6658 The EVT_WINDOW_DESTROY event is sent from the `wx.Window` destructor
6659 when the GUI window is destroyed.
6660
6661 When a class derived from `wx.Window` is destroyed its destructor will
6662 have already run by the time this event is sent. Therefore this event
6663 will not usually be received at all by the window itself. Since it is
6664 received after the destructor has run, an object should not try to
6665 handle its own wx.WindowDestroyEvent, but it can be used to get
6666 notification of the destruction of another window.
5ba5649b 6667 """
0085ce49 6668 _core_.WindowDestroyEvent_swiginit(self,_core_.new_WindowDestroyEvent(*args, **kwargs))
e811c8ce 6669 def GetWindow(*args, **kwargs):
5ba5649b
RD
6670 """
6671 GetWindow(self) -> Window
6672
6673 Returns the window that this event refers to.
6674 """
54f9ee45 6675 return _core_.WindowDestroyEvent_GetWindow(*args, **kwargs)
e811c8ce 6676
dba7934c 6677 Window = property(GetWindow,doc="See `GetWindow`")
2131d850 6678_core_.WindowDestroyEvent_swigregister(WindowDestroyEvent)
d14a1e28
RD
6679
6680#---------------------------------------------------------------------------
6681
6682class ContextMenuEvent(CommandEvent):
5ba5649b
RD
6683 """
6684 This class is used for context menu events (EVT_CONTECT_MENU,) sent to
6685 give the application a chance to show a context (popup) menu.
6686 """
0085ce49
RD
6687 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6688 __repr__ = _swig_repr
6689 def __init__(self, *args, **kwargs):
5ba5649b 6690 """
2131d850 6691 __init__(self, EventType type=wxEVT_NULL, int winid=0, Point pt=DefaultPosition) -> ContextMenuEvent
5ba5649b
RD
6692
6693 Constructor.
6694 """
0085ce49 6695 _core_.ContextMenuEvent_swiginit(self,_core_.new_ContextMenuEvent(*args, **kwargs))
e811c8ce 6696 def GetPosition(*args, **kwargs):
5ba5649b
RD
6697 """
6698 GetPosition(self) -> Point
6699
6700 Returns the position (in screen coordinants) at which the menu should
6701 be shown.
6702 """
54f9ee45 6703 return _core_.ContextMenuEvent_GetPosition(*args, **kwargs)
e811c8ce
RD
6704
6705 def SetPosition(*args, **kwargs):
5ba5649b
RD
6706 """
6707 SetPosition(self, Point pos)
6708
6709 Sets the position at which the menu should be shown.
6710 """
54f9ee45 6711 return _core_.ContextMenuEvent_SetPosition(*args, **kwargs)
e811c8ce 6712
2bf58437 6713 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
2131d850 6714_core_.ContextMenuEvent_swigregister(ContextMenuEvent)
d14a1e28
RD
6715
6716#---------------------------------------------------------------------------
6717
54f9ee45
RD
6718IDLE_PROCESS_ALL = _core_.IDLE_PROCESS_ALL
6719IDLE_PROCESS_SPECIFIED = _core_.IDLE_PROCESS_SPECIFIED
d14a1e28 6720class IdleEvent(Event):
5ba5649b
RD
6721 """
6722 This class is used for EVT_IDLE events, which are generated and sent
6723 when the application *becomes* idle. In other words, the when the
6724 event queue becomes empty then idle events are sent to all windows (by
6725 default) and as long as none of them call `RequestMore` then there are
6726 no more idle events until after the system event queue has some normal
6727 events and then becomes empty again.
6728
6729 By default, idle events are sent to all windows. If this is causing a
6730 significant overhead in your application, you can call
6731 `wx.IdleEvent.SetMode` with the value wx.IDLE_PROCESS_SPECIFIED, and
6732 set the wx.WS_EX_PROCESS_IDLE extra window style for every window
6733 which should receive idle events. Then idle events will only be sent
6734 to those windows and not to any others.
6735 """
0085ce49
RD
6736 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6737 __repr__ = _swig_repr
6738 def __init__(self, *args, **kwargs):
5ba5649b
RD
6739 """
6740 __init__(self) -> IdleEvent
6741
6742 Constructor
6743 """
0085ce49 6744 _core_.IdleEvent_swiginit(self,_core_.new_IdleEvent(*args, **kwargs))
e811c8ce 6745 def RequestMore(*args, **kwargs):
5ba5649b
RD
6746 """
6747 RequestMore(self, bool needMore=True)
6748
6749 Tells wxWidgets that more processing is required. This function can be
6750 called by an EVT_IDLE handler for a window to indicate that the
6751 application should forward the EVT_IDLE event once more to the
6752 application windows. If no window calls this function during its
6753 EVT_IDLE handler, then the application will remain in a passive event
6754 loop until a new event is posted to the application by the windowing
6755 system.
6756 """
54f9ee45 6757 return _core_.IdleEvent_RequestMore(*args, **kwargs)
e811c8ce
RD
6758
6759 def MoreRequested(*args, **kwargs):
5ba5649b
RD
6760 """
6761 MoreRequested(self) -> bool
6762
6763 Returns ``True`` if the OnIdle function processing this event
6764 requested more processing time.
6765 """
54f9ee45 6766 return _core_.IdleEvent_MoreRequested(*args, **kwargs)
e811c8ce
RD
6767
6768 def SetMode(*args, **kwargs):
5ba5649b
RD
6769 """
6770 SetMode(int mode)
6771
6772 Static method for specifying how wxWidgets will send idle events: to
6773 all windows, or only to those which specify that they will process the
6774 events.
6775
6776 The mode can be one of the following values:
6777
6778 ========================= ========================================
6779 wx.IDLE_PROCESS_ALL Send idle events to all windows
6780 wx.IDLE_PROCESS_SPECIFIED Send idle events only to windows that have
6781 the wx.WS_EX_PROCESS_IDLE extra style
6782 flag set.
6783 ========================= ========================================
6784
6785 """
54f9ee45 6786 return _core_.IdleEvent_SetMode(*args, **kwargs)
e811c8ce
RD
6787
6788 SetMode = staticmethod(SetMode)
6789 def GetMode(*args, **kwargs):
5ba5649b
RD
6790 """
6791 GetMode() -> int
6792
6793 Static method returning a value specifying how wxWidgets will send
6794 idle events: to all windows, or only to those which specify that they
6795 will process the events.
6796 """
54f9ee45 6797 return _core_.IdleEvent_GetMode(*args, **kwargs)
e811c8ce
RD
6798
6799 GetMode = staticmethod(GetMode)
6800 def CanSend(*args, **kwargs):
5ba5649b
RD
6801 """
6802 CanSend(Window win) -> bool
6803
6804 Returns ``True`` if it is appropriate to send idle events to this
6805 window.
6806
6807 This function looks at the mode used (see `wx.IdleEvent.SetMode`), and
6808 the wx.WS_EX_PROCESS_IDLE style in window to determine whether idle
6809 events should be sent to this window now. By default this will always
6810 return ``True`` because the update mode is initially
6811 wx.IDLE_PROCESS_ALL. You can change the mode to only send idle events
6812 to windows with the wx.WS_EX_PROCESS_IDLE extra window style set.
6813 """
54f9ee45 6814 return _core_.IdleEvent_CanSend(*args, **kwargs)
e811c8ce
RD
6815
6816 CanSend = staticmethod(CanSend)
2131d850 6817_core_.IdleEvent_swigregister(IdleEvent)
d14a1e28 6818
e811c8ce 6819def IdleEvent_SetMode(*args, **kwargs):
0085ce49 6820 """
5ba5649b
RD
6821 IdleEvent_SetMode(int mode)
6822
6823 Static method for specifying how wxWidgets will send idle events: to
6824 all windows, or only to those which specify that they will process the
6825 events.
6826
6827 The mode can be one of the following values:
6828
6829 ========================= ========================================
6830 wx.IDLE_PROCESS_ALL Send idle events to all windows
6831 wx.IDLE_PROCESS_SPECIFIED Send idle events only to windows that have
6832 the wx.WS_EX_PROCESS_IDLE extra style
6833 flag set.
6834 ========================= ========================================
6835
6836 """
0085ce49 6837 return _core_.IdleEvent_SetMode(*args, **kwargs)
d14a1e28 6838
0085ce49
RD
6839def IdleEvent_GetMode(*args):
6840 """
5ba5649b
RD
6841 IdleEvent_GetMode() -> int
6842
6843 Static method returning a value specifying how wxWidgets will send
6844 idle events: to all windows, or only to those which specify that they
6845 will process the events.
6846 """
0085ce49 6847 return _core_.IdleEvent_GetMode(*args)
d14a1e28 6848
e811c8ce 6849def IdleEvent_CanSend(*args, **kwargs):
0085ce49 6850 """
5ba5649b
RD
6851 IdleEvent_CanSend(Window win) -> bool
6852
6853 Returns ``True`` if it is appropriate to send idle events to this
6854 window.
6855
6856 This function looks at the mode used (see `wx.IdleEvent.SetMode`), and
6857 the wx.WS_EX_PROCESS_IDLE style in window to determine whether idle
6858 events should be sent to this window now. By default this will always
6859 return ``True`` because the update mode is initially
6860 wx.IDLE_PROCESS_ALL. You can change the mode to only send idle events
6861 to windows with the wx.WS_EX_PROCESS_IDLE extra window style set.
6862 """
0085ce49 6863 return _core_.IdleEvent_CanSend(*args, **kwargs)
d14a1e28
RD
6864
6865#---------------------------------------------------------------------------
6866
2131d850
RD
6867class ClipboardTextEvent(CommandEvent):
6868 """
6869 A Clipboard Text event is sent when a window intercepts a text
6870 copy/cut/paste message, i.e. the user has cut/copied/pasted data
6871 from/into a text control via ctrl-C/X/V, ctrl/shift-del/insert, a
6872 popup menu command, etc. NOTE : under windows these events are *NOT*
6873 generated automatically for a Rich Edit text control.
6874 """
6875 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6876 __repr__ = _swig_repr
6877 def __init__(self, *args, **kwargs):
6878 """
6879 __init__(self, EventType type=wxEVT_NULL, int winid=0) -> ClipboardTextEvent
6880
6881 A Clipboard Text event is sent when a window intercepts a text
6882 copy/cut/paste message, i.e. the user has cut/copied/pasted data
6883 from/into a text control via ctrl-C/X/V, ctrl/shift-del/insert, a
6884 popup menu command, etc. NOTE : under windows these events are *NOT*
6885 generated automatically for a Rich Edit text control.
6886 """
6887 _core_.ClipboardTextEvent_swiginit(self,_core_.new_ClipboardTextEvent(*args, **kwargs))
6888_core_.ClipboardTextEvent_swigregister(ClipboardTextEvent)
6889
6890#---------------------------------------------------------------------------
6891
d14a1e28 6892class PyEvent(Event):
5ba5649b
RD
6893 """
6894 wx.PyEvent can be used as a base class for implementing custom event
6895 types in Python. You should derived from this class instead of
6896 `wx.Event` because this class is Python-aware and is able to transport
6897 its Python bits safely through the wxWidgets event system and have
6898 them still be there when the event handler is invoked.
6899
6900 :see: `wx.PyCommandEvent`
6901
6902 """
0085ce49
RD
6903 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6904 __repr__ = _swig_repr
6905 def __init__(self, *args, **kwargs):
2131d850 6906 """__init__(self, int winid=0, EventType eventType=wxEVT_NULL) -> PyEvent"""
0085ce49 6907 _core_.PyEvent_swiginit(self,_core_.new_PyEvent(*args, **kwargs))
5ba5649b 6908 self._SetSelf(self)
e811c8ce 6909
0085ce49
RD
6910 __swig_destroy__ = _core_.delete_PyEvent
6911 __del__ = lambda self : None;
5ba5649b
RD
6912 def _SetSelf(*args, **kwargs):
6913 """_SetSelf(self, PyObject self)"""
6914 return _core_.PyEvent__SetSelf(*args, **kwargs)
e811c8ce 6915
5ba5649b
RD
6916 def _GetSelf(*args, **kwargs):
6917 """_GetSelf(self) -> PyObject"""
6918 return _core_.PyEvent__GetSelf(*args, **kwargs)
e811c8ce 6919
2131d850 6920_core_.PyEvent_swigregister(PyEvent)
d14a1e28
RD
6921
6922class PyCommandEvent(CommandEvent):
5ba5649b
RD
6923 """
6924 wx.PyCommandEvent can be used as a base class for implementing custom
6925 event types in Python, where the event shoudl travel up to parent
6926 windows looking for a handler. You should derived from this class
6927 instead of `wx.CommandEvent` because this class is Python-aware and is
6928 able to transport its Python bits safely through the wxWidgets event
6929 system and have them still be there when the event handler is invoked.
6930
6931 :see: `wx.PyEvent`
6932
6933 """
0085ce49
RD
6934 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6935 __repr__ = _swig_repr
6936 def __init__(self, *args, **kwargs):
2131d850 6937 """__init__(self, EventType eventType=wxEVT_NULL, int id=0) -> PyCommandEvent"""
0085ce49 6938 _core_.PyCommandEvent_swiginit(self,_core_.new_PyCommandEvent(*args, **kwargs))
5ba5649b 6939 self._SetSelf(self)
e811c8ce 6940
0085ce49
RD
6941 __swig_destroy__ = _core_.delete_PyCommandEvent
6942 __del__ = lambda self : None;
5ba5649b
RD
6943 def _SetSelf(*args, **kwargs):
6944 """_SetSelf(self, PyObject self)"""
6945 return _core_.PyCommandEvent__SetSelf(*args, **kwargs)
e811c8ce 6946
5ba5649b
RD
6947 def _GetSelf(*args, **kwargs):
6948 """_GetSelf(self) -> PyObject"""
6949 return _core_.PyCommandEvent__GetSelf(*args, **kwargs)
e811c8ce 6950
2131d850 6951_core_.PyCommandEvent_swigregister(PyCommandEvent)
d14a1e28 6952
53aa7709 6953class DateEvent(CommandEvent):
5ba5649b
RD
6954 """
6955 This event class holds information about a date change event and is
6956 used together with `wx.DatePickerCtrl`. It also serves as a base class
6957 for `wx.calendar.CalendarEvent`. Bind these event types with
6958 EVT_DATE_CHANGED.
6959 """
0085ce49
RD
6960 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6961 __repr__ = _swig_repr
6962 def __init__(self, *args, **kwargs):
2131d850 6963 """__init__(self, Window win, DateTime dt, EventType type) -> DateEvent"""
0085ce49 6964 _core_.DateEvent_swiginit(self,_core_.new_DateEvent(*args, **kwargs))
53aa7709 6965 def GetDate(*args, **kwargs):
5ba5649b
RD
6966 """
6967 GetDate(self) -> DateTime
6968
6969 Returns the date.
6970 """
53aa7709
RD
6971 return _core_.DateEvent_GetDate(*args, **kwargs)
6972
6973 def SetDate(*args, **kwargs):
5ba5649b
RD
6974 """
6975 SetDate(self, DateTime date)
6976
6977 Sets the date carried by the event, normally only used by the library
6978 internally.
6979 """
53aa7709
RD
6980 return _core_.DateEvent_SetDate(*args, **kwargs)
6981
2bf58437 6982 Date = property(GetDate,SetDate,doc="See `GetDate` and `SetDate`")
2131d850 6983_core_.DateEvent_swigregister(DateEvent)
53aa7709
RD
6984
6985wxEVT_DATE_CHANGED = _core_.wxEVT_DATE_CHANGED
6986EVT_DATE_CHANGED = wx.PyEventBinder( wxEVT_DATE_CHANGED, 1 )
6987
d14a1e28
RD
6988#---------------------------------------------------------------------------
6989
54f9ee45
RD
6990PYAPP_ASSERT_SUPPRESS = _core_.PYAPP_ASSERT_SUPPRESS
6991PYAPP_ASSERT_EXCEPTION = _core_.PYAPP_ASSERT_EXCEPTION
6992PYAPP_ASSERT_DIALOG = _core_.PYAPP_ASSERT_DIALOG
6993PYAPP_ASSERT_LOG = _core_.PYAPP_ASSERT_LOG
6994PRINT_WINDOWS = _core_.PRINT_WINDOWS
6995PRINT_POSTSCRIPT = _core_.PRINT_POSTSCRIPT
d14a1e28 6996class PyApp(EvtHandler):
66c033b4
RD
6997 """
6998 The ``wx.PyApp`` class is an *implementation detail*, please use the
6999 `wx.App` class (or some other derived class) instead.
7000 """
0085ce49
RD
7001 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7002 __repr__ = _swig_repr
7003 def __init__(self, *args, **kwargs):
98e665d3 7004 """
a95a7133 7005 __init__(self) -> PyApp
98e665d3
RD
7006
7007 Create a new application object, starting the bootstrap process.
7008 """
0085ce49 7009 _core_.PyApp_swiginit(self,_core_.new_PyApp(*args, **kwargs))
c25f90f6 7010 self._setOORInfo(self, False);PyApp._setCallbackInfo(self, self, PyApp)
e811c8ce 7011
0085ce49
RD
7012 __swig_destroy__ = _core_.delete_PyApp
7013 __del__ = lambda self : None;
e811c8ce 7014 def _setCallbackInfo(*args, **kwargs):
c25f90f6 7015 """_setCallbackInfo(self, PyObject self, PyObject _class, bool incref=False)"""
54f9ee45 7016 return _core_.PyApp__setCallbackInfo(*args, **kwargs)
e811c8ce
RD
7017
7018 def GetAppName(*args, **kwargs):
0df68c9f 7019 """
a95a7133 7020 GetAppName(self) -> String
6c3b4aae 7021
0df68c9f
RD
7022 Get the application name.
7023 """
54f9ee45 7024 return _core_.PyApp_GetAppName(*args, **kwargs)
e811c8ce
RD
7025
7026 def SetAppName(*args, **kwargs):
0df68c9f 7027 """
a95a7133 7028 SetAppName(self, String name)
6c3b4aae 7029
66c033b4
RD
7030 Set the application name. This value may be used automatically by
7031 `wx.Config` and such.
0df68c9f 7032 """
54f9ee45 7033 return _core_.PyApp_SetAppName(*args, **kwargs)
e811c8ce
RD
7034
7035 def GetClassName(*args, **kwargs):
0df68c9f 7036 """
a95a7133 7037 GetClassName(self) -> String
e811c8ce 7038
0df68c9f
RD
7039 Get the application's class name.
7040 """
54f9ee45 7041 return _core_.PyApp_GetClassName(*args, **kwargs)
e811c8ce
RD
7042
7043 def SetClassName(*args, **kwargs):
0df68c9f 7044 """
a95a7133 7045 SetClassName(self, String name)
6c3b4aae 7046
66c033b4
RD
7047 Set the application's class name. This value may be used for
7048 X-resources if applicable for the platform
0df68c9f 7049 """
54f9ee45 7050 return _core_.PyApp_SetClassName(*args, **kwargs)
e811c8ce
RD
7051
7052 def GetVendorName(*args, **kwargs):
0df68c9f 7053 """
a95a7133 7054 GetVendorName(self) -> String
6c3b4aae 7055
0df68c9f
RD
7056 Get the application's vendor name.
7057 """
54f9ee45 7058 return _core_.PyApp_GetVendorName(*args, **kwargs)
e811c8ce
RD
7059
7060 def SetVendorName(*args, **kwargs):
0df68c9f 7061 """
a95a7133 7062 SetVendorName(self, String name)
6c3b4aae 7063
66c033b4
RD
7064 Set the application's vendor name. This value may be used
7065 automatically by `wx.Config` and such.
0df68c9f 7066 """
54f9ee45 7067 return _core_.PyApp_SetVendorName(*args, **kwargs)
e811c8ce
RD
7068
7069 def GetTraits(*args, **kwargs):
0df68c9f 7070 """
a95a7133 7071 GetTraits(self) -> wxAppTraits
6c3b4aae 7072
66c033b4
RD
7073 Return (and create if necessary) the app traits object to which we
7074 delegate for everything which either should be configurable by the
7075 user (then he can change the default behaviour simply by overriding
7076 CreateTraits() and returning his own traits object) or which is
7077 GUI/console dependent as then wx.AppTraits allows us to abstract the
7078 differences behind the common facade.
7079
7080 :todo: Add support for overriding CreateAppTraits in wxPython.
0df68c9f 7081 """
54f9ee45 7082 return _core_.PyApp_GetTraits(*args, **kwargs)
e811c8ce
RD
7083
7084 def ProcessPendingEvents(*args, **kwargs):
0df68c9f 7085 """
a95a7133 7086 ProcessPendingEvents(self)
6c3b4aae 7087
66c033b4
RD
7088 Process all events in the Pending Events list -- it is necessary to
7089 call this function to process posted events. This normally happens
7090 during each event loop iteration.
0df68c9f 7091 """
54f9ee45 7092 return _core_.PyApp_ProcessPendingEvents(*args, **kwargs)
e811c8ce
RD
7093
7094 def Yield(*args, **kwargs):
0df68c9f 7095 """
a95a7133 7096 Yield(self, bool onlyIfNeeded=False) -> bool
6c3b4aae 7097
66c033b4
RD
7098 Process all currently pending events right now, instead of waiting
7099 until return to the event loop. It is an error to call ``Yield``
7100 recursively unless the value of ``onlyIfNeeded`` is True.
6c3b4aae 7101
66c033b4 7102 :warning: This function is dangerous as it can lead to unexpected
41e2b43e
RD
7103 reentrancies (i.e. when called from an event handler it may
7104 result in calling the same event handler again), use with
7105 extreme care or, better, don't use at all!
0df68c9f 7106
66c033b4 7107 :see: `wx.Yield`, `wx.YieldIfNeeded`, `wx.SafeYield`
41e2b43e 7108
0df68c9f 7109 """
54f9ee45 7110 return _core_.PyApp_Yield(*args, **kwargs)
e811c8ce
RD
7111
7112 def WakeUpIdle(*args, **kwargs):
0df68c9f 7113 """
a95a7133 7114 WakeUpIdle(self)
6c3b4aae 7115
66c033b4
RD
7116 Make sure that idle events are sent again.
7117 :see: `wx.WakeUpIdle`
0df68c9f 7118 """
54f9ee45 7119 return _core_.PyApp_WakeUpIdle(*args, **kwargs)
e811c8ce 7120
1fc3b23a
RD
7121 def IsMainLoopRunning(*args, **kwargs):
7122 """
7123 IsMainLoopRunning() -> bool
7124
7125 Returns True if we're running the main loop, i.e. if the events can
7126 currently be dispatched.
7127 """
7128 return _core_.PyApp_IsMainLoopRunning(*args, **kwargs)
7129
7130 IsMainLoopRunning = staticmethod(IsMainLoopRunning)
e811c8ce 7131 def MainLoop(*args, **kwargs):
0df68c9f 7132 """
a95a7133 7133 MainLoop(self) -> int
6c3b4aae 7134
66c033b4
RD
7135 Execute the main GUI loop, the function doesn't normally return until
7136 all top level windows have been closed and destroyed.
0df68c9f 7137 """
54f9ee45 7138 return _core_.PyApp_MainLoop(*args, **kwargs)
e811c8ce
RD
7139
7140 def Exit(*args, **kwargs):
0df68c9f 7141 """
a95a7133 7142 Exit(self)
6c3b4aae 7143
0df68c9f 7144 Exit the main loop thus terminating the application.
66c033b4 7145 :see: `wx.Exit`
0df68c9f 7146 """
54f9ee45 7147 return _core_.PyApp_Exit(*args, **kwargs)
e811c8ce 7148
97ab0f6a
RD
7149 def GetLayoutDirection(*args, **kwargs):
7150 """
994453b8 7151 GetLayoutDirection(self) -> int
97ab0f6a
RD
7152
7153 Return the layout direction for the current locale.
7154 """
7155 return _core_.PyApp_GetLayoutDirection(*args, **kwargs)
7156
e811c8ce 7157 def ExitMainLoop(*args, **kwargs):
0df68c9f 7158 """
a95a7133 7159 ExitMainLoop(self)
6c3b4aae 7160
66c033b4
RD
7161 Exit the main GUI loop during the next iteration of the main
7162 loop, (i.e. it does not stop the program immediately!)
0df68c9f 7163 """
54f9ee45 7164 return _core_.PyApp_ExitMainLoop(*args, **kwargs)
e811c8ce
RD
7165
7166 def Pending(*args, **kwargs):
0df68c9f 7167 """
a95a7133 7168 Pending(self) -> bool
6c3b4aae 7169
0df68c9f
RD
7170 Returns True if there are unprocessed events in the event queue.
7171 """
54f9ee45 7172 return _core_.PyApp_Pending(*args, **kwargs)
e811c8ce
RD
7173
7174 def Dispatch(*args, **kwargs):
0df68c9f 7175 """
a95a7133 7176 Dispatch(self) -> bool
6c3b4aae 7177
0df68c9f
RD
7178 Process the first event in the event queue (blocks until an event
7179 appears if there are none currently)
7180 """
54f9ee45 7181 return _core_.PyApp_Dispatch(*args, **kwargs)
e811c8ce
RD
7182
7183 def ProcessIdle(*args, **kwargs):
0df68c9f 7184 """
a95a7133 7185 ProcessIdle(self) -> bool
6c3b4aae 7186
66c033b4
RD
7187 Called from the MainLoop when the application becomes idle (there are
7188 no pending events) and sends a `wx.IdleEvent` to all interested
7189 parties. Returns True if more idle events are needed, False if not.
0df68c9f 7190 """
54f9ee45 7191 return _core_.PyApp_ProcessIdle(*args, **kwargs)
e811c8ce
RD
7192
7193 def SendIdleEvents(*args, **kwargs):
0df68c9f 7194 """
a95a7133 7195 SendIdleEvents(self, Window win, IdleEvent event) -> bool
e811c8ce 7196
66c033b4
RD
7197 Send idle event to window and all subwindows. Returns True if more
7198 idle time is requested.
0df68c9f 7199 """
54f9ee45 7200 return _core_.PyApp_SendIdleEvents(*args, **kwargs)
e811c8ce
RD
7201
7202 def IsActive(*args, **kwargs):
0df68c9f 7203 """
a95a7133 7204 IsActive(self) -> bool
6c3b4aae 7205
0df68c9f
RD
7206 Return True if our app has focus.
7207 """
54f9ee45 7208 return _core_.PyApp_IsActive(*args, **kwargs)
e811c8ce
RD
7209
7210 def SetTopWindow(*args, **kwargs):
0df68c9f 7211 """
a95a7133 7212 SetTopWindow(self, Window win)
6c3b4aae 7213
66c033b4 7214 Set the *main* top level window
0df68c9f 7215 """
54f9ee45 7216 return _core_.PyApp_SetTopWindow(*args, **kwargs)
e811c8ce
RD
7217
7218 def GetTopWindow(*args, **kwargs):
0df68c9f 7219 """
a95a7133 7220 GetTopWindow(self) -> Window
6c3b4aae 7221
66c033b4
RD
7222 Return the *main* top level window (if it hadn't been set previously
7223 with SetTopWindow(), will return just some top level window and, if
7224 there not any, will return None)
0df68c9f 7225 """
54f9ee45 7226 return _core_.PyApp_GetTopWindow(*args, **kwargs)
e811c8ce
RD
7227
7228 def SetExitOnFrameDelete(*args, **kwargs):
0df68c9f 7229 """
a95a7133 7230 SetExitOnFrameDelete(self, bool flag)
0df68c9f 7231
66c033b4
RD
7232 Control the exit behaviour: by default, the program will exit the main
7233 loop (and so, usually, terminate) when the last top-level program
7234 window is deleted. Beware that if you disable this behaviour (with
7235 SetExitOnFrameDelete(False)), you'll have to call ExitMainLoop()
7236 explicitly from somewhere.
0df68c9f 7237 """
54f9ee45 7238 return _core_.PyApp_SetExitOnFrameDelete(*args, **kwargs)
e811c8ce
RD
7239
7240 def GetExitOnFrameDelete(*args, **kwargs):
0df68c9f 7241 """
a95a7133 7242 GetExitOnFrameDelete(self) -> bool
6c3b4aae 7243
0df68c9f
RD
7244 Get the current exit behaviour setting.
7245 """
54f9ee45 7246 return _core_.PyApp_GetExitOnFrameDelete(*args, **kwargs)
e811c8ce
RD
7247
7248 def SetUseBestVisual(*args, **kwargs):
0df68c9f 7249 """
eccab1a7 7250 SetUseBestVisual(self, bool flag, bool forceTrueColour=False)
6c3b4aae 7251
66c033b4
RD
7252 Set whether the app should try to use the best available visual on
7253 systems where more than one is available, (Sun, SGI, XFree86 4, etc.)
0df68c9f 7254 """
54f9ee45 7255 return _core_.PyApp_SetUseBestVisual(*args, **kwargs)
e811c8ce
RD
7256
7257 def GetUseBestVisual(*args, **kwargs):
0df68c9f 7258 """
a95a7133 7259 GetUseBestVisual(self) -> bool
6c3b4aae 7260
0df68c9f
RD
7261 Get current UseBestVisual setting.
7262 """
54f9ee45 7263 return _core_.PyApp_GetUseBestVisual(*args, **kwargs)
e811c8ce
RD
7264
7265 def SetPrintMode(*args, **kwargs):
a95a7133 7266 """SetPrintMode(self, int mode)"""
54f9ee45 7267 return _core_.PyApp_SetPrintMode(*args, **kwargs)
e811c8ce
RD
7268
7269 def GetPrintMode(*args, **kwargs):
a95a7133 7270 """GetPrintMode(self) -> int"""
54f9ee45 7271 return _core_.PyApp_GetPrintMode(*args, **kwargs)
e811c8ce 7272
e811c8ce 7273 def SetAssertMode(*args, **kwargs):
0df68c9f 7274 """
a95a7133 7275 SetAssertMode(self, int mode)
6c3b4aae 7276
41e2b43e 7277 Set the OnAssert behaviour for debug and hybrid builds.
0df68c9f 7278 """
54f9ee45 7279 return _core_.PyApp_SetAssertMode(*args, **kwargs)
e811c8ce 7280
6c3b4aae 7281 def GetAssertMode(*args, **kwargs):
0df68c9f 7282 """
a95a7133 7283 GetAssertMode(self) -> int
6c3b4aae 7284
0df68c9f
RD
7285 Get the current OnAssert behaviour setting.
7286 """
54f9ee45 7287 return _core_.PyApp_GetAssertMode(*args, **kwargs)
6c3b4aae 7288
e811c8ce 7289 def GetMacSupportPCMenuShortcuts(*args, **kwargs):
66c033b4 7290 """GetMacSupportPCMenuShortcuts() -> bool"""
54f9ee45 7291 return _core_.PyApp_GetMacSupportPCMenuShortcuts(*args, **kwargs)
e811c8ce
RD
7292
7293 GetMacSupportPCMenuShortcuts = staticmethod(GetMacSupportPCMenuShortcuts)
7294 def GetMacAboutMenuItemId(*args, **kwargs):
66c033b4 7295 """GetMacAboutMenuItemId() -> long"""
54f9ee45 7296 return _core_.PyApp_GetMacAboutMenuItemId(*args, **kwargs)
e811c8ce
RD
7297
7298 GetMacAboutMenuItemId = staticmethod(GetMacAboutMenuItemId)
7299 def GetMacPreferencesMenuItemId(*args, **kwargs):
66c033b4 7300 """GetMacPreferencesMenuItemId() -> long"""
54f9ee45 7301 return _core_.PyApp_GetMacPreferencesMenuItemId(*args, **kwargs)
e811c8ce
RD
7302
7303 GetMacPreferencesMenuItemId = staticmethod(GetMacPreferencesMenuItemId)
7304 def GetMacExitMenuItemId(*args, **kwargs):
66c033b4 7305 """GetMacExitMenuItemId() -> long"""
54f9ee45 7306 return _core_.PyApp_GetMacExitMenuItemId(*args, **kwargs)
e811c8ce
RD
7307
7308 GetMacExitMenuItemId = staticmethod(GetMacExitMenuItemId)
7309 def GetMacHelpMenuTitleName(*args, **kwargs):
66c033b4 7310 """GetMacHelpMenuTitleName() -> String"""
54f9ee45 7311 return _core_.PyApp_GetMacHelpMenuTitleName(*args, **kwargs)
e811c8ce
RD
7312
7313 GetMacHelpMenuTitleName = staticmethod(GetMacHelpMenuTitleName)
7314 def SetMacSupportPCMenuShortcuts(*args, **kwargs):
66c033b4 7315 """SetMacSupportPCMenuShortcuts(bool val)"""
54f9ee45 7316 return _core_.PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs)
e811c8ce
RD
7317
7318 SetMacSupportPCMenuShortcuts = staticmethod(SetMacSupportPCMenuShortcuts)
7319 def SetMacAboutMenuItemId(*args, **kwargs):
66c033b4 7320 """SetMacAboutMenuItemId(long val)"""
54f9ee45 7321 return _core_.PyApp_SetMacAboutMenuItemId(*args, **kwargs)
e811c8ce
RD
7322
7323 SetMacAboutMenuItemId = staticmethod(SetMacAboutMenuItemId)
7324 def SetMacPreferencesMenuItemId(*args, **kwargs):
66c033b4 7325 """SetMacPreferencesMenuItemId(long val)"""
54f9ee45 7326 return _core_.PyApp_SetMacPreferencesMenuItemId(*args, **kwargs)
e811c8ce
RD
7327
7328 SetMacPreferencesMenuItemId = staticmethod(SetMacPreferencesMenuItemId)
7329 def SetMacExitMenuItemId(*args, **kwargs):
66c033b4 7330 """SetMacExitMenuItemId(long val)"""
54f9ee45 7331 return _core_.PyApp_SetMacExitMenuItemId(*args, **kwargs)
e811c8ce
RD
7332
7333 SetMacExitMenuItemId = staticmethod(SetMacExitMenuItemId)
7334 def SetMacHelpMenuTitleName(*args, **kwargs):
66c033b4 7335 """SetMacHelpMenuTitleName(String val)"""
54f9ee45 7336 return _core_.PyApp_SetMacHelpMenuTitleName(*args, **kwargs)
e811c8ce
RD
7337
7338 SetMacHelpMenuTitleName = staticmethod(SetMacHelpMenuTitleName)
7339 def _BootstrapApp(*args, **kwargs):
0df68c9f 7340 """
a95a7133 7341 _BootstrapApp(self)
6c3b4aae 7342
0df68c9f
RD
7343 For internal use only
7344 """
54f9ee45 7345 return _core_.PyApp__BootstrapApp(*args, **kwargs)
e811c8ce
RD
7346
7347 def GetComCtl32Version(*args, **kwargs):
0df68c9f 7348 """
66c033b4 7349 GetComCtl32Version() -> int
6c3b4aae 7350
66c033b4
RD
7351 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
7352 it wasn't found at all. Raises an exception on non-Windows platforms.
0df68c9f 7353 """
54f9ee45 7354 return _core_.PyApp_GetComCtl32Version(*args, **kwargs)
e811c8ce
RD
7355
7356 GetComCtl32Version = staticmethod(GetComCtl32Version)
33d6fd3b 7357 def IsDisplayAvailable(*args, **kwargs):
fc46b7f3 7358 """
33d6fd3b 7359 IsDisplayAvailable() -> bool
fc46b7f3
RD
7360
7361 Tests if it is possible to create a GUI in the current environment.
7362 This will mean different things on the different platforms.
7363
7364 * On X Windows systems this function will return ``False`` if it is
7365 not able to open a connection to the X display, which can happen
7366 if $DISPLAY is not set, or is not set correctly.
7367
7368 * On Mac OS X a ``False`` return value will mean that wx is not
7369 able to access the window manager, which can happen if logged in
7370 remotely or if running from the normal version of python instead
7371 of the framework version, (i.e., pythonw.)
7372
7373 * On MS Windows...
7374
7375 """
33d6fd3b
RD
7376 return _core_.PyApp_IsDisplayAvailable(*args, **kwargs)
7377
7378 IsDisplayAvailable = staticmethod(IsDisplayAvailable)
7379 AppName = property(GetAppName,SetAppName,doc="See `GetAppName` and `SetAppName`")
7380 AssertMode = property(GetAssertMode,SetAssertMode,doc="See `GetAssertMode` and `SetAssertMode`")
7381 ClassName = property(GetClassName,SetClassName,doc="See `GetClassName` and `SetClassName`")
7382 ExitOnFrameDelete = property(GetExitOnFrameDelete,SetExitOnFrameDelete,doc="See `GetExitOnFrameDelete` and `SetExitOnFrameDelete`")
7383 LayoutDirection = property(GetLayoutDirection,doc="See `GetLayoutDirection`")
7384 PrintMode = property(GetPrintMode,SetPrintMode,doc="See `GetPrintMode` and `SetPrintMode`")
7385 TopWindow = property(GetTopWindow,SetTopWindow,doc="See `GetTopWindow` and `SetTopWindow`")
7386 Traits = property(GetTraits,doc="See `GetTraits`")
7387 UseBestVisual = property(GetUseBestVisual,SetUseBestVisual,doc="See `GetUseBestVisual` and `SetUseBestVisual`")
7388 VendorName = property(GetVendorName,SetVendorName,doc="See `GetVendorName` and `SetVendorName`")
7389 Active = property(IsActive)
2131d850 7390_core_.PyApp_swigregister(PyApp)
d14a1e28 7391
0085ce49
RD
7392def PyApp_IsMainLoopRunning(*args):
7393 """
1fc3b23a
RD
7394 PyApp_IsMainLoopRunning() -> bool
7395
7396 Returns True if we're running the main loop, i.e. if the events can
7397 currently be dispatched.
7398 """
0085ce49 7399 return _core_.PyApp_IsMainLoopRunning(*args)
1fc3b23a 7400
0085ce49
RD
7401def PyApp_GetMacSupportPCMenuShortcuts(*args):
7402 """PyApp_GetMacSupportPCMenuShortcuts() -> bool"""
7403 return _core_.PyApp_GetMacSupportPCMenuShortcuts(*args)
d14a1e28 7404
0085ce49
RD
7405def PyApp_GetMacAboutMenuItemId(*args):
7406 """PyApp_GetMacAboutMenuItemId() -> long"""
7407 return _core_.PyApp_GetMacAboutMenuItemId(*args)
d14a1e28 7408
0085ce49
RD
7409def PyApp_GetMacPreferencesMenuItemId(*args):
7410 """PyApp_GetMacPreferencesMenuItemId() -> long"""
7411 return _core_.PyApp_GetMacPreferencesMenuItemId(*args)
d14a1e28 7412
0085ce49
RD
7413def PyApp_GetMacExitMenuItemId(*args):
7414 """PyApp_GetMacExitMenuItemId() -> long"""
7415 return _core_.PyApp_GetMacExitMenuItemId(*args)
d14a1e28 7416
0085ce49
RD
7417def PyApp_GetMacHelpMenuTitleName(*args):
7418 """PyApp_GetMacHelpMenuTitleName() -> String"""
7419 return _core_.PyApp_GetMacHelpMenuTitleName(*args)
d14a1e28 7420
e811c8ce 7421def PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs):
0085ce49
RD
7422 """PyApp_SetMacSupportPCMenuShortcuts(bool val)"""
7423 return _core_.PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs)
d14a1e28 7424
e811c8ce 7425def PyApp_SetMacAboutMenuItemId(*args, **kwargs):
0085ce49
RD
7426 """PyApp_SetMacAboutMenuItemId(long val)"""
7427 return _core_.PyApp_SetMacAboutMenuItemId(*args, **kwargs)
d14a1e28 7428
e811c8ce 7429def PyApp_SetMacPreferencesMenuItemId(*args, **kwargs):
0085ce49
RD
7430 """PyApp_SetMacPreferencesMenuItemId(long val)"""
7431 return _core_.PyApp_SetMacPreferencesMenuItemId(*args, **kwargs)
d14a1e28 7432
e811c8ce 7433def PyApp_SetMacExitMenuItemId(*args, **kwargs):
0085ce49
RD
7434 """PyApp_SetMacExitMenuItemId(long val)"""
7435 return _core_.PyApp_SetMacExitMenuItemId(*args, **kwargs)
d14a1e28 7436
e811c8ce 7437def PyApp_SetMacHelpMenuTitleName(*args, **kwargs):
0085ce49
RD
7438 """PyApp_SetMacHelpMenuTitleName(String val)"""
7439 return _core_.PyApp_SetMacHelpMenuTitleName(*args, **kwargs)
d14a1e28 7440
0085ce49
RD
7441def PyApp_GetComCtl32Version(*args):
7442 """
0df68c9f 7443 PyApp_GetComCtl32Version() -> int
6c3b4aae 7444
66c033b4
RD
7445 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
7446 it wasn't found at all. Raises an exception on non-Windows platforms.
0df68c9f 7447 """
0085ce49 7448 return _core_.PyApp_GetComCtl32Version(*args)
d14a1e28 7449
33d6fd3b 7450def PyApp_IsDisplayAvailable(*args):
fc46b7f3 7451 """
33d6fd3b 7452 PyApp_IsDisplayAvailable() -> bool
fc46b7f3
RD
7453
7454 Tests if it is possible to create a GUI in the current environment.
7455 This will mean different things on the different platforms.
7456
7457 * On X Windows systems this function will return ``False`` if it is
7458 not able to open a connection to the X display, which can happen
7459 if $DISPLAY is not set, or is not set correctly.
7460
7461 * On Mac OS X a ``False`` return value will mean that wx is not
7462 able to access the window manager, which can happen if logged in
7463 remotely or if running from the normal version of python instead
7464 of the framework version, (i.e., pythonw.)
7465
7466 * On MS Windows...
7467
7468 """
33d6fd3b 7469 return _core_.PyApp_IsDisplayAvailable(*args)
fc46b7f3 7470
d14a1e28
RD
7471#---------------------------------------------------------------------------
7472
7473
0085ce49
RD
7474def Exit(*args):
7475 """
0df68c9f 7476 Exit()
6c3b4aae 7477
0df68c9f
RD
7478 Force an exit of the application. Convenience for wx.GetApp().Exit()
7479 """
0085ce49 7480 return _core_.Exit(*args)
d14a1e28 7481
0085ce49
RD
7482def Yield(*args):
7483 """
0df68c9f 7484 Yield() -> bool
6c3b4aae 7485
0df68c9f
RD
7486 Yield to other apps/messages. Convenience for wx.GetApp().Yield()
7487 """
0085ce49 7488 return _core_.Yield(*args)
d14a1e28 7489
0085ce49
RD
7490def YieldIfNeeded(*args):
7491 """
0df68c9f 7492 YieldIfNeeded() -> bool
6c3b4aae 7493
0df68c9f
RD
7494 Yield to other apps/messages. Convenience for wx.GetApp().Yield(True)
7495 """
0085ce49 7496 return _core_.YieldIfNeeded(*args)
d14a1e28 7497
e811c8ce 7498def SafeYield(*args, **kwargs):
0085ce49 7499 """
0df68c9f 7500 SafeYield(Window win=None, bool onlyIfNeeded=False) -> bool
6c3b4aae 7501
66c033b4
RD
7502 This function is similar to `wx.Yield`, except that it disables the
7503 user input to all program windows before calling `wx.Yield` and
7504 re-enables it again afterwards. If ``win`` is not None, this window
7505 will remain enabled, allowing the implementation of some limited user
7506 interaction.
6c3b4aae 7507
66c033b4 7508 :Returns: the result of the call to `wx.Yield`.
0df68c9f 7509 """
0085ce49 7510 return _core_.SafeYield(*args, **kwargs)
d14a1e28 7511
0085ce49
RD
7512def WakeUpIdle(*args):
7513 """
0df68c9f 7514 WakeUpIdle()
6c3b4aae 7515
66c033b4
RD
7516 Cause the message queue to become empty again, so idle events will be
7517 sent.
0df68c9f 7518 """
0085ce49 7519 return _core_.WakeUpIdle(*args)
d14a1e28 7520
e811c8ce 7521def PostEvent(*args, **kwargs):
0085ce49 7522 """
0df68c9f 7523 PostEvent(EvtHandler dest, Event event)
6c3b4aae 7524
66c033b4
RD
7525 Send an event to a window or other wx.EvtHandler to be processed
7526 later.
0df68c9f 7527 """
0085ce49 7528 return _core_.PostEvent(*args, **kwargs)
d14a1e28 7529
0085ce49
RD
7530def App_CleanUp(*args):
7531 """
0df68c9f 7532 App_CleanUp()
6c3b4aae 7533
41e2b43e 7534 For internal use only, it is used to cleanup after wxWidgets when
66c033b4 7535 Python shuts down.
0df68c9f 7536 """
0085ce49 7537 return _core_.App_CleanUp(*args)
d14a1e28 7538
0085ce49
RD
7539def GetApp(*args):
7540 """
0df68c9f 7541 GetApp() -> PyApp
6c3b4aae 7542
196addbf 7543 Return a reference to the current wx.App object.
0df68c9f 7544 """
0085ce49 7545 return _core_.GetApp(*args)
5cbf236d
RD
7546
7547def SetDefaultPyEncoding(*args, **kwargs):
0085ce49 7548 """
5cbf236d
RD
7549 SetDefaultPyEncoding(string encoding)
7550
7551 Sets the encoding that wxPython will use when it needs to convert a
7552 Python string or unicode object to or from a wxString.
e505d15e
RD
7553
7554 The default encoding is the value of ``locale.getdefaultlocale()[1]``
7555 but please be aware that the default encoding within the same locale
7556 may be slightly different on different platforms. For example, please
7557 see http://www.alanwood.net/demos/charsetdiffs.html for differences
7558 between the common latin/roman encodings.
5cbf236d 7559 """
0085ce49 7560 return _core_.SetDefaultPyEncoding(*args, **kwargs)
5cbf236d 7561
0085ce49
RD
7562def GetDefaultPyEncoding(*args):
7563 """
5cbf236d
RD
7564 GetDefaultPyEncoding() -> string
7565
7566 Gets the current encoding that wxPython will use when it needs to
7567 convert a Python string or unicode object to or from a wxString.
7568 """
0085ce49 7569 return _core_.GetDefaultPyEncoding(*args)
d14a1e28
RD
7570#----------------------------------------------------------------------
7571
7572class PyOnDemandOutputWindow:
6c3b4aae
RD
7573 """
7574 A class that can be used for redirecting Python's stdout and
7575 stderr streams. It will do nothing until something is wrriten to
7576 the stream at which point it will create a Frame with a text area
7577 and write the text there.
7578 """
d14a1e28
RD
7579 def __init__(self, title = "wxPython: stdout/stderr"):
7580 self.frame = None
7581 self.title = title
412d302d
RD
7582 self.pos = wx.DefaultPosition
7583 self.size = (450, 300)
d14a1e28
RD
7584 self.parent = None
7585
7586 def SetParent(self, parent):
6c3b4aae 7587 """Set the window to be used as the popup Frame's parent."""
d14a1e28
RD
7588 self.parent = parent
7589
6c3b4aae
RD
7590
7591 def CreateOutputWindow(self, st):
412d302d
RD
7592 self.frame = wx.Frame(self.parent, -1, self.title, self.pos, self.size,
7593 style=wx.DEFAULT_FRAME_STYLE)
196addbf 7594 self.text = wx.TextCtrl(self.frame, -1, "",
412d302d 7595 style=wx.TE_MULTILINE|wx.TE_READONLY)
d1e20054 7596 self.text.AppendText(st)
6c3b4aae 7597 self.frame.Show(True)
2131d850 7598 self.frame.Bind(wx.EVT_CLOSE, self.OnCloseWindow)
6c3b4aae 7599
d14a1e28 7600
7409c0c6
RD
7601 def OnCloseWindow(self, event):
7602 if self.frame is not None:
7603 self.frame.Destroy()
7604 self.frame = None
7605 self.text = None
7606
7607
d14a1e28 7608 # These methods provide the file-like output behaviour.
6c3b4aae
RD
7609 def write(self, text):
7610 """
7611 Create the output window if needed and write the string to it.
7612 If not called in the context of the gui thread then uses
7613 CallAfter to do the work there.
7614 """
7615 if self.frame is None:
7616 if not wx.Thread_IsMain():
7617 wx.CallAfter(self.CreateOutputWindow, text)
7618 else:
7619 self.CreateOutputWindow(text)
7620 else:
7621 if not wx.Thread_IsMain():
7622 wx.CallAfter(self.text.AppendText, text)
7623 else:
7624 self.text.AppendText(text)
7625
d14a1e28
RD
7626
7627 def close(self):
6c3b4aae
RD
7628 if self.frame is not None:
7629 wx.CallAfter(self.frame.Close)
7630
d14a1e28 7631
19272049
RD
7632 def flush(self):
7633 pass
7634
7635
d14a1e28
RD
7636
7637#----------------------------------------------------------------------
d14a1e28
RD
7638
7639_defRedirect = (wx.Platform == '__WXMSW__' or wx.Platform == '__WXMAC__')
fc46b7f3 7640
d14a1e28 7641class App(wx.PyApp):
6c3b4aae 7642 """
66c033b4
RD
7643 The ``wx.App`` class represents the application and is used to:
7644
7645 * bootstrap the wxPython system and initialize the underlying
7646 gui toolkit
7647 * set and get application-wide properties
7648 * implement the windowing system main message or event loop,
7649 and to dispatch events to window instances
7650 * etc.
7651
7652 Every application must have a ``wx.App`` instance, and all
7653 creation of UI objects should be delayed until after the
03e37cd5
RD
7654 ``wx.App`` object has been created in order to ensure that the gui
7655 platform and wxWidgets have been fully initialized.
66c033b4
RD
7656
7657 Normally you would derive from this class and implement an
7658 ``OnInit`` method that creates a frame and then calls
7659 ``self.SetTopWindow(frame)``.
7660
03e37cd5 7661 :see: `wx.PySimpleApp` for a simpler app class that can be used
1c0f361b 7662 directly.
6c3b4aae 7663 """
66c033b4 7664
d14a1e28
RD
7665 outputWindowClass = PyOnDemandOutputWindow
7666
03e37cd5
RD
7667 def __init__(self, redirect=_defRedirect, filename=None,
7668 useBestVisual=False, clearSigInt=True):
66c033b4
RD
7669 """
7670 Construct a ``wx.App`` object.
7671
03e37cd5
RD
7672 :param redirect: Should ``sys.stdout`` and ``sys.stderr`` be
7673 redirected? Defaults to True on Windows and Mac, False
7674 otherwise. If `filename` is None then output will be
7675 redirected to a window that pops up as needed. (You can
7676 control what kind of window is created for the output by
7677 resetting the class variable ``outputWindowClass`` to a
7678 class of your choosing.)
66c033b4 7679
03e37cd5
RD
7680 :param filename: The name of a file to redirect output to, if
7681 redirect is True.
66c033b4
RD
7682
7683 :param useBestVisual: Should the app try to use the best
03e37cd5
RD
7684 available visual provided by the system (only relevant on
7685 systems that have more than one visual.) This parameter
7686 must be used instead of calling `SetUseBestVisual` later
7687 on because it must be set before the underlying GUI
7688 toolkit is initialized.
7689
7690 :param clearSigInt: Should SIGINT be cleared? This allows the
7691 app to terminate upon a Ctrl-C in the console like other
7692 GUI apps will.
66c033b4
RD
7693
7694 :note: You should override OnInit to do applicaition
7695 initialization to ensure that the system, toolkit and
7696 wxWidgets are fully initialized.
7697 """
fc46b7f3 7698
d14a1e28
RD
7699 wx.PyApp.__init__(self)
7700
fc46b7f3 7701 # make sure we can create a GUI
33d6fd3b 7702 if not self.IsDisplayAvailable():
fc46b7f3
RD
7703
7704 if wx.Platform == "__WXMAC__":
7705 msg = """This program needs access to the screen.
7706Please run with 'pythonw', not 'python', and only when you are logged
7707in on the main display of your Mac."""
7708
7709 elif wx.Platform == "__WXGTK__":
7710 msg ="Unable to access the X Display, is $DISPLAY set properly?"
d14a1e28 7711
fc46b7f3
RD
7712 else:
7713 msg = "Unable to create GUI"
7714 # TODO: more description is needed for wxMSW...
7715
7716 raise SystemExit(msg)
7717
d14a1e28
RD
7718 # This has to be done before OnInit
7719 self.SetUseBestVisual(useBestVisual)
7720
7721 # Set the default handler for SIGINT. This fixes a problem
7722 # where if Ctrl-C is pressed in the console that started this
7723 # app then it will not appear to do anything, (not even send
7724 # KeyboardInterrupt???) but will later segfault on exit. By
7725 # setting the default handler then the app will exit, as
7726 # expected (depending on platform.)
03e37cd5
RD
7727 if clearSigInt:
7728 try:
7729 import signal
7730 signal.signal(signal.SIGINT, signal.SIG_DFL)
7731 except:
7732 pass
d14a1e28
RD
7733
7734 # Save and redirect the stdio to a window?
7735 self.stdioWin = None
7736 self.saveStdio = (_sys.stdout, _sys.stderr)
7737 if redirect:
7738 self.RedirectStdio(filename)
7739
8fb0e70a
RD
7740 # Use Python's install prefix as the default
7741 wx.StandardPaths.Get().SetInstallPrefix(_sys.prefix)
7742
48a0c021
RD
7743 # Until the new native control for wxMac is up to par, still use the generic one.
7744 wx.SystemOptions.SetOptionInt("mac.listctrl.always_use_generic", 1)
7745
d14a1e28
RD
7746 # This finishes the initialization of wxWindows and then calls
7747 # the OnInit that should be present in the derived class
7748 self._BootstrapApp()
7749
7750
01f6b6d3
RD
7751 def OnPreInit(self):
7752 """
7753 Things that must be done after _BootstrapApp has done its
7754 thing, but would be nice if they were already done by the time
7755 that OnInit is called.
7756 """
7757 wx.StockGDI._initStockObjects()
7758
7759
02b455f2
RD
7760 def __del__(self, destroy=wx.PyApp.__del__):
7761 self.RestoreStdio() # Just in case the MainLoop was overridden
7762 destroy(self)
d14a1e28 7763
70b7a5fe 7764 def Destroy(self):
b39fe951 7765 self.this.own(False)
70b7a5fe 7766 wx.PyApp.Destroy(self)
d14a1e28
RD
7767
7768 def SetTopWindow(self, frame):
1e0c8722 7769 """Set the \"main\" top level window"""
d14a1e28
RD
7770 if self.stdioWin:
7771 self.stdioWin.SetParent(frame)
7772 wx.PyApp.SetTopWindow(self, frame)
7773
7774
7775 def MainLoop(self):
1e0c8722 7776 """Execute the main GUI event loop"""
d14a1e28
RD
7777 wx.PyApp.MainLoop(self)
7778 self.RestoreStdio()
7779
7780
7409c0c6 7781 def RedirectStdio(self, filename=None):
1e0c8722 7782 """Redirect sys.stdout and sys.stderr to a file or a popup window."""
d14a1e28
RD
7783 if filename:
7784 _sys.stdout = _sys.stderr = open(filename, 'a')
7785 else:
7786 self.stdioWin = self.outputWindowClass()
7787 _sys.stdout = _sys.stderr = self.stdioWin
7788
7789
7790 def RestoreStdio(self):
02b455f2
RD
7791 try:
7792 _sys.stdout, _sys.stderr = self.saveStdio
7793 except:
7794 pass
d14a1e28
RD
7795
7796
412d302d
RD
7797 def SetOutputWindowAttributes(self, title=None, pos=None, size=None):
7798 """
7799 Set the title, position and/or size of the output window if
f5b96ee1
RD
7800 the stdio has been redirected. This should be called before
7801 any output would cause the output window to be created.
412d302d
RD
7802 """
7803 if self.stdioWin:
7804 if title is not None:
7805 self.stdioWin.title = title
7806 if pos is not None:
7807 self.stdioWin.pos = pos
7808 if size is not None:
7809 self.stdioWin.size = size
7810
7811
7812
d14a1e28 7813
66c033b4 7814# change from wx.PyApp_XX to wx.App_XX
54f9ee45
RD
7815App_GetMacSupportPCMenuShortcuts = _core_.PyApp_GetMacSupportPCMenuShortcuts
7816App_GetMacAboutMenuItemId = _core_.PyApp_GetMacAboutMenuItemId
7817App_GetMacPreferencesMenuItemId = _core_.PyApp_GetMacPreferencesMenuItemId
7818App_GetMacExitMenuItemId = _core_.PyApp_GetMacExitMenuItemId
7819App_GetMacHelpMenuTitleName = _core_.PyApp_GetMacHelpMenuTitleName
7820App_SetMacSupportPCMenuShortcuts = _core_.PyApp_SetMacSupportPCMenuShortcuts
7821App_SetMacAboutMenuItemId = _core_.PyApp_SetMacAboutMenuItemId
7822App_SetMacPreferencesMenuItemId = _core_.PyApp_SetMacPreferencesMenuItemId
7823App_SetMacExitMenuItemId = _core_.PyApp_SetMacExitMenuItemId
7824App_SetMacHelpMenuTitleName = _core_.PyApp_SetMacHelpMenuTitleName
7825App_GetComCtl32Version = _core_.PyApp_GetComCtl32Version
d14a1e28
RD
7826
7827#----------------------------------------------------------------------------
7828
7829class PySimpleApp(wx.App):
6c3b4aae
RD
7830 """
7831 A simple application class. You can just create one of these and
7832 then then make your top level windows later, and not have to worry
66c033b4
RD
7833 about OnInit. For example::
7834
7835 app = wx.PySimpleApp()
7836 frame = wx.Frame(None, title='Hello World')
7837 frame.Show()
7838 app.MainLoop()
7839
7840 :see: `wx.App`
7841 """
6c3b4aae 7842
03e37cd5
RD
7843 def __init__(self, redirect=False, filename=None,
7844 useBestVisual=False, clearSigInt=True):
66c033b4
RD
7845 """
7846 :see: `wx.App.__init__`
7847 """
03e37cd5 7848 wx.App.__init__(self, redirect, filename, useBestVisual, clearSigInt)
6c3b4aae 7849
d14a1e28 7850 def OnInit(self):
d14a1e28
RD
7851 return True
7852
7853
66c033b4 7854
6c3b4aae 7855# Is anybody using this one?
d14a1e28
RD
7856class PyWidgetTester(wx.App):
7857 def __init__(self, size = (250, 100)):
7858 self.size = size
7859 wx.App.__init__(self, 0)
7860
7861 def OnInit(self):
196addbf 7862 self.frame = wx.Frame(None, -1, "Widget Tester", pos=(0,0), size=self.size)
d14a1e28
RD
7863 self.SetTopWindow(self.frame)
7864 return True
7865
66c033b4
RD
7866 def SetWidget(self, widgetClass, *args, **kwargs):
7867 w = widgetClass(self.frame, *args, **kwargs)
d14a1e28
RD
7868 self.frame.Show(True)
7869
7870#----------------------------------------------------------------------------
7871# DO NOT hold any other references to this object. This is how we
66c033b4 7872# know when to cleanup system resources that wxWidgets is holding. When
d14a1e28 7873# the sys module is unloaded, the refcount on sys.__wxPythonCleanup
66c033b4 7874# goes to zero and it calls the wx.App_CleanUp function.
d14a1e28
RD
7875
7876class __wxPyCleanup:
7877 def __init__(self):
54f9ee45 7878 self.cleanup = _core_.App_CleanUp
d14a1e28
RD
7879 def __del__(self):
7880 self.cleanup()
7881
7882_sys.__wxPythonCleanup = __wxPyCleanup()
7883
7884## # another possible solution, but it gets called too early...
66c033b4
RD
7885## import atexit
7886## atexit.register(_core_.wxApp_CleanUp)
d14a1e28
RD
7887
7888
7889#----------------------------------------------------------------------------
7890
7891#---------------------------------------------------------------------------
2ef75293
RD
7892
7893class EventLoop(object):
093d3ff1 7894 """Proxy of C++ EventLoop class"""
0085ce49
RD
7895 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7896 __repr__ = _swig_repr
7897 def __init__(self, *args, **kwargs):
2ef75293 7898 """__init__(self) -> EventLoop"""
0085ce49
RD
7899 _core_.EventLoop_swiginit(self,_core_.new_EventLoop(*args, **kwargs))
7900 __swig_destroy__ = _core_.delete_EventLoop
7901 __del__ = lambda self : None;
2ef75293
RD
7902 def Run(*args, **kwargs):
7903 """Run(self) -> int"""
7904 return _core_.EventLoop_Run(*args, **kwargs)
7905
7906 def Exit(*args, **kwargs):
7907 """Exit(self, int rc=0)"""
7908 return _core_.EventLoop_Exit(*args, **kwargs)
7909
7910 def Pending(*args, **kwargs):
7911 """Pending(self) -> bool"""
7912 return _core_.EventLoop_Pending(*args, **kwargs)
7913
7914 def Dispatch(*args, **kwargs):
7915 """Dispatch(self) -> bool"""
7916 return _core_.EventLoop_Dispatch(*args, **kwargs)
7917
7918 def IsRunning(*args, **kwargs):
7919 """IsRunning(self) -> bool"""
7920 return _core_.EventLoop_IsRunning(*args, **kwargs)
7921
7922 def GetActive(*args, **kwargs):
7923 """GetActive() -> EventLoop"""
7924 return _core_.EventLoop_GetActive(*args, **kwargs)
7925
7926 GetActive = staticmethod(GetActive)
7927 def SetActive(*args, **kwargs):
7928 """SetActive(EventLoop loop)"""
7929 return _core_.EventLoop_SetActive(*args, **kwargs)
7930
7931 SetActive = staticmethod(SetActive)
2131d850 7932_core_.EventLoop_swigregister(EventLoop)
2ef75293 7933
0085ce49
RD
7934def EventLoop_GetActive(*args):
7935 """EventLoop_GetActive() -> EventLoop"""
7936 return _core_.EventLoop_GetActive(*args)
2ef75293
RD
7937
7938def EventLoop_SetActive(*args, **kwargs):
0085ce49
RD
7939 """EventLoop_SetActive(EventLoop loop)"""
7940 return _core_.EventLoop_SetActive(*args, **kwargs)
2ef75293 7941
091f5bed
RD
7942class EventLoopActivator(object):
7943 """Proxy of C++ EventLoopActivator class"""
0085ce49
RD
7944 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7945 __repr__ = _swig_repr
7946 def __init__(self, *args, **kwargs):
091f5bed 7947 """__init__(self, EventLoop evtLoop) -> EventLoopActivator"""
0085ce49
RD
7948 _core_.EventLoopActivator_swiginit(self,_core_.new_EventLoopActivator(*args, **kwargs))
7949 __swig_destroy__ = _core_.delete_EventLoopActivator
7950 __del__ = lambda self : None;
2131d850 7951_core_.EventLoopActivator_swigregister(EventLoopActivator)
091f5bed 7952
2ef75293 7953#---------------------------------------------------------------------------
d14a1e28 7954
eec1c382
RD
7955ACCEL_ALT = _core_.ACCEL_ALT
7956ACCEL_CTRL = _core_.ACCEL_CTRL
7957ACCEL_SHIFT = _core_.ACCEL_SHIFT
7958ACCEL_NORMAL = _core_.ACCEL_NORMAL
7959ACCEL_CMD = _core_.ACCEL_CMD
1e0c8722 7960class AcceleratorEntry(object):
66c033b4
RD
7961 """
7962 A class used to define items in an `wx.AcceleratorTable`. wxPython
7963 programs can choose to use wx.AcceleratorEntry objects, but using a
7964 list of 3-tuple of integers (flags, keyCode, cmdID) usually works just
41e2b43e 7965 as well. See `__init__` for of the tuple values.
66c033b4
RD
7966
7967 :see: `wx.AcceleratorTable`
7968 """
0085ce49
RD
7969 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7970 __repr__ = _swig_repr
7971 def __init__(self, *args, **kwargs):
66c033b4
RD
7972 """
7973 __init__(self, int flags=0, int keyCode=0, int cmdID=0) -> AcceleratorEntry
7974
7975 Construct a wx.AcceleratorEntry.
66c033b4 7976 """
0085ce49
RD
7977 _core_.AcceleratorEntry_swiginit(self,_core_.new_AcceleratorEntry(*args, **kwargs))
7978 __swig_destroy__ = _core_.delete_AcceleratorEntry
7979 __del__ = lambda self : None;
1e0c8722 7980 def Set(*args, **kwargs):
66c033b4
RD
7981 """
7982 Set(self, int flags, int keyCode, int cmd)
1e0c8722 7983
66c033b4
RD
7984 (Re)set the attributes of a wx.AcceleratorEntry.
7985 :see `__init__`
7986 """
7987 return _core_.AcceleratorEntry_Set(*args, **kwargs)
1e0c8722 7988
97ab0f6a
RD
7989 def Create(*args, **kwargs):
7990 """
7991 Create(String str) -> AcceleratorEntry
7992
7993 Create accelerator corresponding to the specified string, or None if
7994 it coulnd't be parsed.
7995 """
7996 return _core_.AcceleratorEntry_Create(*args, **kwargs)
7997
7998 Create = staticmethod(Create)
1e0c8722 7999 def GetFlags(*args, **kwargs):
66c033b4
RD
8000 """
8001 GetFlags(self) -> int
8002
8003 Get the AcceleratorEntry's flags.
8004 """
54f9ee45 8005 return _core_.AcceleratorEntry_GetFlags(*args, **kwargs)
1e0c8722
RD
8006
8007 def GetKeyCode(*args, **kwargs):
66c033b4
RD
8008 """
8009 GetKeyCode(self) -> int
8010
8011 Get the AcceleratorEntry's keycode.
8012 """
54f9ee45 8013 return _core_.AcceleratorEntry_GetKeyCode(*args, **kwargs)
1e0c8722
RD
8014
8015 def GetCommand(*args, **kwargs):
66c033b4
RD
8016 """
8017 GetCommand(self) -> int
8018
8019 Get the AcceleratorEntry's command ID.
8020 """
54f9ee45 8021 return _core_.AcceleratorEntry_GetCommand(*args, **kwargs)
1e0c8722 8022
97ab0f6a
RD
8023 def IsOk(*args, **kwargs):
8024 """IsOk(self) -> bool"""
8025 return _core_.AcceleratorEntry_IsOk(*args, **kwargs)
8026
8027 def ToString(*args, **kwargs):
8028 """
8029 ToString(self) -> String
8030
8031 Returns a string representation for the this accelerator. The string
8032 is formatted using the <flags>-<keycode> format where <flags> maybe a
8033 hyphen-separed list of "shift|alt|ctrl"
8034
8035 """
8036 return _core_.AcceleratorEntry_ToString(*args, **kwargs)
8037
8038 def FromString(*args, **kwargs):
8039 """
8040 FromString(self, String str) -> bool
8041
8042 Returns true if the given string correctly initialized this object.
8043 """
8044 return _core_.AcceleratorEntry_FromString(*args, **kwargs)
8045
2bf58437
RD
8046 Command = property(GetCommand,doc="See `GetCommand`")
8047 Flags = property(GetFlags,doc="See `GetFlags`")
8048 KeyCode = property(GetKeyCode,doc="See `GetKeyCode`")
2131d850 8049_core_.AcceleratorEntry_swigregister(AcceleratorEntry)
1e0c8722 8050
97ab0f6a
RD
8051def AcceleratorEntry_Create(*args, **kwargs):
8052 """
8053 AcceleratorEntry_Create(String str) -> AcceleratorEntry
8054
8055 Create accelerator corresponding to the specified string, or None if
8056 it coulnd't be parsed.
8057 """
8058 return _core_.AcceleratorEntry_Create(*args, **kwargs)
8059
1e0c8722 8060class AcceleratorTable(Object):
66c033b4
RD
8061 """
8062 An accelerator table allows the application to specify a table of
8063 keyboard shortcuts for menus or other commands. On Windows, menu or
8064 button commands are supported; on GTK, only menu commands are
8065 supported.
66c033b4 8066 """
0085ce49
RD
8067 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
8068 __repr__ = _swig_repr
8069 def __init__(self, *args, **kwargs):
0df68c9f
RD
8070 """
8071 __init__(entries) -> AcceleratorTable
1e0c8722 8072
66c033b4
RD
8073 Construct an AcceleratorTable from a list of `wx.AcceleratorEntry`
8074 items or or of 3-tuples (flags, keyCode, cmdID)
8075
8076 :see: `wx.AcceleratorEntry`
0df68c9f 8077 """
0085ce49
RD
8078 _core_.AcceleratorTable_swiginit(self,_core_.new_AcceleratorTable(*args, **kwargs))
8079 __swig_destroy__ = _core_.delete_AcceleratorTable
8080 __del__ = lambda self : None;
b39fe951
RD
8081 def IsOk(*args, **kwargs):
8082 """IsOk(self) -> bool"""
8083 return _core_.AcceleratorTable_IsOk(*args, **kwargs)
1e0c8722 8084
b39fe951 8085 Ok = IsOk
2131d850 8086_core_.AcceleratorTable_swigregister(AcceleratorTable)
1e0c8722
RD
8087
8088
8089def GetAccelFromString(*args, **kwargs):
0085ce49
RD
8090 """GetAccelFromString(String label) -> AcceleratorEntry"""
8091 return _core_.GetAccelFromString(*args, **kwargs)
1e0c8722
RD
8092#---------------------------------------------------------------------------
8093
74a57fcd
RD
8094class VisualAttributes(object):
8095 """struct containing all the visual attributes of a control"""
0085ce49
RD
8096 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
8097 __repr__ = _swig_repr
8098 def __init__(self, *args, **kwargs):
74a57fcd 8099 """
a95a7133 8100 __init__(self) -> VisualAttributes
74a57fcd
RD
8101
8102 struct containing all the visual attributes of a control
8103 """
0085ce49
RD
8104 _core_.VisualAttributes_swiginit(self,_core_.new_VisualAttributes(*args, **kwargs))
8105 __swig_destroy__ = _core_.delete_VisualAttributes
8106 __del__ = lambda self : None;
54f9ee45
RD
8107 font = property(_core_.VisualAttributes_font_get, _core_.VisualAttributes_font_set)
8108 colFg = property(_core_.VisualAttributes_colFg_get, _core_.VisualAttributes_colFg_set)
8109 colBg = property(_core_.VisualAttributes_colBg_get, _core_.VisualAttributes_colBg_set)
2131d850 8110_core_.VisualAttributes_swigregister(VisualAttributes)
74a57fcd
RD
8111NullAcceleratorTable = cvar.NullAcceleratorTable
8112PanelNameStr = cvar.PanelNameStr
8113
54f9ee45
RD
8114WINDOW_VARIANT_NORMAL = _core_.WINDOW_VARIANT_NORMAL
8115WINDOW_VARIANT_SMALL = _core_.WINDOW_VARIANT_SMALL
8116WINDOW_VARIANT_MINI = _core_.WINDOW_VARIANT_MINI
8117WINDOW_VARIANT_LARGE = _core_.WINDOW_VARIANT_LARGE
8118WINDOW_VARIANT_MAX = _core_.WINDOW_VARIANT_MAX
d14a1e28 8119class Window(EvtHandler):
15afbcd0
RD
8120 """
8121 wx.Window is the base class for all windows and represents any visible
8122 object on the screen. All controls, top level windows and so on are
8123 wx.Windows. Sizers and device contexts are not however, as they don't
8124 appear on screen themselves.
8125
8126 """
0085ce49
RD
8127 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
8128 __repr__ = _swig_repr
8129 def __init__(self, *args, **kwargs):
0df68c9f 8130 """
a95a7133 8131 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
74a57fcd 8132 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> Window
15afbcd0
RD
8133
8134 Construct and show a generic Window.
0df68c9f 8135 """
0085ce49 8136 _core_.Window_swiginit(self,_core_.new_Window(*args, **kwargs))
d14a1e28 8137 self._setOORInfo(self)
d14a1e28 8138
e811c8ce 8139 def Create(*args, **kwargs):
0df68c9f 8140 """
a95a7133 8141 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
74a57fcd 8142 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> bool
15afbcd0
RD
8143
8144 Create the GUI part of the Window for 2-phase creation mode.
0df68c9f 8145 """
54f9ee45 8146 return _core_.Window_Create(*args, **kwargs)
d14a1e28 8147
e811c8ce 8148 def Close(*args, **kwargs):
15afbcd0 8149 """
a95a7133 8150 Close(self, bool force=False) -> bool
15afbcd0
RD
8151
8152 This function simply generates a EVT_CLOSE event whose handler usually
8153 tries to close the window. It doesn't close the window itself,
8154 however. If force is False (the default) then the window's close
8155 handler will be allowed to veto the destruction of the window.
15afbcd0 8156 """
54f9ee45 8157 return _core_.Window_Close(*args, **kwargs)
d14a1e28 8158
e811c8ce 8159 def Destroy(*args, **kwargs):
0df68c9f 8160 """
a95a7133 8161 Destroy(self) -> bool
d14a1e28 8162
15afbcd0
RD
8163 Destroys the window safely. Frames and dialogs are not destroyed
8164 immediately when this function is called -- they are added to a list
8165 of windows to be deleted on idle time, when all the window's events
8166 have been processed. This prevents problems with events being sent to
8167 non-existent windows.
8168
8169 Returns True if the window has either been successfully deleted, or it
8170 has been added to the list of windows pending real deletion.
0df68c9f 8171 """
b39fe951
RD
8172 args[0].this.own(False)
8173 return _core_.Window_Destroy(*args, **kwargs)
d14a1e28 8174
e811c8ce 8175 def DestroyChildren(*args, **kwargs):
15afbcd0 8176 """
a95a7133 8177 DestroyChildren(self) -> bool
15afbcd0 8178
41e2b43e
RD
8179 Destroys all children of a window. Called automatically by the
8180 destructor.
15afbcd0 8181 """
54f9ee45 8182 return _core_.Window_DestroyChildren(*args, **kwargs)
d14a1e28 8183
e811c8ce 8184 def IsBeingDeleted(*args, **kwargs):
15afbcd0 8185 """
a95a7133 8186 IsBeingDeleted(self) -> bool
15afbcd0
RD
8187
8188 Is the window in the process of being deleted?
8189 """
54f9ee45 8190 return _core_.Window_IsBeingDeleted(*args, **kwargs)
d14a1e28 8191
e811c8ce 8192 def SetLabel(*args, **kwargs):
15afbcd0 8193 """
a95a7133 8194 SetLabel(self, String label)
15afbcd0
RD
8195
8196 Set the text which the window shows in its label if applicable.
8197 """
54f9ee45 8198 return _core_.Window_SetLabel(*args, **kwargs)
d14a1e28 8199
e811c8ce 8200 def GetLabel(*args, **kwargs):
15afbcd0 8201 """
a95a7133 8202 GetLabel(self) -> String
15afbcd0 8203
41e2b43e
RD
8204 Generic way of getting a label from any window, for identification
8205 purposes. The interpretation of this function differs from class to
8206 class. For frames and dialogs, the value returned is the title. For
8207 buttons or static text controls, it is the button text. This function
8208 can be useful for meta-programs such as testing tools or special-needs
8209 access programs)which need to identify windows by name.
15afbcd0 8210 """
54f9ee45 8211 return _core_.Window_GetLabel(*args, **kwargs)
d14a1e28 8212
e811c8ce 8213 def SetName(*args, **kwargs):
15afbcd0 8214 """
a95a7133 8215 SetName(self, String name)
15afbcd0 8216
41e2b43e
RD
8217 Sets the window's name. The window name is used for ressource setting
8218 in X, it is not the same as the window title/label
15afbcd0 8219 """
54f9ee45 8220 return _core_.Window_SetName(*args, **kwargs)
d14a1e28 8221
e811c8ce 8222 def GetName(*args, **kwargs):
15afbcd0 8223 """
a95a7133 8224 GetName(self) -> String
15afbcd0 8225
41e2b43e
RD
8226 Returns the windows name. This name is not guaranteed to be unique;
8227 it is up to the programmer to supply an appropriate name in the window
8228 constructor or via wx.Window.SetName.
15afbcd0 8229 """
54f9ee45 8230 return _core_.Window_GetName(*args, **kwargs)
d14a1e28 8231
4276dc52
RD
8232 def SetWindowVariant(*args, **kwargs):
8233 """
a95a7133 8234 SetWindowVariant(self, int variant)
4276dc52 8235
41e2b43e
RD
8236 Sets the variant of the window/font size to use for this window, if
8237 the platform supports variants, for example, wxMac.
4276dc52 8238 """
54f9ee45 8239 return _core_.Window_SetWindowVariant(*args, **kwargs)
4276dc52
RD
8240
8241 def GetWindowVariant(*args, **kwargs):
a95a7133 8242 """GetWindowVariant(self) -> int"""
54f9ee45 8243 return _core_.Window_GetWindowVariant(*args, **kwargs)
4276dc52 8244
e811c8ce 8245 def SetId(*args, **kwargs):
15afbcd0 8246 """
a95a7133 8247 SetId(self, int winid)
15afbcd0
RD
8248
8249 Sets the identifier of the window. Each window has an integer
8250 identifier. If the application has not provided one, an identifier
8251 will be generated. Normally, the identifier should be provided on
8252 creation and should not be modified subsequently.
8253 """
54f9ee45 8254 return _core_.Window_SetId(*args, **kwargs)
d14a1e28 8255
e811c8ce 8256 def GetId(*args, **kwargs):
15afbcd0 8257 """
a95a7133 8258 GetId(self) -> int
15afbcd0
RD
8259
8260 Returns the identifier of the window. Each window has an integer
8261 identifier. If the application has not provided one (or the default Id
8262 -1 is used) then an unique identifier with a negative value will be
8263 generated.
8264 """
54f9ee45 8265 return _core_.Window_GetId(*args, **kwargs)
d14a1e28 8266
e811c8ce 8267 def NewControlId(*args, **kwargs):
15afbcd0 8268 """
66c033b4 8269 NewControlId() -> int
15afbcd0
RD
8270
8271 Generate a control id for the controls which were not given one.
8272 """
54f9ee45 8273 return _core_.Window_NewControlId(*args, **kwargs)
d14a1e28 8274
e811c8ce
RD
8275 NewControlId = staticmethod(NewControlId)
8276 def NextControlId(*args, **kwargs):
15afbcd0 8277 """
66c033b4 8278 NextControlId(int winid) -> int
15afbcd0
RD
8279
8280 Get the id of the control following the one with the given
41e2b43e 8281 autogenerated) id
15afbcd0 8282 """
54f9ee45 8283 return _core_.Window_NextControlId(*args, **kwargs)
d14a1e28 8284
e811c8ce
RD
8285 NextControlId = staticmethod(NextControlId)
8286 def PrevControlId(*args, **kwargs):
15afbcd0 8287 """
66c033b4 8288 PrevControlId(int winid) -> int
15afbcd0
RD
8289
8290 Get the id of the control preceding the one with the given
41e2b43e 8291 autogenerated) id
15afbcd0 8292 """
54f9ee45 8293 return _core_.Window_PrevControlId(*args, **kwargs)
d14a1e28 8294
e811c8ce 8295 PrevControlId = staticmethod(PrevControlId)
97ab0f6a
RD
8296 def GetLayoutDirection(*args, **kwargs):
8297 """
994453b8 8298 GetLayoutDirection(self) -> int
97ab0f6a
RD
8299
8300 Get the layout direction (LTR or RTL) for this window. Returns
8301 ``wx.Layout_Default`` if layout direction is not supported.
8302 """
8303 return _core_.Window_GetLayoutDirection(*args, **kwargs)
8304
8305 def SetLayoutDirection(*args, **kwargs):
8306 """
994453b8 8307 SetLayoutDirection(self, int dir)
97ab0f6a
RD
8308
8309 Set the layout direction (LTR or RTL) for this window.
8310 """
8311 return _core_.Window_SetLayoutDirection(*args, **kwargs)
8312
8313 def AdjustForLayoutDirection(*args, **kwargs):
8314 """
8315 AdjustForLayoutDirection(self, int x, int width, int widthTotal) -> int
8316
8317 Mirror coordinates for RTL layout if this window uses it and if the
8318 mirroring is not done automatically like Win32.
8319 """
8320 return _core_.Window_AdjustForLayoutDirection(*args, **kwargs)
8321
e811c8ce 8322 def SetSize(*args, **kwargs):
15afbcd0 8323 """
a95a7133 8324 SetSize(self, Size size)
15afbcd0
RD
8325
8326 Sets the size of the window in pixels.
8327 """
54f9ee45 8328 return _core_.Window_SetSize(*args, **kwargs)
d14a1e28 8329
e811c8ce 8330 def SetDimensions(*args, **kwargs):
15afbcd0 8331 """
a95a7133 8332 SetDimensions(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)
15afbcd0
RD
8333
8334 Sets the position and size of the window in pixels. The sizeFlags
8335 parameter indicates the interpretation of the other params if they are
e505d15e
RD
8336 equal to -1.
8337
8338 ======================== ======================================
8339 wx.SIZE_AUTO A -1 indicates that a class-specific
8340 default should be used.
8341 wx.SIZE_USE_EXISTING Axisting dimensions should be used if
8342 -1 values are supplied.
8343 wxSIZE_ALLOW_MINUS_ONE Allow dimensions of -1 and less to be
8344 interpreted as real dimensions, not
8345 default values.
8346 ======================== ======================================
8347
15afbcd0 8348 """
54f9ee45 8349 return _core_.Window_SetDimensions(*args, **kwargs)
d14a1e28 8350
e811c8ce 8351 def SetRect(*args, **kwargs):
15afbcd0 8352 """
a95a7133 8353 SetRect(self, Rect rect, int sizeFlags=SIZE_AUTO)
15afbcd0
RD
8354
8355 Sets the position and size of the window in pixels using a wx.Rect.
8356 """
54f9ee45 8357 return _core_.Window_SetRect(*args, **kwargs)
d14a1e28 8358
e811c8ce 8359 def SetSizeWH(*args, **kwargs):
15afbcd0 8360 """
a95a7133 8361 SetSizeWH(self, int width, int height)
15afbcd0
RD
8362
8363 Sets the size of the window in pixels.
8364 """
54f9ee45 8365 return _core_.Window_SetSizeWH(*args, **kwargs)
d14a1e28 8366
e811c8ce 8367 def Move(*args, **kwargs):
15afbcd0 8368 """
a95a7133 8369 Move(self, Point pt, int flags=SIZE_USE_EXISTING)
15afbcd0
RD
8370
8371 Moves the window to the given position.
8372 """
54f9ee45 8373 return _core_.Window_Move(*args, **kwargs)
d14a1e28 8374
e811c8ce
RD
8375 SetPosition = Move
8376 def MoveXY(*args, **kwargs):
15afbcd0 8377 """
a95a7133 8378 MoveXY(self, int x, int y, int flags=SIZE_USE_EXISTING)
15afbcd0
RD
8379
8380 Moves the window to the given position.
8381 """
54f9ee45 8382 return _core_.Window_MoveXY(*args, **kwargs)
e811c8ce 8383
580080c5 8384 def SetInitialSize(*args, **kwargs):
f8167d6e 8385 """
580080c5 8386 SetInitialSize(self, Size size=DefaultSize)
f8167d6e
RD
8387
8388 A 'Smart' SetSize that will fill in default size components with the
8389 window's *best size* values. Also set's the minsize for use with sizers.
8390 """
580080c5 8391 return _core_.Window_SetInitialSize(*args, **kwargs)
f8167d6e 8392
580080c5 8393 SetBestFittingSize = wx._deprecated(SetInitialSize, 'Use `SetInitialSize`')
e811c8ce 8394 def Raise(*args, **kwargs):
15afbcd0 8395 """
a95a7133 8396 Raise(self)
15afbcd0 8397
943e8dfd
RD
8398 Raises the window to the top of the window hierarchy. In current
8399 version of wxWidgets this works both for manage and child windows.
15afbcd0 8400 """
54f9ee45 8401 return _core_.Window_Raise(*args, **kwargs)
e811c8ce
RD
8402
8403 def Lower(*args, **kwargs):
15afbcd0 8404 """
a95a7133 8405 Lower(self)
15afbcd0 8406
943e8dfd
RD
8407 Lowers the window to the bottom of the window hierarchy. In current
8408 version of wxWidgets this works both for manage and child windows.
15afbcd0 8409 """
54f9ee45 8410 return _core_.Window_Lower(*args, **kwargs)
e811c8ce
RD
8411
8412 def SetClientSize(*args, **kwargs):
15afbcd0 8413 """
a95a7133 8414 SetClientSize(self, Size size)
15afbcd0
RD
8415
8416 This sets the size of the window client area in pixels. Using this
8417 function to size a window tends to be more device-independent than
8418 wx.Window.SetSize, since the application need not worry about what
8419 dimensions the border or title bar have when trying to fit the window
8420 around panel items, for example.
8421 """
54f9ee45 8422 return _core_.Window_SetClientSize(*args, **kwargs)
e811c8ce
RD
8423
8424 def SetClientSizeWH(*args, **kwargs):
15afbcd0 8425 """
a95a7133 8426 SetClientSizeWH(self, int width, int height)
15afbcd0
RD
8427
8428 This sets the size of the window client area in pixels. Using this
8429 function to size a window tends to be more device-independent than
8430 wx.Window.SetSize, since the application need not worry about what
8431 dimensions the border or title bar have when trying to fit the window
8432 around panel items, for example.
8433 """
54f9ee45 8434 return _core_.Window_SetClientSizeWH(*args, **kwargs)
e811c8ce
RD
8435
8436 def SetClientRect(*args, **kwargs):
15afbcd0 8437 """
a95a7133 8438 SetClientRect(self, Rect rect)
15afbcd0
RD
8439
8440 This sets the size of the window client area in pixels. Using this
8441 function to size a window tends to be more device-independent than
8442 wx.Window.SetSize, since the application need not worry about what
8443 dimensions the border or title bar have when trying to fit the window
8444 around panel items, for example.
8445 """
54f9ee45 8446 return _core_.Window_SetClientRect(*args, **kwargs)
e811c8ce
RD
8447
8448 def GetPosition(*args, **kwargs):
0df68c9f 8449 """
a95a7133 8450 GetPosition(self) -> Point
e811c8ce 8451
75219dcb
RD
8452 Get the window's position. Notice that the position is in client
8453 coordinates for child windows and screen coordinates for the top level
8454 ones, use `GetScreenPosition` if you need screen coordinates for all
8455 kinds of windows.
0df68c9f 8456 """
54f9ee45 8457 return _core_.Window_GetPosition(*args, **kwargs)
e811c8ce
RD
8458
8459 def GetPositionTuple(*args, **kwargs):
0df68c9f
RD
8460 """
8461 GetPositionTuple() -> (x,y)
e811c8ce 8462
75219dcb
RD
8463 Get the window's position. Notice that the position is in client
8464 coordinates for child windows and screen coordinates for the top level
8465 ones, use `GetScreenPosition` if you need screen coordinates for all
8466 kinds of windows.
0df68c9f 8467 """
54f9ee45 8468 return _core_.Window_GetPositionTuple(*args, **kwargs)
e811c8ce 8469
75219dcb
RD
8470 def GetScreenPosition(*args, **kwargs):
8471 """
8472 GetScreenPosition(self) -> Point
8473
8474 Get the position of the window in screen coordinantes.
8475 """
8476 return _core_.Window_GetScreenPosition(*args, **kwargs)
8477
8478 def GetScreenPositionTuple(*args, **kwargs):
8479 """
8480 GetScreenPositionTuple() -> (x,y)
8481
8482 Get the position of the window in screen coordinantes.
8483 """
8484 return _core_.Window_GetScreenPositionTuple(*args, **kwargs)
8485
8486 def GetScreenRect(*args, **kwargs):
8487 """
8488 GetScreenRect(self) -> Rect
8489
8490 Returns the size and position of the window in screen coordinantes as
8491 a `wx.Rect` object.
8492 """
8493 return _core_.Window_GetScreenRect(*args, **kwargs)
8494
e811c8ce 8495 def GetSize(*args, **kwargs):
0df68c9f 8496 """
a95a7133 8497 GetSize(self) -> Size
e811c8ce 8498
0df68c9f
RD
8499 Get the window size.
8500 """
54f9ee45 8501 return _core_.Window_GetSize(*args, **kwargs)
e811c8ce
RD
8502
8503 def GetSizeTuple(*args, **kwargs):
0df68c9f
RD
8504 """
8505 GetSizeTuple() -> (width, height)
e811c8ce 8506
0df68c9f
RD
8507 Get the window size.
8508 """
54f9ee45 8509 return _core_.Window_GetSizeTuple(*args, **kwargs)
e811c8ce
RD
8510
8511 def GetRect(*args, **kwargs):
15afbcd0 8512 """
a95a7133 8513 GetRect(self) -> Rect
15afbcd0 8514
75219dcb 8515 Returns the size and position of the window as a `wx.Rect` object.
15afbcd0 8516 """
54f9ee45 8517 return _core_.Window_GetRect(*args, **kwargs)
e811c8ce
RD
8518
8519 def GetClientSize(*args, **kwargs):
0df68c9f 8520 """
a95a7133 8521 GetClientSize(self) -> Size
e811c8ce 8522
15afbcd0
RD
8523 This gets the size of the window's 'client area' in pixels. The client
8524 area is the area which may be drawn on by the programmer, excluding
8525 title bar, border, scrollbars, etc.
0df68c9f 8526 """
54f9ee45 8527 return _core_.Window_GetClientSize(*args, **kwargs)
e811c8ce
RD
8528
8529 def GetClientSizeTuple(*args, **kwargs):
0df68c9f
RD
8530 """
8531 GetClientSizeTuple() -> (width, height)
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_GetClientSizeTuple(*args, **kwargs)
e811c8ce
RD
8538
8539 def GetClientAreaOrigin(*args, **kwargs):
15afbcd0 8540 """
a95a7133 8541 GetClientAreaOrigin(self) -> Point
15afbcd0
RD
8542
8543 Get the origin of the client area of the window relative to the
8544 window's top left corner (the client area may be shifted because of
8545 the borders, scrollbars, other decorations...)
8546 """
54f9ee45 8547 return _core_.Window_GetClientAreaOrigin(*args, **kwargs)
e811c8ce
RD
8548
8549 def GetClientRect(*args, **kwargs):
15afbcd0 8550 """
a95a7133 8551 GetClientRect(self) -> Rect
15afbcd0 8552
61863841 8553 Get the client area position and size as a `wx.Rect` object.
15afbcd0 8554 """
54f9ee45 8555 return _core_.Window_GetClientRect(*args, **kwargs)
e811c8ce
RD
8556
8557 def GetBestSize(*args, **kwargs):
0df68c9f 8558 """
a95a7133 8559 GetBestSize(self) -> Size
e811c8ce 8560
248ed943 8561 This function returns the best acceptable minimal size for the
41e2b43e
RD
8562 window, if applicable. For example, for a static text control, it will
8563 be the minimal size such that the control label is not truncated. For
8564 windows containing subwindows (suzh aswx.Panel), the size returned by
8565 this function will be the same as the size the window would have had
8566 after calling Fit.
0df68c9f 8567 """
54f9ee45 8568 return _core_.Window_GetBestSize(*args, **kwargs)
e811c8ce
RD
8569
8570 def GetBestSizeTuple(*args, **kwargs):
0df68c9f
RD
8571 """
8572 GetBestSizeTuple() -> (width, height)
e811c8ce 8573
248ed943 8574 This function returns the best acceptable minimal size for the
41e2b43e
RD
8575 window, if applicable. For example, for a static text control, it will
8576 be the minimal size such that the control label is not truncated. For
8577 windows containing subwindows (suzh aswx.Panel), the size returned by
8578 this function will be the same as the size the window would have had
8579 after calling Fit.
0df68c9f 8580 """
54f9ee45 8581 return _core_.Window_GetBestSizeTuple(*args, **kwargs)
e811c8ce 8582
dfbb5885
RD
8583 def InvalidateBestSize(*args, **kwargs):
8584 """
8585 InvalidateBestSize(self)
8586
8587 Reset the cached best size value so it will be recalculated the next
8588 time it is needed.
8589 """
8590 return _core_.Window_InvalidateBestSize(*args, **kwargs)
8591
e2813725
RD
8592 def CacheBestSize(*args, **kwargs):
8593 """
8594 CacheBestSize(self, Size size)
8595
8596 Cache the best size so it doesn't need to be calculated again, (at least until
8597 some properties of the window change.)
8598 """
8599 return _core_.Window_CacheBestSize(*args, **kwargs)
8600
580080c5 8601 def GetEffectiveMinSize(*args, **kwargs):
dfbb5885 8602 """
580080c5 8603 GetEffectiveMinSize(self) -> Size
dfbb5885
RD
8604
8605 This function will merge the window's best size into the window's
8606 minimum size, giving priority to the min size components, and returns
8607 the results.
8608
8609 """
580080c5 8610 return _core_.Window_GetEffectiveMinSize(*args, **kwargs)
dfbb5885 8611
0d82d64e 8612 GetBestFittingSize = wx._deprecated(GetEffectiveMinSize, 'Use `GetEffectiveMinSize` instead.')
8f514ab4
RD
8613 def GetAdjustedBestSize(self):
8614 s = self.GetBestSize()
8615 return wx.Size(max(s.width, self.GetMinWidth()),
8616 max(s.height, self.GetMinHeight()))
580080c5 8617 GetAdjustedBestSize = wx._deprecated(GetAdjustedBestSize, 'Use `GetEffectiveMinSize` instead.')
e811c8ce
RD
8618
8619 def Center(*args, **kwargs):
15afbcd0 8620 """
a95a7133 8621 Center(self, int direction=BOTH)
15afbcd0
RD
8622
8623 Centers the window. The parameter specifies the direction for
8624 cetering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may
8625 also include wx.CENTER_ON_SCREEN flag if you want to center the window
8626 on the entire screen and not on its parent window. If it is a
8627 top-level window and has no parent then it will always be centered
8628 relative to the screen.
8629 """
54f9ee45 8630 return _core_.Window_Center(*args, **kwargs)
e811c8ce
RD
8631
8632 Centre = Center
e811c8ce 8633 def CenterOnParent(*args, **kwargs):
15afbcd0 8634 """
a95a7133 8635 CenterOnParent(self, int dir=BOTH)
15afbcd0
RD
8636
8637 Center with respect to the the parent window
8638 """
54f9ee45 8639 return _core_.Window_CenterOnParent(*args, **kwargs)
e811c8ce
RD
8640
8641 CentreOnParent = CenterOnParent
8642 def Fit(*args, **kwargs):
15afbcd0 8643 """
a95a7133 8644 Fit(self)
15afbcd0
RD
8645
8646 Sizes the window so that it fits around its subwindows. This function
8647 won't do anything if there are no subwindows and will only really work
8648 correctly if sizers are used for the subwindows layout. Also, if the
8649 window has exactly one subwindow it is better (faster and the result
8650 is more precise as Fit adds some margin to account for fuzziness of
8651 its calculations) to call window.SetClientSize(child.GetSize())
8652 instead of calling Fit.
8653 """
54f9ee45 8654 return _core_.Window_Fit(*args, **kwargs)
e811c8ce
RD
8655
8656 def FitInside(*args, **kwargs):
15afbcd0 8657 """
a95a7133 8658 FitInside(self)
15afbcd0
RD
8659
8660 Similar to Fit, but sizes the interior (virtual) size of a
8661 window. Mainly useful with scrolled windows to reset scrollbars after
8662 sizing changes that do not trigger a size event, and/or scrolled
8663 windows without an interior sizer. This function similarly won't do
8664 anything if there are no subwindows.
8665 """
54f9ee45 8666 return _core_.Window_FitInside(*args, **kwargs)
e811c8ce 8667
f16ab95d 8668 def SetSizeHints(*args, **kwargs):
0df68c9f 8669 """
a95a7133 8670 SetSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1,
0df68c9f 8671 int incH=-1)
15afbcd0
RD
8672
8673 Allows specification of minimum and maximum window sizes, and window
8674 size increments. If a pair of values is not set (or set to -1), the
8675 default values will be used. If this function is called, the user
908b74cd
RD
8676 will not be able to size the window outside the given bounds (if it is
8677 a top-level window.) Sizers will also inspect the minimum window size
8678 and will use that value if set when calculating layout.
8679
8680 The resizing increments are only significant under Motif or Xt.
0df68c9f 8681 """
f16ab95d 8682 return _core_.Window_SetSizeHints(*args, **kwargs)
e811c8ce 8683
f16ab95d
RD
8684 def SetSizeHintsSz(*args, **kwargs):
8685 """
8686 SetSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize, Size incSize=DefaultSize)
8687
8688 Allows specification of minimum and maximum window sizes, and window
8689 size increments. If a pair of values is not set (or set to -1), the
8690 default values will be used. If this function is called, the user
8691 will not be able to size the window outside the given bounds (if it is
8692 a top-level window.) Sizers will also inspect the minimum window size
8693 and will use that value if set when calculating layout.
8694
8695 The resizing increments are only significant under Motif or Xt.
8696 """
8697 return _core_.Window_SetSizeHintsSz(*args, **kwargs)
8698
8699 def SetVirtualSizeHints(*args, **kwargs):
15afbcd0 8700 """
908b74cd 8701 SetVirtualSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1)
15afbcd0
RD
8702
8703 Allows specification of minimum and maximum virtual window sizes. If a
8704 pair of values is not set (or set to -1), the default values will be
8705 used. If this function is called, the user will not be able to size
8706 the virtual area of the window outside the given bounds.
8707 """
f16ab95d
RD
8708 return _core_.Window_SetVirtualSizeHints(*args, **kwargs)
8709
8710 def SetVirtualSizeHintsSz(*args, **kwargs):
8711 """
8712 SetVirtualSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize)
8713
8714 Allows specification of minimum and maximum virtual window sizes. If a
8715 pair of values is not set (or set to -1), the default values will be
8716 used. If this function is called, the user will not be able to size
8717 the virtual area of the window outside the given bounds.
8718 """
8719 return _core_.Window_SetVirtualSizeHintsSz(*args, **kwargs)
e811c8ce 8720
908b74cd
RD
8721 def GetMaxSize(*args, **kwargs):
8722 """GetMaxSize(self) -> Size"""
8723 return _core_.Window_GetMaxSize(*args, **kwargs)
8724
8725 def GetMinSize(*args, **kwargs):
8726 """GetMinSize(self) -> Size"""
8727 return _core_.Window_GetMinSize(*args, **kwargs)
8728
8729 def SetMinSize(*args, **kwargs):
8730 """
8731 SetMinSize(self, Size minSize)
8732
8733 A more convenient method than `SetSizeHints` for setting just the
8734 min size.
8735 """
8736 return _core_.Window_SetMinSize(*args, **kwargs)
8737
8738 def SetMaxSize(*args, **kwargs):
8739 """
8740 SetMaxSize(self, Size maxSize)
8741
8742 A more convenient method than `SetSizeHints` for setting just the
8743 max size.
8744 """
8745 return _core_.Window_SetMaxSize(*args, **kwargs)
8746
e811c8ce 8747 def GetMinWidth(*args, **kwargs):
a95a7133 8748 """GetMinWidth(self) -> int"""
54f9ee45 8749 return _core_.Window_GetMinWidth(*args, **kwargs)
e811c8ce
RD
8750
8751 def GetMinHeight(*args, **kwargs):
a95a7133 8752 """GetMinHeight(self) -> int"""
54f9ee45 8753 return _core_.Window_GetMinHeight(*args, **kwargs)
e811c8ce
RD
8754
8755 def GetMaxWidth(*args, **kwargs):
a95a7133 8756 """GetMaxWidth(self) -> int"""
54f9ee45 8757 return _core_.Window_GetMaxWidth(*args, **kwargs)
e811c8ce
RD
8758
8759 def GetMaxHeight(*args, **kwargs):
a95a7133 8760 """GetMaxHeight(self) -> int"""
54f9ee45 8761 return _core_.Window_GetMaxHeight(*args, **kwargs)
e811c8ce 8762
e811c8ce 8763 def SetVirtualSize(*args, **kwargs):
0df68c9f 8764 """
a95a7133 8765 SetVirtualSize(self, Size size)
e811c8ce 8766
15afbcd0
RD
8767 Set the the virtual size of a window in pixels. For most windows this
8768 is just the client area of the window, but for some like scrolled
8769 windows it is more or less independent of the screen window size.
0df68c9f 8770 """
54f9ee45 8771 return _core_.Window_SetVirtualSize(*args, **kwargs)
e811c8ce
RD
8772
8773 def SetVirtualSizeWH(*args, **kwargs):
0df68c9f 8774 """
a95a7133 8775 SetVirtualSizeWH(self, int w, int h)
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_SetVirtualSizeWH(*args, **kwargs)
e811c8ce
RD
8782
8783 def GetVirtualSize(*args, **kwargs):
0df68c9f 8784 """
a95a7133 8785 GetVirtualSize(self) -> Size
e811c8ce 8786
15afbcd0
RD
8787 Get the the virtual size of the window in pixels. For most windows
8788 this is just the client area of the window, but for some like scrolled
8789 windows it is more or less independent of the screen window size.
0df68c9f 8790 """
54f9ee45 8791 return _core_.Window_GetVirtualSize(*args, **kwargs)
e811c8ce
RD
8792
8793 def GetVirtualSizeTuple(*args, **kwargs):
0df68c9f
RD
8794 """
8795 GetVirtualSizeTuple() -> (width, height)
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_GetVirtualSizeTuple(*args, **kwargs)
e811c8ce 8802
cbdf0fb0
RD
8803 def GetWindowBorderSize(*args, **kwargs):
8804 """
8805 GetWindowBorderSize(self) -> Size
8806
8807 Return the size of the left/right and top/bottom borders.
8808 """
8809 return _core_.Window_GetWindowBorderSize(*args, **kwargs)
8810
e811c8ce 8811 def GetBestVirtualSize(*args, **kwargs):
15afbcd0 8812 """
a95a7133 8813 GetBestVirtualSize(self) -> Size
15afbcd0
RD
8814
8815 Return the largest of ClientSize and BestSize (as determined by a
8816 sizer, interior children, or other means)
8817 """
54f9ee45 8818 return _core_.Window_GetBestVirtualSize(*args, **kwargs)
e811c8ce
RD
8819
8820 def Show(*args, **kwargs):
15afbcd0 8821 """
a95a7133 8822 Show(self, bool show=True) -> bool
15afbcd0
RD
8823
8824 Shows or hides the window. You may need to call Raise for a top level
8825 window if you want to bring it to top, although this is not needed if
8826 Show is called immediately after the frame creation. Returns True if
8827 the window has been shown or hidden or False if nothing was done
8828 because it already was in the requested state.
8829 """
54f9ee45 8830 return _core_.Window_Show(*args, **kwargs)
e811c8ce
RD
8831
8832 def Hide(*args, **kwargs):
15afbcd0 8833 """
a95a7133 8834 Hide(self) -> bool
15afbcd0
RD
8835
8836 Equivalent to calling Show(False).
8837 """
54f9ee45 8838 return _core_.Window_Hide(*args, **kwargs)
e811c8ce
RD
8839
8840 def Enable(*args, **kwargs):
15afbcd0 8841 """
a95a7133 8842 Enable(self, bool enable=True) -> bool
15afbcd0
RD
8843
8844 Enable or disable the window for user input. Note that when a parent
8845 window is disabled, all of its children are disabled as well and they
8846 are reenabled again when the parent is. Returns true if the window
8847 has been enabled or disabled, false if nothing was done, i.e. if the
8848 window had already been in the specified state.
8849 """
54f9ee45 8850 return _core_.Window_Enable(*args, **kwargs)
e811c8ce
RD
8851
8852 def Disable(*args, **kwargs):
15afbcd0 8853 """
a95a7133 8854 Disable(self) -> bool
15afbcd0
RD
8855
8856 Disables the window, same as Enable(false).
8857 """
54f9ee45 8858 return _core_.Window_Disable(*args, **kwargs)
e811c8ce
RD
8859
8860 def IsShown(*args, **kwargs):
15afbcd0 8861 """
a95a7133 8862 IsShown(self) -> bool
15afbcd0
RD
8863
8864 Returns true if the window is shown, false if it has been hidden.
8865 """
54f9ee45 8866 return _core_.Window_IsShown(*args, **kwargs)
e811c8ce
RD
8867
8868 def IsEnabled(*args, **kwargs):
15afbcd0 8869 """
a95a7133 8870 IsEnabled(self) -> bool
15afbcd0
RD
8871
8872 Returns true if the window is enabled for input, false otherwise.
8873 """
54f9ee45 8874 return _core_.Window_IsEnabled(*args, **kwargs)
e811c8ce 8875
33d6fd3b
RD
8876 def IsShownOnScreen(*args, **kwargs):
8877 """
8878 IsShownOnScreen(self) -> bool
8879
8880 Returns ``True`` if the window is physically visible on the screen,
8881 i.e. it is shown and all its parents up to the toplevel window are
8882 shown as well.
8883 """
8884 return _core_.Window_IsShownOnScreen(*args, **kwargs)
8885
e811c8ce 8886 def SetWindowStyleFlag(*args, **kwargs):
15afbcd0 8887 """
a95a7133 8888 SetWindowStyleFlag(self, long style)
15afbcd0 8889
41e2b43e
RD
8890 Sets the style of the window. Please note that some styles cannot be
8891 changed after the window creation and that Refresh() might need to be
8892 called after changing the others for the change to take place
8893 immediately.
15afbcd0 8894 """
54f9ee45 8895 return _core_.Window_SetWindowStyleFlag(*args, **kwargs)
e811c8ce
RD
8896
8897 def GetWindowStyleFlag(*args, **kwargs):
15afbcd0 8898 """
a95a7133 8899 GetWindowStyleFlag(self) -> long
e811c8ce 8900
15afbcd0
RD
8901 Gets the window style that was passed to the constructor or Create
8902 method.
8903 """
54f9ee45 8904 return _core_.Window_GetWindowStyleFlag(*args, **kwargs)
e811c8ce 8905
15afbcd0 8906 SetWindowStyle = SetWindowStyleFlag; GetWindowStyle = GetWindowStyleFlag
e811c8ce 8907 def HasFlag(*args, **kwargs):
15afbcd0 8908 """
a95a7133 8909 HasFlag(self, int flag) -> bool
15afbcd0
RD
8910
8911 Test if the given style is set for this window.
8912 """
54f9ee45 8913 return _core_.Window_HasFlag(*args, **kwargs)
e811c8ce
RD
8914
8915 def IsRetained(*args, **kwargs):
15afbcd0 8916 """
a95a7133 8917 IsRetained(self) -> bool
15afbcd0
RD
8918
8919 Returns true if the window is retained, false otherwise. Retained
8920 windows are only available on X platforms.
8921 """
54f9ee45 8922 return _core_.Window_IsRetained(*args, **kwargs)
e811c8ce 8923
5917d041
RD
8924 def ToggleWindowStyle(*args, **kwargs):
8925 """
8926 ToggleWindowStyle(self, int flag) -> bool
8927
8928 Turn the flag on if it had been turned off before and vice versa,
8929 returns True if the flag is turned on by this function call.
8930 """
8931 return _core_.Window_ToggleWindowStyle(*args, **kwargs)
8932
e811c8ce 8933 def SetExtraStyle(*args, **kwargs):
15afbcd0 8934 """
a95a7133 8935 SetExtraStyle(self, long exStyle)
15afbcd0
RD
8936
8937 Sets the extra style bits for the window. Extra styles are the less
8938 often used style bits which can't be set with the constructor or with
8939 SetWindowStyleFlag()
8940 """
54f9ee45 8941 return _core_.Window_SetExtraStyle(*args, **kwargs)
e811c8ce
RD
8942
8943 def GetExtraStyle(*args, **kwargs):
15afbcd0 8944 """
a95a7133 8945 GetExtraStyle(self) -> long
15afbcd0
RD
8946
8947 Returns the extra style bits for the window.
8948 """
54f9ee45 8949 return _core_.Window_GetExtraStyle(*args, **kwargs)
e811c8ce
RD
8950
8951 def MakeModal(*args, **kwargs):
15afbcd0 8952 """
a95a7133 8953 MakeModal(self, bool modal=True)
15afbcd0
RD
8954
8955 Disables all other windows in the application so that the user can
8956 only interact with this window. Passing False will reverse this
8957 effect.
8958 """
54f9ee45 8959 return _core_.Window_MakeModal(*args, **kwargs)
e811c8ce
RD
8960
8961 def SetThemeEnabled(*args, **kwargs):
15afbcd0 8962 """
a95a7133 8963 SetThemeEnabled(self, bool enableTheme)
15afbcd0
RD
8964
8965 This function tells a window if it should use the system's "theme"
8966 code to draw the windows' background instead if its own background
8967 drawing code. This will only have an effect on platforms that support
8968 the notion of themes in user defined windows. One such platform is
8969 GTK+ where windows can have (very colourful) backgrounds defined by a
8970 user's selected theme.
8971
8972 Dialogs, notebook pages and the status bar have this flag set to true
8973 by default so that the default look and feel is simulated best.
8974 """
54f9ee45 8975 return _core_.Window_SetThemeEnabled(*args, **kwargs)
e811c8ce
RD
8976
8977 def GetThemeEnabled(*args, **kwargs):
15afbcd0 8978 """
a95a7133 8979 GetThemeEnabled(self) -> bool
e811c8ce 8980
15afbcd0
RD
8981 Return the themeEnabled flag.
8982 """
54f9ee45 8983 return _core_.Window_GetThemeEnabled(*args, **kwargs)
e811c8ce
RD
8984
8985 def SetFocus(*args, **kwargs):
15afbcd0 8986 """
a95a7133 8987 SetFocus(self)
15afbcd0
RD
8988
8989 Set's the focus to this window, allowing it to receive keyboard input.
8990 """
54f9ee45 8991 return _core_.Window_SetFocus(*args, **kwargs)
e811c8ce
RD
8992
8993 def SetFocusFromKbd(*args, **kwargs):
15afbcd0 8994 """
a95a7133 8995 SetFocusFromKbd(self)
15afbcd0
RD
8996
8997 Set focus to this window as the result of a keyboard action. Normally
8998 only called internally.
8999 """
54f9ee45 9000 return _core_.Window_SetFocusFromKbd(*args, **kwargs)
e811c8ce
RD
9001
9002 def FindFocus(*args, **kwargs):
15afbcd0 9003 """
66c033b4 9004 FindFocus() -> Window
15afbcd0
RD
9005
9006 Returns the window or control that currently has the keyboard focus,
9007 or None.
9008 """
54f9ee45 9009 return _core_.Window_FindFocus(*args, **kwargs)
e811c8ce
RD
9010
9011 FindFocus = staticmethod(FindFocus)
9012 def AcceptsFocus(*args, **kwargs):
15afbcd0 9013 """
a95a7133 9014 AcceptsFocus(self) -> bool
15afbcd0
RD
9015
9016 Can this window have focus?
9017 """
54f9ee45 9018 return _core_.Window_AcceptsFocus(*args, **kwargs)
e811c8ce
RD
9019
9020 def AcceptsFocusFromKeyboard(*args, **kwargs):
15afbcd0 9021 """
a95a7133 9022 AcceptsFocusFromKeyboard(self) -> bool
15afbcd0
RD
9023
9024 Can this window be given focus by keyboard navigation? if not, the
9025 only way to give it focus (provided it accepts it at all) is to click
9026 it.
9027 """
54f9ee45 9028 return _core_.Window_AcceptsFocusFromKeyboard(*args, **kwargs)
e811c8ce 9029
908b74cd
RD
9030 def Navigate(*args, **kwargs):
9031 """
9032 Navigate(self, int flags=NavigationKeyEvent.IsForward) -> bool
9033
fd2dc343
RD
9034 Does keyboard navigation from this window to another, by sending a
9035 `wx.NavigationKeyEvent`.
908b74cd
RD
9036 """
9037 return _core_.Window_Navigate(*args, **kwargs)
9038
7f98d120
RD
9039 def MoveAfterInTabOrder(*args, **kwargs):
9040 """
9041 MoveAfterInTabOrder(self, Window win)
9042
9043 Moves this window in the tab navigation order after the specified
9044 sibling window. This means that when the user presses the TAB key on
9045 that other window, the focus switches to this window.
9046
9047 The default tab order is the same as creation order. This function
9048 and `MoveBeforeInTabOrder` allow to change it after creating all the
9049 windows.
9050
9051 """
9052 return _core_.Window_MoveAfterInTabOrder(*args, **kwargs)
9053
9054 def MoveBeforeInTabOrder(*args, **kwargs):
9055 """
9056 MoveBeforeInTabOrder(self, Window win)
9057
9058 Same as `MoveAfterInTabOrder` except that it inserts this window just
9059 before win instead of putting it right after it.
9060 """
9061 return _core_.Window_MoveBeforeInTabOrder(*args, **kwargs)
9062
e811c8ce 9063 def GetChildren(*args, **kwargs):
15afbcd0 9064 """
a95a7133 9065 GetChildren(self) -> PyObject
15afbcd0
RD
9066
9067 Returns a list of the window's children. NOTE: Currently this is a
9068 copy of the child window list maintained by the window, so the return
9069 value of this function is only valid as long as the window's children
9070 do not change.
9071 """
54f9ee45 9072 return _core_.Window_GetChildren(*args, **kwargs)
e811c8ce
RD
9073
9074 def GetParent(*args, **kwargs):
15afbcd0 9075 """
a95a7133 9076 GetParent(self) -> Window
15afbcd0
RD
9077
9078 Returns the parent window of this window, or None if there isn't one.
9079 """
54f9ee45 9080 return _core_.Window_GetParent(*args, **kwargs)
e811c8ce
RD
9081
9082 def GetGrandParent(*args, **kwargs):
15afbcd0 9083 """
a95a7133 9084 GetGrandParent(self) -> Window
15afbcd0 9085
41e2b43e
RD
9086 Returns the parent of the parent of this window, or None if there
9087 isn't one.
15afbcd0 9088 """
54f9ee45 9089 return _core_.Window_GetGrandParent(*args, **kwargs)
e811c8ce
RD
9090
9091 def IsTopLevel(*args, **kwargs):
15afbcd0 9092 """
a95a7133 9093 IsTopLevel(self) -> bool
15afbcd0
RD
9094
9095 Returns true if the given window is a top-level one. Currently all
9096 frames and dialogs are always considered to be top-level windows (even
9097 if they have a parent window).
9098 """
54f9ee45 9099 return _core_.Window_IsTopLevel(*args, **kwargs)
e811c8ce
RD
9100
9101 def Reparent(*args, **kwargs):
15afbcd0 9102 """
a95a7133 9103 Reparent(self, Window newParent) -> bool
15afbcd0
RD
9104
9105 Reparents the window, i.e the window will be removed from its current
9106 parent window (e.g. a non-standard toolbar in a wxFrame) and then
9107 re-inserted into another. Available on Windows and GTK. Returns True
9108 if the parent was changed, False otherwise (error or newParent ==
9109 oldParent)
9110 """
54f9ee45 9111 return _core_.Window_Reparent(*args, **kwargs)
e811c8ce
RD
9112
9113 def AddChild(*args, **kwargs):
15afbcd0 9114 """
a95a7133 9115 AddChild(self, Window child)
15afbcd0
RD
9116
9117 Adds a child window. This is called automatically by window creation
9118 functions so should not be required by the application programmer.
9119 """
54f9ee45 9120 return _core_.Window_AddChild(*args, **kwargs)
e811c8ce
RD
9121
9122 def RemoveChild(*args, **kwargs):
15afbcd0 9123 """
a95a7133 9124 RemoveChild(self, Window child)
15afbcd0
RD
9125
9126 Removes a child window. This is called automatically by window
9127 deletion functions so should not be required by the application
9128 programmer.
9129 """
54f9ee45 9130 return _core_.Window_RemoveChild(*args, **kwargs)
e811c8ce 9131
704eda0c
RD
9132 def SetDoubleBuffered(*args, **kwargs):
9133 """
9134 SetDoubleBuffered(self, bool on)
9135
9136 Currently wxGTK2 only.
9137 """
9138 return _core_.Window_SetDoubleBuffered(*args, **kwargs)
9139
e811c8ce 9140 def FindWindowById(*args, **kwargs):
15afbcd0 9141 """
a95a7133 9142 FindWindowById(self, long winid) -> Window
15afbcd0
RD
9143
9144 Find a chld of this window by window ID
9145 """
54f9ee45 9146 return _core_.Window_FindWindowById(*args, **kwargs)
e811c8ce
RD
9147
9148 def FindWindowByName(*args, **kwargs):
15afbcd0 9149 """
a95a7133 9150 FindWindowByName(self, String name) -> Window
15afbcd0
RD
9151
9152 Find a child of this window by name
9153 """
54f9ee45 9154 return _core_.Window_FindWindowByName(*args, **kwargs)
e811c8ce
RD
9155
9156 def GetEventHandler(*args, **kwargs):
15afbcd0 9157 """
a95a7133 9158 GetEventHandler(self) -> EvtHandler
15afbcd0
RD
9159
9160 Returns the event handler for this window. By default, the window is
9161 its own event handler.
9162 """
54f9ee45 9163 return _core_.Window_GetEventHandler(*args, **kwargs)
e811c8ce
RD
9164
9165 def SetEventHandler(*args, **kwargs):
15afbcd0 9166 """
a95a7133 9167 SetEventHandler(self, EvtHandler handler)
15afbcd0
RD
9168
9169 Sets the event handler for this window. An event handler is an object
d49bdf34
RD
9170 that is capable of processing the events sent to a window. (In other
9171 words, is able to dispatch the events to handler function.) By
9172 default, the window is its own event handler, but an application may
9173 wish to substitute another, for example to allow central
9174 implementation of event-handling for a variety of different window
9175 classes.
15afbcd0 9176
41e2b43e 9177 It is usually better to use `wx.Window.PushEventHandler` since this sets
15afbcd0 9178 up a chain of event handlers, where an event not handled by one event
d49bdf34 9179 handler is handed off to the next one in the chain.
15afbcd0 9180 """
54f9ee45 9181 return _core_.Window_SetEventHandler(*args, **kwargs)
e811c8ce
RD
9182
9183 def PushEventHandler(*args, **kwargs):
15afbcd0 9184 """
a95a7133 9185 PushEventHandler(self, EvtHandler handler)
15afbcd0
RD
9186
9187 Pushes this event handler onto the event handler stack for the window.
9188 An event handler is an object that is capable of processing the events
d49bdf34
RD
9189 sent to a window. (In other words, is able to dispatch the events to
9190 handler function.) By default, the window is its own event handler,
9191 but an application may wish to substitute another, for example to
9192 allow central implementation of event-handling for a variety of
9193 different window classes.
15afbcd0
RD
9194
9195 wx.Window.PushEventHandler allows an application to set up a chain of
9196 event handlers, where an event not handled by one event handler is
d49bdf34
RD
9197 handed to the next one in the chain. Use `wx.Window.PopEventHandler`
9198 to remove the event handler. Ownership of the handler is *not* given
9199 to the window, so you should be sure to pop the handler before the
9200 window is destroyed and either let PopEventHandler destroy it, or call
9201 its Destroy method yourself.
15afbcd0 9202 """
54f9ee45 9203 return _core_.Window_PushEventHandler(*args, **kwargs)
e811c8ce
RD
9204
9205 def PopEventHandler(*args, **kwargs):
15afbcd0 9206 """
a95a7133 9207 PopEventHandler(self, bool deleteHandler=False) -> EvtHandler
15afbcd0
RD
9208
9209 Removes and returns the top-most event handler on the event handler
9210 stack. If deleteHandler is True then the wx.EvtHandler object will be
d49bdf34 9211 destroyed after it is popped, and ``None`` will be returned instead.
15afbcd0 9212 """
54f9ee45 9213 return _core_.Window_PopEventHandler(*args, **kwargs)
e811c8ce
RD
9214
9215 def RemoveEventHandler(*args, **kwargs):
15afbcd0 9216 """
a95a7133 9217 RemoveEventHandler(self, EvtHandler handler) -> bool
15afbcd0 9218
41e2b43e 9219 Find the given handler in the event handler chain and remove (but not
d49bdf34 9220 delete) it from the event handler chain, returns True if it was found
41e2b43e
RD
9221 and False otherwise (this also results in an assert failure so this
9222 function should only be called when the handler is supposed to be
9223 there.)
15afbcd0 9224 """
54f9ee45 9225 return _core_.Window_RemoveEventHandler(*args, **kwargs)
e811c8ce
RD
9226
9227 def SetValidator(*args, **kwargs):
15afbcd0 9228 """
a95a7133 9229 SetValidator(self, Validator validator)
15afbcd0
RD
9230
9231 Deletes the current validator (if any) and sets the window validator,
9232 having called wx.Validator.Clone to create a new validator of this
9233 type.
9234 """
54f9ee45 9235 return _core_.Window_SetValidator(*args, **kwargs)
e811c8ce
RD
9236
9237 def GetValidator(*args, **kwargs):
15afbcd0 9238 """
a95a7133 9239 GetValidator(self) -> Validator
15afbcd0
RD
9240
9241 Returns a pointer to the current validator for the window, or None if
9242 there is none.
9243 """
54f9ee45 9244 return _core_.Window_GetValidator(*args, **kwargs)
e811c8ce 9245
74a57fcd
RD
9246 def Validate(*args, **kwargs):
9247 """
a95a7133 9248 Validate(self) -> bool
74a57fcd
RD
9249
9250 Validates the current values of the child controls using their
41e2b43e
RD
9251 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
9252 style flag set, the method will also call Validate() of all child
9253 windows. Returns false if any of the validations failed.
74a57fcd 9254 """
54f9ee45 9255 return _core_.Window_Validate(*args, **kwargs)
74a57fcd
RD
9256
9257 def TransferDataToWindow(*args, **kwargs):
9258 """
a95a7133 9259 TransferDataToWindow(self) -> bool
74a57fcd 9260
41e2b43e
RD
9261 Transfers values to child controls from data areas specified by their
9262 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
9263 style flag set, the method will also call TransferDataToWindow() of
9264 all child windows.
74a57fcd 9265 """
54f9ee45 9266 return _core_.Window_TransferDataToWindow(*args, **kwargs)
74a57fcd
RD
9267
9268 def TransferDataFromWindow(*args, **kwargs):
9269 """
a95a7133 9270 TransferDataFromWindow(self) -> bool
74a57fcd 9271
41e2b43e
RD
9272 Transfers values from child controls to data areas specified by their
9273 validators. Returns false if a transfer failed. If the window has
9274 wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will
9275 also call TransferDataFromWindow() of all child windows.
74a57fcd 9276 """
54f9ee45 9277 return _core_.Window_TransferDataFromWindow(*args, **kwargs)
74a57fcd
RD
9278
9279 def InitDialog(*args, **kwargs):
9280 """
a95a7133 9281 InitDialog(self)
74a57fcd 9282
41e2b43e
RD
9283 Sends an EVT_INIT_DIALOG event, whose handler usually transfers data
9284 to the dialog via validators.
74a57fcd 9285 """
54f9ee45 9286 return _core_.Window_InitDialog(*args, **kwargs)
74a57fcd 9287
e811c8ce 9288 def SetAcceleratorTable(*args, **kwargs):
15afbcd0 9289 """
a95a7133 9290 SetAcceleratorTable(self, AcceleratorTable accel)
15afbcd0
RD
9291
9292 Sets the accelerator table for this window.
9293 """
54f9ee45 9294 return _core_.Window_SetAcceleratorTable(*args, **kwargs)
e811c8ce
RD
9295
9296 def GetAcceleratorTable(*args, **kwargs):
15afbcd0 9297 """
a95a7133 9298 GetAcceleratorTable(self) -> AcceleratorTable
15afbcd0
RD
9299
9300 Gets the accelerator table for this window.
9301 """
54f9ee45 9302 return _core_.Window_GetAcceleratorTable(*args, **kwargs)
e811c8ce
RD
9303
9304 def RegisterHotKey(*args, **kwargs):
15afbcd0 9305 """
a95a7133 9306 RegisterHotKey(self, int hotkeyId, int modifiers, int keycode) -> bool
15afbcd0
RD
9307
9308 Registers a system wide hotkey. Every time the user presses the hotkey
9309 registered here, this window will receive a hotkey event. It will
9310 receive the event even if the application is in the background and
9311 does not have the input focus because the user is working with some
9312 other application. To bind an event handler function to this hotkey
9313 use EVT_HOTKEY with an id equal to hotkeyId. Returns True if the
9314 hotkey was registered successfully.
9315 """
54f9ee45 9316 return _core_.Window_RegisterHotKey(*args, **kwargs)
e811c8ce
RD
9317
9318 def UnregisterHotKey(*args, **kwargs):
15afbcd0 9319 """
a95a7133 9320 UnregisterHotKey(self, int hotkeyId) -> bool
15afbcd0
RD
9321
9322 Unregisters a system wide hotkey.
9323 """
54f9ee45 9324 return _core_.Window_UnregisterHotKey(*args, **kwargs)
e811c8ce
RD
9325
9326 def ConvertDialogPointToPixels(*args, **kwargs):
15afbcd0 9327 """
a95a7133 9328 ConvertDialogPointToPixels(self, Point pt) -> Point
15afbcd0
RD
9329
9330 Converts a point or size from dialog units to pixels. Dialog units
9331 are used for maintaining a dialog's proportions even if the font
9332 changes. For the x dimension, the dialog units are multiplied by the
9333 average character width and then divided by 4. For the y dimension,
9334 the dialog units are multiplied by the average character height and
9335 then divided by 8.
9336 """
54f9ee45 9337 return _core_.Window_ConvertDialogPointToPixels(*args, **kwargs)
e811c8ce
RD
9338
9339 def ConvertDialogSizeToPixels(*args, **kwargs):
15afbcd0 9340 """
a95a7133 9341 ConvertDialogSizeToPixels(self, Size sz) -> Size
15afbcd0
RD
9342
9343 Converts a point or size from dialog units to pixels. Dialog units
9344 are used for maintaining a dialog's proportions even if the font
9345 changes. For the x dimension, the dialog units are multiplied by the
9346 average character width and then divided by 4. For the y dimension,
9347 the dialog units are multiplied by the average character height and
9348 then divided by 8.
9349 """
54f9ee45 9350 return _core_.Window_ConvertDialogSizeToPixels(*args, **kwargs)
e811c8ce
RD
9351
9352 def DLG_PNT(*args, **kwargs):
15afbcd0 9353 """
a95a7133 9354 DLG_PNT(self, Point pt) -> Point
15afbcd0
RD
9355
9356 Converts a point or size from dialog units to pixels. Dialog units
9357 are used for maintaining a dialog's proportions even if the font
9358 changes. For the x dimension, the dialog units are multiplied by the
9359 average character width and then divided by 4. For the y dimension,
9360 the dialog units are multiplied by the average character height and
9361 then divided by 8.
9362 """
54f9ee45 9363 return _core_.Window_DLG_PNT(*args, **kwargs)
e811c8ce
RD
9364
9365 def DLG_SZE(*args, **kwargs):
15afbcd0 9366 """
a95a7133 9367 DLG_SZE(self, Size sz) -> Size
15afbcd0
RD
9368
9369 Converts a point or size from dialog units to pixels. Dialog units
9370 are used for maintaining a dialog's proportions even if the font
9371 changes. For the x dimension, the dialog units are multiplied by the
9372 average character width and then divided by 4. For the y dimension,
9373 the dialog units are multiplied by the average character height and
9374 then divided by 8.
9375 """
54f9ee45 9376 return _core_.Window_DLG_SZE(*args, **kwargs)
e811c8ce
RD
9377
9378 def ConvertPixelPointToDialog(*args, **kwargs):
a95a7133 9379 """ConvertPixelPointToDialog(self, Point pt) -> Point"""
54f9ee45 9380 return _core_.Window_ConvertPixelPointToDialog(*args, **kwargs)
e811c8ce
RD
9381
9382 def ConvertPixelSizeToDialog(*args, **kwargs):
a95a7133 9383 """ConvertPixelSizeToDialog(self, Size sz) -> Size"""
54f9ee45 9384 return _core_.Window_ConvertPixelSizeToDialog(*args, **kwargs)
e811c8ce
RD
9385
9386 def WarpPointer(*args, **kwargs):
15afbcd0 9387 """
a95a7133 9388 WarpPointer(self, int x, int y)
15afbcd0
RD
9389
9390 Moves the pointer to the given position on the window.
9391
9392 NOTE: This function is not supported under Mac because Apple Human
9393 Interface Guidelines forbid moving the mouse cursor programmatically.
9394 """
54f9ee45 9395 return _core_.Window_WarpPointer(*args, **kwargs)
e811c8ce
RD
9396
9397 def CaptureMouse(*args, **kwargs):
15afbcd0 9398 """
a95a7133 9399 CaptureMouse(self)
15afbcd0
RD
9400
9401 Directs all mouse input to this window. Call wx.Window.ReleaseMouse to
9402 release the capture.
9403
9404 Note that wxWindows maintains the stack of windows having captured the
9405 mouse and when the mouse is released the capture returns to the window
9406 which had had captured it previously and it is only really released if
9407 there were no previous window. In particular, this means that you must
34e0a3bb
RD
9408 release the mouse as many times as you capture it, unless the window
9409 receives the `wx.MouseCaptureLostEvent` event.
9410
9411 Any application which captures the mouse in the beginning of some
9412 operation *must* handle `wx.MouseCaptureLostEvent` and cancel this
9413 operation when it receives the event. The event handler must not
9414 recapture mouse.
15afbcd0 9415 """
54f9ee45 9416 return _core_.Window_CaptureMouse(*args, **kwargs)
e811c8ce
RD
9417
9418 def ReleaseMouse(*args, **kwargs):
15afbcd0 9419 """
a95a7133 9420 ReleaseMouse(self)
15afbcd0
RD
9421
9422 Releases mouse input captured with wx.Window.CaptureMouse.
9423 """
54f9ee45 9424 return _core_.Window_ReleaseMouse(*args, **kwargs)
e811c8ce
RD
9425
9426 def GetCapture(*args, **kwargs):
15afbcd0 9427 """
66c033b4 9428 GetCapture() -> Window
15afbcd0
RD
9429
9430 Returns the window which currently captures the mouse or None
9431 """
54f9ee45 9432 return _core_.Window_GetCapture(*args, **kwargs)
e811c8ce
RD
9433
9434 GetCapture = staticmethod(GetCapture)
9435 def HasCapture(*args, **kwargs):
15afbcd0 9436 """
a95a7133 9437 HasCapture(self) -> bool
15afbcd0
RD
9438
9439 Returns true if this window has the current mouse capture.
9440 """
54f9ee45 9441 return _core_.Window_HasCapture(*args, **kwargs)
e811c8ce
RD
9442
9443 def Refresh(*args, **kwargs):
15afbcd0 9444 """
a95a7133 9445 Refresh(self, bool eraseBackground=True, Rect rect=None)
15afbcd0
RD
9446
9447 Mark the specified rectangle (or the whole window) as "dirty" so it
9448 will be repainted. Causes an EVT_PAINT event to be generated and sent
9449 to the window.
9450 """
54f9ee45 9451 return _core_.Window_Refresh(*args, **kwargs)
e811c8ce
RD
9452
9453 def RefreshRect(*args, **kwargs):
15afbcd0 9454 """
fef4c27a 9455 RefreshRect(self, Rect rect, bool eraseBackground=True)
15afbcd0
RD
9456
9457 Redraws the contents of the given rectangle: the area inside it will
9458 be repainted. This is the same as Refresh but has a nicer syntax.
9459 """
54f9ee45 9460 return _core_.Window_RefreshRect(*args, **kwargs)
e811c8ce
RD
9461
9462 def Update(*args, **kwargs):
15afbcd0 9463 """
a95a7133 9464 Update(self)
15afbcd0
RD
9465
9466 Calling this method immediately repaints the invalidated area of the
9467 window instead of waiting for the EVT_PAINT event to happen, (normally
9468 this would usually only happen when the flow of control returns to the
9469 event loop.) Notice that this function doesn't refresh the window and
9b940138 9470 does nothing if the window has been already repainted. Use `Refresh`
15afbcd0
RD
9471 first if you want to immediately redraw the window (or some portion of
9472 it) unconditionally.
9473 """
54f9ee45 9474 return _core_.Window_Update(*args, **kwargs)
e811c8ce
RD
9475
9476 def ClearBackground(*args, **kwargs):
15afbcd0 9477 """
a95a7133 9478 ClearBackground(self)
15afbcd0
RD
9479
9480 Clears the window by filling it with the current background
9481 colour. Does not cause an erase background event to be generated.
9482 """
54f9ee45 9483 return _core_.Window_ClearBackground(*args, **kwargs)
e811c8ce
RD
9484
9485 def Freeze(*args, **kwargs):
15afbcd0 9486 """
a95a7133 9487 Freeze(self)
15afbcd0 9488
41e2b43e
RD
9489 Freezes the window or, in other words, prevents any updates from
9490 taking place on screen, the window is not redrawn at all. Thaw must be
9491 called to reenable window redrawing. Calls to Freeze/Thaw may be
9492 nested, with the actual Thaw being delayed until all the nesting has
9493 been undone.
15afbcd0
RD
9494
9495 This method is useful for visual appearance optimization (for example,
9496 it is a good idea to use it before inserting large amount of text into
9497 a wxTextCtrl under wxGTK) but is not implemented on all platforms nor
9498 for all controls so it is mostly just a hint to wxWindows and not a
9499 mandatory directive.
9500 """
54f9ee45 9501 return _core_.Window_Freeze(*args, **kwargs)
e811c8ce 9502
33d6fd3b
RD
9503 def IsFrozen(*args, **kwargs):
9504 """
9505 IsFrozen(self) -> bool
9506
9507 Returns ``True`` if the window has been frozen and not thawed yet.
9508
9509 :see: `Freeze` and `Thaw`
9510 """
9511 return _core_.Window_IsFrozen(*args, **kwargs)
9512
e811c8ce 9513 def Thaw(*args, **kwargs):
15afbcd0 9514 """
a95a7133 9515 Thaw(self)
15afbcd0 9516
4276dc52 9517 Reenables window updating after a previous call to Freeze. Calls to
41e2b43e
RD
9518 Freeze/Thaw may be nested, so Thaw must be called the same number of
9519 times that Freeze was before the window will be updated.
15afbcd0 9520 """
54f9ee45 9521 return _core_.Window_Thaw(*args, **kwargs)
e811c8ce
RD
9522
9523 def PrepareDC(*args, **kwargs):
15afbcd0 9524 """
a95a7133 9525 PrepareDC(self, DC dc)
15afbcd0
RD
9526
9527 Call this function to prepare the device context for drawing a
9528 scrolled image. It sets the device origin according to the current
9529 scroll position.
9530 """
54f9ee45 9531 return _core_.Window_PrepareDC(*args, **kwargs)
e811c8ce 9532
b39fe951
RD
9533 def IsDoubleBuffered(*args, **kwargs):
9534 """
9535 IsDoubleBuffered(self) -> bool
9536
9537 Returns ``True`` if the window contents is double-buffered by the
9538 system, i.e. if any drawing done on the window is really done on a
9539 temporary backing surface and transferred to the screen all at once
9540 later.
9541 """
9542 return _core_.Window_IsDoubleBuffered(*args, **kwargs)
9543
e811c8ce 9544 def GetUpdateRegion(*args, **kwargs):
15afbcd0 9545 """
a95a7133 9546 GetUpdateRegion(self) -> Region
15afbcd0
RD
9547
9548 Returns the region specifying which parts of the window have been
9549 damaged. Should only be called within an EVT_PAINT handler.
9550 """
54f9ee45 9551 return _core_.Window_GetUpdateRegion(*args, **kwargs)
e811c8ce
RD
9552
9553 def GetUpdateClientRect(*args, **kwargs):
15afbcd0 9554 """
a95a7133 9555 GetUpdateClientRect(self) -> Rect
15afbcd0
RD
9556
9557 Get the update rectangle region bounding box in client coords.
9558 """
54f9ee45 9559 return _core_.Window_GetUpdateClientRect(*args, **kwargs)
e811c8ce
RD
9560
9561 def IsExposed(*args, **kwargs):
15afbcd0 9562 """
a95a7133 9563 IsExposed(self, int x, int y, int w=1, int h=1) -> bool
15afbcd0
RD
9564
9565 Returns true if the given point or rectangle area has been exposed
9566 since the last repaint. Call this in an paint event handler to
9567 optimize redrawing by only redrawing those areas, which have been
9568 exposed.
9569 """
54f9ee45 9570 return _core_.Window_IsExposed(*args, **kwargs)
e811c8ce
RD
9571
9572 def IsExposedPoint(*args, **kwargs):
15afbcd0 9573 """
a95a7133 9574 IsExposedPoint(self, Point pt) -> bool
15afbcd0
RD
9575
9576 Returns true if the given point or rectangle area has been exposed
9577 since the last repaint. Call this in an paint event handler to
9578 optimize redrawing by only redrawing those areas, which have been
9579 exposed.
9580 """
54f9ee45 9581 return _core_.Window_IsExposedPoint(*args, **kwargs)
e811c8ce 9582
4276dc52 9583 def IsExposedRect(*args, **kwargs):
15afbcd0 9584 """
a95a7133 9585 IsExposedRect(self, Rect rect) -> bool
15afbcd0
RD
9586
9587 Returns true if the given point or rectangle area has been exposed
9588 since the last repaint. Call this in an paint event handler to
9589 optimize redrawing by only redrawing those areas, which have been
9590 exposed.
9591 """
54f9ee45 9592 return _core_.Window_IsExposedRect(*args, **kwargs)
e811c8ce 9593
74a57fcd
RD
9594 def GetDefaultAttributes(*args, **kwargs):
9595 """
a95a7133 9596 GetDefaultAttributes(self) -> VisualAttributes
74a57fcd 9597
41e2b43e
RD
9598 Get the default attributes for an instance of this class. This is
9599 useful if you want to use the same font or colour in your own control
9600 as in a standard control -- which is a much better idea than hard
9601 coding specific colours or fonts which might look completely out of
db3e571a 9602 place on the user's system, especially if it uses themes.
74a57fcd 9603 """
54f9ee45 9604 return _core_.Window_GetDefaultAttributes(*args, **kwargs)
74a57fcd
RD
9605
9606 def GetClassDefaultAttributes(*args, **kwargs):
9607 """
66c033b4 9608 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
74a57fcd 9609
41e2b43e
RD
9610 Get the default attributes for this class. This is useful if you want
9611 to use the same font or colour in your own control as in a standard
9612 control -- which is a much better idea than hard coding specific
db3e571a
RD
9613 colours or fonts which might look completely out of place on the
9614 user's system, especially if it uses themes.
74a57fcd
RD
9615
9616 The variant parameter is only relevant under Mac currently and is
41e2b43e 9617 ignore under other platforms. Under Mac, it will change the size of
db3e571a
RD
9618 the returned font. See `wx.Window.SetWindowVariant` for more about
9619 this.
74a57fcd 9620 """
54f9ee45 9621 return _core_.Window_GetClassDefaultAttributes(*args, **kwargs)
74a57fcd
RD
9622
9623 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
e811c8ce 9624 def SetBackgroundColour(*args, **kwargs):
15afbcd0 9625 """
a95a7133 9626 SetBackgroundColour(self, Colour colour) -> bool
15afbcd0
RD
9627
9628 Sets the background colour of the window. Returns True if the colour
9629 was changed. The background colour is usually painted by the default
9630 EVT_ERASE_BACKGROUND event handler function under Windows and
f8167d6e
RD
9631 automatically under GTK. Using `wx.NullColour` will reset the window
9632 to the default background colour.
15afbcd0 9633
db3e571a 9634 Note that setting the background colour may not cause an immediate
f8167d6e 9635 refresh, so you may wish to call `ClearBackground` or `Refresh` after
15afbcd0
RD
9636 calling this function.
9637
f8167d6e
RD
9638 Using this function will disable attempts to use themes for this
9639 window, if the system supports them. Use with care since usually the
9640 themes represent the appearance chosen by the user to be used for all
9641 applications on the system.
15afbcd0 9642 """
54f9ee45 9643 return _core_.Window_SetBackgroundColour(*args, **kwargs)
e811c8ce 9644
412d302d
RD
9645 def SetOwnBackgroundColour(*args, **kwargs):
9646 """SetOwnBackgroundColour(self, Colour colour)"""
9647 return _core_.Window_SetOwnBackgroundColour(*args, **kwargs)
b2df227b 9648
e811c8ce 9649 def SetForegroundColour(*args, **kwargs):
15afbcd0 9650 """
a95a7133 9651 SetForegroundColour(self, Colour colour) -> bool
15afbcd0
RD
9652
9653 Sets the foreground colour of the window. Returns True is the colour
9654 was changed. The interpretation of foreground colour is dependent on
9655 the window class; it may be the text colour or other colour, or it may
9656 not be used at all.
9657 """
54f9ee45 9658 return _core_.Window_SetForegroundColour(*args, **kwargs)
e811c8ce 9659
fa47d7a7
VS
9660 def SetOwnForegroundColour(*args, **kwargs):
9661 """SetOwnForegroundColour(self, Colour colour)"""
9662 return _core_.Window_SetOwnForegroundColour(*args, **kwargs)
b2df227b 9663
e811c8ce 9664 def GetBackgroundColour(*args, **kwargs):
15afbcd0 9665 """
a95a7133 9666 GetBackgroundColour(self) -> Colour
15afbcd0
RD
9667
9668 Returns the background colour of the window.
9669 """
54f9ee45 9670 return _core_.Window_GetBackgroundColour(*args, **kwargs)
e811c8ce
RD
9671
9672 def GetForegroundColour(*args, **kwargs):
15afbcd0 9673 """
a95a7133 9674 GetForegroundColour(self) -> Colour
15afbcd0
RD
9675
9676 Returns the foreground colour of the window. The interpretation of
9677 foreground colour is dependent on the window class; it may be the text
9678 colour or other colour, or it may not be used at all.
9679 """
54f9ee45 9680 return _core_.Window_GetForegroundColour(*args, **kwargs)
e811c8ce 9681
562ecc31
RD
9682 def InheritsBackgroundColour(*args, **kwargs):
9683 """InheritsBackgroundColour(self) -> bool"""
9684 return _core_.Window_InheritsBackgroundColour(*args, **kwargs)
9685
9686 def UseBgCol(*args, **kwargs):
9687 """UseBgCol(self) -> bool"""
9688 return _core_.Window_UseBgCol(*args, **kwargs)
9689
7bc1e663
RD
9690 def SetBackgroundStyle(*args, **kwargs):
9691 """
9692 SetBackgroundStyle(self, int style) -> bool
9693
9694 Returns the background style of the window. The background style
9695 indicates how the background of the window is drawn.
9696
9697 ====================== ========================================
9698 wx.BG_STYLE_SYSTEM The background colour or pattern should
9699 be determined by the system
9700 wx.BG_STYLE_COLOUR The background should be a solid colour
9701 wx.BG_STYLE_CUSTOM The background will be implemented by the
9702 application.
9703 ====================== ========================================
9704
9705 On GTK+, use of wx.BG_STYLE_CUSTOM allows the flicker-free drawing of
9706 a custom background, such as a tiled bitmap. Currently the style has
9707 no effect on other platforms.
9708
9709 :see: `GetBackgroundStyle`, `SetBackgroundColour`
9710 """
9711 return _core_.Window_SetBackgroundStyle(*args, **kwargs)
9712
9713 def GetBackgroundStyle(*args, **kwargs):
9714 """
9715 GetBackgroundStyle(self) -> int
9716
9717 Returns the background style of the window.
9718
9719 :see: `SetBackgroundStyle`
9720 """
9721 return _core_.Window_GetBackgroundStyle(*args, **kwargs)
9722
51b83b37
RD
9723 def HasTransparentBackground(*args, **kwargs):
9724 """
9725 HasTransparentBackground(self) -> bool
9726
9727 Returns True if this window's background is transparent (as, for
9728 example, for `wx.StaticText`) and should show the parent window's
9729 background.
9730
9731 This method is mostly used internally by the library itself and you
9732 normally shouldn't have to call it. You may, however, have to override
9733 it in your custom control classes to ensure that background is painted
9734 correctly.
9735 """
9736 return _core_.Window_HasTransparentBackground(*args, **kwargs)
9737
e811c8ce 9738 def SetCursor(*args, **kwargs):
15afbcd0 9739 """
a95a7133 9740 SetCursor(self, Cursor cursor) -> bool
15afbcd0
RD
9741
9742 Sets the window's cursor. Notice that the window cursor also sets it
9743 for the children of the window implicitly.
9744
9745 The cursor may be wx.NullCursor in which case the window cursor will
9746 be reset back to default.
9747 """
54f9ee45 9748 return _core_.Window_SetCursor(*args, **kwargs)
e811c8ce
RD
9749
9750 def GetCursor(*args, **kwargs):
15afbcd0 9751 """
a95a7133 9752 GetCursor(self) -> Cursor
15afbcd0
RD
9753
9754 Return the cursor associated with this window.
9755 """
54f9ee45 9756 return _core_.Window_GetCursor(*args, **kwargs)
e811c8ce
RD
9757
9758 def SetFont(*args, **kwargs):
15afbcd0 9759 """
a95a7133 9760 SetFont(self, Font font) -> bool
15afbcd0
RD
9761
9762 Sets the font for this window.
9763 """
54f9ee45 9764 return _core_.Window_SetFont(*args, **kwargs)
e811c8ce 9765
fa47d7a7
VS
9766 def SetOwnFont(*args, **kwargs):
9767 """SetOwnFont(self, Font font)"""
9768 return _core_.Window_SetOwnFont(*args, **kwargs)
b2df227b 9769
e811c8ce 9770 def GetFont(*args, **kwargs):
15afbcd0 9771 """
a95a7133 9772 GetFont(self) -> Font
15afbcd0 9773
4276dc52 9774 Returns the default font used for this window.
15afbcd0 9775 """
54f9ee45 9776 return _core_.Window_GetFont(*args, **kwargs)
e811c8ce
RD
9777
9778 def SetCaret(*args, **kwargs):
15afbcd0 9779 """
a95a7133 9780 SetCaret(self, Caret caret)
15afbcd0
RD
9781
9782 Sets the caret associated with the window.
9783 """
54f9ee45 9784 return _core_.Window_SetCaret(*args, **kwargs)
e811c8ce
RD
9785
9786 def GetCaret(*args, **kwargs):
15afbcd0 9787 """
a95a7133 9788 GetCaret(self) -> Caret
15afbcd0
RD
9789
9790 Returns the caret associated with the window.
9791 """
54f9ee45 9792 return _core_.Window_GetCaret(*args, **kwargs)
e811c8ce
RD
9793
9794 def GetCharHeight(*args, **kwargs):
15afbcd0 9795 """
a95a7133 9796 GetCharHeight(self) -> int
15afbcd0
RD
9797
9798 Get the (average) character size for the current font.
9799 """
54f9ee45 9800 return _core_.Window_GetCharHeight(*args, **kwargs)
e811c8ce
RD
9801
9802 def GetCharWidth(*args, **kwargs):
15afbcd0 9803 """
a95a7133 9804 GetCharWidth(self) -> int
15afbcd0
RD
9805
9806 Get the (average) character size for the current font.
9807 """
54f9ee45 9808 return _core_.Window_GetCharWidth(*args, **kwargs)
e811c8ce
RD
9809
9810 def GetTextExtent(*args, **kwargs):
fd2dc343
RD
9811 """
9812 GetTextExtent(String string) -> (width, height)
9813
9814 Get the width and height of the text using the current font.
9815 """
54f9ee45 9816 return _core_.Window_GetTextExtent(*args, **kwargs)
e811c8ce
RD
9817
9818 def GetFullTextExtent(*args, **kwargs):
0df68c9f 9819 """
196addbf 9820 GetFullTextExtent(String string, Font font=None) ->
0df68c9f 9821 (width, height, descent, externalLeading)
e811c8ce 9822
15afbcd0
RD
9823 Get the width, height, decent and leading of the text using the
9824 current or specified font.
0df68c9f 9825 """
54f9ee45 9826 return _core_.Window_GetFullTextExtent(*args, **kwargs)
e811c8ce
RD
9827
9828 def ClientToScreenXY(*args, **kwargs):
15afbcd0
RD
9829 """
9830 ClientToScreenXY(int x, int y) -> (x,y)
9831
9832 Converts to screen coordinates from coordinates relative to this window.
9833 """
54f9ee45 9834 return _core_.Window_ClientToScreenXY(*args, **kwargs)
e811c8ce
RD
9835
9836 def ScreenToClientXY(*args, **kwargs):
15afbcd0
RD
9837 """
9838 ScreenToClientXY(int x, int y) -> (x,y)
9839
9840 Converts from screen to client window coordinates.
9841 """
54f9ee45 9842 return _core_.Window_ScreenToClientXY(*args, **kwargs)
e811c8ce
RD
9843
9844 def ClientToScreen(*args, **kwargs):
15afbcd0 9845 """
a95a7133 9846 ClientToScreen(self, Point pt) -> Point
15afbcd0
RD
9847
9848 Converts to screen coordinates from coordinates relative to this window.
9849 """
54f9ee45 9850 return _core_.Window_ClientToScreen(*args, **kwargs)
e811c8ce
RD
9851
9852 def ScreenToClient(*args, **kwargs):
15afbcd0 9853 """
a95a7133 9854 ScreenToClient(self, Point pt) -> Point
15afbcd0
RD
9855
9856 Converts from screen to client window coordinates.
9857 """
54f9ee45 9858 return _core_.Window_ScreenToClient(*args, **kwargs)
e811c8ce
RD
9859
9860 def HitTestXY(*args, **kwargs):
15afbcd0 9861 """
a95a7133 9862 HitTestXY(self, int x, int y) -> int
15afbcd0
RD
9863
9864 Test where the given (in client coords) point lies
9865 """
54f9ee45 9866 return _core_.Window_HitTestXY(*args, **kwargs)
e811c8ce
RD
9867
9868 def HitTest(*args, **kwargs):
15afbcd0 9869 """
a95a7133 9870 HitTest(self, Point pt) -> int
15afbcd0
RD
9871
9872 Test where the given (in client coords) point lies
9873 """
54f9ee45 9874 return _core_.Window_HitTest(*args, **kwargs)
e811c8ce 9875
15afbcd0
RD
9876 def GetBorder(*args):
9877 """
a95a7133
RD
9878 GetBorder(self, long flags) -> int
9879 GetBorder(self) -> int
e811c8ce 9880
15afbcd0
RD
9881 Get border for the flags of this window
9882 """
54f9ee45 9883 return _core_.Window_GetBorder(*args)
e811c8ce
RD
9884
9885 def UpdateWindowUI(*args, **kwargs):
15afbcd0 9886 """
a95a7133 9887 UpdateWindowUI(self, long flags=UPDATE_UI_NONE)
15afbcd0
RD
9888
9889 This function sends EVT_UPDATE_UI events to the window. The particular
9890 implementation depends on the window; for example a wx.ToolBar will
9891 send an update UI event for each toolbar button, and a wx.Frame will
9892 send an update UI event for each menubar menu item. You can call this
9893 function from your application to ensure that your UI is up-to-date at
9894 a particular point in time (as far as your EVT_UPDATE_UI handlers are
9895 concerned). This may be necessary if you have called
5ba5649b 9896 `wx.UpdateUIEvent.SetMode` or `wx.UpdateUIEvent.SetUpdateInterval` to
15afbcd0
RD
9897 limit the overhead that wxWindows incurs by sending update UI events
9898 in idle time.
15afbcd0 9899 """
54f9ee45 9900 return _core_.Window_UpdateWindowUI(*args, **kwargs)
e811c8ce
RD
9901
9902 def PopupMenuXY(*args, **kwargs):
15afbcd0 9903 """
b0503257 9904 PopupMenuXY(self, Menu menu, int x=-1, int y=-1) -> bool
15afbcd0 9905
b0503257
RD
9906 Pops up the given menu at the specified coordinates, relative to this window,
9907 and returns control when the user has dismissed the menu. If a menu item is
9908 selected, the corresponding menu event is generated and will be processed as
9909 usual. If the default position is given then the current position of the
9910 mouse cursor will be used.
15afbcd0 9911 """
54f9ee45 9912 return _core_.Window_PopupMenuXY(*args, **kwargs)
e811c8ce 9913
15afbcd0
RD
9914 def PopupMenu(*args, **kwargs):
9915 """
b0503257 9916 PopupMenu(self, Menu menu, Point pos=DefaultPosition) -> bool
15afbcd0 9917
b0503257
RD
9918 Pops up the given menu at the specified coordinates, relative to this window,
9919 and returns control when the user has dismissed the menu. If a menu item is
9920 selected, the corresponding menu event is generated and will be processed as
9921 usual. If the default position is given then the current position of the
9922 mouse cursor will be used.
15afbcd0 9923 """
54f9ee45 9924 return _core_.Window_PopupMenu(*args, **kwargs)
15afbcd0 9925
10044bf1
RD
9926 def HasMultiplePages(*args, **kwargs):
9927 """HasMultiplePages(self) -> bool"""
9928 return _core_.Window_HasMultiplePages(*args, **kwargs)
9929
15afbcd0
RD
9930 def GetHandle(*args, **kwargs):
9931 """
a95a7133 9932 GetHandle(self) -> long
15afbcd0
RD
9933
9934 Returns the platform-specific handle (as a long integer) of the
9935 physical window. Currently on wxMac it returns the handle of the
9936 toplevel parent of the window.
9937 """
54f9ee45 9938 return _core_.Window_GetHandle(*args, **kwargs)
15afbcd0 9939
7e63a440
RD
9940 def AssociateHandle(*args, **kwargs):
9941 """
9942 AssociateHandle(self, long handle)
9943
9944 Associate the window with a new native handle
9945 """
9946 return _core_.Window_AssociateHandle(*args, **kwargs)
9947
9948 def DissociateHandle(*args, **kwargs):
9949 """
9950 DissociateHandle(self)
9951
9952 Dissociate the current native handle from the window
9953 """
9954 return _core_.Window_DissociateHandle(*args, **kwargs)
9955
15afbcd0
RD
9956 def HasScrollbar(*args, **kwargs):
9957 """
a95a7133 9958 HasScrollbar(self, int orient) -> bool
15afbcd0
RD
9959
9960 Does the window have the scrollbar for this orientation?
9961 """
54f9ee45 9962 return _core_.Window_HasScrollbar(*args, **kwargs)
15afbcd0
RD
9963
9964 def SetScrollbar(*args, **kwargs):
9965 """
41e2b43e 9966 SetScrollbar(self, int orientation, int position, int thumbSize, int range,
15afbcd0
RD
9967 bool refresh=True)
9968
9969 Sets the scrollbar properties of a built-in scrollbar.
15afbcd0 9970 """
54f9ee45 9971 return _core_.Window_SetScrollbar(*args, **kwargs)
e811c8ce
RD
9972
9973 def SetScrollPos(*args, **kwargs):
15afbcd0 9974 """
a95a7133 9975 SetScrollPos(self, int orientation, int pos, bool refresh=True)
15afbcd0
RD
9976
9977 Sets the position of one of the built-in scrollbars.
9978 """
54f9ee45 9979 return _core_.Window_SetScrollPos(*args, **kwargs)
e811c8ce
RD
9980
9981 def GetScrollPos(*args, **kwargs):
15afbcd0 9982 """
a95a7133 9983 GetScrollPos(self, int orientation) -> int
15afbcd0
RD
9984
9985 Returns the built-in scrollbar position.
9986 """
54f9ee45 9987 return _core_.Window_GetScrollPos(*args, **kwargs)
e811c8ce
RD
9988
9989 def GetScrollThumb(*args, **kwargs):
15afbcd0 9990 """
a95a7133 9991 GetScrollThumb(self, int orientation) -> int
15afbcd0
RD
9992
9993 Returns the built-in scrollbar thumb size.
9994 """
54f9ee45 9995 return _core_.Window_GetScrollThumb(*args, **kwargs)
e811c8ce
RD
9996
9997 def GetScrollRange(*args, **kwargs):
15afbcd0 9998 """
a95a7133 9999 GetScrollRange(self, int orientation) -> int
15afbcd0
RD
10000
10001 Returns the built-in scrollbar range.
10002 """
54f9ee45 10003 return _core_.Window_GetScrollRange(*args, **kwargs)
e811c8ce
RD
10004
10005 def ScrollWindow(*args, **kwargs):
15afbcd0 10006 """
a95a7133 10007 ScrollWindow(self, int dx, int dy, Rect rect=None)
15afbcd0
RD
10008
10009 Physically scrolls the pixels in the window and move child windows
10010 accordingly. Use this function to optimise your scrolling
10011 implementations, to minimise the area that must be redrawn. Note that
10012 it is rarely required to call this function from a user program.
15afbcd0 10013 """
54f9ee45 10014 return _core_.Window_ScrollWindow(*args, **kwargs)
e811c8ce
RD
10015
10016 def ScrollLines(*args, **kwargs):
15afbcd0 10017 """
a95a7133 10018 ScrollLines(self, int lines) -> bool
15afbcd0
RD
10019
10020 If the platform and window class supports it, scrolls the window by
10021 the given number of lines down, if lines is positive, or up if lines
10022 is negative. Returns True if the window was scrolled, False if it was
10023 already on top/bottom and nothing was done.
10024 """
54f9ee45 10025 return _core_.Window_ScrollLines(*args, **kwargs)
e811c8ce
RD
10026
10027 def ScrollPages(*args, **kwargs):
15afbcd0 10028 """
a95a7133 10029 ScrollPages(self, int pages) -> bool
15afbcd0 10030
41e2b43e 10031 If the platform and window class supports it, scrolls the window by
15afbcd0
RD
10032 the given number of pages down, if pages is positive, or up if pages
10033 is negative. Returns True if the window was scrolled, False if it was
10034 already on top/bottom and nothing was done.
10035 """
54f9ee45 10036 return _core_.Window_ScrollPages(*args, **kwargs)
e811c8ce
RD
10037
10038 def LineUp(*args, **kwargs):
15afbcd0 10039 """
a95a7133 10040 LineUp(self) -> bool
15afbcd0
RD
10041
10042 This is just a wrapper for ScrollLines(-1).
10043 """
54f9ee45 10044 return _core_.Window_LineUp(*args, **kwargs)
e811c8ce
RD
10045
10046 def LineDown(*args, **kwargs):
15afbcd0 10047 """
a95a7133 10048 LineDown(self) -> bool
15afbcd0
RD
10049
10050 This is just a wrapper for ScrollLines(1).
10051 """
54f9ee45 10052 return _core_.Window_LineDown(*args, **kwargs)
e811c8ce
RD
10053
10054 def PageUp(*args, **kwargs):
15afbcd0 10055 """
a95a7133 10056 PageUp(self) -> bool
15afbcd0
RD
10057
10058 This is just a wrapper for ScrollPages(-1).
10059 """
54f9ee45 10060 return _core_.Window_PageUp(*args, **kwargs)
e811c8ce
RD
10061
10062 def PageDown(*args, **kwargs):
15afbcd0 10063 """
a95a7133 10064 PageDown(self) -> bool
15afbcd0
RD
10065
10066 This is just a wrapper for ScrollPages(1).
10067 """
54f9ee45 10068 return _core_.Window_PageDown(*args, **kwargs)
e811c8ce
RD
10069
10070 def SetHelpText(*args, **kwargs):
15afbcd0 10071 """
a95a7133 10072 SetHelpText(self, String text)
15afbcd0
RD
10073
10074 Sets the help text to be used as context-sensitive help for this
10075 window. Note that the text is actually stored by the current
f52cbe90 10076 `wx.HelpProvider` implementation, and not in the window object itself.
15afbcd0 10077 """
54f9ee45 10078 return _core_.Window_SetHelpText(*args, **kwargs)
e811c8ce
RD
10079
10080 def SetHelpTextForId(*args, **kwargs):
15afbcd0 10081 """
a95a7133 10082 SetHelpTextForId(self, String text)
15afbcd0
RD
10083
10084 Associate this help text with all windows with the same id as this
10085 one.
10086 """
54f9ee45 10087 return _core_.Window_SetHelpTextForId(*args, **kwargs)
e811c8ce 10088
b850e7f3
RD
10089 def GetHelpTextAtPoint(*args, **kwargs):
10090 """
10091 GetHelpTextAtPoint(self, Point pt, wxHelpEvent::Origin origin) -> String
10092
10093 Get the help string associated with the given position in this window.
10094
10095 Notice that pt may be invalid if event origin is keyboard or unknown
10096 and this method should return the global window help text then
10097
10098 """
10099 return _core_.Window_GetHelpTextAtPoint(*args, **kwargs)
10100
e811c8ce 10101 def GetHelpText(*args, **kwargs):
15afbcd0 10102 """
a95a7133 10103 GetHelpText(self) -> String
15afbcd0
RD
10104
10105 Gets the help text to be used as context-sensitive help for this
10106 window. Note that the text is actually stored by the current
f52cbe90 10107 `wx.HelpProvider` implementation, and not in the window object itself.
15afbcd0 10108 """
54f9ee45 10109 return _core_.Window_GetHelpText(*args, **kwargs)
e811c8ce
RD
10110
10111 def SetToolTipString(*args, **kwargs):
15afbcd0 10112 """
a95a7133 10113 SetToolTipString(self, String tip)
15afbcd0
RD
10114
10115 Attach a tooltip to the window.
10116 """
54f9ee45 10117 return _core_.Window_SetToolTipString(*args, **kwargs)
e811c8ce
RD
10118
10119 def SetToolTip(*args, **kwargs):
15afbcd0 10120 """
a95a7133 10121 SetToolTip(self, ToolTip tip)
15afbcd0
RD
10122
10123 Attach a tooltip to the window.
10124 """
54f9ee45 10125 return _core_.Window_SetToolTip(*args, **kwargs)
e811c8ce
RD
10126
10127 def GetToolTip(*args, **kwargs):
15afbcd0 10128 """
a95a7133 10129 GetToolTip(self) -> ToolTip
15afbcd0
RD
10130
10131 get the associated tooltip or None if none
10132 """
54f9ee45 10133 return _core_.Window_GetToolTip(*args, **kwargs)
e811c8ce
RD
10134
10135 def SetDropTarget(*args, **kwargs):
15afbcd0 10136 """
a95a7133 10137 SetDropTarget(self, DropTarget dropTarget)
15afbcd0
RD
10138
10139 Associates a drop target with this window. If the window already has
10140 a drop target, it is deleted.
10141 """
54f9ee45 10142 return _core_.Window_SetDropTarget(*args, **kwargs)
e811c8ce
RD
10143
10144 def GetDropTarget(*args, **kwargs):
15afbcd0 10145 """
a95a7133 10146 GetDropTarget(self) -> DropTarget
15afbcd0
RD
10147
10148 Returns the associated drop target, which may be None.
10149 """
54f9ee45 10150 return _core_.Window_GetDropTarget(*args, **kwargs)
e811c8ce 10151
5ba5649b
RD
10152 def DragAcceptFiles(*args, **kwargs):
10153 """
10154 DragAcceptFiles(self, bool accept)
10155
10156 Enables or disables eligibility for drop file events, EVT_DROP_FILES.
10157 Only functional on Windows.
10158 """
10159 return _core_.Window_DragAcceptFiles(*args, **kwargs)
10160
e811c8ce 10161 def SetConstraints(*args, **kwargs):
15afbcd0 10162 """
a95a7133 10163 SetConstraints(self, LayoutConstraints constraints)
15afbcd0
RD
10164
10165 Sets the window to have the given layout constraints. If an existing
10166 layout constraints object is already owned by the window, it will be
10167 deleted. Pass None to disassociate and delete the window's current
10168 constraints.
10169
10170 You must call SetAutoLayout to tell a window to use the constraints
10171 automatically in its default EVT_SIZE handler; otherwise, you must
10172 handle EVT_SIZE yourself and call Layout() explicitly. When setting
10173 both a wx.LayoutConstraints and a wx.Sizer, only the sizer will have
10174 effect.
10175 """
54f9ee45 10176 return _core_.Window_SetConstraints(*args, **kwargs)
e811c8ce
RD
10177
10178 def GetConstraints(*args, **kwargs):
15afbcd0 10179 """
a95a7133 10180 GetConstraints(self) -> LayoutConstraints
15afbcd0
RD
10181
10182 Returns a pointer to the window's layout constraints, or None if there
10183 are none.
10184 """
54f9ee45 10185 return _core_.Window_GetConstraints(*args, **kwargs)
e811c8ce
RD
10186
10187 def SetAutoLayout(*args, **kwargs):
15afbcd0 10188 """
a95a7133 10189 SetAutoLayout(self, bool autoLayout)
15afbcd0
RD
10190
10191 Determines whether the Layout function will be called automatically
b1fcee84
RD
10192 when the window is resized. lease note that this only happens for the
10193 windows usually used to contain children, namely `wx.Panel` and
10194 `wx.TopLevelWindow` (and the classes deriving from them).
10195
10196 This method is called implicitly by `SetSizer` but if you use
10197 `SetConstraints` you should call it manually or otherwise the window
10198 layout won't be correctly updated when its size changes.
15afbcd0 10199 """
54f9ee45 10200 return _core_.Window_SetAutoLayout(*args, **kwargs)
e811c8ce
RD
10201
10202 def GetAutoLayout(*args, **kwargs):
15afbcd0 10203 """
a95a7133 10204 GetAutoLayout(self) -> bool
15afbcd0
RD
10205
10206 Returns the current autoLayout setting
10207 """
54f9ee45 10208 return _core_.Window_GetAutoLayout(*args, **kwargs)
e811c8ce
RD
10209
10210 def Layout(*args, **kwargs):
15afbcd0 10211 """
a95a7133 10212 Layout(self) -> bool
15afbcd0
RD
10213
10214 Invokes the constraint-based layout algorithm or the sizer-based
10215 algorithm for this window. See SetAutoLayout: when auto layout is on,
10216 this function gets called automatically by the default EVT_SIZE
10217 handler when the window is resized.
10218 """
54f9ee45 10219 return _core_.Window_Layout(*args, **kwargs)
e811c8ce
RD
10220
10221 def SetSizer(*args, **kwargs):
15afbcd0 10222 """
a95a7133 10223 SetSizer(self, Sizer sizer, bool deleteOld=True)
15afbcd0
RD
10224
10225 Sets the window to have the given layout sizer. The window will then
10226 own the object, and will take care of its deletion. If an existing
10227 layout sizer object is already owned by the window, it will be deleted
10228 if the deleteOld parameter is true. Note that this function will also
10229 call SetAutoLayout implicitly with a True parameter if the sizer is
ae8162c8 10230 non-None, and False otherwise.
15afbcd0 10231 """
54f9ee45 10232 return _core_.Window_SetSizer(*args, **kwargs)
e811c8ce
RD
10233
10234 def SetSizerAndFit(*args, **kwargs):
15afbcd0 10235 """
a95a7133 10236 SetSizerAndFit(self, Sizer sizer, bool deleteOld=True)
15afbcd0
RD
10237
10238 The same as SetSizer, except it also sets the size hints for the
10239 window based on the sizer's minimum size.
10240 """
54f9ee45 10241 return _core_.Window_SetSizerAndFit(*args, **kwargs)
e811c8ce
RD
10242
10243 def GetSizer(*args, **kwargs):
15afbcd0 10244 """
a95a7133 10245 GetSizer(self) -> Sizer
15afbcd0
RD
10246
10247 Return the sizer associated with the window by a previous call to
10248 SetSizer or None if there isn't one.
10249 """
54f9ee45 10250 return _core_.Window_GetSizer(*args, **kwargs)
e811c8ce
RD
10251
10252 def SetContainingSizer(*args, **kwargs):
15afbcd0 10253 """
a95a7133 10254 SetContainingSizer(self, Sizer sizer)
15afbcd0
RD
10255
10256 This normally does not need to be called by application code. It is
10257 called internally when a window is added to a sizer, and is used so
10258 the window can remove itself from the sizer when it is destroyed.
10259 """
54f9ee45 10260 return _core_.Window_SetContainingSizer(*args, **kwargs)
e811c8ce
RD
10261
10262 def GetContainingSizer(*args, **kwargs):
15afbcd0 10263 """
a95a7133 10264 GetContainingSizer(self) -> Sizer
15afbcd0
RD
10265
10266 Return the sizer that this window is a member of, if any, otherwise None.
10267 """
54f9ee45 10268 return _core_.Window_GetContainingSizer(*args, **kwargs)
e811c8ce 10269
a95a7133
RD
10270 def InheritAttributes(*args, **kwargs):
10271 """
10272 InheritAttributes(self)
10273
41e2b43e
RD
10274 This function is (or should be, in case of custom controls) called
10275 during window creation to intelligently set up the window visual
10276 attributes, that is the font and the foreground and background
10277 colours.
10278
10279 By 'intelligently' the following is meant: by default, all windows use
10280 their own default attributes. However if some of the parent's
10281 attributes are explicitly changed (that is, using SetFont and not
fa47d7a7 10282 SetOwnFont) and if the corresponding attribute hadn't been
41e2b43e
RD
10283 explicitly set for this window itself, then this window takes the same
10284 value as used by the parent. In addition, if the window overrides
10285 ShouldInheritColours to return false, the colours will not be changed
10286 no matter what and only the font might.
10287
34621cc5 10288 This rather complicated logic is necessary in order to accommodate the
ec9b55ca 10289 different usage scenarios. The most common one is when all default
41e2b43e
RD
10290 attributes are used and in this case, nothing should be inherited as
10291 in modern GUIs different controls use different fonts (and colours)
10292 than their siblings so they can't inherit the same value from the
10293 parent. However it was also deemed desirable to allow to simply change
10294 the attributes of all children at once by just changing the font or
10295 colour of their common parent, hence in this case we do inherit the
10296 parents attributes.
10297
a95a7133 10298 """
54f9ee45 10299 return _core_.Window_InheritAttributes(*args, **kwargs)
a95a7133
RD
10300
10301 def ShouldInheritColours(*args, **kwargs):
10302 """
10303 ShouldInheritColours(self) -> bool
10304
10305 Return true from here to allow the colours of this window to be
41e2b43e
RD
10306 changed by InheritAttributes, returning false forbids inheriting them
10307 from the parent window.
a95a7133 10308
41e2b43e
RD
10309 The base class version returns false, but this method is overridden in
10310 wxControl where it returns true.
a95a7133 10311 """
54f9ee45 10312 return _core_.Window_ShouldInheritColours(*args, **kwargs)
a95a7133 10313
fc46b7f3
RD
10314 def CanSetTransparent(*args, **kwargs):
10315 """
10316 CanSetTransparent(self) -> bool
10317
10318 Returns ``True`` if the platform supports setting the transparency for
10319 this window. Note that this method will err on the side of caution,
10320 so it is possible that this will return ``False`` when it is in fact
10321 possible to set the transparency.
10322
10323 NOTE: On X-windows systems the X server must have the composite
10324 extension loaded, and there must be a composite manager program (such
10325 as xcompmgr) running.
10326 """
10327 return _core_.Window_CanSetTransparent(*args, **kwargs)
10328
10329 def SetTransparent(*args, **kwargs):
10330 """
10331 SetTransparent(self, byte alpha) -> bool
10332
10333 Attempt to set the transparency of this window to the ``alpha`` value,
10334 returns True on success. The ``alpha`` value is an integer in the
10335 range of 0 to 255, where 0 is fully transparent and 255 is fully
10336 opaque.
10337 """
10338 return _core_.Window_SetTransparent(*args, **kwargs)
10339
e811c8ce 10340 def PostCreate(self, pre):
15afbcd0
RD
10341 """
10342 Phase 3 of the 2-phase create <wink!>
10343 Call this method after precreating the window with the 2-phase create method.
10344 """
e811c8ce
RD
10345 self.this = pre.this
10346 self.thisown = pre.thisown
10347 pre.thisown = 0
10348 if hasattr(self, '_setOORInfo'):
10349 self._setOORInfo(self)
10350 if hasattr(self, '_setCallbackInfo'):
c25f90f6 10351 self._setCallbackInfo(self, pre.__class__)
e811c8ce 10352
7e08d4ef 10353 def SendSizeEvent(self):
453fb36b 10354 self.GetEventHandler().ProcessEvent(wx.SizeEvent((-1,-1)))
7e08d4ef 10355
2bf58437
RD
10356 AcceleratorTable = property(GetAcceleratorTable,SetAcceleratorTable,doc="See `GetAcceleratorTable` and `SetAcceleratorTable`")
10357 AdjustedBestSize = property(GetAdjustedBestSize,doc="See `GetAdjustedBestSize`")
10358 AutoLayout = property(GetAutoLayout,SetAutoLayout,doc="See `GetAutoLayout` and `SetAutoLayout`")
10359 BackgroundColour = property(GetBackgroundColour,SetBackgroundColour,doc="See `GetBackgroundColour` and `SetBackgroundColour`")
10360 BackgroundStyle = property(GetBackgroundStyle,SetBackgroundStyle,doc="See `GetBackgroundStyle` and `SetBackgroundStyle`")
580080c5 10361 EffectiveMinSize = property(GetEffectiveMinSize,doc="See `GetEffectiveMinSize`")
2bf58437
RD
10362 BestSize = property(GetBestSize,doc="See `GetBestSize`")
10363 BestVirtualSize = property(GetBestVirtualSize,doc="See `GetBestVirtualSize`")
10364 Border = property(GetBorder,doc="See `GetBorder`")
10365 Caret = property(GetCaret,SetCaret,doc="See `GetCaret` and `SetCaret`")
10366 CharHeight = property(GetCharHeight,doc="See `GetCharHeight`")
10367 CharWidth = property(GetCharWidth,doc="See `GetCharWidth`")
10368 Children = property(GetChildren,doc="See `GetChildren`")
10369 ClientAreaOrigin = property(GetClientAreaOrigin,doc="See `GetClientAreaOrigin`")
10370 ClientRect = property(GetClientRect,SetClientRect,doc="See `GetClientRect` and `SetClientRect`")
10371 ClientSize = property(GetClientSize,SetClientSize,doc="See `GetClientSize` and `SetClientSize`")
10372 Constraints = property(GetConstraints,SetConstraints,doc="See `GetConstraints` and `SetConstraints`")
10373 ContainingSizer = property(GetContainingSizer,SetContainingSizer,doc="See `GetContainingSizer` and `SetContainingSizer`")
10374 Cursor = property(GetCursor,SetCursor,doc="See `GetCursor` and `SetCursor`")
10375 DefaultAttributes = property(GetDefaultAttributes,doc="See `GetDefaultAttributes`")
10376 DropTarget = property(GetDropTarget,SetDropTarget,doc="See `GetDropTarget` and `SetDropTarget`")
10377 EventHandler = property(GetEventHandler,SetEventHandler,doc="See `GetEventHandler` and `SetEventHandler`")
10378 ExtraStyle = property(GetExtraStyle,SetExtraStyle,doc="See `GetExtraStyle` and `SetExtraStyle`")
10379 Font = property(GetFont,SetFont,doc="See `GetFont` and `SetFont`")
10380 ForegroundColour = property(GetForegroundColour,SetForegroundColour,doc="See `GetForegroundColour` and `SetForegroundColour`")
2bf58437
RD
10381 GrandParent = property(GetGrandParent,doc="See `GetGrandParent`")
10382 Handle = property(GetHandle,doc="See `GetHandle`")
10383 HelpText = property(GetHelpText,SetHelpText,doc="See `GetHelpText` and `SetHelpText`")
2bf58437
RD
10384 Id = property(GetId,SetId,doc="See `GetId` and `SetId`")
10385 Label = property(GetLabel,SetLabel,doc="See `GetLabel` and `SetLabel`")
994453b8 10386 LayoutDirection = property(GetLayoutDirection,SetLayoutDirection,doc="See `GetLayoutDirection` and `SetLayoutDirection`")
2bf58437
RD
10387 MaxHeight = property(GetMaxHeight,doc="See `GetMaxHeight`")
10388 MaxSize = property(GetMaxSize,SetMaxSize,doc="See `GetMaxSize` and `SetMaxSize`")
10389 MaxWidth = property(GetMaxWidth,doc="See `GetMaxWidth`")
10390 MinHeight = property(GetMinHeight,doc="See `GetMinHeight`")
10391 MinSize = property(GetMinSize,SetMinSize,doc="See `GetMinSize` and `SetMinSize`")
10392 MinWidth = property(GetMinWidth,doc="See `GetMinWidth`")
10393 Name = property(GetName,SetName,doc="See `GetName` and `SetName`")
10394 Parent = property(GetParent,doc="See `GetParent`")
10395 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
10396 Rect = property(GetRect,SetRect,doc="See `GetRect` and `SetRect`")
10397 ScreenPosition = property(GetScreenPosition,doc="See `GetScreenPosition`")
10398 ScreenRect = property(GetScreenRect,doc="See `GetScreenRect`")
2bf58437
RD
10399 Size = property(GetSize,SetSize,doc="See `GetSize` and `SetSize`")
10400 Sizer = property(GetSizer,SetSizer,doc="See `GetSizer` and `SetSizer`")
2bf58437
RD
10401 ThemeEnabled = property(GetThemeEnabled,SetThemeEnabled,doc="See `GetThemeEnabled` and `SetThemeEnabled`")
10402 ToolTip = property(GetToolTip,SetToolTip,doc="See `GetToolTip` and `SetToolTip`")
10403 UpdateClientRect = property(GetUpdateClientRect,doc="See `GetUpdateClientRect`")
10404 UpdateRegion = property(GetUpdateRegion,doc="See `GetUpdateRegion`")
10405 Validator = property(GetValidator,SetValidator,doc="See `GetValidator` and `SetValidator`")
10406 VirtualSize = property(GetVirtualSize,SetVirtualSize,doc="See `GetVirtualSize` and `SetVirtualSize`")
10407 WindowStyle = property(GetWindowStyle,SetWindowStyle,doc="See `GetWindowStyle` and `SetWindowStyle`")
10408 WindowStyleFlag = property(GetWindowStyleFlag,SetWindowStyleFlag,doc="See `GetWindowStyleFlag` and `SetWindowStyleFlag`")
10409 WindowVariant = property(GetWindowVariant,SetWindowVariant,doc="See `GetWindowVariant` and `SetWindowVariant`")
97ab0f6a
RD
10410 Shown = property(IsShown,Show,doc="See `IsShown` and `Show`")
10411 Enabled = property(IsEnabled,Enable,doc="See `IsEnabled` and `Enable`")
10412 TopLevel = property(IsTopLevel,doc="See `IsTopLevel`")
2131d850 10413_core_.Window_swigregister(Window)
e811c8ce
RD
10414
10415def PreWindow(*args, **kwargs):
15afbcd0
RD
10416 """
10417 PreWindow() -> Window
10418
10419 Precreate a Window for 2-phase creation.
10420 """
54f9ee45 10421 val = _core_.new_PreWindow(*args, **kwargs)
e811c8ce
RD
10422 return val
10423
0085ce49
RD
10424def Window_NewControlId(*args):
10425 """
15afbcd0
RD
10426 Window_NewControlId() -> int
10427
10428 Generate a control id for the controls which were not given one.
10429 """
0085ce49 10430 return _core_.Window_NewControlId(*args)
e811c8ce
RD
10431
10432def Window_NextControlId(*args, **kwargs):
0085ce49 10433 """
15afbcd0
RD
10434 Window_NextControlId(int winid) -> int
10435
10436 Get the id of the control following the one with the given
41e2b43e 10437 autogenerated) id
15afbcd0 10438 """
0085ce49 10439 return _core_.Window_NextControlId(*args, **kwargs)
e811c8ce
RD
10440
10441def Window_PrevControlId(*args, **kwargs):
0085ce49 10442 """
15afbcd0
RD
10443 Window_PrevControlId(int winid) -> int
10444
10445 Get the id of the control preceding the one with the given
41e2b43e 10446 autogenerated) id
15afbcd0 10447 """
0085ce49 10448 return _core_.Window_PrevControlId(*args, **kwargs)
e811c8ce 10449
0085ce49
RD
10450def Window_FindFocus(*args):
10451 """
15afbcd0
RD
10452 Window_FindFocus() -> Window
10453
10454 Returns the window or control that currently has the keyboard focus,
10455 or None.
10456 """
0085ce49 10457 return _core_.Window_FindFocus(*args)
e811c8ce 10458
0085ce49
RD
10459def Window_GetCapture(*args):
10460 """
15afbcd0
RD
10461 Window_GetCapture() -> Window
10462
10463 Returns the window which currently captures the mouse or None
10464 """
0085ce49 10465 return _core_.Window_GetCapture(*args)
e811c8ce 10466
74a57fcd 10467def Window_GetClassDefaultAttributes(*args, **kwargs):
0085ce49 10468 """
74a57fcd
RD
10469 Window_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
10470
41e2b43e
RD
10471 Get the default attributes for this class. This is useful if you want
10472 to use the same font or colour in your own control as in a standard
10473 control -- which is a much better idea than hard coding specific
db3e571a
RD
10474 colours or fonts which might look completely out of place on the
10475 user's system, especially if it uses themes.
74a57fcd
RD
10476
10477 The variant parameter is only relevant under Mac currently and is
41e2b43e 10478 ignore under other platforms. Under Mac, it will change the size of
db3e571a
RD
10479 the returned font. See `wx.Window.SetWindowVariant` for more about
10480 this.
74a57fcd 10481 """
0085ce49 10482 return _core_.Window_GetClassDefaultAttributes(*args, **kwargs)
74a57fcd 10483
e811c8ce 10484def DLG_PNT(win, point_or_x, y=None):
15afbcd0
RD
10485 """
10486 Convenience function for converting a Point or (x,y) in
10487 dialog units to pixel units.
10488 """
e811c8ce
RD
10489 if y is None:
10490 return win.ConvertDialogPointToPixels(point_or_x)
10491 else:
fd3f2efe 10492 return win.ConvertDialogPointToPixels(wx.Point(point_or_x, y))
e811c8ce
RD
10493
10494def DLG_SZE(win, size_width, height=None):
15afbcd0
RD
10495 """
10496 Convenience function for converting a Size or (w,h) in
10497 dialog units to pixel units.
10498 """
e811c8ce
RD
10499 if height is None:
10500 return win.ConvertDialogSizeToPixels(size_width)
10501 else:
fd3f2efe 10502 return win.ConvertDialogSizeToPixels(wx.Size(size_width, height))
e811c8ce
RD
10503
10504
10505def FindWindowById(*args, **kwargs):
0085ce49 10506 """
15afbcd0
RD
10507 FindWindowById(long id, Window parent=None) -> Window
10508
10509 Find the first window in the application with the given id. If parent
10510 is None, the search will start from all top-level frames and dialog
10511 boxes; if non-None, the search will be limited to the given window
10512 hierarchy. The search is recursive in both cases.
10513 """
0085ce49 10514 return _core_.FindWindowById(*args, **kwargs)
e811c8ce
RD
10515
10516def FindWindowByName(*args, **kwargs):
0085ce49 10517 """
15afbcd0
RD
10518 FindWindowByName(String name, Window parent=None) -> Window
10519
10520 Find a window by its name (as given in a window constructor or Create
10521 function call). If parent is None, the search will start from all
10522 top-level frames and dialog boxes; if non-None, the search will be
10523 limited to the given window hierarchy. The search is recursive in both
10524 cases.
10525
10526 If no window with such name is found, wx.FindWindowByLabel is called.
10527 """
0085ce49 10528 return _core_.FindWindowByName(*args, **kwargs)
e811c8ce
RD
10529
10530def FindWindowByLabel(*args, **kwargs):
0085ce49 10531 """
15afbcd0
RD
10532 FindWindowByLabel(String label, Window parent=None) -> Window
10533
10534 Find a window by its label. Depending on the type of window, the label
10535 may be a window title or panel item label. If parent is None, the
10536 search will start from all top-level frames and dialog boxes; if
10537 non-None, the search will be limited to the given window
10538 hierarchy. The search is recursive in both cases.
10539 """
0085ce49 10540 return _core_.FindWindowByLabel(*args, **kwargs)
e811c8ce
RD
10541
10542def Window_FromHWND(*args, **kwargs):
0085ce49
RD
10543 """Window_FromHWND(Window parent, unsigned long _hWnd) -> Window"""
10544 return _core_.Window_FromHWND(*args, **kwargs)
b6b0383e 10545
0085ce49
RD
10546def GetTopLevelWindows(*args):
10547 """
b6b0383e
RD
10548 GetTopLevelWindows() -> PyObject
10549
10550 Returns a list of the the application's top-level windows, (frames,
10551 dialogs, etc.) NOTE: Currently this is a copy of the list maintained
10552 by wxWidgets, and so it is only valid as long as no top-level windows
10553 are closed or new top-level windows are created.
10554
10555 """
0085ce49 10556 return _core_.GetTopLevelWindows(*args)
e811c8ce
RD
10557#---------------------------------------------------------------------------
10558
10559class Validator(EvtHandler):
093d3ff1 10560 """Proxy of C++ Validator class"""
0085ce49
RD
10561 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10562 __repr__ = _swig_repr
10563 def __init__(self, *args, **kwargs):
a95a7133 10564 """__init__(self) -> Validator"""
0085ce49 10565 _core_.Validator_swiginit(self,_core_.new_Validator(*args, **kwargs))
d14a1e28 10566 self._setOORInfo(self)
e811c8ce
RD
10567
10568 def Clone(*args, **kwargs):
a95a7133 10569 """Clone(self) -> Validator"""
54f9ee45 10570 return _core_.Validator_Clone(*args, **kwargs)
e811c8ce
RD
10571
10572 def Validate(*args, **kwargs):
a95a7133 10573 """Validate(self, Window parent) -> bool"""
54f9ee45 10574 return _core_.Validator_Validate(*args, **kwargs)
e811c8ce
RD
10575
10576 def TransferToWindow(*args, **kwargs):
a95a7133 10577 """TransferToWindow(self) -> bool"""
54f9ee45 10578 return _core_.Validator_TransferToWindow(*args, **kwargs)
e811c8ce
RD
10579
10580 def TransferFromWindow(*args, **kwargs):
a95a7133 10581 """TransferFromWindow(self) -> bool"""
54f9ee45 10582 return _core_.Validator_TransferFromWindow(*args, **kwargs)
e811c8ce
RD
10583
10584 def GetWindow(*args, **kwargs):
a95a7133 10585 """GetWindow(self) -> Window"""
54f9ee45 10586 return _core_.Validator_GetWindow(*args, **kwargs)
e811c8ce
RD
10587
10588 def SetWindow(*args, **kwargs):
a95a7133 10589 """SetWindow(self, Window window)"""
54f9ee45 10590 return _core_.Validator_SetWindow(*args, **kwargs)
e811c8ce
RD
10591
10592 def IsSilent(*args, **kwargs):
66c033b4 10593 """IsSilent() -> bool"""
54f9ee45 10594 return _core_.Validator_IsSilent(*args, **kwargs)
e811c8ce
RD
10595
10596 IsSilent = staticmethod(IsSilent)
10597 def SetBellOnError(*args, **kwargs):
66c033b4 10598 """SetBellOnError(int doIt=True)"""
54f9ee45 10599 return _core_.Validator_SetBellOnError(*args, **kwargs)
e811c8ce
RD
10600
10601 SetBellOnError = staticmethod(SetBellOnError)
dba7934c 10602 Window = property(GetWindow,SetWindow,doc="See `GetWindow` and `SetWindow`")
2131d850 10603_core_.Validator_swigregister(Validator)
e811c8ce 10604
0085ce49
RD
10605def Validator_IsSilent(*args):
10606 """Validator_IsSilent() -> bool"""
10607 return _core_.Validator_IsSilent(*args)
e811c8ce
RD
10608
10609def Validator_SetBellOnError(*args, **kwargs):
0085ce49
RD
10610 """Validator_SetBellOnError(int doIt=True)"""
10611 return _core_.Validator_SetBellOnError(*args, **kwargs)
e811c8ce
RD
10612
10613class PyValidator(Validator):
093d3ff1 10614 """Proxy of C++ PyValidator class"""
0085ce49
RD
10615 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10616 __repr__ = _swig_repr
10617 def __init__(self, *args, **kwargs):
a95a7133 10618 """__init__(self) -> PyValidator"""
0085ce49 10619 _core_.PyValidator_swiginit(self,_core_.new_PyValidator(*args, **kwargs))
c25f90f6 10620 self._setOORInfo(self);PyValidator._setCallbackInfo(self, self, PyValidator)
e811c8ce
RD
10621
10622 def _setCallbackInfo(*args, **kwargs):
c25f90f6 10623 """_setCallbackInfo(self, PyObject self, PyObject _class, int incref=1)"""
54f9ee45 10624 return _core_.PyValidator__setCallbackInfo(*args, **kwargs)
e811c8ce 10625
2131d850 10626_core_.PyValidator_swigregister(PyValidator)
e811c8ce
RD
10627
10628#---------------------------------------------------------------------------
10629
10630class Menu(EvtHandler):
093d3ff1 10631 """Proxy of C++ Menu class"""
0085ce49
RD
10632 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10633 __repr__ = _swig_repr
10634 def __init__(self, *args, **kwargs):
a95a7133 10635 """__init__(self, String title=EmptyString, long style=0) -> Menu"""
0085ce49 10636 _core_.Menu_swiginit(self,_core_.new_Menu(*args, **kwargs))
e811c8ce
RD
10637 self._setOORInfo(self)
10638
10639 def Append(*args, **kwargs):
97ab0f6a
RD
10640 """
10641 Append(self, int id, String text=EmptyString, String help=EmptyString,
10642 int kind=ITEM_NORMAL) -> MenuItem
10643 """
54f9ee45 10644 return _core_.Menu_Append(*args, **kwargs)
e811c8ce
RD
10645
10646 def AppendSeparator(*args, **kwargs):
a95a7133 10647 """AppendSeparator(self) -> MenuItem"""
54f9ee45 10648 return _core_.Menu_AppendSeparator(*args, **kwargs)
e811c8ce
RD
10649
10650 def AppendCheckItem(*args, **kwargs):
a95a7133 10651 """AppendCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
54f9ee45 10652 return _core_.Menu_AppendCheckItem(*args, **kwargs)
e811c8ce
RD
10653
10654 def AppendRadioItem(*args, **kwargs):
a95a7133 10655 """AppendRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
54f9ee45 10656 return _core_.Menu_AppendRadioItem(*args, **kwargs)
e811c8ce
RD
10657
10658 def AppendMenu(*args, **kwargs):
a95a7133 10659 """AppendMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
54f9ee45 10660 return _core_.Menu_AppendMenu(*args, **kwargs)
e811c8ce 10661
50efceee
RD
10662 def AppendSubMenu(*args, **kwargs):
10663 """AppendSubMenu(self, Menu submenu, String text, String help=EmptyString) -> MenuItem"""
10664 return _core_.Menu_AppendSubMenu(*args, **kwargs)
10665
e811c8ce 10666 def AppendItem(*args, **kwargs):
a95a7133 10667 """AppendItem(self, MenuItem item) -> MenuItem"""
54f9ee45 10668 return _core_.Menu_AppendItem(*args, **kwargs)
e811c8ce 10669
e811c8ce 10670 def InsertItem(*args, **kwargs):
a95a7133 10671 """InsertItem(self, size_t pos, MenuItem item) -> MenuItem"""
54f9ee45 10672 return _core_.Menu_InsertItem(*args, **kwargs)
e811c8ce 10673
0085ce49
RD
10674 def PrependItem(*args, **kwargs):
10675 """PrependItem(self, MenuItem item) -> MenuItem"""
10676 return _core_.Menu_PrependItem(*args, **kwargs)
10677
10678 def Break(*args, **kwargs):
10679 """Break(self)"""
10680 return _core_.Menu_Break(*args, **kwargs)
10681
e811c8ce 10682 def Insert(*args, **kwargs):
0df68c9f 10683 """
97ab0f6a 10684 Insert(self, size_t pos, int id, String text=EmptyString, String help=EmptyString,
a41e16b6 10685 int kind=ITEM_NORMAL) -> MenuItem
0df68c9f 10686 """
54f9ee45 10687 return _core_.Menu_Insert(*args, **kwargs)
e811c8ce
RD
10688
10689 def InsertSeparator(*args, **kwargs):
a95a7133 10690 """InsertSeparator(self, size_t pos) -> MenuItem"""
54f9ee45 10691 return _core_.Menu_InsertSeparator(*args, **kwargs)
e811c8ce
RD
10692
10693 def InsertCheckItem(*args, **kwargs):
a95a7133 10694 """InsertCheckItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
54f9ee45 10695 return _core_.Menu_InsertCheckItem(*args, **kwargs)
e811c8ce
RD
10696
10697 def InsertRadioItem(*args, **kwargs):
a95a7133 10698 """InsertRadioItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
54f9ee45 10699 return _core_.Menu_InsertRadioItem(*args, **kwargs)
e811c8ce
RD
10700
10701 def InsertMenu(*args, **kwargs):
a95a7133 10702 """InsertMenu(self, size_t pos, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
54f9ee45 10703 return _core_.Menu_InsertMenu(*args, **kwargs)
e811c8ce 10704
e811c8ce 10705 def Prepend(*args, **kwargs):
97ab0f6a
RD
10706 """
10707 Prepend(self, int id, String text=EmptyString, String help=EmptyString,
10708 int kind=ITEM_NORMAL) -> MenuItem
10709 """
54f9ee45 10710 return _core_.Menu_Prepend(*args, **kwargs)
e811c8ce
RD
10711
10712 def PrependSeparator(*args, **kwargs):
a95a7133 10713 """PrependSeparator(self) -> MenuItem"""
54f9ee45 10714 return _core_.Menu_PrependSeparator(*args, **kwargs)
e811c8ce
RD
10715
10716 def PrependCheckItem(*args, **kwargs):
a95a7133 10717 """PrependCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
54f9ee45 10718 return _core_.Menu_PrependCheckItem(*args, **kwargs)
e811c8ce
RD
10719
10720 def PrependRadioItem(*args, **kwargs):
a95a7133 10721 """PrependRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
54f9ee45 10722 return _core_.Menu_PrependRadioItem(*args, **kwargs)
e811c8ce
RD
10723
10724 def PrependMenu(*args, **kwargs):
a95a7133 10725 """PrependMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
54f9ee45 10726 return _core_.Menu_PrependMenu(*args, **kwargs)
e811c8ce
RD
10727
10728 def Remove(*args, **kwargs):
a95a7133 10729 """Remove(self, int id) -> MenuItem"""
54f9ee45 10730 return _core_.Menu_Remove(*args, **kwargs)
e811c8ce
RD
10731
10732 def RemoveItem(*args, **kwargs):
a95a7133 10733 """RemoveItem(self, MenuItem item) -> MenuItem"""
54f9ee45 10734 return _core_.Menu_RemoveItem(*args, **kwargs)
e811c8ce
RD
10735
10736 def Delete(*args, **kwargs):
a95a7133 10737 """Delete(self, int id) -> bool"""
54f9ee45 10738 return _core_.Menu_Delete(*args, **kwargs)
e811c8ce
RD
10739
10740 def DeleteItem(*args, **kwargs):
a95a7133 10741 """DeleteItem(self, MenuItem item) -> bool"""
54f9ee45 10742 return _core_.Menu_DeleteItem(*args, **kwargs)
e811c8ce
RD
10743
10744 def Destroy(*args, **kwargs):
0df68c9f 10745 """
a95a7133 10746 Destroy(self)
e811c8ce 10747
0df68c9f
RD
10748 Deletes the C++ object this Python object is a proxy for.
10749 """
b39fe951
RD
10750 args[0].this.own(False)
10751 return _core_.Menu_Destroy(*args, **kwargs)
e811c8ce
RD
10752
10753 def DestroyId(*args, **kwargs):
b39fe951
RD
10754 """DestroyId(self, int id) -> bool"""
10755 return _core_.Menu_DestroyId(*args, **kwargs)
e811c8ce
RD
10756
10757 def DestroyItem(*args, **kwargs):
b39fe951
RD
10758 """DestroyItem(self, MenuItem item) -> bool"""
10759 return _core_.Menu_DestroyItem(*args, **kwargs)
e811c8ce
RD
10760
10761 def GetMenuItemCount(*args, **kwargs):
a95a7133 10762 """GetMenuItemCount(self) -> size_t"""
54f9ee45 10763 return _core_.Menu_GetMenuItemCount(*args, **kwargs)
e811c8ce
RD
10764
10765 def GetMenuItems(*args, **kwargs):
a95a7133 10766 """GetMenuItems(self) -> PyObject"""
54f9ee45 10767 return _core_.Menu_GetMenuItems(*args, **kwargs)
e811c8ce
RD
10768
10769 def FindItem(*args, **kwargs):
a95a7133 10770 """FindItem(self, String item) -> int"""
54f9ee45 10771 return _core_.Menu_FindItem(*args, **kwargs)
e811c8ce
RD
10772
10773 def FindItemById(*args, **kwargs):
a95a7133 10774 """FindItemById(self, int id) -> MenuItem"""
54f9ee45 10775 return _core_.Menu_FindItemById(*args, **kwargs)
e811c8ce
RD
10776
10777 def FindItemByPosition(*args, **kwargs):
a95a7133 10778 """FindItemByPosition(self, size_t position) -> MenuItem"""
54f9ee45 10779 return _core_.Menu_FindItemByPosition(*args, **kwargs)
e811c8ce
RD
10780
10781 def Enable(*args, **kwargs):
a95a7133 10782 """Enable(self, int id, bool enable)"""
54f9ee45 10783 return _core_.Menu_Enable(*args, **kwargs)
e811c8ce
RD
10784
10785 def IsEnabled(*args, **kwargs):
a95a7133 10786 """IsEnabled(self, int id) -> bool"""
54f9ee45 10787 return _core_.Menu_IsEnabled(*args, **kwargs)
e811c8ce
RD
10788
10789 def Check(*args, **kwargs):
a95a7133 10790 """Check(self, int id, bool check)"""
54f9ee45 10791 return _core_.Menu_Check(*args, **kwargs)
e811c8ce
RD
10792
10793 def IsChecked(*args, **kwargs):
a95a7133 10794 """IsChecked(self, int id) -> bool"""
54f9ee45 10795 return _core_.Menu_IsChecked(*args, **kwargs)
e811c8ce
RD
10796
10797 def SetLabel(*args, **kwargs):
a95a7133 10798 """SetLabel(self, int id, String label)"""
54f9ee45 10799 return _core_.Menu_SetLabel(*args, **kwargs)
e811c8ce
RD
10800
10801 def GetLabel(*args, **kwargs):
a95a7133 10802 """GetLabel(self, int id) -> String"""
54f9ee45 10803 return _core_.Menu_GetLabel(*args, **kwargs)
e811c8ce
RD
10804
10805 def SetHelpString(*args, **kwargs):
a95a7133 10806 """SetHelpString(self, int id, String helpString)"""
54f9ee45 10807 return _core_.Menu_SetHelpString(*args, **kwargs)
e811c8ce
RD
10808
10809 def GetHelpString(*args, **kwargs):
a95a7133 10810 """GetHelpString(self, int id) -> String"""
54f9ee45 10811 return _core_.Menu_GetHelpString(*args, **kwargs)
e811c8ce
RD
10812
10813 def SetTitle(*args, **kwargs):
a95a7133 10814 """SetTitle(self, String title)"""
54f9ee45 10815 return _core_.Menu_SetTitle(*args, **kwargs)
e811c8ce
RD
10816
10817 def GetTitle(*args, **kwargs):
a95a7133 10818 """GetTitle(self) -> String"""
54f9ee45 10819 return _core_.Menu_GetTitle(*args, **kwargs)
e811c8ce
RD
10820
10821 def SetEventHandler(*args, **kwargs):
a95a7133 10822 """SetEventHandler(self, EvtHandler handler)"""
54f9ee45 10823 return _core_.Menu_SetEventHandler(*args, **kwargs)
e811c8ce
RD
10824
10825 def GetEventHandler(*args, **kwargs):
a95a7133 10826 """GetEventHandler(self) -> EvtHandler"""
54f9ee45 10827 return _core_.Menu_GetEventHandler(*args, **kwargs)
e811c8ce
RD
10828
10829 def SetInvokingWindow(*args, **kwargs):
a95a7133 10830 """SetInvokingWindow(self, Window win)"""
54f9ee45 10831 return _core_.Menu_SetInvokingWindow(*args, **kwargs)
e811c8ce
RD
10832
10833 def GetInvokingWindow(*args, **kwargs):
a95a7133 10834 """GetInvokingWindow(self) -> Window"""
54f9ee45 10835 return _core_.Menu_GetInvokingWindow(*args, **kwargs)
e811c8ce
RD
10836
10837 def GetStyle(*args, **kwargs):
a95a7133 10838 """GetStyle(self) -> long"""
54f9ee45 10839 return _core_.Menu_GetStyle(*args, **kwargs)
e811c8ce
RD
10840
10841 def UpdateUI(*args, **kwargs):
a95a7133 10842 """UpdateUI(self, EvtHandler source=None)"""
54f9ee45 10843 return _core_.Menu_UpdateUI(*args, **kwargs)
e811c8ce
RD
10844
10845 def GetMenuBar(*args, **kwargs):
a95a7133 10846 """GetMenuBar(self) -> MenuBar"""
54f9ee45 10847 return _core_.Menu_GetMenuBar(*args, **kwargs)
e811c8ce
RD
10848
10849 def Attach(*args, **kwargs):
a95a7133 10850 """Attach(self, wxMenuBarBase menubar)"""
54f9ee45 10851 return _core_.Menu_Attach(*args, **kwargs)
e811c8ce
RD
10852
10853 def Detach(*args, **kwargs):
a95a7133 10854 """Detach(self)"""
54f9ee45 10855 return _core_.Menu_Detach(*args, **kwargs)
e811c8ce
RD
10856
10857 def IsAttached(*args, **kwargs):
a95a7133 10858 """IsAttached(self) -> bool"""
54f9ee45 10859 return _core_.Menu_IsAttached(*args, **kwargs)
e811c8ce
RD
10860
10861 def SetParent(*args, **kwargs):
a95a7133 10862 """SetParent(self, Menu parent)"""
54f9ee45 10863 return _core_.Menu_SetParent(*args, **kwargs)
e811c8ce
RD
10864
10865 def GetParent(*args, **kwargs):
a95a7133 10866 """GetParent(self) -> Menu"""
54f9ee45 10867 return _core_.Menu_GetParent(*args, **kwargs)
e811c8ce 10868
57332a5a
RD
10869 EventHandler = property(GetEventHandler,SetEventHandler,doc="See `GetEventHandler` and `SetEventHandler`")
10870 HelpString = property(GetHelpString,SetHelpString,doc="See `GetHelpString` and `SetHelpString`")
10871 InvokingWindow = property(GetInvokingWindow,SetInvokingWindow,doc="See `GetInvokingWindow` and `SetInvokingWindow`")
10872 MenuBar = property(GetMenuBar,doc="See `GetMenuBar`")
10873 MenuItemCount = property(GetMenuItemCount,doc="See `GetMenuItemCount`")
10874 MenuItems = property(GetMenuItems,doc="See `GetMenuItems`")
10875 Parent = property(GetParent,SetParent,doc="See `GetParent` and `SetParent`")
10876 Style = property(GetStyle,doc="See `GetStyle`")
10877 Title = property(GetTitle,SetTitle,doc="See `GetTitle` and `SetTitle`")
2131d850 10878_core_.Menu_swigregister(Menu)
d14a1e28
RD
10879DefaultValidator = cvar.DefaultValidator
10880
10881#---------------------------------------------------------------------------
10882
10883class MenuBar(Window):
093d3ff1 10884 """Proxy of C++ MenuBar class"""
0085ce49
RD
10885 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10886 __repr__ = _swig_repr
10887 def __init__(self, *args, **kwargs):
a95a7133 10888 """__init__(self, long style=0) -> MenuBar"""
0085ce49 10889 _core_.MenuBar_swiginit(self,_core_.new_MenuBar(*args, **kwargs))
d14a1e28 10890 self._setOORInfo(self)
e811c8ce
RD
10891
10892 def Append(*args, **kwargs):
a95a7133 10893 """Append(self, Menu menu, String title) -> bool"""
54f9ee45 10894 return _core_.MenuBar_Append(*args, **kwargs)
e811c8ce
RD
10895
10896 def Insert(*args, **kwargs):
a95a7133 10897 """Insert(self, size_t pos, Menu menu, String title) -> bool"""
54f9ee45 10898 return _core_.MenuBar_Insert(*args, **kwargs)
e811c8ce
RD
10899
10900 def GetMenuCount(*args, **kwargs):
a95a7133 10901 """GetMenuCount(self) -> size_t"""
54f9ee45 10902 return _core_.MenuBar_GetMenuCount(*args, **kwargs)
e811c8ce
RD
10903
10904 def GetMenu(*args, **kwargs):
a95a7133 10905 """GetMenu(self, size_t pos) -> Menu"""
54f9ee45 10906 return _core_.MenuBar_GetMenu(*args, **kwargs)
e811c8ce
RD
10907
10908 def Replace(*args, **kwargs):
a95a7133 10909 """Replace(self, size_t pos, Menu menu, String title) -> Menu"""
54f9ee45 10910 return _core_.MenuBar_Replace(*args, **kwargs)
e811c8ce
RD
10911
10912 def Remove(*args, **kwargs):
a95a7133 10913 """Remove(self, size_t pos) -> Menu"""
54f9ee45 10914 return _core_.MenuBar_Remove(*args, **kwargs)
e811c8ce
RD
10915
10916 def EnableTop(*args, **kwargs):
a95a7133 10917 """EnableTop(self, size_t pos, bool enable)"""
54f9ee45 10918 return _core_.MenuBar_EnableTop(*args, **kwargs)
e811c8ce
RD
10919
10920 def IsEnabledTop(*args, **kwargs):
a95a7133 10921 """IsEnabledTop(self, size_t pos) -> bool"""
54f9ee45 10922 return _core_.MenuBar_IsEnabledTop(*args, **kwargs)
e811c8ce
RD
10923
10924 def SetLabelTop(*args, **kwargs):
a95a7133 10925 """SetLabelTop(self, size_t pos, String label)"""
54f9ee45 10926 return _core_.MenuBar_SetLabelTop(*args, **kwargs)
e811c8ce
RD
10927
10928 def GetLabelTop(*args, **kwargs):
a95a7133 10929 """GetLabelTop(self, size_t pos) -> String"""
54f9ee45 10930 return _core_.MenuBar_GetLabelTop(*args, **kwargs)
e811c8ce
RD
10931
10932 def FindMenuItem(*args, **kwargs):
a95a7133 10933 """FindMenuItem(self, String menu, String item) -> int"""
54f9ee45 10934 return _core_.MenuBar_FindMenuItem(*args, **kwargs)
e811c8ce
RD
10935
10936 def FindItemById(*args, **kwargs):
a95a7133 10937 """FindItemById(self, int id) -> MenuItem"""
54f9ee45 10938 return _core_.MenuBar_FindItemById(*args, **kwargs)
e811c8ce
RD
10939
10940 def FindMenu(*args, **kwargs):
a95a7133 10941 """FindMenu(self, String title) -> int"""
54f9ee45 10942 return _core_.MenuBar_FindMenu(*args, **kwargs)
e811c8ce
RD
10943
10944 def Enable(*args, **kwargs):
a95a7133 10945 """Enable(self, int id, bool enable)"""
54f9ee45 10946 return _core_.MenuBar_Enable(*args, **kwargs)
e811c8ce
RD
10947
10948 def Check(*args, **kwargs):
a95a7133 10949 """Check(self, int id, bool check)"""
54f9ee45 10950 return _core_.MenuBar_Check(*args, **kwargs)
e811c8ce
RD
10951
10952 def IsChecked(*args, **kwargs):
a95a7133 10953 """IsChecked(self, int id) -> bool"""
54f9ee45 10954 return _core_.MenuBar_IsChecked(*args, **kwargs)
e811c8ce
RD
10955
10956 def IsEnabled(*args, **kwargs):
a95a7133 10957 """IsEnabled(self, int id) -> bool"""
54f9ee45 10958 return _core_.MenuBar_IsEnabled(*args, **kwargs)
e811c8ce
RD
10959
10960 def SetLabel(*args, **kwargs):
a95a7133 10961 """SetLabel(self, int id, String label)"""
54f9ee45 10962 return _core_.MenuBar_SetLabel(*args, **kwargs)
e811c8ce
RD
10963
10964 def GetLabel(*args, **kwargs):
a95a7133 10965 """GetLabel(self, int id) -> String"""
54f9ee45 10966 return _core_.MenuBar_GetLabel(*args, **kwargs)
e811c8ce
RD
10967
10968 def SetHelpString(*args, **kwargs):
a95a7133 10969 """SetHelpString(self, int id, String helpString)"""
54f9ee45 10970 return _core_.MenuBar_SetHelpString(*args, **kwargs)
e811c8ce
RD
10971
10972 def GetHelpString(*args, **kwargs):
a95a7133 10973 """GetHelpString(self, int id) -> String"""
54f9ee45 10974 return _core_.MenuBar_GetHelpString(*args, **kwargs)
e811c8ce
RD
10975
10976 def GetFrame(*args, **kwargs):
a95a7133 10977 """GetFrame(self) -> wxFrame"""
54f9ee45 10978 return _core_.MenuBar_GetFrame(*args, **kwargs)
e811c8ce
RD
10979
10980 def IsAttached(*args, **kwargs):
a95a7133 10981 """IsAttached(self) -> bool"""
54f9ee45 10982 return _core_.MenuBar_IsAttached(*args, **kwargs)
e811c8ce
RD
10983
10984 def Attach(*args, **kwargs):
a95a7133 10985 """Attach(self, wxFrame frame)"""
54f9ee45 10986 return _core_.MenuBar_Attach(*args, **kwargs)
e811c8ce
RD
10987
10988 def Detach(*args, **kwargs):
a95a7133 10989 """Detach(self)"""
54f9ee45 10990 return _core_.MenuBar_Detach(*args, **kwargs)
e811c8ce 10991
587d0f36
RD
10992 def UpdateMenus(*args, **kwargs):
10993 """UpdateMenus(self)"""
10994 return _core_.MenuBar_UpdateMenus(*args, **kwargs)
10995
4f433fef
RD
10996 def SetAutoWindowMenu(*args, **kwargs):
10997 """SetAutoWindowMenu(bool enable)"""
10998 return _core_.MenuBar_SetAutoWindowMenu(*args, **kwargs)
10999
11000 SetAutoWindowMenu = staticmethod(SetAutoWindowMenu)
11001 def GetAutoWindowMenu(*args, **kwargs):
11002 """GetAutoWindowMenu() -> bool"""
11003 return _core_.MenuBar_GetAutoWindowMenu(*args, **kwargs)
11004
11005 GetAutoWindowMenu = staticmethod(GetAutoWindowMenu)
97ab0f6a
RD
11006 def GetMenus(self):
11007 """Return a list of (menu, label) items for the menus in the MenuBar. """
11008 return [(self.GetMenu(i), self.GetLabelTop(i))
11009 for i in range(self.GetMenuCount())]
11010
11011 def SetMenus(self, items):
11012 """Clear and add new menus to the MenuBar from a list of (menu, label) items. """
11013 for i in range(self.GetMenuCount()-1, -1, -1):
11014 self.Remove(i)
11015 for m, l in items:
11016 self.Append(m, l)
11017
57332a5a
RD
11018 Frame = property(GetFrame,doc="See `GetFrame`")
11019 Menu = property(GetMenu,doc="See `GetMenu`")
11020 MenuCount = property(GetMenuCount,doc="See `GetMenuCount`")
11021 Menus = property(GetMenus,SetMenus,doc="See `GetMenus` and `SetMenus`")
2131d850 11022_core_.MenuBar_swigregister(MenuBar)
d14a1e28 11023
4f433fef 11024def MenuBar_SetAutoWindowMenu(*args, **kwargs):
0085ce49
RD
11025 """MenuBar_SetAutoWindowMenu(bool enable)"""
11026 return _core_.MenuBar_SetAutoWindowMenu(*args, **kwargs)
4f433fef 11027
0085ce49
RD
11028def MenuBar_GetAutoWindowMenu(*args):
11029 """MenuBar_GetAutoWindowMenu() -> bool"""
11030 return _core_.MenuBar_GetAutoWindowMenu(*args)
4f433fef 11031
d14a1e28
RD
11032#---------------------------------------------------------------------------
11033
11034class MenuItem(Object):
093d3ff1 11035 """Proxy of C++ MenuItem class"""
0085ce49
RD
11036 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11037 __repr__ = _swig_repr
11038 def __init__(self, *args, **kwargs):
0df68c9f 11039 """
a95a7133 11040 __init__(self, Menu parentMenu=None, int id=ID_ANY, String text=EmptyString,
196addbf
RD
11041 String help=EmptyString, int kind=ITEM_NORMAL,
11042 Menu subMenu=None) -> MenuItem
0df68c9f 11043 """
0085ce49
RD
11044 _core_.MenuItem_swiginit(self,_core_.new_MenuItem(*args, **kwargs))
11045 __swig_destroy__ = _core_.delete_MenuItem
11046 __del__ = lambda self : None;
e811c8ce 11047 def GetMenu(*args, **kwargs):
a95a7133 11048 """GetMenu(self) -> Menu"""
54f9ee45 11049 return _core_.MenuItem_GetMenu(*args, **kwargs)
e811c8ce
RD
11050
11051 def SetMenu(*args, **kwargs):
a95a7133 11052 """SetMenu(self, Menu menu)"""
54f9ee45 11053 return _core_.MenuItem_SetMenu(*args, **kwargs)
e811c8ce
RD
11054
11055 def SetId(*args, **kwargs):
a95a7133 11056 """SetId(self, int id)"""
54f9ee45 11057 return _core_.MenuItem_SetId(*args, **kwargs)
e811c8ce
RD
11058
11059 def GetId(*args, **kwargs):
a95a7133 11060 """GetId(self) -> int"""
54f9ee45 11061 return _core_.MenuItem_GetId(*args, **kwargs)
e811c8ce
RD
11062
11063 def IsSeparator(*args, **kwargs):
a95a7133 11064 """IsSeparator(self) -> bool"""
54f9ee45 11065 return _core_.MenuItem_IsSeparator(*args, **kwargs)
e811c8ce
RD
11066
11067 def SetText(*args, **kwargs):
a95a7133 11068 """SetText(self, String str)"""
54f9ee45 11069 return _core_.MenuItem_SetText(*args, **kwargs)
e811c8ce
RD
11070
11071 def GetLabel(*args, **kwargs):
a95a7133 11072 """GetLabel(self) -> String"""
54f9ee45 11073 return _core_.MenuItem_GetLabel(*args, **kwargs)
e811c8ce
RD
11074
11075 def GetText(*args, **kwargs):
a95a7133 11076 """GetText(self) -> String"""
54f9ee45 11077 return _core_.MenuItem_GetText(*args, **kwargs)
e811c8ce
RD
11078
11079 def GetLabelFromText(*args, **kwargs):
66c033b4 11080 """GetLabelFromText(String text) -> String"""
54f9ee45 11081 return _core_.MenuItem_GetLabelFromText(*args, **kwargs)
e811c8ce
RD
11082
11083 GetLabelFromText = staticmethod(GetLabelFromText)
11084 def GetKind(*args, **kwargs):
a95a7133 11085 """GetKind(self) -> int"""
54f9ee45 11086 return _core_.MenuItem_GetKind(*args, **kwargs)
e811c8ce 11087
a95a7133
RD
11088 def SetKind(*args, **kwargs):
11089 """SetKind(self, int kind)"""
54f9ee45 11090 return _core_.MenuItem_SetKind(*args, **kwargs)
a95a7133 11091
e811c8ce 11092 def SetCheckable(*args, **kwargs):
a95a7133 11093 """SetCheckable(self, bool checkable)"""
54f9ee45 11094 return _core_.MenuItem_SetCheckable(*args, **kwargs)
e811c8ce
RD
11095
11096 def IsCheckable(*args, **kwargs):
a95a7133 11097 """IsCheckable(self) -> bool"""
54f9ee45 11098 return _core_.MenuItem_IsCheckable(*args, **kwargs)
e811c8ce
RD
11099
11100 def IsSubMenu(*args, **kwargs):
a95a7133 11101 """IsSubMenu(self) -> bool"""
54f9ee45 11102 return _core_.MenuItem_IsSubMenu(*args, **kwargs)
e811c8ce
RD
11103
11104 def SetSubMenu(*args, **kwargs):
a95a7133 11105 """SetSubMenu(self, Menu menu)"""
54f9ee45 11106 return _core_.MenuItem_SetSubMenu(*args, **kwargs)
e811c8ce
RD
11107
11108 def GetSubMenu(*args, **kwargs):
a95a7133 11109 """GetSubMenu(self) -> Menu"""
54f9ee45 11110 return _core_.MenuItem_GetSubMenu(*args, **kwargs)
e811c8ce
RD
11111
11112 def Enable(*args, **kwargs):
a95a7133 11113 """Enable(self, bool enable=True)"""
54f9ee45 11114 return _core_.MenuItem_Enable(*args, **kwargs)
e811c8ce
RD
11115
11116 def IsEnabled(*args, **kwargs):
a95a7133 11117 """IsEnabled(self) -> bool"""
54f9ee45 11118 return _core_.MenuItem_IsEnabled(*args, **kwargs)
e811c8ce
RD
11119
11120 def Check(*args, **kwargs):
a95a7133 11121 """Check(self, bool check=True)"""
54f9ee45 11122 return _core_.MenuItem_Check(*args, **kwargs)
e811c8ce
RD
11123
11124 def IsChecked(*args, **kwargs):
a95a7133 11125 """IsChecked(self) -> bool"""
54f9ee45 11126 return _core_.MenuItem_IsChecked(*args, **kwargs)
e811c8ce
RD
11127
11128 def Toggle(*args, **kwargs):
a95a7133 11129 """Toggle(self)"""
54f9ee45 11130 return _core_.MenuItem_Toggle(*args, **kwargs)
e811c8ce
RD
11131
11132 def SetHelp(*args, **kwargs):
a95a7133 11133 """SetHelp(self, String str)"""
54f9ee45 11134 return _core_.MenuItem_SetHelp(*args, **kwargs)
e811c8ce
RD
11135
11136 def GetHelp(*args, **kwargs):
a95a7133 11137 """GetHelp(self) -> String"""
54f9ee45 11138 return _core_.MenuItem_GetHelp(*args, **kwargs)
e811c8ce
RD
11139
11140 def GetAccel(*args, **kwargs):
a95a7133 11141 """GetAccel(self) -> AcceleratorEntry"""
54f9ee45 11142 return _core_.MenuItem_GetAccel(*args, **kwargs)
e811c8ce
RD
11143
11144 def SetAccel(*args, **kwargs):
a95a7133 11145 """SetAccel(self, AcceleratorEntry accel)"""
54f9ee45 11146 return _core_.MenuItem_SetAccel(*args, **kwargs)
e811c8ce 11147
091f5bed
RD
11148 def SetBitmap(*args, **kwargs):
11149 """SetBitmap(self, Bitmap bitmap)"""
11150 return _core_.MenuItem_SetBitmap(*args, **kwargs)
11151
11152 def GetBitmap(*args, **kwargs):
11153 """GetBitmap(self) -> Bitmap"""
11154 return _core_.MenuItem_GetBitmap(*args, **kwargs)
11155
c1280d1e
RD
11156 def SetFont(*args, **kwargs):
11157 """SetFont(self, Font font)"""
11158 return _core_.MenuItem_SetFont(*args, **kwargs)
11159
11160 def GetFont(*args, **kwargs):
11161 """GetFont(self) -> Font"""
11162 return _core_.MenuItem_GetFont(*args, **kwargs)
11163
11164 def SetTextColour(*args, **kwargs):
11165 """SetTextColour(self, Colour colText)"""
11166 return _core_.MenuItem_SetTextColour(*args, **kwargs)
11167
11168 def GetTextColour(*args, **kwargs):
11169 """GetTextColour(self) -> Colour"""
11170 return _core_.MenuItem_GetTextColour(*args, **kwargs)
11171
11172 def SetBackgroundColour(*args, **kwargs):
11173 """SetBackgroundColour(self, Colour colBack)"""
11174 return _core_.MenuItem_SetBackgroundColour(*args, **kwargs)
11175
11176 def GetBackgroundColour(*args, **kwargs):
11177 """GetBackgroundColour(self) -> Colour"""
11178 return _core_.MenuItem_GetBackgroundColour(*args, **kwargs)
11179
11180 def SetBitmaps(*args, **kwargs):
11181 """SetBitmaps(self, Bitmap bmpChecked, Bitmap bmpUnchecked=wxNullBitmap)"""
11182 return _core_.MenuItem_SetBitmaps(*args, **kwargs)
11183
11184 def SetDisabledBitmap(*args, **kwargs):
11185 """SetDisabledBitmap(self, Bitmap bmpDisabled)"""
11186 return _core_.MenuItem_SetDisabledBitmap(*args, **kwargs)
11187
11188 def GetDisabledBitmap(*args, **kwargs):
11189 """GetDisabledBitmap(self) -> Bitmap"""
11190 return _core_.MenuItem_GetDisabledBitmap(*args, **kwargs)
11191
11192 def SetMarginWidth(*args, **kwargs):
11193 """SetMarginWidth(self, int nWidth)"""
11194 return _core_.MenuItem_SetMarginWidth(*args, **kwargs)
11195
11196 def GetMarginWidth(*args, **kwargs):
11197 """GetMarginWidth(self) -> int"""
11198 return _core_.MenuItem_GetMarginWidth(*args, **kwargs)
11199
e811c8ce 11200 def GetDefaultMarginWidth(*args, **kwargs):
66c033b4 11201 """GetDefaultMarginWidth() -> int"""
54f9ee45 11202 return _core_.MenuItem_GetDefaultMarginWidth(*args, **kwargs)
e811c8ce
RD
11203
11204 GetDefaultMarginWidth = staticmethod(GetDefaultMarginWidth)
c1280d1e
RD
11205 def IsOwnerDrawn(*args, **kwargs):
11206 """IsOwnerDrawn(self) -> bool"""
11207 return _core_.MenuItem_IsOwnerDrawn(*args, **kwargs)
11208
11209 def SetOwnerDrawn(*args, **kwargs):
11210 """SetOwnerDrawn(self, bool ownerDrawn=True)"""
11211 return _core_.MenuItem_SetOwnerDrawn(*args, **kwargs)
11212
11213 def ResetOwnerDrawn(*args, **kwargs):
11214 """ResetOwnerDrawn(self)"""
11215 return _core_.MenuItem_ResetOwnerDrawn(*args, **kwargs)
11216
57332a5a
RD
11217 Accel = property(GetAccel,SetAccel,doc="See `GetAccel` and `SetAccel`")
11218 BackgroundColour = property(GetBackgroundColour,SetBackgroundColour,doc="See `GetBackgroundColour` and `SetBackgroundColour`")
11219 Bitmap = property(GetBitmap,SetBitmap,doc="See `GetBitmap` and `SetBitmap`")
11220 DisabledBitmap = property(GetDisabledBitmap,SetDisabledBitmap,doc="See `GetDisabledBitmap` and `SetDisabledBitmap`")
11221 Font = property(GetFont,SetFont,doc="See `GetFont` and `SetFont`")
11222 Help = property(GetHelp,SetHelp,doc="See `GetHelp` and `SetHelp`")
11223 Id = property(GetId,SetId,doc="See `GetId` and `SetId`")
11224 Kind = property(GetKind,SetKind,doc="See `GetKind` and `SetKind`")
11225 Label = property(GetLabel,doc="See `GetLabel`")
11226 MarginWidth = property(GetMarginWidth,SetMarginWidth,doc="See `GetMarginWidth` and `SetMarginWidth`")
11227 Menu = property(GetMenu,SetMenu,doc="See `GetMenu` and `SetMenu`")
11228 SubMenu = property(GetSubMenu,SetSubMenu,doc="See `GetSubMenu` and `SetSubMenu`")
11229 Text = property(GetText,SetText,doc="See `GetText` and `SetText`")
11230 TextColour = property(GetTextColour,SetTextColour,doc="See `GetTextColour` and `SetTextColour`")
2131d850 11231_core_.MenuItem_swigregister(MenuItem)
d14a1e28 11232
e811c8ce 11233def MenuItem_GetLabelFromText(*args, **kwargs):
0085ce49
RD
11234 """MenuItem_GetLabelFromText(String text) -> String"""
11235 return _core_.MenuItem_GetLabelFromText(*args, **kwargs)
d14a1e28 11236
0085ce49
RD
11237def MenuItem_GetDefaultMarginWidth(*args):
11238 """MenuItem_GetDefaultMarginWidth() -> int"""
11239 return _core_.MenuItem_GetDefaultMarginWidth(*args)
d14a1e28
RD
11240
11241#---------------------------------------------------------------------------
11242
11243class Control(Window):
15afbcd0
RD
11244 """
11245 This is the base class for a control or 'widget'.
11246
41e2b43e
RD
11247 A control is generally a small window which processes user input
11248 and/or displays one or more item of data.
15afbcd0 11249 """
0085ce49
RD
11250 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11251 __repr__ = _swig_repr
11252 def __init__(self, *args, **kwargs):
0df68c9f 11253 """
248ed943
RD
11254 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
11255 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
b2dc1044 11256 String name=ControlNameStr) -> Control
15afbcd0 11257
41e2b43e
RD
11258 Create a Control. Normally you should only call this from a subclass'
11259 __init__ as a plain old wx.Control is not very useful.
0df68c9f 11260 """
0085ce49 11261 _core_.Control_swiginit(self,_core_.new_Control(*args, **kwargs))
d14a1e28 11262 self._setOORInfo(self)
e811c8ce
RD
11263
11264 def Create(*args, **kwargs):
0df68c9f 11265 """
248ed943
RD
11266 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
11267 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
b2dc1044 11268 String name=ControlNameStr) -> bool
15afbcd0
RD
11269
11270 Do the 2nd phase and create the GUI control.
0df68c9f 11271 """
54f9ee45 11272 return _core_.Control_Create(*args, **kwargs)
e811c8ce 11273
10044bf1
RD
11274 def GetAlignment(*args, **kwargs):
11275 """
11276 GetAlignment(self) -> int
11277
11278 Get the control alignment (left/right/centre, top/bottom/centre)
11279 """
11280 return _core_.Control_GetAlignment(*args, **kwargs)
11281
34e0a3bb 11282 def GetLabelText(*args, **kwargs):
10044bf1 11283 """
10044bf1
RD
11284 GetLabelText(self) -> String
11285
11286 Get just the text of the label, without mnemonic characters ('&')
11287 """
34e0a3bb 11288 return _core_.Control_GetLabelText(*args, **kwargs)
10044bf1 11289
e811c8ce 11290 def Command(*args, **kwargs):
15afbcd0 11291 """
a95a7133 11292 Command(self, CommandEvent event)
15afbcd0 11293
41e2b43e
RD
11294 Simulates the effect of the user issuing a command to the item.
11295
11296 :see: `wx.CommandEvent`
11297
15afbcd0 11298 """
54f9ee45 11299 return _core_.Control_Command(*args, **kwargs)
e811c8ce 11300
74a57fcd 11301 def GetClassDefaultAttributes(*args, **kwargs):
110da5b0
RD
11302 """
11303 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
11304
11305 Get the default attributes for this class. This is useful if you want
11306 to use the same font or colour in your own control as in a standard
11307 control -- which is a much better idea than hard coding specific
11308 colours or fonts which might look completely out of place on the
11309 user's system, especially if it uses themes.
11310
11311 The variant parameter is only relevant under Mac currently and is
11312 ignore under other platforms. Under Mac, it will change the size of
11313 the returned font. See `wx.Window.SetWindowVariant` for more about
11314 this.
11315 """
54f9ee45 11316 return _core_.Control_GetClassDefaultAttributes(*args, **kwargs)
74a57fcd
RD
11317
11318 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
2bf58437 11319 Alignment = property(GetAlignment,doc="See `GetAlignment`")
2bf58437 11320 LabelText = property(GetLabelText,doc="See `GetLabelText`")
2131d850 11321_core_.Control_swigregister(Control)
b2dc1044 11322ControlNameStr = cvar.ControlNameStr
d14a1e28
RD
11323
11324def PreControl(*args, **kwargs):
15afbcd0
RD
11325 """
11326 PreControl() -> Control
11327
11328 Precreate a Control control for 2-phase creation
11329 """
54f9ee45 11330 val = _core_.new_PreControl(*args, **kwargs)
d14a1e28
RD
11331 return val
11332
74a57fcd 11333def Control_GetClassDefaultAttributes(*args, **kwargs):
0085ce49 11334 """
110da5b0
RD
11335 Control_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
11336
11337 Get the default attributes for this class. This is useful if you want
11338 to use the same font or colour in your own control as in a standard
11339 control -- which is a much better idea than hard coding specific
11340 colours or fonts which might look completely out of place on the
11341 user's system, especially if it uses themes.
11342
11343 The variant parameter is only relevant under Mac currently and is
11344 ignore under other platforms. Under Mac, it will change the size of
11345 the returned font. See `wx.Window.SetWindowVariant` for more about
11346 this.
11347 """
0085ce49 11348 return _core_.Control_GetClassDefaultAttributes(*args, **kwargs)
74a57fcd 11349
d14a1e28
RD
11350#---------------------------------------------------------------------------
11351
11352class ItemContainer(object):
15afbcd0 11353 """
53aa7709
RD
11354 The wx.ItemContainer class defines an interface which is implemented
11355 by all controls which have string subitems, each of which may be
11356 selected, such as `wx.ListBox`, `wx.CheckListBox`, `wx.Choice` as well
11357 as `wx.ComboBox` which implements an extended interface deriving from
41e2b43e 11358 this one.
15afbcd0 11359
41e2b43e
RD
11360 It defines the methods for accessing the control's items and although
11361 each of the derived classes implements them differently, they still
11362 all conform to the same interface.
15afbcd0 11363
41e2b43e
RD
11364 The items in a wx.ItemContainer have (non empty) string labels and,
11365 optionally, client data associated with them.
15afbcd0
RD
11366
11367 """
0085ce49
RD
11368 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11369 def __init__(self): raise AttributeError, "No constructor defined"
11370 __repr__ = _swig_repr
e811c8ce 11371 def Append(*args, **kwargs):
15afbcd0 11372 """
a95a7133 11373 Append(self, String item, PyObject clientData=None) -> int
15afbcd0 11374
41e2b43e
RD
11375 Adds the item to the control, associating the given data with the item
11376 if not None. The return value is the index of the newly added item
11377 which may be different from the last one if the control is sorted (e.g.
11378 has wx.LB_SORT or wx.CB_SORT style).
15afbcd0 11379 """
54f9ee45 11380 return _core_.ItemContainer_Append(*args, **kwargs)
e811c8ce
RD
11381
11382 def AppendItems(*args, **kwargs):
15afbcd0 11383 """
f5b96ee1 11384 AppendItems(self, List strings)
15afbcd0 11385
41e2b43e
RD
11386 Apend several items at once to the control. Notice that calling this
11387 method may be much faster than appending the items one by one if you
11388 need to add a lot of items.
15afbcd0 11389 """
54f9ee45 11390 return _core_.ItemContainer_AppendItems(*args, **kwargs)
e811c8ce
RD
11391
11392 def Insert(*args, **kwargs):
15afbcd0 11393 """
d359a380 11394 Insert(self, String item, int pos, PyObject clientData=None) -> int
15afbcd0 11395
41e2b43e 11396 Insert an item into the control before the item at the ``pos`` index,
15afbcd0
RD
11397 optionally associating some data object with the item.
11398 """
54f9ee45 11399 return _core_.ItemContainer_Insert(*args, **kwargs)
e811c8ce
RD
11400
11401 def Clear(*args, **kwargs):
15afbcd0 11402 """
a95a7133 11403 Clear(self)
15afbcd0
RD
11404
11405 Removes all items from the control.
11406 """
54f9ee45 11407 return _core_.ItemContainer_Clear(*args, **kwargs)
e811c8ce
RD
11408
11409 def Delete(*args, **kwargs):
15afbcd0 11410 """
d359a380 11411 Delete(self, int n)
15afbcd0 11412
41e2b43e
RD
11413 Deletes the item at the zero-based index 'n' from the control. Note
11414 that it is an error (signalled by a `wx.PyAssertionError` exception if
11415 enabled) to remove an item with the index negative or greater or equal
11416 than the number of items in the control.
15afbcd0 11417 """
54f9ee45 11418 return _core_.ItemContainer_Delete(*args, **kwargs)
e811c8ce 11419
53aa7709
RD
11420 def GetClientData(*args, **kwargs):
11421 """
d359a380 11422 GetClientData(self, int n) -> PyObject
53aa7709
RD
11423
11424 Returns the client data associated with the given item, (if any.)
11425 """
11426 return _core_.ItemContainer_GetClientData(*args, **kwargs)
11427
11428 def SetClientData(*args, **kwargs):
11429 """
d359a380 11430 SetClientData(self, int n, PyObject clientData)
53aa7709
RD
11431
11432 Associate the given client data with the item at position n.
11433 """
11434 return _core_.ItemContainer_SetClientData(*args, **kwargs)
11435
e811c8ce 11436 def GetCount(*args, **kwargs):
15afbcd0 11437 """
d359a380 11438 GetCount(self) -> int
15afbcd0
RD
11439
11440 Returns the number of items in the control.
11441 """
54f9ee45 11442 return _core_.ItemContainer_GetCount(*args, **kwargs)
e811c8ce
RD
11443
11444 def IsEmpty(*args, **kwargs):
15afbcd0 11445 """
a95a7133 11446 IsEmpty(self) -> bool
15afbcd0
RD
11447
11448 Returns True if the control is empty or False if it has some items.
11449 """
54f9ee45 11450 return _core_.ItemContainer_IsEmpty(*args, **kwargs)
e811c8ce
RD
11451
11452 def GetString(*args, **kwargs):
15afbcd0 11453 """
d359a380 11454 GetString(self, int n) -> String
15afbcd0
RD
11455
11456 Returns the label of the item with the given index.
11457 """
54f9ee45 11458 return _core_.ItemContainer_GetString(*args, **kwargs)
e811c8ce
RD
11459
11460 def GetStrings(*args, **kwargs):
a95a7133 11461 """GetStrings(self) -> wxArrayString"""
54f9ee45 11462 return _core_.ItemContainer_GetStrings(*args, **kwargs)
e811c8ce
RD
11463
11464 def SetString(*args, **kwargs):
15afbcd0 11465 """
d359a380 11466 SetString(self, int n, String s)
15afbcd0
RD
11467
11468 Sets the label for the given item.
11469 """
54f9ee45 11470 return _core_.ItemContainer_SetString(*args, **kwargs)
e811c8ce
RD
11471
11472 def FindString(*args, **kwargs):
15afbcd0 11473 """
a95a7133 11474 FindString(self, String s) -> int
15afbcd0
RD
11475
11476 Finds an item whose label matches the given string. Returns the
41e2b43e
RD
11477 zero-based position of the item, or ``wx.NOT_FOUND`` if the string was not
11478 found.
15afbcd0 11479 """
54f9ee45 11480 return _core_.ItemContainer_FindString(*args, **kwargs)
e811c8ce 11481
53aa7709 11482 def SetSelection(*args, **kwargs):
15afbcd0 11483 """
53aa7709 11484 SetSelection(self, int n)
15afbcd0
RD
11485
11486 Sets the item at index 'n' to be the selected item.
11487 """
53aa7709 11488 return _core_.ItemContainer_SetSelection(*args, **kwargs)
e811c8ce
RD
11489
11490 def GetSelection(*args, **kwargs):
15afbcd0 11491 """
a95a7133 11492 GetSelection(self) -> int
15afbcd0 11493
41e2b43e
RD
11494 Returns the index of the selected item or ``wx.NOT_FOUND`` if no item
11495 is selected.
15afbcd0 11496 """
54f9ee45 11497 return _core_.ItemContainer_GetSelection(*args, **kwargs)
e811c8ce 11498
53aa7709
RD
11499 def SetStringSelection(*args, **kwargs):
11500 """SetStringSelection(self, String s) -> bool"""
11501 return _core_.ItemContainer_SetStringSelection(*args, **kwargs)
11502
e811c8ce 11503 def GetStringSelection(*args, **kwargs):
15afbcd0 11504 """
a95a7133 11505 GetStringSelection(self) -> String
15afbcd0 11506
41e2b43e
RD
11507 Returns the label of the selected item or an empty string if no item
11508 is selected.
15afbcd0 11509 """
54f9ee45 11510 return _core_.ItemContainer_GetStringSelection(*args, **kwargs)
e811c8ce 11511
53aa7709 11512 def Select(*args, **kwargs):
15afbcd0 11513 """
53aa7709 11514 Select(self, int n)
15afbcd0 11515
53aa7709
RD
11516 This is the same as `SetSelection` and exists only because it is
11517 slightly more natural for controls which support multiple selection.
15afbcd0 11518 """
53aa7709 11519 return _core_.ItemContainer_Select(*args, **kwargs)
e811c8ce 11520
97ab0f6a
RD
11521 def GetItems(self):
11522 """Return a list of the strings in the control"""
11523 return [self.GetString(i) for i in xrange(self.GetCount())]
11524
11525 def SetItems(self, items):
11526 """Clear and set the strings in the control from a list"""
11527 self.Clear()
11528 for i in items:
11529 self.Append(i)
11530
11531 Count = property(GetCount,doc="See `GetCount`")
11532 Items = property(GetItems,SetItems,doc="See `GetItems` and `SetItems`")
11533 Selection = property(GetSelection,SetSelection,doc="See `GetSelection` and `SetSelection`")
11534 StringSelection = property(GetStringSelection,SetStringSelection,doc="See `GetStringSelection` and `SetStringSelection`")
11535 Strings = property(GetStrings,doc="See `GetStrings`")
2131d850 11536_core_.ItemContainer_swigregister(ItemContainer)
d14a1e28
RD
11537
11538#---------------------------------------------------------------------------
11539
11540class ControlWithItems(Control,ItemContainer):
15afbcd0 11541 """
41e2b43e
RD
11542 wx.ControlWithItems combines the ``wx.ItemContainer`` class with the
11543 wx.Control class, and is used for the base class of various controls
11544 that have items.
15afbcd0 11545 """
0085ce49
RD
11546 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11547 def __init__(self): raise AttributeError, "No constructor defined"
11548 __repr__ = _swig_repr
2131d850 11549_core_.ControlWithItems_swigregister(ControlWithItems)
d14a1e28
RD
11550
11551#---------------------------------------------------------------------------
11552
11553class SizerItem(Object):
248ed943
RD
11554 """
11555 The wx.SizerItem class is used to track the position, size and other
01f6b6d3
RD
11556 attributes of each item managed by a `wx.Sizer`. It is not usually
11557 necessary to use this class because the sizer elements can also be
11558 identified by their positions or window or sizer references but
11559 sometimes it may be more convenient to use wx.SizerItem directly.
11560 Also, custom classes derived from `wx.PySizer` will probably need to
11561 use the collection of wx.SizerItems held by wx.Sizer when calculating
11562 layout.
248ed943
RD
11563
11564 :see: `wx.Sizer`, `wx.GBSizerItem`
11565 """
0085ce49
RD
11566 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11567 __repr__ = _swig_repr
11568 def __init__(self, *args, **kwargs):
248ed943
RD
11569 """
11570 __init__(self) -> SizerItem
11571
11572 Constructs an empty wx.SizerItem. Either a window, sizer or spacer
11573 size will need to be set before this item can be used in a Sizer.
11574
11575 You will probably never need to create a wx.SizerItem directly as they
11576 are created automatically when the sizer's Add, Insert or Prepend
11577 methods are called.
11578
11579 :see: `wx.SizerItemSpacer`, `wx.SizerItemWindow`, `wx.SizerItemSizer`
11580 """
0085ce49
RD
11581 _core_.SizerItem_swiginit(self,_core_.new_SizerItem(*args, **kwargs))
11582 __swig_destroy__ = _core_.delete_SizerItem
11583 __del__ = lambda self : None;
e811c8ce 11584 def DeleteWindows(*args, **kwargs):
248ed943
RD
11585 """
11586 DeleteWindows(self)
11587
11588 Destroy the window or the windows in a subsizer, depending on the type
11589 of item.
11590 """
54f9ee45 11591 return _core_.SizerItem_DeleteWindows(*args, **kwargs)
e811c8ce
RD
11592
11593 def DetachSizer(*args, **kwargs):
248ed943
RD
11594 """
11595 DetachSizer(self)
11596
11597 Enable deleting the SizerItem without destroying the contained sizer.
11598 """
54f9ee45 11599 return _core_.SizerItem_DetachSizer(*args, **kwargs)
e811c8ce
RD
11600
11601 def GetSize(*args, **kwargs):
248ed943
RD
11602 """
11603 GetSize(self) -> Size
11604
11605 Get the current size of the item, as set in the last Layout.
11606 """
54f9ee45 11607 return _core_.SizerItem_GetSize(*args, **kwargs)
e811c8ce
RD
11608
11609 def CalcMin(*args, **kwargs):
248ed943
RD
11610 """
11611 CalcMin(self) -> Size
11612
11613 Calculates the minimum desired size for the item, including any space
11614 needed by borders.
11615 """
54f9ee45 11616 return _core_.SizerItem_CalcMin(*args, **kwargs)
e811c8ce
RD
11617
11618 def SetDimension(*args, **kwargs):
248ed943
RD
11619 """
11620 SetDimension(self, Point pos, Size size)
11621
11622 Set the position and size of the space allocated for this item by the
11623 sizer, and adjust the position and size of the item (window or
11624 subsizer) to be within that space taking alignment and borders into
11625 account.
11626 """
54f9ee45 11627 return _core_.SizerItem_SetDimension(*args, **kwargs)
e811c8ce
RD
11628
11629 def GetMinSize(*args, **kwargs):
248ed943
RD
11630 """
11631 GetMinSize(self) -> Size
11632
11633 Get the minimum size needed for the item.
11634 """
54f9ee45 11635 return _core_.SizerItem_GetMinSize(*args, **kwargs)
e811c8ce 11636
dfbb5885
RD
11637 def GetMinSizeWithBorder(*args, **kwargs):
11638 """
11639 GetMinSizeWithBorder(self) -> Size
11640
11641 Get the minimum size needed for the item with space for the borders
11642 added, if needed.
11643 """
11644 return _core_.SizerItem_GetMinSizeWithBorder(*args, **kwargs)
11645
e811c8ce 11646 def SetInitSize(*args, **kwargs):
a95a7133 11647 """SetInitSize(self, int x, int y)"""
54f9ee45 11648 return _core_.SizerItem_SetInitSize(*args, **kwargs)
e811c8ce
RD
11649
11650 def SetRatioWH(*args, **kwargs):
248ed943
RD
11651 """
11652 SetRatioWH(self, int width, int height)
11653
11654 Set the ratio item attribute.
11655 """
54f9ee45 11656 return _core_.SizerItem_SetRatioWH(*args, **kwargs)
e811c8ce
RD
11657
11658 def SetRatioSize(*args, **kwargs):
248ed943
RD
11659 """
11660 SetRatioSize(self, Size size)
11661
11662 Set the ratio item attribute.
11663 """
54f9ee45 11664 return _core_.SizerItem_SetRatioSize(*args, **kwargs)
e811c8ce
RD
11665
11666 def SetRatio(*args, **kwargs):
248ed943
RD
11667 """
11668 SetRatio(self, float ratio)
11669
11670 Set the ratio item attribute.
11671 """
54f9ee45 11672 return _core_.SizerItem_SetRatio(*args, **kwargs)
e811c8ce
RD
11673
11674 def GetRatio(*args, **kwargs):
248ed943
RD
11675 """
11676 GetRatio(self) -> float
11677
11678 Set the ratio item attribute.
11679 """
54f9ee45 11680 return _core_.SizerItem_GetRatio(*args, **kwargs)
e811c8ce 11681
d3b6e4ff
RD
11682 def GetRect(*args, **kwargs):
11683 """
11684 GetRect(self) -> Rect
11685
11686 Returns the rectangle that the sizer item should occupy
11687 """
11688 return _core_.SizerItem_GetRect(*args, **kwargs)
11689
e811c8ce 11690 def IsWindow(*args, **kwargs):
248ed943
RD
11691 """
11692 IsWindow(self) -> bool
11693
11694 Is this sizer item a window?
11695 """
54f9ee45 11696 return _core_.SizerItem_IsWindow(*args, **kwargs)
e811c8ce
RD
11697
11698 def IsSizer(*args, **kwargs):
248ed943
RD
11699 """
11700 IsSizer(self) -> bool
11701
11702 Is this sizer item a subsizer?
11703 """
54f9ee45 11704 return _core_.SizerItem_IsSizer(*args, **kwargs)
e811c8ce
RD
11705
11706 def IsSpacer(*args, **kwargs):
248ed943
RD
11707 """
11708 IsSpacer(self) -> bool
11709
11710 Is this sizer item a spacer?
11711 """
54f9ee45 11712 return _core_.SizerItem_IsSpacer(*args, **kwargs)
e811c8ce
RD
11713
11714 def SetProportion(*args, **kwargs):
248ed943
RD
11715 """
11716 SetProportion(self, int proportion)
11717
11718 Set the proportion value for this item.
11719 """
54f9ee45 11720 return _core_.SizerItem_SetProportion(*args, **kwargs)
e811c8ce
RD
11721
11722 def GetProportion(*args, **kwargs):
248ed943
RD
11723 """
11724 GetProportion(self) -> int
11725
11726 Get the proportion value for this item.
11727 """
54f9ee45 11728 return _core_.SizerItem_GetProportion(*args, **kwargs)
e811c8ce 11729
248ed943
RD
11730 SetOption = wx._deprecated(SetProportion, "Please use `SetProportion` instead.")
11731 GetOption = wx._deprecated(GetProportion, "Please use `GetProportion` instead.")
e811c8ce 11732 def SetFlag(*args, **kwargs):
248ed943
RD
11733 """
11734 SetFlag(self, int flag)
11735
11736 Set the flag value for this item.
11737 """
54f9ee45 11738 return _core_.SizerItem_SetFlag(*args, **kwargs)
e811c8ce
RD
11739
11740 def GetFlag(*args, **kwargs):
248ed943
RD
11741 """
11742 GetFlag(self) -> int
11743
11744 Get the flag value for this item.
11745 """
54f9ee45 11746 return _core_.SizerItem_GetFlag(*args, **kwargs)
e811c8ce
RD
11747
11748 def SetBorder(*args, **kwargs):
248ed943
RD
11749 """
11750 SetBorder(self, int border)
11751
11752 Set the border value for this item.
11753 """
54f9ee45 11754 return _core_.SizerItem_SetBorder(*args, **kwargs)
e811c8ce
RD
11755
11756 def GetBorder(*args, **kwargs):
248ed943
RD
11757 """
11758 GetBorder(self) -> int
11759
11760 Get the border value for this item.
11761 """
54f9ee45 11762 return _core_.SizerItem_GetBorder(*args, **kwargs)
e811c8ce
RD
11763
11764 def GetWindow(*args, **kwargs):
248ed943
RD
11765 """
11766 GetWindow(self) -> Window
11767
11768 Get the window (if any) that is managed by this sizer item.
11769 """
54f9ee45 11770 return _core_.SizerItem_GetWindow(*args, **kwargs)
e811c8ce
RD
11771
11772 def SetWindow(*args, **kwargs):
248ed943
RD
11773 """
11774 SetWindow(self, Window window)
11775
11776 Set the window to be managed by this sizer item.
11777 """
54f9ee45 11778 return _core_.SizerItem_SetWindow(*args, **kwargs)
e811c8ce
RD
11779
11780 def GetSizer(*args, **kwargs):
248ed943
RD
11781 """
11782 GetSizer(self) -> Sizer
11783
11784 Get the subsizer (if any) that is managed by this sizer item.
11785 """
54f9ee45 11786 return _core_.SizerItem_GetSizer(*args, **kwargs)
e811c8ce
RD
11787
11788 def SetSizer(*args, **kwargs):
248ed943
RD
11789 """
11790 SetSizer(self, Sizer sizer)
11791
11792 Set the subsizer to be managed by this sizer item.
11793 """
54f9ee45 11794 return _core_.SizerItem_SetSizer(*args, **kwargs)
e811c8ce
RD
11795
11796 def GetSpacer(*args, **kwargs):
248ed943
RD
11797 """
11798 GetSpacer(self) -> Size
11799
11800 Get the size of the spacer managed by this sizer item.
11801 """
54f9ee45 11802 return _core_.SizerItem_GetSpacer(*args, **kwargs)
e811c8ce
RD
11803
11804 def SetSpacer(*args, **kwargs):
248ed943
RD
11805 """
11806 SetSpacer(self, Size size)
11807
11808 Set the size of the spacer to be managed by this sizer item.
11809 """
54f9ee45 11810 return _core_.SizerItem_SetSpacer(*args, **kwargs)
e811c8ce
RD
11811
11812 def Show(*args, **kwargs):
248ed943
RD
11813 """
11814 Show(self, bool show)
11815
11816 Set the show item attribute, which sizers use to determine if the item
11817 is to be made part of the layout or not. If the item is tracking a
11818 window then it is shown or hidden as needed.
11819 """
54f9ee45 11820 return _core_.SizerItem_Show(*args, **kwargs)
e811c8ce
RD
11821
11822 def IsShown(*args, **kwargs):
248ed943
RD
11823 """
11824 IsShown(self) -> bool
11825
11826 Is the item to be shown in the layout?
11827 """
54f9ee45 11828 return _core_.SizerItem_IsShown(*args, **kwargs)
e811c8ce
RD
11829
11830 def GetPosition(*args, **kwargs):
248ed943
RD
11831 """
11832 GetPosition(self) -> Point
11833
11834 Returns the current position of the item, as set in the last Layout.
11835 """
54f9ee45 11836 return _core_.SizerItem_GetPosition(*args, **kwargs)
e811c8ce
RD
11837
11838 def GetUserData(*args, **kwargs):
248ed943
RD
11839 """
11840 GetUserData(self) -> PyObject
11841
11842 Returns the userData associated with this sizer item, or None if there
11843 isn't any.
11844 """
54f9ee45 11845 return _core_.SizerItem_GetUserData(*args, **kwargs)
e811c8ce 11846
091f5bed
RD
11847 def SetUserData(*args, **kwargs):
11848 """
11849 SetUserData(self, PyObject userData)
11850
11851 Associate a Python object with this sizer item.
11852 """
11853 return _core_.SizerItem_SetUserData(*args, **kwargs)
11854
33d6fd3b
RD
11855 Border = property(GetBorder,SetBorder,doc="See `GetBorder` and `SetBorder`")
11856 Flag = property(GetFlag,SetFlag,doc="See `GetFlag` and `SetFlag`")
11857 MinSize = property(GetMinSize,doc="See `GetMinSize`")
11858 MinSizeWithBorder = property(GetMinSizeWithBorder,doc="See `GetMinSizeWithBorder`")
11859 Position = property(GetPosition,doc="See `GetPosition`")
11860 Proportion = property(GetProportion,SetProportion,doc="See `GetProportion` and `SetProportion`")
11861 Ratio = property(GetRatio,SetRatio,doc="See `GetRatio` and `SetRatio`")
11862 Rect = property(GetRect,doc="See `GetRect`")
11863 Size = property(GetSize,doc="See `GetSize`")
11864 Sizer = property(GetSizer,SetSizer,doc="See `GetSizer` and `SetSizer`")
11865 Spacer = property(GetSpacer,SetSpacer,doc="See `GetSpacer` and `SetSpacer`")
11866 UserData = property(GetUserData,SetUserData,doc="See `GetUserData` and `SetUserData`")
11867 Window = property(GetWindow,SetWindow,doc="See `GetWindow` and `SetWindow`")
2131d850 11868_core_.SizerItem_swigregister(SizerItem)
d14a1e28 11869
248ed943 11870def SizerItemWindow(*args, **kwargs):
0df68c9f 11871 """
248ed943
RD
11872 SizerItemWindow(Window window, int proportion, int flag, int border,
11873 PyObject userData=None) -> SizerItem
11874
11875 Constructs a `wx.SizerItem` for tracking a window.
0df68c9f 11876 """
248ed943 11877 val = _core_.new_SizerItemWindow(*args, **kwargs)
d14a1e28
RD
11878 return val
11879
248ed943 11880def SizerItemSpacer(*args, **kwargs):
0df68c9f 11881 """
248ed943
RD
11882 SizerItemSpacer(int width, int height, int proportion, int flag, int border,
11883 PyObject userData=None) -> SizerItem
11884
11885 Constructs a `wx.SizerItem` for tracking a spacer.
0df68c9f 11886 """
248ed943 11887 val = _core_.new_SizerItemSpacer(*args, **kwargs)
d14a1e28
RD
11888 return val
11889
11890def SizerItemSizer(*args, **kwargs):
0df68c9f
RD
11891 """
11892 SizerItemSizer(Sizer sizer, int proportion, int flag, int border,
248ed943
RD
11893 PyObject userData=None) -> SizerItem
11894
11895 Constructs a `wx.SizerItem` for tracking a subsizer
0df68c9f 11896 """
54f9ee45 11897 val = _core_.new_SizerItemSizer(*args, **kwargs)
d14a1e28
RD
11898 return val
11899
11900class Sizer(Object):
248ed943
RD
11901 """
11902 wx.Sizer is the abstract base class used for laying out subwindows in
11903 a window. You cannot use wx.Sizer directly; instead, you will have to
11904 use one of the sizer classes derived from it such as `wx.BoxSizer`,
1d5ee749
RD
11905 `wx.StaticBoxSizer`, `wx.GridSizer`, `wx.FlexGridSizer` and
11906 `wx.GridBagSizer`.
248ed943
RD
11907
11908 The concept implemented by sizers in wxWidgets is closely related to
11909 layout tools in other GUI toolkits, such as Java's AWT, the GTK
11910 toolkit or the Qt toolkit. It is based upon the idea of the individual
11911 subwindows reporting their minimal required size and their ability to
11912 get stretched if the size of the parent window has changed. This will
11913 most often mean that the programmer does not set the original size of
11914 a dialog in the beginning, rather the dialog will assigned a sizer and
11915 this sizer will be queried about the recommended size. The sizer in
11916 turn will query its children, which can be normal windows or contorls,
11917 empty space or other sizers, so that a hierarchy of sizers can be
11918 constructed. Note that wxSizer does not derive from wxWindow and thus
11919 do not interfere with tab ordering and requires very little resources
11920 compared to a real window on screen.
11921
11922 What makes sizers so well fitted for use in wxWidgets is the fact that
11923 every control reports its own minimal size and the algorithm can
11924 handle differences in font sizes or different window (dialog item)
11925 sizes on different platforms without problems. If for example the
11926 standard font as well as the overall design of Mac widgets requires
11927 more space than on Windows, then the initial size of a dialog using a
11928 sizer will automatically be bigger on Mac than on Windows.
11929 """
0085ce49
RD
11930 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11931 def __init__(self): raise AttributeError, "No constructor defined"
11932 __repr__ = _swig_repr
11933 __swig_destroy__ = _core_.delete_Sizer
11934 __del__ = lambda self : None;
e811c8ce 11935 def _setOORInfo(*args, **kwargs):
a95a7133 11936 """_setOORInfo(self, PyObject _self)"""
54f9ee45 11937 return _core_.Sizer__setOORInfo(*args, **kwargs)
e811c8ce
RD
11938
11939 def Add(*args, **kwargs):
0df68c9f 11940 """
248ed943 11941 Add(self, item, int proportion=0, int flag=0, int border=0,
d3b6e4ff 11942 PyObject userData=None) -> wx.SizerItem
248ed943
RD
11943
11944 Appends a child item to the sizer.
0df68c9f 11945 """
54f9ee45 11946 return _core_.Sizer_Add(*args, **kwargs)
e811c8ce
RD
11947
11948 def Insert(*args, **kwargs):
0df68c9f 11949 """
248ed943 11950 Insert(self, int before, item, int proportion=0, int flag=0, int border=0,
d3b6e4ff 11951 PyObject userData=None) -> wx.SizerItem
248ed943
RD
11952
11953 Inserts a new item into the list of items managed by this sizer before
11954 the item at index *before*. See `Add` for a description of the parameters.
0df68c9f 11955 """
54f9ee45 11956 return _core_.Sizer_Insert(*args, **kwargs)
e811c8ce
RD
11957
11958 def Prepend(*args, **kwargs):
0df68c9f 11959 """
248ed943 11960 Prepend(self, item, int proportion=0, int flag=0, int border=0,
d3b6e4ff 11961 PyObject userData=None) -> wx.SizerItem
248ed943
RD
11962
11963 Adds a new item to the begining of the list of sizer items managed by
11964 this sizer. See `Add` for a description of the parameters.
0df68c9f 11965 """
54f9ee45 11966 return _core_.Sizer_Prepend(*args, **kwargs)
e811c8ce
RD
11967
11968 def Remove(*args, **kwargs):
248ed943
RD
11969 """
11970 Remove(self, item) -> bool
11971
11972 Removes an item from the sizer and destroys it. This method does not
11973 cause any layout or resizing to take place, call `Layout` to update
11974 the layout on screen after removing a child from the sizer. The
11975 *item* parameter can be either a window, a sizer, or the zero-based
11976 index of an item to remove. Returns True if the child item was found
11977 and removed.
11978 """
54f9ee45 11979 return _core_.Sizer_Remove(*args, **kwargs)
e811c8ce 11980
1c0f361b 11981 def Detach(*args, **kwargs):
248ed943
RD
11982 """
11983 Detach(self, item) -> bool
11984
11985 Detaches an item from the sizer without destroying it. This method
11986 does not cause any layout or resizing to take place, call `Layout` to
11987 do so. The *item* parameter can be either a window, a sizer, or the
11988 zero-based index of the item to be detached. Returns True if the child item
11989 was found and detached.
11990 """
1c0f361b
RD
11991 return _core_.Sizer_Detach(*args, **kwargs)
11992
d3b6e4ff
RD
11993 def GetItem(*args, **kwargs):
11994 """
11995 GetItem(self, item) -> wx.SizerItem
11996
11997 Returns the `wx.SizerItem` which holds the *item* given. The *item*
11998 parameter can be either a window, a sizer, or the zero-based index of
4d170c95 11999 the item to be found.
d3b6e4ff
RD
12000 """
12001 return _core_.Sizer_GetItem(*args, **kwargs)
12002
e811c8ce 12003 def _SetItemMinSize(*args, **kwargs):
a95a7133 12004 """_SetItemMinSize(self, PyObject item, Size size)"""
54f9ee45 12005 return _core_.Sizer__SetItemMinSize(*args, **kwargs)
e811c8ce 12006
97ab0f6a
RD
12007 def _ReplaceWin(*args, **kwargs):
12008 """_ReplaceWin(self, Window oldwin, Window newwin, bool recursive=False) -> bool"""
12009 return _core_.Sizer__ReplaceWin(*args, **kwargs)
12010
12011 def _ReplaceSizer(*args, **kwargs):
12012 """_ReplaceSizer(self, Sizer oldsz, Sizer newsz, bool recursive=False) -> bool"""
12013 return _core_.Sizer__ReplaceSizer(*args, **kwargs)
12014
12015 def _ReplaceItem(*args, **kwargs):
12016 """_ReplaceItem(self, size_t index, SizerItem newitem) -> bool"""
12017 return _core_.Sizer__ReplaceItem(*args, **kwargs)
12018
12019 def Replace(self, olditem, item, recursive=False):
12020 """
12021 Detaches the given ``olditem`` from the sizer and replaces it with
12022 ``item`` which can be a window, sizer, or `wx.SizerItem`. The
12023 detached child is destroyed only if it is not a window, (because
12024 windows are owned by their parent, not the sizer.) The
12025 ``recursive`` parameter can be used to search for the given
12026 element recursivly in subsizers.
12027
12028 This method does not cause any layout or resizing to take place,
12029 call `Layout` to do so.
12030
12031 Returns ``True`` if the child item was found and removed.
12032 """
12033 if isinstance(olditem, wx.Window):
12034 return self._ReplaceWin(olditem, item, recursive)
12035 elif isinstnace(olditem, wx.Sizer):
12036 return self._ReplaceSizer(olditem, item, recursive)
12037 elif isinstnace(olditem, int):
12038 return self._ReplaceItem(olditem, item)
12039 else:
12040 raise TypeError("Expected Window, Sizer, or integer for first parameter.")
12041
12042 def SetContainingWindow(*args, **kwargs):
12043 """
12044 SetContainingWindow(self, Window window)
12045
12046 Set (or unset) the window this sizer is used in.
12047 """
12048 return _core_.Sizer_SetContainingWindow(*args, **kwargs)
12049
12050 def GetContainingWindow(*args, **kwargs):
12051 """
12052 GetContainingWindow(self) -> Window
12053
12054 Get the window this sizer is used in.
12055 """
12056 return _core_.Sizer_GetContainingWindow(*args, **kwargs)
12057
248ed943
RD
12058 def SetItemMinSize(self, item, *args):
12059 """
12060 SetItemMinSize(self, item, Size size)
12061
12062 Sets the minimum size that will be allocated for an item in the sizer.
12063 The *item* parameter can be either a window, a sizer, or the
12064 zero-based index of the item. If a window or sizer is given then it
12065 will be searched for recursivly in subsizers if neccessary.
12066 """
12067 if len(args) == 2:
12068 # for backward compatibility accept separate width,height args too
12069 return self._SetItemMinSize(item, args)
12070 else:
12071 return self._SetItemMinSize(item, args[0])
12072
e811c8ce 12073 def AddItem(*args, **kwargs):
248ed943
RD
12074 """
12075 AddItem(self, SizerItem item)
12076
12077 Adds a `wx.SizerItem` to the sizer.
12078 """
54f9ee45 12079 return _core_.Sizer_AddItem(*args, **kwargs)
e811c8ce
RD
12080
12081 def InsertItem(*args, **kwargs):
248ed943
RD
12082 """
12083 InsertItem(self, int index, SizerItem item)
12084
12085 Inserts a `wx.SizerItem` to the sizer at the position given by *index*.
12086 """
54f9ee45 12087 return _core_.Sizer_InsertItem(*args, **kwargs)
e811c8ce
RD
12088
12089 def PrependItem(*args, **kwargs):
248ed943
RD
12090 """
12091 PrependItem(self, SizerItem item)
12092
12093 Prepends a `wx.SizerItem` to the sizer.
12094 """
54f9ee45 12095 return _core_.Sizer_PrependItem(*args, **kwargs)
e811c8ce 12096
248ed943 12097 def AddMany(self, items):
66c033b4
RD
12098 """
12099 AddMany is a convenience method for adding several items
12100 to a sizer at one time. Simply pass it a list of tuples,
12101 where each tuple consists of the parameters that you
12102 would normally pass to the `Add` method.
12103 """
248ed943
RD
12104 for item in items:
12105 if type(item) != type(()) or (len(item) == 2 and type(item[0]) == type(1)):
12106 item = (item, )
12107 self.Add(*item)
d14a1e28 12108
ae5bc7f3
RD
12109 def AddSpacer(self, *args, **kw):
12110 """AddSpacer(int size) --> SizerItem
12111
12112 Add a spacer that is (size,size) pixels.
12113 """
12114 if args and type(args[0]) == int:
12115 return self.Add( (args[0],args[0] ), 0)
12116 else: # otherwise stay compatible with old AddSpacer
12117 return self.Add(*args, **kw)
12118 def PrependSpacer(self, *args, **kw):
12119 """PrependSpacer(int size) --> SizerItem
12120
12121 Prepend a spacer that is (size, size) pixels."""
12122 if args and type(args[0]) == int:
12123 return self.Prepend( (args[0],args[0] ), 0)
12124 else: # otherwise stay compatible with old PrependSpacer
12125 return self.Prepend(*args, **kw)
12126 def InsertSpacer(self, index, *args, **kw):
12127 """InsertSpacer(int index, int size) --> SizerItem
12128
12129 Insert a spacer at position index that is (size, size) pixels."""
12130 if args and type(args[0]) == int:
12131 return self.Insert( index, (args[0],args[0] ), 0)
12132 else: # otherwise stay compatible with old InsertSpacer
12133 return self.Insert(index, *args, **kw)
12134
12135
12136 def AddStretchSpacer(self, prop=1):
12137 """AddStretchSpacer(int prop=1) --> SizerItem
12138
12139 Add a stretchable spacer."""
12140 return self.Add((0,0), prop)
12141 def PrependStretchSpacer(self, prop=1):
12142 """PrependStretchSpacer(int prop=1) --> SizerItem
12143
12144 Prepend a stretchable spacer."""
12145 return self.Prepend((0,0), prop)
12146 def InsertStretchSpacer(self, index, prop=1):
12147 """InsertStretchSpacer(int index, int prop=1) --> SizerItem
12148
12149 Insert a stretchable spacer."""
12150 return self.Insert(index, (0,0), prop)
12151
12152
74e96f3d 12153 # for backwards compatibility only, please do not use in new code
b9d6a5f3
RD
12154 def AddWindow(self, *args, **kw):
12155 """Compatibility alias for `Add`."""
12156 return self.Add(*args, **kw)
12157 def AddSizer(self, *args, **kw):
12158 """Compatibility alias for `Add`."""
12159 return self.Add(*args, **kw)
b9d6a5f3
RD
12160
12161 def PrependWindow(self, *args, **kw):
12162 """Compatibility alias for `Prepend`."""
12163 return self.Prepend(*args, **kw)
12164 def PrependSizer(self, *args, **kw):
12165 """Compatibility alias for `Prepend`."""
12166 return self.Prepend(*args, **kw)
b9d6a5f3
RD
12167
12168 def InsertWindow(self, *args, **kw):
12169 """Compatibility alias for `Insert`."""
12170 return self.Insert(*args, **kw)
12171 def InsertSizer(self, *args, **kw):
12172 """Compatibility alias for `Insert`."""
b9d6a5f3
RD
12173 return self.Insert(*args, **kw)
12174
12175 def RemoveWindow(self, *args, **kw):
12176 """Compatibility alias for `Remove`."""
12177 return self.Remove(*args, **kw)
12178 def RemoveSizer(self, *args, **kw):
12179 """Compatibility alias for `Remove`."""
12180 return self.Remove(*args, **kw)
12181 def RemovePos(self, *args, **kw):
12182 """Compatibility alias for `Remove`."""
12183 return self.Remove(*args, **kw)
d14a1e28
RD
12184
12185
e811c8ce 12186 def SetDimension(*args, **kwargs):
248ed943
RD
12187 """
12188 SetDimension(self, int x, int y, int width, int height)
12189
12190 Call this to force the sizer to take the given dimension and thus
12191 force the items owned by the sizer to resize themselves according to
12192 the rules defined by the parameter in the `Add`, `Insert` or `Prepend`
12193 methods.
12194 """
54f9ee45 12195 return _core_.Sizer_SetDimension(*args, **kwargs)
e811c8ce
RD
12196
12197 def SetMinSize(*args, **kwargs):
248ed943
RD
12198 """
12199 SetMinSize(self, Size size)
12200
12201 Call this to give the sizer a minimal size. Normally, the sizer will
12202 calculate its minimal size based purely on how much space its children
12203 need. After calling this method `GetMinSize` will return either the
12204 minimal size as requested by its children or the minimal size set
12205 here, depending on which is bigger.
12206 """
54f9ee45 12207 return _core_.Sizer_SetMinSize(*args, **kwargs)
e811c8ce
RD
12208
12209 def GetSize(*args, **kwargs):
248ed943
RD
12210 """
12211 GetSize(self) -> Size
12212
12213 Returns the current size of the space managed by the sizer.
12214 """
54f9ee45 12215 return _core_.Sizer_GetSize(*args, **kwargs)
e811c8ce
RD
12216
12217 def GetPosition(*args, **kwargs):
248ed943
RD
12218 """
12219 GetPosition(self) -> Point
12220
12221 Returns the current position of the sizer's managed space.
12222 """
54f9ee45 12223 return _core_.Sizer_GetPosition(*args, **kwargs)
e811c8ce
RD
12224
12225 def GetMinSize(*args, **kwargs):
248ed943
RD
12226 """
12227 GetMinSize(self) -> Size
12228
12229 Returns the minimal size of the sizer. This is either the combined
12230 minimal size of all the children and their borders or the minimal size
12231 set by SetMinSize, depending on which is bigger.
12232 """
54f9ee45 12233 return _core_.Sizer_GetMinSize(*args, **kwargs)
e811c8ce 12234
d14a1e28 12235 def GetSizeTuple(self):
1c0f361b 12236 return self.GetSize().Get()
d14a1e28 12237 def GetPositionTuple(self):
1c0f361b 12238 return self.GetPosition().Get()
d14a1e28 12239 def GetMinSizeTuple(self):
1c0f361b 12240 return self.GetMinSize().Get()
d14a1e28 12241
e811c8ce 12242 def RecalcSizes(*args, **kwargs):
248ed943
RD
12243 """
12244 RecalcSizes(self)
12245
12246 Using the sizes calculated by `CalcMin` reposition and resize all the
12247 items managed by this sizer. You should not need to call this directly as
12248 it is called by `Layout`.
12249 """
54f9ee45 12250 return _core_.Sizer_RecalcSizes(*args, **kwargs)
e811c8ce
RD
12251
12252 def CalcMin(*args, **kwargs):
248ed943
RD
12253 """
12254 CalcMin(self) -> Size
12255
12256 This method is where the sizer will do the actual calculation of its
12257 children's minimal sizes. You should not need to call this directly as
12258 it is called by `Layout`.
12259 """
54f9ee45 12260 return _core_.Sizer_CalcMin(*args, **kwargs)
e811c8ce
RD
12261
12262 def Layout(*args, **kwargs):
248ed943
RD
12263 """
12264 Layout(self)
12265
12266 This method will force the recalculation and layout of the items
12267 controlled by the sizer using the current space allocated to the
12268 sizer. Normally this is called automatically from the owning window's
12269 EVT_SIZE handler, but it is also useful to call it from user code when
12270 one of the items in a sizer change size, or items are added or
12271 removed.
12272 """
54f9ee45 12273 return _core_.Sizer_Layout(*args, **kwargs)
e811c8ce
RD
12274
12275 def Fit(*args, **kwargs):
248ed943
RD
12276 """
12277 Fit(self, Window window) -> Size
12278
12279 Tell the sizer to resize the *window* to match the sizer's minimal
12280 size. This is commonly done in the constructor of the window itself in
12281 order to set its initial size to match the needs of the children as
12282 determined by the sizer. Returns the new size.
12283
12284 For a top level window this is the total window size, not the client size.
12285 """
54f9ee45 12286 return _core_.Sizer_Fit(*args, **kwargs)
e811c8ce
RD
12287
12288 def FitInside(*args, **kwargs):
248ed943
RD
12289 """
12290 FitInside(self, Window window)
12291
12292 Tell the sizer to resize the *virtual size* of the *window* to match the
12293 sizer's minimal size. This will not alter the on screen size of the
12294 window, but may cause the addition/removal/alteration of scrollbars
12295 required to view the virtual area in windows which manage it.
12296
12297 :see: `wx.ScrolledWindow.SetScrollbars`, `SetVirtualSizeHints`
12298
12299 """
54f9ee45 12300 return _core_.Sizer_FitInside(*args, **kwargs)
e811c8ce
RD
12301
12302 def SetSizeHints(*args, **kwargs):
248ed943
RD
12303 """
12304 SetSizeHints(self, Window window)
12305
12306 Tell the sizer to set (and `Fit`) the minimal size of the *window* to
12307 match the sizer's minimal size. This is commonly done in the
12308 constructor of the window itself if the window is resizable (as are
12309 many dialogs under Unix and frames on probably all platforms) in order
12310 to prevent the window from being sized smaller than the minimal size
12311 required by the sizer.
12312 """
54f9ee45 12313 return _core_.Sizer_SetSizeHints(*args, **kwargs)
e811c8ce
RD
12314
12315 def SetVirtualSizeHints(*args, **kwargs):
248ed943
RD
12316 """
12317 SetVirtualSizeHints(self, Window window)
12318
12319 Tell the sizer to set the minimal size of the window virtual area to
12320 match the sizer's minimal size. For windows with managed scrollbars
12321 this will set them appropriately.
12322
12323 :see: `wx.ScrolledWindow.SetScrollbars`
12324
12325 """
54f9ee45 12326 return _core_.Sizer_SetVirtualSizeHints(*args, **kwargs)
e811c8ce
RD
12327
12328 def Clear(*args, **kwargs):
248ed943
RD
12329 """
12330 Clear(self, bool deleteWindows=False)
12331
12332 Clear all items from the sizer, optionally destroying the window items
12333 as well.
12334 """
54f9ee45 12335 return _core_.Sizer_Clear(*args, **kwargs)
e811c8ce
RD
12336
12337 def DeleteWindows(*args, **kwargs):
248ed943
RD
12338 """
12339 DeleteWindows(self)
12340
12341 Destroy all windows managed by the sizer.
12342 """
54f9ee45 12343 return _core_.Sizer_DeleteWindows(*args, **kwargs)
e811c8ce
RD
12344
12345 def GetChildren(*args, **kwargs):
248ed943 12346 """
51b83b37 12347 GetChildren(self) -> list
248ed943
RD
12348
12349 Returns a list of all the `wx.SizerItem` objects managed by the sizer.
12350 """
54f9ee45 12351 return _core_.Sizer_GetChildren(*args, **kwargs)
e811c8ce
RD
12352
12353 def Show(*args, **kwargs):
248ed943 12354 """
ae8162c8 12355 Show(self, item, bool show=True, bool recursive=false) -> bool
e811c8ce 12356
248ed943
RD
12357 Shows or hides an item managed by the sizer. To make a sizer item
12358 disappear or reappear, use Show followed by `Layout`. The *item*
12359 parameter can be either a window, a sizer, or the zero-based index of
7e63a440
RD
12360 the item. Use the recursive parameter to show or hide an item in a
12361 subsizer. Returns True if the item was found.
248ed943
RD
12362 """
12363 return _core_.Sizer_Show(*args, **kwargs)
e811c8ce
RD
12364
12365 def IsShown(*args, **kwargs):
248ed943
RD
12366 """
12367 IsShown(self, item)
12368
b1fcee84 12369 Determines if the item is currently shown. To make a sizer
248ed943
RD
12370 item disappear or reappear, use Show followed by `Layout`. The *item*
12371 parameter can be either a window, a sizer, or the zero-based index of
12372 the item.
12373 """
54f9ee45 12374 return _core_.Sizer_IsShown(*args, **kwargs)
e811c8ce 12375
7e63a440 12376 def Hide(self, item, recursive=False):
248ed943 12377 """
27fb7603 12378 A convenience method for `Show` (item, False, recursive).
248ed943 12379 """
06759a38 12380 return self.Show(item, False, recursive)
248ed943 12381
e811c8ce 12382 def ShowItems(*args, **kwargs):
248ed943
RD
12383 """
12384 ShowItems(self, bool show)
12385
84f85550 12386 Recursively call `wx.SizerItem.Show` on all sizer items.
248ed943 12387 """
54f9ee45 12388 return _core_.Sizer_ShowItems(*args, **kwargs)
e811c8ce 12389
33d6fd3b
RD
12390 Children = property(GetChildren,doc="See `GetChildren`")
12391 ContainingWindow = property(GetContainingWindow,SetContainingWindow,doc="See `GetContainingWindow` and `SetContainingWindow`")
12392 MinSize = property(GetMinSize,SetMinSize,doc="See `GetMinSize` and `SetMinSize`")
12393 Position = property(GetPosition,doc="See `GetPosition`")
12394 Size = property(GetSize,doc="See `GetSize`")
2131d850 12395_core_.Sizer_swigregister(Sizer)
d14a1e28
RD
12396
12397class PySizer(Sizer):
248ed943
RD
12398 """
12399 wx.PySizer is a special version of `wx.Sizer` that has been
12400 instrumented to allow the C++ virtual methods to be overloaded in
12401 Python derived classes. You would derive from this class if you are
12402 wanting to implement a custom sizer in Python code. Simply implement
12403 `CalcMin` and `RecalcSizes` in the derived class and you're all set.
12404 For example::
12405
12406 class MySizer(wx.PySizer):
12407 def __init__(self):
12408 wx.PySizer.__init__(self)
12409
12410 def CalcMin(self):
12411 for item in self.GetChildren():
12412 # calculate the total minimum width and height needed
12413 # by all items in the sizer according to this sizer's
12414 # layout algorithm.
12415 ...
12416 return wx.Size(width, height)
12417
12418 def RecalcSizes(self):
12419 # find the space allotted to this sizer
12420 pos = self.GetPosition()
12421 size = self.GetSize()
12422 for item in self.GetChildren():
12423 # Recalculate (if necessary) the position and size of
12424 # each item and then call item.SetDimension to do the
12425 # actual positioning and sizing of the items within the
12426 # space alloted to this sizer.
12427 ...
12428 item.SetDimension(itemPos, itemSize)
12429
12430
12431 When `Layout` is called it first calls `CalcMin` followed by
12432 `RecalcSizes` so you can optimize a bit by saving the results of
e505d15e 12433 `CalcMin` and reusing them in `RecalcSizes`.
248ed943
RD
12434
12435 :see: `wx.SizerItem`, `wx.Sizer.GetChildren`
12436
12437
12438 """
0085ce49
RD
12439 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12440 __repr__ = _swig_repr
12441 def __init__(self, *args, **kwargs):
248ed943
RD
12442 """
12443 __init__(self) -> PySizer
12444
12445 Creates a wx.PySizer. Must be called from the __init__ in the derived
12446 class.
12447 """
0085ce49 12448 _core_.PySizer_swiginit(self,_core_.new_PySizer(*args, **kwargs))
c25f90f6 12449 self._setOORInfo(self);PySizer._setCallbackInfo(self, self, PySizer)
e811c8ce
RD
12450
12451 def _setCallbackInfo(*args, **kwargs):
a95a7133 12452 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
54f9ee45 12453 return _core_.PySizer__setCallbackInfo(*args, **kwargs)
e811c8ce 12454
2131d850 12455_core_.PySizer_swigregister(PySizer)
d14a1e28
RD
12456
12457#---------------------------------------------------------------------------
12458
12459class BoxSizer(Sizer):
248ed943
RD
12460 """
12461 The basic idea behind a box sizer is that windows will most often be
12462 laid out in rather simple basic geometry, typically in a row or a
12463 column or nested hierarchies of either. A wx.BoxSizer will lay out
12464 its items in a simple row or column, depending on the orientation
12465 parameter passed to the constructor.
12466 """
0085ce49
RD
12467 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12468 __repr__ = _swig_repr
12469 def __init__(self, *args, **kwargs):
248ed943
RD
12470 """
12471 __init__(self, int orient=HORIZONTAL) -> BoxSizer
12472
12473 Constructor for a wx.BoxSizer. *orient* may be one of ``wx.VERTICAL``
12474 or ``wx.HORIZONTAL`` for creating either a column sizer or a row
12475 sizer.
12476 """
0085ce49 12477 _core_.BoxSizer_swiginit(self,_core_.new_BoxSizer(*args, **kwargs))
d14a1e28 12478 self._setOORInfo(self)
e811c8ce
RD
12479
12480 def GetOrientation(*args, **kwargs):
248ed943
RD
12481 """
12482 GetOrientation(self) -> int
12483
12484 Returns the current orientation of the sizer.
12485 """
54f9ee45 12486 return _core_.BoxSizer_GetOrientation(*args, **kwargs)
e811c8ce
RD
12487
12488 def SetOrientation(*args, **kwargs):
248ed943
RD
12489 """
12490 SetOrientation(self, int orient)
e811c8ce 12491
248ed943
RD
12492 Resets the orientation of the sizer.
12493 """
12494 return _core_.BoxSizer_SetOrientation(*args, **kwargs)
e811c8ce 12495
2bf58437 12496 Orientation = property(GetOrientation,SetOrientation,doc="See `GetOrientation` and `SetOrientation`")
2131d850 12497_core_.BoxSizer_swigregister(BoxSizer)
d14a1e28
RD
12498
12499#---------------------------------------------------------------------------
12500
12501class StaticBoxSizer(BoxSizer):
248ed943
RD
12502 """
12503 wx.StaticBoxSizer derives from and functions identically to the
12504 `wx.BoxSizer` and adds a `wx.StaticBox` around the items that the sizer
12505 manages. Note that this static box must be created separately and
12506 passed to the sizer constructor.
12507 """
0085ce49
RD
12508 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12509 __repr__ = _swig_repr
12510 def __init__(self, *args, **kwargs):
248ed943
RD
12511 """
12512 __init__(self, StaticBox box, int orient=HORIZONTAL) -> StaticBoxSizer
12513
12514 Constructor. It takes an associated static box and the orientation
12515 *orient* as parameters - orient can be either of ``wx.VERTICAL`` or
12516 ``wx.HORIZONTAL``.
12517 """
0085ce49 12518 _core_.StaticBoxSizer_swiginit(self,_core_.new_StaticBoxSizer(*args, **kwargs))
d14a1e28 12519 self._setOORInfo(self)
e811c8ce
RD
12520
12521 def GetStaticBox(*args, **kwargs):
248ed943
RD
12522 """
12523 GetStaticBox(self) -> StaticBox
e811c8ce 12524
248ed943
RD
12525 Returns the static box associated with this sizer.
12526 """
12527 return _core_.StaticBoxSizer_GetStaticBox(*args, **kwargs)
e811c8ce 12528
33d6fd3b 12529 StaticBox = property(GetStaticBox,doc="See `GetStaticBox`")
2131d850 12530_core_.StaticBoxSizer_swigregister(StaticBoxSizer)
d14a1e28
RD
12531
12532#---------------------------------------------------------------------------
12533
12534class GridSizer(Sizer):
248ed943
RD
12535 """
12536 A grid sizer is a sizer which lays out its children in a
12537 two-dimensional table with all cells having the same size. In other
12538 words, the width of each cell within the grid is the width of the
12539 widest item added to the sizer and the height of each grid cell is the
12540 height of the tallest item. An optional vertical and/or horizontal
12541 gap between items can also be specified (in pixels.)
12542
12543 Items are placed in the cells of the grid in the order they are added,
12544 in row-major order. In other words, the first row is filled first,
12545 then the second, and so on until all items have been added. (If
12546 neccessary, additional rows will be added as items are added.) If you
12547 need to have greater control over the cells that items are placed in
12548 then use the `wx.GridBagSizer`.
12549
12550 """
0085ce49
RD
12551 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12552 __repr__ = _swig_repr
12553 def __init__(self, *args, **kwargs):
248ed943
RD
12554 """
12555 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> GridSizer
12556
12557 Constructor for a wx.GridSizer. *rows* and *cols* determine the number
12558 of columns and rows in the sizer - if either of the parameters is
12559 zero, it will be calculated to from the total number of children in
12560 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
12561 define extra space between all children.
12562 """
0085ce49 12563 _core_.GridSizer_swiginit(self,_core_.new_GridSizer(*args, **kwargs))
d14a1e28 12564 self._setOORInfo(self)
e811c8ce 12565
e811c8ce 12566 def SetCols(*args, **kwargs):
248ed943
RD
12567 """
12568 SetCols(self, int cols)
12569
12570 Sets the number of columns in the sizer.
12571 """
54f9ee45 12572 return _core_.GridSizer_SetCols(*args, **kwargs)
e811c8ce
RD
12573
12574 def SetRows(*args, **kwargs):
248ed943
RD
12575 """
12576 SetRows(self, int rows)
12577
12578 Sets the number of rows in the sizer.
12579 """
54f9ee45 12580 return _core_.GridSizer_SetRows(*args, **kwargs)
e811c8ce
RD
12581
12582 def SetVGap(*args, **kwargs):
248ed943
RD
12583 """
12584 SetVGap(self, int gap)
12585
12586 Sets the vertical gap (in pixels) between the cells in the sizer.
12587 """
54f9ee45 12588 return _core_.GridSizer_SetVGap(*args, **kwargs)
e811c8ce
RD
12589
12590 def SetHGap(*args, **kwargs):
248ed943
RD
12591 """
12592 SetHGap(self, int gap)
12593
12594 Sets the horizontal gap (in pixels) between cells in the sizer
12595 """
54f9ee45 12596 return _core_.GridSizer_SetHGap(*args, **kwargs)
e811c8ce
RD
12597
12598 def GetCols(*args, **kwargs):
248ed943
RD
12599 """
12600 GetCols(self) -> int
12601
12602 Returns the number of columns in the sizer.
12603 """
54f9ee45 12604 return _core_.GridSizer_GetCols(*args, **kwargs)
e811c8ce
RD
12605
12606 def GetRows(*args, **kwargs):
248ed943
RD
12607 """
12608 GetRows(self) -> int
12609
12610 Returns the number of rows in the sizer.
12611 """
54f9ee45 12612 return _core_.GridSizer_GetRows(*args, **kwargs)
e811c8ce
RD
12613
12614 def GetVGap(*args, **kwargs):
248ed943
RD
12615 """
12616 GetVGap(self) -> int
12617
12618 Returns the vertical gap (in pixels) between the cells in the sizer.
12619 """
54f9ee45 12620 return _core_.GridSizer_GetVGap(*args, **kwargs)
e811c8ce
RD
12621
12622 def GetHGap(*args, **kwargs):
248ed943
RD
12623 """
12624 GetHGap(self) -> int
12625
12626 Returns the horizontal gap (in pixels) between cells in the sizer.
12627 """
54f9ee45 12628 return _core_.GridSizer_GetHGap(*args, **kwargs)
e811c8ce 12629
0085ce49
RD
12630 def CalcRowsCols(self):
12631 """
12632 CalcRowsCols() -> (rows, cols)
12633
12634 Calculates how many rows and columns will be in the sizer based
12635 on the current number of items and also the rows, cols specified
12636 in the constructor.
12637 """
12638 nitems = len(self.GetChildren())
12639 rows = self.GetRows()
12640 cols = self.GetCols()
12641 assert rows != 0 or cols != 0, "Grid sizer must have either rows or columns fixed"
12642 if cols != 0:
12643 rows = (nitems + cols - 1) / cols
12644 elif rows != 0:
12645 cols = (nitems + rows - 1) / rows
12646 return (rows, cols)
d14a1e28 12647
97ab0f6a
RD
12648 Cols = property(GetCols,SetCols,doc="See `GetCols` and `SetCols`")
12649 HGap = property(GetHGap,SetHGap,doc="See `GetHGap` and `SetHGap`")
12650 Rows = property(GetRows,SetRows,doc="See `GetRows` and `SetRows`")
12651 VGap = property(GetVGap,SetVGap,doc="See `GetVGap` and `SetVGap`")
2131d850 12652_core_.GridSizer_swigregister(GridSizer)
d14a1e28
RD
12653
12654#---------------------------------------------------------------------------
12655
54f9ee45
RD
12656FLEX_GROWMODE_NONE = _core_.FLEX_GROWMODE_NONE
12657FLEX_GROWMODE_SPECIFIED = _core_.FLEX_GROWMODE_SPECIFIED
12658FLEX_GROWMODE_ALL = _core_.FLEX_GROWMODE_ALL
d14a1e28 12659class FlexGridSizer(GridSizer):
248ed943
RD
12660 """
12661 A flex grid sizer is a sizer which lays out its children in a
12662 two-dimensional table with all table cells in one row having the same
12663 height and all cells in one column having the same width, but all
12664 rows or all columns are not necessarily the same height or width as in
12665 the `wx.GridSizer`.
12666
12667 wx.FlexGridSizer can also size items equally in one direction but
12668 unequally ("flexibly") in the other. If the sizer is only flexible
12669 in one direction (this can be changed using `SetFlexibleDirection`), it
12670 needs to be decided how the sizer should grow in the other ("non
12671 flexible") direction in order to fill the available space. The
12672 `SetNonFlexibleGrowMode` method serves this purpose.
12673
12674
12675 """
0085ce49
RD
12676 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12677 __repr__ = _swig_repr
12678 def __init__(self, *args, **kwargs):
248ed943
RD
12679 """
12680 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> FlexGridSizer
12681
12682 Constructor for a wx.FlexGridSizer. *rows* and *cols* determine the
12683 number of columns and rows in the sizer - if either of the parameters
12684 is zero, it will be calculated to from the total number of children in
12685 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
12686 define extra space between all children.
12687 """
0085ce49 12688 _core_.FlexGridSizer_swiginit(self,_core_.new_FlexGridSizer(*args, **kwargs))
d14a1e28 12689 self._setOORInfo(self)
e811c8ce 12690
248ed943
RD
12691 def AddGrowableRow(*args, **kwargs):
12692 """
12693 AddGrowableRow(self, size_t idx, int proportion=0)
e811c8ce 12694
248ed943
RD
12695 Specifies that row *idx* (starting from zero) should be grown if there
12696 is extra space available to the sizer.
e811c8ce 12697
248ed943
RD
12698 The *proportion* parameter has the same meaning as the stretch factor
12699 for the box sizers except that if all proportions are 0, then all
12700 columns are resized equally (instead of not being resized at all).
12701 """
54f9ee45 12702 return _core_.FlexGridSizer_AddGrowableRow(*args, **kwargs)
e811c8ce
RD
12703
12704 def RemoveGrowableRow(*args, **kwargs):
248ed943
RD
12705 """
12706 RemoveGrowableRow(self, size_t idx)
12707
12708 Specifies that row *idx* is no longer growable.
12709 """
54f9ee45 12710 return _core_.FlexGridSizer_RemoveGrowableRow(*args, **kwargs)
e811c8ce
RD
12711
12712 def AddGrowableCol(*args, **kwargs):
248ed943
RD
12713 """
12714 AddGrowableCol(self, size_t idx, int proportion=0)
12715
12716 Specifies that column *idx* (starting from zero) should be grown if
12717 there is extra space available to the sizer.
12718
12719 The *proportion* parameter has the same meaning as the stretch factor
12720 for the box sizers except that if all proportions are 0, then all
12721 columns are resized equally (instead of not being resized at all).
12722 """
54f9ee45 12723 return _core_.FlexGridSizer_AddGrowableCol(*args, **kwargs)
e811c8ce
RD
12724
12725 def RemoveGrowableCol(*args, **kwargs):
248ed943
RD
12726 """
12727 RemoveGrowableCol(self, size_t idx)
12728
12729 Specifies that column *idx* is no longer growable.
12730 """
54f9ee45 12731 return _core_.FlexGridSizer_RemoveGrowableCol(*args, **kwargs)
e811c8ce
RD
12732
12733 def SetFlexibleDirection(*args, **kwargs):
248ed943
RD
12734 """
12735 SetFlexibleDirection(self, int direction)
12736
12737 Specifies whether the sizer should flexibly resize its columns, rows,
12738 or both. Argument *direction* can be one of the following values. Any
12739 other value is ignored.
12740
12741 ============== =======================================
12742 wx.VERTICAL Rows are flexibly sized.
12743 wx.HORIZONTAL Columns are flexibly sized.
12744 wx.BOTH Both rows and columns are flexibly sized
12745 (this is the default value).
12746 ============== =======================================
12747
12748 Note that this method does not trigger relayout.
12749
12750 """
54f9ee45 12751 return _core_.FlexGridSizer_SetFlexibleDirection(*args, **kwargs)
e811c8ce
RD
12752
12753 def GetFlexibleDirection(*args, **kwargs):
248ed943
RD
12754 """
12755 GetFlexibleDirection(self) -> int
12756
12757 Returns a value that specifies whether the sizer
12758 flexibly resizes its columns, rows, or both (default).
12759
12760 :see: `SetFlexibleDirection`
12761 """
54f9ee45 12762 return _core_.FlexGridSizer_GetFlexibleDirection(*args, **kwargs)
e811c8ce
RD
12763
12764 def SetNonFlexibleGrowMode(*args, **kwargs):
248ed943
RD
12765 """
12766 SetNonFlexibleGrowMode(self, int mode)
12767
12768 Specifies how the sizer should grow in the non-flexible direction if
12769 there is one (so `SetFlexibleDirection` must have been called
12770 previously). Argument *mode* can be one of the following values:
12771
12772 ========================== =================================================
12773 wx.FLEX_GROWMODE_NONE Sizer doesn't grow in the non flexible direction.
12774 wx.FLEX_GROWMODE_SPECIFIED Sizer honors growable columns/rows set with
12775 `AddGrowableCol` and `AddGrowableRow`. In this
12776 case equal sizing applies to minimum sizes of
12777 columns or rows (this is the default value).
12778 wx.FLEX_GROWMODE_ALL Sizer equally stretches all columns or rows in
12779 the non flexible direction, whether they are
12780 growable or not in the flexbile direction.
12781 ========================== =================================================
12782
12783 Note that this method does not trigger relayout.
248ed943 12784 """
54f9ee45 12785 return _core_.FlexGridSizer_SetNonFlexibleGrowMode(*args, **kwargs)
e811c8ce
RD
12786
12787 def GetNonFlexibleGrowMode(*args, **kwargs):
248ed943
RD
12788 """
12789 GetNonFlexibleGrowMode(self) -> int
12790
12791 Returns the value that specifies how the sizer grows in the
12792 non-flexible direction if there is one.
12793
12794 :see: `SetNonFlexibleGrowMode`
12795 """
54f9ee45 12796 return _core_.FlexGridSizer_GetNonFlexibleGrowMode(*args, **kwargs)
e811c8ce
RD
12797
12798 def GetRowHeights(*args, **kwargs):
fd2dc343
RD
12799 """
12800 GetRowHeights(self) -> list
12801
12802 Returns a list of integers representing the heights of each of the
12803 rows in the sizer.
12804 """
54f9ee45 12805 return _core_.FlexGridSizer_GetRowHeights(*args, **kwargs)
e811c8ce
RD
12806
12807 def GetColWidths(*args, **kwargs):
fd2dc343
RD
12808 """
12809 GetColWidths(self) -> list
12810
12811 Returns a list of integers representing the widths of each of the
12812 columns in the sizer.
12813 """
54f9ee45 12814 return _core_.FlexGridSizer_GetColWidths(*args, **kwargs)
e811c8ce 12815
97ab0f6a
RD
12816 ColWidths = property(GetColWidths,doc="See `GetColWidths`")
12817 FlexibleDirection = property(GetFlexibleDirection,SetFlexibleDirection,doc="See `GetFlexibleDirection` and `SetFlexibleDirection`")
12818 NonFlexibleGrowMode = property(GetNonFlexibleGrowMode,SetNonFlexibleGrowMode,doc="See `GetNonFlexibleGrowMode` and `SetNonFlexibleGrowMode`")
12819 RowHeights = property(GetRowHeights,doc="See `GetRowHeights`")
2131d850 12820_core_.FlexGridSizer_swigregister(FlexGridSizer)
d14a1e28 12821
e505d15e
RD
12822class StdDialogButtonSizer(BoxSizer):
12823 """
12824 A special sizer that knows how to order and position standard buttons
12825 in order to conform to the current platform's standards. You simply
12826 need to add each `wx.Button` to the sizer, and be sure to create the
53aa7709 12827 buttons using the standard ID's. Then call `Realize` and the sizer
e505d15e
RD
12828 will take care of the rest.
12829
12830 """
0085ce49
RD
12831 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12832 __repr__ = _swig_repr
12833 def __init__(self, *args, **kwargs):
e505d15e 12834 """__init__(self) -> StdDialogButtonSizer"""
0085ce49 12835 _core_.StdDialogButtonSizer_swiginit(self,_core_.new_StdDialogButtonSizer(*args, **kwargs))
e505d15e
RD
12836 def AddButton(*args, **kwargs):
12837 """
12838 AddButton(self, wxButton button)
12839
12840 Use this to add the buttons to this sizer. Do not use the `Add`
12841 method in the base class.
12842 """
12843 return _core_.StdDialogButtonSizer_AddButton(*args, **kwargs)
12844
53aa7709 12845 def Realize(*args, **kwargs):
e505d15e 12846 """
53aa7709 12847 Realize(self)
e505d15e
RD
12848
12849 This funciton needs to be called after all the buttons have been added
12850 to the sizer. It will reorder them and position them in a platform
12851 specifc manner.
12852 """
53aa7709 12853 return _core_.StdDialogButtonSizer_Realize(*args, **kwargs)
51b83b37
RD
12854
12855 def SetAffirmativeButton(*args, **kwargs):
12856 """SetAffirmativeButton(self, wxButton button)"""
12857 return _core_.StdDialogButtonSizer_SetAffirmativeButton(*args, **kwargs)
12858
12859 def SetNegativeButton(*args, **kwargs):
12860 """SetNegativeButton(self, wxButton button)"""
12861 return _core_.StdDialogButtonSizer_SetNegativeButton(*args, **kwargs)
12862
12863 def SetCancelButton(*args, **kwargs):
12864 """SetCancelButton(self, wxButton button)"""
12865 return _core_.StdDialogButtonSizer_SetCancelButton(*args, **kwargs)
e505d15e
RD
12866
12867 def GetAffirmativeButton(*args, **kwargs):
12868 """GetAffirmativeButton(self) -> wxButton"""
12869 return _core_.StdDialogButtonSizer_GetAffirmativeButton(*args, **kwargs)
12870
12871 def GetApplyButton(*args, **kwargs):
12872 """GetApplyButton(self) -> wxButton"""
12873 return _core_.StdDialogButtonSizer_GetApplyButton(*args, **kwargs)
12874
12875 def GetNegativeButton(*args, **kwargs):
12876 """GetNegativeButton(self) -> wxButton"""
12877 return _core_.StdDialogButtonSizer_GetNegativeButton(*args, **kwargs)
12878
12879 def GetCancelButton(*args, **kwargs):
12880 """GetCancelButton(self) -> wxButton"""
12881 return _core_.StdDialogButtonSizer_GetCancelButton(*args, **kwargs)
12882
12883 def GetHelpButton(*args, **kwargs):
12884 """GetHelpButton(self) -> wxButton"""
12885 return _core_.StdDialogButtonSizer_GetHelpButton(*args, **kwargs)
12886
33d6fd3b
RD
12887 AffirmativeButton = property(GetAffirmativeButton,SetAffirmativeButton,doc="See `GetAffirmativeButton` and `SetAffirmativeButton`")
12888 ApplyButton = property(GetApplyButton,doc="See `GetApplyButton`")
12889 CancelButton = property(GetCancelButton,SetCancelButton,doc="See `GetCancelButton` and `SetCancelButton`")
12890 HelpButton = property(GetHelpButton,doc="See `GetHelpButton`")
12891 NegativeButton = property(GetNegativeButton,SetNegativeButton,doc="See `GetNegativeButton` and `SetNegativeButton`")
2131d850 12892_core_.StdDialogButtonSizer_swigregister(StdDialogButtonSizer)
e505d15e 12893
d14a1e28
RD
12894#---------------------------------------------------------------------------
12895
12896class GBPosition(object):
248ed943
RD
12897 """
12898 This class represents the position of an item in a virtual grid of
12899 rows and columns managed by a `wx.GridBagSizer`. wxPython has
12900 typemaps that will automatically convert from a 2-element sequence of
12901 integers to a wx.GBPosition, so you can use the more pythonic
12902 representation of the position nearly transparently in Python code.
12903 """
0085ce49
RD
12904 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12905 __repr__ = _swig_repr
12906 def __init__(self, *args, **kwargs):
248ed943
RD
12907 """
12908 __init__(self, int row=0, int col=0) -> GBPosition
12909
12910 This class represents the position of an item in a virtual grid of
12911 rows and columns managed by a `wx.GridBagSizer`. wxPython has
12912 typemaps that will automatically convert from a 2-element sequence of
12913 integers to a wx.GBPosition, so you can use the more pythonic
12914 representation of the position nearly transparently in Python code.
12915 """
0085ce49
RD
12916 _core_.GBPosition_swiginit(self,_core_.new_GBPosition(*args, **kwargs))
12917 __swig_destroy__ = _core_.delete_GBPosition
12918 __del__ = lambda self : None;
e811c8ce 12919 def GetRow(*args, **kwargs):
a95a7133 12920 """GetRow(self) -> int"""
54f9ee45 12921 return _core_.GBPosition_GetRow(*args, **kwargs)
e811c8ce
RD
12922
12923 def GetCol(*args, **kwargs):
a95a7133 12924 """GetCol(self) -> int"""
54f9ee45 12925 return _core_.GBPosition_GetCol(*args, **kwargs)
e811c8ce
RD
12926
12927 def SetRow(*args, **kwargs):
a95a7133 12928 """SetRow(self, int row)"""
54f9ee45 12929 return _core_.GBPosition_SetRow(*args, **kwargs)
e811c8ce
RD
12930
12931 def SetCol(*args, **kwargs):
a95a7133 12932 """SetCol(self, int col)"""
54f9ee45 12933 return _core_.GBPosition_SetCol(*args, **kwargs)
e811c8ce
RD
12934
12935 def __eq__(*args, **kwargs):
e9d6f3a4
RD
12936 """
12937 __eq__(self, PyObject other) -> bool
12938
12939 Compare GBPosition for equality.
12940 """
54f9ee45 12941 return _core_.GBPosition___eq__(*args, **kwargs)
e811c8ce
RD
12942
12943 def __ne__(*args, **kwargs):
e9d6f3a4
RD
12944 """
12945 __ne__(self, PyObject other) -> bool
12946
12947 Compare GBPosition for inequality.
12948 """
54f9ee45 12949 return _core_.GBPosition___ne__(*args, **kwargs)
e811c8ce
RD
12950
12951 def Set(*args, **kwargs):
a95a7133 12952 """Set(self, int row=0, int col=0)"""
54f9ee45 12953 return _core_.GBPosition_Set(*args, **kwargs)
e811c8ce
RD
12954
12955 def Get(*args, **kwargs):
a95a7133 12956 """Get(self) -> PyObject"""
54f9ee45 12957 return _core_.GBPosition_Get(*args, **kwargs)
e811c8ce 12958
41e2b43e 12959 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
e811c8ce
RD
12960 def __str__(self): return str(self.Get())
12961 def __repr__(self): return 'wx.GBPosition'+str(self.Get())
12962 def __len__(self): return len(self.Get())
12963 def __getitem__(self, index): return self.Get()[index]
d14a1e28
RD
12964 def __setitem__(self, index, val):
12965 if index == 0: self.SetRow(val)
12966 elif index == 1: self.SetCol(val)
12967 else: raise IndexError
e811c8ce 12968 def __nonzero__(self): return self.Get() != (0,0)
74e96f3d
RD
12969 __safe_for_unpickling__ = True
12970 def __reduce__(self): return (wx.GBPosition, self.Get())
d14a1e28
RD
12971
12972 row = property(GetRow, SetRow)
12973 col = property(GetCol, SetCol)
12974
2131d850 12975_core_.GBPosition_swigregister(GBPosition)
d14a1e28
RD
12976
12977class GBSpan(object):
248ed943
RD
12978 """
12979 This class is used to hold the row and column spanning attributes of
12980 items in a `wx.GridBagSizer`. wxPython has typemaps that will
12981 automatically convert from a 2-element sequence of integers to a
12982 wx.GBSpan, so you can use the more pythonic representation of the span
12983 nearly transparently in Python code.
12984
12985 """
0085ce49
RD
12986 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12987 __repr__ = _swig_repr
12988 def __init__(self, *args, **kwargs):
248ed943
RD
12989 """
12990 __init__(self, int rowspan=1, int colspan=1) -> GBSpan
12991
12992 Construct a new wxGBSpan, optionally setting the rowspan and
12993 colspan. The default is (1,1). (Meaning that the item occupies one
12994 cell in each direction.
12995 """
0085ce49
RD
12996 _core_.GBSpan_swiginit(self,_core_.new_GBSpan(*args, **kwargs))
12997 __swig_destroy__ = _core_.delete_GBSpan
12998 __del__ = lambda self : None;
e811c8ce 12999 def GetRowspan(*args, **kwargs):
a95a7133 13000 """GetRowspan(self) -> int"""
54f9ee45 13001 return _core_.GBSpan_GetRowspan(*args, **kwargs)
e811c8ce
RD
13002
13003 def GetColspan(*args, **kwargs):
a95a7133 13004 """GetColspan(self) -> int"""
54f9ee45 13005 return _core_.GBSpan_GetColspan(*args, **kwargs)
e811c8ce
RD
13006
13007 def SetRowspan(*args, **kwargs):
a95a7133 13008 """SetRowspan(self, int rowspan)"""
54f9ee45 13009 return _core_.GBSpan_SetRowspan(*args, **kwargs)
e811c8ce
RD
13010
13011 def SetColspan(*args, **kwargs):
a95a7133 13012 """SetColspan(self, int colspan)"""
54f9ee45 13013 return _core_.GBSpan_SetColspan(*args, **kwargs)
e811c8ce
RD
13014
13015 def __eq__(*args, **kwargs):
e9d6f3a4
RD
13016 """
13017 __eq__(self, PyObject other) -> bool
13018
13019 Compare wxGBSpan for equality.
13020 """
54f9ee45 13021 return _core_.GBSpan___eq__(*args, **kwargs)
e811c8ce
RD
13022
13023 def __ne__(*args, **kwargs):
e9d6f3a4
RD
13024 """
13025 __ne__(self, PyObject other) -> bool
13026
13027 Compare GBSpan for inequality.
13028 """
54f9ee45 13029 return _core_.GBSpan___ne__(*args, **kwargs)
e811c8ce
RD
13030
13031 def Set(*args, **kwargs):
a95a7133 13032 """Set(self, int rowspan=1, int colspan=1)"""
54f9ee45 13033 return _core_.GBSpan_Set(*args, **kwargs)
e811c8ce
RD
13034
13035 def Get(*args, **kwargs):
a95a7133 13036 """Get(self) -> PyObject"""
54f9ee45 13037 return _core_.GBSpan_Get(*args, **kwargs)
e811c8ce 13038
41e2b43e 13039 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
e811c8ce
RD
13040 def __str__(self): return str(self.Get())
13041 def __repr__(self): return 'wx.GBSpan'+str(self.Get())
13042 def __len__(self): return len(self.Get())
13043 def __getitem__(self, index): return self.Get()[index]
d14a1e28
RD
13044 def __setitem__(self, index, val):
13045 if index == 0: self.SetRowspan(val)
13046 elif index == 1: self.SetColspan(val)
13047 else: raise IndexError
e811c8ce 13048 def __nonzero__(self): return self.Get() != (0,0)
74e96f3d
RD
13049 __safe_for_unpickling__ = True
13050 def __reduce__(self): return (wx.GBSpan, self.Get())
d14a1e28
RD
13051
13052 rowspan = property(GetRowspan, SetRowspan)
13053 colspan = property(GetColspan, SetColspan)
13054
2131d850 13055_core_.GBSpan_swigregister(GBSpan)
d14a1e28
RD
13056
13057class GBSizerItem(SizerItem):
248ed943
RD
13058 """
13059 The wx.GBSizerItem class is used to track the additional data about
13060 items in a `wx.GridBagSizer` such as the item's position in the grid
13061 and how many rows or columns it spans.
13062
13063 """
0085ce49
RD
13064 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
13065 __repr__ = _swig_repr
13066 def __init__(self, *args, **kwargs):
248ed943
RD
13067 """
13068 __init__(self) -> GBSizerItem
13069
13070 Constructs an empty wx.GBSizerItem. Either a window, sizer or spacer
13071 size will need to be set, as well as a position and span before this
13072 item can be used in a Sizer.
13073
13074 You will probably never need to create a wx.GBSizerItem directly as they
13075 are created automatically when the sizer's Add method is called.
13076 """
0085ce49
RD
13077 _core_.GBSizerItem_swiginit(self,_core_.new_GBSizerItem(*args, **kwargs))
13078 __swig_destroy__ = _core_.delete_GBSizerItem
13079 __del__ = lambda self : None;
e811c8ce 13080 def GetPos(*args, **kwargs):
248ed943
RD
13081 """
13082 GetPos(self) -> GBPosition
13083
13084 Get the grid position of the item
13085 """
54f9ee45 13086 return _core_.GBSizerItem_GetPos(*args, **kwargs)
e811c8ce
RD
13087
13088 def GetPosTuple(self): return self.GetPos().Get()
13089 def GetSpan(*args, **kwargs):
248ed943
RD
13090 """
13091 GetSpan(self) -> GBSpan
13092
13093 Get the row and column spanning of the item
13094 """
54f9ee45 13095 return _core_.GBSizerItem_GetSpan(*args, **kwargs)
e811c8ce
RD
13096
13097 def GetSpanTuple(self): return self.GetSpan().Get()
13098 def SetPos(*args, **kwargs):
248ed943
RD
13099 """
13100 SetPos(self, GBPosition pos) -> bool
13101
13102 If the item is already a member of a sizer then first ensure that
13103 there is no other item that would intersect with this one at the new
13104 position, then set the new position. Returns True if the change is
13105 successful and after the next Layout() the item will be moved.
13106 """
54f9ee45 13107 return _core_.GBSizerItem_SetPos(*args, **kwargs)
e811c8ce
RD
13108
13109 def SetSpan(*args, **kwargs):
248ed943
RD
13110 """
13111 SetSpan(self, GBSpan span) -> bool
13112
13113 If the item is already a member of a sizer then first ensure that
13114 there is no other item that would intersect with this one with its new
13115 spanning size, then set the new spanning. Returns True if the change
13116 is successful and after the next Layout() the item will be resized.
13117
13118 """
54f9ee45 13119 return _core_.GBSizerItem_SetSpan(*args, **kwargs)
e811c8ce 13120
248ed943 13121 def Intersects(*args, **kwargs):
0df68c9f 13122 """
a95a7133 13123 Intersects(self, GBSizerItem other) -> bool
248ed943
RD
13124
13125 Returns True if this item and the other item instersect.
0df68c9f 13126 """
248ed943
RD
13127 return _core_.GBSizerItem_Intersects(*args, **kwargs)
13128
13129 def IntersectsPos(*args, **kwargs):
13130 """
13131 IntersectsPos(self, GBPosition pos, GBSpan span) -> bool
13132
13133 Returns True if the given pos/span would intersect with this item.
13134 """
13135 return _core_.GBSizerItem_IntersectsPos(*args, **kwargs)
e811c8ce
RD
13136
13137 def GetEndPos(*args, **kwargs):
248ed943
RD
13138 """
13139 GetEndPos(self) -> GBPosition
13140
13141 Get the row and column of the endpoint of this item.
13142 """
54f9ee45 13143 return _core_.GBSizerItem_GetEndPos(*args, **kwargs)
e811c8ce
RD
13144
13145 def GetGBSizer(*args, **kwargs):
248ed943
RD
13146 """
13147 GetGBSizer(self) -> GridBagSizer
13148
13149 Get the sizer this item is a member of.
13150 """
54f9ee45 13151 return _core_.GBSizerItem_GetGBSizer(*args, **kwargs)
e811c8ce
RD
13152
13153 def SetGBSizer(*args, **kwargs):
248ed943
RD
13154 """
13155 SetGBSizer(self, GridBagSizer sizer)
13156
13157 Set the sizer this item is a member of.
13158 """
54f9ee45 13159 return _core_.GBSizerItem_SetGBSizer(*args, **kwargs)
e811c8ce 13160
97ab0f6a
RD
13161 EndPos = property(GetEndPos,doc="See `GetEndPos`")
13162 GBSizer = property(GetGBSizer,SetGBSizer,doc="See `GetGBSizer` and `SetGBSizer`")
13163 Pos = property(GetPos,SetPos,doc="See `GetPos` and `SetPos`")
13164 Span = property(GetSpan,SetSpan,doc="See `GetSpan` and `SetSpan`")
2131d850 13165_core_.GBSizerItem_swigregister(GBSizerItem)
d14a1e28
RD
13166DefaultSpan = cvar.DefaultSpan
13167
13168def GBSizerItemWindow(*args, **kwargs):
0df68c9f
RD
13169 """
13170 GBSizerItemWindow(Window window, GBPosition pos, GBSpan span, int flag,
248ed943
RD
13171 int border, PyObject userData=None) -> GBSizerItem
13172
13173 Construct a `wx.GBSizerItem` for a window.
0df68c9f 13174 """
54f9ee45 13175 val = _core_.new_GBSizerItemWindow(*args, **kwargs)
d14a1e28
RD
13176 return val
13177
13178def GBSizerItemSizer(*args, **kwargs):
0df68c9f
RD
13179 """
13180 GBSizerItemSizer(Sizer sizer, GBPosition pos, GBSpan span, int flag,
248ed943
RD
13181 int border, PyObject userData=None) -> GBSizerItem
13182
13183 Construct a `wx.GBSizerItem` for a sizer
0df68c9f 13184 """
54f9ee45 13185 val = _core_.new_GBSizerItemSizer(*args, **kwargs)
d14a1e28
RD
13186 return val
13187
13188def GBSizerItemSpacer(*args, **kwargs):
0df68c9f
RD
13189 """
13190 GBSizerItemSpacer(int width, int height, GBPosition pos, GBSpan span,
248ed943
RD
13191 int flag, int border, PyObject userData=None) -> GBSizerItem
13192
13193 Construct a `wx.GBSizerItem` for a spacer.
0df68c9f 13194 """
54f9ee45 13195 val = _core_.new_GBSizerItemSpacer(*args, **kwargs)
d14a1e28
RD
13196 return val
13197
13198class GridBagSizer(FlexGridSizer):
248ed943
RD
13199 """
13200 A `wx.Sizer` that can lay out items in a virtual grid like a
13201 `wx.FlexGridSizer` but in this case explicit positioning of the items
13202 is allowed using `wx.GBPosition`, and items can optionally span more
13203 than one row and/or column using `wx.GBSpan`. The total size of the
13204 virtual grid is determined by the largest row and column that items are
13205 positioned at, adjusted for spanning.
13206
13207 """
0085ce49
RD
13208 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
13209 __repr__ = _swig_repr
13210 def __init__(self, *args, **kwargs):
248ed943
RD
13211 """
13212 __init__(self, int vgap=0, int hgap=0) -> GridBagSizer
13213
13214 Constructor, with optional parameters to specify the gap between the
13215 rows and columns.
13216 """
0085ce49 13217 _core_.GridBagSizer_swiginit(self,_core_.new_GridBagSizer(*args, **kwargs))
1823fbb4
RD
13218 self._setOORInfo(self)
13219
e811c8ce 13220 def Add(*args, **kwargs):
0df68c9f 13221 """
248ed943 13222 Add(self, item, GBPosition pos, GBSpan span=DefaultSpan, int flag=0,
d3b6e4ff 13223 int border=0, userData=None) -> wx.GBSizerItem
248ed943
RD
13224
13225 Adds an item to the sizer at the grid cell *pos*, optionally spanning
13226 more than one row or column as specified with *span*. The remaining
13227 args behave similarly to `wx.Sizer.Add`.
13228
13229 Returns True if the item was successfully placed at the given cell
13230 position, False if something was already there.
13231
0df68c9f 13232 """
54f9ee45 13233 return _core_.GridBagSizer_Add(*args, **kwargs)
e811c8ce
RD
13234
13235 def AddItem(*args, **kwargs):
248ed943 13236 """
d3b6e4ff 13237 Add(self, GBSizerItem item) -> wx.GBSizerItem
248ed943
RD
13238
13239 Add an item to the sizer using a `wx.GBSizerItem`. Returns True if
13240 the item was successfully placed at its given cell position, False if
13241 something was already there.
13242 """
54f9ee45 13243 return _core_.GridBagSizer_AddItem(*args, **kwargs)
e811c8ce 13244
84f85550
RD
13245 def GetCellSize(*args, **kwargs):
13246 """
13247 GetCellSize(self, int row, int col) -> Size
13248
13249 Get the size of the specified cell, including hgap and
13250 vgap. Only valid after a Layout.
13251 """
13252 return _core_.GridBagSizer_GetCellSize(*args, **kwargs)
13253
e811c8ce 13254 def GetEmptyCellSize(*args, **kwargs):
248ed943
RD
13255 """
13256 GetEmptyCellSize(self) -> Size
13257
13258 Get the size used for cells in the grid with no item.
13259 """
54f9ee45 13260 return _core_.GridBagSizer_GetEmptyCellSize(*args, **kwargs)
e811c8ce
RD
13261
13262 def SetEmptyCellSize(*args, **kwargs):
248ed943
RD
13263 """
13264 SetEmptyCellSize(self, Size sz)
13265
13266 Set the size used for cells in the grid with no item.
13267 """
54f9ee45 13268 return _core_.GridBagSizer_SetEmptyCellSize(*args, **kwargs)
e811c8ce
RD
13269
13270 def GetItemPosition(*args):
0df68c9f 13271 """
248ed943
RD
13272 GetItemPosition(self, item) -> GBPosition
13273
13274 Get the grid position of the specified *item* where *item* is either a
13275 window or subsizer that is a member of this sizer, or a zero-based
13276 index of an item.
0df68c9f 13277 """
54f9ee45 13278 return _core_.GridBagSizer_GetItemPosition(*args)
e811c8ce
RD
13279
13280 def SetItemPosition(*args):
0df68c9f 13281 """
248ed943
RD
13282 SetItemPosition(self, item, GBPosition pos) -> bool
13283
13284 Set the grid position of the specified *item* where *item* is either a
13285 window or subsizer that is a member of this sizer, or a zero-based
13286 index of an item. Returns True on success. If the move is not
13287 allowed (because an item is already there) then False is returned.
13288
0df68c9f 13289 """
54f9ee45 13290 return _core_.GridBagSizer_SetItemPosition(*args)
e811c8ce
RD
13291
13292 def GetItemSpan(*args):
0df68c9f 13293 """
248ed943
RD
13294 GetItemSpan(self, item) -> GBSpan
13295
13296 Get the row/col spanning of the specified *item* where *item* is
13297 either a window or subsizer that is a member of this sizer, or a
13298 zero-based index of an item.
0df68c9f 13299 """
54f9ee45 13300 return _core_.GridBagSizer_GetItemSpan(*args)
e811c8ce
RD
13301
13302 def SetItemSpan(*args):
0df68c9f 13303 """
248ed943
RD
13304 SetItemSpan(self, item, GBSpan span) -> bool
13305
13306 Set the row/col spanning of the specified *item* where *item* is
13307 either a window or subsizer that is a member of this sizer, or a
13308 zero-based index of an item. Returns True on success. If the move is
13309 not allowed (because an item is already there) then False is returned.
0df68c9f 13310 """
54f9ee45 13311 return _core_.GridBagSizer_SetItemSpan(*args)
e811c8ce
RD
13312
13313 def FindItem(*args):
0df68c9f 13314 """
248ed943
RD
13315 FindItem(self, item) -> GBSizerItem
13316
13317 Find the sizer item for the given window or subsizer, returns None if
13318 not found. (non-recursive)
0df68c9f 13319 """
54f9ee45 13320 return _core_.GridBagSizer_FindItem(*args)
e811c8ce
RD
13321
13322 def FindItemAtPosition(*args, **kwargs):
248ed943
RD
13323 """
13324 FindItemAtPosition(self, GBPosition pos) -> GBSizerItem
13325
13326 Return the sizer item for the given grid cell, or None if there is no
13327 item at that position. (non-recursive)
13328 """
54f9ee45 13329 return _core_.GridBagSizer_FindItemAtPosition(*args, **kwargs)
e811c8ce
RD
13330
13331 def FindItemAtPoint(*args, **kwargs):
248ed943
RD
13332 """
13333 FindItemAtPoint(self, Point pt) -> GBSizerItem
13334
13335 Return the sizer item located at the point given in *pt*, or None if
13336 there is no item at that point. The (x,y) coordinates in pt correspond
13337 to the client coordinates of the window using the sizer for
13338 layout. (non-recursive)
13339 """
54f9ee45 13340 return _core_.GridBagSizer_FindItemAtPoint(*args, **kwargs)
e811c8ce 13341
248ed943
RD
13342 def CheckForIntersection(*args, **kwargs):
13343 """
13344 CheckForIntersection(self, GBSizerItem item, GBSizerItem excludeItem=None) -> bool
e811c8ce 13345
248ed943
RD
13346 Look at all items and see if any intersect (or would overlap) the
13347 given *item*. Returns True if so, False if there would be no overlap.
13348 If an *excludeItem* is given then it will not be checked for
13349 intersection, for example it may be the item we are checking the
13350 position of.
e811c8ce 13351
248ed943
RD
13352 """
13353 return _core_.GridBagSizer_CheckForIntersection(*args, **kwargs)
e811c8ce 13354
248ed943 13355 def CheckForIntersectionPos(*args, **kwargs):
0df68c9f 13356 """
248ed943
RD
13357 CheckForIntersectionPos(self, GBPosition pos, GBSpan span, GBSizerItem excludeItem=None) -> bool
13358
13359 Look at all items and see if any intersect (or would overlap) the
13360 given position and span. Returns True if so, False if there would be
13361 no overlap. If an *excludeItem* is given then it will not be checked
13362 for intersection, for example it may be the item we are checking the
13363 position of.
0df68c9f 13364 """
248ed943 13365 return _core_.GridBagSizer_CheckForIntersectionPos(*args, **kwargs)
e811c8ce 13366
2131d850 13367_core_.GridBagSizer_swigregister(GridBagSizer)
d14a1e28
RD
13368
13369#---------------------------------------------------------------------------
13370
54f9ee45
RD
13371Left = _core_.Left
13372Top = _core_.Top
13373Right = _core_.Right
13374Bottom = _core_.Bottom
13375Width = _core_.Width
13376Height = _core_.Height
13377Centre = _core_.Centre
13378Center = _core_.Center
13379CentreX = _core_.CentreX
13380CentreY = _core_.CentreY
13381Unconstrained = _core_.Unconstrained
13382AsIs = _core_.AsIs
13383PercentOf = _core_.PercentOf
13384Above = _core_.Above
13385Below = _core_.Below
13386LeftOf = _core_.LeftOf
13387RightOf = _core_.RightOf
13388SameAs = _core_.SameAs
13389Absolute = _core_.Absolute
d14a1e28 13390class IndividualLayoutConstraint(Object):
15afbcd0 13391 """
41e2b43e
RD
13392 Objects of this class are stored in the `wx.LayoutConstraints` class as
13393 one of eight possible constraints that a window can be involved in.
13394 You will never need to create an instance of
13395 wx.IndividualLayoutConstraint, rather you should create a
13396 `wx.LayoutConstraints` instance and use the individual contstraints
15afbcd0 13397 that it contains.
15afbcd0 13398 """
0085ce49
RD
13399 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
13400 def __init__(self): raise AttributeError, "No constructor defined"
13401 __repr__ = _swig_repr
e811c8ce 13402 def Set(*args, **kwargs):
41e2b43e
RD
13403 """
13404 Set(self, int rel, Window otherW, int otherE, int val=0, int marg=wxLAYOUT_DEFAULT_MARGIN)
13405
13406 Sets the properties of the constraint. Normally called by one of the
13407 convenience functions such as Above, RightOf, SameAs.
13408 """
54f9ee45 13409 return _core_.IndividualLayoutConstraint_Set(*args, **kwargs)
e811c8ce
RD
13410
13411 def LeftOf(*args, **kwargs):
15afbcd0 13412 """
a95a7133 13413 LeftOf(self, Window sibling, int marg=0)
15afbcd0 13414
41e2b43e
RD
13415 Constrains this edge to be to the left of the given window, with an
13416 optional margin. Implicitly, this is relative to the left edge of the
13417 other window.
15afbcd0 13418 """
54f9ee45 13419 return _core_.IndividualLayoutConstraint_LeftOf(*args, **kwargs)
e811c8ce
RD
13420
13421 def RightOf(*args, **kwargs):
15afbcd0 13422 """
a95a7133 13423 RightOf(self, Window sibling, int marg=0)
15afbcd0 13424
41e2b43e
RD
13425 Constrains this edge to be to the right of the given window, with an
13426 optional margin. Implicitly, this is relative to the right edge of the
13427 other window.
15afbcd0 13428 """
54f9ee45 13429 return _core_.IndividualLayoutConstraint_RightOf(*args, **kwargs)
e811c8ce
RD
13430
13431 def Above(*args, **kwargs):
15afbcd0 13432 """
a95a7133 13433 Above(self, Window sibling, int marg=0)
15afbcd0 13434
41e2b43e
RD
13435 Constrains this edge to be above the given window, with an optional
13436 margin. Implicitly, this is relative to the top edge of the other
13437 window.
15afbcd0 13438 """
54f9ee45 13439 return _core_.IndividualLayoutConstraint_Above(*args, **kwargs)
e811c8ce
RD
13440
13441 def Below(*args, **kwargs):
15afbcd0 13442 """
a95a7133 13443 Below(self, Window sibling, int marg=0)
15afbcd0 13444
41e2b43e
RD
13445 Constrains this edge to be below the given window, with an optional
13446 margin. Implicitly, this is relative to the bottom edge of the other
13447 window.
15afbcd0 13448 """
54f9ee45 13449 return _core_.IndividualLayoutConstraint_Below(*args, **kwargs)
e811c8ce
RD
13450
13451 def SameAs(*args, **kwargs):
15afbcd0 13452 """
a95a7133 13453 SameAs(self, Window otherW, int edge, int marg=0)
15afbcd0 13454
41e2b43e
RD
13455 Constrains this edge or dimension to be to the same as the edge of the
13456 given window, with an optional margin.
15afbcd0 13457 """
54f9ee45 13458 return _core_.IndividualLayoutConstraint_SameAs(*args, **kwargs)
e811c8ce
RD
13459
13460 def PercentOf(*args, **kwargs):
15afbcd0 13461 """
a95a7133 13462 PercentOf(self, Window otherW, int wh, int per)
15afbcd0 13463
41e2b43e
RD
13464 Constrains this edge or dimension to be to a percentage of the given
13465 window, with an optional margin.
15afbcd0 13466 """
54f9ee45 13467 return _core_.IndividualLayoutConstraint_PercentOf(*args, **kwargs)
e811c8ce
RD
13468
13469 def Absolute(*args, **kwargs):
15afbcd0 13470 """
a95a7133 13471 Absolute(self, int val)
15afbcd0 13472
41e2b43e 13473 Constrains this edge or dimension to be the given absolute value.
15afbcd0 13474 """
54f9ee45 13475 return _core_.IndividualLayoutConstraint_Absolute(*args, **kwargs)
e811c8ce
RD
13476
13477 def Unconstrained(*args, **kwargs):
15afbcd0 13478 """
a95a7133 13479 Unconstrained(self)
15afbcd0 13480
41e2b43e
RD
13481 Sets this edge or dimension to be unconstrained, that is, dependent on
13482 other edges and dimensions from which this value can be deduced.
15afbcd0 13483 """
54f9ee45 13484 return _core_.IndividualLayoutConstraint_Unconstrained(*args, **kwargs)
e811c8ce
RD
13485
13486 def AsIs(*args, **kwargs):
15afbcd0 13487 """
a95a7133 13488 AsIs(self)
15afbcd0 13489
41e2b43e
RD
13490 Sets this edge or constraint to be whatever the window's value is at
13491 the moment. If either of the width and height constraints are *as is*,
13492 the window will not be resized, but moved instead. This is important
13493 when considering panel items which are intended to have a default
13494 size, such as a button, which may take its size from the size of the
13495 button label.
15afbcd0 13496 """
54f9ee45 13497 return _core_.IndividualLayoutConstraint_AsIs(*args, **kwargs)
e811c8ce
RD
13498
13499 def GetOtherWindow(*args, **kwargs):
a95a7133 13500 """GetOtherWindow(self) -> Window"""
54f9ee45 13501 return _core_.IndividualLayoutConstraint_GetOtherWindow(*args, **kwargs)
e811c8ce
RD
13502
13503 def GetMyEdge(*args, **kwargs):
a95a7133 13504 """GetMyEdge(self) -> int"""
54f9ee45 13505 return _core_.IndividualLayoutConstraint_GetMyEdge(*args, **kwargs)
e811c8ce
RD
13506
13507 def SetEdge(*args, **kwargs):
a95a7133 13508 """SetEdge(self, int which)"""
54f9ee45 13509 return _core_.IndividualLayoutConstraint_SetEdge(*args, **kwargs)
e811c8ce
RD
13510
13511 def SetValue(*args, **kwargs):
a95a7133 13512 """SetValue(self, int v)"""
54f9ee45 13513 return _core_.IndividualLayoutConstraint_SetValue(*args, **kwargs)
e811c8ce
RD
13514
13515 def GetMargin(*args, **kwargs):
a95a7133 13516 """GetMargin(self) -> int"""
54f9ee45 13517 return _core_.IndividualLayoutConstraint_GetMargin(*args, **kwargs)
e811c8ce
RD
13518
13519 def SetMargin(*args, **kwargs):
a95a7133 13520 """SetMargin(self, int m)"""
54f9ee45 13521 return _core_.IndividualLayoutConstraint_SetMargin(*args, **kwargs)
e811c8ce
RD
13522
13523 def GetValue(*args, **kwargs):
a95a7133 13524 """GetValue(self) -> int"""
54f9ee45 13525 return _core_.IndividualLayoutConstraint_GetValue(*args, **kwargs)
e811c8ce
RD
13526
13527 def GetPercent(*args, **kwargs):
a95a7133 13528 """GetPercent(self) -> int"""
54f9ee45 13529 return _core_.IndividualLayoutConstraint_GetPercent(*args, **kwargs)
e811c8ce
RD
13530
13531 def GetOtherEdge(*args, **kwargs):
a95a7133 13532 """GetOtherEdge(self) -> int"""
54f9ee45 13533 return _core_.IndividualLayoutConstraint_GetOtherEdge(*args, **kwargs)
e811c8ce
RD
13534
13535 def GetDone(*args, **kwargs):
a95a7133 13536 """GetDone(self) -> bool"""
54f9ee45 13537 return _core_.IndividualLayoutConstraint_GetDone(*args, **kwargs)
e811c8ce
RD
13538
13539 def SetDone(*args, **kwargs):
a95a7133 13540 """SetDone(self, bool d)"""
54f9ee45 13541 return _core_.IndividualLayoutConstraint_SetDone(*args, **kwargs)
e811c8ce
RD
13542
13543 def GetRelationship(*args, **kwargs):
a95a7133 13544 """GetRelationship(self) -> int"""
54f9ee45 13545 return _core_.IndividualLayoutConstraint_GetRelationship(*args, **kwargs)
e811c8ce
RD
13546
13547 def SetRelationship(*args, **kwargs):
a95a7133 13548 """SetRelationship(self, int r)"""
54f9ee45 13549 return _core_.IndividualLayoutConstraint_SetRelationship(*args, **kwargs)
e811c8ce
RD
13550
13551 def ResetIfWin(*args, **kwargs):
15afbcd0 13552 """
a95a7133 13553 ResetIfWin(self, Window otherW) -> bool
15afbcd0
RD
13554
13555 Reset constraint if it mentions otherWin
13556 """
54f9ee45 13557 return _core_.IndividualLayoutConstraint_ResetIfWin(*args, **kwargs)
e811c8ce
RD
13558
13559 def SatisfyConstraint(*args, **kwargs):
15afbcd0 13560 """
a95a7133 13561 SatisfyConstraint(self, LayoutConstraints constraints, Window win) -> bool
15afbcd0
RD
13562
13563 Try to satisfy constraint
13564 """
54f9ee45 13565 return _core_.IndividualLayoutConstraint_SatisfyConstraint(*args, **kwargs)
e811c8ce
RD
13566
13567 def GetEdge(*args, **kwargs):
15afbcd0 13568 """
a95a7133 13569 GetEdge(self, int which, Window thisWin, Window other) -> int
15afbcd0
RD
13570
13571 Get the value of this edge or dimension, or if this
13572 is not determinable, -1.
13573 """
54f9ee45 13574 return _core_.IndividualLayoutConstraint_GetEdge(*args, **kwargs)
e811c8ce 13575
97ab0f6a
RD
13576 Done = property(GetDone,SetDone,doc="See `GetDone` and `SetDone`")
13577 Margin = property(GetMargin,SetMargin,doc="See `GetMargin` and `SetMargin`")
13578 MyEdge = property(GetMyEdge,doc="See `GetMyEdge`")
13579 OtherEdge = property(GetOtherEdge,doc="See `GetOtherEdge`")
13580 OtherWindow = property(GetOtherWindow,doc="See `GetOtherWindow`")
13581 Percent = property(GetPercent,doc="See `GetPercent`")
13582 Relationship = property(GetRelationship,SetRelationship,doc="See `GetRelationship` and `SetRelationship`")
13583 Value = property(GetValue,SetValue,doc="See `GetValue` and `SetValue`")
2131d850 13584_core_.IndividualLayoutConstraint_swigregister(IndividualLayoutConstraint)
d14a1e28
RD
13585
13586class LayoutConstraints(Object):
15afbcd0 13587 """
41e2b43e
RD
13588 **Note:** constraints are now deprecated and you should use sizers
13589 instead.
15afbcd0 13590
41e2b43e
RD
13591 Objects of this class can be associated with a window to define its
13592 layout constraints, with respect to siblings or its parent.
15afbcd0
RD
13593
13594 The class consists of the following eight constraints of class
13595 wx.IndividualLayoutConstraint, some or all of which should be accessed
13596 directly to set the appropriate constraints.
13597
13598 * left: represents the left hand edge of the window
13599 * right: represents the right hand edge of the window
13600 * top: represents the top edge of the window
13601 * bottom: represents the bottom edge of the window
13602 * width: represents the width of the window
13603 * height: represents the height of the window
13604 * centreX: represents the horizontal centre point of the window
13605 * centreY: represents the vertical centre point of the window
13606
41e2b43e
RD
13607 Most constraints are initially set to have the relationship
13608 wxUnconstrained, which means that their values should be calculated by
13609 looking at known constraints. The exceptions are width and height,
13610 which are set to wxAsIs to ensure that if the user does not specify a
13611 constraint, the existing width and height will be used, to be
13612 compatible with panel items which often have take a default size. If
13613 the constraint is ``wx.AsIs``, the dimension will not be changed.
13614
13615 :see: `wx.IndividualLayoutConstraint`, `wx.Window.SetConstraints`
15afbcd0
RD
13616
13617 """
0085ce49
RD
13618 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
13619 __repr__ = _swig_repr
54f9ee45
RD
13620 left = property(_core_.LayoutConstraints_left_get)
13621 top = property(_core_.LayoutConstraints_top_get)
13622 right = property(_core_.LayoutConstraints_right_get)
13623 bottom = property(_core_.LayoutConstraints_bottom_get)
13624 width = property(_core_.LayoutConstraints_width_get)
13625 height = property(_core_.LayoutConstraints_height_get)
13626 centreX = property(_core_.LayoutConstraints_centreX_get)
13627 centreY = property(_core_.LayoutConstraints_centreY_get)
0085ce49 13628 def __init__(self, *args, **kwargs):
a95a7133 13629 """__init__(self) -> LayoutConstraints"""
0085ce49
RD
13630 _core_.LayoutConstraints_swiginit(self,_core_.new_LayoutConstraints(*args, **kwargs))
13631 __swig_destroy__ = _core_.delete_LayoutConstraints
13632 __del__ = lambda self : None;
e811c8ce 13633 def SatisfyConstraints(*args, **kwargs):
6c3b4aae 13634 """SatisfyConstraints(Window win) -> (areSatisfied, noChanges)"""
54f9ee45 13635 return _core_.LayoutConstraints_SatisfyConstraints(*args, **kwargs)
e811c8ce
RD
13636
13637 def AreSatisfied(*args, **kwargs):
a95a7133 13638 """AreSatisfied(self) -> bool"""
54f9ee45 13639 return _core_.LayoutConstraints_AreSatisfied(*args, **kwargs)
e811c8ce 13640
2131d850 13641_core_.LayoutConstraints_swigregister(LayoutConstraints)
d14a1e28
RD
13642
13643#----------------------------------------------------------------------------
13644
322913ce 13645# Use Python's bool constants if available, make some if not
d14a1e28
RD
13646try:
13647 True
13648except NameError:
322913ce
RD
13649 __builtins__.True = 1==1
13650 __builtins__.False = 1==0
4f89f6a3
RD
13651 def bool(value): return not not value
13652 __builtins__.bool = bool
d14a1e28 13653
d14a1e28
RD
13654
13655
13656# workarounds for bad wxRTTI names
13657__wxPyPtrTypeMap['wxGauge95'] = 'wxGauge'
13658__wxPyPtrTypeMap['wxSlider95'] = 'wxSlider'
13659__wxPyPtrTypeMap['wxStatusBar95'] = 'wxStatusBar'
13660
13661
13662#----------------------------------------------------------------------------
13663# Load version numbers from __version__... Ensure that major and minor
7bc1e663 13664# versions are the same for both wxPython and wxWidgets.
d14a1e28
RD
13665
13666from __version__ import *
13667__version__ = VERSION_STRING
13668
7bc1e663
RD
13669assert MAJOR_VERSION == _core_.MAJOR_VERSION, "wxPython/wxWidgets version mismatch"
13670assert MINOR_VERSION == _core_.MINOR_VERSION, "wxPython/wxWidgets version mismatch"
54f9ee45 13671if RELEASE_VERSION != _core_.RELEASE_VERSION:
d14a1e28 13672 import warnings
7bc1e663 13673 warnings.warn("wxPython/wxWidgets release number mismatch")
d14a1e28 13674
f9bf356b
RD
13675
13676def version():
13677 """Returns a string containing version and port info"""
13678 ctype = wx.USE_UNICODE and 'unicode' or 'ansi'
13679 if wx.Platform == '__WXMSW__':
13680 port = 'msw'
13681 elif wx.Platform == '__WXMAC__':
13682 port = 'mac'
13683 elif wx.Platform == '__WXGTK__':
13684 port = 'gtk'
13685 if 'gtk2' in wx.PlatformInfo:
13686 port = 'gtk2'
13687 else:
13688 port = '?'
13689
13690 return "%s (%s-%s)" % (wx.VERSION_STRING, port, ctype)
13691
13692
d14a1e28
RD
13693#----------------------------------------------------------------------------
13694
70b7a5fe
RD
13695# Set wxPython's default string<-->unicode conversion encoding from
13696# the locale, but only if Python's default hasn't been changed. (We
13697# assume that if the user has customized it already then that is the
13698# encoding we need to use as well.)
13699#
13700# The encoding selected here is used when string or unicode objects
13701# need to be converted in order to pass them to wxWidgets. Please be
13702# aware that the default encoding within the same locale may be
13703# slightly different on different platforms. For example, please see
e505d15e
RD
13704# http://www.alanwood.net/demos/charsetdiffs.html for differences
13705# between the common latin/roman encodings.
396fb509
RD
13706
13707default = _sys.getdefaultencoding()
13708if default == 'ascii':
13709 import locale
13710 import codecs
13711 try:
474e2ff2
RD
13712 if hasattr(locale, 'getpreferredencoding'):
13713 default = locale.getpreferredencoding()
13714 else:
13715 default = locale.getdefaultlocale()[1]
396fb509 13716 codecs.lookup(default)
70b7a5fe 13717 except (ValueError, LookupError, TypeError):
396fb509
RD
13718 default = _sys.getdefaultencoding()
13719 del locale
13720 del codecs
5cbf236d
RD
13721if default:
13722 wx.SetDefaultPyEncoding(default)
13723del default
5cbf236d
RD
13724
13725#----------------------------------------------------------------------------
13726
d14a1e28
RD
13727class PyDeadObjectError(AttributeError):
13728 pass
13729
d14a1e28
RD
13730class _wxPyDeadObject(object):
13731 """
13732 Instances of wx objects that are OOR capable will have their __class__
13733 changed to this class when the C++ object is deleted. This should help
13734 prevent crashes due to referencing a bogus C++ pointer.
13735 """
13736 reprStr = "wxPython wrapper for DELETED %s object! (The C++ object no longer exists.)"
13737 attrStr = "The C++ part of the %s object has been deleted, attribute access no longer allowed."
13738
3a04f143 13739 def __repr__(self):
d14a1e28
RD
13740 if not hasattr(self, "_name"):
13741 self._name = "[unknown]"
13742 return self.reprStr % self._name
13743
3a04f143 13744 def __getattr__(self, *args):
d14a1e28
RD
13745 if not hasattr(self, "_name"):
13746 self._name = "[unknown]"
3a04f143
RD
13747 raise PyDeadObjectError(self.attrStr % self._name)
13748
13749 def __nonzero__(self):
13750 return 0
13751
13752
13753
13754class PyUnbornObjectError(AttributeError):
13755 pass
13756
13757class _wxPyUnbornObject(object):
13758 """
54f9ee45 13759 Some stock objects are created when the wx._core module is
3a04f143
RD
13760 imported, but their C++ instance is not created until the wx.App
13761 object is created and initialized. These object instances will
13762 temporarily have their __class__ changed to this class so an
13763 exception will be raised if they are used before the C++ instance
13764 is ready.
13765 """
13766
13767 reprStr = "wxPython wrapper for UNBORN object! (The C++ object is not initialized yet.)"
13768 attrStr = "The C++ part of this object has not been initialized, attribute access not allowed."
13769
13770 def __repr__(self):
13771 #if not hasattr(self, "_name"):
13772 # self._name = "[unknown]"
13773 return self.reprStr #% self._name
13774
13775 def __getattr__(self, *args):
13776 #if not hasattr(self, "_name"):
13777 # self._name = "[unknown]"
13778 raise PyUnbornObjectError(self.attrStr) # % self._name )
d14a1e28
RD
13779
13780 def __nonzero__(self):
13781 return 0
13782
13783
13784#----------------------------------------------------------------------------
d14a1e28
RD
13785
13786def CallAfter(callable, *args, **kw):
13787 """
13788 Call the specified function after the current and pending event
13789 handlers have been completed. This is also good for making GUI
61863841
RD
13790 method calls from non-GUI threads. Any extra positional or
13791 keyword args are passed on to the callable when it is called.
13792
846c181b 13793 :see: `wx.CallLater`
d14a1e28
RD
13794 """
13795 app = wx.GetApp()
dfbb5885 13796 assert app is not None, 'No wx.App created yet'
d14a1e28 13797
148275d3
RD
13798 if not hasattr(app, "_CallAfterId"):
13799 app._CallAfterId = wx.NewEventType()
13800 app.Connect(-1, -1, app._CallAfterId,
13801 lambda event: event.callable(*event.args, **event.kw) )
d14a1e28 13802 evt = wx.PyEvent()
148275d3 13803 evt.SetEventType(app._CallAfterId)
d14a1e28
RD
13804 evt.callable = callable
13805 evt.args = args
13806 evt.kw = kw
13807 wx.PostEvent(app, evt)
13808
d14a1e28
RD
13809#----------------------------------------------------------------------------
13810
13811
846c181b 13812class CallLater:
d14a1e28 13813 """
8ac8dba0 13814 A convenience class for `wx.Timer`, that calls the given callable
d14a1e28
RD
13815 object once after the given amount of milliseconds, passing any
13816 positional or keyword args. The return value of the callable is
61863841 13817 availbale after it has been run with the `GetResult` method.
d14a1e28
RD
13818
13819 If you don't need to get the return value or restart the timer
13820 then there is no need to hold a reference to this object. It will
13821 hold a reference to itself while the timer is running (the timer
13822 has a reference to self.Notify) but the cycle will be broken when
846c181b 13823 the timer completes, automatically cleaning up the wx.CallLater
d14a1e28 13824 object.
61863841
RD
13825
13826 :see: `wx.CallAfter`
d14a1e28
RD
13827 """
13828 def __init__(self, millis, callable, *args, **kwargs):
13829 self.millis = millis
13830 self.callable = callable
13831 self.SetArgs(*args, **kwargs)
13832 self.runCount = 0
4276dc52 13833 self.running = False
d14a1e28
RD
13834 self.hasRun = False
13835 self.result = None
13836 self.timer = None
13837 self.Start()
13838
13839 def __del__(self):
13840 self.Stop()
13841
13842
13843 def Start(self, millis=None, *args, **kwargs):
13844 """
13845 (Re)start the timer
13846 """
13847 self.hasRun = False
13848 if millis is not None:
13849 self.millis = millis
13850 if args or kwargs:
13851 self.SetArgs(*args, **kwargs)
13852 self.Stop()
13853 self.timer = wx.PyTimer(self.Notify)
13854 self.timer.Start(self.millis, wx.TIMER_ONE_SHOT)
4276dc52 13855 self.running = True
d14a1e28
RD
13856 Restart = Start
13857
13858
13859 def Stop(self):
13860 """
13861 Stop and destroy the timer.
13862 """
13863 if self.timer is not None:
13864 self.timer.Stop()
13865 self.timer = None
13866
13867
13868 def GetInterval(self):
13869 if self.timer is not None:
13870 return self.timer.GetInterval()
13871 else:
13872 return 0
13873
13874
13875 def IsRunning(self):
13876 return self.timer is not None and self.timer.IsRunning()
13877
13878
13879 def SetArgs(self, *args, **kwargs):
13880 """
13881 (Re)set the args passed to the callable object. This is
13882 useful in conjunction with Restart if you want to schedule a
13883 new call to the same callable object but with different
13884 parameters.
13885 """
13886 self.args = args
13887 self.kwargs = kwargs
13888
13889
13890 def HasRun(self):
13891 return self.hasRun
13892
13893 def GetResult(self):
13894 return self.result
13895
13896 def Notify(self):
13897 """
13898 The timer has expired so call the callable.
13899 """
13900 if self.callable and getattr(self.callable, 'im_self', True):
13901 self.runCount += 1
4276dc52 13902 self.running = False
d14a1e28
RD
13903 self.result = self.callable(*self.args, **self.kwargs)
13904 self.hasRun = True
4276dc52
RD
13905 if not self.running:
13906 # if it wasn't restarted, then cleanup
13907 wx.CallAfter(self.Stop)
d14a1e28 13908
97ab0f6a
RD
13909 Interval = property(GetInterval)
13910 Result = property(GetResult)
d14a1e28 13911
a95a7133 13912
846c181b 13913class FutureCall(CallLater):
b39fe951 13914 """A compatibility alias for `CallLater`."""
846c181b 13915
a95a7133
RD
13916#----------------------------------------------------------------------------
13917# Control which items in this module should be documented by epydoc.
13918# We allow only classes and functions, which will help reduce the size
13919# of the docs by filtering out the zillions of constants, EVT objects,
13920# and etc that don't make much sense by themselves, but are instead
13921# documented (or will be) as part of the classes/functions/methods
13922# where they should be used.
13923
66c033b4
RD
13924class __DocFilter:
13925 """
13926 A filter for epydoc that only allows non-Ptr classes and
34e0a3bb 13927 functions, in order to reduce the clutter in the API docs.
66c033b4
RD
13928 """
13929 def __init__(self, globals):
13930 self._globals = globals
13931
13932 def __call__(self, name):
13933 import types
13934 obj = self._globals.get(name, None)
34e0a3bb
RD
13935
13936 # only document classes and function
66c033b4
RD
13937 if type(obj) not in [type, types.ClassType, types.FunctionType, types.BuiltinFunctionType]:
13938 return False
34e0a3bb
RD
13939
13940 # skip other things that are private or will be documented as part of somethign else
0085ce49 13941 if name.startswith('_') or name.startswith('EVT') or name.endswith('_swigregister') or name.endswith('Ptr') :
66c033b4 13942 return False
34e0a3bb
RD
13943
13944 # skip functions that are duplicates of static functions in a class
13945 if name.find('_') != -1:
13946 cls = self._globals.get(name.split('_')[0], None)
13947 methname = name.split('_')[1]
13948 if hasattr(cls, methname) and type(getattr(cls, methname)) is types.FunctionType:
13949 return False
13950
66c033b4 13951 return True
a95a7133 13952
d14a1e28
RD
13953#----------------------------------------------------------------------------
13954#----------------------------------------------------------------------------
13955
13956# Import other modules in this package that should show up in the
13957# "core" wx namespace
54f9ee45
RD
13958from _gdi import *
13959from _windows import *
13960from _controls import *
13961from _misc import *
d14a1e28
RD
13962
13963#----------------------------------------------------------------------------
13964#----------------------------------------------------------------------------
13965
13966
32fe5131 13967