]> git.saurik.com Git - wxWidgets.git/blame - wxPython/src/msw/_core.py
Factory some of wxFilterClassFactory into a base class.
[wxWidgets.git] / wxPython / src / msw / _core.py
CommitLineData
554f62e9 1# This file was created automatically by SWIG 1.3.29.
d55e5bfc
RD
2# Don't modify this file, modify the SWIG interface instead.
3
4import _core_
554f62e9
RD
5import new
6new_instancemethod = new.instancemethod
093d3ff1 7def _swig_setattr_nondynamic(self,class_type,name,value,static=1):
554f62e9 8 if (name == "thisown"): return self.this.own(value)
093d3ff1 9 if (name == "this"):
554f62e9
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)
554f62e9 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):
554f62e9 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
554f62e9
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):
554f62e9
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
d55e5bfc
RD
54#// Give a reference to the dictionary of this module to the C++ extension
55#// code.
56_core_._wxPySetDictionary(vars())
57
58#// A little trick to make 'wx' be a reference to this module so wx.Names can
59#// be used here.
60import sys as _sys
61wx = _sys.modules[__name__]
62
c24da6d6
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
d55e5bfc
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
57133d5c 95DEFAULT_CONTROL_BORDER = _core_.DEFAULT_CONTROL_BORDER
6d88e192 96DEFAULT_STATUSBAR_STYLE = _core_.DEFAULT_STATUSBAR_STYLE
d55e5bfc
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
d55e5bfc
RD
103CLIP_CHILDREN = _core_.CLIP_CHILDREN
104CLIP_SIBLINGS = _core_.CLIP_SIBLINGS
092f0ed7 105WINDOW_STYLE_MASK = _core_.WINDOW_STYLE_MASK
d55e5bfc
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
d55e5bfc
RD
130RB_GROUP = _core_.RB_GROUP
131RB_SINGLE = _core_.RB_SINGLE
d55e5bfc
RD
132SB_HORIZONTAL = _core_.SB_HORIZONTAL
133SB_VERTICAL = _core_.SB_VERTICAL
fef4c27a 134RB_USE_CHECKBOX = _core_.RB_USE_CHECKBOX
d55e5bfc
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
d55e5bfc
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
9d7dfdff 174SIZE_FORCE = _core_.SIZE_FORCE
d55e5bfc
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
9d7dfdff 183ID_NONE = _core_.ID_NONE
d55e5bfc
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
d55e5bfc
RD
198ID_PREVIEW = _core_.ID_PREVIEW
199ID_ABOUT = _core_.ID_ABOUT
200ID_HELP_CONTENTS = _core_.ID_HELP_CONTENTS
201ID_HELP_COMMANDS = _core_.ID_HELP_COMMANDS
202ID_HELP_PROCEDURES = _core_.ID_HELP_PROCEDURES
203ID_HELP_CONTEXT = _core_.ID_HELP_CONTEXT
1eeb270e
RD
204ID_HELP_INDEX = _core_.ID_HELP_INDEX
205ID_HELP_SEARCH = _core_.ID_HELP_SEARCH
d55e5bfc
RD
206ID_CLOSE_ALL = _core_.ID_CLOSE_ALL
207ID_PREFERENCES = _core_.ID_PREFERENCES
97ab0f6a 208ID_EDIT = _core_.ID_EDIT
d55e5bfc
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
d55e5bfc
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
0f63ec68
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
d55e5bfc 279ID_HIGHEST = _core_.ID_HIGHEST
d55e5bfc
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
0f63ec68
RD
346BG_STYLE_SYSTEM = _core_.BG_STYLE_SYSTEM
347BG_STYLE_COLOUR = _core_.BG_STYLE_COLOUR
348BG_STYLE_CUSTOM = _core_.BG_STYLE_CUSTOM
d55e5bfc
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
d55e5bfc
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
d55e5bfc
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
034e3677
RD
595PAPER_DBL_JAPANESE_POSTCARD = _core_.PAPER_DBL_JAPANESE_POSTCARD
596PAPER_A6 = _core_.PAPER_A6
597PAPER_JENV_KAKU2 = _core_.PAPER_JENV_KAKU2
598PAPER_JENV_KAKU3 = _core_.PAPER_JENV_KAKU3
599PAPER_JENV_CHOU3 = _core_.PAPER_JENV_CHOU3
600PAPER_JENV_CHOU4 = _core_.PAPER_JENV_CHOU4
601PAPER_LETTER_ROTATED = _core_.PAPER_LETTER_ROTATED
602PAPER_A3_ROTATED = _core_.PAPER_A3_ROTATED
603PAPER_A4_ROTATED = _core_.PAPER_A4_ROTATED
604PAPER_A5_ROTATED = _core_.PAPER_A5_ROTATED
605PAPER_B4_JIS_ROTATED = _core_.PAPER_B4_JIS_ROTATED
606PAPER_B5_JIS_ROTATED = _core_.PAPER_B5_JIS_ROTATED
607PAPER_JAPANESE_POSTCARD_ROTATED = _core_.PAPER_JAPANESE_POSTCARD_ROTATED
608PAPER_DBL_JAPANESE_POSTCARD_ROTATED = _core_.PAPER_DBL_JAPANESE_POSTCARD_ROTATED
609PAPER_A6_ROTATED = _core_.PAPER_A6_ROTATED
610PAPER_JENV_KAKU2_ROTATED = _core_.PAPER_JENV_KAKU2_ROTATED
611PAPER_JENV_KAKU3_ROTATED = _core_.PAPER_JENV_KAKU3_ROTATED
612PAPER_JENV_CHOU3_ROTATED = _core_.PAPER_JENV_CHOU3_ROTATED
613PAPER_JENV_CHOU4_ROTATED = _core_.PAPER_JENV_CHOU4_ROTATED
614PAPER_B6_JIS = _core_.PAPER_B6_JIS
615PAPER_B6_JIS_ROTATED = _core_.PAPER_B6_JIS_ROTATED
616PAPER_12X11 = _core_.PAPER_12X11
617PAPER_JENV_YOU4 = _core_.PAPER_JENV_YOU4
618PAPER_JENV_YOU4_ROTATED = _core_.PAPER_JENV_YOU4_ROTATED
619PAPER_P16K = _core_.PAPER_P16K
620PAPER_P32K = _core_.PAPER_P32K
621PAPER_P32KBIG = _core_.PAPER_P32KBIG
622PAPER_PENV_1 = _core_.PAPER_PENV_1
623PAPER_PENV_2 = _core_.PAPER_PENV_2
624PAPER_PENV_3 = _core_.PAPER_PENV_3
625PAPER_PENV_4 = _core_.PAPER_PENV_4
626PAPER_PENV_5 = _core_.PAPER_PENV_5
627PAPER_PENV_6 = _core_.PAPER_PENV_6
628PAPER_PENV_7 = _core_.PAPER_PENV_7
629PAPER_PENV_8 = _core_.PAPER_PENV_8
630PAPER_PENV_9 = _core_.PAPER_PENV_9
631PAPER_PENV_10 = _core_.PAPER_PENV_10
632PAPER_P16K_ROTATED = _core_.PAPER_P16K_ROTATED
633PAPER_P32K_ROTATED = _core_.PAPER_P32K_ROTATED
634PAPER_P32KBIG_ROTATED = _core_.PAPER_P32KBIG_ROTATED
635PAPER_PENV_1_ROTATED = _core_.PAPER_PENV_1_ROTATED
636PAPER_PENV_2_ROTATED = _core_.PAPER_PENV_2_ROTATED
637PAPER_PENV_3_ROTATED = _core_.PAPER_PENV_3_ROTATED
638PAPER_PENV_4_ROTATED = _core_.PAPER_PENV_4_ROTATED
639PAPER_PENV_5_ROTATED = _core_.PAPER_PENV_5_ROTATED
640PAPER_PENV_6_ROTATED = _core_.PAPER_PENV_6_ROTATED
641PAPER_PENV_7_ROTATED = _core_.PAPER_PENV_7_ROTATED
642PAPER_PENV_8_ROTATED = _core_.PAPER_PENV_8_ROTATED
643PAPER_PENV_9_ROTATED = _core_.PAPER_PENV_9_ROTATED
644PAPER_PENV_10_ROTATED = _core_.PAPER_PENV_10_ROTATED
d55e5bfc
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
9d7dfdff 672MOD_ALTGR = _core_.MOD_ALTGR
d55e5bfc 673MOD_SHIFT = _core_.MOD_SHIFT
9d7dfdff 674MOD_META = _core_.MOD_META
d55e5bfc 675MOD_WIN = _core_.MOD_WIN
9d7dfdff
RD
676MOD_CMD = _core_.MOD_CMD
677MOD_ALL = _core_.MOD_ALL
d55e5bfc
RD
678UPDATE_UI_NONE = _core_.UPDATE_UI_NONE
679UPDATE_UI_RECURSE = _core_.UPDATE_UI_RECURSE
680UPDATE_UI_FROMIDLE = _core_.UPDATE_UI_FROMIDLE
994453b8
RD
681Layout_Default = _core_.Layout_Default
682Layout_LeftToRight = _core_.Layout_LeftToRight
683Layout_RightToLeft = _core_.Layout_RightToLeft
d55e5bfc
RD
684#---------------------------------------------------------------------------
685
686class Object(object):
687 """
688 The base class for most wx objects, although in wxPython not
689 much functionality is needed nor exposed.
690 """
554f62e9
RD
691 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
692 def __init__(self): raise AttributeError, "No constructor defined"
693 __repr__ = _swig_repr
d55e5bfc
RD
694 def GetClassName(*args, **kwargs):
695 """
696 GetClassName(self) -> String
697
698 Returns the class name of the C++ class using wxRTTI.
699 """
700 return _core_.Object_GetClassName(*args, **kwargs)
701
702 def Destroy(*args, **kwargs):
703 """
704 Destroy(self)
705
706 Deletes the C++ object this Python object is a proxy for.
707 """
b39fe951
RD
708 args[0].this.own(False)
709 return _core_.Object_Destroy(*args, **kwargs)
d55e5bfc 710
33d6fd3b 711 ClassName = property(GetClassName,doc="See `GetClassName`")
2131d850 712_core_.Object_swigregister(Object)
d55e5bfc 713_wxPySetDictionary = _core_._wxPySetDictionary
d55e5bfc
RD
714cvar = _core_.cvar
715EmptyString = cvar.EmptyString
716
717#---------------------------------------------------------------------------
718
719BITMAP_TYPE_INVALID = _core_.BITMAP_TYPE_INVALID
720BITMAP_TYPE_BMP = _core_.BITMAP_TYPE_BMP
721BITMAP_TYPE_ICO = _core_.BITMAP_TYPE_ICO
722BITMAP_TYPE_CUR = _core_.BITMAP_TYPE_CUR
723BITMAP_TYPE_XBM = _core_.BITMAP_TYPE_XBM
724BITMAP_TYPE_XBM_DATA = _core_.BITMAP_TYPE_XBM_DATA
725BITMAP_TYPE_XPM = _core_.BITMAP_TYPE_XPM
726BITMAP_TYPE_XPM_DATA = _core_.BITMAP_TYPE_XPM_DATA
727BITMAP_TYPE_TIF = _core_.BITMAP_TYPE_TIF
728BITMAP_TYPE_GIF = _core_.BITMAP_TYPE_GIF
729BITMAP_TYPE_PNG = _core_.BITMAP_TYPE_PNG
730BITMAP_TYPE_JPEG = _core_.BITMAP_TYPE_JPEG
731BITMAP_TYPE_PNM = _core_.BITMAP_TYPE_PNM
732BITMAP_TYPE_PCX = _core_.BITMAP_TYPE_PCX
733BITMAP_TYPE_PICT = _core_.BITMAP_TYPE_PICT
734BITMAP_TYPE_ICON = _core_.BITMAP_TYPE_ICON
735BITMAP_TYPE_ANI = _core_.BITMAP_TYPE_ANI
736BITMAP_TYPE_IFF = _core_.BITMAP_TYPE_IFF
737BITMAP_TYPE_MACCURSOR = _core_.BITMAP_TYPE_MACCURSOR
738BITMAP_TYPE_ANY = _core_.BITMAP_TYPE_ANY
739CURSOR_NONE = _core_.CURSOR_NONE
740CURSOR_ARROW = _core_.CURSOR_ARROW
741CURSOR_RIGHT_ARROW = _core_.CURSOR_RIGHT_ARROW
742CURSOR_BULLSEYE = _core_.CURSOR_BULLSEYE
743CURSOR_CHAR = _core_.CURSOR_CHAR
744CURSOR_CROSS = _core_.CURSOR_CROSS
745CURSOR_HAND = _core_.CURSOR_HAND
746CURSOR_IBEAM = _core_.CURSOR_IBEAM
747CURSOR_LEFT_BUTTON = _core_.CURSOR_LEFT_BUTTON
748CURSOR_MAGNIFIER = _core_.CURSOR_MAGNIFIER
749CURSOR_MIDDLE_BUTTON = _core_.CURSOR_MIDDLE_BUTTON
750CURSOR_NO_ENTRY = _core_.CURSOR_NO_ENTRY
751CURSOR_PAINT_BRUSH = _core_.CURSOR_PAINT_BRUSH
752CURSOR_PENCIL = _core_.CURSOR_PENCIL
753CURSOR_POINT_LEFT = _core_.CURSOR_POINT_LEFT
754CURSOR_POINT_RIGHT = _core_.CURSOR_POINT_RIGHT
755CURSOR_QUESTION_ARROW = _core_.CURSOR_QUESTION_ARROW
756CURSOR_RIGHT_BUTTON = _core_.CURSOR_RIGHT_BUTTON
757CURSOR_SIZENESW = _core_.CURSOR_SIZENESW
758CURSOR_SIZENS = _core_.CURSOR_SIZENS
759CURSOR_SIZENWSE = _core_.CURSOR_SIZENWSE
760CURSOR_SIZEWE = _core_.CURSOR_SIZEWE
761CURSOR_SIZING = _core_.CURSOR_SIZING
762CURSOR_SPRAYCAN = _core_.CURSOR_SPRAYCAN
763CURSOR_WAIT = _core_.CURSOR_WAIT
764CURSOR_WATCH = _core_.CURSOR_WATCH
765CURSOR_BLANK = _core_.CURSOR_BLANK
766CURSOR_DEFAULT = _core_.CURSOR_DEFAULT
767CURSOR_COPY_ARROW = _core_.CURSOR_COPY_ARROW
768CURSOR_ARROWWAIT = _core_.CURSOR_ARROWWAIT
769CURSOR_MAX = _core_.CURSOR_MAX
770#---------------------------------------------------------------------------
771
772class Size(object):
773 """
79fccf9d 774 wx.Size is a useful data structure used to represent the size of
554f62e9
RD
775 something. It simply contains integer width and height
776 properties. In most places in wxPython where a wx.Size is
093d3ff1 777 expected a (width, height) tuple can be used instead.
d55e5bfc 778 """
554f62e9
RD
779 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
780 __repr__ = _swig_repr
d55e5bfc
RD
781 width = property(_core_.Size_width_get, _core_.Size_width_set)
782 height = property(_core_.Size_height_get, _core_.Size_height_set)
783 x = width; y = height
554f62e9 784 def __init__(self, *args, **kwargs):
d55e5bfc
RD
785 """
786 __init__(self, int w=0, int h=0) -> Size
787
788 Creates a size object.
789 """
554f62e9
RD
790 _core_.Size_swiginit(self,_core_.new_Size(*args, **kwargs))
791 __swig_destroy__ = _core_.delete_Size
792 __del__ = lambda self : None;
d55e5bfc
RD
793 def __eq__(*args, **kwargs):
794 """
e9d6f3a4 795 __eq__(self, PyObject other) -> bool
d55e5bfc
RD
796
797 Test for equality of wx.Size objects.
798 """
799 return _core_.Size___eq__(*args, **kwargs)
800
801 def __ne__(*args, **kwargs):
802 """
e9d6f3a4 803 __ne__(self, PyObject other) -> bool
d55e5bfc 804
e9d6f3a4 805 Test for inequality of wx.Size objects.
d55e5bfc
RD
806 """
807 return _core_.Size___ne__(*args, **kwargs)
808
809 def __add__(*args, **kwargs):
810 """
811 __add__(self, Size sz) -> Size
812
813 Add sz's proprties to this and return the result.
814 """
815 return _core_.Size___add__(*args, **kwargs)
816
817 def __sub__(*args, **kwargs):
818 """
819 __sub__(self, Size sz) -> Size
820
821 Subtract sz's properties from this and return the result.
822 """
823 return _core_.Size___sub__(*args, **kwargs)
824
825 def IncTo(*args, **kwargs):
826 """
827 IncTo(self, Size sz)
828
829 Increments this object so that both of its dimensions are not less
830 than the corresponding dimensions of the size.
831 """
832 return _core_.Size_IncTo(*args, **kwargs)
833
834 def DecTo(*args, **kwargs):
835 """
836 DecTo(self, Size sz)
837
838 Decrements this object so that both of its dimensions are not greater
839 than the corresponding dimensions of the size.
840 """
841 return _core_.Size_DecTo(*args, **kwargs)
842
f5263701
RD
843 def IncBy(*args, **kwargs):
844 """IncBy(self, int dx, int dy)"""
845 return _core_.Size_IncBy(*args, **kwargs)
846
847 def DecBy(*args, **kwargs):
848 """DecBy(self, int dx, int dy)"""
849 return _core_.Size_DecBy(*args, **kwargs)
850
1eeb270e
RD
851 def Scale(*args, **kwargs):
852 """
853 Scale(self, float xscale, float yscale)
854
855 Scales the dimensions of this object by the given factors.
856 """
857 return _core_.Size_Scale(*args, **kwargs)
858
d55e5bfc
RD
859 def Set(*args, **kwargs):
860 """
861 Set(self, int w, int h)
862
863 Set both width and height.
864 """
865 return _core_.Size_Set(*args, **kwargs)
866
867 def SetWidth(*args, **kwargs):
868 """SetWidth(self, int w)"""
869 return _core_.Size_SetWidth(*args, **kwargs)
870
871 def SetHeight(*args, **kwargs):
872 """SetHeight(self, int h)"""
873 return _core_.Size_SetHeight(*args, **kwargs)
874
875 def GetWidth(*args, **kwargs):
876 """GetWidth(self) -> int"""
877 return _core_.Size_GetWidth(*args, **kwargs)
878
879 def GetHeight(*args, **kwargs):
880 """GetHeight(self) -> int"""
881 return _core_.Size_GetHeight(*args, **kwargs)
882
883 def IsFullySpecified(*args, **kwargs):
884 """
885 IsFullySpecified(self) -> bool
886
887 Returns True if both components of the size are non-default values.
888 """
889 return _core_.Size_IsFullySpecified(*args, **kwargs)
890
891 def SetDefaults(*args, **kwargs):
892 """
893 SetDefaults(self, Size size)
894
79fccf9d
RD
895 Combine this size with the other one replacing the default components
896 of this object (i.e. equal to -1) with those of the other.
d55e5bfc
RD
897 """
898 return _core_.Size_SetDefaults(*args, **kwargs)
899
900 def Get(*args, **kwargs):
901 """
902 Get() -> (width,height)
903
904 Returns the width and height properties as a tuple.
905 """
906 return _core_.Size_Get(*args, **kwargs)
907
79fccf9d 908 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD
909 def __str__(self): return str(self.Get())
910 def __repr__(self): return 'wx.Size'+str(self.Get())
911 def __len__(self): return len(self.Get())
912 def __getitem__(self, index): return self.Get()[index]
913 def __setitem__(self, index, val):
914 if index == 0: self.width = val
915 elif index == 1: self.height = val
916 else: raise IndexError
917 def __nonzero__(self): return self.Get() != (0,0)
918 __safe_for_unpickling__ = True
919 def __reduce__(self): return (wx.Size, self.Get())
920
2131d850 921_core_.Size_swigregister(Size)
d55e5bfc
RD
922
923#---------------------------------------------------------------------------
924
925class RealPoint(object):
926 """
79fccf9d
RD
927 A data structure for representing a point or position with floating
928 point x and y properties. In wxPython most places that expect a
929 wx.RealPoint can also accept a (x,y) tuple.
d55e5bfc 930 """
554f62e9
RD
931 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
932 __repr__ = _swig_repr
d55e5bfc
RD
933 x = property(_core_.RealPoint_x_get, _core_.RealPoint_x_set)
934 y = property(_core_.RealPoint_y_get, _core_.RealPoint_y_set)
554f62e9 935 def __init__(self, *args, **kwargs):
d55e5bfc
RD
936 """
937 __init__(self, double x=0.0, double y=0.0) -> RealPoint
938
939 Create a wx.RealPoint object
940 """
554f62e9
RD
941 _core_.RealPoint_swiginit(self,_core_.new_RealPoint(*args, **kwargs))
942 __swig_destroy__ = _core_.delete_RealPoint
943 __del__ = lambda self : None;
d55e5bfc
RD
944 def __eq__(*args, **kwargs):
945 """
e9d6f3a4 946 __eq__(self, PyObject other) -> bool
d55e5bfc
RD
947
948 Test for equality of wx.RealPoint objects.
949 """
950 return _core_.RealPoint___eq__(*args, **kwargs)
951
952 def __ne__(*args, **kwargs):
953 """
e9d6f3a4 954 __ne__(self, PyObject other) -> bool
d55e5bfc
RD
955
956 Test for inequality of wx.RealPoint objects.
957 """
958 return _core_.RealPoint___ne__(*args, **kwargs)
959
960 def __add__(*args, **kwargs):
961 """
962 __add__(self, RealPoint pt) -> RealPoint
963
964 Add pt's proprties to this and return the result.
965 """
966 return _core_.RealPoint___add__(*args, **kwargs)
967
968 def __sub__(*args, **kwargs):
969 """
970 __sub__(self, RealPoint pt) -> RealPoint
971
972 Subtract pt's proprties from this and return the result
973 """
974 return _core_.RealPoint___sub__(*args, **kwargs)
975
976 def Set(*args, **kwargs):
977 """
978 Set(self, double x, double y)
979
980 Set both the x and y properties
981 """
982 return _core_.RealPoint_Set(*args, **kwargs)
983
984 def Get(*args, **kwargs):
985 """
986 Get() -> (x,y)
987
988 Return the x and y properties as a tuple.
989 """
990 return _core_.RealPoint_Get(*args, **kwargs)
991
79fccf9d 992 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD
993 def __str__(self): return str(self.Get())
994 def __repr__(self): return 'wx.RealPoint'+str(self.Get())
995 def __len__(self): return len(self.Get())
996 def __getitem__(self, index): return self.Get()[index]
997 def __setitem__(self, index, val):
998 if index == 0: self.x = val
999 elif index == 1: self.y = val
1000 else: raise IndexError
1001 def __nonzero__(self): return self.Get() != (0.0, 0.0)
1002 __safe_for_unpickling__ = True
1003 def __reduce__(self): return (wx.RealPoint, self.Get())
1004
2131d850 1005_core_.RealPoint_swigregister(RealPoint)
d55e5bfc
RD
1006
1007#---------------------------------------------------------------------------
1008
1009class Point(object):
1010 """
79fccf9d
RD
1011 A data structure for representing a point or position with integer x
1012 and y properties. Most places in wxPython that expect a wx.Point can
1013 also accept a (x,y) tuple.
d55e5bfc 1014 """
554f62e9
RD
1015 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1016 __repr__ = _swig_repr
d55e5bfc
RD
1017 x = property(_core_.Point_x_get, _core_.Point_x_set)
1018 y = property(_core_.Point_y_get, _core_.Point_y_set)
554f62e9 1019 def __init__(self, *args, **kwargs):
d55e5bfc
RD
1020 """
1021 __init__(self, int x=0, int y=0) -> Point
1022
1023 Create a wx.Point object
1024 """
554f62e9
RD
1025 _core_.Point_swiginit(self,_core_.new_Point(*args, **kwargs))
1026 __swig_destroy__ = _core_.delete_Point
1027 __del__ = lambda self : None;
d55e5bfc
RD
1028 def __eq__(*args, **kwargs):
1029 """
e9d6f3a4 1030 __eq__(self, PyObject other) -> bool
d55e5bfc
RD
1031
1032 Test for equality of wx.Point objects.
1033 """
1034 return _core_.Point___eq__(*args, **kwargs)
1035
1036 def __ne__(*args, **kwargs):
1037 """
e9d6f3a4 1038 __ne__(self, PyObject other) -> bool
d55e5bfc
RD
1039
1040 Test for inequality of wx.Point objects.
1041 """
1042 return _core_.Point___ne__(*args, **kwargs)
1043
1044 def __add__(*args, **kwargs):
1045 """
1046 __add__(self, Point pt) -> Point
1047
1048 Add pt's proprties to this and return the result.
1049 """
1050 return _core_.Point___add__(*args, **kwargs)
1051
1052 def __sub__(*args, **kwargs):
1053 """
1054 __sub__(self, Point pt) -> Point
1055
1056 Subtract pt's proprties from this and return the result
1057 """
1058 return _core_.Point___sub__(*args, **kwargs)
1059
1060 def __iadd__(*args, **kwargs):
1061 """
1062 __iadd__(self, Point pt) -> Point
1063
1064 Add pt to this object.
1065 """
1066 return _core_.Point___iadd__(*args, **kwargs)
1067
1068 def __isub__(*args, **kwargs):
1069 """
1070 __isub__(self, Point pt) -> Point
1071
1072 Subtract pt from this object.
1073 """
1074 return _core_.Point___isub__(*args, **kwargs)
1075
1076 def Set(*args, **kwargs):
1077 """
1078 Set(self, long x, long y)
1079
1080 Set both the x and y properties
1081 """
1082 return _core_.Point_Set(*args, **kwargs)
1083
1084 def Get(*args, **kwargs):
1085 """
1086 Get() -> (x,y)
1087
1088 Return the x and y properties as a tuple.
1089 """
1090 return _core_.Point_Get(*args, **kwargs)
1091
79fccf9d 1092 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD
1093 def __str__(self): return str(self.Get())
1094 def __repr__(self): return 'wx.Point'+str(self.Get())
1095 def __len__(self): return len(self.Get())
1096 def __getitem__(self, index): return self.Get()[index]
1097 def __setitem__(self, index, val):
1098 if index == 0: self.x = val
1099 elif index == 1: self.y = val
1100 else: raise IndexError
1101 def __nonzero__(self): return self.Get() != (0,0)
1102 __safe_for_unpickling__ = True
1103 def __reduce__(self): return (wx.Point, self.Get())
1104
2131d850 1105_core_.Point_swigregister(Point)
d55e5bfc
RD
1106
1107#---------------------------------------------------------------------------
1108
1109class Rect(object):
1110 """
79fccf9d
RD
1111 A class for representing and manipulating rectangles. It has x, y,
1112 width and height properties. In wxPython most palces that expect a
1113 wx.Rect can also accept a (x,y,width,height) tuple.
d55e5bfc 1114 """
554f62e9
RD
1115 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1116 __repr__ = _swig_repr
1117 def __init__(self, *args, **kwargs):
d55e5bfc
RD
1118 """
1119 __init__(self, int x=0, int y=0, int width=0, int height=0) -> Rect
1120
1121 Create a new Rect object.
1122 """
554f62e9
RD
1123 _core_.Rect_swiginit(self,_core_.new_Rect(*args, **kwargs))
1124 __swig_destroy__ = _core_.delete_Rect
1125 __del__ = lambda self : None;
d55e5bfc
RD
1126 def GetX(*args, **kwargs):
1127 """GetX(self) -> int"""
1128 return _core_.Rect_GetX(*args, **kwargs)
1129
1130 def SetX(*args, **kwargs):
1131 """SetX(self, int x)"""
1132 return _core_.Rect_SetX(*args, **kwargs)
1133
1134 def GetY(*args, **kwargs):
1135 """GetY(self) -> int"""
1136 return _core_.Rect_GetY(*args, **kwargs)
1137
1138 def SetY(*args, **kwargs):
1139 """SetY(self, int y)"""
1140 return _core_.Rect_SetY(*args, **kwargs)
1141
1142 def GetWidth(*args, **kwargs):
1143 """GetWidth(self) -> int"""
1144 return _core_.Rect_GetWidth(*args, **kwargs)
1145
1146 def SetWidth(*args, **kwargs):
1147 """SetWidth(self, int w)"""
1148 return _core_.Rect_SetWidth(*args, **kwargs)
1149
1150 def GetHeight(*args, **kwargs):
1151 """GetHeight(self) -> int"""
1152 return _core_.Rect_GetHeight(*args, **kwargs)
1153
1154 def SetHeight(*args, **kwargs):
1155 """SetHeight(self, int h)"""
1156 return _core_.Rect_SetHeight(*args, **kwargs)
1157
1158 def GetPosition(*args, **kwargs):
1159 """GetPosition(self) -> Point"""
1160 return _core_.Rect_GetPosition(*args, **kwargs)
1161
1162 def SetPosition(*args, **kwargs):
1163 """SetPosition(self, Point p)"""
1164 return _core_.Rect_SetPosition(*args, **kwargs)
1165
1166 def GetSize(*args, **kwargs):
1167 """GetSize(self) -> Size"""
1168 return _core_.Rect_GetSize(*args, **kwargs)
1169
1170 def SetSize(*args, **kwargs):
1171 """SetSize(self, Size s)"""
1172 return _core_.Rect_SetSize(*args, **kwargs)
1173
aff4cc5c
RD
1174 def IsEmpty(*args, **kwargs):
1175 """IsEmpty(self) -> bool"""
1176 return _core_.Rect_IsEmpty(*args, **kwargs)
1177
d55e5bfc
RD
1178 def GetTopLeft(*args, **kwargs):
1179 """GetTopLeft(self) -> Point"""
1180 return _core_.Rect_GetTopLeft(*args, **kwargs)
1181
1182 def SetTopLeft(*args, **kwargs):
1183 """SetTopLeft(self, Point p)"""
1184 return _core_.Rect_SetTopLeft(*args, **kwargs)
1185
1186 def GetBottomRight(*args, **kwargs):
1187 """GetBottomRight(self) -> Point"""
1188 return _core_.Rect_GetBottomRight(*args, **kwargs)
1189
1190 def SetBottomRight(*args, **kwargs):
1191 """SetBottomRight(self, Point p)"""
1192 return _core_.Rect_SetBottomRight(*args, **kwargs)
1193
5acb46e0
RD
1194 def GetTopRight(*args, **kwargs):
1195 """GetTopRight(self) -> Point"""
1196 return _core_.Rect_GetTopRight(*args, **kwargs)
1197
1198 def SetTopRight(*args, **kwargs):
1199 """SetTopRight(self, Point p)"""
1200 return _core_.Rect_SetTopRight(*args, **kwargs)
1201
1202 def GetBottomLeft(*args, **kwargs):
1203 """GetBottomLeft(self) -> Point"""
1204 return _core_.Rect_GetBottomLeft(*args, **kwargs)
1205
1206 def SetBottomLeft(*args, **kwargs):
1207 """SetBottomLeft(self, Point p)"""
1208 return _core_.Rect_SetBottomLeft(*args, **kwargs)
1209
d55e5bfc
RD
1210 def GetLeft(*args, **kwargs):
1211 """GetLeft(self) -> int"""
1212 return _core_.Rect_GetLeft(*args, **kwargs)
1213
1214 def GetTop(*args, **kwargs):
1215 """GetTop(self) -> int"""
1216 return _core_.Rect_GetTop(*args, **kwargs)
1217
1218 def GetBottom(*args, **kwargs):
1219 """GetBottom(self) -> int"""
1220 return _core_.Rect_GetBottom(*args, **kwargs)
1221
1222 def GetRight(*args, **kwargs):
1223 """GetRight(self) -> int"""
1224 return _core_.Rect_GetRight(*args, **kwargs)
1225
1226 def SetLeft(*args, **kwargs):
1227 """SetLeft(self, int left)"""
1228 return _core_.Rect_SetLeft(*args, **kwargs)
1229
1230 def SetRight(*args, **kwargs):
1231 """SetRight(self, int right)"""
1232 return _core_.Rect_SetRight(*args, **kwargs)
1233
1234 def SetTop(*args, **kwargs):
1235 """SetTop(self, int top)"""
1236 return _core_.Rect_SetTop(*args, **kwargs)
1237
1238 def SetBottom(*args, **kwargs):
1239 """SetBottom(self, int bottom)"""
1240 return _core_.Rect_SetBottom(*args, **kwargs)
1241
1242 position = property(GetPosition, SetPosition)
1243 size = property(GetSize, SetSize)
1244 left = property(GetLeft, SetLeft)
1245 right = property(GetRight, SetRight)
1246 top = property(GetTop, SetTop)
1247 bottom = property(GetBottom, SetBottom)
1248
1249 def Inflate(*args, **kwargs):
1250 """
1251 Inflate(self, int dx, int dy) -> Rect
1252
091fdbfa
RD
1253 Increases the size of the rectangle.
1254
1255 The left border is moved farther left and the right border is moved
1256 farther right by ``dx``. The upper border is moved farther up and the
1257 bottom border is moved farther down by ``dy``. (Note the the width and
1258 height of the rectangle thus change by ``2*dx`` and ``2*dy``,
1259 respectively.) If one or both of ``dx`` and ``dy`` are negative, the
1260 opposite happens: the rectangle size decreases in the respective
1261 direction.
1262
1263 The change is made to the rectangle inplace, if instead you need a
1264 copy that is inflated, preserving the original then make the copy
1265 first::
1266
1267 copy = wx.Rect(*original)
1268 copy.Inflate(10,15)
1269
1270
d55e5bfc
RD
1271 """
1272 return _core_.Rect_Inflate(*args, **kwargs)
1273
1274 def Deflate(*args, **kwargs):
1275 """
1276 Deflate(self, int dx, int dy) -> Rect
1277
091fdbfa
RD
1278 Decrease the rectangle size. This method is the opposite of `Inflate`
1279 in that Deflate(a,b) is equivalent to Inflate(-a,-b). Please refer to
1280 `Inflate` for a full description.
d55e5bfc
RD
1281 """
1282 return _core_.Rect_Deflate(*args, **kwargs)
1283
1284 def OffsetXY(*args, **kwargs):
1285 """
1286 OffsetXY(self, int dx, int dy)
1287
79fccf9d
RD
1288 Moves the rectangle by the specified offset. If dx is positive, the
1289 rectangle is moved to the right, if dy is positive, it is moved to the
1290 bottom, otherwise it is moved to the left or top respectively.
d55e5bfc
RD
1291 """
1292 return _core_.Rect_OffsetXY(*args, **kwargs)
1293
1294 def Offset(*args, **kwargs):
1295 """
1296 Offset(self, Point pt)
1297
b1fcee84 1298 Same as `OffsetXY` but uses dx,dy from Point
d55e5bfc
RD
1299 """
1300 return _core_.Rect_Offset(*args, **kwargs)
1301
1302 def Intersect(*args, **kwargs):
1303 """
1304 Intersect(self, Rect rect) -> Rect
1305
b519803b 1306 Returns the intersectsion of this rectangle and rect.
d55e5bfc
RD
1307 """
1308 return _core_.Rect_Intersect(*args, **kwargs)
1309
b519803b
RD
1310 def Union(*args, **kwargs):
1311 """
1312 Union(self, Rect rect) -> Rect
1313
1314 Returns the union of this rectangle and rect.
1315 """
1316 return _core_.Rect_Union(*args, **kwargs)
1317
d55e5bfc
RD
1318 def __add__(*args, **kwargs):
1319 """
1320 __add__(self, Rect rect) -> Rect
1321
1322 Add the properties of rect to this rectangle and return the result.
1323 """
1324 return _core_.Rect___add__(*args, **kwargs)
1325
1326 def __iadd__(*args, **kwargs):
1327 """
1328 __iadd__(self, Rect rect) -> Rect
1329
1330 Add the properties of rect to this rectangle, updating this rectangle.
1331 """
1332 return _core_.Rect___iadd__(*args, **kwargs)
1333
1334 def __eq__(*args, **kwargs):
1335 """
e9d6f3a4 1336 __eq__(self, PyObject other) -> bool
d55e5bfc 1337
e9d6f3a4 1338 Test for equality of wx.Rect objects.
d55e5bfc
RD
1339 """
1340 return _core_.Rect___eq__(*args, **kwargs)
1341
1342 def __ne__(*args, **kwargs):
1343 """
e9d6f3a4 1344 __ne__(self, PyObject other) -> bool
d55e5bfc 1345
e9d6f3a4 1346 Test for inequality of wx.Rect objects.
d55e5bfc
RD
1347 """
1348 return _core_.Rect___ne__(*args, **kwargs)
1349
33d6fd3b 1350 def ContainsXY(*args, **kwargs):
d55e5bfc 1351 """
33d6fd3b 1352 ContainsXY(self, int x, int y) -> bool
d55e5bfc 1353
33d6fd3b 1354 Return True if the point is inside the rect.
d55e5bfc 1355 """
33d6fd3b 1356 return _core_.Rect_ContainsXY(*args, **kwargs)
d55e5bfc 1357
33d6fd3b 1358 def Contains(*args, **kwargs):
d55e5bfc 1359 """
33d6fd3b 1360 Contains(self, Point pt) -> bool
d55e5bfc 1361
33d6fd3b 1362 Return True if the point is inside the rect.
d55e5bfc 1363 """
33d6fd3b 1364 return _core_.Rect_Contains(*args, **kwargs)
d55e5bfc 1365
33d6fd3b 1366 def ContainsRect(*args, **kwargs):
fc46b7f3 1367 """
33d6fd3b 1368 ContainsRect(self, Rect rect) -> bool
fc46b7f3
RD
1369
1370 Returns ``True`` if the given rectangle is completely inside this
1371 rectangle or touches its boundary.
1372 """
33d6fd3b
RD
1373 return _core_.Rect_ContainsRect(*args, **kwargs)
1374
72ef6efb
RD
1375 #Inside = wx._deprecated(Contains, "Use `Contains` instead.")
1376 #InsideXY = wx._deprecated(ContainsXY, "Use `ContainsXY` instead.")
1377 #InsideRect = wx._deprecated(ContainsRect, "Use `ContainsRect` instead.")
1378 Inside = Contains
1379 InsideXY = ContainsXY
1380 InsideRect = ContainsRect
fc46b7f3 1381
d55e5bfc
RD
1382 def Intersects(*args, **kwargs):
1383 """
1384 Intersects(self, Rect rect) -> bool
1385
1386 Returns True if the rectangles have a non empty intersection.
1387 """
1388 return _core_.Rect_Intersects(*args, **kwargs)
1389
b1fcee84
RD
1390 def CenterIn(*args, **kwargs):
1391 """
1392 CenterIn(self, Rect r, int dir=BOTH) -> Rect
1393
1394 Center this rectangle within the one passed to the method, which is
1395 usually, but not necessarily, the larger one.
1396 """
1397 return _core_.Rect_CenterIn(*args, **kwargs)
1398
1399 CentreIn = CenterIn
d55e5bfc
RD
1400 x = property(_core_.Rect_x_get, _core_.Rect_x_set)
1401 y = property(_core_.Rect_y_get, _core_.Rect_y_set)
1402 width = property(_core_.Rect_width_get, _core_.Rect_width_set)
1403 height = property(_core_.Rect_height_get, _core_.Rect_height_set)
1404 def Set(*args, **kwargs):
1405 """
1406 Set(self, int x=0, int y=0, int width=0, int height=0)
1407
1408 Set all rectangle properties.
1409 """
1410 return _core_.Rect_Set(*args, **kwargs)
1411
1412 def Get(*args, **kwargs):
1413 """
1414 Get() -> (x,y,width,height)
1415
1416 Return the rectangle properties as a tuple.
1417 """
1418 return _core_.Rect_Get(*args, **kwargs)
1419
79fccf9d 1420 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD
1421 def __str__(self): return str(self.Get())
1422 def __repr__(self): return 'wx.Rect'+str(self.Get())
1423 def __len__(self): return len(self.Get())
1424 def __getitem__(self, index): return self.Get()[index]
1425 def __setitem__(self, index, val):
1426 if index == 0: self.x = val
1427 elif index == 1: self.y = val
1428 elif index == 2: self.width = val
1429 elif index == 3: self.height = val
1430 else: raise IndexError
1431 def __nonzero__(self): return self.Get() != (0,0,0,0)
1432 __safe_for_unpickling__ = True
1433 def __reduce__(self): return (wx.Rect, self.Get())
1434
33d6fd3b
RD
1435 Bottom = property(GetBottom,SetBottom,doc="See `GetBottom` and `SetBottom`")
1436 BottomRight = property(GetBottomRight,SetBottomRight,doc="See `GetBottomRight` and `SetBottomRight`")
5acb46e0 1437 BottomLeft = property(GetBottomLeft,SetBottomLeft,doc="See `GetBottomLeft` and `SetBottomLeft`")
33d6fd3b
RD
1438 Height = property(GetHeight,SetHeight,doc="See `GetHeight` and `SetHeight`")
1439 Left = property(GetLeft,SetLeft,doc="See `GetLeft` and `SetLeft`")
1440 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
1441 Right = property(GetRight,SetRight,doc="See `GetRight` and `SetRight`")
1442 Size = property(GetSize,SetSize,doc="See `GetSize` and `SetSize`")
1443 Top = property(GetTop,SetTop,doc="See `GetTop` and `SetTop`")
1444 TopLeft = property(GetTopLeft,SetTopLeft,doc="See `GetTopLeft` and `SetTopLeft`")
5acb46e0 1445 TopRight = property(GetTopRight,SetTopRight,doc="See `GetTopRight` and `SetTopRight`")
33d6fd3b
RD
1446 Width = property(GetWidth,SetWidth,doc="See `GetWidth` and `SetWidth`")
1447 X = property(GetX,SetX,doc="See `GetX` and `SetX`")
1448 Y = property(GetY,SetY,doc="See `GetY` and `SetY`")
1449 Empty = property(IsEmpty,doc="See `IsEmpty`")
2131d850 1450_core_.Rect_swigregister(Rect)
d55e5bfc
RD
1451
1452def RectPP(*args, **kwargs):
1453 """
1454 RectPP(Point topLeft, Point bottomRight) -> Rect
1455
1456 Create a new Rect object from Points representing two corners.
1457 """
1458 val = _core_.new_RectPP(*args, **kwargs)
d55e5bfc
RD
1459 return val
1460
1461def RectPS(*args, **kwargs):
1462 """
1463 RectPS(Point pos, Size size) -> Rect
1464
1465 Create a new Rect from a position and size.
1466 """
1467 val = _core_.new_RectPS(*args, **kwargs)
d55e5bfc
RD
1468 return val
1469
c1cb24a4
RD
1470def RectS(*args, **kwargs):
1471 """
1472 RectS(Size size) -> Rect
1473
1474 Create a new Rect from a size only.
1475 """
1476 val = _core_.new_RectS(*args, **kwargs)
c1cb24a4
RD
1477 return val
1478
d55e5bfc
RD
1479
1480def IntersectRect(*args, **kwargs):
554f62e9 1481 """
d55e5bfc
RD
1482 IntersectRect(Rect r1, Rect r2) -> Rect
1483
1484 Calculate and return the intersection of r1 and r2.
1485 """
554f62e9 1486 return _core_.IntersectRect(*args, **kwargs)
d55e5bfc
RD
1487#---------------------------------------------------------------------------
1488
1489class Point2D(object):
79fccf9d
RD
1490 """
1491 wx.Point2Ds represent a point or a vector in a 2d coordinate system
1492 with floating point values.
1493 """
554f62e9
RD
1494 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1495 __repr__ = _swig_repr
1496 def __init__(self, *args, **kwargs):
d55e5bfc
RD
1497 """
1498 __init__(self, double x=0.0, double y=0.0) -> Point2D
1499
1500 Create a w.Point2D object.
1501 """
554f62e9 1502 _core_.Point2D_swiginit(self,_core_.new_Point2D(*args, **kwargs))
b39fe951
RD
1503 __swig_destroy__ = _core_.delete_Point2D
1504 __del__ = lambda self : None;
d55e5bfc 1505 def GetFloor(*args, **kwargs):
a8eff060
RD
1506 """
1507 GetFloor() -> (x,y)
1508
1509 Convert to integer
1510 """
d55e5bfc
RD
1511 return _core_.Point2D_GetFloor(*args, **kwargs)
1512
1513 def GetRounded(*args, **kwargs):
a8eff060
RD
1514 """
1515 GetRounded() -> (x,y)
1516
1517 Convert to integer
1518 """
d55e5bfc
RD
1519 return _core_.Point2D_GetRounded(*args, **kwargs)
1520
1521 def GetVectorLength(*args, **kwargs):
1522 """GetVectorLength(self) -> double"""
1523 return _core_.Point2D_GetVectorLength(*args, **kwargs)
1524
1525 def GetVectorAngle(*args, **kwargs):
1526 """GetVectorAngle(self) -> double"""
1527 return _core_.Point2D_GetVectorAngle(*args, **kwargs)
1528
1529 def SetVectorLength(*args, **kwargs):
1530 """SetVectorLength(self, double length)"""
1531 return _core_.Point2D_SetVectorLength(*args, **kwargs)
1532
1533 def SetVectorAngle(*args, **kwargs):
1534 """SetVectorAngle(self, double degrees)"""
1535 return _core_.Point2D_SetVectorAngle(*args, **kwargs)
1536
1537 def SetPolarCoordinates(self, angle, length):
1538 self.SetVectorLength(length)
1539 self.SetVectorAngle(angle)
1540 def Normalize(self):
1541 self.SetVectorLength(1.0)
1542
1543 def GetDistance(*args, **kwargs):
1544 """GetDistance(self, Point2D pt) -> double"""
1545 return _core_.Point2D_GetDistance(*args, **kwargs)
1546
1547 def GetDistanceSquare(*args, **kwargs):
1548 """GetDistanceSquare(self, Point2D pt) -> double"""
1549 return _core_.Point2D_GetDistanceSquare(*args, **kwargs)
1550
1551 def GetDotProduct(*args, **kwargs):
1552 """GetDotProduct(self, Point2D vec) -> double"""
1553 return _core_.Point2D_GetDotProduct(*args, **kwargs)
1554
1555 def GetCrossProduct(*args, **kwargs):
1556 """GetCrossProduct(self, Point2D vec) -> double"""
1557 return _core_.Point2D_GetCrossProduct(*args, **kwargs)
1558
1559 def __neg__(*args, **kwargs):
1560 """
1561 __neg__(self) -> Point2D
1562
1563 the reflection of this point
1564 """
1565 return _core_.Point2D___neg__(*args, **kwargs)
1566
1567 def __iadd__(*args, **kwargs):
1568 """__iadd__(self, Point2D pt) -> Point2D"""
1569 return _core_.Point2D___iadd__(*args, **kwargs)
1570
1571 def __isub__(*args, **kwargs):
1572 """__isub__(self, Point2D pt) -> Point2D"""
1573 return _core_.Point2D___isub__(*args, **kwargs)
1574
1575 def __imul__(*args, **kwargs):
1576 """__imul__(self, Point2D pt) -> Point2D"""
1577 return _core_.Point2D___imul__(*args, **kwargs)
1578
1579 def __idiv__(*args, **kwargs):
1580 """__idiv__(self, Point2D pt) -> Point2D"""
1581 return _core_.Point2D___idiv__(*args, **kwargs)
1582
1583 def __eq__(*args, **kwargs):
1584 """
e9d6f3a4 1585 __eq__(self, PyObject other) -> bool
d55e5bfc 1586
e9d6f3a4 1587 Test for equality of wx.Point2D objects.
d55e5bfc
RD
1588 """
1589 return _core_.Point2D___eq__(*args, **kwargs)
1590
1591 def __ne__(*args, **kwargs):
1592 """
e9d6f3a4 1593 __ne__(self, PyObject other) -> bool
d55e5bfc 1594
e9d6f3a4 1595 Test for inequality of wx.Point2D objects.
d55e5bfc
RD
1596 """
1597 return _core_.Point2D___ne__(*args, **kwargs)
1598
1599 x = property(_core_.Point2D_x_get, _core_.Point2D_x_set)
1600 y = property(_core_.Point2D_y_get, _core_.Point2D_y_set)
1601 def Set(*args, **kwargs):
1602 """Set(self, double x=0, double y=0)"""
1603 return _core_.Point2D_Set(*args, **kwargs)
1604
1605 def Get(*args, **kwargs):
1606 """
1607 Get() -> (x,y)
1608
1609 Return x and y properties as a tuple.
1610 """
1611 return _core_.Point2D_Get(*args, **kwargs)
1612
79fccf9d 1613 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD
1614 def __str__(self): return str(self.Get())
1615 def __repr__(self): return 'wx.Point2D'+str(self.Get())
1616 def __len__(self): return len(self.Get())
1617 def __getitem__(self, index): return self.Get()[index]
1618 def __setitem__(self, index, val):
1619 if index == 0: self.x = val
1620 elif index == 1: self.y = val
1621 else: raise IndexError
1622 def __nonzero__(self): return self.Get() != (0.0, 0.0)
1623 __safe_for_unpickling__ = True
1624 def __reduce__(self): return (wx.Point2D, self.Get())
1625
33d6fd3b
RD
1626 Floor = property(GetFloor,doc="See `GetFloor`")
1627 Rounded = property(GetRounded,doc="See `GetRounded`")
1628 VectorAngle = property(GetVectorAngle,SetVectorAngle,doc="See `GetVectorAngle` and `SetVectorAngle`")
1629 VectorLength = property(GetVectorLength,SetVectorLength,doc="See `GetVectorLength` and `SetVectorLength`")
2131d850 1630_core_.Point2D_swigregister(Point2D)
d55e5bfc
RD
1631
1632def Point2DCopy(*args, **kwargs):
1633 """
1634 Point2DCopy(Point2D pt) -> Point2D
1635
1636 Create a w.Point2D object.
1637 """
1638 val = _core_.new_Point2DCopy(*args, **kwargs)
d55e5bfc
RD
1639 return val
1640
1641def Point2DFromPoint(*args, **kwargs):
1642 """
1643 Point2DFromPoint(Point pt) -> Point2D
1644
1645 Create a w.Point2D object.
1646 """
1647 val = _core_.new_Point2DFromPoint(*args, **kwargs)
d55e5bfc
RD
1648 return val
1649
1650#---------------------------------------------------------------------------
1651
1652FromStart = _core_.FromStart
1653FromCurrent = _core_.FromCurrent
1654FromEnd = _core_.FromEnd
1655class InputStream(object):
093d3ff1 1656 """Proxy of C++ InputStream class"""
554f62e9
RD
1657 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1658 __repr__ = _swig_repr
1659 def __init__(self, *args, **kwargs):
d55e5bfc 1660 """__init__(self, PyObject p) -> InputStream"""
554f62e9
RD
1661 _core_.InputStream_swiginit(self,_core_.new_InputStream(*args, **kwargs))
1662 __swig_destroy__ = _core_.delete_InputStream
1663 __del__ = lambda self : None;
d55e5bfc
RD
1664 def close(*args, **kwargs):
1665 """close(self)"""
1666 return _core_.InputStream_close(*args, **kwargs)
1667
1668 def flush(*args, **kwargs):
1669 """flush(self)"""
1670 return _core_.InputStream_flush(*args, **kwargs)
1671
1672 def eof(*args, **kwargs):
1673 """eof(self) -> bool"""
1674 return _core_.InputStream_eof(*args, **kwargs)
1675
1676 def read(*args, **kwargs):
1677 """read(self, int size=-1) -> PyObject"""
1678 return _core_.InputStream_read(*args, **kwargs)
1679
1680 def readline(*args, **kwargs):
1681 """readline(self, int size=-1) -> PyObject"""
1682 return _core_.InputStream_readline(*args, **kwargs)
1683
1684 def readlines(*args, **kwargs):
1685 """readlines(self, int sizehint=-1) -> PyObject"""
1686 return _core_.InputStream_readlines(*args, **kwargs)
1687
1688 def seek(*args, **kwargs):
1689 """seek(self, int offset, int whence=0)"""
1690 return _core_.InputStream_seek(*args, **kwargs)
1691
1692 def tell(*args, **kwargs):
1693 """tell(self) -> int"""
1694 return _core_.InputStream_tell(*args, **kwargs)
1695
1696 def Peek(*args, **kwargs):
1697 """Peek(self) -> char"""
1698 return _core_.InputStream_Peek(*args, **kwargs)
1699
1700 def GetC(*args, **kwargs):
1701 """GetC(self) -> char"""
1702 return _core_.InputStream_GetC(*args, **kwargs)
1703
1704 def LastRead(*args, **kwargs):
1705 """LastRead(self) -> size_t"""
1706 return _core_.InputStream_LastRead(*args, **kwargs)
1707
1708 def CanRead(*args, **kwargs):
1709 """CanRead(self) -> bool"""
1710 return _core_.InputStream_CanRead(*args, **kwargs)
1711
1712 def Eof(*args, **kwargs):
1713 """Eof(self) -> bool"""
1714 return _core_.InputStream_Eof(*args, **kwargs)
1715
1716 def Ungetch(*args, **kwargs):
1717 """Ungetch(self, char c) -> bool"""
1718 return _core_.InputStream_Ungetch(*args, **kwargs)
1719
1720 def SeekI(*args, **kwargs):
1721 """SeekI(self, long pos, int mode=FromStart) -> long"""
1722 return _core_.InputStream_SeekI(*args, **kwargs)
1723
1724 def TellI(*args, **kwargs):
1725 """TellI(self) -> long"""
1726 return _core_.InputStream_TellI(*args, **kwargs)
1727
2131d850 1728_core_.InputStream_swigregister(InputStream)
d55e5bfc
RD
1729DefaultPosition = cvar.DefaultPosition
1730DefaultSize = cvar.DefaultSize
1731
1732class OutputStream(object):
093d3ff1 1733 """Proxy of C++ OutputStream class"""
554f62e9
RD
1734 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1735 def __init__(self): raise AttributeError, "No constructor defined"
1736 __repr__ = _swig_repr
d55e5bfc
RD
1737 def write(*args, **kwargs):
1738 """write(self, PyObject obj)"""
1739 return _core_.OutputStream_write(*args, **kwargs)
1740
554f62e9
RD
1741 def LastWrite(*args, **kwargs):
1742 """LastWrite(self) -> size_t"""
1743 return _core_.OutputStream_LastWrite(*args, **kwargs)
d55e5bfc 1744
2131d850 1745_core_.OutputStream_swigregister(OutputStream)
d55e5bfc
RD
1746
1747#---------------------------------------------------------------------------
1748
1749class FSFile(Object):
093d3ff1 1750 """Proxy of C++ FSFile class"""
554f62e9
RD
1751 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1752 __repr__ = _swig_repr
1753 def __init__(self, *args, **kwargs):
d55e5bfc
RD
1754 """
1755 __init__(self, InputStream stream, String loc, String mimetype, String anchor,
1756 DateTime modif) -> FSFile
1757 """
554f62e9 1758 _core_.FSFile_swiginit(self,_core_.new_FSFile(*args, **kwargs))
554f62e9
RD
1759 __swig_destroy__ = _core_.delete_FSFile
1760 __del__ = lambda self : None;
d55e5bfc
RD
1761 def GetStream(*args, **kwargs):
1762 """GetStream(self) -> InputStream"""
1763 return _core_.FSFile_GetStream(*args, **kwargs)
1764
97ab0f6a
RD
1765 def DetachStream(*args, **kwargs):
1766 """DetachStream(self)"""
1767 return _core_.FSFile_DetachStream(*args, **kwargs)
1768
d55e5bfc
RD
1769 def GetMimeType(*args, **kwargs):
1770 """GetMimeType(self) -> String"""
1771 return _core_.FSFile_GetMimeType(*args, **kwargs)
1772
1773 def GetLocation(*args, **kwargs):
1774 """GetLocation(self) -> String"""
1775 return _core_.FSFile_GetLocation(*args, **kwargs)
1776
1777 def GetAnchor(*args, **kwargs):
1778 """GetAnchor(self) -> String"""
1779 return _core_.FSFile_GetAnchor(*args, **kwargs)
1780
1781 def GetModificationTime(*args, **kwargs):
1782 """GetModificationTime(self) -> DateTime"""
1783 return _core_.FSFile_GetModificationTime(*args, **kwargs)
1784
97ab0f6a
RD
1785 Anchor = property(GetAnchor,doc="See `GetAnchor`")
1786 Location = property(GetLocation,doc="See `GetLocation`")
1787 MimeType = property(GetMimeType,doc="See `GetMimeType`")
1788 ModificationTime = property(GetModificationTime,doc="See `GetModificationTime`")
1789 Stream = property(GetStream,doc="See `GetStream`")
2131d850 1790_core_.FSFile_swigregister(FSFile)
d55e5bfc
RD
1791
1792class CPPFileSystemHandler(object):
093d3ff1 1793 """Proxy of C++ CPPFileSystemHandler class"""
554f62e9
RD
1794 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1795 def __init__(self): raise AttributeError, "No constructor defined"
1796 __repr__ = _swig_repr
50f151d7
RD
1797 __swig_destroy__ = _core_.delete_CPPFileSystemHandler
1798 __del__ = lambda self : None;
2131d850 1799_core_.CPPFileSystemHandler_swigregister(CPPFileSystemHandler)
d55e5bfc
RD
1800
1801class FileSystemHandler(CPPFileSystemHandler):
093d3ff1 1802 """Proxy of C++ FileSystemHandler class"""
554f62e9
RD
1803 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1804 __repr__ = _swig_repr
1805 def __init__(self, *args, **kwargs):
d55e5bfc 1806 """__init__(self) -> FileSystemHandler"""
554f62e9 1807 _core_.FileSystemHandler_swiginit(self,_core_.new_FileSystemHandler(*args, **kwargs))
d55e5bfc
RD
1808 self._setCallbackInfo(self, FileSystemHandler)
1809
1810 def _setCallbackInfo(*args, **kwargs):
1811 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
1812 return _core_.FileSystemHandler__setCallbackInfo(*args, **kwargs)
1813
1814 def CanOpen(*args, **kwargs):
1815 """CanOpen(self, String location) -> bool"""
1816 return _core_.FileSystemHandler_CanOpen(*args, **kwargs)
1817
1818 def OpenFile(*args, **kwargs):
1819 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
1820 return _core_.FileSystemHandler_OpenFile(*args, **kwargs)
1821
1822 def FindFirst(*args, **kwargs):
1823 """FindFirst(self, String spec, int flags=0) -> String"""
1824 return _core_.FileSystemHandler_FindFirst(*args, **kwargs)
1825
1826 def FindNext(*args, **kwargs):
1827 """FindNext(self) -> String"""
1828 return _core_.FileSystemHandler_FindNext(*args, **kwargs)
1829
1830 def GetProtocol(*args, **kwargs):
1831 """GetProtocol(self, String location) -> String"""
1832 return _core_.FileSystemHandler_GetProtocol(*args, **kwargs)
1833
1834 def GetLeftLocation(*args, **kwargs):
1835 """GetLeftLocation(self, String location) -> String"""
1836 return _core_.FileSystemHandler_GetLeftLocation(*args, **kwargs)
1837
1838 def GetAnchor(*args, **kwargs):
1839 """GetAnchor(self, String location) -> String"""
1840 return _core_.FileSystemHandler_GetAnchor(*args, **kwargs)
1841
1842 def GetRightLocation(*args, **kwargs):
1843 """GetRightLocation(self, String location) -> String"""
1844 return _core_.FileSystemHandler_GetRightLocation(*args, **kwargs)
1845
1846 def GetMimeTypeFromExt(*args, **kwargs):
1847 """GetMimeTypeFromExt(self, String location) -> String"""
1848 return _core_.FileSystemHandler_GetMimeTypeFromExt(*args, **kwargs)
1849
97ab0f6a
RD
1850 Anchor = property(GetAnchor,doc="See `GetAnchor`")
1851 LeftLocation = property(GetLeftLocation,doc="See `GetLeftLocation`")
1852 MimeTypeFromExt = property(GetMimeTypeFromExt,doc="See `GetMimeTypeFromExt`")
1853 Protocol = property(GetProtocol,doc="See `GetProtocol`")
1854 RightLocation = property(GetRightLocation,doc="See `GetRightLocation`")
2131d850 1855_core_.FileSystemHandler_swigregister(FileSystemHandler)
d55e5bfc
RD
1856
1857class FileSystem(Object):
093d3ff1 1858 """Proxy of C++ FileSystem class"""
554f62e9
RD
1859 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1860 __repr__ = _swig_repr
1861 def __init__(self, *args, **kwargs):
d55e5bfc 1862 """__init__(self) -> FileSystem"""
554f62e9
RD
1863 _core_.FileSystem_swiginit(self,_core_.new_FileSystem(*args, **kwargs))
1864 __swig_destroy__ = _core_.delete_FileSystem
1865 __del__ = lambda self : None;
d55e5bfc
RD
1866 def ChangePathTo(*args, **kwargs):
1867 """ChangePathTo(self, String location, bool is_dir=False)"""
1868 return _core_.FileSystem_ChangePathTo(*args, **kwargs)
1869
1870 def GetPath(*args, **kwargs):
1871 """GetPath(self) -> String"""
1872 return _core_.FileSystem_GetPath(*args, **kwargs)
1873
1874 def OpenFile(*args, **kwargs):
1875 """OpenFile(self, String location) -> FSFile"""
1876 return _core_.FileSystem_OpenFile(*args, **kwargs)
1877
1878 def FindFirst(*args, **kwargs):
1879 """FindFirst(self, String spec, int flags=0) -> String"""
1880 return _core_.FileSystem_FindFirst(*args, **kwargs)
1881
1882 def FindNext(*args, **kwargs):
1883 """FindNext(self) -> String"""
1884 return _core_.FileSystem_FindNext(*args, **kwargs)
1885
1886 def AddHandler(*args, **kwargs):
c24da6d6 1887 """AddHandler(CPPFileSystemHandler handler)"""
d55e5bfc
RD
1888 return _core_.FileSystem_AddHandler(*args, **kwargs)
1889
1890 AddHandler = staticmethod(AddHandler)
97ab0f6a
RD
1891 def RemoveHandler(*args, **kwargs):
1892 """RemoveHandler(CPPFileSystemHandler handler) -> CPPFileSystemHandler"""
1893 return _core_.FileSystem_RemoveHandler(*args, **kwargs)
1894
1895 RemoveHandler = staticmethod(RemoveHandler)
d55e5bfc 1896 def CleanUpHandlers(*args, **kwargs):
c24da6d6 1897 """CleanUpHandlers()"""
d55e5bfc
RD
1898 return _core_.FileSystem_CleanUpHandlers(*args, **kwargs)
1899
1900 CleanUpHandlers = staticmethod(CleanUpHandlers)
1901 def FileNameToURL(*args, **kwargs):
c24da6d6 1902 """FileNameToURL(String filename) -> String"""
d55e5bfc
RD
1903 return _core_.FileSystem_FileNameToURL(*args, **kwargs)
1904
1905 FileNameToURL = staticmethod(FileNameToURL)
ae8162c8
RD
1906 def URLToFileName(*args, **kwargs):
1907 """URLToFileName(String url) -> String"""
1908 return _core_.FileSystem_URLToFileName(*args, **kwargs)
1909
1910 URLToFileName = staticmethod(URLToFileName)
97ab0f6a 1911 Path = property(GetPath,doc="See `GetPath`")
2131d850 1912_core_.FileSystem_swigregister(FileSystem)
d55e5bfc
RD
1913
1914def FileSystem_AddHandler(*args, **kwargs):
554f62e9
RD
1915 """FileSystem_AddHandler(CPPFileSystemHandler handler)"""
1916 return _core_.FileSystem_AddHandler(*args, **kwargs)
d55e5bfc 1917
97ab0f6a
RD
1918def FileSystem_RemoveHandler(*args, **kwargs):
1919 """FileSystem_RemoveHandler(CPPFileSystemHandler handler) -> CPPFileSystemHandler"""
1920 return _core_.FileSystem_RemoveHandler(*args, **kwargs)
1921
554f62e9
RD
1922def FileSystem_CleanUpHandlers(*args):
1923 """FileSystem_CleanUpHandlers()"""
1924 return _core_.FileSystem_CleanUpHandlers(*args)
d55e5bfc
RD
1925
1926def FileSystem_FileNameToURL(*args, **kwargs):
554f62e9
RD
1927 """FileSystem_FileNameToURL(String filename) -> String"""
1928 return _core_.FileSystem_FileNameToURL(*args, **kwargs)
d55e5bfc 1929
d55e5bfc 1930def FileSystem_URLToFileName(*args, **kwargs):
554f62e9
RD
1931 """FileSystem_URLToFileName(String url) -> String"""
1932 return _core_.FileSystem_URLToFileName(*args, **kwargs)
ae8162c8 1933
d55e5bfc 1934class InternetFSHandler(CPPFileSystemHandler):
093d3ff1 1935 """Proxy of C++ InternetFSHandler class"""
554f62e9
RD
1936 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1937 __repr__ = _swig_repr
1938 def __init__(self, *args, **kwargs):
d55e5bfc 1939 """__init__(self) -> InternetFSHandler"""
554f62e9 1940 _core_.InternetFSHandler_swiginit(self,_core_.new_InternetFSHandler(*args, **kwargs))
d55e5bfc
RD
1941 def CanOpen(*args, **kwargs):
1942 """CanOpen(self, String location) -> bool"""
1943 return _core_.InternetFSHandler_CanOpen(*args, **kwargs)
1944
1945 def OpenFile(*args, **kwargs):
1946 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
1947 return _core_.InternetFSHandler_OpenFile(*args, **kwargs)
1948
2131d850 1949_core_.InternetFSHandler_swigregister(InternetFSHandler)
d55e5bfc
RD
1950
1951class ZipFSHandler(CPPFileSystemHandler):
093d3ff1 1952 """Proxy of C++ ZipFSHandler class"""
554f62e9
RD
1953 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1954 __repr__ = _swig_repr
1955 def __init__(self, *args, **kwargs):
d55e5bfc 1956 """__init__(self) -> ZipFSHandler"""
554f62e9 1957 _core_.ZipFSHandler_swiginit(self,_core_.new_ZipFSHandler(*args, **kwargs))
d55e5bfc
RD
1958 def CanOpen(*args, **kwargs):
1959 """CanOpen(self, String location) -> bool"""
1960 return _core_.ZipFSHandler_CanOpen(*args, **kwargs)
1961
1962 def OpenFile(*args, **kwargs):
1963 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
1964 return _core_.ZipFSHandler_OpenFile(*args, **kwargs)
1965
1966 def FindFirst(*args, **kwargs):
1967 """FindFirst(self, String spec, int flags=0) -> String"""
1968 return _core_.ZipFSHandler_FindFirst(*args, **kwargs)
1969
1970 def FindNext(*args, **kwargs):
1971 """FindNext(self) -> String"""
1972 return _core_.ZipFSHandler_FindNext(*args, **kwargs)
1973
2131d850 1974_core_.ZipFSHandler_swigregister(ZipFSHandler)
d55e5bfc
RD
1975
1976
1977def __wxMemoryFSHandler_AddFile_wxImage(*args, **kwargs):
554f62e9
RD
1978 """__wxMemoryFSHandler_AddFile_wxImage(String filename, Image image, long type)"""
1979 return _core_.__wxMemoryFSHandler_AddFile_wxImage(*args, **kwargs)
d55e5bfc
RD
1980
1981def __wxMemoryFSHandler_AddFile_wxBitmap(*args, **kwargs):
554f62e9
RD
1982 """__wxMemoryFSHandler_AddFile_wxBitmap(String filename, Bitmap bitmap, long type)"""
1983 return _core_.__wxMemoryFSHandler_AddFile_wxBitmap(*args, **kwargs)
d55e5bfc
RD
1984
1985def __wxMemoryFSHandler_AddFile_Data(*args, **kwargs):
554f62e9
RD
1986 """__wxMemoryFSHandler_AddFile_Data(String filename, PyObject data)"""
1987 return _core_.__wxMemoryFSHandler_AddFile_Data(*args, **kwargs)
ae8162c8
RD
1988def MemoryFSHandler_AddFile(filename, dataItem, imgType=-1):
1989 """
1990 Add 'file' to the memory filesystem. The dataItem parameter can
1991 either be a `wx.Bitmap`, `wx.Image` or a string that can contain
1992 arbitrary data. If a bitmap or image is used then the imgType
1993 parameter should specify what kind of image file it should be
1994 written as, wx.BITMAP_TYPE_PNG, etc.
1995 """
1996 if isinstance(dataItem, wx.Image):
1997 __wxMemoryFSHandler_AddFile_wxImage(filename, dataItem, imgType)
1998 elif isinstance(dataItem, wx.Bitmap):
1999 __wxMemoryFSHandler_AddFile_wxBitmap(filename, dataItem, imgType)
2000 elif type(dataItem) == str:
2001 __wxMemoryFSHandler_AddFile_Data(filename, dataItem)
2002 else:
2003 raise TypeError, 'wx.Image, wx.Bitmap or string expected'
d55e5bfc
RD
2004
2005class MemoryFSHandler(CPPFileSystemHandler):
093d3ff1 2006 """Proxy of C++ MemoryFSHandler class"""
554f62e9
RD
2007 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2008 __repr__ = _swig_repr
2009 def __init__(self, *args, **kwargs):
d55e5bfc 2010 """__init__(self) -> MemoryFSHandler"""
554f62e9 2011 _core_.MemoryFSHandler_swiginit(self,_core_.new_MemoryFSHandler(*args, **kwargs))
d55e5bfc 2012 def RemoveFile(*args, **kwargs):
c24da6d6 2013 """RemoveFile(String filename)"""
d55e5bfc
RD
2014 return _core_.MemoryFSHandler_RemoveFile(*args, **kwargs)
2015
2016 RemoveFile = staticmethod(RemoveFile)
2017 AddFile = staticmethod(MemoryFSHandler_AddFile)
2018 def CanOpen(*args, **kwargs):
2019 """CanOpen(self, String location) -> bool"""
2020 return _core_.MemoryFSHandler_CanOpen(*args, **kwargs)
2021
2022 def OpenFile(*args, **kwargs):
2023 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
2024 return _core_.MemoryFSHandler_OpenFile(*args, **kwargs)
2025
2026 def FindFirst(*args, **kwargs):
2027 """FindFirst(self, String spec, int flags=0) -> String"""
2028 return _core_.MemoryFSHandler_FindFirst(*args, **kwargs)
2029
2030 def FindNext(*args, **kwargs):
2031 """FindNext(self) -> String"""
2032 return _core_.MemoryFSHandler_FindNext(*args, **kwargs)
2033
2131d850 2034_core_.MemoryFSHandler_swigregister(MemoryFSHandler)
d55e5bfc
RD
2035
2036def MemoryFSHandler_RemoveFile(*args, **kwargs):
554f62e9
RD
2037 """MemoryFSHandler_RemoveFile(String filename)"""
2038 return _core_.MemoryFSHandler_RemoveFile(*args, **kwargs)
d55e5bfc 2039
57133d5c
RD
2040IMAGE_ALPHA_TRANSPARENT = _core_.IMAGE_ALPHA_TRANSPARENT
2041IMAGE_ALPHA_THRESHOLD = _core_.IMAGE_ALPHA_THRESHOLD
2042IMAGE_ALPHA_OPAQUE = _core_.IMAGE_ALPHA_OPAQUE
f5263701
RD
2043IMAGE_QUALITY_NORMAL = _core_.IMAGE_QUALITY_NORMAL
2044IMAGE_QUALITY_HIGH = _core_.IMAGE_QUALITY_HIGH
d55e5bfc
RD
2045#---------------------------------------------------------------------------
2046
2047class ImageHandler(Object):
27fb7603
RD
2048 """
2049 This is the base class for implementing image file loading/saving, and
2050 image creation from data. It is used within `wx.Image` and is not
2051 normally seen by the application.
2052 """
554f62e9
RD
2053 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2054 def __init__(self): raise AttributeError, "No constructor defined"
2055 __repr__ = _swig_repr
d55e5bfc
RD
2056 def GetName(*args, **kwargs):
2057 """GetName(self) -> String"""
2058 return _core_.ImageHandler_GetName(*args, **kwargs)
2059
2060 def GetExtension(*args, **kwargs):
2061 """GetExtension(self) -> String"""
2062 return _core_.ImageHandler_GetExtension(*args, **kwargs)
2063
2064 def GetType(*args, **kwargs):
2065 """GetType(self) -> long"""
2066 return _core_.ImageHandler_GetType(*args, **kwargs)
2067
2068 def GetMimeType(*args, **kwargs):
2069 """GetMimeType(self) -> String"""
2070 return _core_.ImageHandler_GetMimeType(*args, **kwargs)
2071
2072 def CanRead(*args, **kwargs):
2073 """CanRead(self, String name) -> bool"""
2074 return _core_.ImageHandler_CanRead(*args, **kwargs)
2075
b02396e8
RD
2076 def CanReadStream(*args, **kwargs):
2077 """CanReadStream(self, InputStream stream) -> bool"""
2078 return _core_.ImageHandler_CanReadStream(*args, **kwargs)
2079
d55e5bfc
RD
2080 def SetName(*args, **kwargs):
2081 """SetName(self, String name)"""
2082 return _core_.ImageHandler_SetName(*args, **kwargs)
2083
2084 def SetExtension(*args, **kwargs):
2085 """SetExtension(self, String extension)"""
2086 return _core_.ImageHandler_SetExtension(*args, **kwargs)
2087
2088 def SetType(*args, **kwargs):
2089 """SetType(self, long type)"""
2090 return _core_.ImageHandler_SetType(*args, **kwargs)
2091
2092 def SetMimeType(*args, **kwargs):
2093 """SetMimeType(self, String mimetype)"""
2094 return _core_.ImageHandler_SetMimeType(*args, **kwargs)
2095
97ab0f6a
RD
2096 Extension = property(GetExtension,SetExtension,doc="See `GetExtension` and `SetExtension`")
2097 MimeType = property(GetMimeType,SetMimeType,doc="See `GetMimeType` and `SetMimeType`")
2098 Name = property(GetName,SetName,doc="See `GetName` and `SetName`")
2099 Type = property(GetType,SetType,doc="See `GetType` and `SetType`")
2131d850 2100_core_.ImageHandler_swigregister(ImageHandler)
d55e5bfc 2101
9d7dfdff
RD
2102class PyImageHandler(ImageHandler):
2103 """
2104 This is the base class for implementing image file loading/saving, and
2105 image creation from data, all written in Python. To create a custom
2106 image handler derive a new class from wx.PyImageHandler and provide
2107 the following methods::
2108
2109 def DoCanRead(self, stream) --> bool
2110 '''Check if this handler can read the image on the stream'''
2111
2112 def LoadFile(self, image, stream, verbose, index) --> bool
2113 '''Load image data from the stream and load it into image.'''
2114
2115 def SaveFile(self, image, stream, verbose) --> bool
2116 '''Save the iamge data in image to the stream using
2117 this handler's image file format.'''
2118
2119 def GetImageCount(self, stream) --> int
2120 '''If this image format can hold more than one image,
2121 how many does the image on the stream have?'''
2122
2123 To activate your handler create an instance of it and pass it to
2124 `wx.Image_AddHandler`. Be sure to call `SetName`, `SetType`, and
2125 `SetExtension` from your constructor.
2126
2127 """
554f62e9
RD
2128 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2129 __repr__ = _swig_repr
2130 def __init__(self, *args, **kwargs):
9d7dfdff
RD
2131 """
2132 __init__(self) -> PyImageHandler
2133
2134 This is the base class for implementing image file loading/saving, and
2135 image creation from data, all written in Python. To create a custom
2136 image handler derive a new class from wx.PyImageHandler and provide
2137 the following methods::
2138
2139 def DoCanRead(self, stream) --> bool
2140 '''Check if this handler can read the image on the stream'''
2141
2142 def LoadFile(self, image, stream, verbose, index) --> bool
2143 '''Load image data from the stream and load it into image.'''
2144
2145 def SaveFile(self, image, stream, verbose) --> bool
2146 '''Save the iamge data in image to the stream using
2147 this handler's image file format.'''
2148
2149 def GetImageCount(self, stream) --> int
2150 '''If this image format can hold more than one image,
2151 how many does the image on the stream have?'''
2152
2153 To activate your handler create an instance of it and pass it to
2154 `wx.Image_AddHandler`. Be sure to call `SetName`, `SetType`, and
2155 `SetExtension` from your constructor.
2156
2157 """
554f62e9 2158 _core_.PyImageHandler_swiginit(self,_core_.new_PyImageHandler(*args, **kwargs))
9d7dfdff
RD
2159 self._SetSelf(self)
2160
2161 def _SetSelf(*args, **kwargs):
2162 """_SetSelf(self, PyObject self)"""
2163 return _core_.PyImageHandler__SetSelf(*args, **kwargs)
2164
2131d850 2165_core_.PyImageHandler_swigregister(PyImageHandler)
9d7dfdff 2166
d55e5bfc 2167class ImageHistogram(object):
093d3ff1 2168 """Proxy of C++ ImageHistogram class"""
554f62e9
RD
2169 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2170 __repr__ = _swig_repr
2171 def __init__(self, *args, **kwargs):
d55e5bfc 2172 """__init__(self) -> ImageHistogram"""
554f62e9 2173 _core_.ImageHistogram_swiginit(self,_core_.new_ImageHistogram(*args, **kwargs))
d55e5bfc
RD
2174 def MakeKey(*args, **kwargs):
2175 """
7a27cf7c 2176 MakeKey(byte r, byte g, byte b) -> unsigned long
d55e5bfc
RD
2177
2178 Get the key in the histogram for the given RGB values
2179 """
2180 return _core_.ImageHistogram_MakeKey(*args, **kwargs)
2181
2182 MakeKey = staticmethod(MakeKey)
2183 def FindFirstUnusedColour(*args, **kwargs):
a8eff060
RD
2184 """
2185 FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)
2186
2187 Find first colour that is not used in the image and has higher RGB
2188 values than startR, startG, startB. Returns a tuple consisting of a
2189 success flag and rgb values.
2190 """
d55e5bfc
RD
2191 return _core_.ImageHistogram_FindFirstUnusedColour(*args, **kwargs)
2192
f1cbd8fa
RD
2193 def GetCount(*args, **kwargs):
2194 """
2195 GetCount(self, unsigned long key) -> unsigned long
2196
2197 Returns the pixel count for the given key. Use `MakeKey` to create a
2198 key value from a RGB tripple.
2199 """
2200 return _core_.ImageHistogram_GetCount(*args, **kwargs)
2201
2202 def GetCountRGB(*args, **kwargs):
2203 """
7a27cf7c 2204 GetCountRGB(self, byte r, byte g, byte b) -> unsigned long
f1cbd8fa
RD
2205
2206 Returns the pixel count for the given RGB values.
2207 """
2208 return _core_.ImageHistogram_GetCountRGB(*args, **kwargs)
2209
2210 def GetCountColour(*args, **kwargs):
2211 """
2212 GetCountColour(self, Colour colour) -> unsigned long
2213
2214 Returns the pixel count for the given `wx.Colour` value.
2215 """
2216 return _core_.ImageHistogram_GetCountColour(*args, **kwargs)
2217
2131d850 2218_core_.ImageHistogram_swigregister(ImageHistogram)
d55e5bfc
RD
2219
2220def ImageHistogram_MakeKey(*args, **kwargs):
554f62e9 2221 """
7a27cf7c 2222 ImageHistogram_MakeKey(byte r, byte g, byte b) -> unsigned long
d55e5bfc
RD
2223
2224 Get the key in the histogram for the given RGB values
2225 """
554f62e9 2226 return _core_.ImageHistogram_MakeKey(*args, **kwargs)
d55e5bfc 2227
2f91e3df 2228class Image_RGBValue(object):
9d7dfdff
RD
2229 """
2230 An object that contains values for red, green and blue which represent
2231 the value of a color. It is used by `wx.Image.HSVtoRGB` and
2232 `wx.Image.RGBtoHSV`, which converts between HSV color space and RGB
2233 color space.
2234 """
554f62e9
RD
2235 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2236 __repr__ = _swig_repr
2237 def __init__(self, *args, **kwargs):
9d7dfdff
RD
2238 """
2239 __init__(self, byte r=0, byte g=0, byte b=0) -> Image_RGBValue
2240
2241 Constructor.
2242 """
554f62e9 2243 _core_.Image_RGBValue_swiginit(self,_core_.new_Image_RGBValue(*args, **kwargs))
2f91e3df
KO
2244 red = property(_core_.Image_RGBValue_red_get, _core_.Image_RGBValue_red_set)
2245 green = property(_core_.Image_RGBValue_green_get, _core_.Image_RGBValue_green_set)
2246 blue = property(_core_.Image_RGBValue_blue_get, _core_.Image_RGBValue_blue_set)
2131d850 2247_core_.Image_RGBValue_swigregister(Image_RGBValue)
2f91e3df
KO
2248
2249class Image_HSVValue(object):
9d7dfdff
RD
2250 """
2251 An object that contains values for hue, saturation and value which
2252 represent the value of a color. It is used by `wx.Image.HSVtoRGB` and
2253 `wx.Image.RGBtoHSV`, which +converts between HSV color space and RGB
2254 color space.
2255 """
554f62e9
RD
2256 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2257 __repr__ = _swig_repr
2258 def __init__(self, *args, **kwargs):
9d7dfdff
RD
2259 """
2260 __init__(self, double h=0.0, double s=0.0, double v=0.0) -> Image_HSVValue
2261
2262 Constructor.
2263 """
554f62e9 2264 _core_.Image_HSVValue_swiginit(self,_core_.new_Image_HSVValue(*args, **kwargs))
2f91e3df
KO
2265 hue = property(_core_.Image_HSVValue_hue_get, _core_.Image_HSVValue_hue_set)
2266 saturation = property(_core_.Image_HSVValue_saturation_get, _core_.Image_HSVValue_saturation_set)
2267 value = property(_core_.Image_HSVValue_value_get, _core_.Image_HSVValue_value_set)
2131d850 2268_core_.Image_HSVValue_swigregister(Image_HSVValue)
2f91e3df 2269
d55e5bfc 2270class Image(Object):
7a27cf7c
RD
2271 """
2272 A platform-independent image class. An image can be created from
2273 data, or using `wx.Bitmap.ConvertToImage`, or loaded from a file in a
2274 variety of formats. Functions are available to set and get image
2275 bits, so it can be used for basic image manipulation.
2276
2277 A wx.Image cannot be drawn directly to a `wx.DC`. Instead, a
2278 platform-specific `wx.Bitmap` object must be created from it using the
2279 `wx.BitmapFromImage` constructor. This bitmap can then be drawn in a
2280 device context, using `wx.DC.DrawBitmap`.
2281
2282 One colour value of the image may be used as a mask colour which will
2283 lead to the automatic creation of a `wx.Mask` object associated to the
2284 bitmap object.
2285
2286 wx.Image supports alpha channel data, that is in addition to a byte
2287 for the red, green and blue colour components for each pixel it also
2288 stores a byte representing the pixel opacity. An alpha value of 0
2289 corresponds to a transparent pixel (null opacity) while a value of 255
2290 means that the pixel is 100% opaque.
2291
2292 Unlike RGB data, not all images have an alpha channel and before using
2293 `GetAlpha` you should check if this image contains an alpha channel
2294 with `HasAlpha`. Note that currently only images loaded from PNG files
2295 with transparency information will have an alpha channel.
2296 """
554f62e9
RD
2297 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2298 __repr__ = _swig_repr
2299 def __init__(self, *args, **kwargs):
7a27cf7c
RD
2300 """
2301 __init__(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> Image
2302
2303 Loads an image from a file.
2304 """
554f62e9
RD
2305 _core_.Image_swiginit(self,_core_.new_Image(*args, **kwargs))
2306 __swig_destroy__ = _core_.delete_Image
2307 __del__ = lambda self : None;
d55e5bfc 2308 def Create(*args, **kwargs):
7a27cf7c
RD
2309 """
2310 Create(self, int width, int height, bool clear=True)
2311
2312 Creates a fresh image. If clear is ``True``, the new image will be
2313 initialized to black. Otherwise, the image data will be uninitialized.
2314 """
d55e5bfc
RD
2315 return _core_.Image_Create(*args, **kwargs)
2316
2317 def Destroy(*args, **kwargs):
2318 """
2319 Destroy(self)
2320
7a27cf7c 2321 Destroys the image data.
d55e5bfc 2322 """
b39fe951
RD
2323 args[0].this.own(False)
2324 return _core_.Image_Destroy(*args, **kwargs)
d55e5bfc
RD
2325
2326 def Scale(*args, **kwargs):
7a27cf7c 2327 """
f5263701 2328 Scale(self, int width, int height, int quality=IMAGE_QUALITY_NORMAL) -> Image
7a27cf7c
RD
2329
2330 Returns a scaled version of the image. This is also useful for scaling
2331 bitmaps in general as the only other way to scale bitmaps is to blit a
f5263701
RD
2332 `wx.MemoryDC` into another `wx.MemoryDC`. The ``quality`` parameter
2333 specifies what method to use for resampling the image. It can be
2334 either wx.IMAGE_QUALITY_NORMAL, which uses the normal default scaling
2335 method of pixel replication, or wx.IMAGE_QUALITY_HIGH which uses
2336 bicubic and box averaging resampling methods for upsampling and
2337 downsampling respectively.
7a27cf7c 2338 """
d55e5bfc
RD
2339 return _core_.Image_Scale(*args, **kwargs)
2340
f5263701
RD
2341 def ResampleBox(*args, **kwargs):
2342 """ResampleBox(self, int width, int height) -> Image"""
2343 return _core_.Image_ResampleBox(*args, **kwargs)
2344
2345 def ResampleBicubic(*args, **kwargs):
2346 """ResampleBicubic(self, int width, int height) -> Image"""
2347 return _core_.Image_ResampleBicubic(*args, **kwargs)
2348
2349 def Blur(*args, **kwargs):
2350 """
2351 Blur(self, int radius) -> Image
2352
2353 Blurs the image in both horizontal and vertical directions by the
2354 specified pixel ``radius``. This should not be used when using a
2355 single mask colour for transparency.
2356 """
2357 return _core_.Image_Blur(*args, **kwargs)
2358
2359 def BlurHorizontal(*args, **kwargs):
2360 """
2361 BlurHorizontal(self, int radius) -> Image
2362
2363 Blurs the image in the horizontal direction only. This should not be
2364 used when using a single mask colour for transparency.
2365
2366 """
2367 return _core_.Image_BlurHorizontal(*args, **kwargs)
2368
2369 def BlurVertical(*args, **kwargs):
2370 """
2371 BlurVertical(self, int radius) -> Image
2372
2373 Blurs the image in the vertical direction only. This should not be
2374 used when using a single mask colour for transparency.
2375 """
2376 return _core_.Image_BlurVertical(*args, **kwargs)
2377
d55e5bfc 2378 def ShrinkBy(*args, **kwargs):
7a27cf7c
RD
2379 """
2380 ShrinkBy(self, int xFactor, int yFactor) -> Image
2381
2382 Return a version of the image scaled smaller by the given factors.
2383 """
d55e5bfc
RD
2384 return _core_.Image_ShrinkBy(*args, **kwargs)
2385
2386 def Rescale(*args, **kwargs):
7a27cf7c 2387 """
f5263701 2388 Rescale(self, int width, int height, int quality=IMAGE_QUALITY_NORMAL) -> Image
7a27cf7c
RD
2389
2390 Changes the size of the image in-place by scaling it: after a call to
2391 this function, the image will have the given width and height.
2392
2393 Returns the (modified) image itself.
2394 """
d55e5bfc
RD
2395 return _core_.Image_Rescale(*args, **kwargs)
2396
aff4cc5c 2397 def Resize(*args, **kwargs):
7a27cf7c
RD
2398 """
2399 Resize(self, Size size, Point pos, int r=-1, int g=-1, int b=-1) -> Image
2400
2401 Changes the size of the image in-place without scaling it, by adding
2402 either a border with the given colour or cropping as necessary. The
2403 image is pasted into a new image with the given size and background
2404 colour at the position pos relative to the upper left of the new
2405 image. If red = green = blue = -1 then use either the current mask
2406 colour if set or find, use, and set a suitable mask colour for any
2407 newly exposed areas.
2408
2409 Returns the (modified) image itself.
2410 """
aff4cc5c
RD
2411 return _core_.Image_Resize(*args, **kwargs)
2412
d55e5bfc 2413 def SetRGB(*args, **kwargs):
7a27cf7c
RD
2414 """
2415 SetRGB(self, int x, int y, byte r, byte g, byte b)
2416
2417 Sets the pixel at the given coordinate. This routine performs
2418 bounds-checks for the coordinate so it can be considered a safe way to
2419 manipulate the data, but in some cases this might be too slow so that
2420 the data will have to be set directly. In that case you will have to
2421 get access to the image data using the `GetData` method.
2422 """
d55e5bfc
RD
2423 return _core_.Image_SetRGB(*args, **kwargs)
2424
aff4cc5c 2425 def SetRGBRect(*args, **kwargs):
7a27cf7c
RD
2426 """
2427 SetRGBRect(self, Rect rect, byte r, byte g, byte b)
2428
2429 Sets the colour of the pixels within the given rectangle. This routine
2430 performs bounds-checks for the rectangle so it can be considered a
2431 safe way to manipulate the data.
2432 """
aff4cc5c
RD
2433 return _core_.Image_SetRGBRect(*args, **kwargs)
2434
d55e5bfc 2435 def GetRed(*args, **kwargs):
7a27cf7c
RD
2436 """
2437 GetRed(self, int x, int y) -> byte
2438
2439 Returns the red intensity at the given coordinate.
2440 """
d55e5bfc
RD
2441 return _core_.Image_GetRed(*args, **kwargs)
2442
2443 def GetGreen(*args, **kwargs):
7a27cf7c
RD
2444 """
2445 GetGreen(self, int x, int y) -> byte
2446
2447 Returns the green intensity at the given coordinate.
2448 """
d55e5bfc
RD
2449 return _core_.Image_GetGreen(*args, **kwargs)
2450
2451 def GetBlue(*args, **kwargs):
7a27cf7c
RD
2452 """
2453 GetBlue(self, int x, int y) -> byte
2454
2455 Returns the blue intensity at the given coordinate.
2456 """
d55e5bfc
RD
2457 return _core_.Image_GetBlue(*args, **kwargs)
2458
2459 def SetAlpha(*args, **kwargs):
7a27cf7c
RD
2460 """
2461 SetAlpha(self, int x, int y, byte alpha)
2462
2463 Sets the alpha value for the given pixel. This function should only be
2464 called if the image has alpha channel data, use `HasAlpha` to check
2465 for this.
2466 """
d55e5bfc
RD
2467 return _core_.Image_SetAlpha(*args, **kwargs)
2468
2469 def GetAlpha(*args, **kwargs):
7a27cf7c
RD
2470 """
2471 GetAlpha(self, int x, int y) -> byte
2472
2473 Returns the alpha value for the given pixel. This function may only be
2474 called for the images with alpha channel, use `HasAlpha` to check for
2475 this.
2476
2477 The returned value is the *opacity* of the image, i.e. the value of 0
2478 corresponds to the fully transparent pixels while the value of 255 to
2479 the fully opaque pixels.
2480 """
d55e5bfc
RD
2481 return _core_.Image_GetAlpha(*args, **kwargs)
2482
2483 def HasAlpha(*args, **kwargs):
7a27cf7c
RD
2484 """
2485 HasAlpha(self) -> bool
2486
2487 Returns true if this image has alpha channel, false otherwise.
2488 """
d55e5bfc
RD
2489 return _core_.Image_HasAlpha(*args, **kwargs)
2490
68350608
RD
2491 def InitAlpha(*args, **kwargs):
2492 """
2493 InitAlpha(self)
2494
2495 Initializes the image alpha channel data. It is an error to call it if
2496 the image already has alpha data. If it doesn't, alpha data will be by
2497 default initialized to all pixels being fully opaque. But if the image
2498 has a a mask colour, all mask pixels will be completely transparent.
2499 """
2500 return _core_.Image_InitAlpha(*args, **kwargs)
2501
57133d5c
RD
2502 def IsTransparent(*args, **kwargs):
2503 """
7a27cf7c 2504 IsTransparent(self, int x, int y, byte threshold=IMAGE_ALPHA_THRESHOLD) -> bool
57133d5c 2505
7a27cf7c
RD
2506 Returns ``True`` if this pixel is masked or has an alpha value less
2507 than the spcified threshold.
57133d5c
RD
2508 """
2509 return _core_.Image_IsTransparent(*args, **kwargs)
2510
d55e5bfc 2511 def FindFirstUnusedColour(*args, **kwargs):
a8eff060
RD
2512 """
2513 FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)
2514
2515 Find first colour that is not used in the image and has higher RGB
2516 values than startR, startG, startB. Returns a tuple consisting of a
2517 success flag and rgb values.
2518 """
d55e5bfc
RD
2519 return _core_.Image_FindFirstUnusedColour(*args, **kwargs)
2520
4cf4100f
RD
2521 def ConvertAlphaToMask(*args, **kwargs):
2522 """
57133d5c 2523 ConvertAlphaToMask(self, byte threshold=IMAGE_ALPHA_THRESHOLD) -> bool
4cf4100f 2524
7a27cf7c
RD
2525 If the image has alpha channel, this method converts it to mask. All
2526 pixels with alpha value less than ``threshold`` are replaced with the
2527 mask colour and the alpha channel is removed. The mask colour is
2528 chosen automatically using `FindFirstUnusedColour`.
4cf4100f
RD
2529
2530 If the image image doesn't have alpha channel, ConvertAlphaToMask does
2531 nothing.
2532 """
2533 return _core_.Image_ConvertAlphaToMask(*args, **kwargs)
2534
8fb0e70a
RD
2535 def ConvertColourToAlpha(*args, **kwargs):
2536 """
7a27cf7c 2537 ConvertColourToAlpha(self, byte r, byte g, byte b) -> bool
8fb0e70a
RD
2538
2539 This method converts an image where the original alpha information is
2540 only available as a shades of a colour (actually shades of grey)
2541 typically when you draw anti-aliased text into a bitmap. The DC
2542 drawing routines draw grey values on the black background although
2543 they actually mean to draw white with differnt alpha values. This
2544 method reverses it, assuming a black (!) background and white text.
2545 The method will then fill up the whole image with the colour given.
2546 """
2547 return _core_.Image_ConvertColourToAlpha(*args, **kwargs)
2548
d55e5bfc 2549 def SetMaskFromImage(*args, **kwargs):
7a27cf7c
RD
2550 """
2551 SetMaskFromImage(self, Image mask, byte mr, byte mg, byte mb) -> bool
2552
2553 Sets the image's mask so that the pixels that have RGB value of
2554 ``(mr,mg,mb)`` in ``mask`` will be masked in this image. This is done
2555 by first finding an unused colour in the image, setting this colour as
2556 the mask colour and then using this colour to draw all pixels in the
2557 image who corresponding pixel in mask has given RGB value.
2558
2559 Returns ``False`` if ``mask`` does not have same dimensions as the
2560 image or if there is no unused colour left. Returns ``True`` if the
2561 mask was successfully applied.
2562
2563 Note that this method involves computing the histogram, which is
2564 computationally intensive operation.
2565 """
d55e5bfc
RD
2566 return _core_.Image_SetMaskFromImage(*args, **kwargs)
2567
2568 def CanRead(*args, **kwargs):
7a27cf7c
RD
2569 """
2570 CanRead(String filename) -> bool
2571
2572 Returns True if the image handlers can read this file.
2573 """
d55e5bfc
RD
2574 return _core_.Image_CanRead(*args, **kwargs)
2575
2576 CanRead = staticmethod(CanRead)
2577 def GetImageCount(*args, **kwargs):
7a27cf7c
RD
2578 """
2579 GetImageCount(String filename, long type=BITMAP_TYPE_ANY) -> int
2580
2581 If the image file contains more than one image and the image handler
2582 is capable of retrieving these individually, this function will return
2583 the number of available images.
2584 """
d55e5bfc
RD
2585 return _core_.Image_GetImageCount(*args, **kwargs)
2586
2587 GetImageCount = staticmethod(GetImageCount)
2588 def LoadFile(*args, **kwargs):
7a27cf7c
RD
2589 """
2590 LoadFile(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> bool
2591
2592 Loads an image from a file. If no handler type is provided, the
2593 library will try to autodetect the format.
2594 """
d55e5bfc
RD
2595 return _core_.Image_LoadFile(*args, **kwargs)
2596
2597 def LoadMimeFile(*args, **kwargs):
7a27cf7c
RD
2598 """
2599 LoadMimeFile(self, String name, String mimetype, int index=-1) -> bool
2600
2601 Loads an image from a file, specifying the image type with a MIME type
2602 string.
2603 """
d55e5bfc
RD
2604 return _core_.Image_LoadMimeFile(*args, **kwargs)
2605
2606 def SaveFile(*args, **kwargs):
7a27cf7c
RD
2607 """
2608 SaveFile(self, String name, int type) -> bool
2609
2610 Saves an image in the named file.
2611 """
d55e5bfc
RD
2612 return _core_.Image_SaveFile(*args, **kwargs)
2613
2614 def SaveMimeFile(*args, **kwargs):
7a27cf7c
RD
2615 """
2616 SaveMimeFile(self, String name, String mimetype) -> bool
2617
2618 Saves an image in the named file.
2619 """
d55e5bfc
RD
2620 return _core_.Image_SaveMimeFile(*args, **kwargs)
2621
2622 def CanReadStream(*args, **kwargs):
7a27cf7c
RD
2623 """
2624 CanReadStream(InputStream stream) -> bool
2625
2626 Returns True if the image handlers can read an image file from the
2627 data currently on the input stream, or a readable Python file-like
2628 object.
2629 """
d55e5bfc
RD
2630 return _core_.Image_CanReadStream(*args, **kwargs)
2631
2632 CanReadStream = staticmethod(CanReadStream)
2633 def LoadStream(*args, **kwargs):
7a27cf7c
RD
2634 """
2635 LoadStream(self, InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> bool
2636
2637 Loads an image from an input stream or a readable Python file-like
2638 object. If no handler type is provided, the library will try to
2639 autodetect the format.
2640 """
d55e5bfc
RD
2641 return _core_.Image_LoadStream(*args, **kwargs)
2642
2643 def LoadMimeStream(*args, **kwargs):
7a27cf7c
RD
2644 """
2645 LoadMimeStream(self, InputStream stream, String mimetype, int index=-1) -> bool
2646
2647 Loads an image from an input stream or a readable Python file-like
2648 object, using a MIME type string to specify the image file format.
2649 """
d55e5bfc
RD
2650 return _core_.Image_LoadMimeStream(*args, **kwargs)
2651
b39fe951 2652 def IsOk(*args, **kwargs):
7a27cf7c 2653 """
b39fe951 2654 IsOk(self) -> bool
7a27cf7c
RD
2655
2656 Returns true if image data is present.
2657 """
b39fe951 2658 return _core_.Image_IsOk(*args, **kwargs)
d55e5bfc 2659
b39fe951 2660 Ok = IsOk
d55e5bfc 2661 def GetWidth(*args, **kwargs):
7a27cf7c
RD
2662 """
2663 GetWidth(self) -> int
2664
2665 Gets the width of the image in pixels.
2666 """
d55e5bfc
RD
2667 return _core_.Image_GetWidth(*args, **kwargs)
2668
2669 def GetHeight(*args, **kwargs):
7a27cf7c
RD
2670 """
2671 GetHeight(self) -> int
2672
2673 Gets the height of the image in pixels.
2674 """
d55e5bfc
RD
2675 return _core_.Image_GetHeight(*args, **kwargs)
2676
2677 def GetSize(*args, **kwargs):
7a27cf7c
RD
2678 """
2679 GetSize(self) -> Size
2680
2681 Returns the size of the image in pixels.
2682 """
d55e5bfc
RD
2683 return _core_.Image_GetSize(*args, **kwargs)
2684
2685 def GetSubImage(*args, **kwargs):
7a27cf7c
RD
2686 """
2687 GetSubImage(self, Rect rect) -> Image
2688
2689 Returns a sub image of the current one as long as the rect belongs
2690 entirely to the image.
2691 """
d55e5bfc
RD
2692 return _core_.Image_GetSubImage(*args, **kwargs)
2693
aff4cc5c 2694 def Size(*args, **kwargs):
7a27cf7c
RD
2695 """
2696 Size(self, Size size, Point pos, int r=-1, int g=-1, int b=-1) -> Image
2697
2698 Returns a resized version of this image without scaling it by adding
2699 either a border with the given colour or cropping as necessary. The
2700 image is pasted into a new image with the given size and background
2701 colour at the position ``pos`` relative to the upper left of the new
2702 image. If red = green = blue = -1 then use either the current mask
2703 colour if set or find, use, and set a suitable mask colour for any
2704 newly exposed areas.
2705 """
aff4cc5c
RD
2706 return _core_.Image_Size(*args, **kwargs)
2707
d55e5bfc 2708 def Copy(*args, **kwargs):
7a27cf7c
RD
2709 """
2710 Copy(self) -> Image
2711
2712 Returns an identical copy of the image.
2713 """
d55e5bfc
RD
2714 return _core_.Image_Copy(*args, **kwargs)
2715
2716 def Paste(*args, **kwargs):
7a27cf7c
RD
2717 """
2718 Paste(self, Image image, int x, int y)
2719
2720 Pastes ``image`` into this instance and takes care of the mask colour
2721 and any out of bounds problems.
2722 """
d55e5bfc
RD
2723 return _core_.Image_Paste(*args, **kwargs)
2724
2725 def GetData(*args, **kwargs):
ea939623
RD
2726 """
2727 GetData(self) -> PyObject
2728
2729 Returns a string containing a copy of the RGB bytes of the image.
2730 """
d55e5bfc
RD
2731 return _core_.Image_GetData(*args, **kwargs)
2732
2733 def SetData(*args, **kwargs):
ea939623
RD
2734 """
2735 SetData(self, buffer data)
2736
2737 Resets the Image's RGB data from a buffer of RGB bytes. Accepts
2738 either a string or a buffer object holding the data and the length of
2739 the data must be width*height*3.
2740 """
d55e5bfc
RD
2741 return _core_.Image_SetData(*args, **kwargs)
2742
2743 def GetDataBuffer(*args, **kwargs):
ea939623
RD
2744 """
2745 GetDataBuffer(self) -> PyObject
2746
2747 Returns a writable Python buffer object that is pointing at the RGB
7a27cf7c
RD
2748 image data buffer inside the wx.Image. You need to ensure that you do
2749 not use this buffer object after the image has been destroyed.
ea939623 2750 """
d55e5bfc
RD
2751 return _core_.Image_GetDataBuffer(*args, **kwargs)
2752
2753 def SetDataBuffer(*args, **kwargs):
ea939623
RD
2754 """
2755 SetDataBuffer(self, buffer data)
2756
2757 Sets the internal image data pointer to point at a Python buffer
7a27cf7c
RD
2758 object. This can save making an extra copy of the data but you must
2759 ensure that the buffer object lives longer than the wx.Image does.
ea939623 2760 """
d55e5bfc
RD
2761 return _core_.Image_SetDataBuffer(*args, **kwargs)
2762
2763 def GetAlphaData(*args, **kwargs):
ea939623
RD
2764 """
2765 GetAlphaData(self) -> PyObject
2766
2767 Returns a string containing a copy of the alpha bytes of the image.
2768 """
d55e5bfc
RD
2769 return _core_.Image_GetAlphaData(*args, **kwargs)
2770
2771 def SetAlphaData(*args, **kwargs):
ea939623
RD
2772 """
2773 SetAlphaData(self, buffer alpha)
2774
2775 Resets the Image's alpha data from a buffer of bytes. Accepts either
2776 a string or a buffer object holding the data and the length of the
2777 data must be width*height.
2778 """
d55e5bfc
RD
2779 return _core_.Image_SetAlphaData(*args, **kwargs)
2780
2781 def GetAlphaBuffer(*args, **kwargs):
fc46b7f3
RD
2782 """
2783 GetAlphaBuffer(self) -> PyObject
2784
2785 Returns a writable Python buffer object that is pointing at the Alpha
2786 data buffer inside the wx.Image. You need to ensure that you do not
2787 use this buffer object after the image has been destroyed.
2788 """
d55e5bfc
RD
2789 return _core_.Image_GetAlphaBuffer(*args, **kwargs)
2790
2791 def SetAlphaBuffer(*args, **kwargs):
fc46b7f3
RD
2792 """
2793 SetAlphaBuffer(self, buffer alpha)
2794
2795 Sets the internal image alpha pointer to point at a Python buffer
2796 object. This can save making an extra copy of the data but you must
2797 ensure that the buffer object lives as long as the wx.Image does.
2798 """
d55e5bfc
RD
2799 return _core_.Image_SetAlphaBuffer(*args, **kwargs)
2800
2801 def SetMaskColour(*args, **kwargs):
7a27cf7c
RD
2802 """
2803 SetMaskColour(self, byte r, byte g, byte b)
2804
2805 Sets the mask colour for this image (and tells the image to use the
2806 mask).
2807 """
d55e5bfc
RD
2808 return _core_.Image_SetMaskColour(*args, **kwargs)
2809
aff4cc5c
RD
2810 def GetOrFindMaskColour(*args, **kwargs):
2811 """
2812 GetOrFindMaskColour() -> (r,g,b)
2813
2814 Get the current mask colour or find a suitable colour.
2815 """
2816 return _core_.Image_GetOrFindMaskColour(*args, **kwargs)
2817
d55e5bfc 2818 def GetMaskRed(*args, **kwargs):
7a27cf7c
RD
2819 """
2820 GetMaskRed(self) -> byte
2821
2822 Gets the red component of the mask colour.
2823 """
d55e5bfc
RD
2824 return _core_.Image_GetMaskRed(*args, **kwargs)
2825
2826 def GetMaskGreen(*args, **kwargs):
7a27cf7c
RD
2827 """
2828 GetMaskGreen(self) -> byte
2829
2830 Gets the green component of the mask colour.
2831 """
d55e5bfc
RD
2832 return _core_.Image_GetMaskGreen(*args, **kwargs)
2833
2834 def GetMaskBlue(*args, **kwargs):
7a27cf7c
RD
2835 """
2836 GetMaskBlue(self) -> byte
2837
2838 Gets the blue component of the mask colour.
2839 """
d55e5bfc
RD
2840 return _core_.Image_GetMaskBlue(*args, **kwargs)
2841
2842 def SetMask(*args, **kwargs):
7a27cf7c
RD
2843 """
2844 SetMask(self, bool mask=True)
2845
2846 Specifies whether there is a mask or not. The area of the mask is
2847 determined by the current mask colour.
2848 """
d55e5bfc
RD
2849 return _core_.Image_SetMask(*args, **kwargs)
2850
2851 def HasMask(*args, **kwargs):
7a27cf7c
RD
2852 """
2853 HasMask(self) -> bool
2854
2855 Returns ``True`` if there is a mask active, ``False`` otherwise.
2856 """
d55e5bfc
RD
2857 return _core_.Image_HasMask(*args, **kwargs)
2858
2859 def Rotate(*args, **kwargs):
2860 """
2861 Rotate(self, double angle, Point centre_of_rotation, bool interpolating=True,
2862 Point offset_after_rotation=None) -> Image
7a27cf7c
RD
2863
2864 Rotates the image about the given point, by ``angle`` radians. Passing
2865 ``True`` to ``interpolating`` results in better image quality, but is
2866 slower. If the image has a mask, then the mask colour is used for the
2867 uncovered pixels in the rotated image background. Otherwise, black
2868 will be used as the fill colour.
2869
2870 Returns the rotated image, leaving this image intact.
d55e5bfc
RD
2871 """
2872 return _core_.Image_Rotate(*args, **kwargs)
2873
2874 def Rotate90(*args, **kwargs):
7a27cf7c
RD
2875 """
2876 Rotate90(self, bool clockwise=True) -> Image
2877
2878 Returns a copy of the image rotated 90 degrees in the direction
2879 indicated by ``clockwise``.
2880 """
d55e5bfc
RD
2881 return _core_.Image_Rotate90(*args, **kwargs)
2882
2883 def Mirror(*args, **kwargs):
7a27cf7c
RD
2884 """
2885 Mirror(self, bool horizontally=True) -> Image
2886
2887 Returns a mirrored copy of the image. The parameter ``horizontally``
2888 indicates the orientation.
2889 """
d55e5bfc
RD
2890 return _core_.Image_Mirror(*args, **kwargs)
2891
2892 def Replace(*args, **kwargs):
2893 """
7a27cf7c
RD
2894 Replace(self, byte r1, byte g1, byte b1, byte r2, byte g2, byte b2)
2895
2896 Replaces the colour specified by ``(r1,g1,b1)`` by the colour
2897 ``(r2,g2,b2)``.
d55e5bfc
RD
2898 """
2899 return _core_.Image_Replace(*args, **kwargs)
2900
7449af73
RD
2901 def ConvertToGreyscale(*args, **kwargs):
2902 """
2903 ConvertToGreyscale(self, double lr=0.299, double lg=0.587, double lb=0.114) -> Image
2904
2905 Convert to greyscale image. Uses the luminance component (Y) of the
2906 image. The luma value (YUV) is calculated using (R * lr) + (G * lg) + (B * lb),
2907 defaults to ITU-T BT.601
2908 """
2909 return _core_.Image_ConvertToGreyscale(*args, **kwargs)
2910
d55e5bfc 2911 def ConvertToMono(*args, **kwargs):
7a27cf7c
RD
2912 """
2913 ConvertToMono(self, byte r, byte g, byte b) -> Image
2914
2915 Returns monochromatic version of the image. The returned image has
2916 white colour where the original has ``(r,g,b)`` colour and black
2917 colour everywhere else.
2918 """
d55e5bfc
RD
2919 return _core_.Image_ConvertToMono(*args, **kwargs)
2920
2921 def SetOption(*args, **kwargs):
7a27cf7c
RD
2922 """
2923 SetOption(self, String name, String value)
2924
2925 Sets an image handler defined option. For example, when saving as a
2926 JPEG file, the option ``wx.IMAGE_OPTION_QUALITY`` is used, which is a
2927 number between 0 and 100 (0 is terrible, 100 is very good).
2928 """
d55e5bfc
RD
2929 return _core_.Image_SetOption(*args, **kwargs)
2930
2931 def SetOptionInt(*args, **kwargs):
7a27cf7c
RD
2932 """
2933 SetOptionInt(self, String name, int value)
2934
2935 Sets an image option as an integer.
2936 """
d55e5bfc
RD
2937 return _core_.Image_SetOptionInt(*args, **kwargs)
2938
2939 def GetOption(*args, **kwargs):
7a27cf7c
RD
2940 """
2941 GetOption(self, String name) -> String
2942
2943 Gets the value of an image handler option.
2944 """
d55e5bfc
RD
2945 return _core_.Image_GetOption(*args, **kwargs)
2946
2947 def GetOptionInt(*args, **kwargs):
7a27cf7c
RD
2948 """
2949 GetOptionInt(self, String name) -> int
2950
2951 Gets the value of an image handler option as an integer. If the given
2952 option is not present, the function returns 0.
2953 """
d55e5bfc
RD
2954 return _core_.Image_GetOptionInt(*args, **kwargs)
2955
2956 def HasOption(*args, **kwargs):
7a27cf7c
RD
2957 """
2958 HasOption(self, String name) -> bool
2959
2960 Returns true if the given option is present.
2961 """
d55e5bfc
RD
2962 return _core_.Image_HasOption(*args, **kwargs)
2963
2964 def CountColours(*args, **kwargs):
2965 """CountColours(self, unsigned long stopafter=(unsigned long) -1) -> unsigned long"""
2966 return _core_.Image_CountColours(*args, **kwargs)
2967
2968 def ComputeHistogram(*args, **kwargs):
2969 """ComputeHistogram(self, ImageHistogram h) -> unsigned long"""
2970 return _core_.Image_ComputeHistogram(*args, **kwargs)
2971
2972 def AddHandler(*args, **kwargs):
c24da6d6 2973 """AddHandler(ImageHandler handler)"""
d55e5bfc
RD
2974 return _core_.Image_AddHandler(*args, **kwargs)
2975
2976 AddHandler = staticmethod(AddHandler)
2977 def InsertHandler(*args, **kwargs):
c24da6d6 2978 """InsertHandler(ImageHandler handler)"""
d55e5bfc
RD
2979 return _core_.Image_InsertHandler(*args, **kwargs)
2980
2981 InsertHandler = staticmethod(InsertHandler)
2982 def RemoveHandler(*args, **kwargs):
c24da6d6 2983 """RemoveHandler(String name) -> bool"""
d55e5bfc
RD
2984 return _core_.Image_RemoveHandler(*args, **kwargs)
2985
2986 RemoveHandler = staticmethod(RemoveHandler)
554f62e9
RD
2987 def GetHandlers(*args, **kwargs):
2988 """GetHandlers() -> PyObject"""
2989 return _core_.Image_GetHandlers(*args, **kwargs)
2990
2991 GetHandlers = staticmethod(GetHandlers)
d55e5bfc 2992 def GetImageExtWildcard(*args, **kwargs):
7a27cf7c
RD
2993 """
2994 GetImageExtWildcard() -> String
2995
2996 Iterates all registered wxImageHandler objects, and returns a string
2997 containing file extension masks suitable for passing to file open/save
2998 dialog boxes.
2999 """
d55e5bfc
RD
3000 return _core_.Image_GetImageExtWildcard(*args, **kwargs)
3001
3002 GetImageExtWildcard = staticmethod(GetImageExtWildcard)
3003 def ConvertToBitmap(*args, **kwargs):
1fbf26be 3004 """ConvertToBitmap(self, int depth=-1) -> Bitmap"""
d55e5bfc
RD
3005 return _core_.Image_ConvertToBitmap(*args, **kwargs)
3006
3007 def ConvertToMonoBitmap(*args, **kwargs):
7a27cf7c 3008 """ConvertToMonoBitmap(self, byte red, byte green, byte blue) -> Bitmap"""
d55e5bfc
RD
3009 return _core_.Image_ConvertToMonoBitmap(*args, **kwargs)
3010
2f91e3df
KO
3011 def RotateHue(*args, **kwargs):
3012 """
3013 RotateHue(self, double angle)
3014
3015 Rotates the hue of each pixel of the image. Hue is a double in the
3016 range -1.0..1.0 where -1.0 is -360 degrees and 1.0 is 360 degrees
3017 """
3018 return _core_.Image_RotateHue(*args, **kwargs)
3019
3020 def RGBtoHSV(*args, **kwargs):
9d7dfdff
RD
3021 """
3022 RGBtoHSV(Image_RGBValue rgb) -> Image_HSVValue
3023
3024 Converts a color in RGB color space to HSV color space.
3025 """
2f91e3df
KO
3026 return _core_.Image_RGBtoHSV(*args, **kwargs)
3027
3028 RGBtoHSV = staticmethod(RGBtoHSV)
3029 def HSVtoRGB(*args, **kwargs):
9d7dfdff
RD
3030 """
3031 HSVtoRGB(Image_HSVValue hsv) -> Image_RGBValue
3032
3033 Converts a color in HSV color space to RGB color space.
3034 """
2f91e3df
KO
3035 return _core_.Image_HSVtoRGB(*args, **kwargs)
3036
3037 HSVtoRGB = staticmethod(HSVtoRGB)
b39fe951 3038 def __nonzero__(self): return self.IsOk()
97ab0f6a
RD
3039 AlphaBuffer = property(GetAlphaBuffer,SetAlphaBuffer,doc="See `GetAlphaBuffer` and `SetAlphaBuffer`")
3040 AlphaData = property(GetAlphaData,SetAlphaData,doc="See `GetAlphaData` and `SetAlphaData`")
3041 Data = property(GetData,SetData,doc="See `GetData` and `SetData`")
3042 DataBuffer = property(GetDataBuffer,SetDataBuffer,doc="See `GetDataBuffer` and `SetDataBuffer`")
3043 Height = property(GetHeight,doc="See `GetHeight`")
3044 MaskBlue = property(GetMaskBlue,doc="See `GetMaskBlue`")
3045 MaskGreen = property(GetMaskGreen,doc="See `GetMaskGreen`")
3046 MaskRed = property(GetMaskRed,doc="See `GetMaskRed`")
97ab0f6a 3047 Width = property(GetWidth,doc="See `GetWidth`")
2131d850 3048_core_.Image_swigregister(Image)
d55e5bfc
RD
3049
3050def ImageFromMime(*args, **kwargs):
7a27cf7c
RD
3051 """
3052 ImageFromMime(String name, String mimetype, int index=-1) -> Image
3053
3054 Loads an image from a file, using a MIME type string (such as
3055 'image/jpeg') to specify image type.
3056 """
d55e5bfc 3057 val = _core_.new_ImageFromMime(*args, **kwargs)
d55e5bfc
RD
3058 return val
3059
3060def ImageFromStream(*args, **kwargs):
7a27cf7c
RD
3061 """
3062 ImageFromStream(InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> Image
3063
3064 Loads an image from an input stream, or any readable Python file-like
3065 object.
3066 """
d55e5bfc 3067 val = _core_.new_ImageFromStream(*args, **kwargs)
d55e5bfc
RD
3068 return val
3069
3070def ImageFromStreamMime(*args, **kwargs):
7a27cf7c
RD
3071 """
3072 ImageFromStreamMime(InputStream stream, String mimetype, int index=-1) -> Image
3073
3074 Loads an image from an input stream, or any readable Python file-like
3075 object, specifying the image format with a MIME type string.
3076 """
d55e5bfc 3077 val = _core_.new_ImageFromStreamMime(*args, **kwargs)
d55e5bfc
RD
3078 return val
3079
c24da6d6 3080def EmptyImage(*args, **kwargs):
ea939623
RD
3081 """
3082 EmptyImage(int width=0, int height=0, bool clear=True) -> Image
3083
3084 Construct an empty image of a given size, optionally setting all
3085 pixels to black.
3086 """
c24da6d6 3087 val = _core_.new_EmptyImage(*args, **kwargs)
d55e5bfc
RD
3088 return val
3089
3090def ImageFromBitmap(*args, **kwargs):
ea939623
RD
3091 """
3092 ImageFromBitmap(Bitmap bitmap) -> Image
3093
3094 Construct an Image from a `wx.Bitmap`.
3095 """
d55e5bfc 3096 val = _core_.new_ImageFromBitmap(*args, **kwargs)
d55e5bfc
RD
3097 return val
3098
3099def ImageFromData(*args, **kwargs):
ea939623
RD
3100 """
3101 ImageFromData(int width, int height, buffer data) -> Image
3102
3103 Construct an Image from a buffer of RGB bytes. Accepts either a
3104 string or a buffer object holding the data and the length of the data
3105 must be width*height*3.
3106 """
d55e5bfc 3107 val = _core_.new_ImageFromData(*args, **kwargs)
d55e5bfc
RD
3108 return val
3109
c9c2cf70 3110def ImageFromDataWithAlpha(*args, **kwargs):
ea939623
RD
3111 """
3112 ImageFromDataWithAlpha(int width, int height, buffer data, buffer alpha) -> Image
3113
3114 Construct an Image from a buffer of RGB bytes with an Alpha channel.
3115 Accepts either a string or a buffer object holding the data and the
7a27cf7c
RD
3116 length of the data must be width*height*3 bytes, and the length of the
3117 alpha data must be width*height bytes.
ea939623 3118 """
c9c2cf70 3119 val = _core_.new_ImageFromDataWithAlpha(*args, **kwargs)
c9c2cf70
RD
3120 return val
3121
d55e5bfc 3122def Image_CanRead(*args, **kwargs):
554f62e9 3123 """
7a27cf7c
RD
3124 Image_CanRead(String filename) -> bool
3125
3126 Returns True if the image handlers can read this file.
3127 """
554f62e9 3128 return _core_.Image_CanRead(*args, **kwargs)
d55e5bfc
RD
3129
3130def Image_GetImageCount(*args, **kwargs):
554f62e9 3131 """
7a27cf7c
RD
3132 Image_GetImageCount(String filename, long type=BITMAP_TYPE_ANY) -> int
3133
3134 If the image file contains more than one image and the image handler
3135 is capable of retrieving these individually, this function will return
3136 the number of available images.
3137 """
554f62e9 3138 return _core_.Image_GetImageCount(*args, **kwargs)
d55e5bfc
RD
3139
3140def Image_CanReadStream(*args, **kwargs):
554f62e9 3141 """
7a27cf7c
RD
3142 Image_CanReadStream(InputStream stream) -> bool
3143
3144 Returns True if the image handlers can read an image file from the
3145 data currently on the input stream, or a readable Python file-like
3146 object.
3147 """
554f62e9 3148 return _core_.Image_CanReadStream(*args, **kwargs)
d55e5bfc
RD
3149
3150def Image_AddHandler(*args, **kwargs):
554f62e9
RD
3151 """Image_AddHandler(ImageHandler handler)"""
3152 return _core_.Image_AddHandler(*args, **kwargs)
d55e5bfc
RD
3153
3154def Image_InsertHandler(*args, **kwargs):
554f62e9
RD
3155 """Image_InsertHandler(ImageHandler handler)"""
3156 return _core_.Image_InsertHandler(*args, **kwargs)
d55e5bfc
RD
3157
3158def Image_RemoveHandler(*args, **kwargs):
554f62e9
RD
3159 """Image_RemoveHandler(String name) -> bool"""
3160 return _core_.Image_RemoveHandler(*args, **kwargs)
d55e5bfc 3161
554f62e9
RD
3162def Image_GetHandlers(*args):
3163 """Image_GetHandlers() -> PyObject"""
3164 return _core_.Image_GetHandlers(*args)
3165
3166def Image_GetImageExtWildcard(*args):
3167 """
7a27cf7c
RD
3168 Image_GetImageExtWildcard() -> String
3169
3170 Iterates all registered wxImageHandler objects, and returns a string
3171 containing file extension masks suitable for passing to file open/save
3172 dialog boxes.
3173 """
554f62e9 3174 return _core_.Image_GetImageExtWildcard(*args)
d55e5bfc 3175
2f91e3df 3176def Image_RGBtoHSV(*args, **kwargs):
554f62e9 3177 """
9d7dfdff
RD
3178 Image_RGBtoHSV(Image_RGBValue rgb) -> Image_HSVValue
3179
3180 Converts a color in RGB color space to HSV color space.
3181 """
554f62e9 3182 return _core_.Image_RGBtoHSV(*args, **kwargs)
2f91e3df
KO
3183
3184def Image_HSVtoRGB(*args, **kwargs):
554f62e9 3185 """
9d7dfdff
RD
3186 Image_HSVtoRGB(Image_HSVValue hsv) -> Image_RGBValue
3187
3188 Converts a color in HSV color space to RGB color space.
3189 """
554f62e9 3190 return _core_.Image_HSVtoRGB(*args, **kwargs)
2f91e3df 3191
fc46b7f3
RD
3192
3193def _ImageFromBuffer(*args, **kwargs):
3194 """_ImageFromBuffer(int width, int height, buffer data, buffer alpha=None) -> Image"""
3195 return _core_._ImageFromBuffer(*args, **kwargs)
3196def ImageFromBuffer(width, height, dataBuffer, alphaBuffer=None):
3197 """
3198 Creates a `wx.Image` from the data in dataBuffer. The dataBuffer
eec1c382
RD
3199 parameter must be a Python object that implements the buffer interface,
3200 such as a string, array, etc. The dataBuffer object is expected to
3201 contain a series of RGB bytes and be width*height*3 bytes long. A buffer
3202 object can optionally be supplied for the image's alpha channel data, and
3203 it is expected to be width*height bytes long.
fc46b7f3
RD
3204
3205 The wx.Image will be created with its data and alpha pointers initialized
3206 to the memory address pointed to by the buffer objects, thus saving the
3207 time needed to copy the image data from the buffer object to the wx.Image.
3208 While this has advantages, it also has the shoot-yourself-in-the-foot
3209 risks associated with sharing a C pointer between two objects.
3210
3211 To help alleviate the risk a reference to the data and alpha buffer
3212 objects are kept with the wx.Image, so that they won't get deleted until
3213 after the wx.Image is deleted. However please be aware that it is not
3214 guaranteed that an object won't move its memory buffer to a new location
3215 when it needs to resize its contents. If that happens then the wx.Image
3216 will end up referring to an invalid memory location and could cause the
3217 application to crash. Therefore care should be taken to not manipulate
3218 the objects used for the data and alpha buffers in a way that would cause
3219 them to change size.
3220 """
fc46b7f3
RD
3221 image = _core_._ImageFromBuffer(width, height, dataBuffer, alphaBuffer)
3222 image._buffer = dataBuffer
3223 image._alpha = alphaBuffer
3224 return image
3225
a07a67e6
RD
3226def InitAllImageHandlers():
3227 """
3228 The former functionality of InitAllImageHanders is now done internal to
3229 the _core_ extension module and so this function has become a simple NOP.
3230 """
3231 pass
d55e5bfc 3232
d55e5bfc
RD
3233IMAGE_RESOLUTION_INCHES = _core_.IMAGE_RESOLUTION_INCHES
3234IMAGE_RESOLUTION_CM = _core_.IMAGE_RESOLUTION_CM
b9d6a5f3
RD
3235PNG_TYPE_COLOUR = _core_.PNG_TYPE_COLOUR
3236PNG_TYPE_GREY = _core_.PNG_TYPE_GREY
3237PNG_TYPE_GREY_RED = _core_.PNG_TYPE_GREY_RED
d55e5bfc
RD
3238BMP_24BPP = _core_.BMP_24BPP
3239BMP_8BPP = _core_.BMP_8BPP
3240BMP_8BPP_GREY = _core_.BMP_8BPP_GREY
3241BMP_8BPP_GRAY = _core_.BMP_8BPP_GRAY
3242BMP_8BPP_RED = _core_.BMP_8BPP_RED
3243BMP_8BPP_PALETTE = _core_.BMP_8BPP_PALETTE
3244BMP_4BPP = _core_.BMP_4BPP
3245BMP_1BPP = _core_.BMP_1BPP
3246BMP_1BPP_BW = _core_.BMP_1BPP_BW
3247class BMPHandler(ImageHandler):
27fb7603 3248 """A `wx.ImageHandler` for \*.bmp bitmap files."""
554f62e9
RD
3249 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3250 __repr__ = _swig_repr
3251 def __init__(self, *args, **kwargs):
27fb7603
RD
3252 """
3253 __init__(self) -> BMPHandler
3254
3255 A `wx.ImageHandler` for \*.bmp bitmap files.
3256 """
554f62e9 3257 _core_.BMPHandler_swiginit(self,_core_.new_BMPHandler(*args, **kwargs))
2131d850 3258_core_.BMPHandler_swigregister(BMPHandler)
d55e5bfc 3259NullImage = cvar.NullImage
68350608 3260IMAGE_OPTION_FILENAME = cvar.IMAGE_OPTION_FILENAME
d55e5bfc
RD
3261IMAGE_OPTION_BMP_FORMAT = cvar.IMAGE_OPTION_BMP_FORMAT
3262IMAGE_OPTION_CUR_HOTSPOT_X = cvar.IMAGE_OPTION_CUR_HOTSPOT_X
3263IMAGE_OPTION_CUR_HOTSPOT_Y = cvar.IMAGE_OPTION_CUR_HOTSPOT_Y
3264IMAGE_OPTION_RESOLUTION = cvar.IMAGE_OPTION_RESOLUTION
68350608
RD
3265IMAGE_OPTION_RESOLUTIONX = cvar.IMAGE_OPTION_RESOLUTIONX
3266IMAGE_OPTION_RESOLUTIONY = cvar.IMAGE_OPTION_RESOLUTIONY
d55e5bfc 3267IMAGE_OPTION_RESOLUTIONUNIT = cvar.IMAGE_OPTION_RESOLUTIONUNIT
24d7cbea 3268IMAGE_OPTION_QUALITY = cvar.IMAGE_OPTION_QUALITY
68350608
RD
3269IMAGE_OPTION_BITSPERSAMPLE = cvar.IMAGE_OPTION_BITSPERSAMPLE
3270IMAGE_OPTION_SAMPLESPERPIXEL = cvar.IMAGE_OPTION_SAMPLESPERPIXEL
3271IMAGE_OPTION_COMPRESSION = cvar.IMAGE_OPTION_COMPRESSION
3272IMAGE_OPTION_IMAGEDESCRIPTOR = cvar.IMAGE_OPTION_IMAGEDESCRIPTOR
b9d6a5f3
RD
3273IMAGE_OPTION_PNG_FORMAT = cvar.IMAGE_OPTION_PNG_FORMAT
3274IMAGE_OPTION_PNG_BITDEPTH = cvar.IMAGE_OPTION_PNG_BITDEPTH
d55e5bfc
RD
3275
3276class ICOHandler(BMPHandler):
27fb7603 3277 """A `wx.ImageHandler` for \*.ico icon files."""
554f62e9
RD
3278 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3279 __repr__ = _swig_repr
3280 def __init__(self, *args, **kwargs):
27fb7603
RD
3281 """
3282 __init__(self) -> ICOHandler
3283
3284 A `wx.ImageHandler` for \*.ico icon files.
3285 """
554f62e9 3286 _core_.ICOHandler_swiginit(self,_core_.new_ICOHandler(*args, **kwargs))
2131d850 3287_core_.ICOHandler_swigregister(ICOHandler)
d55e5bfc
RD
3288
3289class CURHandler(ICOHandler):
27fb7603 3290 """A `wx.ImageHandler` for \*.cur cursor files."""
554f62e9
RD
3291 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3292 __repr__ = _swig_repr
3293 def __init__(self, *args, **kwargs):
27fb7603
RD
3294 """
3295 __init__(self) -> CURHandler
3296
3297 A `wx.ImageHandler` for \*.cur cursor files.
3298 """
554f62e9 3299 _core_.CURHandler_swiginit(self,_core_.new_CURHandler(*args, **kwargs))
2131d850 3300_core_.CURHandler_swigregister(CURHandler)
d55e5bfc
RD
3301
3302class ANIHandler(CURHandler):
27fb7603 3303 """A `wx.ImageHandler` for \*.ani animated cursor files."""
554f62e9
RD
3304 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3305 __repr__ = _swig_repr
3306 def __init__(self, *args, **kwargs):
27fb7603
RD
3307 """
3308 __init__(self) -> ANIHandler
3309
3310 A `wx.ImageHandler` for \*.ani animated cursor files.
3311 """
554f62e9 3312 _core_.ANIHandler_swiginit(self,_core_.new_ANIHandler(*args, **kwargs))
2131d850 3313_core_.ANIHandler_swigregister(ANIHandler)
d55e5bfc
RD
3314
3315class PNGHandler(ImageHandler):
27fb7603 3316 """A `wx.ImageHandler` for PNG image files."""
554f62e9
RD
3317 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3318 __repr__ = _swig_repr
3319 def __init__(self, *args, **kwargs):
27fb7603
RD
3320 """
3321 __init__(self) -> PNGHandler
3322
3323 A `wx.ImageHandler` for PNG image files.
3324 """
554f62e9 3325 _core_.PNGHandler_swiginit(self,_core_.new_PNGHandler(*args, **kwargs))
2131d850 3326_core_.PNGHandler_swigregister(PNGHandler)
d55e5bfc
RD
3327
3328class GIFHandler(ImageHandler):
27fb7603 3329 """A `wx.ImageHandler` for GIF image files."""
554f62e9
RD
3330 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3331 __repr__ = _swig_repr
3332 def __init__(self, *args, **kwargs):
27fb7603
RD
3333 """
3334 __init__(self) -> GIFHandler
3335
3336 A `wx.ImageHandler` for GIF image files.
3337 """
554f62e9 3338 _core_.GIFHandler_swiginit(self,_core_.new_GIFHandler(*args, **kwargs))
2131d850 3339_core_.GIFHandler_swigregister(GIFHandler)
d55e5bfc
RD
3340
3341class PCXHandler(ImageHandler):
27fb7603 3342 """A `wx.ImageHandler` for PCX imager files."""
554f62e9
RD
3343 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3344 __repr__ = _swig_repr
3345 def __init__(self, *args, **kwargs):
27fb7603
RD
3346 """
3347 __init__(self) -> PCXHandler
3348
3349 A `wx.ImageHandler` for PCX imager files.
3350 """
554f62e9 3351 _core_.PCXHandler_swiginit(self,_core_.new_PCXHandler(*args, **kwargs))
2131d850 3352_core_.PCXHandler_swigregister(PCXHandler)
d55e5bfc
RD
3353
3354class JPEGHandler(ImageHandler):
27fb7603 3355 """A `wx.ImageHandler` for JPEG/JPG image files."""
554f62e9
RD
3356 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3357 __repr__ = _swig_repr
3358 def __init__(self, *args, **kwargs):
27fb7603
RD
3359 """
3360 __init__(self) -> JPEGHandler
3361
3362 A `wx.ImageHandler` for JPEG/JPG image files.
3363 """
554f62e9 3364 _core_.JPEGHandler_swiginit(self,_core_.new_JPEGHandler(*args, **kwargs))
2131d850 3365_core_.JPEGHandler_swigregister(JPEGHandler)
d55e5bfc
RD
3366
3367class PNMHandler(ImageHandler):
27fb7603 3368 """A `wx.ImageHandler` for PNM image files."""
554f62e9
RD
3369 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3370 __repr__ = _swig_repr
3371 def __init__(self, *args, **kwargs):
27fb7603
RD
3372 """
3373 __init__(self) -> PNMHandler
3374
3375 A `wx.ImageHandler` for PNM image files.
3376 """
554f62e9 3377 _core_.PNMHandler_swiginit(self,_core_.new_PNMHandler(*args, **kwargs))
2131d850 3378_core_.PNMHandler_swigregister(PNMHandler)
d55e5bfc
RD
3379
3380class XPMHandler(ImageHandler):
27fb7603 3381 """A `wx.ImageHandler` for XPM image."""
554f62e9
RD
3382 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3383 __repr__ = _swig_repr
3384 def __init__(self, *args, **kwargs):
27fb7603
RD
3385 """
3386 __init__(self) -> XPMHandler
3387
3388 A `wx.ImageHandler` for XPM image.
3389 """
554f62e9 3390 _core_.XPMHandler_swiginit(self,_core_.new_XPMHandler(*args, **kwargs))
2131d850 3391_core_.XPMHandler_swigregister(XPMHandler)
d55e5bfc
RD
3392
3393class TIFFHandler(ImageHandler):
27fb7603 3394 """A `wx.ImageHandler` for TIFF image files."""
554f62e9
RD
3395 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3396 __repr__ = _swig_repr
3397 def __init__(self, *args, **kwargs):
27fb7603
RD
3398 """
3399 __init__(self) -> TIFFHandler
3400
3401 A `wx.ImageHandler` for TIFF image files.
3402 """
554f62e9 3403 _core_.TIFFHandler_swiginit(self,_core_.new_TIFFHandler(*args, **kwargs))
2131d850 3404_core_.TIFFHandler_swigregister(TIFFHandler)
d55e5bfc 3405
c0de73ae
RD
3406QUANTIZE_INCLUDE_WINDOWS_COLOURS = _core_.QUANTIZE_INCLUDE_WINDOWS_COLOURS
3407QUANTIZE_FILL_DESTINATION_IMAGE = _core_.QUANTIZE_FILL_DESTINATION_IMAGE
3408class Quantize(object):
3409 """Performs quantization, or colour reduction, on a wxImage."""
554f62e9
RD
3410 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3411 def __init__(self): raise AttributeError, "No constructor defined"
3412 __repr__ = _swig_repr
c0de73ae
RD
3413 def Quantize(*args, **kwargs):
3414 """
3415 Quantize(Image src, Image dest, int desiredNoColours=236, int flags=wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE) -> bool
3416
3417 Reduce the colours in the source image and put the result into the
3418 destination image, setting the palette in the destination if
3419 needed. Both images may be the same, to overwrite the source image.
3420 """
3421 return _core_.Quantize_Quantize(*args, **kwargs)
3422
3423 Quantize = staticmethod(Quantize)
2131d850 3424_core_.Quantize_swigregister(Quantize)
c0de73ae
RD
3425
3426def Quantize_Quantize(*args, **kwargs):
554f62e9 3427 """
c0de73ae
RD
3428 Quantize_Quantize(Image src, Image dest, int desiredNoColours=236, int flags=wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE) -> bool
3429
3430 Reduce the colours in the source image and put the result into the
3431 destination image, setting the palette in the destination if
3432 needed. Both images may be the same, to overwrite the source image.
3433 """
554f62e9 3434 return _core_.Quantize_Quantize(*args, **kwargs)
c0de73ae 3435
d55e5bfc
RD
3436#---------------------------------------------------------------------------
3437
3438class EvtHandler(Object):
093d3ff1 3439 """Proxy of C++ EvtHandler class"""
554f62e9
RD
3440 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3441 __repr__ = _swig_repr
3442 def __init__(self, *args, **kwargs):
d55e5bfc 3443 """__init__(self) -> EvtHandler"""
554f62e9 3444 _core_.EvtHandler_swiginit(self,_core_.new_EvtHandler(*args, **kwargs))
d49bdf34
RD
3445 self._setOORInfo(self)
3446
d55e5bfc
RD
3447 def GetNextHandler(*args, **kwargs):
3448 """GetNextHandler(self) -> EvtHandler"""
3449 return _core_.EvtHandler_GetNextHandler(*args, **kwargs)
3450
3451 def GetPreviousHandler(*args, **kwargs):
3452 """GetPreviousHandler(self) -> EvtHandler"""
3453 return _core_.EvtHandler_GetPreviousHandler(*args, **kwargs)
3454
3455 def SetNextHandler(*args, **kwargs):
3456 """SetNextHandler(self, EvtHandler handler)"""
3457 return _core_.EvtHandler_SetNextHandler(*args, **kwargs)
3458
3459 def SetPreviousHandler(*args, **kwargs):
3460 """SetPreviousHandler(self, EvtHandler handler)"""
3461 return _core_.EvtHandler_SetPreviousHandler(*args, **kwargs)
3462
3463 def GetEvtHandlerEnabled(*args, **kwargs):
3464 """GetEvtHandlerEnabled(self) -> bool"""
3465 return _core_.EvtHandler_GetEvtHandlerEnabled(*args, **kwargs)
3466
3467 def SetEvtHandlerEnabled(*args, **kwargs):
3468 """SetEvtHandlerEnabled(self, bool enabled)"""
3469 return _core_.EvtHandler_SetEvtHandlerEnabled(*args, **kwargs)
3470
3471 def ProcessEvent(*args, **kwargs):
3472 """ProcessEvent(self, Event event) -> bool"""
3473 return _core_.EvtHandler_ProcessEvent(*args, **kwargs)
3474
3475 def AddPendingEvent(*args, **kwargs):
3476 """AddPendingEvent(self, Event event)"""
3477 return _core_.EvtHandler_AddPendingEvent(*args, **kwargs)
3478
3479 def ProcessPendingEvents(*args, **kwargs):
3480 """ProcessPendingEvents(self)"""
3481 return _core_.EvtHandler_ProcessPendingEvents(*args, **kwargs)
3482
b39fe951
RD
3483 def AllowReentrance(*args, **kwargs):
3484 """AllowReentrance(self, bool allow=True)"""
3485 return _core_.EvtHandler_AllowReentrance(*args, **kwargs)
3486
3487 def IsReentranceAllowed(*args, **kwargs):
3488 """IsReentranceAllowed(self) -> bool"""
3489 return _core_.EvtHandler_IsReentranceAllowed(*args, **kwargs)
3490
3491 def IsEventHandlingInProgress(*args, **kwargs):
3492 """IsEventHandlingInProgress(self) -> bool"""
3493 return _core_.EvtHandler_IsEventHandlingInProgress(*args, **kwargs)
3494
d55e5bfc
RD
3495 def Connect(*args, **kwargs):
3496 """Connect(self, int id, int lastId, int eventType, PyObject func)"""
3497 return _core_.EvtHandler_Connect(*args, **kwargs)
3498
3499 def Disconnect(*args, **kwargs):
f460c29d 3500 """Disconnect(self, int id, int lastId=-1, EventType eventType=wxEVT_NULL) -> bool"""
d55e5bfc
RD
3501 return _core_.EvtHandler_Disconnect(*args, **kwargs)
3502
3503 def _setOORInfo(*args, **kwargs):
093d3ff1 3504 """_setOORInfo(self, PyObject _self, bool incref=True)"""
7e08d4ef
RD
3505 val = _core_.EvtHandler__setOORInfo(*args, **kwargs)
3506 args[0].thisown = 0
3507 return val
d55e5bfc
RD
3508
3509 def Bind(self, event, handler, source=None, id=wx.ID_ANY, id2=wx.ID_ANY):
3510 """
3511 Bind an event to an event handler.
3512
caef1a4d
RD
3513 :param event: One of the EVT_* objects that specifies the
3514 type of event to bind,
d55e5bfc 3515
caef1a4d
RD
3516 :param handler: A callable object to be invoked when the
3517 event is delivered to self. Pass None to
3518 disconnect an event handler.
d55e5bfc 3519
caef1a4d
RD
3520 :param source: Sometimes the event originates from a
3521 different window than self, but you still
3522 want to catch it in self. (For example, a
3523 button event delivered to a frame.) By
3524 passing the source of the event, the event
3525 handling system is able to differentiate
3526 between the same event type from different
3527 controls.
d55e5bfc 3528
caef1a4d
RD
3529 :param id: Used to spcify the event source by ID instead
3530 of instance.
3531
3532 :param id2: Used when it is desirable to bind a handler
3533 to a range of IDs, such as with EVT_MENU_RANGE.
d55e5bfc
RD
3534 """
3535 if source is not None:
3536 id = source.GetId()
3537 event.Bind(self, id, id2, handler)
3538
c24da6d6
RD
3539 def Unbind(self, event, source=None, id=wx.ID_ANY, id2=wx.ID_ANY):
3540 """
3541 Disconencts the event handler binding for event from self.
3542 Returns True if successful.
3543 """
3544 if source is not None:
3545 id = source.GetId()
3546 return event.Unbind(self, id, id2)
d55e5bfc 3547
97ab0f6a
RD
3548 EvtHandlerEnabled = property(GetEvtHandlerEnabled,SetEvtHandlerEnabled,doc="See `GetEvtHandlerEnabled` and `SetEvtHandlerEnabled`")
3549 NextHandler = property(GetNextHandler,SetNextHandler,doc="See `GetNextHandler` and `SetNextHandler`")
3550 PreviousHandler = property(GetPreviousHandler,SetPreviousHandler,doc="See `GetPreviousHandler` and `SetPreviousHandler`")
2131d850 3551_core_.EvtHandler_swigregister(EvtHandler)
d55e5bfc
RD
3552
3553#---------------------------------------------------------------------------
3554
3555class PyEventBinder(object):
3556 """
3557 Instances of this class are used to bind specific events to event
3558 handlers.
3559 """
3560 def __init__(self, evtType, expectedIDs=0):
3561 if expectedIDs not in [0, 1, 2]:
3562 raise ValueError, "Invalid number of expectedIDs"
3563 self.expectedIDs = expectedIDs
3564
3565 if type(evtType) == list or type(evtType) == tuple:
3566 self.evtType = evtType
3567 else:
3568 self.evtType = [evtType]
3569
3570
3571 def Bind(self, target, id1, id2, function):
3572 """Bind this set of event types to target."""
3573 for et in self.evtType:
3574 target.Connect(id1, id2, et, function)
3575
c24da6d6
RD
3576
3577 def Unbind(self, target, id1, id2):
3578 """Remove an event binding."""
3579 success = 0
3580 for et in self.evtType:
3581 success += target.Disconnect(id1, id2, et)
3582 return success != 0
3583
d55e5bfc
RD
3584
3585 def __call__(self, *args):
3586 """
3587 For backwards compatibility with the old EVT_* functions.
3588 Should be called with either (window, func), (window, ID,
3589 func) or (window, ID1, ID2, func) parameters depending on the
3590 type of the event.
3591 """
3592 assert len(args) == 2 + self.expectedIDs
3593 id1 = wx.ID_ANY
3594 id2 = wx.ID_ANY
3595 target = args[0]
3596 if self.expectedIDs == 0:
3597 func = args[1]
3598 elif self.expectedIDs == 1:
3599 id1 = args[1]
3600 func = args[2]
3601 elif self.expectedIDs == 2:
3602 id1 = args[1]
3603 id2 = args[2]
3604 func = args[3]
3605 else:
3606 raise ValueError, "Unexpected number of IDs"
3607
3608 self.Bind(target, id1, id2, func)
3609
3610
3611# These two are square pegs that don't fit the PyEventBinder hole...
3612def EVT_COMMAND(win, id, cmd, func):
3613 win.Connect(id, -1, cmd, func)
3614def EVT_COMMAND_RANGE(win, id1, id2, cmd, func):
3615 win.Connect(id1, id2, cmd, func)
3616
3617
3618#---------------------------------------------------------------------------
3619
3620#---------------------------------------------------------------------------
3621
3622EVENT_PROPAGATE_NONE = _core_.EVENT_PROPAGATE_NONE
3623EVENT_PROPAGATE_MAX = _core_.EVENT_PROPAGATE_MAX
3624
554f62e9 3625def NewEventType(*args):
f460c29d 3626 """NewEventType() -> EventType"""
554f62e9 3627 return _core_.NewEventType(*args)
d55e5bfc
RD
3628wxEVT_NULL = _core_.wxEVT_NULL
3629wxEVT_FIRST = _core_.wxEVT_FIRST
3630wxEVT_USER_FIRST = _core_.wxEVT_USER_FIRST
3631wxEVT_COMMAND_BUTTON_CLICKED = _core_.wxEVT_COMMAND_BUTTON_CLICKED
3632wxEVT_COMMAND_CHECKBOX_CLICKED = _core_.wxEVT_COMMAND_CHECKBOX_CLICKED
3633wxEVT_COMMAND_CHOICE_SELECTED = _core_.wxEVT_COMMAND_CHOICE_SELECTED
3634wxEVT_COMMAND_LISTBOX_SELECTED = _core_.wxEVT_COMMAND_LISTBOX_SELECTED
3635wxEVT_COMMAND_LISTBOX_DOUBLECLICKED = _core_.wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
3636wxEVT_COMMAND_CHECKLISTBOX_TOGGLED = _core_.wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
3637wxEVT_COMMAND_MENU_SELECTED = _core_.wxEVT_COMMAND_MENU_SELECTED
3638wxEVT_COMMAND_TOOL_CLICKED = _core_.wxEVT_COMMAND_TOOL_CLICKED
3639wxEVT_COMMAND_SLIDER_UPDATED = _core_.wxEVT_COMMAND_SLIDER_UPDATED
3640wxEVT_COMMAND_RADIOBOX_SELECTED = _core_.wxEVT_COMMAND_RADIOBOX_SELECTED
3641wxEVT_COMMAND_RADIOBUTTON_SELECTED = _core_.wxEVT_COMMAND_RADIOBUTTON_SELECTED
3642wxEVT_COMMAND_SCROLLBAR_UPDATED = _core_.wxEVT_COMMAND_SCROLLBAR_UPDATED
3643wxEVT_COMMAND_VLBOX_SELECTED = _core_.wxEVT_COMMAND_VLBOX_SELECTED
3644wxEVT_COMMAND_COMBOBOX_SELECTED = _core_.wxEVT_COMMAND_COMBOBOX_SELECTED
3645wxEVT_COMMAND_TOOL_RCLICKED = _core_.wxEVT_COMMAND_TOOL_RCLICKED
3646wxEVT_COMMAND_TOOL_ENTER = _core_.wxEVT_COMMAND_TOOL_ENTER
3647wxEVT_LEFT_DOWN = _core_.wxEVT_LEFT_DOWN
3648wxEVT_LEFT_UP = _core_.wxEVT_LEFT_UP
3649wxEVT_MIDDLE_DOWN = _core_.wxEVT_MIDDLE_DOWN
3650wxEVT_MIDDLE_UP = _core_.wxEVT_MIDDLE_UP
3651wxEVT_RIGHT_DOWN = _core_.wxEVT_RIGHT_DOWN
3652wxEVT_RIGHT_UP = _core_.wxEVT_RIGHT_UP
3653wxEVT_MOTION = _core_.wxEVT_MOTION
3654wxEVT_ENTER_WINDOW = _core_.wxEVT_ENTER_WINDOW
3655wxEVT_LEAVE_WINDOW = _core_.wxEVT_LEAVE_WINDOW
3656wxEVT_LEFT_DCLICK = _core_.wxEVT_LEFT_DCLICK
3657wxEVT_MIDDLE_DCLICK = _core_.wxEVT_MIDDLE_DCLICK
3658wxEVT_RIGHT_DCLICK = _core_.wxEVT_RIGHT_DCLICK
3659wxEVT_SET_FOCUS = _core_.wxEVT_SET_FOCUS
3660wxEVT_KILL_FOCUS = _core_.wxEVT_KILL_FOCUS
3661wxEVT_CHILD_FOCUS = _core_.wxEVT_CHILD_FOCUS
3662wxEVT_MOUSEWHEEL = _core_.wxEVT_MOUSEWHEEL
3663wxEVT_NC_LEFT_DOWN = _core_.wxEVT_NC_LEFT_DOWN
3664wxEVT_NC_LEFT_UP = _core_.wxEVT_NC_LEFT_UP
3665wxEVT_NC_MIDDLE_DOWN = _core_.wxEVT_NC_MIDDLE_DOWN
3666wxEVT_NC_MIDDLE_UP = _core_.wxEVT_NC_MIDDLE_UP
3667wxEVT_NC_RIGHT_DOWN = _core_.wxEVT_NC_RIGHT_DOWN
3668wxEVT_NC_RIGHT_UP = _core_.wxEVT_NC_RIGHT_UP
3669wxEVT_NC_MOTION = _core_.wxEVT_NC_MOTION
3670wxEVT_NC_ENTER_WINDOW = _core_.wxEVT_NC_ENTER_WINDOW
3671wxEVT_NC_LEAVE_WINDOW = _core_.wxEVT_NC_LEAVE_WINDOW
3672wxEVT_NC_LEFT_DCLICK = _core_.wxEVT_NC_LEFT_DCLICK
3673wxEVT_NC_MIDDLE_DCLICK = _core_.wxEVT_NC_MIDDLE_DCLICK
3674wxEVT_NC_RIGHT_DCLICK = _core_.wxEVT_NC_RIGHT_DCLICK
3675wxEVT_CHAR = _core_.wxEVT_CHAR
3676wxEVT_CHAR_HOOK = _core_.wxEVT_CHAR_HOOK
3677wxEVT_NAVIGATION_KEY = _core_.wxEVT_NAVIGATION_KEY
3678wxEVT_KEY_DOWN = _core_.wxEVT_KEY_DOWN
3679wxEVT_KEY_UP = _core_.wxEVT_KEY_UP
3680wxEVT_HOTKEY = _core_.wxEVT_HOTKEY
3681wxEVT_SET_CURSOR = _core_.wxEVT_SET_CURSOR
3682wxEVT_SCROLL_TOP = _core_.wxEVT_SCROLL_TOP
3683wxEVT_SCROLL_BOTTOM = _core_.wxEVT_SCROLL_BOTTOM
3684wxEVT_SCROLL_LINEUP = _core_.wxEVT_SCROLL_LINEUP
3685wxEVT_SCROLL_LINEDOWN = _core_.wxEVT_SCROLL_LINEDOWN
3686wxEVT_SCROLL_PAGEUP = _core_.wxEVT_SCROLL_PAGEUP
3687wxEVT_SCROLL_PAGEDOWN = _core_.wxEVT_SCROLL_PAGEDOWN
3688wxEVT_SCROLL_THUMBTRACK = _core_.wxEVT_SCROLL_THUMBTRACK
3689wxEVT_SCROLL_THUMBRELEASE = _core_.wxEVT_SCROLL_THUMBRELEASE
db67f999
RD
3690wxEVT_SCROLL_CHANGED = _core_.wxEVT_SCROLL_CHANGED
3691wxEVT_SCROLL_ENDSCROLL = wxEVT_SCROLL_CHANGED
d55e5bfc
RD
3692wxEVT_SCROLLWIN_TOP = _core_.wxEVT_SCROLLWIN_TOP
3693wxEVT_SCROLLWIN_BOTTOM = _core_.wxEVT_SCROLLWIN_BOTTOM
3694wxEVT_SCROLLWIN_LINEUP = _core_.wxEVT_SCROLLWIN_LINEUP
3695wxEVT_SCROLLWIN_LINEDOWN = _core_.wxEVT_SCROLLWIN_LINEDOWN
3696wxEVT_SCROLLWIN_PAGEUP = _core_.wxEVT_SCROLLWIN_PAGEUP
3697wxEVT_SCROLLWIN_PAGEDOWN = _core_.wxEVT_SCROLLWIN_PAGEDOWN
3698wxEVT_SCROLLWIN_THUMBTRACK = _core_.wxEVT_SCROLLWIN_THUMBTRACK
3699wxEVT_SCROLLWIN_THUMBRELEASE = _core_.wxEVT_SCROLLWIN_THUMBRELEASE
3700wxEVT_SIZE = _core_.wxEVT_SIZE
3701wxEVT_MOVE = _core_.wxEVT_MOVE
3702wxEVT_CLOSE_WINDOW = _core_.wxEVT_CLOSE_WINDOW
3703wxEVT_END_SESSION = _core_.wxEVT_END_SESSION
3704wxEVT_QUERY_END_SESSION = _core_.wxEVT_QUERY_END_SESSION
3705wxEVT_ACTIVATE_APP = _core_.wxEVT_ACTIVATE_APP
d55e5bfc
RD
3706wxEVT_ACTIVATE = _core_.wxEVT_ACTIVATE
3707wxEVT_CREATE = _core_.wxEVT_CREATE
3708wxEVT_DESTROY = _core_.wxEVT_DESTROY
3709wxEVT_SHOW = _core_.wxEVT_SHOW
3710wxEVT_ICONIZE = _core_.wxEVT_ICONIZE
3711wxEVT_MAXIMIZE = _core_.wxEVT_MAXIMIZE
3712wxEVT_MOUSE_CAPTURE_CHANGED = _core_.wxEVT_MOUSE_CAPTURE_CHANGED
0f83f5da 3713wxEVT_MOUSE_CAPTURE_LOST = _core_.wxEVT_MOUSE_CAPTURE_LOST
d55e5bfc
RD
3714wxEVT_PAINT = _core_.wxEVT_PAINT
3715wxEVT_ERASE_BACKGROUND = _core_.wxEVT_ERASE_BACKGROUND
3716wxEVT_NC_PAINT = _core_.wxEVT_NC_PAINT
3717wxEVT_PAINT_ICON = _core_.wxEVT_PAINT_ICON
3718wxEVT_MENU_OPEN = _core_.wxEVT_MENU_OPEN
3719wxEVT_MENU_CLOSE = _core_.wxEVT_MENU_CLOSE
3720wxEVT_MENU_HIGHLIGHT = _core_.wxEVT_MENU_HIGHLIGHT
3721wxEVT_CONTEXT_MENU = _core_.wxEVT_CONTEXT_MENU
3722wxEVT_SYS_COLOUR_CHANGED = _core_.wxEVT_SYS_COLOUR_CHANGED
3723wxEVT_DISPLAY_CHANGED = _core_.wxEVT_DISPLAY_CHANGED
3724wxEVT_SETTING_CHANGED = _core_.wxEVT_SETTING_CHANGED
3725wxEVT_QUERY_NEW_PALETTE = _core_.wxEVT_QUERY_NEW_PALETTE
3726wxEVT_PALETTE_CHANGED = _core_.wxEVT_PALETTE_CHANGED
3727wxEVT_DROP_FILES = _core_.wxEVT_DROP_FILES
3728wxEVT_DRAW_ITEM = _core_.wxEVT_DRAW_ITEM
3729wxEVT_MEASURE_ITEM = _core_.wxEVT_MEASURE_ITEM
3730wxEVT_COMPARE_ITEM = _core_.wxEVT_COMPARE_ITEM
3731wxEVT_INIT_DIALOG = _core_.wxEVT_INIT_DIALOG
3732wxEVT_IDLE = _core_.wxEVT_IDLE
3733wxEVT_UPDATE_UI = _core_.wxEVT_UPDATE_UI
3734wxEVT_SIZING = _core_.wxEVT_SIZING
3735wxEVT_MOVING = _core_.wxEVT_MOVING
88c6b281 3736wxEVT_HIBERNATE = _core_.wxEVT_HIBERNATE
2131d850
RD
3737wxEVT_COMMAND_TEXT_COPY = _core_.wxEVT_COMMAND_TEXT_COPY
3738wxEVT_COMMAND_TEXT_CUT = _core_.wxEVT_COMMAND_TEXT_CUT
3739wxEVT_COMMAND_TEXT_PASTE = _core_.wxEVT_COMMAND_TEXT_PASTE
d55e5bfc
RD
3740wxEVT_COMMAND_LEFT_CLICK = _core_.wxEVT_COMMAND_LEFT_CLICK
3741wxEVT_COMMAND_LEFT_DCLICK = _core_.wxEVT_COMMAND_LEFT_DCLICK
3742wxEVT_COMMAND_RIGHT_CLICK = _core_.wxEVT_COMMAND_RIGHT_CLICK
3743wxEVT_COMMAND_RIGHT_DCLICK = _core_.wxEVT_COMMAND_RIGHT_DCLICK
3744wxEVT_COMMAND_SET_FOCUS = _core_.wxEVT_COMMAND_SET_FOCUS
3745wxEVT_COMMAND_KILL_FOCUS = _core_.wxEVT_COMMAND_KILL_FOCUS
3746wxEVT_COMMAND_ENTER = _core_.wxEVT_COMMAND_ENTER
3747#
3748# Create some event binders
3749EVT_SIZE = wx.PyEventBinder( wxEVT_SIZE )
3750EVT_SIZING = wx.PyEventBinder( wxEVT_SIZING )
3751EVT_MOVE = wx.PyEventBinder( wxEVT_MOVE )
3752EVT_MOVING = wx.PyEventBinder( wxEVT_MOVING )
3753EVT_CLOSE = wx.PyEventBinder( wxEVT_CLOSE_WINDOW )
3754EVT_END_SESSION = wx.PyEventBinder( wxEVT_END_SESSION )
3755EVT_QUERY_END_SESSION = wx.PyEventBinder( wxEVT_QUERY_END_SESSION )
3756EVT_PAINT = wx.PyEventBinder( wxEVT_PAINT )
3757EVT_NC_PAINT = wx.PyEventBinder( wxEVT_NC_PAINT )
3758EVT_ERASE_BACKGROUND = wx.PyEventBinder( wxEVT_ERASE_BACKGROUND )
3759EVT_CHAR = wx.PyEventBinder( wxEVT_CHAR )
3760EVT_KEY_DOWN = wx.PyEventBinder( wxEVT_KEY_DOWN )
3761EVT_KEY_UP = wx.PyEventBinder( wxEVT_KEY_UP )
704eda0c 3762EVT_HOTKEY = wx.PyEventBinder( wxEVT_HOTKEY, 1)
d55e5bfc
RD
3763EVT_CHAR_HOOK = wx.PyEventBinder( wxEVT_CHAR_HOOK )
3764EVT_MENU_OPEN = wx.PyEventBinder( wxEVT_MENU_OPEN )
3765EVT_MENU_CLOSE = wx.PyEventBinder( wxEVT_MENU_CLOSE )
3766EVT_MENU_HIGHLIGHT = wx.PyEventBinder( wxEVT_MENU_HIGHLIGHT, 1)
3767EVT_MENU_HIGHLIGHT_ALL = wx.PyEventBinder( wxEVT_MENU_HIGHLIGHT )
3768EVT_SET_FOCUS = wx.PyEventBinder( wxEVT_SET_FOCUS )
3769EVT_KILL_FOCUS = wx.PyEventBinder( wxEVT_KILL_FOCUS )
3770EVT_CHILD_FOCUS = wx.PyEventBinder( wxEVT_CHILD_FOCUS )
3771EVT_ACTIVATE = wx.PyEventBinder( wxEVT_ACTIVATE )
3772EVT_ACTIVATE_APP = wx.PyEventBinder( wxEVT_ACTIVATE_APP )
704eda0c 3773EVT_HIBERNATE = wx.PyEventBinder( wxEVT_HIBERNATE )
d55e5bfc
RD
3774EVT_END_SESSION = wx.PyEventBinder( wxEVT_END_SESSION )
3775EVT_QUERY_END_SESSION = wx.PyEventBinder( wxEVT_QUERY_END_SESSION )
3776EVT_DROP_FILES = wx.PyEventBinder( wxEVT_DROP_FILES )
3777EVT_INIT_DIALOG = wx.PyEventBinder( wxEVT_INIT_DIALOG )
3778EVT_SYS_COLOUR_CHANGED = wx.PyEventBinder( wxEVT_SYS_COLOUR_CHANGED )
3779EVT_DISPLAY_CHANGED = wx.PyEventBinder( wxEVT_DISPLAY_CHANGED )
3780EVT_SHOW = wx.PyEventBinder( wxEVT_SHOW )
3781EVT_MAXIMIZE = wx.PyEventBinder( wxEVT_MAXIMIZE )
3782EVT_ICONIZE = wx.PyEventBinder( wxEVT_ICONIZE )
3783EVT_NAVIGATION_KEY = wx.PyEventBinder( wxEVT_NAVIGATION_KEY )
3784EVT_PALETTE_CHANGED = wx.PyEventBinder( wxEVT_PALETTE_CHANGED )
3785EVT_QUERY_NEW_PALETTE = wx.PyEventBinder( wxEVT_QUERY_NEW_PALETTE )
3786EVT_WINDOW_CREATE = wx.PyEventBinder( wxEVT_CREATE )
3787EVT_WINDOW_DESTROY = wx.PyEventBinder( wxEVT_DESTROY )
3788EVT_SET_CURSOR = wx.PyEventBinder( wxEVT_SET_CURSOR )
3789EVT_MOUSE_CAPTURE_CHANGED = wx.PyEventBinder( wxEVT_MOUSE_CAPTURE_CHANGED )
0f83f5da 3790EVT_MOUSE_CAPTURE_LOST = wx.PyEventBinder( wxEVT_MOUSE_CAPTURE_LOST )
d55e5bfc
RD
3791
3792EVT_LEFT_DOWN = wx.PyEventBinder( wxEVT_LEFT_DOWN )
3793EVT_LEFT_UP = wx.PyEventBinder( wxEVT_LEFT_UP )
3794EVT_MIDDLE_DOWN = wx.PyEventBinder( wxEVT_MIDDLE_DOWN )
3795EVT_MIDDLE_UP = wx.PyEventBinder( wxEVT_MIDDLE_UP )
3796EVT_RIGHT_DOWN = wx.PyEventBinder( wxEVT_RIGHT_DOWN )
3797EVT_RIGHT_UP = wx.PyEventBinder( wxEVT_RIGHT_UP )
3798EVT_MOTION = wx.PyEventBinder( wxEVT_MOTION )
3799EVT_LEFT_DCLICK = wx.PyEventBinder( wxEVT_LEFT_DCLICK )
3800EVT_MIDDLE_DCLICK = wx.PyEventBinder( wxEVT_MIDDLE_DCLICK )
3801EVT_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_RIGHT_DCLICK )
3802EVT_LEAVE_WINDOW = wx.PyEventBinder( wxEVT_LEAVE_WINDOW )
3803EVT_ENTER_WINDOW = wx.PyEventBinder( wxEVT_ENTER_WINDOW )
3804EVT_MOUSEWHEEL = wx.PyEventBinder( wxEVT_MOUSEWHEEL )
3805
3806EVT_MOUSE_EVENTS = wx.PyEventBinder([ wxEVT_LEFT_DOWN,
3807 wxEVT_LEFT_UP,
3808 wxEVT_MIDDLE_DOWN,
3809 wxEVT_MIDDLE_UP,
3810 wxEVT_RIGHT_DOWN,
3811 wxEVT_RIGHT_UP,
3812 wxEVT_MOTION,
3813 wxEVT_LEFT_DCLICK,
3814 wxEVT_MIDDLE_DCLICK,
3815 wxEVT_RIGHT_DCLICK,
3816 wxEVT_ENTER_WINDOW,
3817 wxEVT_LEAVE_WINDOW,
3818 wxEVT_MOUSEWHEEL
3819 ])
3820
3821
3822# Scrolling from wxWindow (sent to wxScrolledWindow)
704eda0c 3823EVT_SCROLLWIN = wx.PyEventBinder([ wxEVT_SCROLLWIN_TOP,
d55e5bfc
RD
3824 wxEVT_SCROLLWIN_BOTTOM,
3825 wxEVT_SCROLLWIN_LINEUP,
3826 wxEVT_SCROLLWIN_LINEDOWN,
704eda0c 3827 wxEVT_SCROLLWIN_PAGEUP,
d55e5bfc
RD
3828 wxEVT_SCROLLWIN_PAGEDOWN,
3829 wxEVT_SCROLLWIN_THUMBTRACK,
3830 wxEVT_SCROLLWIN_THUMBRELEASE,
3831 ])
3832
3833EVT_SCROLLWIN_TOP = wx.PyEventBinder( wxEVT_SCROLLWIN_TOP )
3834EVT_SCROLLWIN_BOTTOM = wx.PyEventBinder( wxEVT_SCROLLWIN_BOTTOM )
3835EVT_SCROLLWIN_LINEUP = wx.PyEventBinder( wxEVT_SCROLLWIN_LINEUP )
3836EVT_SCROLLWIN_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLLWIN_LINEDOWN )
3837EVT_SCROLLWIN_PAGEUP = wx.PyEventBinder( wxEVT_SCROLLWIN_PAGEUP )
3838EVT_SCROLLWIN_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLLWIN_PAGEDOWN )
3839EVT_SCROLLWIN_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLLWIN_THUMBTRACK )
3840EVT_SCROLLWIN_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLLWIN_THUMBRELEASE )
3841
27fb7603 3842# Scrolling from wx.Slider and wx.ScrollBar
704eda0c
RD
3843EVT_SCROLL = wx.PyEventBinder([ wxEVT_SCROLL_TOP,
3844 wxEVT_SCROLL_BOTTOM,
3845 wxEVT_SCROLL_LINEUP,
3846 wxEVT_SCROLL_LINEDOWN,
3847 wxEVT_SCROLL_PAGEUP,
3848 wxEVT_SCROLL_PAGEDOWN,
3849 wxEVT_SCROLL_THUMBTRACK,
3850 wxEVT_SCROLL_THUMBRELEASE,
db67f999 3851 wxEVT_SCROLL_CHANGED,
d55e5bfc
RD
3852 ])
3853
3854EVT_SCROLL_TOP = wx.PyEventBinder( wxEVT_SCROLL_TOP )
3855EVT_SCROLL_BOTTOM = wx.PyEventBinder( wxEVT_SCROLL_BOTTOM )
3856EVT_SCROLL_LINEUP = wx.PyEventBinder( wxEVT_SCROLL_LINEUP )
3857EVT_SCROLL_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLL_LINEDOWN )
3858EVT_SCROLL_PAGEUP = wx.PyEventBinder( wxEVT_SCROLL_PAGEUP )
3859EVT_SCROLL_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLL_PAGEDOWN )
3860EVT_SCROLL_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLL_THUMBTRACK )
3861EVT_SCROLL_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE )
db67f999
RD
3862EVT_SCROLL_CHANGED = wx.PyEventBinder( wxEVT_SCROLL_CHANGED )
3863EVT_SCROLL_ENDSCROLL = EVT_SCROLL_CHANGED
704eda0c 3864
27fb7603 3865# Scrolling from wx.Slider and wx.ScrollBar, with an id
704eda0c
RD
3866EVT_COMMAND_SCROLL = wx.PyEventBinder([ wxEVT_SCROLL_TOP,
3867 wxEVT_SCROLL_BOTTOM,
3868 wxEVT_SCROLL_LINEUP,
3869 wxEVT_SCROLL_LINEDOWN,
3870 wxEVT_SCROLL_PAGEUP,
3871 wxEVT_SCROLL_PAGEDOWN,
3872 wxEVT_SCROLL_THUMBTRACK,
d55e5bfc 3873 wxEVT_SCROLL_THUMBRELEASE,
db67f999 3874 wxEVT_SCROLL_CHANGED,
d55e5bfc
RD
3875 ], 1)
3876
3877EVT_COMMAND_SCROLL_TOP = wx.PyEventBinder( wxEVT_SCROLL_TOP, 1)
3878EVT_COMMAND_SCROLL_BOTTOM = wx.PyEventBinder( wxEVT_SCROLL_BOTTOM, 1)
3879EVT_COMMAND_SCROLL_LINEUP = wx.PyEventBinder( wxEVT_SCROLL_LINEUP, 1)
3880EVT_COMMAND_SCROLL_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLL_LINEDOWN, 1)
3881EVT_COMMAND_SCROLL_PAGEUP = wx.PyEventBinder( wxEVT_SCROLL_PAGEUP, 1)
3882EVT_COMMAND_SCROLL_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLL_PAGEDOWN, 1)
3883EVT_COMMAND_SCROLL_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLL_THUMBTRACK, 1)
3884EVT_COMMAND_SCROLL_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE, 1)
db67f999
RD
3885EVT_COMMAND_SCROLL_CHANGED = wx.PyEventBinder( wxEVT_SCROLL_CHANGED, 1)
3886EVT_COMMAND_SCROLL_ENDSCROLL = EVT_COMMAND_SCROLL_CHANGED
d55e5bfc
RD
3887
3888EVT_BUTTON = wx.PyEventBinder( wxEVT_COMMAND_BUTTON_CLICKED, 1)
3889EVT_CHECKBOX = wx.PyEventBinder( wxEVT_COMMAND_CHECKBOX_CLICKED, 1)
3890EVT_CHOICE = wx.PyEventBinder( wxEVT_COMMAND_CHOICE_SELECTED, 1)
3891EVT_LISTBOX = wx.PyEventBinder( wxEVT_COMMAND_LISTBOX_SELECTED, 1)
3892EVT_LISTBOX_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, 1)
3893EVT_MENU = wx.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED, 1)
3894EVT_MENU_RANGE = wx.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED, 2)
3895EVT_SLIDER = wx.PyEventBinder( wxEVT_COMMAND_SLIDER_UPDATED, 1)
3896EVT_RADIOBOX = wx.PyEventBinder( wxEVT_COMMAND_RADIOBOX_SELECTED, 1)
3897EVT_RADIOBUTTON = wx.PyEventBinder( wxEVT_COMMAND_RADIOBUTTON_SELECTED, 1)
3898
3899EVT_SCROLLBAR = wx.PyEventBinder( wxEVT_COMMAND_SCROLLBAR_UPDATED, 1)
3900EVT_VLBOX = wx.PyEventBinder( wxEVT_COMMAND_VLBOX_SELECTED, 1)
3901EVT_COMBOBOX = wx.PyEventBinder( wxEVT_COMMAND_COMBOBOX_SELECTED, 1)
3902EVT_TOOL = wx.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED, 1)
3903EVT_TOOL_RANGE = wx.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED, 2)
3904EVT_TOOL_RCLICKED = wx.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED, 1)
3905EVT_TOOL_RCLICKED_RANGE = wx.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED, 2)
3906EVT_TOOL_ENTER = wx.PyEventBinder( wxEVT_COMMAND_TOOL_ENTER, 1)
3907EVT_CHECKLISTBOX = wx.PyEventBinder( wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, 1)
3908
3909
3910EVT_COMMAND_LEFT_CLICK = wx.PyEventBinder( wxEVT_COMMAND_LEFT_CLICK, 1)
3911EVT_COMMAND_LEFT_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_LEFT_DCLICK, 1)
3912EVT_COMMAND_RIGHT_CLICK = wx.PyEventBinder( wxEVT_COMMAND_RIGHT_CLICK, 1)
3913EVT_COMMAND_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_RIGHT_DCLICK, 1)
3914EVT_COMMAND_SET_FOCUS = wx.PyEventBinder( wxEVT_COMMAND_SET_FOCUS, 1)
3915EVT_COMMAND_KILL_FOCUS = wx.PyEventBinder( wxEVT_COMMAND_KILL_FOCUS, 1)
3916EVT_COMMAND_ENTER = wx.PyEventBinder( wxEVT_COMMAND_ENTER, 1)
3917
3918EVT_IDLE = wx.PyEventBinder( wxEVT_IDLE )
3919
3920EVT_UPDATE_UI = wx.PyEventBinder( wxEVT_UPDATE_UI, 1)
3921EVT_UPDATE_UI_RANGE = wx.PyEventBinder( wxEVT_UPDATE_UI, 2)
3922
3923EVT_CONTEXT_MENU = wx.PyEventBinder( wxEVT_CONTEXT_MENU )
3924
2131d850
RD
3925EVT_TEXT_CUT = wx.PyEventBinder( wxEVT_COMMAND_TEXT_CUT )
3926EVT_TEXT_COPY = wx.PyEventBinder( wxEVT_COMMAND_TEXT_COPY )
3927EVT_TEXT_PASTE = wx.PyEventBinder( wxEVT_COMMAND_TEXT_PASTE )
d55e5bfc
RD
3928
3929
3930#---------------------------------------------------------------------------
3931
3932class Event(Object):
27fb7603
RD
3933 """
3934 An event is a structure holding information about an event passed to a
3935 callback or member function. wx.Event is an abstract base class for
3936 other event classes
3937 """
554f62e9
RD
3938 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3939 def __init__(self): raise AttributeError, "No constructor defined"
3940 __repr__ = _swig_repr
3941 __swig_destroy__ = _core_.delete_Event
3942 __del__ = lambda self : None;
d55e5bfc 3943 def SetEventType(*args, **kwargs):
27fb7603 3944 """
f460c29d 3945 SetEventType(self, EventType typ)
27fb7603
RD
3946
3947 Sets the specific type of the event.
3948 """
d55e5bfc
RD
3949 return _core_.Event_SetEventType(*args, **kwargs)
3950
3951 def GetEventType(*args, **kwargs):
27fb7603 3952 """
f460c29d 3953 GetEventType(self) -> EventType
27fb7603
RD
3954
3955 Returns the identifier of the given event type, such as
3956 ``wxEVT_COMMAND_BUTTON_CLICKED``.
3957 """
d55e5bfc
RD
3958 return _core_.Event_GetEventType(*args, **kwargs)
3959
3960 def GetEventObject(*args, **kwargs):
27fb7603
RD
3961 """
3962 GetEventObject(self) -> Object
3963
3964 Returns the object (usually a window) associated with the event, if
3965 any.
3966 """
d55e5bfc
RD
3967 return _core_.Event_GetEventObject(*args, **kwargs)
3968
3969 def SetEventObject(*args, **kwargs):
27fb7603
RD
3970 """
3971 SetEventObject(self, Object obj)
3972
3973 Sets the originating object, or in other words, obj is normally the
3974 object that is sending the event.
3975 """
d55e5bfc
RD
3976 return _core_.Event_SetEventObject(*args, **kwargs)
3977
3978 def GetTimestamp(*args, **kwargs):
3979 """GetTimestamp(self) -> long"""
3980 return _core_.Event_GetTimestamp(*args, **kwargs)
3981
3982 def SetTimestamp(*args, **kwargs):
3983 """SetTimestamp(self, long ts=0)"""
3984 return _core_.Event_SetTimestamp(*args, **kwargs)
3985
3986 def GetId(*args, **kwargs):
27fb7603
RD
3987 """
3988 GetId(self) -> int
3989
3990 Returns the identifier associated with this event, such as a button
3991 command id.
3992 """
d55e5bfc
RD
3993 return _core_.Event_GetId(*args, **kwargs)
3994
3995 def SetId(*args, **kwargs):
27fb7603
RD
3996 """
3997 SetId(self, int Id)
3998
3999 Set's the ID for the event. This is usually the ID of the window that
4000 is sending the event, but it can also be a command id from a menu
4001 item, etc.
4002 """
d55e5bfc
RD
4003 return _core_.Event_SetId(*args, **kwargs)
4004
4005 def IsCommandEvent(*args, **kwargs):
27fb7603
RD
4006 """
4007 IsCommandEvent(self) -> bool
4008
4009 Returns true if the event is or is derived from `wx.CommandEvent` else
4010 it returns false. Note: Exists only for optimization purposes.
4011 """
d55e5bfc
RD
4012 return _core_.Event_IsCommandEvent(*args, **kwargs)
4013
4014 def Skip(*args, **kwargs):
51b83b37
RD
4015 """
4016 Skip(self, bool skip=True)
4017
6b449b19
RD
4018 This method can be used inside an event handler to control whether
4019 further event handlers bound to this event will be called after the
4020 current one returns. Without Skip() (or equivalently if Skip(False) is
4021 used), the event will not be processed any more. If Skip(True) is
4022 called, the event processing system continues searching for a further
4023 handler function for this event, even though it has been processed
4024 already in the current handler.
51b83b37 4025 """
d55e5bfc
RD
4026 return _core_.Event_Skip(*args, **kwargs)
4027
4028 def GetSkipped(*args, **kwargs):
27fb7603
RD
4029 """
4030 GetSkipped(self) -> bool
4031
4032 Returns true if the event handler should be skipped, false otherwise.
4033 :see: `Skip`
4034 """
d55e5bfc
RD
4035 return _core_.Event_GetSkipped(*args, **kwargs)
4036
4037 def ShouldPropagate(*args, **kwargs):
27fb7603
RD
4038 """
4039 ShouldPropagate(self) -> bool
4040
4041 Test if this event should be propagated to the parent window or not,
4042 i.e. if the propagation level is currently greater than 0.
4043 """
d55e5bfc
RD
4044 return _core_.Event_ShouldPropagate(*args, **kwargs)
4045
4046 def StopPropagation(*args, **kwargs):
27fb7603
RD
4047 """
4048 StopPropagation(self) -> int
4049
4050 Stop the event from propagating to its parent window. Returns the old
4051 propagation level value which may be later passed to
4052 `ResumePropagation` to allow propagating the event again.
4053 """
d55e5bfc
RD
4054 return _core_.Event_StopPropagation(*args, **kwargs)
4055
4056 def ResumePropagation(*args, **kwargs):
27fb7603
RD
4057 """
4058 ResumePropagation(self, int propagationLevel)
4059
4060 Resume the event propagation by restoring the propagation level. (For
4061 example, you can use the value returned by an earlier call to
4062 `StopPropagation`.)
4063
4064 """
d55e5bfc
RD
4065 return _core_.Event_ResumePropagation(*args, **kwargs)
4066
4067 def Clone(*args, **kwargs):
4068 """Clone(self) -> Event"""
4069 return _core_.Event_Clone(*args, **kwargs)
4070
97ab0f6a
RD
4071 EventObject = property(GetEventObject,SetEventObject,doc="See `GetEventObject` and `SetEventObject`")
4072 EventType = property(GetEventType,SetEventType,doc="See `GetEventType` and `SetEventType`")
4073 Id = property(GetId,SetId,doc="See `GetId` and `SetId`")
4074 Skipped = property(GetSkipped,doc="See `GetSkipped`")
4075 Timestamp = property(GetTimestamp,SetTimestamp,doc="See `GetTimestamp` and `SetTimestamp`")
2131d850 4076_core_.Event_swigregister(Event)
d55e5bfc
RD
4077
4078#---------------------------------------------------------------------------
4079
4080class PropagationDisabler(object):
27fb7603
RD
4081 """
4082 Helper class to temporarily change an event not to propagate. Simply
4083 create an instance of this class and then whe it is destroyed the
4084 propogation of the event will be restored.
4085 """
554f62e9
RD
4086 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4087 __repr__ = _swig_repr
4088 def __init__(self, *args, **kwargs):
27fb7603
RD
4089 """
4090 __init__(self, Event event) -> PropagationDisabler
4091
4092 Helper class to temporarily change an event not to propagate. Simply
4093 create an instance of this class and then whe it is destroyed the
4094 propogation of the event will be restored.
4095 """
554f62e9
RD
4096 _core_.PropagationDisabler_swiginit(self,_core_.new_PropagationDisabler(*args, **kwargs))
4097 __swig_destroy__ = _core_.delete_PropagationDisabler
4098 __del__ = lambda self : None;
2131d850 4099_core_.PropagationDisabler_swigregister(PropagationDisabler)
d55e5bfc
RD
4100
4101class PropagateOnce(object):
27fb7603
RD
4102 """
4103 A helper class that will temporarily lower propagation level of an
4104 event. Simply create an instance of this class and then whe it is
4105 destroyed the propogation of the event will be restored.
4106 """
554f62e9
RD
4107 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4108 __repr__ = _swig_repr
4109 def __init__(self, *args, **kwargs):
27fb7603
RD
4110 """
4111 __init__(self, Event event) -> PropagateOnce
4112
4113 A helper class that will temporarily lower propagation level of an
4114 event. Simply create an instance of this class and then whe it is
4115 destroyed the propogation of the event will be restored.
4116 """
554f62e9
RD
4117 _core_.PropagateOnce_swiginit(self,_core_.new_PropagateOnce(*args, **kwargs))
4118 __swig_destroy__ = _core_.delete_PropagateOnce
4119 __del__ = lambda self : None;
2131d850 4120_core_.PropagateOnce_swigregister(PropagateOnce)
d55e5bfc
RD
4121
4122#---------------------------------------------------------------------------
4123
4124class CommandEvent(Event):
27fb7603
RD
4125 """
4126 This event class contains information about command events, which
4127 originate from a variety of simple controls, as well as menus and
4128 toolbars.
4129 """
554f62e9
RD
4130 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4131 __repr__ = _swig_repr
4132 def __init__(self, *args, **kwargs):
27fb7603 4133 """
f460c29d 4134 __init__(self, EventType commandType=wxEVT_NULL, int winid=0) -> CommandEvent
27fb7603
RD
4135
4136 This event class contains information about command events, which
4137 originate from a variety of simple controls, as well as menus and
4138 toolbars.
4139 """
554f62e9 4140 _core_.CommandEvent_swiginit(self,_core_.new_CommandEvent(*args, **kwargs))
d55e5bfc 4141 def GetSelection(*args, **kwargs):
27fb7603
RD
4142 """
4143 GetSelection(self) -> int
4144
4145 Returns item index for a listbox or choice selection event (not valid
4146 for a deselection).
4147 """
d55e5bfc
RD
4148 return _core_.CommandEvent_GetSelection(*args, **kwargs)
4149
4150 def SetString(*args, **kwargs):
4151 """SetString(self, String s)"""
4152 return _core_.CommandEvent_SetString(*args, **kwargs)
4153
4154 def GetString(*args, **kwargs):
27fb7603
RD
4155 """
4156 GetString(self) -> String
4157
4158 Returns item string for a listbox or choice selection event (not valid
4159 for a deselection).
4160 """
d55e5bfc
RD
4161 return _core_.CommandEvent_GetString(*args, **kwargs)
4162
4163 def IsChecked(*args, **kwargs):
27fb7603
RD
4164 """
4165 IsChecked(self) -> bool
4166
4167 This method can be used with checkbox and menu events: for the
4168 checkboxes, the method returns true for a selection event and false
4169 for a deselection one. For the menu events, this method indicates if
4170 the menu item just has become checked or unchecked (and thus only
4171 makes sense for checkable menu items).
4172 """
d55e5bfc
RD
4173 return _core_.CommandEvent_IsChecked(*args, **kwargs)
4174
4175 Checked = IsChecked
4176 def IsSelection(*args, **kwargs):
27fb7603
RD
4177 """
4178 IsSelection(self) -> bool
4179
4180 For a listbox or similar event, returns true if it is a selection,
4181 false if it is a deselection.
4182 """
d55e5bfc
RD
4183 return _core_.CommandEvent_IsSelection(*args, **kwargs)
4184
4185 def SetExtraLong(*args, **kwargs):
4186 """SetExtraLong(self, long extraLong)"""
4187 return _core_.CommandEvent_SetExtraLong(*args, **kwargs)
4188
4189 def GetExtraLong(*args, **kwargs):
27fb7603
RD
4190 """
4191 GetExtraLong(self) -> long
4192
5ba5649b
RD
4193 Returns extra information dependant on the event objects type. If the
4194 event comes from a listbox selection, it is a boolean determining
4195 whether the event was a selection (true) or a deselection (false). A
4196 listbox deselection only occurs for multiple-selection boxes, and in
4197 this case the index and string values are indeterminate and the
4198 listbox must be examined by the application.
27fb7603 4199 """
d55e5bfc
RD
4200 return _core_.CommandEvent_GetExtraLong(*args, **kwargs)
4201
4202 def SetInt(*args, **kwargs):
4203 """SetInt(self, int i)"""
4204 return _core_.CommandEvent_SetInt(*args, **kwargs)
4205
4206 def GetInt(*args, **kwargs):
27fb7603 4207 """
f460c29d 4208 GetInt(self) -> int
27fb7603 4209
5ba5649b
RD
4210 Returns the integer identifier corresponding to a listbox, choice or
4211 radiobox selection (only if the event was a selection, not a
4212 deselection), or a boolean value representing the value of a checkbox.
27fb7603 4213 """
d55e5bfc
RD
4214 return _core_.CommandEvent_GetInt(*args, **kwargs)
4215
554f62e9
RD
4216 def GetClientData(*args, **kwargs):
4217 """
4218 GetClientData(self) -> PyObject
4219
4220 Returns the client data object for a listbox or choice selection event, (if any.)
4221 """
4222 return _core_.CommandEvent_GetClientData(*args, **kwargs)
4223
4224 def SetClientData(*args, **kwargs):
4225 """
4226 SetClientData(self, PyObject clientData)
4227
4228 Associate the given client data with the item at position n.
4229 """
4230 return _core_.CommandEvent_SetClientData(*args, **kwargs)
4231
4232 GetClientObject = GetClientData
4233 SetClientObject = SetClientData
4234
d55e5bfc
RD
4235 def Clone(*args, **kwargs):
4236 """Clone(self) -> Event"""
4237 return _core_.CommandEvent_Clone(*args, **kwargs)
4238
226118fc
RD
4239 ClientData = property(GetClientData,SetClientData,doc="See `GetClientData` and `SetClientData`")
4240 ClientObject = property(GetClientObject,SetClientObject,doc="See `GetClientObject` and `SetClientObject`")
4241 ExtraLong = property(GetExtraLong,SetExtraLong,doc="See `GetExtraLong` and `SetExtraLong`")
4242 Int = property(GetInt,SetInt,doc="See `GetInt` and `SetInt`")
4243 Selection = property(GetSelection,doc="See `GetSelection`")
4244 String = property(GetString,SetString,doc="See `GetString` and `SetString`")
2131d850 4245_core_.CommandEvent_swigregister(CommandEvent)
d55e5bfc
RD
4246
4247#---------------------------------------------------------------------------
4248
4249class NotifyEvent(CommandEvent):
27fb7603
RD
4250 """
4251 An instance of this class (or one of its derived classes) is sent from
4252 a control when the control's state is being changed and the control
4253 allows that change to be prevented from happening. The event handler
4254 can call `Veto` or `Allow` to tell the control what to do.
4255 """
554f62e9
RD
4256 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4257 __repr__ = _swig_repr
4258 def __init__(self, *args, **kwargs):
27fb7603 4259 """
f460c29d 4260 __init__(self, EventType commandType=wxEVT_NULL, int winid=0) -> NotifyEvent
27fb7603
RD
4261
4262 An instance of this class (or one of its derived classes) is sent from
4263 a control when the control's state is being changed and the control
4264 allows that change to be prevented from happening. The event handler
4265 can call `Veto` or `Allow` to tell the control what to do.
4266 """
554f62e9 4267 _core_.NotifyEvent_swiginit(self,_core_.new_NotifyEvent(*args, **kwargs))
d55e5bfc 4268 def Veto(*args, **kwargs):
27fb7603
RD
4269 """
4270 Veto(self)
4271
4272 Prevents the change announced by this event from happening.
4273
4274 It is in general a good idea to notify the user about the reasons for
4275 vetoing the change because otherwise the applications behaviour (which
4276 just refuses to do what the user wants) might be quite surprising.
4277 """
d55e5bfc
RD
4278 return _core_.NotifyEvent_Veto(*args, **kwargs)
4279
4280 def Allow(*args, **kwargs):
27fb7603
RD
4281 """
4282 Allow(self)
4283
4284 This is the opposite of `Veto`: it explicitly allows the event to be
4285 processed. For most events it is not necessary to call this method as
4286 the events are allowed anyhow but some are forbidden by default (this
4287 will be mentioned in the corresponding event description).
4288 """
d55e5bfc
RD
4289 return _core_.NotifyEvent_Allow(*args, **kwargs)
4290
4291 def IsAllowed(*args, **kwargs):
27fb7603
RD
4292 """
4293 IsAllowed(self) -> bool
4294
4295 Returns true if the change is allowed (`Veto` hasn't been called) or
4296 false otherwise (if it was).
4297 """
d55e5bfc
RD
4298 return _core_.NotifyEvent_IsAllowed(*args, **kwargs)
4299
2131d850 4300_core_.NotifyEvent_swigregister(NotifyEvent)
d55e5bfc
RD
4301
4302#---------------------------------------------------------------------------
4303
4304class ScrollEvent(CommandEvent):
27fb7603
RD
4305 """
4306 A scroll event holds information about events sent from stand-alone
4307 scrollbars and sliders. Note that scrolled windows do not send
4308 instnaces of this event class, but send the `wx.ScrollWinEvent`
4309 instead.
4310 """
554f62e9
RD
4311 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4312 __repr__ = _swig_repr
4313 def __init__(self, *args, **kwargs):
d55e5bfc 4314 """
f460c29d 4315 __init__(self, EventType commandType=wxEVT_NULL, int winid=0, int pos=0,
d55e5bfc
RD
4316 int orient=0) -> ScrollEvent
4317 """
554f62e9 4318 _core_.ScrollEvent_swiginit(self,_core_.new_ScrollEvent(*args, **kwargs))
d55e5bfc 4319 def GetOrientation(*args, **kwargs):
27fb7603
RD
4320 """
4321 GetOrientation(self) -> int
4322
4323 Returns wx.HORIZONTAL or wx.VERTICAL, depending on the orientation of
4324 the scrollbar.
4325 """
d55e5bfc
RD
4326 return _core_.ScrollEvent_GetOrientation(*args, **kwargs)
4327
4328 def GetPosition(*args, **kwargs):
27fb7603
RD
4329 """
4330 GetPosition(self) -> int
4331
4332 Returns the position of the scrollbar.
4333 """
d55e5bfc
RD
4334 return _core_.ScrollEvent_GetPosition(*args, **kwargs)
4335
4336 def SetOrientation(*args, **kwargs):
4337 """SetOrientation(self, int orient)"""
4338 return _core_.ScrollEvent_SetOrientation(*args, **kwargs)
4339
4340 def SetPosition(*args, **kwargs):
4341 """SetPosition(self, int pos)"""
4342 return _core_.ScrollEvent_SetPosition(*args, **kwargs)
4343
33d6fd3b
RD
4344 Orientation = property(GetOrientation,SetOrientation,doc="See `GetOrientation` and `SetOrientation`")
4345 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
2131d850 4346_core_.ScrollEvent_swigregister(ScrollEvent)
d55e5bfc
RD
4347
4348#---------------------------------------------------------------------------
4349
4350class ScrollWinEvent(Event):
27fb7603
RD
4351 """
4352 A wx.ScrollWinEvent holds information about scrolling and is sent from
4353 scrolling windows.
4354 """
554f62e9
RD
4355 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4356 __repr__ = _swig_repr
4357 def __init__(self, *args, **kwargs):
27fb7603 4358 """
f460c29d 4359 __init__(self, EventType commandType=wxEVT_NULL, int pos=0, int orient=0) -> ScrollWinEvent
27fb7603
RD
4360
4361 A wx.ScrollWinEvent holds information about scrolling and is sent from
4362 scrolling windows.
4363 """
554f62e9 4364 _core_.ScrollWinEvent_swiginit(self,_core_.new_ScrollWinEvent(*args, **kwargs))
d55e5bfc 4365 def GetOrientation(*args, **kwargs):
27fb7603
RD
4366 """
4367 GetOrientation(self) -> int
4368
4369 Returns wx.HORIZONTAL or wx.VERTICAL, depending on the orientation of
4370 the scrollbar.
4371 """
d55e5bfc
RD
4372 return _core_.ScrollWinEvent_GetOrientation(*args, **kwargs)
4373
4374 def GetPosition(*args, **kwargs):
27fb7603
RD
4375 """
4376 GetPosition(self) -> int
4377
4378 Returns the position of the scrollbar for the thumb track and release
4379 events. Note that this field can't be used for the other events, you
4380 need to query the window itself for the current position in that case.
4381 """
d55e5bfc
RD
4382 return _core_.ScrollWinEvent_GetPosition(*args, **kwargs)
4383
4384 def SetOrientation(*args, **kwargs):
4385 """SetOrientation(self, int orient)"""
4386 return _core_.ScrollWinEvent_SetOrientation(*args, **kwargs)
4387
4388 def SetPosition(*args, **kwargs):
4389 """SetPosition(self, int pos)"""
4390 return _core_.ScrollWinEvent_SetPosition(*args, **kwargs)
4391
33d6fd3b
RD
4392 Orientation = property(GetOrientation,SetOrientation,doc="See `GetOrientation` and `SetOrientation`")
4393 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
2131d850 4394_core_.ScrollWinEvent_swigregister(ScrollWinEvent)
d55e5bfc
RD
4395
4396#---------------------------------------------------------------------------
4397
4398MOUSE_BTN_ANY = _core_.MOUSE_BTN_ANY
4399MOUSE_BTN_NONE = _core_.MOUSE_BTN_NONE
4400MOUSE_BTN_LEFT = _core_.MOUSE_BTN_LEFT
4401MOUSE_BTN_MIDDLE = _core_.MOUSE_BTN_MIDDLE
4402MOUSE_BTN_RIGHT = _core_.MOUSE_BTN_RIGHT
4403class MouseEvent(Event):
27fb7603
RD
4404 """
4405 This event class contains information about the events generated by
4406 the mouse: they include mouse buttons press and release events and
4407 mouse move events.
4408
4409 All mouse events involving the buttons use ``wx.MOUSE_BTN_LEFT`` for
4410 the left mouse button, ``wx.MOUSE_BTN_MIDDLE`` for the middle one and
4411 ``wx.MOUSE_BTN_RIGHT`` for the right one. Note that not all mice have
4412 a middle button so a portable application should avoid relying on the
4413 events from it.
4414
4415 Note the difference between methods like `LeftDown` and `LeftIsDown`:
4416 the former returns true when the event corresponds to the left mouse
4417 button click while the latter returns true if the left mouse button is
4418 currently being pressed. For example, when the user is dragging the
4419 mouse you can use `LeftIsDown` to test whether the left mouse button
4420 is (still) depressed. Also, by convention, if `LeftDown` returns true,
4421 `LeftIsDown` will also return true in wxWidgets whatever the
4422 underlying GUI behaviour is (which is platform-dependent). The same
4423 applies, of course, to other mouse buttons as well.
4424 """
554f62e9
RD
4425 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4426 __repr__ = _swig_repr
4427 def __init__(self, *args, **kwargs):
27fb7603 4428 """
f460c29d 4429 __init__(self, EventType mouseType=wxEVT_NULL) -> MouseEvent
27fb7603
RD
4430
4431 Constructs a wx.MouseEvent. Valid event types are:
4432
4433 * wxEVT_ENTER_WINDOW
4434 * wxEVT_LEAVE_WINDOW
4435 * wxEVT_LEFT_DOWN
4436 * wxEVT_LEFT_UP
4437 * wxEVT_LEFT_DCLICK
4438 * wxEVT_MIDDLE_DOWN
4439 * wxEVT_MIDDLE_UP
4440 * wxEVT_MIDDLE_DCLICK
4441 * wxEVT_RIGHT_DOWN
4442 * wxEVT_RIGHT_UP
4443 * wxEVT_RIGHT_DCLICK
4444 * wxEVT_MOTION
4445 * wxEVT_MOUSEWHEEL
4446 """
554f62e9 4447 _core_.MouseEvent_swiginit(self,_core_.new_MouseEvent(*args, **kwargs))
d55e5bfc 4448 def IsButton(*args, **kwargs):
27fb7603
RD
4449 """
4450 IsButton(self) -> bool
4451
4452 Returns true if the event was a mouse button event (not necessarily a
4453 button down event - that may be tested using `ButtonDown`).
4454 """
d55e5bfc
RD
4455 return _core_.MouseEvent_IsButton(*args, **kwargs)
4456
4457 def ButtonDown(*args, **kwargs):
27fb7603
RD
4458 """
4459 ButtonDown(self, int but=MOUSE_BTN_ANY) -> bool
4460
5ba5649b
RD
4461 If the argument is omitted, this returns true if the event was any
4462 mouse button down event. Otherwise the argument specifies which
4463 button-down event shold be checked for (see `Button` for the possible
4464 values).
27fb7603 4465 """
d55e5bfc
RD
4466 return _core_.MouseEvent_ButtonDown(*args, **kwargs)
4467
4468 def ButtonDClick(*args, **kwargs):
27fb7603
RD
4469 """
4470 ButtonDClick(self, int but=MOUSE_BTN_ANY) -> bool
4471
4472 If the argument is omitted, this returns true if the event was any
4473 mouse double click event. Otherwise the argument specifies which
4474 double click event to check for (see `Button` for the possible
4475 values).
4476 """
d55e5bfc
RD
4477 return _core_.MouseEvent_ButtonDClick(*args, **kwargs)
4478
4479 def ButtonUp(*args, **kwargs):
27fb7603
RD
4480 """
4481 ButtonUp(self, int but=MOUSE_BTN_ANY) -> bool
4482
4483 If the argument is omitted, this returns true if the event was any
5ba5649b
RD
4484 mouse button up event. Otherwise the argument specifies which button
4485 up event to check for (see `Button` for the possible values).
27fb7603 4486 """
d55e5bfc
RD
4487 return _core_.MouseEvent_ButtonUp(*args, **kwargs)
4488
4489 def Button(*args, **kwargs):
27fb7603
RD
4490 """
4491 Button(self, int button) -> bool
4492
4493 Returns true if the identified mouse button is changing state. Valid
4494 values of button are:
4495
4496 ==================== =====================================
4497 wx.MOUSE_BTN_LEFT check if left button was pressed
4498 wx.MOUSE_BTN_MIDDLE check if middle button was pressed
4499 wx.MOUSE_BTN_RIGHT check if right button was pressed
4500 wx.MOUSE_BTN_ANY check if any button was pressed
4501 ==================== =====================================
4502
4503 """
d55e5bfc
RD
4504 return _core_.MouseEvent_Button(*args, **kwargs)
4505
4506 def ButtonIsDown(*args, **kwargs):
4507 """ButtonIsDown(self, int but) -> bool"""
4508 return _core_.MouseEvent_ButtonIsDown(*args, **kwargs)
4509
4510 def GetButton(*args, **kwargs):
27fb7603
RD
4511 """
4512 GetButton(self) -> int
4513
4514 Returns the mouse button which generated this event or
4515 wx.MOUSE_BTN_NONE if no button is involved (for mouse move, enter or
4516 leave event, for example). Otherwise wx.MOUSE_BTN_LEFT is returned for
4517 the left button down, up and double click events, wx.MOUSE_BTN_MIDDLE
4518 and wx.MOUSE_BTN_RIGHT for the same events for the middle and the
4519 right buttons respectively.
4520 """
d55e5bfc
RD
4521 return _core_.MouseEvent_GetButton(*args, **kwargs)
4522
4523 def ControlDown(*args, **kwargs):
27fb7603
RD
4524 """
4525 ControlDown(self) -> bool
4526
4527 Returns true if the control key was down at the time of the event.
4528 """
d55e5bfc
RD
4529 return _core_.MouseEvent_ControlDown(*args, **kwargs)
4530
4531 def MetaDown(*args, **kwargs):
27fb7603
RD
4532 """
4533 MetaDown(self) -> bool
4534
4535 Returns true if the Meta key was down at the time of the event.
4536 """
d55e5bfc
RD
4537 return _core_.MouseEvent_MetaDown(*args, **kwargs)
4538
4539 def AltDown(*args, **kwargs):
27fb7603
RD
4540 """
4541 AltDown(self) -> bool
4542
4543 Returns true if the Alt key was down at the time of the event.
4544 """
d55e5bfc
RD
4545 return _core_.MouseEvent_AltDown(*args, **kwargs)
4546
4547 def ShiftDown(*args, **kwargs):
27fb7603
RD
4548 """
4549 ShiftDown(self) -> bool
4550
4551 Returns true if the Shift key was down at the time of the event.
4552 """
d55e5bfc
RD
4553 return _core_.MouseEvent_ShiftDown(*args, **kwargs)
4554
412d302d
RD
4555 def CmdDown(*args, **kwargs):
4556 """
4557 CmdDown(self) -> bool
4558
4559 "Cmd" is a pseudo key which is the same as Control for PC and Unix
4560 platforms but the special "Apple" (a.k.a as "Command") key on
5ba5649b 4561 Macs. It often makes sense to use it instead of, say, `ControlDown`
412d302d 4562 because Cmd key is used for the same thing under Mac as Ctrl
27fb7603 4563 elsewhere. The Ctrl key still exists, it's just not used for this
412d302d
RD
4564 purpose. So for non-Mac platforms this is the same as `ControlDown`
4565 and Macs this is the same as `MetaDown`.
4566 """
4567 return _core_.MouseEvent_CmdDown(*args, **kwargs)
4568
d55e5bfc 4569 def LeftDown(*args, **kwargs):
27fb7603
RD
4570 """
4571 LeftDown(self) -> bool
4572
4573 Returns true if the left mouse button state changed to down.
4574 """
d55e5bfc
RD
4575 return _core_.MouseEvent_LeftDown(*args, **kwargs)
4576
4577 def MiddleDown(*args, **kwargs):
27fb7603
RD
4578 """
4579 MiddleDown(self) -> bool
4580
4581 Returns true if the middle mouse button state changed to down.
4582 """
d55e5bfc
RD
4583 return _core_.MouseEvent_MiddleDown(*args, **kwargs)
4584
4585 def RightDown(*args, **kwargs):
27fb7603
RD
4586 """
4587 RightDown(self) -> bool
4588
4589 Returns true if the right mouse button state changed to down.
4590 """
d55e5bfc
RD
4591 return _core_.MouseEvent_RightDown(*args, **kwargs)
4592
4593 def LeftUp(*args, **kwargs):
27fb7603
RD
4594 """
4595 LeftUp(self) -> bool
4596
4597 Returns true if the left mouse button state changed to up.
4598 """
d55e5bfc
RD
4599 return _core_.MouseEvent_LeftUp(*args, **kwargs)
4600
4601 def MiddleUp(*args, **kwargs):
27fb7603
RD
4602 """
4603 MiddleUp(self) -> bool
4604
4605 Returns true if the middle mouse button state changed to up.
4606 """
d55e5bfc
RD
4607 return _core_.MouseEvent_MiddleUp(*args, **kwargs)
4608
4609 def RightUp(*args, **kwargs):
27fb7603
RD
4610 """
4611 RightUp(self) -> bool
4612
4613 Returns true if the right mouse button state changed to up.
4614 """
d55e5bfc
RD
4615 return _core_.MouseEvent_RightUp(*args, **kwargs)
4616
4617 def LeftDClick(*args, **kwargs):
27fb7603
RD
4618 """
4619 LeftDClick(self) -> bool
4620
4621 Returns true if the event was a left button double click.
4622 """
d55e5bfc
RD
4623 return _core_.MouseEvent_LeftDClick(*args, **kwargs)
4624
4625 def MiddleDClick(*args, **kwargs):
27fb7603
RD
4626 """
4627 MiddleDClick(self) -> bool
4628
4629 Returns true if the event was a middle button double click.
4630 """
d55e5bfc
RD
4631 return _core_.MouseEvent_MiddleDClick(*args, **kwargs)
4632
4633 def RightDClick(*args, **kwargs):
27fb7603
RD
4634 """
4635 RightDClick(self) -> bool
4636
4637 Returns true if the event was a right button double click.
4638 """
d55e5bfc
RD
4639 return _core_.MouseEvent_RightDClick(*args, **kwargs)
4640
4641 def LeftIsDown(*args, **kwargs):
27fb7603
RD
4642 """
4643 LeftIsDown(self) -> bool
4644
4645 Returns true if the left mouse button is currently down, independent
4646 of the current event type.
4647
4648 Please notice that it is not the same as LeftDown which returns true
4649 if the left mouse button was just pressed. Rather, it describes the
4650 state of the mouse button before the event happened.
4651
4652 This event is usually used in the mouse event handlers which process
4653 "move mouse" messages to determine whether the user is (still)
4654 dragging the mouse.
4655 """
d55e5bfc
RD
4656 return _core_.MouseEvent_LeftIsDown(*args, **kwargs)
4657
4658 def MiddleIsDown(*args, **kwargs):
27fb7603
RD
4659 """
4660 MiddleIsDown(self) -> bool
4661
4662 Returns true if the middle mouse button is currently down, independent
4663 of the current event type.
4664 """
d55e5bfc
RD
4665 return _core_.MouseEvent_MiddleIsDown(*args, **kwargs)
4666
4667 def RightIsDown(*args, **kwargs):
27fb7603
RD
4668 """
4669 RightIsDown(self) -> bool
4670
4671 Returns true if the right mouse button is currently down, independent
4672 of the current event type.
4673 """
d55e5bfc
RD
4674 return _core_.MouseEvent_RightIsDown(*args, **kwargs)
4675
4676 def Dragging(*args, **kwargs):
27fb7603
RD
4677 """
4678 Dragging(self) -> bool
4679
4680 Returns true if this was a dragging event (motion while a button is
4681 depressed).
4682 """
d55e5bfc
RD
4683 return _core_.MouseEvent_Dragging(*args, **kwargs)
4684
4685 def Moving(*args, **kwargs):
27fb7603
RD
4686 """
4687 Moving(self) -> bool
4688
4689 Returns true if this was a motion event and no mouse buttons were
4690 pressed. If any mouse button is held pressed, then this method returns
4691 false and Dragging returns true.
4692 """
d55e5bfc
RD
4693 return _core_.MouseEvent_Moving(*args, **kwargs)
4694
4695 def Entering(*args, **kwargs):
27fb7603
RD
4696 """
4697 Entering(self) -> bool
4698
4699 Returns true if the mouse was entering the window.
4700 """
d55e5bfc
RD
4701 return _core_.MouseEvent_Entering(*args, **kwargs)
4702
4703 def Leaving(*args, **kwargs):
27fb7603
RD
4704 """
4705 Leaving(self) -> bool
4706
4707 Returns true if the mouse was leaving the window.
4708 """
d55e5bfc
RD
4709 return _core_.MouseEvent_Leaving(*args, **kwargs)
4710
4711 def GetPosition(*args, **kwargs):
4712 """
4713 GetPosition(self) -> Point
4714
27fb7603
RD
4715 Returns the pixel position of the mouse in window coordinates when the
4716 event happened.
d55e5bfc
RD
4717 """
4718 return _core_.MouseEvent_GetPosition(*args, **kwargs)
4719
4720 def GetPositionTuple(*args, **kwargs):
4721 """
4722 GetPositionTuple() -> (x,y)
4723
27fb7603
RD
4724 Returns the pixel position of the mouse in window coordinates when the
4725 event happened.
d55e5bfc
RD
4726 """
4727 return _core_.MouseEvent_GetPositionTuple(*args, **kwargs)
4728
4729 def GetLogicalPosition(*args, **kwargs):
27fb7603
RD
4730 """
4731 GetLogicalPosition(self, DC dc) -> Point
4732
4733 Returns the logical mouse position in pixels (i.e. translated
4734 according to the translation set for the DC, which usually indicates
4735 that the window has been scrolled).
4736 """
d55e5bfc
RD
4737 return _core_.MouseEvent_GetLogicalPosition(*args, **kwargs)
4738
4739 def GetX(*args, **kwargs):
27fb7603
RD
4740 """
4741 GetX(self) -> int
4742
4743 Returns X coordinate of the physical mouse event position.
4744 """
d55e5bfc
RD
4745 return _core_.MouseEvent_GetX(*args, **kwargs)
4746
4747 def GetY(*args, **kwargs):
27fb7603
RD
4748 """
4749 GetY(self) -> int
4750
4751 Returns Y coordinate of the physical mouse event position.
4752 """
d55e5bfc
RD
4753 return _core_.MouseEvent_GetY(*args, **kwargs)
4754
4755 def GetWheelRotation(*args, **kwargs):
27fb7603
RD
4756 """
4757 GetWheelRotation(self) -> int
4758
4759 Get wheel rotation, positive or negative indicates direction of
4760 rotation. Current devices all send an event when rotation is equal to
4761 +/-WheelDelta, but this allows for finer resolution devices to be
4762 created in the future. Because of this you shouldn't assume that one
4763 event is equal to 1 line or whatever, but you should be able to either
4764 do partial line scrolling or wait until +/-WheelDelta rotation values
4765 have been accumulated before scrolling.
4766 """
d55e5bfc
RD
4767 return _core_.MouseEvent_GetWheelRotation(*args, **kwargs)
4768
4769 def GetWheelDelta(*args, **kwargs):
27fb7603
RD
4770 """
4771 GetWheelDelta(self) -> int
4772
4773 Get wheel delta, normally 120. This is the threshold for action to be
4774 taken, and one such action (for example, scrolling one increment)
4775 should occur for each delta.
4776 """
d55e5bfc
RD
4777 return _core_.MouseEvent_GetWheelDelta(*args, **kwargs)
4778
4779 def GetLinesPerAction(*args, **kwargs):
27fb7603
RD
4780 """
4781 GetLinesPerAction(self) -> int
4782
4783 Returns the configured number of lines (or whatever) to be scrolled
4784 per wheel action. Defaults to three.
4785 """
d55e5bfc
RD
4786 return _core_.MouseEvent_GetLinesPerAction(*args, **kwargs)
4787
4788 def IsPageScroll(*args, **kwargs):
27fb7603
RD
4789 """
4790 IsPageScroll(self) -> bool
4791
4792 Returns true if the system has been setup to do page scrolling with
4793 the mouse wheel instead of line scrolling.
4794 """
d55e5bfc
RD
4795 return _core_.MouseEvent_IsPageScroll(*args, **kwargs)
4796
4797 m_x = property(_core_.MouseEvent_m_x_get, _core_.MouseEvent_m_x_set)
4798 m_y = property(_core_.MouseEvent_m_y_get, _core_.MouseEvent_m_y_set)
4799 m_leftDown = property(_core_.MouseEvent_m_leftDown_get, _core_.MouseEvent_m_leftDown_set)
4800 m_middleDown = property(_core_.MouseEvent_m_middleDown_get, _core_.MouseEvent_m_middleDown_set)
4801 m_rightDown = property(_core_.MouseEvent_m_rightDown_get, _core_.MouseEvent_m_rightDown_set)
4802 m_controlDown = property(_core_.MouseEvent_m_controlDown_get, _core_.MouseEvent_m_controlDown_set)
4803 m_shiftDown = property(_core_.MouseEvent_m_shiftDown_get, _core_.MouseEvent_m_shiftDown_set)
4804 m_altDown = property(_core_.MouseEvent_m_altDown_get, _core_.MouseEvent_m_altDown_set)
4805 m_metaDown = property(_core_.MouseEvent_m_metaDown_get, _core_.MouseEvent_m_metaDown_set)
4806 m_wheelRotation = property(_core_.MouseEvent_m_wheelRotation_get, _core_.MouseEvent_m_wheelRotation_set)
4807 m_wheelDelta = property(_core_.MouseEvent_m_wheelDelta_get, _core_.MouseEvent_m_wheelDelta_set)
4808 m_linesPerAction = property(_core_.MouseEvent_m_linesPerAction_get, _core_.MouseEvent_m_linesPerAction_set)
57332a5a
RD
4809 Button = property(GetButton,doc="See `GetButton`")
4810 LinesPerAction = property(GetLinesPerAction,doc="See `GetLinesPerAction`")
4811 LogicalPosition = property(GetLogicalPosition,doc="See `GetLogicalPosition`")
4812 Position = property(GetPosition,doc="See `GetPosition`")
4813 WheelDelta = property(GetWheelDelta,doc="See `GetWheelDelta`")
4814 WheelRotation = property(GetWheelRotation,doc="See `GetWheelRotation`")
4815 X = property(GetX,doc="See `GetX`")
4816 Y = property(GetY,doc="See `GetY`")
2131d850 4817_core_.MouseEvent_swigregister(MouseEvent)
d55e5bfc
RD
4818
4819#---------------------------------------------------------------------------
4820
4821class SetCursorEvent(Event):
5ba5649b
RD
4822 """
4823 A SetCursorEvent is generated when the mouse cursor is about to be set
4824 as a result of mouse motion. This event gives the application the
4825 chance to perform specific mouse cursor processing based on the
4826 current position of the mouse within the window. Use the `SetCursor`
4827 method to specify the cursor you want to be displayed.
4828 """
554f62e9
RD
4829 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4830 __repr__ = _swig_repr
4831 def __init__(self, *args, **kwargs):
5ba5649b
RD
4832 """
4833 __init__(self, int x=0, int y=0) -> SetCursorEvent
4834
4835 Construct a new `wx.SetCursorEvent`.
4836 """
554f62e9 4837 _core_.SetCursorEvent_swiginit(self,_core_.new_SetCursorEvent(*args, **kwargs))
d55e5bfc 4838 def GetX(*args, **kwargs):
5ba5649b
RD
4839 """
4840 GetX(self) -> int
4841
4842 Returns the X coordinate of the mouse in client coordinates.
4843 """
d55e5bfc
RD
4844 return _core_.SetCursorEvent_GetX(*args, **kwargs)
4845
4846 def GetY(*args, **kwargs):
5ba5649b
RD
4847 """
4848 GetY(self) -> int
4849
4850 Returns the Y coordinate of the mouse in client coordinates.
4851 """
d55e5bfc
RD
4852 return _core_.SetCursorEvent_GetY(*args, **kwargs)
4853
4854 def SetCursor(*args, **kwargs):
5ba5649b
RD
4855 """
4856 SetCursor(self, Cursor cursor)
4857
4858 Sets the cursor associated with this event.
4859 """
d55e5bfc
RD
4860 return _core_.SetCursorEvent_SetCursor(*args, **kwargs)
4861
4862 def GetCursor(*args, **kwargs):
5ba5649b
RD
4863 """
4864 GetCursor(self) -> Cursor
4865
4866 Returns a reference to the cursor specified by this event.
4867 """
d55e5bfc
RD
4868 return _core_.SetCursorEvent_GetCursor(*args, **kwargs)
4869
4870 def HasCursor(*args, **kwargs):
5ba5649b
RD
4871 """
4872 HasCursor(self) -> bool
4873
4874 Returns true if the cursor specified by this event is a valid cursor.
4875 """
d55e5bfc
RD
4876 return _core_.SetCursorEvent_HasCursor(*args, **kwargs)
4877
33d6fd3b
RD
4878 Cursor = property(GetCursor,SetCursor,doc="See `GetCursor` and `SetCursor`")
4879 X = property(GetX,doc="See `GetX`")
4880 Y = property(GetY,doc="See `GetY`")
2131d850 4881_core_.SetCursorEvent_swigregister(SetCursorEvent)
d55e5bfc
RD
4882
4883#---------------------------------------------------------------------------
4884
4885class KeyEvent(Event):
5ba5649b
RD
4886 """
4887 This event class contains information about keypress and character
4888 events. These events are only sent to the widget that currently has
4889 the keyboard focus.
4890
4891 Notice that there are three different kinds of keyboard events in
4892 wxWidgets: key down and up events and char events. The difference
4893 between the first two is clear - the first corresponds to a key press
4894 and the second to a key release - otherwise they are identical. Just
4895 note that if the key is maintained in a pressed state you will
4896 typically get a lot of (automatically generated) down events but only
4897 one up so it is wrong to assume that there is one up event
4898 corresponding to each down one.
4899
4900 Both key events provide untranslated key codes while the char event
4901 carries the translated one. The untranslated code for alphanumeric
4902 keys is always an upper case value. For the other keys it is one of
4903 WXK_XXX values from the keycodes table. The translated key is, in
4904 general, the character the user expects to appear as the result of the
4905 key combination when typing the text into a text entry zone, for
4906 example.
4907
4908 A few examples to clarify this (all assume that CAPS LOCK is unpressed
4909 and the standard US keyboard): when the 'A' key is pressed, the key
4910 down event key code is equal to ASCII A == 65. But the char event key
4911 code is ASCII a == 97. On the other hand, if you press both SHIFT and
4912 'A' keys simultaneously , the key code in key down event will still be
4913 just 'A' while the char event key code parameter will now be 'A' as
4914 well.
4915
4916 Although in this simple case it is clear that the correct key code
4917 could be found in the key down event handler by checking the value
4918 returned by `ShiftDown`, in general you should use EVT_CHAR for this
4919 as for non alphanumeric keys or non-US keyboard layouts the
4920 translation is keyboard-layout dependent and can only be done properly
4921 by the system itself.
4922
4923 Another kind of translation is done when the control key is pressed:
4924 for example, for CTRL-A key press the key down event still carries the
4925 same key code 'A' as usual but the char event will have key code of 1,
4926 the ASCII value of this key combination.
4927
4928 You may discover how the other keys on your system behave
4929 interactively by running the KeyEvents sample in the wxPython demo and
4930 pressing some keys while the blue box at the top has the keyboard
4931 focus.
4932
4933 **Note**: If a key down event is caught and the event handler does not
4934 call event.Skip() then the coresponding char event will not
4935 happen. This is by design and enables the programs that handle both
4936 types of events to be a bit simpler.
4937
4938 **Note for Windows programmers**: The key and char events in wxWidgets
4939 are similar to but slightly different from Windows WM_KEYDOWN and
4940 WM_CHAR events. In particular, Alt-x combination will generate a char
4941 event in wxWidgets (unless it is used as an accelerator).
4942
4943 **Tip**: be sure to call event.Skip() for events that you don't
4944 process in key event function, otherwise menu shortcuts may cease to
4945 work under Windows.
4946
4947 """
554f62e9
RD
4948 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4949 __repr__ = _swig_repr
4950 def __init__(self, *args, **kwargs):
5ba5649b 4951 """
f460c29d 4952 __init__(self, EventType eventType=wxEVT_NULL) -> KeyEvent
5ba5649b
RD
4953
4954 Construct a new `wx.KeyEvent`. Valid event types are:
4955 *
4956 """
554f62e9 4957 _core_.KeyEvent_swiginit(self,_core_.new_KeyEvent(*args, **kwargs))
b1fcee84
RD
4958 def GetModifiers(*args, **kwargs):
4959 """
4960 GetModifiers(self) -> int
4961
4962 Returns a bitmask of the current modifier settings. Can be used to
4963 check if the key event has exactly the given modifiers without having
4964 to explicitly check that the other modifiers are not down. For
4965 example::
4966
4967 if event.GetModifers() == wx.MOD_CONTROL:
4968 DoSomething()
4969
4970 """
4971 return _core_.KeyEvent_GetModifiers(*args, **kwargs)
4972
d55e5bfc 4973 def ControlDown(*args, **kwargs):
5ba5649b
RD
4974 """
4975 ControlDown(self) -> bool
4976
4977 Returns ``True`` if the Control key was down at the time of the event.
4978 """
d55e5bfc
RD
4979 return _core_.KeyEvent_ControlDown(*args, **kwargs)
4980
4981 def MetaDown(*args, **kwargs):
5ba5649b
RD
4982 """
4983 MetaDown(self) -> bool
4984
4985 Returns ``True`` if the Meta key was down at the time of the event.
4986 """
d55e5bfc
RD
4987 return _core_.KeyEvent_MetaDown(*args, **kwargs)
4988
4989 def AltDown(*args, **kwargs):
5ba5649b
RD
4990 """
4991 AltDown(self) -> bool
4992
4993 Returns ``True`` if the Alt key was down at the time of the event.
4994 """
d55e5bfc
RD
4995 return _core_.KeyEvent_AltDown(*args, **kwargs)
4996
4997 def ShiftDown(*args, **kwargs):
5ba5649b
RD
4998 """
4999 ShiftDown(self) -> bool
5000
5001 Returns ``True`` if the Shift key was down at the time of the event.
5002 """
d55e5bfc
RD
5003 return _core_.KeyEvent_ShiftDown(*args, **kwargs)
5004
412d302d
RD
5005 def CmdDown(*args, **kwargs):
5006 """
5007 CmdDown(self) -> bool
5008
5009 "Cmd" is a pseudo key which is the same as Control for PC and Unix
5010 platforms but the special "Apple" (a.k.a as "Command") key on
5ba5649b 5011 Macs. It makes often sense to use it instead of, say, `ControlDown`
412d302d
RD
5012 because Cmd key is used for the same thing under Mac as Ctrl
5013 elsewhere. The Ctrl still exists, it's just not used for this
5014 purpose. So for non-Mac platforms this is the same as `ControlDown`
5015 and Macs this is the same as `MetaDown`.
5016 """
5017 return _core_.KeyEvent_CmdDown(*args, **kwargs)
5018
d55e5bfc 5019 def HasModifiers(*args, **kwargs):
5ba5649b
RD
5020 """
5021 HasModifiers(self) -> bool
5022
5023 Returns true if either CTRL or ALT keys was down at the time of the
5024 key event. Note that this function does not take into account neither
5025 SHIFT nor META key states (the reason for ignoring the latter is that
5026 it is common for NUMLOCK key to be configured as META under X but the
5027 key presses even while NUMLOCK is on should be still processed
5028 normally).
5029 """
d55e5bfc
RD
5030 return _core_.KeyEvent_HasModifiers(*args, **kwargs)
5031
5032 def GetKeyCode(*args, **kwargs):
5ba5649b
RD
5033 """
5034 GetKeyCode(self) -> int
5035
5036 Returns the virtual key code. ASCII events return normal ASCII values,
5037 while non-ASCII events return values such as WXK_LEFT for the left
5038 cursor key. See `wx.KeyEvent` for a full list of the virtual key
5039 codes.
5040
5041 Note that in Unicode build, the returned value is meaningful only if
5042 the user entered a character that can be represented in current
5043 locale's default charset. You can obtain the corresponding Unicode
5044 character using `GetUnicodeKey`.
5045 """
d55e5bfc
RD
5046 return _core_.KeyEvent_GetKeyCode(*args, **kwargs)
5047
19272049 5048 def GetUnicodeKey(*args, **kwargs):
5ba5649b
RD
5049 """
5050 GetUnicodeKey(self) -> int
5051
5052 Returns the Unicode character corresponding to this key event. This
5053 function is only meaningfule in a Unicode build of wxPython.
5054 """
19272049 5055 return _core_.KeyEvent_GetUnicodeKey(*args, **kwargs)
d55e5bfc 5056
19272049 5057 GetUniChar = GetUnicodeKey
b850e7f3
RD
5058 def SetUnicodeKey(*args, **kwargs):
5059 """
5060 SetUnicodeKey(self, int uniChar)
5061
5062 Set the Unicode value of the key event, but only if this is a Unicode
5063 build of wxPython.
5064 """
5065 return _core_.KeyEvent_SetUnicodeKey(*args, **kwargs)
5066
d55e5bfc 5067 def GetRawKeyCode(*args, **kwargs):
5ba5649b
RD
5068 """
5069 GetRawKeyCode(self) -> unsigned int
5070
5071 Returns the raw key code for this event. This is a platform-dependent
5072 scan code which should only be used in advanced
5073 applications. Currently the raw key codes are not supported by all
5074 ports.
5075 """
d55e5bfc
RD
5076 return _core_.KeyEvent_GetRawKeyCode(*args, **kwargs)
5077
5078 def GetRawKeyFlags(*args, **kwargs):
5ba5649b
RD
5079 """
5080 GetRawKeyFlags(self) -> unsigned int
5081
5082 Returns the low level key flags for this event. The flags are
5083 platform-dependent and should only be used in advanced applications.
5084 Currently the raw key flags are not supported by all ports.
5085 """
d55e5bfc
RD
5086 return _core_.KeyEvent_GetRawKeyFlags(*args, **kwargs)
5087
5088 def GetPosition(*args, **kwargs):
5089 """
5090 GetPosition(self) -> Point
5091
5ba5649b 5092 Find the position of the event, if applicable.
d55e5bfc
RD
5093 """
5094 return _core_.KeyEvent_GetPosition(*args, **kwargs)
5095
5096 def GetPositionTuple(*args, **kwargs):
5097 """
5098 GetPositionTuple() -> (x,y)
5099
5ba5649b 5100 Find the position of the event, if applicable.
d55e5bfc
RD
5101 """
5102 return _core_.KeyEvent_GetPositionTuple(*args, **kwargs)
5103
5104 def GetX(*args, **kwargs):
5ba5649b
RD
5105 """
5106 GetX(self) -> int
5107
5108 Returns the X position (in client coordinates) of the event, if
5109 applicable.
5110 """
d55e5bfc
RD
5111 return _core_.KeyEvent_GetX(*args, **kwargs)
5112
5113 def GetY(*args, **kwargs):
5ba5649b
RD
5114 """
5115 GetY(self) -> int
5116
5117 Returns the Y position (in client coordinates) of the event, if
5118 applicable.
5119 """
d55e5bfc
RD
5120 return _core_.KeyEvent_GetY(*args, **kwargs)
5121
5122 m_x = property(_core_.KeyEvent_m_x_get, _core_.KeyEvent_m_x_set)
5123 m_y = property(_core_.KeyEvent_m_y_get, _core_.KeyEvent_m_y_set)
5124 m_keyCode = property(_core_.KeyEvent_m_keyCode_get, _core_.KeyEvent_m_keyCode_set)
5125 m_controlDown = property(_core_.KeyEvent_m_controlDown_get, _core_.KeyEvent_m_controlDown_set)
5126 m_shiftDown = property(_core_.KeyEvent_m_shiftDown_get, _core_.KeyEvent_m_shiftDown_set)
5127 m_altDown = property(_core_.KeyEvent_m_altDown_get, _core_.KeyEvent_m_altDown_set)
5128 m_metaDown = property(_core_.KeyEvent_m_metaDown_get, _core_.KeyEvent_m_metaDown_set)
5129 m_scanCode = property(_core_.KeyEvent_m_scanCode_get, _core_.KeyEvent_m_scanCode_set)
5130 m_rawCode = property(_core_.KeyEvent_m_rawCode_get, _core_.KeyEvent_m_rawCode_set)
5131 m_rawFlags = property(_core_.KeyEvent_m_rawFlags_get, _core_.KeyEvent_m_rawFlags_set)
97ab0f6a
RD
5132 KeyCode = property(GetKeyCode,doc="See `GetKeyCode`")
5133 Modifiers = property(GetModifiers,doc="See `GetModifiers`")
5134 Position = property(GetPosition,doc="See `GetPosition`")
5135 RawKeyCode = property(GetRawKeyCode,doc="See `GetRawKeyCode`")
5136 RawKeyFlags = property(GetRawKeyFlags,doc="See `GetRawKeyFlags`")
5137 UnicodeKey = property(GetUnicodeKey,SetUnicodeKey,doc="See `GetUnicodeKey` and `SetUnicodeKey`")
5138 X = property(GetX,doc="See `GetX`")
5139 Y = property(GetY,doc="See `GetY`")
2131d850 5140_core_.KeyEvent_swigregister(KeyEvent)
d55e5bfc
RD
5141
5142#---------------------------------------------------------------------------
5143
5144class SizeEvent(Event):
5ba5649b
RD
5145 """
5146 A size event holds information about size change events. The EVT_SIZE
5147 handler function will be called when the window it is bound to has
5148 been resized.
5149
5150 Note that the size passed is of the whole window: call
5151 `wx.Window.GetClientSize` for the area which may be used by the
5152 application.
5153
5154 When a window is resized, usually only a small part of the window is
5155 damaged and and that area is all that is in the update region for the
5156 next paint event. However, if your drawing depends on the size of the
5157 window, you may need to clear the DC explicitly and repaint the whole
5158 window. In which case, you may need to call `wx.Window.Refresh` to
5159 invalidate the entire window.
5160
5161 """
554f62e9
RD
5162 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5163 __repr__ = _swig_repr
5164 def __init__(self, *args, **kwargs):
5ba5649b
RD
5165 """
5166 __init__(self, Size sz=DefaultSize, int winid=0) -> SizeEvent
5167
5168 Construct a new ``wx.SizeEvent``.
5169 """
554f62e9 5170 _core_.SizeEvent_swiginit(self,_core_.new_SizeEvent(*args, **kwargs))
d55e5bfc 5171 def GetSize(*args, **kwargs):
5ba5649b
RD
5172 """
5173 GetSize(self) -> Size
5174
5175 Returns the entire size of the window generating the size change
5176 event.
5177 """
d55e5bfc
RD
5178 return _core_.SizeEvent_GetSize(*args, **kwargs)
5179
5180 def GetRect(*args, **kwargs):
5181 """GetRect(self) -> Rect"""
5182 return _core_.SizeEvent_GetRect(*args, **kwargs)
5183
5184 def SetRect(*args, **kwargs):
5185 """SetRect(self, Rect rect)"""
5186 return _core_.SizeEvent_SetRect(*args, **kwargs)
5187
5188 def SetSize(*args, **kwargs):
5189 """SetSize(self, Size size)"""
5190 return _core_.SizeEvent_SetSize(*args, **kwargs)
5191
5192 m_size = property(_core_.SizeEvent_m_size_get, _core_.SizeEvent_m_size_set)
5193 m_rect = property(_core_.SizeEvent_m_rect_get, _core_.SizeEvent_m_rect_set)
33d6fd3b
RD
5194 Rect = property(GetRect,SetRect,doc="See `GetRect` and `SetRect`")
5195 Size = property(GetSize,SetSize,doc="See `GetSize` and `SetSize`")
2131d850 5196_core_.SizeEvent_swigregister(SizeEvent)
d55e5bfc
RD
5197
5198#---------------------------------------------------------------------------
5199
5200class MoveEvent(Event):
5ba5649b
RD
5201 """
5202 This event object is sent for EVT_MOVE event bindings when a window is
5203 moved to a new position.
5204 """
554f62e9
RD
5205 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5206 __repr__ = _swig_repr
5207 def __init__(self, *args, **kwargs):
5ba5649b
RD
5208 """
5209 __init__(self, Point pos=DefaultPosition, int winid=0) -> MoveEvent
5210
5211 Constructor.
5212 """
554f62e9 5213 _core_.MoveEvent_swiginit(self,_core_.new_MoveEvent(*args, **kwargs))
d55e5bfc 5214 def GetPosition(*args, **kwargs):
5ba5649b
RD
5215 """
5216 GetPosition(self) -> Point
5217
5218 Returns the position of the window generating the move change event.
5219 """
d55e5bfc
RD
5220 return _core_.MoveEvent_GetPosition(*args, **kwargs)
5221
5222 def GetRect(*args, **kwargs):
5223 """GetRect(self) -> Rect"""
5224 return _core_.MoveEvent_GetRect(*args, **kwargs)
5225
5226 def SetRect(*args, **kwargs):
5227 """SetRect(self, Rect rect)"""
5228 return _core_.MoveEvent_SetRect(*args, **kwargs)
5229
5230 def SetPosition(*args, **kwargs):
5231 """SetPosition(self, Point pos)"""
5232 return _core_.MoveEvent_SetPosition(*args, **kwargs)
5233
fef4c27a
RD
5234 m_pos = property(GetPosition, SetPosition)
5235 m_rect = property(GetRect, SetRect)
5236
57332a5a
RD
5237 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
5238 Rect = property(GetRect,SetRect,doc="See `GetRect` and `SetRect`")
2131d850 5239_core_.MoveEvent_swigregister(MoveEvent)
d55e5bfc
RD
5240
5241#---------------------------------------------------------------------------
5242
5243class PaintEvent(Event):
5ba5649b
RD
5244 """
5245 A paint event is sent when a window's contents needs to be repainted.
5246 Note that in an EVT_PAINT handler the application must *always* create
5247 a `wx.PaintDC` object, even if you do not use it. Otherwise MS
5248 Windows assumes that the window has not been painted yet and will send
5249 the event again, causing endless refreshes.
5250
5251 You can optimize painting by retrieving the rectangles that have been
5252 damaged using `wx.Window.GetUpdateRegion` and/or `wx.RegionIterator`,
5253 and only repainting these rectangles. The rectangles are in terms of
5254 the client area, and are unscrolled, so you will need to do some
5255 calculations using the current view position to obtain logical,
5256 scrolled units.
5257
5258 """
554f62e9
RD
5259 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5260 __repr__ = _swig_repr
5261 def __init__(self, *args, **kwargs):
d55e5bfc 5262 """__init__(self, int Id=0) -> PaintEvent"""
554f62e9 5263 _core_.PaintEvent_swiginit(self,_core_.new_PaintEvent(*args, **kwargs))
2131d850 5264_core_.PaintEvent_swigregister(PaintEvent)
d55e5bfc
RD
5265
5266class NcPaintEvent(Event):
093d3ff1 5267 """Proxy of C++ NcPaintEvent class"""
554f62e9
RD
5268 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5269 __repr__ = _swig_repr
5270 def __init__(self, *args, **kwargs):
d55e5bfc 5271 """__init__(self, int winid=0) -> NcPaintEvent"""
554f62e9 5272 _core_.NcPaintEvent_swiginit(self,_core_.new_NcPaintEvent(*args, **kwargs))
2131d850 5273_core_.NcPaintEvent_swigregister(NcPaintEvent)
d55e5bfc
RD
5274
5275#---------------------------------------------------------------------------
5276
5277class EraseEvent(Event):
5ba5649b
RD
5278 """
5279 An erase event is sent whenever the background of a window needs to be
5280 repainted. To intercept this event use the EVT_ERASE_BACKGROUND event
5281 binder. On some platforms, such as GTK+, this event is simulated
5282 (simply generated just before the paint event) and may cause flicker.
5283
5284 To paint a custom background use the `GetDC` method and use the returned
5285 device context if it is not ``None``, otherwise create a temporary
5286 `wx.ClientDC` and draw on that.
5287
5288 """
554f62e9
RD
5289 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5290 __repr__ = _swig_repr
5291 def __init__(self, *args, **kwargs):
5ba5649b
RD
5292 """
5293 __init__(self, int Id=0, DC dc=None) -> EraseEvent
5294
5295 Constructor
5296 """
554f62e9 5297 _core_.EraseEvent_swiginit(self,_core_.new_EraseEvent(*args, **kwargs))
d55e5bfc 5298 def GetDC(*args, **kwargs):
5ba5649b
RD
5299 """
5300 GetDC(self) -> DC
5301
5302 Returns the device context the event handler should draw upon. If
5303 ``None`` is returned then create a temporary `wx.ClientDC` and use
5304 that instead.
5305 """
d55e5bfc
RD
5306 return _core_.EraseEvent_GetDC(*args, **kwargs)
5307
97ab0f6a 5308 DC = property(GetDC,doc="See `GetDC`")
2131d850 5309_core_.EraseEvent_swigregister(EraseEvent)
d55e5bfc
RD
5310
5311#---------------------------------------------------------------------------
5312
5313class FocusEvent(Event):
5ba5649b
RD
5314 """
5315 A focus event is sent when a window's focus changes. The window losing
5316 focus receives an EVT_KILL_FOCUS event while the window gaining it
5317 gets an EVT_SET_FOCUS event.
5318
5319 Notice that the set focus event happens both when the user gives focus
5320 to the window (whether using the mouse or keyboard) and when it is
5321 done from the program itself using `wx.Window.SetFocus`.
5322
5323 """
554f62e9
RD
5324 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5325 __repr__ = _swig_repr
5326 def __init__(self, *args, **kwargs):
5ba5649b 5327 """
f460c29d 5328 __init__(self, EventType type=wxEVT_NULL, int winid=0) -> FocusEvent
5ba5649b
RD
5329
5330 Constructor
5331 """
554f62e9 5332 _core_.FocusEvent_swiginit(self,_core_.new_FocusEvent(*args, **kwargs))
d55e5bfc 5333 def GetWindow(*args, **kwargs):
5ba5649b
RD
5334 """
5335 GetWindow(self) -> Window
5336
5337 Returns the other window associated with this event, that is the
5338 window which had the focus before for the EVT_SET_FOCUS event and the
5339 window which is going to receive focus for the wxEVT_KILL_FOCUS event.
5340
5341 Warning: the window returned may be None!
5342 """
d55e5bfc
RD
5343 return _core_.FocusEvent_GetWindow(*args, **kwargs)
5344
5345 def SetWindow(*args, **kwargs):
5346 """SetWindow(self, Window win)"""
5347 return _core_.FocusEvent_SetWindow(*args, **kwargs)
5348
97ab0f6a 5349 Window = property(GetWindow,SetWindow,doc="See `GetWindow` and `SetWindow`")
2131d850 5350_core_.FocusEvent_swigregister(FocusEvent)
d55e5bfc
RD
5351
5352#---------------------------------------------------------------------------
5353
5354class ChildFocusEvent(CommandEvent):
5ba5649b 5355 """
33d6fd3b
RD
5356 A child focus event is sent to a (parent-)window when one of its child
5357 windows gains focus, so that the window could restore the focus back
5358 to its corresponding child if it loses it now and regains later.
5359
5360 Notice that child window is the direct child of the window receiving
5361 the event, and so may not be the actual widget recieving focus if it
5362 is further down the containment heirarchy. Use `wx.Window.FindFocus`
5363 to get the widget that is actually receiving focus.
5ba5649b 5364 """
554f62e9
RD
5365 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5366 __repr__ = _swig_repr
5367 def __init__(self, *args, **kwargs):
5ba5649b
RD
5368 """
5369 __init__(self, Window win=None) -> ChildFocusEvent
5370
5371 Constructor
5372 """
554f62e9 5373 _core_.ChildFocusEvent_swiginit(self,_core_.new_ChildFocusEvent(*args, **kwargs))
d55e5bfc 5374 def GetWindow(*args, **kwargs):
5ba5649b
RD
5375 """
5376 GetWindow(self) -> Window
5377
33d6fd3b
RD
5378 The window, or (grand)parent of the window which has just received the
5379 focus.
5ba5649b 5380 """
d55e5bfc
RD
5381 return _core_.ChildFocusEvent_GetWindow(*args, **kwargs)
5382
226118fc 5383 Window = property(GetWindow,doc="See `GetWindow`")
2131d850 5384_core_.ChildFocusEvent_swigregister(ChildFocusEvent)
d55e5bfc
RD
5385
5386#---------------------------------------------------------------------------
5387
5388class ActivateEvent(Event):
5ba5649b
RD
5389 """
5390 An activate event is sent when a top-level window or the entire
5391 application is being activated or deactivated.
5392
5393 A top-level window (a dialog or frame) receives an activate event when
5394 is being activated or deactivated. This is indicated visually by the
5395 title bar changing colour, and a subwindow gaining the keyboard focus.
5396 An application is activated or deactivated when one of its frames
5397 becomes activated, or a frame becomes inactivate resulting in all
5398 application frames being inactive.
5399
5400 Please note that usually you should call event.Skip() in your handlers
5401 for these events so the default handlers will still be called, as not
5402 doing so can result in strange effects.
5403
5404 """
554f62e9
RD
5405 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5406 __repr__ = _swig_repr
5407 def __init__(self, *args, **kwargs):
5ba5649b 5408 """
f460c29d 5409 __init__(self, EventType type=wxEVT_NULL, bool active=True, int Id=0) -> ActivateEvent
5ba5649b
RD
5410
5411 Constructor
5412 """
554f62e9 5413 _core_.ActivateEvent_swiginit(self,_core_.new_ActivateEvent(*args, **kwargs))
d55e5bfc 5414 def GetActive(*args, **kwargs):
5ba5649b
RD
5415 """
5416 GetActive(self) -> bool
5417
5418 Returns true if the application or window is being activated, false
5419 otherwise.
5420 """
d55e5bfc
RD
5421 return _core_.ActivateEvent_GetActive(*args, **kwargs)
5422
226118fc 5423 Active = property(GetActive,doc="See `GetActive`")
2131d850 5424_core_.ActivateEvent_swigregister(ActivateEvent)
d55e5bfc
RD
5425
5426#---------------------------------------------------------------------------
5427
5428class InitDialogEvent(Event):
5ba5649b
RD
5429 """
5430 A wx.InitDialogEvent is sent as a dialog is being initialised, or for
5431 any window when `wx.Window.InitDialog` is called. Handlers for this
5432 event can transfer data to the window, or anything else that should be
5433 done before the user begins editing the form. The default handler
5434 calls `wx.Window.TransferDataToWindow`.
5435 """
554f62e9
RD
5436 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5437 __repr__ = _swig_repr
5438 def __init__(self, *args, **kwargs):
5ba5649b
RD
5439 """
5440 __init__(self, int Id=0) -> InitDialogEvent
5441
5442 Constructor
5443 """
554f62e9 5444 _core_.InitDialogEvent_swiginit(self,_core_.new_InitDialogEvent(*args, **kwargs))
2131d850 5445_core_.InitDialogEvent_swigregister(InitDialogEvent)
d55e5bfc
RD
5446
5447#---------------------------------------------------------------------------
5448
5449class MenuEvent(Event):
5ba5649b
RD
5450 """
5451 This class is used for a variety of menu-related events. Note that
5452 these do not include menu command events, which are handled by sending
5453 `wx.CommandEvent` objects.
5454
5455 The default handler for wx.EVT_MENU_HIGHLIGHT displays menu item help
5456 text in the first field of the status bar.
5457 """
554f62e9
RD
5458 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5459 __repr__ = _swig_repr
5460 def __init__(self, *args, **kwargs):
5ba5649b 5461 """
f460c29d 5462 __init__(self, EventType type=wxEVT_NULL, int winid=0, Menu menu=None) -> MenuEvent
5ba5649b
RD
5463
5464 Constructor
5465 """
554f62e9 5466 _core_.MenuEvent_swiginit(self,_core_.new_MenuEvent(*args, **kwargs))
d55e5bfc 5467 def GetMenuId(*args, **kwargs):
5ba5649b
RD
5468 """
5469 GetMenuId(self) -> int
5470
5471 Returns the menu identifier associated with the event. This method
5472 should be only used with the HIGHLIGHT events.
5473 """
d55e5bfc
RD
5474 return _core_.MenuEvent_GetMenuId(*args, **kwargs)
5475
5476 def IsPopup(*args, **kwargs):
5ba5649b
RD
5477 """
5478 IsPopup(self) -> bool
5479
5480 Returns ``True`` if the menu which is being opened or closed is a
5481 popup menu, ``False`` if it is a normal one. This method should only
5482 be used with the OPEN and CLOSE events.
5483 """
d55e5bfc
RD
5484 return _core_.MenuEvent_IsPopup(*args, **kwargs)
5485
5486 def GetMenu(*args, **kwargs):
5ba5649b
RD
5487 """
5488 GetMenu(self) -> Menu
5489
5490 Returns the menu which is being opened or closed. This method should
5491 only be used with the OPEN and CLOSE events.
5492 """
d55e5bfc
RD
5493 return _core_.MenuEvent_GetMenu(*args, **kwargs)
5494
57332a5a
RD
5495 Menu = property(GetMenu,doc="See `GetMenu`")
5496 MenuId = property(GetMenuId,doc="See `GetMenuId`")
2131d850 5497_core_.MenuEvent_swigregister(MenuEvent)
d55e5bfc
RD
5498
5499#---------------------------------------------------------------------------
5500
5501class CloseEvent(Event):
5ba5649b
RD
5502 """
5503 This event class contains information about window and session close
5504 events.
5505
5506 The handler function for EVT_CLOSE is called when the user has tried
5507 to close a a frame or dialog box using the window manager controls or
5508 the system menu. It can also be invoked by the application itself
5509 programmatically, for example by calling the `wx.Window.Close`
5510 function.
5511
5512 You should check whether the application is forcing the deletion of
5513 the window using `CanVeto`. If it returns ``False``, you must destroy
5514 the window using `wx.Window.Destroy`. If the return value is ``True``,
5515 it is up to you whether you respond by destroying the window or not.
5516 For example you may wish to display a message dialog prompting to save
5517 files or to cancel the close.
5518
5519 If you don't destroy the window, you should call `Veto` to let the
5520 calling code know that you did not destroy the window. This allows the
5521 `wx.Window.Close` function to return ``True`` or ``False`` depending
5522 on whether the close instruction was honored or not.
5523 """
554f62e9
RD
5524 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5525 __repr__ = _swig_repr
5526 def __init__(self, *args, **kwargs):
5ba5649b 5527 """
f460c29d 5528 __init__(self, EventType type=wxEVT_NULL, int winid=0) -> CloseEvent
5ba5649b
RD
5529
5530 Constructor.
5531 """
554f62e9 5532 _core_.CloseEvent_swiginit(self,_core_.new_CloseEvent(*args, **kwargs))
d55e5bfc 5533 def SetLoggingOff(*args, **kwargs):
5ba5649b
RD
5534 """
5535 SetLoggingOff(self, bool logOff)
5536
5537 Sets the 'logging off' flag.
5538 """
d55e5bfc
RD
5539 return _core_.CloseEvent_SetLoggingOff(*args, **kwargs)
5540
5541 def GetLoggingOff(*args, **kwargs):
5ba5649b
RD
5542 """
5543 GetLoggingOff(self) -> bool
5544
034e3677
RD
5545 Returns ``True`` if the user is logging off or ``False`` if the
5546 system is shutting down. This method can only be called for end
5547 session and query end session events, it doesn't make sense for close
5548 window event.
5ba5649b 5549 """
d55e5bfc
RD
5550 return _core_.CloseEvent_GetLoggingOff(*args, **kwargs)
5551
5552 def Veto(*args, **kwargs):
5ba5649b
RD
5553 """
5554 Veto(self, bool veto=True)
5555
5556 Call this from your event handler to veto a system shutdown or to
5557 signal to the calling application that a window close did not happen.
5558
5559 You can only veto a shutdown or close if `CanVeto` returns true.
5560 """
d55e5bfc
RD
5561 return _core_.CloseEvent_Veto(*args, **kwargs)
5562
5ba5649b
RD
5563 def GetVeto(*args, **kwargs):
5564 """GetVeto(self) -> bool"""
5565 return _core_.CloseEvent_GetVeto(*args, **kwargs)
5566
d55e5bfc 5567 def SetCanVeto(*args, **kwargs):
5ba5649b
RD
5568 """
5569 SetCanVeto(self, bool canVeto)
5570
5571 Sets the 'can veto' flag.
5572 """
d55e5bfc
RD
5573 return _core_.CloseEvent_SetCanVeto(*args, **kwargs)
5574
5575 def CanVeto(*args, **kwargs):
5ba5649b
RD
5576 """
5577 CanVeto(self) -> bool
d55e5bfc 5578
5ba5649b
RD
5579 Returns true if you can veto a system shutdown or a window close
5580 event. Vetoing a window close event is not possible if the calling
5581 code wishes to force the application to exit, and so this function
5582 must be called to check this.
5583 """
5584 return _core_.CloseEvent_CanVeto(*args, **kwargs)
d55e5bfc 5585
226118fc 5586 LoggingOff = property(GetLoggingOff,SetLoggingOff,doc="See `GetLoggingOff` and `SetLoggingOff`")
2131d850 5587_core_.CloseEvent_swigregister(CloseEvent)
d55e5bfc
RD
5588
5589#---------------------------------------------------------------------------
5590
5591class ShowEvent(Event):
5ba5649b 5592 """An EVT_SHOW event is sent when a window is shown or hidden."""
554f62e9
RD
5593 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5594 __repr__ = _swig_repr
5595 def __init__(self, *args, **kwargs):
5ba5649b
RD
5596 """
5597 __init__(self, int winid=0, bool show=False) -> ShowEvent
5598
5599 An EVT_SHOW event is sent when a window is shown or hidden.
5600 """
554f62e9 5601 _core_.ShowEvent_swiginit(self,_core_.new_ShowEvent(*args, **kwargs))
d55e5bfc
RD
5602 def SetShow(*args, **kwargs):
5603 """SetShow(self, bool show)"""
5604 return _core_.ShowEvent_SetShow(*args, **kwargs)
5605
5606 def GetShow(*args, **kwargs):
5607 """GetShow(self) -> bool"""
5608 return _core_.ShowEvent_GetShow(*args, **kwargs)
5609
33d6fd3b 5610 Show = property(GetShow,SetShow,doc="See `GetShow` and `SetShow`")
2131d850 5611_core_.ShowEvent_swigregister(ShowEvent)
d55e5bfc
RD
5612
5613#---------------------------------------------------------------------------
5614
5615class IconizeEvent(Event):
5ba5649b
RD
5616 """
5617 An EVT_ICONIZE event is sent when a frame is iconized (minimized) or
5618 restored.
5619 """
554f62e9
RD
5620 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5621 __repr__ = _swig_repr
5622 def __init__(self, *args, **kwargs):
5ba5649b
RD
5623 """
5624 __init__(self, int id=0, bool iconized=True) -> IconizeEvent
5625
5626 An EVT_ICONIZE event is sent when a frame is iconized (minimized) or
5627 restored.
5628 """
554f62e9 5629 _core_.IconizeEvent_swiginit(self,_core_.new_IconizeEvent(*args, **kwargs))
d55e5bfc 5630 def Iconized(*args, **kwargs):
5ba5649b
RD
5631 """
5632 Iconized(self) -> bool
5633
5634 Returns ``True`` if the frame has been iconized, ``False`` if it has
5635 been restored.
5636 """
d55e5bfc
RD
5637 return _core_.IconizeEvent_Iconized(*args, **kwargs)
5638
2131d850 5639_core_.IconizeEvent_swigregister(IconizeEvent)
d55e5bfc
RD
5640
5641#---------------------------------------------------------------------------
5642
5643class MaximizeEvent(Event):
5ba5649b 5644 """An EVT_MAXIMIZE event is sent when a frame is maximized or restored."""
554f62e9
RD
5645 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5646 __repr__ = _swig_repr
5647 def __init__(self, *args, **kwargs):
5ba5649b
RD
5648 """
5649 __init__(self, int id=0) -> MaximizeEvent
5650
5651 An EVT_MAXIMIZE event is sent when a frame is maximized or restored.
5652 """
554f62e9 5653 _core_.MaximizeEvent_swiginit(self,_core_.new_MaximizeEvent(*args, **kwargs))
2131d850 5654_core_.MaximizeEvent_swigregister(MaximizeEvent)
d55e5bfc
RD
5655
5656#---------------------------------------------------------------------------
5657
5658class DropFilesEvent(Event):
5ba5649b
RD
5659 """
5660 This class is used for drop files events, that is, when files have
5661 been dropped onto the window. This functionality is only available
5662 under Windows. The window must have previously been enabled for
5663 dropping by calling `wx.Window.DragAcceptFiles`.
5664
5665 Important note: this is a separate implementation to the more general
5666 drag and drop implementation using `wx.FileDropTarget`, and etc. This
5667 implementation uses the older, Windows message-based approach of
5668 dropping files.
5669
5670 Use wx.EVT_DROP_FILES to bind an event handler to receive file drop
5671 events.
5672
5673 """
554f62e9
RD
5674 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5675 def __init__(self): raise AttributeError, "No constructor defined"
5676 __repr__ = _swig_repr
d55e5bfc 5677 def GetPosition(*args, **kwargs):
5ba5649b
RD
5678 """
5679 GetPosition(self) -> Point
5680
5681 Returns the position at which the files were dropped.
5682 """
d55e5bfc
RD
5683 return _core_.DropFilesEvent_GetPosition(*args, **kwargs)
5684
5685 def GetNumberOfFiles(*args, **kwargs):
5ba5649b
RD
5686 """
5687 GetNumberOfFiles(self) -> int
5688
5689 Returns the number of files dropped.
5690 """
d55e5bfc
RD
5691 return _core_.DropFilesEvent_GetNumberOfFiles(*args, **kwargs)
5692
5693 def GetFiles(*args, **kwargs):
5ba5649b
RD
5694 """
5695 GetFiles(self) -> PyObject
5696
5697 Returns a list of the filenames that were dropped.
5698 """
d55e5bfc
RD
5699 return _core_.DropFilesEvent_GetFiles(*args, **kwargs)
5700
226118fc
RD
5701 Files = property(GetFiles,doc="See `GetFiles`")
5702 NumberOfFiles = property(GetNumberOfFiles,doc="See `GetNumberOfFiles`")
5703 Position = property(GetPosition,doc="See `GetPosition`")
2131d850 5704_core_.DropFilesEvent_swigregister(DropFilesEvent)
d55e5bfc
RD
5705
5706#---------------------------------------------------------------------------
5707
5708UPDATE_UI_PROCESS_ALL = _core_.UPDATE_UI_PROCESS_ALL
5709UPDATE_UI_PROCESS_SPECIFIED = _core_.UPDATE_UI_PROCESS_SPECIFIED
5710class UpdateUIEvent(CommandEvent):
5ba5649b
RD
5711 """
5712 This class is used for EVT_UPDATE_UI pseudo-events which are sent by
5713 wxWidgets to give an application the chance to update various user
5714 interface elements.
5715
5716 Without update UI events, an application has to work hard to
5717 check/uncheck, enable/disable, and set the text for elements such as
5718 menu items and toolbar buttons. The code for doing this has to be
5719 mixed up with the code that is invoked when an action is invoked for a
5720 menu item or button.
5721
5722 With update UI events, you define an event handler to look at the
5723 state of the application and change UI elements accordingly. wxWidgets
5724 will call your handler functions in idle time, so you don't have to
5725 worry where to call this code. In addition to being a clearer and more
5726 declarative method, it also means you don't have to worry whether
5727 you're updating a toolbar or menubar identifier. The same handler can
5728 update a menu item and toolbar button, if the ID values are the same.
5729
5730 Instead of directly manipulating the menu or button, you call
5731 functions in the event object, such as `Check`. wxWidgets will
5732 determine whether such a call has been made, and which UI element to
5733 update.
5734
5735 These events will work for popup menus as well as menubars. Just
5736 before a menu is popped up, `wx.Menu.UpdateUI` is called to process
5737 any UI events for the window that owns the menu.
5738
5739 If you find that the overhead of UI update processing is affecting
5740 your application, you can do one or both of the following:
5741
5742 1. Call `wx.UpdateUIEvent.SetMode` with a value of
5743 wx.UPDATE_UI_PROCESS_SPECIFIED, and set the extra style
5744 wx.WS_EX_PROCESS_UPDATE_EVENTS for every window that should
5745 receive update events. No other windows will receive update
5746 events.
5747
5748 2. Call `wx.UpdateUIEvent.SetUpdateInterval` with a millisecond
5749 value to set the delay between updates. You may need to call
5750 `wx.Window.UpdateWindowUI` at critical points, for example when
5751 a dialog is about to be shown, in case the user sees a slight
5752 delay before windows are updated.
5753
5754 Note that although events are sent in idle time, defining a EVT_IDLE
5755 handler for a window does not affect this because the events are sent
5756 from an internal idle handler.
5757
5758 wxWidgets tries to optimize update events on some platforms. On
5759 Windows and GTK+, events for menubar items are only sent when the menu
5760 is about to be shown, and not in idle time.
5761
5762 """
554f62e9
RD
5763 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5764 __repr__ = _swig_repr
5765 def __init__(self, *args, **kwargs):
5ba5649b
RD
5766 """
5767 __init__(self, int commandId=0) -> UpdateUIEvent
5768
5769 Constructor
5770 """
554f62e9 5771 _core_.UpdateUIEvent_swiginit(self,_core_.new_UpdateUIEvent(*args, **kwargs))
d55e5bfc 5772 def GetChecked(*args, **kwargs):
5ba5649b
RD
5773 """
5774 GetChecked(self) -> bool
5775
5776 Returns ``True`` if the UI element should be checked.
5777 """
d55e5bfc
RD
5778 return _core_.UpdateUIEvent_GetChecked(*args, **kwargs)
5779
5780 def GetEnabled(*args, **kwargs):
5ba5649b
RD
5781 """
5782 GetEnabled(self) -> bool
5783
5784 Returns ``True`` if the UI element should be enabled.
5785 """
d55e5bfc
RD
5786 return _core_.UpdateUIEvent_GetEnabled(*args, **kwargs)
5787
554f62e9
RD
5788 def GetShown(*args, **kwargs):
5789 """
5790 GetShown(self) -> bool
5791
5792 Returns ``True`` if the UI element should be shown.
5793 """
5794 return _core_.UpdateUIEvent_GetShown(*args, **kwargs)
5795
d55e5bfc 5796 def GetText(*args, **kwargs):
5ba5649b
RD
5797 """
5798 GetText(self) -> String
5799
5800 Returns the text that should be set for the UI element.
5801 """
d55e5bfc
RD
5802 return _core_.UpdateUIEvent_GetText(*args, **kwargs)
5803
5804 def GetSetText(*args, **kwargs):
5ba5649b
RD
5805 """
5806 GetSetText(self) -> bool
5807
5808 Returns ``True`` if the application has called `SetText`. For
5809 wxWidgets internal use only.
5810 """
d55e5bfc
RD
5811 return _core_.UpdateUIEvent_GetSetText(*args, **kwargs)
5812
5813 def GetSetChecked(*args, **kwargs):
5ba5649b
RD
5814 """
5815 GetSetChecked(self) -> bool
5816
5817 Returns ``True`` if the application has called `Check`. For wxWidgets
5818 internal use only.
5819 """
d55e5bfc
RD
5820 return _core_.UpdateUIEvent_GetSetChecked(*args, **kwargs)
5821
5822 def GetSetEnabled(*args, **kwargs):
5ba5649b
RD
5823 """
5824 GetSetEnabled(self) -> bool
5825
5826 Returns ``True`` if the application has called `Enable`. For wxWidgets
5827 internal use only.
5828 """
d55e5bfc
RD
5829 return _core_.UpdateUIEvent_GetSetEnabled(*args, **kwargs)
5830
554f62e9
RD
5831 def GetSetShown(*args, **kwargs):
5832 """
5833 GetSetShown(self) -> bool
5834
5835 Returns ``True`` if the application has called `Show`. For wxWidgets
5836 internal use only.
5837 """
5838 return _core_.UpdateUIEvent_GetSetShown(*args, **kwargs)
5839
d55e5bfc 5840 def Check(*args, **kwargs):
5ba5649b
RD
5841 """
5842 Check(self, bool check)
5843
5844 Check or uncheck the UI element.
5845 """
d55e5bfc
RD
5846 return _core_.UpdateUIEvent_Check(*args, **kwargs)
5847
5848 def Enable(*args, **kwargs):
5ba5649b
RD
5849 """
5850 Enable(self, bool enable)
5851
5852 Enable or disable the UI element.
5853 """
d55e5bfc
RD
5854 return _core_.UpdateUIEvent_Enable(*args, **kwargs)
5855
554f62e9
RD
5856 def Show(*args, **kwargs):
5857 """
5858 Show(self, bool show)
5859
5860 Show or hide the UI element.
5861 """
5862 return _core_.UpdateUIEvent_Show(*args, **kwargs)
5863
d55e5bfc 5864 def SetText(*args, **kwargs):
5ba5649b
RD
5865 """
5866 SetText(self, String text)
5867
5868 Sets the text for this UI element.
5869 """
d55e5bfc
RD
5870 return _core_.UpdateUIEvent_SetText(*args, **kwargs)
5871
5872 def SetUpdateInterval(*args, **kwargs):
5ba5649b
RD
5873 """
5874 SetUpdateInterval(long updateInterval)
5875
5876 Sets the interval between updates in milliseconds. Set to -1 to
5877 disable updates, or to 0 to update as frequently as possible. The
5878 default is 0.
5879
5880 Use this to reduce the overhead of UI update events if your
5881 application has a lot of windows. If you set the value to -1 or
5882 greater than 0, you may also need to call `wx.Window.UpdateWindowUI`
5883 at appropriate points in your application, such as when a dialog is
5884 about to be shown.
5885 """
d55e5bfc
RD
5886 return _core_.UpdateUIEvent_SetUpdateInterval(*args, **kwargs)
5887
5888 SetUpdateInterval = staticmethod(SetUpdateInterval)
5889 def GetUpdateInterval(*args, **kwargs):
5ba5649b
RD
5890 """
5891 GetUpdateInterval() -> long
5892
5893 Returns the current interval between updates in milliseconds. -1
5894 disables updates, 0 updates as frequently as possible.
5895 """
d55e5bfc
RD
5896 return _core_.UpdateUIEvent_GetUpdateInterval(*args, **kwargs)
5897
5898 GetUpdateInterval = staticmethod(GetUpdateInterval)
5899 def CanUpdate(*args, **kwargs):
5ba5649b
RD
5900 """
5901 CanUpdate(Window win) -> bool
5902
5903 Returns ``True`` if it is appropriate to update (send UI update events
5904 to) this window.
5905
5906 This function looks at the mode used (see `wx.UpdateUIEvent.SetMode`),
5907 the wx.WS_EX_PROCESS_UPDATE_EVENTS flag in window, the time update
5908 events were last sent in idle time, and the update interval, to
5909 determine whether events should be sent to this window now. By default
5910 this will always return true because the update mode is initially
5911 wx.UPDATE_UI_PROCESS_ALL and the interval is set to 0; so update
5912 events will be sent as often as possible. You can reduce the frequency
5913 that events are sent by changing the mode and/or setting an update
5914 interval.
5915
5916 """
d55e5bfc
RD
5917 return _core_.UpdateUIEvent_CanUpdate(*args, **kwargs)
5918
5919 CanUpdate = staticmethod(CanUpdate)
5920 def ResetUpdateTime(*args, **kwargs):
5ba5649b
RD
5921 """
5922 ResetUpdateTime()
5923
5924 Used internally to reset the last-updated time to the current time. It
5925 is assumed that update events are normally sent in idle time, so this
5926 is called at the end of idle processing.
5927 """
d55e5bfc
RD
5928 return _core_.UpdateUIEvent_ResetUpdateTime(*args, **kwargs)
5929
5930 ResetUpdateTime = staticmethod(ResetUpdateTime)
5931 def SetMode(*args, **kwargs):
5ba5649b
RD
5932 """
5933 SetMode(int mode)
5934
5935 Specify how wxWidgets will send update events: to all windows, or only
5936 to those which specify that they will process the events.
5937
5938 The mode may be one of the following values:
5939
5940 ============================= ==========================================
5941 wxUPDATE_UI_PROCESS_ALL Send UI update events to all windows. This
5942 is the default setting.
5943 wxUPDATE_UI_PROCESS_SPECIFIED Send UI update events only to windows that
5944 have the wx.WS_EX_PROCESS_UI_UPDATES extra
5945 style set.
5946 ============================= ==========================================
5947
5948 """
d55e5bfc
RD
5949 return _core_.UpdateUIEvent_SetMode(*args, **kwargs)
5950
5951 SetMode = staticmethod(SetMode)
5952 def GetMode(*args, **kwargs):
5ba5649b
RD
5953 """
5954 GetMode() -> int
5955
5956 Returns a value specifying how wxWidgets will send update events: to
5957 all windows, or only to those which specify that they will process the
5958 events.
5959 """
d55e5bfc
RD
5960 return _core_.UpdateUIEvent_GetMode(*args, **kwargs)
5961
5962 GetMode = staticmethod(GetMode)
dba7934c
RD
5963 Checked = property(GetChecked,Check,doc="See `GetChecked`")
5964 Enabled = property(GetEnabled,Enable,doc="See `GetEnabled`")
5965 Shown = property(GetShown,Show,doc="See `GetShown`")
5966 Text = property(GetText,SetText,doc="See `GetText` and `SetText`")
2131d850 5967_core_.UpdateUIEvent_swigregister(UpdateUIEvent)
d55e5bfc
RD
5968
5969def UpdateUIEvent_SetUpdateInterval(*args, **kwargs):
554f62e9 5970 """
5ba5649b
RD
5971 UpdateUIEvent_SetUpdateInterval(long updateInterval)
5972
5973 Sets the interval between updates in milliseconds. Set to -1 to
5974 disable updates, or to 0 to update as frequently as possible. The
5975 default is 0.
5976
5977 Use this to reduce the overhead of UI update events if your
5978 application has a lot of windows. If you set the value to -1 or
5979 greater than 0, you may also need to call `wx.Window.UpdateWindowUI`
5980 at appropriate points in your application, such as when a dialog is
5981 about to be shown.
5982 """
554f62e9 5983 return _core_.UpdateUIEvent_SetUpdateInterval(*args, **kwargs)
d55e5bfc 5984
554f62e9
RD
5985def UpdateUIEvent_GetUpdateInterval(*args):
5986 """
5ba5649b
RD
5987 UpdateUIEvent_GetUpdateInterval() -> long
5988
5989 Returns the current interval between updates in milliseconds. -1
5990 disables updates, 0 updates as frequently as possible.
5991 """
554f62e9 5992 return _core_.UpdateUIEvent_GetUpdateInterval(*args)
d55e5bfc
RD
5993
5994def UpdateUIEvent_CanUpdate(*args, **kwargs):
554f62e9 5995 """
5ba5649b
RD
5996 UpdateUIEvent_CanUpdate(Window win) -> bool
5997
5998 Returns ``True`` if it is appropriate to update (send UI update events
5999 to) this window.
6000
6001 This function looks at the mode used (see `wx.UpdateUIEvent.SetMode`),
6002 the wx.WS_EX_PROCESS_UPDATE_EVENTS flag in window, the time update
6003 events were last sent in idle time, and the update interval, to
6004 determine whether events should be sent to this window now. By default
6005 this will always return true because the update mode is initially
6006 wx.UPDATE_UI_PROCESS_ALL and the interval is set to 0; so update
6007 events will be sent as often as possible. You can reduce the frequency
6008 that events are sent by changing the mode and/or setting an update
6009 interval.
6010
6011 """
554f62e9 6012 return _core_.UpdateUIEvent_CanUpdate(*args, **kwargs)
d55e5bfc 6013
554f62e9
RD
6014def UpdateUIEvent_ResetUpdateTime(*args):
6015 """
5ba5649b
RD
6016 UpdateUIEvent_ResetUpdateTime()
6017
6018 Used internally to reset the last-updated time to the current time. It
6019 is assumed that update events are normally sent in idle time, so this
6020 is called at the end of idle processing.
6021 """
554f62e9 6022 return _core_.UpdateUIEvent_ResetUpdateTime(*args)
d55e5bfc
RD
6023
6024def UpdateUIEvent_SetMode(*args, **kwargs):
554f62e9 6025 """
5ba5649b
RD
6026 UpdateUIEvent_SetMode(int mode)
6027
6028 Specify how wxWidgets will send update events: to all windows, or only
6029 to those which specify that they will process the events.
6030
6031 The mode may be one of the following values:
6032
6033 ============================= ==========================================
6034 wxUPDATE_UI_PROCESS_ALL Send UI update events to all windows. This
6035 is the default setting.
6036 wxUPDATE_UI_PROCESS_SPECIFIED Send UI update events only to windows that
6037 have the wx.WS_EX_PROCESS_UI_UPDATES extra
6038 style set.
6039 ============================= ==========================================
6040
6041 """
554f62e9 6042 return _core_.UpdateUIEvent_SetMode(*args, **kwargs)
d55e5bfc 6043
554f62e9
RD
6044def UpdateUIEvent_GetMode(*args):
6045 """
5ba5649b
RD
6046 UpdateUIEvent_GetMode() -> int
6047
6048 Returns a value specifying how wxWidgets will send update events: to
6049 all windows, or only to those which specify that they will process the
6050 events.
6051 """
554f62e9 6052 return _core_.UpdateUIEvent_GetMode(*args)
d55e5bfc
RD
6053
6054#---------------------------------------------------------------------------
6055
6056class SysColourChangedEvent(Event):
5ba5649b
RD
6057 """
6058 This class is used for EVT_SYS_COLOUR_CHANGED, which are generated
6059 when the user changes the colour settings using the control
6060 panel. This is only applicable under Windows.
6061
6062 The default event handler for this event propagates the event to child
6063 windows, since Windows only sends the events to top-level windows. If
6064 intercepting this event for a top-level window, remember to call
6065 `Skip` so the the base class handler will still be executed, or to
6066 pass the event on to the window's children explicitly.
6067
6068 """
554f62e9
RD
6069 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6070 __repr__ = _swig_repr
6071 def __init__(self, *args, **kwargs):
5ba5649b
RD
6072 """
6073 __init__(self) -> SysColourChangedEvent
6074
6075 Constructor
6076 """
554f62e9 6077 _core_.SysColourChangedEvent_swiginit(self,_core_.new_SysColourChangedEvent(*args, **kwargs))
2131d850 6078_core_.SysColourChangedEvent_swigregister(SysColourChangedEvent)
d55e5bfc
RD
6079
6080#---------------------------------------------------------------------------
6081
6082class MouseCaptureChangedEvent(Event):
5ba5649b
RD
6083 """
6084 An mouse capture changed event (EVT_MOUSE_CAPTURE_CHANGED) is sent to
6085 a window that loses its mouse capture. This is called even if
6086 `wx.Window.ReleaseMouse` was called by the application code. Handling
6087 this event allows an application to cater for unexpected capture
6088 releases which might otherwise confuse mouse handling code.
6089
6090 This event is implemented under Windows only.
6091 """
554f62e9
RD
6092 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6093 __repr__ = _swig_repr
6094 def __init__(self, *args, **kwargs):
5ba5649b
RD
6095 """
6096 __init__(self, int winid=0, Window gainedCapture=None) -> MouseCaptureChangedEvent
6097
6098 Constructor
6099 """
554f62e9 6100 _core_.MouseCaptureChangedEvent_swiginit(self,_core_.new_MouseCaptureChangedEvent(*args, **kwargs))
d55e5bfc 6101 def GetCapturedWindow(*args, **kwargs):
5ba5649b
RD
6102 """
6103 GetCapturedWindow(self) -> Window
6104
6105 Returns the window that gained the capture, or ``None`` if it was a
6106 non-wxWidgets window.
6107 """
d55e5bfc
RD
6108 return _core_.MouseCaptureChangedEvent_GetCapturedWindow(*args, **kwargs)
6109
57332a5a 6110 CapturedWindow = property(GetCapturedWindow,doc="See `GetCapturedWindow`")
2131d850 6111_core_.MouseCaptureChangedEvent_swigregister(MouseCaptureChangedEvent)
d55e5bfc
RD
6112
6113#---------------------------------------------------------------------------
6114
0f83f5da
RD
6115class MouseCaptureLostEvent(Event):
6116 """
6117 A mouse capture lost event is sent to a window that obtained mouse
6118 capture, which was subsequently loss due to "external" event, for
6119 example when a dialog box is shown or if another application captures
6120 the mouse.
6121
6122 If this happens, this event is sent to all windows that are on the
6123 capture stack (i.e. a window that called `wx.Window.CaptureMouse`, but
6124 didn't call `wx.Window.ReleaseMouse` yet). The event is *not* sent
6125 if the capture changes because of a call to CaptureMouse or
6126 ReleaseMouse.
6127
6128 This event is currently emitted under Windows only.
6129
6130 """
6131 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6132 __repr__ = _swig_repr
6133 def __init__(self, *args, **kwargs):
6134 """
6135 __init__(self, int winid=0) -> MouseCaptureLostEvent
6136
6137 A mouse capture lost event is sent to a window that obtained mouse
6138 capture, which was subsequently loss due to "external" event, for
6139 example when a dialog box is shown or if another application captures
6140 the mouse.
6141
6142 If this happens, this event is sent to all windows that are on the
6143 capture stack (i.e. a window that called `wx.Window.CaptureMouse`, but
6144 didn't call `wx.Window.ReleaseMouse` yet). The event is *not* sent
6145 if the capture changes because of a call to CaptureMouse or
6146 ReleaseMouse.
6147
6148 This event is currently emitted under Windows only.
6149
6150 """
6151 _core_.MouseCaptureLostEvent_swiginit(self,_core_.new_MouseCaptureLostEvent(*args, **kwargs))
6152_core_.MouseCaptureLostEvent_swigregister(MouseCaptureLostEvent)
6153
6154#---------------------------------------------------------------------------
6155
d55e5bfc 6156class DisplayChangedEvent(Event):
5ba5649b
RD
6157 """
6158 An EVT_DISPLAY_CHANGED event is sent to all windows when the display
6159 resolution has changed.
6160
6161 This event is implemented under Windows only.
6162 """
554f62e9
RD
6163 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6164 __repr__ = _swig_repr
6165 def __init__(self, *args, **kwargs):
d55e5bfc 6166 """__init__(self) -> DisplayChangedEvent"""
554f62e9 6167 _core_.DisplayChangedEvent_swiginit(self,_core_.new_DisplayChangedEvent(*args, **kwargs))
2131d850 6168_core_.DisplayChangedEvent_swigregister(DisplayChangedEvent)
d55e5bfc
RD
6169
6170#---------------------------------------------------------------------------
6171
6172class PaletteChangedEvent(Event):
5ba5649b
RD
6173 """
6174 An EVT_PALETTE_CHANGED event is sent when the system palette has
6175 changed, thereby giving each window a chance to redo their own to
6176 match.
6177
6178 This event is implemented under Windows only.
6179 """
554f62e9
RD
6180 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6181 __repr__ = _swig_repr
6182 def __init__(self, *args, **kwargs):
5ba5649b
RD
6183 """
6184 __init__(self, int id=0) -> PaletteChangedEvent
6185
6186 An EVT_PALETTE_CHANGED event is sent when the system palette has
6187 changed, thereby giving each window a chance to redo their own to
6188 match.
6189
6190 This event is implemented under Windows only.
6191 """
554f62e9 6192 _core_.PaletteChangedEvent_swiginit(self,_core_.new_PaletteChangedEvent(*args, **kwargs))
d55e5bfc
RD
6193 def SetChangedWindow(*args, **kwargs):
6194 """SetChangedWindow(self, Window win)"""
6195 return _core_.PaletteChangedEvent_SetChangedWindow(*args, **kwargs)
6196
6197 def GetChangedWindow(*args, **kwargs):
6198 """GetChangedWindow(self) -> Window"""
6199 return _core_.PaletteChangedEvent_GetChangedWindow(*args, **kwargs)
6200
33d6fd3b 6201 ChangedWindow = property(GetChangedWindow,SetChangedWindow,doc="See `GetChangedWindow` and `SetChangedWindow`")
2131d850 6202_core_.PaletteChangedEvent_swigregister(PaletteChangedEvent)
d55e5bfc
RD
6203
6204#---------------------------------------------------------------------------
6205
6206class QueryNewPaletteEvent(Event):
5ba5649b
RD
6207 """
6208 An EVT_QUERY_NEW_PALETE event indicates the window is getting keyboard
6209 focus and should re-do its palette.
6210
6211 This event is implemented under Windows only.
6212 """
554f62e9
RD
6213 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6214 __repr__ = _swig_repr
6215 def __init__(self, *args, **kwargs):
5ba5649b
RD
6216 """
6217 __init__(self, int winid=0) -> QueryNewPaletteEvent
6218
6219 Constructor.
6220 """
554f62e9 6221 _core_.QueryNewPaletteEvent_swiginit(self,_core_.new_QueryNewPaletteEvent(*args, **kwargs))
d55e5bfc 6222 def SetPaletteRealized(*args, **kwargs):
5ba5649b
RD
6223 """
6224 SetPaletteRealized(self, bool realized)
6225
6226 App should set this if it changes the palette.
6227 """
d55e5bfc
RD
6228 return _core_.QueryNewPaletteEvent_SetPaletteRealized(*args, **kwargs)
6229
6230 def GetPaletteRealized(*args, **kwargs):
6231 """GetPaletteRealized(self) -> bool"""
6232 return _core_.QueryNewPaletteEvent_GetPaletteRealized(*args, **kwargs)
6233
33d6fd3b 6234 PaletteRealized = property(GetPaletteRealized,SetPaletteRealized,doc="See `GetPaletteRealized` and `SetPaletteRealized`")
2131d850 6235_core_.QueryNewPaletteEvent_swigregister(QueryNewPaletteEvent)
d55e5bfc
RD
6236
6237#---------------------------------------------------------------------------
6238
6239class NavigationKeyEvent(Event):
5ba5649b
RD
6240 """
6241 EVT_NAVIGATION_KEY events are used to control moving the focus between
6242 widgets, otherwise known as tab-traversal. You woudl normally not
6243 catch navigation events in applications as there are already
6244 appropriate handlers in `wx.Dialog` and `wx.Panel`, but you may find
6245 it useful to send navigation events in certain situations to change
6246 the focus in certain ways, although it's probably easier to just call
6247 `wx.Window.Navigate`.
6248 """
554f62e9
RD
6249 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6250 __repr__ = _swig_repr
6251 def __init__(self, *args, **kwargs):
d55e5bfc 6252 """__init__(self) -> NavigationKeyEvent"""
554f62e9 6253 _core_.NavigationKeyEvent_swiginit(self,_core_.new_NavigationKeyEvent(*args, **kwargs))
d55e5bfc 6254 def GetDirection(*args, **kwargs):
5ba5649b
RD
6255 """
6256 GetDirection(self) -> bool
6257
6258 Returns ``True`` if the direction is forward, ``False`` otherwise.
6259 """
d55e5bfc
RD
6260 return _core_.NavigationKeyEvent_GetDirection(*args, **kwargs)
6261
6262 def SetDirection(*args, **kwargs):
5ba5649b
RD
6263 """
6264 SetDirection(self, bool forward)
6265
6266 Specify the direction that the navigation should take. Usually the
6267 difference between using Tab and Shift-Tab.
6268 """
d55e5bfc
RD
6269 return _core_.NavigationKeyEvent_SetDirection(*args, **kwargs)
6270
6271 def IsWindowChange(*args, **kwargs):
5ba5649b
RD
6272 """
6273 IsWindowChange(self) -> bool
6274
6275 Returns ``True`` if window change is allowed.
6276 """
d55e5bfc
RD
6277 return _core_.NavigationKeyEvent_IsWindowChange(*args, **kwargs)
6278
6279 def SetWindowChange(*args, **kwargs):
5ba5649b
RD
6280 """
6281 SetWindowChange(self, bool ischange)
6282
6283 Specify if the navigation should be able to change parent windows.
6284 For example, changing notebook pages, etc. This is usually implemented
6285 by using Control-Tab.
6286 """
d55e5bfc
RD
6287 return _core_.NavigationKeyEvent_SetWindowChange(*args, **kwargs)
6288
68350608 6289 def IsFromTab(*args, **kwargs):
5ba5649b
RD
6290 """
6291 IsFromTab(self) -> bool
6292
6293 Returns ``True`` if the navigation event is originated from the Tab
6294 key.
6295 """
68350608
RD
6296 return _core_.NavigationKeyEvent_IsFromTab(*args, **kwargs)
6297
6298 def SetFromTab(*args, **kwargs):
5ba5649b
RD
6299 """
6300 SetFromTab(self, bool bIs)
6301
6302 Set to true under MSW if the event was generated using the tab key.
6303 This is required for proper navogation over radio buttons.
6304 """
68350608
RD
6305 return _core_.NavigationKeyEvent_SetFromTab(*args, **kwargs)
6306
908b74cd 6307 def SetFlags(*args, **kwargs):
5ba5649b
RD
6308 """
6309 SetFlags(self, long flags)
6310
6311 Set the navigation flags to a combination of the following:
6312
6313 * wx.NavigationKeyEvent.IsBackward
6314 * wx.NavigationKeyEvent.IsForward
6315 * wx.NavigationKeyEvent.WinChange
6316 * wx.NavigationKeyEvent.FromTab
6317
6318 """
908b74cd
RD
6319 return _core_.NavigationKeyEvent_SetFlags(*args, **kwargs)
6320
d55e5bfc 6321 def GetCurrentFocus(*args, **kwargs):
5ba5649b
RD
6322 """
6323 GetCurrentFocus(self) -> Window
6324
6325 Returns the child window which currenty has the focus. May be
6326 ``None``.
6327 """
d55e5bfc
RD
6328 return _core_.NavigationKeyEvent_GetCurrentFocus(*args, **kwargs)
6329
6330 def SetCurrentFocus(*args, **kwargs):
5ba5649b
RD
6331 """
6332 SetCurrentFocus(self, Window win)
6333
6334 Set the window that has the focus.
6335 """
d55e5bfc
RD
6336 return _core_.NavigationKeyEvent_SetCurrentFocus(*args, **kwargs)
6337
b0f7404b 6338 IsBackward = _core_.NavigationKeyEvent_IsBackward
908b74cd
RD
6339 IsForward = _core_.NavigationKeyEvent_IsForward
6340 WinChange = _core_.NavigationKeyEvent_WinChange
68350608 6341 FromTab = _core_.NavigationKeyEvent_FromTab
57332a5a
RD
6342 CurrentFocus = property(GetCurrentFocus,SetCurrentFocus,doc="See `GetCurrentFocus` and `SetCurrentFocus`")
6343 Direction = property(GetDirection,SetDirection,doc="See `GetDirection` and `SetDirection`")
2131d850 6344_core_.NavigationKeyEvent_swigregister(NavigationKeyEvent)
d55e5bfc
RD
6345
6346#---------------------------------------------------------------------------
6347
6348class WindowCreateEvent(CommandEvent):
5ba5649b
RD
6349 """
6350 The EVT_WINDOW_CREATE event is sent as soon as the window object (the
6351 underlying GUI object) exists.
6352 """
554f62e9
RD
6353 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6354 __repr__ = _swig_repr
6355 def __init__(self, *args, **kwargs):
5ba5649b
RD
6356 """
6357 __init__(self, Window win=None) -> WindowCreateEvent
6358
6359 The EVT_WINDOW_CREATE event is sent as soon as the window object (the
6360 underlying GUI object) exists.
6361 """
554f62e9 6362 _core_.WindowCreateEvent_swiginit(self,_core_.new_WindowCreateEvent(*args, **kwargs))
d55e5bfc 6363 def GetWindow(*args, **kwargs):
5ba5649b
RD
6364 """
6365 GetWindow(self) -> Window
6366
6367 Returns the window that this event refers to.
6368 """
d55e5bfc
RD
6369 return _core_.WindowCreateEvent_GetWindow(*args, **kwargs)
6370
dba7934c 6371 Window = property(GetWindow,doc="See `GetWindow`")
2131d850 6372_core_.WindowCreateEvent_swigregister(WindowCreateEvent)
d55e5bfc
RD
6373
6374class WindowDestroyEvent(CommandEvent):
5ba5649b 6375 """
9d7dfdff
RD
6376 The EVT_WINDOW_DESTROY event is sent from the `wx.Window` destructor
6377 when the GUI window is destroyed.
6378
6379 When a class derived from `wx.Window` is destroyed its destructor will
6380 have already run by the time this event is sent. Therefore this event
6381 will not usually be received at all by the window itself. Since it is
6382 received after the destructor has run, an object should not try to
6383 handle its own wx.WindowDestroyEvent, but it can be used to get
6384 notification of the destruction of another window.
5ba5649b 6385 """
554f62e9
RD
6386 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6387 __repr__ = _swig_repr
6388 def __init__(self, *args, **kwargs):
5ba5649b
RD
6389 """
6390 __init__(self, Window win=None) -> WindowDestroyEvent
6391
9d7dfdff
RD
6392 The EVT_WINDOW_DESTROY event is sent from the `wx.Window` destructor
6393 when the GUI window is destroyed.
6394
6395 When a class derived from `wx.Window` is destroyed its destructor will
6396 have already run by the time this event is sent. Therefore this event
6397 will not usually be received at all by the window itself. Since it is
6398 received after the destructor has run, an object should not try to
6399 handle its own wx.WindowDestroyEvent, but it can be used to get
6400 notification of the destruction of another window.
5ba5649b 6401 """
554f62e9 6402 _core_.WindowDestroyEvent_swiginit(self,_core_.new_WindowDestroyEvent(*args, **kwargs))
d55e5bfc 6403 def GetWindow(*args, **kwargs):
5ba5649b
RD
6404 """
6405 GetWindow(self) -> Window
6406
6407 Returns the window that this event refers to.
6408 """
d55e5bfc
RD
6409 return _core_.WindowDestroyEvent_GetWindow(*args, **kwargs)
6410
dba7934c 6411 Window = property(GetWindow,doc="See `GetWindow`")
2131d850 6412_core_.WindowDestroyEvent_swigregister(WindowDestroyEvent)
d55e5bfc
RD
6413
6414#---------------------------------------------------------------------------
6415
6416class ContextMenuEvent(CommandEvent):
5ba5649b
RD
6417 """
6418 This class is used for context menu events (EVT_CONTECT_MENU,) sent to
6419 give the application a chance to show a context (popup) menu.
6420 """
554f62e9
RD
6421 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6422 __repr__ = _swig_repr
6423 def __init__(self, *args, **kwargs):
5ba5649b 6424 """
f460c29d 6425 __init__(self, EventType type=wxEVT_NULL, int winid=0, Point pt=DefaultPosition) -> ContextMenuEvent
5ba5649b
RD
6426
6427 Constructor.
6428 """
554f62e9 6429 _core_.ContextMenuEvent_swiginit(self,_core_.new_ContextMenuEvent(*args, **kwargs))
d55e5bfc 6430 def GetPosition(*args, **kwargs):
5ba5649b
RD
6431 """
6432 GetPosition(self) -> Point
6433
6434 Returns the position (in screen coordinants) at which the menu should
6435 be shown.
6436 """
d55e5bfc
RD
6437 return _core_.ContextMenuEvent_GetPosition(*args, **kwargs)
6438
6439 def SetPosition(*args, **kwargs):
5ba5649b
RD
6440 """
6441 SetPosition(self, Point pos)
6442
6443 Sets the position at which the menu should be shown.
6444 """
d55e5bfc
RD
6445 return _core_.ContextMenuEvent_SetPosition(*args, **kwargs)
6446
226118fc 6447 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
2131d850 6448_core_.ContextMenuEvent_swigregister(ContextMenuEvent)
d55e5bfc
RD
6449
6450#---------------------------------------------------------------------------
6451
6452IDLE_PROCESS_ALL = _core_.IDLE_PROCESS_ALL
6453IDLE_PROCESS_SPECIFIED = _core_.IDLE_PROCESS_SPECIFIED
6454class IdleEvent(Event):
5ba5649b
RD
6455 """
6456 This class is used for EVT_IDLE events, which are generated and sent
6457 when the application *becomes* idle. In other words, the when the
6458 event queue becomes empty then idle events are sent to all windows (by
6459 default) and as long as none of them call `RequestMore` then there are
6460 no more idle events until after the system event queue has some normal
6461 events and then becomes empty again.
6462
6463 By default, idle events are sent to all windows. If this is causing a
6464 significant overhead in your application, you can call
6465 `wx.IdleEvent.SetMode` with the value wx.IDLE_PROCESS_SPECIFIED, and
6466 set the wx.WS_EX_PROCESS_IDLE extra window style for every window
6467 which should receive idle events. Then idle events will only be sent
6468 to those windows and not to any others.
6469 """
554f62e9
RD
6470 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6471 __repr__ = _swig_repr
6472 def __init__(self, *args, **kwargs):
5ba5649b
RD
6473 """
6474 __init__(self) -> IdleEvent
6475
6476 Constructor
6477 """
554f62e9 6478 _core_.IdleEvent_swiginit(self,_core_.new_IdleEvent(*args, **kwargs))
d55e5bfc 6479 def RequestMore(*args, **kwargs):
5ba5649b
RD
6480 """
6481 RequestMore(self, bool needMore=True)
6482
6483 Tells wxWidgets that more processing is required. This function can be
6484 called by an EVT_IDLE handler for a window to indicate that the
6485 application should forward the EVT_IDLE event once more to the
6486 application windows. If no window calls this function during its
6487 EVT_IDLE handler, then the application will remain in a passive event
6488 loop until a new event is posted to the application by the windowing
6489 system.
6490 """
d55e5bfc
RD
6491 return _core_.IdleEvent_RequestMore(*args, **kwargs)
6492
6493 def MoreRequested(*args, **kwargs):
5ba5649b
RD
6494 """
6495 MoreRequested(self) -> bool
6496
6497 Returns ``True`` if the OnIdle function processing this event
6498 requested more processing time.
6499 """
d55e5bfc
RD
6500 return _core_.IdleEvent_MoreRequested(*args, **kwargs)
6501
6502 def SetMode(*args, **kwargs):
5ba5649b
RD
6503 """
6504 SetMode(int mode)
6505
6506 Static method for specifying how wxWidgets will send idle events: to
6507 all windows, or only to those which specify that they will process the
6508 events.
6509
6510 The mode can be one of the following values:
6511
6512 ========================= ========================================
6513 wx.IDLE_PROCESS_ALL Send idle events to all windows
6514 wx.IDLE_PROCESS_SPECIFIED Send idle events only to windows that have
6515 the wx.WS_EX_PROCESS_IDLE extra style
6516 flag set.
6517 ========================= ========================================
6518
6519 """
d55e5bfc
RD
6520 return _core_.IdleEvent_SetMode(*args, **kwargs)
6521
6522 SetMode = staticmethod(SetMode)
6523 def GetMode(*args, **kwargs):
5ba5649b
RD
6524 """
6525 GetMode() -> int
6526
6527 Static method returning a value specifying how wxWidgets will send
6528 idle events: to all windows, or only to those which specify that they
6529 will process the events.
6530 """
d55e5bfc
RD
6531 return _core_.IdleEvent_GetMode(*args, **kwargs)
6532
6533 GetMode = staticmethod(GetMode)
6534 def CanSend(*args, **kwargs):
5ba5649b
RD
6535 """
6536 CanSend(Window win) -> bool
6537
6538 Returns ``True`` if it is appropriate to send idle events to this
6539 window.
6540
6541 This function looks at the mode used (see `wx.IdleEvent.SetMode`), and
6542 the wx.WS_EX_PROCESS_IDLE style in window to determine whether idle
6543 events should be sent to this window now. By default this will always
6544 return ``True`` because the update mode is initially
6545 wx.IDLE_PROCESS_ALL. You can change the mode to only send idle events
6546 to windows with the wx.WS_EX_PROCESS_IDLE extra window style set.
6547 """
d55e5bfc
RD
6548 return _core_.IdleEvent_CanSend(*args, **kwargs)
6549
6550 CanSend = staticmethod(CanSend)
2131d850 6551_core_.IdleEvent_swigregister(IdleEvent)
d55e5bfc
RD
6552
6553def IdleEvent_SetMode(*args, **kwargs):
554f62e9 6554 """
5ba5649b
RD
6555 IdleEvent_SetMode(int mode)
6556
6557 Static method for specifying how wxWidgets will send idle events: to
6558 all windows, or only to those which specify that they will process the
6559 events.
6560
6561 The mode can be one of the following values:
6562
6563 ========================= ========================================
6564 wx.IDLE_PROCESS_ALL Send idle events to all windows
6565 wx.IDLE_PROCESS_SPECIFIED Send idle events only to windows that have
6566 the wx.WS_EX_PROCESS_IDLE extra style
6567 flag set.
6568 ========================= ========================================
6569
6570 """
554f62e9 6571 return _core_.IdleEvent_SetMode(*args, **kwargs)
d55e5bfc 6572
554f62e9
RD
6573def IdleEvent_GetMode(*args):
6574 """
5ba5649b
RD
6575 IdleEvent_GetMode() -> int
6576
6577 Static method returning a value specifying how wxWidgets will send
6578 idle events: to all windows, or only to those which specify that they
6579 will process the events.
6580 """
554f62e9 6581 return _core_.IdleEvent_GetMode(*args)
d55e5bfc
RD
6582
6583def IdleEvent_CanSend(*args, **kwargs):
554f62e9 6584 """
5ba5649b
RD
6585 IdleEvent_CanSend(Window win) -> bool
6586
6587 Returns ``True`` if it is appropriate to send idle events to this
6588 window.
6589
6590 This function looks at the mode used (see `wx.IdleEvent.SetMode`), and
6591 the wx.WS_EX_PROCESS_IDLE style in window to determine whether idle
6592 events should be sent to this window now. By default this will always
6593 return ``True`` because the update mode is initially
6594 wx.IDLE_PROCESS_ALL. You can change the mode to only send idle events
6595 to windows with the wx.WS_EX_PROCESS_IDLE extra window style set.
6596 """
554f62e9 6597 return _core_.IdleEvent_CanSend(*args, **kwargs)
d55e5bfc
RD
6598
6599#---------------------------------------------------------------------------
6600
2131d850
RD
6601class ClipboardTextEvent(CommandEvent):
6602 """
6603 A Clipboard Text event is sent when a window intercepts a text
6604 copy/cut/paste message, i.e. the user has cut/copied/pasted data
6605 from/into a text control via ctrl-C/X/V, ctrl/shift-del/insert, a
6606 popup menu command, etc. NOTE : under windows these events are *NOT*
6607 generated automatically for a Rich Edit text control.
6608 """
6609 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6610 __repr__ = _swig_repr
6611 def __init__(self, *args, **kwargs):
6612 """
6613 __init__(self, EventType type=wxEVT_NULL, int winid=0) -> ClipboardTextEvent
6614
6615 A Clipboard Text event is sent when a window intercepts a text
6616 copy/cut/paste message, i.e. the user has cut/copied/pasted data
6617 from/into a text control via ctrl-C/X/V, ctrl/shift-del/insert, a
6618 popup menu command, etc. NOTE : under windows these events are *NOT*
6619 generated automatically for a Rich Edit text control.
6620 """
6621 _core_.ClipboardTextEvent_swiginit(self,_core_.new_ClipboardTextEvent(*args, **kwargs))
6622_core_.ClipboardTextEvent_swigregister(ClipboardTextEvent)
6623
6624#---------------------------------------------------------------------------
6625
d55e5bfc 6626class PyEvent(Event):
5ba5649b
RD
6627 """
6628 wx.PyEvent can be used as a base class for implementing custom event
6629 types in Python. You should derived from this class instead of
6630 `wx.Event` because this class is Python-aware and is able to transport
6631 its Python bits safely through the wxWidgets event system and have
6632 them still be there when the event handler is invoked.
6633
6634 :see: `wx.PyCommandEvent`
6635
6636 """
554f62e9
RD
6637 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6638 __repr__ = _swig_repr
6639 def __init__(self, *args, **kwargs):
f460c29d 6640 """__init__(self, int winid=0, EventType eventType=wxEVT_NULL) -> PyEvent"""
554f62e9 6641 _core_.PyEvent_swiginit(self,_core_.new_PyEvent(*args, **kwargs))
5ba5649b 6642 self._SetSelf(self)
d55e5bfc 6643
554f62e9
RD
6644 __swig_destroy__ = _core_.delete_PyEvent
6645 __del__ = lambda self : None;
5ba5649b
RD
6646 def _SetSelf(*args, **kwargs):
6647 """_SetSelf(self, PyObject self)"""
6648 return _core_.PyEvent__SetSelf(*args, **kwargs)
d55e5bfc 6649
5ba5649b
RD
6650 def _GetSelf(*args, **kwargs):
6651 """_GetSelf(self) -> PyObject"""
6652 return _core_.PyEvent__GetSelf(*args, **kwargs)
d55e5bfc 6653
2131d850 6654_core_.PyEvent_swigregister(PyEvent)
d55e5bfc
RD
6655
6656class PyCommandEvent(CommandEvent):
5ba5649b
RD
6657 """
6658 wx.PyCommandEvent can be used as a base class for implementing custom
6659 event types in Python, where the event shoudl travel up to parent
6660 windows looking for a handler. You should derived from this class
6661 instead of `wx.CommandEvent` because this class is Python-aware and is
6662 able to transport its Python bits safely through the wxWidgets event
6663 system and have them still be there when the event handler is invoked.
6664
6665 :see: `wx.PyEvent`
6666
6667 """
554f62e9
RD
6668 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6669 __repr__ = _swig_repr
6670 def __init__(self, *args, **kwargs):
f460c29d 6671 """__init__(self, EventType eventType=wxEVT_NULL, int id=0) -> PyCommandEvent"""
554f62e9 6672 _core_.PyCommandEvent_swiginit(self,_core_.new_PyCommandEvent(*args, **kwargs))
5ba5649b 6673 self._SetSelf(self)
d55e5bfc 6674
554f62e9
RD
6675 __swig_destroy__ = _core_.delete_PyCommandEvent
6676 __del__ = lambda self : None;
5ba5649b
RD
6677 def _SetSelf(*args, **kwargs):
6678 """_SetSelf(self, PyObject self)"""
6679 return _core_.PyCommandEvent__SetSelf(*args, **kwargs)
d55e5bfc 6680
5ba5649b
RD
6681 def _GetSelf(*args, **kwargs):
6682 """_GetSelf(self) -> PyObject"""
6683 return _core_.PyCommandEvent__GetSelf(*args, **kwargs)
d55e5bfc 6684
2131d850 6685_core_.PyCommandEvent_swigregister(PyCommandEvent)
d55e5bfc 6686
53aa7709 6687class DateEvent(CommandEvent):
5ba5649b
RD
6688 """
6689 This event class holds information about a date change event and is
6690 used together with `wx.DatePickerCtrl`. It also serves as a base class
6691 for `wx.calendar.CalendarEvent`. Bind these event types with
6692 EVT_DATE_CHANGED.
6693 """
554f62e9
RD
6694 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6695 __repr__ = _swig_repr
6696 def __init__(self, *args, **kwargs):
f460c29d 6697 """__init__(self, Window win, DateTime dt, EventType type) -> DateEvent"""
554f62e9 6698 _core_.DateEvent_swiginit(self,_core_.new_DateEvent(*args, **kwargs))
53aa7709 6699 def GetDate(*args, **kwargs):
5ba5649b
RD
6700 """
6701 GetDate(self) -> DateTime
6702
6703 Returns the date.
6704 """
53aa7709
RD
6705 return _core_.DateEvent_GetDate(*args, **kwargs)
6706
6707 def SetDate(*args, **kwargs):
5ba5649b
RD
6708 """
6709 SetDate(self, DateTime date)
6710
6711 Sets the date carried by the event, normally only used by the library
6712 internally.
6713 """
53aa7709
RD
6714 return _core_.DateEvent_SetDate(*args, **kwargs)
6715
226118fc 6716 Date = property(GetDate,SetDate,doc="See `GetDate` and `SetDate`")
2131d850 6717_core_.DateEvent_swigregister(DateEvent)
53aa7709
RD
6718
6719wxEVT_DATE_CHANGED = _core_.wxEVT_DATE_CHANGED
6720EVT_DATE_CHANGED = wx.PyEventBinder( wxEVT_DATE_CHANGED, 1 )
6721
d55e5bfc
RD
6722#---------------------------------------------------------------------------
6723
6724PYAPP_ASSERT_SUPPRESS = _core_.PYAPP_ASSERT_SUPPRESS
6725PYAPP_ASSERT_EXCEPTION = _core_.PYAPP_ASSERT_EXCEPTION
6726PYAPP_ASSERT_DIALOG = _core_.PYAPP_ASSERT_DIALOG
6727PYAPP_ASSERT_LOG = _core_.PYAPP_ASSERT_LOG
6728PRINT_WINDOWS = _core_.PRINT_WINDOWS
6729PRINT_POSTSCRIPT = _core_.PRINT_POSTSCRIPT
6730class PyApp(EvtHandler):
c24da6d6
RD
6731 """
6732 The ``wx.PyApp`` class is an *implementation detail*, please use the
6733 `wx.App` class (or some other derived class) instead.
6734 """
554f62e9
RD
6735 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6736 __repr__ = _swig_repr
6737 def __init__(self, *args, **kwargs):
d55e5bfc
RD
6738 """
6739 __init__(self) -> PyApp
6740
6741 Create a new application object, starting the bootstrap process.
6742 """
554f62e9 6743 _core_.PyApp_swiginit(self,_core_.new_PyApp(*args, **kwargs))
70b7a5fe
RD
6744 self._setCallbackInfo(self, PyApp, False)
6745 self._setOORInfo(self, False)
d55e5bfc 6746
554f62e9
RD
6747 __swig_destroy__ = _core_.delete_PyApp
6748 __del__ = lambda self : None;
d55e5bfc 6749 def _setCallbackInfo(*args, **kwargs):
70b7a5fe 6750 """_setCallbackInfo(self, PyObject self, PyObject _class, bool incref)"""
d55e5bfc
RD
6751 return _core_.PyApp__setCallbackInfo(*args, **kwargs)
6752
6753 def GetAppName(*args, **kwargs):
6754 """
6755 GetAppName(self) -> String
6756
6757 Get the application name.
6758 """
6759 return _core_.PyApp_GetAppName(*args, **kwargs)
6760
6761 def SetAppName(*args, **kwargs):
6762 """
6763 SetAppName(self, String name)
6764
c24da6d6
RD
6765 Set the application name. This value may be used automatically by
6766 `wx.Config` and such.
d55e5bfc
RD
6767 """
6768 return _core_.PyApp_SetAppName(*args, **kwargs)
6769
6770 def GetClassName(*args, **kwargs):
6771 """
6772 GetClassName(self) -> String
6773
6774 Get the application's class name.
6775 """
6776 return _core_.PyApp_GetClassName(*args, **kwargs)
6777
6778 def SetClassName(*args, **kwargs):
6779 """
6780 SetClassName(self, String name)
6781
c24da6d6
RD
6782 Set the application's class name. This value may be used for
6783 X-resources if applicable for the platform
d55e5bfc
RD
6784 """
6785 return _core_.PyApp_SetClassName(*args, **kwargs)
6786
6787 def GetVendorName(*args, **kwargs):
6788 """
6789 GetVendorName(self) -> String
6790
6791 Get the application's vendor name.
6792 """
6793 return _core_.PyApp_GetVendorName(*args, **kwargs)
6794
6795 def SetVendorName(*args, **kwargs):
6796 """
6797 SetVendorName(self, String name)
6798
c24da6d6
RD
6799 Set the application's vendor name. This value may be used
6800 automatically by `wx.Config` and such.
d55e5bfc
RD
6801 """
6802 return _core_.PyApp_SetVendorName(*args, **kwargs)
6803
6804 def GetTraits(*args, **kwargs):
6805 """
6806 GetTraits(self) -> wxAppTraits
6807
c24da6d6
RD
6808 Return (and create if necessary) the app traits object to which we
6809 delegate for everything which either should be configurable by the
6810 user (then he can change the default behaviour simply by overriding
6811 CreateTraits() and returning his own traits object) or which is
6812 GUI/console dependent as then wx.AppTraits allows us to abstract the
6813 differences behind the common facade.
6814
6815 :todo: Add support for overriding CreateAppTraits in wxPython.
d55e5bfc
RD
6816 """
6817 return _core_.PyApp_GetTraits(*args, **kwargs)
6818
6819 def ProcessPendingEvents(*args, **kwargs):
6820 """
6821 ProcessPendingEvents(self)
6822
c24da6d6
RD
6823 Process all events in the Pending Events list -- it is necessary to
6824 call this function to process posted events. This normally happens
6825 during each event loop iteration.
d55e5bfc
RD
6826 """
6827 return _core_.PyApp_ProcessPendingEvents(*args, **kwargs)
6828
6829 def Yield(*args, **kwargs):
6830 """
6831 Yield(self, bool onlyIfNeeded=False) -> bool
6832
c24da6d6
RD
6833 Process all currently pending events right now, instead of waiting
6834 until return to the event loop. It is an error to call ``Yield``
6835 recursively unless the value of ``onlyIfNeeded`` is True.
d55e5bfc 6836
c24da6d6 6837 :warning: This function is dangerous as it can lead to unexpected
79fccf9d
RD
6838 reentrancies (i.e. when called from an event handler it may
6839 result in calling the same event handler again), use with
6840 extreme care or, better, don't use at all!
d55e5bfc 6841
c24da6d6 6842 :see: `wx.Yield`, `wx.YieldIfNeeded`, `wx.SafeYield`
79fccf9d 6843
d55e5bfc
RD
6844 """
6845 return _core_.PyApp_Yield(*args, **kwargs)
6846
6847 def WakeUpIdle(*args, **kwargs):
6848 """
6849 WakeUpIdle(self)
6850
c24da6d6
RD
6851 Make sure that idle events are sent again.
6852 :see: `wx.WakeUpIdle`
d55e5bfc
RD
6853 """
6854 return _core_.PyApp_WakeUpIdle(*args, **kwargs)
6855
84f85550
RD
6856 def IsMainLoopRunning(*args, **kwargs):
6857 """
6858 IsMainLoopRunning() -> bool
6859
6860 Returns True if we're running the main loop, i.e. if the events can
6861 currently be dispatched.
6862 """
6863 return _core_.PyApp_IsMainLoopRunning(*args, **kwargs)
6864
6865 IsMainLoopRunning = staticmethod(IsMainLoopRunning)
d55e5bfc
RD
6866 def MainLoop(*args, **kwargs):
6867 """
6868 MainLoop(self) -> int
6869
c24da6d6
RD
6870 Execute the main GUI loop, the function doesn't normally return until
6871 all top level windows have been closed and destroyed.
d55e5bfc
RD
6872 """
6873 return _core_.PyApp_MainLoop(*args, **kwargs)
6874
6875 def Exit(*args, **kwargs):
6876 """
6877 Exit(self)
6878
6879 Exit the main loop thus terminating the application.
c24da6d6 6880 :see: `wx.Exit`
d55e5bfc
RD
6881 """
6882 return _core_.PyApp_Exit(*args, **kwargs)
6883
97ab0f6a
RD
6884 def GetLayoutDirection(*args, **kwargs):
6885 """
994453b8 6886 GetLayoutDirection(self) -> int
97ab0f6a
RD
6887
6888 Return the layout direction for the current locale.
6889 """
6890 return _core_.PyApp_GetLayoutDirection(*args, **kwargs)
6891
d55e5bfc
RD
6892 def ExitMainLoop(*args, **kwargs):
6893 """
6894 ExitMainLoop(self)
6895
c24da6d6
RD
6896 Exit the main GUI loop during the next iteration of the main
6897 loop, (i.e. it does not stop the program immediately!)
d55e5bfc
RD
6898 """
6899 return _core_.PyApp_ExitMainLoop(*args, **kwargs)
6900
6901 def Pending(*args, **kwargs):
6902 """
6903 Pending(self) -> bool
6904
6905 Returns True if there are unprocessed events in the event queue.
6906 """
6907 return _core_.PyApp_Pending(*args, **kwargs)
6908
6909 def Dispatch(*args, **kwargs):
6910 """
6911 Dispatch(self) -> bool
6912
6913 Process the first event in the event queue (blocks until an event
6914 appears if there are none currently)
6915 """
6916 return _core_.PyApp_Dispatch(*args, **kwargs)
6917
6918 def ProcessIdle(*args, **kwargs):
6919 """
6920 ProcessIdle(self) -> bool
6921
c24da6d6
RD
6922 Called from the MainLoop when the application becomes idle (there are
6923 no pending events) and sends a `wx.IdleEvent` to all interested
6924 parties. Returns True if more idle events are needed, False if not.
d55e5bfc
RD
6925 """
6926 return _core_.PyApp_ProcessIdle(*args, **kwargs)
6927
6928 def SendIdleEvents(*args, **kwargs):
6929 """
6930 SendIdleEvents(self, Window win, IdleEvent event) -> bool
6931
c24da6d6
RD
6932 Send idle event to window and all subwindows. Returns True if more
6933 idle time is requested.
d55e5bfc
RD
6934 """
6935 return _core_.PyApp_SendIdleEvents(*args, **kwargs)
6936
6937 def IsActive(*args, **kwargs):
6938 """
6939 IsActive(self) -> bool
6940
6941 Return True if our app has focus.
6942 """
6943 return _core_.PyApp_IsActive(*args, **kwargs)
6944
6945 def SetTopWindow(*args, **kwargs):
6946 """
6947 SetTopWindow(self, Window win)
6948
c24da6d6 6949 Set the *main* top level window
d55e5bfc
RD
6950 """
6951 return _core_.PyApp_SetTopWindow(*args, **kwargs)
6952
6953 def GetTopWindow(*args, **kwargs):
6954 """
6955 GetTopWindow(self) -> Window
6956
c24da6d6
RD
6957 Return the *main* top level window (if it hadn't been set previously
6958 with SetTopWindow(), will return just some top level window and, if
6959 there not any, will return None)
d55e5bfc
RD
6960 """
6961 return _core_.PyApp_GetTopWindow(*args, **kwargs)
6962
6963 def SetExitOnFrameDelete(*args, **kwargs):
6964 """
6965 SetExitOnFrameDelete(self, bool flag)
6966
c24da6d6
RD
6967 Control the exit behaviour: by default, the program will exit the main
6968 loop (and so, usually, terminate) when the last top-level program
6969 window is deleted. Beware that if you disable this behaviour (with
6970 SetExitOnFrameDelete(False)), you'll have to call ExitMainLoop()
6971 explicitly from somewhere.
d55e5bfc
RD
6972 """
6973 return _core_.PyApp_SetExitOnFrameDelete(*args, **kwargs)
6974
6975 def GetExitOnFrameDelete(*args, **kwargs):
6976 """
6977 GetExitOnFrameDelete(self) -> bool
6978
6979 Get the current exit behaviour setting.
6980 """
6981 return _core_.PyApp_GetExitOnFrameDelete(*args, **kwargs)
6982
6983 def SetUseBestVisual(*args, **kwargs):
6984 """
6985 SetUseBestVisual(self, bool flag)
6986
c24da6d6
RD
6987 Set whether the app should try to use the best available visual on
6988 systems where more than one is available, (Sun, SGI, XFree86 4, etc.)
d55e5bfc
RD
6989 """
6990 return _core_.PyApp_SetUseBestVisual(*args, **kwargs)
6991
6992 def GetUseBestVisual(*args, **kwargs):
6993 """
6994 GetUseBestVisual(self) -> bool
6995
6996 Get current UseBestVisual setting.
6997 """
6998 return _core_.PyApp_GetUseBestVisual(*args, **kwargs)
6999
7000 def SetPrintMode(*args, **kwargs):
7001 """SetPrintMode(self, int mode)"""
7002 return _core_.PyApp_SetPrintMode(*args, **kwargs)
7003
7004 def GetPrintMode(*args, **kwargs):
7005 """GetPrintMode(self) -> int"""
7006 return _core_.PyApp_GetPrintMode(*args, **kwargs)
7007
7008 def SetAssertMode(*args, **kwargs):
7009 """
7010 SetAssertMode(self, int mode)
7011
79fccf9d 7012 Set the OnAssert behaviour for debug and hybrid builds.
d55e5bfc
RD
7013 """
7014 return _core_.PyApp_SetAssertMode(*args, **kwargs)
7015
7016 def GetAssertMode(*args, **kwargs):
7017 """
7018 GetAssertMode(self) -> int
7019
7020 Get the current OnAssert behaviour setting.
7021 """
7022 return _core_.PyApp_GetAssertMode(*args, **kwargs)
7023
7024 def GetMacSupportPCMenuShortcuts(*args, **kwargs):
c24da6d6 7025 """GetMacSupportPCMenuShortcuts() -> bool"""
d55e5bfc
RD
7026 return _core_.PyApp_GetMacSupportPCMenuShortcuts(*args, **kwargs)
7027
7028 GetMacSupportPCMenuShortcuts = staticmethod(GetMacSupportPCMenuShortcuts)
7029 def GetMacAboutMenuItemId(*args, **kwargs):
c24da6d6 7030 """GetMacAboutMenuItemId() -> long"""
d55e5bfc
RD
7031 return _core_.PyApp_GetMacAboutMenuItemId(*args, **kwargs)
7032
7033 GetMacAboutMenuItemId = staticmethod(GetMacAboutMenuItemId)
7034 def GetMacPreferencesMenuItemId(*args, **kwargs):
c24da6d6 7035 """GetMacPreferencesMenuItemId() -> long"""
d55e5bfc
RD
7036 return _core_.PyApp_GetMacPreferencesMenuItemId(*args, **kwargs)
7037
7038 GetMacPreferencesMenuItemId = staticmethod(GetMacPreferencesMenuItemId)
7039 def GetMacExitMenuItemId(*args, **kwargs):
c24da6d6 7040 """GetMacExitMenuItemId() -> long"""
d55e5bfc
RD
7041 return _core_.PyApp_GetMacExitMenuItemId(*args, **kwargs)
7042
7043 GetMacExitMenuItemId = staticmethod(GetMacExitMenuItemId)
7044 def GetMacHelpMenuTitleName(*args, **kwargs):
c24da6d6 7045 """GetMacHelpMenuTitleName() -> String"""
d55e5bfc
RD
7046 return _core_.PyApp_GetMacHelpMenuTitleName(*args, **kwargs)
7047
7048 GetMacHelpMenuTitleName = staticmethod(GetMacHelpMenuTitleName)
7049 def SetMacSupportPCMenuShortcuts(*args, **kwargs):
c24da6d6 7050 """SetMacSupportPCMenuShortcuts(bool val)"""
d55e5bfc
RD
7051 return _core_.PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs)
7052
7053 SetMacSupportPCMenuShortcuts = staticmethod(SetMacSupportPCMenuShortcuts)
7054 def SetMacAboutMenuItemId(*args, **kwargs):
c24da6d6 7055 """SetMacAboutMenuItemId(long val)"""
d55e5bfc
RD
7056 return _core_.PyApp_SetMacAboutMenuItemId(*args, **kwargs)
7057
7058 SetMacAboutMenuItemId = staticmethod(SetMacAboutMenuItemId)
7059 def SetMacPreferencesMenuItemId(*args, **kwargs):
c24da6d6 7060 """SetMacPreferencesMenuItemId(long val)"""
d55e5bfc
RD
7061 return _core_.PyApp_SetMacPreferencesMenuItemId(*args, **kwargs)
7062
7063 SetMacPreferencesMenuItemId = staticmethod(SetMacPreferencesMenuItemId)
7064 def SetMacExitMenuItemId(*args, **kwargs):
c24da6d6 7065 """SetMacExitMenuItemId(long val)"""
d55e5bfc
RD
7066 return _core_.PyApp_SetMacExitMenuItemId(*args, **kwargs)
7067
7068 SetMacExitMenuItemId = staticmethod(SetMacExitMenuItemId)
7069 def SetMacHelpMenuTitleName(*args, **kwargs):
c24da6d6 7070 """SetMacHelpMenuTitleName(String val)"""
d55e5bfc
RD
7071 return _core_.PyApp_SetMacHelpMenuTitleName(*args, **kwargs)
7072
7073 SetMacHelpMenuTitleName = staticmethod(SetMacHelpMenuTitleName)
7074 def _BootstrapApp(*args, **kwargs):
7075 """
7076 _BootstrapApp(self)
7077
7078 For internal use only
7079 """
7080 return _core_.PyApp__BootstrapApp(*args, **kwargs)
7081
7082 def GetComCtl32Version(*args, **kwargs):
7083 """
c24da6d6 7084 GetComCtl32Version() -> int
d55e5bfc 7085
c24da6d6
RD
7086 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
7087 it wasn't found at all. Raises an exception on non-Windows platforms.
d55e5bfc
RD
7088 """
7089 return _core_.PyApp_GetComCtl32Version(*args, **kwargs)
7090
7091 GetComCtl32Version = staticmethod(GetComCtl32Version)
33d6fd3b 7092 def IsDisplayAvailable(*args, **kwargs):
fc46b7f3 7093 """
33d6fd3b 7094 IsDisplayAvailable() -> bool
fc46b7f3
RD
7095
7096 Tests if it is possible to create a GUI in the current environment.
7097 This will mean different things on the different platforms.
7098
7099 * On X Windows systems this function will return ``False`` if it is
7100 not able to open a connection to the X display, which can happen
7101 if $DISPLAY is not set, or is not set correctly.
7102
7103 * On Mac OS X a ``False`` return value will mean that wx is not
7104 able to access the window manager, which can happen if logged in
7105 remotely or if running from the normal version of python instead
7106 of the framework version, (i.e., pythonw.)
7107
7108 * On MS Windows...
7109
7110 """
33d6fd3b
RD
7111 return _core_.PyApp_IsDisplayAvailable(*args, **kwargs)
7112
7113 IsDisplayAvailable = staticmethod(IsDisplayAvailable)
7114 AppName = property(GetAppName,SetAppName,doc="See `GetAppName` and `SetAppName`")
7115 AssertMode = property(GetAssertMode,SetAssertMode,doc="See `GetAssertMode` and `SetAssertMode`")
7116 ClassName = property(GetClassName,SetClassName,doc="See `GetClassName` and `SetClassName`")
7117 ExitOnFrameDelete = property(GetExitOnFrameDelete,SetExitOnFrameDelete,doc="See `GetExitOnFrameDelete` and `SetExitOnFrameDelete`")
7118 LayoutDirection = property(GetLayoutDirection,doc="See `GetLayoutDirection`")
7119 PrintMode = property(GetPrintMode,SetPrintMode,doc="See `GetPrintMode` and `SetPrintMode`")
7120 TopWindow = property(GetTopWindow,SetTopWindow,doc="See `GetTopWindow` and `SetTopWindow`")
7121 Traits = property(GetTraits,doc="See `GetTraits`")
7122 UseBestVisual = property(GetUseBestVisual,SetUseBestVisual,doc="See `GetUseBestVisual` and `SetUseBestVisual`")
7123 VendorName = property(GetVendorName,SetVendorName,doc="See `GetVendorName` and `SetVendorName`")
7124 Active = property(IsActive)
2131d850 7125_core_.PyApp_swigregister(PyApp)
d55e5bfc 7126
554f62e9
RD
7127def PyApp_IsMainLoopRunning(*args):
7128 """
84f85550
RD
7129 PyApp_IsMainLoopRunning() -> bool
7130
7131 Returns True if we're running the main loop, i.e. if the events can
7132 currently be dispatched.
7133 """
554f62e9 7134 return _core_.PyApp_IsMainLoopRunning(*args)
84f85550 7135
554f62e9
RD
7136def PyApp_GetMacSupportPCMenuShortcuts(*args):
7137 """PyApp_GetMacSupportPCMenuShortcuts() -> bool"""
7138 return _core_.PyApp_GetMacSupportPCMenuShortcuts(*args)
d55e5bfc 7139
554f62e9
RD
7140def PyApp_GetMacAboutMenuItemId(*args):
7141 """PyApp_GetMacAboutMenuItemId() -> long"""
7142 return _core_.PyApp_GetMacAboutMenuItemId(*args)
d55e5bfc 7143
554f62e9
RD
7144def PyApp_GetMacPreferencesMenuItemId(*args):
7145 """PyApp_GetMacPreferencesMenuItemId() -> long"""
7146 return _core_.PyApp_GetMacPreferencesMenuItemId(*args)
d55e5bfc 7147
554f62e9
RD
7148def PyApp_GetMacExitMenuItemId(*args):
7149 """PyApp_GetMacExitMenuItemId() -> long"""
7150 return _core_.PyApp_GetMacExitMenuItemId(*args)
d55e5bfc 7151
554f62e9
RD
7152def PyApp_GetMacHelpMenuTitleName(*args):
7153 """PyApp_GetMacHelpMenuTitleName() -> String"""
7154 return _core_.PyApp_GetMacHelpMenuTitleName(*args)
d55e5bfc
RD
7155
7156def PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs):
554f62e9
RD
7157 """PyApp_SetMacSupportPCMenuShortcuts(bool val)"""
7158 return _core_.PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs)
d55e5bfc
RD
7159
7160def PyApp_SetMacAboutMenuItemId(*args, **kwargs):
554f62e9
RD
7161 """PyApp_SetMacAboutMenuItemId(long val)"""
7162 return _core_.PyApp_SetMacAboutMenuItemId(*args, **kwargs)
d55e5bfc
RD
7163
7164def PyApp_SetMacPreferencesMenuItemId(*args, **kwargs):
554f62e9
RD
7165 """PyApp_SetMacPreferencesMenuItemId(long val)"""
7166 return _core_.PyApp_SetMacPreferencesMenuItemId(*args, **kwargs)
d55e5bfc
RD
7167
7168def PyApp_SetMacExitMenuItemId(*args, **kwargs):
554f62e9
RD
7169 """PyApp_SetMacExitMenuItemId(long val)"""
7170 return _core_.PyApp_SetMacExitMenuItemId(*args, **kwargs)
d55e5bfc
RD
7171
7172def PyApp_SetMacHelpMenuTitleName(*args, **kwargs):
554f62e9
RD
7173 """PyApp_SetMacHelpMenuTitleName(String val)"""
7174 return _core_.PyApp_SetMacHelpMenuTitleName(*args, **kwargs)
d55e5bfc 7175
554f62e9
RD
7176def PyApp_GetComCtl32Version(*args):
7177 """
d55e5bfc
RD
7178 PyApp_GetComCtl32Version() -> int
7179
c24da6d6
RD
7180 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
7181 it wasn't found at all. Raises an exception on non-Windows platforms.
d55e5bfc 7182 """
554f62e9 7183 return _core_.PyApp_GetComCtl32Version(*args)
d55e5bfc 7184
33d6fd3b 7185def PyApp_IsDisplayAvailable(*args):
fc46b7f3 7186 """
33d6fd3b 7187 PyApp_IsDisplayAvailable() -> bool
fc46b7f3
RD
7188
7189 Tests if it is possible to create a GUI in the current environment.
7190 This will mean different things on the different platforms.
7191
7192 * On X Windows systems this function will return ``False`` if it is
7193 not able to open a connection to the X display, which can happen
7194 if $DISPLAY is not set, or is not set correctly.
7195
7196 * On Mac OS X a ``False`` return value will mean that wx is not
7197 able to access the window manager, which can happen if logged in
7198 remotely or if running from the normal version of python instead
7199 of the framework version, (i.e., pythonw.)
7200
7201 * On MS Windows...
7202
7203 """
33d6fd3b 7204 return _core_.PyApp_IsDisplayAvailable(*args)
fc46b7f3 7205
d55e5bfc
RD
7206#---------------------------------------------------------------------------
7207
7208
554f62e9
RD
7209def Exit(*args):
7210 """
d55e5bfc
RD
7211 Exit()
7212
7213 Force an exit of the application. Convenience for wx.GetApp().Exit()
7214 """
554f62e9 7215 return _core_.Exit(*args)
d55e5bfc 7216
554f62e9
RD
7217def Yield(*args):
7218 """
d55e5bfc
RD
7219 Yield() -> bool
7220
7221 Yield to other apps/messages. Convenience for wx.GetApp().Yield()
7222 """
554f62e9 7223 return _core_.Yield(*args)
d55e5bfc 7224
554f62e9
RD
7225def YieldIfNeeded(*args):
7226 """
d55e5bfc
RD
7227 YieldIfNeeded() -> bool
7228
7229 Yield to other apps/messages. Convenience for wx.GetApp().Yield(True)
7230 """
554f62e9 7231 return _core_.YieldIfNeeded(*args)
d55e5bfc
RD
7232
7233def SafeYield(*args, **kwargs):
554f62e9 7234 """
d55e5bfc
RD
7235 SafeYield(Window win=None, bool onlyIfNeeded=False) -> bool
7236
c24da6d6
RD
7237 This function is similar to `wx.Yield`, except that it disables the
7238 user input to all program windows before calling `wx.Yield` and
7239 re-enables it again afterwards. If ``win`` is not None, this window
7240 will remain enabled, allowing the implementation of some limited user
7241 interaction.
d55e5bfc 7242
c24da6d6 7243 :Returns: the result of the call to `wx.Yield`.
d55e5bfc 7244 """
554f62e9 7245 return _core_.SafeYield(*args, **kwargs)
d55e5bfc 7246
554f62e9
RD
7247def WakeUpIdle(*args):
7248 """
d55e5bfc
RD
7249 WakeUpIdle()
7250
c24da6d6
RD
7251 Cause the message queue to become empty again, so idle events will be
7252 sent.
d55e5bfc 7253 """
554f62e9 7254 return _core_.WakeUpIdle(*args)
d55e5bfc
RD
7255
7256def PostEvent(*args, **kwargs):
554f62e9 7257 """
d55e5bfc
RD
7258 PostEvent(EvtHandler dest, Event event)
7259
c24da6d6
RD
7260 Send an event to a window or other wx.EvtHandler to be processed
7261 later.
d55e5bfc 7262 """
554f62e9 7263 return _core_.PostEvent(*args, **kwargs)
d55e5bfc 7264
554f62e9
RD
7265def App_CleanUp(*args):
7266 """
d55e5bfc
RD
7267 App_CleanUp()
7268
79fccf9d 7269 For internal use only, it is used to cleanup after wxWidgets when
c24da6d6 7270 Python shuts down.
d55e5bfc 7271 """
554f62e9 7272 return _core_.App_CleanUp(*args)
d55e5bfc 7273
554f62e9
RD
7274def GetApp(*args):
7275 """
d55e5bfc
RD
7276 GetApp() -> PyApp
7277
7278 Return a reference to the current wx.App object.
7279 """
554f62e9 7280 return _core_.GetApp(*args)
5cbf236d
RD
7281
7282def SetDefaultPyEncoding(*args, **kwargs):
554f62e9 7283 """
5cbf236d
RD
7284 SetDefaultPyEncoding(string encoding)
7285
7286 Sets the encoding that wxPython will use when it needs to convert a
7287 Python string or unicode object to or from a wxString.
62d32a5f
RD
7288
7289 The default encoding is the value of ``locale.getdefaultlocale()[1]``
7290 but please be aware that the default encoding within the same locale
7291 may be slightly different on different platforms. For example, please
7292 see http://www.alanwood.net/demos/charsetdiffs.html for differences
7293 between the common latin/roman encodings.
5cbf236d 7294 """
554f62e9 7295 return _core_.SetDefaultPyEncoding(*args, **kwargs)
5cbf236d 7296
554f62e9
RD
7297def GetDefaultPyEncoding(*args):
7298 """
5cbf236d
RD
7299 GetDefaultPyEncoding() -> string
7300
7301 Gets the current encoding that wxPython will use when it needs to
7302 convert a Python string or unicode object to or from a wxString.
7303 """
554f62e9 7304 return _core_.GetDefaultPyEncoding(*args)
d55e5bfc
RD
7305#----------------------------------------------------------------------
7306
7307class PyOnDemandOutputWindow:
7308 """
7309 A class that can be used for redirecting Python's stdout and
7310 stderr streams. It will do nothing until something is wrriten to
7311 the stream at which point it will create a Frame with a text area
7312 and write the text there.
7313 """
7314 def __init__(self, title = "wxPython: stdout/stderr"):
7315 self.frame = None
7316 self.title = title
412d302d
RD
7317 self.pos = wx.DefaultPosition
7318 self.size = (450, 300)
d55e5bfc
RD
7319 self.parent = None
7320
7321 def SetParent(self, parent):
7322 """Set the window to be used as the popup Frame's parent."""
7323 self.parent = parent
7324
7325
7326 def CreateOutputWindow(self, st):
412d302d
RD
7327 self.frame = wx.Frame(self.parent, -1, self.title, self.pos, self.size,
7328 style=wx.DEFAULT_FRAME_STYLE)
d55e5bfc 7329 self.text = wx.TextCtrl(self.frame, -1, "",
412d302d 7330 style=wx.TE_MULTILINE|wx.TE_READONLY)
d55e5bfc 7331 self.text.AppendText(st)
d55e5bfc 7332 self.frame.Show(True)
2131d850 7333 self.frame.Bind(wx.EVT_CLOSE, self.OnCloseWindow)
d55e5bfc
RD
7334
7335
7336 def OnCloseWindow(self, event):
7337 if self.frame is not None:
7338 self.frame.Destroy()
7339 self.frame = None
7340 self.text = None
7341
7342
7343 # These methods provide the file-like output behaviour.
7344 def write(self, text):
7345 """
7346 Create the output window if needed and write the string to it.
7347 If not called in the context of the gui thread then uses
7348 CallAfter to do the work there.
7349 """
7350 if self.frame is None:
7351 if not wx.Thread_IsMain():
7352 wx.CallAfter(self.CreateOutputWindow, text)
7353 else:
7354 self.CreateOutputWindow(text)
7355 else:
7356 if not wx.Thread_IsMain():
7357 wx.CallAfter(self.text.AppendText, text)
7358 else:
7359 self.text.AppendText(text)
7360
7361
7362 def close(self):
7363 if self.frame is not None:
7364 wx.CallAfter(self.frame.Close)
7365
7366
19272049
RD
7367 def flush(self):
7368 pass
7369
7370
d55e5bfc
RD
7371
7372#----------------------------------------------------------------------
7373
7374_defRedirect = (wx.Platform == '__WXMSW__' or wx.Platform == '__WXMAC__')
fc46b7f3 7375
d55e5bfc
RD
7376class App(wx.PyApp):
7377 """
c24da6d6
RD
7378 The ``wx.App`` class represents the application and is used to:
7379
7380 * bootstrap the wxPython system and initialize the underlying
7381 gui toolkit
7382 * set and get application-wide properties
7383 * implement the windowing system main message or event loop,
7384 and to dispatch events to window instances
7385 * etc.
7386
7387 Every application must have a ``wx.App`` instance, and all
7388 creation of UI objects should be delayed until after the
7389 ``wx.App`` object has been created in order to ensure that the gui
7390 platform and wxWidgets have been fully initialized.
7391
7392 Normally you would derive from this class and implement an
7393 ``OnInit`` method that creates a frame and then calls
7394 ``self.SetTopWindow(frame)``.
7395
7396 :see: `wx.PySimpleApp` for a simpler app class that can be used
79fccf9d 7397 directly.
d55e5bfc 7398 """
c24da6d6 7399
d55e5bfc
RD
7400 outputWindowClass = PyOnDemandOutputWindow
7401
c24da6d6
RD
7402 def __init__(self, redirect=_defRedirect, filename=None,
7403 useBestVisual=False, clearSigInt=True):
7404 """
7405 Construct a ``wx.App`` object.
7406
7407 :param redirect: Should ``sys.stdout`` and ``sys.stderr`` be
7408 redirected? Defaults to True on Windows and Mac, False
7409 otherwise. If `filename` is None then output will be
7410 redirected to a window that pops up as needed. (You can
7411 control what kind of window is created for the output by
7412 resetting the class variable ``outputWindowClass`` to a
7413 class of your choosing.)
7414
7415 :param filename: The name of a file to redirect output to, if
7416 redirect is True.
7417
7418 :param useBestVisual: Should the app try to use the best
7419 available visual provided by the system (only relevant on
7420 systems that have more than one visual.) This parameter
7421 must be used instead of calling `SetUseBestVisual` later
7422 on because it must be set before the underlying GUI
7423 toolkit is initialized.
7424
7425 :param clearSigInt: Should SIGINT be cleared? This allows the
7426 app to terminate upon a Ctrl-C in the console like other
7427 GUI apps will.
7428
7429 :note: You should override OnInit to do applicaition
7430 initialization to ensure that the system, toolkit and
7431 wxWidgets are fully initialized.
7432 """
fc46b7f3 7433
d55e5bfc
RD
7434 wx.PyApp.__init__(self)
7435
fc46b7f3 7436 # make sure we can create a GUI
33d6fd3b 7437 if not self.IsDisplayAvailable():
fc46b7f3
RD
7438
7439 if wx.Platform == "__WXMAC__":
7440 msg = """This program needs access to the screen.
7441Please run with 'pythonw', not 'python', and only when you are logged
7442in on the main display of your Mac."""
7443
7444 elif wx.Platform == "__WXGTK__":
7445 msg ="Unable to access the X Display, is $DISPLAY set properly?"
d55e5bfc 7446
fc46b7f3
RD
7447 else:
7448 msg = "Unable to create GUI"
7449 # TODO: more description is needed for wxMSW...
7450
7451 raise SystemExit(msg)
7452
d55e5bfc
RD
7453 # This has to be done before OnInit
7454 self.SetUseBestVisual(useBestVisual)
7455
7456 # Set the default handler for SIGINT. This fixes a problem
7457 # where if Ctrl-C is pressed in the console that started this
7458 # app then it will not appear to do anything, (not even send
7459 # KeyboardInterrupt???) but will later segfault on exit. By
7460 # setting the default handler then the app will exit, as
7461 # expected (depending on platform.)
c24da6d6
RD
7462 if clearSigInt:
7463 try:
7464 import signal
7465 signal.signal(signal.SIGINT, signal.SIG_DFL)
7466 except:
7467 pass
d55e5bfc
RD
7468
7469 # Save and redirect the stdio to a window?
7470 self.stdioWin = None
7471 self.saveStdio = (_sys.stdout, _sys.stderr)
7472 if redirect:
7473 self.RedirectStdio(filename)
7474
8fb0e70a
RD
7475 # Use Python's install prefix as the default
7476 wx.StandardPaths.Get().SetInstallPrefix(_sys.prefix)
7477
d55e5bfc
RD
7478 # This finishes the initialization of wxWindows and then calls
7479 # the OnInit that should be present in the derived class
7480 self._BootstrapApp()
7481
7482
f460c29d
RD
7483 def OnPreInit(self):
7484 """
7485 Things that must be done after _BootstrapApp has done its
7486 thing, but would be nice if they were already done by the time
7487 that OnInit is called.
7488 """
7489 wx.StockGDI._initStockObjects()
7490
7491
66af7a75
RD
7492 def __del__(self, destroy=wx.PyApp.__del__):
7493 self.RestoreStdio() # Just in case the MainLoop was overridden
7494 destroy(self)
d55e5bfc 7495
70b7a5fe 7496 def Destroy(self):
b39fe951 7497 self.this.own(False)
70b7a5fe 7498 wx.PyApp.Destroy(self)
d55e5bfc
RD
7499
7500 def SetTopWindow(self, frame):
7501 """Set the \"main\" top level window"""
7502 if self.stdioWin:
7503 self.stdioWin.SetParent(frame)
7504 wx.PyApp.SetTopWindow(self, frame)
7505
7506
7507 def MainLoop(self):
7508 """Execute the main GUI event loop"""
7509 wx.PyApp.MainLoop(self)
7510 self.RestoreStdio()
7511
7512
7513 def RedirectStdio(self, filename=None):
7514 """Redirect sys.stdout and sys.stderr to a file or a popup window."""
7515 if filename:
7516 _sys.stdout = _sys.stderr = open(filename, 'a')
7517 else:
7518 self.stdioWin = self.outputWindowClass()
7519 _sys.stdout = _sys.stderr = self.stdioWin
7520
7521
7522 def RestoreStdio(self):
66af7a75
RD
7523 try:
7524 _sys.stdout, _sys.stderr = self.saveStdio
7525 except:
7526 pass
d55e5bfc
RD
7527
7528
412d302d
RD
7529 def SetOutputWindowAttributes(self, title=None, pos=None, size=None):
7530 """
7531 Set the title, position and/or size of the output window if
f5b96ee1
RD
7532 the stdio has been redirected. This should be called before
7533 any output would cause the output window to be created.
412d302d
RD
7534 """
7535 if self.stdioWin:
7536 if title is not None:
7537 self.stdioWin.title = title
7538 if pos is not None:
7539 self.stdioWin.pos = pos
7540 if size is not None:
7541 self.stdioWin.size = size
7542
7543
7544
d55e5bfc 7545
c24da6d6 7546# change from wx.PyApp_XX to wx.App_XX
d55e5bfc
RD
7547App_GetMacSupportPCMenuShortcuts = _core_.PyApp_GetMacSupportPCMenuShortcuts
7548App_GetMacAboutMenuItemId = _core_.PyApp_GetMacAboutMenuItemId
7549App_GetMacPreferencesMenuItemId = _core_.PyApp_GetMacPreferencesMenuItemId
7550App_GetMacExitMenuItemId = _core_.PyApp_GetMacExitMenuItemId
7551App_GetMacHelpMenuTitleName = _core_.PyApp_GetMacHelpMenuTitleName
7552App_SetMacSupportPCMenuShortcuts = _core_.PyApp_SetMacSupportPCMenuShortcuts
7553App_SetMacAboutMenuItemId = _core_.PyApp_SetMacAboutMenuItemId
7554App_SetMacPreferencesMenuItemId = _core_.PyApp_SetMacPreferencesMenuItemId
7555App_SetMacExitMenuItemId = _core_.PyApp_SetMacExitMenuItemId
7556App_SetMacHelpMenuTitleName = _core_.PyApp_SetMacHelpMenuTitleName
7557App_GetComCtl32Version = _core_.PyApp_GetComCtl32Version
7558
7559#----------------------------------------------------------------------------
7560
7561class PySimpleApp(wx.App):
7562 """
7563 A simple application class. You can just create one of these and
7564 then then make your top level windows later, and not have to worry
c24da6d6 7565 about OnInit. For example::
d55e5bfc 7566
c24da6d6
RD
7567 app = wx.PySimpleApp()
7568 frame = wx.Frame(None, title='Hello World')
7569 frame.Show()
7570 app.MainLoop()
7571
7572 :see: `wx.App`
7573 """
7574
7575 def __init__(self, redirect=False, filename=None,
7576 useBestVisual=False, clearSigInt=True):
7577 """
7578 :see: `wx.App.__init__`
7579 """
7580 wx.App.__init__(self, redirect, filename, useBestVisual, clearSigInt)
d55e5bfc
RD
7581
7582 def OnInit(self):
d55e5bfc
RD
7583 return True
7584
7585
c24da6d6 7586
d55e5bfc
RD
7587# Is anybody using this one?
7588class PyWidgetTester(wx.App):
7589 def __init__(self, size = (250, 100)):
7590 self.size = size
7591 wx.App.__init__(self, 0)
7592
7593 def OnInit(self):
7594 self.frame = wx.Frame(None, -1, "Widget Tester", pos=(0,0), size=self.size)
7595 self.SetTopWindow(self.frame)
7596 return True
7597
c24da6d6
RD
7598 def SetWidget(self, widgetClass, *args, **kwargs):
7599 w = widgetClass(self.frame, *args, **kwargs)
d55e5bfc
RD
7600 self.frame.Show(True)
7601
7602#----------------------------------------------------------------------------
7603# DO NOT hold any other references to this object. This is how we
c24da6d6 7604# know when to cleanup system resources that wxWidgets is holding. When
d55e5bfc 7605# the sys module is unloaded, the refcount on sys.__wxPythonCleanup
c24da6d6 7606# goes to zero and it calls the wx.App_CleanUp function.
d55e5bfc
RD
7607
7608class __wxPyCleanup:
7609 def __init__(self):
7610 self.cleanup = _core_.App_CleanUp
7611 def __del__(self):
7612 self.cleanup()
7613
7614_sys.__wxPythonCleanup = __wxPyCleanup()
7615
7616## # another possible solution, but it gets called too early...
c24da6d6
RD
7617## import atexit
7618## atexit.register(_core_.wxApp_CleanUp)
d55e5bfc
RD
7619
7620
7621#----------------------------------------------------------------------------
7622
7623#---------------------------------------------------------------------------
7624
ae8162c8 7625class EventLoop(object):
093d3ff1 7626 """Proxy of C++ EventLoop class"""
554f62e9
RD
7627 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7628 __repr__ = _swig_repr
7629 def __init__(self, *args, **kwargs):
ae8162c8 7630 """__init__(self) -> EventLoop"""
554f62e9
RD
7631 _core_.EventLoop_swiginit(self,_core_.new_EventLoop(*args, **kwargs))
7632 __swig_destroy__ = _core_.delete_EventLoop
7633 __del__ = lambda self : None;
ae8162c8
RD
7634 def Run(*args, **kwargs):
7635 """Run(self) -> int"""
7636 return _core_.EventLoop_Run(*args, **kwargs)
7637
7638 def Exit(*args, **kwargs):
7639 """Exit(self, int rc=0)"""
7640 return _core_.EventLoop_Exit(*args, **kwargs)
7641
7642 def Pending(*args, **kwargs):
7643 """Pending(self) -> bool"""
7644 return _core_.EventLoop_Pending(*args, **kwargs)
7645
7646 def Dispatch(*args, **kwargs):
7647 """Dispatch(self) -> bool"""
7648 return _core_.EventLoop_Dispatch(*args, **kwargs)
7649
7650 def IsRunning(*args, **kwargs):
7651 """IsRunning(self) -> bool"""
7652 return _core_.EventLoop_IsRunning(*args, **kwargs)
7653
7654 def GetActive(*args, **kwargs):
7655 """GetActive() -> EventLoop"""
7656 return _core_.EventLoop_GetActive(*args, **kwargs)
7657
7658 GetActive = staticmethod(GetActive)
7659 def SetActive(*args, **kwargs):
7660 """SetActive(EventLoop loop)"""
7661 return _core_.EventLoop_SetActive(*args, **kwargs)
7662
7663 SetActive = staticmethod(SetActive)
2131d850 7664_core_.EventLoop_swigregister(EventLoop)
ae8162c8 7665
554f62e9
RD
7666def EventLoop_GetActive(*args):
7667 """EventLoop_GetActive() -> EventLoop"""
7668 return _core_.EventLoop_GetActive(*args)
ae8162c8
RD
7669
7670def EventLoop_SetActive(*args, **kwargs):
554f62e9
RD
7671 """EventLoop_SetActive(EventLoop loop)"""
7672 return _core_.EventLoop_SetActive(*args, **kwargs)
ae8162c8 7673
7449af73
RD
7674class EventLoopActivator(object):
7675 """Proxy of C++ EventLoopActivator class"""
554f62e9
RD
7676 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7677 __repr__ = _swig_repr
7678 def __init__(self, *args, **kwargs):
7449af73 7679 """__init__(self, EventLoop evtLoop) -> EventLoopActivator"""
554f62e9
RD
7680 _core_.EventLoopActivator_swiginit(self,_core_.new_EventLoopActivator(*args, **kwargs))
7681 __swig_destroy__ = _core_.delete_EventLoopActivator
7682 __del__ = lambda self : None;
2131d850 7683_core_.EventLoopActivator_swigregister(EventLoopActivator)
7449af73 7684
ae8162c8
RD
7685#---------------------------------------------------------------------------
7686
eec1c382
RD
7687ACCEL_ALT = _core_.ACCEL_ALT
7688ACCEL_CTRL = _core_.ACCEL_CTRL
7689ACCEL_SHIFT = _core_.ACCEL_SHIFT
7690ACCEL_NORMAL = _core_.ACCEL_NORMAL
7691ACCEL_CMD = _core_.ACCEL_CMD
d55e5bfc 7692class AcceleratorEntry(object):
c24da6d6
RD
7693 """
7694 A class used to define items in an `wx.AcceleratorTable`. wxPython
7695 programs can choose to use wx.AcceleratorEntry objects, but using a
7696 list of 3-tuple of integers (flags, keyCode, cmdID) usually works just
79fccf9d 7697 as well. See `__init__` for of the tuple values.
c24da6d6
RD
7698
7699 :see: `wx.AcceleratorTable`
7700 """
554f62e9
RD
7701 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7702 __repr__ = _swig_repr
7703 def __init__(self, *args, **kwargs):
c24da6d6
RD
7704 """
7705 __init__(self, int flags=0, int keyCode=0, int cmdID=0) -> AcceleratorEntry
7706
7707 Construct a wx.AcceleratorEntry.
c24da6d6 7708 """
554f62e9
RD
7709 _core_.AcceleratorEntry_swiginit(self,_core_.new_AcceleratorEntry(*args, **kwargs))
7710 __swig_destroy__ = _core_.delete_AcceleratorEntry
7711 __del__ = lambda self : None;
d55e5bfc 7712 def Set(*args, **kwargs):
c24da6d6
RD
7713 """
7714 Set(self, int flags, int keyCode, int cmd)
d55e5bfc 7715
c24da6d6
RD
7716 (Re)set the attributes of a wx.AcceleratorEntry.
7717 :see `__init__`
7718 """
7719 return _core_.AcceleratorEntry_Set(*args, **kwargs)
d55e5bfc 7720
97ab0f6a
RD
7721 def Create(*args, **kwargs):
7722 """
7723 Create(String str) -> AcceleratorEntry
7724
7725 Create accelerator corresponding to the specified string, or None if
7726 it coulnd't be parsed.
7727 """
7728 return _core_.AcceleratorEntry_Create(*args, **kwargs)
7729
7730 Create = staticmethod(Create)
d55e5bfc 7731 def GetFlags(*args, **kwargs):
c24da6d6
RD
7732 """
7733 GetFlags(self) -> int
7734
7735 Get the AcceleratorEntry's flags.
7736 """
d55e5bfc
RD
7737 return _core_.AcceleratorEntry_GetFlags(*args, **kwargs)
7738
7739 def GetKeyCode(*args, **kwargs):
c24da6d6
RD
7740 """
7741 GetKeyCode(self) -> int
7742
7743 Get the AcceleratorEntry's keycode.
7744 """
d55e5bfc
RD
7745 return _core_.AcceleratorEntry_GetKeyCode(*args, **kwargs)
7746
7747 def GetCommand(*args, **kwargs):
c24da6d6
RD
7748 """
7749 GetCommand(self) -> int
7750
7751 Get the AcceleratorEntry's command ID.
7752 """
d55e5bfc
RD
7753 return _core_.AcceleratorEntry_GetCommand(*args, **kwargs)
7754
97ab0f6a
RD
7755 def IsOk(*args, **kwargs):
7756 """IsOk(self) -> bool"""
7757 return _core_.AcceleratorEntry_IsOk(*args, **kwargs)
7758
7759 def ToString(*args, **kwargs):
7760 """
7761 ToString(self) -> String
7762
7763 Returns a string representation for the this accelerator. The string
7764 is formatted using the <flags>-<keycode> format where <flags> maybe a
7765 hyphen-separed list of "shift|alt|ctrl"
7766
7767 """
7768 return _core_.AcceleratorEntry_ToString(*args, **kwargs)
7769
7770 def FromString(*args, **kwargs):
7771 """
7772 FromString(self, String str) -> bool
7773
7774 Returns true if the given string correctly initialized this object.
7775 """
7776 return _core_.AcceleratorEntry_FromString(*args, **kwargs)
7777
226118fc
RD
7778 Command = property(GetCommand,doc="See `GetCommand`")
7779 Flags = property(GetFlags,doc="See `GetFlags`")
7780 KeyCode = property(GetKeyCode,doc="See `GetKeyCode`")
2131d850 7781_core_.AcceleratorEntry_swigregister(AcceleratorEntry)
d55e5bfc 7782
97ab0f6a
RD
7783def AcceleratorEntry_Create(*args, **kwargs):
7784 """
7785 AcceleratorEntry_Create(String str) -> AcceleratorEntry
7786
7787 Create accelerator corresponding to the specified string, or None if
7788 it coulnd't be parsed.
7789 """
7790 return _core_.AcceleratorEntry_Create(*args, **kwargs)
7791
d55e5bfc 7792class AcceleratorTable(Object):
c24da6d6
RD
7793 """
7794 An accelerator table allows the application to specify a table of
7795 keyboard shortcuts for menus or other commands. On Windows, menu or
7796 button commands are supported; on GTK, only menu commands are
7797 supported.
c24da6d6 7798 """
554f62e9
RD
7799 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7800 __repr__ = _swig_repr
7801 def __init__(self, *args, **kwargs):
d55e5bfc
RD
7802 """
7803 __init__(entries) -> AcceleratorTable
7804
c24da6d6
RD
7805 Construct an AcceleratorTable from a list of `wx.AcceleratorEntry`
7806 items or or of 3-tuples (flags, keyCode, cmdID)
7807
7808 :see: `wx.AcceleratorEntry`
d55e5bfc 7809 """
554f62e9
RD
7810 _core_.AcceleratorTable_swiginit(self,_core_.new_AcceleratorTable(*args, **kwargs))
7811 __swig_destroy__ = _core_.delete_AcceleratorTable
7812 __del__ = lambda self : None;
b39fe951
RD
7813 def IsOk(*args, **kwargs):
7814 """IsOk(self) -> bool"""
7815 return _core_.AcceleratorTable_IsOk(*args, **kwargs)
d55e5bfc 7816
b39fe951 7817 Ok = IsOk
2131d850 7818_core_.AcceleratorTable_swigregister(AcceleratorTable)
d55e5bfc
RD
7819
7820
7821def GetAccelFromString(*args, **kwargs):
554f62e9
RD
7822 """GetAccelFromString(String label) -> AcceleratorEntry"""
7823 return _core_.GetAccelFromString(*args, **kwargs)
d55e5bfc
RD
7824#---------------------------------------------------------------------------
7825
7826class VisualAttributes(object):
7827 """struct containing all the visual attributes of a control"""
554f62e9
RD
7828 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7829 __repr__ = _swig_repr
7830 def __init__(self, *args, **kwargs):
d55e5bfc
RD
7831 """
7832 __init__(self) -> VisualAttributes
7833
7834 struct containing all the visual attributes of a control
7835 """
554f62e9
RD
7836 _core_.VisualAttributes_swiginit(self,_core_.new_VisualAttributes(*args, **kwargs))
7837 __swig_destroy__ = _core_.delete_VisualAttributes
7838 __del__ = lambda self : None;
d55e5bfc
RD
7839 font = property(_core_.VisualAttributes_font_get, _core_.VisualAttributes_font_set)
7840 colFg = property(_core_.VisualAttributes_colFg_get, _core_.VisualAttributes_colFg_set)
7841 colBg = property(_core_.VisualAttributes_colBg_get, _core_.VisualAttributes_colBg_set)
2131d850 7842_core_.VisualAttributes_swigregister(VisualAttributes)
d55e5bfc
RD
7843NullAcceleratorTable = cvar.NullAcceleratorTable
7844PanelNameStr = cvar.PanelNameStr
7845
7846WINDOW_VARIANT_NORMAL = _core_.WINDOW_VARIANT_NORMAL
7847WINDOW_VARIANT_SMALL = _core_.WINDOW_VARIANT_SMALL
7848WINDOW_VARIANT_MINI = _core_.WINDOW_VARIANT_MINI
7849WINDOW_VARIANT_LARGE = _core_.WINDOW_VARIANT_LARGE
7850WINDOW_VARIANT_MAX = _core_.WINDOW_VARIANT_MAX
7851class Window(EvtHandler):
7852 """
7853 wx.Window is the base class for all windows and represents any visible
7854 object on the screen. All controls, top level windows and so on are
7855 wx.Windows. Sizers and device contexts are not however, as they don't
7856 appear on screen themselves.
7857
7858 """
554f62e9
RD
7859 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7860 __repr__ = _swig_repr
7861 def __init__(self, *args, **kwargs):
d55e5bfc
RD
7862 """
7863 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
7864 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> Window
7865
7866 Construct and show a generic Window.
7867 """
554f62e9 7868 _core_.Window_swiginit(self,_core_.new_Window(*args, **kwargs))
d55e5bfc
RD
7869 self._setOORInfo(self)
7870
7871 def Create(*args, **kwargs):
7872 """
7873 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
7874 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> bool
7875
7876 Create the GUI part of the Window for 2-phase creation mode.
7877 """
7878 return _core_.Window_Create(*args, **kwargs)
7879
7880 def Close(*args, **kwargs):
7881 """
7882 Close(self, bool force=False) -> bool
7883
7884 This function simply generates a EVT_CLOSE event whose handler usually
7885 tries to close the window. It doesn't close the window itself,
7886 however. If force is False (the default) then the window's close
7887 handler will be allowed to veto the destruction of the window.
d55e5bfc
RD
7888 """
7889 return _core_.Window_Close(*args, **kwargs)
7890
7891 def Destroy(*args, **kwargs):
7892 """
7893 Destroy(self) -> bool
7894
7895 Destroys the window safely. Frames and dialogs are not destroyed
7896 immediately when this function is called -- they are added to a list
7897 of windows to be deleted on idle time, when all the window's events
7898 have been processed. This prevents problems with events being sent to
7899 non-existent windows.
7900
7901 Returns True if the window has either been successfully deleted, or it
7902 has been added to the list of windows pending real deletion.
7903 """
b39fe951
RD
7904 args[0].this.own(False)
7905 return _core_.Window_Destroy(*args, **kwargs)
d55e5bfc
RD
7906
7907 def DestroyChildren(*args, **kwargs):
7908 """
7909 DestroyChildren(self) -> bool
7910
79fccf9d
RD
7911 Destroys all children of a window. Called automatically by the
7912 destructor.
d55e5bfc
RD
7913 """
7914 return _core_.Window_DestroyChildren(*args, **kwargs)
7915
7916 def IsBeingDeleted(*args, **kwargs):
7917 """
7918 IsBeingDeleted(self) -> bool
7919
7920 Is the window in the process of being deleted?
7921 """
7922 return _core_.Window_IsBeingDeleted(*args, **kwargs)
7923
d55e5bfc
RD
7924 def SetLabel(*args, **kwargs):
7925 """
7926 SetLabel(self, String label)
7927
7928 Set the text which the window shows in its label if applicable.
7929 """
7930 return _core_.Window_SetLabel(*args, **kwargs)
7931
7932 def GetLabel(*args, **kwargs):
7933 """
7934 GetLabel(self) -> String
7935
79fccf9d
RD
7936 Generic way of getting a label from any window, for identification
7937 purposes. The interpretation of this function differs from class to
7938 class. For frames and dialogs, the value returned is the title. For
7939 buttons or static text controls, it is the button text. This function
7940 can be useful for meta-programs such as testing tools or special-needs
7941 access programs)which need to identify windows by name.
d55e5bfc
RD
7942 """
7943 return _core_.Window_GetLabel(*args, **kwargs)
7944
7945 def SetName(*args, **kwargs):
7946 """
7947 SetName(self, String name)
7948
79fccf9d
RD
7949 Sets the window's name. The window name is used for ressource setting
7950 in X, it is not the same as the window title/label
d55e5bfc
RD
7951 """
7952 return _core_.Window_SetName(*args, **kwargs)
7953
7954 def GetName(*args, **kwargs):
7955 """
7956 GetName(self) -> String
7957
79fccf9d
RD
7958 Returns the windows name. This name is not guaranteed to be unique;
7959 it is up to the programmer to supply an appropriate name in the window
7960 constructor or via wx.Window.SetName.
d55e5bfc
RD
7961 """
7962 return _core_.Window_GetName(*args, **kwargs)
7963
7964 def SetWindowVariant(*args, **kwargs):
7965 """
7966 SetWindowVariant(self, int variant)
7967
79fccf9d
RD
7968 Sets the variant of the window/font size to use for this window, if
7969 the platform supports variants, for example, wxMac.
d55e5bfc
RD
7970 """
7971 return _core_.Window_SetWindowVariant(*args, **kwargs)
7972
7973 def GetWindowVariant(*args, **kwargs):
7974 """GetWindowVariant(self) -> int"""
7975 return _core_.Window_GetWindowVariant(*args, **kwargs)
7976
7977 def SetId(*args, **kwargs):
7978 """
7979 SetId(self, int winid)
7980
7981 Sets the identifier of the window. Each window has an integer
7982 identifier. If the application has not provided one, an identifier
7983 will be generated. Normally, the identifier should be provided on
7984 creation and should not be modified subsequently.
7985 """
7986 return _core_.Window_SetId(*args, **kwargs)
7987
7988 def GetId(*args, **kwargs):
7989 """
7990 GetId(self) -> int
7991
7992 Returns the identifier of the window. Each window has an integer
7993 identifier. If the application has not provided one (or the default Id
7994 -1 is used) then an unique identifier with a negative value will be
7995 generated.
7996 """
7997 return _core_.Window_GetId(*args, **kwargs)
7998
7999 def NewControlId(*args, **kwargs):
8000 """
c24da6d6 8001 NewControlId() -> int
d55e5bfc
RD
8002
8003 Generate a control id for the controls which were not given one.
8004 """
8005 return _core_.Window_NewControlId(*args, **kwargs)
8006
8007 NewControlId = staticmethod(NewControlId)
8008 def NextControlId(*args, **kwargs):
8009 """
c24da6d6 8010 NextControlId(int winid) -> int
d55e5bfc
RD
8011
8012 Get the id of the control following the one with the given
79fccf9d 8013 autogenerated) id
d55e5bfc
RD
8014 """
8015 return _core_.Window_NextControlId(*args, **kwargs)
8016
8017 NextControlId = staticmethod(NextControlId)
8018 def PrevControlId(*args, **kwargs):
8019 """
c24da6d6 8020 PrevControlId(int winid) -> int
d55e5bfc
RD
8021
8022 Get the id of the control preceding the one with the given
79fccf9d 8023 autogenerated) id
d55e5bfc
RD
8024 """
8025 return _core_.Window_PrevControlId(*args, **kwargs)
8026
8027 PrevControlId = staticmethod(PrevControlId)
97ab0f6a
RD
8028 def GetLayoutDirection(*args, **kwargs):
8029 """
994453b8 8030 GetLayoutDirection(self) -> int
97ab0f6a
RD
8031
8032 Get the layout direction (LTR or RTL) for this window. Returns
8033 ``wx.Layout_Default`` if layout direction is not supported.
8034 """
8035 return _core_.Window_GetLayoutDirection(*args, **kwargs)
8036
8037 def SetLayoutDirection(*args, **kwargs):
8038 """
994453b8 8039 SetLayoutDirection(self, int dir)
97ab0f6a
RD
8040
8041 Set the layout direction (LTR or RTL) for this window.
8042 """
8043 return _core_.Window_SetLayoutDirection(*args, **kwargs)
8044
8045 def AdjustForLayoutDirection(*args, **kwargs):
8046 """
8047 AdjustForLayoutDirection(self, int x, int width, int widthTotal) -> int
8048
8049 Mirror coordinates for RTL layout if this window uses it and if the
8050 mirroring is not done automatically like Win32.
8051 """
8052 return _core_.Window_AdjustForLayoutDirection(*args, **kwargs)
8053
d55e5bfc
RD
8054 def SetSize(*args, **kwargs):
8055 """
8056 SetSize(self, Size size)
8057
8058 Sets the size of the window in pixels.
8059 """
8060 return _core_.Window_SetSize(*args, **kwargs)
8061
8062 def SetDimensions(*args, **kwargs):
8063 """
8064 SetDimensions(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)
8065
8066 Sets the position and size of the window in pixels. The sizeFlags
8067 parameter indicates the interpretation of the other params if they are
62d32a5f
RD
8068 equal to -1.
8069
8070 ======================== ======================================
8071 wx.SIZE_AUTO A -1 indicates that a class-specific
8072 default should be used.
8073 wx.SIZE_USE_EXISTING Axisting dimensions should be used if
8074 -1 values are supplied.
8075 wxSIZE_ALLOW_MINUS_ONE Allow dimensions of -1 and less to be
8076 interpreted as real dimensions, not
8077 default values.
8078 ======================== ======================================
8079
d55e5bfc
RD
8080 """
8081 return _core_.Window_SetDimensions(*args, **kwargs)
8082
8083 def SetRect(*args, **kwargs):
8084 """
8085 SetRect(self, Rect rect, int sizeFlags=SIZE_AUTO)
8086
8087 Sets the position and size of the window in pixels using a wx.Rect.
8088 """
8089 return _core_.Window_SetRect(*args, **kwargs)
8090
8091 def SetSizeWH(*args, **kwargs):
8092 """
8093 SetSizeWH(self, int width, int height)
8094
8095 Sets the size of the window in pixels.
8096 """
8097 return _core_.Window_SetSizeWH(*args, **kwargs)
8098
8099 def Move(*args, **kwargs):
8100 """
8101 Move(self, Point pt, int flags=SIZE_USE_EXISTING)
8102
8103 Moves the window to the given position.
8104 """
8105 return _core_.Window_Move(*args, **kwargs)
8106
8107 SetPosition = Move
8108 def MoveXY(*args, **kwargs):
8109 """
8110 MoveXY(self, int x, int y, int flags=SIZE_USE_EXISTING)
8111
8112 Moves the window to the given position.
8113 """
8114 return _core_.Window_MoveXY(*args, **kwargs)
8115
f8167d6e
RD
8116 def SetBestFittingSize(*args, **kwargs):
8117 """
8118 SetBestFittingSize(self, Size size=DefaultSize)
8119
8120 A 'Smart' SetSize that will fill in default size components with the
8121 window's *best size* values. Also set's the minsize for use with sizers.
8122 """
8123 return _core_.Window_SetBestFittingSize(*args, **kwargs)
8124
d55e5bfc
RD
8125 def Raise(*args, **kwargs):
8126 """
8127 Raise(self)
8128
9d7dfdff
RD
8129 Raises the window to the top of the window hierarchy. In current
8130 version of wxWidgets this works both for manage and child windows.
d55e5bfc
RD
8131 """
8132 return _core_.Window_Raise(*args, **kwargs)
8133
8134 def Lower(*args, **kwargs):
8135 """
8136 Lower(self)
8137
9d7dfdff
RD
8138 Lowers the window to the bottom of the window hierarchy. In current
8139 version of wxWidgets this works both for manage and child windows.
d55e5bfc
RD
8140 """
8141 return _core_.Window_Lower(*args, **kwargs)
8142
8143 def SetClientSize(*args, **kwargs):
8144 """
8145 SetClientSize(self, Size size)
8146
8147 This sets the size of the window client area in pixels. Using this
8148 function to size a window tends to be more device-independent than
8149 wx.Window.SetSize, since the application need not worry about what
8150 dimensions the border or title bar have when trying to fit the window
8151 around panel items, for example.
8152 """
8153 return _core_.Window_SetClientSize(*args, **kwargs)
8154
8155 def SetClientSizeWH(*args, **kwargs):
8156 """
8157 SetClientSizeWH(self, int width, int height)
8158
8159 This sets the size of the window client area in pixels. Using this
8160 function to size a window tends to be more device-independent than
8161 wx.Window.SetSize, since the application need not worry about what
8162 dimensions the border or title bar have when trying to fit the window
8163 around panel items, for example.
8164 """
8165 return _core_.Window_SetClientSizeWH(*args, **kwargs)
8166
8167 def SetClientRect(*args, **kwargs):
8168 """
8169 SetClientRect(self, Rect rect)
8170
8171 This sets the size of the window client area in pixels. Using this
8172 function to size a window tends to be more device-independent than
8173 wx.Window.SetSize, since the application need not worry about what
8174 dimensions the border or title bar have when trying to fit the window
8175 around panel items, for example.
8176 """
8177 return _core_.Window_SetClientRect(*args, **kwargs)
8178
8179 def GetPosition(*args, **kwargs):
8180 """
8181 GetPosition(self) -> Point
8182
1c71765a
RD
8183 Get the window's position. Notice that the position is in client
8184 coordinates for child windows and screen coordinates for the top level
8185 ones, use `GetScreenPosition` if you need screen coordinates for all
8186 kinds of windows.
d55e5bfc
RD
8187 """
8188 return _core_.Window_GetPosition(*args, **kwargs)
8189
8190 def GetPositionTuple(*args, **kwargs):
8191 """
8192 GetPositionTuple() -> (x,y)
8193
1c71765a
RD
8194 Get the window's position. Notice that the position is in client
8195 coordinates for child windows and screen coordinates for the top level
8196 ones, use `GetScreenPosition` if you need screen coordinates for all
8197 kinds of windows.
d55e5bfc
RD
8198 """
8199 return _core_.Window_GetPositionTuple(*args, **kwargs)
8200
1c71765a
RD
8201 def GetScreenPosition(*args, **kwargs):
8202 """
8203 GetScreenPosition(self) -> Point
8204
8205 Get the position of the window in screen coordinantes.
8206 """
8207 return _core_.Window_GetScreenPosition(*args, **kwargs)
8208
8209 def GetScreenPositionTuple(*args, **kwargs):
8210 """
8211 GetScreenPositionTuple() -> (x,y)
8212
8213 Get the position of the window in screen coordinantes.
8214 """
8215 return _core_.Window_GetScreenPositionTuple(*args, **kwargs)
8216
8217 def GetScreenRect(*args, **kwargs):
8218 """
8219 GetScreenRect(self) -> Rect
8220
8221 Returns the size and position of the window in screen coordinantes as
8222 a `wx.Rect` object.
8223 """
8224 return _core_.Window_GetScreenRect(*args, **kwargs)
8225
d55e5bfc
RD
8226 def GetSize(*args, **kwargs):
8227 """
8228 GetSize(self) -> Size
8229
8230 Get the window size.
8231 """
8232 return _core_.Window_GetSize(*args, **kwargs)
8233
8234 def GetSizeTuple(*args, **kwargs):
8235 """
8236 GetSizeTuple() -> (width, height)
8237
8238 Get the window size.
8239 """
8240 return _core_.Window_GetSizeTuple(*args, **kwargs)
8241
8242 def GetRect(*args, **kwargs):
8243 """
8244 GetRect(self) -> Rect
8245
1c71765a 8246 Returns the size and position of the window as a `wx.Rect` object.
d55e5bfc
RD
8247 """
8248 return _core_.Window_GetRect(*args, **kwargs)
8249
8250 def GetClientSize(*args, **kwargs):
8251 """
8252 GetClientSize(self) -> Size
8253
8254 This gets the size of the window's 'client area' in pixels. The client
8255 area is the area which may be drawn on by the programmer, excluding
8256 title bar, border, scrollbars, etc.
8257 """
8258 return _core_.Window_GetClientSize(*args, **kwargs)
8259
8260 def GetClientSizeTuple(*args, **kwargs):
8261 """
8262 GetClientSizeTuple() -> (width, height)
8263
8264 This gets the size of the window's 'client area' in pixels. The client
8265 area is the area which may be drawn on by the programmer, excluding
8266 title bar, border, scrollbars, etc.
8267 """
8268 return _core_.Window_GetClientSizeTuple(*args, **kwargs)
8269
8270 def GetClientAreaOrigin(*args, **kwargs):
8271 """
8272 GetClientAreaOrigin(self) -> Point
8273
8274 Get the origin of the client area of the window relative to the
8275 window's top left corner (the client area may be shifted because of
8276 the borders, scrollbars, other decorations...)
8277 """
8278 return _core_.Window_GetClientAreaOrigin(*args, **kwargs)
8279
8280 def GetClientRect(*args, **kwargs):
8281 """
8282 GetClientRect(self) -> Rect
8283
629f3c1b 8284 Get the client area position and size as a `wx.Rect` object.
d55e5bfc
RD
8285 """
8286 return _core_.Window_GetClientRect(*args, **kwargs)
8287
8288 def GetBestSize(*args, **kwargs):
8289 """
8290 GetBestSize(self) -> Size
8291
248ed943 8292 This function returns the best acceptable minimal size for the
79fccf9d
RD
8293 window, if applicable. For example, for a static text control, it will
8294 be the minimal size such that the control label is not truncated. For
8295 windows containing subwindows (suzh aswx.Panel), the size returned by
8296 this function will be the same as the size the window would have had
8297 after calling Fit.
d55e5bfc
RD
8298 """
8299 return _core_.Window_GetBestSize(*args, **kwargs)
8300
8301 def GetBestSizeTuple(*args, **kwargs):
8302 """
8303 GetBestSizeTuple() -> (width, height)
8304
248ed943 8305 This function returns the best acceptable minimal size for the
79fccf9d
RD
8306 window, if applicable. For example, for a static text control, it will
8307 be the minimal size such that the control label is not truncated. For
8308 windows containing subwindows (suzh aswx.Panel), the size returned by
8309 this function will be the same as the size the window would have had
8310 after calling Fit.
d55e5bfc
RD
8311 """
8312 return _core_.Window_GetBestSizeTuple(*args, **kwargs)
8313
a001823c
RD
8314 def InvalidateBestSize(*args, **kwargs):
8315 """
8316 InvalidateBestSize(self)
8317
8318 Reset the cached best size value so it will be recalculated the next
8319 time it is needed.
8320 """
8321 return _core_.Window_InvalidateBestSize(*args, **kwargs)
8322
e2813725
RD
8323 def CacheBestSize(*args, **kwargs):
8324 """
8325 CacheBestSize(self, Size size)
8326
8327 Cache the best size so it doesn't need to be calculated again, (at least until
8328 some properties of the window change.)
8329 """
8330 return _core_.Window_CacheBestSize(*args, **kwargs)
8331
a001823c
RD
8332 def GetBestFittingSize(*args, **kwargs):
8333 """
8334 GetBestFittingSize(self) -> Size
8335
8336 This function will merge the window's best size into the window's
8337 minimum size, giving priority to the min size components, and returns
8338 the results.
8339
8340 """
8341 return _core_.Window_GetBestFittingSize(*args, **kwargs)
8342
d55e5bfc
RD
8343 def GetAdjustedBestSize(*args, **kwargs):
8344 """
8345 GetAdjustedBestSize(self) -> Size
8346
8347 This method is similar to GetBestSize, except in one
8348 thing. GetBestSize should return the minimum untruncated size of the
8349 window, while this method will return the largest of BestSize and any
8350 user specified minimum size. ie. it is the minimum size the window
8351 should currently be drawn at, not the minimal size it can possibly
8352 tolerate.
8353 """
8354 return _core_.Window_GetAdjustedBestSize(*args, **kwargs)
8355
8356 def Center(*args, **kwargs):
8357 """
8358 Center(self, int direction=BOTH)
8359
8360 Centers the window. The parameter specifies the direction for
8361 cetering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may
8362 also include wx.CENTER_ON_SCREEN flag if you want to center the window
8363 on the entire screen and not on its parent window. If it is a
8364 top-level window and has no parent then it will always be centered
8365 relative to the screen.
8366 """
8367 return _core_.Window_Center(*args, **kwargs)
8368
8369 Centre = Center
d55e5bfc
RD
8370 def CenterOnParent(*args, **kwargs):
8371 """
8372 CenterOnParent(self, int dir=BOTH)
8373
8374 Center with respect to the the parent window
8375 """
8376 return _core_.Window_CenterOnParent(*args, **kwargs)
8377
8378 CentreOnParent = CenterOnParent
8379 def Fit(*args, **kwargs):
8380 """
8381 Fit(self)
8382
8383 Sizes the window so that it fits around its subwindows. This function
8384 won't do anything if there are no subwindows and will only really work
8385 correctly if sizers are used for the subwindows layout. Also, if the
8386 window has exactly one subwindow it is better (faster and the result
8387 is more precise as Fit adds some margin to account for fuzziness of
8388 its calculations) to call window.SetClientSize(child.GetSize())
8389 instead of calling Fit.
8390 """
8391 return _core_.Window_Fit(*args, **kwargs)
8392
8393 def FitInside(*args, **kwargs):
8394 """
8395 FitInside(self)
8396
8397 Similar to Fit, but sizes the interior (virtual) size of a
8398 window. Mainly useful with scrolled windows to reset scrollbars after
8399 sizing changes that do not trigger a size event, and/or scrolled
8400 windows without an interior sizer. This function similarly won't do
8401 anything if there are no subwindows.
8402 """
8403 return _core_.Window_FitInside(*args, **kwargs)
8404
03837c5c 8405 def SetSizeHints(*args, **kwargs):
d55e5bfc
RD
8406 """
8407 SetSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1,
8408 int incH=-1)
d55e5bfc
RD
8409
8410 Allows specification of minimum and maximum window sizes, and window
8411 size increments. If a pair of values is not set (or set to -1), the
8412 default values will be used. If this function is called, the user
908b74cd
RD
8413 will not be able to size the window outside the given bounds (if it is
8414 a top-level window.) Sizers will also inspect the minimum window size
8415 and will use that value if set when calculating layout.
8416
8417 The resizing increments are only significant under Motif or Xt.
d55e5bfc 8418 """
03837c5c 8419 return _core_.Window_SetSizeHints(*args, **kwargs)
d55e5bfc 8420
03837c5c
RD
8421 def SetSizeHintsSz(*args, **kwargs):
8422 """
8423 SetSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize, Size incSize=DefaultSize)
8424
8425 Allows specification of minimum and maximum window sizes, and window
8426 size increments. If a pair of values is not set (or set to -1), the
8427 default values will be used. If this function is called, the user
8428 will not be able to size the window outside the given bounds (if it is
8429 a top-level window.) Sizers will also inspect the minimum window size
8430 and will use that value if set when calculating layout.
8431
8432 The resizing increments are only significant under Motif or Xt.
8433 """
8434 return _core_.Window_SetSizeHintsSz(*args, **kwargs)
8435
8436 def SetVirtualSizeHints(*args, **kwargs):
d55e5bfc 8437 """
908b74cd 8438 SetVirtualSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1)
d55e5bfc
RD
8439
8440 Allows specification of minimum and maximum virtual window sizes. If a
8441 pair of values is not set (or set to -1), the default values will be
8442 used. If this function is called, the user will not be able to size
8443 the virtual area of the window outside the given bounds.
8444 """
03837c5c
RD
8445 return _core_.Window_SetVirtualSizeHints(*args, **kwargs)
8446
8447 def SetVirtualSizeHintsSz(*args, **kwargs):
8448 """
8449 SetVirtualSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize)
8450
8451 Allows specification of minimum and maximum virtual window sizes. If a
8452 pair of values is not set (or set to -1), the default values will be
8453 used. If this function is called, the user will not be able to size
8454 the virtual area of the window outside the given bounds.
8455 """
8456 return _core_.Window_SetVirtualSizeHintsSz(*args, **kwargs)
d55e5bfc 8457
908b74cd
RD
8458 def GetMaxSize(*args, **kwargs):
8459 """GetMaxSize(self) -> Size"""
8460 return _core_.Window_GetMaxSize(*args, **kwargs)
8461
8462 def GetMinSize(*args, **kwargs):
8463 """GetMinSize(self) -> Size"""
8464 return _core_.Window_GetMinSize(*args, **kwargs)
8465
8466 def SetMinSize(*args, **kwargs):
8467 """
8468 SetMinSize(self, Size minSize)
8469
8470 A more convenient method than `SetSizeHints` for setting just the
8471 min size.
8472 """
8473 return _core_.Window_SetMinSize(*args, **kwargs)
8474
8475 def SetMaxSize(*args, **kwargs):
8476 """
8477 SetMaxSize(self, Size maxSize)
8478
8479 A more convenient method than `SetSizeHints` for setting just the
8480 max size.
8481 """
8482 return _core_.Window_SetMaxSize(*args, **kwargs)
8483
d55e5bfc
RD
8484 def GetMinWidth(*args, **kwargs):
8485 """GetMinWidth(self) -> int"""
8486 return _core_.Window_GetMinWidth(*args, **kwargs)
8487
8488 def GetMinHeight(*args, **kwargs):
8489 """GetMinHeight(self) -> int"""
8490 return _core_.Window_GetMinHeight(*args, **kwargs)
8491
8492 def GetMaxWidth(*args, **kwargs):
8493 """GetMaxWidth(self) -> int"""
8494 return _core_.Window_GetMaxWidth(*args, **kwargs)
8495
8496 def GetMaxHeight(*args, **kwargs):
8497 """GetMaxHeight(self) -> int"""
8498 return _core_.Window_GetMaxHeight(*args, **kwargs)
8499
d55e5bfc
RD
8500 def SetVirtualSize(*args, **kwargs):
8501 """
8502 SetVirtualSize(self, Size size)
8503
8504 Set the the virtual size of a window in pixels. For most windows this
8505 is just the client area of the window, but for some like scrolled
8506 windows it is more or less independent of the screen window size.
8507 """
8508 return _core_.Window_SetVirtualSize(*args, **kwargs)
8509
8510 def SetVirtualSizeWH(*args, **kwargs):
8511 """
8512 SetVirtualSizeWH(self, int w, int h)
8513
8514 Set the the virtual size of a window in pixels. For most windows this
8515 is just the client area of the window, but for some like scrolled
8516 windows it is more or less independent of the screen window size.
8517 """
8518 return _core_.Window_SetVirtualSizeWH(*args, **kwargs)
8519
8520 def GetVirtualSize(*args, **kwargs):
8521 """
8522 GetVirtualSize(self) -> Size
8523
8524 Get the the virtual size of the window in pixels. For most windows
8525 this is just the client area of the window, but for some like scrolled
8526 windows it is more or less independent of the screen window size.
8527 """
8528 return _core_.Window_GetVirtualSize(*args, **kwargs)
8529
8530 def GetVirtualSizeTuple(*args, **kwargs):
8531 """
8532 GetVirtualSizeTuple() -> (width, height)
8533
8534 Get the the virtual size of the window in pixels. For most windows
8535 this is just the client area of the window, but for some like scrolled
8536 windows it is more or less independent of the screen window size.
8537 """
8538 return _core_.Window_GetVirtualSizeTuple(*args, **kwargs)
8539
8540 def GetBestVirtualSize(*args, **kwargs):
8541 """
8542 GetBestVirtualSize(self) -> Size
8543
8544 Return the largest of ClientSize and BestSize (as determined by a
8545 sizer, interior children, or other means)
8546 """
8547 return _core_.Window_GetBestVirtualSize(*args, **kwargs)
8548
8549 def Show(*args, **kwargs):
8550 """
8551 Show(self, bool show=True) -> bool
8552
8553 Shows or hides the window. You may need to call Raise for a top level
8554 window if you want to bring it to top, although this is not needed if
8555 Show is called immediately after the frame creation. Returns True if
8556 the window has been shown or hidden or False if nothing was done
8557 because it already was in the requested state.
8558 """
8559 return _core_.Window_Show(*args, **kwargs)
8560
8561 def Hide(*args, **kwargs):
8562 """
8563 Hide(self) -> bool
8564
8565 Equivalent to calling Show(False).
8566 """
8567 return _core_.Window_Hide(*args, **kwargs)
8568
8569 def Enable(*args, **kwargs):
8570 """
8571 Enable(self, bool enable=True) -> bool
8572
8573 Enable or disable the window for user input. Note that when a parent
8574 window is disabled, all of its children are disabled as well and they
8575 are reenabled again when the parent is. Returns true if the window
8576 has been enabled or disabled, false if nothing was done, i.e. if the
8577 window had already been in the specified state.
8578 """
8579 return _core_.Window_Enable(*args, **kwargs)
8580
8581 def Disable(*args, **kwargs):
8582 """
8583 Disable(self) -> bool
8584
8585 Disables the window, same as Enable(false).
8586 """
8587 return _core_.Window_Disable(*args, **kwargs)
8588
8589 def IsShown(*args, **kwargs):
8590 """
8591 IsShown(self) -> bool
8592
8593 Returns true if the window is shown, false if it has been hidden.
8594 """
8595 return _core_.Window_IsShown(*args, **kwargs)
8596
8597 def IsEnabled(*args, **kwargs):
8598 """
8599 IsEnabled(self) -> bool
8600
8601 Returns true if the window is enabled for input, false otherwise.
8602 """
8603 return _core_.Window_IsEnabled(*args, **kwargs)
8604
33d6fd3b
RD
8605 def IsShownOnScreen(*args, **kwargs):
8606 """
8607 IsShownOnScreen(self) -> bool
8608
8609 Returns ``True`` if the window is physically visible on the screen,
8610 i.e. it is shown and all its parents up to the toplevel window are
8611 shown as well.
8612 """
8613 return _core_.Window_IsShownOnScreen(*args, **kwargs)
8614
d55e5bfc
RD
8615 def SetWindowStyleFlag(*args, **kwargs):
8616 """
8617 SetWindowStyleFlag(self, long style)
8618
79fccf9d
RD
8619 Sets the style of the window. Please note that some styles cannot be
8620 changed after the window creation and that Refresh() might need to be
8621 called after changing the others for the change to take place
8622 immediately.
d55e5bfc
RD
8623 """
8624 return _core_.Window_SetWindowStyleFlag(*args, **kwargs)
8625
8626 def GetWindowStyleFlag(*args, **kwargs):
8627 """
8628 GetWindowStyleFlag(self) -> long
8629
8630 Gets the window style that was passed to the constructor or Create
8631 method.
8632 """
8633 return _core_.Window_GetWindowStyleFlag(*args, **kwargs)
8634
8635 SetWindowStyle = SetWindowStyleFlag; GetWindowStyle = GetWindowStyleFlag
8636 def HasFlag(*args, **kwargs):
8637 """
8638 HasFlag(self, int flag) -> bool
8639
8640 Test if the given style is set for this window.
8641 """
8642 return _core_.Window_HasFlag(*args, **kwargs)
8643
8644 def IsRetained(*args, **kwargs):
8645 """
8646 IsRetained(self) -> bool
8647
8648 Returns true if the window is retained, false otherwise. Retained
8649 windows are only available on X platforms.
8650 """
8651 return _core_.Window_IsRetained(*args, **kwargs)
8652
8653 def SetExtraStyle(*args, **kwargs):
8654 """
8655 SetExtraStyle(self, long exStyle)
8656
8657 Sets the extra style bits for the window. Extra styles are the less
8658 often used style bits which can't be set with the constructor or with
8659 SetWindowStyleFlag()
8660 """
8661 return _core_.Window_SetExtraStyle(*args, **kwargs)
8662
8663 def GetExtraStyle(*args, **kwargs):
8664 """
8665 GetExtraStyle(self) -> long
8666
8667 Returns the extra style bits for the window.
8668 """
8669 return _core_.Window_GetExtraStyle(*args, **kwargs)
8670
8671 def MakeModal(*args, **kwargs):
8672 """
8673 MakeModal(self, bool modal=True)
8674
8675 Disables all other windows in the application so that the user can
8676 only interact with this window. Passing False will reverse this
8677 effect.
8678 """
8679 return _core_.Window_MakeModal(*args, **kwargs)
8680
8681 def SetThemeEnabled(*args, **kwargs):
8682 """
8683 SetThemeEnabled(self, bool enableTheme)
8684
8685 This function tells a window if it should use the system's "theme"
8686 code to draw the windows' background instead if its own background
8687 drawing code. This will only have an effect on platforms that support
8688 the notion of themes in user defined windows. One such platform is
8689 GTK+ where windows can have (very colourful) backgrounds defined by a
8690 user's selected theme.
8691
8692 Dialogs, notebook pages and the status bar have this flag set to true
8693 by default so that the default look and feel is simulated best.
8694 """
8695 return _core_.Window_SetThemeEnabled(*args, **kwargs)
8696
8697 def GetThemeEnabled(*args, **kwargs):
8698 """
8699 GetThemeEnabled(self) -> bool
8700
8701 Return the themeEnabled flag.
8702 """
8703 return _core_.Window_GetThemeEnabled(*args, **kwargs)
8704
8705 def SetFocus(*args, **kwargs):
8706 """
8707 SetFocus(self)
8708
8709 Set's the focus to this window, allowing it to receive keyboard input.
8710 """
8711 return _core_.Window_SetFocus(*args, **kwargs)
8712
8713 def SetFocusFromKbd(*args, **kwargs):
8714 """
8715 SetFocusFromKbd(self)
8716
8717 Set focus to this window as the result of a keyboard action. Normally
8718 only called internally.
8719 """
8720 return _core_.Window_SetFocusFromKbd(*args, **kwargs)
8721
8722 def FindFocus(*args, **kwargs):
8723 """
c24da6d6 8724 FindFocus() -> Window
d55e5bfc
RD
8725
8726 Returns the window or control that currently has the keyboard focus,
8727 or None.
8728 """
8729 return _core_.Window_FindFocus(*args, **kwargs)
8730
8731 FindFocus = staticmethod(FindFocus)
8732 def AcceptsFocus(*args, **kwargs):
8733 """
8734 AcceptsFocus(self) -> bool
8735
8736 Can this window have focus?
8737 """
8738 return _core_.Window_AcceptsFocus(*args, **kwargs)
8739
8740 def AcceptsFocusFromKeyboard(*args, **kwargs):
8741 """
8742 AcceptsFocusFromKeyboard(self) -> bool
8743
8744 Can this window be given focus by keyboard navigation? if not, the
8745 only way to give it focus (provided it accepts it at all) is to click
8746 it.
8747 """
8748 return _core_.Window_AcceptsFocusFromKeyboard(*args, **kwargs)
8749
908b74cd
RD
8750 def Navigate(*args, **kwargs):
8751 """
8752 Navigate(self, int flags=NavigationKeyEvent.IsForward) -> bool
8753
a8eff060
RD
8754 Does keyboard navigation from this window to another, by sending a
8755 `wx.NavigationKeyEvent`.
908b74cd
RD
8756 """
8757 return _core_.Window_Navigate(*args, **kwargs)
8758
bf26d883
RD
8759 def MoveAfterInTabOrder(*args, **kwargs):
8760 """
8761 MoveAfterInTabOrder(self, Window win)
8762
8763 Moves this window in the tab navigation order after the specified
8764 sibling window. This means that when the user presses the TAB key on
8765 that other window, the focus switches to this window.
8766
8767 The default tab order is the same as creation order. This function
8768 and `MoveBeforeInTabOrder` allow to change it after creating all the
8769 windows.
8770
8771 """
8772 return _core_.Window_MoveAfterInTabOrder(*args, **kwargs)
8773
8774 def MoveBeforeInTabOrder(*args, **kwargs):
8775 """
8776 MoveBeforeInTabOrder(self, Window win)
8777
8778 Same as `MoveAfterInTabOrder` except that it inserts this window just
8779 before win instead of putting it right after it.
8780 """
8781 return _core_.Window_MoveBeforeInTabOrder(*args, **kwargs)
8782
d55e5bfc
RD
8783 def GetChildren(*args, **kwargs):
8784 """
8785 GetChildren(self) -> PyObject
8786
8787 Returns a list of the window's children. NOTE: Currently this is a
8788 copy of the child window list maintained by the window, so the return
8789 value of this function is only valid as long as the window's children
8790 do not change.
8791 """
8792 return _core_.Window_GetChildren(*args, **kwargs)
8793
8794 def GetParent(*args, **kwargs):
8795 """
8796 GetParent(self) -> Window
8797
8798 Returns the parent window of this window, or None if there isn't one.
8799 """
8800 return _core_.Window_GetParent(*args, **kwargs)
8801
8802 def GetGrandParent(*args, **kwargs):
8803 """
8804 GetGrandParent(self) -> Window
8805
79fccf9d
RD
8806 Returns the parent of the parent of this window, or None if there
8807 isn't one.
d55e5bfc
RD
8808 """
8809 return _core_.Window_GetGrandParent(*args, **kwargs)
8810
8811 def IsTopLevel(*args, **kwargs):
8812 """
8813 IsTopLevel(self) -> bool
8814
8815 Returns true if the given window is a top-level one. Currently all
8816 frames and dialogs are always considered to be top-level windows (even
8817 if they have a parent window).
8818 """
8819 return _core_.Window_IsTopLevel(*args, **kwargs)
8820
8821 def Reparent(*args, **kwargs):
8822 """
8823 Reparent(self, Window newParent) -> bool
8824
8825 Reparents the window, i.e the window will be removed from its current
8826 parent window (e.g. a non-standard toolbar in a wxFrame) and then
8827 re-inserted into another. Available on Windows and GTK. Returns True
8828 if the parent was changed, False otherwise (error or newParent ==
8829 oldParent)
8830 """
8831 return _core_.Window_Reparent(*args, **kwargs)
8832
8833 def AddChild(*args, **kwargs):
8834 """
8835 AddChild(self, Window child)
8836
8837 Adds a child window. This is called automatically by window creation
8838 functions so should not be required by the application programmer.
8839 """
8840 return _core_.Window_AddChild(*args, **kwargs)
8841
8842 def RemoveChild(*args, **kwargs):
8843 """
8844 RemoveChild(self, Window child)
8845
8846 Removes a child window. This is called automatically by window
8847 deletion functions so should not be required by the application
8848 programmer.
8849 """
8850 return _core_.Window_RemoveChild(*args, **kwargs)
8851
704eda0c
RD
8852 def SetDoubleBuffered(*args, **kwargs):
8853 """
8854 SetDoubleBuffered(self, bool on)
8855
8856 Currently wxGTK2 only.
8857 """
8858 return _core_.Window_SetDoubleBuffered(*args, **kwargs)
8859
d55e5bfc
RD
8860 def FindWindowById(*args, **kwargs):
8861 """
8862 FindWindowById(self, long winid) -> Window
8863
8864 Find a chld of this window by window ID
8865 """
8866 return _core_.Window_FindWindowById(*args, **kwargs)
8867
8868 def FindWindowByName(*args, **kwargs):
8869 """
8870 FindWindowByName(self, String name) -> Window
8871
8872 Find a child of this window by name
8873 """
8874 return _core_.Window_FindWindowByName(*args, **kwargs)
8875
8876 def GetEventHandler(*args, **kwargs):
8877 """
8878 GetEventHandler(self) -> EvtHandler
8879
8880 Returns the event handler for this window. By default, the window is
8881 its own event handler.
8882 """
8883 return _core_.Window_GetEventHandler(*args, **kwargs)
8884
8885 def SetEventHandler(*args, **kwargs):
8886 """
8887 SetEventHandler(self, EvtHandler handler)
8888
8889 Sets the event handler for this window. An event handler is an object
d49bdf34
RD
8890 that is capable of processing the events sent to a window. (In other
8891 words, is able to dispatch the events to handler function.) By
8892 default, the window is its own event handler, but an application may
8893 wish to substitute another, for example to allow central
8894 implementation of event-handling for a variety of different window
8895 classes.
d55e5bfc 8896
79fccf9d 8897 It is usually better to use `wx.Window.PushEventHandler` since this sets
d55e5bfc 8898 up a chain of event handlers, where an event not handled by one event
d49bdf34 8899 handler is handed off to the next one in the chain.
d55e5bfc
RD
8900 """
8901 return _core_.Window_SetEventHandler(*args, **kwargs)
8902
8903 def PushEventHandler(*args, **kwargs):
8904 """
8905 PushEventHandler(self, EvtHandler handler)
8906
8907 Pushes this event handler onto the event handler stack for the window.
8908 An event handler is an object that is capable of processing the events
d49bdf34
RD
8909 sent to a window. (In other words, is able to dispatch the events to
8910 handler function.) By default, the window is its own event handler,
8911 but an application may wish to substitute another, for example to
8912 allow central implementation of event-handling for a variety of
8913 different window classes.
d55e5bfc
RD
8914
8915 wx.Window.PushEventHandler allows an application to set up a chain of
8916 event handlers, where an event not handled by one event handler is
d49bdf34
RD
8917 handed to the next one in the chain. Use `wx.Window.PopEventHandler`
8918 to remove the event handler. Ownership of the handler is *not* given
8919 to the window, so you should be sure to pop the handler before the
8920 window is destroyed and either let PopEventHandler destroy it, or call
8921 its Destroy method yourself.
d55e5bfc
RD
8922 """
8923 return _core_.Window_PushEventHandler(*args, **kwargs)
8924
8925 def PopEventHandler(*args, **kwargs):
8926 """
8927 PopEventHandler(self, bool deleteHandler=False) -> EvtHandler
8928
8929 Removes and returns the top-most event handler on the event handler
8930 stack. If deleteHandler is True then the wx.EvtHandler object will be
d49bdf34 8931 destroyed after it is popped, and ``None`` will be returned instead.
d55e5bfc
RD
8932 """
8933 return _core_.Window_PopEventHandler(*args, **kwargs)
8934
8935 def RemoveEventHandler(*args, **kwargs):
8936 """
8937 RemoveEventHandler(self, EvtHandler handler) -> bool
8938
79fccf9d 8939 Find the given handler in the event handler chain and remove (but not
d49bdf34 8940 delete) it from the event handler chain, returns True if it was found
79fccf9d
RD
8941 and False otherwise (this also results in an assert failure so this
8942 function should only be called when the handler is supposed to be
8943 there.)
d55e5bfc
RD
8944 """
8945 return _core_.Window_RemoveEventHandler(*args, **kwargs)
8946
8947 def SetValidator(*args, **kwargs):
8948 """
8949 SetValidator(self, Validator validator)
8950
8951 Deletes the current validator (if any) and sets the window validator,
8952 having called wx.Validator.Clone to create a new validator of this
8953 type.
8954 """
8955 return _core_.Window_SetValidator(*args, **kwargs)
8956
8957 def GetValidator(*args, **kwargs):
8958 """
8959 GetValidator(self) -> Validator
8960
8961 Returns a pointer to the current validator for the window, or None if
8962 there is none.
8963 """
8964 return _core_.Window_GetValidator(*args, **kwargs)
8965
8966 def Validate(*args, **kwargs):
8967 """
8968 Validate(self) -> bool
8969
8970 Validates the current values of the child controls using their
79fccf9d
RD
8971 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
8972 style flag set, the method will also call Validate() of all child
8973 windows. Returns false if any of the validations failed.
d55e5bfc
RD
8974 """
8975 return _core_.Window_Validate(*args, **kwargs)
8976
8977 def TransferDataToWindow(*args, **kwargs):
8978 """
8979 TransferDataToWindow(self) -> bool
8980
79fccf9d
RD
8981 Transfers values to child controls from data areas specified by their
8982 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
8983 style flag set, the method will also call TransferDataToWindow() of
8984 all child windows.
d55e5bfc
RD
8985 """
8986 return _core_.Window_TransferDataToWindow(*args, **kwargs)
8987
8988 def TransferDataFromWindow(*args, **kwargs):
8989 """
8990 TransferDataFromWindow(self) -> bool
8991
79fccf9d
RD
8992 Transfers values from child controls to data areas specified by their
8993 validators. Returns false if a transfer failed. If the window has
8994 wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will
8995 also call TransferDataFromWindow() of all child windows.
d55e5bfc
RD
8996 """
8997 return _core_.Window_TransferDataFromWindow(*args, **kwargs)
8998
8999 def InitDialog(*args, **kwargs):
9000 """
9001 InitDialog(self)
9002
79fccf9d
RD
9003 Sends an EVT_INIT_DIALOG event, whose handler usually transfers data
9004 to the dialog via validators.
d55e5bfc
RD
9005 """
9006 return _core_.Window_InitDialog(*args, **kwargs)
9007
9008 def SetAcceleratorTable(*args, **kwargs):
9009 """
9010 SetAcceleratorTable(self, AcceleratorTable accel)
9011
9012 Sets the accelerator table for this window.
9013 """
9014 return _core_.Window_SetAcceleratorTable(*args, **kwargs)
9015
9016 def GetAcceleratorTable(*args, **kwargs):
9017 """
9018 GetAcceleratorTable(self) -> AcceleratorTable
9019
9020 Gets the accelerator table for this window.
9021 """
9022 return _core_.Window_GetAcceleratorTable(*args, **kwargs)
9023
9024 def RegisterHotKey(*args, **kwargs):
9025 """
9026 RegisterHotKey(self, int hotkeyId, int modifiers, int keycode) -> bool
9027
9028 Registers a system wide hotkey. Every time the user presses the hotkey
9029 registered here, this window will receive a hotkey event. It will
9030 receive the event even if the application is in the background and
9031 does not have the input focus because the user is working with some
9032 other application. To bind an event handler function to this hotkey
9033 use EVT_HOTKEY with an id equal to hotkeyId. Returns True if the
9034 hotkey was registered successfully.
9035 """
9036 return _core_.Window_RegisterHotKey(*args, **kwargs)
9037
9038 def UnregisterHotKey(*args, **kwargs):
9039 """
9040 UnregisterHotKey(self, int hotkeyId) -> bool
9041
9042 Unregisters a system wide hotkey.
9043 """
9044 return _core_.Window_UnregisterHotKey(*args, **kwargs)
9045
9046 def ConvertDialogPointToPixels(*args, **kwargs):
9047 """
9048 ConvertDialogPointToPixels(self, Point pt) -> Point
9049
9050 Converts a point or size from dialog units to pixels. Dialog units
9051 are used for maintaining a dialog's proportions even if the font
9052 changes. For the x dimension, the dialog units are multiplied by the
9053 average character width and then divided by 4. For the y dimension,
9054 the dialog units are multiplied by the average character height and
9055 then divided by 8.
9056 """
9057 return _core_.Window_ConvertDialogPointToPixels(*args, **kwargs)
9058
9059 def ConvertDialogSizeToPixels(*args, **kwargs):
9060 """
9061 ConvertDialogSizeToPixels(self, Size sz) -> Size
9062
9063 Converts a point or size from dialog units to pixels. Dialog units
9064 are used for maintaining a dialog's proportions even if the font
9065 changes. For the x dimension, the dialog units are multiplied by the
9066 average character width and then divided by 4. For the y dimension,
9067 the dialog units are multiplied by the average character height and
9068 then divided by 8.
9069 """
9070 return _core_.Window_ConvertDialogSizeToPixels(*args, **kwargs)
9071
9072 def DLG_PNT(*args, **kwargs):
9073 """
9074 DLG_PNT(self, Point pt) -> Point
9075
9076 Converts a point or size from dialog units to pixels. Dialog units
9077 are used for maintaining a dialog's proportions even if the font
9078 changes. For the x dimension, the dialog units are multiplied by the
9079 average character width and then divided by 4. For the y dimension,
9080 the dialog units are multiplied by the average character height and
9081 then divided by 8.
9082 """
9083 return _core_.Window_DLG_PNT(*args, **kwargs)
9084
9085 def DLG_SZE(*args, **kwargs):
9086 """
9087 DLG_SZE(self, Size sz) -> Size
9088
9089 Converts a point or size from dialog units to pixels. Dialog units
9090 are used for maintaining a dialog's proportions even if the font
9091 changes. For the x dimension, the dialog units are multiplied by the
9092 average character width and then divided by 4. For the y dimension,
9093 the dialog units are multiplied by the average character height and
9094 then divided by 8.
9095 """
9096 return _core_.Window_DLG_SZE(*args, **kwargs)
9097
9098 def ConvertPixelPointToDialog(*args, **kwargs):
9099 """ConvertPixelPointToDialog(self, Point pt) -> Point"""
9100 return _core_.Window_ConvertPixelPointToDialog(*args, **kwargs)
9101
9102 def ConvertPixelSizeToDialog(*args, **kwargs):
9103 """ConvertPixelSizeToDialog(self, Size sz) -> Size"""
9104 return _core_.Window_ConvertPixelSizeToDialog(*args, **kwargs)
9105
9106 def WarpPointer(*args, **kwargs):
9107 """
9108 WarpPointer(self, int x, int y)
9109
9110 Moves the pointer to the given position on the window.
9111
9112 NOTE: This function is not supported under Mac because Apple Human
9113 Interface Guidelines forbid moving the mouse cursor programmatically.
9114 """
9115 return _core_.Window_WarpPointer(*args, **kwargs)
9116
9117 def CaptureMouse(*args, **kwargs):
9118 """
9119 CaptureMouse(self)
9120
9121 Directs all mouse input to this window. Call wx.Window.ReleaseMouse to
9122 release the capture.
9123
9124 Note that wxWindows maintains the stack of windows having captured the
9125 mouse and when the mouse is released the capture returns to the window
9126 which had had captured it previously and it is only really released if
9127 there were no previous window. In particular, this means that you must
0f83f5da
RD
9128 release the mouse as many times as you capture it, unless the window
9129 receives the `wx.MouseCaptureLostEvent` event.
9130
9131 Any application which captures the mouse in the beginning of some
9132 operation *must* handle `wx.MouseCaptureLostEvent` and cancel this
9133 operation when it receives the event. The event handler must not
9134 recapture mouse.
d55e5bfc
RD
9135 """
9136 return _core_.Window_CaptureMouse(*args, **kwargs)
9137
9138 def ReleaseMouse(*args, **kwargs):
9139 """
9140 ReleaseMouse(self)
9141
9142 Releases mouse input captured with wx.Window.CaptureMouse.
9143 """
9144 return _core_.Window_ReleaseMouse(*args, **kwargs)
9145
9146 def GetCapture(*args, **kwargs):
9147 """
c24da6d6 9148 GetCapture() -> Window
d55e5bfc
RD
9149
9150 Returns the window which currently captures the mouse or None
9151 """
9152 return _core_.Window_GetCapture(*args, **kwargs)
9153
9154 GetCapture = staticmethod(GetCapture)
9155 def HasCapture(*args, **kwargs):
9156 """
9157 HasCapture(self) -> bool
9158
9159 Returns true if this window has the current mouse capture.
9160 """
9161 return _core_.Window_HasCapture(*args, **kwargs)
9162
9163 def Refresh(*args, **kwargs):
9164 """
9165 Refresh(self, bool eraseBackground=True, Rect rect=None)
9166
9167 Mark the specified rectangle (or the whole window) as "dirty" so it
9168 will be repainted. Causes an EVT_PAINT event to be generated and sent
9169 to the window.
9170 """
9171 return _core_.Window_Refresh(*args, **kwargs)
9172
9173 def RefreshRect(*args, **kwargs):
9174 """
fef4c27a 9175 RefreshRect(self, Rect rect, bool eraseBackground=True)
d55e5bfc
RD
9176
9177 Redraws the contents of the given rectangle: the area inside it will
9178 be repainted. This is the same as Refresh but has a nicer syntax.
9179 """
9180 return _core_.Window_RefreshRect(*args, **kwargs)
9181
9182 def Update(*args, **kwargs):
9183 """
9184 Update(self)
9185
9186 Calling this method immediately repaints the invalidated area of the
9187 window instead of waiting for the EVT_PAINT event to happen, (normally
9188 this would usually only happen when the flow of control returns to the
9189 event loop.) Notice that this function doesn't refresh the window and
9b940138 9190 does nothing if the window has been already repainted. Use `Refresh`
d55e5bfc
RD
9191 first if you want to immediately redraw the window (or some portion of
9192 it) unconditionally.
9193 """
9194 return _core_.Window_Update(*args, **kwargs)
9195
9196 def ClearBackground(*args, **kwargs):
9197 """
9198 ClearBackground(self)
9199
9200 Clears the window by filling it with the current background
9201 colour. Does not cause an erase background event to be generated.
9202 """
9203 return _core_.Window_ClearBackground(*args, **kwargs)
9204
9205 def Freeze(*args, **kwargs):
9206 """
9207 Freeze(self)
9208
79fccf9d
RD
9209 Freezes the window or, in other words, prevents any updates from
9210 taking place on screen, the window is not redrawn at all. Thaw must be
9211 called to reenable window redrawing. Calls to Freeze/Thaw may be
9212 nested, with the actual Thaw being delayed until all the nesting has
9213 been undone.
d55e5bfc
RD
9214
9215 This method is useful for visual appearance optimization (for example,
9216 it is a good idea to use it before inserting large amount of text into
9217 a wxTextCtrl under wxGTK) but is not implemented on all platforms nor
9218 for all controls so it is mostly just a hint to wxWindows and not a
9219 mandatory directive.
9220 """
9221 return _core_.Window_Freeze(*args, **kwargs)
9222
33d6fd3b
RD
9223 def IsFrozen(*args, **kwargs):
9224 """
9225 IsFrozen(self) -> bool
9226
9227 Returns ``True`` if the window has been frozen and not thawed yet.
9228
9229 :see: `Freeze` and `Thaw`
9230 """
9231 return _core_.Window_IsFrozen(*args, **kwargs)
9232
d55e5bfc
RD
9233 def Thaw(*args, **kwargs):
9234 """
9235 Thaw(self)
9236
9237 Reenables window updating after a previous call to Freeze. Calls to
79fccf9d
RD
9238 Freeze/Thaw may be nested, so Thaw must be called the same number of
9239 times that Freeze was before the window will be updated.
d55e5bfc
RD
9240 """
9241 return _core_.Window_Thaw(*args, **kwargs)
9242
9243 def PrepareDC(*args, **kwargs):
9244 """
9245 PrepareDC(self, DC dc)
9246
9247 Call this function to prepare the device context for drawing a
9248 scrolled image. It sets the device origin according to the current
9249 scroll position.
9250 """
9251 return _core_.Window_PrepareDC(*args, **kwargs)
9252
b39fe951
RD
9253 def IsDoubleBuffered(*args, **kwargs):
9254 """
9255 IsDoubleBuffered(self) -> bool
9256
9257 Returns ``True`` if the window contents is double-buffered by the
9258 system, i.e. if any drawing done on the window is really done on a
9259 temporary backing surface and transferred to the screen all at once
9260 later.
9261 """
9262 return _core_.Window_IsDoubleBuffered(*args, **kwargs)
9263
d55e5bfc
RD
9264 def GetUpdateRegion(*args, **kwargs):
9265 """
9266 GetUpdateRegion(self) -> Region
9267
9268 Returns the region specifying which parts of the window have been
9269 damaged. Should only be called within an EVT_PAINT handler.
9270 """
9271 return _core_.Window_GetUpdateRegion(*args, **kwargs)
9272
9273 def GetUpdateClientRect(*args, **kwargs):
9274 """
9275 GetUpdateClientRect(self) -> Rect
9276
9277 Get the update rectangle region bounding box in client coords.
9278 """
9279 return _core_.Window_GetUpdateClientRect(*args, **kwargs)
9280
9281 def IsExposed(*args, **kwargs):
9282 """
9283 IsExposed(self, int x, int y, int w=1, int h=1) -> bool
9284
9285 Returns true if the given point or rectangle area has been exposed
9286 since the last repaint. Call this in an paint event handler to
9287 optimize redrawing by only redrawing those areas, which have been
9288 exposed.
9289 """
9290 return _core_.Window_IsExposed(*args, **kwargs)
9291
9292 def IsExposedPoint(*args, **kwargs):
9293 """
9294 IsExposedPoint(self, Point pt) -> bool
9295
9296 Returns true if the given point or rectangle area has been exposed
9297 since the last repaint. Call this in an paint event handler to
9298 optimize redrawing by only redrawing those areas, which have been
9299 exposed.
9300 """
9301 return _core_.Window_IsExposedPoint(*args, **kwargs)
9302
9303 def IsExposedRect(*args, **kwargs):
9304 """
9305 IsExposedRect(self, Rect rect) -> bool
9306
9307 Returns true if the given point or rectangle area has been exposed
9308 since the last repaint. Call this in an paint event handler to
9309 optimize redrawing by only redrawing those areas, which have been
9310 exposed.
9311 """
9312 return _core_.Window_IsExposedRect(*args, **kwargs)
9313
9314 def GetDefaultAttributes(*args, **kwargs):
9315 """
9316 GetDefaultAttributes(self) -> VisualAttributes
9317
79fccf9d
RD
9318 Get the default attributes for an instance of this class. This is
9319 useful if you want to use the same font or colour in your own control
9320 as in a standard control -- which is a much better idea than hard
9321 coding specific colours or fonts which might look completely out of
caef1a4d 9322 place on the user's system, especially if it uses themes.
d55e5bfc
RD
9323 """
9324 return _core_.Window_GetDefaultAttributes(*args, **kwargs)
9325
9326 def GetClassDefaultAttributes(*args, **kwargs):
9327 """
c24da6d6 9328 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
d55e5bfc 9329
79fccf9d
RD
9330 Get the default attributes for this class. This is useful if you want
9331 to use the same font or colour in your own control as in a standard
9332 control -- which is a much better idea than hard coding specific
caef1a4d
RD
9333 colours or fonts which might look completely out of place on the
9334 user's system, especially if it uses themes.
d55e5bfc
RD
9335
9336 The variant parameter is only relevant under Mac currently and is
79fccf9d 9337 ignore under other platforms. Under Mac, it will change the size of
caef1a4d
RD
9338 the returned font. See `wx.Window.SetWindowVariant` for more about
9339 this.
d55e5bfc
RD
9340 """
9341 return _core_.Window_GetClassDefaultAttributes(*args, **kwargs)
9342
9343 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
9344 def SetBackgroundColour(*args, **kwargs):
9345 """
9346 SetBackgroundColour(self, Colour colour) -> bool
9347
9348 Sets the background colour of the window. Returns True if the colour
9349 was changed. The background colour is usually painted by the default
9350 EVT_ERASE_BACKGROUND event handler function under Windows and
f8167d6e
RD
9351 automatically under GTK. Using `wx.NullColour` will reset the window
9352 to the default background colour.
d55e5bfc 9353
caef1a4d 9354 Note that setting the background colour may not cause an immediate
f8167d6e 9355 refresh, so you may wish to call `ClearBackground` or `Refresh` after
d55e5bfc
RD
9356 calling this function.
9357
f8167d6e
RD
9358 Using this function will disable attempts to use themes for this
9359 window, if the system supports them. Use with care since usually the
9360 themes represent the appearance chosen by the user to be used for all
9361 applications on the system.
d55e5bfc
RD
9362 """
9363 return _core_.Window_SetBackgroundColour(*args, **kwargs)
9364
412d302d
RD
9365 def SetOwnBackgroundColour(*args, **kwargs):
9366 """SetOwnBackgroundColour(self, Colour colour)"""
9367 return _core_.Window_SetOwnBackgroundColour(*args, **kwargs)
d55e5bfc
RD
9368
9369 def SetForegroundColour(*args, **kwargs):
9370 """
9371 SetForegroundColour(self, Colour colour) -> bool
9372
9373 Sets the foreground colour of the window. Returns True is the colour
9374 was changed. The interpretation of foreground colour is dependent on
9375 the window class; it may be the text colour or other colour, or it may
9376 not be used at all.
9377 """
9378 return _core_.Window_SetForegroundColour(*args, **kwargs)
9379
fa47d7a7
VS
9380 def SetOwnForegroundColour(*args, **kwargs):
9381 """SetOwnForegroundColour(self, Colour colour)"""
9382 return _core_.Window_SetOwnForegroundColour(*args, **kwargs)
d55e5bfc
RD
9383
9384 def GetBackgroundColour(*args, **kwargs):
9385 """
9386 GetBackgroundColour(self) -> Colour
9387
9388 Returns the background colour of the window.
9389 """
9390 return _core_.Window_GetBackgroundColour(*args, **kwargs)
9391
9392 def GetForegroundColour(*args, **kwargs):
9393 """
9394 GetForegroundColour(self) -> Colour
9395
9396 Returns the foreground colour of the window. The interpretation of
9397 foreground colour is dependent on the window class; it may be the text
9398 colour or other colour, or it may not be used at all.
9399 """
9400 return _core_.Window_GetForegroundColour(*args, **kwargs)
9401
dcb8fc74
RD
9402 def InheritsBackgroundColour(*args, **kwargs):
9403 """InheritsBackgroundColour(self) -> bool"""
9404 return _core_.Window_InheritsBackgroundColour(*args, **kwargs)
9405
9406 def UseBgCol(*args, **kwargs):
9407 """UseBgCol(self) -> bool"""
9408 return _core_.Window_UseBgCol(*args, **kwargs)
9409
0f63ec68
RD
9410 def SetBackgroundStyle(*args, **kwargs):
9411 """
9412 SetBackgroundStyle(self, int style) -> bool
9413
9414 Returns the background style of the window. The background style
9415 indicates how the background of the window is drawn.
9416
9417 ====================== ========================================
9418 wx.BG_STYLE_SYSTEM The background colour or pattern should
9419 be determined by the system
9420 wx.BG_STYLE_COLOUR The background should be a solid colour
9421 wx.BG_STYLE_CUSTOM The background will be implemented by the
9422 application.
9423 ====================== ========================================
9424
9425 On GTK+, use of wx.BG_STYLE_CUSTOM allows the flicker-free drawing of
9426 a custom background, such as a tiled bitmap. Currently the style has
9427 no effect on other platforms.
9428
9429 :see: `GetBackgroundStyle`, `SetBackgroundColour`
9430 """
9431 return _core_.Window_SetBackgroundStyle(*args, **kwargs)
9432
9433 def GetBackgroundStyle(*args, **kwargs):
9434 """
9435 GetBackgroundStyle(self) -> int
9436
9437 Returns the background style of the window.
9438
9439 :see: `SetBackgroundStyle`
9440 """
9441 return _core_.Window_GetBackgroundStyle(*args, **kwargs)
9442
51b83b37
RD
9443 def HasTransparentBackground(*args, **kwargs):
9444 """
9445 HasTransparentBackground(self) -> bool
9446
9447 Returns True if this window's background is transparent (as, for
9448 example, for `wx.StaticText`) and should show the parent window's
9449 background.
9450
9451 This method is mostly used internally by the library itself and you
9452 normally shouldn't have to call it. You may, however, have to override
9453 it in your custom control classes to ensure that background is painted
9454 correctly.
9455 """
9456 return _core_.Window_HasTransparentBackground(*args, **kwargs)
9457
d55e5bfc
RD
9458 def SetCursor(*args, **kwargs):
9459 """
9460 SetCursor(self, Cursor cursor) -> bool
9461
9462 Sets the window's cursor. Notice that the window cursor also sets it
9463 for the children of the window implicitly.
9464
9465 The cursor may be wx.NullCursor in which case the window cursor will
9466 be reset back to default.
9467 """
9468 return _core_.Window_SetCursor(*args, **kwargs)
9469
9470 def GetCursor(*args, **kwargs):
9471 """
9472 GetCursor(self) -> Cursor
9473
9474 Return the cursor associated with this window.
9475 """
9476 return _core_.Window_GetCursor(*args, **kwargs)
9477
9478 def SetFont(*args, **kwargs):
9479 """
9480 SetFont(self, Font font) -> bool
9481
9482 Sets the font for this window.
9483 """
9484 return _core_.Window_SetFont(*args, **kwargs)
9485
fa47d7a7
VS
9486 def SetOwnFont(*args, **kwargs):
9487 """SetOwnFont(self, Font font)"""
9488 return _core_.Window_SetOwnFont(*args, **kwargs)
d55e5bfc
RD
9489
9490 def GetFont(*args, **kwargs):
9491 """
9492 GetFont(self) -> Font
9493
9494 Returns the default font used for this window.
9495 """
9496 return _core_.Window_GetFont(*args, **kwargs)
9497
9498 def SetCaret(*args, **kwargs):
9499 """
9500 SetCaret(self, Caret caret)
9501
9502 Sets the caret associated with the window.
9503 """
9504 return _core_.Window_SetCaret(*args, **kwargs)
9505
9506 def GetCaret(*args, **kwargs):
9507 """
9508 GetCaret(self) -> Caret
9509
9510 Returns the caret associated with the window.
9511 """
9512 return _core_.Window_GetCaret(*args, **kwargs)
9513
9514 def GetCharHeight(*args, **kwargs):
9515 """
9516 GetCharHeight(self) -> int
9517
9518 Get the (average) character size for the current font.
9519 """
9520 return _core_.Window_GetCharHeight(*args, **kwargs)
9521
9522 def GetCharWidth(*args, **kwargs):
9523 """
9524 GetCharWidth(self) -> int
9525
9526 Get the (average) character size for the current font.
9527 """
9528 return _core_.Window_GetCharWidth(*args, **kwargs)
9529
9530 def GetTextExtent(*args, **kwargs):
a8eff060
RD
9531 """
9532 GetTextExtent(String string) -> (width, height)
9533
9534 Get the width and height of the text using the current font.
9535 """
d55e5bfc
RD
9536 return _core_.Window_GetTextExtent(*args, **kwargs)
9537
9538 def GetFullTextExtent(*args, **kwargs):
9539 """
9540 GetFullTextExtent(String string, Font font=None) ->
9541 (width, height, descent, externalLeading)
9542
9543 Get the width, height, decent and leading of the text using the
9544 current or specified font.
9545 """
9546 return _core_.Window_GetFullTextExtent(*args, **kwargs)
9547
9548 def ClientToScreenXY(*args, **kwargs):
9549 """
9550 ClientToScreenXY(int x, int y) -> (x,y)
9551
9552 Converts to screen coordinates from coordinates relative to this window.
9553 """
9554 return _core_.Window_ClientToScreenXY(*args, **kwargs)
9555
9556 def ScreenToClientXY(*args, **kwargs):
9557 """
9558 ScreenToClientXY(int x, int y) -> (x,y)
9559
9560 Converts from screen to client window coordinates.
9561 """
9562 return _core_.Window_ScreenToClientXY(*args, **kwargs)
9563
9564 def ClientToScreen(*args, **kwargs):
9565 """
9566 ClientToScreen(self, Point pt) -> Point
9567
9568 Converts to screen coordinates from coordinates relative to this window.
9569 """
9570 return _core_.Window_ClientToScreen(*args, **kwargs)
9571
9572 def ScreenToClient(*args, **kwargs):
9573 """
9574 ScreenToClient(self, Point pt) -> Point
9575
9576 Converts from screen to client window coordinates.
9577 """
9578 return _core_.Window_ScreenToClient(*args, **kwargs)
9579
9580 def HitTestXY(*args, **kwargs):
9581 """
9582 HitTestXY(self, int x, int y) -> int
9583
9584 Test where the given (in client coords) point lies
9585 """
9586 return _core_.Window_HitTestXY(*args, **kwargs)
9587
9588 def HitTest(*args, **kwargs):
9589 """
9590 HitTest(self, Point pt) -> int
9591
9592 Test where the given (in client coords) point lies
9593 """
9594 return _core_.Window_HitTest(*args, **kwargs)
9595
9596 def GetBorder(*args):
9597 """
9598 GetBorder(self, long flags) -> int
9599 GetBorder(self) -> int
9600
9601 Get border for the flags of this window
9602 """
9603 return _core_.Window_GetBorder(*args)
9604
9605 def UpdateWindowUI(*args, **kwargs):
9606 """
9607 UpdateWindowUI(self, long flags=UPDATE_UI_NONE)
9608
9609 This function sends EVT_UPDATE_UI events to the window. The particular
9610 implementation depends on the window; for example a wx.ToolBar will
9611 send an update UI event for each toolbar button, and a wx.Frame will
9612 send an update UI event for each menubar menu item. You can call this
9613 function from your application to ensure that your UI is up-to-date at
9614 a particular point in time (as far as your EVT_UPDATE_UI handlers are
9615 concerned). This may be necessary if you have called
5ba5649b 9616 `wx.UpdateUIEvent.SetMode` or `wx.UpdateUIEvent.SetUpdateInterval` to
d55e5bfc
RD
9617 limit the overhead that wxWindows incurs by sending update UI events
9618 in idle time.
d55e5bfc
RD
9619 """
9620 return _core_.Window_UpdateWindowUI(*args, **kwargs)
9621
9622 def PopupMenuXY(*args, **kwargs):
9623 """
7a0b95b0 9624 PopupMenuXY(self, Menu menu, int x=-1, int y=-1) -> bool
d55e5bfc 9625
7a0b95b0
RD
9626 Pops up the given menu at the specified coordinates, relative to this window,
9627 and returns control when the user has dismissed the menu. If a menu item is
9628 selected, the corresponding menu event is generated and will be processed as
9629 usual. If the default position is given then the current position of the
9630 mouse cursor will be used.
d55e5bfc
RD
9631 """
9632 return _core_.Window_PopupMenuXY(*args, **kwargs)
9633
9634 def PopupMenu(*args, **kwargs):
9635 """
7a0b95b0 9636 PopupMenu(self, Menu menu, Point pos=DefaultPosition) -> bool
d55e5bfc 9637
7a0b95b0
RD
9638 Pops up the given menu at the specified coordinates, relative to this window,
9639 and returns control when the user has dismissed the menu. If a menu item is
9640 selected, the corresponding menu event is generated and will be processed as
9641 usual. If the default position is given then the current position of the
9642 mouse cursor will be used.
d55e5bfc
RD
9643 """
9644 return _core_.Window_PopupMenu(*args, **kwargs)
9645
1eeb270e
RD
9646 def HasMultiplePages(*args, **kwargs):
9647 """HasMultiplePages(self) -> bool"""
9648 return _core_.Window_HasMultiplePages(*args, **kwargs)
9649
d55e5bfc
RD
9650 def GetHandle(*args, **kwargs):
9651 """
9652 GetHandle(self) -> long
9653
9654 Returns the platform-specific handle (as a long integer) of the
9655 physical window. Currently on wxMac it returns the handle of the
9656 toplevel parent of the window.
9657 """
9658 return _core_.Window_GetHandle(*args, **kwargs)
9659
629e65c2
RD
9660 def AssociateHandle(*args, **kwargs):
9661 """
9662 AssociateHandle(self, long handle)
9663
9664 Associate the window with a new native handle
9665 """
9666 return _core_.Window_AssociateHandle(*args, **kwargs)
9667
9668 def DissociateHandle(*args, **kwargs):
9669 """
9670 DissociateHandle(self)
9671
9672 Dissociate the current native handle from the window
9673 """
9674 return _core_.Window_DissociateHandle(*args, **kwargs)
9675
d55e5bfc
RD
9676 def OnPaint(*args, **kwargs):
9677 """OnPaint(self, PaintEvent event)"""
9678 return _core_.Window_OnPaint(*args, **kwargs)
9679
9680 def HasScrollbar(*args, **kwargs):
9681 """
9682 HasScrollbar(self, int orient) -> bool
9683
9684 Does the window have the scrollbar for this orientation?
9685 """
9686 return _core_.Window_HasScrollbar(*args, **kwargs)
9687
9688 def SetScrollbar(*args, **kwargs):
9689 """
79fccf9d 9690 SetScrollbar(self, int orientation, int position, int thumbSize, int range,
d55e5bfc
RD
9691 bool refresh=True)
9692
9693 Sets the scrollbar properties of a built-in scrollbar.
d55e5bfc
RD
9694 """
9695 return _core_.Window_SetScrollbar(*args, **kwargs)
9696
9697 def SetScrollPos(*args, **kwargs):
9698 """
9699 SetScrollPos(self, int orientation, int pos, bool refresh=True)
9700
9701 Sets the position of one of the built-in scrollbars.
9702 """
9703 return _core_.Window_SetScrollPos(*args, **kwargs)
9704
9705 def GetScrollPos(*args, **kwargs):
9706 """
9707 GetScrollPos(self, int orientation) -> int
9708
9709 Returns the built-in scrollbar position.
9710 """
9711 return _core_.Window_GetScrollPos(*args, **kwargs)
9712
9713 def GetScrollThumb(*args, **kwargs):
9714 """
9715 GetScrollThumb(self, int orientation) -> int
9716
9717 Returns the built-in scrollbar thumb size.
9718 """
9719 return _core_.Window_GetScrollThumb(*args, **kwargs)
9720
9721 def GetScrollRange(*args, **kwargs):
9722 """
9723 GetScrollRange(self, int orientation) -> int
9724
9725 Returns the built-in scrollbar range.
9726 """
9727 return _core_.Window_GetScrollRange(*args, **kwargs)
9728
9729 def ScrollWindow(*args, **kwargs):
9730 """
9731 ScrollWindow(self, int dx, int dy, Rect rect=None)
9732
9733 Physically scrolls the pixels in the window and move child windows
9734 accordingly. Use this function to optimise your scrolling
9735 implementations, to minimise the area that must be redrawn. Note that
9736 it is rarely required to call this function from a user program.
d55e5bfc
RD
9737 """
9738 return _core_.Window_ScrollWindow(*args, **kwargs)
9739
9740 def ScrollLines(*args, **kwargs):
9741 """
9742 ScrollLines(self, int lines) -> bool
9743
9744 If the platform and window class supports it, scrolls the window by
9745 the given number of lines down, if lines is positive, or up if lines
9746 is negative. Returns True if the window was scrolled, False if it was
9747 already on top/bottom and nothing was done.
9748 """
9749 return _core_.Window_ScrollLines(*args, **kwargs)
9750
9751 def ScrollPages(*args, **kwargs):
9752 """
9753 ScrollPages(self, int pages) -> bool
9754
79fccf9d 9755 If the platform and window class supports it, scrolls the window by
d55e5bfc
RD
9756 the given number of pages down, if pages is positive, or up if pages
9757 is negative. Returns True if the window was scrolled, False if it was
9758 already on top/bottom and nothing was done.
9759 """
9760 return _core_.Window_ScrollPages(*args, **kwargs)
9761
9762 def LineUp(*args, **kwargs):
9763 """
9764 LineUp(self) -> bool
9765
9766 This is just a wrapper for ScrollLines(-1).
9767 """
9768 return _core_.Window_LineUp(*args, **kwargs)
9769
9770 def LineDown(*args, **kwargs):
9771 """
9772 LineDown(self) -> bool
9773
9774 This is just a wrapper for ScrollLines(1).
9775 """
9776 return _core_.Window_LineDown(*args, **kwargs)
9777
9778 def PageUp(*args, **kwargs):
9779 """
9780 PageUp(self) -> bool
9781
9782 This is just a wrapper for ScrollPages(-1).
9783 """
9784 return _core_.Window_PageUp(*args, **kwargs)
9785
9786 def PageDown(*args, **kwargs):
9787 """
9788 PageDown(self) -> bool
9789
9790 This is just a wrapper for ScrollPages(1).
9791 """
9792 return _core_.Window_PageDown(*args, **kwargs)
9793
9794 def SetHelpText(*args, **kwargs):
9795 """
9796 SetHelpText(self, String text)
9797
9798 Sets the help text to be used as context-sensitive help for this
9799 window. Note that the text is actually stored by the current
f52cbe90 9800 `wx.HelpProvider` implementation, and not in the window object itself.
d55e5bfc
RD
9801 """
9802 return _core_.Window_SetHelpText(*args, **kwargs)
9803
9804 def SetHelpTextForId(*args, **kwargs):
9805 """
9806 SetHelpTextForId(self, String text)
9807
9808 Associate this help text with all windows with the same id as this
9809 one.
9810 """
9811 return _core_.Window_SetHelpTextForId(*args, **kwargs)
9812
b850e7f3
RD
9813 def GetHelpTextAtPoint(*args, **kwargs):
9814 """
9815 GetHelpTextAtPoint(self, Point pt, wxHelpEvent::Origin origin) -> String
9816
9817 Get the help string associated with the given position in this window.
9818
9819 Notice that pt may be invalid if event origin is keyboard or unknown
9820 and this method should return the global window help text then
9821
9822 """
9823 return _core_.Window_GetHelpTextAtPoint(*args, **kwargs)
9824
d55e5bfc
RD
9825 def GetHelpText(*args, **kwargs):
9826 """
9827 GetHelpText(self) -> String
9828
9829 Gets the help text to be used as context-sensitive help for this
9830 window. Note that the text is actually stored by the current
f52cbe90 9831 `wx.HelpProvider` implementation, and not in the window object itself.
d55e5bfc
RD
9832 """
9833 return _core_.Window_GetHelpText(*args, **kwargs)
9834
9835 def SetToolTipString(*args, **kwargs):
9836 """
9837 SetToolTipString(self, String tip)
9838
9839 Attach a tooltip to the window.
9840 """
9841 return _core_.Window_SetToolTipString(*args, **kwargs)
9842
9843 def SetToolTip(*args, **kwargs):
9844 """
9845 SetToolTip(self, ToolTip tip)
9846
9847 Attach a tooltip to the window.
9848 """
9849 return _core_.Window_SetToolTip(*args, **kwargs)
9850
9851 def GetToolTip(*args, **kwargs):
9852 """
9853 GetToolTip(self) -> ToolTip
9854
9855 get the associated tooltip or None if none
9856 """
9857 return _core_.Window_GetToolTip(*args, **kwargs)
9858
9859 def SetDropTarget(*args, **kwargs):
9860 """
9861 SetDropTarget(self, DropTarget dropTarget)
9862
9863 Associates a drop target with this window. If the window already has
9864 a drop target, it is deleted.
9865 """
9866 return _core_.Window_SetDropTarget(*args, **kwargs)
9867
9868 def GetDropTarget(*args, **kwargs):
9869 """
9870 GetDropTarget(self) -> DropTarget
9871
9872 Returns the associated drop target, which may be None.
9873 """
9874 return _core_.Window_GetDropTarget(*args, **kwargs)
9875
9876 def DragAcceptFiles(*args, **kwargs):
9877 """
9878 DragAcceptFiles(self, bool accept)
9879
9880 Enables or disables eligibility for drop file events, EVT_DROP_FILES.
5ba5649b 9881 Only functional on Windows.
d55e5bfc
RD
9882 """
9883 return _core_.Window_DragAcceptFiles(*args, **kwargs)
9884
9885 def SetConstraints(*args, **kwargs):
9886 """
9887 SetConstraints(self, LayoutConstraints constraints)
9888
9889 Sets the window to have the given layout constraints. If an existing
9890 layout constraints object is already owned by the window, it will be
9891 deleted. Pass None to disassociate and delete the window's current
9892 constraints.
9893
9894 You must call SetAutoLayout to tell a window to use the constraints
9895 automatically in its default EVT_SIZE handler; otherwise, you must
9896 handle EVT_SIZE yourself and call Layout() explicitly. When setting
9897 both a wx.LayoutConstraints and a wx.Sizer, only the sizer will have
9898 effect.
9899 """
9900 return _core_.Window_SetConstraints(*args, **kwargs)
9901
9902 def GetConstraints(*args, **kwargs):
9903 """
9904 GetConstraints(self) -> LayoutConstraints
9905
9906 Returns a pointer to the window's layout constraints, or None if there
9907 are none.
9908 """
9909 return _core_.Window_GetConstraints(*args, **kwargs)
9910
9911 def SetAutoLayout(*args, **kwargs):
9912 """
9913 SetAutoLayout(self, bool autoLayout)
9914
9915 Determines whether the Layout function will be called automatically
b1fcee84
RD
9916 when the window is resized. lease note that this only happens for the
9917 windows usually used to contain children, namely `wx.Panel` and
9918 `wx.TopLevelWindow` (and the classes deriving from them).
9919
9920 This method is called implicitly by `SetSizer` but if you use
9921 `SetConstraints` you should call it manually or otherwise the window
9922 layout won't be correctly updated when its size changes.
d55e5bfc
RD
9923 """
9924 return _core_.Window_SetAutoLayout(*args, **kwargs)
9925
9926 def GetAutoLayout(*args, **kwargs):
9927 """
9928 GetAutoLayout(self) -> bool
9929
9930 Returns the current autoLayout setting
9931 """
9932 return _core_.Window_GetAutoLayout(*args, **kwargs)
9933
9934 def Layout(*args, **kwargs):
9935 """
9936 Layout(self) -> bool
9937
9938 Invokes the constraint-based layout algorithm or the sizer-based
9939 algorithm for this window. See SetAutoLayout: when auto layout is on,
9940 this function gets called automatically by the default EVT_SIZE
9941 handler when the window is resized.
9942 """
9943 return _core_.Window_Layout(*args, **kwargs)
9944
9945 def SetSizer(*args, **kwargs):
9946 """
9947 SetSizer(self, Sizer sizer, bool deleteOld=True)
9948
9949 Sets the window to have the given layout sizer. The window will then
9950 own the object, and will take care of its deletion. If an existing
9951 layout sizer object is already owned by the window, it will be deleted
9952 if the deleteOld parameter is true. Note that this function will also
9953 call SetAutoLayout implicitly with a True parameter if the sizer is
ae8162c8 9954 non-None, and False otherwise.
d55e5bfc
RD
9955 """
9956 return _core_.Window_SetSizer(*args, **kwargs)
9957
9958 def SetSizerAndFit(*args, **kwargs):
9959 """
9960 SetSizerAndFit(self, Sizer sizer, bool deleteOld=True)
9961
9962 The same as SetSizer, except it also sets the size hints for the
9963 window based on the sizer's minimum size.
9964 """
9965 return _core_.Window_SetSizerAndFit(*args, **kwargs)
9966
9967 def GetSizer(*args, **kwargs):
9968 """
9969 GetSizer(self) -> Sizer
9970
9971 Return the sizer associated with the window by a previous call to
9972 SetSizer or None if there isn't one.
9973 """
9974 return _core_.Window_GetSizer(*args, **kwargs)
9975
9976 def SetContainingSizer(*args, **kwargs):
9977 """
9978 SetContainingSizer(self, Sizer sizer)
9979
9980 This normally does not need to be called by application code. It is
9981 called internally when a window is added to a sizer, and is used so
9982 the window can remove itself from the sizer when it is destroyed.
9983 """
9984 return _core_.Window_SetContainingSizer(*args, **kwargs)
9985
9986 def GetContainingSizer(*args, **kwargs):
9987 """
9988 GetContainingSizer(self) -> Sizer
9989
9990 Return the sizer that this window is a member of, if any, otherwise None.
9991 """
9992 return _core_.Window_GetContainingSizer(*args, **kwargs)
9993
9994 def InheritAttributes(*args, **kwargs):
9995 """
9996 InheritAttributes(self)
9997
79fccf9d
RD
9998 This function is (or should be, in case of custom controls) called
9999 during window creation to intelligently set up the window visual
10000 attributes, that is the font and the foreground and background
10001 colours.
10002
10003 By 'intelligently' the following is meant: by default, all windows use
10004 their own default attributes. However if some of the parent's
10005 attributes are explicitly changed (that is, using SetFont and not
fa47d7a7 10006 SetOwnFont) and if the corresponding attribute hadn't been
79fccf9d
RD
10007 explicitly set for this window itself, then this window takes the same
10008 value as used by the parent. In addition, if the window overrides
10009 ShouldInheritColours to return false, the colours will not be changed
10010 no matter what and only the font might.
10011
ec9b55ca
RD
10012 This rather complicated logic is necessary in order to accommodate the
10013 different usage scenarios. The most common one is when all default
79fccf9d
RD
10014 attributes are used and in this case, nothing should be inherited as
10015 in modern GUIs different controls use different fonts (and colours)
10016 than their siblings so they can't inherit the same value from the
10017 parent. However it was also deemed desirable to allow to simply change
10018 the attributes of all children at once by just changing the font or
10019 colour of their common parent, hence in this case we do inherit the
10020 parents attributes.
10021
d55e5bfc
RD
10022 """
10023 return _core_.Window_InheritAttributes(*args, **kwargs)
10024
10025 def ShouldInheritColours(*args, **kwargs):
10026 """
10027 ShouldInheritColours(self) -> bool
10028
10029 Return true from here to allow the colours of this window to be
79fccf9d
RD
10030 changed by InheritAttributes, returning false forbids inheriting them
10031 from the parent window.
d55e5bfc 10032
79fccf9d
RD
10033 The base class version returns false, but this method is overridden in
10034 wxControl where it returns true.
d55e5bfc
RD
10035 """
10036 return _core_.Window_ShouldInheritColours(*args, **kwargs)
10037
fc46b7f3
RD
10038 def CanSetTransparent(*args, **kwargs):
10039 """
10040 CanSetTransparent(self) -> bool
10041
10042 Returns ``True`` if the platform supports setting the transparency for
10043 this window. Note that this method will err on the side of caution,
10044 so it is possible that this will return ``False`` when it is in fact
10045 possible to set the transparency.
10046
10047 NOTE: On X-windows systems the X server must have the composite
10048 extension loaded, and there must be a composite manager program (such
10049 as xcompmgr) running.
10050 """
10051 return _core_.Window_CanSetTransparent(*args, **kwargs)
10052
10053 def SetTransparent(*args, **kwargs):
10054 """
10055 SetTransparent(self, byte alpha) -> bool
10056
10057 Attempt to set the transparency of this window to the ``alpha`` value,
10058 returns True on success. The ``alpha`` value is an integer in the
10059 range of 0 to 255, where 0 is fully transparent and 255 is fully
10060 opaque.
10061 """
10062 return _core_.Window_SetTransparent(*args, **kwargs)
10063
d55e5bfc
RD
10064 def PostCreate(self, pre):
10065 """
10066 Phase 3 of the 2-phase create <wink!>
10067 Call this method after precreating the window with the 2-phase create method.
10068 """
10069 self.this = pre.this
10070 self.thisown = pre.thisown
10071 pre.thisown = 0
10072 if hasattr(self, '_setOORInfo'):
10073 self._setOORInfo(self)
10074 if hasattr(self, '_setCallbackInfo'):
10075 self._setCallbackInfo(self, self.__class__)
10076
7e08d4ef 10077 def SendSizeEvent(self):
0ef86618 10078 self.GetEventHandler().ProcessEvent(wx.SizeEvent((-1,-1)))
7e08d4ef 10079
226118fc
RD
10080 AcceleratorTable = property(GetAcceleratorTable,SetAcceleratorTable,doc="See `GetAcceleratorTable` and `SetAcceleratorTable`")
10081 AdjustedBestSize = property(GetAdjustedBestSize,doc="See `GetAdjustedBestSize`")
10082 AutoLayout = property(GetAutoLayout,SetAutoLayout,doc="See `GetAutoLayout` and `SetAutoLayout`")
10083 BackgroundColour = property(GetBackgroundColour,SetBackgroundColour,doc="See `GetBackgroundColour` and `SetBackgroundColour`")
10084 BackgroundStyle = property(GetBackgroundStyle,SetBackgroundStyle,doc="See `GetBackgroundStyle` and `SetBackgroundStyle`")
10085 BestFittingSize = property(GetBestFittingSize,SetBestFittingSize,doc="See `GetBestFittingSize` and `SetBestFittingSize`")
10086 BestSize = property(GetBestSize,doc="See `GetBestSize`")
10087 BestVirtualSize = property(GetBestVirtualSize,doc="See `GetBestVirtualSize`")
10088 Border = property(GetBorder,doc="See `GetBorder`")
10089 Caret = property(GetCaret,SetCaret,doc="See `GetCaret` and `SetCaret`")
10090 CharHeight = property(GetCharHeight,doc="See `GetCharHeight`")
10091 CharWidth = property(GetCharWidth,doc="See `GetCharWidth`")
10092 Children = property(GetChildren,doc="See `GetChildren`")
10093 ClientAreaOrigin = property(GetClientAreaOrigin,doc="See `GetClientAreaOrigin`")
10094 ClientRect = property(GetClientRect,SetClientRect,doc="See `GetClientRect` and `SetClientRect`")
10095 ClientSize = property(GetClientSize,SetClientSize,doc="See `GetClientSize` and `SetClientSize`")
10096 Constraints = property(GetConstraints,SetConstraints,doc="See `GetConstraints` and `SetConstraints`")
10097 ContainingSizer = property(GetContainingSizer,SetContainingSizer,doc="See `GetContainingSizer` and `SetContainingSizer`")
10098 Cursor = property(GetCursor,SetCursor,doc="See `GetCursor` and `SetCursor`")
10099 DefaultAttributes = property(GetDefaultAttributes,doc="See `GetDefaultAttributes`")
10100 DropTarget = property(GetDropTarget,SetDropTarget,doc="See `GetDropTarget` and `SetDropTarget`")
10101 EventHandler = property(GetEventHandler,SetEventHandler,doc="See `GetEventHandler` and `SetEventHandler`")
10102 ExtraStyle = property(GetExtraStyle,SetExtraStyle,doc="See `GetExtraStyle` and `SetExtraStyle`")
10103 Font = property(GetFont,SetFont,doc="See `GetFont` and `SetFont`")
10104 ForegroundColour = property(GetForegroundColour,SetForegroundColour,doc="See `GetForegroundColour` and `SetForegroundColour`")
226118fc
RD
10105 GrandParent = property(GetGrandParent,doc="See `GetGrandParent`")
10106 Handle = property(GetHandle,doc="See `GetHandle`")
10107 HelpText = property(GetHelpText,SetHelpText,doc="See `GetHelpText` and `SetHelpText`")
226118fc
RD
10108 Id = property(GetId,SetId,doc="See `GetId` and `SetId`")
10109 Label = property(GetLabel,SetLabel,doc="See `GetLabel` and `SetLabel`")
994453b8 10110 LayoutDirection = property(GetLayoutDirection,SetLayoutDirection,doc="See `GetLayoutDirection` and `SetLayoutDirection`")
226118fc
RD
10111 MaxHeight = property(GetMaxHeight,doc="See `GetMaxHeight`")
10112 MaxSize = property(GetMaxSize,SetMaxSize,doc="See `GetMaxSize` and `SetMaxSize`")
10113 MaxWidth = property(GetMaxWidth,doc="See `GetMaxWidth`")
10114 MinHeight = property(GetMinHeight,doc="See `GetMinHeight`")
10115 MinSize = property(GetMinSize,SetMinSize,doc="See `GetMinSize` and `SetMinSize`")
10116 MinWidth = property(GetMinWidth,doc="See `GetMinWidth`")
10117 Name = property(GetName,SetName,doc="See `GetName` and `SetName`")
10118 Parent = property(GetParent,doc="See `GetParent`")
10119 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
10120 Rect = property(GetRect,SetRect,doc="See `GetRect` and `SetRect`")
10121 ScreenPosition = property(GetScreenPosition,doc="See `GetScreenPosition`")
10122 ScreenRect = property(GetScreenRect,doc="See `GetScreenRect`")
226118fc
RD
10123 Size = property(GetSize,SetSize,doc="See `GetSize` and `SetSize`")
10124 Sizer = property(GetSizer,SetSizer,doc="See `GetSizer` and `SetSizer`")
226118fc
RD
10125 ThemeEnabled = property(GetThemeEnabled,SetThemeEnabled,doc="See `GetThemeEnabled` and `SetThemeEnabled`")
10126 ToolTip = property(GetToolTip,SetToolTip,doc="See `GetToolTip` and `SetToolTip`")
10127 UpdateClientRect = property(GetUpdateClientRect,doc="See `GetUpdateClientRect`")
10128 UpdateRegion = property(GetUpdateRegion,doc="See `GetUpdateRegion`")
10129 Validator = property(GetValidator,SetValidator,doc="See `GetValidator` and `SetValidator`")
10130 VirtualSize = property(GetVirtualSize,SetVirtualSize,doc="See `GetVirtualSize` and `SetVirtualSize`")
10131 WindowStyle = property(GetWindowStyle,SetWindowStyle,doc="See `GetWindowStyle` and `SetWindowStyle`")
10132 WindowStyleFlag = property(GetWindowStyleFlag,SetWindowStyleFlag,doc="See `GetWindowStyleFlag` and `SetWindowStyleFlag`")
10133 WindowVariant = property(GetWindowVariant,SetWindowVariant,doc="See `GetWindowVariant` and `SetWindowVariant`")
97ab0f6a
RD
10134 Shown = property(IsShown,Show,doc="See `IsShown` and `Show`")
10135 Enabled = property(IsEnabled,Enable,doc="See `IsEnabled` and `Enable`")
10136 TopLevel = property(IsTopLevel,doc="See `IsTopLevel`")
2131d850 10137_core_.Window_swigregister(Window)
d55e5bfc
RD
10138
10139def PreWindow(*args, **kwargs):
10140 """
10141 PreWindow() -> Window
10142
10143 Precreate a Window for 2-phase creation.
10144 """
10145 val = _core_.new_PreWindow(*args, **kwargs)
d55e5bfc
RD
10146 return val
10147
554f62e9
RD
10148def Window_NewControlId(*args):
10149 """
d55e5bfc
RD
10150 Window_NewControlId() -> int
10151
10152 Generate a control id for the controls which were not given one.
10153 """
554f62e9 10154 return _core_.Window_NewControlId(*args)
d55e5bfc
RD
10155
10156def Window_NextControlId(*args, **kwargs):
554f62e9 10157 """
d55e5bfc
RD
10158 Window_NextControlId(int winid) -> int
10159
10160 Get the id of the control following the one with the given
79fccf9d 10161 autogenerated) id
d55e5bfc 10162 """
554f62e9 10163 return _core_.Window_NextControlId(*args, **kwargs)
d55e5bfc
RD
10164
10165def Window_PrevControlId(*args, **kwargs):
554f62e9 10166 """
d55e5bfc
RD
10167 Window_PrevControlId(int winid) -> int
10168
10169 Get the id of the control preceding the one with the given
79fccf9d 10170 autogenerated) id
d55e5bfc 10171 """
554f62e9 10172 return _core_.Window_PrevControlId(*args, **kwargs)
d55e5bfc 10173
554f62e9
RD
10174def Window_FindFocus(*args):
10175 """
d55e5bfc
RD
10176 Window_FindFocus() -> Window
10177
10178 Returns the window or control that currently has the keyboard focus,
10179 or None.
10180 """
554f62e9 10181 return _core_.Window_FindFocus(*args)
d55e5bfc 10182
554f62e9
RD
10183def Window_GetCapture(*args):
10184 """
d55e5bfc
RD
10185 Window_GetCapture() -> Window
10186
10187 Returns the window which currently captures the mouse or None
10188 """
554f62e9 10189 return _core_.Window_GetCapture(*args)
d55e5bfc
RD
10190
10191def Window_GetClassDefaultAttributes(*args, **kwargs):
554f62e9 10192 """
d55e5bfc
RD
10193 Window_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
10194
79fccf9d
RD
10195 Get the default attributes for this class. This is useful if you want
10196 to use the same font or colour in your own control as in a standard
10197 control -- which is a much better idea than hard coding specific
caef1a4d
RD
10198 colours or fonts which might look completely out of place on the
10199 user's system, especially if it uses themes.
d55e5bfc
RD
10200
10201 The variant parameter is only relevant under Mac currently and is
79fccf9d 10202 ignore under other platforms. Under Mac, it will change the size of
caef1a4d
RD
10203 the returned font. See `wx.Window.SetWindowVariant` for more about
10204 this.
d55e5bfc 10205 """
554f62e9 10206 return _core_.Window_GetClassDefaultAttributes(*args, **kwargs)
d55e5bfc
RD
10207
10208def DLG_PNT(win, point_or_x, y=None):
10209 """
10210 Convenience function for converting a Point or (x,y) in
10211 dialog units to pixel units.
10212 """
10213 if y is None:
10214 return win.ConvertDialogPointToPixels(point_or_x)
10215 else:
10216 return win.ConvertDialogPointToPixels(wx.Point(point_or_x, y))
10217
10218def DLG_SZE(win, size_width, height=None):
10219 """
10220 Convenience function for converting a Size or (w,h) in
10221 dialog units to pixel units.
10222 """
10223 if height is None:
10224 return win.ConvertDialogSizeToPixels(size_width)
10225 else:
10226 return win.ConvertDialogSizeToPixels(wx.Size(size_width, height))
10227
10228
10229def FindWindowById(*args, **kwargs):
554f62e9 10230 """
d55e5bfc
RD
10231 FindWindowById(long id, Window parent=None) -> Window
10232
10233 Find the first window in the application with the given id. If parent
10234 is None, the search will start from all top-level frames and dialog
10235 boxes; if non-None, the search will be limited to the given window
10236 hierarchy. The search is recursive in both cases.
10237 """
554f62e9 10238 return _core_.FindWindowById(*args, **kwargs)
d55e5bfc
RD
10239
10240def FindWindowByName(*args, **kwargs):
554f62e9 10241 """
d55e5bfc
RD
10242 FindWindowByName(String name, Window parent=None) -> Window
10243
10244 Find a window by its name (as given in a window constructor or Create
10245 function call). If parent is None, the search will start from all
10246 top-level frames and dialog boxes; if non-None, the search will be
10247 limited to the given window hierarchy. The search is recursive in both
10248 cases.
10249
10250 If no window with such name is found, wx.FindWindowByLabel is called.
10251 """
554f62e9 10252 return _core_.FindWindowByName(*args, **kwargs)
d55e5bfc
RD
10253
10254def FindWindowByLabel(*args, **kwargs):
554f62e9 10255 """
d55e5bfc
RD
10256 FindWindowByLabel(String label, Window parent=None) -> Window
10257
10258 Find a window by its label. Depending on the type of window, the label
10259 may be a window title or panel item label. If parent is None, the
10260 search will start from all top-level frames and dialog boxes; if
10261 non-None, the search will be limited to the given window
10262 hierarchy. The search is recursive in both cases.
10263 """
554f62e9 10264 return _core_.FindWindowByLabel(*args, **kwargs)
d55e5bfc
RD
10265
10266def Window_FromHWND(*args, **kwargs):
554f62e9
RD
10267 """Window_FromHWND(Window parent, unsigned long _hWnd) -> Window"""
10268 return _core_.Window_FromHWND(*args, **kwargs)
3215336e 10269
554f62e9
RD
10270def GetTopLevelWindows(*args):
10271 """
3215336e
RD
10272 GetTopLevelWindows() -> PyObject
10273
10274 Returns a list of the the application's top-level windows, (frames,
10275 dialogs, etc.) NOTE: Currently this is a copy of the list maintained
10276 by wxWidgets, and so it is only valid as long as no top-level windows
10277 are closed or new top-level windows are created.
10278
10279 """
554f62e9 10280 return _core_.GetTopLevelWindows(*args)
d55e5bfc
RD
10281#---------------------------------------------------------------------------
10282
10283class Validator(EvtHandler):
093d3ff1 10284 """Proxy of C++ Validator class"""
554f62e9
RD
10285 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10286 __repr__ = _swig_repr
10287 def __init__(self, *args, **kwargs):
d55e5bfc 10288 """__init__(self) -> Validator"""
554f62e9 10289 _core_.Validator_swiginit(self,_core_.new_Validator(*args, **kwargs))
d55e5bfc
RD
10290 self._setOORInfo(self)
10291
10292 def Clone(*args, **kwargs):
10293 """Clone(self) -> Validator"""
10294 return _core_.Validator_Clone(*args, **kwargs)
10295
10296 def Validate(*args, **kwargs):
10297 """Validate(self, Window parent) -> bool"""
10298 return _core_.Validator_Validate(*args, **kwargs)
10299
10300 def TransferToWindow(*args, **kwargs):
10301 """TransferToWindow(self) -> bool"""
10302 return _core_.Validator_TransferToWindow(*args, **kwargs)
10303
10304 def TransferFromWindow(*args, **kwargs):
10305 """TransferFromWindow(self) -> bool"""
10306 return _core_.Validator_TransferFromWindow(*args, **kwargs)
10307
10308 def GetWindow(*args, **kwargs):
10309 """GetWindow(self) -> Window"""
10310 return _core_.Validator_GetWindow(*args, **kwargs)
10311
10312 def SetWindow(*args, **kwargs):
10313 """SetWindow(self, Window window)"""
10314 return _core_.Validator_SetWindow(*args, **kwargs)
10315
10316 def IsSilent(*args, **kwargs):
c24da6d6 10317 """IsSilent() -> bool"""
d55e5bfc
RD
10318 return _core_.Validator_IsSilent(*args, **kwargs)
10319
10320 IsSilent = staticmethod(IsSilent)
10321 def SetBellOnError(*args, **kwargs):
c24da6d6 10322 """SetBellOnError(int doIt=True)"""
d55e5bfc
RD
10323 return _core_.Validator_SetBellOnError(*args, **kwargs)
10324
10325 SetBellOnError = staticmethod(SetBellOnError)
dba7934c 10326 Window = property(GetWindow,SetWindow,doc="See `GetWindow` and `SetWindow`")
2131d850 10327_core_.Validator_swigregister(Validator)
d55e5bfc 10328
554f62e9
RD
10329def Validator_IsSilent(*args):
10330 """Validator_IsSilent() -> bool"""
10331 return _core_.Validator_IsSilent(*args)
d55e5bfc
RD
10332
10333def Validator_SetBellOnError(*args, **kwargs):
554f62e9
RD
10334 """Validator_SetBellOnError(int doIt=True)"""
10335 return _core_.Validator_SetBellOnError(*args, **kwargs)
d55e5bfc
RD
10336
10337class PyValidator(Validator):
093d3ff1 10338 """Proxy of C++ PyValidator class"""
554f62e9
RD
10339 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10340 __repr__ = _swig_repr
10341 def __init__(self, *args, **kwargs):
d55e5bfc 10342 """__init__(self) -> PyValidator"""
554f62e9 10343 _core_.PyValidator_swiginit(self,_core_.new_PyValidator(*args, **kwargs))
d55e5bfc
RD
10344
10345 self._setCallbackInfo(self, PyValidator, 1)
10346 self._setOORInfo(self)
10347
10348 def _setCallbackInfo(*args, **kwargs):
10349 """_setCallbackInfo(self, PyObject self, PyObject _class, int incref=True)"""
10350 return _core_.PyValidator__setCallbackInfo(*args, **kwargs)
10351
2131d850 10352_core_.PyValidator_swigregister(PyValidator)
d55e5bfc
RD
10353
10354#---------------------------------------------------------------------------
10355
10356class Menu(EvtHandler):
093d3ff1 10357 """Proxy of C++ Menu class"""
554f62e9
RD
10358 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10359 __repr__ = _swig_repr
10360 def __init__(self, *args, **kwargs):
d55e5bfc 10361 """__init__(self, String title=EmptyString, long style=0) -> Menu"""
554f62e9 10362 _core_.Menu_swiginit(self,_core_.new_Menu(*args, **kwargs))
d55e5bfc
RD
10363 self._setOORInfo(self)
10364
10365 def Append(*args, **kwargs):
97ab0f6a
RD
10366 """
10367 Append(self, int id, String text=EmptyString, String help=EmptyString,
10368 int kind=ITEM_NORMAL) -> MenuItem
10369 """
d55e5bfc
RD
10370 return _core_.Menu_Append(*args, **kwargs)
10371
10372 def AppendSeparator(*args, **kwargs):
10373 """AppendSeparator(self) -> MenuItem"""
10374 return _core_.Menu_AppendSeparator(*args, **kwargs)
10375
10376 def AppendCheckItem(*args, **kwargs):
10377 """AppendCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10378 return _core_.Menu_AppendCheckItem(*args, **kwargs)
10379
10380 def AppendRadioItem(*args, **kwargs):
10381 """AppendRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10382 return _core_.Menu_AppendRadioItem(*args, **kwargs)
10383
10384 def AppendMenu(*args, **kwargs):
10385 """AppendMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
10386 return _core_.Menu_AppendMenu(*args, **kwargs)
10387
50efceee
RD
10388 def AppendSubMenu(*args, **kwargs):
10389 """AppendSubMenu(self, Menu submenu, String text, String help=EmptyString) -> MenuItem"""
10390 return _core_.Menu_AppendSubMenu(*args, **kwargs)
10391
d55e5bfc
RD
10392 def AppendItem(*args, **kwargs):
10393 """AppendItem(self, MenuItem item) -> MenuItem"""
10394 return _core_.Menu_AppendItem(*args, **kwargs)
10395
d55e5bfc
RD
10396 def InsertItem(*args, **kwargs):
10397 """InsertItem(self, size_t pos, MenuItem item) -> MenuItem"""
10398 return _core_.Menu_InsertItem(*args, **kwargs)
10399
554f62e9
RD
10400 def PrependItem(*args, **kwargs):
10401 """PrependItem(self, MenuItem item) -> MenuItem"""
10402 return _core_.Menu_PrependItem(*args, **kwargs)
10403
10404 def Break(*args, **kwargs):
10405 """Break(self)"""
10406 return _core_.Menu_Break(*args, **kwargs)
10407
d55e5bfc
RD
10408 def Insert(*args, **kwargs):
10409 """
97ab0f6a 10410 Insert(self, size_t pos, int id, String text=EmptyString, String help=EmptyString,
d55e5bfc
RD
10411 int kind=ITEM_NORMAL) -> MenuItem
10412 """
10413 return _core_.Menu_Insert(*args, **kwargs)
10414
10415 def InsertSeparator(*args, **kwargs):
10416 """InsertSeparator(self, size_t pos) -> MenuItem"""
10417 return _core_.Menu_InsertSeparator(*args, **kwargs)
10418
10419 def InsertCheckItem(*args, **kwargs):
10420 """InsertCheckItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
10421 return _core_.Menu_InsertCheckItem(*args, **kwargs)
10422
10423 def InsertRadioItem(*args, **kwargs):
10424 """InsertRadioItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
10425 return _core_.Menu_InsertRadioItem(*args, **kwargs)
10426
10427 def InsertMenu(*args, **kwargs):
10428 """InsertMenu(self, size_t pos, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
10429 return _core_.Menu_InsertMenu(*args, **kwargs)
10430
d55e5bfc 10431 def Prepend(*args, **kwargs):
97ab0f6a
RD
10432 """
10433 Prepend(self, int id, String text=EmptyString, String help=EmptyString,
10434 int kind=ITEM_NORMAL) -> MenuItem
10435 """
d55e5bfc
RD
10436 return _core_.Menu_Prepend(*args, **kwargs)
10437
10438 def PrependSeparator(*args, **kwargs):
10439 """PrependSeparator(self) -> MenuItem"""
10440 return _core_.Menu_PrependSeparator(*args, **kwargs)
10441
10442 def PrependCheckItem(*args, **kwargs):
10443 """PrependCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10444 return _core_.Menu_PrependCheckItem(*args, **kwargs)
10445
10446 def PrependRadioItem(*args, **kwargs):
10447 """PrependRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10448 return _core_.Menu_PrependRadioItem(*args, **kwargs)
10449
10450 def PrependMenu(*args, **kwargs):
10451 """PrependMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
10452 return _core_.Menu_PrependMenu(*args, **kwargs)
10453
10454 def Remove(*args, **kwargs):
10455 """Remove(self, int id) -> MenuItem"""
10456 return _core_.Menu_Remove(*args, **kwargs)
10457
10458 def RemoveItem(*args, **kwargs):
10459 """RemoveItem(self, MenuItem item) -> MenuItem"""
10460 return _core_.Menu_RemoveItem(*args, **kwargs)
10461
10462 def Delete(*args, **kwargs):
10463 """Delete(self, int id) -> bool"""
10464 return _core_.Menu_Delete(*args, **kwargs)
10465
10466 def DeleteItem(*args, **kwargs):
10467 """DeleteItem(self, MenuItem item) -> bool"""
10468 return _core_.Menu_DeleteItem(*args, **kwargs)
10469
10470 def Destroy(*args, **kwargs):
10471 """
10472 Destroy(self)
10473
10474 Deletes the C++ object this Python object is a proxy for.
10475 """
b39fe951
RD
10476 args[0].this.own(False)
10477 return _core_.Menu_Destroy(*args, **kwargs)
d55e5bfc
RD
10478
10479 def DestroyId(*args, **kwargs):
b39fe951
RD
10480 """DestroyId(self, int id) -> bool"""
10481 return _core_.Menu_DestroyId(*args, **kwargs)
d55e5bfc
RD
10482
10483 def DestroyItem(*args, **kwargs):
b39fe951
RD
10484 """DestroyItem(self, MenuItem item) -> bool"""
10485 return _core_.Menu_DestroyItem(*args, **kwargs)
d55e5bfc
RD
10486
10487 def GetMenuItemCount(*args, **kwargs):
10488 """GetMenuItemCount(self) -> size_t"""
10489 return _core_.Menu_GetMenuItemCount(*args, **kwargs)
10490
10491 def GetMenuItems(*args, **kwargs):
10492 """GetMenuItems(self) -> PyObject"""
10493 return _core_.Menu_GetMenuItems(*args, **kwargs)
10494
10495 def FindItem(*args, **kwargs):
10496 """FindItem(self, String item) -> int"""
10497 return _core_.Menu_FindItem(*args, **kwargs)
10498
10499 def FindItemById(*args, **kwargs):
10500 """FindItemById(self, int id) -> MenuItem"""
10501 return _core_.Menu_FindItemById(*args, **kwargs)
10502
10503 def FindItemByPosition(*args, **kwargs):
10504 """FindItemByPosition(self, size_t position) -> MenuItem"""
10505 return _core_.Menu_FindItemByPosition(*args, **kwargs)
10506
10507 def Enable(*args, **kwargs):
10508 """Enable(self, int id, bool enable)"""
10509 return _core_.Menu_Enable(*args, **kwargs)
10510
10511 def IsEnabled(*args, **kwargs):
10512 """IsEnabled(self, int id) -> bool"""
10513 return _core_.Menu_IsEnabled(*args, **kwargs)
10514
10515 def Check(*args, **kwargs):
10516 """Check(self, int id, bool check)"""
10517 return _core_.Menu_Check(*args, **kwargs)
10518
10519 def IsChecked(*args, **kwargs):
10520 """IsChecked(self, int id) -> bool"""
10521 return _core_.Menu_IsChecked(*args, **kwargs)
10522
10523 def SetLabel(*args, **kwargs):
10524 """SetLabel(self, int id, String label)"""
10525 return _core_.Menu_SetLabel(*args, **kwargs)
10526
10527 def GetLabel(*args, **kwargs):
10528 """GetLabel(self, int id) -> String"""
10529 return _core_.Menu_GetLabel(*args, **kwargs)
10530
10531 def SetHelpString(*args, **kwargs):
10532 """SetHelpString(self, int id, String helpString)"""
10533 return _core_.Menu_SetHelpString(*args, **kwargs)
10534
10535 def GetHelpString(*args, **kwargs):
10536 """GetHelpString(self, int id) -> String"""
10537 return _core_.Menu_GetHelpString(*args, **kwargs)
10538
10539 def SetTitle(*args, **kwargs):
10540 """SetTitle(self, String title)"""
10541 return _core_.Menu_SetTitle(*args, **kwargs)
10542
10543 def GetTitle(*args, **kwargs):
10544 """GetTitle(self) -> String"""
10545 return _core_.Menu_GetTitle(*args, **kwargs)
10546
10547 def SetEventHandler(*args, **kwargs):
10548 """SetEventHandler(self, EvtHandler handler)"""
10549 return _core_.Menu_SetEventHandler(*args, **kwargs)
10550
10551 def GetEventHandler(*args, **kwargs):
10552 """GetEventHandler(self) -> EvtHandler"""
10553 return _core_.Menu_GetEventHandler(*args, **kwargs)
10554
10555 def SetInvokingWindow(*args, **kwargs):
10556 """SetInvokingWindow(self, Window win)"""
10557 return _core_.Menu_SetInvokingWindow(*args, **kwargs)
10558
10559 def GetInvokingWindow(*args, **kwargs):
10560 """GetInvokingWindow(self) -> Window"""
10561 return _core_.Menu_GetInvokingWindow(*args, **kwargs)
10562
10563 def GetStyle(*args, **kwargs):
10564 """GetStyle(self) -> long"""
10565 return _core_.Menu_GetStyle(*args, **kwargs)
10566
10567 def UpdateUI(*args, **kwargs):
10568 """UpdateUI(self, EvtHandler source=None)"""
10569 return _core_.Menu_UpdateUI(*args, **kwargs)
10570
10571 def GetMenuBar(*args, **kwargs):
10572 """GetMenuBar(self) -> MenuBar"""
10573 return _core_.Menu_GetMenuBar(*args, **kwargs)
10574
10575 def Attach(*args, **kwargs):
10576 """Attach(self, wxMenuBarBase menubar)"""
10577 return _core_.Menu_Attach(*args, **kwargs)
10578
10579 def Detach(*args, **kwargs):
10580 """Detach(self)"""
10581 return _core_.Menu_Detach(*args, **kwargs)
10582
10583 def IsAttached(*args, **kwargs):
10584 """IsAttached(self) -> bool"""
10585 return _core_.Menu_IsAttached(*args, **kwargs)
10586
10587 def SetParent(*args, **kwargs):
10588 """SetParent(self, Menu parent)"""
10589 return _core_.Menu_SetParent(*args, **kwargs)
10590
10591 def GetParent(*args, **kwargs):
10592 """GetParent(self) -> Menu"""
10593 return _core_.Menu_GetParent(*args, **kwargs)
10594
57332a5a
RD
10595 EventHandler = property(GetEventHandler,SetEventHandler,doc="See `GetEventHandler` and `SetEventHandler`")
10596 HelpString = property(GetHelpString,SetHelpString,doc="See `GetHelpString` and `SetHelpString`")
10597 InvokingWindow = property(GetInvokingWindow,SetInvokingWindow,doc="See `GetInvokingWindow` and `SetInvokingWindow`")
10598 MenuBar = property(GetMenuBar,doc="See `GetMenuBar`")
10599 MenuItemCount = property(GetMenuItemCount,doc="See `GetMenuItemCount`")
10600 MenuItems = property(GetMenuItems,doc="See `GetMenuItems`")
10601 Parent = property(GetParent,SetParent,doc="See `GetParent` and `SetParent`")
10602 Style = property(GetStyle,doc="See `GetStyle`")
10603 Title = property(GetTitle,SetTitle,doc="See `GetTitle` and `SetTitle`")
2131d850 10604_core_.Menu_swigregister(Menu)
d55e5bfc
RD
10605DefaultValidator = cvar.DefaultValidator
10606
10607#---------------------------------------------------------------------------
10608
10609class MenuBar(Window):
093d3ff1 10610 """Proxy of C++ MenuBar class"""
554f62e9
RD
10611 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10612 __repr__ = _swig_repr
10613 def __init__(self, *args, **kwargs):
d55e5bfc 10614 """__init__(self, long style=0) -> MenuBar"""
554f62e9 10615 _core_.MenuBar_swiginit(self,_core_.new_MenuBar(*args, **kwargs))
d55e5bfc
RD
10616 self._setOORInfo(self)
10617
10618 def Append(*args, **kwargs):
10619 """Append(self, Menu menu, String title) -> bool"""
10620 return _core_.MenuBar_Append(*args, **kwargs)
10621
10622 def Insert(*args, **kwargs):
10623 """Insert(self, size_t pos, Menu menu, String title) -> bool"""
10624 return _core_.MenuBar_Insert(*args, **kwargs)
10625
10626 def GetMenuCount(*args, **kwargs):
10627 """GetMenuCount(self) -> size_t"""
10628 return _core_.MenuBar_GetMenuCount(*args, **kwargs)
10629
10630 def GetMenu(*args, **kwargs):
10631 """GetMenu(self, size_t pos) -> Menu"""
10632 return _core_.MenuBar_GetMenu(*args, **kwargs)
10633
10634 def Replace(*args, **kwargs):
10635 """Replace(self, size_t pos, Menu menu, String title) -> Menu"""
10636 return _core_.MenuBar_Replace(*args, **kwargs)
10637
10638 def Remove(*args, **kwargs):
10639 """Remove(self, size_t pos) -> Menu"""
10640 return _core_.MenuBar_Remove(*args, **kwargs)
10641
10642 def EnableTop(*args, **kwargs):
10643 """EnableTop(self, size_t pos, bool enable)"""
10644 return _core_.MenuBar_EnableTop(*args, **kwargs)
10645
10646 def IsEnabledTop(*args, **kwargs):
10647 """IsEnabledTop(self, size_t pos) -> bool"""
10648 return _core_.MenuBar_IsEnabledTop(*args, **kwargs)
10649
10650 def SetLabelTop(*args, **kwargs):
10651 """SetLabelTop(self, size_t pos, String label)"""
10652 return _core_.MenuBar_SetLabelTop(*args, **kwargs)
10653
10654 def GetLabelTop(*args, **kwargs):
10655 """GetLabelTop(self, size_t pos) -> String"""
10656 return _core_.MenuBar_GetLabelTop(*args, **kwargs)
10657
10658 def FindMenuItem(*args, **kwargs):
10659 """FindMenuItem(self, String menu, String item) -> int"""
10660 return _core_.MenuBar_FindMenuItem(*args, **kwargs)
10661
10662 def FindItemById(*args, **kwargs):
10663 """FindItemById(self, int id) -> MenuItem"""
10664 return _core_.MenuBar_FindItemById(*args, **kwargs)
10665
10666 def FindMenu(*args, **kwargs):
10667 """FindMenu(self, String title) -> int"""
10668 return _core_.MenuBar_FindMenu(*args, **kwargs)
10669
10670 def Enable(*args, **kwargs):
10671 """Enable(self, int id, bool enable)"""
10672 return _core_.MenuBar_Enable(*args, **kwargs)
10673
10674 def Check(*args, **kwargs):
10675 """Check(self, int id, bool check)"""
10676 return _core_.MenuBar_Check(*args, **kwargs)
10677
10678 def IsChecked(*args, **kwargs):
10679 """IsChecked(self, int id) -> bool"""
10680 return _core_.MenuBar_IsChecked(*args, **kwargs)
10681
10682 def IsEnabled(*args, **kwargs):
10683 """IsEnabled(self, int id) -> bool"""
10684 return _core_.MenuBar_IsEnabled(*args, **kwargs)
10685
10686 def SetLabel(*args, **kwargs):
10687 """SetLabel(self, int id, String label)"""
10688 return _core_.MenuBar_SetLabel(*args, **kwargs)
10689
10690 def GetLabel(*args, **kwargs):
10691 """GetLabel(self, int id) -> String"""
10692 return _core_.MenuBar_GetLabel(*args, **kwargs)
10693
10694 def SetHelpString(*args, **kwargs):
10695 """SetHelpString(self, int id, String helpString)"""
10696 return _core_.MenuBar_SetHelpString(*args, **kwargs)
10697
10698 def GetHelpString(*args, **kwargs):
10699 """GetHelpString(self, int id) -> String"""
10700 return _core_.MenuBar_GetHelpString(*args, **kwargs)
10701
10702 def GetFrame(*args, **kwargs):
10703 """GetFrame(self) -> wxFrame"""
10704 return _core_.MenuBar_GetFrame(*args, **kwargs)
10705
10706 def IsAttached(*args, **kwargs):
10707 """IsAttached(self) -> bool"""
10708 return _core_.MenuBar_IsAttached(*args, **kwargs)
10709
10710 def Attach(*args, **kwargs):
10711 """Attach(self, wxFrame frame)"""
10712 return _core_.MenuBar_Attach(*args, **kwargs)
10713
10714 def Detach(*args, **kwargs):
10715 """Detach(self)"""
10716 return _core_.MenuBar_Detach(*args, **kwargs)
10717
587d0f36
RD
10718 def UpdateMenus(*args, **kwargs):
10719 """UpdateMenus(self)"""
10720 return _core_.MenuBar_UpdateMenus(*args, **kwargs)
10721
db67f999
RD
10722 def SetAutoWindowMenu(*args, **kwargs):
10723 """SetAutoWindowMenu(bool enable)"""
10724 return _core_.MenuBar_SetAutoWindowMenu(*args, **kwargs)
10725
10726 SetAutoWindowMenu = staticmethod(SetAutoWindowMenu)
10727 def GetAutoWindowMenu(*args, **kwargs):
10728 """GetAutoWindowMenu() -> bool"""
10729 return _core_.MenuBar_GetAutoWindowMenu(*args, **kwargs)
10730
10731 GetAutoWindowMenu = staticmethod(GetAutoWindowMenu)
97ab0f6a
RD
10732 def GetMenus(self):
10733 """Return a list of (menu, label) items for the menus in the MenuBar. """
10734 return [(self.GetMenu(i), self.GetLabelTop(i))
10735 for i in range(self.GetMenuCount())]
10736
10737 def SetMenus(self, items):
10738 """Clear and add new menus to the MenuBar from a list of (menu, label) items. """
10739 for i in range(self.GetMenuCount()-1, -1, -1):
10740 self.Remove(i)
10741 for m, l in items:
10742 self.Append(m, l)
10743
57332a5a
RD
10744 Frame = property(GetFrame,doc="See `GetFrame`")
10745 Menu = property(GetMenu,doc="See `GetMenu`")
10746 MenuCount = property(GetMenuCount,doc="See `GetMenuCount`")
10747 Menus = property(GetMenus,SetMenus,doc="See `GetMenus` and `SetMenus`")
2131d850 10748_core_.MenuBar_swigregister(MenuBar)
d55e5bfc 10749
db67f999 10750def MenuBar_SetAutoWindowMenu(*args, **kwargs):
554f62e9
RD
10751 """MenuBar_SetAutoWindowMenu(bool enable)"""
10752 return _core_.MenuBar_SetAutoWindowMenu(*args, **kwargs)
db67f999 10753
554f62e9
RD
10754def MenuBar_GetAutoWindowMenu(*args):
10755 """MenuBar_GetAutoWindowMenu() -> bool"""
10756 return _core_.MenuBar_GetAutoWindowMenu(*args)
db67f999 10757
d55e5bfc
RD
10758#---------------------------------------------------------------------------
10759
10760class MenuItem(Object):
093d3ff1 10761 """Proxy of C++ MenuItem class"""
554f62e9
RD
10762 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10763 __repr__ = _swig_repr
10764 def __init__(self, *args, **kwargs):
d55e5bfc
RD
10765 """
10766 __init__(self, Menu parentMenu=None, int id=ID_ANY, String text=EmptyString,
10767 String help=EmptyString, int kind=ITEM_NORMAL,
10768 Menu subMenu=None) -> MenuItem
10769 """
554f62e9
RD
10770 _core_.MenuItem_swiginit(self,_core_.new_MenuItem(*args, **kwargs))
10771 __swig_destroy__ = _core_.delete_MenuItem
10772 __del__ = lambda self : None;
d55e5bfc
RD
10773 def GetMenu(*args, **kwargs):
10774 """GetMenu(self) -> Menu"""
10775 return _core_.MenuItem_GetMenu(*args, **kwargs)
10776
10777 def SetMenu(*args, **kwargs):
10778 """SetMenu(self, Menu menu)"""
10779 return _core_.MenuItem_SetMenu(*args, **kwargs)
10780
10781 def SetId(*args, **kwargs):
10782 """SetId(self, int id)"""
10783 return _core_.MenuItem_SetId(*args, **kwargs)
10784
10785 def GetId(*args, **kwargs):
10786 """GetId(self) -> int"""
10787 return _core_.MenuItem_GetId(*args, **kwargs)
10788
10789 def IsSeparator(*args, **kwargs):
10790 """IsSeparator(self) -> bool"""
10791 return _core_.MenuItem_IsSeparator(*args, **kwargs)
10792
10793 def SetText(*args, **kwargs):
10794 """SetText(self, String str)"""
10795 return _core_.MenuItem_SetText(*args, **kwargs)
10796
10797 def GetLabel(*args, **kwargs):
10798 """GetLabel(self) -> String"""
10799 return _core_.MenuItem_GetLabel(*args, **kwargs)
10800
10801 def GetText(*args, **kwargs):
10802 """GetText(self) -> String"""
10803 return _core_.MenuItem_GetText(*args, **kwargs)
10804
10805 def GetLabelFromText(*args, **kwargs):
c24da6d6 10806 """GetLabelFromText(String text) -> String"""
d55e5bfc
RD
10807 return _core_.MenuItem_GetLabelFromText(*args, **kwargs)
10808
10809 GetLabelFromText = staticmethod(GetLabelFromText)
10810 def GetKind(*args, **kwargs):
10811 """GetKind(self) -> int"""
10812 return _core_.MenuItem_GetKind(*args, **kwargs)
10813
10814 def SetKind(*args, **kwargs):
10815 """SetKind(self, int kind)"""
10816 return _core_.MenuItem_SetKind(*args, **kwargs)
10817
10818 def SetCheckable(*args, **kwargs):
10819 """SetCheckable(self, bool checkable)"""
10820 return _core_.MenuItem_SetCheckable(*args, **kwargs)
10821
10822 def IsCheckable(*args, **kwargs):
10823 """IsCheckable(self) -> bool"""
10824 return _core_.MenuItem_IsCheckable(*args, **kwargs)
10825
10826 def IsSubMenu(*args, **kwargs):
10827 """IsSubMenu(self) -> bool"""
10828 return _core_.MenuItem_IsSubMenu(*args, **kwargs)
10829
10830 def SetSubMenu(*args, **kwargs):
10831 """SetSubMenu(self, Menu menu)"""
10832 return _core_.MenuItem_SetSubMenu(*args, **kwargs)
10833
10834 def GetSubMenu(*args, **kwargs):
10835 """GetSubMenu(self) -> Menu"""
10836 return _core_.MenuItem_GetSubMenu(*args, **kwargs)
10837
10838 def Enable(*args, **kwargs):
10839 """Enable(self, bool enable=True)"""
10840 return _core_.MenuItem_Enable(*args, **kwargs)
10841
10842 def IsEnabled(*args, **kwargs):
10843 """IsEnabled(self) -> bool"""
10844 return _core_.MenuItem_IsEnabled(*args, **kwargs)
10845
10846 def Check(*args, **kwargs):
10847 """Check(self, bool check=True)"""
10848 return _core_.MenuItem_Check(*args, **kwargs)
10849
10850 def IsChecked(*args, **kwargs):
10851 """IsChecked(self) -> bool"""
10852 return _core_.MenuItem_IsChecked(*args, **kwargs)
10853
10854 def Toggle(*args, **kwargs):
10855 """Toggle(self)"""
10856 return _core_.MenuItem_Toggle(*args, **kwargs)
10857
10858 def SetHelp(*args, **kwargs):
10859 """SetHelp(self, String str)"""
10860 return _core_.MenuItem_SetHelp(*args, **kwargs)
10861
10862 def GetHelp(*args, **kwargs):
10863 """GetHelp(self) -> String"""
10864 return _core_.MenuItem_GetHelp(*args, **kwargs)
10865
10866 def GetAccel(*args, **kwargs):
10867 """GetAccel(self) -> AcceleratorEntry"""
10868 return _core_.MenuItem_GetAccel(*args, **kwargs)
10869
10870 def SetAccel(*args, **kwargs):
10871 """SetAccel(self, AcceleratorEntry accel)"""
10872 return _core_.MenuItem_SetAccel(*args, **kwargs)
10873
7449af73
RD
10874 def SetBitmap(*args, **kwargs):
10875 """SetBitmap(self, Bitmap bitmap)"""
10876 return _core_.MenuItem_SetBitmap(*args, **kwargs)
10877
10878 def GetBitmap(*args, **kwargs):
10879 """GetBitmap(self) -> Bitmap"""
10880 return _core_.MenuItem_GetBitmap(*args, **kwargs)
10881
d55e5bfc
RD
10882 def SetFont(*args, **kwargs):
10883 """SetFont(self, Font font)"""
10884 return _core_.MenuItem_SetFont(*args, **kwargs)
10885
10886 def GetFont(*args, **kwargs):
10887 """GetFont(self) -> Font"""
10888 return _core_.MenuItem_GetFont(*args, **kwargs)
10889
10890 def SetTextColour(*args, **kwargs):
10891 """SetTextColour(self, Colour colText)"""
10892 return _core_.MenuItem_SetTextColour(*args, **kwargs)
10893
10894 def GetTextColour(*args, **kwargs):
10895 """GetTextColour(self) -> Colour"""
10896 return _core_.MenuItem_GetTextColour(*args, **kwargs)
10897
10898 def SetBackgroundColour(*args, **kwargs):
10899 """SetBackgroundColour(self, Colour colBack)"""
10900 return _core_.MenuItem_SetBackgroundColour(*args, **kwargs)
10901
10902 def GetBackgroundColour(*args, **kwargs):
10903 """GetBackgroundColour(self) -> Colour"""
10904 return _core_.MenuItem_GetBackgroundColour(*args, **kwargs)
10905
10906 def SetBitmaps(*args, **kwargs):
10907 """SetBitmaps(self, Bitmap bmpChecked, Bitmap bmpUnchecked=wxNullBitmap)"""
10908 return _core_.MenuItem_SetBitmaps(*args, **kwargs)
10909
10910 def SetDisabledBitmap(*args, **kwargs):
10911 """SetDisabledBitmap(self, Bitmap bmpDisabled)"""
10912 return _core_.MenuItem_SetDisabledBitmap(*args, **kwargs)
10913
10914 def GetDisabledBitmap(*args, **kwargs):
10915 """GetDisabledBitmap(self) -> Bitmap"""
10916 return _core_.MenuItem_GetDisabledBitmap(*args, **kwargs)
10917
10918 def SetMarginWidth(*args, **kwargs):
10919 """SetMarginWidth(self, int nWidth)"""
10920 return _core_.MenuItem_SetMarginWidth(*args, **kwargs)
10921
10922 def GetMarginWidth(*args, **kwargs):
10923 """GetMarginWidth(self) -> int"""
10924 return _core_.MenuItem_GetMarginWidth(*args, **kwargs)
10925
10926 def GetDefaultMarginWidth(*args, **kwargs):
c24da6d6 10927 """GetDefaultMarginWidth() -> int"""
d55e5bfc
RD
10928 return _core_.MenuItem_GetDefaultMarginWidth(*args, **kwargs)
10929
10930 GetDefaultMarginWidth = staticmethod(GetDefaultMarginWidth)
10931 def IsOwnerDrawn(*args, **kwargs):
10932 """IsOwnerDrawn(self) -> bool"""
10933 return _core_.MenuItem_IsOwnerDrawn(*args, **kwargs)
10934
10935 def SetOwnerDrawn(*args, **kwargs):
10936 """SetOwnerDrawn(self, bool ownerDrawn=True)"""
10937 return _core_.MenuItem_SetOwnerDrawn(*args, **kwargs)
10938
10939 def ResetOwnerDrawn(*args, **kwargs):
10940 """ResetOwnerDrawn(self)"""
10941 return _core_.MenuItem_ResetOwnerDrawn(*args, **kwargs)
10942
57332a5a
RD
10943 Accel = property(GetAccel,SetAccel,doc="See `GetAccel` and `SetAccel`")
10944 BackgroundColour = property(GetBackgroundColour,SetBackgroundColour,doc="See `GetBackgroundColour` and `SetBackgroundColour`")
10945 Bitmap = property(GetBitmap,SetBitmap,doc="See `GetBitmap` and `SetBitmap`")
10946 DisabledBitmap = property(GetDisabledBitmap,SetDisabledBitmap,doc="See `GetDisabledBitmap` and `SetDisabledBitmap`")
10947 Font = property(GetFont,SetFont,doc="See `GetFont` and `SetFont`")
10948 Help = property(GetHelp,SetHelp,doc="See `GetHelp` and `SetHelp`")
10949 Id = property(GetId,SetId,doc="See `GetId` and `SetId`")
10950 Kind = property(GetKind,SetKind,doc="See `GetKind` and `SetKind`")
10951 Label = property(GetLabel,doc="See `GetLabel`")
10952 MarginWidth = property(GetMarginWidth,SetMarginWidth,doc="See `GetMarginWidth` and `SetMarginWidth`")
10953 Menu = property(GetMenu,SetMenu,doc="See `GetMenu` and `SetMenu`")
10954 SubMenu = property(GetSubMenu,SetSubMenu,doc="See `GetSubMenu` and `SetSubMenu`")
10955 Text = property(GetText,SetText,doc="See `GetText` and `SetText`")
10956 TextColour = property(GetTextColour,SetTextColour,doc="See `GetTextColour` and `SetTextColour`")
2131d850 10957_core_.MenuItem_swigregister(MenuItem)
d55e5bfc
RD
10958
10959def MenuItem_GetLabelFromText(*args, **kwargs):
554f62e9
RD
10960 """MenuItem_GetLabelFromText(String text) -> String"""
10961 return _core_.MenuItem_GetLabelFromText(*args, **kwargs)
d55e5bfc 10962
554f62e9
RD
10963def MenuItem_GetDefaultMarginWidth(*args):
10964 """MenuItem_GetDefaultMarginWidth() -> int"""
10965 return _core_.MenuItem_GetDefaultMarginWidth(*args)
d55e5bfc
RD
10966
10967#---------------------------------------------------------------------------
10968
10969class Control(Window):
10970 """
10971 This is the base class for a control or 'widget'.
10972
79fccf9d
RD
10973 A control is generally a small window which processes user input
10974 and/or displays one or more item of data.
d55e5bfc 10975 """
554f62e9
RD
10976 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10977 __repr__ = _swig_repr
10978 def __init__(self, *args, **kwargs):
d55e5bfc 10979 """
248ed943
RD
10980 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
10981 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
d55e5bfc
RD
10982 String name=ControlNameStr) -> Control
10983
79fccf9d
RD
10984 Create a Control. Normally you should only call this from a subclass'
10985 __init__ as a plain old wx.Control is not very useful.
d55e5bfc 10986 """
554f62e9 10987 _core_.Control_swiginit(self,_core_.new_Control(*args, **kwargs))
d55e5bfc
RD
10988 self._setOORInfo(self)
10989
10990 def Create(*args, **kwargs):
10991 """
248ed943
RD
10992 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
10993 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
d55e5bfc
RD
10994 String name=ControlNameStr) -> bool
10995
10996 Do the 2nd phase and create the GUI control.
10997 """
10998 return _core_.Control_Create(*args, **kwargs)
10999
1eeb270e
RD
11000 def GetAlignment(*args, **kwargs):
11001 """
11002 GetAlignment(self) -> int
11003
11004 Get the control alignment (left/right/centre, top/bottom/centre)
11005 """
11006 return _core_.Control_GetAlignment(*args, **kwargs)
11007
0f83f5da 11008 def GetLabelText(*args, **kwargs):
1eeb270e 11009 """
1eeb270e
RD
11010 GetLabelText(self) -> String
11011
11012 Get just the text of the label, without mnemonic characters ('&')
11013 """
0f83f5da 11014 return _core_.Control_GetLabelText(*args, **kwargs)
1eeb270e 11015
d55e5bfc
RD
11016 def Command(*args, **kwargs):
11017 """
11018 Command(self, CommandEvent event)
11019
79fccf9d
RD
11020 Simulates the effect of the user issuing a command to the item.
11021
11022 :see: `wx.CommandEvent`
11023
d55e5bfc
RD
11024 """
11025 return _core_.Control_Command(*args, **kwargs)
11026
a001823c 11027 def GetClassDefaultAttributes(*args, **kwargs):
f8167d6e 11028 """
a001823c 11029 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
f8167d6e 11030
a001823c
RD
11031 Get the default attributes for this class. This is useful if you want
11032 to use the same font or colour in your own control as in a standard
11033 control -- which is a much better idea than hard coding specific
11034 colours or fonts which might look completely out of place on the
11035 user's system, especially if it uses themes.
f8167d6e 11036
a001823c
RD
11037 The variant parameter is only relevant under Mac currently and is
11038 ignore under other platforms. Under Mac, it will change the size of
11039 the returned font. See `wx.Window.SetWindowVariant` for more about
11040 this.
f8167d6e 11041 """
d55e5bfc
RD
11042 return _core_.Control_GetClassDefaultAttributes(*args, **kwargs)
11043
11044 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
226118fc 11045 Alignment = property(GetAlignment,doc="See `GetAlignment`")
226118fc 11046 LabelText = property(GetLabelText,doc="See `GetLabelText`")
2131d850 11047_core_.Control_swigregister(Control)
d55e5bfc
RD
11048ControlNameStr = cvar.ControlNameStr
11049
11050def PreControl(*args, **kwargs):
11051 """
11052 PreControl() -> Control
11053
11054 Precreate a Control control for 2-phase creation
11055 """
11056 val = _core_.new_PreControl(*args, **kwargs)
d55e5bfc
RD
11057 return val
11058
11059def Control_GetClassDefaultAttributes(*args, **kwargs):
554f62e9 11060 """
a001823c
RD
11061 Control_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
11062
11063 Get the default attributes for this class. This is useful if you want
11064 to use the same font or colour in your own control as in a standard
11065 control -- which is a much better idea than hard coding specific
11066 colours or fonts which might look completely out of place on the
11067 user's system, especially if it uses themes.
11068
11069 The variant parameter is only relevant under Mac currently and is
11070 ignore under other platforms. Under Mac, it will change the size of
11071 the returned font. See `wx.Window.SetWindowVariant` for more about
11072 this.
11073 """
554f62e9 11074 return _core_.Control_GetClassDefaultAttributes(*args, **kwargs)
d55e5bfc
RD
11075
11076#---------------------------------------------------------------------------
11077
11078class ItemContainer(object):
11079 """
53aa7709
RD
11080 The wx.ItemContainer class defines an interface which is implemented
11081 by all controls which have string subitems, each of which may be
11082 selected, such as `wx.ListBox`, `wx.CheckListBox`, `wx.Choice` as well
11083 as `wx.ComboBox` which implements an extended interface deriving from
79fccf9d 11084 this one.
d55e5bfc 11085
79fccf9d
RD
11086 It defines the methods for accessing the control's items and although
11087 each of the derived classes implements them differently, they still
11088 all conform to the same interface.
d55e5bfc 11089
79fccf9d
RD
11090 The items in a wx.ItemContainer have (non empty) string labels and,
11091 optionally, client data associated with them.
d55e5bfc
RD
11092
11093 """
554f62e9
RD
11094 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11095 def __init__(self): raise AttributeError, "No constructor defined"
11096 __repr__ = _swig_repr
d55e5bfc
RD
11097 def Append(*args, **kwargs):
11098 """
11099 Append(self, String item, PyObject clientData=None) -> int
11100
79fccf9d
RD
11101 Adds the item to the control, associating the given data with the item
11102 if not None. The return value is the index of the newly added item
11103 which may be different from the last one if the control is sorted (e.g.
11104 has wx.LB_SORT or wx.CB_SORT style).
d55e5bfc
RD
11105 """
11106 return _core_.ItemContainer_Append(*args, **kwargs)
11107
11108 def AppendItems(*args, **kwargs):
11109 """
f5b96ee1 11110 AppendItems(self, List strings)
d55e5bfc 11111
79fccf9d
RD
11112 Apend several items at once to the control. Notice that calling this
11113 method may be much faster than appending the items one by one if you
11114 need to add a lot of items.
d55e5bfc
RD
11115 """
11116 return _core_.ItemContainer_AppendItems(*args, **kwargs)
11117
11118 def Insert(*args, **kwargs):
11119 """
50f151d7 11120 Insert(self, String item, unsigned int pos, PyObject clientData=None) -> int
d55e5bfc 11121
79fccf9d 11122 Insert an item into the control before the item at the ``pos`` index,
d55e5bfc
RD
11123 optionally associating some data object with the item.
11124 """
11125 return _core_.ItemContainer_Insert(*args, **kwargs)
11126
11127 def Clear(*args, **kwargs):
11128 """
11129 Clear(self)
11130
11131 Removes all items from the control.
11132 """
11133 return _core_.ItemContainer_Clear(*args, **kwargs)
11134
11135 def Delete(*args, **kwargs):
11136 """
50f151d7 11137 Delete(self, unsigned int n)
d55e5bfc 11138
79fccf9d
RD
11139 Deletes the item at the zero-based index 'n' from the control. Note
11140 that it is an error (signalled by a `wx.PyAssertionError` exception if
11141 enabled) to remove an item with the index negative or greater or equal
11142 than the number of items in the control.
d55e5bfc
RD
11143 """
11144 return _core_.ItemContainer_Delete(*args, **kwargs)
11145
53aa7709
RD
11146 def GetClientData(*args, **kwargs):
11147 """
50f151d7 11148 GetClientData(self, unsigned int n) -> PyObject
53aa7709
RD
11149
11150 Returns the client data associated with the given item, (if any.)
11151 """
11152 return _core_.ItemContainer_GetClientData(*args, **kwargs)
11153
11154 def SetClientData(*args, **kwargs):
11155 """
50f151d7 11156 SetClientData(self, unsigned int n, PyObject clientData)
53aa7709
RD
11157
11158 Associate the given client data with the item at position n.
11159 """
11160 return _core_.ItemContainer_SetClientData(*args, **kwargs)
11161
d55e5bfc
RD
11162 def GetCount(*args, **kwargs):
11163 """
50f151d7 11164 GetCount(self) -> unsigned int
d55e5bfc
RD
11165
11166 Returns the number of items in the control.
11167 """
11168 return _core_.ItemContainer_GetCount(*args, **kwargs)
11169
11170 def IsEmpty(*args, **kwargs):
11171 """
11172 IsEmpty(self) -> bool
11173
11174 Returns True if the control is empty or False if it has some items.
11175 """
11176 return _core_.ItemContainer_IsEmpty(*args, **kwargs)
11177
11178 def GetString(*args, **kwargs):
11179 """
50f151d7 11180 GetString(self, unsigned int n) -> String
d55e5bfc
RD
11181
11182 Returns the label of the item with the given index.
11183 """
11184 return _core_.ItemContainer_GetString(*args, **kwargs)
11185
11186 def GetStrings(*args, **kwargs):
11187 """GetStrings(self) -> wxArrayString"""
11188 return _core_.ItemContainer_GetStrings(*args, **kwargs)
11189
11190 def SetString(*args, **kwargs):
11191 """
50f151d7 11192 SetString(self, unsigned int n, String s)
d55e5bfc
RD
11193
11194 Sets the label for the given item.
11195 """
11196 return _core_.ItemContainer_SetString(*args, **kwargs)
11197
11198 def FindString(*args, **kwargs):
11199 """
11200 FindString(self, String s) -> int
11201
11202 Finds an item whose label matches the given string. Returns the
79fccf9d
RD
11203 zero-based position of the item, or ``wx.NOT_FOUND`` if the string was not
11204 found.
d55e5bfc
RD
11205 """
11206 return _core_.ItemContainer_FindString(*args, **kwargs)
11207
53aa7709 11208 def SetSelection(*args, **kwargs):
d55e5bfc 11209 """
53aa7709 11210 SetSelection(self, int n)
d55e5bfc
RD
11211
11212 Sets the item at index 'n' to be the selected item.
11213 """
53aa7709 11214 return _core_.ItemContainer_SetSelection(*args, **kwargs)
d55e5bfc 11215
d55e5bfc
RD
11216 def GetSelection(*args, **kwargs):
11217 """
11218 GetSelection(self) -> int
11219
79fccf9d
RD
11220 Returns the index of the selected item or ``wx.NOT_FOUND`` if no item
11221 is selected.
d55e5bfc
RD
11222 """
11223 return _core_.ItemContainer_GetSelection(*args, **kwargs)
11224
53aa7709
RD
11225 def SetStringSelection(*args, **kwargs):
11226 """SetStringSelection(self, String s) -> bool"""
11227 return _core_.ItemContainer_SetStringSelection(*args, **kwargs)
11228
d55e5bfc
RD
11229 def GetStringSelection(*args, **kwargs):
11230 """
11231 GetStringSelection(self) -> String
11232
79fccf9d
RD
11233 Returns the label of the selected item or an empty string if no item
11234 is selected.
d55e5bfc
RD
11235 """
11236 return _core_.ItemContainer_GetStringSelection(*args, **kwargs)
11237
53aa7709 11238 def Select(*args, **kwargs):
d55e5bfc 11239 """
53aa7709 11240 Select(self, int n)
d55e5bfc 11241
53aa7709
RD
11242 This is the same as `SetSelection` and exists only because it is
11243 slightly more natural for controls which support multiple selection.
d55e5bfc 11244 """
53aa7709 11245 return _core_.ItemContainer_Select(*args, **kwargs)
d55e5bfc 11246
97ab0f6a
RD
11247 def GetItems(self):
11248 """Return a list of the strings in the control"""
11249 return [self.GetString(i) for i in xrange(self.GetCount())]
11250
11251 def SetItems(self, items):
11252 """Clear and set the strings in the control from a list"""
11253 self.Clear()
11254 for i in items:
11255 self.Append(i)
11256
11257 Count = property(GetCount,doc="See `GetCount`")
11258 Items = property(GetItems,SetItems,doc="See `GetItems` and `SetItems`")
11259 Selection = property(GetSelection,SetSelection,doc="See `GetSelection` and `SetSelection`")
11260 StringSelection = property(GetStringSelection,SetStringSelection,doc="See `GetStringSelection` and `SetStringSelection`")
11261 Strings = property(GetStrings,doc="See `GetStrings`")
2131d850 11262_core_.ItemContainer_swigregister(ItemContainer)
d55e5bfc
RD
11263
11264#---------------------------------------------------------------------------
11265
11266class ControlWithItems(Control,ItemContainer):
11267 """
79fccf9d
RD
11268 wx.ControlWithItems combines the ``wx.ItemContainer`` class with the
11269 wx.Control class, and is used for the base class of various controls
11270 that have items.
d55e5bfc 11271 """
554f62e9
RD
11272 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11273 def __init__(self): raise AttributeError, "No constructor defined"
11274 __repr__ = _swig_repr
2131d850 11275_core_.ControlWithItems_swigregister(ControlWithItems)
d55e5bfc
RD
11276
11277#---------------------------------------------------------------------------
11278
11279class SizerItem(Object):
248ed943
RD
11280 """
11281 The wx.SizerItem class is used to track the position, size and other
f460c29d
RD
11282 attributes of each item managed by a `wx.Sizer`. It is not usually
11283 necessary to use this class because the sizer elements can also be
11284 identified by their positions or window or sizer references but
11285 sometimes it may be more convenient to use wx.SizerItem directly.
11286 Also, custom classes derived from `wx.PySizer` will probably need to
11287 use the collection of wx.SizerItems held by wx.Sizer when calculating
11288 layout.
248ed943
RD
11289
11290 :see: `wx.Sizer`, `wx.GBSizerItem`
11291 """
554f62e9
RD
11292 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11293 __repr__ = _swig_repr
11294 def __init__(self, *args, **kwargs):
248ed943
RD
11295 """
11296 __init__(self) -> SizerItem
11297
11298 Constructs an empty wx.SizerItem. Either a window, sizer or spacer
11299 size will need to be set before this item can be used in a Sizer.
11300
11301 You will probably never need to create a wx.SizerItem directly as they
11302 are created automatically when the sizer's Add, Insert or Prepend
11303 methods are called.
11304
11305 :see: `wx.SizerItemSpacer`, `wx.SizerItemWindow`, `wx.SizerItemSizer`
11306 """
554f62e9
RD
11307 _core_.SizerItem_swiginit(self,_core_.new_SizerItem(*args, **kwargs))
11308 __swig_destroy__ = _core_.delete_SizerItem
11309 __del__ = lambda self : None;
d55e5bfc 11310 def DeleteWindows(*args, **kwargs):
248ed943
RD
11311 """
11312 DeleteWindows(self)
11313
11314 Destroy the window or the windows in a subsizer, depending on the type
11315 of item.
11316 """
d55e5bfc
RD
11317 return _core_.SizerItem_DeleteWindows(*args, **kwargs)
11318
11319 def DetachSizer(*args, **kwargs):
248ed943
RD
11320 """
11321 DetachSizer(self)
11322
11323 Enable deleting the SizerItem without destroying the contained sizer.
11324 """
d55e5bfc
RD
11325 return _core_.SizerItem_DetachSizer(*args, **kwargs)
11326
11327 def GetSize(*args, **kwargs):
248ed943
RD
11328 """
11329 GetSize(self) -> Size
11330
11331 Get the current size of the item, as set in the last Layout.
11332 """
d55e5bfc
RD
11333 return _core_.SizerItem_GetSize(*args, **kwargs)
11334
11335 def CalcMin(*args, **kwargs):
248ed943
RD
11336 """
11337 CalcMin(self) -> Size
11338
11339 Calculates the minimum desired size for the item, including any space
11340 needed by borders.
11341 """
d55e5bfc
RD
11342 return _core_.SizerItem_CalcMin(*args, **kwargs)
11343
11344 def SetDimension(*args, **kwargs):
248ed943
RD
11345 """
11346 SetDimension(self, Point pos, Size size)
11347
11348 Set the position and size of the space allocated for this item by the
11349 sizer, and adjust the position and size of the item (window or
11350 subsizer) to be within that space taking alignment and borders into
11351 account.
11352 """
d55e5bfc
RD
11353 return _core_.SizerItem_SetDimension(*args, **kwargs)
11354
11355 def GetMinSize(*args, **kwargs):
248ed943
RD
11356 """
11357 GetMinSize(self) -> Size
11358
11359 Get the minimum size needed for the item.
11360 """
d55e5bfc
RD
11361 return _core_.SizerItem_GetMinSize(*args, **kwargs)
11362
a001823c
RD
11363 def GetMinSizeWithBorder(*args, **kwargs):
11364 """
11365 GetMinSizeWithBorder(self) -> Size
11366
11367 Get the minimum size needed for the item with space for the borders
11368 added, if needed.
11369 """
11370 return _core_.SizerItem_GetMinSizeWithBorder(*args, **kwargs)
11371
d55e5bfc
RD
11372 def SetInitSize(*args, **kwargs):
11373 """SetInitSize(self, int x, int y)"""
11374 return _core_.SizerItem_SetInitSize(*args, **kwargs)
11375
11376 def SetRatioWH(*args, **kwargs):
248ed943
RD
11377 """
11378 SetRatioWH(self, int width, int height)
11379
11380 Set the ratio item attribute.
11381 """
d55e5bfc
RD
11382 return _core_.SizerItem_SetRatioWH(*args, **kwargs)
11383
11384 def SetRatioSize(*args, **kwargs):
248ed943
RD
11385 """
11386 SetRatioSize(self, Size size)
11387
11388 Set the ratio item attribute.
11389 """
d55e5bfc
RD
11390 return _core_.SizerItem_SetRatioSize(*args, **kwargs)
11391
11392 def SetRatio(*args, **kwargs):
248ed943
RD
11393 """
11394 SetRatio(self, float ratio)
11395
11396 Set the ratio item attribute.
11397 """
d55e5bfc
RD
11398 return _core_.SizerItem_SetRatio(*args, **kwargs)
11399
11400 def GetRatio(*args, **kwargs):
248ed943
RD
11401 """
11402 GetRatio(self) -> float
11403
11404 Set the ratio item attribute.
11405 """
d55e5bfc
RD
11406 return _core_.SizerItem_GetRatio(*args, **kwargs)
11407
c1cb24a4
RD
11408 def GetRect(*args, **kwargs):
11409 """
11410 GetRect(self) -> Rect
11411
11412 Returns the rectangle that the sizer item should occupy
11413 """
11414 return _core_.SizerItem_GetRect(*args, **kwargs)
11415
d55e5bfc 11416 def IsWindow(*args, **kwargs):
248ed943
RD
11417 """
11418 IsWindow(self) -> bool
11419
11420 Is this sizer item a window?
11421 """
d55e5bfc
RD
11422 return _core_.SizerItem_IsWindow(*args, **kwargs)
11423
11424 def IsSizer(*args, **kwargs):
248ed943
RD
11425 """
11426 IsSizer(self) -> bool
11427
11428 Is this sizer item a subsizer?
11429 """
d55e5bfc
RD
11430 return _core_.SizerItem_IsSizer(*args, **kwargs)
11431
11432 def IsSpacer(*args, **kwargs):
248ed943
RD
11433 """
11434 IsSpacer(self) -> bool
11435
11436 Is this sizer item a spacer?
11437 """
d55e5bfc
RD
11438 return _core_.SizerItem_IsSpacer(*args, **kwargs)
11439
11440 def SetProportion(*args, **kwargs):
248ed943
RD
11441 """
11442 SetProportion(self, int proportion)
11443
11444 Set the proportion value for this item.
11445 """
d55e5bfc
RD
11446 return _core_.SizerItem_SetProportion(*args, **kwargs)
11447
11448 def GetProportion(*args, **kwargs):
248ed943
RD
11449 """
11450 GetProportion(self) -> int
11451
11452 Get the proportion value for this item.
11453 """
d55e5bfc
RD
11454 return _core_.SizerItem_GetProportion(*args, **kwargs)
11455
248ed943
RD
11456 SetOption = wx._deprecated(SetProportion, "Please use `SetProportion` instead.")
11457 GetOption = wx._deprecated(GetProportion, "Please use `GetProportion` instead.")
d55e5bfc 11458 def SetFlag(*args, **kwargs):
248ed943
RD
11459 """
11460 SetFlag(self, int flag)
11461
11462 Set the flag value for this item.
11463 """
d55e5bfc
RD
11464 return _core_.SizerItem_SetFlag(*args, **kwargs)
11465
11466 def GetFlag(*args, **kwargs):
248ed943
RD
11467 """
11468 GetFlag(self) -> int
11469
11470 Get the flag value for this item.
11471 """
d55e5bfc
RD
11472 return _core_.SizerItem_GetFlag(*args, **kwargs)
11473
11474 def SetBorder(*args, **kwargs):
248ed943
RD
11475 """
11476 SetBorder(self, int border)
11477
11478 Set the border value for this item.
11479 """
d55e5bfc
RD
11480 return _core_.SizerItem_SetBorder(*args, **kwargs)
11481
11482 def GetBorder(*args, **kwargs):
248ed943
RD
11483 """
11484 GetBorder(self) -> int
11485
11486 Get the border value for this item.
11487 """
d55e5bfc
RD
11488 return _core_.SizerItem_GetBorder(*args, **kwargs)
11489
11490 def GetWindow(*args, **kwargs):
248ed943
RD
11491 """
11492 GetWindow(self) -> Window
11493
11494 Get the window (if any) that is managed by this sizer item.
11495 """
d55e5bfc
RD
11496 return _core_.SizerItem_GetWindow(*args, **kwargs)
11497
11498 def SetWindow(*args, **kwargs):
248ed943
RD
11499 """
11500 SetWindow(self, Window window)
11501
11502 Set the window to be managed by this sizer item.
11503 """
d55e5bfc
RD
11504 return _core_.SizerItem_SetWindow(*args, **kwargs)
11505
11506 def GetSizer(*args, **kwargs):
248ed943
RD
11507 """
11508 GetSizer(self) -> Sizer
11509
11510 Get the subsizer (if any) that is managed by this sizer item.
11511 """
d55e5bfc
RD
11512 return _core_.SizerItem_GetSizer(*args, **kwargs)
11513
11514 def SetSizer(*args, **kwargs):
248ed943
RD
11515 """
11516 SetSizer(self, Sizer sizer)
11517
11518 Set the subsizer to be managed by this sizer item.
11519 """
d55e5bfc
RD
11520 return _core_.SizerItem_SetSizer(*args, **kwargs)
11521
11522 def GetSpacer(*args, **kwargs):
248ed943
RD
11523 """
11524 GetSpacer(self) -> Size
11525
11526 Get the size of the spacer managed by this sizer item.
11527 """
d55e5bfc
RD
11528 return _core_.SizerItem_GetSpacer(*args, **kwargs)
11529
11530 def SetSpacer(*args, **kwargs):
248ed943
RD
11531 """
11532 SetSpacer(self, Size size)
11533
11534 Set the size of the spacer to be managed by this sizer item.
11535 """
d55e5bfc
RD
11536 return _core_.SizerItem_SetSpacer(*args, **kwargs)
11537
11538 def Show(*args, **kwargs):
248ed943
RD
11539 """
11540 Show(self, bool show)
11541
11542 Set the show item attribute, which sizers use to determine if the item
11543 is to be made part of the layout or not. If the item is tracking a
11544 window then it is shown or hidden as needed.
11545 """
d55e5bfc
RD
11546 return _core_.SizerItem_Show(*args, **kwargs)
11547
11548 def IsShown(*args, **kwargs):
248ed943
RD
11549 """
11550 IsShown(self) -> bool
11551
11552 Is the item to be shown in the layout?
11553 """
d55e5bfc
RD
11554 return _core_.SizerItem_IsShown(*args, **kwargs)
11555
11556 def GetPosition(*args, **kwargs):
248ed943
RD
11557 """
11558 GetPosition(self) -> Point
11559
11560 Returns the current position of the item, as set in the last Layout.
11561 """
d55e5bfc
RD
11562 return _core_.SizerItem_GetPosition(*args, **kwargs)
11563
11564 def GetUserData(*args, **kwargs):
248ed943
RD
11565 """
11566 GetUserData(self) -> PyObject
11567
11568 Returns the userData associated with this sizer item, or None if there
11569 isn't any.
11570 """
d55e5bfc
RD
11571 return _core_.SizerItem_GetUserData(*args, **kwargs)
11572
7449af73
RD
11573 def SetUserData(*args, **kwargs):
11574 """
11575 SetUserData(self, PyObject userData)
11576
11577 Associate a Python object with this sizer item.
11578 """
11579 return _core_.SizerItem_SetUserData(*args, **kwargs)
11580
33d6fd3b
RD
11581 Border = property(GetBorder,SetBorder,doc="See `GetBorder` and `SetBorder`")
11582 Flag = property(GetFlag,SetFlag,doc="See `GetFlag` and `SetFlag`")
11583 MinSize = property(GetMinSize,doc="See `GetMinSize`")
11584 MinSizeWithBorder = property(GetMinSizeWithBorder,doc="See `GetMinSizeWithBorder`")
11585 Position = property(GetPosition,doc="See `GetPosition`")
11586 Proportion = property(GetProportion,SetProportion,doc="See `GetProportion` and `SetProportion`")
11587 Ratio = property(GetRatio,SetRatio,doc="See `GetRatio` and `SetRatio`")
11588 Rect = property(GetRect,doc="See `GetRect`")
11589 Size = property(GetSize,doc="See `GetSize`")
11590 Sizer = property(GetSizer,SetSizer,doc="See `GetSizer` and `SetSizer`")
11591 Spacer = property(GetSpacer,SetSpacer,doc="See `GetSpacer` and `SetSpacer`")
11592 UserData = property(GetUserData,SetUserData,doc="See `GetUserData` and `SetUserData`")
11593 Window = property(GetWindow,SetWindow,doc="See `GetWindow` and `SetWindow`")
2131d850 11594_core_.SizerItem_swigregister(SizerItem)
d55e5bfc 11595
248ed943 11596def SizerItemWindow(*args, **kwargs):
d55e5bfc 11597 """
248ed943
RD
11598 SizerItemWindow(Window window, int proportion, int flag, int border,
11599 PyObject userData=None) -> SizerItem
11600
11601 Constructs a `wx.SizerItem` for tracking a window.
d55e5bfc 11602 """
248ed943 11603 val = _core_.new_SizerItemWindow(*args, **kwargs)
d55e5bfc
RD
11604 return val
11605
248ed943 11606def SizerItemSpacer(*args, **kwargs):
d55e5bfc 11607 """
248ed943
RD
11608 SizerItemSpacer(int width, int height, int proportion, int flag, int border,
11609 PyObject userData=None) -> SizerItem
11610
11611 Constructs a `wx.SizerItem` for tracking a spacer.
d55e5bfc 11612 """
248ed943 11613 val = _core_.new_SizerItemSpacer(*args, **kwargs)
d55e5bfc
RD
11614 return val
11615
11616def SizerItemSizer(*args, **kwargs):
11617 """
11618 SizerItemSizer(Sizer sizer, int proportion, int flag, int border,
248ed943
RD
11619 PyObject userData=None) -> SizerItem
11620
11621 Constructs a `wx.SizerItem` for tracking a subsizer
d55e5bfc
RD
11622 """
11623 val = _core_.new_SizerItemSizer(*args, **kwargs)
d55e5bfc
RD
11624 return val
11625
11626class Sizer(Object):
248ed943
RD
11627 """
11628 wx.Sizer is the abstract base class used for laying out subwindows in
11629 a window. You cannot use wx.Sizer directly; instead, you will have to
11630 use one of the sizer classes derived from it such as `wx.BoxSizer`,
1d5ee749
RD
11631 `wx.StaticBoxSizer`, `wx.GridSizer`, `wx.FlexGridSizer` and
11632 `wx.GridBagSizer`.
248ed943
RD
11633
11634 The concept implemented by sizers in wxWidgets is closely related to
11635 layout tools in other GUI toolkits, such as Java's AWT, the GTK
11636 toolkit or the Qt toolkit. It is based upon the idea of the individual
11637 subwindows reporting their minimal required size and their ability to
11638 get stretched if the size of the parent window has changed. This will
11639 most often mean that the programmer does not set the original size of
11640 a dialog in the beginning, rather the dialog will assigned a sizer and
11641 this sizer will be queried about the recommended size. The sizer in
11642 turn will query its children, which can be normal windows or contorls,
11643 empty space or other sizers, so that a hierarchy of sizers can be
11644 constructed. Note that wxSizer does not derive from wxWindow and thus
11645 do not interfere with tab ordering and requires very little resources
11646 compared to a real window on screen.
11647
11648 What makes sizers so well fitted for use in wxWidgets is the fact that
11649 every control reports its own minimal size and the algorithm can
11650 handle differences in font sizes or different window (dialog item)
11651 sizes on different platforms without problems. If for example the
11652 standard font as well as the overall design of Mac widgets requires
11653 more space than on Windows, then the initial size of a dialog using a
11654 sizer will automatically be bigger on Mac than on Windows.
11655 """
554f62e9
RD
11656 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11657 def __init__(self): raise AttributeError, "No constructor defined"
11658 __repr__ = _swig_repr
11659 __swig_destroy__ = _core_.delete_Sizer
11660 __del__ = lambda self : None;
d55e5bfc
RD
11661 def _setOORInfo(*args, **kwargs):
11662 """_setOORInfo(self, PyObject _self)"""
11663 return _core_.Sizer__setOORInfo(*args, **kwargs)
11664
11665 def Add(*args, **kwargs):
11666 """
248ed943 11667 Add(self, item, int proportion=0, int flag=0, int border=0,
c1cb24a4 11668 PyObject userData=None) -> wx.SizerItem
248ed943
RD
11669
11670 Appends a child item to the sizer.
d55e5bfc
RD
11671 """
11672 return _core_.Sizer_Add(*args, **kwargs)
11673
11674 def Insert(*args, **kwargs):
11675 """
248ed943 11676 Insert(self, int before, item, int proportion=0, int flag=0, int border=0,
c1cb24a4 11677 PyObject userData=None) -> wx.SizerItem
248ed943
RD
11678
11679 Inserts a new item into the list of items managed by this sizer before
11680 the item at index *before*. See `Add` for a description of the parameters.
d55e5bfc
RD
11681 """
11682 return _core_.Sizer_Insert(*args, **kwargs)
11683
11684 def Prepend(*args, **kwargs):
11685 """
248ed943 11686 Prepend(self, item, int proportion=0, int flag=0, int border=0,
c1cb24a4 11687 PyObject userData=None) -> wx.SizerItem
248ed943
RD
11688
11689 Adds a new item to the begining of the list of sizer items managed by
11690 this sizer. See `Add` for a description of the parameters.
d55e5bfc
RD
11691 """
11692 return _core_.Sizer_Prepend(*args, **kwargs)
11693
11694 def Remove(*args, **kwargs):
248ed943
RD
11695 """
11696 Remove(self, item) -> bool
11697
11698 Removes an item from the sizer and destroys it. This method does not
11699 cause any layout or resizing to take place, call `Layout` to update
11700 the layout on screen after removing a child from the sizer. The
11701 *item* parameter can be either a window, a sizer, or the zero-based
11702 index of an item to remove. Returns True if the child item was found
11703 and removed.
11704 """
d55e5bfc
RD
11705 return _core_.Sizer_Remove(*args, **kwargs)
11706
1a6bba1e 11707 def Detach(*args, **kwargs):
248ed943
RD
11708 """
11709 Detach(self, item) -> bool
11710
11711 Detaches an item from the sizer without destroying it. This method
11712 does not cause any layout or resizing to take place, call `Layout` to
11713 do so. The *item* parameter can be either a window, a sizer, or the
11714 zero-based index of the item to be detached. Returns True if the child item
11715 was found and detached.
11716 """
1a6bba1e
RD
11717 return _core_.Sizer_Detach(*args, **kwargs)
11718
c1cb24a4
RD
11719 def GetItem(*args, **kwargs):
11720 """
11721 GetItem(self, item) -> wx.SizerItem
11722
11723 Returns the `wx.SizerItem` which holds the *item* given. The *item*
11724 parameter can be either a window, a sizer, or the zero-based index of
4d170c95 11725 the item to be found.
c1cb24a4
RD
11726 """
11727 return _core_.Sizer_GetItem(*args, **kwargs)
11728
d55e5bfc
RD
11729 def _SetItemMinSize(*args, **kwargs):
11730 """_SetItemMinSize(self, PyObject item, Size size)"""
11731 return _core_.Sizer__SetItemMinSize(*args, **kwargs)
11732
97ab0f6a
RD
11733 def _ReplaceWin(*args, **kwargs):
11734 """_ReplaceWin(self, Window oldwin, Window newwin, bool recursive=False) -> bool"""
11735 return _core_.Sizer__ReplaceWin(*args, **kwargs)
11736
11737 def _ReplaceSizer(*args, **kwargs):
11738 """_ReplaceSizer(self, Sizer oldsz, Sizer newsz, bool recursive=False) -> bool"""
11739 return _core_.Sizer__ReplaceSizer(*args, **kwargs)
11740
11741 def _ReplaceItem(*args, **kwargs):
11742 """_ReplaceItem(self, size_t index, SizerItem newitem) -> bool"""
11743 return _core_.Sizer__ReplaceItem(*args, **kwargs)
11744
11745 def Replace(self, olditem, item, recursive=False):
11746 """
11747 Detaches the given ``olditem`` from the sizer and replaces it with
11748 ``item`` which can be a window, sizer, or `wx.SizerItem`. The
11749 detached child is destroyed only if it is not a window, (because
11750 windows are owned by their parent, not the sizer.) The
11751 ``recursive`` parameter can be used to search for the given
11752 element recursivly in subsizers.
11753
11754 This method does not cause any layout or resizing to take place,
11755 call `Layout` to do so.
11756
11757 Returns ``True`` if the child item was found and removed.
11758 """
11759 if isinstance(olditem, wx.Window):
11760 return self._ReplaceWin(olditem, item, recursive)
11761 elif isinstnace(olditem, wx.Sizer):
11762 return self._ReplaceSizer(olditem, item, recursive)
11763 elif isinstnace(olditem, int):
11764 return self._ReplaceItem(olditem, item)
11765 else:
11766 raise TypeError("Expected Window, Sizer, or integer for first parameter.")
11767
11768 def SetContainingWindow(*args, **kwargs):
11769 """
11770 SetContainingWindow(self, Window window)
11771
11772 Set (or unset) the window this sizer is used in.
11773 """
11774 return _core_.Sizer_SetContainingWindow(*args, **kwargs)
11775
11776 def GetContainingWindow(*args, **kwargs):
11777 """
11778 GetContainingWindow(self) -> Window
11779
11780 Get the window this sizer is used in.
11781 """
11782 return _core_.Sizer_GetContainingWindow(*args, **kwargs)
11783
248ed943
RD
11784 def SetItemMinSize(self, item, *args):
11785 """
11786 SetItemMinSize(self, item, Size size)
11787
11788 Sets the minimum size that will be allocated for an item in the sizer.
11789 The *item* parameter can be either a window, a sizer, or the
11790 zero-based index of the item. If a window or sizer is given then it
11791 will be searched for recursivly in subsizers if neccessary.
11792 """
11793 if len(args) == 2:
11794 # for backward compatibility accept separate width,height args too
11795 return self._SetItemMinSize(item, args)
11796 else:
11797 return self._SetItemMinSize(item, args[0])
11798
d55e5bfc 11799 def AddItem(*args, **kwargs):
248ed943
RD
11800 """
11801 AddItem(self, SizerItem item)
11802
11803 Adds a `wx.SizerItem` to the sizer.
11804 """
d55e5bfc
RD
11805 return _core_.Sizer_AddItem(*args, **kwargs)
11806
11807 def InsertItem(*args, **kwargs):
248ed943
RD
11808 """
11809 InsertItem(self, int index, SizerItem item)
11810
11811 Inserts a `wx.SizerItem` to the sizer at the position given by *index*.
11812 """
d55e5bfc
RD
11813 return _core_.Sizer_InsertItem(*args, **kwargs)
11814
11815 def PrependItem(*args, **kwargs):
248ed943
RD
11816 """
11817 PrependItem(self, SizerItem item)
11818
11819 Prepends a `wx.SizerItem` to the sizer.
11820 """
d55e5bfc
RD
11821 return _core_.Sizer_PrependItem(*args, **kwargs)
11822
248ed943 11823 def AddMany(self, items):
c24da6d6
RD
11824 """
11825 AddMany is a convenience method for adding several items
11826 to a sizer at one time. Simply pass it a list of tuples,
11827 where each tuple consists of the parameters that you
11828 would normally pass to the `Add` method.
11829 """
248ed943
RD
11830 for item in items:
11831 if type(item) != type(()) or (len(item) == 2 and type(item[0]) == type(1)):
11832 item = (item, )
11833 self.Add(*item)
d55e5bfc 11834
0d2c9713
RD
11835 def AddSpacer(self, *args, **kw):
11836 """AddSpacer(int size) --> SizerItem
11837
11838 Add a spacer that is (size,size) pixels.
11839 """
11840 if args and type(args[0]) == int:
11841 return self.Add( (args[0],args[0] ), 0)
11842 else: # otherwise stay compatible with old AddSpacer
11843 return self.Add(*args, **kw)
11844 def PrependSpacer(self, *args, **kw):
11845 """PrependSpacer(int size) --> SizerItem
11846
11847 Prepend a spacer that is (size, size) pixels."""
11848 if args and type(args[0]) == int:
11849 return self.Prepend( (args[0],args[0] ), 0)
11850 else: # otherwise stay compatible with old PrependSpacer
11851 return self.Prepend(*args, **kw)
11852 def InsertSpacer(self, index, *args, **kw):
11853 """InsertSpacer(int index, int size) --> SizerItem
11854
11855 Insert a spacer at position index that is (size, size) pixels."""
11856 if args and type(args[0]) == int:
11857 return self.Insert( index, (args[0],args[0] ), 0)
11858 else: # otherwise stay compatible with old InsertSpacer
11859 return self.Insert(index, *args, **kw)
11860
11861
11862 def AddStretchSpacer(self, prop=1):
11863 """AddStretchSpacer(int prop=1) --> SizerItem
11864
11865 Add a stretchable spacer."""
11866 return self.Add((0,0), prop)
11867 def PrependStretchSpacer(self, prop=1):
11868 """PrependStretchSpacer(int prop=1) --> SizerItem
11869
11870 Prepend a stretchable spacer."""
11871 return self.Prepend((0,0), prop)
11872 def InsertStretchSpacer(self, index, prop=1):
11873 """InsertStretchSpacer(int index, int prop=1) --> SizerItem
11874
11875 Insert a stretchable spacer."""
11876 return self.Insert(index, (0,0), prop)
11877
11878
d55e5bfc 11879 # for backwards compatibility only, please do not use in new code
b9d6a5f3
RD
11880 def AddWindow(self, *args, **kw):
11881 """Compatibility alias for `Add`."""
11882 return self.Add(*args, **kw)
11883 def AddSizer(self, *args, **kw):
11884 """Compatibility alias for `Add`."""
11885 return self.Add(*args, **kw)
b9d6a5f3
RD
11886
11887 def PrependWindow(self, *args, **kw):
11888 """Compatibility alias for `Prepend`."""
11889 return self.Prepend(*args, **kw)
11890 def PrependSizer(self, *args, **kw):
11891 """Compatibility alias for `Prepend`."""
11892 return self.Prepend(*args, **kw)
b9d6a5f3
RD
11893
11894 def InsertWindow(self, *args, **kw):
11895 """Compatibility alias for `Insert`."""
11896 return self.Insert(*args, **kw)
11897 def InsertSizer(self, *args, **kw):
11898 """Compatibility alias for `Insert`."""
b9d6a5f3
RD
11899 return self.Insert(*args, **kw)
11900
11901 def RemoveWindow(self, *args, **kw):
11902 """Compatibility alias for `Remove`."""
11903 return self.Remove(*args, **kw)
11904 def RemoveSizer(self, *args, **kw):
11905 """Compatibility alias for `Remove`."""
11906 return self.Remove(*args, **kw)
11907 def RemovePos(self, *args, **kw):
11908 """Compatibility alias for `Remove`."""
11909 return self.Remove(*args, **kw)
d55e5bfc
RD
11910
11911
d55e5bfc 11912 def SetDimension(*args, **kwargs):
248ed943
RD
11913 """
11914 SetDimension(self, int x, int y, int width, int height)
11915
11916 Call this to force the sizer to take the given dimension and thus
11917 force the items owned by the sizer to resize themselves according to
11918 the rules defined by the parameter in the `Add`, `Insert` or `Prepend`
11919 methods.
11920 """
d55e5bfc
RD
11921 return _core_.Sizer_SetDimension(*args, **kwargs)
11922
11923 def SetMinSize(*args, **kwargs):
248ed943
RD
11924 """
11925 SetMinSize(self, Size size)
11926
11927 Call this to give the sizer a minimal size. Normally, the sizer will
11928 calculate its minimal size based purely on how much space its children
11929 need. After calling this method `GetMinSize` will return either the
11930 minimal size as requested by its children or the minimal size set
11931 here, depending on which is bigger.
11932 """
d55e5bfc
RD
11933 return _core_.Sizer_SetMinSize(*args, **kwargs)
11934
11935 def GetSize(*args, **kwargs):
248ed943
RD
11936 """
11937 GetSize(self) -> Size
11938
11939 Returns the current size of the space managed by the sizer.
11940 """
d55e5bfc
RD
11941 return _core_.Sizer_GetSize(*args, **kwargs)
11942
11943 def GetPosition(*args, **kwargs):
248ed943
RD
11944 """
11945 GetPosition(self) -> Point
11946
11947 Returns the current position of the sizer's managed space.
11948 """
d55e5bfc
RD
11949 return _core_.Sizer_GetPosition(*args, **kwargs)
11950
11951 def GetMinSize(*args, **kwargs):
248ed943
RD
11952 """
11953 GetMinSize(self) -> Size
11954
11955 Returns the minimal size of the sizer. This is either the combined
11956 minimal size of all the children and their borders or the minimal size
11957 set by SetMinSize, depending on which is bigger.
11958 """
d55e5bfc
RD
11959 return _core_.Sizer_GetMinSize(*args, **kwargs)
11960
11961 def GetSizeTuple(self):
1a6bba1e 11962 return self.GetSize().Get()
d55e5bfc 11963 def GetPositionTuple(self):
1a6bba1e 11964 return self.GetPosition().Get()
d55e5bfc 11965 def GetMinSizeTuple(self):
1a6bba1e 11966 return self.GetMinSize().Get()
d55e5bfc
RD
11967
11968 def RecalcSizes(*args, **kwargs):
248ed943
RD
11969 """
11970 RecalcSizes(self)
11971
11972 Using the sizes calculated by `CalcMin` reposition and resize all the
11973 items managed by this sizer. You should not need to call this directly as
11974 it is called by `Layout`.
11975 """
d55e5bfc
RD
11976 return _core_.Sizer_RecalcSizes(*args, **kwargs)
11977
11978 def CalcMin(*args, **kwargs):
248ed943
RD
11979 """
11980 CalcMin(self) -> Size
11981
11982 This method is where the sizer will do the actual calculation of its
11983 children's minimal sizes. You should not need to call this directly as
11984 it is called by `Layout`.
11985 """
d55e5bfc
RD
11986 return _core_.Sizer_CalcMin(*args, **kwargs)
11987
11988 def Layout(*args, **kwargs):
248ed943
RD
11989 """
11990 Layout(self)
11991
11992 This method will force the recalculation and layout of the items
11993 controlled by the sizer using the current space allocated to the
11994 sizer. Normally this is called automatically from the owning window's
11995 EVT_SIZE handler, but it is also useful to call it from user code when
11996 one of the items in a sizer change size, or items are added or
11997 removed.
11998 """
d55e5bfc
RD
11999 return _core_.Sizer_Layout(*args, **kwargs)
12000
12001 def Fit(*args, **kwargs):
248ed943
RD
12002 """
12003 Fit(self, Window window) -> Size
12004
12005 Tell the sizer to resize the *window* to match the sizer's minimal
12006 size. This is commonly done in the constructor of the window itself in
12007 order to set its initial size to match the needs of the children as
12008 determined by the sizer. Returns the new size.
12009
12010 For a top level window this is the total window size, not the client size.
12011 """
d55e5bfc
RD
12012 return _core_.Sizer_Fit(*args, **kwargs)
12013
12014 def FitInside(*args, **kwargs):
248ed943
RD
12015 """
12016 FitInside(self, Window window)
12017
12018 Tell the sizer to resize the *virtual size* of the *window* to match the
12019 sizer's minimal size. This will not alter the on screen size of the
12020 window, but may cause the addition/removal/alteration of scrollbars
12021 required to view the virtual area in windows which manage it.
12022
12023 :see: `wx.ScrolledWindow.SetScrollbars`, `SetVirtualSizeHints`
12024
12025 """
d55e5bfc
RD
12026 return _core_.Sizer_FitInside(*args, **kwargs)
12027
12028 def SetSizeHints(*args, **kwargs):
248ed943
RD
12029 """
12030 SetSizeHints(self, Window window)
12031
12032 Tell the sizer to set (and `Fit`) the minimal size of the *window* to
12033 match the sizer's minimal size. This is commonly done in the
12034 constructor of the window itself if the window is resizable (as are
12035 many dialogs under Unix and frames on probably all platforms) in order
12036 to prevent the window from being sized smaller than the minimal size
12037 required by the sizer.
12038 """
d55e5bfc
RD
12039 return _core_.Sizer_SetSizeHints(*args, **kwargs)
12040
12041 def SetVirtualSizeHints(*args, **kwargs):
248ed943
RD
12042 """
12043 SetVirtualSizeHints(self, Window window)
12044
12045 Tell the sizer to set the minimal size of the window virtual area to
12046 match the sizer's minimal size. For windows with managed scrollbars
12047 this will set them appropriately.
12048
12049 :see: `wx.ScrolledWindow.SetScrollbars`
12050
12051 """
d55e5bfc
RD
12052 return _core_.Sizer_SetVirtualSizeHints(*args, **kwargs)
12053
12054 def Clear(*args, **kwargs):
248ed943
RD
12055 """
12056 Clear(self, bool deleteWindows=False)
12057
12058 Clear all items from the sizer, optionally destroying the window items
12059 as well.
12060 """
d55e5bfc
RD
12061 return _core_.Sizer_Clear(*args, **kwargs)
12062
12063 def DeleteWindows(*args, **kwargs):
248ed943
RD
12064 """
12065 DeleteWindows(self)
12066
12067 Destroy all windows managed by the sizer.
12068 """
d55e5bfc
RD
12069 return _core_.Sizer_DeleteWindows(*args, **kwargs)
12070
12071 def GetChildren(*args, **kwargs):
248ed943 12072 """
51b83b37 12073 GetChildren(self) -> list
248ed943
RD
12074
12075 Returns a list of all the `wx.SizerItem` objects managed by the sizer.
12076 """
d55e5bfc
RD
12077 return _core_.Sizer_GetChildren(*args, **kwargs)
12078
12079 def Show(*args, **kwargs):
248ed943 12080 """
ae8162c8 12081 Show(self, item, bool show=True, bool recursive=false) -> bool
d55e5bfc 12082
248ed943
RD
12083 Shows or hides an item managed by the sizer. To make a sizer item
12084 disappear or reappear, use Show followed by `Layout`. The *item*
12085 parameter can be either a window, a sizer, or the zero-based index of
629e65c2
RD
12086 the item. Use the recursive parameter to show or hide an item in a
12087 subsizer. Returns True if the item was found.
248ed943
RD
12088 """
12089 return _core_.Sizer_Show(*args, **kwargs)
d55e5bfc
RD
12090
12091 def IsShown(*args, **kwargs):
248ed943
RD
12092 """
12093 IsShown(self, item)
12094
b1fcee84 12095 Determines if the item is currently shown. To make a sizer
248ed943
RD
12096 item disappear or reappear, use Show followed by `Layout`. The *item*
12097 parameter can be either a window, a sizer, or the zero-based index of
12098 the item.
12099 """
d55e5bfc
RD
12100 return _core_.Sizer_IsShown(*args, **kwargs)
12101
629e65c2 12102 def Hide(self, item, recursive=False):
248ed943 12103 """
27fb7603 12104 A convenience method for `Show` (item, False, recursive).
248ed943 12105 """
06759a38 12106 return self.Show(item, False, recursive)
248ed943 12107
d55e5bfc 12108 def ShowItems(*args, **kwargs):
248ed943
RD
12109 """
12110 ShowItems(self, bool show)
12111
84f85550 12112 Recursively call `wx.SizerItem.Show` on all sizer items.
248ed943 12113 """
d55e5bfc
RD
12114 return _core_.Sizer_ShowItems(*args, **kwargs)
12115
33d6fd3b
RD
12116 Children = property(GetChildren,doc="See `GetChildren`")
12117 ContainingWindow = property(GetContainingWindow,SetContainingWindow,doc="See `GetContainingWindow` and `SetContainingWindow`")
12118 MinSize = property(GetMinSize,SetMinSize,doc="See `GetMinSize` and `SetMinSize`")
12119 Position = property(GetPosition,doc="See `GetPosition`")
12120 Size = property(GetSize,doc="See `GetSize`")
2131d850 12121_core_.Sizer_swigregister(Sizer)
d55e5bfc
RD
12122
12123class PySizer(Sizer):
248ed943
RD
12124 """
12125 wx.PySizer is a special version of `wx.Sizer` that has been
12126 instrumented to allow the C++ virtual methods to be overloaded in
12127 Python derived classes. You would derive from this class if you are
12128 wanting to implement a custom sizer in Python code. Simply implement
12129 `CalcMin` and `RecalcSizes` in the derived class and you're all set.
12130 For example::
12131
12132 class MySizer(wx.PySizer):
12133 def __init__(self):
12134 wx.PySizer.__init__(self)
12135
12136 def CalcMin(self):
12137 for item in self.GetChildren():
12138 # calculate the total minimum width and height needed
12139 # by all items in the sizer according to this sizer's
12140 # layout algorithm.
12141 ...
12142 return wx.Size(width, height)
12143
12144 def RecalcSizes(self):
12145 # find the space allotted to this sizer
12146 pos = self.GetPosition()
12147 size = self.GetSize()
12148 for item in self.GetChildren():
12149 # Recalculate (if necessary) the position and size of
12150 # each item and then call item.SetDimension to do the
12151 # actual positioning and sizing of the items within the
12152 # space alloted to this sizer.
12153 ...
12154 item.SetDimension(itemPos, itemSize)
12155
12156
12157 When `Layout` is called it first calls `CalcMin` followed by
12158 `RecalcSizes` so you can optimize a bit by saving the results of
62d32a5f 12159 `CalcMin` and reusing them in `RecalcSizes`.
248ed943
RD
12160
12161 :see: `wx.SizerItem`, `wx.Sizer.GetChildren`
12162
12163
12164 """
554f62e9
RD
12165 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12166 __repr__ = _swig_repr
12167 def __init__(self, *args, **kwargs):
248ed943
RD
12168 """
12169 __init__(self) -> PySizer
12170
12171 Creates a wx.PySizer. Must be called from the __init__ in the derived
12172 class.
12173 """
554f62e9 12174 _core_.PySizer_swiginit(self,_core_.new_PySizer(*args, **kwargs))
d55e5bfc
RD
12175 self._setCallbackInfo(self, PySizer);self._setOORInfo(self)
12176
12177 def _setCallbackInfo(*args, **kwargs):
12178 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
12179 return _core_.PySizer__setCallbackInfo(*args, **kwargs)
12180
2131d850 12181_core_.PySizer_swigregister(PySizer)
d55e5bfc
RD
12182
12183#---------------------------------------------------------------------------
12184
12185class BoxSizer(Sizer):
248ed943
RD
12186 """
12187 The basic idea behind a box sizer is that windows will most often be
12188 laid out in rather simple basic geometry, typically in a row or a
12189 column or nested hierarchies of either. A wx.BoxSizer will lay out
12190 its items in a simple row or column, depending on the orientation
12191 parameter passed to the constructor.
12192 """
554f62e9
RD
12193 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12194 __repr__ = _swig_repr
12195 def __init__(self, *args, **kwargs):
248ed943
RD
12196 """
12197 __init__(self, int orient=HORIZONTAL) -> BoxSizer
12198
12199 Constructor for a wx.BoxSizer. *orient* may be one of ``wx.VERTICAL``
12200 or ``wx.HORIZONTAL`` for creating either a column sizer or a row
12201 sizer.
12202 """
554f62e9 12203 _core_.BoxSizer_swiginit(self,_core_.new_BoxSizer(*args, **kwargs))
d55e5bfc
RD
12204 self._setOORInfo(self)
12205
12206 def GetOrientation(*args, **kwargs):
248ed943
RD
12207 """
12208 GetOrientation(self) -> int
12209
12210 Returns the current orientation of the sizer.
12211 """
d55e5bfc
RD
12212 return _core_.BoxSizer_GetOrientation(*args, **kwargs)
12213
12214 def SetOrientation(*args, **kwargs):
248ed943
RD
12215 """
12216 SetOrientation(self, int orient)
d55e5bfc 12217
248ed943
RD
12218 Resets the orientation of the sizer.
12219 """
12220 return _core_.BoxSizer_SetOrientation(*args, **kwargs)
d55e5bfc 12221
226118fc 12222 Orientation = property(GetOrientation,SetOrientation,doc="See `GetOrientation` and `SetOrientation`")
2131d850 12223_core_.BoxSizer_swigregister(BoxSizer)
d55e5bfc
RD
12224
12225#---------------------------------------------------------------------------
12226
12227class StaticBoxSizer(BoxSizer):
248ed943
RD
12228 """
12229 wx.StaticBoxSizer derives from and functions identically to the
12230 `wx.BoxSizer` and adds a `wx.StaticBox` around the items that the sizer
12231 manages. Note that this static box must be created separately and
12232 passed to the sizer constructor.
12233 """
554f62e9
RD
12234 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12235 __repr__ = _swig_repr
12236 def __init__(self, *args, **kwargs):
248ed943
RD
12237 """
12238 __init__(self, StaticBox box, int orient=HORIZONTAL) -> StaticBoxSizer
12239
12240 Constructor. It takes an associated static box and the orientation
12241 *orient* as parameters - orient can be either of ``wx.VERTICAL`` or
12242 ``wx.HORIZONTAL``.
12243 """
554f62e9 12244 _core_.StaticBoxSizer_swiginit(self,_core_.new_StaticBoxSizer(*args, **kwargs))
d55e5bfc
RD
12245 self._setOORInfo(self)
12246
12247 def GetStaticBox(*args, **kwargs):
248ed943
RD
12248 """
12249 GetStaticBox(self) -> StaticBox
d55e5bfc 12250
248ed943
RD
12251 Returns the static box associated with this sizer.
12252 """
12253 return _core_.StaticBoxSizer_GetStaticBox(*args, **kwargs)
d55e5bfc 12254
33d6fd3b 12255 StaticBox = property(GetStaticBox,doc="See `GetStaticBox`")
2131d850 12256_core_.StaticBoxSizer_swigregister(StaticBoxSizer)
d55e5bfc
RD
12257
12258#---------------------------------------------------------------------------
12259
12260class GridSizer(Sizer):
248ed943
RD
12261 """
12262 A grid sizer is a sizer which lays out its children in a
12263 two-dimensional table with all cells having the same size. In other
12264 words, the width of each cell within the grid is the width of the
12265 widest item added to the sizer and the height of each grid cell is the
12266 height of the tallest item. An optional vertical and/or horizontal
12267 gap between items can also be specified (in pixels.)
12268
12269 Items are placed in the cells of the grid in the order they are added,
12270 in row-major order. In other words, the first row is filled first,
12271 then the second, and so on until all items have been added. (If
12272 neccessary, additional rows will be added as items are added.) If you
12273 need to have greater control over the cells that items are placed in
12274 then use the `wx.GridBagSizer`.
12275
12276 """
554f62e9
RD
12277 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12278 __repr__ = _swig_repr
12279 def __init__(self, *args, **kwargs):
248ed943
RD
12280 """
12281 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> GridSizer
12282
12283 Constructor for a wx.GridSizer. *rows* and *cols* determine the number
12284 of columns and rows in the sizer - if either of the parameters is
12285 zero, it will be calculated to from the total number of children in
12286 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
12287 define extra space between all children.
12288 """
554f62e9 12289 _core_.GridSizer_swiginit(self,_core_.new_GridSizer(*args, **kwargs))
d55e5bfc
RD
12290 self._setOORInfo(self)
12291
d55e5bfc 12292 def SetCols(*args, **kwargs):
248ed943
RD
12293 """
12294 SetCols(self, int cols)
12295
12296 Sets the number of columns in the sizer.
12297 """
d55e5bfc
RD
12298 return _core_.GridSizer_SetCols(*args, **kwargs)
12299
12300 def SetRows(*args, **kwargs):
248ed943
RD
12301 """
12302 SetRows(self, int rows)
12303
12304 Sets the number of rows in the sizer.
12305 """
d55e5bfc
RD
12306 return _core_.GridSizer_SetRows(*args, **kwargs)
12307
12308 def SetVGap(*args, **kwargs):
248ed943
RD
12309 """
12310 SetVGap(self, int gap)
12311
12312 Sets the vertical gap (in pixels) between the cells in the sizer.
12313 """
d55e5bfc
RD
12314 return _core_.GridSizer_SetVGap(*args, **kwargs)
12315
12316 def SetHGap(*args, **kwargs):
248ed943
RD
12317 """
12318 SetHGap(self, int gap)
12319
12320 Sets the horizontal gap (in pixels) between cells in the sizer
12321 """
d55e5bfc
RD
12322 return _core_.GridSizer_SetHGap(*args, **kwargs)
12323
12324 def GetCols(*args, **kwargs):
248ed943
RD
12325 """
12326 GetCols(self) -> int
12327
12328 Returns the number of columns in the sizer.
12329 """
d55e5bfc
RD
12330 return _core_.GridSizer_GetCols(*args, **kwargs)
12331
12332 def GetRows(*args, **kwargs):
248ed943
RD
12333 """
12334 GetRows(self) -> int
12335
12336 Returns the number of rows in the sizer.
12337 """
d55e5bfc
RD
12338 return _core_.GridSizer_GetRows(*args, **kwargs)
12339
12340 def GetVGap(*args, **kwargs):
248ed943
RD
12341 """
12342 GetVGap(self) -> int
12343
12344 Returns the vertical gap (in pixels) between the cells in the sizer.
12345 """
d55e5bfc
RD
12346 return _core_.GridSizer_GetVGap(*args, **kwargs)
12347
12348 def GetHGap(*args, **kwargs):
248ed943
RD
12349 """
12350 GetHGap(self) -> int
12351
12352 Returns the horizontal gap (in pixels) between cells in the sizer.
12353 """
d55e5bfc
RD
12354 return _core_.GridSizer_GetHGap(*args, **kwargs)
12355
554f62e9
RD
12356 def CalcRowsCols(self):
12357 """
12358 CalcRowsCols() -> (rows, cols)
d55e5bfc 12359
554f62e9
RD
12360 Calculates how many rows and columns will be in the sizer based
12361 on the current number of items and also the rows, cols specified
12362 in the constructor.
12363 """
12364 nitems = len(self.GetChildren())
12365 rows = self.GetRows()
12366 cols = self.GetCols()
12367 assert rows != 0 or cols != 0, "Grid sizer must have either rows or columns fixed"
12368 if cols != 0:
12369 rows = (nitems + cols - 1) / cols
12370 elif rows != 0:
12371 cols = (nitems + rows - 1) / rows
12372 return (rows, cols)
12373
97ab0f6a
RD
12374 Cols = property(GetCols,SetCols,doc="See `GetCols` and `SetCols`")
12375 HGap = property(GetHGap,SetHGap,doc="See `GetHGap` and `SetHGap`")
12376 Rows = property(GetRows,SetRows,doc="See `GetRows` and `SetRows`")
12377 VGap = property(GetVGap,SetVGap,doc="See `GetVGap` and `SetVGap`")
2131d850 12378_core_.GridSizer_swigregister(GridSizer)
d55e5bfc
RD
12379
12380#---------------------------------------------------------------------------
12381
12382FLEX_GROWMODE_NONE = _core_.FLEX_GROWMODE_NONE
12383FLEX_GROWMODE_SPECIFIED = _core_.FLEX_GROWMODE_SPECIFIED
12384FLEX_GROWMODE_ALL = _core_.FLEX_GROWMODE_ALL
12385class FlexGridSizer(GridSizer):
248ed943
RD
12386 """
12387 A flex grid sizer is a sizer which lays out its children in a
12388 two-dimensional table with all table cells in one row having the same
12389 height and all cells in one column having the same width, but all
12390 rows or all columns are not necessarily the same height or width as in
12391 the `wx.GridSizer`.
12392
12393 wx.FlexGridSizer can also size items equally in one direction but
12394 unequally ("flexibly") in the other. If the sizer is only flexible
12395 in one direction (this can be changed using `SetFlexibleDirection`), it
12396 needs to be decided how the sizer should grow in the other ("non
12397 flexible") direction in order to fill the available space. The
12398 `SetNonFlexibleGrowMode` method serves this purpose.
12399
12400
12401 """
554f62e9
RD
12402 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12403 __repr__ = _swig_repr
12404 def __init__(self, *args, **kwargs):
248ed943
RD
12405 """
12406 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> FlexGridSizer
12407
12408 Constructor for a wx.FlexGridSizer. *rows* and *cols* determine the
12409 number of columns and rows in the sizer - if either of the parameters
12410 is zero, it will be calculated to from the total number of children in
12411 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
12412 define extra space between all children.
12413 """
554f62e9 12414 _core_.FlexGridSizer_swiginit(self,_core_.new_FlexGridSizer(*args, **kwargs))
d55e5bfc
RD
12415 self._setOORInfo(self)
12416
248ed943
RD
12417 def AddGrowableRow(*args, **kwargs):
12418 """
12419 AddGrowableRow(self, size_t idx, int proportion=0)
d55e5bfc 12420
248ed943
RD
12421 Specifies that row *idx* (starting from zero) should be grown if there
12422 is extra space available to the sizer.
d55e5bfc 12423
248ed943
RD
12424 The *proportion* parameter has the same meaning as the stretch factor
12425 for the box sizers except that if all proportions are 0, then all
12426 columns are resized equally (instead of not being resized at all).
12427 """
d55e5bfc
RD
12428 return _core_.FlexGridSizer_AddGrowableRow(*args, **kwargs)
12429
12430 def RemoveGrowableRow(*args, **kwargs):
248ed943
RD
12431 """
12432 RemoveGrowableRow(self, size_t idx)
12433
12434 Specifies that row *idx* is no longer growable.
12435 """
d55e5bfc
RD
12436 return _core_.FlexGridSizer_RemoveGrowableRow(*args, **kwargs)
12437
12438 def AddGrowableCol(*args, **kwargs):
248ed943
RD
12439 """
12440 AddGrowableCol(self, size_t idx, int proportion=0)
12441
12442 Specifies that column *idx* (starting from zero) should be grown if
12443 there is extra space available to the sizer.
12444
12445 The *proportion* parameter has the same meaning as the stretch factor
12446 for the box sizers except that if all proportions are 0, then all
12447 columns are resized equally (instead of not being resized at all).
12448 """
d55e5bfc
RD
12449 return _core_.FlexGridSizer_AddGrowableCol(*args, **kwargs)
12450
12451 def RemoveGrowableCol(*args, **kwargs):
248ed943
RD
12452 """
12453 RemoveGrowableCol(self, size_t idx)
12454
12455 Specifies that column *idx* is no longer growable.
12456 """
d55e5bfc
RD
12457 return _core_.FlexGridSizer_RemoveGrowableCol(*args, **kwargs)
12458
12459 def SetFlexibleDirection(*args, **kwargs):
248ed943
RD
12460 """
12461 SetFlexibleDirection(self, int direction)
12462
12463 Specifies whether the sizer should flexibly resize its columns, rows,
12464 or both. Argument *direction* can be one of the following values. Any
12465 other value is ignored.
12466
12467 ============== =======================================
12468 wx.VERTICAL Rows are flexibly sized.
12469 wx.HORIZONTAL Columns are flexibly sized.
12470 wx.BOTH Both rows and columns are flexibly sized
12471 (this is the default value).
12472 ============== =======================================
12473
12474 Note that this method does not trigger relayout.
12475
12476 """
d55e5bfc
RD
12477 return _core_.FlexGridSizer_SetFlexibleDirection(*args, **kwargs)
12478
12479 def GetFlexibleDirection(*args, **kwargs):
248ed943
RD
12480 """
12481 GetFlexibleDirection(self) -> int
12482
12483 Returns a value that specifies whether the sizer
12484 flexibly resizes its columns, rows, or both (default).
12485
12486 :see: `SetFlexibleDirection`
12487 """
d55e5bfc
RD
12488 return _core_.FlexGridSizer_GetFlexibleDirection(*args, **kwargs)
12489
12490 def SetNonFlexibleGrowMode(*args, **kwargs):
248ed943
RD
12491 """
12492 SetNonFlexibleGrowMode(self, int mode)
12493
12494 Specifies how the sizer should grow in the non-flexible direction if
12495 there is one (so `SetFlexibleDirection` must have been called
12496 previously). Argument *mode* can be one of the following values:
12497
12498 ========================== =================================================
12499 wx.FLEX_GROWMODE_NONE Sizer doesn't grow in the non flexible direction.
12500 wx.FLEX_GROWMODE_SPECIFIED Sizer honors growable columns/rows set with
12501 `AddGrowableCol` and `AddGrowableRow`. In this
12502 case equal sizing applies to minimum sizes of
12503 columns or rows (this is the default value).
12504 wx.FLEX_GROWMODE_ALL Sizer equally stretches all columns or rows in
12505 the non flexible direction, whether they are
12506 growable or not in the flexbile direction.
12507 ========================== =================================================
12508
12509 Note that this method does not trigger relayout.
248ed943 12510 """
d55e5bfc
RD
12511 return _core_.FlexGridSizer_SetNonFlexibleGrowMode(*args, **kwargs)
12512
12513 def GetNonFlexibleGrowMode(*args, **kwargs):
248ed943
RD
12514 """
12515 GetNonFlexibleGrowMode(self) -> int
12516
12517 Returns the value that specifies how the sizer grows in the
12518 non-flexible direction if there is one.
12519
12520 :see: `SetNonFlexibleGrowMode`
12521 """
d55e5bfc
RD
12522 return _core_.FlexGridSizer_GetNonFlexibleGrowMode(*args, **kwargs)
12523
12524 def GetRowHeights(*args, **kwargs):
a8eff060
RD
12525 """
12526 GetRowHeights(self) -> list
12527
12528 Returns a list of integers representing the heights of each of the
12529 rows in the sizer.
12530 """
d55e5bfc
RD
12531 return _core_.FlexGridSizer_GetRowHeights(*args, **kwargs)
12532
12533 def GetColWidths(*args, **kwargs):
a8eff060
RD
12534 """
12535 GetColWidths(self) -> list
12536
12537 Returns a list of integers representing the widths of each of the
12538 columns in the sizer.
12539 """
d55e5bfc
RD
12540 return _core_.FlexGridSizer_GetColWidths(*args, **kwargs)
12541
97ab0f6a
RD
12542 ColWidths = property(GetColWidths,doc="See `GetColWidths`")
12543 FlexibleDirection = property(GetFlexibleDirection,SetFlexibleDirection,doc="See `GetFlexibleDirection` and `SetFlexibleDirection`")
12544 NonFlexibleGrowMode = property(GetNonFlexibleGrowMode,SetNonFlexibleGrowMode,doc="See `GetNonFlexibleGrowMode` and `SetNonFlexibleGrowMode`")
12545 RowHeights = property(GetRowHeights,doc="See `GetRowHeights`")
2131d850 12546_core_.FlexGridSizer_swigregister(FlexGridSizer)
d55e5bfc 12547
62d32a5f
RD
12548class StdDialogButtonSizer(BoxSizer):
12549 """
12550 A special sizer that knows how to order and position standard buttons
12551 in order to conform to the current platform's standards. You simply
12552 need to add each `wx.Button` to the sizer, and be sure to create the
53aa7709 12553 buttons using the standard ID's. Then call `Realize` and the sizer
62d32a5f
RD
12554 will take care of the rest.
12555
12556 """
554f62e9
RD
12557 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12558 __repr__ = _swig_repr
12559 def __init__(self, *args, **kwargs):
62d32a5f 12560 """__init__(self) -> StdDialogButtonSizer"""
554f62e9 12561 _core_.StdDialogButtonSizer_swiginit(self,_core_.new_StdDialogButtonSizer(*args, **kwargs))
62d32a5f
RD
12562 def AddButton(*args, **kwargs):
12563 """
12564 AddButton(self, wxButton button)
12565
12566 Use this to add the buttons to this sizer. Do not use the `Add`
12567 method in the base class.
12568 """
12569 return _core_.StdDialogButtonSizer_AddButton(*args, **kwargs)
12570
53aa7709 12571 def Realize(*args, **kwargs):
62d32a5f 12572 """
53aa7709 12573 Realize(self)
62d32a5f
RD
12574
12575 This funciton needs to be called after all the buttons have been added
12576 to the sizer. It will reorder them and position them in a platform
12577 specifc manner.
12578 """
53aa7709 12579 return _core_.StdDialogButtonSizer_Realize(*args, **kwargs)
51b83b37
RD
12580
12581 def SetAffirmativeButton(*args, **kwargs):
12582 """SetAffirmativeButton(self, wxButton button)"""
12583 return _core_.StdDialogButtonSizer_SetAffirmativeButton(*args, **kwargs)
12584
12585 def SetNegativeButton(*args, **kwargs):
12586 """SetNegativeButton(self, wxButton button)"""
12587 return _core_.StdDialogButtonSizer_SetNegativeButton(*args, **kwargs)
12588
12589 def SetCancelButton(*args, **kwargs):
12590 """SetCancelButton(self, wxButton button)"""
12591 return _core_.StdDialogButtonSizer_SetCancelButton(*args, **kwargs)
62d32a5f
RD
12592
12593 def GetAffirmativeButton(*args, **kwargs):
12594 """GetAffirmativeButton(self) -> wxButton"""
12595 return _core_.StdDialogButtonSizer_GetAffirmativeButton(*args, **kwargs)
12596
12597 def GetApplyButton(*args, **kwargs):
12598 """GetApplyButton(self) -> wxButton"""
12599 return _core_.StdDialogButtonSizer_GetApplyButton(*args, **kwargs)
12600
12601 def GetNegativeButton(*args, **kwargs):
12602 """GetNegativeButton(self) -> wxButton"""
12603 return _core_.StdDialogButtonSizer_GetNegativeButton(*args, **kwargs)
12604
12605 def GetCancelButton(*args, **kwargs):
12606 """GetCancelButton(self) -> wxButton"""
12607 return _core_.StdDialogButtonSizer_GetCancelButton(*args, **kwargs)
12608
12609 def GetHelpButton(*args, **kwargs):
12610 """GetHelpButton(self) -> wxButton"""
12611 return _core_.StdDialogButtonSizer_GetHelpButton(*args, **kwargs)
12612
33d6fd3b
RD
12613 AffirmativeButton = property(GetAffirmativeButton,SetAffirmativeButton,doc="See `GetAffirmativeButton` and `SetAffirmativeButton`")
12614 ApplyButton = property(GetApplyButton,doc="See `GetApplyButton`")
12615 CancelButton = property(GetCancelButton,SetCancelButton,doc="See `GetCancelButton` and `SetCancelButton`")
12616 HelpButton = property(GetHelpButton,doc="See `GetHelpButton`")
12617 NegativeButton = property(GetNegativeButton,SetNegativeButton,doc="See `GetNegativeButton` and `SetNegativeButton`")
2131d850 12618_core_.StdDialogButtonSizer_swigregister(StdDialogButtonSizer)
62d32a5f 12619
d55e5bfc
RD
12620#---------------------------------------------------------------------------
12621
12622class GBPosition(object):
248ed943
RD
12623 """
12624 This class represents the position of an item in a virtual grid of
12625 rows and columns managed by a `wx.GridBagSizer`. wxPython has
12626 typemaps that will automatically convert from a 2-element sequence of
12627 integers to a wx.GBPosition, so you can use the more pythonic
12628 representation of the position nearly transparently in Python code.
12629 """
554f62e9
RD
12630 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12631 __repr__ = _swig_repr
12632 def __init__(self, *args, **kwargs):
248ed943
RD
12633 """
12634 __init__(self, int row=0, int col=0) -> GBPosition
12635
12636 This class represents the position of an item in a virtual grid of
12637 rows and columns managed by a `wx.GridBagSizer`. wxPython has
12638 typemaps that will automatically convert from a 2-element sequence of
12639 integers to a wx.GBPosition, so you can use the more pythonic
12640 representation of the position nearly transparently in Python code.
12641 """
554f62e9
RD
12642 _core_.GBPosition_swiginit(self,_core_.new_GBPosition(*args, **kwargs))
12643 __swig_destroy__ = _core_.delete_GBPosition
12644 __del__ = lambda self : None;
d55e5bfc
RD
12645 def GetRow(*args, **kwargs):
12646 """GetRow(self) -> int"""
12647 return _core_.GBPosition_GetRow(*args, **kwargs)
12648
12649 def GetCol(*args, **kwargs):
12650 """GetCol(self) -> int"""
12651 return _core_.GBPosition_GetCol(*args, **kwargs)
12652
12653 def SetRow(*args, **kwargs):
12654 """SetRow(self, int row)"""
12655 return _core_.GBPosition_SetRow(*args, **kwargs)
12656
12657 def SetCol(*args, **kwargs):
12658 """SetCol(self, int col)"""
12659 return _core_.GBPosition_SetCol(*args, **kwargs)
12660
12661 def __eq__(*args, **kwargs):
e9d6f3a4
RD
12662 """
12663 __eq__(self, PyObject other) -> bool
12664
12665 Compare GBPosition for equality.
12666 """
d55e5bfc
RD
12667 return _core_.GBPosition___eq__(*args, **kwargs)
12668
12669 def __ne__(*args, **kwargs):
e9d6f3a4
RD
12670 """
12671 __ne__(self, PyObject other) -> bool
12672
12673 Compare GBPosition for inequality.
12674 """
d55e5bfc
RD
12675 return _core_.GBPosition___ne__(*args, **kwargs)
12676
12677 def Set(*args, **kwargs):
12678 """Set(self, int row=0, int col=0)"""
12679 return _core_.GBPosition_Set(*args, **kwargs)
12680
12681 def Get(*args, **kwargs):
12682 """Get(self) -> PyObject"""
12683 return _core_.GBPosition_Get(*args, **kwargs)
12684
79fccf9d 12685 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD
12686 def __str__(self): return str(self.Get())
12687 def __repr__(self): return 'wx.GBPosition'+str(self.Get())
12688 def __len__(self): return len(self.Get())
12689 def __getitem__(self, index): return self.Get()[index]
12690 def __setitem__(self, index, val):
12691 if index == 0: self.SetRow(val)
12692 elif index == 1: self.SetCol(val)
12693 else: raise IndexError
12694 def __nonzero__(self): return self.Get() != (0,0)
12695 __safe_for_unpickling__ = True
12696 def __reduce__(self): return (wx.GBPosition, self.Get())
12697
12698 row = property(GetRow, SetRow)
12699 col = property(GetCol, SetCol)
12700
2131d850 12701_core_.GBPosition_swigregister(GBPosition)
d55e5bfc
RD
12702
12703class GBSpan(object):
248ed943
RD
12704 """
12705 This class is used to hold the row and column spanning attributes of
12706 items in a `wx.GridBagSizer`. wxPython has typemaps that will
12707 automatically convert from a 2-element sequence of integers to a
12708 wx.GBSpan, so you can use the more pythonic representation of the span
12709 nearly transparently in Python code.
12710
12711 """
554f62e9
RD
12712 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12713 __repr__ = _swig_repr
12714 def __init__(self, *args, **kwargs):
248ed943
RD
12715 """
12716 __init__(self, int rowspan=1, int colspan=1) -> GBSpan
12717
12718 Construct a new wxGBSpan, optionally setting the rowspan and
12719 colspan. The default is (1,1). (Meaning that the item occupies one
12720 cell in each direction.
12721 """
554f62e9
RD
12722 _core_.GBSpan_swiginit(self,_core_.new_GBSpan(*args, **kwargs))
12723 __swig_destroy__ = _core_.delete_GBSpan
12724 __del__ = lambda self : None;
d55e5bfc
RD
12725 def GetRowspan(*args, **kwargs):
12726 """GetRowspan(self) -> int"""
12727 return _core_.GBSpan_GetRowspan(*args, **kwargs)
12728
12729 def GetColspan(*args, **kwargs):
12730 """GetColspan(self) -> int"""
12731 return _core_.GBSpan_GetColspan(*args, **kwargs)
12732
12733 def SetRowspan(*args, **kwargs):
12734 """SetRowspan(self, int rowspan)"""
12735 return _core_.GBSpan_SetRowspan(*args, **kwargs)
12736
12737 def SetColspan(*args, **kwargs):
12738 """SetColspan(self, int colspan)"""
12739 return _core_.GBSpan_SetColspan(*args, **kwargs)
12740
12741 def __eq__(*args, **kwargs):
e9d6f3a4
RD
12742 """
12743 __eq__(self, PyObject other) -> bool
12744
12745 Compare wxGBSpan for equality.
12746 """
d55e5bfc
RD
12747 return _core_.GBSpan___eq__(*args, **kwargs)
12748
12749 def __ne__(*args, **kwargs):
e9d6f3a4
RD
12750 """
12751 __ne__(self, PyObject other) -> bool
12752
12753 Compare GBSpan for inequality.
12754 """
d55e5bfc
RD
12755 return _core_.GBSpan___ne__(*args, **kwargs)
12756
12757 def Set(*args, **kwargs):
12758 """Set(self, int rowspan=1, int colspan=1)"""
12759 return _core_.GBSpan_Set(*args, **kwargs)
12760
12761 def Get(*args, **kwargs):
12762 """Get(self) -> PyObject"""
12763 return _core_.GBSpan_Get(*args, **kwargs)
12764
79fccf9d 12765 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD
12766 def __str__(self): return str(self.Get())
12767 def __repr__(self): return 'wx.GBSpan'+str(self.Get())
12768 def __len__(self): return len(self.Get())
12769 def __getitem__(self, index): return self.Get()[index]
12770 def __setitem__(self, index, val):
12771 if index == 0: self.SetRowspan(val)
12772 elif index == 1: self.SetColspan(val)
12773 else: raise IndexError
12774 def __nonzero__(self): return self.Get() != (0,0)
12775 __safe_for_unpickling__ = True
12776 def __reduce__(self): return (wx.GBSpan, self.Get())
12777
12778 rowspan = property(GetRowspan, SetRowspan)
12779 colspan = property(GetColspan, SetColspan)
12780
2131d850 12781_core_.GBSpan_swigregister(GBSpan)
d55e5bfc
RD
12782
12783class GBSizerItem(SizerItem):
248ed943
RD
12784 """
12785 The wx.GBSizerItem class is used to track the additional data about
12786 items in a `wx.GridBagSizer` such as the item's position in the grid
12787 and how many rows or columns it spans.
12788
12789 """
554f62e9
RD
12790 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12791 __repr__ = _swig_repr
12792 def __init__(self, *args, **kwargs):
248ed943
RD
12793 """
12794 __init__(self) -> GBSizerItem
12795
12796 Constructs an empty wx.GBSizerItem. Either a window, sizer or spacer
12797 size will need to be set, as well as a position and span before this
12798 item can be used in a Sizer.
12799
12800 You will probably never need to create a wx.GBSizerItem directly as they
12801 are created automatically when the sizer's Add method is called.
12802 """
554f62e9
RD
12803 _core_.GBSizerItem_swiginit(self,_core_.new_GBSizerItem(*args, **kwargs))
12804 __swig_destroy__ = _core_.delete_GBSizerItem
12805 __del__ = lambda self : None;
d55e5bfc 12806 def GetPos(*args, **kwargs):
248ed943
RD
12807 """
12808 GetPos(self) -> GBPosition
12809
12810 Get the grid position of the item
12811 """
d55e5bfc
RD
12812 return _core_.GBSizerItem_GetPos(*args, **kwargs)
12813
12814 def GetPosTuple(self): return self.GetPos().Get()
12815 def GetSpan(*args, **kwargs):
248ed943
RD
12816 """
12817 GetSpan(self) -> GBSpan
12818
12819 Get the row and column spanning of the item
12820 """
d55e5bfc
RD
12821 return _core_.GBSizerItem_GetSpan(*args, **kwargs)
12822
12823 def GetSpanTuple(self): return self.GetSpan().Get()
12824 def SetPos(*args, **kwargs):
248ed943
RD
12825 """
12826 SetPos(self, GBPosition pos) -> bool
12827
12828 If the item is already a member of a sizer then first ensure that
12829 there is no other item that would intersect with this one at the new
12830 position, then set the new position. Returns True if the change is
12831 successful and after the next Layout() the item will be moved.
12832 """
d55e5bfc
RD
12833 return _core_.GBSizerItem_SetPos(*args, **kwargs)
12834
12835 def SetSpan(*args, **kwargs):
248ed943
RD
12836 """
12837 SetSpan(self, GBSpan span) -> bool
12838
12839 If the item is already a member of a sizer then first ensure that
12840 there is no other item that would intersect with this one with its new
12841 spanning size, then set the new spanning. Returns True if the change
12842 is successful and after the next Layout() the item will be resized.
12843
12844 """
d55e5bfc
RD
12845 return _core_.GBSizerItem_SetSpan(*args, **kwargs)
12846
248ed943 12847 def Intersects(*args, **kwargs):
d55e5bfc
RD
12848 """
12849 Intersects(self, GBSizerItem other) -> bool
248ed943
RD
12850
12851 Returns True if this item and the other item instersect.
d55e5bfc 12852 """
248ed943
RD
12853 return _core_.GBSizerItem_Intersects(*args, **kwargs)
12854
12855 def IntersectsPos(*args, **kwargs):
12856 """
12857 IntersectsPos(self, GBPosition pos, GBSpan span) -> bool
12858
12859 Returns True if the given pos/span would intersect with this item.
12860 """
12861 return _core_.GBSizerItem_IntersectsPos(*args, **kwargs)
d55e5bfc
RD
12862
12863 def GetEndPos(*args, **kwargs):
248ed943
RD
12864 """
12865 GetEndPos(self) -> GBPosition
12866
12867 Get the row and column of the endpoint of this item.
12868 """
d55e5bfc
RD
12869 return _core_.GBSizerItem_GetEndPos(*args, **kwargs)
12870
12871 def GetGBSizer(*args, **kwargs):
248ed943
RD
12872 """
12873 GetGBSizer(self) -> GridBagSizer
12874
12875 Get the sizer this item is a member of.
12876 """
d55e5bfc
RD
12877 return _core_.GBSizerItem_GetGBSizer(*args, **kwargs)
12878
12879 def SetGBSizer(*args, **kwargs):
248ed943
RD
12880 """
12881 SetGBSizer(self, GridBagSizer sizer)
12882
12883 Set the sizer this item is a member of.
12884 """
d55e5bfc
RD
12885 return _core_.GBSizerItem_SetGBSizer(*args, **kwargs)
12886
97ab0f6a
RD
12887 EndPos = property(GetEndPos,doc="See `GetEndPos`")
12888 GBSizer = property(GetGBSizer,SetGBSizer,doc="See `GetGBSizer` and `SetGBSizer`")
12889 Pos = property(GetPos,SetPos,doc="See `GetPos` and `SetPos`")
12890 Span = property(GetSpan,SetSpan,doc="See `GetSpan` and `SetSpan`")
2131d850 12891_core_.GBSizerItem_swigregister(GBSizerItem)
d55e5bfc
RD
12892DefaultSpan = cvar.DefaultSpan
12893
12894def GBSizerItemWindow(*args, **kwargs):
12895 """
12896 GBSizerItemWindow(Window window, GBPosition pos, GBSpan span, int flag,
248ed943
RD
12897 int border, PyObject userData=None) -> GBSizerItem
12898
12899 Construct a `wx.GBSizerItem` for a window.
d55e5bfc
RD
12900 """
12901 val = _core_.new_GBSizerItemWindow(*args, **kwargs)
d55e5bfc
RD
12902 return val
12903
12904def GBSizerItemSizer(*args, **kwargs):
12905 """
12906 GBSizerItemSizer(Sizer sizer, GBPosition pos, GBSpan span, int flag,
248ed943
RD
12907 int border, PyObject userData=None) -> GBSizerItem
12908
12909 Construct a `wx.GBSizerItem` for a sizer
d55e5bfc
RD
12910 """
12911 val = _core_.new_GBSizerItemSizer(*args, **kwargs)
d55e5bfc
RD
12912 return val
12913
12914def GBSizerItemSpacer(*args, **kwargs):
12915 """
12916 GBSizerItemSpacer(int width, int height, GBPosition pos, GBSpan span,
248ed943
RD
12917 int flag, int border, PyObject userData=None) -> GBSizerItem
12918
12919 Construct a `wx.GBSizerItem` for a spacer.
d55e5bfc
RD
12920 """
12921 val = _core_.new_GBSizerItemSpacer(*args, **kwargs)
d55e5bfc
RD
12922 return val
12923
12924class GridBagSizer(FlexGridSizer):
248ed943
RD
12925 """
12926 A `wx.Sizer` that can lay out items in a virtual grid like a
12927 `wx.FlexGridSizer` but in this case explicit positioning of the items
12928 is allowed using `wx.GBPosition`, and items can optionally span more
12929 than one row and/or column using `wx.GBSpan`. The total size of the
12930 virtual grid is determined by the largest row and column that items are
12931 positioned at, adjusted for spanning.
12932
12933 """
554f62e9
RD
12934 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12935 __repr__ = _swig_repr
12936 def __init__(self, *args, **kwargs):
248ed943
RD
12937 """
12938 __init__(self, int vgap=0, int hgap=0) -> GridBagSizer
12939
12940 Constructor, with optional parameters to specify the gap between the
12941 rows and columns.
12942 """
554f62e9 12943 _core_.GridBagSizer_swiginit(self,_core_.new_GridBagSizer(*args, **kwargs))
c9c2cf70
RD
12944 self._setOORInfo(self)
12945
d55e5bfc
RD
12946 def Add(*args, **kwargs):
12947 """
248ed943 12948 Add(self, item, GBPosition pos, GBSpan span=DefaultSpan, int flag=0,
c1cb24a4 12949 int border=0, userData=None) -> wx.GBSizerItem
248ed943
RD
12950
12951 Adds an item to the sizer at the grid cell *pos*, optionally spanning
12952 more than one row or column as specified with *span*. The remaining
12953 args behave similarly to `wx.Sizer.Add`.
12954
12955 Returns True if the item was successfully placed at the given cell
12956 position, False if something was already there.
12957
d55e5bfc
RD
12958 """
12959 return _core_.GridBagSizer_Add(*args, **kwargs)
12960
12961 def AddItem(*args, **kwargs):
248ed943 12962 """
c1cb24a4 12963 Add(self, GBSizerItem item) -> wx.GBSizerItem
248ed943
RD
12964
12965 Add an item to the sizer using a `wx.GBSizerItem`. Returns True if
12966 the item was successfully placed at its given cell position, False if
12967 something was already there.
12968 """
d55e5bfc
RD
12969 return _core_.GridBagSizer_AddItem(*args, **kwargs)
12970
84f85550
RD
12971 def GetCellSize(*args, **kwargs):
12972 """
12973 GetCellSize(self, int row, int col) -> Size
12974
12975 Get the size of the specified cell, including hgap and
12976 vgap. Only valid after a Layout.
12977 """
12978 return _core_.GridBagSizer_GetCellSize(*args, **kwargs)
12979
d55e5bfc 12980 def GetEmptyCellSize(*args, **kwargs):
248ed943
RD
12981 """
12982 GetEmptyCellSize(self) -> Size
12983
12984 Get the size used for cells in the grid with no item.
12985 """
d55e5bfc
RD
12986 return _core_.GridBagSizer_GetEmptyCellSize(*args, **kwargs)
12987
12988 def SetEmptyCellSize(*args, **kwargs):
248ed943
RD
12989 """
12990 SetEmptyCellSize(self, Size sz)
12991
12992 Set the size used for cells in the grid with no item.
12993 """
d55e5bfc
RD
12994 return _core_.GridBagSizer_SetEmptyCellSize(*args, **kwargs)
12995
12996 def GetItemPosition(*args):
12997 """
248ed943
RD
12998 GetItemPosition(self, item) -> GBPosition
12999
13000 Get the grid position of the specified *item* where *item* is either a
13001 window or subsizer that is a member of this sizer, or a zero-based
13002 index of an item.
d55e5bfc
RD
13003 """
13004 return _core_.GridBagSizer_GetItemPosition(*args)
13005
13006 def SetItemPosition(*args):
13007 """
248ed943
RD
13008 SetItemPosition(self, item, GBPosition pos) -> bool
13009
13010 Set the grid position of the specified *item* where *item* is either a
13011 window or subsizer that is a member of this sizer, or a zero-based
13012 index of an item. Returns True on success. If the move is not
13013 allowed (because an item is already there) then False is returned.
13014
d55e5bfc
RD
13015 """
13016 return _core_.GridBagSizer_SetItemPosition(*args)
13017
13018 def GetItemSpan(*args):
13019 """
248ed943
RD
13020 GetItemSpan(self, item) -> GBSpan
13021
13022 Get the row/col spanning of the specified *item* where *item* is
13023 either a window or subsizer that is a member of this sizer, or a
13024 zero-based index of an item.
d55e5bfc
RD
13025 """
13026 return _core_.GridBagSizer_GetItemSpan(*args)
13027
13028 def SetItemSpan(*args):
13029 """
248ed943
RD
13030 SetItemSpan(self, item, GBSpan span) -> bool
13031
13032 Set the row/col spanning of the specified *item* where *item* is
13033 either a window or subsizer that is a member of this sizer, or a
13034 zero-based index of an item. Returns True on success. If the move is
13035 not allowed (because an item is already there) then False is returned.
d55e5bfc
RD
13036 """
13037 return _core_.GridBagSizer_SetItemSpan(*args)
13038
13039 def FindItem(*args):
13040 """
248ed943
RD
13041 FindItem(self, item) -> GBSizerItem
13042
13043 Find the sizer item for the given window or subsizer, returns None if
13044 not found. (non-recursive)
d55e5bfc
RD
13045 """
13046 return _core_.GridBagSizer_FindItem(*args)
13047
13048 def FindItemAtPosition(*args, **kwargs):
248ed943
RD
13049 """
13050 FindItemAtPosition(self, GBPosition pos) -> GBSizerItem
13051
13052 Return the sizer item for the given grid cell, or None if there is no
13053 item at that position. (non-recursive)
13054 """
d55e5bfc
RD
13055 return _core_.GridBagSizer_FindItemAtPosition(*args, **kwargs)
13056
13057 def FindItemAtPoint(*args, **kwargs):
248ed943
RD
13058 """
13059 FindItemAtPoint(self, Point pt) -> GBSizerItem
13060
13061 Return the sizer item located at the point given in *pt*, or None if
13062 there is no item at that point. The (x,y) coordinates in pt correspond
13063 to the client coordinates of the window using the sizer for
13064 layout. (non-recursive)
13065 """
d55e5bfc
RD
13066 return _core_.GridBagSizer_FindItemAtPoint(*args, **kwargs)
13067
248ed943
RD
13068 def CheckForIntersection(*args, **kwargs):
13069 """
13070 CheckForIntersection(self, GBSizerItem item, GBSizerItem excludeItem=None) -> bool
d55e5bfc 13071
248ed943
RD
13072 Look at all items and see if any intersect (or would overlap) the
13073 given *item*. Returns True if so, False if there would be no overlap.
13074 If an *excludeItem* is given then it will not be checked for
13075 intersection, for example it may be the item we are checking the
13076 position of.
d55e5bfc 13077
248ed943
RD
13078 """
13079 return _core_.GridBagSizer_CheckForIntersection(*args, **kwargs)
d55e5bfc 13080
248ed943 13081 def CheckForIntersectionPos(*args, **kwargs):
d55e5bfc 13082 """
248ed943
RD
13083 CheckForIntersectionPos(self, GBPosition pos, GBSpan span, GBSizerItem excludeItem=None) -> bool
13084
13085 Look at all items and see if any intersect (or would overlap) the
13086 given position and span. Returns True if so, False if there would be
13087 no overlap. If an *excludeItem* is given then it will not be checked
13088 for intersection, for example it may be the item we are checking the
13089 position of.
d55e5bfc 13090 """
248ed943 13091 return _core_.GridBagSizer_CheckForIntersectionPos(*args, **kwargs)
d55e5bfc 13092
2131d850 13093_core_.GridBagSizer_swigregister(GridBagSizer)
d55e5bfc
RD
13094
13095#---------------------------------------------------------------------------
13096
13097Left = _core_.Left
13098Top = _core_.Top
13099Right = _core_.Right
13100Bottom = _core_.Bottom
13101Width = _core_.Width
13102Height = _core_.Height
13103Centre = _core_.Centre
13104Center = _core_.Center
13105CentreX = _core_.CentreX
13106CentreY = _core_.CentreY
13107Unconstrained = _core_.Unconstrained
13108AsIs = _core_.AsIs
13109PercentOf = _core_.PercentOf
13110Above = _core_.Above
13111Below = _core_.Below
13112LeftOf = _core_.LeftOf
13113RightOf = _core_.RightOf
13114SameAs = _core_.SameAs
13115Absolute = _core_.Absolute
13116class IndividualLayoutConstraint(Object):
13117 """
79fccf9d
RD
13118 Objects of this class are stored in the `wx.LayoutConstraints` class as
13119 one of eight possible constraints that a window can be involved in.
13120 You will never need to create an instance of
13121 wx.IndividualLayoutConstraint, rather you should create a
13122 `wx.LayoutConstraints` instance and use the individual contstraints
d55e5bfc 13123 that it contains.
d55e5bfc 13124 """
554f62e9
RD
13125 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
13126 def __init__(self): raise AttributeError, "No constructor defined"
13127 __repr__ = _swig_repr
d55e5bfc 13128 def Set(*args, **kwargs):
79fccf9d
RD
13129 """
13130 Set(self, int rel, Window otherW, int otherE, int val=0, int marg=wxLAYOUT_DEFAULT_MARGIN)
13131
13132 Sets the properties of the constraint. Normally called by one of the
13133 convenience functions such as Above, RightOf, SameAs.
13134 """
d55e5bfc
RD
13135 return _core_.IndividualLayoutConstraint_Set(*args, **kwargs)
13136
13137 def LeftOf(*args, **kwargs):
13138 """
13139 LeftOf(self, Window sibling, int marg=0)
13140
79fccf9d
RD
13141 Constrains this edge to be to the left of the given window, with an
13142 optional margin. Implicitly, this is relative to the left edge of the
13143 other window.
d55e5bfc
RD
13144 """
13145 return _core_.IndividualLayoutConstraint_LeftOf(*args, **kwargs)
13146
13147 def RightOf(*args, **kwargs):
13148 """
13149 RightOf(self, Window sibling, int marg=0)
13150
79fccf9d
RD
13151 Constrains this edge to be to the right of the given window, with an
13152 optional margin. Implicitly, this is relative to the right edge of the
13153 other window.
d55e5bfc
RD
13154 """
13155 return _core_.IndividualLayoutConstraint_RightOf(*args, **kwargs)
13156
13157 def Above(*args, **kwargs):
13158 """
13159 Above(self, Window sibling, int marg=0)
13160
79fccf9d
RD
13161 Constrains this edge to be above the given window, with an optional
13162 margin. Implicitly, this is relative to the top edge of the other
13163 window.
d55e5bfc
RD
13164 """
13165 return _core_.IndividualLayoutConstraint_Above(*args, **kwargs)
13166
13167 def Below(*args, **kwargs):
13168 """
13169 Below(self, Window sibling, int marg=0)
13170
79fccf9d
RD
13171 Constrains this edge to be below the given window, with an optional
13172 margin. Implicitly, this is relative to the bottom edge of the other
13173 window.
d55e5bfc
RD
13174 """
13175 return _core_.IndividualLayoutConstraint_Below(*args, **kwargs)
13176
13177 def SameAs(*args, **kwargs):
13178 """
13179 SameAs(self, Window otherW, int edge, int marg=0)
13180
79fccf9d
RD
13181 Constrains this edge or dimension to be to the same as the edge of the
13182 given window, with an optional margin.
d55e5bfc
RD
13183 """
13184 return _core_.IndividualLayoutConstraint_SameAs(*args, **kwargs)
13185
13186 def PercentOf(*args, **kwargs):
13187 """
13188 PercentOf(self, Window otherW, int wh, int per)
13189
79fccf9d
RD
13190 Constrains this edge or dimension to be to a percentage of the given
13191 window, with an optional margin.
d55e5bfc
RD
13192 """
13193 return _core_.IndividualLayoutConstraint_PercentOf(*args, **kwargs)
13194
13195 def Absolute(*args, **kwargs):
13196 """
13197 Absolute(self, int val)
13198
79fccf9d 13199 Constrains this edge or dimension to be the given absolute value.
d55e5bfc
RD
13200 """
13201 return _core_.IndividualLayoutConstraint_Absolute(*args, **kwargs)
13202
13203 def Unconstrained(*args, **kwargs):
13204 """
13205 Unconstrained(self)
13206
79fccf9d
RD
13207 Sets this edge or dimension to be unconstrained, that is, dependent on
13208 other edges and dimensions from which this value can be deduced.
d55e5bfc
RD
13209 """
13210 return _core_.IndividualLayoutConstraint_Unconstrained(*args, **kwargs)
13211
13212 def AsIs(*args, **kwargs):
13213 """
13214 AsIs(self)
13215
79fccf9d
RD
13216 Sets this edge or constraint to be whatever the window's value is at
13217 the moment. If either of the width and height constraints are *as is*,
13218 the window will not be resized, but moved instead. This is important
13219 when considering panel items which are intended to have a default
13220 size, such as a button, which may take its size from the size of the
13221 button label.
d55e5bfc
RD
13222 """
13223 return _core_.IndividualLayoutConstraint_AsIs(*args, **kwargs)
13224
13225 def GetOtherWindow(*args, **kwargs):
13226 """GetOtherWindow(self) -> Window"""
13227 return _core_.IndividualLayoutConstraint_GetOtherWindow(*args, **kwargs)
13228
13229 def GetMyEdge(*args, **kwargs):
13230 """GetMyEdge(self) -> int"""
13231 return _core_.IndividualLayoutConstraint_GetMyEdge(*args, **kwargs)
13232
13233 def SetEdge(*args, **kwargs):
13234 """SetEdge(self, int which)"""
13235 return _core_.IndividualLayoutConstraint_SetEdge(*args, **kwargs)
13236
13237 def SetValue(*args, **kwargs):
13238 """SetValue(self, int v)"""
13239 return _core_.IndividualLayoutConstraint_SetValue(*args, **kwargs)
13240
13241 def GetMargin(*args, **kwargs):
13242 """GetMargin(self) -> int"""
13243 return _core_.IndividualLayoutConstraint_GetMargin(*args, **kwargs)
13244
13245 def SetMargin(*args, **kwargs):
13246 """SetMargin(self, int m)"""
13247 return _core_.IndividualLayoutConstraint_SetMargin(*args, **kwargs)
13248
13249 def GetValue(*args, **kwargs):
13250 """GetValue(self) -> int"""
13251 return _core_.IndividualLayoutConstraint_GetValue(*args, **kwargs)
13252
13253 def GetPercent(*args, **kwargs):
13254 """GetPercent(self) -> int"""
13255 return _core_.IndividualLayoutConstraint_GetPercent(*args, **kwargs)
13256
13257 def GetOtherEdge(*args, **kwargs):
13258 """GetOtherEdge(self) -> int"""
13259 return _core_.IndividualLayoutConstraint_GetOtherEdge(*args, **kwargs)
13260
13261 def GetDone(*args, **kwargs):
13262 """GetDone(self) -> bool"""
13263 return _core_.IndividualLayoutConstraint_GetDone(*args, **kwargs)
13264
13265 def SetDone(*args, **kwargs):
13266 """SetDone(self, bool d)"""
13267 return _core_.IndividualLayoutConstraint_SetDone(*args, **kwargs)
13268
13269 def GetRelationship(*args, **kwargs):
13270 """GetRelationship(self) -> int"""
13271 return _core_.IndividualLayoutConstraint_GetRelationship(*args, **kwargs)
13272
13273 def SetRelationship(*args, **kwargs):
13274 """SetRelationship(self, int r)"""
13275 return _core_.IndividualLayoutConstraint_SetRelationship(*args, **kwargs)
13276
13277 def ResetIfWin(*args, **kwargs):
13278 """
13279 ResetIfWin(self, Window otherW) -> bool
13280
13281 Reset constraint if it mentions otherWin
13282 """
13283 return _core_.IndividualLayoutConstraint_ResetIfWin(*args, **kwargs)
13284
13285 def SatisfyConstraint(*args, **kwargs):
13286 """
13287 SatisfyConstraint(self, LayoutConstraints constraints, Window win) -> bool
13288
13289 Try to satisfy constraint
13290 """
13291 return _core_.IndividualLayoutConstraint_SatisfyConstraint(*args, **kwargs)
13292
13293 def GetEdge(*args, **kwargs):
13294 """
13295 GetEdge(self, int which, Window thisWin, Window other) -> int
13296
13297 Get the value of this edge or dimension, or if this
13298 is not determinable, -1.
13299 """
13300 return _core_.IndividualLayoutConstraint_GetEdge(*args, **kwargs)
13301
97ab0f6a
RD
13302 Done = property(GetDone,SetDone,doc="See `GetDone` and `SetDone`")
13303 Margin = property(GetMargin,SetMargin,doc="See `GetMargin` and `SetMargin`")
13304 MyEdge = property(GetMyEdge,doc="See `GetMyEdge`")
13305 OtherEdge = property(GetOtherEdge,doc="See `GetOtherEdge`")
13306 OtherWindow = property(GetOtherWindow,doc="See `GetOtherWindow`")
13307 Percent = property(GetPercent,doc="See `GetPercent`")
13308 Relationship = property(GetRelationship,SetRelationship,doc="See `GetRelationship` and `SetRelationship`")
13309 Value = property(GetValue,SetValue,doc="See `GetValue` and `SetValue`")
2131d850 13310_core_.IndividualLayoutConstraint_swigregister(IndividualLayoutConstraint)
d55e5bfc
RD
13311
13312class LayoutConstraints(Object):
13313 """
79fccf9d
RD
13314 **Note:** constraints are now deprecated and you should use sizers
13315 instead.
d55e5bfc 13316
79fccf9d
RD
13317 Objects of this class can be associated with a window to define its
13318 layout constraints, with respect to siblings or its parent.
d55e5bfc
RD
13319
13320 The class consists of the following eight constraints of class
13321 wx.IndividualLayoutConstraint, some or all of which should be accessed
13322 directly to set the appropriate constraints.
13323
13324 * left: represents the left hand edge of the window
13325 * right: represents the right hand edge of the window
13326 * top: represents the top edge of the window
13327 * bottom: represents the bottom edge of the window
13328 * width: represents the width of the window
13329 * height: represents the height of the window
13330 * centreX: represents the horizontal centre point of the window
13331 * centreY: represents the vertical centre point of the window
13332
79fccf9d
RD
13333 Most constraints are initially set to have the relationship
13334 wxUnconstrained, which means that their values should be calculated by
13335 looking at known constraints. The exceptions are width and height,
13336 which are set to wxAsIs to ensure that if the user does not specify a
13337 constraint, the existing width and height will be used, to be
13338 compatible with panel items which often have take a default size. If
13339 the constraint is ``wx.AsIs``, the dimension will not be changed.
13340
13341 :see: `wx.IndividualLayoutConstraint`, `wx.Window.SetConstraints`
d55e5bfc
RD
13342
13343 """
554f62e9
RD
13344 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
13345 __repr__ = _swig_repr
d55e5bfc
RD
13346 left = property(_core_.LayoutConstraints_left_get)
13347 top = property(_core_.LayoutConstraints_top_get)
13348 right = property(_core_.LayoutConstraints_right_get)
13349 bottom = property(_core_.LayoutConstraints_bottom_get)
13350 width = property(_core_.LayoutConstraints_width_get)
13351 height = property(_core_.LayoutConstraints_height_get)
13352 centreX = property(_core_.LayoutConstraints_centreX_get)
13353 centreY = property(_core_.LayoutConstraints_centreY_get)
554f62e9 13354 def __init__(self, *args, **kwargs):
d55e5bfc 13355 """__init__(self) -> LayoutConstraints"""
554f62e9
RD
13356 _core_.LayoutConstraints_swiginit(self,_core_.new_LayoutConstraints(*args, **kwargs))
13357 __swig_destroy__ = _core_.delete_LayoutConstraints
13358 __del__ = lambda self : None;
d55e5bfc
RD
13359 def SatisfyConstraints(*args, **kwargs):
13360 """SatisfyConstraints(Window win) -> (areSatisfied, noChanges)"""
13361 return _core_.LayoutConstraints_SatisfyConstraints(*args, **kwargs)
13362
13363 def AreSatisfied(*args, **kwargs):
13364 """AreSatisfied(self) -> bool"""
13365 return _core_.LayoutConstraints_AreSatisfied(*args, **kwargs)
13366
2131d850 13367_core_.LayoutConstraints_swigregister(LayoutConstraints)
d55e5bfc
RD
13368
13369#----------------------------------------------------------------------------
13370
13371# Use Python's bool constants if available, make some if not
13372try:
13373 True
13374except NameError:
13375 __builtins__.True = 1==1
13376 __builtins__.False = 1==0
13377 def bool(value): return not not value
13378 __builtins__.bool = bool
13379
13380
13381
13382# workarounds for bad wxRTTI names
13383__wxPyPtrTypeMap['wxGauge95'] = 'wxGauge'
13384__wxPyPtrTypeMap['wxSlider95'] = 'wxSlider'
13385__wxPyPtrTypeMap['wxStatusBar95'] = 'wxStatusBar'
13386
13387
13388#----------------------------------------------------------------------------
13389# Load version numbers from __version__... Ensure that major and minor
0f63ec68 13390# versions are the same for both wxPython and wxWidgets.
d55e5bfc
RD
13391
13392from __version__ import *
13393__version__ = VERSION_STRING
13394
0f63ec68
RD
13395assert MAJOR_VERSION == _core_.MAJOR_VERSION, "wxPython/wxWidgets version mismatch"
13396assert MINOR_VERSION == _core_.MINOR_VERSION, "wxPython/wxWidgets version mismatch"
d55e5bfc
RD
13397if RELEASE_VERSION != _core_.RELEASE_VERSION:
13398 import warnings
0f63ec68 13399 warnings.warn("wxPython/wxWidgets release number mismatch")
d55e5bfc
RD
13400
13401#----------------------------------------------------------------------------
13402
70b7a5fe
RD
13403# Set wxPython's default string<-->unicode conversion encoding from
13404# the locale, but only if Python's default hasn't been changed. (We
13405# assume that if the user has customized it already then that is the
13406# encoding we need to use as well.)
13407#
13408# The encoding selected here is used when string or unicode objects
13409# need to be converted in order to pass them to wxWidgets. Please be
13410# aware that the default encoding within the same locale may be
13411# slightly different on different platforms. For example, please see
62d32a5f
RD
13412# http://www.alanwood.net/demos/charsetdiffs.html for differences
13413# between the common latin/roman encodings.
396fb509
RD
13414
13415default = _sys.getdefaultencoding()
13416if default == 'ascii':
13417 import locale
13418 import codecs
13419 try:
13420 default = locale.getdefaultlocale()[1]
13421 codecs.lookup(default)
70b7a5fe 13422 except (ValueError, LookupError, TypeError):
396fb509
RD
13423 default = _sys.getdefaultencoding()
13424 del locale
13425 del codecs
5cbf236d
RD
13426if default:
13427 wx.SetDefaultPyEncoding(default)
13428del default
5cbf236d
RD
13429
13430#----------------------------------------------------------------------------
13431
d55e5bfc
RD
13432class PyDeadObjectError(AttributeError):
13433 pass
13434
13435class _wxPyDeadObject(object):
13436 """
13437 Instances of wx objects that are OOR capable will have their __class__
13438 changed to this class when the C++ object is deleted. This should help
13439 prevent crashes due to referencing a bogus C++ pointer.
13440 """
13441 reprStr = "wxPython wrapper for DELETED %s object! (The C++ object no longer exists.)"
13442 attrStr = "The C++ part of the %s object has been deleted, attribute access no longer allowed."
13443
13444 def __repr__(self):
13445 if not hasattr(self, "_name"):
13446 self._name = "[unknown]"
13447 return self.reprStr % self._name
13448
13449 def __getattr__(self, *args):
13450 if not hasattr(self, "_name"):
13451 self._name = "[unknown]"
13452 raise PyDeadObjectError(self.attrStr % self._name)
13453
13454 def __nonzero__(self):
13455 return 0
13456
13457
13458
13459class PyUnbornObjectError(AttributeError):
13460 pass
13461
13462class _wxPyUnbornObject(object):
13463 """
13464 Some stock objects are created when the wx._core module is
13465 imported, but their C++ instance is not created until the wx.App
13466 object is created and initialized. These object instances will
13467 temporarily have their __class__ changed to this class so an
13468 exception will be raised if they are used before the C++ instance
13469 is ready.
13470 """
13471
13472 reprStr = "wxPython wrapper for UNBORN object! (The C++ object is not initialized yet.)"
13473 attrStr = "The C++ part of this object has not been initialized, attribute access not allowed."
13474
13475 def __repr__(self):
13476 #if not hasattr(self, "_name"):
13477 # self._name = "[unknown]"
13478 return self.reprStr #% self._name
13479
13480 def __getattr__(self, *args):
13481 #if not hasattr(self, "_name"):
13482 # self._name = "[unknown]"
13483 raise PyUnbornObjectError(self.attrStr) # % self._name )
13484
13485 def __nonzero__(self):
13486 return 0
13487
13488
13489#----------------------------------------------------------------------------
d55e5bfc
RD
13490
13491def CallAfter(callable, *args, **kw):
13492 """
13493 Call the specified function after the current and pending event
13494 handlers have been completed. This is also good for making GUI
0439c23b
RD
13495 method calls from non-GUI threads. Any extra positional or
13496 keyword args are passed on to the callable when it is called.
13497
846c181b 13498 :see: `wx.CallLater`
d55e5bfc
RD
13499 """
13500 app = wx.GetApp()
a001823c 13501 assert app is not None, 'No wx.App created yet'
d55e5bfc 13502
891bb194
RD
13503 if not hasattr(app, "_CallAfterId"):
13504 app._CallAfterId = wx.NewEventType()
13505 app.Connect(-1, -1, app._CallAfterId,
13506 lambda event: event.callable(*event.args, **event.kw) )
d55e5bfc 13507 evt = wx.PyEvent()
891bb194 13508 evt.SetEventType(app._CallAfterId)
d55e5bfc
RD
13509 evt.callable = callable
13510 evt.args = args
13511 evt.kw = kw
13512 wx.PostEvent(app, evt)
13513
d55e5bfc
RD
13514#----------------------------------------------------------------------------
13515
13516
846c181b 13517class CallLater:
d55e5bfc 13518 """
8ac8dba0 13519 A convenience class for `wx.Timer`, that calls the given callable
d55e5bfc
RD
13520 object once after the given amount of milliseconds, passing any
13521 positional or keyword args. The return value of the callable is
0439c23b 13522 availbale after it has been run with the `GetResult` method.
d55e5bfc
RD
13523
13524 If you don't need to get the return value or restart the timer
13525 then there is no need to hold a reference to this object. It will
13526 hold a reference to itself while the timer is running (the timer
13527 has a reference to self.Notify) but the cycle will be broken when
846c181b 13528 the timer completes, automatically cleaning up the wx.CallLater
d55e5bfc 13529 object.
0439c23b
RD
13530
13531 :see: `wx.CallAfter`
d55e5bfc
RD
13532 """
13533 def __init__(self, millis, callable, *args, **kwargs):
13534 self.millis = millis
13535 self.callable = callable
13536 self.SetArgs(*args, **kwargs)
13537 self.runCount = 0
13538 self.running = False
13539 self.hasRun = False
13540 self.result = None
13541 self.timer = None
13542 self.Start()
13543
13544 def __del__(self):
13545 self.Stop()
13546
13547
13548 def Start(self, millis=None, *args, **kwargs):
13549 """
13550 (Re)start the timer
13551 """
13552 self.hasRun = False
13553 if millis is not None:
13554 self.millis = millis
13555 if args or kwargs:
13556 self.SetArgs(*args, **kwargs)
13557 self.Stop()
13558 self.timer = wx.PyTimer(self.Notify)
13559 self.timer.Start(self.millis, wx.TIMER_ONE_SHOT)
13560 self.running = True
13561 Restart = Start
13562
13563
13564 def Stop(self):
13565 """
13566 Stop and destroy the timer.
13567 """
13568 if self.timer is not None:
13569 self.timer.Stop()
13570 self.timer = None
13571
13572
13573 def GetInterval(self):
13574 if self.timer is not None:
13575 return self.timer.GetInterval()
13576 else:
13577 return 0
13578
13579
13580 def IsRunning(self):
13581 return self.timer is not None and self.timer.IsRunning()
13582
13583
13584 def SetArgs(self, *args, **kwargs):
13585 """
13586 (Re)set the args passed to the callable object. This is
13587 useful in conjunction with Restart if you want to schedule a
13588 new call to the same callable object but with different
13589 parameters.
13590 """
13591 self.args = args
13592 self.kwargs = kwargs
13593
13594
13595 def HasRun(self):
13596 return self.hasRun
13597
13598 def GetResult(self):
13599 return self.result
13600
13601 def Notify(self):
13602 """
13603 The timer has expired so call the callable.
13604 """
13605 if self.callable and getattr(self.callable, 'im_self', True):
13606 self.runCount += 1
13607 self.running = False
13608 self.result = self.callable(*self.args, **self.kwargs)
13609 self.hasRun = True
13610 if not self.running:
13611 # if it wasn't restarted, then cleanup
13612 wx.CallAfter(self.Stop)
13613
97ab0f6a
RD
13614 Interval = property(GetInterval)
13615 Result = property(GetResult)
d55e5bfc
RD
13616
13617
846c181b
RD
13618class FutureCall(CallLater):
13619 """A compatibility alias for `CallLater`."""
13620
d55e5bfc
RD
13621#----------------------------------------------------------------------------
13622# Control which items in this module should be documented by epydoc.
13623# We allow only classes and functions, which will help reduce the size
13624# of the docs by filtering out the zillions of constants, EVT objects,
13625# and etc that don't make much sense by themselves, but are instead
13626# documented (or will be) as part of the classes/functions/methods
13627# where they should be used.
13628
c24da6d6
RD
13629class __DocFilter:
13630 """
13631 A filter for epydoc that only allows non-Ptr classes and
0f83f5da 13632 functions, in order to reduce the clutter in the API docs.
c24da6d6
RD
13633 """
13634 def __init__(self, globals):
13635 self._globals = globals
13636
13637 def __call__(self, name):
13638 import types
13639 obj = self._globals.get(name, None)
0f83f5da
RD
13640
13641 # only document classes and function
c24da6d6
RD
13642 if type(obj) not in [type, types.ClassType, types.FunctionType, types.BuiltinFunctionType]:
13643 return False
0f83f5da
RD
13644
13645 # skip other things that are private or will be documented as part of somethign else
554f62e9 13646 if name.startswith('_') or name.startswith('EVT') or name.endswith('_swigregister') or name.endswith('Ptr') :
c24da6d6 13647 return False
0f83f5da
RD
13648
13649 # skip functions that are duplicates of static functions in a class
13650 if name.find('_') != -1:
13651 cls = self._globals.get(name.split('_')[0], None)
13652 methname = name.split('_')[1]
13653 if hasattr(cls, methname) and type(getattr(cls, methname)) is types.FunctionType:
13654 return False
13655
c24da6d6 13656 return True
d55e5bfc
RD
13657
13658#----------------------------------------------------------------------------
13659#----------------------------------------------------------------------------
13660
13661# Import other modules in this package that should show up in the
13662# "core" wx namespace
13663from _gdi import *
13664from _windows import *
13665from _controls import *
13666from _misc import *
13667
d55e5bfc
RD
13668#----------------------------------------------------------------------------
13669#----------------------------------------------------------------------------
13670
13671
7449af73 13672