]> git.saurik.com Git - wxWidgets.git/blame - wxPython/src/gtk/_core.py
reSWIGged
[wxWidgets.git] / wxPython / src / gtk / _core.py
CommitLineData
0085ce49 1# This file was created automatically by SWIG 1.3.29.
d14a1e28
RD
2# Don't modify this file, modify the SWIG interface instead.
3
54f9ee45 4import _core_
0085ce49
RD
5import new
6new_instancemethod = new.instancemethod
093d3ff1 7def _swig_setattr_nondynamic(self,class_type,name,value,static=1):
0085ce49 8 if (name == "thisown"): return self.this.own(value)
093d3ff1 9 if (name == "this"):
0085ce49
RD
10 if type(value).__name__ == 'PySwigObject':
11 self.__dict__[name] = value
093d3ff1
RD
12 return
13 method = class_type.__swig_setmethods__.get(name,None)
14 if method: return method(self,value)
0085ce49 15 if (not static) or hasattr(self,name):
093d3ff1
RD
16 self.__dict__[name] = value
17 else:
18 raise AttributeError("You cannot add attributes to %s" % self)
19
20def _swig_setattr(self,class_type,name,value):
21 return _swig_setattr_nondynamic(self,class_type,name,value,0)
22
23def _swig_getattr(self,class_type,name):
0085ce49 24 if (name == "thisown"): return self.this.own()
093d3ff1
RD
25 method = class_type.__swig_getmethods__.get(name,None)
26 if method: return method(self)
27 raise AttributeError,name
28
0085ce49
RD
29def _swig_repr(self):
30 try: strthis = "proxy of " + self.this.__repr__()
31 except: strthis = ""
32 return "<%s.%s; %s >" % (self.__class__.__module__, self.__class__.__name__, strthis,)
33
093d3ff1
RD
34import types
35try:
36 _object = types.ObjectType
37 _newclass = 1
38except AttributeError:
39 class _object : pass
40 _newclass = 0
41del types
42
43
44def _swig_setattr_nondynamic_method(set):
45 def set_attr(self,name,value):
0085ce49
RD
46 if (name == "thisown"): return self.this.own(value)
47 if hasattr(self,name) or (name == "this"):
093d3ff1
RD
48 set(self,name,value)
49 else:
50 raise AttributeError("You cannot add attributes to %s" % self)
51 return set_attr
52
53
d14a1e28
RD
54#// Give a reference to the dictionary of this module to the C++ extension
55#// code.
54f9ee45 56_core_._wxPySetDictionary(vars())
d14a1e28
RD
57
58#// A little trick to make 'wx' be a reference to this module so wx.Names can
59#// be used here.
60import sys as _sys
61wx = _sys.modules[__name__]
62
66c033b4
RD
63
64#----------------------------------------------------------------------------
65
66def _deprecated(callable, msg=None):
67 """
68 Create a wrapper function that will raise a DeprecationWarning
69 before calling the callable.
70 """
71 if msg is None:
72 msg = "%s is deprecated" % callable
73 def deprecatedWrapper(*args, **kwargs):
74 import warnings
75 warnings.warn(msg, DeprecationWarning, stacklevel=2)
76 return callable(*args, **kwargs)
77 deprecatedWrapper.__doc__ = msg
78 return deprecatedWrapper
79
80
81#----------------------------------------------------------------------------
82
54f9ee45
RD
83NOT_FOUND = _core_.NOT_FOUND
84VSCROLL = _core_.VSCROLL
85HSCROLL = _core_.HSCROLL
86CAPTION = _core_.CAPTION
87DOUBLE_BORDER = _core_.DOUBLE_BORDER
88SUNKEN_BORDER = _core_.SUNKEN_BORDER
89RAISED_BORDER = _core_.RAISED_BORDER
90BORDER = _core_.BORDER
91SIMPLE_BORDER = _core_.SIMPLE_BORDER
92STATIC_BORDER = _core_.STATIC_BORDER
93TRANSPARENT_WINDOW = _core_.TRANSPARENT_WINDOW
94NO_BORDER = _core_.NO_BORDER
bcd0d7b6 95DEFAULT_CONTROL_BORDER = _core_.DEFAULT_CONTROL_BORDER
6d88e192 96DEFAULT_STATUSBAR_STYLE = _core_.DEFAULT_STATUSBAR_STYLE
54f9ee45
RD
97TAB_TRAVERSAL = _core_.TAB_TRAVERSAL
98WANTS_CHARS = _core_.WANTS_CHARS
99POPUP_WINDOW = _core_.POPUP_WINDOW
100CENTER_FRAME = _core_.CENTER_FRAME
101CENTRE_ON_SCREEN = _core_.CENTRE_ON_SCREEN
102CENTER_ON_SCREEN = _core_.CENTER_ON_SCREEN
54f9ee45
RD
103CLIP_CHILDREN = _core_.CLIP_CHILDREN
104CLIP_SIBLINGS = _core_.CLIP_SIBLINGS
092f0ed7 105WINDOW_STYLE_MASK = _core_.WINDOW_STYLE_MASK
54f9ee45
RD
106ALWAYS_SHOW_SB = _core_.ALWAYS_SHOW_SB
107RETAINED = _core_.RETAINED
108BACKINGSTORE = _core_.BACKINGSTORE
109COLOURED = _core_.COLOURED
110FIXED_LENGTH = _core_.FIXED_LENGTH
111LB_NEEDED_SB = _core_.LB_NEEDED_SB
112LB_ALWAYS_SB = _core_.LB_ALWAYS_SB
113LB_SORT = _core_.LB_SORT
114LB_SINGLE = _core_.LB_SINGLE
115LB_MULTIPLE = _core_.LB_MULTIPLE
116LB_EXTENDED = _core_.LB_EXTENDED
117LB_OWNERDRAW = _core_.LB_OWNERDRAW
118LB_HSCROLL = _core_.LB_HSCROLL
119PROCESS_ENTER = _core_.PROCESS_ENTER
120PASSWORD = _core_.PASSWORD
121CB_SIMPLE = _core_.CB_SIMPLE
122CB_DROPDOWN = _core_.CB_DROPDOWN
123CB_SORT = _core_.CB_SORT
124CB_READONLY = _core_.CB_READONLY
125RA_HORIZONTAL = _core_.RA_HORIZONTAL
126RA_VERTICAL = _core_.RA_VERTICAL
127RA_SPECIFY_ROWS = _core_.RA_SPECIFY_ROWS
128RA_SPECIFY_COLS = _core_.RA_SPECIFY_COLS
fef4c27a 129RA_USE_CHECKBOX = _core_.RA_USE_CHECKBOX
54f9ee45
RD
130RB_GROUP = _core_.RB_GROUP
131RB_SINGLE = _core_.RB_SINGLE
54f9ee45
RD
132SB_HORIZONTAL = _core_.SB_HORIZONTAL
133SB_VERTICAL = _core_.SB_VERTICAL
fef4c27a 134RB_USE_CHECKBOX = _core_.RB_USE_CHECKBOX
54f9ee45
RD
135ST_SIZEGRIP = _core_.ST_SIZEGRIP
136ST_NO_AUTORESIZE = _core_.ST_NO_AUTORESIZE
e9d6f3a4
RD
137ST_DOTS_MIDDLE = _core_.ST_DOTS_MIDDLE
138ST_DOTS_END = _core_.ST_DOTS_END
54f9ee45
RD
139FLOOD_SURFACE = _core_.FLOOD_SURFACE
140FLOOD_BORDER = _core_.FLOOD_BORDER
141ODDEVEN_RULE = _core_.ODDEVEN_RULE
142WINDING_RULE = _core_.WINDING_RULE
143TOOL_TOP = _core_.TOOL_TOP
144TOOL_BOTTOM = _core_.TOOL_BOTTOM
145TOOL_LEFT = _core_.TOOL_LEFT
146TOOL_RIGHT = _core_.TOOL_RIGHT
147OK = _core_.OK
148YES_NO = _core_.YES_NO
149CANCEL = _core_.CANCEL
150YES = _core_.YES
151NO = _core_.NO
152NO_DEFAULT = _core_.NO_DEFAULT
153YES_DEFAULT = _core_.YES_DEFAULT
154ICON_EXCLAMATION = _core_.ICON_EXCLAMATION
155ICON_HAND = _core_.ICON_HAND
156ICON_QUESTION = _core_.ICON_QUESTION
157ICON_INFORMATION = _core_.ICON_INFORMATION
158ICON_STOP = _core_.ICON_STOP
159ICON_ASTERISK = _core_.ICON_ASTERISK
160ICON_MASK = _core_.ICON_MASK
161ICON_WARNING = _core_.ICON_WARNING
162ICON_ERROR = _core_.ICON_ERROR
163FORWARD = _core_.FORWARD
164BACKWARD = _core_.BACKWARD
165RESET = _core_.RESET
166HELP = _core_.HELP
167MORE = _core_.MORE
168SETUP = _core_.SETUP
169SIZE_AUTO_WIDTH = _core_.SIZE_AUTO_WIDTH
170SIZE_AUTO_HEIGHT = _core_.SIZE_AUTO_HEIGHT
171SIZE_AUTO = _core_.SIZE_AUTO
172SIZE_USE_EXISTING = _core_.SIZE_USE_EXISTING
173SIZE_ALLOW_MINUS_ONE = _core_.SIZE_ALLOW_MINUS_ONE
943e8dfd 174SIZE_FORCE = _core_.SIZE_FORCE
54f9ee45
RD
175PORTRAIT = _core_.PORTRAIT
176LANDSCAPE = _core_.LANDSCAPE
177PRINT_QUALITY_HIGH = _core_.PRINT_QUALITY_HIGH
178PRINT_QUALITY_MEDIUM = _core_.PRINT_QUALITY_MEDIUM
179PRINT_QUALITY_LOW = _core_.PRINT_QUALITY_LOW
180PRINT_QUALITY_DRAFT = _core_.PRINT_QUALITY_DRAFT
181ID_ANY = _core_.ID_ANY
182ID_SEPARATOR = _core_.ID_SEPARATOR
943e8dfd 183ID_NONE = _core_.ID_NONE
54f9ee45
RD
184ID_LOWEST = _core_.ID_LOWEST
185ID_OPEN = _core_.ID_OPEN
186ID_CLOSE = _core_.ID_CLOSE
187ID_NEW = _core_.ID_NEW
188ID_SAVE = _core_.ID_SAVE
189ID_SAVEAS = _core_.ID_SAVEAS
190ID_REVERT = _core_.ID_REVERT
191ID_EXIT = _core_.ID_EXIT
192ID_UNDO = _core_.ID_UNDO
193ID_REDO = _core_.ID_REDO
194ID_HELP = _core_.ID_HELP
195ID_PRINT = _core_.ID_PRINT
196ID_PRINT_SETUP = _core_.ID_PRINT_SETUP
fc46b7f3 197ID_PAGE_SETUP = _core_.ID_PAGE_SETUP
54f9ee45
RD
198ID_PREVIEW = _core_.ID_PREVIEW
199ID_ABOUT = _core_.ID_ABOUT
200ID_HELP_CONTENTS = _core_.ID_HELP_CONTENTS
201ID_HELP_COMMANDS = _core_.ID_HELP_COMMANDS
202ID_HELP_PROCEDURES = _core_.ID_HELP_PROCEDURES
203ID_HELP_CONTEXT = _core_.ID_HELP_CONTEXT
10044bf1
RD
204ID_HELP_INDEX = _core_.ID_HELP_INDEX
205ID_HELP_SEARCH = _core_.ID_HELP_SEARCH
54f9ee45
RD
206ID_CLOSE_ALL = _core_.ID_CLOSE_ALL
207ID_PREFERENCES = _core_.ID_PREFERENCES
97ab0f6a 208ID_EDIT = _core_.ID_EDIT
54f9ee45
RD
209ID_CUT = _core_.ID_CUT
210ID_COPY = _core_.ID_COPY
211ID_PASTE = _core_.ID_PASTE
212ID_CLEAR = _core_.ID_CLEAR
213ID_FIND = _core_.ID_FIND
214ID_DUPLICATE = _core_.ID_DUPLICATE
215ID_SELECTALL = _core_.ID_SELECTALL
216ID_DELETE = _core_.ID_DELETE
217ID_REPLACE = _core_.ID_REPLACE
218ID_REPLACE_ALL = _core_.ID_REPLACE_ALL
219ID_PROPERTIES = _core_.ID_PROPERTIES
220ID_VIEW_DETAILS = _core_.ID_VIEW_DETAILS
221ID_VIEW_LARGEICONS = _core_.ID_VIEW_LARGEICONS
222ID_VIEW_SMALLICONS = _core_.ID_VIEW_SMALLICONS
223ID_VIEW_LIST = _core_.ID_VIEW_LIST
224ID_VIEW_SORTDATE = _core_.ID_VIEW_SORTDATE
225ID_VIEW_SORTNAME = _core_.ID_VIEW_SORTNAME
226ID_VIEW_SORTSIZE = _core_.ID_VIEW_SORTSIZE
227ID_VIEW_SORTTYPE = _core_.ID_VIEW_SORTTYPE
97ab0f6a 228ID_FILE = _core_.ID_FILE
54f9ee45
RD
229ID_FILE1 = _core_.ID_FILE1
230ID_FILE2 = _core_.ID_FILE2
231ID_FILE3 = _core_.ID_FILE3
232ID_FILE4 = _core_.ID_FILE4
233ID_FILE5 = _core_.ID_FILE5
234ID_FILE6 = _core_.ID_FILE6
235ID_FILE7 = _core_.ID_FILE7
236ID_FILE8 = _core_.ID_FILE8
237ID_FILE9 = _core_.ID_FILE9
238ID_OK = _core_.ID_OK
239ID_CANCEL = _core_.ID_CANCEL
240ID_APPLY = _core_.ID_APPLY
241ID_YES = _core_.ID_YES
242ID_NO = _core_.ID_NO
243ID_STATIC = _core_.ID_STATIC
244ID_FORWARD = _core_.ID_FORWARD
245ID_BACKWARD = _core_.ID_BACKWARD
246ID_DEFAULT = _core_.ID_DEFAULT
247ID_MORE = _core_.ID_MORE
248ID_SETUP = _core_.ID_SETUP
249ID_RESET = _core_.ID_RESET
250ID_CONTEXT_HELP = _core_.ID_CONTEXT_HELP
251ID_YESTOALL = _core_.ID_YESTOALL
252ID_NOTOALL = _core_.ID_NOTOALL
253ID_ABORT = _core_.ID_ABORT
254ID_RETRY = _core_.ID_RETRY
255ID_IGNORE = _core_.ID_IGNORE
7bc1e663
RD
256ID_ADD = _core_.ID_ADD
257ID_REMOVE = _core_.ID_REMOVE
258ID_UP = _core_.ID_UP
259ID_DOWN = _core_.ID_DOWN
260ID_HOME = _core_.ID_HOME
261ID_REFRESH = _core_.ID_REFRESH
262ID_STOP = _core_.ID_STOP
263ID_INDEX = _core_.ID_INDEX
264ID_BOLD = _core_.ID_BOLD
265ID_ITALIC = _core_.ID_ITALIC
266ID_JUSTIFY_CENTER = _core_.ID_JUSTIFY_CENTER
267ID_JUSTIFY_FILL = _core_.ID_JUSTIFY_FILL
268ID_JUSTIFY_RIGHT = _core_.ID_JUSTIFY_RIGHT
269ID_JUSTIFY_LEFT = _core_.ID_JUSTIFY_LEFT
270ID_UNDERLINE = _core_.ID_UNDERLINE
271ID_INDENT = _core_.ID_INDENT
272ID_UNINDENT = _core_.ID_UNINDENT
273ID_ZOOM_100 = _core_.ID_ZOOM_100
274ID_ZOOM_FIT = _core_.ID_ZOOM_FIT
275ID_ZOOM_IN = _core_.ID_ZOOM_IN
276ID_ZOOM_OUT = _core_.ID_ZOOM_OUT
277ID_UNDELETE = _core_.ID_UNDELETE
278ID_REVERT_TO_SAVED = _core_.ID_REVERT_TO_SAVED
54f9ee45 279ID_HIGHEST = _core_.ID_HIGHEST
54f9ee45
RD
280MENU_TEAROFF = _core_.MENU_TEAROFF
281MB_DOCKABLE = _core_.MB_DOCKABLE
282NO_FULL_REPAINT_ON_RESIZE = _core_.NO_FULL_REPAINT_ON_RESIZE
283FULL_REPAINT_ON_RESIZE = _core_.FULL_REPAINT_ON_RESIZE
284LI_HORIZONTAL = _core_.LI_HORIZONTAL
285LI_VERTICAL = _core_.LI_VERTICAL
286WS_EX_VALIDATE_RECURSIVELY = _core_.WS_EX_VALIDATE_RECURSIVELY
287WS_EX_BLOCK_EVENTS = _core_.WS_EX_BLOCK_EVENTS
288WS_EX_TRANSIENT = _core_.WS_EX_TRANSIENT
289WS_EX_THEMED_BACKGROUND = _core_.WS_EX_THEMED_BACKGROUND
290WS_EX_PROCESS_IDLE = _core_.WS_EX_PROCESS_IDLE
291WS_EX_PROCESS_UI_UPDATES = _core_.WS_EX_PROCESS_UI_UPDATES
292MM_TEXT = _core_.MM_TEXT
293MM_LOMETRIC = _core_.MM_LOMETRIC
294MM_HIMETRIC = _core_.MM_HIMETRIC
295MM_LOENGLISH = _core_.MM_LOENGLISH
296MM_HIENGLISH = _core_.MM_HIENGLISH
297MM_TWIPS = _core_.MM_TWIPS
298MM_ISOTROPIC = _core_.MM_ISOTROPIC
299MM_ANISOTROPIC = _core_.MM_ANISOTROPIC
300MM_POINTS = _core_.MM_POINTS
301MM_METRIC = _core_.MM_METRIC
302CENTRE = _core_.CENTRE
303CENTER = _core_.CENTER
304HORIZONTAL = _core_.HORIZONTAL
305VERTICAL = _core_.VERTICAL
306BOTH = _core_.BOTH
307LEFT = _core_.LEFT
308RIGHT = _core_.RIGHT
309UP = _core_.UP
310DOWN = _core_.DOWN
311TOP = _core_.TOP
312BOTTOM = _core_.BOTTOM
313NORTH = _core_.NORTH
314SOUTH = _core_.SOUTH
315WEST = _core_.WEST
316EAST = _core_.EAST
317ALL = _core_.ALL
318ALIGN_NOT = _core_.ALIGN_NOT
319ALIGN_CENTER_HORIZONTAL = _core_.ALIGN_CENTER_HORIZONTAL
320ALIGN_CENTRE_HORIZONTAL = _core_.ALIGN_CENTRE_HORIZONTAL
321ALIGN_LEFT = _core_.ALIGN_LEFT
322ALIGN_TOP = _core_.ALIGN_TOP
323ALIGN_RIGHT = _core_.ALIGN_RIGHT
324ALIGN_BOTTOM = _core_.ALIGN_BOTTOM
325ALIGN_CENTER_VERTICAL = _core_.ALIGN_CENTER_VERTICAL
326ALIGN_CENTRE_VERTICAL = _core_.ALIGN_CENTRE_VERTICAL
327ALIGN_CENTER = _core_.ALIGN_CENTER
328ALIGN_CENTRE = _core_.ALIGN_CENTRE
329ALIGN_MASK = _core_.ALIGN_MASK
330STRETCH_NOT = _core_.STRETCH_NOT
331SHRINK = _core_.SHRINK
332GROW = _core_.GROW
333EXPAND = _core_.EXPAND
334SHAPED = _core_.SHAPED
335FIXED_MINSIZE = _core_.FIXED_MINSIZE
336TILE = _core_.TILE
337ADJUST_MINSIZE = _core_.ADJUST_MINSIZE
338BORDER_DEFAULT = _core_.BORDER_DEFAULT
339BORDER_NONE = _core_.BORDER_NONE
340BORDER_STATIC = _core_.BORDER_STATIC
341BORDER_SIMPLE = _core_.BORDER_SIMPLE
342BORDER_RAISED = _core_.BORDER_RAISED
343BORDER_SUNKEN = _core_.BORDER_SUNKEN
344BORDER_DOUBLE = _core_.BORDER_DOUBLE
345BORDER_MASK = _core_.BORDER_MASK
7bc1e663
RD
346BG_STYLE_SYSTEM = _core_.BG_STYLE_SYSTEM
347BG_STYLE_COLOUR = _core_.BG_STYLE_COLOUR
348BG_STYLE_CUSTOM = _core_.BG_STYLE_CUSTOM
54f9ee45
RD
349DEFAULT = _core_.DEFAULT
350DECORATIVE = _core_.DECORATIVE
351ROMAN = _core_.ROMAN
352SCRIPT = _core_.SCRIPT
353SWISS = _core_.SWISS
354MODERN = _core_.MODERN
355TELETYPE = _core_.TELETYPE
356VARIABLE = _core_.VARIABLE
357FIXED = _core_.FIXED
358NORMAL = _core_.NORMAL
359LIGHT = _core_.LIGHT
360BOLD = _core_.BOLD
361ITALIC = _core_.ITALIC
362SLANT = _core_.SLANT
363SOLID = _core_.SOLID
364DOT = _core_.DOT
365LONG_DASH = _core_.LONG_DASH
366SHORT_DASH = _core_.SHORT_DASH
367DOT_DASH = _core_.DOT_DASH
368USER_DASH = _core_.USER_DASH
369TRANSPARENT = _core_.TRANSPARENT
370STIPPLE = _core_.STIPPLE
d04418a7
RD
371STIPPLE_MASK = _core_.STIPPLE_MASK
372STIPPLE_MASK_OPAQUE = _core_.STIPPLE_MASK_OPAQUE
54f9ee45
RD
373BDIAGONAL_HATCH = _core_.BDIAGONAL_HATCH
374CROSSDIAG_HATCH = _core_.CROSSDIAG_HATCH
375FDIAGONAL_HATCH = _core_.FDIAGONAL_HATCH
376CROSS_HATCH = _core_.CROSS_HATCH
377HORIZONTAL_HATCH = _core_.HORIZONTAL_HATCH
378VERTICAL_HATCH = _core_.VERTICAL_HATCH
379JOIN_BEVEL = _core_.JOIN_BEVEL
380JOIN_MITER = _core_.JOIN_MITER
381JOIN_ROUND = _core_.JOIN_ROUND
382CAP_ROUND = _core_.CAP_ROUND
383CAP_PROJECTING = _core_.CAP_PROJECTING
384CAP_BUTT = _core_.CAP_BUTT
385CLEAR = _core_.CLEAR
386XOR = _core_.XOR
387INVERT = _core_.INVERT
388OR_REVERSE = _core_.OR_REVERSE
389AND_REVERSE = _core_.AND_REVERSE
390COPY = _core_.COPY
391AND = _core_.AND
392AND_INVERT = _core_.AND_INVERT
393NO_OP = _core_.NO_OP
394NOR = _core_.NOR
395EQUIV = _core_.EQUIV
396SRC_INVERT = _core_.SRC_INVERT
397OR_INVERT = _core_.OR_INVERT
398NAND = _core_.NAND
399OR = _core_.OR
400SET = _core_.SET
401WXK_BACK = _core_.WXK_BACK
402WXK_TAB = _core_.WXK_TAB
403WXK_RETURN = _core_.WXK_RETURN
404WXK_ESCAPE = _core_.WXK_ESCAPE
405WXK_SPACE = _core_.WXK_SPACE
406WXK_DELETE = _core_.WXK_DELETE
407WXK_START = _core_.WXK_START
408WXK_LBUTTON = _core_.WXK_LBUTTON
409WXK_RBUTTON = _core_.WXK_RBUTTON
410WXK_CANCEL = _core_.WXK_CANCEL
411WXK_MBUTTON = _core_.WXK_MBUTTON
412WXK_CLEAR = _core_.WXK_CLEAR
413WXK_SHIFT = _core_.WXK_SHIFT
414WXK_ALT = _core_.WXK_ALT
415WXK_CONTROL = _core_.WXK_CONTROL
416WXK_MENU = _core_.WXK_MENU
417WXK_PAUSE = _core_.WXK_PAUSE
418WXK_CAPITAL = _core_.WXK_CAPITAL
419WXK_PRIOR = _core_.WXK_PRIOR
420WXK_NEXT = _core_.WXK_NEXT
421WXK_END = _core_.WXK_END
422WXK_HOME = _core_.WXK_HOME
423WXK_LEFT = _core_.WXK_LEFT
424WXK_UP = _core_.WXK_UP
425WXK_RIGHT = _core_.WXK_RIGHT
426WXK_DOWN = _core_.WXK_DOWN
427WXK_SELECT = _core_.WXK_SELECT
428WXK_PRINT = _core_.WXK_PRINT
429WXK_EXECUTE = _core_.WXK_EXECUTE
430WXK_SNAPSHOT = _core_.WXK_SNAPSHOT
431WXK_INSERT = _core_.WXK_INSERT
432WXK_HELP = _core_.WXK_HELP
433WXK_NUMPAD0 = _core_.WXK_NUMPAD0
434WXK_NUMPAD1 = _core_.WXK_NUMPAD1
435WXK_NUMPAD2 = _core_.WXK_NUMPAD2
436WXK_NUMPAD3 = _core_.WXK_NUMPAD3
437WXK_NUMPAD4 = _core_.WXK_NUMPAD4
438WXK_NUMPAD5 = _core_.WXK_NUMPAD5
439WXK_NUMPAD6 = _core_.WXK_NUMPAD6
440WXK_NUMPAD7 = _core_.WXK_NUMPAD7
441WXK_NUMPAD8 = _core_.WXK_NUMPAD8
442WXK_NUMPAD9 = _core_.WXK_NUMPAD9
443WXK_MULTIPLY = _core_.WXK_MULTIPLY
444WXK_ADD = _core_.WXK_ADD
445WXK_SEPARATOR = _core_.WXK_SEPARATOR
446WXK_SUBTRACT = _core_.WXK_SUBTRACT
447WXK_DECIMAL = _core_.WXK_DECIMAL
448WXK_DIVIDE = _core_.WXK_DIVIDE
449WXK_F1 = _core_.WXK_F1
450WXK_F2 = _core_.WXK_F2
451WXK_F3 = _core_.WXK_F3
452WXK_F4 = _core_.WXK_F4
453WXK_F5 = _core_.WXK_F5
454WXK_F6 = _core_.WXK_F6
455WXK_F7 = _core_.WXK_F7
456WXK_F8 = _core_.WXK_F8
457WXK_F9 = _core_.WXK_F9
458WXK_F10 = _core_.WXK_F10
459WXK_F11 = _core_.WXK_F11
460WXK_F12 = _core_.WXK_F12
461WXK_F13 = _core_.WXK_F13
462WXK_F14 = _core_.WXK_F14
463WXK_F15 = _core_.WXK_F15
464WXK_F16 = _core_.WXK_F16
465WXK_F17 = _core_.WXK_F17
466WXK_F18 = _core_.WXK_F18
467WXK_F19 = _core_.WXK_F19
468WXK_F20 = _core_.WXK_F20
469WXK_F21 = _core_.WXK_F21
470WXK_F22 = _core_.WXK_F22
471WXK_F23 = _core_.WXK_F23
472WXK_F24 = _core_.WXK_F24
473WXK_NUMLOCK = _core_.WXK_NUMLOCK
474WXK_SCROLL = _core_.WXK_SCROLL
475WXK_PAGEUP = _core_.WXK_PAGEUP
476WXK_PAGEDOWN = _core_.WXK_PAGEDOWN
477WXK_NUMPAD_SPACE = _core_.WXK_NUMPAD_SPACE
478WXK_NUMPAD_TAB = _core_.WXK_NUMPAD_TAB
479WXK_NUMPAD_ENTER = _core_.WXK_NUMPAD_ENTER
480WXK_NUMPAD_F1 = _core_.WXK_NUMPAD_F1
481WXK_NUMPAD_F2 = _core_.WXK_NUMPAD_F2
482WXK_NUMPAD_F3 = _core_.WXK_NUMPAD_F3
483WXK_NUMPAD_F4 = _core_.WXK_NUMPAD_F4
484WXK_NUMPAD_HOME = _core_.WXK_NUMPAD_HOME
485WXK_NUMPAD_LEFT = _core_.WXK_NUMPAD_LEFT
486WXK_NUMPAD_UP = _core_.WXK_NUMPAD_UP
487WXK_NUMPAD_RIGHT = _core_.WXK_NUMPAD_RIGHT
488WXK_NUMPAD_DOWN = _core_.WXK_NUMPAD_DOWN
489WXK_NUMPAD_PRIOR = _core_.WXK_NUMPAD_PRIOR
490WXK_NUMPAD_PAGEUP = _core_.WXK_NUMPAD_PAGEUP
491WXK_NUMPAD_NEXT = _core_.WXK_NUMPAD_NEXT
492WXK_NUMPAD_PAGEDOWN = _core_.WXK_NUMPAD_PAGEDOWN
493WXK_NUMPAD_END = _core_.WXK_NUMPAD_END
494WXK_NUMPAD_BEGIN = _core_.WXK_NUMPAD_BEGIN
495WXK_NUMPAD_INSERT = _core_.WXK_NUMPAD_INSERT
496WXK_NUMPAD_DELETE = _core_.WXK_NUMPAD_DELETE
497WXK_NUMPAD_EQUAL = _core_.WXK_NUMPAD_EQUAL
498WXK_NUMPAD_MULTIPLY = _core_.WXK_NUMPAD_MULTIPLY
499WXK_NUMPAD_ADD = _core_.WXK_NUMPAD_ADD
500WXK_NUMPAD_SEPARATOR = _core_.WXK_NUMPAD_SEPARATOR
501WXK_NUMPAD_SUBTRACT = _core_.WXK_NUMPAD_SUBTRACT
502WXK_NUMPAD_DECIMAL = _core_.WXK_NUMPAD_DECIMAL
503WXK_NUMPAD_DIVIDE = _core_.WXK_NUMPAD_DIVIDE
504WXK_WINDOWS_LEFT = _core_.WXK_WINDOWS_LEFT
505WXK_WINDOWS_RIGHT = _core_.WXK_WINDOWS_RIGHT
506WXK_WINDOWS_MENU = _core_.WXK_WINDOWS_MENU
88c6b281
RD
507WXK_COMMAND = _core_.WXK_COMMAND
508WXK_SPECIAL1 = _core_.WXK_SPECIAL1
509WXK_SPECIAL2 = _core_.WXK_SPECIAL2
510WXK_SPECIAL3 = _core_.WXK_SPECIAL3
511WXK_SPECIAL4 = _core_.WXK_SPECIAL4
512WXK_SPECIAL5 = _core_.WXK_SPECIAL5
513WXK_SPECIAL6 = _core_.WXK_SPECIAL6
514WXK_SPECIAL7 = _core_.WXK_SPECIAL7
515WXK_SPECIAL8 = _core_.WXK_SPECIAL8
516WXK_SPECIAL9 = _core_.WXK_SPECIAL9
517WXK_SPECIAL10 = _core_.WXK_SPECIAL10
518WXK_SPECIAL11 = _core_.WXK_SPECIAL11
519WXK_SPECIAL12 = _core_.WXK_SPECIAL12
520WXK_SPECIAL13 = _core_.WXK_SPECIAL13
521WXK_SPECIAL14 = _core_.WXK_SPECIAL14
522WXK_SPECIAL15 = _core_.WXK_SPECIAL15
523WXK_SPECIAL16 = _core_.WXK_SPECIAL16
524WXK_SPECIAL17 = _core_.WXK_SPECIAL17
525WXK_SPECIAL18 = _core_.WXK_SPECIAL18
526WXK_SPECIAL19 = _core_.WXK_SPECIAL19
527WXK_SPECIAL20 = _core_.WXK_SPECIAL20
54f9ee45
RD
528PAPER_NONE = _core_.PAPER_NONE
529PAPER_LETTER = _core_.PAPER_LETTER
530PAPER_LEGAL = _core_.PAPER_LEGAL
531PAPER_A4 = _core_.PAPER_A4
532PAPER_CSHEET = _core_.PAPER_CSHEET
533PAPER_DSHEET = _core_.PAPER_DSHEET
534PAPER_ESHEET = _core_.PAPER_ESHEET
535PAPER_LETTERSMALL = _core_.PAPER_LETTERSMALL
536PAPER_TABLOID = _core_.PAPER_TABLOID
537PAPER_LEDGER = _core_.PAPER_LEDGER
538PAPER_STATEMENT = _core_.PAPER_STATEMENT
539PAPER_EXECUTIVE = _core_.PAPER_EXECUTIVE
540PAPER_A3 = _core_.PAPER_A3
541PAPER_A4SMALL = _core_.PAPER_A4SMALL
542PAPER_A5 = _core_.PAPER_A5
543PAPER_B4 = _core_.PAPER_B4
544PAPER_B5 = _core_.PAPER_B5
545PAPER_FOLIO = _core_.PAPER_FOLIO
546PAPER_QUARTO = _core_.PAPER_QUARTO
547PAPER_10X14 = _core_.PAPER_10X14
548PAPER_11X17 = _core_.PAPER_11X17
549PAPER_NOTE = _core_.PAPER_NOTE
550PAPER_ENV_9 = _core_.PAPER_ENV_9
551PAPER_ENV_10 = _core_.PAPER_ENV_10
552PAPER_ENV_11 = _core_.PAPER_ENV_11
553PAPER_ENV_12 = _core_.PAPER_ENV_12
554PAPER_ENV_14 = _core_.PAPER_ENV_14
555PAPER_ENV_DL = _core_.PAPER_ENV_DL
556PAPER_ENV_C5 = _core_.PAPER_ENV_C5
557PAPER_ENV_C3 = _core_.PAPER_ENV_C3
558PAPER_ENV_C4 = _core_.PAPER_ENV_C4
559PAPER_ENV_C6 = _core_.PAPER_ENV_C6
560PAPER_ENV_C65 = _core_.PAPER_ENV_C65
561PAPER_ENV_B4 = _core_.PAPER_ENV_B4
562PAPER_ENV_B5 = _core_.PAPER_ENV_B5
563PAPER_ENV_B6 = _core_.PAPER_ENV_B6
564PAPER_ENV_ITALY = _core_.PAPER_ENV_ITALY
565PAPER_ENV_MONARCH = _core_.PAPER_ENV_MONARCH
566PAPER_ENV_PERSONAL = _core_.PAPER_ENV_PERSONAL
567PAPER_FANFOLD_US = _core_.PAPER_FANFOLD_US
568PAPER_FANFOLD_STD_GERMAN = _core_.PAPER_FANFOLD_STD_GERMAN
569PAPER_FANFOLD_LGL_GERMAN = _core_.PAPER_FANFOLD_LGL_GERMAN
570PAPER_ISO_B4 = _core_.PAPER_ISO_B4
571PAPER_JAPANESE_POSTCARD = _core_.PAPER_JAPANESE_POSTCARD
572PAPER_9X11 = _core_.PAPER_9X11
573PAPER_10X11 = _core_.PAPER_10X11
574PAPER_15X11 = _core_.PAPER_15X11
575PAPER_ENV_INVITE = _core_.PAPER_ENV_INVITE
576PAPER_LETTER_EXTRA = _core_.PAPER_LETTER_EXTRA
577PAPER_LEGAL_EXTRA = _core_.PAPER_LEGAL_EXTRA
578PAPER_TABLOID_EXTRA = _core_.PAPER_TABLOID_EXTRA
579PAPER_A4_EXTRA = _core_.PAPER_A4_EXTRA
580PAPER_LETTER_TRANSVERSE = _core_.PAPER_LETTER_TRANSVERSE
581PAPER_A4_TRANSVERSE = _core_.PAPER_A4_TRANSVERSE
582PAPER_LETTER_EXTRA_TRANSVERSE = _core_.PAPER_LETTER_EXTRA_TRANSVERSE
583PAPER_A_PLUS = _core_.PAPER_A_PLUS
584PAPER_B_PLUS = _core_.PAPER_B_PLUS
585PAPER_LETTER_PLUS = _core_.PAPER_LETTER_PLUS
586PAPER_A4_PLUS = _core_.PAPER_A4_PLUS
587PAPER_A5_TRANSVERSE = _core_.PAPER_A5_TRANSVERSE
588PAPER_B5_TRANSVERSE = _core_.PAPER_B5_TRANSVERSE
589PAPER_A3_EXTRA = _core_.PAPER_A3_EXTRA
590PAPER_A5_EXTRA = _core_.PAPER_A5_EXTRA
591PAPER_B5_EXTRA = _core_.PAPER_B5_EXTRA
592PAPER_A2 = _core_.PAPER_A2
593PAPER_A3_TRANSVERSE = _core_.PAPER_A3_TRANSVERSE
594PAPER_A3_EXTRA_TRANSVERSE = _core_.PAPER_A3_EXTRA_TRANSVERSE
6c75a4cf
RD
595PAPER_DBL_JAPANESE_POSTCARD = _core_.PAPER_DBL_JAPANESE_POSTCARD
596PAPER_A6 = _core_.PAPER_A6
597PAPER_JENV_KAKU2 = _core_.PAPER_JENV_KAKU2
598PAPER_JENV_KAKU3 = _core_.PAPER_JENV_KAKU3
599PAPER_JENV_CHOU3 = _core_.PAPER_JENV_CHOU3
600PAPER_JENV_CHOU4 = _core_.PAPER_JENV_CHOU4
601PAPER_LETTER_ROTATED = _core_.PAPER_LETTER_ROTATED
602PAPER_A3_ROTATED = _core_.PAPER_A3_ROTATED
603PAPER_A4_ROTATED = _core_.PAPER_A4_ROTATED
604PAPER_A5_ROTATED = _core_.PAPER_A5_ROTATED
605PAPER_B4_JIS_ROTATED = _core_.PAPER_B4_JIS_ROTATED
606PAPER_B5_JIS_ROTATED = _core_.PAPER_B5_JIS_ROTATED
607PAPER_JAPANESE_POSTCARD_ROTATED = _core_.PAPER_JAPANESE_POSTCARD_ROTATED
608PAPER_DBL_JAPANESE_POSTCARD_ROTATED = _core_.PAPER_DBL_JAPANESE_POSTCARD_ROTATED
609PAPER_A6_ROTATED = _core_.PAPER_A6_ROTATED
610PAPER_JENV_KAKU2_ROTATED = _core_.PAPER_JENV_KAKU2_ROTATED
611PAPER_JENV_KAKU3_ROTATED = _core_.PAPER_JENV_KAKU3_ROTATED
612PAPER_JENV_CHOU3_ROTATED = _core_.PAPER_JENV_CHOU3_ROTATED
613PAPER_JENV_CHOU4_ROTATED = _core_.PAPER_JENV_CHOU4_ROTATED
614PAPER_B6_JIS = _core_.PAPER_B6_JIS
615PAPER_B6_JIS_ROTATED = _core_.PAPER_B6_JIS_ROTATED
616PAPER_12X11 = _core_.PAPER_12X11
617PAPER_JENV_YOU4 = _core_.PAPER_JENV_YOU4
618PAPER_JENV_YOU4_ROTATED = _core_.PAPER_JENV_YOU4_ROTATED
619PAPER_P16K = _core_.PAPER_P16K
620PAPER_P32K = _core_.PAPER_P32K
621PAPER_P32KBIG = _core_.PAPER_P32KBIG
622PAPER_PENV_1 = _core_.PAPER_PENV_1
623PAPER_PENV_2 = _core_.PAPER_PENV_2
624PAPER_PENV_3 = _core_.PAPER_PENV_3
625PAPER_PENV_4 = _core_.PAPER_PENV_4
626PAPER_PENV_5 = _core_.PAPER_PENV_5
627PAPER_PENV_6 = _core_.PAPER_PENV_6
628PAPER_PENV_7 = _core_.PAPER_PENV_7
629PAPER_PENV_8 = _core_.PAPER_PENV_8
630PAPER_PENV_9 = _core_.PAPER_PENV_9
631PAPER_PENV_10 = _core_.PAPER_PENV_10
632PAPER_P16K_ROTATED = _core_.PAPER_P16K_ROTATED
633PAPER_P32K_ROTATED = _core_.PAPER_P32K_ROTATED
634PAPER_P32KBIG_ROTATED = _core_.PAPER_P32KBIG_ROTATED
635PAPER_PENV_1_ROTATED = _core_.PAPER_PENV_1_ROTATED
636PAPER_PENV_2_ROTATED = _core_.PAPER_PENV_2_ROTATED
637PAPER_PENV_3_ROTATED = _core_.PAPER_PENV_3_ROTATED
638PAPER_PENV_4_ROTATED = _core_.PAPER_PENV_4_ROTATED
639PAPER_PENV_5_ROTATED = _core_.PAPER_PENV_5_ROTATED
640PAPER_PENV_6_ROTATED = _core_.PAPER_PENV_6_ROTATED
641PAPER_PENV_7_ROTATED = _core_.PAPER_PENV_7_ROTATED
642PAPER_PENV_8_ROTATED = _core_.PAPER_PENV_8_ROTATED
643PAPER_PENV_9_ROTATED = _core_.PAPER_PENV_9_ROTATED
644PAPER_PENV_10_ROTATED = _core_.PAPER_PENV_10_ROTATED
54f9ee45
RD
645DUPLEX_SIMPLEX = _core_.DUPLEX_SIMPLEX
646DUPLEX_HORIZONTAL = _core_.DUPLEX_HORIZONTAL
647DUPLEX_VERTICAL = _core_.DUPLEX_VERTICAL
648ITEM_SEPARATOR = _core_.ITEM_SEPARATOR
649ITEM_NORMAL = _core_.ITEM_NORMAL
650ITEM_CHECK = _core_.ITEM_CHECK
651ITEM_RADIO = _core_.ITEM_RADIO
652ITEM_MAX = _core_.ITEM_MAX
653HT_NOWHERE = _core_.HT_NOWHERE
654HT_SCROLLBAR_FIRST = _core_.HT_SCROLLBAR_FIRST
655HT_SCROLLBAR_ARROW_LINE_1 = _core_.HT_SCROLLBAR_ARROW_LINE_1
656HT_SCROLLBAR_ARROW_LINE_2 = _core_.HT_SCROLLBAR_ARROW_LINE_2
657HT_SCROLLBAR_ARROW_PAGE_1 = _core_.HT_SCROLLBAR_ARROW_PAGE_1
658HT_SCROLLBAR_ARROW_PAGE_2 = _core_.HT_SCROLLBAR_ARROW_PAGE_2
659HT_SCROLLBAR_THUMB = _core_.HT_SCROLLBAR_THUMB
660HT_SCROLLBAR_BAR_1 = _core_.HT_SCROLLBAR_BAR_1
661HT_SCROLLBAR_BAR_2 = _core_.HT_SCROLLBAR_BAR_2
662HT_SCROLLBAR_LAST = _core_.HT_SCROLLBAR_LAST
663HT_WINDOW_OUTSIDE = _core_.HT_WINDOW_OUTSIDE
664HT_WINDOW_INSIDE = _core_.HT_WINDOW_INSIDE
665HT_WINDOW_VERT_SCROLLBAR = _core_.HT_WINDOW_VERT_SCROLLBAR
666HT_WINDOW_HORZ_SCROLLBAR = _core_.HT_WINDOW_HORZ_SCROLLBAR
667HT_WINDOW_CORNER = _core_.HT_WINDOW_CORNER
668HT_MAX = _core_.HT_MAX
669MOD_NONE = _core_.MOD_NONE
670MOD_ALT = _core_.MOD_ALT
671MOD_CONTROL = _core_.MOD_CONTROL
943e8dfd 672MOD_ALTGR = _core_.MOD_ALTGR
54f9ee45 673MOD_SHIFT = _core_.MOD_SHIFT
943e8dfd 674MOD_META = _core_.MOD_META
54f9ee45 675MOD_WIN = _core_.MOD_WIN
943e8dfd
RD
676MOD_CMD = _core_.MOD_CMD
677MOD_ALL = _core_.MOD_ALL
54f9ee45
RD
678UPDATE_UI_NONE = _core_.UPDATE_UI_NONE
679UPDATE_UI_RECURSE = _core_.UPDATE_UI_RECURSE
680UPDATE_UI_FROMIDLE = _core_.UPDATE_UI_FROMIDLE
994453b8
RD
681Layout_Default = _core_.Layout_Default
682Layout_LeftToRight = _core_.Layout_LeftToRight
683Layout_RightToLeft = _core_.Layout_RightToLeft
d14a1e28
RD
684#---------------------------------------------------------------------------
685
686class Object(object):
0df68c9f
RD
687 """
688 The base class for most wx objects, although in wxPython not
689 much functionality is needed nor exposed.
690 """
0085ce49
RD
691 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
692 def __init__(self): raise AttributeError, "No constructor defined"
693 __repr__ = _swig_repr
e811c8ce 694 def GetClassName(*args, **kwargs):
0df68c9f 695 """
a95a7133 696 GetClassName(self) -> String
e811c8ce 697
a95a7133 698 Returns the class name of the C++ class using wxRTTI.
0df68c9f 699 """
54f9ee45 700 return _core_.Object_GetClassName(*args, **kwargs)
e811c8ce
RD
701
702 def Destroy(*args, **kwargs):
0df68c9f 703 """
a95a7133 704 Destroy(self)
e811c8ce 705
0df68c9f
RD
706 Deletes the C++ object this Python object is a proxy for.
707 """
b39fe951
RD
708 args[0].this.own(False)
709 return _core_.Object_Destroy(*args, **kwargs)
e811c8ce 710
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
b08d67c2
RD
3850 def _getEvtType(self):
3851 """
3852 Make it easy to get to the default wxEventType typeID for this
3853 event binder.
3854 """
3855 return self.evtType[0]
3856
3857 typeId = property(_getEvtType)
3858
d14a1e28
RD
3859
3860 def __call__(self, *args):
3861 """
3862 For backwards compatibility with the old EVT_* functions.
3863 Should be called with either (window, func), (window, ID,
3864 func) or (window, ID1, ID2, func) parameters depending on the
3865 type of the event.
3866 """
3867 assert len(args) == 2 + self.expectedIDs
3868 id1 = wx.ID_ANY
3869 id2 = wx.ID_ANY
3870 target = args[0]
3871 if self.expectedIDs == 0:
3872 func = args[1]
3873 elif self.expectedIDs == 1:
3874 id1 = args[1]
3875 func = args[2]
3876 elif self.expectedIDs == 2:
3877 id1 = args[1]
3878 id2 = args[2]
3879 func = args[3]
3880 else:
3881 raise ValueError, "Unexpected number of IDs"
3882
3883 self.Bind(target, id1, id2, func)
3884
3885
3886# These two are square pegs that don't fit the PyEventBinder hole...
3887def EVT_COMMAND(win, id, cmd, func):
3888 win.Connect(id, -1, cmd, func)
3889def EVT_COMMAND_RANGE(win, id1, id2, cmd, func):
3890 win.Connect(id1, id2, cmd, func)
3891
3892
3893#---------------------------------------------------------------------------
3894
3895#---------------------------------------------------------------------------
3896
54f9ee45
RD
3897EVENT_PROPAGATE_NONE = _core_.EVENT_PROPAGATE_NONE
3898EVENT_PROPAGATE_MAX = _core_.EVENT_PROPAGATE_MAX
d14a1e28 3899
0085ce49 3900def NewEventType(*args):
2131d850 3901 """NewEventType() -> EventType"""
0085ce49 3902 return _core_.NewEventType(*args)
4976f996 3903wxEVT_ANY = _core_.wxEVT_ANY
54f9ee45
RD
3904wxEVT_NULL = _core_.wxEVT_NULL
3905wxEVT_FIRST = _core_.wxEVT_FIRST
3906wxEVT_USER_FIRST = _core_.wxEVT_USER_FIRST
3907wxEVT_COMMAND_BUTTON_CLICKED = _core_.wxEVT_COMMAND_BUTTON_CLICKED
3908wxEVT_COMMAND_CHECKBOX_CLICKED = _core_.wxEVT_COMMAND_CHECKBOX_CLICKED
3909wxEVT_COMMAND_CHOICE_SELECTED = _core_.wxEVT_COMMAND_CHOICE_SELECTED
3910wxEVT_COMMAND_LISTBOX_SELECTED = _core_.wxEVT_COMMAND_LISTBOX_SELECTED
3911wxEVT_COMMAND_LISTBOX_DOUBLECLICKED = _core_.wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
3912wxEVT_COMMAND_CHECKLISTBOX_TOGGLED = _core_.wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
3913wxEVT_COMMAND_MENU_SELECTED = _core_.wxEVT_COMMAND_MENU_SELECTED
3914wxEVT_COMMAND_TOOL_CLICKED = _core_.wxEVT_COMMAND_TOOL_CLICKED
3915wxEVT_COMMAND_SLIDER_UPDATED = _core_.wxEVT_COMMAND_SLIDER_UPDATED
3916wxEVT_COMMAND_RADIOBOX_SELECTED = _core_.wxEVT_COMMAND_RADIOBOX_SELECTED
3917wxEVT_COMMAND_RADIOBUTTON_SELECTED = _core_.wxEVT_COMMAND_RADIOBUTTON_SELECTED
3918wxEVT_COMMAND_SCROLLBAR_UPDATED = _core_.wxEVT_COMMAND_SCROLLBAR_UPDATED
3919wxEVT_COMMAND_VLBOX_SELECTED = _core_.wxEVT_COMMAND_VLBOX_SELECTED
3920wxEVT_COMMAND_COMBOBOX_SELECTED = _core_.wxEVT_COMMAND_COMBOBOX_SELECTED
3921wxEVT_COMMAND_TOOL_RCLICKED = _core_.wxEVT_COMMAND_TOOL_RCLICKED
3922wxEVT_COMMAND_TOOL_ENTER = _core_.wxEVT_COMMAND_TOOL_ENTER
3923wxEVT_LEFT_DOWN = _core_.wxEVT_LEFT_DOWN
3924wxEVT_LEFT_UP = _core_.wxEVT_LEFT_UP
3925wxEVT_MIDDLE_DOWN = _core_.wxEVT_MIDDLE_DOWN
3926wxEVT_MIDDLE_UP = _core_.wxEVT_MIDDLE_UP
3927wxEVT_RIGHT_DOWN = _core_.wxEVT_RIGHT_DOWN
3928wxEVT_RIGHT_UP = _core_.wxEVT_RIGHT_UP
3929wxEVT_MOTION = _core_.wxEVT_MOTION
3930wxEVT_ENTER_WINDOW = _core_.wxEVT_ENTER_WINDOW
3931wxEVT_LEAVE_WINDOW = _core_.wxEVT_LEAVE_WINDOW
3932wxEVT_LEFT_DCLICK = _core_.wxEVT_LEFT_DCLICK
3933wxEVT_MIDDLE_DCLICK = _core_.wxEVT_MIDDLE_DCLICK
3934wxEVT_RIGHT_DCLICK = _core_.wxEVT_RIGHT_DCLICK
3935wxEVT_SET_FOCUS = _core_.wxEVT_SET_FOCUS
3936wxEVT_KILL_FOCUS = _core_.wxEVT_KILL_FOCUS
3937wxEVT_CHILD_FOCUS = _core_.wxEVT_CHILD_FOCUS
3938wxEVT_MOUSEWHEEL = _core_.wxEVT_MOUSEWHEEL
3939wxEVT_NC_LEFT_DOWN = _core_.wxEVT_NC_LEFT_DOWN
3940wxEVT_NC_LEFT_UP = _core_.wxEVT_NC_LEFT_UP
3941wxEVT_NC_MIDDLE_DOWN = _core_.wxEVT_NC_MIDDLE_DOWN
3942wxEVT_NC_MIDDLE_UP = _core_.wxEVT_NC_MIDDLE_UP
3943wxEVT_NC_RIGHT_DOWN = _core_.wxEVT_NC_RIGHT_DOWN
3944wxEVT_NC_RIGHT_UP = _core_.wxEVT_NC_RIGHT_UP
3945wxEVT_NC_MOTION = _core_.wxEVT_NC_MOTION
3946wxEVT_NC_ENTER_WINDOW = _core_.wxEVT_NC_ENTER_WINDOW
3947wxEVT_NC_LEAVE_WINDOW = _core_.wxEVT_NC_LEAVE_WINDOW
3948wxEVT_NC_LEFT_DCLICK = _core_.wxEVT_NC_LEFT_DCLICK
3949wxEVT_NC_MIDDLE_DCLICK = _core_.wxEVT_NC_MIDDLE_DCLICK
3950wxEVT_NC_RIGHT_DCLICK = _core_.wxEVT_NC_RIGHT_DCLICK
3951wxEVT_CHAR = _core_.wxEVT_CHAR
3952wxEVT_CHAR_HOOK = _core_.wxEVT_CHAR_HOOK
3953wxEVT_NAVIGATION_KEY = _core_.wxEVT_NAVIGATION_KEY
3954wxEVT_KEY_DOWN = _core_.wxEVT_KEY_DOWN
3955wxEVT_KEY_UP = _core_.wxEVT_KEY_UP
3956wxEVT_HOTKEY = _core_.wxEVT_HOTKEY
3957wxEVT_SET_CURSOR = _core_.wxEVT_SET_CURSOR
3958wxEVT_SCROLL_TOP = _core_.wxEVT_SCROLL_TOP
3959wxEVT_SCROLL_BOTTOM = _core_.wxEVT_SCROLL_BOTTOM
3960wxEVT_SCROLL_LINEUP = _core_.wxEVT_SCROLL_LINEUP
3961wxEVT_SCROLL_LINEDOWN = _core_.wxEVT_SCROLL_LINEDOWN
3962wxEVT_SCROLL_PAGEUP = _core_.wxEVT_SCROLL_PAGEUP
3963wxEVT_SCROLL_PAGEDOWN = _core_.wxEVT_SCROLL_PAGEDOWN
3964wxEVT_SCROLL_THUMBTRACK = _core_.wxEVT_SCROLL_THUMBTRACK
3965wxEVT_SCROLL_THUMBRELEASE = _core_.wxEVT_SCROLL_THUMBRELEASE
4f433fef
RD
3966wxEVT_SCROLL_CHANGED = _core_.wxEVT_SCROLL_CHANGED
3967wxEVT_SCROLL_ENDSCROLL = wxEVT_SCROLL_CHANGED
54f9ee45
RD
3968wxEVT_SCROLLWIN_TOP = _core_.wxEVT_SCROLLWIN_TOP
3969wxEVT_SCROLLWIN_BOTTOM = _core_.wxEVT_SCROLLWIN_BOTTOM
3970wxEVT_SCROLLWIN_LINEUP = _core_.wxEVT_SCROLLWIN_LINEUP
3971wxEVT_SCROLLWIN_LINEDOWN = _core_.wxEVT_SCROLLWIN_LINEDOWN
3972wxEVT_SCROLLWIN_PAGEUP = _core_.wxEVT_SCROLLWIN_PAGEUP
3973wxEVT_SCROLLWIN_PAGEDOWN = _core_.wxEVT_SCROLLWIN_PAGEDOWN
3974wxEVT_SCROLLWIN_THUMBTRACK = _core_.wxEVT_SCROLLWIN_THUMBTRACK
3975wxEVT_SCROLLWIN_THUMBRELEASE = _core_.wxEVT_SCROLLWIN_THUMBRELEASE
3976wxEVT_SIZE = _core_.wxEVT_SIZE
3977wxEVT_MOVE = _core_.wxEVT_MOVE
3978wxEVT_CLOSE_WINDOW = _core_.wxEVT_CLOSE_WINDOW
3979wxEVT_END_SESSION = _core_.wxEVT_END_SESSION
3980wxEVT_QUERY_END_SESSION = _core_.wxEVT_QUERY_END_SESSION
3981wxEVT_ACTIVATE_APP = _core_.wxEVT_ACTIVATE_APP
54f9ee45
RD
3982wxEVT_ACTIVATE = _core_.wxEVT_ACTIVATE
3983wxEVT_CREATE = _core_.wxEVT_CREATE
3984wxEVT_DESTROY = _core_.wxEVT_DESTROY
3985wxEVT_SHOW = _core_.wxEVT_SHOW
3986wxEVT_ICONIZE = _core_.wxEVT_ICONIZE
3987wxEVT_MAXIMIZE = _core_.wxEVT_MAXIMIZE
3988wxEVT_MOUSE_CAPTURE_CHANGED = _core_.wxEVT_MOUSE_CAPTURE_CHANGED
34e0a3bb 3989wxEVT_MOUSE_CAPTURE_LOST = _core_.wxEVT_MOUSE_CAPTURE_LOST
54f9ee45
RD
3990wxEVT_PAINT = _core_.wxEVT_PAINT
3991wxEVT_ERASE_BACKGROUND = _core_.wxEVT_ERASE_BACKGROUND
3992wxEVT_NC_PAINT = _core_.wxEVT_NC_PAINT
3993wxEVT_PAINT_ICON = _core_.wxEVT_PAINT_ICON
3994wxEVT_MENU_OPEN = _core_.wxEVT_MENU_OPEN
3995wxEVT_MENU_CLOSE = _core_.wxEVT_MENU_CLOSE
3996wxEVT_MENU_HIGHLIGHT = _core_.wxEVT_MENU_HIGHLIGHT
3997wxEVT_CONTEXT_MENU = _core_.wxEVT_CONTEXT_MENU
3998wxEVT_SYS_COLOUR_CHANGED = _core_.wxEVT_SYS_COLOUR_CHANGED
3999wxEVT_DISPLAY_CHANGED = _core_.wxEVT_DISPLAY_CHANGED
4000wxEVT_SETTING_CHANGED = _core_.wxEVT_SETTING_CHANGED
4001wxEVT_QUERY_NEW_PALETTE = _core_.wxEVT_QUERY_NEW_PALETTE
4002wxEVT_PALETTE_CHANGED = _core_.wxEVT_PALETTE_CHANGED
4003wxEVT_DROP_FILES = _core_.wxEVT_DROP_FILES
4004wxEVT_DRAW_ITEM = _core_.wxEVT_DRAW_ITEM
4005wxEVT_MEASURE_ITEM = _core_.wxEVT_MEASURE_ITEM
4006wxEVT_COMPARE_ITEM = _core_.wxEVT_COMPARE_ITEM
4007wxEVT_INIT_DIALOG = _core_.wxEVT_INIT_DIALOG
4008wxEVT_IDLE = _core_.wxEVT_IDLE
4009wxEVT_UPDATE_UI = _core_.wxEVT_UPDATE_UI
4010wxEVT_SIZING = _core_.wxEVT_SIZING
4011wxEVT_MOVING = _core_.wxEVT_MOVING
88c6b281 4012wxEVT_HIBERNATE = _core_.wxEVT_HIBERNATE
2131d850
RD
4013wxEVT_COMMAND_TEXT_COPY = _core_.wxEVT_COMMAND_TEXT_COPY
4014wxEVT_COMMAND_TEXT_CUT = _core_.wxEVT_COMMAND_TEXT_CUT
4015wxEVT_COMMAND_TEXT_PASTE = _core_.wxEVT_COMMAND_TEXT_PASTE
54f9ee45
RD
4016wxEVT_COMMAND_LEFT_CLICK = _core_.wxEVT_COMMAND_LEFT_CLICK
4017wxEVT_COMMAND_LEFT_DCLICK = _core_.wxEVT_COMMAND_LEFT_DCLICK
4018wxEVT_COMMAND_RIGHT_CLICK = _core_.wxEVT_COMMAND_RIGHT_CLICK
4019wxEVT_COMMAND_RIGHT_DCLICK = _core_.wxEVT_COMMAND_RIGHT_DCLICK
4020wxEVT_COMMAND_SET_FOCUS = _core_.wxEVT_COMMAND_SET_FOCUS
4021wxEVT_COMMAND_KILL_FOCUS = _core_.wxEVT_COMMAND_KILL_FOCUS
4022wxEVT_COMMAND_ENTER = _core_.wxEVT_COMMAND_ENTER
d14a1e28
RD
4023#
4024# Create some event binders
4025EVT_SIZE = wx.PyEventBinder( wxEVT_SIZE )
4026EVT_SIZING = wx.PyEventBinder( wxEVT_SIZING )
4027EVT_MOVE = wx.PyEventBinder( wxEVT_MOVE )
4028EVT_MOVING = wx.PyEventBinder( wxEVT_MOVING )
4029EVT_CLOSE = wx.PyEventBinder( wxEVT_CLOSE_WINDOW )
4030EVT_END_SESSION = wx.PyEventBinder( wxEVT_END_SESSION )
4031EVT_QUERY_END_SESSION = wx.PyEventBinder( wxEVT_QUERY_END_SESSION )
4032EVT_PAINT = wx.PyEventBinder( wxEVT_PAINT )
4033EVT_NC_PAINT = wx.PyEventBinder( wxEVT_NC_PAINT )
4034EVT_ERASE_BACKGROUND = wx.PyEventBinder( wxEVT_ERASE_BACKGROUND )
4035EVT_CHAR = wx.PyEventBinder( wxEVT_CHAR )
4036EVT_KEY_DOWN = wx.PyEventBinder( wxEVT_KEY_DOWN )
4037EVT_KEY_UP = wx.PyEventBinder( wxEVT_KEY_UP )
704eda0c 4038EVT_HOTKEY = wx.PyEventBinder( wxEVT_HOTKEY, 1)
d14a1e28
RD
4039EVT_CHAR_HOOK = wx.PyEventBinder( wxEVT_CHAR_HOOK )
4040EVT_MENU_OPEN = wx.PyEventBinder( wxEVT_MENU_OPEN )
4041EVT_MENU_CLOSE = wx.PyEventBinder( wxEVT_MENU_CLOSE )
4042EVT_MENU_HIGHLIGHT = wx.PyEventBinder( wxEVT_MENU_HIGHLIGHT, 1)
4043EVT_MENU_HIGHLIGHT_ALL = wx.PyEventBinder( wxEVT_MENU_HIGHLIGHT )
4044EVT_SET_FOCUS = wx.PyEventBinder( wxEVT_SET_FOCUS )
4045EVT_KILL_FOCUS = wx.PyEventBinder( wxEVT_KILL_FOCUS )
4046EVT_CHILD_FOCUS = wx.PyEventBinder( wxEVT_CHILD_FOCUS )
4047EVT_ACTIVATE = wx.PyEventBinder( wxEVT_ACTIVATE )
4048EVT_ACTIVATE_APP = wx.PyEventBinder( wxEVT_ACTIVATE_APP )
704eda0c 4049EVT_HIBERNATE = wx.PyEventBinder( wxEVT_HIBERNATE )
d14a1e28
RD
4050EVT_END_SESSION = wx.PyEventBinder( wxEVT_END_SESSION )
4051EVT_QUERY_END_SESSION = wx.PyEventBinder( wxEVT_QUERY_END_SESSION )
4052EVT_DROP_FILES = wx.PyEventBinder( wxEVT_DROP_FILES )
4053EVT_INIT_DIALOG = wx.PyEventBinder( wxEVT_INIT_DIALOG )
4054EVT_SYS_COLOUR_CHANGED = wx.PyEventBinder( wxEVT_SYS_COLOUR_CHANGED )
4055EVT_DISPLAY_CHANGED = wx.PyEventBinder( wxEVT_DISPLAY_CHANGED )
4056EVT_SHOW = wx.PyEventBinder( wxEVT_SHOW )
4057EVT_MAXIMIZE = wx.PyEventBinder( wxEVT_MAXIMIZE )
4058EVT_ICONIZE = wx.PyEventBinder( wxEVT_ICONIZE )
4059EVT_NAVIGATION_KEY = wx.PyEventBinder( wxEVT_NAVIGATION_KEY )
4060EVT_PALETTE_CHANGED = wx.PyEventBinder( wxEVT_PALETTE_CHANGED )
4061EVT_QUERY_NEW_PALETTE = wx.PyEventBinder( wxEVT_QUERY_NEW_PALETTE )
4062EVT_WINDOW_CREATE = wx.PyEventBinder( wxEVT_CREATE )
4063EVT_WINDOW_DESTROY = wx.PyEventBinder( wxEVT_DESTROY )
4064EVT_SET_CURSOR = wx.PyEventBinder( wxEVT_SET_CURSOR )
4065EVT_MOUSE_CAPTURE_CHANGED = wx.PyEventBinder( wxEVT_MOUSE_CAPTURE_CHANGED )
34e0a3bb 4066EVT_MOUSE_CAPTURE_LOST = wx.PyEventBinder( wxEVT_MOUSE_CAPTURE_LOST )
d14a1e28
RD
4067
4068EVT_LEFT_DOWN = wx.PyEventBinder( wxEVT_LEFT_DOWN )
4069EVT_LEFT_UP = wx.PyEventBinder( wxEVT_LEFT_UP )
4070EVT_MIDDLE_DOWN = wx.PyEventBinder( wxEVT_MIDDLE_DOWN )
4071EVT_MIDDLE_UP = wx.PyEventBinder( wxEVT_MIDDLE_UP )
4072EVT_RIGHT_DOWN = wx.PyEventBinder( wxEVT_RIGHT_DOWN )
4073EVT_RIGHT_UP = wx.PyEventBinder( wxEVT_RIGHT_UP )
4074EVT_MOTION = wx.PyEventBinder( wxEVT_MOTION )
4075EVT_LEFT_DCLICK = wx.PyEventBinder( wxEVT_LEFT_DCLICK )
4076EVT_MIDDLE_DCLICK = wx.PyEventBinder( wxEVT_MIDDLE_DCLICK )
4077EVT_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_RIGHT_DCLICK )
4078EVT_LEAVE_WINDOW = wx.PyEventBinder( wxEVT_LEAVE_WINDOW )
4079EVT_ENTER_WINDOW = wx.PyEventBinder( wxEVT_ENTER_WINDOW )
4080EVT_MOUSEWHEEL = wx.PyEventBinder( wxEVT_MOUSEWHEEL )
4081
4082EVT_MOUSE_EVENTS = wx.PyEventBinder([ wxEVT_LEFT_DOWN,
4083 wxEVT_LEFT_UP,
4084 wxEVT_MIDDLE_DOWN,
4085 wxEVT_MIDDLE_UP,
4086 wxEVT_RIGHT_DOWN,
4087 wxEVT_RIGHT_UP,
4088 wxEVT_MOTION,
4089 wxEVT_LEFT_DCLICK,
4090 wxEVT_MIDDLE_DCLICK,
4091 wxEVT_RIGHT_DCLICK,
4092 wxEVT_ENTER_WINDOW,
4093 wxEVT_LEAVE_WINDOW,
4094 wxEVT_MOUSEWHEEL
4095 ])
4096
4097
4098# Scrolling from wxWindow (sent to wxScrolledWindow)
704eda0c 4099EVT_SCROLLWIN = wx.PyEventBinder([ wxEVT_SCROLLWIN_TOP,
d14a1e28
RD
4100 wxEVT_SCROLLWIN_BOTTOM,
4101 wxEVT_SCROLLWIN_LINEUP,
4102 wxEVT_SCROLLWIN_LINEDOWN,
704eda0c 4103 wxEVT_SCROLLWIN_PAGEUP,
d14a1e28
RD
4104 wxEVT_SCROLLWIN_PAGEDOWN,
4105 wxEVT_SCROLLWIN_THUMBTRACK,
4106 wxEVT_SCROLLWIN_THUMBRELEASE,
4107 ])
4108
4109EVT_SCROLLWIN_TOP = wx.PyEventBinder( wxEVT_SCROLLWIN_TOP )
4110EVT_SCROLLWIN_BOTTOM = wx.PyEventBinder( wxEVT_SCROLLWIN_BOTTOM )
4111EVT_SCROLLWIN_LINEUP = wx.PyEventBinder( wxEVT_SCROLLWIN_LINEUP )
4112EVT_SCROLLWIN_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLLWIN_LINEDOWN )
4113EVT_SCROLLWIN_PAGEUP = wx.PyEventBinder( wxEVT_SCROLLWIN_PAGEUP )
4114EVT_SCROLLWIN_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLLWIN_PAGEDOWN )
4115EVT_SCROLLWIN_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLLWIN_THUMBTRACK )
4116EVT_SCROLLWIN_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLLWIN_THUMBRELEASE )
4117
27fb7603 4118# Scrolling from wx.Slider and wx.ScrollBar
704eda0c
RD
4119EVT_SCROLL = wx.PyEventBinder([ wxEVT_SCROLL_TOP,
4120 wxEVT_SCROLL_BOTTOM,
4121 wxEVT_SCROLL_LINEUP,
4122 wxEVT_SCROLL_LINEDOWN,
4123 wxEVT_SCROLL_PAGEUP,
4124 wxEVT_SCROLL_PAGEDOWN,
4125 wxEVT_SCROLL_THUMBTRACK,
4126 wxEVT_SCROLL_THUMBRELEASE,
4f433fef 4127 wxEVT_SCROLL_CHANGED,
d14a1e28
RD
4128 ])
4129
4130EVT_SCROLL_TOP = wx.PyEventBinder( wxEVT_SCROLL_TOP )
4131EVT_SCROLL_BOTTOM = wx.PyEventBinder( wxEVT_SCROLL_BOTTOM )
4132EVT_SCROLL_LINEUP = wx.PyEventBinder( wxEVT_SCROLL_LINEUP )
4133EVT_SCROLL_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLL_LINEDOWN )
4134EVT_SCROLL_PAGEUP = wx.PyEventBinder( wxEVT_SCROLL_PAGEUP )
4135EVT_SCROLL_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLL_PAGEDOWN )
4136EVT_SCROLL_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLL_THUMBTRACK )
4137EVT_SCROLL_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE )
4f433fef
RD
4138EVT_SCROLL_CHANGED = wx.PyEventBinder( wxEVT_SCROLL_CHANGED )
4139EVT_SCROLL_ENDSCROLL = EVT_SCROLL_CHANGED
704eda0c 4140
27fb7603 4141# Scrolling from wx.Slider and wx.ScrollBar, with an id
704eda0c
RD
4142EVT_COMMAND_SCROLL = wx.PyEventBinder([ wxEVT_SCROLL_TOP,
4143 wxEVT_SCROLL_BOTTOM,
4144 wxEVT_SCROLL_LINEUP,
4145 wxEVT_SCROLL_LINEDOWN,
4146 wxEVT_SCROLL_PAGEUP,
4147 wxEVT_SCROLL_PAGEDOWN,
4148 wxEVT_SCROLL_THUMBTRACK,
d14a1e28 4149 wxEVT_SCROLL_THUMBRELEASE,
4f433fef 4150 wxEVT_SCROLL_CHANGED,
d14a1e28
RD
4151 ], 1)
4152
4153EVT_COMMAND_SCROLL_TOP = wx.PyEventBinder( wxEVT_SCROLL_TOP, 1)
4154EVT_COMMAND_SCROLL_BOTTOM = wx.PyEventBinder( wxEVT_SCROLL_BOTTOM, 1)
4155EVT_COMMAND_SCROLL_LINEUP = wx.PyEventBinder( wxEVT_SCROLL_LINEUP, 1)
4156EVT_COMMAND_SCROLL_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLL_LINEDOWN, 1)
4157EVT_COMMAND_SCROLL_PAGEUP = wx.PyEventBinder( wxEVT_SCROLL_PAGEUP, 1)
4158EVT_COMMAND_SCROLL_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLL_PAGEDOWN, 1)
4159EVT_COMMAND_SCROLL_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLL_THUMBTRACK, 1)
4160EVT_COMMAND_SCROLL_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE, 1)
4f433fef
RD
4161EVT_COMMAND_SCROLL_CHANGED = wx.PyEventBinder( wxEVT_SCROLL_CHANGED, 1)
4162EVT_COMMAND_SCROLL_ENDSCROLL = EVT_COMMAND_SCROLL_CHANGED
d14a1e28 4163
d14a1e28
RD
4164EVT_BUTTON = wx.PyEventBinder( wxEVT_COMMAND_BUTTON_CLICKED, 1)
4165EVT_CHECKBOX = wx.PyEventBinder( wxEVT_COMMAND_CHECKBOX_CLICKED, 1)
4166EVT_CHOICE = wx.PyEventBinder( wxEVT_COMMAND_CHOICE_SELECTED, 1)
4167EVT_LISTBOX = wx.PyEventBinder( wxEVT_COMMAND_LISTBOX_SELECTED, 1)
4168EVT_LISTBOX_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, 1)
4169EVT_MENU = wx.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED, 1)
4170EVT_MENU_RANGE = wx.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED, 2)
4171EVT_SLIDER = wx.PyEventBinder( wxEVT_COMMAND_SLIDER_UPDATED, 1)
4172EVT_RADIOBOX = wx.PyEventBinder( wxEVT_COMMAND_RADIOBOX_SELECTED, 1)
4173EVT_RADIOBUTTON = wx.PyEventBinder( wxEVT_COMMAND_RADIOBUTTON_SELECTED, 1)
4174
4175EVT_SCROLLBAR = wx.PyEventBinder( wxEVT_COMMAND_SCROLLBAR_UPDATED, 1)
4176EVT_VLBOX = wx.PyEventBinder( wxEVT_COMMAND_VLBOX_SELECTED, 1)
4177EVT_COMBOBOX = wx.PyEventBinder( wxEVT_COMMAND_COMBOBOX_SELECTED, 1)
4178EVT_TOOL = wx.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED, 1)
4179EVT_TOOL_RANGE = wx.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED, 2)
4180EVT_TOOL_RCLICKED = wx.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED, 1)
4181EVT_TOOL_RCLICKED_RANGE = wx.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED, 2)
4182EVT_TOOL_ENTER = wx.PyEventBinder( wxEVT_COMMAND_TOOL_ENTER, 1)
4183EVT_CHECKLISTBOX = wx.PyEventBinder( wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, 1)
4184
4185
4186EVT_COMMAND_LEFT_CLICK = wx.PyEventBinder( wxEVT_COMMAND_LEFT_CLICK, 1)
4187EVT_COMMAND_LEFT_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_LEFT_DCLICK, 1)
4188EVT_COMMAND_RIGHT_CLICK = wx.PyEventBinder( wxEVT_COMMAND_RIGHT_CLICK, 1)
4189EVT_COMMAND_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_RIGHT_DCLICK, 1)
4190EVT_COMMAND_SET_FOCUS = wx.PyEventBinder( wxEVT_COMMAND_SET_FOCUS, 1)
4191EVT_COMMAND_KILL_FOCUS = wx.PyEventBinder( wxEVT_COMMAND_KILL_FOCUS, 1)
4192EVT_COMMAND_ENTER = wx.PyEventBinder( wxEVT_COMMAND_ENTER, 1)
4193
4194EVT_IDLE = wx.PyEventBinder( wxEVT_IDLE )
4195
4196EVT_UPDATE_UI = wx.PyEventBinder( wxEVT_UPDATE_UI, 1)
4197EVT_UPDATE_UI_RANGE = wx.PyEventBinder( wxEVT_UPDATE_UI, 2)
4198
4199EVT_CONTEXT_MENU = wx.PyEventBinder( wxEVT_CONTEXT_MENU )
4200
2131d850
RD
4201EVT_TEXT_CUT = wx.PyEventBinder( wxEVT_COMMAND_TEXT_CUT )
4202EVT_TEXT_COPY = wx.PyEventBinder( wxEVT_COMMAND_TEXT_COPY )
4203EVT_TEXT_PASTE = wx.PyEventBinder( wxEVT_COMMAND_TEXT_PASTE )
d14a1e28
RD
4204
4205
4206#---------------------------------------------------------------------------
4207
4208class Event(Object):
27fb7603
RD
4209 """
4210 An event is a structure holding information about an event passed to a
4211 callback or member function. wx.Event is an abstract base class for
4212 other event classes
4213 """
0085ce49
RD
4214 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4215 def __init__(self): raise AttributeError, "No constructor defined"
4216 __repr__ = _swig_repr
4217 __swig_destroy__ = _core_.delete_Event
4218 __del__ = lambda self : None;
e811c8ce 4219 def SetEventType(*args, **kwargs):
27fb7603 4220 """
2131d850 4221 SetEventType(self, EventType typ)
27fb7603
RD
4222
4223 Sets the specific type of the event.
4224 """
54f9ee45 4225 return _core_.Event_SetEventType(*args, **kwargs)
e811c8ce
RD
4226
4227 def GetEventType(*args, **kwargs):
27fb7603 4228 """
2131d850 4229 GetEventType(self) -> EventType
27fb7603
RD
4230
4231 Returns the identifier of the given event type, such as
4232 ``wxEVT_COMMAND_BUTTON_CLICKED``.
4233 """
54f9ee45 4234 return _core_.Event_GetEventType(*args, **kwargs)
e811c8ce
RD
4235
4236 def GetEventObject(*args, **kwargs):
27fb7603
RD
4237 """
4238 GetEventObject(self) -> Object
4239
4240 Returns the object (usually a window) associated with the event, if
4241 any.
4242 """
54f9ee45 4243 return _core_.Event_GetEventObject(*args, **kwargs)
e811c8ce
RD
4244
4245 def SetEventObject(*args, **kwargs):
27fb7603
RD
4246 """
4247 SetEventObject(self, Object obj)
4248
4249 Sets the originating object, or in other words, obj is normally the
4250 object that is sending the event.
4251 """
54f9ee45 4252 return _core_.Event_SetEventObject(*args, **kwargs)
e811c8ce
RD
4253
4254 def GetTimestamp(*args, **kwargs):
a95a7133 4255 """GetTimestamp(self) -> long"""
54f9ee45 4256 return _core_.Event_GetTimestamp(*args, **kwargs)
e811c8ce
RD
4257
4258 def SetTimestamp(*args, **kwargs):
a95a7133 4259 """SetTimestamp(self, long ts=0)"""
54f9ee45 4260 return _core_.Event_SetTimestamp(*args, **kwargs)
e811c8ce
RD
4261
4262 def GetId(*args, **kwargs):
27fb7603
RD
4263 """
4264 GetId(self) -> int
4265
4266 Returns the identifier associated with this event, such as a button
4267 command id.
4268 """
54f9ee45 4269 return _core_.Event_GetId(*args, **kwargs)
e811c8ce
RD
4270
4271 def SetId(*args, **kwargs):
27fb7603
RD
4272 """
4273 SetId(self, int Id)
4274
4275 Set's the ID for the event. This is usually the ID of the window that
4276 is sending the event, but it can also be a command id from a menu
4277 item, etc.
4278 """
54f9ee45 4279 return _core_.Event_SetId(*args, **kwargs)
e811c8ce
RD
4280
4281 def IsCommandEvent(*args, **kwargs):
27fb7603
RD
4282 """
4283 IsCommandEvent(self) -> bool
4284
4285 Returns true if the event is or is derived from `wx.CommandEvent` else
4286 it returns false. Note: Exists only for optimization purposes.
4287 """
54f9ee45 4288 return _core_.Event_IsCommandEvent(*args, **kwargs)
e811c8ce
RD
4289
4290 def Skip(*args, **kwargs):
51b83b37
RD
4291 """
4292 Skip(self, bool skip=True)
4293
6b449b19
RD
4294 This method can be used inside an event handler to control whether
4295 further event handlers bound to this event will be called after the
4296 current one returns. Without Skip() (or equivalently if Skip(False) is
4297 used), the event will not be processed any more. If Skip(True) is
4298 called, the event processing system continues searching for a further
4299 handler function for this event, even though it has been processed
4300 already in the current handler.
51b83b37 4301 """
54f9ee45 4302 return _core_.Event_Skip(*args, **kwargs)
e811c8ce
RD
4303
4304 def GetSkipped(*args, **kwargs):
27fb7603
RD
4305 """
4306 GetSkipped(self) -> bool
4307
4308 Returns true if the event handler should be skipped, false otherwise.
4309 :see: `Skip`
4310 """
54f9ee45 4311 return _core_.Event_GetSkipped(*args, **kwargs)
e811c8ce
RD
4312
4313 def ShouldPropagate(*args, **kwargs):
27fb7603
RD
4314 """
4315 ShouldPropagate(self) -> bool
4316
4317 Test if this event should be propagated to the parent window or not,
4318 i.e. if the propagation level is currently greater than 0.
4319 """
54f9ee45 4320 return _core_.Event_ShouldPropagate(*args, **kwargs)
e811c8ce
RD
4321
4322 def StopPropagation(*args, **kwargs):
27fb7603
RD
4323 """
4324 StopPropagation(self) -> int
4325
4326 Stop the event from propagating to its parent window. Returns the old
4327 propagation level value which may be later passed to
4328 `ResumePropagation` to allow propagating the event again.
4329 """
54f9ee45 4330 return _core_.Event_StopPropagation(*args, **kwargs)
e811c8ce
RD
4331
4332 def ResumePropagation(*args, **kwargs):
27fb7603
RD
4333 """
4334 ResumePropagation(self, int propagationLevel)
4335
4336 Resume the event propagation by restoring the propagation level. (For
4337 example, you can use the value returned by an earlier call to
4338 `StopPropagation`.)
4339
4340 """
54f9ee45 4341 return _core_.Event_ResumePropagation(*args, **kwargs)
e811c8ce
RD
4342
4343 def Clone(*args, **kwargs):
a95a7133 4344 """Clone(self) -> Event"""
54f9ee45 4345 return _core_.Event_Clone(*args, **kwargs)
e811c8ce 4346
97ab0f6a
RD
4347 EventObject = property(GetEventObject,SetEventObject,doc="See `GetEventObject` and `SetEventObject`")
4348 EventType = property(GetEventType,SetEventType,doc="See `GetEventType` and `SetEventType`")
4349 Id = property(GetId,SetId,doc="See `GetId` and `SetId`")
4350 Skipped = property(GetSkipped,doc="See `GetSkipped`")
4351 Timestamp = property(GetTimestamp,SetTimestamp,doc="See `GetTimestamp` and `SetTimestamp`")
2131d850 4352_core_.Event_swigregister(Event)
d14a1e28
RD
4353
4354#---------------------------------------------------------------------------
4355
4356class PropagationDisabler(object):
27fb7603
RD
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 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4363 __repr__ = _swig_repr
4364 def __init__(self, *args, **kwargs):
27fb7603
RD
4365 """
4366 __init__(self, Event event) -> PropagationDisabler
4367
4368 Helper class to temporarily change an event not to propagate. Simply
4369 create an instance of this class and then whe it is destroyed the
4370 propogation of the event will be restored.
4371 """
0085ce49
RD
4372 _core_.PropagationDisabler_swiginit(self,_core_.new_PropagationDisabler(*args, **kwargs))
4373 __swig_destroy__ = _core_.delete_PropagationDisabler
4374 __del__ = lambda self : None;
2131d850 4375_core_.PropagationDisabler_swigregister(PropagationDisabler)
d14a1e28
RD
4376
4377class PropagateOnce(object):
27fb7603
RD
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 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4384 __repr__ = _swig_repr
4385 def __init__(self, *args, **kwargs):
27fb7603
RD
4386 """
4387 __init__(self, Event event) -> PropagateOnce
4388
4389 A helper class that will temporarily lower propagation level of an
4390 event. Simply create an instance of this class and then whe it is
4391 destroyed the propogation of the event will be restored.
4392 """
0085ce49
RD
4393 _core_.PropagateOnce_swiginit(self,_core_.new_PropagateOnce(*args, **kwargs))
4394 __swig_destroy__ = _core_.delete_PropagateOnce
4395 __del__ = lambda self : None;
2131d850 4396_core_.PropagateOnce_swigregister(PropagateOnce)
d14a1e28
RD
4397
4398#---------------------------------------------------------------------------
4399
4400class CommandEvent(Event):
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
RD
4406 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4407 __repr__ = _swig_repr
4408 def __init__(self, *args, **kwargs):
27fb7603 4409 """
2131d850 4410 __init__(self, EventType commandType=wxEVT_NULL, int winid=0) -> CommandEvent
27fb7603
RD
4411
4412 This event class contains information about command events, which
4413 originate from a variety of simple controls, as well as menus and
4414 toolbars.
4415 """
0085ce49 4416 _core_.CommandEvent_swiginit(self,_core_.new_CommandEvent(*args, **kwargs))
e811c8ce 4417 def GetSelection(*args, **kwargs):
27fb7603
RD
4418 """
4419 GetSelection(self) -> int
4420
4421 Returns item index for a listbox or choice selection event (not valid
4422 for a deselection).
4423 """
54f9ee45 4424 return _core_.CommandEvent_GetSelection(*args, **kwargs)
e811c8ce
RD
4425
4426 def SetString(*args, **kwargs):
a95a7133 4427 """SetString(self, String s)"""
54f9ee45 4428 return _core_.CommandEvent_SetString(*args, **kwargs)
e811c8ce
RD
4429
4430 def GetString(*args, **kwargs):
27fb7603
RD
4431 """
4432 GetString(self) -> String
4433
4434 Returns item string for a listbox or choice selection event (not valid
4435 for a deselection).
4436 """
54f9ee45 4437 return _core_.CommandEvent_GetString(*args, **kwargs)
e811c8ce
RD
4438
4439 def IsChecked(*args, **kwargs):
27fb7603
RD
4440 """
4441 IsChecked(self) -> bool
4442
4443 This method can be used with checkbox and menu events: for the
4444 checkboxes, the method returns true for a selection event and false
4445 for a deselection one. For the menu events, this method indicates if
4446 the menu item just has become checked or unchecked (and thus only
4447 makes sense for checkable menu items).
4448 """
54f9ee45 4449 return _core_.CommandEvent_IsChecked(*args, **kwargs)
e811c8ce 4450
242b7b46 4451 Checked = IsChecked
e811c8ce 4452 def IsSelection(*args, **kwargs):
27fb7603
RD
4453 """
4454 IsSelection(self) -> bool
4455
4456 For a listbox or similar event, returns true if it is a selection,
4457 false if it is a deselection.
4458 """
54f9ee45 4459 return _core_.CommandEvent_IsSelection(*args, **kwargs)
e811c8ce
RD
4460
4461 def SetExtraLong(*args, **kwargs):
a95a7133 4462 """SetExtraLong(self, long extraLong)"""
54f9ee45 4463 return _core_.CommandEvent_SetExtraLong(*args, **kwargs)
e811c8ce
RD
4464
4465 def GetExtraLong(*args, **kwargs):
27fb7603
RD
4466 """
4467 GetExtraLong(self) -> long
4468
5ba5649b
RD
4469 Returns extra information dependant on the event objects type. If the
4470 event comes from a listbox selection, it is a boolean determining
4471 whether the event was a selection (true) or a deselection (false). A
4472 listbox deselection only occurs for multiple-selection boxes, and in
4473 this case the index and string values are indeterminate and the
4474 listbox must be examined by the application.
27fb7603 4475 """
54f9ee45 4476 return _core_.CommandEvent_GetExtraLong(*args, **kwargs)
e811c8ce
RD
4477
4478 def SetInt(*args, **kwargs):
a95a7133 4479 """SetInt(self, int i)"""
54f9ee45 4480 return _core_.CommandEvent_SetInt(*args, **kwargs)
e811c8ce
RD
4481
4482 def GetInt(*args, **kwargs):
27fb7603 4483 """
01f6b6d3 4484 GetInt(self) -> int
27fb7603 4485
5ba5649b
RD
4486 Returns the integer identifier corresponding to a listbox, choice or
4487 radiobox selection (only if the event was a selection, not a
4488 deselection), or a boolean value representing the value of a checkbox.
27fb7603 4489 """
54f9ee45 4490 return _core_.CommandEvent_GetInt(*args, **kwargs)
e811c8ce 4491
0085ce49
RD
4492 def GetClientData(*args, **kwargs):
4493 """
4494 GetClientData(self) -> PyObject
4495
4496 Returns the client data object for a listbox or choice selection event, (if any.)
4497 """
4498 return _core_.CommandEvent_GetClientData(*args, **kwargs)
4499
4500 def SetClientData(*args, **kwargs):
4501 """
4502 SetClientData(self, PyObject clientData)
4503
4504 Associate the given client data with the item at position n.
4505 """
4506 return _core_.CommandEvent_SetClientData(*args, **kwargs)
4507
4508 GetClientObject = GetClientData
4509 SetClientObject = SetClientData
4510
e811c8ce 4511 def Clone(*args, **kwargs):
a95a7133 4512 """Clone(self) -> Event"""
54f9ee45 4513 return _core_.CommandEvent_Clone(*args, **kwargs)
e811c8ce 4514
2bf58437
RD
4515 ClientData = property(GetClientData,SetClientData,doc="See `GetClientData` and `SetClientData`")
4516 ClientObject = property(GetClientObject,SetClientObject,doc="See `GetClientObject` and `SetClientObject`")
4517 ExtraLong = property(GetExtraLong,SetExtraLong,doc="See `GetExtraLong` and `SetExtraLong`")
4518 Int = property(GetInt,SetInt,doc="See `GetInt` and `SetInt`")
4519 Selection = property(GetSelection,doc="See `GetSelection`")
4520 String = property(GetString,SetString,doc="See `GetString` and `SetString`")
2131d850 4521_core_.CommandEvent_swigregister(CommandEvent)
d14a1e28
RD
4522
4523#---------------------------------------------------------------------------
4524
4525class NotifyEvent(CommandEvent):
27fb7603
RD
4526 """
4527 An instance of this class (or one of its derived classes) is sent from
4528 a control when the control's state is being changed and the control
4529 allows that change to be prevented from happening. The event handler
4530 can call `Veto` or `Allow` to tell the control what to do.
4531 """
0085ce49
RD
4532 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4533 __repr__ = _swig_repr
4534 def __init__(self, *args, **kwargs):
27fb7603 4535 """
2131d850 4536 __init__(self, EventType commandType=wxEVT_NULL, int winid=0) -> NotifyEvent
27fb7603
RD
4537
4538 An instance of this class (or one of its derived classes) is sent from
4539 a control when the control's state is being changed and the control
4540 allows that change to be prevented from happening. The event handler
4541 can call `Veto` or `Allow` to tell the control what to do.
4542 """
0085ce49 4543 _core_.NotifyEvent_swiginit(self,_core_.new_NotifyEvent(*args, **kwargs))
e811c8ce 4544 def Veto(*args, **kwargs):
27fb7603
RD
4545 """
4546 Veto(self)
4547
4548 Prevents the change announced by this event from happening.
4549
4550 It is in general a good idea to notify the user about the reasons for
4551 vetoing the change because otherwise the applications behaviour (which
4552 just refuses to do what the user wants) might be quite surprising.
4553 """
54f9ee45 4554 return _core_.NotifyEvent_Veto(*args, **kwargs)
e811c8ce
RD
4555
4556 def Allow(*args, **kwargs):
27fb7603
RD
4557 """
4558 Allow(self)
4559
4560 This is the opposite of `Veto`: it explicitly allows the event to be
4561 processed. For most events it is not necessary to call this method as
4562 the events are allowed anyhow but some are forbidden by default (this
4563 will be mentioned in the corresponding event description).
4564 """
54f9ee45 4565 return _core_.NotifyEvent_Allow(*args, **kwargs)
e811c8ce
RD
4566
4567 def IsAllowed(*args, **kwargs):
27fb7603
RD
4568 """
4569 IsAllowed(self) -> bool
4570
4571 Returns true if the change is allowed (`Veto` hasn't been called) or
4572 false otherwise (if it was).
4573 """
54f9ee45 4574 return _core_.NotifyEvent_IsAllowed(*args, **kwargs)
e811c8ce 4575
2131d850 4576_core_.NotifyEvent_swigregister(NotifyEvent)
d14a1e28
RD
4577
4578#---------------------------------------------------------------------------
4579
4580class ScrollEvent(CommandEvent):
27fb7603
RD
4581 """
4582 A scroll event holds information about events sent from stand-alone
4583 scrollbars and sliders. Note that scrolled windows do not send
4584 instnaces of this event class, but send the `wx.ScrollWinEvent`
4585 instead.
4586 """
0085ce49
RD
4587 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4588 __repr__ = _swig_repr
4589 def __init__(self, *args, **kwargs):
0df68c9f 4590 """
2131d850 4591 __init__(self, EventType commandType=wxEVT_NULL, int winid=0, int pos=0,
0df68c9f
RD
4592 int orient=0) -> ScrollEvent
4593 """
0085ce49 4594 _core_.ScrollEvent_swiginit(self,_core_.new_ScrollEvent(*args, **kwargs))
e811c8ce 4595 def GetOrientation(*args, **kwargs):
27fb7603
RD
4596 """
4597 GetOrientation(self) -> int
4598
4599 Returns wx.HORIZONTAL or wx.VERTICAL, depending on the orientation of
4600 the scrollbar.
4601 """
54f9ee45 4602 return _core_.ScrollEvent_GetOrientation(*args, **kwargs)
e811c8ce
RD
4603
4604 def GetPosition(*args, **kwargs):
27fb7603
RD
4605 """
4606 GetPosition(self) -> int
4607
4608 Returns the position of the scrollbar.
4609 """
54f9ee45 4610 return _core_.ScrollEvent_GetPosition(*args, **kwargs)
e811c8ce
RD
4611
4612 def SetOrientation(*args, **kwargs):
a95a7133 4613 """SetOrientation(self, int orient)"""
54f9ee45 4614 return _core_.ScrollEvent_SetOrientation(*args, **kwargs)
e811c8ce
RD
4615
4616 def SetPosition(*args, **kwargs):
a95a7133 4617 """SetPosition(self, int pos)"""
54f9ee45 4618 return _core_.ScrollEvent_SetPosition(*args, **kwargs)
e811c8ce 4619
33d6fd3b
RD
4620 Orientation = property(GetOrientation,SetOrientation,doc="See `GetOrientation` and `SetOrientation`")
4621 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
2131d850 4622_core_.ScrollEvent_swigregister(ScrollEvent)
d14a1e28
RD
4623
4624#---------------------------------------------------------------------------
4625
4626class ScrollWinEvent(Event):
27fb7603
RD
4627 """
4628 A wx.ScrollWinEvent holds information about scrolling and is sent from
4629 scrolling windows.
4630 """
0085ce49
RD
4631 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4632 __repr__ = _swig_repr
4633 def __init__(self, *args, **kwargs):
27fb7603 4634 """
2131d850 4635 __init__(self, EventType commandType=wxEVT_NULL, int pos=0, int orient=0) -> ScrollWinEvent
27fb7603
RD
4636
4637 A wx.ScrollWinEvent holds information about scrolling and is sent from
4638 scrolling windows.
4639 """
0085ce49 4640 _core_.ScrollWinEvent_swiginit(self,_core_.new_ScrollWinEvent(*args, **kwargs))
e811c8ce 4641 def GetOrientation(*args, **kwargs):
27fb7603
RD
4642 """
4643 GetOrientation(self) -> int
4644
4645 Returns wx.HORIZONTAL or wx.VERTICAL, depending on the orientation of
4646 the scrollbar.
4647 """
54f9ee45 4648 return _core_.ScrollWinEvent_GetOrientation(*args, **kwargs)
e811c8ce
RD
4649
4650 def GetPosition(*args, **kwargs):
27fb7603
RD
4651 """
4652 GetPosition(self) -> int
4653
4654 Returns the position of the scrollbar for the thumb track and release
4655 events. Note that this field can't be used for the other events, you
4656 need to query the window itself for the current position in that case.
4657 """
54f9ee45 4658 return _core_.ScrollWinEvent_GetPosition(*args, **kwargs)
e811c8ce
RD
4659
4660 def SetOrientation(*args, **kwargs):
a95a7133 4661 """SetOrientation(self, int orient)"""
54f9ee45 4662 return _core_.ScrollWinEvent_SetOrientation(*args, **kwargs)
e811c8ce
RD
4663
4664 def SetPosition(*args, **kwargs):
a95a7133 4665 """SetPosition(self, int pos)"""
54f9ee45 4666 return _core_.ScrollWinEvent_SetPosition(*args, **kwargs)
e811c8ce 4667
33d6fd3b
RD
4668 Orientation = property(GetOrientation,SetOrientation,doc="See `GetOrientation` and `SetOrientation`")
4669 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
2131d850 4670_core_.ScrollWinEvent_swigregister(ScrollWinEvent)
d14a1e28
RD
4671
4672#---------------------------------------------------------------------------
4673
54f9ee45
RD
4674MOUSE_BTN_ANY = _core_.MOUSE_BTN_ANY
4675MOUSE_BTN_NONE = _core_.MOUSE_BTN_NONE
4676MOUSE_BTN_LEFT = _core_.MOUSE_BTN_LEFT
4677MOUSE_BTN_MIDDLE = _core_.MOUSE_BTN_MIDDLE
4678MOUSE_BTN_RIGHT = _core_.MOUSE_BTN_RIGHT
d14a1e28 4679class MouseEvent(Event):
27fb7603
RD
4680 """
4681 This event class contains information about the events generated by
4682 the mouse: they include mouse buttons press and release events and
4683 mouse move events.
4684
4685 All mouse events involving the buttons use ``wx.MOUSE_BTN_LEFT`` for
4686 the left mouse button, ``wx.MOUSE_BTN_MIDDLE`` for the middle one and
4687 ``wx.MOUSE_BTN_RIGHT`` for the right one. Note that not all mice have
4688 a middle button so a portable application should avoid relying on the
4689 events from it.
4690
4691 Note the difference between methods like `LeftDown` and `LeftIsDown`:
4692 the former returns true when the event corresponds to the left mouse
4693 button click while the latter returns true if the left mouse button is
4694 currently being pressed. For example, when the user is dragging the
4695 mouse you can use `LeftIsDown` to test whether the left mouse button
4696 is (still) depressed. Also, by convention, if `LeftDown` returns true,
4697 `LeftIsDown` will also return true in wxWidgets whatever the
4698 underlying GUI behaviour is (which is platform-dependent). The same
4699 applies, of course, to other mouse buttons as well.
4700 """
0085ce49
RD
4701 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4702 __repr__ = _swig_repr
4703 def __init__(self, *args, **kwargs):
27fb7603 4704 """
2131d850 4705 __init__(self, EventType mouseType=wxEVT_NULL) -> MouseEvent
27fb7603
RD
4706
4707 Constructs a wx.MouseEvent. Valid event types are:
4708
4709 * wxEVT_ENTER_WINDOW
4710 * wxEVT_LEAVE_WINDOW
4711 * wxEVT_LEFT_DOWN
4712 * wxEVT_LEFT_UP
4713 * wxEVT_LEFT_DCLICK
4714 * wxEVT_MIDDLE_DOWN
4715 * wxEVT_MIDDLE_UP
4716 * wxEVT_MIDDLE_DCLICK
4717 * wxEVT_RIGHT_DOWN
4718 * wxEVT_RIGHT_UP
4719 * wxEVT_RIGHT_DCLICK
4720 * wxEVT_MOTION
4721 * wxEVT_MOUSEWHEEL
4722 """
0085ce49 4723 _core_.MouseEvent_swiginit(self,_core_.new_MouseEvent(*args, **kwargs))
e811c8ce 4724 def IsButton(*args, **kwargs):
27fb7603
RD
4725 """
4726 IsButton(self) -> bool
4727
4728 Returns true if the event was a mouse button event (not necessarily a
4729 button down event - that may be tested using `ButtonDown`).
4730 """
54f9ee45 4731 return _core_.MouseEvent_IsButton(*args, **kwargs)
e811c8ce
RD
4732
4733 def ButtonDown(*args, **kwargs):
27fb7603
RD
4734 """
4735 ButtonDown(self, int but=MOUSE_BTN_ANY) -> bool
4736
5ba5649b
RD
4737 If the argument is omitted, this returns true if the event was any
4738 mouse button down event. Otherwise the argument specifies which
4739 button-down event shold be checked for (see `Button` for the possible
4740 values).
27fb7603 4741 """
54f9ee45 4742 return _core_.MouseEvent_ButtonDown(*args, **kwargs)
e811c8ce
RD
4743
4744 def ButtonDClick(*args, **kwargs):
27fb7603
RD
4745 """
4746 ButtonDClick(self, int but=MOUSE_BTN_ANY) -> bool
4747
4748 If the argument is omitted, this returns true if the event was any
4749 mouse double click event. Otherwise the argument specifies which
4750 double click event to check for (see `Button` for the possible
4751 values).
4752 """
54f9ee45 4753 return _core_.MouseEvent_ButtonDClick(*args, **kwargs)
e811c8ce
RD
4754
4755 def ButtonUp(*args, **kwargs):
27fb7603
RD
4756 """
4757 ButtonUp(self, int but=MOUSE_BTN_ANY) -> bool
4758
4759 If the argument is omitted, this returns true if the event was any
5ba5649b
RD
4760 mouse button up event. Otherwise the argument specifies which button
4761 up event to check for (see `Button` for the possible values).
27fb7603 4762 """
54f9ee45 4763 return _core_.MouseEvent_ButtonUp(*args, **kwargs)
e811c8ce
RD
4764
4765 def Button(*args, **kwargs):
27fb7603
RD
4766 """
4767 Button(self, int button) -> bool
4768
4769 Returns true if the identified mouse button is changing state. Valid
4770 values of button are:
4771
4772 ==================== =====================================
4773 wx.MOUSE_BTN_LEFT check if left button was pressed
4774 wx.MOUSE_BTN_MIDDLE check if middle button was pressed
4775 wx.MOUSE_BTN_RIGHT check if right button was pressed
4776 wx.MOUSE_BTN_ANY check if any button was pressed
4777 ==================== =====================================
4778
4779 """
54f9ee45 4780 return _core_.MouseEvent_Button(*args, **kwargs)
e811c8ce
RD
4781
4782 def ButtonIsDown(*args, **kwargs):
a95a7133 4783 """ButtonIsDown(self, int but) -> bool"""
54f9ee45 4784 return _core_.MouseEvent_ButtonIsDown(*args, **kwargs)
e811c8ce
RD
4785
4786 def GetButton(*args, **kwargs):
27fb7603
RD
4787 """
4788 GetButton(self) -> int
4789
4790 Returns the mouse button which generated this event or
4791 wx.MOUSE_BTN_NONE if no button is involved (for mouse move, enter or
4792 leave event, for example). Otherwise wx.MOUSE_BTN_LEFT is returned for
4793 the left button down, up and double click events, wx.MOUSE_BTN_MIDDLE
4794 and wx.MOUSE_BTN_RIGHT for the same events for the middle and the
4795 right buttons respectively.
4796 """
54f9ee45 4797 return _core_.MouseEvent_GetButton(*args, **kwargs)
e811c8ce
RD
4798
4799 def ControlDown(*args, **kwargs):
27fb7603
RD
4800 """
4801 ControlDown(self) -> bool
4802
4803 Returns true if the control key was down at the time of the event.
4804 """
54f9ee45 4805 return _core_.MouseEvent_ControlDown(*args, **kwargs)
e811c8ce
RD
4806
4807 def MetaDown(*args, **kwargs):
27fb7603
RD
4808 """
4809 MetaDown(self) -> bool
4810
4811 Returns true if the Meta key was down at the time of the event.
4812 """
54f9ee45 4813 return _core_.MouseEvent_MetaDown(*args, **kwargs)
e811c8ce
RD
4814
4815 def AltDown(*args, **kwargs):
27fb7603
RD
4816 """
4817 AltDown(self) -> bool
4818
4819 Returns true if the Alt key was down at the time of the event.
4820 """
54f9ee45 4821 return _core_.MouseEvent_AltDown(*args, **kwargs)
e811c8ce
RD
4822
4823 def ShiftDown(*args, **kwargs):
27fb7603
RD
4824 """
4825 ShiftDown(self) -> bool
4826
4827 Returns true if the Shift key was down at the time of the event.
4828 """
54f9ee45 4829 return _core_.MouseEvent_ShiftDown(*args, **kwargs)
e811c8ce 4830
412d302d
RD
4831 def CmdDown(*args, **kwargs):
4832 """
4833 CmdDown(self) -> bool
4834
4835 "Cmd" is a pseudo key which is the same as Control for PC and Unix
4836 platforms but the special "Apple" (a.k.a as "Command") key on
5ba5649b 4837 Macs. It often makes sense to use it instead of, say, `ControlDown`
412d302d 4838 because Cmd key is used for the same thing under Mac as Ctrl
27fb7603 4839 elsewhere. The Ctrl key still exists, it's just not used for this
412d302d
RD
4840 purpose. So for non-Mac platforms this is the same as `ControlDown`
4841 and Macs this is the same as `MetaDown`.
4842 """
4843 return _core_.MouseEvent_CmdDown(*args, **kwargs)
4844
e811c8ce 4845 def LeftDown(*args, **kwargs):
27fb7603
RD
4846 """
4847 LeftDown(self) -> bool
4848
4849 Returns true if the left mouse button state changed to down.
4850 """
54f9ee45 4851 return _core_.MouseEvent_LeftDown(*args, **kwargs)
e811c8ce
RD
4852
4853 def MiddleDown(*args, **kwargs):
27fb7603
RD
4854 """
4855 MiddleDown(self) -> bool
4856
4857 Returns true if the middle mouse button state changed to down.
4858 """
54f9ee45 4859 return _core_.MouseEvent_MiddleDown(*args, **kwargs)
e811c8ce
RD
4860
4861 def RightDown(*args, **kwargs):
27fb7603
RD
4862 """
4863 RightDown(self) -> bool
4864
4865 Returns true if the right mouse button state changed to down.
4866 """
54f9ee45 4867 return _core_.MouseEvent_RightDown(*args, **kwargs)
e811c8ce
RD
4868
4869 def LeftUp(*args, **kwargs):
27fb7603
RD
4870 """
4871 LeftUp(self) -> bool
4872
4873 Returns true if the left mouse button state changed to up.
4874 """
54f9ee45 4875 return _core_.MouseEvent_LeftUp(*args, **kwargs)
e811c8ce
RD
4876
4877 def MiddleUp(*args, **kwargs):
27fb7603
RD
4878 """
4879 MiddleUp(self) -> bool
4880
4881 Returns true if the middle mouse button state changed to up.
4882 """
54f9ee45 4883 return _core_.MouseEvent_MiddleUp(*args, **kwargs)
e811c8ce
RD
4884
4885 def RightUp(*args, **kwargs):
27fb7603
RD
4886 """
4887 RightUp(self) -> bool
4888
4889 Returns true if the right mouse button state changed to up.
4890 """
54f9ee45 4891 return _core_.MouseEvent_RightUp(*args, **kwargs)
e811c8ce
RD
4892
4893 def LeftDClick(*args, **kwargs):
27fb7603
RD
4894 """
4895 LeftDClick(self) -> bool
4896
4897 Returns true if the event was a left button double click.
4898 """
54f9ee45 4899 return _core_.MouseEvent_LeftDClick(*args, **kwargs)
e811c8ce
RD
4900
4901 def MiddleDClick(*args, **kwargs):
27fb7603
RD
4902 """
4903 MiddleDClick(self) -> bool
4904
4905 Returns true if the event was a middle button double click.
4906 """
54f9ee45 4907 return _core_.MouseEvent_MiddleDClick(*args, **kwargs)
e811c8ce
RD
4908
4909 def RightDClick(*args, **kwargs):
27fb7603
RD
4910 """
4911 RightDClick(self) -> bool
4912
4913 Returns true if the event was a right button double click.
4914 """
54f9ee45 4915 return _core_.MouseEvent_RightDClick(*args, **kwargs)
e811c8ce
RD
4916
4917 def LeftIsDown(*args, **kwargs):
27fb7603
RD
4918 """
4919 LeftIsDown(self) -> bool
4920
4921 Returns true if the left mouse button is currently down, independent
4922 of the current event type.
4923
4924 Please notice that it is not the same as LeftDown which returns true
4925 if the left mouse button was just pressed. Rather, it describes the
4926 state of the mouse button before the event happened.
4927
4928 This event is usually used in the mouse event handlers which process
4929 "move mouse" messages to determine whether the user is (still)
4930 dragging the mouse.
4931 """
54f9ee45 4932 return _core_.MouseEvent_LeftIsDown(*args, **kwargs)
e811c8ce
RD
4933
4934 def MiddleIsDown(*args, **kwargs):
27fb7603
RD
4935 """
4936 MiddleIsDown(self) -> bool
4937
4938 Returns true if the middle mouse button is currently down, independent
4939 of the current event type.
4940 """
54f9ee45 4941 return _core_.MouseEvent_MiddleIsDown(*args, **kwargs)
e811c8ce
RD
4942
4943 def RightIsDown(*args, **kwargs):
27fb7603
RD
4944 """
4945 RightIsDown(self) -> bool
4946
4947 Returns true if the right mouse button is currently down, independent
4948 of the current event type.
4949 """
54f9ee45 4950 return _core_.MouseEvent_RightIsDown(*args, **kwargs)
e811c8ce
RD
4951
4952 def Dragging(*args, **kwargs):
27fb7603
RD
4953 """
4954 Dragging(self) -> bool
4955
4956 Returns true if this was a dragging event (motion while a button is
4957 depressed).
4958 """
54f9ee45 4959 return _core_.MouseEvent_Dragging(*args, **kwargs)
e811c8ce
RD
4960
4961 def Moving(*args, **kwargs):
27fb7603
RD
4962 """
4963 Moving(self) -> bool
4964
4965 Returns true if this was a motion event and no mouse buttons were
4966 pressed. If any mouse button is held pressed, then this method returns
4967 false and Dragging returns true.
4968 """
54f9ee45 4969 return _core_.MouseEvent_Moving(*args, **kwargs)
e811c8ce
RD
4970
4971 def Entering(*args, **kwargs):
27fb7603
RD
4972 """
4973 Entering(self) -> bool
4974
4975 Returns true if the mouse was entering the window.
4976 """
54f9ee45 4977 return _core_.MouseEvent_Entering(*args, **kwargs)
e811c8ce
RD
4978
4979 def Leaving(*args, **kwargs):
27fb7603
RD
4980 """
4981 Leaving(self) -> bool
4982
4983 Returns true if the mouse was leaving the window.
4984 """
54f9ee45 4985 return _core_.MouseEvent_Leaving(*args, **kwargs)
e811c8ce
RD
4986
4987 def GetPosition(*args, **kwargs):
0df68c9f 4988 """
a95a7133 4989 GetPosition(self) -> Point
e811c8ce 4990
27fb7603
RD
4991 Returns the pixel position of the mouse in window coordinates when the
4992 event happened.
0df68c9f 4993 """
54f9ee45 4994 return _core_.MouseEvent_GetPosition(*args, **kwargs)
e811c8ce
RD
4995
4996 def GetPositionTuple(*args, **kwargs):
0df68c9f
RD
4997 """
4998 GetPositionTuple() -> (x,y)
e811c8ce 4999
27fb7603
RD
5000 Returns the pixel position of the mouse in window coordinates when the
5001 event happened.
0df68c9f 5002 """
54f9ee45 5003 return _core_.MouseEvent_GetPositionTuple(*args, **kwargs)
e811c8ce
RD
5004
5005 def GetLogicalPosition(*args, **kwargs):
27fb7603
RD
5006 """
5007 GetLogicalPosition(self, DC dc) -> Point
5008
5009 Returns the logical mouse position in pixels (i.e. translated
5010 according to the translation set for the DC, which usually indicates
5011 that the window has been scrolled).
5012 """
54f9ee45 5013 return _core_.MouseEvent_GetLogicalPosition(*args, **kwargs)
e811c8ce
RD
5014
5015 def GetX(*args, **kwargs):
27fb7603
RD
5016 """
5017 GetX(self) -> int
5018
5019 Returns X coordinate of the physical mouse event position.
5020 """
54f9ee45 5021 return _core_.MouseEvent_GetX(*args, **kwargs)
e811c8ce
RD
5022
5023 def GetY(*args, **kwargs):
27fb7603
RD
5024 """
5025 GetY(self) -> int
5026
5027 Returns Y coordinate of the physical mouse event position.
5028 """
54f9ee45 5029 return _core_.MouseEvent_GetY(*args, **kwargs)
e811c8ce
RD
5030
5031 def GetWheelRotation(*args, **kwargs):
27fb7603
RD
5032 """
5033 GetWheelRotation(self) -> int
5034
5035 Get wheel rotation, positive or negative indicates direction of
5036 rotation. Current devices all send an event when rotation is equal to
5037 +/-WheelDelta, but this allows for finer resolution devices to be
5038 created in the future. Because of this you shouldn't assume that one
5039 event is equal to 1 line or whatever, but you should be able to either
5040 do partial line scrolling or wait until +/-WheelDelta rotation values
5041 have been accumulated before scrolling.
5042 """
54f9ee45 5043 return _core_.MouseEvent_GetWheelRotation(*args, **kwargs)
e811c8ce
RD
5044
5045 def GetWheelDelta(*args, **kwargs):
27fb7603
RD
5046 """
5047 GetWheelDelta(self) -> int
5048
5049 Get wheel delta, normally 120. This is the threshold for action to be
5050 taken, and one such action (for example, scrolling one increment)
5051 should occur for each delta.
5052 """
54f9ee45 5053 return _core_.MouseEvent_GetWheelDelta(*args, **kwargs)
e811c8ce 5054
4976f996
RD
5055 def GetWheelAxis(*args, **kwargs):
5056 """
5057 GetWheelAxis(self) -> int
5058
5059 Gets the axis the wheel operation concerns, 0 being the y axis as on
5060 most mouse wheels, 1 is the x axis for things like MightyMouse scrolls
5061 or horizontal trackpad scrolling.
5062 """
5063 return _core_.MouseEvent_GetWheelAxis(*args, **kwargs)
5064
e811c8ce 5065 def GetLinesPerAction(*args, **kwargs):
27fb7603
RD
5066 """
5067 GetLinesPerAction(self) -> int
5068
5069 Returns the configured number of lines (or whatever) to be scrolled
5070 per wheel action. Defaults to three.
5071 """
54f9ee45 5072 return _core_.MouseEvent_GetLinesPerAction(*args, **kwargs)
e811c8ce
RD
5073
5074 def IsPageScroll(*args, **kwargs):
27fb7603
RD
5075 """
5076 IsPageScroll(self) -> bool
5077
5078 Returns true if the system has been setup to do page scrolling with
5079 the mouse wheel instead of line scrolling.
5080 """
54f9ee45
RD
5081 return _core_.MouseEvent_IsPageScroll(*args, **kwargs)
5082
5083 m_x = property(_core_.MouseEvent_m_x_get, _core_.MouseEvent_m_x_set)
5084 m_y = property(_core_.MouseEvent_m_y_get, _core_.MouseEvent_m_y_set)
5085 m_leftDown = property(_core_.MouseEvent_m_leftDown_get, _core_.MouseEvent_m_leftDown_set)
5086 m_middleDown = property(_core_.MouseEvent_m_middleDown_get, _core_.MouseEvent_m_middleDown_set)
5087 m_rightDown = property(_core_.MouseEvent_m_rightDown_get, _core_.MouseEvent_m_rightDown_set)
5088 m_controlDown = property(_core_.MouseEvent_m_controlDown_get, _core_.MouseEvent_m_controlDown_set)
5089 m_shiftDown = property(_core_.MouseEvent_m_shiftDown_get, _core_.MouseEvent_m_shiftDown_set)
5090 m_altDown = property(_core_.MouseEvent_m_altDown_get, _core_.MouseEvent_m_altDown_set)
5091 m_metaDown = property(_core_.MouseEvent_m_metaDown_get, _core_.MouseEvent_m_metaDown_set)
5092 m_wheelRotation = property(_core_.MouseEvent_m_wheelRotation_get, _core_.MouseEvent_m_wheelRotation_set)
5093 m_wheelDelta = property(_core_.MouseEvent_m_wheelDelta_get, _core_.MouseEvent_m_wheelDelta_set)
5094 m_linesPerAction = property(_core_.MouseEvent_m_linesPerAction_get, _core_.MouseEvent_m_linesPerAction_set)
57332a5a
RD
5095 Button = property(GetButton,doc="See `GetButton`")
5096 LinesPerAction = property(GetLinesPerAction,doc="See `GetLinesPerAction`")
5097 LogicalPosition = property(GetLogicalPosition,doc="See `GetLogicalPosition`")
5098 Position = property(GetPosition,doc="See `GetPosition`")
5099 WheelDelta = property(GetWheelDelta,doc="See `GetWheelDelta`")
5100 WheelRotation = property(GetWheelRotation,doc="See `GetWheelRotation`")
5101 X = property(GetX,doc="See `GetX`")
5102 Y = property(GetY,doc="See `GetY`")
2131d850 5103_core_.MouseEvent_swigregister(MouseEvent)
d14a1e28
RD
5104
5105#---------------------------------------------------------------------------
5106
5107class SetCursorEvent(Event):
5ba5649b
RD
5108 """
5109 A SetCursorEvent is generated when the mouse cursor is about to be set
5110 as a result of mouse motion. This event gives the application the
5111 chance to perform specific mouse cursor processing based on the
5112 current position of the mouse within the window. Use the `SetCursor`
5113 method to specify the cursor you want to be displayed.
5114 """
0085ce49
RD
5115 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5116 __repr__ = _swig_repr
5117 def __init__(self, *args, **kwargs):
5ba5649b
RD
5118 """
5119 __init__(self, int x=0, int y=0) -> SetCursorEvent
5120
5121 Construct a new `wx.SetCursorEvent`.
5122 """
0085ce49 5123 _core_.SetCursorEvent_swiginit(self,_core_.new_SetCursorEvent(*args, **kwargs))
e811c8ce 5124 def GetX(*args, **kwargs):
5ba5649b
RD
5125 """
5126 GetX(self) -> int
5127
5128 Returns the X coordinate of the mouse in client coordinates.
5129 """
54f9ee45 5130 return _core_.SetCursorEvent_GetX(*args, **kwargs)
e811c8ce
RD
5131
5132 def GetY(*args, **kwargs):
5ba5649b
RD
5133 """
5134 GetY(self) -> int
5135
5136 Returns the Y coordinate of the mouse in client coordinates.
5137 """
54f9ee45 5138 return _core_.SetCursorEvent_GetY(*args, **kwargs)
e811c8ce
RD
5139
5140 def SetCursor(*args, **kwargs):
5ba5649b
RD
5141 """
5142 SetCursor(self, Cursor cursor)
5143
5144 Sets the cursor associated with this event.
5145 """
54f9ee45 5146 return _core_.SetCursorEvent_SetCursor(*args, **kwargs)
e811c8ce
RD
5147
5148 def GetCursor(*args, **kwargs):
5ba5649b
RD
5149 """
5150 GetCursor(self) -> Cursor
5151
5152 Returns a reference to the cursor specified by this event.
5153 """
54f9ee45 5154 return _core_.SetCursorEvent_GetCursor(*args, **kwargs)
e811c8ce
RD
5155
5156 def HasCursor(*args, **kwargs):
5ba5649b
RD
5157 """
5158 HasCursor(self) -> bool
5159
5160 Returns true if the cursor specified by this event is a valid cursor.
5161 """
54f9ee45 5162 return _core_.SetCursorEvent_HasCursor(*args, **kwargs)
e811c8ce 5163
33d6fd3b
RD
5164 Cursor = property(GetCursor,SetCursor,doc="See `GetCursor` and `SetCursor`")
5165 X = property(GetX,doc="See `GetX`")
5166 Y = property(GetY,doc="See `GetY`")
2131d850 5167_core_.SetCursorEvent_swigregister(SetCursorEvent)
d14a1e28
RD
5168
5169#---------------------------------------------------------------------------
5170
5171class KeyEvent(Event):
5ba5649b
RD
5172 """
5173 This event class contains information about keypress and character
5174 events. These events are only sent to the widget that currently has
5175 the keyboard focus.
5176
5177 Notice that there are three different kinds of keyboard events in
5178 wxWidgets: key down and up events and char events. The difference
5179 between the first two is clear - the first corresponds to a key press
5180 and the second to a key release - otherwise they are identical. Just
5181 note that if the key is maintained in a pressed state you will
5182 typically get a lot of (automatically generated) down events but only
5183 one up so it is wrong to assume that there is one up event
5184 corresponding to each down one.
5185
5186 Both key events provide untranslated key codes while the char event
5187 carries the translated one. The untranslated code for alphanumeric
5188 keys is always an upper case value. For the other keys it is one of
5189 WXK_XXX values from the keycodes table. The translated key is, in
5190 general, the character the user expects to appear as the result of the
5191 key combination when typing the text into a text entry zone, for
5192 example.
5193
5194 A few examples to clarify this (all assume that CAPS LOCK is unpressed
5195 and the standard US keyboard): when the 'A' key is pressed, the key
5196 down event key code is equal to ASCII A == 65. But the char event key
5197 code is ASCII a == 97. On the other hand, if you press both SHIFT and
5198 'A' keys simultaneously , the key code in key down event will still be
5199 just 'A' while the char event key code parameter will now be 'A' as
5200 well.
5201
5202 Although in this simple case it is clear that the correct key code
5203 could be found in the key down event handler by checking the value
5204 returned by `ShiftDown`, in general you should use EVT_CHAR for this
5205 as for non alphanumeric keys or non-US keyboard layouts the
5206 translation is keyboard-layout dependent and can only be done properly
5207 by the system itself.
5208
5209 Another kind of translation is done when the control key is pressed:
5210 for example, for CTRL-A key press the key down event still carries the
5211 same key code 'A' as usual but the char event will have key code of 1,
5212 the ASCII value of this key combination.
5213
5214 You may discover how the other keys on your system behave
5215 interactively by running the KeyEvents sample in the wxPython demo and
5216 pressing some keys while the blue box at the top has the keyboard
5217 focus.
5218
5219 **Note**: If a key down event is caught and the event handler does not
5220 call event.Skip() then the coresponding char event will not
5221 happen. This is by design and enables the programs that handle both
5222 types of events to be a bit simpler.
5223
5224 **Note for Windows programmers**: The key and char events in wxWidgets
5225 are similar to but slightly different from Windows WM_KEYDOWN and
5226 WM_CHAR events. In particular, Alt-x combination will generate a char
5227 event in wxWidgets (unless it is used as an accelerator).
5228
5229 **Tip**: be sure to call event.Skip() for events that you don't
5230 process in key event function, otherwise menu shortcuts may cease to
5231 work under Windows.
5232
5233 """
0085ce49
RD
5234 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5235 __repr__ = _swig_repr
5236 def __init__(self, *args, **kwargs):
5ba5649b 5237 """
2131d850 5238 __init__(self, EventType eventType=wxEVT_NULL) -> KeyEvent
5ba5649b
RD
5239
5240 Construct a new `wx.KeyEvent`. Valid event types are:
5241 *
5242 """
0085ce49 5243 _core_.KeyEvent_swiginit(self,_core_.new_KeyEvent(*args, **kwargs))
b1fcee84
RD
5244 def GetModifiers(*args, **kwargs):
5245 """
5246 GetModifiers(self) -> int
5247
5248 Returns a bitmask of the current modifier settings. Can be used to
5249 check if the key event has exactly the given modifiers without having
5250 to explicitly check that the other modifiers are not down. For
5251 example::
5252
5253 if event.GetModifers() == wx.MOD_CONTROL:
5254 DoSomething()
5255
5256 """
5257 return _core_.KeyEvent_GetModifiers(*args, **kwargs)
5258
e811c8ce 5259 def ControlDown(*args, **kwargs):
5ba5649b
RD
5260 """
5261 ControlDown(self) -> bool
5262
5263 Returns ``True`` if the Control key was down at the time of the event.
5264 """
54f9ee45 5265 return _core_.KeyEvent_ControlDown(*args, **kwargs)
e811c8ce
RD
5266
5267 def MetaDown(*args, **kwargs):
5ba5649b
RD
5268 """
5269 MetaDown(self) -> bool
5270
5271 Returns ``True`` if the Meta key was down at the time of the event.
5272 """
54f9ee45 5273 return _core_.KeyEvent_MetaDown(*args, **kwargs)
e811c8ce
RD
5274
5275 def AltDown(*args, **kwargs):
5ba5649b
RD
5276 """
5277 AltDown(self) -> bool
5278
5279 Returns ``True`` if the Alt key was down at the time of the event.
5280 """
54f9ee45 5281 return _core_.KeyEvent_AltDown(*args, **kwargs)
e811c8ce
RD
5282
5283 def ShiftDown(*args, **kwargs):
5ba5649b
RD
5284 """
5285 ShiftDown(self) -> bool
5286
5287 Returns ``True`` if the Shift key was down at the time of the event.
5288 """
54f9ee45 5289 return _core_.KeyEvent_ShiftDown(*args, **kwargs)
e811c8ce 5290
412d302d
RD
5291 def CmdDown(*args, **kwargs):
5292 """
5293 CmdDown(self) -> bool
5294
5295 "Cmd" is a pseudo key which is the same as Control for PC and Unix
5296 platforms but the special "Apple" (a.k.a as "Command") key on
5ba5649b 5297 Macs. It makes often sense to use it instead of, say, `ControlDown`
412d302d
RD
5298 because Cmd key is used for the same thing under Mac as Ctrl
5299 elsewhere. The Ctrl still exists, it's just not used for this
5300 purpose. So for non-Mac platforms this is the same as `ControlDown`
5301 and Macs this is the same as `MetaDown`.
5302 """
5303 return _core_.KeyEvent_CmdDown(*args, **kwargs)
5304
e811c8ce 5305 def HasModifiers(*args, **kwargs):
5ba5649b
RD
5306 """
5307 HasModifiers(self) -> bool
5308
5309 Returns true if either CTRL or ALT keys was down at the time of the
5310 key event. Note that this function does not take into account neither
5311 SHIFT nor META key states (the reason for ignoring the latter is that
5312 it is common for NUMLOCK key to be configured as META under X but the
5313 key presses even while NUMLOCK is on should be still processed
5314 normally).
5315 """
54f9ee45 5316 return _core_.KeyEvent_HasModifiers(*args, **kwargs)
e811c8ce
RD
5317
5318 def GetKeyCode(*args, **kwargs):
5ba5649b
RD
5319 """
5320 GetKeyCode(self) -> int
5321
5322 Returns the virtual key code. ASCII events return normal ASCII values,
5323 while non-ASCII events return values such as WXK_LEFT for the left
5324 cursor key. See `wx.KeyEvent` for a full list of the virtual key
5325 codes.
5326
5327 Note that in Unicode build, the returned value is meaningful only if
5328 the user entered a character that can be represented in current
5329 locale's default charset. You can obtain the corresponding Unicode
5330 character using `GetUnicodeKey`.
5331 """
54f9ee45 5332 return _core_.KeyEvent_GetKeyCode(*args, **kwargs)
e811c8ce 5333
19272049 5334 def GetUnicodeKey(*args, **kwargs):
5ba5649b
RD
5335 """
5336 GetUnicodeKey(self) -> int
5337
5338 Returns the Unicode character corresponding to this key event. This
5339 function is only meaningfule in a Unicode build of wxPython.
5340 """
19272049 5341 return _core_.KeyEvent_GetUnicodeKey(*args, **kwargs)
e811c8ce 5342
19272049 5343 GetUniChar = GetUnicodeKey
b850e7f3
RD
5344 def SetUnicodeKey(*args, **kwargs):
5345 """
5346 SetUnicodeKey(self, int uniChar)
5347
5348 Set the Unicode value of the key event, but only if this is a Unicode
5349 build of wxPython.
5350 """
5351 return _core_.KeyEvent_SetUnicodeKey(*args, **kwargs)
5352
e811c8ce 5353 def GetRawKeyCode(*args, **kwargs):
5ba5649b
RD
5354 """
5355 GetRawKeyCode(self) -> unsigned int
5356
5357 Returns the raw key code for this event. This is a platform-dependent
5358 scan code which should only be used in advanced
5359 applications. Currently the raw key codes are not supported by all
5360 ports.
5361 """
54f9ee45 5362 return _core_.KeyEvent_GetRawKeyCode(*args, **kwargs)
e811c8ce
RD
5363
5364 def GetRawKeyFlags(*args, **kwargs):
5ba5649b
RD
5365 """
5366 GetRawKeyFlags(self) -> unsigned int
5367
5368 Returns the low level key flags for this event. The flags are
5369 platform-dependent and should only be used in advanced applications.
5370 Currently the raw key flags are not supported by all ports.
5371 """
54f9ee45 5372 return _core_.KeyEvent_GetRawKeyFlags(*args, **kwargs)
e811c8ce
RD
5373
5374 def GetPosition(*args, **kwargs):
0df68c9f 5375 """
a95a7133 5376 GetPosition(self) -> Point
e811c8ce 5377
5ba5649b 5378 Find the position of the event, if applicable.
0df68c9f 5379 """
54f9ee45 5380 return _core_.KeyEvent_GetPosition(*args, **kwargs)
e811c8ce
RD
5381
5382 def GetPositionTuple(*args, **kwargs):
0df68c9f
RD
5383 """
5384 GetPositionTuple() -> (x,y)
e811c8ce 5385
5ba5649b 5386 Find the position of the event, if applicable.
0df68c9f 5387 """
54f9ee45 5388 return _core_.KeyEvent_GetPositionTuple(*args, **kwargs)
e811c8ce
RD
5389
5390 def GetX(*args, **kwargs):
5ba5649b
RD
5391 """
5392 GetX(self) -> int
5393
5394 Returns the X position (in client coordinates) of the event, if
5395 applicable.
5396 """
54f9ee45 5397 return _core_.KeyEvent_GetX(*args, **kwargs)
e811c8ce
RD
5398
5399 def GetY(*args, **kwargs):
5ba5649b
RD
5400 """
5401 GetY(self) -> int
5402
5403 Returns the Y position (in client coordinates) of the event, if
5404 applicable.
5405 """
54f9ee45
RD
5406 return _core_.KeyEvent_GetY(*args, **kwargs)
5407
5408 m_x = property(_core_.KeyEvent_m_x_get, _core_.KeyEvent_m_x_set)
5409 m_y = property(_core_.KeyEvent_m_y_get, _core_.KeyEvent_m_y_set)
5410 m_keyCode = property(_core_.KeyEvent_m_keyCode_get, _core_.KeyEvent_m_keyCode_set)
5411 m_controlDown = property(_core_.KeyEvent_m_controlDown_get, _core_.KeyEvent_m_controlDown_set)
5412 m_shiftDown = property(_core_.KeyEvent_m_shiftDown_get, _core_.KeyEvent_m_shiftDown_set)
5413 m_altDown = property(_core_.KeyEvent_m_altDown_get, _core_.KeyEvent_m_altDown_set)
5414 m_metaDown = property(_core_.KeyEvent_m_metaDown_get, _core_.KeyEvent_m_metaDown_set)
5415 m_scanCode = property(_core_.KeyEvent_m_scanCode_get, _core_.KeyEvent_m_scanCode_set)
5416 m_rawCode = property(_core_.KeyEvent_m_rawCode_get, _core_.KeyEvent_m_rawCode_set)
5417 m_rawFlags = property(_core_.KeyEvent_m_rawFlags_get, _core_.KeyEvent_m_rawFlags_set)
97ab0f6a
RD
5418 KeyCode = property(GetKeyCode,doc="See `GetKeyCode`")
5419 Modifiers = property(GetModifiers,doc="See `GetModifiers`")
5420 Position = property(GetPosition,doc="See `GetPosition`")
5421 RawKeyCode = property(GetRawKeyCode,doc="See `GetRawKeyCode`")
5422 RawKeyFlags = property(GetRawKeyFlags,doc="See `GetRawKeyFlags`")
5423 UnicodeKey = property(GetUnicodeKey,SetUnicodeKey,doc="See `GetUnicodeKey` and `SetUnicodeKey`")
5424 X = property(GetX,doc="See `GetX`")
5425 Y = property(GetY,doc="See `GetY`")
2131d850 5426_core_.KeyEvent_swigregister(KeyEvent)
d14a1e28
RD
5427
5428#---------------------------------------------------------------------------
5429
5430class SizeEvent(Event):
5ba5649b
RD
5431 """
5432 A size event holds information about size change events. The EVT_SIZE
5433 handler function will be called when the window it is bound to has
5434 been resized.
5435
5436 Note that the size passed is of the whole window: call
5437 `wx.Window.GetClientSize` for the area which may be used by the
5438 application.
5439
5440 When a window is resized, usually only a small part of the window is
5441 damaged and and that area is all that is in the update region for the
5442 next paint event. However, if your drawing depends on the size of the
5443 window, you may need to clear the DC explicitly and repaint the whole
5444 window. In which case, you may need to call `wx.Window.Refresh` to
5445 invalidate the entire window.
5446
5447 """
0085ce49
RD
5448 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5449 __repr__ = _swig_repr
5450 def __init__(self, *args, **kwargs):
5ba5649b
RD
5451 """
5452 __init__(self, Size sz=DefaultSize, int winid=0) -> SizeEvent
5453
5454 Construct a new ``wx.SizeEvent``.
5455 """
0085ce49 5456 _core_.SizeEvent_swiginit(self,_core_.new_SizeEvent(*args, **kwargs))
e811c8ce 5457 def GetSize(*args, **kwargs):
5ba5649b
RD
5458 """
5459 GetSize(self) -> Size
5460
5461 Returns the entire size of the window generating the size change
5462 event.
5463 """
54f9ee45 5464 return _core_.SizeEvent_GetSize(*args, **kwargs)
e811c8ce
RD
5465
5466 def GetRect(*args, **kwargs):
a95a7133 5467 """GetRect(self) -> Rect"""
54f9ee45 5468 return _core_.SizeEvent_GetRect(*args, **kwargs)
e811c8ce
RD
5469
5470 def SetRect(*args, **kwargs):
a95a7133 5471 """SetRect(self, Rect rect)"""
54f9ee45 5472 return _core_.SizeEvent_SetRect(*args, **kwargs)
e811c8ce
RD
5473
5474 def SetSize(*args, **kwargs):
a95a7133 5475 """SetSize(self, Size size)"""
54f9ee45 5476 return _core_.SizeEvent_SetSize(*args, **kwargs)
e811c8ce 5477
54f9ee45
RD
5478 m_size = property(_core_.SizeEvent_m_size_get, _core_.SizeEvent_m_size_set)
5479 m_rect = property(_core_.SizeEvent_m_rect_get, _core_.SizeEvent_m_rect_set)
33d6fd3b
RD
5480 Rect = property(GetRect,SetRect,doc="See `GetRect` and `SetRect`")
5481 Size = property(GetSize,SetSize,doc="See `GetSize` and `SetSize`")
2131d850 5482_core_.SizeEvent_swigregister(SizeEvent)
d14a1e28
RD
5483
5484#---------------------------------------------------------------------------
5485
5486class MoveEvent(Event):
5ba5649b
RD
5487 """
5488 This event object is sent for EVT_MOVE event bindings when a window is
5489 moved to a new position.
5490 """
0085ce49
RD
5491 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5492 __repr__ = _swig_repr
5493 def __init__(self, *args, **kwargs):
5ba5649b
RD
5494 """
5495 __init__(self, Point pos=DefaultPosition, int winid=0) -> MoveEvent
5496
5497 Constructor.
5498 """
0085ce49 5499 _core_.MoveEvent_swiginit(self,_core_.new_MoveEvent(*args, **kwargs))
e811c8ce 5500 def GetPosition(*args, **kwargs):
5ba5649b
RD
5501 """
5502 GetPosition(self) -> Point
5503
5504 Returns the position of the window generating the move change event.
5505 """
54f9ee45 5506 return _core_.MoveEvent_GetPosition(*args, **kwargs)
e811c8ce
RD
5507
5508 def GetRect(*args, **kwargs):
a95a7133 5509 """GetRect(self) -> Rect"""
54f9ee45 5510 return _core_.MoveEvent_GetRect(*args, **kwargs)
e811c8ce
RD
5511
5512 def SetRect(*args, **kwargs):
a95a7133 5513 """SetRect(self, Rect rect)"""
54f9ee45 5514 return _core_.MoveEvent_SetRect(*args, **kwargs)
e811c8ce
RD
5515
5516 def SetPosition(*args, **kwargs):
a95a7133 5517 """SetPosition(self, Point pos)"""
54f9ee45 5518 return _core_.MoveEvent_SetPosition(*args, **kwargs)
e811c8ce 5519
7557b9b5
RD
5520 m_pos = property(GetPosition, SetPosition)
5521 m_rect = property(GetRect, SetRect)
5522
57332a5a
RD
5523 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
5524 Rect = property(GetRect,SetRect,doc="See `GetRect` and `SetRect`")
2131d850 5525_core_.MoveEvent_swigregister(MoveEvent)
d14a1e28
RD
5526
5527#---------------------------------------------------------------------------
5528
5529class PaintEvent(Event):
5ba5649b
RD
5530 """
5531 A paint event is sent when a window's contents needs to be repainted.
5532 Note that in an EVT_PAINT handler the application must *always* create
5533 a `wx.PaintDC` object, even if you do not use it. Otherwise MS
5534 Windows assumes that the window has not been painted yet and will send
5535 the event again, causing endless refreshes.
5536
5537 You can optimize painting by retrieving the rectangles that have been
5538 damaged using `wx.Window.GetUpdateRegion` and/or `wx.RegionIterator`,
5539 and only repainting these rectangles. The rectangles are in terms of
5540 the client area, and are unscrolled, so you will need to do some
5541 calculations using the current view position to obtain logical,
5542 scrolled units.
5543
5544 """
0085ce49
RD
5545 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5546 __repr__ = _swig_repr
5547 def __init__(self, *args, **kwargs):
a95a7133 5548 """__init__(self, int Id=0) -> PaintEvent"""
0085ce49 5549 _core_.PaintEvent_swiginit(self,_core_.new_PaintEvent(*args, **kwargs))
2131d850 5550_core_.PaintEvent_swigregister(PaintEvent)
d14a1e28
RD
5551
5552class NcPaintEvent(Event):
093d3ff1 5553 """Proxy of C++ NcPaintEvent class"""
0085ce49
RD
5554 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5555 __repr__ = _swig_repr
5556 def __init__(self, *args, **kwargs):
a95a7133 5557 """__init__(self, int winid=0) -> NcPaintEvent"""
0085ce49 5558 _core_.NcPaintEvent_swiginit(self,_core_.new_NcPaintEvent(*args, **kwargs))
2131d850 5559_core_.NcPaintEvent_swigregister(NcPaintEvent)
d14a1e28
RD
5560
5561#---------------------------------------------------------------------------
5562
5563class EraseEvent(Event):
5ba5649b
RD
5564 """
5565 An erase event is sent whenever the background of a window needs to be
5566 repainted. To intercept this event use the EVT_ERASE_BACKGROUND event
5567 binder. On some platforms, such as GTK+, this event is simulated
5568 (simply generated just before the paint event) and may cause flicker.
5569
5570 To paint a custom background use the `GetDC` method and use the returned
5571 device context if it is not ``None``, otherwise create a temporary
5572 `wx.ClientDC` and draw on that.
5573
5574 """
0085ce49
RD
5575 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5576 __repr__ = _swig_repr
5577 def __init__(self, *args, **kwargs):
5ba5649b
RD
5578 """
5579 __init__(self, int Id=0, DC dc=None) -> EraseEvent
5580
5581 Constructor
5582 """
0085ce49 5583 _core_.EraseEvent_swiginit(self,_core_.new_EraseEvent(*args, **kwargs))
e811c8ce 5584 def GetDC(*args, **kwargs):
5ba5649b
RD
5585 """
5586 GetDC(self) -> DC
5587
5588 Returns the device context the event handler should draw upon. If
5589 ``None`` is returned then create a temporary `wx.ClientDC` and use
5590 that instead.
5591 """
54f9ee45 5592 return _core_.EraseEvent_GetDC(*args, **kwargs)
e811c8ce 5593
97ab0f6a 5594 DC = property(GetDC,doc="See `GetDC`")
2131d850 5595_core_.EraseEvent_swigregister(EraseEvent)
d14a1e28
RD
5596
5597#---------------------------------------------------------------------------
5598
5599class FocusEvent(Event):
5ba5649b
RD
5600 """
5601 A focus event is sent when a window's focus changes. The window losing
5602 focus receives an EVT_KILL_FOCUS event while the window gaining it
5603 gets an EVT_SET_FOCUS event.
5604
5605 Notice that the set focus event happens both when the user gives focus
5606 to the window (whether using the mouse or keyboard) and when it is
5607 done from the program itself using `wx.Window.SetFocus`.
5608
5609 """
0085ce49
RD
5610 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5611 __repr__ = _swig_repr
5612 def __init__(self, *args, **kwargs):
5ba5649b 5613 """
2131d850 5614 __init__(self, EventType type=wxEVT_NULL, int winid=0) -> FocusEvent
5ba5649b
RD
5615
5616 Constructor
5617 """
0085ce49 5618 _core_.FocusEvent_swiginit(self,_core_.new_FocusEvent(*args, **kwargs))
e811c8ce 5619 def GetWindow(*args, **kwargs):
5ba5649b
RD
5620 """
5621 GetWindow(self) -> Window
5622
5623 Returns the other window associated with this event, that is the
5624 window which had the focus before for the EVT_SET_FOCUS event and the
5625 window which is going to receive focus for the wxEVT_KILL_FOCUS event.
5626
5627 Warning: the window returned may be None!
5628 """
54f9ee45 5629 return _core_.FocusEvent_GetWindow(*args, **kwargs)
e811c8ce
RD
5630
5631 def SetWindow(*args, **kwargs):
a95a7133 5632 """SetWindow(self, Window win)"""
54f9ee45 5633 return _core_.FocusEvent_SetWindow(*args, **kwargs)
e811c8ce 5634
97ab0f6a 5635 Window = property(GetWindow,SetWindow,doc="See `GetWindow` and `SetWindow`")
2131d850 5636_core_.FocusEvent_swigregister(FocusEvent)
d14a1e28
RD
5637
5638#---------------------------------------------------------------------------
5639
5640class ChildFocusEvent(CommandEvent):
5ba5649b 5641 """
33d6fd3b
RD
5642 A child focus event is sent to a (parent-)window when one of its child
5643 windows gains focus, so that the window could restore the focus back
5644 to its corresponding child if it loses it now and regains later.
5645
5646 Notice that child window is the direct child of the window receiving
5647 the event, and so may not be the actual widget recieving focus if it
5648 is further down the containment heirarchy. Use `wx.Window.FindFocus`
5649 to get the widget that is actually receiving focus.
5ba5649b 5650 """
0085ce49
RD
5651 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5652 __repr__ = _swig_repr
5653 def __init__(self, *args, **kwargs):
5ba5649b
RD
5654 """
5655 __init__(self, Window win=None) -> ChildFocusEvent
5656
5657 Constructor
5658 """
0085ce49 5659 _core_.ChildFocusEvent_swiginit(self,_core_.new_ChildFocusEvent(*args, **kwargs))
e811c8ce 5660 def GetWindow(*args, **kwargs):
5ba5649b
RD
5661 """
5662 GetWindow(self) -> Window
5663
33d6fd3b
RD
5664 The window, or (grand)parent of the window which has just received the
5665 focus.
5ba5649b 5666 """
54f9ee45 5667 return _core_.ChildFocusEvent_GetWindow(*args, **kwargs)
e811c8ce 5668
2bf58437 5669 Window = property(GetWindow,doc="See `GetWindow`")
2131d850 5670_core_.ChildFocusEvent_swigregister(ChildFocusEvent)
d14a1e28
RD
5671
5672#---------------------------------------------------------------------------
5673
5674class ActivateEvent(Event):
5ba5649b
RD
5675 """
5676 An activate event is sent when a top-level window or the entire
5677 application is being activated or deactivated.
5678
5679 A top-level window (a dialog or frame) receives an activate event when
5680 is being activated or deactivated. This is indicated visually by the
5681 title bar changing colour, and a subwindow gaining the keyboard focus.
5682 An application is activated or deactivated when one of its frames
5683 becomes activated, or a frame becomes inactivate resulting in all
5684 application frames being inactive.
5685
5686 Please note that usually you should call event.Skip() in your handlers
5687 for these events so the default handlers will still be called, as not
5688 doing so can result in strange effects.
5689
5690 """
0085ce49
RD
5691 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5692 __repr__ = _swig_repr
5693 def __init__(self, *args, **kwargs):
5ba5649b 5694 """
2131d850 5695 __init__(self, EventType type=wxEVT_NULL, bool active=True, int Id=0) -> ActivateEvent
5ba5649b
RD
5696
5697 Constructor
5698 """
0085ce49 5699 _core_.ActivateEvent_swiginit(self,_core_.new_ActivateEvent(*args, **kwargs))
e811c8ce 5700 def GetActive(*args, **kwargs):
5ba5649b
RD
5701 """
5702 GetActive(self) -> bool
5703
5704 Returns true if the application or window is being activated, false
5705 otherwise.
5706 """
54f9ee45 5707 return _core_.ActivateEvent_GetActive(*args, **kwargs)
e811c8ce 5708
2bf58437 5709 Active = property(GetActive,doc="See `GetActive`")
2131d850 5710_core_.ActivateEvent_swigregister(ActivateEvent)
d14a1e28
RD
5711
5712#---------------------------------------------------------------------------
5713
5714class InitDialogEvent(Event):
5ba5649b
RD
5715 """
5716 A wx.InitDialogEvent is sent as a dialog is being initialised, or for
5717 any window when `wx.Window.InitDialog` is called. Handlers for this
5718 event can transfer data to the window, or anything else that should be
5719 done before the user begins editing the form. The default handler
5720 calls `wx.Window.TransferDataToWindow`.
5721 """
0085ce49
RD
5722 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5723 __repr__ = _swig_repr
5724 def __init__(self, *args, **kwargs):
5ba5649b
RD
5725 """
5726 __init__(self, int Id=0) -> InitDialogEvent
5727
5728 Constructor
5729 """
0085ce49 5730 _core_.InitDialogEvent_swiginit(self,_core_.new_InitDialogEvent(*args, **kwargs))
2131d850 5731_core_.InitDialogEvent_swigregister(InitDialogEvent)
d14a1e28
RD
5732
5733#---------------------------------------------------------------------------
5734
5735class MenuEvent(Event):
5ba5649b
RD
5736 """
5737 This class is used for a variety of menu-related events. Note that
5738 these do not include menu command events, which are handled by sending
5739 `wx.CommandEvent` objects.
5740
5741 The default handler for wx.EVT_MENU_HIGHLIGHT displays menu item help
5742 text in the first field of the status bar.
5743 """
0085ce49
RD
5744 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5745 __repr__ = _swig_repr
5746 def __init__(self, *args, **kwargs):
5ba5649b 5747 """
2131d850 5748 __init__(self, EventType type=wxEVT_NULL, int winid=0, Menu menu=None) -> MenuEvent
5ba5649b
RD
5749
5750 Constructor
5751 """
0085ce49 5752 _core_.MenuEvent_swiginit(self,_core_.new_MenuEvent(*args, **kwargs))
e811c8ce 5753 def GetMenuId(*args, **kwargs):
5ba5649b
RD
5754 """
5755 GetMenuId(self) -> int
5756
5757 Returns the menu identifier associated with the event. This method
5758 should be only used with the HIGHLIGHT events.
5759 """
54f9ee45 5760 return _core_.MenuEvent_GetMenuId(*args, **kwargs)
e811c8ce
RD
5761
5762 def IsPopup(*args, **kwargs):
5ba5649b
RD
5763 """
5764 IsPopup(self) -> bool
5765
5766 Returns ``True`` if the menu which is being opened or closed is a
5767 popup menu, ``False`` if it is a normal one. This method should only
5768 be used with the OPEN and CLOSE events.
5769 """
54f9ee45 5770 return _core_.MenuEvent_IsPopup(*args, **kwargs)
e811c8ce
RD
5771
5772 def GetMenu(*args, **kwargs):
5ba5649b
RD
5773 """
5774 GetMenu(self) -> Menu
5775
5776 Returns the menu which is being opened or closed. This method should
5777 only be used with the OPEN and CLOSE events.
5778 """
54f9ee45 5779 return _core_.MenuEvent_GetMenu(*args, **kwargs)
e811c8ce 5780
57332a5a
RD
5781 Menu = property(GetMenu,doc="See `GetMenu`")
5782 MenuId = property(GetMenuId,doc="See `GetMenuId`")
2131d850 5783_core_.MenuEvent_swigregister(MenuEvent)
d14a1e28
RD
5784
5785#---------------------------------------------------------------------------
5786
5787class CloseEvent(Event):
5ba5649b
RD
5788 """
5789 This event class contains information about window and session close
5790 events.
5791
5792 The handler function for EVT_CLOSE is called when the user has tried
5793 to close a a frame or dialog box using the window manager controls or
5794 the system menu. It can also be invoked by the application itself
5795 programmatically, for example by calling the `wx.Window.Close`
5796 function.
5797
5798 You should check whether the application is forcing the deletion of
5799 the window using `CanVeto`. If it returns ``False``, you must destroy
5800 the window using `wx.Window.Destroy`. If the return value is ``True``,
5801 it is up to you whether you respond by destroying the window or not.
5802 For example you may wish to display a message dialog prompting to save
5803 files or to cancel the close.
5804
5805 If you don't destroy the window, you should call `Veto` to let the
5806 calling code know that you did not destroy the window. This allows the
5807 `wx.Window.Close` function to return ``True`` or ``False`` depending
5808 on whether the close instruction was honored or not.
5809 """
0085ce49
RD
5810 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5811 __repr__ = _swig_repr
5812 def __init__(self, *args, **kwargs):
5ba5649b 5813 """
2131d850 5814 __init__(self, EventType type=wxEVT_NULL, int winid=0) -> CloseEvent
5ba5649b
RD
5815
5816 Constructor.
5817 """
0085ce49 5818 _core_.CloseEvent_swiginit(self,_core_.new_CloseEvent(*args, **kwargs))
e811c8ce 5819 def SetLoggingOff(*args, **kwargs):
5ba5649b
RD
5820 """
5821 SetLoggingOff(self, bool logOff)
5822
5823 Sets the 'logging off' flag.
5824 """
54f9ee45 5825 return _core_.CloseEvent_SetLoggingOff(*args, **kwargs)
e811c8ce
RD
5826
5827 def GetLoggingOff(*args, **kwargs):
5ba5649b
RD
5828 """
5829 GetLoggingOff(self) -> bool
5830
6c75a4cf
RD
5831 Returns ``True`` if the user is logging off or ``False`` if the
5832 system is shutting down. This method can only be called for end
5833 session and query end session events, it doesn't make sense for close
5834 window event.
5ba5649b 5835 """
54f9ee45 5836 return _core_.CloseEvent_GetLoggingOff(*args, **kwargs)
e811c8ce
RD
5837
5838 def Veto(*args, **kwargs):
5ba5649b
RD
5839 """
5840 Veto(self, bool veto=True)
5841
5842 Call this from your event handler to veto a system shutdown or to
5843 signal to the calling application that a window close did not happen.
5844
5845 You can only veto a shutdown or close if `CanVeto` returns true.
5846 """
54f9ee45 5847 return _core_.CloseEvent_Veto(*args, **kwargs)
e811c8ce 5848
5ba5649b
RD
5849 def GetVeto(*args, **kwargs):
5850 """GetVeto(self) -> bool"""
5851 return _core_.CloseEvent_GetVeto(*args, **kwargs)
5852
e811c8ce 5853 def SetCanVeto(*args, **kwargs):
5ba5649b
RD
5854 """
5855 SetCanVeto(self, bool canVeto)
5856
5857 Sets the 'can veto' flag.
5858 """
54f9ee45 5859 return _core_.CloseEvent_SetCanVeto(*args, **kwargs)
e811c8ce
RD
5860
5861 def CanVeto(*args, **kwargs):
5ba5649b
RD
5862 """
5863 CanVeto(self) -> bool
e811c8ce 5864
5ba5649b
RD
5865 Returns true if you can veto a system shutdown or a window close
5866 event. Vetoing a window close event is not possible if the calling
5867 code wishes to force the application to exit, and so this function
5868 must be called to check this.
5869 """
5870 return _core_.CloseEvent_CanVeto(*args, **kwargs)
e811c8ce 5871
2bf58437 5872 LoggingOff = property(GetLoggingOff,SetLoggingOff,doc="See `GetLoggingOff` and `SetLoggingOff`")
2131d850 5873_core_.CloseEvent_swigregister(CloseEvent)
d14a1e28
RD
5874
5875#---------------------------------------------------------------------------
5876
5877class ShowEvent(Event):
5ba5649b 5878 """An EVT_SHOW event is sent when a window is shown or hidden."""
0085ce49
RD
5879 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5880 __repr__ = _swig_repr
5881 def __init__(self, *args, **kwargs):
5ba5649b
RD
5882 """
5883 __init__(self, int winid=0, bool show=False) -> ShowEvent
5884
5885 An EVT_SHOW event is sent when a window is shown or hidden.
5886 """
0085ce49 5887 _core_.ShowEvent_swiginit(self,_core_.new_ShowEvent(*args, **kwargs))
e811c8ce 5888 def SetShow(*args, **kwargs):
a95a7133 5889 """SetShow(self, bool show)"""
54f9ee45 5890 return _core_.ShowEvent_SetShow(*args, **kwargs)
e811c8ce
RD
5891
5892 def GetShow(*args, **kwargs):
a95a7133 5893 """GetShow(self) -> bool"""
54f9ee45 5894 return _core_.ShowEvent_GetShow(*args, **kwargs)
e811c8ce 5895
33d6fd3b 5896 Show = property(GetShow,SetShow,doc="See `GetShow` and `SetShow`")
2131d850 5897_core_.ShowEvent_swigregister(ShowEvent)
d14a1e28
RD
5898
5899#---------------------------------------------------------------------------
5900
5901class IconizeEvent(Event):
5ba5649b
RD
5902 """
5903 An EVT_ICONIZE event is sent when a frame is iconized (minimized) or
5904 restored.
5905 """
0085ce49
RD
5906 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5907 __repr__ = _swig_repr
5908 def __init__(self, *args, **kwargs):
5ba5649b
RD
5909 """
5910 __init__(self, int id=0, bool iconized=True) -> IconizeEvent
5911
5912 An EVT_ICONIZE event is sent when a frame is iconized (minimized) or
5913 restored.
5914 """
0085ce49 5915 _core_.IconizeEvent_swiginit(self,_core_.new_IconizeEvent(*args, **kwargs))
e811c8ce 5916 def Iconized(*args, **kwargs):
5ba5649b
RD
5917 """
5918 Iconized(self) -> bool
5919
5920 Returns ``True`` if the frame has been iconized, ``False`` if it has
5921 been restored.
5922 """
54f9ee45 5923 return _core_.IconizeEvent_Iconized(*args, **kwargs)
e811c8ce 5924
2131d850 5925_core_.IconizeEvent_swigregister(IconizeEvent)
d14a1e28
RD
5926
5927#---------------------------------------------------------------------------
5928
5929class MaximizeEvent(Event):
5ba5649b 5930 """An EVT_MAXIMIZE event is sent when a frame is maximized or restored."""
0085ce49
RD
5931 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5932 __repr__ = _swig_repr
5933 def __init__(self, *args, **kwargs):
5ba5649b
RD
5934 """
5935 __init__(self, int id=0) -> MaximizeEvent
5936
5937 An EVT_MAXIMIZE event is sent when a frame is maximized or restored.
5938 """
0085ce49 5939 _core_.MaximizeEvent_swiginit(self,_core_.new_MaximizeEvent(*args, **kwargs))
2131d850 5940_core_.MaximizeEvent_swigregister(MaximizeEvent)
d14a1e28
RD
5941
5942#---------------------------------------------------------------------------
5943
5944class DropFilesEvent(Event):
5ba5649b
RD
5945 """
5946 This class is used for drop files events, that is, when files have
5947 been dropped onto the window. This functionality is only available
5948 under Windows. The window must have previously been enabled for
5949 dropping by calling `wx.Window.DragAcceptFiles`.
5950
5951 Important note: this is a separate implementation to the more general
5952 drag and drop implementation using `wx.FileDropTarget`, and etc. This
5953 implementation uses the older, Windows message-based approach of
5954 dropping files.
5955
5956 Use wx.EVT_DROP_FILES to bind an event handler to receive file drop
5957 events.
5958
5959 """
0085ce49
RD
5960 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5961 def __init__(self): raise AttributeError, "No constructor defined"
5962 __repr__ = _swig_repr
e811c8ce 5963 def GetPosition(*args, **kwargs):
5ba5649b
RD
5964 """
5965 GetPosition(self) -> Point
5966
5967 Returns the position at which the files were dropped.
5968 """
54f9ee45 5969 return _core_.DropFilesEvent_GetPosition(*args, **kwargs)
e811c8ce
RD
5970
5971 def GetNumberOfFiles(*args, **kwargs):
5ba5649b
RD
5972 """
5973 GetNumberOfFiles(self) -> int
5974
5975 Returns the number of files dropped.
5976 """
54f9ee45 5977 return _core_.DropFilesEvent_GetNumberOfFiles(*args, **kwargs)
e811c8ce
RD
5978
5979 def GetFiles(*args, **kwargs):
5ba5649b
RD
5980 """
5981 GetFiles(self) -> PyObject
5982
5983 Returns a list of the filenames that were dropped.
5984 """
54f9ee45 5985 return _core_.DropFilesEvent_GetFiles(*args, **kwargs)
e811c8ce 5986
2bf58437
RD
5987 Files = property(GetFiles,doc="See `GetFiles`")
5988 NumberOfFiles = property(GetNumberOfFiles,doc="See `GetNumberOfFiles`")
5989 Position = property(GetPosition,doc="See `GetPosition`")
2131d850 5990_core_.DropFilesEvent_swigregister(DropFilesEvent)
d14a1e28
RD
5991
5992#---------------------------------------------------------------------------
5993
54f9ee45
RD
5994UPDATE_UI_PROCESS_ALL = _core_.UPDATE_UI_PROCESS_ALL
5995UPDATE_UI_PROCESS_SPECIFIED = _core_.UPDATE_UI_PROCESS_SPECIFIED
d14a1e28 5996class UpdateUIEvent(CommandEvent):
5ba5649b
RD
5997 """
5998 This class is used for EVT_UPDATE_UI pseudo-events which are sent by
5999 wxWidgets to give an application the chance to update various user
6000 interface elements.
6001
6002 Without update UI events, an application has to work hard to
6003 check/uncheck, enable/disable, and set the text for elements such as
6004 menu items and toolbar buttons. The code for doing this has to be
6005 mixed up with the code that is invoked when an action is invoked for a
6006 menu item or button.
6007
6008 With update UI events, you define an event handler to look at the
6009 state of the application and change UI elements accordingly. wxWidgets
6010 will call your handler functions in idle time, so you don't have to
6011 worry where to call this code. In addition to being a clearer and more
6012 declarative method, it also means you don't have to worry whether
6013 you're updating a toolbar or menubar identifier. The same handler can
6014 update a menu item and toolbar button, if the ID values are the same.
6015
6016 Instead of directly manipulating the menu or button, you call
6017 functions in the event object, such as `Check`. wxWidgets will
6018 determine whether such a call has been made, and which UI element to
6019 update.
6020
6021 These events will work for popup menus as well as menubars. Just
6022 before a menu is popped up, `wx.Menu.UpdateUI` is called to process
6023 any UI events for the window that owns the menu.
6024
6025 If you find that the overhead of UI update processing is affecting
6026 your application, you can do one or both of the following:
6027
6028 1. Call `wx.UpdateUIEvent.SetMode` with a value of
6029 wx.UPDATE_UI_PROCESS_SPECIFIED, and set the extra style
6030 wx.WS_EX_PROCESS_UPDATE_EVENTS for every window that should
6031 receive update events. No other windows will receive update
6032 events.
6033
6034 2. Call `wx.UpdateUIEvent.SetUpdateInterval` with a millisecond
6035 value to set the delay between updates. You may need to call
6036 `wx.Window.UpdateWindowUI` at critical points, for example when
6037 a dialog is about to be shown, in case the user sees a slight
6038 delay before windows are updated.
6039
6040 Note that although events are sent in idle time, defining a EVT_IDLE
6041 handler for a window does not affect this because the events are sent
6042 from an internal idle handler.
6043
6044 wxWidgets tries to optimize update events on some platforms. On
6045 Windows and GTK+, events for menubar items are only sent when the menu
6046 is about to be shown, and not in idle time.
6047
6048 """
0085ce49
RD
6049 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6050 __repr__ = _swig_repr
6051 def __init__(self, *args, **kwargs):
5ba5649b
RD
6052 """
6053 __init__(self, int commandId=0) -> UpdateUIEvent
6054
6055 Constructor
6056 """
0085ce49 6057 _core_.UpdateUIEvent_swiginit(self,_core_.new_UpdateUIEvent(*args, **kwargs))
e811c8ce 6058 def GetChecked(*args, **kwargs):
5ba5649b
RD
6059 """
6060 GetChecked(self) -> bool
6061
6062 Returns ``True`` if the UI element should be checked.
6063 """
54f9ee45 6064 return _core_.UpdateUIEvent_GetChecked(*args, **kwargs)
e811c8ce
RD
6065
6066 def GetEnabled(*args, **kwargs):
5ba5649b
RD
6067 """
6068 GetEnabled(self) -> bool
6069
6070 Returns ``True`` if the UI element should be enabled.
6071 """
54f9ee45 6072 return _core_.UpdateUIEvent_GetEnabled(*args, **kwargs)
e811c8ce 6073
b1fcee84
RD
6074 def GetShown(*args, **kwargs):
6075 """
6076 GetShown(self) -> bool
6077
6078 Returns ``True`` if the UI element should be shown.
6079 """
6080 return _core_.UpdateUIEvent_GetShown(*args, **kwargs)
6081
e811c8ce 6082 def GetText(*args, **kwargs):
5ba5649b
RD
6083 """
6084 GetText(self) -> String
6085
6086 Returns the text that should be set for the UI element.
6087 """
54f9ee45 6088 return _core_.UpdateUIEvent_GetText(*args, **kwargs)
e811c8ce
RD
6089
6090 def GetSetText(*args, **kwargs):
5ba5649b
RD
6091 """
6092 GetSetText(self) -> bool
6093
6094 Returns ``True`` if the application has called `SetText`. For
6095 wxWidgets internal use only.
6096 """
54f9ee45 6097 return _core_.UpdateUIEvent_GetSetText(*args, **kwargs)
e811c8ce
RD
6098
6099 def GetSetChecked(*args, **kwargs):
5ba5649b
RD
6100 """
6101 GetSetChecked(self) -> bool
6102
6103 Returns ``True`` if the application has called `Check`. For wxWidgets
6104 internal use only.
6105 """
54f9ee45 6106 return _core_.UpdateUIEvent_GetSetChecked(*args, **kwargs)
e811c8ce
RD
6107
6108 def GetSetEnabled(*args, **kwargs):
5ba5649b
RD
6109 """
6110 GetSetEnabled(self) -> bool
6111
6112 Returns ``True`` if the application has called `Enable`. For wxWidgets
6113 internal use only.
6114 """
54f9ee45 6115 return _core_.UpdateUIEvent_GetSetEnabled(*args, **kwargs)
e811c8ce 6116
b1fcee84
RD
6117 def GetSetShown(*args, **kwargs):
6118 """
6119 GetSetShown(self) -> bool
6120
6121 Returns ``True`` if the application has called `Show`. For wxWidgets
6122 internal use only.
6123 """
6124 return _core_.UpdateUIEvent_GetSetShown(*args, **kwargs)
6125
e811c8ce 6126 def Check(*args, **kwargs):
5ba5649b
RD
6127 """
6128 Check(self, bool check)
6129
6130 Check or uncheck the UI element.
6131 """
54f9ee45 6132 return _core_.UpdateUIEvent_Check(*args, **kwargs)
e811c8ce
RD
6133
6134 def Enable(*args, **kwargs):
5ba5649b
RD
6135 """
6136 Enable(self, bool enable)
6137
6138 Enable or disable the UI element.
6139 """
54f9ee45 6140 return _core_.UpdateUIEvent_Enable(*args, **kwargs)
e811c8ce 6141
b1fcee84
RD
6142 def Show(*args, **kwargs):
6143 """
6144 Show(self, bool show)
6145
6146 Show or hide the UI element.
6147 """
6148 return _core_.UpdateUIEvent_Show(*args, **kwargs)
6149
e811c8ce 6150 def SetText(*args, **kwargs):
5ba5649b
RD
6151 """
6152 SetText(self, String text)
6153
6154 Sets the text for this UI element.
6155 """
54f9ee45 6156 return _core_.UpdateUIEvent_SetText(*args, **kwargs)
e811c8ce
RD
6157
6158 def SetUpdateInterval(*args, **kwargs):
5ba5649b
RD
6159 """
6160 SetUpdateInterval(long updateInterval)
6161
6162 Sets the interval between updates in milliseconds. Set to -1 to
6163 disable updates, or to 0 to update as frequently as possible. The
6164 default is 0.
6165
6166 Use this to reduce the overhead of UI update events if your
6167 application has a lot of windows. If you set the value to -1 or
6168 greater than 0, you may also need to call `wx.Window.UpdateWindowUI`
6169 at appropriate points in your application, such as when a dialog is
6170 about to be shown.
6171 """
54f9ee45 6172 return _core_.UpdateUIEvent_SetUpdateInterval(*args, **kwargs)
e811c8ce
RD
6173
6174 SetUpdateInterval = staticmethod(SetUpdateInterval)
6175 def GetUpdateInterval(*args, **kwargs):
5ba5649b
RD
6176 """
6177 GetUpdateInterval() -> long
6178
6179 Returns the current interval between updates in milliseconds. -1
6180 disables updates, 0 updates as frequently as possible.
6181 """
54f9ee45 6182 return _core_.UpdateUIEvent_GetUpdateInterval(*args, **kwargs)
e811c8ce
RD
6183
6184 GetUpdateInterval = staticmethod(GetUpdateInterval)
6185 def CanUpdate(*args, **kwargs):
5ba5649b
RD
6186 """
6187 CanUpdate(Window win) -> bool
6188
6189 Returns ``True`` if it is appropriate to update (send UI update events
6190 to) this window.
6191
6192 This function looks at the mode used (see `wx.UpdateUIEvent.SetMode`),
6193 the wx.WS_EX_PROCESS_UPDATE_EVENTS flag in window, the time update
6194 events were last sent in idle time, and the update interval, to
6195 determine whether events should be sent to this window now. By default
6196 this will always return true because the update mode is initially
6197 wx.UPDATE_UI_PROCESS_ALL and the interval is set to 0; so update
6198 events will be sent as often as possible. You can reduce the frequency
6199 that events are sent by changing the mode and/or setting an update
6200 interval.
6201
6202 """
54f9ee45 6203 return _core_.UpdateUIEvent_CanUpdate(*args, **kwargs)
e811c8ce
RD
6204
6205 CanUpdate = staticmethod(CanUpdate)
6206 def ResetUpdateTime(*args, **kwargs):
5ba5649b
RD
6207 """
6208 ResetUpdateTime()
6209
6210 Used internally to reset the last-updated time to the current time. It
6211 is assumed that update events are normally sent in idle time, so this
6212 is called at the end of idle processing.
6213 """
54f9ee45 6214 return _core_.UpdateUIEvent_ResetUpdateTime(*args, **kwargs)
e811c8ce
RD
6215
6216 ResetUpdateTime = staticmethod(ResetUpdateTime)
6217 def SetMode(*args, **kwargs):
5ba5649b
RD
6218 """
6219 SetMode(int mode)
6220
6221 Specify how wxWidgets will send update events: to all windows, or only
6222 to those which specify that they will process the events.
6223
6224 The mode may be one of the following values:
6225
6226 ============================= ==========================================
6227 wxUPDATE_UI_PROCESS_ALL Send UI update events to all windows. This
6228 is the default setting.
6229 wxUPDATE_UI_PROCESS_SPECIFIED Send UI update events only to windows that
6230 have the wx.WS_EX_PROCESS_UI_UPDATES extra
6231 style set.
6232 ============================= ==========================================
6233
6234 """
54f9ee45 6235 return _core_.UpdateUIEvent_SetMode(*args, **kwargs)
e811c8ce
RD
6236
6237 SetMode = staticmethod(SetMode)
6238 def GetMode(*args, **kwargs):
5ba5649b
RD
6239 """
6240 GetMode() -> int
6241
6242 Returns a value specifying how wxWidgets will send update events: to
6243 all windows, or only to those which specify that they will process the
6244 events.
6245 """
54f9ee45 6246 return _core_.UpdateUIEvent_GetMode(*args, **kwargs)
e811c8ce
RD
6247
6248 GetMode = staticmethod(GetMode)
dba7934c
RD
6249 Checked = property(GetChecked,Check,doc="See `GetChecked`")
6250 Enabled = property(GetEnabled,Enable,doc="See `GetEnabled`")
6251 Shown = property(GetShown,Show,doc="See `GetShown`")
6252 Text = property(GetText,SetText,doc="See `GetText` and `SetText`")
2131d850 6253_core_.UpdateUIEvent_swigregister(UpdateUIEvent)
d14a1e28 6254
e811c8ce 6255def UpdateUIEvent_SetUpdateInterval(*args, **kwargs):
0085ce49 6256 """
5ba5649b
RD
6257 UpdateUIEvent_SetUpdateInterval(long updateInterval)
6258
6259 Sets the interval between updates in milliseconds. Set to -1 to
6260 disable updates, or to 0 to update as frequently as possible. The
6261 default is 0.
6262
6263 Use this to reduce the overhead of UI update events if your
6264 application has a lot of windows. If you set the value to -1 or
6265 greater than 0, you may also need to call `wx.Window.UpdateWindowUI`
6266 at appropriate points in your application, such as when a dialog is
6267 about to be shown.
6268 """
0085ce49 6269 return _core_.UpdateUIEvent_SetUpdateInterval(*args, **kwargs)
d14a1e28 6270
0085ce49
RD
6271def UpdateUIEvent_GetUpdateInterval(*args):
6272 """
5ba5649b
RD
6273 UpdateUIEvent_GetUpdateInterval() -> long
6274
6275 Returns the current interval between updates in milliseconds. -1
6276 disables updates, 0 updates as frequently as possible.
6277 """
0085ce49 6278 return _core_.UpdateUIEvent_GetUpdateInterval(*args)
d14a1e28 6279
e811c8ce 6280def UpdateUIEvent_CanUpdate(*args, **kwargs):
0085ce49 6281 """
5ba5649b
RD
6282 UpdateUIEvent_CanUpdate(Window win) -> bool
6283
6284 Returns ``True`` if it is appropriate to update (send UI update events
6285 to) this window.
6286
6287 This function looks at the mode used (see `wx.UpdateUIEvent.SetMode`),
6288 the wx.WS_EX_PROCESS_UPDATE_EVENTS flag in window, the time update
6289 events were last sent in idle time, and the update interval, to
6290 determine whether events should be sent to this window now. By default
6291 this will always return true because the update mode is initially
6292 wx.UPDATE_UI_PROCESS_ALL and the interval is set to 0; so update
6293 events will be sent as often as possible. You can reduce the frequency
6294 that events are sent by changing the mode and/or setting an update
6295 interval.
6296
6297 """
0085ce49 6298 return _core_.UpdateUIEvent_CanUpdate(*args, **kwargs)
d14a1e28 6299
0085ce49
RD
6300def UpdateUIEvent_ResetUpdateTime(*args):
6301 """
5ba5649b
RD
6302 UpdateUIEvent_ResetUpdateTime()
6303
6304 Used internally to reset the last-updated time to the current time. It
6305 is assumed that update events are normally sent in idle time, so this
6306 is called at the end of idle processing.
6307 """
0085ce49 6308 return _core_.UpdateUIEvent_ResetUpdateTime(*args)
d14a1e28 6309
e811c8ce 6310def UpdateUIEvent_SetMode(*args, **kwargs):
0085ce49 6311 """
5ba5649b
RD
6312 UpdateUIEvent_SetMode(int mode)
6313
6314 Specify how wxWidgets will send update events: to all windows, or only
6315 to those which specify that they will process the events.
6316
6317 The mode may be one of the following values:
6318
6319 ============================= ==========================================
6320 wxUPDATE_UI_PROCESS_ALL Send UI update events to all windows. This
6321 is the default setting.
6322 wxUPDATE_UI_PROCESS_SPECIFIED Send UI update events only to windows that
6323 have the wx.WS_EX_PROCESS_UI_UPDATES extra
6324 style set.
6325 ============================= ==========================================
6326
6327 """
0085ce49 6328 return _core_.UpdateUIEvent_SetMode(*args, **kwargs)
d14a1e28 6329
0085ce49
RD
6330def UpdateUIEvent_GetMode(*args):
6331 """
5ba5649b
RD
6332 UpdateUIEvent_GetMode() -> int
6333
6334 Returns a value specifying how wxWidgets will send update events: to
6335 all windows, or only to those which specify that they will process the
6336 events.
6337 """
0085ce49 6338 return _core_.UpdateUIEvent_GetMode(*args)
d14a1e28
RD
6339
6340#---------------------------------------------------------------------------
6341
6342class SysColourChangedEvent(Event):
5ba5649b
RD
6343 """
6344 This class is used for EVT_SYS_COLOUR_CHANGED, which are generated
6345 when the user changes the colour settings using the control
6346 panel. This is only applicable under Windows.
6347
6348 The default event handler for this event propagates the event to child
6349 windows, since Windows only sends the events to top-level windows. If
6350 intercepting this event for a top-level window, remember to call
6351 `Skip` so the the base class handler will still be executed, or to
6352 pass the event on to the window's children explicitly.
6353
6354 """
0085ce49
RD
6355 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6356 __repr__ = _swig_repr
6357 def __init__(self, *args, **kwargs):
5ba5649b
RD
6358 """
6359 __init__(self) -> SysColourChangedEvent
6360
6361 Constructor
6362 """
0085ce49 6363 _core_.SysColourChangedEvent_swiginit(self,_core_.new_SysColourChangedEvent(*args, **kwargs))
2131d850 6364_core_.SysColourChangedEvent_swigregister(SysColourChangedEvent)
d14a1e28
RD
6365
6366#---------------------------------------------------------------------------
6367
6368class MouseCaptureChangedEvent(Event):
5ba5649b
RD
6369 """
6370 An mouse capture changed event (EVT_MOUSE_CAPTURE_CHANGED) is sent to
6371 a window that loses its mouse capture. This is called even if
6372 `wx.Window.ReleaseMouse` was called by the application code. Handling
6373 this event allows an application to cater for unexpected capture
6374 releases which might otherwise confuse mouse handling code.
6375
6376 This event is implemented under Windows only.
6377 """
0085ce49
RD
6378 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6379 __repr__ = _swig_repr
6380 def __init__(self, *args, **kwargs):
5ba5649b
RD
6381 """
6382 __init__(self, int winid=0, Window gainedCapture=None) -> MouseCaptureChangedEvent
6383
6384 Constructor
6385 """
0085ce49 6386 _core_.MouseCaptureChangedEvent_swiginit(self,_core_.new_MouseCaptureChangedEvent(*args, **kwargs))
e811c8ce 6387 def GetCapturedWindow(*args, **kwargs):
5ba5649b
RD
6388 """
6389 GetCapturedWindow(self) -> Window
6390
6391 Returns the window that gained the capture, or ``None`` if it was a
6392 non-wxWidgets window.
6393 """
54f9ee45 6394 return _core_.MouseCaptureChangedEvent_GetCapturedWindow(*args, **kwargs)
e811c8ce 6395
57332a5a 6396 CapturedWindow = property(GetCapturedWindow,doc="See `GetCapturedWindow`")
2131d850 6397_core_.MouseCaptureChangedEvent_swigregister(MouseCaptureChangedEvent)
d14a1e28
RD
6398
6399#---------------------------------------------------------------------------
6400
34e0a3bb
RD
6401class MouseCaptureLostEvent(Event):
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 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6418 __repr__ = _swig_repr
6419 def __init__(self, *args, **kwargs):
6420 """
6421 __init__(self, int winid=0) -> MouseCaptureLostEvent
6422
6423 A mouse capture lost event is sent to a window that obtained mouse
6424 capture, which was subsequently loss due to "external" event, for
6425 example when a dialog box is shown or if another application captures
6426 the mouse.
6427
6428 If this happens, this event is sent to all windows that are on the
6429 capture stack (i.e. a window that called `wx.Window.CaptureMouse`, but
6430 didn't call `wx.Window.ReleaseMouse` yet). The event is *not* sent
6431 if the capture changes because of a call to CaptureMouse or
6432 ReleaseMouse.
6433
6434 This event is currently emitted under Windows only.
6435
6436 """
6437 _core_.MouseCaptureLostEvent_swiginit(self,_core_.new_MouseCaptureLostEvent(*args, **kwargs))
6438_core_.MouseCaptureLostEvent_swigregister(MouseCaptureLostEvent)
6439
6440#---------------------------------------------------------------------------
6441
d14a1e28 6442class DisplayChangedEvent(Event):
5ba5649b
RD
6443 """
6444 An EVT_DISPLAY_CHANGED event is sent to all windows when the display
6445 resolution has changed.
6446
6447 This event is implemented under Windows only.
6448 """
0085ce49
RD
6449 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6450 __repr__ = _swig_repr
6451 def __init__(self, *args, **kwargs):
a95a7133 6452 """__init__(self) -> DisplayChangedEvent"""
0085ce49 6453 _core_.DisplayChangedEvent_swiginit(self,_core_.new_DisplayChangedEvent(*args, **kwargs))
2131d850 6454_core_.DisplayChangedEvent_swigregister(DisplayChangedEvent)
d14a1e28
RD
6455
6456#---------------------------------------------------------------------------
6457
6458class PaletteChangedEvent(Event):
5ba5649b
RD
6459 """
6460 An EVT_PALETTE_CHANGED event is sent when the system palette has
6461 changed, thereby giving each window a chance to redo their own to
6462 match.
6463
6464 This event is implemented under Windows only.
6465 """
0085ce49
RD
6466 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6467 __repr__ = _swig_repr
6468 def __init__(self, *args, **kwargs):
5ba5649b
RD
6469 """
6470 __init__(self, int id=0) -> PaletteChangedEvent
6471
6472 An EVT_PALETTE_CHANGED event is sent when the system palette has
6473 changed, thereby giving each window a chance to redo their own to
6474 match.
6475
6476 This event is implemented under Windows only.
6477 """
0085ce49 6478 _core_.PaletteChangedEvent_swiginit(self,_core_.new_PaletteChangedEvent(*args, **kwargs))
e811c8ce 6479 def SetChangedWindow(*args, **kwargs):
a95a7133 6480 """SetChangedWindow(self, Window win)"""
54f9ee45 6481 return _core_.PaletteChangedEvent_SetChangedWindow(*args, **kwargs)
e811c8ce
RD
6482
6483 def GetChangedWindow(*args, **kwargs):
a95a7133 6484 """GetChangedWindow(self) -> Window"""
54f9ee45 6485 return _core_.PaletteChangedEvent_GetChangedWindow(*args, **kwargs)
e811c8ce 6486
33d6fd3b 6487 ChangedWindow = property(GetChangedWindow,SetChangedWindow,doc="See `GetChangedWindow` and `SetChangedWindow`")
2131d850 6488_core_.PaletteChangedEvent_swigregister(PaletteChangedEvent)
d14a1e28
RD
6489
6490#---------------------------------------------------------------------------
6491
6492class QueryNewPaletteEvent(Event):
5ba5649b
RD
6493 """
6494 An EVT_QUERY_NEW_PALETE event indicates the window is getting keyboard
6495 focus and should re-do its palette.
6496
6497 This event is implemented under Windows only.
6498 """
0085ce49
RD
6499 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6500 __repr__ = _swig_repr
6501 def __init__(self, *args, **kwargs):
5ba5649b
RD
6502 """
6503 __init__(self, int winid=0) -> QueryNewPaletteEvent
6504
6505 Constructor.
6506 """
0085ce49 6507 _core_.QueryNewPaletteEvent_swiginit(self,_core_.new_QueryNewPaletteEvent(*args, **kwargs))
e811c8ce 6508 def SetPaletteRealized(*args, **kwargs):
5ba5649b
RD
6509 """
6510 SetPaletteRealized(self, bool realized)
6511
6512 App should set this if it changes the palette.
6513 """
54f9ee45 6514 return _core_.QueryNewPaletteEvent_SetPaletteRealized(*args, **kwargs)
e811c8ce
RD
6515
6516 def GetPaletteRealized(*args, **kwargs):
a95a7133 6517 """GetPaletteRealized(self) -> bool"""
54f9ee45 6518 return _core_.QueryNewPaletteEvent_GetPaletteRealized(*args, **kwargs)
e811c8ce 6519
33d6fd3b 6520 PaletteRealized = property(GetPaletteRealized,SetPaletteRealized,doc="See `GetPaletteRealized` and `SetPaletteRealized`")
2131d850 6521_core_.QueryNewPaletteEvent_swigregister(QueryNewPaletteEvent)
d14a1e28
RD
6522
6523#---------------------------------------------------------------------------
6524
6525class NavigationKeyEvent(Event):
5ba5649b
RD
6526 """
6527 EVT_NAVIGATION_KEY events are used to control moving the focus between
6528 widgets, otherwise known as tab-traversal. You woudl normally not
6529 catch navigation events in applications as there are already
6530 appropriate handlers in `wx.Dialog` and `wx.Panel`, but you may find
6531 it useful to send navigation events in certain situations to change
6532 the focus in certain ways, although it's probably easier to just call
6533 `wx.Window.Navigate`.
6534 """
0085ce49
RD
6535 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6536 __repr__ = _swig_repr
6537 def __init__(self, *args, **kwargs):
a95a7133 6538 """__init__(self) -> NavigationKeyEvent"""
0085ce49 6539 _core_.NavigationKeyEvent_swiginit(self,_core_.new_NavigationKeyEvent(*args, **kwargs))
e811c8ce 6540 def GetDirection(*args, **kwargs):
5ba5649b
RD
6541 """
6542 GetDirection(self) -> bool
6543
6544 Returns ``True`` if the direction is forward, ``False`` otherwise.
6545 """
54f9ee45 6546 return _core_.NavigationKeyEvent_GetDirection(*args, **kwargs)
e811c8ce
RD
6547
6548 def SetDirection(*args, **kwargs):
5ba5649b
RD
6549 """
6550 SetDirection(self, bool forward)
6551
6552 Specify the direction that the navigation should take. Usually the
6553 difference between using Tab and Shift-Tab.
6554 """
54f9ee45 6555 return _core_.NavigationKeyEvent_SetDirection(*args, **kwargs)
e811c8ce
RD
6556
6557 def IsWindowChange(*args, **kwargs):
5ba5649b
RD
6558 """
6559 IsWindowChange(self) -> bool
6560
6561 Returns ``True`` if window change is allowed.
6562 """
54f9ee45 6563 return _core_.NavigationKeyEvent_IsWindowChange(*args, **kwargs)
e811c8ce
RD
6564
6565 def SetWindowChange(*args, **kwargs):
5ba5649b
RD
6566 """
6567 SetWindowChange(self, bool ischange)
6568
6569 Specify if the navigation should be able to change parent windows.
6570 For example, changing notebook pages, etc. This is usually implemented
6571 by using Control-Tab.
6572 """
54f9ee45 6573 return _core_.NavigationKeyEvent_SetWindowChange(*args, **kwargs)
e811c8ce 6574
68350608 6575 def IsFromTab(*args, **kwargs):
5ba5649b
RD
6576 """
6577 IsFromTab(self) -> bool
6578
6579 Returns ``True`` if the navigation event is originated from the Tab
6580 key.
6581 """
68350608
RD
6582 return _core_.NavigationKeyEvent_IsFromTab(*args, **kwargs)
6583
6584 def SetFromTab(*args, **kwargs):
5ba5649b
RD
6585 """
6586 SetFromTab(self, bool bIs)
6587
6588 Set to true under MSW if the event was generated using the tab key.
6589 This is required for proper navogation over radio buttons.
6590 """
68350608
RD
6591 return _core_.NavigationKeyEvent_SetFromTab(*args, **kwargs)
6592
908b74cd 6593 def SetFlags(*args, **kwargs):
5ba5649b
RD
6594 """
6595 SetFlags(self, long flags)
6596
6597 Set the navigation flags to a combination of the following:
6598
6599 * wx.NavigationKeyEvent.IsBackward
6600 * wx.NavigationKeyEvent.IsForward
6601 * wx.NavigationKeyEvent.WinChange
6602 * wx.NavigationKeyEvent.FromTab
6603
6604 """
908b74cd
RD
6605 return _core_.NavigationKeyEvent_SetFlags(*args, **kwargs)
6606
e811c8ce 6607 def GetCurrentFocus(*args, **kwargs):
5ba5649b
RD
6608 """
6609 GetCurrentFocus(self) -> Window
6610
6611 Returns the child window which currenty has the focus. May be
6612 ``None``.
6613 """
54f9ee45 6614 return _core_.NavigationKeyEvent_GetCurrentFocus(*args, **kwargs)
e811c8ce
RD
6615
6616 def SetCurrentFocus(*args, **kwargs):
5ba5649b
RD
6617 """
6618 SetCurrentFocus(self, Window win)
6619
6620 Set the window that has the focus.
6621 """
54f9ee45 6622 return _core_.NavigationKeyEvent_SetCurrentFocus(*args, **kwargs)
e811c8ce 6623
b0f7404b 6624 IsBackward = _core_.NavigationKeyEvent_IsBackward
908b74cd
RD
6625 IsForward = _core_.NavigationKeyEvent_IsForward
6626 WinChange = _core_.NavigationKeyEvent_WinChange
68350608 6627 FromTab = _core_.NavigationKeyEvent_FromTab
57332a5a
RD
6628 CurrentFocus = property(GetCurrentFocus,SetCurrentFocus,doc="See `GetCurrentFocus` and `SetCurrentFocus`")
6629 Direction = property(GetDirection,SetDirection,doc="See `GetDirection` and `SetDirection`")
2131d850 6630_core_.NavigationKeyEvent_swigregister(NavigationKeyEvent)
d14a1e28
RD
6631
6632#---------------------------------------------------------------------------
6633
6634class WindowCreateEvent(CommandEvent):
5ba5649b
RD
6635 """
6636 The EVT_WINDOW_CREATE event is sent as soon as the window object (the
6637 underlying GUI object) exists.
6638 """
0085ce49
RD
6639 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6640 __repr__ = _swig_repr
6641 def __init__(self, *args, **kwargs):
5ba5649b
RD
6642 """
6643 __init__(self, Window win=None) -> WindowCreateEvent
6644
6645 The EVT_WINDOW_CREATE event is sent as soon as the window object (the
6646 underlying GUI object) exists.
6647 """
0085ce49 6648 _core_.WindowCreateEvent_swiginit(self,_core_.new_WindowCreateEvent(*args, **kwargs))
e811c8ce 6649 def GetWindow(*args, **kwargs):
5ba5649b
RD
6650 """
6651 GetWindow(self) -> Window
6652
6653 Returns the window that this event refers to.
6654 """
54f9ee45 6655 return _core_.WindowCreateEvent_GetWindow(*args, **kwargs)
e811c8ce 6656
dba7934c 6657 Window = property(GetWindow,doc="See `GetWindow`")
2131d850 6658_core_.WindowCreateEvent_swigregister(WindowCreateEvent)
d14a1e28
RD
6659
6660class WindowDestroyEvent(CommandEvent):
5ba5649b 6661 """
943e8dfd
RD
6662 The EVT_WINDOW_DESTROY event is sent from the `wx.Window` destructor
6663 when the GUI window is destroyed.
6664
6665 When a class derived from `wx.Window` is destroyed its destructor will
6666 have already run by the time this event is sent. Therefore this event
6667 will not usually be received at all by the window itself. Since it is
6668 received after the destructor has run, an object should not try to
6669 handle its own wx.WindowDestroyEvent, but it can be used to get
6670 notification of the destruction of another window.
5ba5649b 6671 """
0085ce49
RD
6672 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6673 __repr__ = _swig_repr
6674 def __init__(self, *args, **kwargs):
5ba5649b
RD
6675 """
6676 __init__(self, Window win=None) -> WindowDestroyEvent
6677
943e8dfd
RD
6678 The EVT_WINDOW_DESTROY event is sent from the `wx.Window` destructor
6679 when the GUI window is destroyed.
6680
6681 When a class derived from `wx.Window` is destroyed its destructor will
6682 have already run by the time this event is sent. Therefore this event
6683 will not usually be received at all by the window itself. Since it is
6684 received after the destructor has run, an object should not try to
6685 handle its own wx.WindowDestroyEvent, but it can be used to get
6686 notification of the destruction of another window.
5ba5649b 6687 """
0085ce49 6688 _core_.WindowDestroyEvent_swiginit(self,_core_.new_WindowDestroyEvent(*args, **kwargs))
e811c8ce 6689 def GetWindow(*args, **kwargs):
5ba5649b
RD
6690 """
6691 GetWindow(self) -> Window
6692
6693 Returns the window that this event refers to.
6694 """
54f9ee45 6695 return _core_.WindowDestroyEvent_GetWindow(*args, **kwargs)
e811c8ce 6696
dba7934c 6697 Window = property(GetWindow,doc="See `GetWindow`")
2131d850 6698_core_.WindowDestroyEvent_swigregister(WindowDestroyEvent)
d14a1e28
RD
6699
6700#---------------------------------------------------------------------------
6701
6702class ContextMenuEvent(CommandEvent):
5ba5649b
RD
6703 """
6704 This class is used for context menu events (EVT_CONTECT_MENU,) sent to
6705 give the application a chance to show a context (popup) menu.
6706 """
0085ce49
RD
6707 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6708 __repr__ = _swig_repr
6709 def __init__(self, *args, **kwargs):
5ba5649b 6710 """
2131d850 6711 __init__(self, EventType type=wxEVT_NULL, int winid=0, Point pt=DefaultPosition) -> ContextMenuEvent
5ba5649b
RD
6712
6713 Constructor.
6714 """
0085ce49 6715 _core_.ContextMenuEvent_swiginit(self,_core_.new_ContextMenuEvent(*args, **kwargs))
e811c8ce 6716 def GetPosition(*args, **kwargs):
5ba5649b
RD
6717 """
6718 GetPosition(self) -> Point
6719
6720 Returns the position (in screen coordinants) at which the menu should
6721 be shown.
6722 """
54f9ee45 6723 return _core_.ContextMenuEvent_GetPosition(*args, **kwargs)
e811c8ce
RD
6724
6725 def SetPosition(*args, **kwargs):
5ba5649b
RD
6726 """
6727 SetPosition(self, Point pos)
6728
6729 Sets the position at which the menu should be shown.
6730 """
54f9ee45 6731 return _core_.ContextMenuEvent_SetPosition(*args, **kwargs)
e811c8ce 6732
2bf58437 6733 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
2131d850 6734_core_.ContextMenuEvent_swigregister(ContextMenuEvent)
d14a1e28
RD
6735
6736#---------------------------------------------------------------------------
6737
54f9ee45
RD
6738IDLE_PROCESS_ALL = _core_.IDLE_PROCESS_ALL
6739IDLE_PROCESS_SPECIFIED = _core_.IDLE_PROCESS_SPECIFIED
d14a1e28 6740class IdleEvent(Event):
5ba5649b
RD
6741 """
6742 This class is used for EVT_IDLE events, which are generated and sent
6743 when the application *becomes* idle. In other words, the when the
6744 event queue becomes empty then idle events are sent to all windows (by
6745 default) and as long as none of them call `RequestMore` then there are
6746 no more idle events until after the system event queue has some normal
6747 events and then becomes empty again.
6748
6749 By default, idle events are sent to all windows. If this is causing a
6750 significant overhead in your application, you can call
6751 `wx.IdleEvent.SetMode` with the value wx.IDLE_PROCESS_SPECIFIED, and
6752 set the wx.WS_EX_PROCESS_IDLE extra window style for every window
6753 which should receive idle events. Then idle events will only be sent
6754 to those windows and not to any others.
6755 """
0085ce49
RD
6756 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6757 __repr__ = _swig_repr
6758 def __init__(self, *args, **kwargs):
5ba5649b
RD
6759 """
6760 __init__(self) -> IdleEvent
6761
6762 Constructor
6763 """
0085ce49 6764 _core_.IdleEvent_swiginit(self,_core_.new_IdleEvent(*args, **kwargs))
e811c8ce 6765 def RequestMore(*args, **kwargs):
5ba5649b
RD
6766 """
6767 RequestMore(self, bool needMore=True)
6768
6769 Tells wxWidgets that more processing is required. This function can be
6770 called by an EVT_IDLE handler for a window to indicate that the
6771 application should forward the EVT_IDLE event once more to the
6772 application windows. If no window calls this function during its
6773 EVT_IDLE handler, then the application will remain in a passive event
6774 loop until a new event is posted to the application by the windowing
6775 system.
6776 """
54f9ee45 6777 return _core_.IdleEvent_RequestMore(*args, **kwargs)
e811c8ce
RD
6778
6779 def MoreRequested(*args, **kwargs):
5ba5649b
RD
6780 """
6781 MoreRequested(self) -> bool
6782
6783 Returns ``True`` if the OnIdle function processing this event
6784 requested more processing time.
6785 """
54f9ee45 6786 return _core_.IdleEvent_MoreRequested(*args, **kwargs)
e811c8ce
RD
6787
6788 def SetMode(*args, **kwargs):
5ba5649b
RD
6789 """
6790 SetMode(int mode)
6791
6792 Static method for specifying how wxWidgets will send idle events: to
6793 all windows, or only to those which specify that they will process the
6794 events.
6795
6796 The mode can be one of the following values:
6797
6798 ========================= ========================================
6799 wx.IDLE_PROCESS_ALL Send idle events to all windows
6800 wx.IDLE_PROCESS_SPECIFIED Send idle events only to windows that have
6801 the wx.WS_EX_PROCESS_IDLE extra style
6802 flag set.
6803 ========================= ========================================
6804
6805 """
54f9ee45 6806 return _core_.IdleEvent_SetMode(*args, **kwargs)
e811c8ce
RD
6807
6808 SetMode = staticmethod(SetMode)
6809 def GetMode(*args, **kwargs):
5ba5649b
RD
6810 """
6811 GetMode() -> int
6812
6813 Static method returning a value specifying how wxWidgets will send
6814 idle events: to all windows, or only to those which specify that they
6815 will process the events.
6816 """
54f9ee45 6817 return _core_.IdleEvent_GetMode(*args, **kwargs)
e811c8ce
RD
6818
6819 GetMode = staticmethod(GetMode)
6820 def CanSend(*args, **kwargs):
5ba5649b
RD
6821 """
6822 CanSend(Window win) -> bool
6823
6824 Returns ``True`` if it is appropriate to send idle events to this
6825 window.
6826
6827 This function looks at the mode used (see `wx.IdleEvent.SetMode`), and
6828 the wx.WS_EX_PROCESS_IDLE style in window to determine whether idle
6829 events should be sent to this window now. By default this will always
6830 return ``True`` because the update mode is initially
6831 wx.IDLE_PROCESS_ALL. You can change the mode to only send idle events
6832 to windows with the wx.WS_EX_PROCESS_IDLE extra window style set.
6833 """
54f9ee45 6834 return _core_.IdleEvent_CanSend(*args, **kwargs)
e811c8ce
RD
6835
6836 CanSend = staticmethod(CanSend)
2131d850 6837_core_.IdleEvent_swigregister(IdleEvent)
d14a1e28 6838
e811c8ce 6839def IdleEvent_SetMode(*args, **kwargs):
0085ce49 6840 """
5ba5649b
RD
6841 IdleEvent_SetMode(int mode)
6842
6843 Static method for specifying how wxWidgets will send idle events: to
6844 all windows, or only to those which specify that they will process the
6845 events.
6846
6847 The mode can be one of the following values:
6848
6849 ========================= ========================================
6850 wx.IDLE_PROCESS_ALL Send idle events to all windows
6851 wx.IDLE_PROCESS_SPECIFIED Send idle events only to windows that have
6852 the wx.WS_EX_PROCESS_IDLE extra style
6853 flag set.
6854 ========================= ========================================
6855
6856 """
0085ce49 6857 return _core_.IdleEvent_SetMode(*args, **kwargs)
d14a1e28 6858
0085ce49
RD
6859def IdleEvent_GetMode(*args):
6860 """
5ba5649b
RD
6861 IdleEvent_GetMode() -> int
6862
6863 Static method returning a value specifying how wxWidgets will send
6864 idle events: to all windows, or only to those which specify that they
6865 will process the events.
6866 """
0085ce49 6867 return _core_.IdleEvent_GetMode(*args)
d14a1e28 6868
e811c8ce 6869def IdleEvent_CanSend(*args, **kwargs):
0085ce49 6870 """
5ba5649b
RD
6871 IdleEvent_CanSend(Window win) -> bool
6872
6873 Returns ``True`` if it is appropriate to send idle events to this
6874 window.
6875
6876 This function looks at the mode used (see `wx.IdleEvent.SetMode`), and
6877 the wx.WS_EX_PROCESS_IDLE style in window to determine whether idle
6878 events should be sent to this window now. By default this will always
6879 return ``True`` because the update mode is initially
6880 wx.IDLE_PROCESS_ALL. You can change the mode to only send idle events
6881 to windows with the wx.WS_EX_PROCESS_IDLE extra window style set.
6882 """
0085ce49 6883 return _core_.IdleEvent_CanSend(*args, **kwargs)
d14a1e28
RD
6884
6885#---------------------------------------------------------------------------
6886
2131d850
RD
6887class ClipboardTextEvent(CommandEvent):
6888 """
6889 A Clipboard Text event is sent when a window intercepts a text
6890 copy/cut/paste message, i.e. the user has cut/copied/pasted data
6891 from/into a text control via ctrl-C/X/V, ctrl/shift-del/insert, a
6892 popup menu command, etc. NOTE : under windows these events are *NOT*
6893 generated automatically for a Rich Edit text control.
6894 """
6895 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6896 __repr__ = _swig_repr
6897 def __init__(self, *args, **kwargs):
6898 """
6899 __init__(self, EventType type=wxEVT_NULL, int winid=0) -> ClipboardTextEvent
6900
6901 A Clipboard Text event is sent when a window intercepts a text
6902 copy/cut/paste message, i.e. the user has cut/copied/pasted data
6903 from/into a text control via ctrl-C/X/V, ctrl/shift-del/insert, a
6904 popup menu command, etc. NOTE : under windows these events are *NOT*
6905 generated automatically for a Rich Edit text control.
6906 """
6907 _core_.ClipboardTextEvent_swiginit(self,_core_.new_ClipboardTextEvent(*args, **kwargs))
6908_core_.ClipboardTextEvent_swigregister(ClipboardTextEvent)
6909
6910#---------------------------------------------------------------------------
6911
d14a1e28 6912class PyEvent(Event):
5ba5649b
RD
6913 """
6914 wx.PyEvent can be used as a base class for implementing custom event
6915 types in Python. You should derived from this class instead of
6916 `wx.Event` because this class is Python-aware and is able to transport
6917 its Python bits safely through the wxWidgets event system and have
6918 them still be there when the event handler is invoked.
6919
6920 :see: `wx.PyCommandEvent`
6921
6922 """
0085ce49
RD
6923 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6924 __repr__ = _swig_repr
6925 def __init__(self, *args, **kwargs):
2131d850 6926 """__init__(self, int winid=0, EventType eventType=wxEVT_NULL) -> PyEvent"""
0085ce49 6927 _core_.PyEvent_swiginit(self,_core_.new_PyEvent(*args, **kwargs))
5ba5649b 6928 self._SetSelf(self)
e811c8ce 6929
0085ce49
RD
6930 __swig_destroy__ = _core_.delete_PyEvent
6931 __del__ = lambda self : None;
5ba5649b
RD
6932 def _SetSelf(*args, **kwargs):
6933 """_SetSelf(self, PyObject self)"""
6934 return _core_.PyEvent__SetSelf(*args, **kwargs)
e811c8ce 6935
5ba5649b
RD
6936 def _GetSelf(*args, **kwargs):
6937 """_GetSelf(self) -> PyObject"""
6938 return _core_.PyEvent__GetSelf(*args, **kwargs)
e811c8ce 6939
2131d850 6940_core_.PyEvent_swigregister(PyEvent)
d14a1e28
RD
6941
6942class PyCommandEvent(CommandEvent):
5ba5649b
RD
6943 """
6944 wx.PyCommandEvent can be used as a base class for implementing custom
6945 event types in Python, where the event shoudl travel up to parent
6946 windows looking for a handler. You should derived from this class
6947 instead of `wx.CommandEvent` because this class is Python-aware and is
6948 able to transport its Python bits safely through the wxWidgets event
6949 system and have them still be there when the event handler is invoked.
6950
6951 :see: `wx.PyEvent`
6952
6953 """
0085ce49
RD
6954 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6955 __repr__ = _swig_repr
6956 def __init__(self, *args, **kwargs):
2131d850 6957 """__init__(self, EventType eventType=wxEVT_NULL, int id=0) -> PyCommandEvent"""
0085ce49 6958 _core_.PyCommandEvent_swiginit(self,_core_.new_PyCommandEvent(*args, **kwargs))
5ba5649b 6959 self._SetSelf(self)
e811c8ce 6960
0085ce49
RD
6961 __swig_destroy__ = _core_.delete_PyCommandEvent
6962 __del__ = lambda self : None;
5ba5649b
RD
6963 def _SetSelf(*args, **kwargs):
6964 """_SetSelf(self, PyObject self)"""
6965 return _core_.PyCommandEvent__SetSelf(*args, **kwargs)
e811c8ce 6966
5ba5649b
RD
6967 def _GetSelf(*args, **kwargs):
6968 """_GetSelf(self) -> PyObject"""
6969 return _core_.PyCommandEvent__GetSelf(*args, **kwargs)
e811c8ce 6970
2131d850 6971_core_.PyCommandEvent_swigregister(PyCommandEvent)
d14a1e28 6972
53aa7709 6973class DateEvent(CommandEvent):
5ba5649b
RD
6974 """
6975 This event class holds information about a date change event and is
6976 used together with `wx.DatePickerCtrl`. It also serves as a base class
6977 for `wx.calendar.CalendarEvent`. Bind these event types with
6978 EVT_DATE_CHANGED.
6979 """
0085ce49
RD
6980 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6981 __repr__ = _swig_repr
6982 def __init__(self, *args, **kwargs):
2131d850 6983 """__init__(self, Window win, DateTime dt, EventType type) -> DateEvent"""
0085ce49 6984 _core_.DateEvent_swiginit(self,_core_.new_DateEvent(*args, **kwargs))
53aa7709 6985 def GetDate(*args, **kwargs):
5ba5649b
RD
6986 """
6987 GetDate(self) -> DateTime
6988
6989 Returns the date.
6990 """
53aa7709
RD
6991 return _core_.DateEvent_GetDate(*args, **kwargs)
6992
6993 def SetDate(*args, **kwargs):
5ba5649b
RD
6994 """
6995 SetDate(self, DateTime date)
6996
6997 Sets the date carried by the event, normally only used by the library
6998 internally.
6999 """
53aa7709
RD
7000 return _core_.DateEvent_SetDate(*args, **kwargs)
7001
2bf58437 7002 Date = property(GetDate,SetDate,doc="See `GetDate` and `SetDate`")
2131d850 7003_core_.DateEvent_swigregister(DateEvent)
53aa7709
RD
7004
7005wxEVT_DATE_CHANGED = _core_.wxEVT_DATE_CHANGED
7006EVT_DATE_CHANGED = wx.PyEventBinder( wxEVT_DATE_CHANGED, 1 )
7007
4976f996
RD
7008class EventBlocker(EvtHandler):
7009 """Helper class to temporarily disable event handling for a window."""
7010 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7011 __repr__ = _swig_repr
7012 def __init__(self, *args, **kwargs):
7013 """
7014 __init__(self, Window win, EventType type=wxEVT_ANY) -> EventBlocker
7015
7016 Helper class to temporarily disable event handling for a window.
7017 """
7018 _core_.EventBlocker_swiginit(self,_core_.new_EventBlocker(*args, **kwargs))
7019 __swig_destroy__ = _core_.delete_EventBlocker
7020 __del__ = lambda self : None;
7021 def Block(*args, **kwargs):
7022 """Block(self, EventType type)"""
7023 return _core_.EventBlocker_Block(*args, **kwargs)
7024
7025_core_.EventBlocker_swigregister(EventBlocker)
7026
d14a1e28
RD
7027#---------------------------------------------------------------------------
7028
54f9ee45
RD
7029PYAPP_ASSERT_SUPPRESS = _core_.PYAPP_ASSERT_SUPPRESS
7030PYAPP_ASSERT_EXCEPTION = _core_.PYAPP_ASSERT_EXCEPTION
7031PYAPP_ASSERT_DIALOG = _core_.PYAPP_ASSERT_DIALOG
7032PYAPP_ASSERT_LOG = _core_.PYAPP_ASSERT_LOG
7033PRINT_WINDOWS = _core_.PRINT_WINDOWS
7034PRINT_POSTSCRIPT = _core_.PRINT_POSTSCRIPT
d14a1e28 7035class PyApp(EvtHandler):
66c033b4
RD
7036 """
7037 The ``wx.PyApp`` class is an *implementation detail*, please use the
7038 `wx.App` class (or some other derived class) instead.
7039 """
0085ce49
RD
7040 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7041 __repr__ = _swig_repr
7042 def __init__(self, *args, **kwargs):
98e665d3 7043 """
a95a7133 7044 __init__(self) -> PyApp
98e665d3
RD
7045
7046 Create a new application object, starting the bootstrap process.
7047 """
0085ce49 7048 _core_.PyApp_swiginit(self,_core_.new_PyApp(*args, **kwargs))
c25f90f6 7049 self._setOORInfo(self, False);PyApp._setCallbackInfo(self, self, PyApp)
e811c8ce 7050
0085ce49
RD
7051 __swig_destroy__ = _core_.delete_PyApp
7052 __del__ = lambda self : None;
e811c8ce 7053 def _setCallbackInfo(*args, **kwargs):
c25f90f6 7054 """_setCallbackInfo(self, PyObject self, PyObject _class, bool incref=False)"""
54f9ee45 7055 return _core_.PyApp__setCallbackInfo(*args, **kwargs)
e811c8ce
RD
7056
7057 def GetAppName(*args, **kwargs):
0df68c9f 7058 """
a95a7133 7059 GetAppName(self) -> String
6c3b4aae 7060
0df68c9f
RD
7061 Get the application name.
7062 """
54f9ee45 7063 return _core_.PyApp_GetAppName(*args, **kwargs)
e811c8ce
RD
7064
7065 def SetAppName(*args, **kwargs):
0df68c9f 7066 """
a95a7133 7067 SetAppName(self, String name)
6c3b4aae 7068
66c033b4
RD
7069 Set the application name. This value may be used automatically by
7070 `wx.Config` and such.
0df68c9f 7071 """
54f9ee45 7072 return _core_.PyApp_SetAppName(*args, **kwargs)
e811c8ce
RD
7073
7074 def GetClassName(*args, **kwargs):
0df68c9f 7075 """
a95a7133 7076 GetClassName(self) -> String
e811c8ce 7077
0df68c9f
RD
7078 Get the application's class name.
7079 """
54f9ee45 7080 return _core_.PyApp_GetClassName(*args, **kwargs)
e811c8ce
RD
7081
7082 def SetClassName(*args, **kwargs):
0df68c9f 7083 """
a95a7133 7084 SetClassName(self, String name)
6c3b4aae 7085
66c033b4
RD
7086 Set the application's class name. This value may be used for
7087 X-resources if applicable for the platform
0df68c9f 7088 """
54f9ee45 7089 return _core_.PyApp_SetClassName(*args, **kwargs)
e811c8ce
RD
7090
7091 def GetVendorName(*args, **kwargs):
0df68c9f 7092 """
a95a7133 7093 GetVendorName(self) -> String
6c3b4aae 7094
0df68c9f
RD
7095 Get the application's vendor name.
7096 """
54f9ee45 7097 return _core_.PyApp_GetVendorName(*args, **kwargs)
e811c8ce
RD
7098
7099 def SetVendorName(*args, **kwargs):
0df68c9f 7100 """
a95a7133 7101 SetVendorName(self, String name)
6c3b4aae 7102
66c033b4
RD
7103 Set the application's vendor name. This value may be used
7104 automatically by `wx.Config` and such.
0df68c9f 7105 """
54f9ee45 7106 return _core_.PyApp_SetVendorName(*args, **kwargs)
e811c8ce
RD
7107
7108 def GetTraits(*args, **kwargs):
0df68c9f 7109 """
a95a7133 7110 GetTraits(self) -> wxAppTraits
6c3b4aae 7111
66c033b4
RD
7112 Return (and create if necessary) the app traits object to which we
7113 delegate for everything which either should be configurable by the
7114 user (then he can change the default behaviour simply by overriding
7115 CreateTraits() and returning his own traits object) or which is
7116 GUI/console dependent as then wx.AppTraits allows us to abstract the
7117 differences behind the common facade.
7118
7119 :todo: Add support for overriding CreateAppTraits in wxPython.
0df68c9f 7120 """
54f9ee45 7121 return _core_.PyApp_GetTraits(*args, **kwargs)
e811c8ce
RD
7122
7123 def ProcessPendingEvents(*args, **kwargs):
0df68c9f 7124 """
a95a7133 7125 ProcessPendingEvents(self)
6c3b4aae 7126
66c033b4
RD
7127 Process all events in the Pending Events list -- it is necessary to
7128 call this function to process posted events. This normally happens
7129 during each event loop iteration.
0df68c9f 7130 """
54f9ee45 7131 return _core_.PyApp_ProcessPendingEvents(*args, **kwargs)
e811c8ce
RD
7132
7133 def Yield(*args, **kwargs):
0df68c9f 7134 """
a95a7133 7135 Yield(self, bool onlyIfNeeded=False) -> bool
6c3b4aae 7136
66c033b4
RD
7137 Process all currently pending events right now, instead of waiting
7138 until return to the event loop. It is an error to call ``Yield``
7139 recursively unless the value of ``onlyIfNeeded`` is True.
6c3b4aae 7140
66c033b4 7141 :warning: This function is dangerous as it can lead to unexpected
41e2b43e
RD
7142 reentrancies (i.e. when called from an event handler it may
7143 result in calling the same event handler again), use with
7144 extreme care or, better, don't use at all!
0df68c9f 7145
66c033b4 7146 :see: `wx.Yield`, `wx.YieldIfNeeded`, `wx.SafeYield`
41e2b43e 7147
0df68c9f 7148 """
54f9ee45 7149 return _core_.PyApp_Yield(*args, **kwargs)
e811c8ce
RD
7150
7151 def WakeUpIdle(*args, **kwargs):
0df68c9f 7152 """
a95a7133 7153 WakeUpIdle(self)
6c3b4aae 7154
66c033b4
RD
7155 Make sure that idle events are sent again.
7156 :see: `wx.WakeUpIdle`
0df68c9f 7157 """
54f9ee45 7158 return _core_.PyApp_WakeUpIdle(*args, **kwargs)
e811c8ce 7159
1fc3b23a
RD
7160 def IsMainLoopRunning(*args, **kwargs):
7161 """
7162 IsMainLoopRunning() -> bool
7163
7164 Returns True if we're running the main loop, i.e. if the events can
7165 currently be dispatched.
7166 """
7167 return _core_.PyApp_IsMainLoopRunning(*args, **kwargs)
7168
7169 IsMainLoopRunning = staticmethod(IsMainLoopRunning)
e811c8ce 7170 def MainLoop(*args, **kwargs):
0df68c9f 7171 """
a95a7133 7172 MainLoop(self) -> int
6c3b4aae 7173
66c033b4
RD
7174 Execute the main GUI loop, the function doesn't normally return until
7175 all top level windows have been closed and destroyed.
0df68c9f 7176 """
54f9ee45 7177 return _core_.PyApp_MainLoop(*args, **kwargs)
e811c8ce
RD
7178
7179 def Exit(*args, **kwargs):
0df68c9f 7180 """
a95a7133 7181 Exit(self)
6c3b4aae 7182
0df68c9f 7183 Exit the main loop thus terminating the application.
66c033b4 7184 :see: `wx.Exit`
0df68c9f 7185 """
54f9ee45 7186 return _core_.PyApp_Exit(*args, **kwargs)
e811c8ce 7187
97ab0f6a
RD
7188 def GetLayoutDirection(*args, **kwargs):
7189 """
994453b8 7190 GetLayoutDirection(self) -> int
97ab0f6a
RD
7191
7192 Return the layout direction for the current locale.
7193 """
7194 return _core_.PyApp_GetLayoutDirection(*args, **kwargs)
7195
e811c8ce 7196 def ExitMainLoop(*args, **kwargs):
0df68c9f 7197 """
a95a7133 7198 ExitMainLoop(self)
6c3b4aae 7199
66c033b4
RD
7200 Exit the main GUI loop during the next iteration of the main
7201 loop, (i.e. it does not stop the program immediately!)
0df68c9f 7202 """
54f9ee45 7203 return _core_.PyApp_ExitMainLoop(*args, **kwargs)
e811c8ce
RD
7204
7205 def Pending(*args, **kwargs):
0df68c9f 7206 """
a95a7133 7207 Pending(self) -> bool
6c3b4aae 7208
0df68c9f
RD
7209 Returns True if there are unprocessed events in the event queue.
7210 """
54f9ee45 7211 return _core_.PyApp_Pending(*args, **kwargs)
e811c8ce
RD
7212
7213 def Dispatch(*args, **kwargs):
0df68c9f 7214 """
a95a7133 7215 Dispatch(self) -> bool
6c3b4aae 7216
0df68c9f
RD
7217 Process the first event in the event queue (blocks until an event
7218 appears if there are none currently)
7219 """
54f9ee45 7220 return _core_.PyApp_Dispatch(*args, **kwargs)
e811c8ce
RD
7221
7222 def ProcessIdle(*args, **kwargs):
0df68c9f 7223 """
a95a7133 7224 ProcessIdle(self) -> bool
6c3b4aae 7225
66c033b4
RD
7226 Called from the MainLoop when the application becomes idle (there are
7227 no pending events) and sends a `wx.IdleEvent` to all interested
7228 parties. Returns True if more idle events are needed, False if not.
0df68c9f 7229 """
54f9ee45 7230 return _core_.PyApp_ProcessIdle(*args, **kwargs)
e811c8ce
RD
7231
7232 def SendIdleEvents(*args, **kwargs):
0df68c9f 7233 """
a95a7133 7234 SendIdleEvents(self, Window win, IdleEvent event) -> bool
e811c8ce 7235
66c033b4
RD
7236 Send idle event to window and all subwindows. Returns True if more
7237 idle time is requested.
0df68c9f 7238 """
54f9ee45 7239 return _core_.PyApp_SendIdleEvents(*args, **kwargs)
e811c8ce
RD
7240
7241 def IsActive(*args, **kwargs):
0df68c9f 7242 """
a95a7133 7243 IsActive(self) -> bool
6c3b4aae 7244
0df68c9f
RD
7245 Return True if our app has focus.
7246 """
54f9ee45 7247 return _core_.PyApp_IsActive(*args, **kwargs)
e811c8ce
RD
7248
7249 def SetTopWindow(*args, **kwargs):
0df68c9f 7250 """
a95a7133 7251 SetTopWindow(self, Window win)
6c3b4aae 7252
66c033b4 7253 Set the *main* top level window
0df68c9f 7254 """
54f9ee45 7255 return _core_.PyApp_SetTopWindow(*args, **kwargs)
e811c8ce
RD
7256
7257 def GetTopWindow(*args, **kwargs):
0df68c9f 7258 """
a95a7133 7259 GetTopWindow(self) -> Window
6c3b4aae 7260
66c033b4
RD
7261 Return the *main* top level window (if it hadn't been set previously
7262 with SetTopWindow(), will return just some top level window and, if
7263 there not any, will return None)
0df68c9f 7264 """
54f9ee45 7265 return _core_.PyApp_GetTopWindow(*args, **kwargs)
e811c8ce
RD
7266
7267 def SetExitOnFrameDelete(*args, **kwargs):
0df68c9f 7268 """
a95a7133 7269 SetExitOnFrameDelete(self, bool flag)
0df68c9f 7270
66c033b4
RD
7271 Control the exit behaviour: by default, the program will exit the main
7272 loop (and so, usually, terminate) when the last top-level program
7273 window is deleted. Beware that if you disable this behaviour (with
7274 SetExitOnFrameDelete(False)), you'll have to call ExitMainLoop()
7275 explicitly from somewhere.
0df68c9f 7276 """
54f9ee45 7277 return _core_.PyApp_SetExitOnFrameDelete(*args, **kwargs)
e811c8ce
RD
7278
7279 def GetExitOnFrameDelete(*args, **kwargs):
0df68c9f 7280 """
a95a7133 7281 GetExitOnFrameDelete(self) -> bool
6c3b4aae 7282
0df68c9f
RD
7283 Get the current exit behaviour setting.
7284 """
54f9ee45 7285 return _core_.PyApp_GetExitOnFrameDelete(*args, **kwargs)
e811c8ce
RD
7286
7287 def SetUseBestVisual(*args, **kwargs):
0df68c9f 7288 """
eccab1a7 7289 SetUseBestVisual(self, bool flag, bool forceTrueColour=False)
6c3b4aae 7290
66c033b4
RD
7291 Set whether the app should try to use the best available visual on
7292 systems where more than one is available, (Sun, SGI, XFree86 4, etc.)
0df68c9f 7293 """
54f9ee45 7294 return _core_.PyApp_SetUseBestVisual(*args, **kwargs)
e811c8ce
RD
7295
7296 def GetUseBestVisual(*args, **kwargs):
0df68c9f 7297 """
a95a7133 7298 GetUseBestVisual(self) -> bool
6c3b4aae 7299
0df68c9f
RD
7300 Get current UseBestVisual setting.
7301 """
54f9ee45 7302 return _core_.PyApp_GetUseBestVisual(*args, **kwargs)
e811c8ce
RD
7303
7304 def SetPrintMode(*args, **kwargs):
a95a7133 7305 """SetPrintMode(self, int mode)"""
54f9ee45 7306 return _core_.PyApp_SetPrintMode(*args, **kwargs)
e811c8ce
RD
7307
7308 def GetPrintMode(*args, **kwargs):
a95a7133 7309 """GetPrintMode(self) -> int"""
54f9ee45 7310 return _core_.PyApp_GetPrintMode(*args, **kwargs)
e811c8ce 7311
e811c8ce 7312 def SetAssertMode(*args, **kwargs):
0df68c9f 7313 """
a95a7133 7314 SetAssertMode(self, int mode)
6c3b4aae 7315
41e2b43e 7316 Set the OnAssert behaviour for debug and hybrid builds.
0df68c9f 7317 """
54f9ee45 7318 return _core_.PyApp_SetAssertMode(*args, **kwargs)
e811c8ce 7319
6c3b4aae 7320 def GetAssertMode(*args, **kwargs):
0df68c9f 7321 """
a95a7133 7322 GetAssertMode(self) -> int
6c3b4aae 7323
0df68c9f
RD
7324 Get the current OnAssert behaviour setting.
7325 """
54f9ee45 7326 return _core_.PyApp_GetAssertMode(*args, **kwargs)
6c3b4aae 7327
e811c8ce 7328 def GetMacSupportPCMenuShortcuts(*args, **kwargs):
66c033b4 7329 """GetMacSupportPCMenuShortcuts() -> bool"""
54f9ee45 7330 return _core_.PyApp_GetMacSupportPCMenuShortcuts(*args, **kwargs)
e811c8ce
RD
7331
7332 GetMacSupportPCMenuShortcuts = staticmethod(GetMacSupportPCMenuShortcuts)
7333 def GetMacAboutMenuItemId(*args, **kwargs):
66c033b4 7334 """GetMacAboutMenuItemId() -> long"""
54f9ee45 7335 return _core_.PyApp_GetMacAboutMenuItemId(*args, **kwargs)
e811c8ce
RD
7336
7337 GetMacAboutMenuItemId = staticmethod(GetMacAboutMenuItemId)
7338 def GetMacPreferencesMenuItemId(*args, **kwargs):
66c033b4 7339 """GetMacPreferencesMenuItemId() -> long"""
54f9ee45 7340 return _core_.PyApp_GetMacPreferencesMenuItemId(*args, **kwargs)
e811c8ce
RD
7341
7342 GetMacPreferencesMenuItemId = staticmethod(GetMacPreferencesMenuItemId)
7343 def GetMacExitMenuItemId(*args, **kwargs):
66c033b4 7344 """GetMacExitMenuItemId() -> long"""
54f9ee45 7345 return _core_.PyApp_GetMacExitMenuItemId(*args, **kwargs)
e811c8ce
RD
7346
7347 GetMacExitMenuItemId = staticmethod(GetMacExitMenuItemId)
7348 def GetMacHelpMenuTitleName(*args, **kwargs):
66c033b4 7349 """GetMacHelpMenuTitleName() -> String"""
54f9ee45 7350 return _core_.PyApp_GetMacHelpMenuTitleName(*args, **kwargs)
e811c8ce
RD
7351
7352 GetMacHelpMenuTitleName = staticmethod(GetMacHelpMenuTitleName)
7353 def SetMacSupportPCMenuShortcuts(*args, **kwargs):
66c033b4 7354 """SetMacSupportPCMenuShortcuts(bool val)"""
54f9ee45 7355 return _core_.PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs)
e811c8ce
RD
7356
7357 SetMacSupportPCMenuShortcuts = staticmethod(SetMacSupportPCMenuShortcuts)
7358 def SetMacAboutMenuItemId(*args, **kwargs):
66c033b4 7359 """SetMacAboutMenuItemId(long val)"""
54f9ee45 7360 return _core_.PyApp_SetMacAboutMenuItemId(*args, **kwargs)
e811c8ce
RD
7361
7362 SetMacAboutMenuItemId = staticmethod(SetMacAboutMenuItemId)
7363 def SetMacPreferencesMenuItemId(*args, **kwargs):
66c033b4 7364 """SetMacPreferencesMenuItemId(long val)"""
54f9ee45 7365 return _core_.PyApp_SetMacPreferencesMenuItemId(*args, **kwargs)
e811c8ce
RD
7366
7367 SetMacPreferencesMenuItemId = staticmethod(SetMacPreferencesMenuItemId)
7368 def SetMacExitMenuItemId(*args, **kwargs):
66c033b4 7369 """SetMacExitMenuItemId(long val)"""
54f9ee45 7370 return _core_.PyApp_SetMacExitMenuItemId(*args, **kwargs)
e811c8ce
RD
7371
7372 SetMacExitMenuItemId = staticmethod(SetMacExitMenuItemId)
7373 def SetMacHelpMenuTitleName(*args, **kwargs):
66c033b4 7374 """SetMacHelpMenuTitleName(String val)"""
54f9ee45 7375 return _core_.PyApp_SetMacHelpMenuTitleName(*args, **kwargs)
e811c8ce
RD
7376
7377 SetMacHelpMenuTitleName = staticmethod(SetMacHelpMenuTitleName)
7378 def _BootstrapApp(*args, **kwargs):
0df68c9f 7379 """
a95a7133 7380 _BootstrapApp(self)
6c3b4aae 7381
0df68c9f
RD
7382 For internal use only
7383 """
54f9ee45 7384 return _core_.PyApp__BootstrapApp(*args, **kwargs)
e811c8ce
RD
7385
7386 def GetComCtl32Version(*args, **kwargs):
0df68c9f 7387 """
66c033b4 7388 GetComCtl32Version() -> int
6c3b4aae 7389
66c033b4
RD
7390 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
7391 it wasn't found at all. Raises an exception on non-Windows platforms.
0df68c9f 7392 """
54f9ee45 7393 return _core_.PyApp_GetComCtl32Version(*args, **kwargs)
e811c8ce
RD
7394
7395 GetComCtl32Version = staticmethod(GetComCtl32Version)
33d6fd3b 7396 def IsDisplayAvailable(*args, **kwargs):
fc46b7f3 7397 """
33d6fd3b 7398 IsDisplayAvailable() -> bool
fc46b7f3
RD
7399
7400 Tests if it is possible to create a GUI in the current environment.
7401 This will mean different things on the different platforms.
7402
7403 * On X Windows systems this function will return ``False`` if it is
7404 not able to open a connection to the X display, which can happen
7405 if $DISPLAY is not set, or is not set correctly.
7406
7407 * On Mac OS X a ``False`` return value will mean that wx is not
7408 able to access the window manager, which can happen if logged in
7409 remotely or if running from the normal version of python instead
7410 of the framework version, (i.e., pythonw.)
7411
7412 * On MS Windows...
7413
7414 """
33d6fd3b
RD
7415 return _core_.PyApp_IsDisplayAvailable(*args, **kwargs)
7416
7417 IsDisplayAvailable = staticmethod(IsDisplayAvailable)
7418 AppName = property(GetAppName,SetAppName,doc="See `GetAppName` and `SetAppName`")
7419 AssertMode = property(GetAssertMode,SetAssertMode,doc="See `GetAssertMode` and `SetAssertMode`")
7420 ClassName = property(GetClassName,SetClassName,doc="See `GetClassName` and `SetClassName`")
7421 ExitOnFrameDelete = property(GetExitOnFrameDelete,SetExitOnFrameDelete,doc="See `GetExitOnFrameDelete` and `SetExitOnFrameDelete`")
7422 LayoutDirection = property(GetLayoutDirection,doc="See `GetLayoutDirection`")
7423 PrintMode = property(GetPrintMode,SetPrintMode,doc="See `GetPrintMode` and `SetPrintMode`")
7424 TopWindow = property(GetTopWindow,SetTopWindow,doc="See `GetTopWindow` and `SetTopWindow`")
7425 Traits = property(GetTraits,doc="See `GetTraits`")
7426 UseBestVisual = property(GetUseBestVisual,SetUseBestVisual,doc="See `GetUseBestVisual` and `SetUseBestVisual`")
7427 VendorName = property(GetVendorName,SetVendorName,doc="See `GetVendorName` and `SetVendorName`")
7428 Active = property(IsActive)
2131d850 7429_core_.PyApp_swigregister(PyApp)
d14a1e28 7430
0085ce49
RD
7431def PyApp_IsMainLoopRunning(*args):
7432 """
1fc3b23a
RD
7433 PyApp_IsMainLoopRunning() -> bool
7434
7435 Returns True if we're running the main loop, i.e. if the events can
7436 currently be dispatched.
7437 """
0085ce49 7438 return _core_.PyApp_IsMainLoopRunning(*args)
1fc3b23a 7439
0085ce49
RD
7440def PyApp_GetMacSupportPCMenuShortcuts(*args):
7441 """PyApp_GetMacSupportPCMenuShortcuts() -> bool"""
7442 return _core_.PyApp_GetMacSupportPCMenuShortcuts(*args)
d14a1e28 7443
0085ce49
RD
7444def PyApp_GetMacAboutMenuItemId(*args):
7445 """PyApp_GetMacAboutMenuItemId() -> long"""
7446 return _core_.PyApp_GetMacAboutMenuItemId(*args)
d14a1e28 7447
0085ce49
RD
7448def PyApp_GetMacPreferencesMenuItemId(*args):
7449 """PyApp_GetMacPreferencesMenuItemId() -> long"""
7450 return _core_.PyApp_GetMacPreferencesMenuItemId(*args)
d14a1e28 7451
0085ce49
RD
7452def PyApp_GetMacExitMenuItemId(*args):
7453 """PyApp_GetMacExitMenuItemId() -> long"""
7454 return _core_.PyApp_GetMacExitMenuItemId(*args)
d14a1e28 7455
0085ce49
RD
7456def PyApp_GetMacHelpMenuTitleName(*args):
7457 """PyApp_GetMacHelpMenuTitleName() -> String"""
7458 return _core_.PyApp_GetMacHelpMenuTitleName(*args)
d14a1e28 7459
e811c8ce 7460def PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs):
0085ce49
RD
7461 """PyApp_SetMacSupportPCMenuShortcuts(bool val)"""
7462 return _core_.PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs)
d14a1e28 7463
e811c8ce 7464def PyApp_SetMacAboutMenuItemId(*args, **kwargs):
0085ce49
RD
7465 """PyApp_SetMacAboutMenuItemId(long val)"""
7466 return _core_.PyApp_SetMacAboutMenuItemId(*args, **kwargs)
d14a1e28 7467
e811c8ce 7468def PyApp_SetMacPreferencesMenuItemId(*args, **kwargs):
0085ce49
RD
7469 """PyApp_SetMacPreferencesMenuItemId(long val)"""
7470 return _core_.PyApp_SetMacPreferencesMenuItemId(*args, **kwargs)
d14a1e28 7471
e811c8ce 7472def PyApp_SetMacExitMenuItemId(*args, **kwargs):
0085ce49
RD
7473 """PyApp_SetMacExitMenuItemId(long val)"""
7474 return _core_.PyApp_SetMacExitMenuItemId(*args, **kwargs)
d14a1e28 7475
e811c8ce 7476def PyApp_SetMacHelpMenuTitleName(*args, **kwargs):
0085ce49
RD
7477 """PyApp_SetMacHelpMenuTitleName(String val)"""
7478 return _core_.PyApp_SetMacHelpMenuTitleName(*args, **kwargs)
d14a1e28 7479
0085ce49
RD
7480def PyApp_GetComCtl32Version(*args):
7481 """
0df68c9f 7482 PyApp_GetComCtl32Version() -> int
6c3b4aae 7483
66c033b4
RD
7484 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
7485 it wasn't found at all. Raises an exception on non-Windows platforms.
0df68c9f 7486 """
0085ce49 7487 return _core_.PyApp_GetComCtl32Version(*args)
d14a1e28 7488
33d6fd3b 7489def PyApp_IsDisplayAvailable(*args):
fc46b7f3 7490 """
33d6fd3b 7491 PyApp_IsDisplayAvailable() -> bool
fc46b7f3
RD
7492
7493 Tests if it is possible to create a GUI in the current environment.
7494 This will mean different things on the different platforms.
7495
7496 * On X Windows systems this function will return ``False`` if it is
7497 not able to open a connection to the X display, which can happen
7498 if $DISPLAY is not set, or is not set correctly.
7499
7500 * On Mac OS X a ``False`` return value will mean that wx is not
7501 able to access the window manager, which can happen if logged in
7502 remotely or if running from the normal version of python instead
7503 of the framework version, (i.e., pythonw.)
7504
7505 * On MS Windows...
7506
7507 """
33d6fd3b 7508 return _core_.PyApp_IsDisplayAvailable(*args)
fc46b7f3 7509
d14a1e28
RD
7510#---------------------------------------------------------------------------
7511
7512
0085ce49
RD
7513def Exit(*args):
7514 """
0df68c9f 7515 Exit()
6c3b4aae 7516
0df68c9f
RD
7517 Force an exit of the application. Convenience for wx.GetApp().Exit()
7518 """
0085ce49 7519 return _core_.Exit(*args)
d14a1e28 7520
0085ce49
RD
7521def Yield(*args):
7522 """
0df68c9f 7523 Yield() -> bool
6c3b4aae 7524
0df68c9f
RD
7525 Yield to other apps/messages. Convenience for wx.GetApp().Yield()
7526 """
0085ce49 7527 return _core_.Yield(*args)
d14a1e28 7528
0085ce49
RD
7529def YieldIfNeeded(*args):
7530 """
0df68c9f 7531 YieldIfNeeded() -> bool
6c3b4aae 7532
0df68c9f
RD
7533 Yield to other apps/messages. Convenience for wx.GetApp().Yield(True)
7534 """
0085ce49 7535 return _core_.YieldIfNeeded(*args)
d14a1e28 7536
e811c8ce 7537def SafeYield(*args, **kwargs):
0085ce49 7538 """
0df68c9f 7539 SafeYield(Window win=None, bool onlyIfNeeded=False) -> bool
6c3b4aae 7540
66c033b4
RD
7541 This function is similar to `wx.Yield`, except that it disables the
7542 user input to all program windows before calling `wx.Yield` and
7543 re-enables it again afterwards. If ``win`` is not None, this window
7544 will remain enabled, allowing the implementation of some limited user
7545 interaction.
6c3b4aae 7546
66c033b4 7547 :Returns: the result of the call to `wx.Yield`.
0df68c9f 7548 """
0085ce49 7549 return _core_.SafeYield(*args, **kwargs)
d14a1e28 7550
0085ce49
RD
7551def WakeUpIdle(*args):
7552 """
0df68c9f 7553 WakeUpIdle()
6c3b4aae 7554
66c033b4
RD
7555 Cause the message queue to become empty again, so idle events will be
7556 sent.
0df68c9f 7557 """
0085ce49 7558 return _core_.WakeUpIdle(*args)
d14a1e28 7559
e811c8ce 7560def PostEvent(*args, **kwargs):
0085ce49 7561 """
0df68c9f 7562 PostEvent(EvtHandler dest, Event event)
6c3b4aae 7563
66c033b4
RD
7564 Send an event to a window or other wx.EvtHandler to be processed
7565 later.
0df68c9f 7566 """
0085ce49 7567 return _core_.PostEvent(*args, **kwargs)
d14a1e28 7568
0085ce49
RD
7569def App_CleanUp(*args):
7570 """
0df68c9f 7571 App_CleanUp()
6c3b4aae 7572
41e2b43e 7573 For internal use only, it is used to cleanup after wxWidgets when
66c033b4 7574 Python shuts down.
0df68c9f 7575 """
0085ce49 7576 return _core_.App_CleanUp(*args)
d14a1e28 7577
0085ce49
RD
7578def GetApp(*args):
7579 """
0df68c9f 7580 GetApp() -> PyApp
6c3b4aae 7581
196addbf 7582 Return a reference to the current wx.App object.
0df68c9f 7583 """
0085ce49 7584 return _core_.GetApp(*args)
5cbf236d
RD
7585
7586def SetDefaultPyEncoding(*args, **kwargs):
0085ce49 7587 """
5cbf236d
RD
7588 SetDefaultPyEncoding(string encoding)
7589
7590 Sets the encoding that wxPython will use when it needs to convert a
7591 Python string or unicode object to or from a wxString.
e505d15e
RD
7592
7593 The default encoding is the value of ``locale.getdefaultlocale()[1]``
7594 but please be aware that the default encoding within the same locale
7595 may be slightly different on different platforms. For example, please
7596 see http://www.alanwood.net/demos/charsetdiffs.html for differences
7597 between the common latin/roman encodings.
5cbf236d 7598 """
0085ce49 7599 return _core_.SetDefaultPyEncoding(*args, **kwargs)
5cbf236d 7600
0085ce49
RD
7601def GetDefaultPyEncoding(*args):
7602 """
5cbf236d
RD
7603 GetDefaultPyEncoding() -> string
7604
7605 Gets the current encoding that wxPython will use when it needs to
7606 convert a Python string or unicode object to or from a wxString.
7607 """
0085ce49 7608 return _core_.GetDefaultPyEncoding(*args)
d14a1e28
RD
7609#----------------------------------------------------------------------
7610
7611class PyOnDemandOutputWindow:
6c3b4aae
RD
7612 """
7613 A class that can be used for redirecting Python's stdout and
7614 stderr streams. It will do nothing until something is wrriten to
7615 the stream at which point it will create a Frame with a text area
7616 and write the text there.
7617 """
d14a1e28
RD
7618 def __init__(self, title = "wxPython: stdout/stderr"):
7619 self.frame = None
7620 self.title = title
412d302d
RD
7621 self.pos = wx.DefaultPosition
7622 self.size = (450, 300)
d14a1e28
RD
7623 self.parent = None
7624
7625 def SetParent(self, parent):
6c3b4aae 7626 """Set the window to be used as the popup Frame's parent."""
d14a1e28
RD
7627 self.parent = parent
7628
6c3b4aae
RD
7629
7630 def CreateOutputWindow(self, st):
412d302d
RD
7631 self.frame = wx.Frame(self.parent, -1, self.title, self.pos, self.size,
7632 style=wx.DEFAULT_FRAME_STYLE)
196addbf 7633 self.text = wx.TextCtrl(self.frame, -1, "",
412d302d 7634 style=wx.TE_MULTILINE|wx.TE_READONLY)
d1e20054 7635 self.text.AppendText(st)
6c3b4aae 7636 self.frame.Show(True)
2131d850 7637 self.frame.Bind(wx.EVT_CLOSE, self.OnCloseWindow)
6c3b4aae 7638
d14a1e28 7639
7409c0c6
RD
7640 def OnCloseWindow(self, event):
7641 if self.frame is not None:
7642 self.frame.Destroy()
7643 self.frame = None
7644 self.text = None
7645
7646
d14a1e28 7647 # These methods provide the file-like output behaviour.
6c3b4aae
RD
7648 def write(self, text):
7649 """
7650 Create the output window if needed and write the string to it.
7651 If not called in the context of the gui thread then uses
7652 CallAfter to do the work there.
7653 """
7654 if self.frame is None:
7655 if not wx.Thread_IsMain():
7656 wx.CallAfter(self.CreateOutputWindow, text)
7657 else:
7658 self.CreateOutputWindow(text)
7659 else:
7660 if not wx.Thread_IsMain():
7661 wx.CallAfter(self.text.AppendText, text)
7662 else:
7663 self.text.AppendText(text)
7664
d14a1e28
RD
7665
7666 def close(self):
6c3b4aae
RD
7667 if self.frame is not None:
7668 wx.CallAfter(self.frame.Close)
7669
d14a1e28 7670
19272049
RD
7671 def flush(self):
7672 pass
7673
7674
d14a1e28
RD
7675
7676#----------------------------------------------------------------------
d14a1e28
RD
7677
7678_defRedirect = (wx.Platform == '__WXMSW__' or wx.Platform == '__WXMAC__')
fc46b7f3 7679
d14a1e28 7680class App(wx.PyApp):
6c3b4aae 7681 """
66c033b4
RD
7682 The ``wx.App`` class represents the application and is used to:
7683
7684 * bootstrap the wxPython system and initialize the underlying
7685 gui toolkit
7686 * set and get application-wide properties
7687 * implement the windowing system main message or event loop,
7688 and to dispatch events to window instances
7689 * etc.
7690
7691 Every application must have a ``wx.App`` instance, and all
7692 creation of UI objects should be delayed until after the
03e37cd5
RD
7693 ``wx.App`` object has been created in order to ensure that the gui
7694 platform and wxWidgets have been fully initialized.
66c033b4
RD
7695
7696 Normally you would derive from this class and implement an
7697 ``OnInit`` method that creates a frame and then calls
7698 ``self.SetTopWindow(frame)``.
7699
03e37cd5 7700 :see: `wx.PySimpleApp` for a simpler app class that can be used
1c0f361b 7701 directly.
6c3b4aae 7702 """
66c033b4 7703
d14a1e28
RD
7704 outputWindowClass = PyOnDemandOutputWindow
7705
03e37cd5
RD
7706 def __init__(self, redirect=_defRedirect, filename=None,
7707 useBestVisual=False, clearSigInt=True):
66c033b4
RD
7708 """
7709 Construct a ``wx.App`` object.
7710
03e37cd5
RD
7711 :param redirect: Should ``sys.stdout`` and ``sys.stderr`` be
7712 redirected? Defaults to True on Windows and Mac, False
7713 otherwise. If `filename` is None then output will be
7714 redirected to a window that pops up as needed. (You can
7715 control what kind of window is created for the output by
7716 resetting the class variable ``outputWindowClass`` to a
7717 class of your choosing.)
66c033b4 7718
03e37cd5
RD
7719 :param filename: The name of a file to redirect output to, if
7720 redirect is True.
66c033b4
RD
7721
7722 :param useBestVisual: Should the app try to use the best
03e37cd5
RD
7723 available visual provided by the system (only relevant on
7724 systems that have more than one visual.) This parameter
7725 must be used instead of calling `SetUseBestVisual` later
7726 on because it must be set before the underlying GUI
7727 toolkit is initialized.
7728
7729 :param clearSigInt: Should SIGINT be cleared? This allows the
7730 app to terminate upon a Ctrl-C in the console like other
7731 GUI apps will.
66c033b4
RD
7732
7733 :note: You should override OnInit to do applicaition
7734 initialization to ensure that the system, toolkit and
7735 wxWidgets are fully initialized.
7736 """
fc46b7f3 7737
d14a1e28
RD
7738 wx.PyApp.__init__(self)
7739
fc46b7f3 7740 # make sure we can create a GUI
33d6fd3b 7741 if not self.IsDisplayAvailable():
fc46b7f3
RD
7742
7743 if wx.Platform == "__WXMAC__":
7744 msg = """This program needs access to the screen.
7745Please run with 'pythonw', not 'python', and only when you are logged
7746in on the main display of your Mac."""
7747
7748 elif wx.Platform == "__WXGTK__":
7749 msg ="Unable to access the X Display, is $DISPLAY set properly?"
d14a1e28 7750
fc46b7f3
RD
7751 else:
7752 msg = "Unable to create GUI"
7753 # TODO: more description is needed for wxMSW...
7754
7755 raise SystemExit(msg)
7756
d14a1e28
RD
7757 # This has to be done before OnInit
7758 self.SetUseBestVisual(useBestVisual)
7759
7760 # Set the default handler for SIGINT. This fixes a problem
7761 # where if Ctrl-C is pressed in the console that started this
7762 # app then it will not appear to do anything, (not even send
7763 # KeyboardInterrupt???) but will later segfault on exit. By
7764 # setting the default handler then the app will exit, as
7765 # expected (depending on platform.)
03e37cd5
RD
7766 if clearSigInt:
7767 try:
7768 import signal
7769 signal.signal(signal.SIGINT, signal.SIG_DFL)
7770 except:
7771 pass
d14a1e28
RD
7772
7773 # Save and redirect the stdio to a window?
7774 self.stdioWin = None
7775 self.saveStdio = (_sys.stdout, _sys.stderr)
7776 if redirect:
7777 self.RedirectStdio(filename)
7778
8fb0e70a
RD
7779 # Use Python's install prefix as the default
7780 wx.StandardPaths.Get().SetInstallPrefix(_sys.prefix)
7781
48a0c021
RD
7782 # Until the new native control for wxMac is up to par, still use the generic one.
7783 wx.SystemOptions.SetOptionInt("mac.listctrl.always_use_generic", 1)
7784
d14a1e28
RD
7785 # This finishes the initialization of wxWindows and then calls
7786 # the OnInit that should be present in the derived class
7787 self._BootstrapApp()
7788
7789
01f6b6d3
RD
7790 def OnPreInit(self):
7791 """
7792 Things that must be done after _BootstrapApp has done its
7793 thing, but would be nice if they were already done by the time
7794 that OnInit is called.
7795 """
7796 wx.StockGDI._initStockObjects()
7797
7798
02b455f2
RD
7799 def __del__(self, destroy=wx.PyApp.__del__):
7800 self.RestoreStdio() # Just in case the MainLoop was overridden
7801 destroy(self)
d14a1e28 7802
70b7a5fe 7803 def Destroy(self):
b39fe951 7804 self.this.own(False)
70b7a5fe 7805 wx.PyApp.Destroy(self)
d14a1e28
RD
7806
7807 def SetTopWindow(self, frame):
1e0c8722 7808 """Set the \"main\" top level window"""
d14a1e28
RD
7809 if self.stdioWin:
7810 self.stdioWin.SetParent(frame)
7811 wx.PyApp.SetTopWindow(self, frame)
7812
7813
7814 def MainLoop(self):
1e0c8722 7815 """Execute the main GUI event loop"""
d14a1e28
RD
7816 wx.PyApp.MainLoop(self)
7817 self.RestoreStdio()
7818
7819
7409c0c6 7820 def RedirectStdio(self, filename=None):
1e0c8722 7821 """Redirect sys.stdout and sys.stderr to a file or a popup window."""
d14a1e28
RD
7822 if filename:
7823 _sys.stdout = _sys.stderr = open(filename, 'a')
7824 else:
7825 self.stdioWin = self.outputWindowClass()
7826 _sys.stdout = _sys.stderr = self.stdioWin
7827
7828
7829 def RestoreStdio(self):
02b455f2
RD
7830 try:
7831 _sys.stdout, _sys.stderr = self.saveStdio
7832 except:
7833 pass
d14a1e28
RD
7834
7835
412d302d
RD
7836 def SetOutputWindowAttributes(self, title=None, pos=None, size=None):
7837 """
7838 Set the title, position and/or size of the output window if
f5b96ee1
RD
7839 the stdio has been redirected. This should be called before
7840 any output would cause the output window to be created.
412d302d
RD
7841 """
7842 if self.stdioWin:
7843 if title is not None:
7844 self.stdioWin.title = title
7845 if pos is not None:
7846 self.stdioWin.pos = pos
7847 if size is not None:
7848 self.stdioWin.size = size
7849
7850
7851
d14a1e28 7852
66c033b4 7853# change from wx.PyApp_XX to wx.App_XX
54f9ee45
RD
7854App_GetMacSupportPCMenuShortcuts = _core_.PyApp_GetMacSupportPCMenuShortcuts
7855App_GetMacAboutMenuItemId = _core_.PyApp_GetMacAboutMenuItemId
7856App_GetMacPreferencesMenuItemId = _core_.PyApp_GetMacPreferencesMenuItemId
7857App_GetMacExitMenuItemId = _core_.PyApp_GetMacExitMenuItemId
7858App_GetMacHelpMenuTitleName = _core_.PyApp_GetMacHelpMenuTitleName
7859App_SetMacSupportPCMenuShortcuts = _core_.PyApp_SetMacSupportPCMenuShortcuts
7860App_SetMacAboutMenuItemId = _core_.PyApp_SetMacAboutMenuItemId
7861App_SetMacPreferencesMenuItemId = _core_.PyApp_SetMacPreferencesMenuItemId
7862App_SetMacExitMenuItemId = _core_.PyApp_SetMacExitMenuItemId
7863App_SetMacHelpMenuTitleName = _core_.PyApp_SetMacHelpMenuTitleName
7864App_GetComCtl32Version = _core_.PyApp_GetComCtl32Version
d14a1e28
RD
7865
7866#----------------------------------------------------------------------------
7867
7868class PySimpleApp(wx.App):
6c3b4aae
RD
7869 """
7870 A simple application class. You can just create one of these and
7871 then then make your top level windows later, and not have to worry
66c033b4
RD
7872 about OnInit. For example::
7873
7874 app = wx.PySimpleApp()
7875 frame = wx.Frame(None, title='Hello World')
7876 frame.Show()
7877 app.MainLoop()
7878
7879 :see: `wx.App`
7880 """
6c3b4aae 7881
03e37cd5
RD
7882 def __init__(self, redirect=False, filename=None,
7883 useBestVisual=False, clearSigInt=True):
66c033b4
RD
7884 """
7885 :see: `wx.App.__init__`
7886 """
03e37cd5 7887 wx.App.__init__(self, redirect, filename, useBestVisual, clearSigInt)
6c3b4aae 7888
d14a1e28 7889 def OnInit(self):
d14a1e28
RD
7890 return True
7891
7892
66c033b4 7893
6c3b4aae 7894# Is anybody using this one?
d14a1e28
RD
7895class PyWidgetTester(wx.App):
7896 def __init__(self, size = (250, 100)):
7897 self.size = size
7898 wx.App.__init__(self, 0)
7899
7900 def OnInit(self):
196addbf 7901 self.frame = wx.Frame(None, -1, "Widget Tester", pos=(0,0), size=self.size)
d14a1e28
RD
7902 self.SetTopWindow(self.frame)
7903 return True
7904
66c033b4
RD
7905 def SetWidget(self, widgetClass, *args, **kwargs):
7906 w = widgetClass(self.frame, *args, **kwargs)
d14a1e28
RD
7907 self.frame.Show(True)
7908
7909#----------------------------------------------------------------------------
7910# DO NOT hold any other references to this object. This is how we
66c033b4 7911# know when to cleanup system resources that wxWidgets is holding. When
d14a1e28 7912# the sys module is unloaded, the refcount on sys.__wxPythonCleanup
66c033b4 7913# goes to zero and it calls the wx.App_CleanUp function.
d14a1e28
RD
7914
7915class __wxPyCleanup:
7916 def __init__(self):
54f9ee45 7917 self.cleanup = _core_.App_CleanUp
d14a1e28
RD
7918 def __del__(self):
7919 self.cleanup()
7920
7921_sys.__wxPythonCleanup = __wxPyCleanup()
7922
7923## # another possible solution, but it gets called too early...
66c033b4
RD
7924## import atexit
7925## atexit.register(_core_.wxApp_CleanUp)
d14a1e28
RD
7926
7927
7928#----------------------------------------------------------------------------
7929
7930#---------------------------------------------------------------------------
2ef75293
RD
7931
7932class EventLoop(object):
093d3ff1 7933 """Proxy of C++ EventLoop class"""
0085ce49
RD
7934 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7935 __repr__ = _swig_repr
7936 def __init__(self, *args, **kwargs):
2ef75293 7937 """__init__(self) -> EventLoop"""
0085ce49
RD
7938 _core_.EventLoop_swiginit(self,_core_.new_EventLoop(*args, **kwargs))
7939 __swig_destroy__ = _core_.delete_EventLoop
7940 __del__ = lambda self : None;
2ef75293
RD
7941 def Run(*args, **kwargs):
7942 """Run(self) -> int"""
7943 return _core_.EventLoop_Run(*args, **kwargs)
7944
7945 def Exit(*args, **kwargs):
7946 """Exit(self, int rc=0)"""
7947 return _core_.EventLoop_Exit(*args, **kwargs)
7948
7949 def Pending(*args, **kwargs):
7950 """Pending(self) -> bool"""
7951 return _core_.EventLoop_Pending(*args, **kwargs)
7952
7953 def Dispatch(*args, **kwargs):
7954 """Dispatch(self) -> bool"""
7955 return _core_.EventLoop_Dispatch(*args, **kwargs)
7956
7957 def IsRunning(*args, **kwargs):
7958 """IsRunning(self) -> bool"""
7959 return _core_.EventLoop_IsRunning(*args, **kwargs)
7960
7961 def GetActive(*args, **kwargs):
7962 """GetActive() -> EventLoop"""
7963 return _core_.EventLoop_GetActive(*args, **kwargs)
7964
7965 GetActive = staticmethod(GetActive)
7966 def SetActive(*args, **kwargs):
7967 """SetActive(EventLoop loop)"""
7968 return _core_.EventLoop_SetActive(*args, **kwargs)
7969
7970 SetActive = staticmethod(SetActive)
2131d850 7971_core_.EventLoop_swigregister(EventLoop)
2ef75293 7972
0085ce49
RD
7973def EventLoop_GetActive(*args):
7974 """EventLoop_GetActive() -> EventLoop"""
7975 return _core_.EventLoop_GetActive(*args)
2ef75293
RD
7976
7977def EventLoop_SetActive(*args, **kwargs):
0085ce49
RD
7978 """EventLoop_SetActive(EventLoop loop)"""
7979 return _core_.EventLoop_SetActive(*args, **kwargs)
2ef75293 7980
091f5bed
RD
7981class EventLoopActivator(object):
7982 """Proxy of C++ EventLoopActivator class"""
0085ce49
RD
7983 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7984 __repr__ = _swig_repr
7985 def __init__(self, *args, **kwargs):
091f5bed 7986 """__init__(self, EventLoop evtLoop) -> EventLoopActivator"""
0085ce49
RD
7987 _core_.EventLoopActivator_swiginit(self,_core_.new_EventLoopActivator(*args, **kwargs))
7988 __swig_destroy__ = _core_.delete_EventLoopActivator
7989 __del__ = lambda self : None;
2131d850 7990_core_.EventLoopActivator_swigregister(EventLoopActivator)
091f5bed 7991
2ef75293 7992#---------------------------------------------------------------------------
d14a1e28 7993
eec1c382
RD
7994ACCEL_ALT = _core_.ACCEL_ALT
7995ACCEL_CTRL = _core_.ACCEL_CTRL
7996ACCEL_SHIFT = _core_.ACCEL_SHIFT
7997ACCEL_NORMAL = _core_.ACCEL_NORMAL
7998ACCEL_CMD = _core_.ACCEL_CMD
1e0c8722 7999class AcceleratorEntry(object):
66c033b4
RD
8000 """
8001 A class used to define items in an `wx.AcceleratorTable`. wxPython
8002 programs can choose to use wx.AcceleratorEntry objects, but using a
8003 list of 3-tuple of integers (flags, keyCode, cmdID) usually works just
41e2b43e 8004 as well. See `__init__` for of the tuple values.
66c033b4
RD
8005
8006 :see: `wx.AcceleratorTable`
8007 """
0085ce49
RD
8008 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
8009 __repr__ = _swig_repr
8010 def __init__(self, *args, **kwargs):
66c033b4
RD
8011 """
8012 __init__(self, int flags=0, int keyCode=0, int cmdID=0) -> AcceleratorEntry
8013
8014 Construct a wx.AcceleratorEntry.
66c033b4 8015 """
0085ce49
RD
8016 _core_.AcceleratorEntry_swiginit(self,_core_.new_AcceleratorEntry(*args, **kwargs))
8017 __swig_destroy__ = _core_.delete_AcceleratorEntry
8018 __del__ = lambda self : None;
1e0c8722 8019 def Set(*args, **kwargs):
66c033b4
RD
8020 """
8021 Set(self, int flags, int keyCode, int cmd)
1e0c8722 8022
66c033b4
RD
8023 (Re)set the attributes of a wx.AcceleratorEntry.
8024 :see `__init__`
8025 """
8026 return _core_.AcceleratorEntry_Set(*args, **kwargs)
1e0c8722 8027
97ab0f6a
RD
8028 def Create(*args, **kwargs):
8029 """
8030 Create(String str) -> AcceleratorEntry
8031
8032 Create accelerator corresponding to the specified string, or None if
8033 it coulnd't be parsed.
8034 """
8035 return _core_.AcceleratorEntry_Create(*args, **kwargs)
8036
8037 Create = staticmethod(Create)
1e0c8722 8038 def GetFlags(*args, **kwargs):
66c033b4
RD
8039 """
8040 GetFlags(self) -> int
8041
8042 Get the AcceleratorEntry's flags.
8043 """
54f9ee45 8044 return _core_.AcceleratorEntry_GetFlags(*args, **kwargs)
1e0c8722
RD
8045
8046 def GetKeyCode(*args, **kwargs):
66c033b4
RD
8047 """
8048 GetKeyCode(self) -> int
8049
8050 Get the AcceleratorEntry's keycode.
8051 """
54f9ee45 8052 return _core_.AcceleratorEntry_GetKeyCode(*args, **kwargs)
1e0c8722
RD
8053
8054 def GetCommand(*args, **kwargs):
66c033b4
RD
8055 """
8056 GetCommand(self) -> int
8057
8058 Get the AcceleratorEntry's command ID.
8059 """
54f9ee45 8060 return _core_.AcceleratorEntry_GetCommand(*args, **kwargs)
1e0c8722 8061
97ab0f6a
RD
8062 def IsOk(*args, **kwargs):
8063 """IsOk(self) -> bool"""
8064 return _core_.AcceleratorEntry_IsOk(*args, **kwargs)
8065
8066 def ToString(*args, **kwargs):
8067 """
8068 ToString(self) -> String
8069
8070 Returns a string representation for the this accelerator. The string
8071 is formatted using the <flags>-<keycode> format where <flags> maybe a
8072 hyphen-separed list of "shift|alt|ctrl"
8073
8074 """
8075 return _core_.AcceleratorEntry_ToString(*args, **kwargs)
8076
8077 def FromString(*args, **kwargs):
8078 """
8079 FromString(self, String str) -> bool
8080
8081 Returns true if the given string correctly initialized this object.
8082 """
8083 return _core_.AcceleratorEntry_FromString(*args, **kwargs)
8084
2bf58437
RD
8085 Command = property(GetCommand,doc="See `GetCommand`")
8086 Flags = property(GetFlags,doc="See `GetFlags`")
8087 KeyCode = property(GetKeyCode,doc="See `GetKeyCode`")
2131d850 8088_core_.AcceleratorEntry_swigregister(AcceleratorEntry)
1e0c8722 8089
97ab0f6a
RD
8090def AcceleratorEntry_Create(*args, **kwargs):
8091 """
8092 AcceleratorEntry_Create(String str) -> AcceleratorEntry
8093
8094 Create accelerator corresponding to the specified string, or None if
8095 it coulnd't be parsed.
8096 """
8097 return _core_.AcceleratorEntry_Create(*args, **kwargs)
8098
1e0c8722 8099class AcceleratorTable(Object):
66c033b4
RD
8100 """
8101 An accelerator table allows the application to specify a table of
8102 keyboard shortcuts for menus or other commands. On Windows, menu or
8103 button commands are supported; on GTK, only menu commands are
8104 supported.
66c033b4 8105 """
0085ce49
RD
8106 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
8107 __repr__ = _swig_repr
8108 def __init__(self, *args, **kwargs):
0df68c9f
RD
8109 """
8110 __init__(entries) -> AcceleratorTable
1e0c8722 8111
66c033b4
RD
8112 Construct an AcceleratorTable from a list of `wx.AcceleratorEntry`
8113 items or or of 3-tuples (flags, keyCode, cmdID)
8114
8115 :see: `wx.AcceleratorEntry`
0df68c9f 8116 """
0085ce49
RD
8117 _core_.AcceleratorTable_swiginit(self,_core_.new_AcceleratorTable(*args, **kwargs))
8118 __swig_destroy__ = _core_.delete_AcceleratorTable
8119 __del__ = lambda self : None;
b39fe951
RD
8120 def IsOk(*args, **kwargs):
8121 """IsOk(self) -> bool"""
8122 return _core_.AcceleratorTable_IsOk(*args, **kwargs)
1e0c8722 8123
b39fe951 8124 Ok = IsOk
2131d850 8125_core_.AcceleratorTable_swigregister(AcceleratorTable)
1e0c8722
RD
8126
8127
8128def GetAccelFromString(*args, **kwargs):
0085ce49
RD
8129 """GetAccelFromString(String label) -> AcceleratorEntry"""
8130 return _core_.GetAccelFromString(*args, **kwargs)
1e0c8722
RD
8131#---------------------------------------------------------------------------
8132
74a57fcd
RD
8133class VisualAttributes(object):
8134 """struct containing all the visual attributes of a control"""
0085ce49
RD
8135 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
8136 __repr__ = _swig_repr
8137 def __init__(self, *args, **kwargs):
74a57fcd 8138 """
a95a7133 8139 __init__(self) -> VisualAttributes
74a57fcd
RD
8140
8141 struct containing all the visual attributes of a control
8142 """
0085ce49
RD
8143 _core_.VisualAttributes_swiginit(self,_core_.new_VisualAttributes(*args, **kwargs))
8144 __swig_destroy__ = _core_.delete_VisualAttributes
8145 __del__ = lambda self : None;
54f9ee45
RD
8146 font = property(_core_.VisualAttributes_font_get, _core_.VisualAttributes_font_set)
8147 colFg = property(_core_.VisualAttributes_colFg_get, _core_.VisualAttributes_colFg_set)
8148 colBg = property(_core_.VisualAttributes_colBg_get, _core_.VisualAttributes_colBg_set)
2131d850 8149_core_.VisualAttributes_swigregister(VisualAttributes)
74a57fcd
RD
8150NullAcceleratorTable = cvar.NullAcceleratorTable
8151PanelNameStr = cvar.PanelNameStr
8152
54f9ee45
RD
8153WINDOW_VARIANT_NORMAL = _core_.WINDOW_VARIANT_NORMAL
8154WINDOW_VARIANT_SMALL = _core_.WINDOW_VARIANT_SMALL
8155WINDOW_VARIANT_MINI = _core_.WINDOW_VARIANT_MINI
8156WINDOW_VARIANT_LARGE = _core_.WINDOW_VARIANT_LARGE
8157WINDOW_VARIANT_MAX = _core_.WINDOW_VARIANT_MAX
d14a1e28 8158class Window(EvtHandler):
15afbcd0
RD
8159 """
8160 wx.Window is the base class for all windows and represents any visible
8161 object on the screen. All controls, top level windows and so on are
8162 wx.Windows. Sizers and device contexts are not however, as they don't
8163 appear on screen themselves.
8164
8165 """
0085ce49
RD
8166 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
8167 __repr__ = _swig_repr
8168 def __init__(self, *args, **kwargs):
0df68c9f 8169 """
a95a7133 8170 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
74a57fcd 8171 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> Window
15afbcd0
RD
8172
8173 Construct and show a generic Window.
0df68c9f 8174 """
0085ce49 8175 _core_.Window_swiginit(self,_core_.new_Window(*args, **kwargs))
d14a1e28 8176 self._setOORInfo(self)
d14a1e28 8177
e811c8ce 8178 def Create(*args, **kwargs):
0df68c9f 8179 """
a95a7133 8180 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
74a57fcd 8181 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> bool
15afbcd0
RD
8182
8183 Create the GUI part of the Window for 2-phase creation mode.
0df68c9f 8184 """
54f9ee45 8185 return _core_.Window_Create(*args, **kwargs)
d14a1e28 8186
e811c8ce 8187 def Close(*args, **kwargs):
15afbcd0 8188 """
a95a7133 8189 Close(self, bool force=False) -> bool
15afbcd0
RD
8190
8191 This function simply generates a EVT_CLOSE event whose handler usually
8192 tries to close the window. It doesn't close the window itself,
8193 however. If force is False (the default) then the window's close
8194 handler will be allowed to veto the destruction of the window.
15afbcd0 8195 """
54f9ee45 8196 return _core_.Window_Close(*args, **kwargs)
d14a1e28 8197
e811c8ce 8198 def Destroy(*args, **kwargs):
0df68c9f 8199 """
a95a7133 8200 Destroy(self) -> bool
d14a1e28 8201
15afbcd0
RD
8202 Destroys the window safely. Frames and dialogs are not destroyed
8203 immediately when this function is called -- they are added to a list
8204 of windows to be deleted on idle time, when all the window's events
8205 have been processed. This prevents problems with events being sent to
8206 non-existent windows.
8207
8208 Returns True if the window has either been successfully deleted, or it
8209 has been added to the list of windows pending real deletion.
0df68c9f 8210 """
b39fe951
RD
8211 args[0].this.own(False)
8212 return _core_.Window_Destroy(*args, **kwargs)
d14a1e28 8213
e811c8ce 8214 def DestroyChildren(*args, **kwargs):
15afbcd0 8215 """
a95a7133 8216 DestroyChildren(self) -> bool
15afbcd0 8217
41e2b43e
RD
8218 Destroys all children of a window. Called automatically by the
8219 destructor.
15afbcd0 8220 """
54f9ee45 8221 return _core_.Window_DestroyChildren(*args, **kwargs)
d14a1e28 8222
e811c8ce 8223 def IsBeingDeleted(*args, **kwargs):
15afbcd0 8224 """
a95a7133 8225 IsBeingDeleted(self) -> bool
15afbcd0
RD
8226
8227 Is the window in the process of being deleted?
8228 """
54f9ee45 8229 return _core_.Window_IsBeingDeleted(*args, **kwargs)
d14a1e28 8230
e811c8ce 8231 def SetLabel(*args, **kwargs):
15afbcd0 8232 """
a95a7133 8233 SetLabel(self, String label)
15afbcd0
RD
8234
8235 Set the text which the window shows in its label if applicable.
8236 """
54f9ee45 8237 return _core_.Window_SetLabel(*args, **kwargs)
d14a1e28 8238
e811c8ce 8239 def GetLabel(*args, **kwargs):
15afbcd0 8240 """
a95a7133 8241 GetLabel(self) -> String
15afbcd0 8242
41e2b43e
RD
8243 Generic way of getting a label from any window, for identification
8244 purposes. The interpretation of this function differs from class to
8245 class. For frames and dialogs, the value returned is the title. For
8246 buttons or static text controls, it is the button text. This function
8247 can be useful for meta-programs such as testing tools or special-needs
8248 access programs)which need to identify windows by name.
15afbcd0 8249 """
54f9ee45 8250 return _core_.Window_GetLabel(*args, **kwargs)
d14a1e28 8251
e811c8ce 8252 def SetName(*args, **kwargs):
15afbcd0 8253 """
a95a7133 8254 SetName(self, String name)
15afbcd0 8255
41e2b43e
RD
8256 Sets the window's name. The window name is used for ressource setting
8257 in X, it is not the same as the window title/label
15afbcd0 8258 """
54f9ee45 8259 return _core_.Window_SetName(*args, **kwargs)
d14a1e28 8260
e811c8ce 8261 def GetName(*args, **kwargs):
15afbcd0 8262 """
a95a7133 8263 GetName(self) -> String
15afbcd0 8264
41e2b43e
RD
8265 Returns the windows name. This name is not guaranteed to be unique;
8266 it is up to the programmer to supply an appropriate name in the window
8267 constructor or via wx.Window.SetName.
15afbcd0 8268 """
54f9ee45 8269 return _core_.Window_GetName(*args, **kwargs)
d14a1e28 8270
4276dc52
RD
8271 def SetWindowVariant(*args, **kwargs):
8272 """
a95a7133 8273 SetWindowVariant(self, int variant)
4276dc52 8274
41e2b43e
RD
8275 Sets the variant of the window/font size to use for this window, if
8276 the platform supports variants, for example, wxMac.
4276dc52 8277 """
54f9ee45 8278 return _core_.Window_SetWindowVariant(*args, **kwargs)
4276dc52
RD
8279
8280 def GetWindowVariant(*args, **kwargs):
a95a7133 8281 """GetWindowVariant(self) -> int"""
54f9ee45 8282 return _core_.Window_GetWindowVariant(*args, **kwargs)
4276dc52 8283
e811c8ce 8284 def SetId(*args, **kwargs):
15afbcd0 8285 """
a95a7133 8286 SetId(self, int winid)
15afbcd0
RD
8287
8288 Sets the identifier of the window. Each window has an integer
8289 identifier. If the application has not provided one, an identifier
8290 will be generated. Normally, the identifier should be provided on
8291 creation and should not be modified subsequently.
8292 """
54f9ee45 8293 return _core_.Window_SetId(*args, **kwargs)
d14a1e28 8294
e811c8ce 8295 def GetId(*args, **kwargs):
15afbcd0 8296 """
a95a7133 8297 GetId(self) -> int
15afbcd0
RD
8298
8299 Returns the identifier of the window. Each window has an integer
8300 identifier. If the application has not provided one (or the default Id
8301 -1 is used) then an unique identifier with a negative value will be
8302 generated.
8303 """
54f9ee45 8304 return _core_.Window_GetId(*args, **kwargs)
d14a1e28 8305
e811c8ce 8306 def NewControlId(*args, **kwargs):
15afbcd0 8307 """
66c033b4 8308 NewControlId() -> int
15afbcd0
RD
8309
8310 Generate a control id for the controls which were not given one.
8311 """
54f9ee45 8312 return _core_.Window_NewControlId(*args, **kwargs)
d14a1e28 8313
e811c8ce
RD
8314 NewControlId = staticmethod(NewControlId)
8315 def NextControlId(*args, **kwargs):
15afbcd0 8316 """
66c033b4 8317 NextControlId(int winid) -> int
15afbcd0
RD
8318
8319 Get the id of the control following the one with the given
41e2b43e 8320 autogenerated) id
15afbcd0 8321 """
54f9ee45 8322 return _core_.Window_NextControlId(*args, **kwargs)
d14a1e28 8323
e811c8ce
RD
8324 NextControlId = staticmethod(NextControlId)
8325 def PrevControlId(*args, **kwargs):
15afbcd0 8326 """
66c033b4 8327 PrevControlId(int winid) -> int
15afbcd0
RD
8328
8329 Get the id of the control preceding the one with the given
41e2b43e 8330 autogenerated) id
15afbcd0 8331 """
54f9ee45 8332 return _core_.Window_PrevControlId(*args, **kwargs)
d14a1e28 8333
e811c8ce 8334 PrevControlId = staticmethod(PrevControlId)
97ab0f6a
RD
8335 def GetLayoutDirection(*args, **kwargs):
8336 """
994453b8 8337 GetLayoutDirection(self) -> int
97ab0f6a
RD
8338
8339 Get the layout direction (LTR or RTL) for this window. Returns
8340 ``wx.Layout_Default`` if layout direction is not supported.
8341 """
8342 return _core_.Window_GetLayoutDirection(*args, **kwargs)
8343
8344 def SetLayoutDirection(*args, **kwargs):
8345 """
994453b8 8346 SetLayoutDirection(self, int dir)
97ab0f6a
RD
8347
8348 Set the layout direction (LTR or RTL) for this window.
8349 """
8350 return _core_.Window_SetLayoutDirection(*args, **kwargs)
8351
8352 def AdjustForLayoutDirection(*args, **kwargs):
8353 """
8354 AdjustForLayoutDirection(self, int x, int width, int widthTotal) -> int
8355
8356 Mirror coordinates for RTL layout if this window uses it and if the
8357 mirroring is not done automatically like Win32.
8358 """
8359 return _core_.Window_AdjustForLayoutDirection(*args, **kwargs)
8360
e811c8ce 8361 def SetSize(*args, **kwargs):
15afbcd0 8362 """
a95a7133 8363 SetSize(self, Size size)
15afbcd0
RD
8364
8365 Sets the size of the window in pixels.
8366 """
54f9ee45 8367 return _core_.Window_SetSize(*args, **kwargs)
d14a1e28 8368
e811c8ce 8369 def SetDimensions(*args, **kwargs):
15afbcd0 8370 """
a95a7133 8371 SetDimensions(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)
15afbcd0
RD
8372
8373 Sets the position and size of the window in pixels. The sizeFlags
8374 parameter indicates the interpretation of the other params if they are
e505d15e
RD
8375 equal to -1.
8376
8377 ======================== ======================================
8378 wx.SIZE_AUTO A -1 indicates that a class-specific
8379 default should be used.
8380 wx.SIZE_USE_EXISTING Axisting dimensions should be used if
8381 -1 values are supplied.
8382 wxSIZE_ALLOW_MINUS_ONE Allow dimensions of -1 and less to be
8383 interpreted as real dimensions, not
8384 default values.
8385 ======================== ======================================
8386
15afbcd0 8387 """
54f9ee45 8388 return _core_.Window_SetDimensions(*args, **kwargs)
d14a1e28 8389
e811c8ce 8390 def SetRect(*args, **kwargs):
15afbcd0 8391 """
a95a7133 8392 SetRect(self, Rect rect, int sizeFlags=SIZE_AUTO)
15afbcd0
RD
8393
8394 Sets the position and size of the window in pixels using a wx.Rect.
8395 """
54f9ee45 8396 return _core_.Window_SetRect(*args, **kwargs)
d14a1e28 8397
e811c8ce 8398 def SetSizeWH(*args, **kwargs):
15afbcd0 8399 """
a95a7133 8400 SetSizeWH(self, int width, int height)
15afbcd0
RD
8401
8402 Sets the size of the window in pixels.
8403 """
54f9ee45 8404 return _core_.Window_SetSizeWH(*args, **kwargs)
d14a1e28 8405
e811c8ce 8406 def Move(*args, **kwargs):
15afbcd0 8407 """
a95a7133 8408 Move(self, Point pt, int flags=SIZE_USE_EXISTING)
15afbcd0
RD
8409
8410 Moves the window to the given position.
8411 """
54f9ee45 8412 return _core_.Window_Move(*args, **kwargs)
d14a1e28 8413
e811c8ce
RD
8414 SetPosition = Move
8415 def MoveXY(*args, **kwargs):
15afbcd0 8416 """
a95a7133 8417 MoveXY(self, int x, int y, int flags=SIZE_USE_EXISTING)
15afbcd0
RD
8418
8419 Moves the window to the given position.
8420 """
54f9ee45 8421 return _core_.Window_MoveXY(*args, **kwargs)
e811c8ce 8422
580080c5 8423 def SetInitialSize(*args, **kwargs):
f8167d6e 8424 """
580080c5 8425 SetInitialSize(self, Size size=DefaultSize)
f8167d6e
RD
8426
8427 A 'Smart' SetSize that will fill in default size components with the
8428 window's *best size* values. Also set's the minsize for use with sizers.
8429 """
580080c5 8430 return _core_.Window_SetInitialSize(*args, **kwargs)
f8167d6e 8431
580080c5 8432 SetBestFittingSize = wx._deprecated(SetInitialSize, 'Use `SetInitialSize`')
e811c8ce 8433 def Raise(*args, **kwargs):
15afbcd0 8434 """
a95a7133 8435 Raise(self)
15afbcd0 8436
943e8dfd 8437 Raises the window to the top of the window hierarchy. In current
70b63a99 8438 version of wxWidgets this works both for managed and child windows.
15afbcd0 8439 """
54f9ee45 8440 return _core_.Window_Raise(*args, **kwargs)
e811c8ce
RD
8441
8442 def Lower(*args, **kwargs):
15afbcd0 8443 """
a95a7133 8444 Lower(self)
15afbcd0 8445
943e8dfd 8446 Lowers the window to the bottom of the window hierarchy. In current
70b63a99 8447 version of wxWidgets this works both for managed and child windows.
15afbcd0 8448 """
54f9ee45 8449 return _core_.Window_Lower(*args, **kwargs)
e811c8ce
RD
8450
8451 def SetClientSize(*args, **kwargs):
15afbcd0 8452 """
a95a7133 8453 SetClientSize(self, Size size)
15afbcd0
RD
8454
8455 This sets the size of the window client area in pixels. Using this
8456 function to size a window tends to be more device-independent than
8457 wx.Window.SetSize, since the application need not worry about what
8458 dimensions the border or title bar have when trying to fit the window
8459 around panel items, for example.
8460 """
54f9ee45 8461 return _core_.Window_SetClientSize(*args, **kwargs)
e811c8ce
RD
8462
8463 def SetClientSizeWH(*args, **kwargs):
15afbcd0 8464 """
a95a7133 8465 SetClientSizeWH(self, int width, int height)
15afbcd0
RD
8466
8467 This sets the size of the window client area in pixels. Using this
8468 function to size a window tends to be more device-independent than
8469 wx.Window.SetSize, since the application need not worry about what
8470 dimensions the border or title bar have when trying to fit the window
8471 around panel items, for example.
8472 """
54f9ee45 8473 return _core_.Window_SetClientSizeWH(*args, **kwargs)
e811c8ce
RD
8474
8475 def SetClientRect(*args, **kwargs):
15afbcd0 8476 """
a95a7133 8477 SetClientRect(self, Rect rect)
15afbcd0
RD
8478
8479 This sets the size of the window client area in pixels. Using this
8480 function to size a window tends to be more device-independent than
8481 wx.Window.SetSize, since the application need not worry about what
8482 dimensions the border or title bar have when trying to fit the window
8483 around panel items, for example.
8484 """
54f9ee45 8485 return _core_.Window_SetClientRect(*args, **kwargs)
e811c8ce
RD
8486
8487 def GetPosition(*args, **kwargs):
0df68c9f 8488 """
a95a7133 8489 GetPosition(self) -> Point
e811c8ce 8490
75219dcb
RD
8491 Get the window's position. Notice that the position is in client
8492 coordinates for child windows and screen coordinates for the top level
8493 ones, use `GetScreenPosition` if you need screen coordinates for all
8494 kinds of windows.
0df68c9f 8495 """
54f9ee45 8496 return _core_.Window_GetPosition(*args, **kwargs)
e811c8ce
RD
8497
8498 def GetPositionTuple(*args, **kwargs):
0df68c9f
RD
8499 """
8500 GetPositionTuple() -> (x,y)
e811c8ce 8501
75219dcb
RD
8502 Get the window's position. Notice that the position is in client
8503 coordinates for child windows and screen coordinates for the top level
8504 ones, use `GetScreenPosition` if you need screen coordinates for all
8505 kinds of windows.
0df68c9f 8506 """
54f9ee45 8507 return _core_.Window_GetPositionTuple(*args, **kwargs)
e811c8ce 8508
75219dcb
RD
8509 def GetScreenPosition(*args, **kwargs):
8510 """
8511 GetScreenPosition(self) -> Point
8512
8513 Get the position of the window in screen coordinantes.
8514 """
8515 return _core_.Window_GetScreenPosition(*args, **kwargs)
8516
8517 def GetScreenPositionTuple(*args, **kwargs):
8518 """
8519 GetScreenPositionTuple() -> (x,y)
8520
8521 Get the position of the window in screen coordinantes.
8522 """
8523 return _core_.Window_GetScreenPositionTuple(*args, **kwargs)
8524
8525 def GetScreenRect(*args, **kwargs):
8526 """
8527 GetScreenRect(self) -> Rect
8528
8529 Returns the size and position of the window in screen coordinantes as
8530 a `wx.Rect` object.
8531 """
8532 return _core_.Window_GetScreenRect(*args, **kwargs)
8533
e811c8ce 8534 def GetSize(*args, **kwargs):
0df68c9f 8535 """
a95a7133 8536 GetSize(self) -> Size
e811c8ce 8537
0df68c9f
RD
8538 Get the window size.
8539 """
54f9ee45 8540 return _core_.Window_GetSize(*args, **kwargs)
e811c8ce
RD
8541
8542 def GetSizeTuple(*args, **kwargs):
0df68c9f
RD
8543 """
8544 GetSizeTuple() -> (width, height)
e811c8ce 8545
0df68c9f
RD
8546 Get the window size.
8547 """
54f9ee45 8548 return _core_.Window_GetSizeTuple(*args, **kwargs)
e811c8ce
RD
8549
8550 def GetRect(*args, **kwargs):
15afbcd0 8551 """
a95a7133 8552 GetRect(self) -> Rect
15afbcd0 8553
75219dcb 8554 Returns the size and position of the window as a `wx.Rect` object.
15afbcd0 8555 """
54f9ee45 8556 return _core_.Window_GetRect(*args, **kwargs)
e811c8ce
RD
8557
8558 def GetClientSize(*args, **kwargs):
0df68c9f 8559 """
a95a7133 8560 GetClientSize(self) -> Size
e811c8ce 8561
15afbcd0
RD
8562 This gets the size of the window's 'client area' in pixels. The client
8563 area is the area which may be drawn on by the programmer, excluding
8564 title bar, border, scrollbars, etc.
0df68c9f 8565 """
54f9ee45 8566 return _core_.Window_GetClientSize(*args, **kwargs)
e811c8ce
RD
8567
8568 def GetClientSizeTuple(*args, **kwargs):
0df68c9f
RD
8569 """
8570 GetClientSizeTuple() -> (width, height)
e811c8ce 8571
15afbcd0
RD
8572 This gets the size of the window's 'client area' in pixels. The client
8573 area is the area which may be drawn on by the programmer, excluding
8574 title bar, border, scrollbars, etc.
0df68c9f 8575 """
54f9ee45 8576 return _core_.Window_GetClientSizeTuple(*args, **kwargs)
e811c8ce
RD
8577
8578 def GetClientAreaOrigin(*args, **kwargs):
15afbcd0 8579 """
a95a7133 8580 GetClientAreaOrigin(self) -> Point
15afbcd0
RD
8581
8582 Get the origin of the client area of the window relative to the
8583 window's top left corner (the client area may be shifted because of
8584 the borders, scrollbars, other decorations...)
8585 """
54f9ee45 8586 return _core_.Window_GetClientAreaOrigin(*args, **kwargs)
e811c8ce
RD
8587
8588 def GetClientRect(*args, **kwargs):
15afbcd0 8589 """
a95a7133 8590 GetClientRect(self) -> Rect
15afbcd0 8591
61863841 8592 Get the client area position and size as a `wx.Rect` object.
15afbcd0 8593 """
54f9ee45 8594 return _core_.Window_GetClientRect(*args, **kwargs)
e811c8ce
RD
8595
8596 def GetBestSize(*args, **kwargs):
0df68c9f 8597 """
a95a7133 8598 GetBestSize(self) -> Size
e811c8ce 8599
248ed943 8600 This function returns the best acceptable minimal size for the
41e2b43e
RD
8601 window, if applicable. For example, for a static text control, it will
8602 be the minimal size such that the control label is not truncated. For
8603 windows containing subwindows (suzh aswx.Panel), the size returned by
8604 this function will be the same as the size the window would have had
8605 after calling Fit.
0df68c9f 8606 """
54f9ee45 8607 return _core_.Window_GetBestSize(*args, **kwargs)
e811c8ce
RD
8608
8609 def GetBestSizeTuple(*args, **kwargs):
0df68c9f
RD
8610 """
8611 GetBestSizeTuple() -> (width, height)
e811c8ce 8612
248ed943 8613 This function returns the best acceptable minimal size for the
41e2b43e
RD
8614 window, if applicable. For example, for a static text control, it will
8615 be the minimal size such that the control label is not truncated. For
8616 windows containing subwindows (suzh aswx.Panel), the size returned by
8617 this function will be the same as the size the window would have had
8618 after calling Fit.
0df68c9f 8619 """
54f9ee45 8620 return _core_.Window_GetBestSizeTuple(*args, **kwargs)
e811c8ce 8621
dfbb5885
RD
8622 def InvalidateBestSize(*args, **kwargs):
8623 """
8624 InvalidateBestSize(self)
8625
8626 Reset the cached best size value so it will be recalculated the next
8627 time it is needed.
8628 """
8629 return _core_.Window_InvalidateBestSize(*args, **kwargs)
8630
e2813725
RD
8631 def CacheBestSize(*args, **kwargs):
8632 """
8633 CacheBestSize(self, Size size)
8634
8635 Cache the best size so it doesn't need to be calculated again, (at least until
8636 some properties of the window change.)
8637 """
8638 return _core_.Window_CacheBestSize(*args, **kwargs)
8639
580080c5 8640 def GetEffectiveMinSize(*args, **kwargs):
dfbb5885 8641 """
580080c5 8642 GetEffectiveMinSize(self) -> Size
dfbb5885
RD
8643
8644 This function will merge the window's best size into the window's
8645 minimum size, giving priority to the min size components, and returns
8646 the results.
8647
8648 """
580080c5 8649 return _core_.Window_GetEffectiveMinSize(*args, **kwargs)
dfbb5885 8650
0d82d64e 8651 GetBestFittingSize = wx._deprecated(GetEffectiveMinSize, 'Use `GetEffectiveMinSize` instead.')
8f514ab4
RD
8652 def GetAdjustedBestSize(self):
8653 s = self.GetBestSize()
8654 return wx.Size(max(s.width, self.GetMinWidth()),
8655 max(s.height, self.GetMinHeight()))
580080c5 8656 GetAdjustedBestSize = wx._deprecated(GetAdjustedBestSize, 'Use `GetEffectiveMinSize` instead.')
e811c8ce
RD
8657
8658 def Center(*args, **kwargs):
15afbcd0 8659 """
a95a7133 8660 Center(self, int direction=BOTH)
15afbcd0
RD
8661
8662 Centers the window. The parameter specifies the direction for
8663 cetering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may
8664 also include wx.CENTER_ON_SCREEN flag if you want to center the window
8665 on the entire screen and not on its parent window. If it is a
8666 top-level window and has no parent then it will always be centered
8667 relative to the screen.
8668 """
54f9ee45 8669 return _core_.Window_Center(*args, **kwargs)
e811c8ce
RD
8670
8671 Centre = Center
e811c8ce 8672 def CenterOnParent(*args, **kwargs):
15afbcd0 8673 """
a95a7133 8674 CenterOnParent(self, int dir=BOTH)
15afbcd0
RD
8675
8676 Center with respect to the the parent window
8677 """
54f9ee45 8678 return _core_.Window_CenterOnParent(*args, **kwargs)
e811c8ce
RD
8679
8680 CentreOnParent = CenterOnParent
8681 def Fit(*args, **kwargs):
15afbcd0 8682 """
a95a7133 8683 Fit(self)
15afbcd0
RD
8684
8685 Sizes the window so that it fits around its subwindows. This function
8686 won't do anything if there are no subwindows and will only really work
8687 correctly if sizers are used for the subwindows layout. Also, if the
8688 window has exactly one subwindow it is better (faster and the result
8689 is more precise as Fit adds some margin to account for fuzziness of
8690 its calculations) to call window.SetClientSize(child.GetSize())
8691 instead of calling Fit.
8692 """
54f9ee45 8693 return _core_.Window_Fit(*args, **kwargs)
e811c8ce
RD
8694
8695 def FitInside(*args, **kwargs):
15afbcd0 8696 """
a95a7133 8697 FitInside(self)
15afbcd0
RD
8698
8699 Similar to Fit, but sizes the interior (virtual) size of a
8700 window. Mainly useful with scrolled windows to reset scrollbars after
8701 sizing changes that do not trigger a size event, and/or scrolled
8702 windows without an interior sizer. This function similarly won't do
8703 anything if there are no subwindows.
8704 """
54f9ee45 8705 return _core_.Window_FitInside(*args, **kwargs)
e811c8ce 8706
f16ab95d 8707 def SetSizeHints(*args, **kwargs):
0df68c9f 8708 """
a95a7133 8709 SetSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1,
0df68c9f 8710 int incH=-1)
15afbcd0
RD
8711
8712 Allows specification of minimum and maximum window sizes, and window
8713 size increments. If a pair of values is not set (or set to -1), the
8714 default values will be used. If this function is called, the user
908b74cd
RD
8715 will not be able to size the window outside the given bounds (if it is
8716 a top-level window.) Sizers will also inspect the minimum window size
8717 and will use that value if set when calculating layout.
8718
8719 The resizing increments are only significant under Motif or Xt.
0df68c9f 8720 """
f16ab95d 8721 return _core_.Window_SetSizeHints(*args, **kwargs)
e811c8ce 8722
f16ab95d
RD
8723 def SetSizeHintsSz(*args, **kwargs):
8724 """
8725 SetSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize, Size incSize=DefaultSize)
8726
8727 Allows specification of minimum and maximum window sizes, and window
8728 size increments. If a pair of values is not set (or set to -1), the
8729 default values will be used. If this function is called, the user
8730 will not be able to size the window outside the given bounds (if it is
8731 a top-level window.) Sizers will also inspect the minimum window size
8732 and will use that value if set when calculating layout.
8733
8734 The resizing increments are only significant under Motif or Xt.
8735 """
8736 return _core_.Window_SetSizeHintsSz(*args, **kwargs)
8737
8738 def SetVirtualSizeHints(*args, **kwargs):
15afbcd0 8739 """
908b74cd 8740 SetVirtualSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1)
15afbcd0
RD
8741
8742 Allows specification of minimum and maximum virtual window sizes. If a
8743 pair of values is not set (or set to -1), the default values will be
8744 used. If this function is called, the user will not be able to size
8745 the virtual area of the window outside the given bounds.
8746 """
f16ab95d
RD
8747 return _core_.Window_SetVirtualSizeHints(*args, **kwargs)
8748
8749 def SetVirtualSizeHintsSz(*args, **kwargs):
8750 """
8751 SetVirtualSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize)
8752
8753 Allows specification of minimum and maximum virtual window sizes. If a
8754 pair of values is not set (or set to -1), the default values will be
8755 used. If this function is called, the user will not be able to size
8756 the virtual area of the window outside the given bounds.
8757 """
8758 return _core_.Window_SetVirtualSizeHintsSz(*args, **kwargs)
e811c8ce 8759
908b74cd
RD
8760 def GetMaxSize(*args, **kwargs):
8761 """GetMaxSize(self) -> Size"""
8762 return _core_.Window_GetMaxSize(*args, **kwargs)
8763
8764 def GetMinSize(*args, **kwargs):
8765 """GetMinSize(self) -> Size"""
8766 return _core_.Window_GetMinSize(*args, **kwargs)
8767
8768 def SetMinSize(*args, **kwargs):
8769 """
8770 SetMinSize(self, Size minSize)
8771
8772 A more convenient method than `SetSizeHints` for setting just the
8773 min size.
8774 """
8775 return _core_.Window_SetMinSize(*args, **kwargs)
8776
8777 def SetMaxSize(*args, **kwargs):
8778 """
8779 SetMaxSize(self, Size maxSize)
8780
8781 A more convenient method than `SetSizeHints` for setting just the
8782 max size.
8783 """
8784 return _core_.Window_SetMaxSize(*args, **kwargs)
8785
e811c8ce 8786 def GetMinWidth(*args, **kwargs):
a95a7133 8787 """GetMinWidth(self) -> int"""
54f9ee45 8788 return _core_.Window_GetMinWidth(*args, **kwargs)
e811c8ce
RD
8789
8790 def GetMinHeight(*args, **kwargs):
a95a7133 8791 """GetMinHeight(self) -> int"""
54f9ee45 8792 return _core_.Window_GetMinHeight(*args, **kwargs)
e811c8ce
RD
8793
8794 def GetMaxWidth(*args, **kwargs):
a95a7133 8795 """GetMaxWidth(self) -> int"""
54f9ee45 8796 return _core_.Window_GetMaxWidth(*args, **kwargs)
e811c8ce
RD
8797
8798 def GetMaxHeight(*args, **kwargs):
a95a7133 8799 """GetMaxHeight(self) -> int"""
54f9ee45 8800 return _core_.Window_GetMaxHeight(*args, **kwargs)
e811c8ce 8801
e811c8ce 8802 def SetVirtualSize(*args, **kwargs):
0df68c9f 8803 """
a95a7133 8804 SetVirtualSize(self, Size size)
e811c8ce 8805
15afbcd0
RD
8806 Set the the virtual size of a window in pixels. For most windows this
8807 is just the client area of the window, but for some like scrolled
8808 windows it is more or less independent of the screen window size.
0df68c9f 8809 """
54f9ee45 8810 return _core_.Window_SetVirtualSize(*args, **kwargs)
e811c8ce
RD
8811
8812 def SetVirtualSizeWH(*args, **kwargs):
0df68c9f 8813 """
a95a7133 8814 SetVirtualSizeWH(self, int w, int h)
e811c8ce 8815
15afbcd0
RD
8816 Set the the virtual size of a window in pixels. For most windows this
8817 is just the client area of the window, but for some like scrolled
8818 windows it is more or less independent of the screen window size.
0df68c9f 8819 """
54f9ee45 8820 return _core_.Window_SetVirtualSizeWH(*args, **kwargs)
e811c8ce
RD
8821
8822 def GetVirtualSize(*args, **kwargs):
0df68c9f 8823 """
a95a7133 8824 GetVirtualSize(self) -> Size
e811c8ce 8825
15afbcd0
RD
8826 Get the the virtual size of the window in pixels. For most windows
8827 this is just the client area of the window, but for some like scrolled
8828 windows it is more or less independent of the screen window size.
0df68c9f 8829 """
54f9ee45 8830 return _core_.Window_GetVirtualSize(*args, **kwargs)
e811c8ce
RD
8831
8832 def GetVirtualSizeTuple(*args, **kwargs):
0df68c9f
RD
8833 """
8834 GetVirtualSizeTuple() -> (width, height)
e811c8ce 8835
15afbcd0
RD
8836 Get the the virtual size of the window in pixels. For most windows
8837 this is just the client area of the window, but for some like scrolled
8838 windows it is more or less independent of the screen window size.
0df68c9f 8839 """
54f9ee45 8840 return _core_.Window_GetVirtualSizeTuple(*args, **kwargs)
e811c8ce 8841
cbdf0fb0
RD
8842 def GetWindowBorderSize(*args, **kwargs):
8843 """
8844 GetWindowBorderSize(self) -> Size
8845
8846 Return the size of the left/right and top/bottom borders.
8847 """
8848 return _core_.Window_GetWindowBorderSize(*args, **kwargs)
8849
e811c8ce 8850 def GetBestVirtualSize(*args, **kwargs):
15afbcd0 8851 """
a95a7133 8852 GetBestVirtualSize(self) -> Size
15afbcd0
RD
8853
8854 Return the largest of ClientSize and BestSize (as determined by a
8855 sizer, interior children, or other means)
8856 """
54f9ee45 8857 return _core_.Window_GetBestVirtualSize(*args, **kwargs)
e811c8ce
RD
8858
8859 def Show(*args, **kwargs):
15afbcd0 8860 """
a95a7133 8861 Show(self, bool show=True) -> bool
15afbcd0
RD
8862
8863 Shows or hides the window. You may need to call Raise for a top level
8864 window if you want to bring it to top, although this is not needed if
8865 Show is called immediately after the frame creation. Returns True if
8866 the window has been shown or hidden or False if nothing was done
8867 because it already was in the requested state.
8868 """
54f9ee45 8869 return _core_.Window_Show(*args, **kwargs)
e811c8ce
RD
8870
8871 def Hide(*args, **kwargs):
15afbcd0 8872 """
a95a7133 8873 Hide(self) -> bool
15afbcd0
RD
8874
8875 Equivalent to calling Show(False).
8876 """
54f9ee45 8877 return _core_.Window_Hide(*args, **kwargs)
e811c8ce
RD
8878
8879 def Enable(*args, **kwargs):
15afbcd0 8880 """
a95a7133 8881 Enable(self, bool enable=True) -> bool
15afbcd0
RD
8882
8883 Enable or disable the window for user input. Note that when a parent
8884 window is disabled, all of its children are disabled as well and they
8885 are reenabled again when the parent is. Returns true if the window
8886 has been enabled or disabled, false if nothing was done, i.e. if the
8887 window had already been in the specified state.
8888 """
54f9ee45 8889 return _core_.Window_Enable(*args, **kwargs)
e811c8ce
RD
8890
8891 def Disable(*args, **kwargs):
15afbcd0 8892 """
a95a7133 8893 Disable(self) -> bool
15afbcd0
RD
8894
8895 Disables the window, same as Enable(false).
8896 """
54f9ee45 8897 return _core_.Window_Disable(*args, **kwargs)
e811c8ce
RD
8898
8899 def IsShown(*args, **kwargs):
15afbcd0 8900 """
a95a7133 8901 IsShown(self) -> bool
15afbcd0
RD
8902
8903 Returns true if the window is shown, false if it has been hidden.
8904 """
54f9ee45 8905 return _core_.Window_IsShown(*args, **kwargs)
e811c8ce
RD
8906
8907 def IsEnabled(*args, **kwargs):
15afbcd0 8908 """
a95a7133 8909 IsEnabled(self) -> bool
15afbcd0
RD
8910
8911 Returns true if the window is enabled for input, false otherwise.
8912 """
54f9ee45 8913 return _core_.Window_IsEnabled(*args, **kwargs)
e811c8ce 8914
33d6fd3b
RD
8915 def IsShownOnScreen(*args, **kwargs):
8916 """
8917 IsShownOnScreen(self) -> bool
8918
8919 Returns ``True`` if the window is physically visible on the screen,
8920 i.e. it is shown and all its parents up to the toplevel window are
8921 shown as well.
8922 """
8923 return _core_.Window_IsShownOnScreen(*args, **kwargs)
8924
e811c8ce 8925 def SetWindowStyleFlag(*args, **kwargs):
15afbcd0 8926 """
a95a7133 8927 SetWindowStyleFlag(self, long style)
15afbcd0 8928
41e2b43e
RD
8929 Sets the style of the window. Please note that some styles cannot be
8930 changed after the window creation and that Refresh() might need to be
8931 called after changing the others for the change to take place
8932 immediately.
15afbcd0 8933 """
54f9ee45 8934 return _core_.Window_SetWindowStyleFlag(*args, **kwargs)
e811c8ce
RD
8935
8936 def GetWindowStyleFlag(*args, **kwargs):
15afbcd0 8937 """
a95a7133 8938 GetWindowStyleFlag(self) -> long
e811c8ce 8939
15afbcd0
RD
8940 Gets the window style that was passed to the constructor or Create
8941 method.
8942 """
54f9ee45 8943 return _core_.Window_GetWindowStyleFlag(*args, **kwargs)
e811c8ce 8944
15afbcd0 8945 SetWindowStyle = SetWindowStyleFlag; GetWindowStyle = GetWindowStyleFlag
e811c8ce 8946 def HasFlag(*args, **kwargs):
15afbcd0 8947 """
a95a7133 8948 HasFlag(self, int flag) -> bool
15afbcd0
RD
8949
8950 Test if the given style is set for this window.
8951 """
54f9ee45 8952 return _core_.Window_HasFlag(*args, **kwargs)
e811c8ce
RD
8953
8954 def IsRetained(*args, **kwargs):
15afbcd0 8955 """
a95a7133 8956 IsRetained(self) -> bool
15afbcd0
RD
8957
8958 Returns true if the window is retained, false otherwise. Retained
8959 windows are only available on X platforms.
8960 """
54f9ee45 8961 return _core_.Window_IsRetained(*args, **kwargs)
e811c8ce 8962
5917d041
RD
8963 def ToggleWindowStyle(*args, **kwargs):
8964 """
8965 ToggleWindowStyle(self, int flag) -> bool
8966
8967 Turn the flag on if it had been turned off before and vice versa,
8968 returns True if the flag is turned on by this function call.
8969 """
8970 return _core_.Window_ToggleWindowStyle(*args, **kwargs)
8971
e811c8ce 8972 def SetExtraStyle(*args, **kwargs):
15afbcd0 8973 """
a95a7133 8974 SetExtraStyle(self, long exStyle)
15afbcd0
RD
8975
8976 Sets the extra style bits for the window. Extra styles are the less
8977 often used style bits which can't be set with the constructor or with
8978 SetWindowStyleFlag()
8979 """
54f9ee45 8980 return _core_.Window_SetExtraStyle(*args, **kwargs)
e811c8ce
RD
8981
8982 def GetExtraStyle(*args, **kwargs):
15afbcd0 8983 """
a95a7133 8984 GetExtraStyle(self) -> long
15afbcd0
RD
8985
8986 Returns the extra style bits for the window.
8987 """
54f9ee45 8988 return _core_.Window_GetExtraStyle(*args, **kwargs)
e811c8ce
RD
8989
8990 def MakeModal(*args, **kwargs):
15afbcd0 8991 """
a95a7133 8992 MakeModal(self, bool modal=True)
15afbcd0
RD
8993
8994 Disables all other windows in the application so that the user can
8995 only interact with this window. Passing False will reverse this
8996 effect.
8997 """
54f9ee45 8998 return _core_.Window_MakeModal(*args, **kwargs)
e811c8ce
RD
8999
9000 def SetThemeEnabled(*args, **kwargs):
15afbcd0 9001 """
a95a7133 9002 SetThemeEnabled(self, bool enableTheme)
15afbcd0
RD
9003
9004 This function tells a window if it should use the system's "theme"
9005 code to draw the windows' background instead if its own background
9006 drawing code. This will only have an effect on platforms that support
9007 the notion of themes in user defined windows. One such platform is
9008 GTK+ where windows can have (very colourful) backgrounds defined by a
9009 user's selected theme.
9010
9011 Dialogs, notebook pages and the status bar have this flag set to true
9012 by default so that the default look and feel is simulated best.
9013 """
54f9ee45 9014 return _core_.Window_SetThemeEnabled(*args, **kwargs)
e811c8ce
RD
9015
9016 def GetThemeEnabled(*args, **kwargs):
15afbcd0 9017 """
a95a7133 9018 GetThemeEnabled(self) -> bool
e811c8ce 9019
15afbcd0
RD
9020 Return the themeEnabled flag.
9021 """
54f9ee45 9022 return _core_.Window_GetThemeEnabled(*args, **kwargs)
e811c8ce
RD
9023
9024 def SetFocus(*args, **kwargs):
15afbcd0 9025 """
a95a7133 9026 SetFocus(self)
15afbcd0
RD
9027
9028 Set's the focus to this window, allowing it to receive keyboard input.
9029 """
54f9ee45 9030 return _core_.Window_SetFocus(*args, **kwargs)
e811c8ce
RD
9031
9032 def SetFocusFromKbd(*args, **kwargs):
15afbcd0 9033 """
a95a7133 9034 SetFocusFromKbd(self)
15afbcd0
RD
9035
9036 Set focus to this window as the result of a keyboard action. Normally
9037 only called internally.
9038 """
54f9ee45 9039 return _core_.Window_SetFocusFromKbd(*args, **kwargs)
e811c8ce
RD
9040
9041 def FindFocus(*args, **kwargs):
15afbcd0 9042 """
66c033b4 9043 FindFocus() -> Window
15afbcd0
RD
9044
9045 Returns the window or control that currently has the keyboard focus,
9046 or None.
9047 """
54f9ee45 9048 return _core_.Window_FindFocus(*args, **kwargs)
e811c8ce
RD
9049
9050 FindFocus = staticmethod(FindFocus)
9051 def AcceptsFocus(*args, **kwargs):
15afbcd0 9052 """
a95a7133 9053 AcceptsFocus(self) -> bool
15afbcd0
RD
9054
9055 Can this window have focus?
9056 """
54f9ee45 9057 return _core_.Window_AcceptsFocus(*args, **kwargs)
e811c8ce
RD
9058
9059 def AcceptsFocusFromKeyboard(*args, **kwargs):
15afbcd0 9060 """
a95a7133 9061 AcceptsFocusFromKeyboard(self) -> bool
15afbcd0
RD
9062
9063 Can this window be given focus by keyboard navigation? if not, the
9064 only way to give it focus (provided it accepts it at all) is to click
9065 it.
9066 """
54f9ee45 9067 return _core_.Window_AcceptsFocusFromKeyboard(*args, **kwargs)
e811c8ce 9068
908b74cd
RD
9069 def Navigate(*args, **kwargs):
9070 """
9071 Navigate(self, int flags=NavigationKeyEvent.IsForward) -> bool
9072
fd2dc343
RD
9073 Does keyboard navigation from this window to another, by sending a
9074 `wx.NavigationKeyEvent`.
908b74cd
RD
9075 """
9076 return _core_.Window_Navigate(*args, **kwargs)
9077
7f98d120
RD
9078 def MoveAfterInTabOrder(*args, **kwargs):
9079 """
9080 MoveAfterInTabOrder(self, Window win)
9081
9082 Moves this window in the tab navigation order after the specified
9083 sibling window. This means that when the user presses the TAB key on
9084 that other window, the focus switches to this window.
9085
9086 The default tab order is the same as creation order. This function
9087 and `MoveBeforeInTabOrder` allow to change it after creating all the
9088 windows.
9089
9090 """
9091 return _core_.Window_MoveAfterInTabOrder(*args, **kwargs)
9092
9093 def MoveBeforeInTabOrder(*args, **kwargs):
9094 """
9095 MoveBeforeInTabOrder(self, Window win)
9096
9097 Same as `MoveAfterInTabOrder` except that it inserts this window just
9098 before win instead of putting it right after it.
9099 """
9100 return _core_.Window_MoveBeforeInTabOrder(*args, **kwargs)
9101
e811c8ce 9102 def GetChildren(*args, **kwargs):
15afbcd0 9103 """
a95a7133 9104 GetChildren(self) -> PyObject
15afbcd0
RD
9105
9106 Returns a list of the window's children. NOTE: Currently this is a
9107 copy of the child window list maintained by the window, so the return
9108 value of this function is only valid as long as the window's children
9109 do not change.
9110 """
54f9ee45 9111 return _core_.Window_GetChildren(*args, **kwargs)
e811c8ce
RD
9112
9113 def GetParent(*args, **kwargs):
15afbcd0 9114 """
a95a7133 9115 GetParent(self) -> Window
15afbcd0
RD
9116
9117 Returns the parent window of this window, or None if there isn't one.
9118 """
54f9ee45 9119 return _core_.Window_GetParent(*args, **kwargs)
e811c8ce
RD
9120
9121 def GetGrandParent(*args, **kwargs):
15afbcd0 9122 """
a95a7133 9123 GetGrandParent(self) -> Window
15afbcd0 9124
41e2b43e
RD
9125 Returns the parent of the parent of this window, or None if there
9126 isn't one.
15afbcd0 9127 """
54f9ee45 9128 return _core_.Window_GetGrandParent(*args, **kwargs)
e811c8ce
RD
9129
9130 def IsTopLevel(*args, **kwargs):
15afbcd0 9131 """
a95a7133 9132 IsTopLevel(self) -> bool
15afbcd0
RD
9133
9134 Returns true if the given window is a top-level one. Currently all
9135 frames and dialogs are always considered to be top-level windows (even
9136 if they have a parent window).
9137 """
54f9ee45 9138 return _core_.Window_IsTopLevel(*args, **kwargs)
e811c8ce
RD
9139
9140 def Reparent(*args, **kwargs):
15afbcd0 9141 """
a95a7133 9142 Reparent(self, Window newParent) -> bool
15afbcd0
RD
9143
9144 Reparents the window, i.e the window will be removed from its current
9145 parent window (e.g. a non-standard toolbar in a wxFrame) and then
9146 re-inserted into another. Available on Windows and GTK. Returns True
9147 if the parent was changed, False otherwise (error or newParent ==
9148 oldParent)
9149 """
54f9ee45 9150 return _core_.Window_Reparent(*args, **kwargs)
e811c8ce
RD
9151
9152 def AddChild(*args, **kwargs):
15afbcd0 9153 """
a95a7133 9154 AddChild(self, Window child)
15afbcd0
RD
9155
9156 Adds a child window. This is called automatically by window creation
9157 functions so should not be required by the application programmer.
9158 """
54f9ee45 9159 return _core_.Window_AddChild(*args, **kwargs)
e811c8ce
RD
9160
9161 def RemoveChild(*args, **kwargs):
15afbcd0 9162 """
a95a7133 9163 RemoveChild(self, Window child)
15afbcd0
RD
9164
9165 Removes a child window. This is called automatically by window
9166 deletion functions so should not be required by the application
9167 programmer.
9168 """
54f9ee45 9169 return _core_.Window_RemoveChild(*args, **kwargs)
e811c8ce 9170
704eda0c
RD
9171 def SetDoubleBuffered(*args, **kwargs):
9172 """
9173 SetDoubleBuffered(self, bool on)
9174
9175 Currently wxGTK2 only.
9176 """
9177 return _core_.Window_SetDoubleBuffered(*args, **kwargs)
9178
e811c8ce 9179 def FindWindowById(*args, **kwargs):
15afbcd0 9180 """
a95a7133 9181 FindWindowById(self, long winid) -> Window
15afbcd0
RD
9182
9183 Find a chld of this window by window ID
9184 """
54f9ee45 9185 return _core_.Window_FindWindowById(*args, **kwargs)
e811c8ce
RD
9186
9187 def FindWindowByName(*args, **kwargs):
15afbcd0 9188 """
a95a7133 9189 FindWindowByName(self, String name) -> Window
15afbcd0
RD
9190
9191 Find a child of this window by name
9192 """
54f9ee45 9193 return _core_.Window_FindWindowByName(*args, **kwargs)
e811c8ce
RD
9194
9195 def GetEventHandler(*args, **kwargs):
15afbcd0 9196 """
a95a7133 9197 GetEventHandler(self) -> EvtHandler
15afbcd0
RD
9198
9199 Returns the event handler for this window. By default, the window is
9200 its own event handler.
9201 """
54f9ee45 9202 return _core_.Window_GetEventHandler(*args, **kwargs)
e811c8ce
RD
9203
9204 def SetEventHandler(*args, **kwargs):
15afbcd0 9205 """
a95a7133 9206 SetEventHandler(self, EvtHandler handler)
15afbcd0
RD
9207
9208 Sets the event handler for this window. An event handler is an object
d49bdf34
RD
9209 that is capable of processing the events sent to a window. (In other
9210 words, is able to dispatch the events to handler function.) By
9211 default, the window is its own event handler, but an application may
9212 wish to substitute another, for example to allow central
9213 implementation of event-handling for a variety of different window
9214 classes.
15afbcd0 9215
41e2b43e 9216 It is usually better to use `wx.Window.PushEventHandler` since this sets
15afbcd0 9217 up a chain of event handlers, where an event not handled by one event
d49bdf34 9218 handler is handed off to the next one in the chain.
15afbcd0 9219 """
54f9ee45 9220 return _core_.Window_SetEventHandler(*args, **kwargs)
e811c8ce
RD
9221
9222 def PushEventHandler(*args, **kwargs):
15afbcd0 9223 """
a95a7133 9224 PushEventHandler(self, EvtHandler handler)
15afbcd0
RD
9225
9226 Pushes this event handler onto the event handler stack for the window.
9227 An event handler is an object that is capable of processing the events
d49bdf34
RD
9228 sent to a window. (In other words, is able to dispatch the events to
9229 handler function.) By default, the window is its own event handler,
9230 but an application may wish to substitute another, for example to
9231 allow central implementation of event-handling for a variety of
9232 different window classes.
15afbcd0
RD
9233
9234 wx.Window.PushEventHandler allows an application to set up a chain of
9235 event handlers, where an event not handled by one event handler is
d49bdf34
RD
9236 handed to the next one in the chain. Use `wx.Window.PopEventHandler`
9237 to remove the event handler. Ownership of the handler is *not* given
9238 to the window, so you should be sure to pop the handler before the
9239 window is destroyed and either let PopEventHandler destroy it, or call
9240 its Destroy method yourself.
15afbcd0 9241 """
54f9ee45 9242 return _core_.Window_PushEventHandler(*args, **kwargs)
e811c8ce
RD
9243
9244 def PopEventHandler(*args, **kwargs):
15afbcd0 9245 """
a95a7133 9246 PopEventHandler(self, bool deleteHandler=False) -> EvtHandler
15afbcd0
RD
9247
9248 Removes and returns the top-most event handler on the event handler
9249 stack. If deleteHandler is True then the wx.EvtHandler object will be
d49bdf34 9250 destroyed after it is popped, and ``None`` will be returned instead.
15afbcd0 9251 """
54f9ee45 9252 return _core_.Window_PopEventHandler(*args, **kwargs)
e811c8ce
RD
9253
9254 def RemoveEventHandler(*args, **kwargs):
15afbcd0 9255 """
a95a7133 9256 RemoveEventHandler(self, EvtHandler handler) -> bool
15afbcd0 9257
41e2b43e 9258 Find the given handler in the event handler chain and remove (but not
d49bdf34 9259 delete) it from the event handler chain, returns True if it was found
41e2b43e
RD
9260 and False otherwise (this also results in an assert failure so this
9261 function should only be called when the handler is supposed to be
9262 there.)
15afbcd0 9263 """
54f9ee45 9264 return _core_.Window_RemoveEventHandler(*args, **kwargs)
e811c8ce
RD
9265
9266 def SetValidator(*args, **kwargs):
15afbcd0 9267 """
a95a7133 9268 SetValidator(self, Validator validator)
15afbcd0
RD
9269
9270 Deletes the current validator (if any) and sets the window validator,
9271 having called wx.Validator.Clone to create a new validator of this
9272 type.
9273 """
54f9ee45 9274 return _core_.Window_SetValidator(*args, **kwargs)
e811c8ce
RD
9275
9276 def GetValidator(*args, **kwargs):
15afbcd0 9277 """
a95a7133 9278 GetValidator(self) -> Validator
15afbcd0
RD
9279
9280 Returns a pointer to the current validator for the window, or None if
9281 there is none.
9282 """
54f9ee45 9283 return _core_.Window_GetValidator(*args, **kwargs)
e811c8ce 9284
74a57fcd
RD
9285 def Validate(*args, **kwargs):
9286 """
a95a7133 9287 Validate(self) -> bool
74a57fcd
RD
9288
9289 Validates the current values of the child controls using their
41e2b43e
RD
9290 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
9291 style flag set, the method will also call Validate() of all child
9292 windows. Returns false if any of the validations failed.
74a57fcd 9293 """
54f9ee45 9294 return _core_.Window_Validate(*args, **kwargs)
74a57fcd
RD
9295
9296 def TransferDataToWindow(*args, **kwargs):
9297 """
a95a7133 9298 TransferDataToWindow(self) -> bool
74a57fcd 9299
41e2b43e
RD
9300 Transfers values to child controls from data areas specified by their
9301 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
9302 style flag set, the method will also call TransferDataToWindow() of
9303 all child windows.
74a57fcd 9304 """
54f9ee45 9305 return _core_.Window_TransferDataToWindow(*args, **kwargs)
74a57fcd
RD
9306
9307 def TransferDataFromWindow(*args, **kwargs):
9308 """
a95a7133 9309 TransferDataFromWindow(self) -> bool
74a57fcd 9310
41e2b43e
RD
9311 Transfers values from child controls to data areas specified by their
9312 validators. Returns false if a transfer failed. If the window has
9313 wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will
9314 also call TransferDataFromWindow() of all child windows.
74a57fcd 9315 """
54f9ee45 9316 return _core_.Window_TransferDataFromWindow(*args, **kwargs)
74a57fcd
RD
9317
9318 def InitDialog(*args, **kwargs):
9319 """
a95a7133 9320 InitDialog(self)
74a57fcd 9321
41e2b43e
RD
9322 Sends an EVT_INIT_DIALOG event, whose handler usually transfers data
9323 to the dialog via validators.
74a57fcd 9324 """
54f9ee45 9325 return _core_.Window_InitDialog(*args, **kwargs)
74a57fcd 9326
e811c8ce 9327 def SetAcceleratorTable(*args, **kwargs):
15afbcd0 9328 """
a95a7133 9329 SetAcceleratorTable(self, AcceleratorTable accel)
15afbcd0
RD
9330
9331 Sets the accelerator table for this window.
9332 """
54f9ee45 9333 return _core_.Window_SetAcceleratorTable(*args, **kwargs)
e811c8ce
RD
9334
9335 def GetAcceleratorTable(*args, **kwargs):
15afbcd0 9336 """
a95a7133 9337 GetAcceleratorTable(self) -> AcceleratorTable
15afbcd0
RD
9338
9339 Gets the accelerator table for this window.
9340 """
54f9ee45 9341 return _core_.Window_GetAcceleratorTable(*args, **kwargs)
e811c8ce
RD
9342
9343 def RegisterHotKey(*args, **kwargs):
15afbcd0 9344 """
a95a7133 9345 RegisterHotKey(self, int hotkeyId, int modifiers, int keycode) -> bool
15afbcd0
RD
9346
9347 Registers a system wide hotkey. Every time the user presses the hotkey
9348 registered here, this window will receive a hotkey event. It will
9349 receive the event even if the application is in the background and
9350 does not have the input focus because the user is working with some
9351 other application. To bind an event handler function to this hotkey
9352 use EVT_HOTKEY with an id equal to hotkeyId. Returns True if the
9353 hotkey was registered successfully.
9354 """
54f9ee45 9355 return _core_.Window_RegisterHotKey(*args, **kwargs)
e811c8ce
RD
9356
9357 def UnregisterHotKey(*args, **kwargs):
15afbcd0 9358 """
a95a7133 9359 UnregisterHotKey(self, int hotkeyId) -> bool
15afbcd0
RD
9360
9361 Unregisters a system wide hotkey.
9362 """
54f9ee45 9363 return _core_.Window_UnregisterHotKey(*args, **kwargs)
e811c8ce
RD
9364
9365 def ConvertDialogPointToPixels(*args, **kwargs):
15afbcd0 9366 """
a95a7133 9367 ConvertDialogPointToPixels(self, Point pt) -> Point
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_ConvertDialogPointToPixels(*args, **kwargs)
e811c8ce
RD
9377
9378 def ConvertDialogSizeToPixels(*args, **kwargs):
15afbcd0 9379 """
a95a7133 9380 ConvertDialogSizeToPixels(self, Size sz) -> Size
15afbcd0
RD
9381
9382 Converts a point or size from dialog units to pixels. Dialog units
9383 are used for maintaining a dialog's proportions even if the font
9384 changes. For the x dimension, the dialog units are multiplied by the
9385 average character width and then divided by 4. For the y dimension,
9386 the dialog units are multiplied by the average character height and
9387 then divided by 8.
9388 """
54f9ee45 9389 return _core_.Window_ConvertDialogSizeToPixels(*args, **kwargs)
e811c8ce
RD
9390
9391 def DLG_PNT(*args, **kwargs):
15afbcd0 9392 """
a95a7133 9393 DLG_PNT(self, Point pt) -> Point
15afbcd0
RD
9394
9395 Converts a point or size from dialog units to pixels. Dialog units
9396 are used for maintaining a dialog's proportions even if the font
9397 changes. For the x dimension, the dialog units are multiplied by the
9398 average character width and then divided by 4. For the y dimension,
9399 the dialog units are multiplied by the average character height and
9400 then divided by 8.
9401 """
54f9ee45 9402 return _core_.Window_DLG_PNT(*args, **kwargs)
e811c8ce
RD
9403
9404 def DLG_SZE(*args, **kwargs):
15afbcd0 9405 """
a95a7133 9406 DLG_SZE(self, Size sz) -> Size
15afbcd0
RD
9407
9408 Converts a point or size from dialog units to pixels. Dialog units
9409 are used for maintaining a dialog's proportions even if the font
9410 changes. For the x dimension, the dialog units are multiplied by the
9411 average character width and then divided by 4. For the y dimension,
9412 the dialog units are multiplied by the average character height and
9413 then divided by 8.
9414 """
54f9ee45 9415 return _core_.Window_DLG_SZE(*args, **kwargs)
e811c8ce
RD
9416
9417 def ConvertPixelPointToDialog(*args, **kwargs):
a95a7133 9418 """ConvertPixelPointToDialog(self, Point pt) -> Point"""
54f9ee45 9419 return _core_.Window_ConvertPixelPointToDialog(*args, **kwargs)
e811c8ce
RD
9420
9421 def ConvertPixelSizeToDialog(*args, **kwargs):
a95a7133 9422 """ConvertPixelSizeToDialog(self, Size sz) -> Size"""
54f9ee45 9423 return _core_.Window_ConvertPixelSizeToDialog(*args, **kwargs)
e811c8ce
RD
9424
9425 def WarpPointer(*args, **kwargs):
15afbcd0 9426 """
a95a7133 9427 WarpPointer(self, int x, int y)
15afbcd0
RD
9428
9429 Moves the pointer to the given position on the window.
9430
9431 NOTE: This function is not supported under Mac because Apple Human
9432 Interface Guidelines forbid moving the mouse cursor programmatically.
9433 """
54f9ee45 9434 return _core_.Window_WarpPointer(*args, **kwargs)
e811c8ce
RD
9435
9436 def CaptureMouse(*args, **kwargs):
15afbcd0 9437 """
a95a7133 9438 CaptureMouse(self)
15afbcd0
RD
9439
9440 Directs all mouse input to this window. Call wx.Window.ReleaseMouse to
9441 release the capture.
9442
9443 Note that wxWindows maintains the stack of windows having captured the
9444 mouse and when the mouse is released the capture returns to the window
9445 which had had captured it previously and it is only really released if
9446 there were no previous window. In particular, this means that you must
34e0a3bb
RD
9447 release the mouse as many times as you capture it, unless the window
9448 receives the `wx.MouseCaptureLostEvent` event.
9449
9450 Any application which captures the mouse in the beginning of some
9451 operation *must* handle `wx.MouseCaptureLostEvent` and cancel this
9452 operation when it receives the event. The event handler must not
9453 recapture mouse.
15afbcd0 9454 """
54f9ee45 9455 return _core_.Window_CaptureMouse(*args, **kwargs)
e811c8ce
RD
9456
9457 def ReleaseMouse(*args, **kwargs):
15afbcd0 9458 """
a95a7133 9459 ReleaseMouse(self)
15afbcd0
RD
9460
9461 Releases mouse input captured with wx.Window.CaptureMouse.
9462 """
54f9ee45 9463 return _core_.Window_ReleaseMouse(*args, **kwargs)
e811c8ce
RD
9464
9465 def GetCapture(*args, **kwargs):
15afbcd0 9466 """
66c033b4 9467 GetCapture() -> Window
15afbcd0
RD
9468
9469 Returns the window which currently captures the mouse or None
9470 """
54f9ee45 9471 return _core_.Window_GetCapture(*args, **kwargs)
e811c8ce
RD
9472
9473 GetCapture = staticmethod(GetCapture)
9474 def HasCapture(*args, **kwargs):
15afbcd0 9475 """
a95a7133 9476 HasCapture(self) -> bool
15afbcd0
RD
9477
9478 Returns true if this window has the current mouse capture.
9479 """
54f9ee45 9480 return _core_.Window_HasCapture(*args, **kwargs)
e811c8ce
RD
9481
9482 def Refresh(*args, **kwargs):
15afbcd0 9483 """
a95a7133 9484 Refresh(self, bool eraseBackground=True, Rect rect=None)
15afbcd0
RD
9485
9486 Mark the specified rectangle (or the whole window) as "dirty" so it
9487 will be repainted. Causes an EVT_PAINT event to be generated and sent
9488 to the window.
9489 """
54f9ee45 9490 return _core_.Window_Refresh(*args, **kwargs)
e811c8ce
RD
9491
9492 def RefreshRect(*args, **kwargs):
15afbcd0 9493 """
fef4c27a 9494 RefreshRect(self, Rect rect, bool eraseBackground=True)
15afbcd0
RD
9495
9496 Redraws the contents of the given rectangle: the area inside it will
9497 be repainted. This is the same as Refresh but has a nicer syntax.
9498 """
54f9ee45 9499 return _core_.Window_RefreshRect(*args, **kwargs)
e811c8ce
RD
9500
9501 def Update(*args, **kwargs):
15afbcd0 9502 """
a95a7133 9503 Update(self)
15afbcd0
RD
9504
9505 Calling this method immediately repaints the invalidated area of the
9506 window instead of waiting for the EVT_PAINT event to happen, (normally
9507 this would usually only happen when the flow of control returns to the
9508 event loop.) Notice that this function doesn't refresh the window and
9b940138 9509 does nothing if the window has been already repainted. Use `Refresh`
15afbcd0
RD
9510 first if you want to immediately redraw the window (or some portion of
9511 it) unconditionally.
9512 """
54f9ee45 9513 return _core_.Window_Update(*args, **kwargs)
e811c8ce
RD
9514
9515 def ClearBackground(*args, **kwargs):
15afbcd0 9516 """
a95a7133 9517 ClearBackground(self)
15afbcd0
RD
9518
9519 Clears the window by filling it with the current background
9520 colour. Does not cause an erase background event to be generated.
9521 """
54f9ee45 9522 return _core_.Window_ClearBackground(*args, **kwargs)
e811c8ce
RD
9523
9524 def Freeze(*args, **kwargs):
15afbcd0 9525 """
a95a7133 9526 Freeze(self)
15afbcd0 9527
41e2b43e
RD
9528 Freezes the window or, in other words, prevents any updates from
9529 taking place on screen, the window is not redrawn at all. Thaw must be
9530 called to reenable window redrawing. Calls to Freeze/Thaw may be
9531 nested, with the actual Thaw being delayed until all the nesting has
9532 been undone.
15afbcd0
RD
9533
9534 This method is useful for visual appearance optimization (for example,
9535 it is a good idea to use it before inserting large amount of text into
9536 a wxTextCtrl under wxGTK) but is not implemented on all platforms nor
9537 for all controls so it is mostly just a hint to wxWindows and not a
9538 mandatory directive.
9539 """
54f9ee45 9540 return _core_.Window_Freeze(*args, **kwargs)
e811c8ce 9541
33d6fd3b
RD
9542 def IsFrozen(*args, **kwargs):
9543 """
9544 IsFrozen(self) -> bool
9545
9546 Returns ``True`` if the window has been frozen and not thawed yet.
9547
9548 :see: `Freeze` and `Thaw`
9549 """
9550 return _core_.Window_IsFrozen(*args, **kwargs)
9551
e811c8ce 9552 def Thaw(*args, **kwargs):
15afbcd0 9553 """
a95a7133 9554 Thaw(self)
15afbcd0 9555
4276dc52 9556 Reenables window updating after a previous call to Freeze. Calls to
41e2b43e
RD
9557 Freeze/Thaw may be nested, so Thaw must be called the same number of
9558 times that Freeze was before the window will be updated.
15afbcd0 9559 """
54f9ee45 9560 return _core_.Window_Thaw(*args, **kwargs)
e811c8ce
RD
9561
9562 def PrepareDC(*args, **kwargs):
15afbcd0 9563 """
a95a7133 9564 PrepareDC(self, DC dc)
15afbcd0
RD
9565
9566 Call this function to prepare the device context for drawing a
9567 scrolled image. It sets the device origin according to the current
9568 scroll position.
9569 """
54f9ee45 9570 return _core_.Window_PrepareDC(*args, **kwargs)
e811c8ce 9571
b39fe951
RD
9572 def IsDoubleBuffered(*args, **kwargs):
9573 """
9574 IsDoubleBuffered(self) -> bool
9575
9576 Returns ``True`` if the window contents is double-buffered by the
9577 system, i.e. if any drawing done on the window is really done on a
9578 temporary backing surface and transferred to the screen all at once
9579 later.
9580 """
9581 return _core_.Window_IsDoubleBuffered(*args, **kwargs)
9582
e811c8ce 9583 def GetUpdateRegion(*args, **kwargs):
15afbcd0 9584 """
a95a7133 9585 GetUpdateRegion(self) -> Region
15afbcd0
RD
9586
9587 Returns the region specifying which parts of the window have been
9588 damaged. Should only be called within an EVT_PAINT handler.
9589 """
54f9ee45 9590 return _core_.Window_GetUpdateRegion(*args, **kwargs)
e811c8ce
RD
9591
9592 def GetUpdateClientRect(*args, **kwargs):
15afbcd0 9593 """
a95a7133 9594 GetUpdateClientRect(self) -> Rect
15afbcd0
RD
9595
9596 Get the update rectangle region bounding box in client coords.
9597 """
54f9ee45 9598 return _core_.Window_GetUpdateClientRect(*args, **kwargs)
e811c8ce
RD
9599
9600 def IsExposed(*args, **kwargs):
15afbcd0 9601 """
a95a7133 9602 IsExposed(self, int x, int y, int w=1, int h=1) -> bool
15afbcd0
RD
9603
9604 Returns true if the given point or rectangle area has been exposed
9605 since the last repaint. Call this in an paint event handler to
9606 optimize redrawing by only redrawing those areas, which have been
9607 exposed.
9608 """
54f9ee45 9609 return _core_.Window_IsExposed(*args, **kwargs)
e811c8ce
RD
9610
9611 def IsExposedPoint(*args, **kwargs):
15afbcd0 9612 """
a95a7133 9613 IsExposedPoint(self, Point pt) -> bool
15afbcd0
RD
9614
9615 Returns true if the given point or rectangle area has been exposed
9616 since the last repaint. Call this in an paint event handler to
9617 optimize redrawing by only redrawing those areas, which have been
9618 exposed.
9619 """
54f9ee45 9620 return _core_.Window_IsExposedPoint(*args, **kwargs)
e811c8ce 9621
4276dc52 9622 def IsExposedRect(*args, **kwargs):
15afbcd0 9623 """
a95a7133 9624 IsExposedRect(self, Rect rect) -> bool
15afbcd0
RD
9625
9626 Returns true if the given point or rectangle area has been exposed
9627 since the last repaint. Call this in an paint event handler to
9628 optimize redrawing by only redrawing those areas, which have been
9629 exposed.
9630 """
54f9ee45 9631 return _core_.Window_IsExposedRect(*args, **kwargs)
e811c8ce 9632
74a57fcd
RD
9633 def GetDefaultAttributes(*args, **kwargs):
9634 """
a95a7133 9635 GetDefaultAttributes(self) -> VisualAttributes
74a57fcd 9636
41e2b43e
RD
9637 Get the default attributes for an instance of this class. This is
9638 useful if you want to use the same font or colour in your own control
9639 as in a standard control -- which is a much better idea than hard
9640 coding specific colours or fonts which might look completely out of
db3e571a 9641 place on the user's system, especially if it uses themes.
74a57fcd 9642 """
54f9ee45 9643 return _core_.Window_GetDefaultAttributes(*args, **kwargs)
74a57fcd
RD
9644
9645 def GetClassDefaultAttributes(*args, **kwargs):
9646 """
66c033b4 9647 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
74a57fcd 9648
41e2b43e
RD
9649 Get the default attributes for this class. This is useful if you want
9650 to use the same font or colour in your own control as in a standard
9651 control -- which is a much better idea than hard coding specific
db3e571a
RD
9652 colours or fonts which might look completely out of place on the
9653 user's system, especially if it uses themes.
74a57fcd
RD
9654
9655 The variant parameter is only relevant under Mac currently and is
41e2b43e 9656 ignore under other platforms. Under Mac, it will change the size of
db3e571a
RD
9657 the returned font. See `wx.Window.SetWindowVariant` for more about
9658 this.
74a57fcd 9659 """
54f9ee45 9660 return _core_.Window_GetClassDefaultAttributes(*args, **kwargs)
74a57fcd
RD
9661
9662 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
e811c8ce 9663 def SetBackgroundColour(*args, **kwargs):
15afbcd0 9664 """
a95a7133 9665 SetBackgroundColour(self, Colour colour) -> bool
15afbcd0
RD
9666
9667 Sets the background colour of the window. Returns True if the colour
9668 was changed. The background colour is usually painted by the default
9669 EVT_ERASE_BACKGROUND event handler function under Windows and
f8167d6e
RD
9670 automatically under GTK. Using `wx.NullColour` will reset the window
9671 to the default background colour.
15afbcd0 9672
db3e571a 9673 Note that setting the background colour may not cause an immediate
f8167d6e 9674 refresh, so you may wish to call `ClearBackground` or `Refresh` after
15afbcd0
RD
9675 calling this function.
9676
f8167d6e
RD
9677 Using this function will disable attempts to use themes for this
9678 window, if the system supports them. Use with care since usually the
9679 themes represent the appearance chosen by the user to be used for all
9680 applications on the system.
15afbcd0 9681 """
54f9ee45 9682 return _core_.Window_SetBackgroundColour(*args, **kwargs)
e811c8ce 9683
412d302d
RD
9684 def SetOwnBackgroundColour(*args, **kwargs):
9685 """SetOwnBackgroundColour(self, Colour colour)"""
9686 return _core_.Window_SetOwnBackgroundColour(*args, **kwargs)
b2df227b 9687
e811c8ce 9688 def SetForegroundColour(*args, **kwargs):
15afbcd0 9689 """
a95a7133 9690 SetForegroundColour(self, Colour colour) -> bool
15afbcd0
RD
9691
9692 Sets the foreground colour of the window. Returns True is the colour
9693 was changed. The interpretation of foreground colour is dependent on
9694 the window class; it may be the text colour or other colour, or it may
9695 not be used at all.
9696 """
54f9ee45 9697 return _core_.Window_SetForegroundColour(*args, **kwargs)
e811c8ce 9698
fa47d7a7
VS
9699 def SetOwnForegroundColour(*args, **kwargs):
9700 """SetOwnForegroundColour(self, Colour colour)"""
9701 return _core_.Window_SetOwnForegroundColour(*args, **kwargs)
b2df227b 9702
e811c8ce 9703 def GetBackgroundColour(*args, **kwargs):
15afbcd0 9704 """
a95a7133 9705 GetBackgroundColour(self) -> Colour
15afbcd0
RD
9706
9707 Returns the background colour of the window.
9708 """
54f9ee45 9709 return _core_.Window_GetBackgroundColour(*args, **kwargs)
e811c8ce
RD
9710
9711 def GetForegroundColour(*args, **kwargs):
15afbcd0 9712 """
a95a7133 9713 GetForegroundColour(self) -> Colour
15afbcd0
RD
9714
9715 Returns the foreground colour of the window. The interpretation of
9716 foreground colour is dependent on the window class; it may be the text
9717 colour or other colour, or it may not be used at all.
9718 """
54f9ee45 9719 return _core_.Window_GetForegroundColour(*args, **kwargs)
e811c8ce 9720
562ecc31
RD
9721 def InheritsBackgroundColour(*args, **kwargs):
9722 """InheritsBackgroundColour(self) -> bool"""
9723 return _core_.Window_InheritsBackgroundColour(*args, **kwargs)
9724
9725 def UseBgCol(*args, **kwargs):
9726 """UseBgCol(self) -> bool"""
9727 return _core_.Window_UseBgCol(*args, **kwargs)
9728
7bc1e663
RD
9729 def SetBackgroundStyle(*args, **kwargs):
9730 """
9731 SetBackgroundStyle(self, int style) -> bool
9732
9733 Returns the background style of the window. The background style
9734 indicates how the background of the window is drawn.
9735
9736 ====================== ========================================
9737 wx.BG_STYLE_SYSTEM The background colour or pattern should
9738 be determined by the system
9739 wx.BG_STYLE_COLOUR The background should be a solid colour
9740 wx.BG_STYLE_CUSTOM The background will be implemented by the
9741 application.
9742 ====================== ========================================
9743
9744 On GTK+, use of wx.BG_STYLE_CUSTOM allows the flicker-free drawing of
9745 a custom background, such as a tiled bitmap. Currently the style has
9746 no effect on other platforms.
9747
9748 :see: `GetBackgroundStyle`, `SetBackgroundColour`
9749 """
9750 return _core_.Window_SetBackgroundStyle(*args, **kwargs)
9751
9752 def GetBackgroundStyle(*args, **kwargs):
9753 """
9754 GetBackgroundStyle(self) -> int
9755
9756 Returns the background style of the window.
9757
9758 :see: `SetBackgroundStyle`
9759 """
9760 return _core_.Window_GetBackgroundStyle(*args, **kwargs)
9761
51b83b37
RD
9762 def HasTransparentBackground(*args, **kwargs):
9763 """
9764 HasTransparentBackground(self) -> bool
9765
9766 Returns True if this window's background is transparent (as, for
9767 example, for `wx.StaticText`) and should show the parent window's
9768 background.
9769
9770 This method is mostly used internally by the library itself and you
9771 normally shouldn't have to call it. You may, however, have to override
9772 it in your custom control classes to ensure that background is painted
9773 correctly.
9774 """
9775 return _core_.Window_HasTransparentBackground(*args, **kwargs)
9776
e811c8ce 9777 def SetCursor(*args, **kwargs):
15afbcd0 9778 """
a95a7133 9779 SetCursor(self, Cursor cursor) -> bool
15afbcd0
RD
9780
9781 Sets the window's cursor. Notice that the window cursor also sets it
9782 for the children of the window implicitly.
9783
9784 The cursor may be wx.NullCursor in which case the window cursor will
9785 be reset back to default.
9786 """
54f9ee45 9787 return _core_.Window_SetCursor(*args, **kwargs)
e811c8ce
RD
9788
9789 def GetCursor(*args, **kwargs):
15afbcd0 9790 """
a95a7133 9791 GetCursor(self) -> Cursor
15afbcd0
RD
9792
9793 Return the cursor associated with this window.
9794 """
54f9ee45 9795 return _core_.Window_GetCursor(*args, **kwargs)
e811c8ce
RD
9796
9797 def SetFont(*args, **kwargs):
15afbcd0 9798 """
a95a7133 9799 SetFont(self, Font font) -> bool
15afbcd0
RD
9800
9801 Sets the font for this window.
9802 """
54f9ee45 9803 return _core_.Window_SetFont(*args, **kwargs)
e811c8ce 9804
fa47d7a7
VS
9805 def SetOwnFont(*args, **kwargs):
9806 """SetOwnFont(self, Font font)"""
9807 return _core_.Window_SetOwnFont(*args, **kwargs)
b2df227b 9808
e811c8ce 9809 def GetFont(*args, **kwargs):
15afbcd0 9810 """
a95a7133 9811 GetFont(self) -> Font
15afbcd0 9812
4276dc52 9813 Returns the default font used for this window.
15afbcd0 9814 """
54f9ee45 9815 return _core_.Window_GetFont(*args, **kwargs)
e811c8ce
RD
9816
9817 def SetCaret(*args, **kwargs):
15afbcd0 9818 """
a95a7133 9819 SetCaret(self, Caret caret)
15afbcd0
RD
9820
9821 Sets the caret associated with the window.
9822 """
54f9ee45 9823 return _core_.Window_SetCaret(*args, **kwargs)
e811c8ce
RD
9824
9825 def GetCaret(*args, **kwargs):
15afbcd0 9826 """
a95a7133 9827 GetCaret(self) -> Caret
15afbcd0
RD
9828
9829 Returns the caret associated with the window.
9830 """
54f9ee45 9831 return _core_.Window_GetCaret(*args, **kwargs)
e811c8ce
RD
9832
9833 def GetCharHeight(*args, **kwargs):
15afbcd0 9834 """
a95a7133 9835 GetCharHeight(self) -> int
15afbcd0
RD
9836
9837 Get the (average) character size for the current font.
9838 """
54f9ee45 9839 return _core_.Window_GetCharHeight(*args, **kwargs)
e811c8ce
RD
9840
9841 def GetCharWidth(*args, **kwargs):
15afbcd0 9842 """
a95a7133 9843 GetCharWidth(self) -> int
15afbcd0
RD
9844
9845 Get the (average) character size for the current font.
9846 """
54f9ee45 9847 return _core_.Window_GetCharWidth(*args, **kwargs)
e811c8ce
RD
9848
9849 def GetTextExtent(*args, **kwargs):
fd2dc343
RD
9850 """
9851 GetTextExtent(String string) -> (width, height)
9852
9853 Get the width and height of the text using the current font.
9854 """
54f9ee45 9855 return _core_.Window_GetTextExtent(*args, **kwargs)
e811c8ce
RD
9856
9857 def GetFullTextExtent(*args, **kwargs):
0df68c9f 9858 """
196addbf 9859 GetFullTextExtent(String string, Font font=None) ->
0df68c9f 9860 (width, height, descent, externalLeading)
e811c8ce 9861
15afbcd0
RD
9862 Get the width, height, decent and leading of the text using the
9863 current or specified font.
0df68c9f 9864 """
54f9ee45 9865 return _core_.Window_GetFullTextExtent(*args, **kwargs)
e811c8ce
RD
9866
9867 def ClientToScreenXY(*args, **kwargs):
15afbcd0
RD
9868 """
9869 ClientToScreenXY(int x, int y) -> (x,y)
9870
9871 Converts to screen coordinates from coordinates relative to this window.
9872 """
54f9ee45 9873 return _core_.Window_ClientToScreenXY(*args, **kwargs)
e811c8ce
RD
9874
9875 def ScreenToClientXY(*args, **kwargs):
15afbcd0
RD
9876 """
9877 ScreenToClientXY(int x, int y) -> (x,y)
9878
9879 Converts from screen to client window coordinates.
9880 """
54f9ee45 9881 return _core_.Window_ScreenToClientXY(*args, **kwargs)
e811c8ce
RD
9882
9883 def ClientToScreen(*args, **kwargs):
15afbcd0 9884 """
a95a7133 9885 ClientToScreen(self, Point pt) -> Point
15afbcd0
RD
9886
9887 Converts to screen coordinates from coordinates relative to this window.
9888 """
54f9ee45 9889 return _core_.Window_ClientToScreen(*args, **kwargs)
e811c8ce
RD
9890
9891 def ScreenToClient(*args, **kwargs):
15afbcd0 9892 """
a95a7133 9893 ScreenToClient(self, Point pt) -> Point
15afbcd0
RD
9894
9895 Converts from screen to client window coordinates.
9896 """
54f9ee45 9897 return _core_.Window_ScreenToClient(*args, **kwargs)
e811c8ce
RD
9898
9899 def HitTestXY(*args, **kwargs):
15afbcd0 9900 """
a95a7133 9901 HitTestXY(self, int x, int y) -> int
15afbcd0
RD
9902
9903 Test where the given (in client coords) point lies
9904 """
54f9ee45 9905 return _core_.Window_HitTestXY(*args, **kwargs)
e811c8ce
RD
9906
9907 def HitTest(*args, **kwargs):
15afbcd0 9908 """
a95a7133 9909 HitTest(self, Point pt) -> int
15afbcd0
RD
9910
9911 Test where the given (in client coords) point lies
9912 """
54f9ee45 9913 return _core_.Window_HitTest(*args, **kwargs)
e811c8ce 9914
15afbcd0
RD
9915 def GetBorder(*args):
9916 """
a95a7133
RD
9917 GetBorder(self, long flags) -> int
9918 GetBorder(self) -> int
e811c8ce 9919
15afbcd0
RD
9920 Get border for the flags of this window
9921 """
54f9ee45 9922 return _core_.Window_GetBorder(*args)
e811c8ce
RD
9923
9924 def UpdateWindowUI(*args, **kwargs):
15afbcd0 9925 """
a95a7133 9926 UpdateWindowUI(self, long flags=UPDATE_UI_NONE)
15afbcd0
RD
9927
9928 This function sends EVT_UPDATE_UI events to the window. The particular
9929 implementation depends on the window; for example a wx.ToolBar will
9930 send an update UI event for each toolbar button, and a wx.Frame will
9931 send an update UI event for each menubar menu item. You can call this
9932 function from your application to ensure that your UI is up-to-date at
9933 a particular point in time (as far as your EVT_UPDATE_UI handlers are
9934 concerned). This may be necessary if you have called
5ba5649b 9935 `wx.UpdateUIEvent.SetMode` or `wx.UpdateUIEvent.SetUpdateInterval` to
15afbcd0
RD
9936 limit the overhead that wxWindows incurs by sending update UI events
9937 in idle time.
15afbcd0 9938 """
54f9ee45 9939 return _core_.Window_UpdateWindowUI(*args, **kwargs)
e811c8ce
RD
9940
9941 def PopupMenuXY(*args, **kwargs):
15afbcd0 9942 """
b0503257 9943 PopupMenuXY(self, Menu menu, int x=-1, int y=-1) -> bool
15afbcd0 9944
b0503257
RD
9945 Pops up the given menu at the specified coordinates, relative to this window,
9946 and returns control when the user has dismissed the menu. If a menu item is
9947 selected, the corresponding menu event is generated and will be processed as
9948 usual. If the default position is given then the current position of the
9949 mouse cursor will be used.
15afbcd0 9950 """
54f9ee45 9951 return _core_.Window_PopupMenuXY(*args, **kwargs)
e811c8ce 9952
15afbcd0
RD
9953 def PopupMenu(*args, **kwargs):
9954 """
b0503257 9955 PopupMenu(self, Menu menu, Point pos=DefaultPosition) -> bool
15afbcd0 9956
b0503257
RD
9957 Pops up the given menu at the specified coordinates, relative to this window,
9958 and returns control when the user has dismissed the menu. If a menu item is
9959 selected, the corresponding menu event is generated and will be processed as
9960 usual. If the default position is given then the current position of the
9961 mouse cursor will be used.
15afbcd0 9962 """
54f9ee45 9963 return _core_.Window_PopupMenu(*args, **kwargs)
15afbcd0 9964
10044bf1
RD
9965 def HasMultiplePages(*args, **kwargs):
9966 """HasMultiplePages(self) -> bool"""
9967 return _core_.Window_HasMultiplePages(*args, **kwargs)
9968
15afbcd0
RD
9969 def GetHandle(*args, **kwargs):
9970 """
a95a7133 9971 GetHandle(self) -> long
15afbcd0
RD
9972
9973 Returns the platform-specific handle (as a long integer) of the
9974 physical window. Currently on wxMac it returns the handle of the
9975 toplevel parent of the window.
9976 """
54f9ee45 9977 return _core_.Window_GetHandle(*args, **kwargs)
15afbcd0 9978
7e63a440
RD
9979 def AssociateHandle(*args, **kwargs):
9980 """
9981 AssociateHandle(self, long handle)
9982
9983 Associate the window with a new native handle
9984 """
9985 return _core_.Window_AssociateHandle(*args, **kwargs)
9986
9987 def DissociateHandle(*args, **kwargs):
9988 """
9989 DissociateHandle(self)
9990
9991 Dissociate the current native handle from the window
9992 """
9993 return _core_.Window_DissociateHandle(*args, **kwargs)
9994
15afbcd0
RD
9995 def HasScrollbar(*args, **kwargs):
9996 """
a95a7133 9997 HasScrollbar(self, int orient) -> bool
15afbcd0
RD
9998
9999 Does the window have the scrollbar for this orientation?
10000 """
54f9ee45 10001 return _core_.Window_HasScrollbar(*args, **kwargs)
15afbcd0
RD
10002
10003 def SetScrollbar(*args, **kwargs):
10004 """
41e2b43e 10005 SetScrollbar(self, int orientation, int position, int thumbSize, int range,
15afbcd0
RD
10006 bool refresh=True)
10007
10008 Sets the scrollbar properties of a built-in scrollbar.
15afbcd0 10009 """
54f9ee45 10010 return _core_.Window_SetScrollbar(*args, **kwargs)
e811c8ce
RD
10011
10012 def SetScrollPos(*args, **kwargs):
15afbcd0 10013 """
a95a7133 10014 SetScrollPos(self, int orientation, int pos, bool refresh=True)
15afbcd0
RD
10015
10016 Sets the position of one of the built-in scrollbars.
10017 """
54f9ee45 10018 return _core_.Window_SetScrollPos(*args, **kwargs)
e811c8ce
RD
10019
10020 def GetScrollPos(*args, **kwargs):
15afbcd0 10021 """
a95a7133 10022 GetScrollPos(self, int orientation) -> int
15afbcd0
RD
10023
10024 Returns the built-in scrollbar position.
10025 """
54f9ee45 10026 return _core_.Window_GetScrollPos(*args, **kwargs)
e811c8ce
RD
10027
10028 def GetScrollThumb(*args, **kwargs):
15afbcd0 10029 """
a95a7133 10030 GetScrollThumb(self, int orientation) -> int
15afbcd0
RD
10031
10032 Returns the built-in scrollbar thumb size.
10033 """
54f9ee45 10034 return _core_.Window_GetScrollThumb(*args, **kwargs)
e811c8ce
RD
10035
10036 def GetScrollRange(*args, **kwargs):
15afbcd0 10037 """
a95a7133 10038 GetScrollRange(self, int orientation) -> int
15afbcd0
RD
10039
10040 Returns the built-in scrollbar range.
10041 """
54f9ee45 10042 return _core_.Window_GetScrollRange(*args, **kwargs)
e811c8ce
RD
10043
10044 def ScrollWindow(*args, **kwargs):
15afbcd0 10045 """
a95a7133 10046 ScrollWindow(self, int dx, int dy, Rect rect=None)
15afbcd0
RD
10047
10048 Physically scrolls the pixels in the window and move child windows
10049 accordingly. Use this function to optimise your scrolling
10050 implementations, to minimise the area that must be redrawn. Note that
10051 it is rarely required to call this function from a user program.
15afbcd0 10052 """
54f9ee45 10053 return _core_.Window_ScrollWindow(*args, **kwargs)
e811c8ce
RD
10054
10055 def ScrollLines(*args, **kwargs):
15afbcd0 10056 """
a95a7133 10057 ScrollLines(self, int lines) -> bool
15afbcd0
RD
10058
10059 If the platform and window class supports it, scrolls the window by
10060 the given number of lines down, if lines is positive, or up if lines
10061 is negative. Returns True if the window was scrolled, False if it was
10062 already on top/bottom and nothing was done.
10063 """
54f9ee45 10064 return _core_.Window_ScrollLines(*args, **kwargs)
e811c8ce
RD
10065
10066 def ScrollPages(*args, **kwargs):
15afbcd0 10067 """
a95a7133 10068 ScrollPages(self, int pages) -> bool
15afbcd0 10069
41e2b43e 10070 If the platform and window class supports it, scrolls the window by
15afbcd0
RD
10071 the given number of pages down, if pages is positive, or up if pages
10072 is negative. Returns True if the window was scrolled, False if it was
10073 already on top/bottom and nothing was done.
10074 """
54f9ee45 10075 return _core_.Window_ScrollPages(*args, **kwargs)
e811c8ce
RD
10076
10077 def LineUp(*args, **kwargs):
15afbcd0 10078 """
a95a7133 10079 LineUp(self) -> bool
15afbcd0
RD
10080
10081 This is just a wrapper for ScrollLines(-1).
10082 """
54f9ee45 10083 return _core_.Window_LineUp(*args, **kwargs)
e811c8ce
RD
10084
10085 def LineDown(*args, **kwargs):
15afbcd0 10086 """
a95a7133 10087 LineDown(self) -> bool
15afbcd0
RD
10088
10089 This is just a wrapper for ScrollLines(1).
10090 """
54f9ee45 10091 return _core_.Window_LineDown(*args, **kwargs)
e811c8ce
RD
10092
10093 def PageUp(*args, **kwargs):
15afbcd0 10094 """
a95a7133 10095 PageUp(self) -> bool
15afbcd0
RD
10096
10097 This is just a wrapper for ScrollPages(-1).
10098 """
54f9ee45 10099 return _core_.Window_PageUp(*args, **kwargs)
e811c8ce
RD
10100
10101 def PageDown(*args, **kwargs):
15afbcd0 10102 """
a95a7133 10103 PageDown(self) -> bool
15afbcd0
RD
10104
10105 This is just a wrapper for ScrollPages(1).
10106 """
54f9ee45 10107 return _core_.Window_PageDown(*args, **kwargs)
e811c8ce
RD
10108
10109 def SetHelpText(*args, **kwargs):
15afbcd0 10110 """
a95a7133 10111 SetHelpText(self, String text)
15afbcd0
RD
10112
10113 Sets the help text to be used as context-sensitive help for this
10114 window. Note that the text is actually stored by the current
f52cbe90 10115 `wx.HelpProvider` implementation, and not in the window object itself.
15afbcd0 10116 """
54f9ee45 10117 return _core_.Window_SetHelpText(*args, **kwargs)
e811c8ce
RD
10118
10119 def SetHelpTextForId(*args, **kwargs):
15afbcd0 10120 """
a95a7133 10121 SetHelpTextForId(self, String text)
15afbcd0
RD
10122
10123 Associate this help text with all windows with the same id as this
10124 one.
10125 """
54f9ee45 10126 return _core_.Window_SetHelpTextForId(*args, **kwargs)
e811c8ce 10127
b850e7f3
RD
10128 def GetHelpTextAtPoint(*args, **kwargs):
10129 """
10130 GetHelpTextAtPoint(self, Point pt, wxHelpEvent::Origin origin) -> String
10131
10132 Get the help string associated with the given position in this window.
10133
10134 Notice that pt may be invalid if event origin is keyboard or unknown
10135 and this method should return the global window help text then
10136
10137 """
10138 return _core_.Window_GetHelpTextAtPoint(*args, **kwargs)
10139
e811c8ce 10140 def GetHelpText(*args, **kwargs):
15afbcd0 10141 """
a95a7133 10142 GetHelpText(self) -> String
15afbcd0
RD
10143
10144 Gets the help text to be used as context-sensitive help for this
10145 window. Note that the text is actually stored by the current
f52cbe90 10146 `wx.HelpProvider` implementation, and not in the window object itself.
15afbcd0 10147 """
54f9ee45 10148 return _core_.Window_GetHelpText(*args, **kwargs)
e811c8ce
RD
10149
10150 def SetToolTipString(*args, **kwargs):
15afbcd0 10151 """
a95a7133 10152 SetToolTipString(self, String tip)
15afbcd0
RD
10153
10154 Attach a tooltip to the window.
10155 """
54f9ee45 10156 return _core_.Window_SetToolTipString(*args, **kwargs)
e811c8ce
RD
10157
10158 def SetToolTip(*args, **kwargs):
15afbcd0 10159 """
a95a7133 10160 SetToolTip(self, ToolTip tip)
15afbcd0
RD
10161
10162 Attach a tooltip to the window.
10163 """
54f9ee45 10164 return _core_.Window_SetToolTip(*args, **kwargs)
e811c8ce
RD
10165
10166 def GetToolTip(*args, **kwargs):
15afbcd0 10167 """
a95a7133 10168 GetToolTip(self) -> ToolTip
15afbcd0
RD
10169
10170 get the associated tooltip or None if none
10171 """
54f9ee45 10172 return _core_.Window_GetToolTip(*args, **kwargs)
e811c8ce
RD
10173
10174 def SetDropTarget(*args, **kwargs):
15afbcd0 10175 """
a95a7133 10176 SetDropTarget(self, DropTarget dropTarget)
15afbcd0
RD
10177
10178 Associates a drop target with this window. If the window already has
10179 a drop target, it is deleted.
10180 """
54f9ee45 10181 return _core_.Window_SetDropTarget(*args, **kwargs)
e811c8ce
RD
10182
10183 def GetDropTarget(*args, **kwargs):
15afbcd0 10184 """
a95a7133 10185 GetDropTarget(self) -> DropTarget
15afbcd0
RD
10186
10187 Returns the associated drop target, which may be None.
10188 """
54f9ee45 10189 return _core_.Window_GetDropTarget(*args, **kwargs)
e811c8ce 10190
5ba5649b
RD
10191 def DragAcceptFiles(*args, **kwargs):
10192 """
10193 DragAcceptFiles(self, bool accept)
10194
10195 Enables or disables eligibility for drop file events, EVT_DROP_FILES.
10196 Only functional on Windows.
10197 """
10198 return _core_.Window_DragAcceptFiles(*args, **kwargs)
10199
e811c8ce 10200 def SetConstraints(*args, **kwargs):
15afbcd0 10201 """
a95a7133 10202 SetConstraints(self, LayoutConstraints constraints)
15afbcd0
RD
10203
10204 Sets the window to have the given layout constraints. If an existing
10205 layout constraints object is already owned by the window, it will be
10206 deleted. Pass None to disassociate and delete the window's current
10207 constraints.
10208
10209 You must call SetAutoLayout to tell a window to use the constraints
10210 automatically in its default EVT_SIZE handler; otherwise, you must
10211 handle EVT_SIZE yourself and call Layout() explicitly. When setting
10212 both a wx.LayoutConstraints and a wx.Sizer, only the sizer will have
10213 effect.
10214 """
54f9ee45 10215 return _core_.Window_SetConstraints(*args, **kwargs)
e811c8ce
RD
10216
10217 def GetConstraints(*args, **kwargs):
15afbcd0 10218 """
a95a7133 10219 GetConstraints(self) -> LayoutConstraints
15afbcd0
RD
10220
10221 Returns a pointer to the window's layout constraints, or None if there
10222 are none.
10223 """
54f9ee45 10224 return _core_.Window_GetConstraints(*args, **kwargs)
e811c8ce
RD
10225
10226 def SetAutoLayout(*args, **kwargs):
15afbcd0 10227 """
a95a7133 10228 SetAutoLayout(self, bool autoLayout)
15afbcd0
RD
10229
10230 Determines whether the Layout function will be called automatically
b1fcee84
RD
10231 when the window is resized. lease note that this only happens for the
10232 windows usually used to contain children, namely `wx.Panel` and
10233 `wx.TopLevelWindow` (and the classes deriving from them).
10234
10235 This method is called implicitly by `SetSizer` but if you use
10236 `SetConstraints` you should call it manually or otherwise the window
10237 layout won't be correctly updated when its size changes.
15afbcd0 10238 """
54f9ee45 10239 return _core_.Window_SetAutoLayout(*args, **kwargs)
e811c8ce
RD
10240
10241 def GetAutoLayout(*args, **kwargs):
15afbcd0 10242 """
a95a7133 10243 GetAutoLayout(self) -> bool
15afbcd0
RD
10244
10245 Returns the current autoLayout setting
10246 """
54f9ee45 10247 return _core_.Window_GetAutoLayout(*args, **kwargs)
e811c8ce
RD
10248
10249 def Layout(*args, **kwargs):
15afbcd0 10250 """
a95a7133 10251 Layout(self) -> bool
15afbcd0
RD
10252
10253 Invokes the constraint-based layout algorithm or the sizer-based
10254 algorithm for this window. See SetAutoLayout: when auto layout is on,
10255 this function gets called automatically by the default EVT_SIZE
10256 handler when the window is resized.
10257 """
54f9ee45 10258 return _core_.Window_Layout(*args, **kwargs)
e811c8ce
RD
10259
10260 def SetSizer(*args, **kwargs):
15afbcd0 10261 """
a95a7133 10262 SetSizer(self, Sizer sizer, bool deleteOld=True)
15afbcd0
RD
10263
10264 Sets the window to have the given layout sizer. The window will then
10265 own the object, and will take care of its deletion. If an existing
10266 layout sizer object is already owned by the window, it will be deleted
10267 if the deleteOld parameter is true. Note that this function will also
10268 call SetAutoLayout implicitly with a True parameter if the sizer is
ae8162c8 10269 non-None, and False otherwise.
15afbcd0 10270 """
54f9ee45 10271 return _core_.Window_SetSizer(*args, **kwargs)
e811c8ce
RD
10272
10273 def SetSizerAndFit(*args, **kwargs):
15afbcd0 10274 """
a95a7133 10275 SetSizerAndFit(self, Sizer sizer, bool deleteOld=True)
15afbcd0
RD
10276
10277 The same as SetSizer, except it also sets the size hints for the
10278 window based on the sizer's minimum size.
10279 """
54f9ee45 10280 return _core_.Window_SetSizerAndFit(*args, **kwargs)
e811c8ce
RD
10281
10282 def GetSizer(*args, **kwargs):
15afbcd0 10283 """
a95a7133 10284 GetSizer(self) -> Sizer
15afbcd0
RD
10285
10286 Return the sizer associated with the window by a previous call to
10287 SetSizer or None if there isn't one.
10288 """
54f9ee45 10289 return _core_.Window_GetSizer(*args, **kwargs)
e811c8ce
RD
10290
10291 def SetContainingSizer(*args, **kwargs):
15afbcd0 10292 """
a95a7133 10293 SetContainingSizer(self, Sizer sizer)
15afbcd0
RD
10294
10295 This normally does not need to be called by application code. It is
10296 called internally when a window is added to a sizer, and is used so
10297 the window can remove itself from the sizer when it is destroyed.
10298 """
54f9ee45 10299 return _core_.Window_SetContainingSizer(*args, **kwargs)
e811c8ce
RD
10300
10301 def GetContainingSizer(*args, **kwargs):
15afbcd0 10302 """
a95a7133 10303 GetContainingSizer(self) -> Sizer
15afbcd0
RD
10304
10305 Return the sizer that this window is a member of, if any, otherwise None.
10306 """
54f9ee45 10307 return _core_.Window_GetContainingSizer(*args, **kwargs)
e811c8ce 10308
a95a7133
RD
10309 def InheritAttributes(*args, **kwargs):
10310 """
10311 InheritAttributes(self)
10312
41e2b43e
RD
10313 This function is (or should be, in case of custom controls) called
10314 during window creation to intelligently set up the window visual
10315 attributes, that is the font and the foreground and background
10316 colours.
10317
10318 By 'intelligently' the following is meant: by default, all windows use
10319 their own default attributes. However if some of the parent's
10320 attributes are explicitly changed (that is, using SetFont and not
fa47d7a7 10321 SetOwnFont) and if the corresponding attribute hadn't been
41e2b43e
RD
10322 explicitly set for this window itself, then this window takes the same
10323 value as used by the parent. In addition, if the window overrides
10324 ShouldInheritColours to return false, the colours will not be changed
10325 no matter what and only the font might.
10326
34621cc5 10327 This rather complicated logic is necessary in order to accommodate the
ec9b55ca 10328 different usage scenarios. The most common one is when all default
41e2b43e
RD
10329 attributes are used and in this case, nothing should be inherited as
10330 in modern GUIs different controls use different fonts (and colours)
10331 than their siblings so they can't inherit the same value from the
10332 parent. However it was also deemed desirable to allow to simply change
10333 the attributes of all children at once by just changing the font or
10334 colour of their common parent, hence in this case we do inherit the
10335 parents attributes.
10336
a95a7133 10337 """
54f9ee45 10338 return _core_.Window_InheritAttributes(*args, **kwargs)
a95a7133
RD
10339
10340 def ShouldInheritColours(*args, **kwargs):
10341 """
10342 ShouldInheritColours(self) -> bool
10343
10344 Return true from here to allow the colours of this window to be
41e2b43e
RD
10345 changed by InheritAttributes, returning false forbids inheriting them
10346 from the parent window.
a95a7133 10347
41e2b43e
RD
10348 The base class version returns false, but this method is overridden in
10349 wxControl where it returns true.
a95a7133 10350 """
54f9ee45 10351 return _core_.Window_ShouldInheritColours(*args, **kwargs)
a95a7133 10352
fc46b7f3
RD
10353 def CanSetTransparent(*args, **kwargs):
10354 """
10355 CanSetTransparent(self) -> bool
10356
10357 Returns ``True`` if the platform supports setting the transparency for
10358 this window. Note that this method will err on the side of caution,
10359 so it is possible that this will return ``False`` when it is in fact
10360 possible to set the transparency.
10361
10362 NOTE: On X-windows systems the X server must have the composite
10363 extension loaded, and there must be a composite manager program (such
10364 as xcompmgr) running.
10365 """
10366 return _core_.Window_CanSetTransparent(*args, **kwargs)
10367
10368 def SetTransparent(*args, **kwargs):
10369 """
10370 SetTransparent(self, byte alpha) -> bool
10371
10372 Attempt to set the transparency of this window to the ``alpha`` value,
10373 returns True on success. The ``alpha`` value is an integer in the
10374 range of 0 to 255, where 0 is fully transparent and 255 is fully
10375 opaque.
10376 """
10377 return _core_.Window_SetTransparent(*args, **kwargs)
10378
e811c8ce 10379 def PostCreate(self, pre):
15afbcd0
RD
10380 """
10381 Phase 3 of the 2-phase create <wink!>
10382 Call this method after precreating the window with the 2-phase create method.
10383 """
e811c8ce
RD
10384 self.this = pre.this
10385 self.thisown = pre.thisown
10386 pre.thisown = 0
10387 if hasattr(self, '_setOORInfo'):
4976f996
RD
10388 try:
10389 self._setOORInfo(self)
10390 except TypeError:
10391 pass
e811c8ce 10392 if hasattr(self, '_setCallbackInfo'):
4976f996
RD
10393 try:
10394 self._setCallbackInfo(self, pre.__class__)
10395 except TypeError:
10396 pass
e811c8ce 10397
7e08d4ef 10398 def SendSizeEvent(self):
453fb36b 10399 self.GetEventHandler().ProcessEvent(wx.SizeEvent((-1,-1)))
7e08d4ef 10400
2bf58437 10401 AcceleratorTable = property(GetAcceleratorTable,SetAcceleratorTable,doc="See `GetAcceleratorTable` and `SetAcceleratorTable`")
2bf58437
RD
10402 AutoLayout = property(GetAutoLayout,SetAutoLayout,doc="See `GetAutoLayout` and `SetAutoLayout`")
10403 BackgroundColour = property(GetBackgroundColour,SetBackgroundColour,doc="See `GetBackgroundColour` and `SetBackgroundColour`")
10404 BackgroundStyle = property(GetBackgroundStyle,SetBackgroundStyle,doc="See `GetBackgroundStyle` and `SetBackgroundStyle`")
580080c5 10405 EffectiveMinSize = property(GetEffectiveMinSize,doc="See `GetEffectiveMinSize`")
2bf58437
RD
10406 BestSize = property(GetBestSize,doc="See `GetBestSize`")
10407 BestVirtualSize = property(GetBestVirtualSize,doc="See `GetBestVirtualSize`")
10408 Border = property(GetBorder,doc="See `GetBorder`")
10409 Caret = property(GetCaret,SetCaret,doc="See `GetCaret` and `SetCaret`")
10410 CharHeight = property(GetCharHeight,doc="See `GetCharHeight`")
10411 CharWidth = property(GetCharWidth,doc="See `GetCharWidth`")
10412 Children = property(GetChildren,doc="See `GetChildren`")
10413 ClientAreaOrigin = property(GetClientAreaOrigin,doc="See `GetClientAreaOrigin`")
10414 ClientRect = property(GetClientRect,SetClientRect,doc="See `GetClientRect` and `SetClientRect`")
10415 ClientSize = property(GetClientSize,SetClientSize,doc="See `GetClientSize` and `SetClientSize`")
10416 Constraints = property(GetConstraints,SetConstraints,doc="See `GetConstraints` and `SetConstraints`")
10417 ContainingSizer = property(GetContainingSizer,SetContainingSizer,doc="See `GetContainingSizer` and `SetContainingSizer`")
10418 Cursor = property(GetCursor,SetCursor,doc="See `GetCursor` and `SetCursor`")
10419 DefaultAttributes = property(GetDefaultAttributes,doc="See `GetDefaultAttributes`")
10420 DropTarget = property(GetDropTarget,SetDropTarget,doc="See `GetDropTarget` and `SetDropTarget`")
10421 EventHandler = property(GetEventHandler,SetEventHandler,doc="See `GetEventHandler` and `SetEventHandler`")
10422 ExtraStyle = property(GetExtraStyle,SetExtraStyle,doc="See `GetExtraStyle` and `SetExtraStyle`")
10423 Font = property(GetFont,SetFont,doc="See `GetFont` and `SetFont`")
10424 ForegroundColour = property(GetForegroundColour,SetForegroundColour,doc="See `GetForegroundColour` and `SetForegroundColour`")
2bf58437
RD
10425 GrandParent = property(GetGrandParent,doc="See `GetGrandParent`")
10426 Handle = property(GetHandle,doc="See `GetHandle`")
10427 HelpText = property(GetHelpText,SetHelpText,doc="See `GetHelpText` and `SetHelpText`")
2bf58437
RD
10428 Id = property(GetId,SetId,doc="See `GetId` and `SetId`")
10429 Label = property(GetLabel,SetLabel,doc="See `GetLabel` and `SetLabel`")
994453b8 10430 LayoutDirection = property(GetLayoutDirection,SetLayoutDirection,doc="See `GetLayoutDirection` and `SetLayoutDirection`")
2bf58437
RD
10431 MaxHeight = property(GetMaxHeight,doc="See `GetMaxHeight`")
10432 MaxSize = property(GetMaxSize,SetMaxSize,doc="See `GetMaxSize` and `SetMaxSize`")
10433 MaxWidth = property(GetMaxWidth,doc="See `GetMaxWidth`")
10434 MinHeight = property(GetMinHeight,doc="See `GetMinHeight`")
10435 MinSize = property(GetMinSize,SetMinSize,doc="See `GetMinSize` and `SetMinSize`")
10436 MinWidth = property(GetMinWidth,doc="See `GetMinWidth`")
10437 Name = property(GetName,SetName,doc="See `GetName` and `SetName`")
10438 Parent = property(GetParent,doc="See `GetParent`")
10439 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
10440 Rect = property(GetRect,SetRect,doc="See `GetRect` and `SetRect`")
10441 ScreenPosition = property(GetScreenPosition,doc="See `GetScreenPosition`")
10442 ScreenRect = property(GetScreenRect,doc="See `GetScreenRect`")
2bf58437
RD
10443 Size = property(GetSize,SetSize,doc="See `GetSize` and `SetSize`")
10444 Sizer = property(GetSizer,SetSizer,doc="See `GetSizer` and `SetSizer`")
2bf58437
RD
10445 ThemeEnabled = property(GetThemeEnabled,SetThemeEnabled,doc="See `GetThemeEnabled` and `SetThemeEnabled`")
10446 ToolTip = property(GetToolTip,SetToolTip,doc="See `GetToolTip` and `SetToolTip`")
10447 UpdateClientRect = property(GetUpdateClientRect,doc="See `GetUpdateClientRect`")
10448 UpdateRegion = property(GetUpdateRegion,doc="See `GetUpdateRegion`")
10449 Validator = property(GetValidator,SetValidator,doc="See `GetValidator` and `SetValidator`")
10450 VirtualSize = property(GetVirtualSize,SetVirtualSize,doc="See `GetVirtualSize` and `SetVirtualSize`")
10451 WindowStyle = property(GetWindowStyle,SetWindowStyle,doc="See `GetWindowStyle` and `SetWindowStyle`")
10452 WindowStyleFlag = property(GetWindowStyleFlag,SetWindowStyleFlag,doc="See `GetWindowStyleFlag` and `SetWindowStyleFlag`")
10453 WindowVariant = property(GetWindowVariant,SetWindowVariant,doc="See `GetWindowVariant` and `SetWindowVariant`")
97ab0f6a
RD
10454 Shown = property(IsShown,Show,doc="See `IsShown` and `Show`")
10455 Enabled = property(IsEnabled,Enable,doc="See `IsEnabled` and `Enable`")
10456 TopLevel = property(IsTopLevel,doc="See `IsTopLevel`")
2131d850 10457_core_.Window_swigregister(Window)
e811c8ce
RD
10458
10459def PreWindow(*args, **kwargs):
15afbcd0
RD
10460 """
10461 PreWindow() -> Window
10462
10463 Precreate a Window for 2-phase creation.
10464 """
54f9ee45 10465 val = _core_.new_PreWindow(*args, **kwargs)
e811c8ce
RD
10466 return val
10467
0085ce49
RD
10468def Window_NewControlId(*args):
10469 """
15afbcd0
RD
10470 Window_NewControlId() -> int
10471
10472 Generate a control id for the controls which were not given one.
10473 """
0085ce49 10474 return _core_.Window_NewControlId(*args)
e811c8ce
RD
10475
10476def Window_NextControlId(*args, **kwargs):
0085ce49 10477 """
15afbcd0
RD
10478 Window_NextControlId(int winid) -> int
10479
10480 Get the id of the control following the one with the given
41e2b43e 10481 autogenerated) id
15afbcd0 10482 """
0085ce49 10483 return _core_.Window_NextControlId(*args, **kwargs)
e811c8ce
RD
10484
10485def Window_PrevControlId(*args, **kwargs):
0085ce49 10486 """
15afbcd0
RD
10487 Window_PrevControlId(int winid) -> int
10488
10489 Get the id of the control preceding the one with the given
41e2b43e 10490 autogenerated) id
15afbcd0 10491 """
0085ce49 10492 return _core_.Window_PrevControlId(*args, **kwargs)
e811c8ce 10493
0085ce49
RD
10494def Window_FindFocus(*args):
10495 """
15afbcd0
RD
10496 Window_FindFocus() -> Window
10497
10498 Returns the window or control that currently has the keyboard focus,
10499 or None.
10500 """
0085ce49 10501 return _core_.Window_FindFocus(*args)
e811c8ce 10502
0085ce49
RD
10503def Window_GetCapture(*args):
10504 """
15afbcd0
RD
10505 Window_GetCapture() -> Window
10506
10507 Returns the window which currently captures the mouse or None
10508 """
0085ce49 10509 return _core_.Window_GetCapture(*args)
e811c8ce 10510
74a57fcd 10511def Window_GetClassDefaultAttributes(*args, **kwargs):
0085ce49 10512 """
74a57fcd
RD
10513 Window_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
10514
41e2b43e
RD
10515 Get the default attributes for this class. This is useful if you want
10516 to use the same font or colour in your own control as in a standard
10517 control -- which is a much better idea than hard coding specific
db3e571a
RD
10518 colours or fonts which might look completely out of place on the
10519 user's system, especially if it uses themes.
74a57fcd
RD
10520
10521 The variant parameter is only relevant under Mac currently and is
41e2b43e 10522 ignore under other platforms. Under Mac, it will change the size of
db3e571a
RD
10523 the returned font. See `wx.Window.SetWindowVariant` for more about
10524 this.
74a57fcd 10525 """
0085ce49 10526 return _core_.Window_GetClassDefaultAttributes(*args, **kwargs)
74a57fcd 10527
e811c8ce 10528def DLG_PNT(win, point_or_x, y=None):
15afbcd0
RD
10529 """
10530 Convenience function for converting a Point or (x,y) in
10531 dialog units to pixel units.
10532 """
e811c8ce
RD
10533 if y is None:
10534 return win.ConvertDialogPointToPixels(point_or_x)
10535 else:
fd3f2efe 10536 return win.ConvertDialogPointToPixels(wx.Point(point_or_x, y))
e811c8ce
RD
10537
10538def DLG_SZE(win, size_width, height=None):
15afbcd0
RD
10539 """
10540 Convenience function for converting a Size or (w,h) in
10541 dialog units to pixel units.
10542 """
e811c8ce
RD
10543 if height is None:
10544 return win.ConvertDialogSizeToPixels(size_width)
10545 else:
fd3f2efe 10546 return win.ConvertDialogSizeToPixels(wx.Size(size_width, height))
e811c8ce
RD
10547
10548
10549def FindWindowById(*args, **kwargs):
0085ce49 10550 """
15afbcd0
RD
10551 FindWindowById(long id, Window parent=None) -> Window
10552
10553 Find the first window in the application with the given id. If parent
10554 is None, the search will start from all top-level frames and dialog
10555 boxes; if non-None, the search will be limited to the given window
10556 hierarchy. The search is recursive in both cases.
10557 """
0085ce49 10558 return _core_.FindWindowById(*args, **kwargs)
e811c8ce
RD
10559
10560def FindWindowByName(*args, **kwargs):
0085ce49 10561 """
15afbcd0
RD
10562 FindWindowByName(String name, Window parent=None) -> Window
10563
10564 Find a window by its name (as given in a window constructor or Create
10565 function call). If parent is None, the search will start from all
10566 top-level frames and dialog boxes; if non-None, the search will be
10567 limited to the given window hierarchy. The search is recursive in both
10568 cases.
10569
10570 If no window with such name is found, wx.FindWindowByLabel is called.
10571 """
0085ce49 10572 return _core_.FindWindowByName(*args, **kwargs)
e811c8ce
RD
10573
10574def FindWindowByLabel(*args, **kwargs):
0085ce49 10575 """
15afbcd0
RD
10576 FindWindowByLabel(String label, Window parent=None) -> Window
10577
10578 Find a window by its label. Depending on the type of window, the label
10579 may be a window title or panel item label. If parent is None, the
10580 search will start from all top-level frames and dialog boxes; if
10581 non-None, the search will be limited to the given window
10582 hierarchy. The search is recursive in both cases.
10583 """
0085ce49 10584 return _core_.FindWindowByLabel(*args, **kwargs)
e811c8ce
RD
10585
10586def Window_FromHWND(*args, **kwargs):
0085ce49
RD
10587 """Window_FromHWND(Window parent, unsigned long _hWnd) -> Window"""
10588 return _core_.Window_FromHWND(*args, **kwargs)
b6b0383e 10589
0085ce49
RD
10590def GetTopLevelWindows(*args):
10591 """
b6b0383e
RD
10592 GetTopLevelWindows() -> PyObject
10593
10594 Returns a list of the the application's top-level windows, (frames,
10595 dialogs, etc.) NOTE: Currently this is a copy of the list maintained
10596 by wxWidgets, and so it is only valid as long as no top-level windows
10597 are closed or new top-level windows are created.
10598
10599 """
0085ce49 10600 return _core_.GetTopLevelWindows(*args)
e811c8ce
RD
10601#---------------------------------------------------------------------------
10602
10603class Validator(EvtHandler):
093d3ff1 10604 """Proxy of C++ Validator class"""
0085ce49
RD
10605 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10606 __repr__ = _swig_repr
10607 def __init__(self, *args, **kwargs):
a95a7133 10608 """__init__(self) -> Validator"""
0085ce49 10609 _core_.Validator_swiginit(self,_core_.new_Validator(*args, **kwargs))
d14a1e28 10610 self._setOORInfo(self)
e811c8ce
RD
10611
10612 def Clone(*args, **kwargs):
a95a7133 10613 """Clone(self) -> Validator"""
54f9ee45 10614 return _core_.Validator_Clone(*args, **kwargs)
e811c8ce
RD
10615
10616 def Validate(*args, **kwargs):
a95a7133 10617 """Validate(self, Window parent) -> bool"""
54f9ee45 10618 return _core_.Validator_Validate(*args, **kwargs)
e811c8ce
RD
10619
10620 def TransferToWindow(*args, **kwargs):
a95a7133 10621 """TransferToWindow(self) -> bool"""
54f9ee45 10622 return _core_.Validator_TransferToWindow(*args, **kwargs)
e811c8ce
RD
10623
10624 def TransferFromWindow(*args, **kwargs):
a95a7133 10625 """TransferFromWindow(self) -> bool"""
54f9ee45 10626 return _core_.Validator_TransferFromWindow(*args, **kwargs)
e811c8ce
RD
10627
10628 def GetWindow(*args, **kwargs):
a95a7133 10629 """GetWindow(self) -> Window"""
54f9ee45 10630 return _core_.Validator_GetWindow(*args, **kwargs)
e811c8ce
RD
10631
10632 def SetWindow(*args, **kwargs):
a95a7133 10633 """SetWindow(self, Window window)"""
54f9ee45 10634 return _core_.Validator_SetWindow(*args, **kwargs)
e811c8ce
RD
10635
10636 def IsSilent(*args, **kwargs):
66c033b4 10637 """IsSilent() -> bool"""
54f9ee45 10638 return _core_.Validator_IsSilent(*args, **kwargs)
e811c8ce
RD
10639
10640 IsSilent = staticmethod(IsSilent)
10641 def SetBellOnError(*args, **kwargs):
66c033b4 10642 """SetBellOnError(int doIt=True)"""
54f9ee45 10643 return _core_.Validator_SetBellOnError(*args, **kwargs)
e811c8ce
RD
10644
10645 SetBellOnError = staticmethod(SetBellOnError)
dba7934c 10646 Window = property(GetWindow,SetWindow,doc="See `GetWindow` and `SetWindow`")
2131d850 10647_core_.Validator_swigregister(Validator)
e811c8ce 10648
0085ce49
RD
10649def Validator_IsSilent(*args):
10650 """Validator_IsSilent() -> bool"""
10651 return _core_.Validator_IsSilent(*args)
e811c8ce
RD
10652
10653def Validator_SetBellOnError(*args, **kwargs):
0085ce49
RD
10654 """Validator_SetBellOnError(int doIt=True)"""
10655 return _core_.Validator_SetBellOnError(*args, **kwargs)
e811c8ce
RD
10656
10657class PyValidator(Validator):
093d3ff1 10658 """Proxy of C++ PyValidator class"""
0085ce49
RD
10659 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10660 __repr__ = _swig_repr
10661 def __init__(self, *args, **kwargs):
a95a7133 10662 """__init__(self) -> PyValidator"""
0085ce49 10663 _core_.PyValidator_swiginit(self,_core_.new_PyValidator(*args, **kwargs))
c25f90f6 10664 self._setOORInfo(self);PyValidator._setCallbackInfo(self, self, PyValidator)
e811c8ce
RD
10665
10666 def _setCallbackInfo(*args, **kwargs):
c25f90f6 10667 """_setCallbackInfo(self, PyObject self, PyObject _class, int incref=1)"""
54f9ee45 10668 return _core_.PyValidator__setCallbackInfo(*args, **kwargs)
e811c8ce 10669
2131d850 10670_core_.PyValidator_swigregister(PyValidator)
e811c8ce
RD
10671
10672#---------------------------------------------------------------------------
10673
10674class Menu(EvtHandler):
093d3ff1 10675 """Proxy of C++ Menu class"""
0085ce49
RD
10676 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10677 __repr__ = _swig_repr
10678 def __init__(self, *args, **kwargs):
a95a7133 10679 """__init__(self, String title=EmptyString, long style=0) -> Menu"""
0085ce49 10680 _core_.Menu_swiginit(self,_core_.new_Menu(*args, **kwargs))
e811c8ce
RD
10681 self._setOORInfo(self)
10682
10683 def Append(*args, **kwargs):
97ab0f6a
RD
10684 """
10685 Append(self, int id, String text=EmptyString, String help=EmptyString,
10686 int kind=ITEM_NORMAL) -> MenuItem
10687 """
54f9ee45 10688 return _core_.Menu_Append(*args, **kwargs)
e811c8ce
RD
10689
10690 def AppendSeparator(*args, **kwargs):
a95a7133 10691 """AppendSeparator(self) -> MenuItem"""
54f9ee45 10692 return _core_.Menu_AppendSeparator(*args, **kwargs)
e811c8ce
RD
10693
10694 def AppendCheckItem(*args, **kwargs):
a95a7133 10695 """AppendCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
54f9ee45 10696 return _core_.Menu_AppendCheckItem(*args, **kwargs)
e811c8ce
RD
10697
10698 def AppendRadioItem(*args, **kwargs):
a95a7133 10699 """AppendRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
54f9ee45 10700 return _core_.Menu_AppendRadioItem(*args, **kwargs)
e811c8ce
RD
10701
10702 def AppendMenu(*args, **kwargs):
a95a7133 10703 """AppendMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
54f9ee45 10704 return _core_.Menu_AppendMenu(*args, **kwargs)
e811c8ce 10705
50efceee
RD
10706 def AppendSubMenu(*args, **kwargs):
10707 """AppendSubMenu(self, Menu submenu, String text, String help=EmptyString) -> MenuItem"""
10708 return _core_.Menu_AppendSubMenu(*args, **kwargs)
10709
e811c8ce 10710 def AppendItem(*args, **kwargs):
a95a7133 10711 """AppendItem(self, MenuItem item) -> MenuItem"""
54f9ee45 10712 return _core_.Menu_AppendItem(*args, **kwargs)
e811c8ce 10713
e811c8ce 10714 def InsertItem(*args, **kwargs):
a95a7133 10715 """InsertItem(self, size_t pos, MenuItem item) -> MenuItem"""
54f9ee45 10716 return _core_.Menu_InsertItem(*args, **kwargs)
e811c8ce 10717
0085ce49
RD
10718 def PrependItem(*args, **kwargs):
10719 """PrependItem(self, MenuItem item) -> MenuItem"""
10720 return _core_.Menu_PrependItem(*args, **kwargs)
10721
10722 def Break(*args, **kwargs):
10723 """Break(self)"""
10724 return _core_.Menu_Break(*args, **kwargs)
10725
e811c8ce 10726 def Insert(*args, **kwargs):
0df68c9f 10727 """
97ab0f6a 10728 Insert(self, size_t pos, int id, String text=EmptyString, String help=EmptyString,
a41e16b6 10729 int kind=ITEM_NORMAL) -> MenuItem
0df68c9f 10730 """
54f9ee45 10731 return _core_.Menu_Insert(*args, **kwargs)
e811c8ce
RD
10732
10733 def InsertSeparator(*args, **kwargs):
a95a7133 10734 """InsertSeparator(self, size_t pos) -> MenuItem"""
54f9ee45 10735 return _core_.Menu_InsertSeparator(*args, **kwargs)
e811c8ce
RD
10736
10737 def InsertCheckItem(*args, **kwargs):
a95a7133 10738 """InsertCheckItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
54f9ee45 10739 return _core_.Menu_InsertCheckItem(*args, **kwargs)
e811c8ce
RD
10740
10741 def InsertRadioItem(*args, **kwargs):
a95a7133 10742 """InsertRadioItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
54f9ee45 10743 return _core_.Menu_InsertRadioItem(*args, **kwargs)
e811c8ce
RD
10744
10745 def InsertMenu(*args, **kwargs):
a95a7133 10746 """InsertMenu(self, size_t pos, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
54f9ee45 10747 return _core_.Menu_InsertMenu(*args, **kwargs)
e811c8ce 10748
e811c8ce 10749 def Prepend(*args, **kwargs):
97ab0f6a
RD
10750 """
10751 Prepend(self, int id, String text=EmptyString, String help=EmptyString,
10752 int kind=ITEM_NORMAL) -> MenuItem
10753 """
54f9ee45 10754 return _core_.Menu_Prepend(*args, **kwargs)
e811c8ce
RD
10755
10756 def PrependSeparator(*args, **kwargs):
a95a7133 10757 """PrependSeparator(self) -> MenuItem"""
54f9ee45 10758 return _core_.Menu_PrependSeparator(*args, **kwargs)
e811c8ce
RD
10759
10760 def PrependCheckItem(*args, **kwargs):
a95a7133 10761 """PrependCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
54f9ee45 10762 return _core_.Menu_PrependCheckItem(*args, **kwargs)
e811c8ce
RD
10763
10764 def PrependRadioItem(*args, **kwargs):
a95a7133 10765 """PrependRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
54f9ee45 10766 return _core_.Menu_PrependRadioItem(*args, **kwargs)
e811c8ce
RD
10767
10768 def PrependMenu(*args, **kwargs):
a95a7133 10769 """PrependMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
54f9ee45 10770 return _core_.Menu_PrependMenu(*args, **kwargs)
e811c8ce
RD
10771
10772 def Remove(*args, **kwargs):
a95a7133 10773 """Remove(self, int id) -> MenuItem"""
54f9ee45 10774 return _core_.Menu_Remove(*args, **kwargs)
e811c8ce 10775
59ccbf7f 10776 def RemoveItem(self, item):
a95a7133 10777 """RemoveItem(self, MenuItem item) -> MenuItem"""
59ccbf7f
RD
10778 #// The return object is always the parameter, so return that
10779 #// proxy instead of the new one
10780 val = _core_.Menu_RemoveItem(self, item)
10781 item.this.own(val.this.own())
10782 val.this.disown()
10783 return item
10784
e811c8ce
RD
10785
10786 def Delete(*args, **kwargs):
a95a7133 10787 """Delete(self, int id) -> bool"""
54f9ee45 10788 return _core_.Menu_Delete(*args, **kwargs)
e811c8ce
RD
10789
10790 def DeleteItem(*args, **kwargs):
a95a7133 10791 """DeleteItem(self, MenuItem item) -> bool"""
54f9ee45 10792 return _core_.Menu_DeleteItem(*args, **kwargs)
e811c8ce
RD
10793
10794 def Destroy(*args, **kwargs):
0df68c9f 10795 """
a95a7133 10796 Destroy(self)
e811c8ce 10797
0df68c9f
RD
10798 Deletes the C++ object this Python object is a proxy for.
10799 """
b39fe951
RD
10800 args[0].this.own(False)
10801 return _core_.Menu_Destroy(*args, **kwargs)
e811c8ce
RD
10802
10803 def DestroyId(*args, **kwargs):
b39fe951
RD
10804 """DestroyId(self, int id) -> bool"""
10805 return _core_.Menu_DestroyId(*args, **kwargs)
e811c8ce
RD
10806
10807 def DestroyItem(*args, **kwargs):
b39fe951
RD
10808 """DestroyItem(self, MenuItem item) -> bool"""
10809 return _core_.Menu_DestroyItem(*args, **kwargs)
e811c8ce
RD
10810
10811 def GetMenuItemCount(*args, **kwargs):
a95a7133 10812 """GetMenuItemCount(self) -> size_t"""
54f9ee45 10813 return _core_.Menu_GetMenuItemCount(*args, **kwargs)
e811c8ce
RD
10814
10815 def GetMenuItems(*args, **kwargs):
a95a7133 10816 """GetMenuItems(self) -> PyObject"""
54f9ee45 10817 return _core_.Menu_GetMenuItems(*args, **kwargs)
e811c8ce
RD
10818
10819 def FindItem(*args, **kwargs):
a95a7133 10820 """FindItem(self, String item) -> int"""
54f9ee45 10821 return _core_.Menu_FindItem(*args, **kwargs)
e811c8ce
RD
10822
10823 def FindItemById(*args, **kwargs):
a95a7133 10824 """FindItemById(self, int id) -> MenuItem"""
54f9ee45 10825 return _core_.Menu_FindItemById(*args, **kwargs)
e811c8ce
RD
10826
10827 def FindItemByPosition(*args, **kwargs):
a95a7133 10828 """FindItemByPosition(self, size_t position) -> MenuItem"""
54f9ee45 10829 return _core_.Menu_FindItemByPosition(*args, **kwargs)
e811c8ce
RD
10830
10831 def Enable(*args, **kwargs):
a95a7133 10832 """Enable(self, int id, bool enable)"""
54f9ee45 10833 return _core_.Menu_Enable(*args, **kwargs)
e811c8ce
RD
10834
10835 def IsEnabled(*args, **kwargs):
a95a7133 10836 """IsEnabled(self, int id) -> bool"""
54f9ee45 10837 return _core_.Menu_IsEnabled(*args, **kwargs)
e811c8ce
RD
10838
10839 def Check(*args, **kwargs):
a95a7133 10840 """Check(self, int id, bool check)"""
54f9ee45 10841 return _core_.Menu_Check(*args, **kwargs)
e811c8ce
RD
10842
10843 def IsChecked(*args, **kwargs):
a95a7133 10844 """IsChecked(self, int id) -> bool"""
54f9ee45 10845 return _core_.Menu_IsChecked(*args, **kwargs)
e811c8ce
RD
10846
10847 def SetLabel(*args, **kwargs):
a95a7133 10848 """SetLabel(self, int id, String label)"""
54f9ee45 10849 return _core_.Menu_SetLabel(*args, **kwargs)
e811c8ce
RD
10850
10851 def GetLabel(*args, **kwargs):
a95a7133 10852 """GetLabel(self, int id) -> String"""
54f9ee45 10853 return _core_.Menu_GetLabel(*args, **kwargs)
e811c8ce
RD
10854
10855 def SetHelpString(*args, **kwargs):
a95a7133 10856 """SetHelpString(self, int id, String helpString)"""
54f9ee45 10857 return _core_.Menu_SetHelpString(*args, **kwargs)
e811c8ce
RD
10858
10859 def GetHelpString(*args, **kwargs):
a95a7133 10860 """GetHelpString(self, int id) -> String"""
54f9ee45 10861 return _core_.Menu_GetHelpString(*args, **kwargs)
e811c8ce
RD
10862
10863 def SetTitle(*args, **kwargs):
a95a7133 10864 """SetTitle(self, String title)"""
54f9ee45 10865 return _core_.Menu_SetTitle(*args, **kwargs)
e811c8ce
RD
10866
10867 def GetTitle(*args, **kwargs):
a95a7133 10868 """GetTitle(self) -> String"""
54f9ee45 10869 return _core_.Menu_GetTitle(*args, **kwargs)
e811c8ce
RD
10870
10871 def SetEventHandler(*args, **kwargs):
a95a7133 10872 """SetEventHandler(self, EvtHandler handler)"""
54f9ee45 10873 return _core_.Menu_SetEventHandler(*args, **kwargs)
e811c8ce
RD
10874
10875 def GetEventHandler(*args, **kwargs):
a95a7133 10876 """GetEventHandler(self) -> EvtHandler"""
54f9ee45 10877 return _core_.Menu_GetEventHandler(*args, **kwargs)
e811c8ce
RD
10878
10879 def SetInvokingWindow(*args, **kwargs):
a95a7133 10880 """SetInvokingWindow(self, Window win)"""
54f9ee45 10881 return _core_.Menu_SetInvokingWindow(*args, **kwargs)
e811c8ce
RD
10882
10883 def GetInvokingWindow(*args, **kwargs):
a95a7133 10884 """GetInvokingWindow(self) -> Window"""
54f9ee45 10885 return _core_.Menu_GetInvokingWindow(*args, **kwargs)
e811c8ce
RD
10886
10887 def GetStyle(*args, **kwargs):
a95a7133 10888 """GetStyle(self) -> long"""
54f9ee45 10889 return _core_.Menu_GetStyle(*args, **kwargs)
e811c8ce
RD
10890
10891 def UpdateUI(*args, **kwargs):
a95a7133 10892 """UpdateUI(self, EvtHandler source=None)"""
54f9ee45 10893 return _core_.Menu_UpdateUI(*args, **kwargs)
e811c8ce
RD
10894
10895 def GetMenuBar(*args, **kwargs):
a95a7133 10896 """GetMenuBar(self) -> MenuBar"""
54f9ee45 10897 return _core_.Menu_GetMenuBar(*args, **kwargs)
e811c8ce
RD
10898
10899 def Attach(*args, **kwargs):
a95a7133 10900 """Attach(self, wxMenuBarBase menubar)"""
54f9ee45 10901 return _core_.Menu_Attach(*args, **kwargs)
e811c8ce
RD
10902
10903 def Detach(*args, **kwargs):
a95a7133 10904 """Detach(self)"""
54f9ee45 10905 return _core_.Menu_Detach(*args, **kwargs)
e811c8ce
RD
10906
10907 def IsAttached(*args, **kwargs):
a95a7133 10908 """IsAttached(self) -> bool"""
54f9ee45 10909 return _core_.Menu_IsAttached(*args, **kwargs)
e811c8ce
RD
10910
10911 def SetParent(*args, **kwargs):
a95a7133 10912 """SetParent(self, Menu parent)"""
54f9ee45 10913 return _core_.Menu_SetParent(*args, **kwargs)
e811c8ce
RD
10914
10915 def GetParent(*args, **kwargs):
a95a7133 10916 """GetParent(self) -> Menu"""
54f9ee45 10917 return _core_.Menu_GetParent(*args, **kwargs)
e811c8ce 10918
57332a5a
RD
10919 EventHandler = property(GetEventHandler,SetEventHandler,doc="See `GetEventHandler` and `SetEventHandler`")
10920 HelpString = property(GetHelpString,SetHelpString,doc="See `GetHelpString` and `SetHelpString`")
10921 InvokingWindow = property(GetInvokingWindow,SetInvokingWindow,doc="See `GetInvokingWindow` and `SetInvokingWindow`")
10922 MenuBar = property(GetMenuBar,doc="See `GetMenuBar`")
10923 MenuItemCount = property(GetMenuItemCount,doc="See `GetMenuItemCount`")
10924 MenuItems = property(GetMenuItems,doc="See `GetMenuItems`")
10925 Parent = property(GetParent,SetParent,doc="See `GetParent` and `SetParent`")
10926 Style = property(GetStyle,doc="See `GetStyle`")
10927 Title = property(GetTitle,SetTitle,doc="See `GetTitle` and `SetTitle`")
2131d850 10928_core_.Menu_swigregister(Menu)
d14a1e28
RD
10929DefaultValidator = cvar.DefaultValidator
10930
10931#---------------------------------------------------------------------------
10932
10933class MenuBar(Window):
093d3ff1 10934 """Proxy of C++ MenuBar class"""
0085ce49
RD
10935 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10936 __repr__ = _swig_repr
10937 def __init__(self, *args, **kwargs):
a95a7133 10938 """__init__(self, long style=0) -> MenuBar"""
0085ce49 10939 _core_.MenuBar_swiginit(self,_core_.new_MenuBar(*args, **kwargs))
d14a1e28 10940 self._setOORInfo(self)
e811c8ce
RD
10941
10942 def Append(*args, **kwargs):
a95a7133 10943 """Append(self, Menu menu, String title) -> bool"""
54f9ee45 10944 return _core_.MenuBar_Append(*args, **kwargs)
e811c8ce
RD
10945
10946 def Insert(*args, **kwargs):
a95a7133 10947 """Insert(self, size_t pos, Menu menu, String title) -> bool"""
54f9ee45 10948 return _core_.MenuBar_Insert(*args, **kwargs)
e811c8ce
RD
10949
10950 def GetMenuCount(*args, **kwargs):
a95a7133 10951 """GetMenuCount(self) -> size_t"""
54f9ee45 10952 return _core_.MenuBar_GetMenuCount(*args, **kwargs)
e811c8ce
RD
10953
10954 def GetMenu(*args, **kwargs):
a95a7133 10955 """GetMenu(self, size_t pos) -> Menu"""
54f9ee45 10956 return _core_.MenuBar_GetMenu(*args, **kwargs)
e811c8ce
RD
10957
10958 def Replace(*args, **kwargs):
a95a7133 10959 """Replace(self, size_t pos, Menu menu, String title) -> Menu"""
54f9ee45 10960 return _core_.MenuBar_Replace(*args, **kwargs)
e811c8ce
RD
10961
10962 def Remove(*args, **kwargs):
a95a7133 10963 """Remove(self, size_t pos) -> Menu"""
54f9ee45 10964 return _core_.MenuBar_Remove(*args, **kwargs)
e811c8ce
RD
10965
10966 def EnableTop(*args, **kwargs):
a95a7133 10967 """EnableTop(self, size_t pos, bool enable)"""
54f9ee45 10968 return _core_.MenuBar_EnableTop(*args, **kwargs)
e811c8ce
RD
10969
10970 def IsEnabledTop(*args, **kwargs):
a95a7133 10971 """IsEnabledTop(self, size_t pos) -> bool"""
54f9ee45 10972 return _core_.MenuBar_IsEnabledTop(*args, **kwargs)
e811c8ce
RD
10973
10974 def SetLabelTop(*args, **kwargs):
a95a7133 10975 """SetLabelTop(self, size_t pos, String label)"""
54f9ee45 10976 return _core_.MenuBar_SetLabelTop(*args, **kwargs)
e811c8ce
RD
10977
10978 def GetLabelTop(*args, **kwargs):
a95a7133 10979 """GetLabelTop(self, size_t pos) -> String"""
54f9ee45 10980 return _core_.MenuBar_GetLabelTop(*args, **kwargs)
e811c8ce
RD
10981
10982 def FindMenuItem(*args, **kwargs):
a95a7133 10983 """FindMenuItem(self, String menu, String item) -> int"""
54f9ee45 10984 return _core_.MenuBar_FindMenuItem(*args, **kwargs)
e811c8ce
RD
10985
10986 def FindItemById(*args, **kwargs):
a95a7133 10987 """FindItemById(self, int id) -> MenuItem"""
54f9ee45 10988 return _core_.MenuBar_FindItemById(*args, **kwargs)
e811c8ce
RD
10989
10990 def FindMenu(*args, **kwargs):
a95a7133 10991 """FindMenu(self, String title) -> int"""
54f9ee45 10992 return _core_.MenuBar_FindMenu(*args, **kwargs)
e811c8ce
RD
10993
10994 def Enable(*args, **kwargs):
a95a7133 10995 """Enable(self, int id, bool enable)"""
54f9ee45 10996 return _core_.MenuBar_Enable(*args, **kwargs)
e811c8ce
RD
10997
10998 def Check(*args, **kwargs):
a95a7133 10999 """Check(self, int id, bool check)"""
54f9ee45 11000 return _core_.MenuBar_Check(*args, **kwargs)
e811c8ce
RD
11001
11002 def IsChecked(*args, **kwargs):
a95a7133 11003 """IsChecked(self, int id) -> bool"""
54f9ee45 11004 return _core_.MenuBar_IsChecked(*args, **kwargs)
e811c8ce
RD
11005
11006 def IsEnabled(*args, **kwargs):
a95a7133 11007 """IsEnabled(self, int id) -> bool"""
54f9ee45 11008 return _core_.MenuBar_IsEnabled(*args, **kwargs)
e811c8ce
RD
11009
11010 def SetLabel(*args, **kwargs):
a95a7133 11011 """SetLabel(self, int id, String label)"""
54f9ee45 11012 return _core_.MenuBar_SetLabel(*args, **kwargs)
e811c8ce
RD
11013
11014 def GetLabel(*args, **kwargs):
a95a7133 11015 """GetLabel(self, int id) -> String"""
54f9ee45 11016 return _core_.MenuBar_GetLabel(*args, **kwargs)
e811c8ce
RD
11017
11018 def SetHelpString(*args, **kwargs):
a95a7133 11019 """SetHelpString(self, int id, String helpString)"""
54f9ee45 11020 return _core_.MenuBar_SetHelpString(*args, **kwargs)
e811c8ce
RD
11021
11022 def GetHelpString(*args, **kwargs):
a95a7133 11023 """GetHelpString(self, int id) -> String"""
54f9ee45 11024 return _core_.MenuBar_GetHelpString(*args, **kwargs)
e811c8ce
RD
11025
11026 def GetFrame(*args, **kwargs):
a95a7133 11027 """GetFrame(self) -> wxFrame"""
54f9ee45 11028 return _core_.MenuBar_GetFrame(*args, **kwargs)
e811c8ce
RD
11029
11030 def IsAttached(*args, **kwargs):
a95a7133 11031 """IsAttached(self) -> bool"""
54f9ee45 11032 return _core_.MenuBar_IsAttached(*args, **kwargs)
e811c8ce
RD
11033
11034 def Attach(*args, **kwargs):
a95a7133 11035 """Attach(self, wxFrame frame)"""
54f9ee45 11036 return _core_.MenuBar_Attach(*args, **kwargs)
e811c8ce
RD
11037
11038 def Detach(*args, **kwargs):
a95a7133 11039 """Detach(self)"""
54f9ee45 11040 return _core_.MenuBar_Detach(*args, **kwargs)
e811c8ce 11041
587d0f36
RD
11042 def UpdateMenus(*args, **kwargs):
11043 """UpdateMenus(self)"""
11044 return _core_.MenuBar_UpdateMenus(*args, **kwargs)
11045
4f433fef
RD
11046 def SetAutoWindowMenu(*args, **kwargs):
11047 """SetAutoWindowMenu(bool enable)"""
11048 return _core_.MenuBar_SetAutoWindowMenu(*args, **kwargs)
11049
11050 SetAutoWindowMenu = staticmethod(SetAutoWindowMenu)
11051 def GetAutoWindowMenu(*args, **kwargs):
11052 """GetAutoWindowMenu() -> bool"""
11053 return _core_.MenuBar_GetAutoWindowMenu(*args, **kwargs)
11054
11055 GetAutoWindowMenu = staticmethod(GetAutoWindowMenu)
97ab0f6a
RD
11056 def GetMenus(self):
11057 """Return a list of (menu, label) items for the menus in the MenuBar. """
11058 return [(self.GetMenu(i), self.GetLabelTop(i))
11059 for i in range(self.GetMenuCount())]
11060
11061 def SetMenus(self, items):
11062 """Clear and add new menus to the MenuBar from a list of (menu, label) items. """
11063 for i in range(self.GetMenuCount()-1, -1, -1):
11064 self.Remove(i)
11065 for m, l in items:
11066 self.Append(m, l)
11067
57332a5a
RD
11068 Frame = property(GetFrame,doc="See `GetFrame`")
11069 Menu = property(GetMenu,doc="See `GetMenu`")
11070 MenuCount = property(GetMenuCount,doc="See `GetMenuCount`")
11071 Menus = property(GetMenus,SetMenus,doc="See `GetMenus` and `SetMenus`")
2131d850 11072_core_.MenuBar_swigregister(MenuBar)
d14a1e28 11073
4f433fef 11074def MenuBar_SetAutoWindowMenu(*args, **kwargs):
0085ce49
RD
11075 """MenuBar_SetAutoWindowMenu(bool enable)"""
11076 return _core_.MenuBar_SetAutoWindowMenu(*args, **kwargs)
4f433fef 11077
0085ce49
RD
11078def MenuBar_GetAutoWindowMenu(*args):
11079 """MenuBar_GetAutoWindowMenu() -> bool"""
11080 return _core_.MenuBar_GetAutoWindowMenu(*args)
4f433fef 11081
d14a1e28
RD
11082#---------------------------------------------------------------------------
11083
11084class MenuItem(Object):
093d3ff1 11085 """Proxy of C++ MenuItem class"""
0085ce49
RD
11086 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11087 __repr__ = _swig_repr
11088 def __init__(self, *args, **kwargs):
0df68c9f 11089 """
89d1e2ee 11090 __init__(self, Menu parentMenu=None, int id=ID_SEPARATOR, String text=EmptyString,
196addbf
RD
11091 String help=EmptyString, int kind=ITEM_NORMAL,
11092 Menu subMenu=None) -> MenuItem
0df68c9f 11093 """
0085ce49
RD
11094 _core_.MenuItem_swiginit(self,_core_.new_MenuItem(*args, **kwargs))
11095 __swig_destroy__ = _core_.delete_MenuItem
11096 __del__ = lambda self : None;
89d1e2ee 11097 def Destroy(self): pass
e811c8ce 11098 def GetMenu(*args, **kwargs):
a95a7133 11099 """GetMenu(self) -> Menu"""
54f9ee45 11100 return _core_.MenuItem_GetMenu(*args, **kwargs)
e811c8ce
RD
11101
11102 def SetMenu(*args, **kwargs):
a95a7133 11103 """SetMenu(self, Menu menu)"""
54f9ee45 11104 return _core_.MenuItem_SetMenu(*args, **kwargs)
e811c8ce
RD
11105
11106 def SetId(*args, **kwargs):
a95a7133 11107 """SetId(self, int id)"""
54f9ee45 11108 return _core_.MenuItem_SetId(*args, **kwargs)
e811c8ce
RD
11109
11110 def GetId(*args, **kwargs):
a95a7133 11111 """GetId(self) -> int"""
54f9ee45 11112 return _core_.MenuItem_GetId(*args, **kwargs)
e811c8ce
RD
11113
11114 def IsSeparator(*args, **kwargs):
a95a7133 11115 """IsSeparator(self) -> bool"""
54f9ee45 11116 return _core_.MenuItem_IsSeparator(*args, **kwargs)
e811c8ce
RD
11117
11118 def SetText(*args, **kwargs):
a95a7133 11119 """SetText(self, String str)"""
54f9ee45 11120 return _core_.MenuItem_SetText(*args, **kwargs)
e811c8ce
RD
11121
11122 def GetLabel(*args, **kwargs):
a95a7133 11123 """GetLabel(self) -> String"""
54f9ee45 11124 return _core_.MenuItem_GetLabel(*args, **kwargs)
e811c8ce
RD
11125
11126 def GetText(*args, **kwargs):
a95a7133 11127 """GetText(self) -> String"""
54f9ee45 11128 return _core_.MenuItem_GetText(*args, **kwargs)
e811c8ce
RD
11129
11130 def GetLabelFromText(*args, **kwargs):
66c033b4 11131 """GetLabelFromText(String text) -> String"""
54f9ee45 11132 return _core_.MenuItem_GetLabelFromText(*args, **kwargs)
e811c8ce
RD
11133
11134 GetLabelFromText = staticmethod(GetLabelFromText)
11135 def GetKind(*args, **kwargs):
a95a7133 11136 """GetKind(self) -> int"""
54f9ee45 11137 return _core_.MenuItem_GetKind(*args, **kwargs)
e811c8ce 11138
a95a7133
RD
11139 def SetKind(*args, **kwargs):
11140 """SetKind(self, int kind)"""
54f9ee45 11141 return _core_.MenuItem_SetKind(*args, **kwargs)
a95a7133 11142
e811c8ce 11143 def SetCheckable(*args, **kwargs):
a95a7133 11144 """SetCheckable(self, bool checkable)"""
54f9ee45 11145 return _core_.MenuItem_SetCheckable(*args, **kwargs)
e811c8ce
RD
11146
11147 def IsCheckable(*args, **kwargs):
a95a7133 11148 """IsCheckable(self) -> bool"""
54f9ee45 11149 return _core_.MenuItem_IsCheckable(*args, **kwargs)
e811c8ce
RD
11150
11151 def IsSubMenu(*args, **kwargs):
a95a7133 11152 """IsSubMenu(self) -> bool"""
54f9ee45 11153 return _core_.MenuItem_IsSubMenu(*args, **kwargs)
e811c8ce
RD
11154
11155 def SetSubMenu(*args, **kwargs):
a95a7133 11156 """SetSubMenu(self, Menu menu)"""
54f9ee45 11157 return _core_.MenuItem_SetSubMenu(*args, **kwargs)
e811c8ce
RD
11158
11159 def GetSubMenu(*args, **kwargs):
a95a7133 11160 """GetSubMenu(self) -> Menu"""
54f9ee45 11161 return _core_.MenuItem_GetSubMenu(*args, **kwargs)
e811c8ce
RD
11162
11163 def Enable(*args, **kwargs):
a95a7133 11164 """Enable(self, bool enable=True)"""
54f9ee45 11165 return _core_.MenuItem_Enable(*args, **kwargs)
e811c8ce
RD
11166
11167 def IsEnabled(*args, **kwargs):
a95a7133 11168 """IsEnabled(self) -> bool"""
54f9ee45 11169 return _core_.MenuItem_IsEnabled(*args, **kwargs)
e811c8ce
RD
11170
11171 def Check(*args, **kwargs):
a95a7133 11172 """Check(self, bool check=True)"""
54f9ee45 11173 return _core_.MenuItem_Check(*args, **kwargs)
e811c8ce
RD
11174
11175 def IsChecked(*args, **kwargs):
a95a7133 11176 """IsChecked(self) -> bool"""
54f9ee45 11177 return _core_.MenuItem_IsChecked(*args, **kwargs)
e811c8ce
RD
11178
11179 def Toggle(*args, **kwargs):
a95a7133 11180 """Toggle(self)"""
54f9ee45 11181 return _core_.MenuItem_Toggle(*args, **kwargs)
e811c8ce
RD
11182
11183 def SetHelp(*args, **kwargs):
a95a7133 11184 """SetHelp(self, String str)"""
54f9ee45 11185 return _core_.MenuItem_SetHelp(*args, **kwargs)
e811c8ce
RD
11186
11187 def GetHelp(*args, **kwargs):
a95a7133 11188 """GetHelp(self) -> String"""
54f9ee45 11189 return _core_.MenuItem_GetHelp(*args, **kwargs)
e811c8ce
RD
11190
11191 def GetAccel(*args, **kwargs):
a95a7133 11192 """GetAccel(self) -> AcceleratorEntry"""
54f9ee45 11193 return _core_.MenuItem_GetAccel(*args, **kwargs)
e811c8ce
RD
11194
11195 def SetAccel(*args, **kwargs):
a95a7133 11196 """SetAccel(self, AcceleratorEntry accel)"""
54f9ee45 11197 return _core_.MenuItem_SetAccel(*args, **kwargs)
e811c8ce 11198
091f5bed
RD
11199 def SetBitmap(*args, **kwargs):
11200 """SetBitmap(self, Bitmap bitmap)"""
11201 return _core_.MenuItem_SetBitmap(*args, **kwargs)
11202
11203 def GetBitmap(*args, **kwargs):
11204 """GetBitmap(self) -> Bitmap"""
11205 return _core_.MenuItem_GetBitmap(*args, **kwargs)
11206
c1280d1e
RD
11207 def SetFont(*args, **kwargs):
11208 """SetFont(self, Font font)"""
11209 return _core_.MenuItem_SetFont(*args, **kwargs)
11210
11211 def GetFont(*args, **kwargs):
11212 """GetFont(self) -> Font"""
11213 return _core_.MenuItem_GetFont(*args, **kwargs)
11214
11215 def SetTextColour(*args, **kwargs):
11216 """SetTextColour(self, Colour colText)"""
11217 return _core_.MenuItem_SetTextColour(*args, **kwargs)
11218
11219 def GetTextColour(*args, **kwargs):
11220 """GetTextColour(self) -> Colour"""
11221 return _core_.MenuItem_GetTextColour(*args, **kwargs)
11222
11223 def SetBackgroundColour(*args, **kwargs):
11224 """SetBackgroundColour(self, Colour colBack)"""
11225 return _core_.MenuItem_SetBackgroundColour(*args, **kwargs)
11226
11227 def GetBackgroundColour(*args, **kwargs):
11228 """GetBackgroundColour(self) -> Colour"""
11229 return _core_.MenuItem_GetBackgroundColour(*args, **kwargs)
11230
11231 def SetBitmaps(*args, **kwargs):
11232 """SetBitmaps(self, Bitmap bmpChecked, Bitmap bmpUnchecked=wxNullBitmap)"""
11233 return _core_.MenuItem_SetBitmaps(*args, **kwargs)
11234
11235 def SetDisabledBitmap(*args, **kwargs):
11236 """SetDisabledBitmap(self, Bitmap bmpDisabled)"""
11237 return _core_.MenuItem_SetDisabledBitmap(*args, **kwargs)
11238
11239 def GetDisabledBitmap(*args, **kwargs):
11240 """GetDisabledBitmap(self) -> Bitmap"""
11241 return _core_.MenuItem_GetDisabledBitmap(*args, **kwargs)
11242
11243 def SetMarginWidth(*args, **kwargs):
11244 """SetMarginWidth(self, int nWidth)"""
11245 return _core_.MenuItem_SetMarginWidth(*args, **kwargs)
11246
11247 def GetMarginWidth(*args, **kwargs):
11248 """GetMarginWidth(self) -> int"""
11249 return _core_.MenuItem_GetMarginWidth(*args, **kwargs)
11250
e811c8ce 11251 def GetDefaultMarginWidth(*args, **kwargs):
66c033b4 11252 """GetDefaultMarginWidth() -> int"""
54f9ee45 11253 return _core_.MenuItem_GetDefaultMarginWidth(*args, **kwargs)
e811c8ce
RD
11254
11255 GetDefaultMarginWidth = staticmethod(GetDefaultMarginWidth)
c1280d1e
RD
11256 def IsOwnerDrawn(*args, **kwargs):
11257 """IsOwnerDrawn(self) -> bool"""
11258 return _core_.MenuItem_IsOwnerDrawn(*args, **kwargs)
11259
11260 def SetOwnerDrawn(*args, **kwargs):
11261 """SetOwnerDrawn(self, bool ownerDrawn=True)"""
11262 return _core_.MenuItem_SetOwnerDrawn(*args, **kwargs)
11263
11264 def ResetOwnerDrawn(*args, **kwargs):
11265 """ResetOwnerDrawn(self)"""
11266 return _core_.MenuItem_ResetOwnerDrawn(*args, **kwargs)
11267
57332a5a
RD
11268 Accel = property(GetAccel,SetAccel,doc="See `GetAccel` and `SetAccel`")
11269 BackgroundColour = property(GetBackgroundColour,SetBackgroundColour,doc="See `GetBackgroundColour` and `SetBackgroundColour`")
11270 Bitmap = property(GetBitmap,SetBitmap,doc="See `GetBitmap` and `SetBitmap`")
11271 DisabledBitmap = property(GetDisabledBitmap,SetDisabledBitmap,doc="See `GetDisabledBitmap` and `SetDisabledBitmap`")
11272 Font = property(GetFont,SetFont,doc="See `GetFont` and `SetFont`")
11273 Help = property(GetHelp,SetHelp,doc="See `GetHelp` and `SetHelp`")
11274 Id = property(GetId,SetId,doc="See `GetId` and `SetId`")
11275 Kind = property(GetKind,SetKind,doc="See `GetKind` and `SetKind`")
11276 Label = property(GetLabel,doc="See `GetLabel`")
11277 MarginWidth = property(GetMarginWidth,SetMarginWidth,doc="See `GetMarginWidth` and `SetMarginWidth`")
11278 Menu = property(GetMenu,SetMenu,doc="See `GetMenu` and `SetMenu`")
11279 SubMenu = property(GetSubMenu,SetSubMenu,doc="See `GetSubMenu` and `SetSubMenu`")
11280 Text = property(GetText,SetText,doc="See `GetText` and `SetText`")
11281 TextColour = property(GetTextColour,SetTextColour,doc="See `GetTextColour` and `SetTextColour`")
2131d850 11282_core_.MenuItem_swigregister(MenuItem)
d14a1e28 11283
e811c8ce 11284def MenuItem_GetLabelFromText(*args, **kwargs):
0085ce49
RD
11285 """MenuItem_GetLabelFromText(String text) -> String"""
11286 return _core_.MenuItem_GetLabelFromText(*args, **kwargs)
d14a1e28 11287
0085ce49
RD
11288def MenuItem_GetDefaultMarginWidth(*args):
11289 """MenuItem_GetDefaultMarginWidth() -> int"""
11290 return _core_.MenuItem_GetDefaultMarginWidth(*args)
d14a1e28
RD
11291
11292#---------------------------------------------------------------------------
11293
11294class Control(Window):
15afbcd0
RD
11295 """
11296 This is the base class for a control or 'widget'.
11297
41e2b43e
RD
11298 A control is generally a small window which processes user input
11299 and/or displays one or more item of data.
15afbcd0 11300 """
0085ce49
RD
11301 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11302 __repr__ = _swig_repr
11303 def __init__(self, *args, **kwargs):
0df68c9f 11304 """
248ed943
RD
11305 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
11306 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
b2dc1044 11307 String name=ControlNameStr) -> Control
15afbcd0 11308
41e2b43e
RD
11309 Create a Control. Normally you should only call this from a subclass'
11310 __init__ as a plain old wx.Control is not very useful.
0df68c9f 11311 """
0085ce49 11312 _core_.Control_swiginit(self,_core_.new_Control(*args, **kwargs))
d14a1e28 11313 self._setOORInfo(self)
e811c8ce
RD
11314
11315 def Create(*args, **kwargs):
0df68c9f 11316 """
248ed943
RD
11317 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
11318 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
b2dc1044 11319 String name=ControlNameStr) -> bool
15afbcd0
RD
11320
11321 Do the 2nd phase and create the GUI control.
0df68c9f 11322 """
54f9ee45 11323 return _core_.Control_Create(*args, **kwargs)
e811c8ce 11324
10044bf1
RD
11325 def GetAlignment(*args, **kwargs):
11326 """
11327 GetAlignment(self) -> int
11328
11329 Get the control alignment (left/right/centre, top/bottom/centre)
11330 """
11331 return _core_.Control_GetAlignment(*args, **kwargs)
11332
34e0a3bb 11333 def GetLabelText(*args, **kwargs):
10044bf1 11334 """
10044bf1
RD
11335 GetLabelText(self) -> String
11336
11337 Get just the text of the label, without mnemonic characters ('&')
11338 """
34e0a3bb 11339 return _core_.Control_GetLabelText(*args, **kwargs)
10044bf1 11340
e811c8ce 11341 def Command(*args, **kwargs):
15afbcd0 11342 """
a95a7133 11343 Command(self, CommandEvent event)
15afbcd0 11344
41e2b43e
RD
11345 Simulates the effect of the user issuing a command to the item.
11346
11347 :see: `wx.CommandEvent`
11348
15afbcd0 11349 """
54f9ee45 11350 return _core_.Control_Command(*args, **kwargs)
e811c8ce 11351
74a57fcd 11352 def GetClassDefaultAttributes(*args, **kwargs):
110da5b0
RD
11353 """
11354 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
11355
11356 Get the default attributes for this class. This is useful if you want
11357 to use the same font or colour in your own control as in a standard
11358 control -- which is a much better idea than hard coding specific
11359 colours or fonts which might look completely out of place on the
11360 user's system, especially if it uses themes.
11361
11362 The variant parameter is only relevant under Mac currently and is
11363 ignore under other platforms. Under Mac, it will change the size of
11364 the returned font. See `wx.Window.SetWindowVariant` for more about
11365 this.
11366 """
54f9ee45 11367 return _core_.Control_GetClassDefaultAttributes(*args, **kwargs)
74a57fcd
RD
11368
11369 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
2bf58437 11370 Alignment = property(GetAlignment,doc="See `GetAlignment`")
2bf58437 11371 LabelText = property(GetLabelText,doc="See `GetLabelText`")
2131d850 11372_core_.Control_swigregister(Control)
b2dc1044 11373ControlNameStr = cvar.ControlNameStr
d14a1e28
RD
11374
11375def PreControl(*args, **kwargs):
15afbcd0
RD
11376 """
11377 PreControl() -> Control
11378
11379 Precreate a Control control for 2-phase creation
11380 """
54f9ee45 11381 val = _core_.new_PreControl(*args, **kwargs)
d14a1e28
RD
11382 return val
11383
74a57fcd 11384def Control_GetClassDefaultAttributes(*args, **kwargs):
0085ce49 11385 """
110da5b0
RD
11386 Control_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
11387
11388 Get the default attributes for this class. This is useful if you want
11389 to use the same font or colour in your own control as in a standard
11390 control -- which is a much better idea than hard coding specific
11391 colours or fonts which might look completely out of place on the
11392 user's system, especially if it uses themes.
11393
11394 The variant parameter is only relevant under Mac currently and is
11395 ignore under other platforms. Under Mac, it will change the size of
11396 the returned font. See `wx.Window.SetWindowVariant` for more about
11397 this.
11398 """
0085ce49 11399 return _core_.Control_GetClassDefaultAttributes(*args, **kwargs)
74a57fcd 11400
d14a1e28
RD
11401#---------------------------------------------------------------------------
11402
11403class ItemContainer(object):
15afbcd0 11404 """
53aa7709
RD
11405 The wx.ItemContainer class defines an interface which is implemented
11406 by all controls which have string subitems, each of which may be
11407 selected, such as `wx.ListBox`, `wx.CheckListBox`, `wx.Choice` as well
11408 as `wx.ComboBox` which implements an extended interface deriving from
41e2b43e 11409 this one.
15afbcd0 11410
41e2b43e
RD
11411 It defines the methods for accessing the control's items and although
11412 each of the derived classes implements them differently, they still
11413 all conform to the same interface.
15afbcd0 11414
41e2b43e
RD
11415 The items in a wx.ItemContainer have (non empty) string labels and,
11416 optionally, client data associated with them.
15afbcd0
RD
11417
11418 """
0085ce49
RD
11419 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11420 def __init__(self): raise AttributeError, "No constructor defined"
11421 __repr__ = _swig_repr
e811c8ce 11422 def Append(*args, **kwargs):
15afbcd0 11423 """
a95a7133 11424 Append(self, String item, PyObject clientData=None) -> int
15afbcd0 11425
41e2b43e
RD
11426 Adds the item to the control, associating the given data with the item
11427 if not None. The return value is the index of the newly added item
11428 which may be different from the last one if the control is sorted (e.g.
11429 has wx.LB_SORT or wx.CB_SORT style).
15afbcd0 11430 """
54f9ee45 11431 return _core_.ItemContainer_Append(*args, **kwargs)
e811c8ce
RD
11432
11433 def AppendItems(*args, **kwargs):
15afbcd0 11434 """
f5b96ee1 11435 AppendItems(self, List strings)
15afbcd0 11436
41e2b43e
RD
11437 Apend several items at once to the control. Notice that calling this
11438 method may be much faster than appending the items one by one if you
11439 need to add a lot of items.
15afbcd0 11440 """
54f9ee45 11441 return _core_.ItemContainer_AppendItems(*args, **kwargs)
e811c8ce
RD
11442
11443 def Insert(*args, **kwargs):
15afbcd0 11444 """
d359a380 11445 Insert(self, String item, int pos, PyObject clientData=None) -> int
15afbcd0 11446
41e2b43e 11447 Insert an item into the control before the item at the ``pos`` index,
15afbcd0
RD
11448 optionally associating some data object with the item.
11449 """
54f9ee45 11450 return _core_.ItemContainer_Insert(*args, **kwargs)
e811c8ce
RD
11451
11452 def Clear(*args, **kwargs):
15afbcd0 11453 """
a95a7133 11454 Clear(self)
15afbcd0
RD
11455
11456 Removes all items from the control.
11457 """
54f9ee45 11458 return _core_.ItemContainer_Clear(*args, **kwargs)
e811c8ce
RD
11459
11460 def Delete(*args, **kwargs):
15afbcd0 11461 """
d359a380 11462 Delete(self, int n)
15afbcd0 11463
41e2b43e
RD
11464 Deletes the item at the zero-based index 'n' from the control. Note
11465 that it is an error (signalled by a `wx.PyAssertionError` exception if
11466 enabled) to remove an item with the index negative or greater or equal
11467 than the number of items in the control.
15afbcd0 11468 """
54f9ee45 11469 return _core_.ItemContainer_Delete(*args, **kwargs)
e811c8ce 11470
53aa7709
RD
11471 def GetClientData(*args, **kwargs):
11472 """
d359a380 11473 GetClientData(self, int n) -> PyObject
53aa7709
RD
11474
11475 Returns the client data associated with the given item, (if any.)
11476 """
11477 return _core_.ItemContainer_GetClientData(*args, **kwargs)
11478
11479 def SetClientData(*args, **kwargs):
11480 """
d359a380 11481 SetClientData(self, int n, PyObject clientData)
53aa7709
RD
11482
11483 Associate the given client data with the item at position n.
11484 """
11485 return _core_.ItemContainer_SetClientData(*args, **kwargs)
11486
e811c8ce 11487 def GetCount(*args, **kwargs):
15afbcd0 11488 """
d359a380 11489 GetCount(self) -> int
15afbcd0
RD
11490
11491 Returns the number of items in the control.
11492 """
54f9ee45 11493 return _core_.ItemContainer_GetCount(*args, **kwargs)
e811c8ce
RD
11494
11495 def IsEmpty(*args, **kwargs):
15afbcd0 11496 """
a95a7133 11497 IsEmpty(self) -> bool
15afbcd0
RD
11498
11499 Returns True if the control is empty or False if it has some items.
11500 """
54f9ee45 11501 return _core_.ItemContainer_IsEmpty(*args, **kwargs)
e811c8ce
RD
11502
11503 def GetString(*args, **kwargs):
15afbcd0 11504 """
d359a380 11505 GetString(self, int n) -> String
15afbcd0
RD
11506
11507 Returns the label of the item with the given index.
11508 """
54f9ee45 11509 return _core_.ItemContainer_GetString(*args, **kwargs)
e811c8ce
RD
11510
11511 def GetStrings(*args, **kwargs):
a95a7133 11512 """GetStrings(self) -> wxArrayString"""
54f9ee45 11513 return _core_.ItemContainer_GetStrings(*args, **kwargs)
e811c8ce
RD
11514
11515 def SetString(*args, **kwargs):
15afbcd0 11516 """
d359a380 11517 SetString(self, int n, String s)
15afbcd0
RD
11518
11519 Sets the label for the given item.
11520 """
54f9ee45 11521 return _core_.ItemContainer_SetString(*args, **kwargs)
e811c8ce
RD
11522
11523 def FindString(*args, **kwargs):
15afbcd0 11524 """
a95a7133 11525 FindString(self, String s) -> int
15afbcd0
RD
11526
11527 Finds an item whose label matches the given string. Returns the
41e2b43e
RD
11528 zero-based position of the item, or ``wx.NOT_FOUND`` if the string was not
11529 found.
15afbcd0 11530 """
54f9ee45 11531 return _core_.ItemContainer_FindString(*args, **kwargs)
e811c8ce 11532
53aa7709 11533 def SetSelection(*args, **kwargs):
15afbcd0 11534 """
53aa7709 11535 SetSelection(self, int n)
15afbcd0
RD
11536
11537 Sets the item at index 'n' to be the selected item.
11538 """
53aa7709 11539 return _core_.ItemContainer_SetSelection(*args, **kwargs)
e811c8ce
RD
11540
11541 def GetSelection(*args, **kwargs):
15afbcd0 11542 """
a95a7133 11543 GetSelection(self) -> int
15afbcd0 11544
41e2b43e
RD
11545 Returns the index of the selected item or ``wx.NOT_FOUND`` if no item
11546 is selected.
15afbcd0 11547 """
54f9ee45 11548 return _core_.ItemContainer_GetSelection(*args, **kwargs)
e811c8ce 11549
53aa7709
RD
11550 def SetStringSelection(*args, **kwargs):
11551 """SetStringSelection(self, String s) -> bool"""
11552 return _core_.ItemContainer_SetStringSelection(*args, **kwargs)
11553
e811c8ce 11554 def GetStringSelection(*args, **kwargs):
15afbcd0 11555 """
a95a7133 11556 GetStringSelection(self) -> String
15afbcd0 11557
41e2b43e
RD
11558 Returns the label of the selected item or an empty string if no item
11559 is selected.
15afbcd0 11560 """
54f9ee45 11561 return _core_.ItemContainer_GetStringSelection(*args, **kwargs)
e811c8ce 11562
53aa7709 11563 def Select(*args, **kwargs):
15afbcd0 11564 """
53aa7709 11565 Select(self, int n)
15afbcd0 11566
53aa7709
RD
11567 This is the same as `SetSelection` and exists only because it is
11568 slightly more natural for controls which support multiple selection.
15afbcd0 11569 """
53aa7709 11570 return _core_.ItemContainer_Select(*args, **kwargs)
e811c8ce 11571
97ab0f6a
RD
11572 def GetItems(self):
11573 """Return a list of the strings in the control"""
11574 return [self.GetString(i) for i in xrange(self.GetCount())]
11575
11576 def SetItems(self, items):
11577 """Clear and set the strings in the control from a list"""
11578 self.Clear()
11579 for i in items:
11580 self.Append(i)
11581
11582 Count = property(GetCount,doc="See `GetCount`")
11583 Items = property(GetItems,SetItems,doc="See `GetItems` and `SetItems`")
11584 Selection = property(GetSelection,SetSelection,doc="See `GetSelection` and `SetSelection`")
11585 StringSelection = property(GetStringSelection,SetStringSelection,doc="See `GetStringSelection` and `SetStringSelection`")
11586 Strings = property(GetStrings,doc="See `GetStrings`")
2131d850 11587_core_.ItemContainer_swigregister(ItemContainer)
d14a1e28
RD
11588
11589#---------------------------------------------------------------------------
11590
11591class ControlWithItems(Control,ItemContainer):
15afbcd0 11592 """
41e2b43e
RD
11593 wx.ControlWithItems combines the ``wx.ItemContainer`` class with the
11594 wx.Control class, and is used for the base class of various controls
11595 that have items.
15afbcd0 11596 """
0085ce49
RD
11597 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11598 def __init__(self): raise AttributeError, "No constructor defined"
11599 __repr__ = _swig_repr
2131d850 11600_core_.ControlWithItems_swigregister(ControlWithItems)
d14a1e28
RD
11601
11602#---------------------------------------------------------------------------
11603
11604class SizerItem(Object):
248ed943
RD
11605 """
11606 The wx.SizerItem class is used to track the position, size and other
01f6b6d3
RD
11607 attributes of each item managed by a `wx.Sizer`. It is not usually
11608 necessary to use this class because the sizer elements can also be
11609 identified by their positions or window or sizer references but
11610 sometimes it may be more convenient to use wx.SizerItem directly.
11611 Also, custom classes derived from `wx.PySizer` will probably need to
11612 use the collection of wx.SizerItems held by wx.Sizer when calculating
11613 layout.
248ed943
RD
11614
11615 :see: `wx.Sizer`, `wx.GBSizerItem`
11616 """
0085ce49
RD
11617 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11618 __repr__ = _swig_repr
11619 def __init__(self, *args, **kwargs):
248ed943
RD
11620 """
11621 __init__(self) -> SizerItem
11622
11623 Constructs an empty wx.SizerItem. Either a window, sizer or spacer
11624 size will need to be set before this item can be used in a Sizer.
11625
11626 You will probably never need to create a wx.SizerItem directly as they
11627 are created automatically when the sizer's Add, Insert or Prepend
11628 methods are called.
11629
11630 :see: `wx.SizerItemSpacer`, `wx.SizerItemWindow`, `wx.SizerItemSizer`
11631 """
0085ce49
RD
11632 _core_.SizerItem_swiginit(self,_core_.new_SizerItem(*args, **kwargs))
11633 __swig_destroy__ = _core_.delete_SizerItem
11634 __del__ = lambda self : None;
e811c8ce 11635 def DeleteWindows(*args, **kwargs):
248ed943
RD
11636 """
11637 DeleteWindows(self)
11638
11639 Destroy the window or the windows in a subsizer, depending on the type
11640 of item.
11641 """
54f9ee45 11642 return _core_.SizerItem_DeleteWindows(*args, **kwargs)
e811c8ce
RD
11643
11644 def DetachSizer(*args, **kwargs):
248ed943
RD
11645 """
11646 DetachSizer(self)
11647
11648 Enable deleting the SizerItem without destroying the contained sizer.
11649 """
54f9ee45 11650 return _core_.SizerItem_DetachSizer(*args, **kwargs)
e811c8ce
RD
11651
11652 def GetSize(*args, **kwargs):
248ed943
RD
11653 """
11654 GetSize(self) -> Size
11655
11656 Get the current size of the item, as set in the last Layout.
11657 """
54f9ee45 11658 return _core_.SizerItem_GetSize(*args, **kwargs)
e811c8ce
RD
11659
11660 def CalcMin(*args, **kwargs):
248ed943
RD
11661 """
11662 CalcMin(self) -> Size
11663
11664 Calculates the minimum desired size for the item, including any space
11665 needed by borders.
11666 """
54f9ee45 11667 return _core_.SizerItem_CalcMin(*args, **kwargs)
e811c8ce
RD
11668
11669 def SetDimension(*args, **kwargs):
248ed943
RD
11670 """
11671 SetDimension(self, Point pos, Size size)
11672
11673 Set the position and size of the space allocated for this item by the
11674 sizer, and adjust the position and size of the item (window or
11675 subsizer) to be within that space taking alignment and borders into
11676 account.
11677 """
54f9ee45 11678 return _core_.SizerItem_SetDimension(*args, **kwargs)
e811c8ce
RD
11679
11680 def GetMinSize(*args, **kwargs):
248ed943
RD
11681 """
11682 GetMinSize(self) -> Size
11683
11684 Get the minimum size needed for the item.
11685 """
54f9ee45 11686 return _core_.SizerItem_GetMinSize(*args, **kwargs)
e811c8ce 11687
dfbb5885
RD
11688 def GetMinSizeWithBorder(*args, **kwargs):
11689 """
11690 GetMinSizeWithBorder(self) -> Size
11691
11692 Get the minimum size needed for the item with space for the borders
11693 added, if needed.
11694 """
11695 return _core_.SizerItem_GetMinSizeWithBorder(*args, **kwargs)
11696
e811c8ce 11697 def SetInitSize(*args, **kwargs):
a95a7133 11698 """SetInitSize(self, int x, int y)"""
54f9ee45 11699 return _core_.SizerItem_SetInitSize(*args, **kwargs)
e811c8ce
RD
11700
11701 def SetRatioWH(*args, **kwargs):
248ed943
RD
11702 """
11703 SetRatioWH(self, int width, int height)
11704
11705 Set the ratio item attribute.
11706 """
54f9ee45 11707 return _core_.SizerItem_SetRatioWH(*args, **kwargs)
e811c8ce
RD
11708
11709 def SetRatioSize(*args, **kwargs):
248ed943
RD
11710 """
11711 SetRatioSize(self, Size size)
11712
11713 Set the ratio item attribute.
11714 """
54f9ee45 11715 return _core_.SizerItem_SetRatioSize(*args, **kwargs)
e811c8ce
RD
11716
11717 def SetRatio(*args, **kwargs):
248ed943
RD
11718 """
11719 SetRatio(self, float ratio)
11720
11721 Set the ratio item attribute.
11722 """
54f9ee45 11723 return _core_.SizerItem_SetRatio(*args, **kwargs)
e811c8ce
RD
11724
11725 def GetRatio(*args, **kwargs):
248ed943
RD
11726 """
11727 GetRatio(self) -> float
11728
11729 Set the ratio item attribute.
11730 """
54f9ee45 11731 return _core_.SizerItem_GetRatio(*args, **kwargs)
e811c8ce 11732
d3b6e4ff
RD
11733 def GetRect(*args, **kwargs):
11734 """
11735 GetRect(self) -> Rect
11736
11737 Returns the rectangle that the sizer item should occupy
11738 """
11739 return _core_.SizerItem_GetRect(*args, **kwargs)
11740
e811c8ce 11741 def IsWindow(*args, **kwargs):
248ed943
RD
11742 """
11743 IsWindow(self) -> bool
11744
11745 Is this sizer item a window?
11746 """
54f9ee45 11747 return _core_.SizerItem_IsWindow(*args, **kwargs)
e811c8ce
RD
11748
11749 def IsSizer(*args, **kwargs):
248ed943
RD
11750 """
11751 IsSizer(self) -> bool
11752
11753 Is this sizer item a subsizer?
11754 """
54f9ee45 11755 return _core_.SizerItem_IsSizer(*args, **kwargs)
e811c8ce
RD
11756
11757 def IsSpacer(*args, **kwargs):
248ed943
RD
11758 """
11759 IsSpacer(self) -> bool
11760
11761 Is this sizer item a spacer?
11762 """
54f9ee45 11763 return _core_.SizerItem_IsSpacer(*args, **kwargs)
e811c8ce
RD
11764
11765 def SetProportion(*args, **kwargs):
248ed943
RD
11766 """
11767 SetProportion(self, int proportion)
11768
11769 Set the proportion value for this item.
11770 """
54f9ee45 11771 return _core_.SizerItem_SetProportion(*args, **kwargs)
e811c8ce
RD
11772
11773 def GetProportion(*args, **kwargs):
248ed943
RD
11774 """
11775 GetProportion(self) -> int
11776
11777 Get the proportion value for this item.
11778 """
54f9ee45 11779 return _core_.SizerItem_GetProportion(*args, **kwargs)
e811c8ce 11780
248ed943
RD
11781 SetOption = wx._deprecated(SetProportion, "Please use `SetProportion` instead.")
11782 GetOption = wx._deprecated(GetProportion, "Please use `GetProportion` instead.")
e811c8ce 11783 def SetFlag(*args, **kwargs):
248ed943
RD
11784 """
11785 SetFlag(self, int flag)
11786
11787 Set the flag value for this item.
11788 """
54f9ee45 11789 return _core_.SizerItem_SetFlag(*args, **kwargs)
e811c8ce
RD
11790
11791 def GetFlag(*args, **kwargs):
248ed943
RD
11792 """
11793 GetFlag(self) -> int
11794
11795 Get the flag value for this item.
11796 """
54f9ee45 11797 return _core_.SizerItem_GetFlag(*args, **kwargs)
e811c8ce
RD
11798
11799 def SetBorder(*args, **kwargs):
248ed943
RD
11800 """
11801 SetBorder(self, int border)
11802
11803 Set the border value for this item.
11804 """
54f9ee45 11805 return _core_.SizerItem_SetBorder(*args, **kwargs)
e811c8ce
RD
11806
11807 def GetBorder(*args, **kwargs):
248ed943
RD
11808 """
11809 GetBorder(self) -> int
11810
11811 Get the border value for this item.
11812 """
54f9ee45 11813 return _core_.SizerItem_GetBorder(*args, **kwargs)
e811c8ce
RD
11814
11815 def GetWindow(*args, **kwargs):
248ed943
RD
11816 """
11817 GetWindow(self) -> Window
11818
11819 Get the window (if any) that is managed by this sizer item.
11820 """
54f9ee45 11821 return _core_.SizerItem_GetWindow(*args, **kwargs)
e811c8ce
RD
11822
11823 def SetWindow(*args, **kwargs):
248ed943
RD
11824 """
11825 SetWindow(self, Window window)
11826
11827 Set the window to be managed by this sizer item.
11828 """
54f9ee45 11829 return _core_.SizerItem_SetWindow(*args, **kwargs)
e811c8ce
RD
11830
11831 def GetSizer(*args, **kwargs):
248ed943
RD
11832 """
11833 GetSizer(self) -> Sizer
11834
11835 Get the subsizer (if any) that is managed by this sizer item.
11836 """
54f9ee45 11837 return _core_.SizerItem_GetSizer(*args, **kwargs)
e811c8ce
RD
11838
11839 def SetSizer(*args, **kwargs):
248ed943
RD
11840 """
11841 SetSizer(self, Sizer sizer)
11842
11843 Set the subsizer to be managed by this sizer item.
11844 """
54f9ee45 11845 return _core_.SizerItem_SetSizer(*args, **kwargs)
e811c8ce
RD
11846
11847 def GetSpacer(*args, **kwargs):
248ed943
RD
11848 """
11849 GetSpacer(self) -> Size
11850
11851 Get the size of the spacer managed by this sizer item.
11852 """
54f9ee45 11853 return _core_.SizerItem_GetSpacer(*args, **kwargs)
e811c8ce
RD
11854
11855 def SetSpacer(*args, **kwargs):
248ed943
RD
11856 """
11857 SetSpacer(self, Size size)
11858
11859 Set the size of the spacer to be managed by this sizer item.
11860 """
54f9ee45 11861 return _core_.SizerItem_SetSpacer(*args, **kwargs)
e811c8ce
RD
11862
11863 def Show(*args, **kwargs):
248ed943
RD
11864 """
11865 Show(self, bool show)
11866
11867 Set the show item attribute, which sizers use to determine if the item
11868 is to be made part of the layout or not. If the item is tracking a
11869 window then it is shown or hidden as needed.
11870 """
54f9ee45 11871 return _core_.SizerItem_Show(*args, **kwargs)
e811c8ce
RD
11872
11873 def IsShown(*args, **kwargs):
248ed943
RD
11874 """
11875 IsShown(self) -> bool
11876
11877 Is the item to be shown in the layout?
11878 """
54f9ee45 11879 return _core_.SizerItem_IsShown(*args, **kwargs)
e811c8ce
RD
11880
11881 def GetPosition(*args, **kwargs):
248ed943
RD
11882 """
11883 GetPosition(self) -> Point
11884
11885 Returns the current position of the item, as set in the last Layout.
11886 """
54f9ee45 11887 return _core_.SizerItem_GetPosition(*args, **kwargs)
e811c8ce
RD
11888
11889 def GetUserData(*args, **kwargs):
248ed943
RD
11890 """
11891 GetUserData(self) -> PyObject
11892
11893 Returns the userData associated with this sizer item, or None if there
11894 isn't any.
11895 """
54f9ee45 11896 return _core_.SizerItem_GetUserData(*args, **kwargs)
e811c8ce 11897
091f5bed
RD
11898 def SetUserData(*args, **kwargs):
11899 """
11900 SetUserData(self, PyObject userData)
11901
11902 Associate a Python object with this sizer item.
11903 """
11904 return _core_.SizerItem_SetUserData(*args, **kwargs)
11905
33d6fd3b
RD
11906 Border = property(GetBorder,SetBorder,doc="See `GetBorder` and `SetBorder`")
11907 Flag = property(GetFlag,SetFlag,doc="See `GetFlag` and `SetFlag`")
11908 MinSize = property(GetMinSize,doc="See `GetMinSize`")
11909 MinSizeWithBorder = property(GetMinSizeWithBorder,doc="See `GetMinSizeWithBorder`")
11910 Position = property(GetPosition,doc="See `GetPosition`")
11911 Proportion = property(GetProportion,SetProportion,doc="See `GetProportion` and `SetProportion`")
11912 Ratio = property(GetRatio,SetRatio,doc="See `GetRatio` and `SetRatio`")
11913 Rect = property(GetRect,doc="See `GetRect`")
11914 Size = property(GetSize,doc="See `GetSize`")
11915 Sizer = property(GetSizer,SetSizer,doc="See `GetSizer` and `SetSizer`")
11916 Spacer = property(GetSpacer,SetSpacer,doc="See `GetSpacer` and `SetSpacer`")
11917 UserData = property(GetUserData,SetUserData,doc="See `GetUserData` and `SetUserData`")
11918 Window = property(GetWindow,SetWindow,doc="See `GetWindow` and `SetWindow`")
2131d850 11919_core_.SizerItem_swigregister(SizerItem)
d14a1e28 11920
248ed943 11921def SizerItemWindow(*args, **kwargs):
0df68c9f 11922 """
248ed943
RD
11923 SizerItemWindow(Window window, int proportion, int flag, int border,
11924 PyObject userData=None) -> SizerItem
11925
11926 Constructs a `wx.SizerItem` for tracking a window.
0df68c9f 11927 """
248ed943 11928 val = _core_.new_SizerItemWindow(*args, **kwargs)
d14a1e28
RD
11929 return val
11930
248ed943 11931def SizerItemSpacer(*args, **kwargs):
0df68c9f 11932 """
248ed943
RD
11933 SizerItemSpacer(int width, int height, int proportion, int flag, int border,
11934 PyObject userData=None) -> SizerItem
11935
11936 Constructs a `wx.SizerItem` for tracking a spacer.
0df68c9f 11937 """
248ed943 11938 val = _core_.new_SizerItemSpacer(*args, **kwargs)
d14a1e28
RD
11939 return val
11940
11941def SizerItemSizer(*args, **kwargs):
0df68c9f
RD
11942 """
11943 SizerItemSizer(Sizer sizer, int proportion, int flag, int border,
248ed943
RD
11944 PyObject userData=None) -> SizerItem
11945
11946 Constructs a `wx.SizerItem` for tracking a subsizer
0df68c9f 11947 """
54f9ee45 11948 val = _core_.new_SizerItemSizer(*args, **kwargs)
d14a1e28
RD
11949 return val
11950
11951class Sizer(Object):
248ed943
RD
11952 """
11953 wx.Sizer is the abstract base class used for laying out subwindows in
11954 a window. You cannot use wx.Sizer directly; instead, you will have to
11955 use one of the sizer classes derived from it such as `wx.BoxSizer`,
1d5ee749
RD
11956 `wx.StaticBoxSizer`, `wx.GridSizer`, `wx.FlexGridSizer` and
11957 `wx.GridBagSizer`.
248ed943
RD
11958
11959 The concept implemented by sizers in wxWidgets is closely related to
11960 layout tools in other GUI toolkits, such as Java's AWT, the GTK
11961 toolkit or the Qt toolkit. It is based upon the idea of the individual
11962 subwindows reporting their minimal required size and their ability to
11963 get stretched if the size of the parent window has changed. This will
11964 most often mean that the programmer does not set the original size of
11965 a dialog in the beginning, rather the dialog will assigned a sizer and
11966 this sizer will be queried about the recommended size. The sizer in
11967 turn will query its children, which can be normal windows or contorls,
11968 empty space or other sizers, so that a hierarchy of sizers can be
11969 constructed. Note that wxSizer does not derive from wxWindow and thus
11970 do not interfere with tab ordering and requires very little resources
11971 compared to a real window on screen.
11972
11973 What makes sizers so well fitted for use in wxWidgets is the fact that
11974 every control reports its own minimal size and the algorithm can
11975 handle differences in font sizes or different window (dialog item)
11976 sizes on different platforms without problems. If for example the
11977 standard font as well as the overall design of Mac widgets requires
11978 more space than on Windows, then the initial size of a dialog using a
11979 sizer will automatically be bigger on Mac than on Windows.
11980 """
0085ce49
RD
11981 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11982 def __init__(self): raise AttributeError, "No constructor defined"
11983 __repr__ = _swig_repr
11984 __swig_destroy__ = _core_.delete_Sizer
11985 __del__ = lambda self : None;
e811c8ce 11986 def _setOORInfo(*args, **kwargs):
a95a7133 11987 """_setOORInfo(self, PyObject _self)"""
54f9ee45 11988 return _core_.Sizer__setOORInfo(*args, **kwargs)
e811c8ce
RD
11989
11990 def Add(*args, **kwargs):
0df68c9f 11991 """
248ed943 11992 Add(self, item, int proportion=0, int flag=0, int border=0,
d3b6e4ff 11993 PyObject userData=None) -> wx.SizerItem
248ed943
RD
11994
11995 Appends a child item to the sizer.
0df68c9f 11996 """
54f9ee45 11997 return _core_.Sizer_Add(*args, **kwargs)
e811c8ce
RD
11998
11999 def Insert(*args, **kwargs):
0df68c9f 12000 """
248ed943 12001 Insert(self, int before, item, int proportion=0, int flag=0, int border=0,
d3b6e4ff 12002 PyObject userData=None) -> wx.SizerItem
248ed943
RD
12003
12004 Inserts a new item into the list of items managed by this sizer before
12005 the item at index *before*. See `Add` for a description of the parameters.
0df68c9f 12006 """
54f9ee45 12007 return _core_.Sizer_Insert(*args, **kwargs)
e811c8ce
RD
12008
12009 def Prepend(*args, **kwargs):
0df68c9f 12010 """
248ed943 12011 Prepend(self, item, int proportion=0, int flag=0, int border=0,
d3b6e4ff 12012 PyObject userData=None) -> wx.SizerItem
248ed943
RD
12013
12014 Adds a new item to the begining of the list of sizer items managed by
12015 this sizer. See `Add` for a description of the parameters.
0df68c9f 12016 """
54f9ee45 12017 return _core_.Sizer_Prepend(*args, **kwargs)
e811c8ce
RD
12018
12019 def Remove(*args, **kwargs):
248ed943
RD
12020 """
12021 Remove(self, item) -> bool
12022
12023 Removes an item from the sizer and destroys it. This method does not
12024 cause any layout or resizing to take place, call `Layout` to update
12025 the layout on screen after removing a child from the sizer. The
12026 *item* parameter can be either a window, a sizer, or the zero-based
12027 index of an item to remove. Returns True if the child item was found
12028 and removed.
12029 """
54f9ee45 12030 return _core_.Sizer_Remove(*args, **kwargs)
e811c8ce 12031
1c0f361b 12032 def Detach(*args, **kwargs):
248ed943
RD
12033 """
12034 Detach(self, item) -> bool
12035
12036 Detaches an item from the sizer without destroying it. This method
12037 does not cause any layout or resizing to take place, call `Layout` to
12038 do so. The *item* parameter can be either a window, a sizer, or the
12039 zero-based index of the item to be detached. Returns True if the child item
12040 was found and detached.
12041 """
1c0f361b
RD
12042 return _core_.Sizer_Detach(*args, **kwargs)
12043
d3b6e4ff
RD
12044 def GetItem(*args, **kwargs):
12045 """
12046 GetItem(self, item) -> wx.SizerItem
12047
12048 Returns the `wx.SizerItem` which holds the *item* given. The *item*
12049 parameter can be either a window, a sizer, or the zero-based index of
4d170c95 12050 the item to be found.
d3b6e4ff
RD
12051 """
12052 return _core_.Sizer_GetItem(*args, **kwargs)
12053
e811c8ce 12054 def _SetItemMinSize(*args, **kwargs):
a95a7133 12055 """_SetItemMinSize(self, PyObject item, Size size)"""
54f9ee45 12056 return _core_.Sizer__SetItemMinSize(*args, **kwargs)
e811c8ce 12057
97ab0f6a
RD
12058 def _ReplaceWin(*args, **kwargs):
12059 """_ReplaceWin(self, Window oldwin, Window newwin, bool recursive=False) -> bool"""
12060 return _core_.Sizer__ReplaceWin(*args, **kwargs)
12061
12062 def _ReplaceSizer(*args, **kwargs):
12063 """_ReplaceSizer(self, Sizer oldsz, Sizer newsz, bool recursive=False) -> bool"""
12064 return _core_.Sizer__ReplaceSizer(*args, **kwargs)
12065
12066 def _ReplaceItem(*args, **kwargs):
12067 """_ReplaceItem(self, size_t index, SizerItem newitem) -> bool"""
12068 return _core_.Sizer__ReplaceItem(*args, **kwargs)
12069
12070 def Replace(self, olditem, item, recursive=False):
12071 """
12072 Detaches the given ``olditem`` from the sizer and replaces it with
12073 ``item`` which can be a window, sizer, or `wx.SizerItem`. The
12074 detached child is destroyed only if it is not a window, (because
12075 windows are owned by their parent, not the sizer.) The
12076 ``recursive`` parameter can be used to search for the given
12077 element recursivly in subsizers.
12078
12079 This method does not cause any layout or resizing to take place,
12080 call `Layout` to do so.
12081
12082 Returns ``True`` if the child item was found and removed.
12083 """
12084 if isinstance(olditem, wx.Window):
12085 return self._ReplaceWin(olditem, item, recursive)
12086 elif isinstnace(olditem, wx.Sizer):
12087 return self._ReplaceSizer(olditem, item, recursive)
12088 elif isinstnace(olditem, int):
12089 return self._ReplaceItem(olditem, item)
12090 else:
12091 raise TypeError("Expected Window, Sizer, or integer for first parameter.")
12092
12093 def SetContainingWindow(*args, **kwargs):
12094 """
12095 SetContainingWindow(self, Window window)
12096
12097 Set (or unset) the window this sizer is used in.
12098 """
12099 return _core_.Sizer_SetContainingWindow(*args, **kwargs)
12100
12101 def GetContainingWindow(*args, **kwargs):
12102 """
12103 GetContainingWindow(self) -> Window
12104
12105 Get the window this sizer is used in.
12106 """
12107 return _core_.Sizer_GetContainingWindow(*args, **kwargs)
12108
248ed943
RD
12109 def SetItemMinSize(self, item, *args):
12110 """
12111 SetItemMinSize(self, item, Size size)
12112
12113 Sets the minimum size that will be allocated for an item in the sizer.
12114 The *item* parameter can be either a window, a sizer, or the
12115 zero-based index of the item. If a window or sizer is given then it
12116 will be searched for recursivly in subsizers if neccessary.
12117 """
12118 if len(args) == 2:
12119 # for backward compatibility accept separate width,height args too
12120 return self._SetItemMinSize(item, args)
12121 else:
12122 return self._SetItemMinSize(item, args[0])
12123
e811c8ce 12124 def AddItem(*args, **kwargs):
248ed943
RD
12125 """
12126 AddItem(self, SizerItem item)
12127
12128 Adds a `wx.SizerItem` to the sizer.
12129 """
54f9ee45 12130 return _core_.Sizer_AddItem(*args, **kwargs)
e811c8ce
RD
12131
12132 def InsertItem(*args, **kwargs):
248ed943
RD
12133 """
12134 InsertItem(self, int index, SizerItem item)
12135
12136 Inserts a `wx.SizerItem` to the sizer at the position given by *index*.
12137 """
54f9ee45 12138 return _core_.Sizer_InsertItem(*args, **kwargs)
e811c8ce
RD
12139
12140 def PrependItem(*args, **kwargs):
248ed943
RD
12141 """
12142 PrependItem(self, SizerItem item)
12143
12144 Prepends a `wx.SizerItem` to the sizer.
12145 """
54f9ee45 12146 return _core_.Sizer_PrependItem(*args, **kwargs)
e811c8ce 12147
248ed943 12148 def AddMany(self, items):
66c033b4
RD
12149 """
12150 AddMany is a convenience method for adding several items
12151 to a sizer at one time. Simply pass it a list of tuples,
12152 where each tuple consists of the parameters that you
12153 would normally pass to the `Add` method.
12154 """
248ed943
RD
12155 for item in items:
12156 if type(item) != type(()) or (len(item) == 2 and type(item[0]) == type(1)):
12157 item = (item, )
12158 self.Add(*item)
d14a1e28 12159
ae5bc7f3
RD
12160 def AddSpacer(self, *args, **kw):
12161 """AddSpacer(int size) --> SizerItem
12162
12163 Add a spacer that is (size,size) pixels.
12164 """
12165 if args and type(args[0]) == int:
12166 return self.Add( (args[0],args[0] ), 0)
12167 else: # otherwise stay compatible with old AddSpacer
12168 return self.Add(*args, **kw)
12169 def PrependSpacer(self, *args, **kw):
12170 """PrependSpacer(int size) --> SizerItem
12171
12172 Prepend a spacer that is (size, size) pixels."""
12173 if args and type(args[0]) == int:
12174 return self.Prepend( (args[0],args[0] ), 0)
12175 else: # otherwise stay compatible with old PrependSpacer
12176 return self.Prepend(*args, **kw)
12177 def InsertSpacer(self, index, *args, **kw):
12178 """InsertSpacer(int index, int size) --> SizerItem
12179
12180 Insert a spacer at position index that is (size, size) pixels."""
12181 if args and type(args[0]) == int:
12182 return self.Insert( index, (args[0],args[0] ), 0)
12183 else: # otherwise stay compatible with old InsertSpacer
12184 return self.Insert(index, *args, **kw)
12185
12186
12187 def AddStretchSpacer(self, prop=1):
12188 """AddStretchSpacer(int prop=1) --> SizerItem
12189
12190 Add a stretchable spacer."""
12191 return self.Add((0,0), prop)
12192 def PrependStretchSpacer(self, prop=1):
12193 """PrependStretchSpacer(int prop=1) --> SizerItem
12194
12195 Prepend a stretchable spacer."""
12196 return self.Prepend((0,0), prop)
12197 def InsertStretchSpacer(self, index, prop=1):
12198 """InsertStretchSpacer(int index, int prop=1) --> SizerItem
12199
12200 Insert a stretchable spacer."""
12201 return self.Insert(index, (0,0), prop)
12202
12203
74e96f3d 12204 # for backwards compatibility only, please do not use in new code
b9d6a5f3
RD
12205 def AddWindow(self, *args, **kw):
12206 """Compatibility alias for `Add`."""
12207 return self.Add(*args, **kw)
12208 def AddSizer(self, *args, **kw):
12209 """Compatibility alias for `Add`."""
12210 return self.Add(*args, **kw)
b9d6a5f3
RD
12211
12212 def PrependWindow(self, *args, **kw):
12213 """Compatibility alias for `Prepend`."""
12214 return self.Prepend(*args, **kw)
12215 def PrependSizer(self, *args, **kw):
12216 """Compatibility alias for `Prepend`."""
12217 return self.Prepend(*args, **kw)
b9d6a5f3
RD
12218
12219 def InsertWindow(self, *args, **kw):
12220 """Compatibility alias for `Insert`."""
12221 return self.Insert(*args, **kw)
12222 def InsertSizer(self, *args, **kw):
12223 """Compatibility alias for `Insert`."""
b9d6a5f3
RD
12224 return self.Insert(*args, **kw)
12225
12226 def RemoveWindow(self, *args, **kw):
12227 """Compatibility alias for `Remove`."""
12228 return self.Remove(*args, **kw)
12229 def RemoveSizer(self, *args, **kw):
12230 """Compatibility alias for `Remove`."""
12231 return self.Remove(*args, **kw)
12232 def RemovePos(self, *args, **kw):
12233 """Compatibility alias for `Remove`."""
12234 return self.Remove(*args, **kw)
d14a1e28
RD
12235
12236
e811c8ce 12237 def SetDimension(*args, **kwargs):
248ed943
RD
12238 """
12239 SetDimension(self, int x, int y, int width, int height)
12240
12241 Call this to force the sizer to take the given dimension and thus
12242 force the items owned by the sizer to resize themselves according to
12243 the rules defined by the parameter in the `Add`, `Insert` or `Prepend`
12244 methods.
12245 """
54f9ee45 12246 return _core_.Sizer_SetDimension(*args, **kwargs)
e811c8ce
RD
12247
12248 def SetMinSize(*args, **kwargs):
248ed943
RD
12249 """
12250 SetMinSize(self, Size size)
12251
12252 Call this to give the sizer a minimal size. Normally, the sizer will
12253 calculate its minimal size based purely on how much space its children
12254 need. After calling this method `GetMinSize` will return either the
12255 minimal size as requested by its children or the minimal size set
12256 here, depending on which is bigger.
12257 """
54f9ee45 12258 return _core_.Sizer_SetMinSize(*args, **kwargs)
e811c8ce
RD
12259
12260 def GetSize(*args, **kwargs):
248ed943
RD
12261 """
12262 GetSize(self) -> Size
12263
12264 Returns the current size of the space managed by the sizer.
12265 """
54f9ee45 12266 return _core_.Sizer_GetSize(*args, **kwargs)
e811c8ce
RD
12267
12268 def GetPosition(*args, **kwargs):
248ed943
RD
12269 """
12270 GetPosition(self) -> Point
12271
12272 Returns the current position of the sizer's managed space.
12273 """
54f9ee45 12274 return _core_.Sizer_GetPosition(*args, **kwargs)
e811c8ce
RD
12275
12276 def GetMinSize(*args, **kwargs):
248ed943
RD
12277 """
12278 GetMinSize(self) -> Size
12279
12280 Returns the minimal size of the sizer. This is either the combined
12281 minimal size of all the children and their borders or the minimal size
12282 set by SetMinSize, depending on which is bigger.
12283 """
54f9ee45 12284 return _core_.Sizer_GetMinSize(*args, **kwargs)
e811c8ce 12285
d14a1e28 12286 def GetSizeTuple(self):
1c0f361b 12287 return self.GetSize().Get()
d14a1e28 12288 def GetPositionTuple(self):
1c0f361b 12289 return self.GetPosition().Get()
d14a1e28 12290 def GetMinSizeTuple(self):
1c0f361b 12291 return self.GetMinSize().Get()
d14a1e28 12292
e811c8ce 12293 def RecalcSizes(*args, **kwargs):
248ed943
RD
12294 """
12295 RecalcSizes(self)
12296
12297 Using the sizes calculated by `CalcMin` reposition and resize all the
12298 items managed by this sizer. You should not need to call this directly as
12299 it is called by `Layout`.
12300 """
54f9ee45 12301 return _core_.Sizer_RecalcSizes(*args, **kwargs)
e811c8ce
RD
12302
12303 def CalcMin(*args, **kwargs):
248ed943
RD
12304 """
12305 CalcMin(self) -> Size
12306
12307 This method is where the sizer will do the actual calculation of its
12308 children's minimal sizes. You should not need to call this directly as
12309 it is called by `Layout`.
12310 """
54f9ee45 12311 return _core_.Sizer_CalcMin(*args, **kwargs)
e811c8ce
RD
12312
12313 def Layout(*args, **kwargs):
248ed943
RD
12314 """
12315 Layout(self)
12316
12317 This method will force the recalculation and layout of the items
12318 controlled by the sizer using the current space allocated to the
12319 sizer. Normally this is called automatically from the owning window's
12320 EVT_SIZE handler, but it is also useful to call it from user code when
12321 one of the items in a sizer change size, or items are added or
12322 removed.
12323 """
54f9ee45 12324 return _core_.Sizer_Layout(*args, **kwargs)
e811c8ce
RD
12325
12326 def Fit(*args, **kwargs):
248ed943
RD
12327 """
12328 Fit(self, Window window) -> Size
12329
12330 Tell the sizer to resize the *window* to match the sizer's minimal
12331 size. This is commonly done in the constructor of the window itself in
12332 order to set its initial size to match the needs of the children as
12333 determined by the sizer. Returns the new size.
12334
12335 For a top level window this is the total window size, not the client size.
12336 """
54f9ee45 12337 return _core_.Sizer_Fit(*args, **kwargs)
e811c8ce
RD
12338
12339 def FitInside(*args, **kwargs):
248ed943
RD
12340 """
12341 FitInside(self, Window window)
12342
12343 Tell the sizer to resize the *virtual size* of the *window* to match the
12344 sizer's minimal size. This will not alter the on screen size of the
12345 window, but may cause the addition/removal/alteration of scrollbars
12346 required to view the virtual area in windows which manage it.
12347
12348 :see: `wx.ScrolledWindow.SetScrollbars`, `SetVirtualSizeHints`
12349
12350 """
54f9ee45 12351 return _core_.Sizer_FitInside(*args, **kwargs)
e811c8ce
RD
12352
12353 def SetSizeHints(*args, **kwargs):
248ed943
RD
12354 """
12355 SetSizeHints(self, Window window)
12356
12357 Tell the sizer to set (and `Fit`) the minimal size of the *window* to
12358 match the sizer's minimal size. This is commonly done in the
12359 constructor of the window itself if the window is resizable (as are
12360 many dialogs under Unix and frames on probably all platforms) in order
12361 to prevent the window from being sized smaller than the minimal size
12362 required by the sizer.
12363 """
54f9ee45 12364 return _core_.Sizer_SetSizeHints(*args, **kwargs)
e811c8ce
RD
12365
12366 def SetVirtualSizeHints(*args, **kwargs):
248ed943
RD
12367 """
12368 SetVirtualSizeHints(self, Window window)
12369
12370 Tell the sizer to set the minimal size of the window virtual area to
12371 match the sizer's minimal size. For windows with managed scrollbars
12372 this will set them appropriately.
12373
12374 :see: `wx.ScrolledWindow.SetScrollbars`
12375
12376 """
54f9ee45 12377 return _core_.Sizer_SetVirtualSizeHints(*args, **kwargs)
e811c8ce
RD
12378
12379 def Clear(*args, **kwargs):
248ed943
RD
12380 """
12381 Clear(self, bool deleteWindows=False)
12382
12383 Clear all items from the sizer, optionally destroying the window items
12384 as well.
12385 """
54f9ee45 12386 return _core_.Sizer_Clear(*args, **kwargs)
e811c8ce
RD
12387
12388 def DeleteWindows(*args, **kwargs):
248ed943
RD
12389 """
12390 DeleteWindows(self)
12391
12392 Destroy all windows managed by the sizer.
12393 """
54f9ee45 12394 return _core_.Sizer_DeleteWindows(*args, **kwargs)
e811c8ce
RD
12395
12396 def GetChildren(*args, **kwargs):
248ed943 12397 """
51b83b37 12398 GetChildren(self) -> list
248ed943
RD
12399
12400 Returns a list of all the `wx.SizerItem` objects managed by the sizer.
12401 """
54f9ee45 12402 return _core_.Sizer_GetChildren(*args, **kwargs)
e811c8ce
RD
12403
12404 def Show(*args, **kwargs):
248ed943 12405 """
ae8162c8 12406 Show(self, item, bool show=True, bool recursive=false) -> bool
e811c8ce 12407
248ed943
RD
12408 Shows or hides an item managed by the sizer. To make a sizer item
12409 disappear or reappear, use Show followed by `Layout`. The *item*
12410 parameter can be either a window, a sizer, or the zero-based index of
7e63a440
RD
12411 the item. Use the recursive parameter to show or hide an item in a
12412 subsizer. Returns True if the item was found.
248ed943
RD
12413 """
12414 return _core_.Sizer_Show(*args, **kwargs)
e811c8ce
RD
12415
12416 def IsShown(*args, **kwargs):
248ed943
RD
12417 """
12418 IsShown(self, item)
12419
b1fcee84 12420 Determines if the item is currently shown. To make a sizer
248ed943
RD
12421 item disappear or reappear, use Show followed by `Layout`. The *item*
12422 parameter can be either a window, a sizer, or the zero-based index of
12423 the item.
12424 """
54f9ee45 12425 return _core_.Sizer_IsShown(*args, **kwargs)
e811c8ce 12426
7e63a440 12427 def Hide(self, item, recursive=False):
248ed943 12428 """
27fb7603 12429 A convenience method for `Show` (item, False, recursive).
248ed943 12430 """
06759a38 12431 return self.Show(item, False, recursive)
248ed943 12432
e811c8ce 12433 def ShowItems(*args, **kwargs):
248ed943
RD
12434 """
12435 ShowItems(self, bool show)
12436
84f85550 12437 Recursively call `wx.SizerItem.Show` on all sizer items.
248ed943 12438 """
54f9ee45 12439 return _core_.Sizer_ShowItems(*args, **kwargs)
e811c8ce 12440
33d6fd3b
RD
12441 Children = property(GetChildren,doc="See `GetChildren`")
12442 ContainingWindow = property(GetContainingWindow,SetContainingWindow,doc="See `GetContainingWindow` and `SetContainingWindow`")
12443 MinSize = property(GetMinSize,SetMinSize,doc="See `GetMinSize` and `SetMinSize`")
12444 Position = property(GetPosition,doc="See `GetPosition`")
12445 Size = property(GetSize,doc="See `GetSize`")
2131d850 12446_core_.Sizer_swigregister(Sizer)
d14a1e28
RD
12447
12448class PySizer(Sizer):
248ed943
RD
12449 """
12450 wx.PySizer is a special version of `wx.Sizer` that has been
12451 instrumented to allow the C++ virtual methods to be overloaded in
12452 Python derived classes. You would derive from this class if you are
12453 wanting to implement a custom sizer in Python code. Simply implement
12454 `CalcMin` and `RecalcSizes` in the derived class and you're all set.
12455 For example::
12456
12457 class MySizer(wx.PySizer):
12458 def __init__(self):
12459 wx.PySizer.__init__(self)
12460
12461 def CalcMin(self):
12462 for item in self.GetChildren():
12463 # calculate the total minimum width and height needed
12464 # by all items in the sizer according to this sizer's
12465 # layout algorithm.
12466 ...
12467 return wx.Size(width, height)
12468
12469 def RecalcSizes(self):
12470 # find the space allotted to this sizer
12471 pos = self.GetPosition()
12472 size = self.GetSize()
12473 for item in self.GetChildren():
12474 # Recalculate (if necessary) the position and size of
12475 # each item and then call item.SetDimension to do the
12476 # actual positioning and sizing of the items within the
12477 # space alloted to this sizer.
12478 ...
12479 item.SetDimension(itemPos, itemSize)
12480
12481
12482 When `Layout` is called it first calls `CalcMin` followed by
12483 `RecalcSizes` so you can optimize a bit by saving the results of
e505d15e 12484 `CalcMin` and reusing them in `RecalcSizes`.
248ed943
RD
12485
12486 :see: `wx.SizerItem`, `wx.Sizer.GetChildren`
12487
12488
12489 """
0085ce49
RD
12490 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12491 __repr__ = _swig_repr
12492 def __init__(self, *args, **kwargs):
248ed943
RD
12493 """
12494 __init__(self) -> PySizer
12495
12496 Creates a wx.PySizer. Must be called from the __init__ in the derived
12497 class.
12498 """
0085ce49 12499 _core_.PySizer_swiginit(self,_core_.new_PySizer(*args, **kwargs))
c25f90f6 12500 self._setOORInfo(self);PySizer._setCallbackInfo(self, self, PySizer)
e811c8ce
RD
12501
12502 def _setCallbackInfo(*args, **kwargs):
a95a7133 12503 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
54f9ee45 12504 return _core_.PySizer__setCallbackInfo(*args, **kwargs)
e811c8ce 12505
2131d850 12506_core_.PySizer_swigregister(PySizer)
d14a1e28
RD
12507
12508#---------------------------------------------------------------------------
12509
12510class BoxSizer(Sizer):
248ed943
RD
12511 """
12512 The basic idea behind a box sizer is that windows will most often be
12513 laid out in rather simple basic geometry, typically in a row or a
12514 column or nested hierarchies of either. A wx.BoxSizer will lay out
12515 its items in a simple row or column, depending on the orientation
12516 parameter passed to the constructor.
12517 """
0085ce49
RD
12518 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12519 __repr__ = _swig_repr
12520 def __init__(self, *args, **kwargs):
248ed943
RD
12521 """
12522 __init__(self, int orient=HORIZONTAL) -> BoxSizer
12523
12524 Constructor for a wx.BoxSizer. *orient* may be one of ``wx.VERTICAL``
12525 or ``wx.HORIZONTAL`` for creating either a column sizer or a row
12526 sizer.
12527 """
0085ce49 12528 _core_.BoxSizer_swiginit(self,_core_.new_BoxSizer(*args, **kwargs))
d14a1e28 12529 self._setOORInfo(self)
e811c8ce
RD
12530
12531 def GetOrientation(*args, **kwargs):
248ed943
RD
12532 """
12533 GetOrientation(self) -> int
12534
12535 Returns the current orientation of the sizer.
12536 """
54f9ee45 12537 return _core_.BoxSizer_GetOrientation(*args, **kwargs)
e811c8ce
RD
12538
12539 def SetOrientation(*args, **kwargs):
248ed943
RD
12540 """
12541 SetOrientation(self, int orient)
e811c8ce 12542
248ed943
RD
12543 Resets the orientation of the sizer.
12544 """
12545 return _core_.BoxSizer_SetOrientation(*args, **kwargs)
e811c8ce 12546
2bf58437 12547 Orientation = property(GetOrientation,SetOrientation,doc="See `GetOrientation` and `SetOrientation`")
2131d850 12548_core_.BoxSizer_swigregister(BoxSizer)
d14a1e28
RD
12549
12550#---------------------------------------------------------------------------
12551
12552class StaticBoxSizer(BoxSizer):
248ed943
RD
12553 """
12554 wx.StaticBoxSizer derives from and functions identically to the
12555 `wx.BoxSizer` and adds a `wx.StaticBox` around the items that the sizer
12556 manages. Note that this static box must be created separately and
12557 passed to the sizer constructor.
12558 """
0085ce49
RD
12559 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12560 __repr__ = _swig_repr
12561 def __init__(self, *args, **kwargs):
248ed943
RD
12562 """
12563 __init__(self, StaticBox box, int orient=HORIZONTAL) -> StaticBoxSizer
12564
12565 Constructor. It takes an associated static box and the orientation
12566 *orient* as parameters - orient can be either of ``wx.VERTICAL`` or
12567 ``wx.HORIZONTAL``.
12568 """
0085ce49 12569 _core_.StaticBoxSizer_swiginit(self,_core_.new_StaticBoxSizer(*args, **kwargs))
d14a1e28 12570 self._setOORInfo(self)
e811c8ce
RD
12571
12572 def GetStaticBox(*args, **kwargs):
248ed943
RD
12573 """
12574 GetStaticBox(self) -> StaticBox
e811c8ce 12575
248ed943
RD
12576 Returns the static box associated with this sizer.
12577 """
12578 return _core_.StaticBoxSizer_GetStaticBox(*args, **kwargs)
e811c8ce 12579
33d6fd3b 12580 StaticBox = property(GetStaticBox,doc="See `GetStaticBox`")
2131d850 12581_core_.StaticBoxSizer_swigregister(StaticBoxSizer)
d14a1e28
RD
12582
12583#---------------------------------------------------------------------------
12584
12585class GridSizer(Sizer):
248ed943
RD
12586 """
12587 A grid sizer is a sizer which lays out its children in a
12588 two-dimensional table with all cells having the same size. In other
12589 words, the width of each cell within the grid is the width of the
12590 widest item added to the sizer and the height of each grid cell is the
12591 height of the tallest item. An optional vertical and/or horizontal
12592 gap between items can also be specified (in pixels.)
12593
12594 Items are placed in the cells of the grid in the order they are added,
12595 in row-major order. In other words, the first row is filled first,
12596 then the second, and so on until all items have been added. (If
12597 neccessary, additional rows will be added as items are added.) If you
12598 need to have greater control over the cells that items are placed in
12599 then use the `wx.GridBagSizer`.
12600
12601 """
0085ce49
RD
12602 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12603 __repr__ = _swig_repr
12604 def __init__(self, *args, **kwargs):
248ed943
RD
12605 """
12606 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> GridSizer
12607
12608 Constructor for a wx.GridSizer. *rows* and *cols* determine the number
12609 of columns and rows in the sizer - if either of the parameters is
12610 zero, it will be calculated to from the total number of children in
12611 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
12612 define extra space between all children.
12613 """
0085ce49 12614 _core_.GridSizer_swiginit(self,_core_.new_GridSizer(*args, **kwargs))
d14a1e28 12615 self._setOORInfo(self)
e811c8ce 12616
e811c8ce 12617 def SetCols(*args, **kwargs):
248ed943
RD
12618 """
12619 SetCols(self, int cols)
12620
12621 Sets the number of columns in the sizer.
12622 """
54f9ee45 12623 return _core_.GridSizer_SetCols(*args, **kwargs)
e811c8ce
RD
12624
12625 def SetRows(*args, **kwargs):
248ed943
RD
12626 """
12627 SetRows(self, int rows)
12628
12629 Sets the number of rows in the sizer.
12630 """
54f9ee45 12631 return _core_.GridSizer_SetRows(*args, **kwargs)
e811c8ce
RD
12632
12633 def SetVGap(*args, **kwargs):
248ed943
RD
12634 """
12635 SetVGap(self, int gap)
12636
12637 Sets the vertical gap (in pixels) between the cells in the sizer.
12638 """
54f9ee45 12639 return _core_.GridSizer_SetVGap(*args, **kwargs)
e811c8ce
RD
12640
12641 def SetHGap(*args, **kwargs):
248ed943
RD
12642 """
12643 SetHGap(self, int gap)
12644
12645 Sets the horizontal gap (in pixels) between cells in the sizer
12646 """
54f9ee45 12647 return _core_.GridSizer_SetHGap(*args, **kwargs)
e811c8ce
RD
12648
12649 def GetCols(*args, **kwargs):
248ed943
RD
12650 """
12651 GetCols(self) -> int
12652
12653 Returns the number of columns in the sizer.
12654 """
54f9ee45 12655 return _core_.GridSizer_GetCols(*args, **kwargs)
e811c8ce
RD
12656
12657 def GetRows(*args, **kwargs):
248ed943
RD
12658 """
12659 GetRows(self) -> int
12660
12661 Returns the number of rows in the sizer.
12662 """
54f9ee45 12663 return _core_.GridSizer_GetRows(*args, **kwargs)
e811c8ce
RD
12664
12665 def GetVGap(*args, **kwargs):
248ed943
RD
12666 """
12667 GetVGap(self) -> int
12668
12669 Returns the vertical gap (in pixels) between the cells in the sizer.
12670 """
54f9ee45 12671 return _core_.GridSizer_GetVGap(*args, **kwargs)
e811c8ce
RD
12672
12673 def GetHGap(*args, **kwargs):
248ed943
RD
12674 """
12675 GetHGap(self) -> int
12676
12677 Returns the horizontal gap (in pixels) between cells in the sizer.
12678 """
54f9ee45 12679 return _core_.GridSizer_GetHGap(*args, **kwargs)
e811c8ce 12680
0085ce49
RD
12681 def CalcRowsCols(self):
12682 """
12683 CalcRowsCols() -> (rows, cols)
12684
12685 Calculates how many rows and columns will be in the sizer based
12686 on the current number of items and also the rows, cols specified
12687 in the constructor.
12688 """
12689 nitems = len(self.GetChildren())
12690 rows = self.GetRows()
12691 cols = self.GetCols()
12692 assert rows != 0 or cols != 0, "Grid sizer must have either rows or columns fixed"
12693 if cols != 0:
12694 rows = (nitems + cols - 1) / cols
12695 elif rows != 0:
12696 cols = (nitems + rows - 1) / rows
12697 return (rows, cols)
d14a1e28 12698
97ab0f6a
RD
12699 Cols = property(GetCols,SetCols,doc="See `GetCols` and `SetCols`")
12700 HGap = property(GetHGap,SetHGap,doc="See `GetHGap` and `SetHGap`")
12701 Rows = property(GetRows,SetRows,doc="See `GetRows` and `SetRows`")
12702 VGap = property(GetVGap,SetVGap,doc="See `GetVGap` and `SetVGap`")
2131d850 12703_core_.GridSizer_swigregister(GridSizer)
d14a1e28
RD
12704
12705#---------------------------------------------------------------------------
12706
54f9ee45
RD
12707FLEX_GROWMODE_NONE = _core_.FLEX_GROWMODE_NONE
12708FLEX_GROWMODE_SPECIFIED = _core_.FLEX_GROWMODE_SPECIFIED
12709FLEX_GROWMODE_ALL = _core_.FLEX_GROWMODE_ALL
d14a1e28 12710class FlexGridSizer(GridSizer):
248ed943
RD
12711 """
12712 A flex grid sizer is a sizer which lays out its children in a
12713 two-dimensional table with all table cells in one row having the same
12714 height and all cells in one column having the same width, but all
12715 rows or all columns are not necessarily the same height or width as in
12716 the `wx.GridSizer`.
12717
12718 wx.FlexGridSizer can also size items equally in one direction but
12719 unequally ("flexibly") in the other. If the sizer is only flexible
12720 in one direction (this can be changed using `SetFlexibleDirection`), it
12721 needs to be decided how the sizer should grow in the other ("non
12722 flexible") direction in order to fill the available space. The
12723 `SetNonFlexibleGrowMode` method serves this purpose.
12724
12725
12726 """
0085ce49
RD
12727 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12728 __repr__ = _swig_repr
12729 def __init__(self, *args, **kwargs):
248ed943
RD
12730 """
12731 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> FlexGridSizer
12732
12733 Constructor for a wx.FlexGridSizer. *rows* and *cols* determine the
12734 number of columns and rows in the sizer - if either of the parameters
12735 is zero, it will be calculated to from the total number of children in
12736 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
12737 define extra space between all children.
12738 """
0085ce49 12739 _core_.FlexGridSizer_swiginit(self,_core_.new_FlexGridSizer(*args, **kwargs))
d14a1e28 12740 self._setOORInfo(self)
e811c8ce 12741
248ed943
RD
12742 def AddGrowableRow(*args, **kwargs):
12743 """
12744 AddGrowableRow(self, size_t idx, int proportion=0)
e811c8ce 12745
248ed943
RD
12746 Specifies that row *idx* (starting from zero) should be grown if there
12747 is extra space available to the sizer.
e811c8ce 12748
248ed943
RD
12749 The *proportion* parameter has the same meaning as the stretch factor
12750 for the box sizers except that if all proportions are 0, then all
12751 columns are resized equally (instead of not being resized at all).
12752 """
54f9ee45 12753 return _core_.FlexGridSizer_AddGrowableRow(*args, **kwargs)
e811c8ce
RD
12754
12755 def RemoveGrowableRow(*args, **kwargs):
248ed943
RD
12756 """
12757 RemoveGrowableRow(self, size_t idx)
12758
12759 Specifies that row *idx* is no longer growable.
12760 """
54f9ee45 12761 return _core_.FlexGridSizer_RemoveGrowableRow(*args, **kwargs)
e811c8ce
RD
12762
12763 def AddGrowableCol(*args, **kwargs):
248ed943
RD
12764 """
12765 AddGrowableCol(self, size_t idx, int proportion=0)
12766
12767 Specifies that column *idx* (starting from zero) should be grown if
12768 there is extra space available to the sizer.
12769
12770 The *proportion* parameter has the same meaning as the stretch factor
12771 for the box sizers except that if all proportions are 0, then all
12772 columns are resized equally (instead of not being resized at all).
12773 """
54f9ee45 12774 return _core_.FlexGridSizer_AddGrowableCol(*args, **kwargs)
e811c8ce
RD
12775
12776 def RemoveGrowableCol(*args, **kwargs):
248ed943
RD
12777 """
12778 RemoveGrowableCol(self, size_t idx)
12779
12780 Specifies that column *idx* is no longer growable.
12781 """
54f9ee45 12782 return _core_.FlexGridSizer_RemoveGrowableCol(*args, **kwargs)
e811c8ce
RD
12783
12784 def SetFlexibleDirection(*args, **kwargs):
248ed943
RD
12785 """
12786 SetFlexibleDirection(self, int direction)
12787
12788 Specifies whether the sizer should flexibly resize its columns, rows,
12789 or both. Argument *direction* can be one of the following values. Any
12790 other value is ignored.
12791
12792 ============== =======================================
12793 wx.VERTICAL Rows are flexibly sized.
12794 wx.HORIZONTAL Columns are flexibly sized.
12795 wx.BOTH Both rows and columns are flexibly sized
12796 (this is the default value).
12797 ============== =======================================
12798
12799 Note that this method does not trigger relayout.
12800
12801 """
54f9ee45 12802 return _core_.FlexGridSizer_SetFlexibleDirection(*args, **kwargs)
e811c8ce
RD
12803
12804 def GetFlexibleDirection(*args, **kwargs):
248ed943
RD
12805 """
12806 GetFlexibleDirection(self) -> int
12807
12808 Returns a value that specifies whether the sizer
12809 flexibly resizes its columns, rows, or both (default).
12810
12811 :see: `SetFlexibleDirection`
12812 """
54f9ee45 12813 return _core_.FlexGridSizer_GetFlexibleDirection(*args, **kwargs)
e811c8ce
RD
12814
12815 def SetNonFlexibleGrowMode(*args, **kwargs):
248ed943
RD
12816 """
12817 SetNonFlexibleGrowMode(self, int mode)
12818
12819 Specifies how the sizer should grow in the non-flexible direction if
12820 there is one (so `SetFlexibleDirection` must have been called
12821 previously). Argument *mode* can be one of the following values:
12822
12823 ========================== =================================================
12824 wx.FLEX_GROWMODE_NONE Sizer doesn't grow in the non flexible direction.
12825 wx.FLEX_GROWMODE_SPECIFIED Sizer honors growable columns/rows set with
12826 `AddGrowableCol` and `AddGrowableRow`. In this
12827 case equal sizing applies to minimum sizes of
12828 columns or rows (this is the default value).
12829 wx.FLEX_GROWMODE_ALL Sizer equally stretches all columns or rows in
12830 the non flexible direction, whether they are
12831 growable or not in the flexbile direction.
12832 ========================== =================================================
12833
12834 Note that this method does not trigger relayout.
248ed943 12835 """
54f9ee45 12836 return _core_.FlexGridSizer_SetNonFlexibleGrowMode(*args, **kwargs)
e811c8ce
RD
12837
12838 def GetNonFlexibleGrowMode(*args, **kwargs):
248ed943
RD
12839 """
12840 GetNonFlexibleGrowMode(self) -> int
12841
12842 Returns the value that specifies how the sizer grows in the
12843 non-flexible direction if there is one.
12844
12845 :see: `SetNonFlexibleGrowMode`
12846 """
54f9ee45 12847 return _core_.FlexGridSizer_GetNonFlexibleGrowMode(*args, **kwargs)
e811c8ce
RD
12848
12849 def GetRowHeights(*args, **kwargs):
fd2dc343
RD
12850 """
12851 GetRowHeights(self) -> list
12852
12853 Returns a list of integers representing the heights of each of the
12854 rows in the sizer.
12855 """
54f9ee45 12856 return _core_.FlexGridSizer_GetRowHeights(*args, **kwargs)
e811c8ce
RD
12857
12858 def GetColWidths(*args, **kwargs):
fd2dc343
RD
12859 """
12860 GetColWidths(self) -> list
12861
12862 Returns a list of integers representing the widths of each of the
12863 columns in the sizer.
12864 """
54f9ee45 12865 return _core_.FlexGridSizer_GetColWidths(*args, **kwargs)
e811c8ce 12866
97ab0f6a
RD
12867 ColWidths = property(GetColWidths,doc="See `GetColWidths`")
12868 FlexibleDirection = property(GetFlexibleDirection,SetFlexibleDirection,doc="See `GetFlexibleDirection` and `SetFlexibleDirection`")
12869 NonFlexibleGrowMode = property(GetNonFlexibleGrowMode,SetNonFlexibleGrowMode,doc="See `GetNonFlexibleGrowMode` and `SetNonFlexibleGrowMode`")
12870 RowHeights = property(GetRowHeights,doc="See `GetRowHeights`")
2131d850 12871_core_.FlexGridSizer_swigregister(FlexGridSizer)
d14a1e28 12872
e505d15e
RD
12873class StdDialogButtonSizer(BoxSizer):
12874 """
12875 A special sizer that knows how to order and position standard buttons
12876 in order to conform to the current platform's standards. You simply
12877 need to add each `wx.Button` to the sizer, and be sure to create the
53aa7709 12878 buttons using the standard ID's. Then call `Realize` and the sizer
e505d15e
RD
12879 will take care of the rest.
12880
12881 """
0085ce49
RD
12882 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12883 __repr__ = _swig_repr
12884 def __init__(self, *args, **kwargs):
e505d15e 12885 """__init__(self) -> StdDialogButtonSizer"""
0085ce49 12886 _core_.StdDialogButtonSizer_swiginit(self,_core_.new_StdDialogButtonSizer(*args, **kwargs))
e505d15e
RD
12887 def AddButton(*args, **kwargs):
12888 """
12889 AddButton(self, wxButton button)
12890
12891 Use this to add the buttons to this sizer. Do not use the `Add`
12892 method in the base class.
12893 """
12894 return _core_.StdDialogButtonSizer_AddButton(*args, **kwargs)
12895
53aa7709 12896 def Realize(*args, **kwargs):
e505d15e 12897 """
53aa7709 12898 Realize(self)
e505d15e
RD
12899
12900 This funciton needs to be called after all the buttons have been added
12901 to the sizer. It will reorder them and position them in a platform
12902 specifc manner.
12903 """
53aa7709 12904 return _core_.StdDialogButtonSizer_Realize(*args, **kwargs)
51b83b37
RD
12905
12906 def SetAffirmativeButton(*args, **kwargs):
12907 """SetAffirmativeButton(self, wxButton button)"""
12908 return _core_.StdDialogButtonSizer_SetAffirmativeButton(*args, **kwargs)
12909
12910 def SetNegativeButton(*args, **kwargs):
12911 """SetNegativeButton(self, wxButton button)"""
12912 return _core_.StdDialogButtonSizer_SetNegativeButton(*args, **kwargs)
12913
12914 def SetCancelButton(*args, **kwargs):
12915 """SetCancelButton(self, wxButton button)"""
12916 return _core_.StdDialogButtonSizer_SetCancelButton(*args, **kwargs)
e505d15e
RD
12917
12918 def GetAffirmativeButton(*args, **kwargs):
12919 """GetAffirmativeButton(self) -> wxButton"""
12920 return _core_.StdDialogButtonSizer_GetAffirmativeButton(*args, **kwargs)
12921
12922 def GetApplyButton(*args, **kwargs):
12923 """GetApplyButton(self) -> wxButton"""
12924 return _core_.StdDialogButtonSizer_GetApplyButton(*args, **kwargs)
12925
12926 def GetNegativeButton(*args, **kwargs):
12927 """GetNegativeButton(self) -> wxButton"""
12928 return _core_.StdDialogButtonSizer_GetNegativeButton(*args, **kwargs)
12929
12930 def GetCancelButton(*args, **kwargs):
12931 """GetCancelButton(self) -> wxButton"""
12932 return _core_.StdDialogButtonSizer_GetCancelButton(*args, **kwargs)
12933
12934 def GetHelpButton(*args, **kwargs):
12935 """GetHelpButton(self) -> wxButton"""
12936 return _core_.StdDialogButtonSizer_GetHelpButton(*args, **kwargs)
12937
33d6fd3b
RD
12938 AffirmativeButton = property(GetAffirmativeButton,SetAffirmativeButton,doc="See `GetAffirmativeButton` and `SetAffirmativeButton`")
12939 ApplyButton = property(GetApplyButton,doc="See `GetApplyButton`")
12940 CancelButton = property(GetCancelButton,SetCancelButton,doc="See `GetCancelButton` and `SetCancelButton`")
12941 HelpButton = property(GetHelpButton,doc="See `GetHelpButton`")
12942 NegativeButton = property(GetNegativeButton,SetNegativeButton,doc="See `GetNegativeButton` and `SetNegativeButton`")
2131d850 12943_core_.StdDialogButtonSizer_swigregister(StdDialogButtonSizer)
e505d15e 12944
d14a1e28
RD
12945#---------------------------------------------------------------------------
12946
12947class GBPosition(object):
248ed943
RD
12948 """
12949 This class represents the position of an item in a virtual grid of
12950 rows and columns managed by a `wx.GridBagSizer`. wxPython has
12951 typemaps that will automatically convert from a 2-element sequence of
12952 integers to a wx.GBPosition, so you can use the more pythonic
12953 representation of the position nearly transparently in Python code.
12954 """
0085ce49
RD
12955 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12956 __repr__ = _swig_repr
12957 def __init__(self, *args, **kwargs):
248ed943
RD
12958 """
12959 __init__(self, int row=0, int col=0) -> GBPosition
12960
12961 This class represents the position of an item in a virtual grid of
12962 rows and columns managed by a `wx.GridBagSizer`. wxPython has
12963 typemaps that will automatically convert from a 2-element sequence of
12964 integers to a wx.GBPosition, so you can use the more pythonic
12965 representation of the position nearly transparently in Python code.
12966 """
0085ce49
RD
12967 _core_.GBPosition_swiginit(self,_core_.new_GBPosition(*args, **kwargs))
12968 __swig_destroy__ = _core_.delete_GBPosition
12969 __del__ = lambda self : None;
e811c8ce 12970 def GetRow(*args, **kwargs):
a95a7133 12971 """GetRow(self) -> int"""
54f9ee45 12972 return _core_.GBPosition_GetRow(*args, **kwargs)
e811c8ce
RD
12973
12974 def GetCol(*args, **kwargs):
a95a7133 12975 """GetCol(self) -> int"""
54f9ee45 12976 return _core_.GBPosition_GetCol(*args, **kwargs)
e811c8ce
RD
12977
12978 def SetRow(*args, **kwargs):
a95a7133 12979 """SetRow(self, int row)"""
54f9ee45 12980 return _core_.GBPosition_SetRow(*args, **kwargs)
e811c8ce
RD
12981
12982 def SetCol(*args, **kwargs):
a95a7133 12983 """SetCol(self, int col)"""
54f9ee45 12984 return _core_.GBPosition_SetCol(*args, **kwargs)
e811c8ce
RD
12985
12986 def __eq__(*args, **kwargs):
e9d6f3a4
RD
12987 """
12988 __eq__(self, PyObject other) -> bool
12989
12990 Compare GBPosition for equality.
12991 """
54f9ee45 12992 return _core_.GBPosition___eq__(*args, **kwargs)
e811c8ce
RD
12993
12994 def __ne__(*args, **kwargs):
e9d6f3a4
RD
12995 """
12996 __ne__(self, PyObject other) -> bool
12997
12998 Compare GBPosition for inequality.
12999 """
54f9ee45 13000 return _core_.GBPosition___ne__(*args, **kwargs)
e811c8ce
RD
13001
13002 def Set(*args, **kwargs):
a95a7133 13003 """Set(self, int row=0, int col=0)"""
54f9ee45 13004 return _core_.GBPosition_Set(*args, **kwargs)
e811c8ce
RD
13005
13006 def Get(*args, **kwargs):
a95a7133 13007 """Get(self) -> PyObject"""
54f9ee45 13008 return _core_.GBPosition_Get(*args, **kwargs)
e811c8ce 13009
41e2b43e 13010 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
e811c8ce
RD
13011 def __str__(self): return str(self.Get())
13012 def __repr__(self): return 'wx.GBPosition'+str(self.Get())
13013 def __len__(self): return len(self.Get())
13014 def __getitem__(self, index): return self.Get()[index]
d14a1e28
RD
13015 def __setitem__(self, index, val):
13016 if index == 0: self.SetRow(val)
13017 elif index == 1: self.SetCol(val)
13018 else: raise IndexError
e811c8ce 13019 def __nonzero__(self): return self.Get() != (0,0)
74e96f3d
RD
13020 __safe_for_unpickling__ = True
13021 def __reduce__(self): return (wx.GBPosition, self.Get())
d14a1e28
RD
13022
13023 row = property(GetRow, SetRow)
13024 col = property(GetCol, SetCol)
13025
2131d850 13026_core_.GBPosition_swigregister(GBPosition)
d14a1e28
RD
13027
13028class GBSpan(object):
248ed943
RD
13029 """
13030 This class is used to hold the row and column spanning attributes of
13031 items in a `wx.GridBagSizer`. wxPython has typemaps that will
13032 automatically convert from a 2-element sequence of integers to a
13033 wx.GBSpan, so you can use the more pythonic representation of the span
13034 nearly transparently in Python code.
13035
13036 """
0085ce49
RD
13037 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
13038 __repr__ = _swig_repr
13039 def __init__(self, *args, **kwargs):
248ed943
RD
13040 """
13041 __init__(self, int rowspan=1, int colspan=1) -> GBSpan
13042
13043 Construct a new wxGBSpan, optionally setting the rowspan and
13044 colspan. The default is (1,1). (Meaning that the item occupies one
13045 cell in each direction.
13046 """
0085ce49
RD
13047 _core_.GBSpan_swiginit(self,_core_.new_GBSpan(*args, **kwargs))
13048 __swig_destroy__ = _core_.delete_GBSpan
13049 __del__ = lambda self : None;
e811c8ce 13050 def GetRowspan(*args, **kwargs):
a95a7133 13051 """GetRowspan(self) -> int"""
54f9ee45 13052 return _core_.GBSpan_GetRowspan(*args, **kwargs)
e811c8ce
RD
13053
13054 def GetColspan(*args, **kwargs):
a95a7133 13055 """GetColspan(self) -> int"""
54f9ee45 13056 return _core_.GBSpan_GetColspan(*args, **kwargs)
e811c8ce
RD
13057
13058 def SetRowspan(*args, **kwargs):
a95a7133 13059 """SetRowspan(self, int rowspan)"""
54f9ee45 13060 return _core_.GBSpan_SetRowspan(*args, **kwargs)
e811c8ce
RD
13061
13062 def SetColspan(*args, **kwargs):
a95a7133 13063 """SetColspan(self, int colspan)"""
54f9ee45 13064 return _core_.GBSpan_SetColspan(*args, **kwargs)
e811c8ce
RD
13065
13066 def __eq__(*args, **kwargs):
e9d6f3a4
RD
13067 """
13068 __eq__(self, PyObject other) -> bool
13069
13070 Compare wxGBSpan for equality.
13071 """
54f9ee45 13072 return _core_.GBSpan___eq__(*args, **kwargs)
e811c8ce
RD
13073
13074 def __ne__(*args, **kwargs):
e9d6f3a4
RD
13075 """
13076 __ne__(self, PyObject other) -> bool
13077
13078 Compare GBSpan for inequality.
13079 """
54f9ee45 13080 return _core_.GBSpan___ne__(*args, **kwargs)
e811c8ce
RD
13081
13082 def Set(*args, **kwargs):
a95a7133 13083 """Set(self, int rowspan=1, int colspan=1)"""
54f9ee45 13084 return _core_.GBSpan_Set(*args, **kwargs)
e811c8ce
RD
13085
13086 def Get(*args, **kwargs):
a95a7133 13087 """Get(self) -> PyObject"""
54f9ee45 13088 return _core_.GBSpan_Get(*args, **kwargs)
e811c8ce 13089
41e2b43e 13090 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
e811c8ce
RD
13091 def __str__(self): return str(self.Get())
13092 def __repr__(self): return 'wx.GBSpan'+str(self.Get())
13093 def __len__(self): return len(self.Get())
13094 def __getitem__(self, index): return self.Get()[index]
d14a1e28
RD
13095 def __setitem__(self, index, val):
13096 if index == 0: self.SetRowspan(val)
13097 elif index == 1: self.SetColspan(val)
13098 else: raise IndexError
e811c8ce 13099 def __nonzero__(self): return self.Get() != (0,0)
74e96f3d
RD
13100 __safe_for_unpickling__ = True
13101 def __reduce__(self): return (wx.GBSpan, self.Get())
d14a1e28
RD
13102
13103 rowspan = property(GetRowspan, SetRowspan)
13104 colspan = property(GetColspan, SetColspan)
13105
2131d850 13106_core_.GBSpan_swigregister(GBSpan)
d14a1e28
RD
13107
13108class GBSizerItem(SizerItem):
248ed943
RD
13109 """
13110 The wx.GBSizerItem class is used to track the additional data about
13111 items in a `wx.GridBagSizer` such as the item's position in the grid
13112 and how many rows or columns it spans.
13113
13114 """
0085ce49
RD
13115 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
13116 __repr__ = _swig_repr
13117 def __init__(self, *args, **kwargs):
248ed943
RD
13118 """
13119 __init__(self) -> GBSizerItem
13120
13121 Constructs an empty wx.GBSizerItem. Either a window, sizer or spacer
13122 size will need to be set, as well as a position and span before this
13123 item can be used in a Sizer.
13124
13125 You will probably never need to create a wx.GBSizerItem directly as they
13126 are created automatically when the sizer's Add method is called.
13127 """
0085ce49
RD
13128 _core_.GBSizerItem_swiginit(self,_core_.new_GBSizerItem(*args, **kwargs))
13129 __swig_destroy__ = _core_.delete_GBSizerItem
13130 __del__ = lambda self : None;
e811c8ce 13131 def GetPos(*args, **kwargs):
248ed943
RD
13132 """
13133 GetPos(self) -> GBPosition
13134
13135 Get the grid position of the item
13136 """
54f9ee45 13137 return _core_.GBSizerItem_GetPos(*args, **kwargs)
e811c8ce
RD
13138
13139 def GetPosTuple(self): return self.GetPos().Get()
13140 def GetSpan(*args, **kwargs):
248ed943
RD
13141 """
13142 GetSpan(self) -> GBSpan
13143
13144 Get the row and column spanning of the item
13145 """
54f9ee45 13146 return _core_.GBSizerItem_GetSpan(*args, **kwargs)
e811c8ce
RD
13147
13148 def GetSpanTuple(self): return self.GetSpan().Get()
13149 def SetPos(*args, **kwargs):
248ed943
RD
13150 """
13151 SetPos(self, GBPosition pos) -> bool
13152
13153 If the item is already a member of a sizer then first ensure that
13154 there is no other item that would intersect with this one at the new
13155 position, then set the new position. Returns True if the change is
13156 successful and after the next Layout() the item will be moved.
13157 """
54f9ee45 13158 return _core_.GBSizerItem_SetPos(*args, **kwargs)
e811c8ce
RD
13159
13160 def SetSpan(*args, **kwargs):
248ed943
RD
13161 """
13162 SetSpan(self, GBSpan span) -> bool
13163
13164 If the item is already a member of a sizer then first ensure that
13165 there is no other item that would intersect with this one with its new
13166 spanning size, then set the new spanning. Returns True if the change
13167 is successful and after the next Layout() the item will be resized.
13168
13169 """
54f9ee45 13170 return _core_.GBSizerItem_SetSpan(*args, **kwargs)
e811c8ce 13171
248ed943 13172 def Intersects(*args, **kwargs):
0df68c9f 13173 """
a95a7133 13174 Intersects(self, GBSizerItem other) -> bool
248ed943
RD
13175
13176 Returns True if this item and the other item instersect.
0df68c9f 13177 """
248ed943
RD
13178 return _core_.GBSizerItem_Intersects(*args, **kwargs)
13179
13180 def IntersectsPos(*args, **kwargs):
13181 """
13182 IntersectsPos(self, GBPosition pos, GBSpan span) -> bool
13183
13184 Returns True if the given pos/span would intersect with this item.
13185 """
13186 return _core_.GBSizerItem_IntersectsPos(*args, **kwargs)
e811c8ce
RD
13187
13188 def GetEndPos(*args, **kwargs):
248ed943
RD
13189 """
13190 GetEndPos(self) -> GBPosition
13191
13192 Get the row and column of the endpoint of this item.
13193 """
54f9ee45 13194 return _core_.GBSizerItem_GetEndPos(*args, **kwargs)
e811c8ce
RD
13195
13196 def GetGBSizer(*args, **kwargs):
248ed943
RD
13197 """
13198 GetGBSizer(self) -> GridBagSizer
13199
13200 Get the sizer this item is a member of.
13201 """
54f9ee45 13202 return _core_.GBSizerItem_GetGBSizer(*args, **kwargs)
e811c8ce
RD
13203
13204 def SetGBSizer(*args, **kwargs):
248ed943
RD
13205 """
13206 SetGBSizer(self, GridBagSizer sizer)
13207
13208 Set the sizer this item is a member of.
13209 """
54f9ee45 13210 return _core_.GBSizerItem_SetGBSizer(*args, **kwargs)
e811c8ce 13211
97ab0f6a
RD
13212 EndPos = property(GetEndPos,doc="See `GetEndPos`")
13213 GBSizer = property(GetGBSizer,SetGBSizer,doc="See `GetGBSizer` and `SetGBSizer`")
13214 Pos = property(GetPos,SetPos,doc="See `GetPos` and `SetPos`")
13215 Span = property(GetSpan,SetSpan,doc="See `GetSpan` and `SetSpan`")
2131d850 13216_core_.GBSizerItem_swigregister(GBSizerItem)
d14a1e28
RD
13217DefaultSpan = cvar.DefaultSpan
13218
13219def GBSizerItemWindow(*args, **kwargs):
0df68c9f
RD
13220 """
13221 GBSizerItemWindow(Window window, GBPosition pos, GBSpan span, int flag,
248ed943
RD
13222 int border, PyObject userData=None) -> GBSizerItem
13223
13224 Construct a `wx.GBSizerItem` for a window.
0df68c9f 13225 """
54f9ee45 13226 val = _core_.new_GBSizerItemWindow(*args, **kwargs)
d14a1e28
RD
13227 return val
13228
13229def GBSizerItemSizer(*args, **kwargs):
0df68c9f
RD
13230 """
13231 GBSizerItemSizer(Sizer sizer, GBPosition pos, GBSpan span, int flag,
248ed943
RD
13232 int border, PyObject userData=None) -> GBSizerItem
13233
13234 Construct a `wx.GBSizerItem` for a sizer
0df68c9f 13235 """
54f9ee45 13236 val = _core_.new_GBSizerItemSizer(*args, **kwargs)
d14a1e28
RD
13237 return val
13238
13239def GBSizerItemSpacer(*args, **kwargs):
0df68c9f
RD
13240 """
13241 GBSizerItemSpacer(int width, int height, GBPosition pos, GBSpan span,
248ed943
RD
13242 int flag, int border, PyObject userData=None) -> GBSizerItem
13243
13244 Construct a `wx.GBSizerItem` for a spacer.
0df68c9f 13245 """
54f9ee45 13246 val = _core_.new_GBSizerItemSpacer(*args, **kwargs)
d14a1e28
RD
13247 return val
13248
13249class GridBagSizer(FlexGridSizer):
248ed943
RD
13250 """
13251 A `wx.Sizer` that can lay out items in a virtual grid like a
13252 `wx.FlexGridSizer` but in this case explicit positioning of the items
13253 is allowed using `wx.GBPosition`, and items can optionally span more
13254 than one row and/or column using `wx.GBSpan`. The total size of the
13255 virtual grid is determined by the largest row and column that items are
13256 positioned at, adjusted for spanning.
13257
13258 """
0085ce49
RD
13259 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
13260 __repr__ = _swig_repr
13261 def __init__(self, *args, **kwargs):
248ed943
RD
13262 """
13263 __init__(self, int vgap=0, int hgap=0) -> GridBagSizer
13264
13265 Constructor, with optional parameters to specify the gap between the
13266 rows and columns.
13267 """
0085ce49 13268 _core_.GridBagSizer_swiginit(self,_core_.new_GridBagSizer(*args, **kwargs))
1823fbb4
RD
13269 self._setOORInfo(self)
13270
e811c8ce 13271 def Add(*args, **kwargs):
0df68c9f 13272 """
248ed943 13273 Add(self, item, GBPosition pos, GBSpan span=DefaultSpan, int flag=0,
d3b6e4ff 13274 int border=0, userData=None) -> wx.GBSizerItem
248ed943
RD
13275
13276 Adds an item to the sizer at the grid cell *pos*, optionally spanning
13277 more than one row or column as specified with *span*. The remaining
13278 args behave similarly to `wx.Sizer.Add`.
13279
13280 Returns True if the item was successfully placed at the given cell
13281 position, False if something was already there.
13282
0df68c9f 13283 """
54f9ee45 13284 return _core_.GridBagSizer_Add(*args, **kwargs)
e811c8ce
RD
13285
13286 def AddItem(*args, **kwargs):
248ed943 13287 """
d3b6e4ff 13288 Add(self, GBSizerItem item) -> wx.GBSizerItem
248ed943
RD
13289
13290 Add an item to the sizer using a `wx.GBSizerItem`. Returns True if
13291 the item was successfully placed at its given cell position, False if
13292 something was already there.
13293 """
54f9ee45 13294 return _core_.GridBagSizer_AddItem(*args, **kwargs)
e811c8ce 13295
84f85550
RD
13296 def GetCellSize(*args, **kwargs):
13297 """
13298 GetCellSize(self, int row, int col) -> Size
13299
13300 Get the size of the specified cell, including hgap and
13301 vgap. Only valid after a Layout.
13302 """
13303 return _core_.GridBagSizer_GetCellSize(*args, **kwargs)
13304
e811c8ce 13305 def GetEmptyCellSize(*args, **kwargs):
248ed943
RD
13306 """
13307 GetEmptyCellSize(self) -> Size
13308
13309 Get the size used for cells in the grid with no item.
13310 """
54f9ee45 13311 return _core_.GridBagSizer_GetEmptyCellSize(*args, **kwargs)
e811c8ce
RD
13312
13313 def SetEmptyCellSize(*args, **kwargs):
248ed943
RD
13314 """
13315 SetEmptyCellSize(self, Size sz)
13316
13317 Set the size used for cells in the grid with no item.
13318 """
54f9ee45 13319 return _core_.GridBagSizer_SetEmptyCellSize(*args, **kwargs)
e811c8ce
RD
13320
13321 def GetItemPosition(*args):
0df68c9f 13322 """
248ed943
RD
13323 GetItemPosition(self, item) -> GBPosition
13324
13325 Get the grid position of the specified *item* where *item* is either a
13326 window or subsizer that is a member of this sizer, or a zero-based
13327 index of an item.
0df68c9f 13328 """
54f9ee45 13329 return _core_.GridBagSizer_GetItemPosition(*args)
e811c8ce
RD
13330
13331 def SetItemPosition(*args):
0df68c9f 13332 """
248ed943
RD
13333 SetItemPosition(self, item, GBPosition pos) -> bool
13334
13335 Set the grid position of the specified *item* where *item* is either a
13336 window or subsizer that is a member of this sizer, or a zero-based
13337 index of an item. Returns True on success. If the move is not
13338 allowed (because an item is already there) then False is returned.
13339
0df68c9f 13340 """
54f9ee45 13341 return _core_.GridBagSizer_SetItemPosition(*args)
e811c8ce
RD
13342
13343 def GetItemSpan(*args):
0df68c9f 13344 """
248ed943
RD
13345 GetItemSpan(self, item) -> GBSpan
13346
13347 Get the row/col spanning of the specified *item* where *item* is
13348 either a window or subsizer that is a member of this sizer, or a
13349 zero-based index of an item.
0df68c9f 13350 """
54f9ee45 13351 return _core_.GridBagSizer_GetItemSpan(*args)
e811c8ce
RD
13352
13353 def SetItemSpan(*args):
0df68c9f 13354 """
248ed943
RD
13355 SetItemSpan(self, item, GBSpan span) -> bool
13356
13357 Set the row/col spanning of the specified *item* where *item* is
13358 either a window or subsizer that is a member of this sizer, or a
13359 zero-based index of an item. Returns True on success. If the move is
13360 not allowed (because an item is already there) then False is returned.
0df68c9f 13361 """
54f9ee45 13362 return _core_.GridBagSizer_SetItemSpan(*args)
e811c8ce
RD
13363
13364 def FindItem(*args):
0df68c9f 13365 """
248ed943
RD
13366 FindItem(self, item) -> GBSizerItem
13367
13368 Find the sizer item for the given window or subsizer, returns None if
13369 not found. (non-recursive)
0df68c9f 13370 """
54f9ee45 13371 return _core_.GridBagSizer_FindItem(*args)
e811c8ce 13372
b08d67c2
RD
13373 def GetItem(self, item):
13374 gbsi = None
13375 si = wx.FlexGridSizer.GetItem(self, item)
13376 if not si:
13377 return None
13378 if type(item) is not int:
13379 gbsi = self.FindItem(item)
13380 if gbsi: return gbsi
13381 return si
13382
e811c8ce 13383 def FindItemAtPosition(*args, **kwargs):
248ed943
RD
13384 """
13385 FindItemAtPosition(self, GBPosition pos) -> GBSizerItem
13386
13387 Return the sizer item for the given grid cell, or None if there is no
13388 item at that position. (non-recursive)
13389 """
54f9ee45 13390 return _core_.GridBagSizer_FindItemAtPosition(*args, **kwargs)
e811c8ce
RD
13391
13392 def FindItemAtPoint(*args, **kwargs):
248ed943
RD
13393 """
13394 FindItemAtPoint(self, Point pt) -> GBSizerItem
13395
13396 Return the sizer item located at the point given in *pt*, or None if
13397 there is no item at that point. The (x,y) coordinates in pt correspond
13398 to the client coordinates of the window using the sizer for
13399 layout. (non-recursive)
13400 """
54f9ee45 13401 return _core_.GridBagSizer_FindItemAtPoint(*args, **kwargs)
e811c8ce 13402
248ed943
RD
13403 def CheckForIntersection(*args, **kwargs):
13404 """
13405 CheckForIntersection(self, GBSizerItem item, GBSizerItem excludeItem=None) -> bool
e811c8ce 13406
248ed943
RD
13407 Look at all items and see if any intersect (or would overlap) the
13408 given *item*. Returns True if so, False if there would be no overlap.
13409 If an *excludeItem* is given then it will not be checked for
13410 intersection, for example it may be the item we are checking the
13411 position of.
e811c8ce 13412
248ed943
RD
13413 """
13414 return _core_.GridBagSizer_CheckForIntersection(*args, **kwargs)
e811c8ce 13415
248ed943 13416 def CheckForIntersectionPos(*args, **kwargs):
0df68c9f 13417 """
248ed943
RD
13418 CheckForIntersectionPos(self, GBPosition pos, GBSpan span, GBSizerItem excludeItem=None) -> bool
13419
13420 Look at all items and see if any intersect (or would overlap) the
13421 given position and span. Returns True if so, False if there would be
13422 no overlap. If an *excludeItem* is given then it will not be checked
13423 for intersection, for example it may be the item we are checking the
13424 position of.
0df68c9f 13425 """
248ed943 13426 return _core_.GridBagSizer_CheckForIntersectionPos(*args, **kwargs)
e811c8ce 13427
2131d850 13428_core_.GridBagSizer_swigregister(GridBagSizer)
d14a1e28
RD
13429
13430#---------------------------------------------------------------------------
13431
54f9ee45
RD
13432Left = _core_.Left
13433Top = _core_.Top
13434Right = _core_.Right
13435Bottom = _core_.Bottom
13436Width = _core_.Width
13437Height = _core_.Height
13438Centre = _core_.Centre
13439Center = _core_.Center
13440CentreX = _core_.CentreX
13441CentreY = _core_.CentreY
13442Unconstrained = _core_.Unconstrained
13443AsIs = _core_.AsIs
13444PercentOf = _core_.PercentOf
13445Above = _core_.Above
13446Below = _core_.Below
13447LeftOf = _core_.LeftOf
13448RightOf = _core_.RightOf
13449SameAs = _core_.SameAs
13450Absolute = _core_.Absolute
d14a1e28 13451class IndividualLayoutConstraint(Object):
15afbcd0 13452 """
41e2b43e
RD
13453 Objects of this class are stored in the `wx.LayoutConstraints` class as
13454 one of eight possible constraints that a window can be involved in.
13455 You will never need to create an instance of
13456 wx.IndividualLayoutConstraint, rather you should create a
13457 `wx.LayoutConstraints` instance and use the individual contstraints
15afbcd0 13458 that it contains.
15afbcd0 13459 """
0085ce49
RD
13460 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
13461 def __init__(self): raise AttributeError, "No constructor defined"
13462 __repr__ = _swig_repr
e811c8ce 13463 def Set(*args, **kwargs):
41e2b43e
RD
13464 """
13465 Set(self, int rel, Window otherW, int otherE, int val=0, int marg=wxLAYOUT_DEFAULT_MARGIN)
13466
13467 Sets the properties of the constraint. Normally called by one of the
13468 convenience functions such as Above, RightOf, SameAs.
13469 """
54f9ee45 13470 return _core_.IndividualLayoutConstraint_Set(*args, **kwargs)
e811c8ce
RD
13471
13472 def LeftOf(*args, **kwargs):
15afbcd0 13473 """
a95a7133 13474 LeftOf(self, Window sibling, int marg=0)
15afbcd0 13475
41e2b43e
RD
13476 Constrains this edge to be to the left of the given window, with an
13477 optional margin. Implicitly, this is relative to the left edge of the
13478 other window.
15afbcd0 13479 """
54f9ee45 13480 return _core_.IndividualLayoutConstraint_LeftOf(*args, **kwargs)
e811c8ce
RD
13481
13482 def RightOf(*args, **kwargs):
15afbcd0 13483 """
a95a7133 13484 RightOf(self, Window sibling, int marg=0)
15afbcd0 13485
41e2b43e
RD
13486 Constrains this edge to be to the right of the given window, with an
13487 optional margin. Implicitly, this is relative to the right edge of the
13488 other window.
15afbcd0 13489 """
54f9ee45 13490 return _core_.IndividualLayoutConstraint_RightOf(*args, **kwargs)
e811c8ce
RD
13491
13492 def Above(*args, **kwargs):
15afbcd0 13493 """
a95a7133 13494 Above(self, Window sibling, int marg=0)
15afbcd0 13495
41e2b43e
RD
13496 Constrains this edge to be above the given window, with an optional
13497 margin. Implicitly, this is relative to the top edge of the other
13498 window.
15afbcd0 13499 """
54f9ee45 13500 return _core_.IndividualLayoutConstraint_Above(*args, **kwargs)
e811c8ce
RD
13501
13502 def Below(*args, **kwargs):
15afbcd0 13503 """
a95a7133 13504 Below(self, Window sibling, int marg=0)
15afbcd0 13505
41e2b43e
RD
13506 Constrains this edge to be below the given window, with an optional
13507 margin. Implicitly, this is relative to the bottom edge of the other
13508 window.
15afbcd0 13509 """
54f9ee45 13510 return _core_.IndividualLayoutConstraint_Below(*args, **kwargs)
e811c8ce
RD
13511
13512 def SameAs(*args, **kwargs):
15afbcd0 13513 """
a95a7133 13514 SameAs(self, Window otherW, int edge, int marg=0)
15afbcd0 13515
41e2b43e
RD
13516 Constrains this edge or dimension to be to the same as the edge of the
13517 given window, with an optional margin.
15afbcd0 13518 """
54f9ee45 13519 return _core_.IndividualLayoutConstraint_SameAs(*args, **kwargs)
e811c8ce
RD
13520
13521 def PercentOf(*args, **kwargs):
15afbcd0 13522 """
a95a7133 13523 PercentOf(self, Window otherW, int wh, int per)
15afbcd0 13524
41e2b43e
RD
13525 Constrains this edge or dimension to be to a percentage of the given
13526 window, with an optional margin.
15afbcd0 13527 """
54f9ee45 13528 return _core_.IndividualLayoutConstraint_PercentOf(*args, **kwargs)
e811c8ce
RD
13529
13530 def Absolute(*args, **kwargs):
15afbcd0 13531 """
a95a7133 13532 Absolute(self, int val)
15afbcd0 13533
41e2b43e 13534 Constrains this edge or dimension to be the given absolute value.
15afbcd0 13535 """
54f9ee45 13536 return _core_.IndividualLayoutConstraint_Absolute(*args, **kwargs)
e811c8ce
RD
13537
13538 def Unconstrained(*args, **kwargs):
15afbcd0 13539 """
a95a7133 13540 Unconstrained(self)
15afbcd0 13541
41e2b43e
RD
13542 Sets this edge or dimension to be unconstrained, that is, dependent on
13543 other edges and dimensions from which this value can be deduced.
15afbcd0 13544 """
54f9ee45 13545 return _core_.IndividualLayoutConstraint_Unconstrained(*args, **kwargs)
e811c8ce
RD
13546
13547 def AsIs(*args, **kwargs):
15afbcd0 13548 """
a95a7133 13549 AsIs(self)
15afbcd0 13550
41e2b43e
RD
13551 Sets this edge or constraint to be whatever the window's value is at
13552 the moment. If either of the width and height constraints are *as is*,
13553 the window will not be resized, but moved instead. This is important
13554 when considering panel items which are intended to have a default
13555 size, such as a button, which may take its size from the size of the
13556 button label.
15afbcd0 13557 """
54f9ee45 13558 return _core_.IndividualLayoutConstraint_AsIs(*args, **kwargs)
e811c8ce
RD
13559
13560 def GetOtherWindow(*args, **kwargs):
a95a7133 13561 """GetOtherWindow(self) -> Window"""
54f9ee45 13562 return _core_.IndividualLayoutConstraint_GetOtherWindow(*args, **kwargs)
e811c8ce
RD
13563
13564 def GetMyEdge(*args, **kwargs):
a95a7133 13565 """GetMyEdge(self) -> int"""
54f9ee45 13566 return _core_.IndividualLayoutConstraint_GetMyEdge(*args, **kwargs)
e811c8ce
RD
13567
13568 def SetEdge(*args, **kwargs):
a95a7133 13569 """SetEdge(self, int which)"""
54f9ee45 13570 return _core_.IndividualLayoutConstraint_SetEdge(*args, **kwargs)
e811c8ce
RD
13571
13572 def SetValue(*args, **kwargs):
a95a7133 13573 """SetValue(self, int v)"""
54f9ee45 13574 return _core_.IndividualLayoutConstraint_SetValue(*args, **kwargs)
e811c8ce
RD
13575
13576 def GetMargin(*args, **kwargs):
a95a7133 13577 """GetMargin(self) -> int"""
54f9ee45 13578 return _core_.IndividualLayoutConstraint_GetMargin(*args, **kwargs)
e811c8ce
RD
13579
13580 def SetMargin(*args, **kwargs):
a95a7133 13581 """SetMargin(self, int m)"""
54f9ee45 13582 return _core_.IndividualLayoutConstraint_SetMargin(*args, **kwargs)
e811c8ce
RD
13583
13584 def GetValue(*args, **kwargs):
a95a7133 13585 """GetValue(self) -> int"""
54f9ee45 13586 return _core_.IndividualLayoutConstraint_GetValue(*args, **kwargs)
e811c8ce
RD
13587
13588 def GetPercent(*args, **kwargs):
a95a7133 13589 """GetPercent(self) -> int"""
54f9ee45 13590 return _core_.IndividualLayoutConstraint_GetPercent(*args, **kwargs)
e811c8ce
RD
13591
13592 def GetOtherEdge(*args, **kwargs):
a95a7133 13593 """GetOtherEdge(self) -> int"""
54f9ee45 13594 return _core_.IndividualLayoutConstraint_GetOtherEdge(*args, **kwargs)
e811c8ce
RD
13595
13596 def GetDone(*args, **kwargs):
a95a7133 13597 """GetDone(self) -> bool"""
54f9ee45 13598 return _core_.IndividualLayoutConstraint_GetDone(*args, **kwargs)
e811c8ce
RD
13599
13600 def SetDone(*args, **kwargs):
a95a7133 13601 """SetDone(self, bool d)"""
54f9ee45 13602 return _core_.IndividualLayoutConstraint_SetDone(*args, **kwargs)
e811c8ce
RD
13603
13604 def GetRelationship(*args, **kwargs):
a95a7133 13605 """GetRelationship(self) -> int"""
54f9ee45 13606 return _core_.IndividualLayoutConstraint_GetRelationship(*args, **kwargs)
e811c8ce
RD
13607
13608 def SetRelationship(*args, **kwargs):
a95a7133 13609 """SetRelationship(self, int r)"""
54f9ee45 13610 return _core_.IndividualLayoutConstraint_SetRelationship(*args, **kwargs)
e811c8ce
RD
13611
13612 def ResetIfWin(*args, **kwargs):
15afbcd0 13613 """
a95a7133 13614 ResetIfWin(self, Window otherW) -> bool
15afbcd0
RD
13615
13616 Reset constraint if it mentions otherWin
13617 """
54f9ee45 13618 return _core_.IndividualLayoutConstraint_ResetIfWin(*args, **kwargs)
e811c8ce
RD
13619
13620 def SatisfyConstraint(*args, **kwargs):
15afbcd0 13621 """
a95a7133 13622 SatisfyConstraint(self, LayoutConstraints constraints, Window win) -> bool
15afbcd0
RD
13623
13624 Try to satisfy constraint
13625 """
54f9ee45 13626 return _core_.IndividualLayoutConstraint_SatisfyConstraint(*args, **kwargs)
e811c8ce
RD
13627
13628 def GetEdge(*args, **kwargs):
15afbcd0 13629 """
a95a7133 13630 GetEdge(self, int which, Window thisWin, Window other) -> int
15afbcd0
RD
13631
13632 Get the value of this edge or dimension, or if this
13633 is not determinable, -1.
13634 """
54f9ee45 13635 return _core_.IndividualLayoutConstraint_GetEdge(*args, **kwargs)
e811c8ce 13636
97ab0f6a
RD
13637 Done = property(GetDone,SetDone,doc="See `GetDone` and `SetDone`")
13638 Margin = property(GetMargin,SetMargin,doc="See `GetMargin` and `SetMargin`")
13639 MyEdge = property(GetMyEdge,doc="See `GetMyEdge`")
13640 OtherEdge = property(GetOtherEdge,doc="See `GetOtherEdge`")
13641 OtherWindow = property(GetOtherWindow,doc="See `GetOtherWindow`")
13642 Percent = property(GetPercent,doc="See `GetPercent`")
13643 Relationship = property(GetRelationship,SetRelationship,doc="See `GetRelationship` and `SetRelationship`")
13644 Value = property(GetValue,SetValue,doc="See `GetValue` and `SetValue`")
2131d850 13645_core_.IndividualLayoutConstraint_swigregister(IndividualLayoutConstraint)
d14a1e28
RD
13646
13647class LayoutConstraints(Object):
15afbcd0 13648 """
41e2b43e
RD
13649 **Note:** constraints are now deprecated and you should use sizers
13650 instead.
15afbcd0 13651
41e2b43e
RD
13652 Objects of this class can be associated with a window to define its
13653 layout constraints, with respect to siblings or its parent.
15afbcd0
RD
13654
13655 The class consists of the following eight constraints of class
13656 wx.IndividualLayoutConstraint, some or all of which should be accessed
13657 directly to set the appropriate constraints.
13658
13659 * left: represents the left hand edge of the window
13660 * right: represents the right hand edge of the window
13661 * top: represents the top edge of the window
13662 * bottom: represents the bottom edge of the window
13663 * width: represents the width of the window
13664 * height: represents the height of the window
13665 * centreX: represents the horizontal centre point of the window
13666 * centreY: represents the vertical centre point of the window
13667
41e2b43e
RD
13668 Most constraints are initially set to have the relationship
13669 wxUnconstrained, which means that their values should be calculated by
13670 looking at known constraints. The exceptions are width and height,
13671 which are set to wxAsIs to ensure that if the user does not specify a
13672 constraint, the existing width and height will be used, to be
13673 compatible with panel items which often have take a default size. If
13674 the constraint is ``wx.AsIs``, the dimension will not be changed.
13675
13676 :see: `wx.IndividualLayoutConstraint`, `wx.Window.SetConstraints`
15afbcd0
RD
13677
13678 """
0085ce49
RD
13679 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
13680 __repr__ = _swig_repr
54f9ee45
RD
13681 left = property(_core_.LayoutConstraints_left_get)
13682 top = property(_core_.LayoutConstraints_top_get)
13683 right = property(_core_.LayoutConstraints_right_get)
13684 bottom = property(_core_.LayoutConstraints_bottom_get)
13685 width = property(_core_.LayoutConstraints_width_get)
13686 height = property(_core_.LayoutConstraints_height_get)
13687 centreX = property(_core_.LayoutConstraints_centreX_get)
13688 centreY = property(_core_.LayoutConstraints_centreY_get)
0085ce49 13689 def __init__(self, *args, **kwargs):
a95a7133 13690 """__init__(self) -> LayoutConstraints"""
0085ce49
RD
13691 _core_.LayoutConstraints_swiginit(self,_core_.new_LayoutConstraints(*args, **kwargs))
13692 __swig_destroy__ = _core_.delete_LayoutConstraints
13693 __del__ = lambda self : None;
e811c8ce 13694 def SatisfyConstraints(*args, **kwargs):
6c3b4aae 13695 """SatisfyConstraints(Window win) -> (areSatisfied, noChanges)"""
54f9ee45 13696 return _core_.LayoutConstraints_SatisfyConstraints(*args, **kwargs)
e811c8ce
RD
13697
13698 def AreSatisfied(*args, **kwargs):
a95a7133 13699 """AreSatisfied(self) -> bool"""
54f9ee45 13700 return _core_.LayoutConstraints_AreSatisfied(*args, **kwargs)
e811c8ce 13701
2131d850 13702_core_.LayoutConstraints_swigregister(LayoutConstraints)
d14a1e28
RD
13703
13704#----------------------------------------------------------------------------
13705
322913ce 13706# Use Python's bool constants if available, make some if not
d14a1e28
RD
13707try:
13708 True
13709except NameError:
322913ce
RD
13710 __builtins__.True = 1==1
13711 __builtins__.False = 1==0
4f89f6a3
RD
13712 def bool(value): return not not value
13713 __builtins__.bool = bool
d14a1e28 13714
d14a1e28
RD
13715
13716
13717# workarounds for bad wxRTTI names
13718__wxPyPtrTypeMap['wxGauge95'] = 'wxGauge'
13719__wxPyPtrTypeMap['wxSlider95'] = 'wxSlider'
13720__wxPyPtrTypeMap['wxStatusBar95'] = 'wxStatusBar'
13721
13722
13723#----------------------------------------------------------------------------
13724# Load version numbers from __version__... Ensure that major and minor
7bc1e663 13725# versions are the same for both wxPython and wxWidgets.
d14a1e28
RD
13726
13727from __version__ import *
13728__version__ = VERSION_STRING
13729
7bc1e663
RD
13730assert MAJOR_VERSION == _core_.MAJOR_VERSION, "wxPython/wxWidgets version mismatch"
13731assert MINOR_VERSION == _core_.MINOR_VERSION, "wxPython/wxWidgets version mismatch"
54f9ee45 13732if RELEASE_VERSION != _core_.RELEASE_VERSION:
d14a1e28 13733 import warnings
7bc1e663 13734 warnings.warn("wxPython/wxWidgets release number mismatch")
d14a1e28 13735
f9bf356b
RD
13736
13737def version():
13738 """Returns a string containing version and port info"""
13739 ctype = wx.USE_UNICODE and 'unicode' or 'ansi'
13740 if wx.Platform == '__WXMSW__':
13741 port = 'msw'
13742 elif wx.Platform == '__WXMAC__':
13743 port = 'mac'
13744 elif wx.Platform == '__WXGTK__':
13745 port = 'gtk'
13746 if 'gtk2' in wx.PlatformInfo:
13747 port = 'gtk2'
13748 else:
13749 port = '?'
13750
13751 return "%s (%s-%s)" % (wx.VERSION_STRING, port, ctype)
13752
13753
d14a1e28
RD
13754#----------------------------------------------------------------------------
13755
70b7a5fe
RD
13756# Set wxPython's default string<-->unicode conversion encoding from
13757# the locale, but only if Python's default hasn't been changed. (We
13758# assume that if the user has customized it already then that is the
13759# encoding we need to use as well.)
13760#
13761# The encoding selected here is used when string or unicode objects
13762# need to be converted in order to pass them to wxWidgets. Please be
13763# aware that the default encoding within the same locale may be
13764# slightly different on different platforms. For example, please see
e505d15e
RD
13765# http://www.alanwood.net/demos/charsetdiffs.html for differences
13766# between the common latin/roman encodings.
396fb509
RD
13767
13768default = _sys.getdefaultencoding()
13769if default == 'ascii':
13770 import locale
13771 import codecs
13772 try:
474e2ff2
RD
13773 if hasattr(locale, 'getpreferredencoding'):
13774 default = locale.getpreferredencoding()
13775 else:
13776 default = locale.getdefaultlocale()[1]
396fb509 13777 codecs.lookup(default)
70b7a5fe 13778 except (ValueError, LookupError, TypeError):
396fb509
RD
13779 default = _sys.getdefaultencoding()
13780 del locale
13781 del codecs
5cbf236d
RD
13782if default:
13783 wx.SetDefaultPyEncoding(default)
13784del default
5cbf236d
RD
13785
13786#----------------------------------------------------------------------------
13787
d14a1e28
RD
13788class PyDeadObjectError(AttributeError):
13789 pass
13790
d14a1e28
RD
13791class _wxPyDeadObject(object):
13792 """
13793 Instances of wx objects that are OOR capable will have their __class__
13794 changed to this class when the C++ object is deleted. This should help
13795 prevent crashes due to referencing a bogus C++ pointer.
13796 """
13797 reprStr = "wxPython wrapper for DELETED %s object! (The C++ object no longer exists.)"
13798 attrStr = "The C++ part of the %s object has been deleted, attribute access no longer allowed."
13799
3a04f143 13800 def __repr__(self):
d14a1e28
RD
13801 if not hasattr(self, "_name"):
13802 self._name = "[unknown]"
13803 return self.reprStr % self._name
13804
3a04f143 13805 def __getattr__(self, *args):
d14a1e28
RD
13806 if not hasattr(self, "_name"):
13807 self._name = "[unknown]"
3a04f143
RD
13808 raise PyDeadObjectError(self.attrStr % self._name)
13809
13810 def __nonzero__(self):
13811 return 0
13812
13813
13814
13815class PyUnbornObjectError(AttributeError):
13816 pass
13817
13818class _wxPyUnbornObject(object):
13819 """
54f9ee45 13820 Some stock objects are created when the wx._core module is
3a04f143
RD
13821 imported, but their C++ instance is not created until the wx.App
13822 object is created and initialized. These object instances will
13823 temporarily have their __class__ changed to this class so an
13824 exception will be raised if they are used before the C++ instance
13825 is ready.
13826 """
13827
13828 reprStr = "wxPython wrapper for UNBORN object! (The C++ object is not initialized yet.)"
13829 attrStr = "The C++ part of this object has not been initialized, attribute access not allowed."
13830
13831 def __repr__(self):
13832 #if not hasattr(self, "_name"):
13833 # self._name = "[unknown]"
13834 return self.reprStr #% self._name
13835
13836 def __getattr__(self, *args):
13837 #if not hasattr(self, "_name"):
13838 # self._name = "[unknown]"
13839 raise PyUnbornObjectError(self.attrStr) # % self._name )
d14a1e28
RD
13840
13841 def __nonzero__(self):
13842 return 0
13843
13844
13845#----------------------------------------------------------------------------
d14a1e28
RD
13846
13847def CallAfter(callable, *args, **kw):
13848 """
13849 Call the specified function after the current and pending event
13850 handlers have been completed. This is also good for making GUI
61863841
RD
13851 method calls from non-GUI threads. Any extra positional or
13852 keyword args are passed on to the callable when it is called.
13853
846c181b 13854 :see: `wx.CallLater`
d14a1e28
RD
13855 """
13856 app = wx.GetApp()
dfbb5885 13857 assert app is not None, 'No wx.App created yet'
d14a1e28 13858
148275d3
RD
13859 if not hasattr(app, "_CallAfterId"):
13860 app._CallAfterId = wx.NewEventType()
13861 app.Connect(-1, -1, app._CallAfterId,
13862 lambda event: event.callable(*event.args, **event.kw) )
d14a1e28 13863 evt = wx.PyEvent()
148275d3 13864 evt.SetEventType(app._CallAfterId)
d14a1e28
RD
13865 evt.callable = callable
13866 evt.args = args
13867 evt.kw = kw
13868 wx.PostEvent(app, evt)
13869
d14a1e28
RD
13870#----------------------------------------------------------------------------
13871
13872
846c181b 13873class CallLater:
d14a1e28 13874 """
8ac8dba0 13875 A convenience class for `wx.Timer`, that calls the given callable
d14a1e28
RD
13876 object once after the given amount of milliseconds, passing any
13877 positional or keyword args. The return value of the callable is
61863841 13878 availbale after it has been run with the `GetResult` method.
d14a1e28
RD
13879
13880 If you don't need to get the return value or restart the timer
13881 then there is no need to hold a reference to this object. It will
13882 hold a reference to itself while the timer is running (the timer
13883 has a reference to self.Notify) but the cycle will be broken when
846c181b 13884 the timer completes, automatically cleaning up the wx.CallLater
d14a1e28 13885 object.
61863841
RD
13886
13887 :see: `wx.CallAfter`
d14a1e28
RD
13888 """
13889 def __init__(self, millis, callable, *args, **kwargs):
13890 self.millis = millis
13891 self.callable = callable
13892 self.SetArgs(*args, **kwargs)
13893 self.runCount = 0
4276dc52 13894 self.running = False
d14a1e28
RD
13895 self.hasRun = False
13896 self.result = None
13897 self.timer = None
13898 self.Start()
13899
13900 def __del__(self):
13901 self.Stop()
13902
13903
13904 def Start(self, millis=None, *args, **kwargs):
13905 """
13906 (Re)start the timer
13907 """
13908 self.hasRun = False
13909 if millis is not None:
13910 self.millis = millis
13911 if args or kwargs:
13912 self.SetArgs(*args, **kwargs)
13913 self.Stop()
13914 self.timer = wx.PyTimer(self.Notify)
13915 self.timer.Start(self.millis, wx.TIMER_ONE_SHOT)
4276dc52 13916 self.running = True
d14a1e28
RD
13917 Restart = Start
13918
13919
13920 def Stop(self):
13921 """
13922 Stop and destroy the timer.
13923 """
13924 if self.timer is not None:
13925 self.timer.Stop()
13926 self.timer = None
13927
13928
13929 def GetInterval(self):
13930 if self.timer is not None:
13931 return self.timer.GetInterval()
13932 else:
13933 return 0
13934
13935
13936 def IsRunning(self):
13937 return self.timer is not None and self.timer.IsRunning()
13938
13939
13940 def SetArgs(self, *args, **kwargs):
13941 """
13942 (Re)set the args passed to the callable object. This is
13943 useful in conjunction with Restart if you want to schedule a
13944 new call to the same callable object but with different
13945 parameters.
13946 """
13947 self.args = args
13948 self.kwargs = kwargs
13949
13950
13951 def HasRun(self):
13952 return self.hasRun
13953
13954 def GetResult(self):
13955 return self.result
13956
13957 def Notify(self):
13958 """
13959 The timer has expired so call the callable.
13960 """
13961 if self.callable and getattr(self.callable, 'im_self', True):
13962 self.runCount += 1
4276dc52 13963 self.running = False
d14a1e28
RD
13964 self.result = self.callable(*self.args, **self.kwargs)
13965 self.hasRun = True
4276dc52
RD
13966 if not self.running:
13967 # if it wasn't restarted, then cleanup
13968 wx.CallAfter(self.Stop)
d14a1e28 13969
97ab0f6a
RD
13970 Interval = property(GetInterval)
13971 Result = property(GetResult)
d14a1e28 13972
a95a7133 13973
846c181b 13974class FutureCall(CallLater):
b39fe951 13975 """A compatibility alias for `CallLater`."""
846c181b 13976
a95a7133
RD
13977#----------------------------------------------------------------------------
13978# Control which items in this module should be documented by epydoc.
13979# We allow only classes and functions, which will help reduce the size
13980# of the docs by filtering out the zillions of constants, EVT objects,
13981# and etc that don't make much sense by themselves, but are instead
13982# documented (or will be) as part of the classes/functions/methods
13983# where they should be used.
13984
66c033b4
RD
13985class __DocFilter:
13986 """
13987 A filter for epydoc that only allows non-Ptr classes and
34e0a3bb 13988 functions, in order to reduce the clutter in the API docs.
66c033b4
RD
13989 """
13990 def __init__(self, globals):
13991 self._globals = globals
13992
13993 def __call__(self, name):
13994 import types
13995 obj = self._globals.get(name, None)
34e0a3bb
RD
13996
13997 # only document classes and function
66c033b4
RD
13998 if type(obj) not in [type, types.ClassType, types.FunctionType, types.BuiltinFunctionType]:
13999 return False
34e0a3bb
RD
14000
14001 # skip other things that are private or will be documented as part of somethign else
0085ce49 14002 if name.startswith('_') or name.startswith('EVT') or name.endswith('_swigregister') or name.endswith('Ptr') :
66c033b4 14003 return False
34e0a3bb
RD
14004
14005 # skip functions that are duplicates of static functions in a class
14006 if name.find('_') != -1:
14007 cls = self._globals.get(name.split('_')[0], None)
14008 methname = name.split('_')[1]
14009 if hasattr(cls, methname) and type(getattr(cls, methname)) is types.FunctionType:
14010 return False
14011
66c033b4 14012 return True
a95a7133 14013
d14a1e28
RD
14014#----------------------------------------------------------------------------
14015#----------------------------------------------------------------------------
14016
14017# Import other modules in this package that should show up in the
14018# "core" wx namespace
54f9ee45
RD
14019from _gdi import *
14020from _windows import *
14021from _controls import *
14022from _misc import *
d14a1e28
RD
14023
14024#----------------------------------------------------------------------------
14025#----------------------------------------------------------------------------
14026
14027
32fe5131 14028