]> git.saurik.com Git - wxWidgets.git/blame - wxPython/src/msw/_core.py
projects / wxWidgets.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Add some missing wxPyBeginBlockThreads calls
[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
105ALWAYS_SHOW_SB = _core_.ALWAYS_SHOW_SB
106RETAINED = _core_.RETAINED
107BACKINGSTORE = _core_.BACKINGSTORE
108COLOURED = _core_.COLOURED
109FIXED_LENGTH = _core_.FIXED_LENGTH
110LB_NEEDED_SB = _core_.LB_NEEDED_SB
111LB_ALWAYS_SB = _core_.LB_ALWAYS_SB
112LB_SORT = _core_.LB_SORT
113LB_SINGLE = _core_.LB_SINGLE
114LB_MULTIPLE = _core_.LB_MULTIPLE
115LB_EXTENDED = _core_.LB_EXTENDED
116LB_OWNERDRAW = _core_.LB_OWNERDRAW
117LB_HSCROLL = _core_.LB_HSCROLL
118PROCESS_ENTER = _core_.PROCESS_ENTER
119PASSWORD = _core_.PASSWORD
120CB_SIMPLE = _core_.CB_SIMPLE
121CB_DROPDOWN = _core_.CB_DROPDOWN
122CB_SORT = _core_.CB_SORT
123CB_READONLY = _core_.CB_READONLY
124RA_HORIZONTAL = _core_.RA_HORIZONTAL
125RA_VERTICAL = _core_.RA_VERTICAL
126RA_SPECIFY_ROWS = _core_.RA_SPECIFY_ROWS
127RA_SPECIFY_COLS = _core_.RA_SPECIFY_COLS
fef4c27a 128RA_USE_CHECKBOX = _core_.RA_USE_CHECKBOX
d55e5bfc
RD		 129RB_GROUP = _core_.RB_GROUP
130RB_SINGLE = _core_.RB_SINGLE
d55e5bfc
RD		 131SB_HORIZONTAL = _core_.SB_HORIZONTAL
132SB_VERTICAL = _core_.SB_VERTICAL
fef4c27a 133RB_USE_CHECKBOX = _core_.RB_USE_CHECKBOX
d55e5bfc
RD		 134ST_SIZEGRIP = _core_.ST_SIZEGRIP
135ST_NO_AUTORESIZE = _core_.ST_NO_AUTORESIZE
136FLOOD_SURFACE = _core_.FLOOD_SURFACE
137FLOOD_BORDER = _core_.FLOOD_BORDER
138ODDEVEN_RULE = _core_.ODDEVEN_RULE
139WINDING_RULE = _core_.WINDING_RULE
140TOOL_TOP = _core_.TOOL_TOP
141TOOL_BOTTOM = _core_.TOOL_BOTTOM
142TOOL_LEFT = _core_.TOOL_LEFT
143TOOL_RIGHT = _core_.TOOL_RIGHT
144OK = _core_.OK
145YES_NO = _core_.YES_NO
146CANCEL = _core_.CANCEL
147YES = _core_.YES
148NO = _core_.NO
149NO_DEFAULT = _core_.NO_DEFAULT
150YES_DEFAULT = _core_.YES_DEFAULT
151ICON_EXCLAMATION = _core_.ICON_EXCLAMATION
152ICON_HAND = _core_.ICON_HAND
153ICON_QUESTION = _core_.ICON_QUESTION
154ICON_INFORMATION = _core_.ICON_INFORMATION
155ICON_STOP = _core_.ICON_STOP
156ICON_ASTERISK = _core_.ICON_ASTERISK
157ICON_MASK = _core_.ICON_MASK
158ICON_WARNING = _core_.ICON_WARNING
159ICON_ERROR = _core_.ICON_ERROR
160FORWARD = _core_.FORWARD
161BACKWARD = _core_.BACKWARD
162RESET = _core_.RESET
163HELP = _core_.HELP
164MORE = _core_.MORE
165SETUP = _core_.SETUP
166SIZE_AUTO_WIDTH = _core_.SIZE_AUTO_WIDTH
167SIZE_AUTO_HEIGHT = _core_.SIZE_AUTO_HEIGHT
168SIZE_AUTO = _core_.SIZE_AUTO
169SIZE_USE_EXISTING = _core_.SIZE_USE_EXISTING
170SIZE_ALLOW_MINUS_ONE = _core_.SIZE_ALLOW_MINUS_ONE
9d7dfdff 171SIZE_FORCE = _core_.SIZE_FORCE
d55e5bfc
RD		 172PORTRAIT = _core_.PORTRAIT
173LANDSCAPE = _core_.LANDSCAPE
174PRINT_QUALITY_HIGH = _core_.PRINT_QUALITY_HIGH
175PRINT_QUALITY_MEDIUM = _core_.PRINT_QUALITY_MEDIUM
176PRINT_QUALITY_LOW = _core_.PRINT_QUALITY_LOW
177PRINT_QUALITY_DRAFT = _core_.PRINT_QUALITY_DRAFT
178ID_ANY = _core_.ID_ANY
179ID_SEPARATOR = _core_.ID_SEPARATOR
9d7dfdff 180ID_NONE = _core_.ID_NONE
d55e5bfc
RD		 181ID_LOWEST = _core_.ID_LOWEST
182ID_OPEN = _core_.ID_OPEN
183ID_CLOSE = _core_.ID_CLOSE
184ID_NEW = _core_.ID_NEW
185ID_SAVE = _core_.ID_SAVE
186ID_SAVEAS = _core_.ID_SAVEAS
187ID_REVERT = _core_.ID_REVERT
188ID_EXIT = _core_.ID_EXIT
189ID_UNDO = _core_.ID_UNDO
190ID_REDO = _core_.ID_REDO
191ID_HELP = _core_.ID_HELP
192ID_PRINT = _core_.ID_PRINT
193ID_PRINT_SETUP = _core_.ID_PRINT_SETUP
194ID_PREVIEW = _core_.ID_PREVIEW
195ID_ABOUT = _core_.ID_ABOUT
196ID_HELP_CONTENTS = _core_.ID_HELP_CONTENTS
197ID_HELP_COMMANDS = _core_.ID_HELP_COMMANDS
198ID_HELP_PROCEDURES = _core_.ID_HELP_PROCEDURES
199ID_HELP_CONTEXT = _core_.ID_HELP_CONTEXT
200ID_CLOSE_ALL = _core_.ID_CLOSE_ALL
201ID_PREFERENCES = _core_.ID_PREFERENCES
202ID_CUT = _core_.ID_CUT
203ID_COPY = _core_.ID_COPY
204ID_PASTE = _core_.ID_PASTE
205ID_CLEAR = _core_.ID_CLEAR
206ID_FIND = _core_.ID_FIND
207ID_DUPLICATE = _core_.ID_DUPLICATE
208ID_SELECTALL = _core_.ID_SELECTALL
209ID_DELETE = _core_.ID_DELETE
210ID_REPLACE = _core_.ID_REPLACE
211ID_REPLACE_ALL = _core_.ID_REPLACE_ALL
212ID_PROPERTIES = _core_.ID_PROPERTIES
213ID_VIEW_DETAILS = _core_.ID_VIEW_DETAILS
214ID_VIEW_LARGEICONS = _core_.ID_VIEW_LARGEICONS
215ID_VIEW_SMALLICONS = _core_.ID_VIEW_SMALLICONS
216ID_VIEW_LIST = _core_.ID_VIEW_LIST
217ID_VIEW_SORTDATE = _core_.ID_VIEW_SORTDATE
218ID_VIEW_SORTNAME = _core_.ID_VIEW_SORTNAME
219ID_VIEW_SORTSIZE = _core_.ID_VIEW_SORTSIZE
220ID_VIEW_SORTTYPE = _core_.ID_VIEW_SORTTYPE
221ID_FILE1 = _core_.ID_FILE1
222ID_FILE2 = _core_.ID_FILE2
223ID_FILE3 = _core_.ID_FILE3
224ID_FILE4 = _core_.ID_FILE4
225ID_FILE5 = _core_.ID_FILE5
226ID_FILE6 = _core_.ID_FILE6
227ID_FILE7 = _core_.ID_FILE7
228ID_FILE8 = _core_.ID_FILE8
229ID_FILE9 = _core_.ID_FILE9
230ID_OK = _core_.ID_OK
231ID_CANCEL = _core_.ID_CANCEL
232ID_APPLY = _core_.ID_APPLY
233ID_YES = _core_.ID_YES
234ID_NO = _core_.ID_NO
235ID_STATIC = _core_.ID_STATIC
236ID_FORWARD = _core_.ID_FORWARD
237ID_BACKWARD = _core_.ID_BACKWARD
238ID_DEFAULT = _core_.ID_DEFAULT
239ID_MORE = _core_.ID_MORE
240ID_SETUP = _core_.ID_SETUP
241ID_RESET = _core_.ID_RESET
242ID_CONTEXT_HELP = _core_.ID_CONTEXT_HELP
243ID_YESTOALL = _core_.ID_YESTOALL
244ID_NOTOALL = _core_.ID_NOTOALL
245ID_ABORT = _core_.ID_ABORT
246ID_RETRY = _core_.ID_RETRY
247ID_IGNORE = _core_.ID_IGNORE
0f63ec68
RD		 248ID_ADD = _core_.ID_ADD
249ID_REMOVE = _core_.ID_REMOVE
250ID_UP = _core_.ID_UP
251ID_DOWN = _core_.ID_DOWN
252ID_HOME = _core_.ID_HOME
253ID_REFRESH = _core_.ID_REFRESH
254ID_STOP = _core_.ID_STOP
255ID_INDEX = _core_.ID_INDEX
256ID_BOLD = _core_.ID_BOLD
257ID_ITALIC = _core_.ID_ITALIC
258ID_JUSTIFY_CENTER = _core_.ID_JUSTIFY_CENTER
259ID_JUSTIFY_FILL = _core_.ID_JUSTIFY_FILL
260ID_JUSTIFY_RIGHT = _core_.ID_JUSTIFY_RIGHT
261ID_JUSTIFY_LEFT = _core_.ID_JUSTIFY_LEFT
262ID_UNDERLINE = _core_.ID_UNDERLINE
263ID_INDENT = _core_.ID_INDENT
264ID_UNINDENT = _core_.ID_UNINDENT
265ID_ZOOM_100 = _core_.ID_ZOOM_100
266ID_ZOOM_FIT = _core_.ID_ZOOM_FIT
267ID_ZOOM_IN = _core_.ID_ZOOM_IN
268ID_ZOOM_OUT = _core_.ID_ZOOM_OUT
269ID_UNDELETE = _core_.ID_UNDELETE
270ID_REVERT_TO_SAVED = _core_.ID_REVERT_TO_SAVED
d55e5bfc
RD		 271ID_HIGHEST = _core_.ID_HIGHEST
272OPEN = _core_.OPEN
273SAVE = _core_.SAVE
274HIDE_READONLY = _core_.HIDE_READONLY
275OVERWRITE_PROMPT = _core_.OVERWRITE_PROMPT
276FILE_MUST_EXIST = _core_.FILE_MUST_EXIST
277MULTIPLE = _core_.MULTIPLE
278CHANGE_DIR = _core_.CHANGE_DIR
279ACCEL_ALT = _core_.ACCEL_ALT
280ACCEL_CTRL = _core_.ACCEL_CTRL
281ACCEL_SHIFT = _core_.ACCEL_SHIFT
282ACCEL_NORMAL = _core_.ACCEL_NORMAL
283PD_AUTO_HIDE = _core_.PD_AUTO_HIDE
284PD_APP_MODAL = _core_.PD_APP_MODAL
285PD_CAN_ABORT = _core_.PD_CAN_ABORT
286PD_ELAPSED_TIME = _core_.PD_ELAPSED_TIME
287PD_ESTIMATED_TIME = _core_.PD_ESTIMATED_TIME
288PD_REMAINING_TIME = _core_.PD_REMAINING_TIME
62d32a5f
RD		 289PD_SMOOTH = _core_.PD_SMOOTH
290PD_CAN_SKIP = _core_.PD_CAN_SKIP
d55e5bfc
RD		 291DD_NEW_DIR_BUTTON = _core_.DD_NEW_DIR_BUTTON
292DD_DEFAULT_STYLE = _core_.DD_DEFAULT_STYLE
293MENU_TEAROFF = _core_.MENU_TEAROFF
294MB_DOCKABLE = _core_.MB_DOCKABLE
295NO_FULL_REPAINT_ON_RESIZE = _core_.NO_FULL_REPAINT_ON_RESIZE
296FULL_REPAINT_ON_RESIZE = _core_.FULL_REPAINT_ON_RESIZE
297LI_HORIZONTAL = _core_.LI_HORIZONTAL
298LI_VERTICAL = _core_.LI_VERTICAL
299WS_EX_VALIDATE_RECURSIVELY = _core_.WS_EX_VALIDATE_RECURSIVELY
300WS_EX_BLOCK_EVENTS = _core_.WS_EX_BLOCK_EVENTS
301WS_EX_TRANSIENT = _core_.WS_EX_TRANSIENT
302WS_EX_THEMED_BACKGROUND = _core_.WS_EX_THEMED_BACKGROUND
303WS_EX_PROCESS_IDLE = _core_.WS_EX_PROCESS_IDLE
304WS_EX_PROCESS_UI_UPDATES = _core_.WS_EX_PROCESS_UI_UPDATES
305MM_TEXT = _core_.MM_TEXT
306MM_LOMETRIC = _core_.MM_LOMETRIC
307MM_HIMETRIC = _core_.MM_HIMETRIC
308MM_LOENGLISH = _core_.MM_LOENGLISH
309MM_HIENGLISH = _core_.MM_HIENGLISH
310MM_TWIPS = _core_.MM_TWIPS
311MM_ISOTROPIC = _core_.MM_ISOTROPIC
312MM_ANISOTROPIC = _core_.MM_ANISOTROPIC
313MM_POINTS = _core_.MM_POINTS
314MM_METRIC = _core_.MM_METRIC
315CENTRE = _core_.CENTRE
316CENTER = _core_.CENTER
317HORIZONTAL = _core_.HORIZONTAL
318VERTICAL = _core_.VERTICAL
319BOTH = _core_.BOTH
320LEFT = _core_.LEFT
321RIGHT = _core_.RIGHT
322UP = _core_.UP
323DOWN = _core_.DOWN
324TOP = _core_.TOP
325BOTTOM = _core_.BOTTOM
326NORTH = _core_.NORTH
327SOUTH = _core_.SOUTH
328WEST = _core_.WEST
329EAST = _core_.EAST
330ALL = _core_.ALL
331ALIGN_NOT = _core_.ALIGN_NOT
332ALIGN_CENTER_HORIZONTAL = _core_.ALIGN_CENTER_HORIZONTAL
333ALIGN_CENTRE_HORIZONTAL = _core_.ALIGN_CENTRE_HORIZONTAL
334ALIGN_LEFT = _core_.ALIGN_LEFT
335ALIGN_TOP = _core_.ALIGN_TOP
336ALIGN_RIGHT = _core_.ALIGN_RIGHT
337ALIGN_BOTTOM = _core_.ALIGN_BOTTOM
338ALIGN_CENTER_VERTICAL = _core_.ALIGN_CENTER_VERTICAL
339ALIGN_CENTRE_VERTICAL = _core_.ALIGN_CENTRE_VERTICAL
340ALIGN_CENTER = _core_.ALIGN_CENTER
341ALIGN_CENTRE = _core_.ALIGN_CENTRE
342ALIGN_MASK = _core_.ALIGN_MASK
343STRETCH_NOT = _core_.STRETCH_NOT
344SHRINK = _core_.SHRINK
345GROW = _core_.GROW
346EXPAND = _core_.EXPAND
347SHAPED = _core_.SHAPED
348FIXED_MINSIZE = _core_.FIXED_MINSIZE
349TILE = _core_.TILE
350ADJUST_MINSIZE = _core_.ADJUST_MINSIZE
351BORDER_DEFAULT = _core_.BORDER_DEFAULT
352BORDER_NONE = _core_.BORDER_NONE
353BORDER_STATIC = _core_.BORDER_STATIC
354BORDER_SIMPLE = _core_.BORDER_SIMPLE
355BORDER_RAISED = _core_.BORDER_RAISED
356BORDER_SUNKEN = _core_.BORDER_SUNKEN
357BORDER_DOUBLE = _core_.BORDER_DOUBLE
358BORDER_MASK = _core_.BORDER_MASK
0f63ec68
RD		 359BG_STYLE_SYSTEM = _core_.BG_STYLE_SYSTEM
360BG_STYLE_COLOUR = _core_.BG_STYLE_COLOUR
361BG_STYLE_CUSTOM = _core_.BG_STYLE_CUSTOM
d55e5bfc
RD		 362DEFAULT = _core_.DEFAULT
363DECORATIVE = _core_.DECORATIVE
364ROMAN = _core_.ROMAN
365SCRIPT = _core_.SCRIPT
366SWISS = _core_.SWISS
367MODERN = _core_.MODERN
368TELETYPE = _core_.TELETYPE
369VARIABLE = _core_.VARIABLE
370FIXED = _core_.FIXED
371NORMAL = _core_.NORMAL
372LIGHT = _core_.LIGHT
373BOLD = _core_.BOLD
374ITALIC = _core_.ITALIC
375SLANT = _core_.SLANT
376SOLID = _core_.SOLID
377DOT = _core_.DOT
378LONG_DASH = _core_.LONG_DASH
379SHORT_DASH = _core_.SHORT_DASH
380DOT_DASH = _core_.DOT_DASH
381USER_DASH = _core_.USER_DASH
382TRANSPARENT = _core_.TRANSPARENT
383STIPPLE = _core_.STIPPLE
d04418a7
RD		 384STIPPLE_MASK = _core_.STIPPLE_MASK
385STIPPLE_MASK_OPAQUE = _core_.STIPPLE_MASK_OPAQUE
d55e5bfc
RD		 386BDIAGONAL_HATCH = _core_.BDIAGONAL_HATCH
387CROSSDIAG_HATCH = _core_.CROSSDIAG_HATCH
388FDIAGONAL_HATCH = _core_.FDIAGONAL_HATCH
389CROSS_HATCH = _core_.CROSS_HATCH
390HORIZONTAL_HATCH = _core_.HORIZONTAL_HATCH
391VERTICAL_HATCH = _core_.VERTICAL_HATCH
392JOIN_BEVEL = _core_.JOIN_BEVEL
393JOIN_MITER = _core_.JOIN_MITER
394JOIN_ROUND = _core_.JOIN_ROUND
395CAP_ROUND = _core_.CAP_ROUND
396CAP_PROJECTING = _core_.CAP_PROJECTING
397CAP_BUTT = _core_.CAP_BUTT
398CLEAR = _core_.CLEAR
399XOR = _core_.XOR
400INVERT = _core_.INVERT
401OR_REVERSE = _core_.OR_REVERSE
402AND_REVERSE = _core_.AND_REVERSE
403COPY = _core_.COPY
404AND = _core_.AND
405AND_INVERT = _core_.AND_INVERT
406NO_OP = _core_.NO_OP
407NOR = _core_.NOR
408EQUIV = _core_.EQUIV
409SRC_INVERT = _core_.SRC_INVERT
410OR_INVERT = _core_.OR_INVERT
411NAND = _core_.NAND
412OR = _core_.OR
413SET = _core_.SET
414WXK_BACK = _core_.WXK_BACK
415WXK_TAB = _core_.WXK_TAB
416WXK_RETURN = _core_.WXK_RETURN
417WXK_ESCAPE = _core_.WXK_ESCAPE
418WXK_SPACE = _core_.WXK_SPACE
419WXK_DELETE = _core_.WXK_DELETE
420WXK_START = _core_.WXK_START
421WXK_LBUTTON = _core_.WXK_LBUTTON
422WXK_RBUTTON = _core_.WXK_RBUTTON
423WXK_CANCEL = _core_.WXK_CANCEL
424WXK_MBUTTON = _core_.WXK_MBUTTON
425WXK_CLEAR = _core_.WXK_CLEAR
426WXK_SHIFT = _core_.WXK_SHIFT
427WXK_ALT = _core_.WXK_ALT
428WXK_CONTROL = _core_.WXK_CONTROL
429WXK_MENU = _core_.WXK_MENU
430WXK_PAUSE = _core_.WXK_PAUSE
431WXK_CAPITAL = _core_.WXK_CAPITAL
432WXK_PRIOR = _core_.WXK_PRIOR
433WXK_NEXT = _core_.WXK_NEXT
434WXK_END = _core_.WXK_END
435WXK_HOME = _core_.WXK_HOME
436WXK_LEFT = _core_.WXK_LEFT
437WXK_UP = _core_.WXK_UP
438WXK_RIGHT = _core_.WXK_RIGHT
439WXK_DOWN = _core_.WXK_DOWN
440WXK_SELECT = _core_.WXK_SELECT
441WXK_PRINT = _core_.WXK_PRINT
442WXK_EXECUTE = _core_.WXK_EXECUTE
443WXK_SNAPSHOT = _core_.WXK_SNAPSHOT
444WXK_INSERT = _core_.WXK_INSERT
445WXK_HELP = _core_.WXK_HELP
446WXK_NUMPAD0 = _core_.WXK_NUMPAD0
447WXK_NUMPAD1 = _core_.WXK_NUMPAD1
448WXK_NUMPAD2 = _core_.WXK_NUMPAD2
449WXK_NUMPAD3 = _core_.WXK_NUMPAD3
450WXK_NUMPAD4 = _core_.WXK_NUMPAD4
451WXK_NUMPAD5 = _core_.WXK_NUMPAD5
452WXK_NUMPAD6 = _core_.WXK_NUMPAD6
453WXK_NUMPAD7 = _core_.WXK_NUMPAD7
454WXK_NUMPAD8 = _core_.WXK_NUMPAD8
455WXK_NUMPAD9 = _core_.WXK_NUMPAD9
456WXK_MULTIPLY = _core_.WXK_MULTIPLY
457WXK_ADD = _core_.WXK_ADD
458WXK_SEPARATOR = _core_.WXK_SEPARATOR
459WXK_SUBTRACT = _core_.WXK_SUBTRACT
460WXK_DECIMAL = _core_.WXK_DECIMAL
461WXK_DIVIDE = _core_.WXK_DIVIDE
462WXK_F1 = _core_.WXK_F1
463WXK_F2 = _core_.WXK_F2
464WXK_F3 = _core_.WXK_F3
465WXK_F4 = _core_.WXK_F4
466WXK_F5 = _core_.WXK_F5
467WXK_F6 = _core_.WXK_F6
468WXK_F7 = _core_.WXK_F7
469WXK_F8 = _core_.WXK_F8
470WXK_F9 = _core_.WXK_F9
471WXK_F10 = _core_.WXK_F10
472WXK_F11 = _core_.WXK_F11
473WXK_F12 = _core_.WXK_F12
474WXK_F13 = _core_.WXK_F13
475WXK_F14 = _core_.WXK_F14
476WXK_F15 = _core_.WXK_F15
477WXK_F16 = _core_.WXK_F16
478WXK_F17 = _core_.WXK_F17
479WXK_F18 = _core_.WXK_F18
480WXK_F19 = _core_.WXK_F19
481WXK_F20 = _core_.WXK_F20
482WXK_F21 = _core_.WXK_F21
483WXK_F22 = _core_.WXK_F22
484WXK_F23 = _core_.WXK_F23
485WXK_F24 = _core_.WXK_F24
486WXK_NUMLOCK = _core_.WXK_NUMLOCK
487WXK_SCROLL = _core_.WXK_SCROLL
488WXK_PAGEUP = _core_.WXK_PAGEUP
489WXK_PAGEDOWN = _core_.WXK_PAGEDOWN
490WXK_NUMPAD_SPACE = _core_.WXK_NUMPAD_SPACE
491WXK_NUMPAD_TAB = _core_.WXK_NUMPAD_TAB
492WXK_NUMPAD_ENTER = _core_.WXK_NUMPAD_ENTER
493WXK_NUMPAD_F1 = _core_.WXK_NUMPAD_F1
494WXK_NUMPAD_F2 = _core_.WXK_NUMPAD_F2
495WXK_NUMPAD_F3 = _core_.WXK_NUMPAD_F3
496WXK_NUMPAD_F4 = _core_.WXK_NUMPAD_F4
497WXK_NUMPAD_HOME = _core_.WXK_NUMPAD_HOME
498WXK_NUMPAD_LEFT = _core_.WXK_NUMPAD_LEFT
499WXK_NUMPAD_UP = _core_.WXK_NUMPAD_UP
500WXK_NUMPAD_RIGHT = _core_.WXK_NUMPAD_RIGHT
501WXK_NUMPAD_DOWN = _core_.WXK_NUMPAD_DOWN
502WXK_NUMPAD_PRIOR = _core_.WXK_NUMPAD_PRIOR
503WXK_NUMPAD_PAGEUP = _core_.WXK_NUMPAD_PAGEUP
504WXK_NUMPAD_NEXT = _core_.WXK_NUMPAD_NEXT
505WXK_NUMPAD_PAGEDOWN = _core_.WXK_NUMPAD_PAGEDOWN
506WXK_NUMPAD_END = _core_.WXK_NUMPAD_END
507WXK_NUMPAD_BEGIN = _core_.WXK_NUMPAD_BEGIN
508WXK_NUMPAD_INSERT = _core_.WXK_NUMPAD_INSERT
509WXK_NUMPAD_DELETE = _core_.WXK_NUMPAD_DELETE
510WXK_NUMPAD_EQUAL = _core_.WXK_NUMPAD_EQUAL
511WXK_NUMPAD_MULTIPLY = _core_.WXK_NUMPAD_MULTIPLY
512WXK_NUMPAD_ADD = _core_.WXK_NUMPAD_ADD
513WXK_NUMPAD_SEPARATOR = _core_.WXK_NUMPAD_SEPARATOR
514WXK_NUMPAD_SUBTRACT = _core_.WXK_NUMPAD_SUBTRACT
515WXK_NUMPAD_DECIMAL = _core_.WXK_NUMPAD_DECIMAL
516WXK_NUMPAD_DIVIDE = _core_.WXK_NUMPAD_DIVIDE
517WXK_WINDOWS_LEFT = _core_.WXK_WINDOWS_LEFT
518WXK_WINDOWS_RIGHT = _core_.WXK_WINDOWS_RIGHT
519WXK_WINDOWS_MENU = _core_.WXK_WINDOWS_MENU
88c6b281
RD		 520WXK_COMMAND = _core_.WXK_COMMAND
521WXK_SPECIAL1 = _core_.WXK_SPECIAL1
522WXK_SPECIAL2 = _core_.WXK_SPECIAL2
523WXK_SPECIAL3 = _core_.WXK_SPECIAL3
524WXK_SPECIAL4 = _core_.WXK_SPECIAL4
525WXK_SPECIAL5 = _core_.WXK_SPECIAL5
526WXK_SPECIAL6 = _core_.WXK_SPECIAL6
527WXK_SPECIAL7 = _core_.WXK_SPECIAL7
528WXK_SPECIAL8 = _core_.WXK_SPECIAL8
529WXK_SPECIAL9 = _core_.WXK_SPECIAL9
530WXK_SPECIAL10 = _core_.WXK_SPECIAL10
531WXK_SPECIAL11 = _core_.WXK_SPECIAL11
532WXK_SPECIAL12 = _core_.WXK_SPECIAL12
533WXK_SPECIAL13 = _core_.WXK_SPECIAL13
534WXK_SPECIAL14 = _core_.WXK_SPECIAL14
535WXK_SPECIAL15 = _core_.WXK_SPECIAL15
536WXK_SPECIAL16 = _core_.WXK_SPECIAL16
537WXK_SPECIAL17 = _core_.WXK_SPECIAL17
538WXK_SPECIAL18 = _core_.WXK_SPECIAL18
539WXK_SPECIAL19 = _core_.WXK_SPECIAL19
540WXK_SPECIAL20 = _core_.WXK_SPECIAL20
d55e5bfc
RD		 541PAPER_NONE = _core_.PAPER_NONE
542PAPER_LETTER = _core_.PAPER_LETTER
543PAPER_LEGAL = _core_.PAPER_LEGAL
544PAPER_A4 = _core_.PAPER_A4
545PAPER_CSHEET = _core_.PAPER_CSHEET
546PAPER_DSHEET = _core_.PAPER_DSHEET
547PAPER_ESHEET = _core_.PAPER_ESHEET
548PAPER_LETTERSMALL = _core_.PAPER_LETTERSMALL
549PAPER_TABLOID = _core_.PAPER_TABLOID
550PAPER_LEDGER = _core_.PAPER_LEDGER
551PAPER_STATEMENT = _core_.PAPER_STATEMENT
552PAPER_EXECUTIVE = _core_.PAPER_EXECUTIVE
553PAPER_A3 = _core_.PAPER_A3
554PAPER_A4SMALL = _core_.PAPER_A4SMALL
555PAPER_A5 = _core_.PAPER_A5
556PAPER_B4 = _core_.PAPER_B4
557PAPER_B5 = _core_.PAPER_B5
558PAPER_FOLIO = _core_.PAPER_FOLIO
559PAPER_QUARTO = _core_.PAPER_QUARTO
560PAPER_10X14 = _core_.PAPER_10X14
561PAPER_11X17 = _core_.PAPER_11X17
562PAPER_NOTE = _core_.PAPER_NOTE
563PAPER_ENV_9 = _core_.PAPER_ENV_9
564PAPER_ENV_10 = _core_.PAPER_ENV_10
565PAPER_ENV_11 = _core_.PAPER_ENV_11
566PAPER_ENV_12 = _core_.PAPER_ENV_12
567PAPER_ENV_14 = _core_.PAPER_ENV_14
568PAPER_ENV_DL = _core_.PAPER_ENV_DL
569PAPER_ENV_C5 = _core_.PAPER_ENV_C5
570PAPER_ENV_C3 = _core_.PAPER_ENV_C3
571PAPER_ENV_C4 = _core_.PAPER_ENV_C4
572PAPER_ENV_C6 = _core_.PAPER_ENV_C6
573PAPER_ENV_C65 = _core_.PAPER_ENV_C65
574PAPER_ENV_B4 = _core_.PAPER_ENV_B4
575PAPER_ENV_B5 = _core_.PAPER_ENV_B5
576PAPER_ENV_B6 = _core_.PAPER_ENV_B6
577PAPER_ENV_ITALY = _core_.PAPER_ENV_ITALY
578PAPER_ENV_MONARCH = _core_.PAPER_ENV_MONARCH
579PAPER_ENV_PERSONAL = _core_.PAPER_ENV_PERSONAL
580PAPER_FANFOLD_US = _core_.PAPER_FANFOLD_US
581PAPER_FANFOLD_STD_GERMAN = _core_.PAPER_FANFOLD_STD_GERMAN
582PAPER_FANFOLD_LGL_GERMAN = _core_.PAPER_FANFOLD_LGL_GERMAN
583PAPER_ISO_B4 = _core_.PAPER_ISO_B4
584PAPER_JAPANESE_POSTCARD = _core_.PAPER_JAPANESE_POSTCARD
585PAPER_9X11 = _core_.PAPER_9X11
586PAPER_10X11 = _core_.PAPER_10X11
587PAPER_15X11 = _core_.PAPER_15X11
588PAPER_ENV_INVITE = _core_.PAPER_ENV_INVITE
589PAPER_LETTER_EXTRA = _core_.PAPER_LETTER_EXTRA
590PAPER_LEGAL_EXTRA = _core_.PAPER_LEGAL_EXTRA
591PAPER_TABLOID_EXTRA = _core_.PAPER_TABLOID_EXTRA
592PAPER_A4_EXTRA = _core_.PAPER_A4_EXTRA
593PAPER_LETTER_TRANSVERSE = _core_.PAPER_LETTER_TRANSVERSE
594PAPER_A4_TRANSVERSE = _core_.PAPER_A4_TRANSVERSE
595PAPER_LETTER_EXTRA_TRANSVERSE = _core_.PAPER_LETTER_EXTRA_TRANSVERSE
596PAPER_A_PLUS = _core_.PAPER_A_PLUS
597PAPER_B_PLUS = _core_.PAPER_B_PLUS
598PAPER_LETTER_PLUS = _core_.PAPER_LETTER_PLUS
599PAPER_A4_PLUS = _core_.PAPER_A4_PLUS
600PAPER_A5_TRANSVERSE = _core_.PAPER_A5_TRANSVERSE
601PAPER_B5_TRANSVERSE = _core_.PAPER_B5_TRANSVERSE
602PAPER_A3_EXTRA = _core_.PAPER_A3_EXTRA
603PAPER_A5_EXTRA = _core_.PAPER_A5_EXTRA
604PAPER_B5_EXTRA = _core_.PAPER_B5_EXTRA
605PAPER_A2 = _core_.PAPER_A2
606PAPER_A3_TRANSVERSE = _core_.PAPER_A3_TRANSVERSE
607PAPER_A3_EXTRA_TRANSVERSE = _core_.PAPER_A3_EXTRA_TRANSVERSE
034e3677
RD		 608PAPER_DBL_JAPANESE_POSTCARD = _core_.PAPER_DBL_JAPANESE_POSTCARD
609PAPER_A6 = _core_.PAPER_A6
610PAPER_JENV_KAKU2 = _core_.PAPER_JENV_KAKU2
611PAPER_JENV_KAKU3 = _core_.PAPER_JENV_KAKU3
612PAPER_JENV_CHOU3 = _core_.PAPER_JENV_CHOU3
613PAPER_JENV_CHOU4 = _core_.PAPER_JENV_CHOU4
614PAPER_LETTER_ROTATED = _core_.PAPER_LETTER_ROTATED
615PAPER_A3_ROTATED = _core_.PAPER_A3_ROTATED
616PAPER_A4_ROTATED = _core_.PAPER_A4_ROTATED
617PAPER_A5_ROTATED = _core_.PAPER_A5_ROTATED
618PAPER_B4_JIS_ROTATED = _core_.PAPER_B4_JIS_ROTATED
619PAPER_B5_JIS_ROTATED = _core_.PAPER_B5_JIS_ROTATED
620PAPER_JAPANESE_POSTCARD_ROTATED = _core_.PAPER_JAPANESE_POSTCARD_ROTATED
621PAPER_DBL_JAPANESE_POSTCARD_ROTATED = _core_.PAPER_DBL_JAPANESE_POSTCARD_ROTATED
622PAPER_A6_ROTATED = _core_.PAPER_A6_ROTATED
623PAPER_JENV_KAKU2_ROTATED = _core_.PAPER_JENV_KAKU2_ROTATED
624PAPER_JENV_KAKU3_ROTATED = _core_.PAPER_JENV_KAKU3_ROTATED
625PAPER_JENV_CHOU3_ROTATED = _core_.PAPER_JENV_CHOU3_ROTATED
626PAPER_JENV_CHOU4_ROTATED = _core_.PAPER_JENV_CHOU4_ROTATED
627PAPER_B6_JIS = _core_.PAPER_B6_JIS
628PAPER_B6_JIS_ROTATED = _core_.PAPER_B6_JIS_ROTATED
629PAPER_12X11 = _core_.PAPER_12X11
630PAPER_JENV_YOU4 = _core_.PAPER_JENV_YOU4
631PAPER_JENV_YOU4_ROTATED = _core_.PAPER_JENV_YOU4_ROTATED
632PAPER_P16K = _core_.PAPER_P16K
633PAPER_P32K = _core_.PAPER_P32K
634PAPER_P32KBIG = _core_.PAPER_P32KBIG
635PAPER_PENV_1 = _core_.PAPER_PENV_1
636PAPER_PENV_2 = _core_.PAPER_PENV_2
637PAPER_PENV_3 = _core_.PAPER_PENV_3
638PAPER_PENV_4 = _core_.PAPER_PENV_4
639PAPER_PENV_5 = _core_.PAPER_PENV_5
640PAPER_PENV_6 = _core_.PAPER_PENV_6
641PAPER_PENV_7 = _core_.PAPER_PENV_7
642PAPER_PENV_8 = _core_.PAPER_PENV_8
643PAPER_PENV_9 = _core_.PAPER_PENV_9
644PAPER_PENV_10 = _core_.PAPER_PENV_10
645PAPER_P16K_ROTATED = _core_.PAPER_P16K_ROTATED
646PAPER_P32K_ROTATED = _core_.PAPER_P32K_ROTATED
647PAPER_P32KBIG_ROTATED = _core_.PAPER_P32KBIG_ROTATED
648PAPER_PENV_1_ROTATED = _core_.PAPER_PENV_1_ROTATED
649PAPER_PENV_2_ROTATED = _core_.PAPER_PENV_2_ROTATED
650PAPER_PENV_3_ROTATED = _core_.PAPER_PENV_3_ROTATED
651PAPER_PENV_4_ROTATED = _core_.PAPER_PENV_4_ROTATED
652PAPER_PENV_5_ROTATED = _core_.PAPER_PENV_5_ROTATED
653PAPER_PENV_6_ROTATED = _core_.PAPER_PENV_6_ROTATED
654PAPER_PENV_7_ROTATED = _core_.PAPER_PENV_7_ROTATED
655PAPER_PENV_8_ROTATED = _core_.PAPER_PENV_8_ROTATED
656PAPER_PENV_9_ROTATED = _core_.PAPER_PENV_9_ROTATED
657PAPER_PENV_10_ROTATED = _core_.PAPER_PENV_10_ROTATED
d55e5bfc
RD		 658DUPLEX_SIMPLEX = _core_.DUPLEX_SIMPLEX
659DUPLEX_HORIZONTAL = _core_.DUPLEX_HORIZONTAL
660DUPLEX_VERTICAL = _core_.DUPLEX_VERTICAL
661ITEM_SEPARATOR = _core_.ITEM_SEPARATOR
662ITEM_NORMAL = _core_.ITEM_NORMAL
663ITEM_CHECK = _core_.ITEM_CHECK
664ITEM_RADIO = _core_.ITEM_RADIO
665ITEM_MAX = _core_.ITEM_MAX
666HT_NOWHERE = _core_.HT_NOWHERE
667HT_SCROLLBAR_FIRST = _core_.HT_SCROLLBAR_FIRST
668HT_SCROLLBAR_ARROW_LINE_1 = _core_.HT_SCROLLBAR_ARROW_LINE_1
669HT_SCROLLBAR_ARROW_LINE_2 = _core_.HT_SCROLLBAR_ARROW_LINE_2
670HT_SCROLLBAR_ARROW_PAGE_1 = _core_.HT_SCROLLBAR_ARROW_PAGE_1
671HT_SCROLLBAR_ARROW_PAGE_2 = _core_.HT_SCROLLBAR_ARROW_PAGE_2
672HT_SCROLLBAR_THUMB = _core_.HT_SCROLLBAR_THUMB
673HT_SCROLLBAR_BAR_1 = _core_.HT_SCROLLBAR_BAR_1
674HT_SCROLLBAR_BAR_2 = _core_.HT_SCROLLBAR_BAR_2
675HT_SCROLLBAR_LAST = _core_.HT_SCROLLBAR_LAST
676HT_WINDOW_OUTSIDE = _core_.HT_WINDOW_OUTSIDE
677HT_WINDOW_INSIDE = _core_.HT_WINDOW_INSIDE
678HT_WINDOW_VERT_SCROLLBAR = _core_.HT_WINDOW_VERT_SCROLLBAR
679HT_WINDOW_HORZ_SCROLLBAR = _core_.HT_WINDOW_HORZ_SCROLLBAR
680HT_WINDOW_CORNER = _core_.HT_WINDOW_CORNER
681HT_MAX = _core_.HT_MAX
682MOD_NONE = _core_.MOD_NONE
683MOD_ALT = _core_.MOD_ALT
684MOD_CONTROL = _core_.MOD_CONTROL
9d7dfdff 685MOD_ALTGR = _core_.MOD_ALTGR
d55e5bfc 686MOD_SHIFT = _core_.MOD_SHIFT
9d7dfdff 687MOD_META = _core_.MOD_META
d55e5bfc 688MOD_WIN = _core_.MOD_WIN
9d7dfdff
RD		 689MOD_CMD = _core_.MOD_CMD
690MOD_ALL = _core_.MOD_ALL
d55e5bfc
RD		 691UPDATE_UI_NONE = _core_.UPDATE_UI_NONE
692UPDATE_UI_RECURSE = _core_.UPDATE_UI_RECURSE
693UPDATE_UI_FROMIDLE = _core_.UPDATE_UI_FROMIDLE
694#---------------------------------------------------------------------------
695
696class Object(object):
697 """
698 The base class for most wx objects, although in wxPython not
699 much functionality is needed nor exposed.
700 """
554f62e9
RD		 701 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
702 def __init__(self): raise AttributeError, "No constructor defined"
703 __repr__ = _swig_repr
d55e5bfc
RD		 704 def GetClassName(*args, **kwargs):
705 """
706 GetClassName(self) -> String
707
708 Returns the class name of the C++ class using wxRTTI.
709 """
710 return _core_.Object_GetClassName(*args, **kwargs)
711
712 def Destroy(*args, **kwargs):
713 """
714 Destroy(self)
715
716 Deletes the C++ object this Python object is a proxy for.
717 """
7e08d4ef
RD		 718 val = _core_.Object_Destroy(*args, **kwargs)
719 args[0].thisown = 0
720 return val
d55e5bfc 721
554f62e9
RD		 722Object_swigregister = _core_.Object_swigregister
723Object_swigregister(Object)
d55e5bfc 724_wxPySetDictionary = _core_._wxPySetDictionary
d55e5bfc 725_wxPyFixStockObjects = _core_._wxPyFixStockObjects
d55e5bfc
RD		 726cvar = _core_.cvar
727EmptyString = cvar.EmptyString
728
729#---------------------------------------------------------------------------
730
731BITMAP_TYPE_INVALID = _core_.BITMAP_TYPE_INVALID
732BITMAP_TYPE_BMP = _core_.BITMAP_TYPE_BMP
733BITMAP_TYPE_ICO = _core_.BITMAP_TYPE_ICO
734BITMAP_TYPE_CUR = _core_.BITMAP_TYPE_CUR
735BITMAP_TYPE_XBM = _core_.BITMAP_TYPE_XBM
736BITMAP_TYPE_XBM_DATA = _core_.BITMAP_TYPE_XBM_DATA
737BITMAP_TYPE_XPM = _core_.BITMAP_TYPE_XPM
738BITMAP_TYPE_XPM_DATA = _core_.BITMAP_TYPE_XPM_DATA
739BITMAP_TYPE_TIF = _core_.BITMAP_TYPE_TIF
740BITMAP_TYPE_GIF = _core_.BITMAP_TYPE_GIF
741BITMAP_TYPE_PNG = _core_.BITMAP_TYPE_PNG
742BITMAP_TYPE_JPEG = _core_.BITMAP_TYPE_JPEG
743BITMAP_TYPE_PNM = _core_.BITMAP_TYPE_PNM
744BITMAP_TYPE_PCX = _core_.BITMAP_TYPE_PCX
745BITMAP_TYPE_PICT = _core_.BITMAP_TYPE_PICT
746BITMAP_TYPE_ICON = _core_.BITMAP_TYPE_ICON
747BITMAP_TYPE_ANI = _core_.BITMAP_TYPE_ANI
748BITMAP_TYPE_IFF = _core_.BITMAP_TYPE_IFF
749BITMAP_TYPE_MACCURSOR = _core_.BITMAP_TYPE_MACCURSOR
750BITMAP_TYPE_ANY = _core_.BITMAP_TYPE_ANY
751CURSOR_NONE = _core_.CURSOR_NONE
752CURSOR_ARROW = _core_.CURSOR_ARROW
753CURSOR_RIGHT_ARROW = _core_.CURSOR_RIGHT_ARROW
754CURSOR_BULLSEYE = _core_.CURSOR_BULLSEYE
755CURSOR_CHAR = _core_.CURSOR_CHAR
756CURSOR_CROSS = _core_.CURSOR_CROSS
757CURSOR_HAND = _core_.CURSOR_HAND
758CURSOR_IBEAM = _core_.CURSOR_IBEAM
759CURSOR_LEFT_BUTTON = _core_.CURSOR_LEFT_BUTTON
760CURSOR_MAGNIFIER = _core_.CURSOR_MAGNIFIER
761CURSOR_MIDDLE_BUTTON = _core_.CURSOR_MIDDLE_BUTTON
762CURSOR_NO_ENTRY = _core_.CURSOR_NO_ENTRY
763CURSOR_PAINT_BRUSH = _core_.CURSOR_PAINT_BRUSH
764CURSOR_PENCIL = _core_.CURSOR_PENCIL
765CURSOR_POINT_LEFT = _core_.CURSOR_POINT_LEFT
766CURSOR_POINT_RIGHT = _core_.CURSOR_POINT_RIGHT
767CURSOR_QUESTION_ARROW = _core_.CURSOR_QUESTION_ARROW
768CURSOR_RIGHT_BUTTON = _core_.CURSOR_RIGHT_BUTTON
769CURSOR_SIZENESW = _core_.CURSOR_SIZENESW
770CURSOR_SIZENS = _core_.CURSOR_SIZENS
771CURSOR_SIZENWSE = _core_.CURSOR_SIZENWSE
772CURSOR_SIZEWE = _core_.CURSOR_SIZEWE
773CURSOR_SIZING = _core_.CURSOR_SIZING
774CURSOR_SPRAYCAN = _core_.CURSOR_SPRAYCAN
775CURSOR_WAIT = _core_.CURSOR_WAIT
776CURSOR_WATCH = _core_.CURSOR_WATCH
777CURSOR_BLANK = _core_.CURSOR_BLANK
778CURSOR_DEFAULT = _core_.CURSOR_DEFAULT
779CURSOR_COPY_ARROW = _core_.CURSOR_COPY_ARROW
780CURSOR_ARROWWAIT = _core_.CURSOR_ARROWWAIT
781CURSOR_MAX = _core_.CURSOR_MAX
782#---------------------------------------------------------------------------
783
784class Size(object):
785 """
79fccf9d 786 wx.Size is a useful data structure used to represent the size of
554f62e9
RD		 787 something. It simply contains integer width and height
788 properties. In most places in wxPython where a wx.Size is
093d3ff1 789 expected a (width, height) tuple can be used instead.
d55e5bfc 790 """
554f62e9
RD		 791 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
792 __repr__ = _swig_repr
d55e5bfc
RD		 793 width = property(_core_.Size_width_get, _core_.Size_width_set)
794 height = property(_core_.Size_height_get, _core_.Size_height_set)
795 x = width; y = height
554f62e9 796 def __init__(self, *args, **kwargs):
d55e5bfc
RD		 797 """
798 __init__(self, int w=0, int h=0) -> Size
799
800 Creates a size object.
801 """
554f62e9
RD		 802 _core_.Size_swiginit(self,_core_.new_Size(*args, **kwargs))
803 __swig_destroy__ = _core_.delete_Size
804 __del__ = lambda self : None;
d55e5bfc
RD		 805 def __eq__(*args, **kwargs):
806 """
807 __eq__(self, Size sz) -> bool
808
809 Test for equality of wx.Size objects.
810 """
811 return _core_.Size___eq__(*args, **kwargs)
812
813 def __ne__(*args, **kwargs):
814 """
815 __ne__(self, Size sz) -> bool
816
817 Test for inequality.
818 """
819 return _core_.Size___ne__(*args, **kwargs)
820
821 def __add__(*args, **kwargs):
822 """
823 __add__(self, Size sz) -> Size
824
825 Add sz's proprties to this and return the result.
826 """
827 return _core_.Size___add__(*args, **kwargs)
828
829 def __sub__(*args, **kwargs):
830 """
831 __sub__(self, Size sz) -> Size
832
833 Subtract sz's properties from this and return the result.
834 """
835 return _core_.Size___sub__(*args, **kwargs)
836
837 def IncTo(*args, **kwargs):
838 """
839 IncTo(self, Size sz)
840
841 Increments this object so that both of its dimensions are not less
842 than the corresponding dimensions of the size.
843 """
844 return _core_.Size_IncTo(*args, **kwargs)
845
846 def DecTo(*args, **kwargs):
847 """
848 DecTo(self, Size sz)
849
850 Decrements this object so that both of its dimensions are not greater
851 than the corresponding dimensions of the size.
852 """
853 return _core_.Size_DecTo(*args, **kwargs)
854
855 def Set(*args, **kwargs):
856 """
857 Set(self, int w, int h)
858
859 Set both width and height.
860 """
861 return _core_.Size_Set(*args, **kwargs)
862
863 def SetWidth(*args, **kwargs):
864 """SetWidth(self, int w)"""
865 return _core_.Size_SetWidth(*args, **kwargs)
866
867 def SetHeight(*args, **kwargs):
868 """SetHeight(self, int h)"""
869 return _core_.Size_SetHeight(*args, **kwargs)
870
871 def GetWidth(*args, **kwargs):
872 """GetWidth(self) -> int"""
873 return _core_.Size_GetWidth(*args, **kwargs)
874
875 def GetHeight(*args, **kwargs):
876 """GetHeight(self) -> int"""
877 return _core_.Size_GetHeight(*args, **kwargs)
878
879 def IsFullySpecified(*args, **kwargs):
880 """
881 IsFullySpecified(self) -> bool
882
883 Returns True if both components of the size are non-default values.
884 """
885 return _core_.Size_IsFullySpecified(*args, **kwargs)
886
887 def SetDefaults(*args, **kwargs):
888 """
889 SetDefaults(self, Size size)
890
79fccf9d
RD		 891 Combine this size with the other one replacing the default components
892 of this object (i.e. equal to -1) with those of the other.
d55e5bfc
RD		 893 """
894 return _core_.Size_SetDefaults(*args, **kwargs)
895
896 def Get(*args, **kwargs):
897 """
898 Get() -> (width,height)
899
900 Returns the width and height properties as a tuple.
901 """
902 return _core_.Size_Get(*args, **kwargs)
903
79fccf9d 904 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD		 905 def __str__(self): return str(self.Get())
906 def __repr__(self): return 'wx.Size'+str(self.Get())
907 def __len__(self): return len(self.Get())
908 def __getitem__(self, index): return self.Get()[index]
909 def __setitem__(self, index, val):
910 if index == 0: self.width = val
911 elif index == 1: self.height = val
912 else: raise IndexError
913 def __nonzero__(self): return self.Get() != (0,0)
914 __safe_for_unpickling__ = True
915 def __reduce__(self): return (wx.Size, self.Get())
916
554f62e9
RD		 917Size_swigregister = _core_.Size_swigregister
918Size_swigregister(Size)
d55e5bfc
RD		 919
920#---------------------------------------------------------------------------
921
922class RealPoint(object):
923 """
79fccf9d
RD		 924 A data structure for representing a point or position with floating
925 point x and y properties. In wxPython most places that expect a
926 wx.RealPoint can also accept a (x,y) tuple.
d55e5bfc 927 """
554f62e9
RD		 928 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
929 __repr__ = _swig_repr
d55e5bfc
RD		 930 x = property(_core_.RealPoint_x_get, _core_.RealPoint_x_set)
931 y = property(_core_.RealPoint_y_get, _core_.RealPoint_y_set)
554f62e9 932 def __init__(self, *args, **kwargs):
d55e5bfc
RD		 933 """
934 __init__(self, double x=0.0, double y=0.0) -> RealPoint
935
936 Create a wx.RealPoint object
937 """
554f62e9
RD		 938 _core_.RealPoint_swiginit(self,_core_.new_RealPoint(*args, **kwargs))
939 __swig_destroy__ = _core_.delete_RealPoint
940 __del__ = lambda self : None;
d55e5bfc
RD		 941 def __eq__(*args, **kwargs):
942 """
943 __eq__(self, RealPoint pt) -> bool
944
945 Test for equality of wx.RealPoint objects.
946 """
947 return _core_.RealPoint___eq__(*args, **kwargs)
948
949 def __ne__(*args, **kwargs):
950 """
951 __ne__(self, RealPoint pt) -> bool
952
953 Test for inequality of wx.RealPoint objects.
954 """
955 return _core_.RealPoint___ne__(*args, **kwargs)
956
957 def __add__(*args, **kwargs):
958 """
959 __add__(self, RealPoint pt) -> RealPoint
960
961 Add pt's proprties to this and return the result.
962 """
963 return _core_.RealPoint___add__(*args, **kwargs)
964
965 def __sub__(*args, **kwargs):
966 """
967 __sub__(self, RealPoint pt) -> RealPoint
968
969 Subtract pt's proprties from this and return the result
970 """
971 return _core_.RealPoint___sub__(*args, **kwargs)
972
973 def Set(*args, **kwargs):
974 """
975 Set(self, double x, double y)
976
977 Set both the x and y properties
978 """
979 return _core_.RealPoint_Set(*args, **kwargs)
980
981 def Get(*args, **kwargs):
982 """
983 Get() -> (x,y)
984
985 Return the x and y properties as a tuple.
986 """
987 return _core_.RealPoint_Get(*args, **kwargs)
988
79fccf9d 989 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD		 990 def __str__(self): return str(self.Get())
991 def __repr__(self): return 'wx.RealPoint'+str(self.Get())
992 def __len__(self): return len(self.Get())
993 def __getitem__(self, index): return self.Get()[index]
994 def __setitem__(self, index, val):
995 if index == 0: self.x = val
996 elif index == 1: self.y = val
997 else: raise IndexError
998 def __nonzero__(self): return self.Get() != (0.0, 0.0)
999 __safe_for_unpickling__ = True
1000 def __reduce__(self): return (wx.RealPoint, self.Get())
1001
554f62e9
RD		 1002RealPoint_swigregister = _core_.RealPoint_swigregister
1003RealPoint_swigregister(RealPoint)
d55e5bfc
RD		 1004
1005#---------------------------------------------------------------------------
1006
1007class Point(object):
1008 """
79fccf9d
RD		 1009 A data structure for representing a point or position with integer x
1010 and y properties. Most places in wxPython that expect a wx.Point can
1011 also accept a (x,y) tuple.
d55e5bfc 1012 """
554f62e9
RD		 1013 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1014 __repr__ = _swig_repr
d55e5bfc
RD		 1015 x = property(_core_.Point_x_get, _core_.Point_x_set)
1016 y = property(_core_.Point_y_get, _core_.Point_y_set)
554f62e9 1017 def __init__(self, *args, **kwargs):
d55e5bfc
RD		 1018 """
1019 __init__(self, int x=0, int y=0) -> Point
1020
1021 Create a wx.Point object
1022 """
554f62e9
RD		 1023 _core_.Point_swiginit(self,_core_.new_Point(*args, **kwargs))
1024 __swig_destroy__ = _core_.delete_Point
1025 __del__ = lambda self : None;
d55e5bfc
RD		 1026 def __eq__(*args, **kwargs):
1027 """
1028 __eq__(self, Point pt) -> bool
1029
1030 Test for equality of wx.Point objects.
1031 """
1032 return _core_.Point___eq__(*args, **kwargs)
1033
1034 def __ne__(*args, **kwargs):
1035 """
1036 __ne__(self, Point pt) -> bool
1037
1038 Test for inequality of wx.Point objects.
1039 """
1040 return _core_.Point___ne__(*args, **kwargs)
1041
1042 def __add__(*args, **kwargs):
1043 """
1044 __add__(self, Point pt) -> Point
1045
1046 Add pt's proprties to this and return the result.
1047 """
1048 return _core_.Point___add__(*args, **kwargs)
1049
1050 def __sub__(*args, **kwargs):
1051 """
1052 __sub__(self, Point pt) -> Point
1053
1054 Subtract pt's proprties from this and return the result
1055 """
1056 return _core_.Point___sub__(*args, **kwargs)
1057
1058 def __iadd__(*args, **kwargs):
1059 """
1060 __iadd__(self, Point pt) -> Point
1061
1062 Add pt to this object.
1063 """
1064 return _core_.Point___iadd__(*args, **kwargs)
1065
1066 def __isub__(*args, **kwargs):
1067 """
1068 __isub__(self, Point pt) -> Point
1069
1070 Subtract pt from this object.
1071 """
1072 return _core_.Point___isub__(*args, **kwargs)
1073
1074 def Set(*args, **kwargs):
1075 """
1076 Set(self, long x, long y)
1077
1078 Set both the x and y properties
1079 """
1080 return _core_.Point_Set(*args, **kwargs)
1081
1082 def Get(*args, **kwargs):
1083 """
1084 Get() -> (x,y)
1085
1086 Return the x and y properties as a tuple.
1087 """
1088 return _core_.Point_Get(*args, **kwargs)
1089
79fccf9d 1090 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD		 1091 def __str__(self): return str(self.Get())
1092 def __repr__(self): return 'wx.Point'+str(self.Get())
1093 def __len__(self): return len(self.Get())
1094 def __getitem__(self, index): return self.Get()[index]
1095 def __setitem__(self, index, val):
1096 if index == 0: self.x = val
1097 elif index == 1: self.y = val
1098 else: raise IndexError
1099 def __nonzero__(self): return self.Get() != (0,0)
1100 __safe_for_unpickling__ = True
1101 def __reduce__(self): return (wx.Point, self.Get())
1102
554f62e9
RD		 1103Point_swigregister = _core_.Point_swigregister
1104Point_swigregister(Point)
d55e5bfc
RD		 1105
1106#---------------------------------------------------------------------------
1107
1108class Rect(object):
1109 """
79fccf9d
RD		 1110 A class for representing and manipulating rectangles. It has x, y,
1111 width and height properties. In wxPython most palces that expect a
1112 wx.Rect can also accept a (x,y,width,height) tuple.
d55e5bfc 1113 """
554f62e9
RD		 1114 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1115 __repr__ = _swig_repr
1116 def __init__(self, *args, **kwargs):
d55e5bfc
RD		 1117 """
1118 __init__(self, int x=0, int y=0, int width=0, int height=0) -> Rect
1119
1120 Create a new Rect object.
1121 """
554f62e9
RD		 1122 _core_.Rect_swiginit(self,_core_.new_Rect(*args, **kwargs))
1123 __swig_destroy__ = _core_.delete_Rect
1124 __del__ = lambda self : None;
d55e5bfc
RD		 1125 def GetX(*args, **kwargs):
1126 """GetX(self) -> int"""
1127 return _core_.Rect_GetX(*args, **kwargs)
1128
1129 def SetX(*args, **kwargs):
1130 """SetX(self, int x)"""
1131 return _core_.Rect_SetX(*args, **kwargs)
1132
1133 def GetY(*args, **kwargs):
1134 """GetY(self) -> int"""
1135 return _core_.Rect_GetY(*args, **kwargs)
1136
1137 def SetY(*args, **kwargs):
1138 """SetY(self, int y)"""
1139 return _core_.Rect_SetY(*args, **kwargs)
1140
1141 def GetWidth(*args, **kwargs):
1142 """GetWidth(self) -> int"""
1143 return _core_.Rect_GetWidth(*args, **kwargs)
1144
1145 def SetWidth(*args, **kwargs):
1146 """SetWidth(self, int w)"""
1147 return _core_.Rect_SetWidth(*args, **kwargs)
1148
1149 def GetHeight(*args, **kwargs):
1150 """GetHeight(self) -> int"""
1151 return _core_.Rect_GetHeight(*args, **kwargs)
1152
1153 def SetHeight(*args, **kwargs):
1154 """SetHeight(self, int h)"""
1155 return _core_.Rect_SetHeight(*args, **kwargs)
1156
1157 def GetPosition(*args, **kwargs):
1158 """GetPosition(self) -> Point"""
1159 return _core_.Rect_GetPosition(*args, **kwargs)
1160
1161 def SetPosition(*args, **kwargs):
1162 """SetPosition(self, Point p)"""
1163 return _core_.Rect_SetPosition(*args, **kwargs)
1164
1165 def GetSize(*args, **kwargs):
1166 """GetSize(self) -> Size"""
1167 return _core_.Rect_GetSize(*args, **kwargs)
1168
1169 def SetSize(*args, **kwargs):
1170 """SetSize(self, Size s)"""
1171 return _core_.Rect_SetSize(*args, **kwargs)
1172
aff4cc5c
RD		 1173 def IsEmpty(*args, **kwargs):
1174 """IsEmpty(self) -> bool"""
1175 return _core_.Rect_IsEmpty(*args, **kwargs)
1176
d55e5bfc
RD		 1177 def GetTopLeft(*args, **kwargs):
1178 """GetTopLeft(self) -> Point"""
1179 return _core_.Rect_GetTopLeft(*args, **kwargs)
1180
1181 def SetTopLeft(*args, **kwargs):
1182 """SetTopLeft(self, Point p)"""
1183 return _core_.Rect_SetTopLeft(*args, **kwargs)
1184
1185 def GetBottomRight(*args, **kwargs):
1186 """GetBottomRight(self) -> Point"""
1187 return _core_.Rect_GetBottomRight(*args, **kwargs)
1188
1189 def SetBottomRight(*args, **kwargs):
1190 """SetBottomRight(self, Point p)"""
1191 return _core_.Rect_SetBottomRight(*args, **kwargs)
1192
1193 def GetLeft(*args, **kwargs):
1194 """GetLeft(self) -> int"""
1195 return _core_.Rect_GetLeft(*args, **kwargs)
1196
1197 def GetTop(*args, **kwargs):
1198 """GetTop(self) -> int"""
1199 return _core_.Rect_GetTop(*args, **kwargs)
1200
1201 def GetBottom(*args, **kwargs):
1202 """GetBottom(self) -> int"""
1203 return _core_.Rect_GetBottom(*args, **kwargs)
1204
1205 def GetRight(*args, **kwargs):
1206 """GetRight(self) -> int"""
1207 return _core_.Rect_GetRight(*args, **kwargs)
1208
1209 def SetLeft(*args, **kwargs):
1210 """SetLeft(self, int left)"""
1211 return _core_.Rect_SetLeft(*args, **kwargs)
1212
1213 def SetRight(*args, **kwargs):
1214 """SetRight(self, int right)"""
1215 return _core_.Rect_SetRight(*args, **kwargs)
1216
1217 def SetTop(*args, **kwargs):
1218 """SetTop(self, int top)"""
1219 return _core_.Rect_SetTop(*args, **kwargs)
1220
1221 def SetBottom(*args, **kwargs):
1222 """SetBottom(self, int bottom)"""
1223 return _core_.Rect_SetBottom(*args, **kwargs)
1224
1225 position = property(GetPosition, SetPosition)
1226 size = property(GetSize, SetSize)
1227 left = property(GetLeft, SetLeft)
1228 right = property(GetRight, SetRight)
1229 top = property(GetTop, SetTop)
1230 bottom = property(GetBottom, SetBottom)
1231
1232 def Inflate(*args, **kwargs):
1233 """
1234 Inflate(self, int dx, int dy) -> Rect
1235
091fdbfa
RD		 1236 Increases the size of the rectangle.
1237
1238 The left border is moved farther left and the right border is moved
1239 farther right by ``dx``. The upper border is moved farther up and the
1240 bottom border is moved farther down by ``dy``. (Note the the width and
1241 height of the rectangle thus change by ``2*dx`` and ``2*dy``,
1242 respectively.) If one or both of ``dx`` and ``dy`` are negative, the
1243 opposite happens: the rectangle size decreases in the respective
1244 direction.
1245
1246 The change is made to the rectangle inplace, if instead you need a
1247 copy that is inflated, preserving the original then make the copy
1248 first::
1249
1250 copy = wx.Rect(*original)
1251 copy.Inflate(10,15)
1252
1253
d55e5bfc
RD		 1254 """
1255 return _core_.Rect_Inflate(*args, **kwargs)
1256
1257 def Deflate(*args, **kwargs):
1258 """
1259 Deflate(self, int dx, int dy) -> Rect
1260
091fdbfa
RD		 1261 Decrease the rectangle size. This method is the opposite of `Inflate`
1262 in that Deflate(a,b) is equivalent to Inflate(-a,-b). Please refer to
1263 `Inflate` for a full description.
d55e5bfc
RD		 1264 """
1265 return _core_.Rect_Deflate(*args, **kwargs)
1266
1267 def OffsetXY(*args, **kwargs):
1268 """
1269 OffsetXY(self, int dx, int dy)
1270
79fccf9d
RD		 1271 Moves the rectangle by the specified offset. If dx is positive, the
1272 rectangle is moved to the right, if dy is positive, it is moved to the
1273 bottom, otherwise it is moved to the left or top respectively.
d55e5bfc
RD		 1274 """
1275 return _core_.Rect_OffsetXY(*args, **kwargs)
1276
1277 def Offset(*args, **kwargs):
1278 """
1279 Offset(self, Point pt)
1280
b1fcee84 1281 Same as `OffsetXY` but uses dx,dy from Point
d55e5bfc
RD		 1282 """
1283 return _core_.Rect_Offset(*args, **kwargs)
1284
1285 def Intersect(*args, **kwargs):
1286 """
1287 Intersect(self, Rect rect) -> Rect
1288
b519803b 1289 Returns the intersectsion of this rectangle and rect.
d55e5bfc
RD		 1290 """
1291 return _core_.Rect_Intersect(*args, **kwargs)
1292
b519803b
RD		 1293 def Union(*args, **kwargs):
1294 """
1295 Union(self, Rect rect) -> Rect
1296
1297 Returns the union of this rectangle and rect.
1298 """
1299 return _core_.Rect_Union(*args, **kwargs)
1300
d55e5bfc
RD		 1301 def __add__(*args, **kwargs):
1302 """
1303 __add__(self, Rect rect) -> Rect
1304
1305 Add the properties of rect to this rectangle and return the result.
1306 """
1307 return _core_.Rect___add__(*args, **kwargs)
1308
1309 def __iadd__(*args, **kwargs):
1310 """
1311 __iadd__(self, Rect rect) -> Rect
1312
1313 Add the properties of rect to this rectangle, updating this rectangle.
1314 """
1315 return _core_.Rect___iadd__(*args, **kwargs)
1316
1317 def __eq__(*args, **kwargs):
1318 """
1319 __eq__(self, Rect rect) -> bool
1320
1321 Test for equality.
1322 """
1323 return _core_.Rect___eq__(*args, **kwargs)
1324
1325 def __ne__(*args, **kwargs):
1326 """
1327 __ne__(self, Rect rect) -> bool
1328
1329 Test for inequality.
1330 """
1331 return _core_.Rect___ne__(*args, **kwargs)
1332
1333 def InsideXY(*args, **kwargs):
1334 """
1335 InsideXY(self, int x, int y) -> bool
1336
1337 Return True if the point is (not strcitly) inside the rect.
1338 """
1339 return _core_.Rect_InsideXY(*args, **kwargs)
1340
1341 def Inside(*args, **kwargs):
1342 """
1343 Inside(self, Point pt) -> bool
1344
1345 Return True if the point is (not strcitly) inside the rect.
1346 """
1347 return _core_.Rect_Inside(*args, **kwargs)
1348
1349 def Intersects(*args, **kwargs):
1350 """
1351 Intersects(self, Rect rect) -> bool
1352
1353 Returns True if the rectangles have a non empty intersection.
1354 """
1355 return _core_.Rect_Intersects(*args, **kwargs)
1356
b1fcee84
RD		 1357 def CenterIn(*args, **kwargs):
1358 """
1359 CenterIn(self, Rect r, int dir=BOTH) -> Rect
1360
1361 Center this rectangle within the one passed to the method, which is
1362 usually, but not necessarily, the larger one.
1363 """
1364 return _core_.Rect_CenterIn(*args, **kwargs)
1365
1366 CentreIn = CenterIn
d55e5bfc
RD		 1367 x = property(_core_.Rect_x_get, _core_.Rect_x_set)
1368 y = property(_core_.Rect_y_get, _core_.Rect_y_set)
1369 width = property(_core_.Rect_width_get, _core_.Rect_width_set)
1370 height = property(_core_.Rect_height_get, _core_.Rect_height_set)
1371 def Set(*args, **kwargs):
1372 """
1373 Set(self, int x=0, int y=0, int width=0, int height=0)
1374
1375 Set all rectangle properties.
1376 """
1377 return _core_.Rect_Set(*args, **kwargs)
1378
1379 def Get(*args, **kwargs):
1380 """
1381 Get() -> (x,y,width,height)
1382
1383 Return the rectangle properties as a tuple.
1384 """
1385 return _core_.Rect_Get(*args, **kwargs)
1386
79fccf9d 1387 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD		 1388 def __str__(self): return str(self.Get())
1389 def __repr__(self): return 'wx.Rect'+str(self.Get())
1390 def __len__(self): return len(self.Get())
1391 def __getitem__(self, index): return self.Get()[index]
1392 def __setitem__(self, index, val):
1393 if index == 0: self.x = val
1394 elif index == 1: self.y = val
1395 elif index == 2: self.width = val
1396 elif index == 3: self.height = val
1397 else: raise IndexError
1398 def __nonzero__(self): return self.Get() != (0,0,0,0)
1399 __safe_for_unpickling__ = True
1400 def __reduce__(self): return (wx.Rect, self.Get())
1401
554f62e9
RD		 1402Rect_swigregister = _core_.Rect_swigregister
1403Rect_swigregister(Rect)
d55e5bfc
RD		 1404
1405def RectPP(*args, **kwargs):
1406 """
1407 RectPP(Point topLeft, Point bottomRight) -> Rect
1408
1409 Create a new Rect object from Points representing two corners.
1410 """
1411 val = _core_.new_RectPP(*args, **kwargs)
d55e5bfc
RD		 1412 return val
1413
1414def RectPS(*args, **kwargs):
1415 """
1416 RectPS(Point pos, Size size) -> Rect
1417
1418 Create a new Rect from a position and size.
1419 """
1420 val = _core_.new_RectPS(*args, **kwargs)
d55e5bfc
RD		 1421 return val
1422
c1cb24a4
RD		 1423def RectS(*args, **kwargs):
1424 """
1425 RectS(Size size) -> Rect
1426
1427 Create a new Rect from a size only.
1428 """
1429 val = _core_.new_RectS(*args, **kwargs)
c1cb24a4
RD		 1430 return val
1431
d55e5bfc
RD		 1432
1433def IntersectRect(*args, **kwargs):
554f62e9 1434 """
d55e5bfc
RD		 1435 IntersectRect(Rect r1, Rect r2) -> Rect
1436
1437 Calculate and return the intersection of r1 and r2.
1438 """
554f62e9 1439 return _core_.IntersectRect(*args, **kwargs)
d55e5bfc
RD		 1440#---------------------------------------------------------------------------
1441
1442class Point2D(object):
79fccf9d
RD		 1443 """
1444 wx.Point2Ds represent a point or a vector in a 2d coordinate system
1445 with floating point values.
1446 """
554f62e9
RD		 1447 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1448 __repr__ = _swig_repr
1449 def __init__(self, *args, **kwargs):
d55e5bfc
RD		 1450 """
1451 __init__(self, double x=0.0, double y=0.0) -> Point2D
1452
1453 Create a w.Point2D object.
1454 """
554f62e9 1455 _core_.Point2D_swiginit(self,_core_.new_Point2D(*args, **kwargs))
d55e5bfc 1456 def GetFloor(*args, **kwargs):
a8eff060
RD		 1457 """
1458 GetFloor() -> (x,y)
1459
1460 Convert to integer
1461 """
d55e5bfc
RD		 1462 return _core_.Point2D_GetFloor(*args, **kwargs)
1463
1464 def GetRounded(*args, **kwargs):
a8eff060
RD		 1465 """
1466 GetRounded() -> (x,y)
1467
1468 Convert to integer
1469 """
d55e5bfc
RD		 1470 return _core_.Point2D_GetRounded(*args, **kwargs)
1471
1472 def GetVectorLength(*args, **kwargs):
1473 """GetVectorLength(self) -> double"""
1474 return _core_.Point2D_GetVectorLength(*args, **kwargs)
1475
1476 def GetVectorAngle(*args, **kwargs):
1477 """GetVectorAngle(self) -> double"""
1478 return _core_.Point2D_GetVectorAngle(*args, **kwargs)
1479
1480 def SetVectorLength(*args, **kwargs):
1481 """SetVectorLength(self, double length)"""
1482 return _core_.Point2D_SetVectorLength(*args, **kwargs)
1483
1484 def SetVectorAngle(*args, **kwargs):
1485 """SetVectorAngle(self, double degrees)"""
1486 return _core_.Point2D_SetVectorAngle(*args, **kwargs)
1487
1488 def SetPolarCoordinates(self, angle, length):
1489 self.SetVectorLength(length)
1490 self.SetVectorAngle(angle)
1491 def Normalize(self):
1492 self.SetVectorLength(1.0)
1493
1494 def GetDistance(*args, **kwargs):
1495 """GetDistance(self, Point2D pt) -> double"""
1496 return _core_.Point2D_GetDistance(*args, **kwargs)
1497
1498 def GetDistanceSquare(*args, **kwargs):
1499 """GetDistanceSquare(self, Point2D pt) -> double"""
1500 return _core_.Point2D_GetDistanceSquare(*args, **kwargs)
1501
1502 def GetDotProduct(*args, **kwargs):
1503 """GetDotProduct(self, Point2D vec) -> double"""
1504 return _core_.Point2D_GetDotProduct(*args, **kwargs)
1505
1506 def GetCrossProduct(*args, **kwargs):
1507 """GetCrossProduct(self, Point2D vec) -> double"""
1508 return _core_.Point2D_GetCrossProduct(*args, **kwargs)
1509
1510 def __neg__(*args, **kwargs):
1511 """
1512 __neg__(self) -> Point2D
1513
1514 the reflection of this point
1515 """
1516 return _core_.Point2D___neg__(*args, **kwargs)
1517
1518 def __iadd__(*args, **kwargs):
1519 """__iadd__(self, Point2D pt) -> Point2D"""
1520 return _core_.Point2D___iadd__(*args, **kwargs)
1521
1522 def __isub__(*args, **kwargs):
1523 """__isub__(self, Point2D pt) -> Point2D"""
1524 return _core_.Point2D___isub__(*args, **kwargs)
1525
1526 def __imul__(*args, **kwargs):
1527 """__imul__(self, Point2D pt) -> Point2D"""
1528 return _core_.Point2D___imul__(*args, **kwargs)
1529
1530 def __idiv__(*args, **kwargs):
1531 """__idiv__(self, Point2D pt) -> Point2D"""
1532 return _core_.Point2D___idiv__(*args, **kwargs)
1533
1534 def __eq__(*args, **kwargs):
1535 """
1536 __eq__(self, Point2D pt) -> bool
1537
1538 Test for equality
1539 """
1540 return _core_.Point2D___eq__(*args, **kwargs)
1541
1542 def __ne__(*args, **kwargs):
1543 """
1544 __ne__(self, Point2D pt) -> bool
1545
1546 Test for inequality
1547 """
1548 return _core_.Point2D___ne__(*args, **kwargs)
1549
1550 x = property(_core_.Point2D_x_get, _core_.Point2D_x_set)
1551 y = property(_core_.Point2D_y_get, _core_.Point2D_y_set)
1552 def Set(*args, **kwargs):
1553 """Set(self, double x=0, double y=0)"""
1554 return _core_.Point2D_Set(*args, **kwargs)
1555
1556 def Get(*args, **kwargs):
1557 """
1558 Get() -> (x,y)
1559
1560 Return x and y properties as a tuple.
1561 """
1562 return _core_.Point2D_Get(*args, **kwargs)
1563
79fccf9d 1564 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD		 1565 def __str__(self): return str(self.Get())
1566 def __repr__(self): return 'wx.Point2D'+str(self.Get())
1567 def __len__(self): return len(self.Get())
1568 def __getitem__(self, index): return self.Get()[index]
1569 def __setitem__(self, index, val):
1570 if index == 0: self.x = val
1571 elif index == 1: self.y = val
1572 else: raise IndexError
1573 def __nonzero__(self): return self.Get() != (0.0, 0.0)
1574 __safe_for_unpickling__ = True
1575 def __reduce__(self): return (wx.Point2D, self.Get())
1576
554f62e9
RD		 1577Point2D_swigregister = _core_.Point2D_swigregister
1578Point2D_swigregister(Point2D)
d55e5bfc
RD		 1579
1580def Point2DCopy(*args, **kwargs):
1581 """
1582 Point2DCopy(Point2D pt) -> Point2D
1583
1584 Create a w.Point2D object.
1585 """
1586 val = _core_.new_Point2DCopy(*args, **kwargs)
d55e5bfc
RD		 1587 return val
1588
1589def Point2DFromPoint(*args, **kwargs):
1590 """
1591 Point2DFromPoint(Point pt) -> Point2D
1592
1593 Create a w.Point2D object.
1594 """
1595 val = _core_.new_Point2DFromPoint(*args, **kwargs)
d55e5bfc
RD		 1596 return val
1597
1598#---------------------------------------------------------------------------
1599
1600FromStart = _core_.FromStart
1601FromCurrent = _core_.FromCurrent
1602FromEnd = _core_.FromEnd
1603class InputStream(object):
093d3ff1 1604 """Proxy of C++ InputStream class"""
554f62e9
RD		 1605 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1606 __repr__ = _swig_repr
1607 def __init__(self, *args, **kwargs):
d55e5bfc 1608 """__init__(self, PyObject p) -> InputStream"""
554f62e9
RD		 1609 _core_.InputStream_swiginit(self,_core_.new_InputStream(*args, **kwargs))
1610 __swig_destroy__ = _core_.delete_InputStream
1611 __del__ = lambda self : None;
d55e5bfc
RD		 1612 def close(*args, **kwargs):
1613 """close(self)"""
1614 return _core_.InputStream_close(*args, **kwargs)
1615
1616 def flush(*args, **kwargs):
1617 """flush(self)"""
1618 return _core_.InputStream_flush(*args, **kwargs)
1619
1620 def eof(*args, **kwargs):
1621 """eof(self) -> bool"""
1622 return _core_.InputStream_eof(*args, **kwargs)
1623
1624 def read(*args, **kwargs):
1625 """read(self, int size=-1) -> PyObject"""
1626 return _core_.InputStream_read(*args, **kwargs)
1627
1628 def readline(*args, **kwargs):
1629 """readline(self, int size=-1) -> PyObject"""
1630 return _core_.InputStream_readline(*args, **kwargs)
1631
1632 def readlines(*args, **kwargs):
1633 """readlines(self, int sizehint=-1) -> PyObject"""
1634 return _core_.InputStream_readlines(*args, **kwargs)
1635
1636 def seek(*args, **kwargs):
1637 """seek(self, int offset, int whence=0)"""
1638 return _core_.InputStream_seek(*args, **kwargs)
1639
1640 def tell(*args, **kwargs):
1641 """tell(self) -> int"""
1642 return _core_.InputStream_tell(*args, **kwargs)
1643
1644 def Peek(*args, **kwargs):
1645 """Peek(self) -> char"""
1646 return _core_.InputStream_Peek(*args, **kwargs)
1647
1648 def GetC(*args, **kwargs):
1649 """GetC(self) -> char"""
1650 return _core_.InputStream_GetC(*args, **kwargs)
1651
1652 def LastRead(*args, **kwargs):
1653 """LastRead(self) -> size_t"""
1654 return _core_.InputStream_LastRead(*args, **kwargs)
1655
1656 def CanRead(*args, **kwargs):
1657 """CanRead(self) -> bool"""
1658 return _core_.InputStream_CanRead(*args, **kwargs)
1659
1660 def Eof(*args, **kwargs):
1661 """Eof(self) -> bool"""
1662 return _core_.InputStream_Eof(*args, **kwargs)
1663
1664 def Ungetch(*args, **kwargs):
1665 """Ungetch(self, char c) -> bool"""
1666 return _core_.InputStream_Ungetch(*args, **kwargs)
1667
1668 def SeekI(*args, **kwargs):
1669 """SeekI(self, long pos, int mode=FromStart) -> long"""
1670 return _core_.InputStream_SeekI(*args, **kwargs)
1671
1672 def TellI(*args, **kwargs):
1673 """TellI(self) -> long"""
1674 return _core_.InputStream_TellI(*args, **kwargs)
1675
554f62e9
RD		 1676InputStream_swigregister = _core_.InputStream_swigregister
1677InputStream_swigregister(InputStream)
d55e5bfc
RD		 1678DefaultPosition = cvar.DefaultPosition
1679DefaultSize = cvar.DefaultSize
1680
1681class OutputStream(object):
093d3ff1 1682 """Proxy of C++ OutputStream class"""
554f62e9
RD		 1683 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1684 def __init__(self): raise AttributeError, "No constructor defined"
1685 __repr__ = _swig_repr
d55e5bfc
RD		 1686 def write(*args, **kwargs):
1687 """write(self, PyObject obj)"""
1688 return _core_.OutputStream_write(*args, **kwargs)
1689
554f62e9
RD		 1690 def LastWrite(*args, **kwargs):
1691 """LastWrite(self) -> size_t"""
1692 return _core_.OutputStream_LastWrite(*args, **kwargs)
d55e5bfc 1693
554f62e9
RD		 1694OutputStream_swigregister = _core_.OutputStream_swigregister
1695OutputStream_swigregister(OutputStream)
d55e5bfc
RD		 1696
1697#---------------------------------------------------------------------------
1698
1699class FSFile(Object):
093d3ff1 1700 """Proxy of C++ FSFile class"""
554f62e9
RD		 1701 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1702 __repr__ = _swig_repr
1703 def __init__(self, *args, **kwargs):
d55e5bfc
RD		 1704 """
1705 __init__(self, InputStream stream, String loc, String mimetype, String anchor,
1706 DateTime modif) -> FSFile
1707 """
554f62e9 1708 _core_.FSFile_swiginit(self,_core_.new_FSFile(*args, **kwargs))
e2950dbb 1709 self.thisown = 0 # It will normally be deleted by the user of the wx.FileSystem
4cf4100f 1710
554f62e9
RD		 1711 __swig_destroy__ = _core_.delete_FSFile
1712 __del__ = lambda self : None;
d55e5bfc
RD		 1713 def GetStream(*args, **kwargs):
1714 """GetStream(self) -> InputStream"""
1715 return _core_.FSFile_GetStream(*args, **kwargs)
1716
1717 def GetMimeType(*args, **kwargs):
1718 """GetMimeType(self) -> String"""
1719 return _core_.FSFile_GetMimeType(*args, **kwargs)
1720
1721 def GetLocation(*args, **kwargs):
1722 """GetLocation(self) -> String"""
1723 return _core_.FSFile_GetLocation(*args, **kwargs)
1724
1725 def GetAnchor(*args, **kwargs):
1726 """GetAnchor(self) -> String"""
1727 return _core_.FSFile_GetAnchor(*args, **kwargs)
1728
1729 def GetModificationTime(*args, **kwargs):
1730 """GetModificationTime(self) -> DateTime"""
1731 return _core_.FSFile_GetModificationTime(*args, **kwargs)
1732
554f62e9
RD		 1733FSFile_swigregister = _core_.FSFile_swigregister
1734FSFile_swigregister(FSFile)
d55e5bfc
RD		 1735
1736class CPPFileSystemHandler(object):
093d3ff1 1737 """Proxy of C++ CPPFileSystemHandler class"""
554f62e9
RD		 1738 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1739 def __init__(self): raise AttributeError, "No constructor defined"
1740 __repr__ = _swig_repr
50f151d7
RD		 1741 __swig_destroy__ = _core_.delete_CPPFileSystemHandler
1742 __del__ = lambda self : None;
554f62e9
RD		 1743CPPFileSystemHandler_swigregister = _core_.CPPFileSystemHandler_swigregister
1744CPPFileSystemHandler_swigregister(CPPFileSystemHandler)
d55e5bfc
RD		 1745
1746class FileSystemHandler(CPPFileSystemHandler):
093d3ff1 1747 """Proxy of C++ FileSystemHandler class"""
554f62e9
RD		 1748 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1749 __repr__ = _swig_repr
1750 def __init__(self, *args, **kwargs):
d55e5bfc 1751 """__init__(self) -> FileSystemHandler"""
554f62e9 1752 _core_.FileSystemHandler_swiginit(self,_core_.new_FileSystemHandler(*args, **kwargs))
d55e5bfc
RD		 1753 self._setCallbackInfo(self, FileSystemHandler)
1754
1755 def _setCallbackInfo(*args, **kwargs):
1756 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
1757 return _core_.FileSystemHandler__setCallbackInfo(*args, **kwargs)
1758
1759 def CanOpen(*args, **kwargs):
1760 """CanOpen(self, String location) -> bool"""
1761 return _core_.FileSystemHandler_CanOpen(*args, **kwargs)
1762
1763 def OpenFile(*args, **kwargs):
1764 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
1765 return _core_.FileSystemHandler_OpenFile(*args, **kwargs)
1766
1767 def FindFirst(*args, **kwargs):
1768 """FindFirst(self, String spec, int flags=0) -> String"""
1769 return _core_.FileSystemHandler_FindFirst(*args, **kwargs)
1770
1771 def FindNext(*args, **kwargs):
1772 """FindNext(self) -> String"""
1773 return _core_.FileSystemHandler_FindNext(*args, **kwargs)
1774
1775 def GetProtocol(*args, **kwargs):
1776 """GetProtocol(self, String location) -> String"""
1777 return _core_.FileSystemHandler_GetProtocol(*args, **kwargs)
1778
1779 def GetLeftLocation(*args, **kwargs):
1780 """GetLeftLocation(self, String location) -> String"""
1781 return _core_.FileSystemHandler_GetLeftLocation(*args, **kwargs)
1782
1783 def GetAnchor(*args, **kwargs):
1784 """GetAnchor(self, String location) -> String"""
1785 return _core_.FileSystemHandler_GetAnchor(*args, **kwargs)
1786
1787 def GetRightLocation(*args, **kwargs):
1788 """GetRightLocation(self, String location) -> String"""
1789 return _core_.FileSystemHandler_GetRightLocation(*args, **kwargs)
1790
1791 def GetMimeTypeFromExt(*args, **kwargs):
1792 """GetMimeTypeFromExt(self, String location) -> String"""
1793 return _core_.FileSystemHandler_GetMimeTypeFromExt(*args, **kwargs)
1794
554f62e9
RD		 1795FileSystemHandler_swigregister = _core_.FileSystemHandler_swigregister
1796FileSystemHandler_swigregister(FileSystemHandler)
d55e5bfc
RD		 1797
1798class FileSystem(Object):
093d3ff1 1799 """Proxy of C++ FileSystem class"""
554f62e9
RD		 1800 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1801 __repr__ = _swig_repr
1802 def __init__(self, *args, **kwargs):
d55e5bfc 1803 """__init__(self) -> FileSystem"""
554f62e9
RD		 1804 _core_.FileSystem_swiginit(self,_core_.new_FileSystem(*args, **kwargs))
1805 __swig_destroy__ = _core_.delete_FileSystem
1806 __del__ = lambda self : None;
d55e5bfc
RD		 1807 def ChangePathTo(*args, **kwargs):
1808 """ChangePathTo(self, String location, bool is_dir=False)"""
1809 return _core_.FileSystem_ChangePathTo(*args, **kwargs)
1810
1811 def GetPath(*args, **kwargs):
1812 """GetPath(self) -> String"""
1813 return _core_.FileSystem_GetPath(*args, **kwargs)
1814
1815 def OpenFile(*args, **kwargs):
1816 """OpenFile(self, String location) -> FSFile"""
1817 return _core_.FileSystem_OpenFile(*args, **kwargs)
1818
1819 def FindFirst(*args, **kwargs):
1820 """FindFirst(self, String spec, int flags=0) -> String"""
1821 return _core_.FileSystem_FindFirst(*args, **kwargs)
1822
1823 def FindNext(*args, **kwargs):
1824 """FindNext(self) -> String"""
1825 return _core_.FileSystem_FindNext(*args, **kwargs)
1826
1827 def AddHandler(*args, **kwargs):
c24da6d6 1828 """AddHandler(CPPFileSystemHandler handler)"""
d55e5bfc
RD		 1829 return _core_.FileSystem_AddHandler(*args, **kwargs)
1830
1831 AddHandler = staticmethod(AddHandler)
1832 def CleanUpHandlers(*args, **kwargs):
c24da6d6 1833 """CleanUpHandlers()"""
d55e5bfc
RD		 1834 return _core_.FileSystem_CleanUpHandlers(*args, **kwargs)
1835
1836 CleanUpHandlers = staticmethod(CleanUpHandlers)
1837 def FileNameToURL(*args, **kwargs):
c24da6d6 1838 """FileNameToURL(String filename) -> String"""
d55e5bfc
RD		 1839 return _core_.FileSystem_FileNameToURL(*args, **kwargs)
1840
1841 FileNameToURL = staticmethod(FileNameToURL)
ae8162c8
RD		 1842 def URLToFileName(*args, **kwargs):
1843 """URLToFileName(String url) -> String"""
1844 return _core_.FileSystem_URLToFileName(*args, **kwargs)
1845
1846 URLToFileName = staticmethod(URLToFileName)
554f62e9
RD		 1847FileSystem_swigregister = _core_.FileSystem_swigregister
1848FileSystem_swigregister(FileSystem)
d55e5bfc
RD		 1849
1850def FileSystem_AddHandler(*args, **kwargs):
554f62e9
RD		 1851 """FileSystem_AddHandler(CPPFileSystemHandler handler)"""
1852 return _core_.FileSystem_AddHandler(*args, **kwargs)
d55e5bfc 1853
554f62e9
RD		 1854def FileSystem_CleanUpHandlers(*args):
1855 """FileSystem_CleanUpHandlers()"""
1856 return _core_.FileSystem_CleanUpHandlers(*args)
d55e5bfc
RD		 1857
1858def FileSystem_FileNameToURL(*args, **kwargs):
554f62e9
RD		 1859 """FileSystem_FileNameToURL(String filename) -> String"""
1860 return _core_.FileSystem_FileNameToURL(*args, **kwargs)
d55e5bfc 1861
d55e5bfc 1862def FileSystem_URLToFileName(*args, **kwargs):
554f62e9
RD		 1863 """FileSystem_URLToFileName(String url) -> String"""
1864 return _core_.FileSystem_URLToFileName(*args, **kwargs)
ae8162c8 1865
d55e5bfc 1866class InternetFSHandler(CPPFileSystemHandler):
093d3ff1 1867 """Proxy of C++ InternetFSHandler class"""
554f62e9
RD		 1868 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1869 __repr__ = _swig_repr
1870 def __init__(self, *args, **kwargs):
d55e5bfc 1871 """__init__(self) -> InternetFSHandler"""
554f62e9 1872 _core_.InternetFSHandler_swiginit(self,_core_.new_InternetFSHandler(*args, **kwargs))
d55e5bfc
RD		 1873 def CanOpen(*args, **kwargs):
1874 """CanOpen(self, String location) -> bool"""
1875 return _core_.InternetFSHandler_CanOpen(*args, **kwargs)
1876
1877 def OpenFile(*args, **kwargs):
1878 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
1879 return _core_.InternetFSHandler_OpenFile(*args, **kwargs)
1880
554f62e9
RD		 1881InternetFSHandler_swigregister = _core_.InternetFSHandler_swigregister
1882InternetFSHandler_swigregister(InternetFSHandler)
d55e5bfc
RD		 1883
1884class ZipFSHandler(CPPFileSystemHandler):
093d3ff1 1885 """Proxy of C++ ZipFSHandler class"""
554f62e9
RD		 1886 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1887 __repr__ = _swig_repr
1888 def __init__(self, *args, **kwargs):
d55e5bfc 1889 """__init__(self) -> ZipFSHandler"""
554f62e9 1890 _core_.ZipFSHandler_swiginit(self,_core_.new_ZipFSHandler(*args, **kwargs))
d55e5bfc
RD		 1891 def CanOpen(*args, **kwargs):
1892 """CanOpen(self, String location) -> bool"""
1893 return _core_.ZipFSHandler_CanOpen(*args, **kwargs)
1894
1895 def OpenFile(*args, **kwargs):
1896 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
1897 return _core_.ZipFSHandler_OpenFile(*args, **kwargs)
1898
1899 def FindFirst(*args, **kwargs):
1900 """FindFirst(self, String spec, int flags=0) -> String"""
1901 return _core_.ZipFSHandler_FindFirst(*args, **kwargs)
1902
1903 def FindNext(*args, **kwargs):
1904 """FindNext(self) -> String"""
1905 return _core_.ZipFSHandler_FindNext(*args, **kwargs)
1906
554f62e9
RD		 1907ZipFSHandler_swigregister = _core_.ZipFSHandler_swigregister
1908ZipFSHandler_swigregister(ZipFSHandler)
d55e5bfc
RD		 1909
1910
1911def __wxMemoryFSHandler_AddFile_wxImage(*args, **kwargs):
554f62e9
RD		 1912 """__wxMemoryFSHandler_AddFile_wxImage(String filename, Image image, long type)"""
1913 return _core_.__wxMemoryFSHandler_AddFile_wxImage(*args, **kwargs)
d55e5bfc
RD		 1914
1915def __wxMemoryFSHandler_AddFile_wxBitmap(*args, **kwargs):
554f62e9
RD		 1916 """__wxMemoryFSHandler_AddFile_wxBitmap(String filename, Bitmap bitmap, long type)"""
1917 return _core_.__wxMemoryFSHandler_AddFile_wxBitmap(*args, **kwargs)
d55e5bfc
RD		 1918
1919def __wxMemoryFSHandler_AddFile_Data(*args, **kwargs):
554f62e9
RD		 1920 """__wxMemoryFSHandler_AddFile_Data(String filename, PyObject data)"""
1921 return _core_.__wxMemoryFSHandler_AddFile_Data(*args, **kwargs)
ae8162c8
RD		 1922def MemoryFSHandler_AddFile(filename, dataItem, imgType=-1):
1923 """
1924 Add 'file' to the memory filesystem. The dataItem parameter can
1925 either be a `wx.Bitmap`, `wx.Image` or a string that can contain
1926 arbitrary data. If a bitmap or image is used then the imgType
1927 parameter should specify what kind of image file it should be
1928 written as, wx.BITMAP_TYPE_PNG, etc.
1929 """
1930 if isinstance(dataItem, wx.Image):
1931 __wxMemoryFSHandler_AddFile_wxImage(filename, dataItem, imgType)
1932 elif isinstance(dataItem, wx.Bitmap):
1933 __wxMemoryFSHandler_AddFile_wxBitmap(filename, dataItem, imgType)
1934 elif type(dataItem) == str:
1935 __wxMemoryFSHandler_AddFile_Data(filename, dataItem)
1936 else:
1937 raise TypeError, 'wx.Image, wx.Bitmap or string expected'
d55e5bfc
RD		 1938
1939class MemoryFSHandler(CPPFileSystemHandler):
093d3ff1 1940 """Proxy of C++ MemoryFSHandler class"""
554f62e9
RD		 1941 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1942 __repr__ = _swig_repr
1943 def __init__(self, *args, **kwargs):
d55e5bfc 1944 """__init__(self) -> MemoryFSHandler"""
554f62e9 1945 _core_.MemoryFSHandler_swiginit(self,_core_.new_MemoryFSHandler(*args, **kwargs))
d55e5bfc 1946 def RemoveFile(*args, **kwargs):
c24da6d6 1947 """RemoveFile(String filename)"""
d55e5bfc
RD		 1948 return _core_.MemoryFSHandler_RemoveFile(*args, **kwargs)
1949
1950 RemoveFile = staticmethod(RemoveFile)
1951 AddFile = staticmethod(MemoryFSHandler_AddFile)
1952 def CanOpen(*args, **kwargs):
1953 """CanOpen(self, String location) -> bool"""
1954 return _core_.MemoryFSHandler_CanOpen(*args, **kwargs)
1955
1956 def OpenFile(*args, **kwargs):
1957 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
1958 return _core_.MemoryFSHandler_OpenFile(*args, **kwargs)
1959
1960 def FindFirst(*args, **kwargs):
1961 """FindFirst(self, String spec, int flags=0) -> String"""
1962 return _core_.MemoryFSHandler_FindFirst(*args, **kwargs)
1963
1964 def FindNext(*args, **kwargs):
1965 """FindNext(self) -> String"""
1966 return _core_.MemoryFSHandler_FindNext(*args, **kwargs)
1967
554f62e9
RD		 1968MemoryFSHandler_swigregister = _core_.MemoryFSHandler_swigregister
1969MemoryFSHandler_swigregister(MemoryFSHandler)
d55e5bfc
RD		 1970
1971def MemoryFSHandler_RemoveFile(*args, **kwargs):
554f62e9
RD		 1972 """MemoryFSHandler_RemoveFile(String filename)"""
1973 return _core_.MemoryFSHandler_RemoveFile(*args, **kwargs)
d55e5bfc 1974
57133d5c
RD		 1975IMAGE_ALPHA_TRANSPARENT = _core_.IMAGE_ALPHA_TRANSPARENT
1976IMAGE_ALPHA_THRESHOLD = _core_.IMAGE_ALPHA_THRESHOLD
1977IMAGE_ALPHA_OPAQUE = _core_.IMAGE_ALPHA_OPAQUE
d55e5bfc
RD		 1978#---------------------------------------------------------------------------
1979
1980class ImageHandler(Object):
27fb7603
RD		 1981 """
1982 This is the base class for implementing image file loading/saving, and
1983 image creation from data. It is used within `wx.Image` and is not
1984 normally seen by the application.
1985 """
554f62e9
RD		 1986 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1987 def __init__(self): raise AttributeError, "No constructor defined"
1988 __repr__ = _swig_repr
d55e5bfc
RD		 1989 def GetName(*args, **kwargs):
1990 """GetName(self) -> String"""
1991 return _core_.ImageHandler_GetName(*args, **kwargs)
1992
1993 def GetExtension(*args, **kwargs):
1994 """GetExtension(self) -> String"""
1995 return _core_.ImageHandler_GetExtension(*args, **kwargs)
1996
1997 def GetType(*args, **kwargs):
1998 """GetType(self) -> long"""
1999 return _core_.ImageHandler_GetType(*args, **kwargs)
2000
2001 def GetMimeType(*args, **kwargs):
2002 """GetMimeType(self) -> String"""
2003 return _core_.ImageHandler_GetMimeType(*args, **kwargs)
2004
2005 def CanRead(*args, **kwargs):
2006 """CanRead(self, String name) -> bool"""
2007 return _core_.ImageHandler_CanRead(*args, **kwargs)
2008
2009 def SetName(*args, **kwargs):
2010 """SetName(self, String name)"""
2011 return _core_.ImageHandler_SetName(*args, **kwargs)
2012
2013 def SetExtension(*args, **kwargs):
2014 """SetExtension(self, String extension)"""
2015 return _core_.ImageHandler_SetExtension(*args, **kwargs)
2016
2017 def SetType(*args, **kwargs):
2018 """SetType(self, long type)"""
2019 return _core_.ImageHandler_SetType(*args, **kwargs)
2020
2021 def SetMimeType(*args, **kwargs):
2022 """SetMimeType(self, String mimetype)"""
2023 return _core_.ImageHandler_SetMimeType(*args, **kwargs)
2024
554f62e9
RD		 2025ImageHandler_swigregister = _core_.ImageHandler_swigregister
2026ImageHandler_swigregister(ImageHandler)
d55e5bfc 2027
9d7dfdff
RD		 2028class PyImageHandler(ImageHandler):
2029 """
2030 This is the base class for implementing image file loading/saving, and
2031 image creation from data, all written in Python. To create a custom
2032 image handler derive a new class from wx.PyImageHandler and provide
2033 the following methods::
2034
2035 def DoCanRead(self, stream) --> bool
2036 '''Check if this handler can read the image on the stream'''
2037
2038 def LoadFile(self, image, stream, verbose, index) --> bool
2039 '''Load image data from the stream and load it into image.'''
2040
2041 def SaveFile(self, image, stream, verbose) --> bool
2042 '''Save the iamge data in image to the stream using
2043 this handler's image file format.'''
2044
2045 def GetImageCount(self, stream) --> int
2046 '''If this image format can hold more than one image,
2047 how many does the image on the stream have?'''
2048
2049 To activate your handler create an instance of it and pass it to
2050 `wx.Image_AddHandler`. Be sure to call `SetName`, `SetType`, and
2051 `SetExtension` from your constructor.
2052
2053 """
554f62e9
RD		 2054 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2055 __repr__ = _swig_repr
2056 def __init__(self, *args, **kwargs):
9d7dfdff
RD		 2057 """
2058 __init__(self) -> PyImageHandler
2059
2060 This is the base class for implementing image file loading/saving, and
2061 image creation from data, all written in Python. To create a custom
2062 image handler derive a new class from wx.PyImageHandler and provide
2063 the following methods::
2064
2065 def DoCanRead(self, stream) --> bool
2066 '''Check if this handler can read the image on the stream'''
2067
2068 def LoadFile(self, image, stream, verbose, index) --> bool
2069 '''Load image data from the stream and load it into image.'''
2070
2071 def SaveFile(self, image, stream, verbose) --> bool
2072 '''Save the iamge data in image to the stream using
2073 this handler's image file format.'''
2074
2075 def GetImageCount(self, stream) --> int
2076 '''If this image format can hold more than one image,
2077 how many does the image on the stream have?'''
2078
2079 To activate your handler create an instance of it and pass it to
2080 `wx.Image_AddHandler`. Be sure to call `SetName`, `SetType`, and
2081 `SetExtension` from your constructor.
2082
2083 """
554f62e9 2084 _core_.PyImageHandler_swiginit(self,_core_.new_PyImageHandler(*args, **kwargs))
9d7dfdff
RD		 2085 self._SetSelf(self)
2086
2087 def _SetSelf(*args, **kwargs):
2088 """_SetSelf(self, PyObject self)"""
2089 return _core_.PyImageHandler__SetSelf(*args, **kwargs)
2090
554f62e9
RD		 2091PyImageHandler_swigregister = _core_.PyImageHandler_swigregister
2092PyImageHandler_swigregister(PyImageHandler)
9d7dfdff 2093
d55e5bfc 2094class ImageHistogram(object):
093d3ff1 2095 """Proxy of C++ ImageHistogram class"""
554f62e9
RD		 2096 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2097 __repr__ = _swig_repr
2098 def __init__(self, *args, **kwargs):
d55e5bfc 2099 """__init__(self) -> ImageHistogram"""
554f62e9 2100 _core_.ImageHistogram_swiginit(self,_core_.new_ImageHistogram(*args, **kwargs))
d55e5bfc
RD		 2101 def MakeKey(*args, **kwargs):
2102 """
7a27cf7c 2103 MakeKey(byte r, byte g, byte b) -> unsigned long
d55e5bfc
RD		 2104
2105 Get the key in the histogram for the given RGB values
2106 """
2107 return _core_.ImageHistogram_MakeKey(*args, **kwargs)
2108
2109 MakeKey = staticmethod(MakeKey)
2110 def FindFirstUnusedColour(*args, **kwargs):
a8eff060
RD		 2111 """
2112 FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)
2113
2114 Find first colour that is not used in the image and has higher RGB
2115 values than startR, startG, startB. Returns a tuple consisting of a
2116 success flag and rgb values.
2117 """
d55e5bfc
RD		 2118 return _core_.ImageHistogram_FindFirstUnusedColour(*args, **kwargs)
2119
f1cbd8fa
RD		 2120 def GetCount(*args, **kwargs):
2121 """
2122 GetCount(self, unsigned long key) -> unsigned long
2123
2124 Returns the pixel count for the given key. Use `MakeKey` to create a
2125 key value from a RGB tripple.
2126 """
2127 return _core_.ImageHistogram_GetCount(*args, **kwargs)
2128
2129 def GetCountRGB(*args, **kwargs):
2130 """
7a27cf7c 2131 GetCountRGB(self, byte r, byte g, byte b) -> unsigned long
f1cbd8fa
RD		 2132
2133 Returns the pixel count for the given RGB values.
2134 """
2135 return _core_.ImageHistogram_GetCountRGB(*args, **kwargs)
2136
2137 def GetCountColour(*args, **kwargs):
2138 """
2139 GetCountColour(self, Colour colour) -> unsigned long
2140
2141 Returns the pixel count for the given `wx.Colour` value.
2142 """
2143 return _core_.ImageHistogram_GetCountColour(*args, **kwargs)
2144
554f62e9
RD		 2145ImageHistogram_swigregister = _core_.ImageHistogram_swigregister
2146ImageHistogram_swigregister(ImageHistogram)
d55e5bfc
RD		 2147
2148def ImageHistogram_MakeKey(*args, **kwargs):
554f62e9 2149 """
7a27cf7c 2150 ImageHistogram_MakeKey(byte r, byte g, byte b) -> unsigned long
d55e5bfc
RD		 2151
2152 Get the key in the histogram for the given RGB values
2153 """
554f62e9 2154 return _core_.ImageHistogram_MakeKey(*args, **kwargs)
d55e5bfc 2155
2f91e3df 2156class Image_RGBValue(object):
9d7dfdff
RD		 2157 """
2158 An object that contains values for red, green and blue which represent
2159 the value of a color. It is used by `wx.Image.HSVtoRGB` and
2160 `wx.Image.RGBtoHSV`, which converts between HSV color space and RGB
2161 color space.
2162 """
554f62e9
RD		 2163 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2164 __repr__ = _swig_repr
2165 def __init__(self, *args, **kwargs):
9d7dfdff
RD		 2166 """
2167 __init__(self, byte r=0, byte g=0, byte b=0) -> Image_RGBValue
2168
2169 Constructor.
2170 """
554f62e9 2171 _core_.Image_RGBValue_swiginit(self,_core_.new_Image_RGBValue(*args, **kwargs))
2f91e3df
KO		 2172 red = property(_core_.Image_RGBValue_red_get, _core_.Image_RGBValue_red_set)
2173 green = property(_core_.Image_RGBValue_green_get, _core_.Image_RGBValue_green_set)
2174 blue = property(_core_.Image_RGBValue_blue_get, _core_.Image_RGBValue_blue_set)
554f62e9
RD		 2175Image_RGBValue_swigregister = _core_.Image_RGBValue_swigregister
2176Image_RGBValue_swigregister(Image_RGBValue)
2f91e3df
KO		 2177
2178class Image_HSVValue(object):
9d7dfdff
RD		 2179 """
2180 An object that contains values for hue, saturation and value which
2181 represent the value of a color. It is used by `wx.Image.HSVtoRGB` and
2182 `wx.Image.RGBtoHSV`, which +converts between HSV color space and RGB
2183 color space.
2184 """
554f62e9
RD		 2185 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2186 __repr__ = _swig_repr
2187 def __init__(self, *args, **kwargs):
9d7dfdff
RD		 2188 """
2189 __init__(self, double h=0.0, double s=0.0, double v=0.0) -> Image_HSVValue
2190
2191 Constructor.
2192 """
554f62e9 2193 _core_.Image_HSVValue_swiginit(self,_core_.new_Image_HSVValue(*args, **kwargs))
2f91e3df
KO		 2194 hue = property(_core_.Image_HSVValue_hue_get, _core_.Image_HSVValue_hue_set)
2195 saturation = property(_core_.Image_HSVValue_saturation_get, _core_.Image_HSVValue_saturation_set)
2196 value = property(_core_.Image_HSVValue_value_get, _core_.Image_HSVValue_value_set)
554f62e9
RD		 2197Image_HSVValue_swigregister = _core_.Image_HSVValue_swigregister
2198Image_HSVValue_swigregister(Image_HSVValue)
2f91e3df 2199
d55e5bfc 2200class Image(Object):
7a27cf7c
RD		 2201 """
2202 A platform-independent image class. An image can be created from
2203 data, or using `wx.Bitmap.ConvertToImage`, or loaded from a file in a
2204 variety of formats. Functions are available to set and get image
2205 bits, so it can be used for basic image manipulation.
2206
2207 A wx.Image cannot be drawn directly to a `wx.DC`. Instead, a
2208 platform-specific `wx.Bitmap` object must be created from it using the
2209 `wx.BitmapFromImage` constructor. This bitmap can then be drawn in a
2210 device context, using `wx.DC.DrawBitmap`.
2211
2212 One colour value of the image may be used as a mask colour which will
2213 lead to the automatic creation of a `wx.Mask` object associated to the
2214 bitmap object.
2215
2216 wx.Image supports alpha channel data, that is in addition to a byte
2217 for the red, green and blue colour components for each pixel it also
2218 stores a byte representing the pixel opacity. An alpha value of 0
2219 corresponds to a transparent pixel (null opacity) while a value of 255
2220 means that the pixel is 100% opaque.
2221
2222 Unlike RGB data, not all images have an alpha channel and before using
2223 `GetAlpha` you should check if this image contains an alpha channel
2224 with `HasAlpha`. Note that currently only images loaded from PNG files
2225 with transparency information will have an alpha channel.
2226 """
554f62e9
RD		 2227 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2228 __repr__ = _swig_repr
2229 def __init__(self, *args, **kwargs):
7a27cf7c
RD		 2230 """
2231 __init__(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> Image
2232
2233 Loads an image from a file.
2234 """
554f62e9
RD		 2235 _core_.Image_swiginit(self,_core_.new_Image(*args, **kwargs))
2236 __swig_destroy__ = _core_.delete_Image
2237 __del__ = lambda self : None;
d55e5bfc 2238 def Create(*args, **kwargs):
7a27cf7c
RD		 2239 """
2240 Create(self, int width, int height, bool clear=True)
2241
2242 Creates a fresh image. If clear is ``True``, the new image will be
2243 initialized to black. Otherwise, the image data will be uninitialized.
2244 """
d55e5bfc
RD		 2245 return _core_.Image_Create(*args, **kwargs)
2246
2247 def Destroy(*args, **kwargs):
2248 """
2249 Destroy(self)
2250
7a27cf7c 2251 Destroys the image data.
d55e5bfc 2252 """
7e08d4ef
RD		 2253 val = _core_.Image_Destroy(*args, **kwargs)
2254 args[0].thisown = 0
2255 return val
d55e5bfc
RD		 2256
2257 def Scale(*args, **kwargs):
7a27cf7c
RD		 2258 """
2259 Scale(self, int width, int height) -> Image
2260
2261 Returns a scaled version of the image. This is also useful for scaling
2262 bitmaps in general as the only other way to scale bitmaps is to blit a
2263 `wx.MemoryDC` into another `wx.MemoryDC`.
2264 """
d55e5bfc
RD		 2265 return _core_.Image_Scale(*args, **kwargs)
2266
2267 def ShrinkBy(*args, **kwargs):
7a27cf7c
RD		 2268 """
2269 ShrinkBy(self, int xFactor, int yFactor) -> Image
2270
2271 Return a version of the image scaled smaller by the given factors.
2272 """
d55e5bfc
RD		 2273 return _core_.Image_ShrinkBy(*args, **kwargs)
2274
2275 def Rescale(*args, **kwargs):
7a27cf7c
RD		 2276 """
2277 Rescale(self, int width, int height) -> Image
2278
2279 Changes the size of the image in-place by scaling it: after a call to
2280 this function, the image will have the given width and height.
2281
2282 Returns the (modified) image itself.
2283 """
d55e5bfc
RD		 2284 return _core_.Image_Rescale(*args, **kwargs)
2285
aff4cc5c 2286 def Resize(*args, **kwargs):
7a27cf7c
RD		 2287 """
2288 Resize(self, Size size, Point pos, int r=-1, int g=-1, int b=-1) -> Image
2289
2290 Changes the size of the image in-place without scaling it, by adding
2291 either a border with the given colour or cropping as necessary. The
2292 image is pasted into a new image with the given size and background
2293 colour at the position pos relative to the upper left of the new
2294 image. If red = green = blue = -1 then use either the current mask
2295 colour if set or find, use, and set a suitable mask colour for any
2296 newly exposed areas.
2297
2298 Returns the (modified) image itself.
2299 """
aff4cc5c
RD		 2300 return _core_.Image_Resize(*args, **kwargs)
2301
d55e5bfc 2302 def SetRGB(*args, **kwargs):
7a27cf7c
RD		 2303 """
2304 SetRGB(self, int x, int y, byte r, byte g, byte b)
2305
2306 Sets the pixel at the given coordinate. This routine performs
2307 bounds-checks for the coordinate so it can be considered a safe way to
2308 manipulate the data, but in some cases this might be too slow so that
2309 the data will have to be set directly. In that case you will have to
2310 get access to the image data using the `GetData` method.
2311 """
d55e5bfc
RD		 2312 return _core_.Image_SetRGB(*args, **kwargs)
2313
aff4cc5c 2314 def SetRGBRect(*args, **kwargs):
7a27cf7c
RD		 2315 """
2316 SetRGBRect(self, Rect rect, byte r, byte g, byte b)
2317
2318 Sets the colour of the pixels within the given rectangle. This routine
2319 performs bounds-checks for the rectangle so it can be considered a
2320 safe way to manipulate the data.
2321 """
aff4cc5c
RD		 2322 return _core_.Image_SetRGBRect(*args, **kwargs)
2323
d55e5bfc 2324 def GetRed(*args, **kwargs):
7a27cf7c
RD		 2325 """
2326 GetRed(self, int x, int y) -> byte
2327
2328 Returns the red intensity at the given coordinate.
2329 """
d55e5bfc
RD		 2330 return _core_.Image_GetRed(*args, **kwargs)
2331
2332 def GetGreen(*args, **kwargs):
7a27cf7c
RD		 2333 """
2334 GetGreen(self, int x, int y) -> byte
2335
2336 Returns the green intensity at the given coordinate.
2337 """
d55e5bfc
RD		 2338 return _core_.Image_GetGreen(*args, **kwargs)
2339
2340 def GetBlue(*args, **kwargs):
7a27cf7c
RD		 2341 """
2342 GetBlue(self, int x, int y) -> byte
2343
2344 Returns the blue intensity at the given coordinate.
2345 """
d55e5bfc
RD		 2346 return _core_.Image_GetBlue(*args, **kwargs)
2347
2348 def SetAlpha(*args, **kwargs):
7a27cf7c
RD		 2349 """
2350 SetAlpha(self, int x, int y, byte alpha)
2351
2352 Sets the alpha value for the given pixel. This function should only be
2353 called if the image has alpha channel data, use `HasAlpha` to check
2354 for this.
2355 """
d55e5bfc
RD		 2356 return _core_.Image_SetAlpha(*args, **kwargs)
2357
2358 def GetAlpha(*args, **kwargs):
7a27cf7c
RD		 2359 """
2360 GetAlpha(self, int x, int y) -> byte
2361
2362 Returns the alpha value for the given pixel. This function may only be
2363 called for the images with alpha channel, use `HasAlpha` to check for
2364 this.
2365
2366 The returned value is the *opacity* of the image, i.e. the value of 0
2367 corresponds to the fully transparent pixels while the value of 255 to
2368 the fully opaque pixels.
2369 """
d55e5bfc
RD		 2370 return _core_.Image_GetAlpha(*args, **kwargs)
2371
2372 def HasAlpha(*args, **kwargs):
7a27cf7c
RD		 2373 """
2374 HasAlpha(self) -> bool
2375
2376 Returns true if this image has alpha channel, false otherwise.
2377 """
d55e5bfc
RD		 2378 return _core_.Image_HasAlpha(*args, **kwargs)
2379
68350608
RD		 2380 def InitAlpha(*args, **kwargs):
2381 """
2382 InitAlpha(self)
2383
2384 Initializes the image alpha channel data. It is an error to call it if
2385 the image already has alpha data. If it doesn't, alpha data will be by
2386 default initialized to all pixels being fully opaque. But if the image
2387 has a a mask colour, all mask pixels will be completely transparent.
2388 """
2389 return _core_.Image_InitAlpha(*args, **kwargs)
2390
57133d5c
RD		 2391 def IsTransparent(*args, **kwargs):
2392 """
7a27cf7c 2393 IsTransparent(self, int x, int y, byte threshold=IMAGE_ALPHA_THRESHOLD) -> bool
57133d5c 2394
7a27cf7c
RD		 2395 Returns ``True`` if this pixel is masked or has an alpha value less
2396 than the spcified threshold.
57133d5c
RD		 2397 """
2398 return _core_.Image_IsTransparent(*args, **kwargs)
2399
d55e5bfc 2400 def FindFirstUnusedColour(*args, **kwargs):
a8eff060
RD		 2401 """
2402 FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)
2403
2404 Find first colour that is not used in the image and has higher RGB
2405 values than startR, startG, startB. Returns a tuple consisting of a
2406 success flag and rgb values.
2407 """
d55e5bfc
RD		 2408 return _core_.Image_FindFirstUnusedColour(*args, **kwargs)
2409
4cf4100f
RD		 2410 def ConvertAlphaToMask(*args, **kwargs):
2411 """
57133d5c 2412 ConvertAlphaToMask(self, byte threshold=IMAGE_ALPHA_THRESHOLD) -> bool
4cf4100f 2413
7a27cf7c
RD		 2414 If the image has alpha channel, this method converts it to mask. All
2415 pixels with alpha value less than ``threshold`` are replaced with the
2416 mask colour and the alpha channel is removed. The mask colour is
2417 chosen automatically using `FindFirstUnusedColour`.
4cf4100f
RD		 2418
2419 If the image image doesn't have alpha channel, ConvertAlphaToMask does
2420 nothing.
2421 """
2422 return _core_.Image_ConvertAlphaToMask(*args, **kwargs)
2423
8fb0e70a
RD		 2424 def ConvertColourToAlpha(*args, **kwargs):
2425 """
7a27cf7c 2426 ConvertColourToAlpha(self, byte r, byte g, byte b) -> bool
8fb0e70a
RD		 2427
2428 This method converts an image where the original alpha information is
2429 only available as a shades of a colour (actually shades of grey)
2430 typically when you draw anti-aliased text into a bitmap. The DC
2431 drawing routines draw grey values on the black background although
2432 they actually mean to draw white with differnt alpha values. This
2433 method reverses it, assuming a black (!) background and white text.
2434 The method will then fill up the whole image with the colour given.
2435 """
2436 return _core_.Image_ConvertColourToAlpha(*args, **kwargs)
2437
d55e5bfc 2438 def SetMaskFromImage(*args, **kwargs):
7a27cf7c
RD		 2439 """
2440 SetMaskFromImage(self, Image mask, byte mr, byte mg, byte mb) -> bool
2441
2442 Sets the image's mask so that the pixels that have RGB value of
2443 ``(mr,mg,mb)`` in ``mask`` will be masked in this image. This is done
2444 by first finding an unused colour in the image, setting this colour as
2445 the mask colour and then using this colour to draw all pixels in the
2446 image who corresponding pixel in mask has given RGB value.
2447
2448 Returns ``False`` if ``mask`` does not have same dimensions as the
2449 image or if there is no unused colour left. Returns ``True`` if the
2450 mask was successfully applied.
2451
2452 Note that this method involves computing the histogram, which is
2453 computationally intensive operation.
2454 """
d55e5bfc
RD		 2455 return _core_.Image_SetMaskFromImage(*args, **kwargs)
2456
2457 def CanRead(*args, **kwargs):
7a27cf7c
RD		 2458 """
2459 CanRead(String filename) -> bool
2460
2461 Returns True if the image handlers can read this file.
2462 """
d55e5bfc
RD		 2463 return _core_.Image_CanRead(*args, **kwargs)
2464
2465 CanRead = staticmethod(CanRead)
2466 def GetImageCount(*args, **kwargs):
7a27cf7c
RD		 2467 """
2468 GetImageCount(String filename, long type=BITMAP_TYPE_ANY) -> int
2469
2470 If the image file contains more than one image and the image handler
2471 is capable of retrieving these individually, this function will return
2472 the number of available images.
2473 """
d55e5bfc
RD		 2474 return _core_.Image_GetImageCount(*args, **kwargs)
2475
2476 GetImageCount = staticmethod(GetImageCount)
2477 def LoadFile(*args, **kwargs):
7a27cf7c
RD		 2478 """
2479 LoadFile(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> bool
2480
2481 Loads an image from a file. If no handler type is provided, the
2482 library will try to autodetect the format.
2483 """
d55e5bfc
RD		 2484 return _core_.Image_LoadFile(*args, **kwargs)
2485
2486 def LoadMimeFile(*args, **kwargs):
7a27cf7c
RD		 2487 """
2488 LoadMimeFile(self, String name, String mimetype, int index=-1) -> bool
2489
2490 Loads an image from a file, specifying the image type with a MIME type
2491 string.
2492 """
d55e5bfc
RD		 2493 return _core_.Image_LoadMimeFile(*args, **kwargs)
2494
2495 def SaveFile(*args, **kwargs):
7a27cf7c
RD		 2496 """
2497 SaveFile(self, String name, int type) -> bool
2498
2499 Saves an image in the named file.
2500 """
d55e5bfc
RD		 2501 return _core_.Image_SaveFile(*args, **kwargs)
2502
2503 def SaveMimeFile(*args, **kwargs):
7a27cf7c
RD		 2504 """
2505 SaveMimeFile(self, String name, String mimetype) -> bool
2506
2507 Saves an image in the named file.
2508 """
d55e5bfc
RD		 2509 return _core_.Image_SaveMimeFile(*args, **kwargs)
2510
2511 def CanReadStream(*args, **kwargs):
7a27cf7c
RD		 2512 """
2513 CanReadStream(InputStream stream) -> bool
2514
2515 Returns True if the image handlers can read an image file from the
2516 data currently on the input stream, or a readable Python file-like
2517 object.
2518 """
d55e5bfc
RD		 2519 return _core_.Image_CanReadStream(*args, **kwargs)
2520
2521 CanReadStream = staticmethod(CanReadStream)
2522 def LoadStream(*args, **kwargs):
7a27cf7c
RD		 2523 """
2524 LoadStream(self, InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> bool
2525
2526 Loads an image from an input stream or a readable Python file-like
2527 object. If no handler type is provided, the library will try to
2528 autodetect the format.
2529 """
d55e5bfc
RD		 2530 return _core_.Image_LoadStream(*args, **kwargs)
2531
2532 def LoadMimeStream(*args, **kwargs):
7a27cf7c
RD		 2533 """
2534 LoadMimeStream(self, InputStream stream, String mimetype, int index=-1) -> bool
2535
2536 Loads an image from an input stream or a readable Python file-like
2537 object, using a MIME type string to specify the image file format.
2538 """
d55e5bfc
RD		 2539 return _core_.Image_LoadMimeStream(*args, **kwargs)
2540
2541 def Ok(*args, **kwargs):
7a27cf7c
RD		 2542 """
2543 Ok(self) -> bool
2544
2545 Returns true if image data is present.
2546 """
d55e5bfc
RD		 2547 return _core_.Image_Ok(*args, **kwargs)
2548
2549 def GetWidth(*args, **kwargs):
7a27cf7c
RD		 2550 """
2551 GetWidth(self) -> int
2552
2553 Gets the width of the image in pixels.
2554 """
d55e5bfc
RD		 2555 return _core_.Image_GetWidth(*args, **kwargs)
2556
2557 def GetHeight(*args, **kwargs):
7a27cf7c
RD		 2558 """
2559 GetHeight(self) -> int
2560
2561 Gets the height of the image in pixels.
2562 """
d55e5bfc
RD		 2563 return _core_.Image_GetHeight(*args, **kwargs)
2564
2565 def GetSize(*args, **kwargs):
7a27cf7c
RD		 2566 """
2567 GetSize(self) -> Size
2568
2569 Returns the size of the image in pixels.
2570 """
d55e5bfc
RD		 2571 return _core_.Image_GetSize(*args, **kwargs)
2572
2573 def GetSubImage(*args, **kwargs):
7a27cf7c
RD		 2574 """
2575 GetSubImage(self, Rect rect) -> Image
2576
2577 Returns a sub image of the current one as long as the rect belongs
2578 entirely to the image.
2579 """
d55e5bfc
RD		 2580 return _core_.Image_GetSubImage(*args, **kwargs)
2581
aff4cc5c 2582 def Size(*args, **kwargs):
7a27cf7c
RD		 2583 """
2584 Size(self, Size size, Point pos, int r=-1, int g=-1, int b=-1) -> Image
2585
2586 Returns a resized version of this image without scaling it by adding
2587 either a border with the given colour or cropping as necessary. The
2588 image is pasted into a new image with the given size and background
2589 colour at the position ``pos`` relative to the upper left of the new
2590 image. If red = green = blue = -1 then use either the current mask
2591 colour if set or find, use, and set a suitable mask colour for any
2592 newly exposed areas.
2593 """
aff4cc5c
RD		 2594 return _core_.Image_Size(*args, **kwargs)
2595
d55e5bfc 2596 def Copy(*args, **kwargs):
7a27cf7c
RD		 2597 """
2598 Copy(self) -> Image
2599
2600 Returns an identical copy of the image.
2601 """
d55e5bfc
RD		 2602 return _core_.Image_Copy(*args, **kwargs)
2603
2604 def Paste(*args, **kwargs):
7a27cf7c
RD		 2605 """
2606 Paste(self, Image image, int x, int y)
2607
2608 Pastes ``image`` into this instance and takes care of the mask colour
2609 and any out of bounds problems.
2610 """
d55e5bfc
RD		 2611 return _core_.Image_Paste(*args, **kwargs)
2612
2613 def GetData(*args, **kwargs):
ea939623
RD		 2614 """
2615 GetData(self) -> PyObject
2616
2617 Returns a string containing a copy of the RGB bytes of the image.
2618 """
d55e5bfc
RD		 2619 return _core_.Image_GetData(*args, **kwargs)
2620
2621 def SetData(*args, **kwargs):
ea939623
RD		 2622 """
2623 SetData(self, buffer data)
2624
2625 Resets the Image's RGB data from a buffer of RGB bytes. Accepts
2626 either a string or a buffer object holding the data and the length of
2627 the data must be width*height*3.
2628 """
d55e5bfc
RD		 2629 return _core_.Image_SetData(*args, **kwargs)
2630
2631 def GetDataBuffer(*args, **kwargs):
ea939623
RD		 2632 """
2633 GetDataBuffer(self) -> PyObject
2634
2635 Returns a writable Python buffer object that is pointing at the RGB
7a27cf7c
RD		 2636 image data buffer inside the wx.Image. You need to ensure that you do
2637 not use this buffer object after the image has been destroyed.
ea939623 2638 """
d55e5bfc
RD		 2639 return _core_.Image_GetDataBuffer(*args, **kwargs)
2640
2641 def SetDataBuffer(*args, **kwargs):
ea939623
RD		 2642 """
2643 SetDataBuffer(self, buffer data)
2644
2645 Sets the internal image data pointer to point at a Python buffer
7a27cf7c
RD		 2646 object. This can save making an extra copy of the data but you must
2647 ensure that the buffer object lives longer than the wx.Image does.
ea939623 2648 """
d55e5bfc
RD		 2649 return _core_.Image_SetDataBuffer(*args, **kwargs)
2650
2651 def GetAlphaData(*args, **kwargs):
ea939623
RD		 2652 """
2653 GetAlphaData(self) -> PyObject
2654
2655 Returns a string containing a copy of the alpha bytes of the image.
2656 """
d55e5bfc
RD		 2657 return _core_.Image_GetAlphaData(*args, **kwargs)
2658
2659 def SetAlphaData(*args, **kwargs):
ea939623
RD		 2660 """
2661 SetAlphaData(self, buffer alpha)
2662
2663 Resets the Image's alpha data from a buffer of bytes. Accepts either
2664 a string or a buffer object holding the data and the length of the
2665 data must be width*height.
2666 """
d55e5bfc
RD		 2667 return _core_.Image_SetAlphaData(*args, **kwargs)
2668
2669 def GetAlphaBuffer(*args, **kwargs):
2670 """GetAlphaBuffer(self) -> PyObject"""
2671 return _core_.Image_GetAlphaBuffer(*args, **kwargs)
2672
2673 def SetAlphaBuffer(*args, **kwargs):
ea939623 2674 """SetAlphaBuffer(self, buffer alpha)"""
d55e5bfc
RD		 2675 return _core_.Image_SetAlphaBuffer(*args, **kwargs)
2676
2677 def SetMaskColour(*args, **kwargs):
7a27cf7c
RD		 2678 """
2679 SetMaskColour(self, byte r, byte g, byte b)
2680
2681 Sets the mask colour for this image (and tells the image to use the
2682 mask).
2683 """
d55e5bfc
RD		 2684 return _core_.Image_SetMaskColour(*args, **kwargs)
2685
aff4cc5c
RD		 2686 def GetOrFindMaskColour(*args, **kwargs):
2687 """
2688 GetOrFindMaskColour() -> (r,g,b)
2689
2690 Get the current mask colour or find a suitable colour.
2691 """
2692 return _core_.Image_GetOrFindMaskColour(*args, **kwargs)
2693
d55e5bfc 2694 def GetMaskRed(*args, **kwargs):
7a27cf7c
RD		 2695 """
2696 GetMaskRed(self) -> byte
2697
2698 Gets the red component of the mask colour.
2699 """
d55e5bfc
RD		 2700 return _core_.Image_GetMaskRed(*args, **kwargs)
2701
2702 def GetMaskGreen(*args, **kwargs):
7a27cf7c
RD		 2703 """
2704 GetMaskGreen(self) -> byte
2705
2706 Gets the green component of the mask colour.
2707 """
d55e5bfc
RD		 2708 return _core_.Image_GetMaskGreen(*args, **kwargs)
2709
2710 def GetMaskBlue(*args, **kwargs):
7a27cf7c
RD		 2711 """
2712 GetMaskBlue(self) -> byte
2713
2714 Gets the blue component of the mask colour.
2715 """
d55e5bfc
RD		 2716 return _core_.Image_GetMaskBlue(*args, **kwargs)
2717
2718 def SetMask(*args, **kwargs):
7a27cf7c
RD		 2719 """
2720 SetMask(self, bool mask=True)
2721
2722 Specifies whether there is a mask or not. The area of the mask is
2723 determined by the current mask colour.
2724 """
d55e5bfc
RD		 2725 return _core_.Image_SetMask(*args, **kwargs)
2726
2727 def HasMask(*args, **kwargs):
7a27cf7c
RD		 2728 """
2729 HasMask(self) -> bool
2730
2731 Returns ``True`` if there is a mask active, ``False`` otherwise.
2732 """
d55e5bfc
RD		 2733 return _core_.Image_HasMask(*args, **kwargs)
2734
2735 def Rotate(*args, **kwargs):
2736 """
2737 Rotate(self, double angle, Point centre_of_rotation, bool interpolating=True,
2738 Point offset_after_rotation=None) -> Image
7a27cf7c
RD		 2739
2740 Rotates the image about the given point, by ``angle`` radians. Passing
2741 ``True`` to ``interpolating`` results in better image quality, but is
2742 slower. If the image has a mask, then the mask colour is used for the
2743 uncovered pixels in the rotated image background. Otherwise, black
2744 will be used as the fill colour.
2745
2746 Returns the rotated image, leaving this image intact.
d55e5bfc
RD		 2747 """
2748 return _core_.Image_Rotate(*args, **kwargs)
2749
2750 def Rotate90(*args, **kwargs):
7a27cf7c
RD		 2751 """
2752 Rotate90(self, bool clockwise=True) -> Image
2753
2754 Returns a copy of the image rotated 90 degrees in the direction
2755 indicated by ``clockwise``.
2756 """
d55e5bfc
RD		 2757 return _core_.Image_Rotate90(*args, **kwargs)
2758
2759 def Mirror(*args, **kwargs):
7a27cf7c
RD		 2760 """
2761 Mirror(self, bool horizontally=True) -> Image
2762
2763 Returns a mirrored copy of the image. The parameter ``horizontally``
2764 indicates the orientation.
2765 """
d55e5bfc
RD		 2766 return _core_.Image_Mirror(*args, **kwargs)
2767
2768 def Replace(*args, **kwargs):
2769 """
7a27cf7c
RD		 2770 Replace(self, byte r1, byte g1, byte b1, byte r2, byte g2, byte b2)
2771
2772 Replaces the colour specified by ``(r1,g1,b1)`` by the colour
2773 ``(r2,g2,b2)``.
d55e5bfc
RD		 2774 """
2775 return _core_.Image_Replace(*args, **kwargs)
2776
7449af73
RD		 2777 def ConvertToGreyscale(*args, **kwargs):
2778 """
2779 ConvertToGreyscale(self, double lr=0.299, double lg=0.587, double lb=0.114) -> Image
2780
2781 Convert to greyscale image. Uses the luminance component (Y) of the
2782 image. The luma value (YUV) is calculated using (R * lr) + (G * lg) + (B * lb),
2783 defaults to ITU-T BT.601
2784 """
2785 return _core_.Image_ConvertToGreyscale(*args, **kwargs)
2786
d55e5bfc 2787 def ConvertToMono(*args, **kwargs):
7a27cf7c
RD		 2788 """
2789 ConvertToMono(self, byte r, byte g, byte b) -> Image
2790
2791 Returns monochromatic version of the image. The returned image has
2792 white colour where the original has ``(r,g,b)`` colour and black
2793 colour everywhere else.
2794 """
d55e5bfc
RD		 2795 return _core_.Image_ConvertToMono(*args, **kwargs)
2796
2797 def SetOption(*args, **kwargs):
7a27cf7c
RD		 2798 """
2799 SetOption(self, String name, String value)
2800
2801 Sets an image handler defined option. For example, when saving as a
2802 JPEG file, the option ``wx.IMAGE_OPTION_QUALITY`` is used, which is a
2803 number between 0 and 100 (0 is terrible, 100 is very good).
2804 """
d55e5bfc
RD		 2805 return _core_.Image_SetOption(*args, **kwargs)
2806
2807 def SetOptionInt(*args, **kwargs):
7a27cf7c
RD		 2808 """
2809 SetOptionInt(self, String name, int value)
2810
2811 Sets an image option as an integer.
2812 """
d55e5bfc
RD		 2813 return _core_.Image_SetOptionInt(*args, **kwargs)
2814
2815 def GetOption(*args, **kwargs):
7a27cf7c
RD		 2816 """
2817 GetOption(self, String name) -> String
2818
2819 Gets the value of an image handler option.
2820 """
d55e5bfc
RD		 2821 return _core_.Image_GetOption(*args, **kwargs)
2822
2823 def GetOptionInt(*args, **kwargs):
7a27cf7c
RD		 2824 """
2825 GetOptionInt(self, String name) -> int
2826
2827 Gets the value of an image handler option as an integer. If the given
2828 option is not present, the function returns 0.
2829 """
d55e5bfc
RD		 2830 return _core_.Image_GetOptionInt(*args, **kwargs)
2831
2832 def HasOption(*args, **kwargs):
7a27cf7c
RD		 2833 """
2834 HasOption(self, String name) -> bool
2835
2836 Returns true if the given option is present.
2837 """
d55e5bfc
RD		 2838 return _core_.Image_HasOption(*args, **kwargs)
2839
2840 def CountColours(*args, **kwargs):
2841 """CountColours(self, unsigned long stopafter=(unsigned long) -1) -> unsigned long"""
2842 return _core_.Image_CountColours(*args, **kwargs)
2843
2844 def ComputeHistogram(*args, **kwargs):
2845 """ComputeHistogram(self, ImageHistogram h) -> unsigned long"""
2846 return _core_.Image_ComputeHistogram(*args, **kwargs)
2847
2848 def AddHandler(*args, **kwargs):
c24da6d6 2849 """AddHandler(ImageHandler handler)"""
d55e5bfc
RD		 2850 return _core_.Image_AddHandler(*args, **kwargs)
2851
2852 AddHandler = staticmethod(AddHandler)
2853 def InsertHandler(*args, **kwargs):
c24da6d6 2854 """InsertHandler(ImageHandler handler)"""
d55e5bfc
RD		 2855 return _core_.Image_InsertHandler(*args, **kwargs)
2856
2857 InsertHandler = staticmethod(InsertHandler)
2858 def RemoveHandler(*args, **kwargs):
c24da6d6 2859 """RemoveHandler(String name) -> bool"""
d55e5bfc
RD		 2860 return _core_.Image_RemoveHandler(*args, **kwargs)
2861
2862 RemoveHandler = staticmethod(RemoveHandler)
554f62e9
RD		 2863 def GetHandlers(*args, **kwargs):
2864 """GetHandlers() -> PyObject"""
2865 return _core_.Image_GetHandlers(*args, **kwargs)
2866
2867 GetHandlers = staticmethod(GetHandlers)
d55e5bfc 2868 def GetImageExtWildcard(*args, **kwargs):
7a27cf7c
RD		 2869 """
2870 GetImageExtWildcard() -> String
2871
2872 Iterates all registered wxImageHandler objects, and returns a string
2873 containing file extension masks suitable for passing to file open/save
2874 dialog boxes.
2875 """
d55e5bfc
RD		 2876 return _core_.Image_GetImageExtWildcard(*args, **kwargs)
2877
2878 GetImageExtWildcard = staticmethod(GetImageExtWildcard)
2879 def ConvertToBitmap(*args, **kwargs):
1fbf26be 2880 """ConvertToBitmap(self, int depth=-1) -> Bitmap"""
d55e5bfc
RD		 2881 return _core_.Image_ConvertToBitmap(*args, **kwargs)
2882
2883 def ConvertToMonoBitmap(*args, **kwargs):
7a27cf7c 2884 """ConvertToMonoBitmap(self, byte red, byte green, byte blue) -> Bitmap"""
d55e5bfc
RD		 2885 return _core_.Image_ConvertToMonoBitmap(*args, **kwargs)
2886
2f91e3df
KO		 2887 def RotateHue(*args, **kwargs):
2888 """
2889 RotateHue(self, double angle)
2890
2891 Rotates the hue of each pixel of the image. Hue is a double in the
2892 range -1.0..1.0 where -1.0 is -360 degrees and 1.0 is 360 degrees
2893 """
2894 return _core_.Image_RotateHue(*args, **kwargs)
2895
2896 def RGBtoHSV(*args, **kwargs):
9d7dfdff
RD		 2897 """
2898 RGBtoHSV(Image_RGBValue rgb) -> Image_HSVValue
2899
2900 Converts a color in RGB color space to HSV color space.
2901 """
2f91e3df
KO		 2902 return _core_.Image_RGBtoHSV(*args, **kwargs)
2903
2904 RGBtoHSV = staticmethod(RGBtoHSV)
2905 def HSVtoRGB(*args, **kwargs):
9d7dfdff
RD		 2906 """
2907 HSVtoRGB(Image_HSVValue hsv) -> Image_RGBValue
2908
2909 Converts a color in HSV color space to RGB color space.
2910 """
2f91e3df
KO		 2911 return _core_.Image_HSVtoRGB(*args, **kwargs)
2912
2913 HSVtoRGB = staticmethod(HSVtoRGB)
d55e5bfc 2914 def __nonzero__(self): return self.Ok()
554f62e9
RD		 2915Image_swigregister = _core_.Image_swigregister
2916Image_swigregister(Image)
d55e5bfc
RD		 2917
2918def ImageFromMime(*args, **kwargs):
7a27cf7c
RD		 2919 """
2920 ImageFromMime(String name, String mimetype, int index=-1) -> Image
2921
2922 Loads an image from a file, using a MIME type string (such as
2923 'image/jpeg') to specify image type.
2924 """
d55e5bfc 2925 val = _core_.new_ImageFromMime(*args, **kwargs)
d55e5bfc
RD		 2926 return val
2927
2928def ImageFromStream(*args, **kwargs):
7a27cf7c
RD		 2929 """
2930 ImageFromStream(InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> Image
2931
2932 Loads an image from an input stream, or any readable Python file-like
2933 object.
2934 """
d55e5bfc 2935 val = _core_.new_ImageFromStream(*args, **kwargs)
d55e5bfc
RD		 2936 return val
2937
2938def ImageFromStreamMime(*args, **kwargs):
7a27cf7c
RD		 2939 """
2940 ImageFromStreamMime(InputStream stream, String mimetype, int index=-1) -> Image
2941
2942 Loads an image from an input stream, or any readable Python file-like
2943 object, specifying the image format with a MIME type string.
2944 """
d55e5bfc 2945 val = _core_.new_ImageFromStreamMime(*args, **kwargs)
d55e5bfc
RD		 2946 return val
2947
c24da6d6 2948def EmptyImage(*args, **kwargs):
ea939623
RD		 2949 """
2950 EmptyImage(int width=0, int height=0, bool clear=True) -> Image
2951
2952 Construct an empty image of a given size, optionally setting all
2953 pixels to black.
2954 """
c24da6d6 2955 val = _core_.new_EmptyImage(*args, **kwargs)
d55e5bfc
RD		 2956 return val
2957
2958def ImageFromBitmap(*args, **kwargs):
ea939623
RD		 2959 """
2960 ImageFromBitmap(Bitmap bitmap) -> Image
2961
2962 Construct an Image from a `wx.Bitmap`.
2963 """
d55e5bfc 2964 val = _core_.new_ImageFromBitmap(*args, **kwargs)
d55e5bfc
RD		 2965 return val
2966
2967def ImageFromData(*args, **kwargs):
ea939623
RD		 2968 """
2969 ImageFromData(int width, int height, buffer data) -> Image
2970
2971 Construct an Image from a buffer of RGB bytes. Accepts either a
2972 string or a buffer object holding the data and the length of the data
2973 must be width*height*3.
2974 """
d55e5bfc 2975 val = _core_.new_ImageFromData(*args, **kwargs)
d55e5bfc
RD		 2976 return val
2977
c9c2cf70 2978def ImageFromDataWithAlpha(*args, **kwargs):
ea939623
RD		 2979 """
2980 ImageFromDataWithAlpha(int width, int height, buffer data, buffer alpha) -> Image
2981
2982 Construct an Image from a buffer of RGB bytes with an Alpha channel.
2983 Accepts either a string or a buffer object holding the data and the
7a27cf7c
RD		 2984 length of the data must be width*height*3 bytes, and the length of the
2985 alpha data must be width*height bytes.
ea939623 2986 """
c9c2cf70 2987 val = _core_.new_ImageFromDataWithAlpha(*args, **kwargs)
c9c2cf70
RD		 2988 return val
2989
d55e5bfc 2990def Image_CanRead(*args, **kwargs):
554f62e9 2991 """
7a27cf7c
RD		 2992 Image_CanRead(String filename) -> bool
2993
2994 Returns True if the image handlers can read this file.
2995 """
554f62e9 2996 return _core_.Image_CanRead(*args, **kwargs)
d55e5bfc
RD		 2997
2998def Image_GetImageCount(*args, **kwargs):
554f62e9 2999 """
7a27cf7c
RD		 3000 Image_GetImageCount(String filename, long type=BITMAP_TYPE_ANY) -> int
3001
3002 If the image file contains more than one image and the image handler
3003 is capable of retrieving these individually, this function will return
3004 the number of available images.
3005 """
554f62e9 3006 return _core_.Image_GetImageCount(*args, **kwargs)
d55e5bfc
RD		 3007
3008def Image_CanReadStream(*args, **kwargs):
554f62e9 3009 """
7a27cf7c
RD		 3010 Image_CanReadStream(InputStream stream) -> bool
3011
3012 Returns True if the image handlers can read an image file from the
3013 data currently on the input stream, or a readable Python file-like
3014 object.
3015 """
554f62e9 3016 return _core_.Image_CanReadStream(*args, **kwargs)
d55e5bfc
RD		 3017
3018def Image_AddHandler(*args, **kwargs):
554f62e9
RD		 3019 """Image_AddHandler(ImageHandler handler)"""
3020 return _core_.Image_AddHandler(*args, **kwargs)
d55e5bfc
RD		 3021
3022def Image_InsertHandler(*args, **kwargs):
554f62e9
RD		 3023 """Image_InsertHandler(ImageHandler handler)"""
3024 return _core_.Image_InsertHandler(*args, **kwargs)
d55e5bfc
RD		 3025
3026def Image_RemoveHandler(*args, **kwargs):
554f62e9
RD		 3027 """Image_RemoveHandler(String name) -> bool"""
3028 return _core_.Image_RemoveHandler(*args, **kwargs)
d55e5bfc 3029
554f62e9
RD		 3030def Image_GetHandlers(*args):
3031 """Image_GetHandlers() -> PyObject"""
3032 return _core_.Image_GetHandlers(*args)
3033
3034def Image_GetImageExtWildcard(*args):
3035 """
7a27cf7c
RD		 3036 Image_GetImageExtWildcard() -> String
3037
3038 Iterates all registered wxImageHandler objects, and returns a string
3039 containing file extension masks suitable for passing to file open/save
3040 dialog boxes.
3041 """
554f62e9 3042 return _core_.Image_GetImageExtWildcard(*args)
d55e5bfc 3043
2f91e3df 3044def Image_RGBtoHSV(*args, **kwargs):
554f62e9 3045 """
9d7dfdff
RD		 3046 Image_RGBtoHSV(Image_RGBValue rgb) -> Image_HSVValue
3047
3048 Converts a color in RGB color space to HSV color space.
3049 """
554f62e9 3050 return _core_.Image_RGBtoHSV(*args, **kwargs)
2f91e3df
KO		 3051
3052def Image_HSVtoRGB(*args, **kwargs):
554f62e9 3053 """
9d7dfdff
RD		 3054 Image_HSVtoRGB(Image_HSVValue hsv) -> Image_RGBValue
3055
3056 Converts a color in HSV color space to RGB color space.
3057 """
554f62e9 3058 return _core_.Image_HSVtoRGB(*args, **kwargs)
2f91e3df 3059
a07a67e6
RD		 3060def InitAllImageHandlers():
3061 """
3062 The former functionality of InitAllImageHanders is now done internal to
3063 the _core_ extension module and so this function has become a simple NOP.
3064 """
3065 pass
d55e5bfc 3066
d55e5bfc
RD		 3067IMAGE_RESOLUTION_INCHES = _core_.IMAGE_RESOLUTION_INCHES
3068IMAGE_RESOLUTION_CM = _core_.IMAGE_RESOLUTION_CM
b9d6a5f3
RD		 3069PNG_TYPE_COLOUR = _core_.PNG_TYPE_COLOUR
3070PNG_TYPE_GREY = _core_.PNG_TYPE_GREY
3071PNG_TYPE_GREY_RED = _core_.PNG_TYPE_GREY_RED
d55e5bfc
RD		 3072BMP_24BPP = _core_.BMP_24BPP
3073BMP_8BPP = _core_.BMP_8BPP
3074BMP_8BPP_GREY = _core_.BMP_8BPP_GREY
3075BMP_8BPP_GRAY = _core_.BMP_8BPP_GRAY
3076BMP_8BPP_RED = _core_.BMP_8BPP_RED
3077BMP_8BPP_PALETTE = _core_.BMP_8BPP_PALETTE
3078BMP_4BPP = _core_.BMP_4BPP
3079BMP_1BPP = _core_.BMP_1BPP
3080BMP_1BPP_BW = _core_.BMP_1BPP_BW
3081class BMPHandler(ImageHandler):
27fb7603 3082 """A `wx.ImageHandler` for \*.bmp bitmap files."""
554f62e9
RD		 3083 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3084 __repr__ = _swig_repr
3085 def __init__(self, *args, **kwargs):
27fb7603
RD		 3086 """
3087 __init__(self) -> BMPHandler
3088
3089 A `wx.ImageHandler` for \*.bmp bitmap files.
3090 """
554f62e9
RD		 3091 _core_.BMPHandler_swiginit(self,_core_.new_BMPHandler(*args, **kwargs))
3092BMPHandler_swigregister = _core_.BMPHandler_swigregister
3093BMPHandler_swigregister(BMPHandler)
d55e5bfc 3094NullImage = cvar.NullImage
68350608 3095IMAGE_OPTION_FILENAME = cvar.IMAGE_OPTION_FILENAME
d55e5bfc
RD		 3096IMAGE_OPTION_BMP_FORMAT = cvar.IMAGE_OPTION_BMP_FORMAT
3097IMAGE_OPTION_CUR_HOTSPOT_X = cvar.IMAGE_OPTION_CUR_HOTSPOT_X
3098IMAGE_OPTION_CUR_HOTSPOT_Y = cvar.IMAGE_OPTION_CUR_HOTSPOT_Y
3099IMAGE_OPTION_RESOLUTION = cvar.IMAGE_OPTION_RESOLUTION
68350608
RD		 3100IMAGE_OPTION_RESOLUTIONX = cvar.IMAGE_OPTION_RESOLUTIONX
3101IMAGE_OPTION_RESOLUTIONY = cvar.IMAGE_OPTION_RESOLUTIONY
d55e5bfc 3102IMAGE_OPTION_RESOLUTIONUNIT = cvar.IMAGE_OPTION_RESOLUTIONUNIT
24d7cbea 3103IMAGE_OPTION_QUALITY = cvar.IMAGE_OPTION_QUALITY
68350608
RD		 3104IMAGE_OPTION_BITSPERSAMPLE = cvar.IMAGE_OPTION_BITSPERSAMPLE
3105IMAGE_OPTION_SAMPLESPERPIXEL = cvar.IMAGE_OPTION_SAMPLESPERPIXEL
3106IMAGE_OPTION_COMPRESSION = cvar.IMAGE_OPTION_COMPRESSION
3107IMAGE_OPTION_IMAGEDESCRIPTOR = cvar.IMAGE_OPTION_IMAGEDESCRIPTOR
b9d6a5f3
RD		 3108IMAGE_OPTION_PNG_FORMAT = cvar.IMAGE_OPTION_PNG_FORMAT
3109IMAGE_OPTION_PNG_BITDEPTH = cvar.IMAGE_OPTION_PNG_BITDEPTH
d55e5bfc
RD		 3110
3111class ICOHandler(BMPHandler):
27fb7603 3112 """A `wx.ImageHandler` for \*.ico icon files."""
554f62e9
RD		 3113 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3114 __repr__ = _swig_repr
3115 def __init__(self, *args, **kwargs):
27fb7603
RD		 3116 """
3117 __init__(self) -> ICOHandler
3118
3119 A `wx.ImageHandler` for \*.ico icon files.
3120 """
554f62e9
RD		 3121 _core_.ICOHandler_swiginit(self,_core_.new_ICOHandler(*args, **kwargs))
3122ICOHandler_swigregister = _core_.ICOHandler_swigregister
3123ICOHandler_swigregister(ICOHandler)
d55e5bfc
RD		 3124
3125class CURHandler(ICOHandler):
27fb7603 3126 """A `wx.ImageHandler` for \*.cur cursor files."""
554f62e9
RD		 3127 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3128 __repr__ = _swig_repr
3129 def __init__(self, *args, **kwargs):
27fb7603
RD		 3130 """
3131 __init__(self) -> CURHandler
3132
3133 A `wx.ImageHandler` for \*.cur cursor files.
3134 """
554f62e9
RD		 3135 _core_.CURHandler_swiginit(self,_core_.new_CURHandler(*args, **kwargs))
3136CURHandler_swigregister = _core_.CURHandler_swigregister
3137CURHandler_swigregister(CURHandler)
d55e5bfc
RD		 3138
3139class ANIHandler(CURHandler):
27fb7603 3140 """A `wx.ImageHandler` for \*.ani animated cursor files."""
554f62e9
RD		 3141 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3142 __repr__ = _swig_repr
3143 def __init__(self, *args, **kwargs):
27fb7603
RD		 3144 """
3145 __init__(self) -> ANIHandler
3146
3147 A `wx.ImageHandler` for \*.ani animated cursor files.
3148 """
554f62e9
RD		 3149 _core_.ANIHandler_swiginit(self,_core_.new_ANIHandler(*args, **kwargs))
3150ANIHandler_swigregister = _core_.ANIHandler_swigregister
3151ANIHandler_swigregister(ANIHandler)
d55e5bfc
RD		 3152
3153class PNGHandler(ImageHandler):
27fb7603 3154 """A `wx.ImageHandler` for PNG image files."""
554f62e9
RD		 3155 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3156 __repr__ = _swig_repr
3157 def __init__(self, *args, **kwargs):
27fb7603
RD		 3158 """
3159 __init__(self) -> PNGHandler
3160
3161 A `wx.ImageHandler` for PNG image files.
3162 """
554f62e9
RD		 3163 _core_.PNGHandler_swiginit(self,_core_.new_PNGHandler(*args, **kwargs))
3164PNGHandler_swigregister = _core_.PNGHandler_swigregister
3165PNGHandler_swigregister(PNGHandler)
d55e5bfc
RD		 3166
3167class GIFHandler(ImageHandler):
27fb7603 3168 """A `wx.ImageHandler` for GIF image files."""
554f62e9
RD		 3169 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3170 __repr__ = _swig_repr
3171 def __init__(self, *args, **kwargs):
27fb7603
RD		 3172 """
3173 __init__(self) -> GIFHandler
3174
3175 A `wx.ImageHandler` for GIF image files.
3176 """
554f62e9
RD		 3177 _core_.GIFHandler_swiginit(self,_core_.new_GIFHandler(*args, **kwargs))
3178GIFHandler_swigregister = _core_.GIFHandler_swigregister
3179GIFHandler_swigregister(GIFHandler)
d55e5bfc
RD		 3180
3181class PCXHandler(ImageHandler):
27fb7603 3182 """A `wx.ImageHandler` for PCX imager files."""
554f62e9
RD		 3183 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3184 __repr__ = _swig_repr
3185 def __init__(self, *args, **kwargs):
27fb7603
RD		 3186 """
3187 __init__(self) -> PCXHandler
3188
3189 A `wx.ImageHandler` for PCX imager files.
3190 """
554f62e9
RD		 3191 _core_.PCXHandler_swiginit(self,_core_.new_PCXHandler(*args, **kwargs))
3192PCXHandler_swigregister = _core_.PCXHandler_swigregister
3193PCXHandler_swigregister(PCXHandler)
d55e5bfc
RD		 3194
3195class JPEGHandler(ImageHandler):
27fb7603 3196 """A `wx.ImageHandler` for JPEG/JPG image files."""
554f62e9
RD		 3197 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3198 __repr__ = _swig_repr
3199 def __init__(self, *args, **kwargs):
27fb7603
RD		 3200 """
3201 __init__(self) -> JPEGHandler
3202
3203 A `wx.ImageHandler` for JPEG/JPG image files.
3204 """
554f62e9
RD		 3205 _core_.JPEGHandler_swiginit(self,_core_.new_JPEGHandler(*args, **kwargs))
3206JPEGHandler_swigregister = _core_.JPEGHandler_swigregister
3207JPEGHandler_swigregister(JPEGHandler)
d55e5bfc
RD		 3208
3209class PNMHandler(ImageHandler):
27fb7603 3210 """A `wx.ImageHandler` for PNM image files."""
554f62e9
RD		 3211 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3212 __repr__ = _swig_repr
3213 def __init__(self, *args, **kwargs):
27fb7603
RD		 3214 """
3215 __init__(self) -> PNMHandler
3216
3217 A `wx.ImageHandler` for PNM image files.
3218 """
554f62e9
RD		 3219 _core_.PNMHandler_swiginit(self,_core_.new_PNMHandler(*args, **kwargs))
3220PNMHandler_swigregister = _core_.PNMHandler_swigregister
3221PNMHandler_swigregister(PNMHandler)
d55e5bfc
RD		 3222
3223class XPMHandler(ImageHandler):
27fb7603 3224 """A `wx.ImageHandler` for XPM image."""
554f62e9
RD		 3225 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3226 __repr__ = _swig_repr
3227 def __init__(self, *args, **kwargs):
27fb7603
RD		 3228 """
3229 __init__(self) -> XPMHandler
3230
3231 A `wx.ImageHandler` for XPM image.
3232 """
554f62e9
RD		 3233 _core_.XPMHandler_swiginit(self,_core_.new_XPMHandler(*args, **kwargs))
3234XPMHandler_swigregister = _core_.XPMHandler_swigregister
3235XPMHandler_swigregister(XPMHandler)
d55e5bfc
RD		 3236
3237class TIFFHandler(ImageHandler):
27fb7603 3238 """A `wx.ImageHandler` for TIFF image files."""
554f62e9
RD		 3239 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3240 __repr__ = _swig_repr
3241 def __init__(self, *args, **kwargs):
27fb7603
RD		 3242 """
3243 __init__(self) -> TIFFHandler
3244
3245 A `wx.ImageHandler` for TIFF image files.
3246 """
554f62e9
RD		 3247 _core_.TIFFHandler_swiginit(self,_core_.new_TIFFHandler(*args, **kwargs))
3248TIFFHandler_swigregister = _core_.TIFFHandler_swigregister
3249TIFFHandler_swigregister(TIFFHandler)
d55e5bfc 3250
c0de73ae
RD		 3251QUANTIZE_INCLUDE_WINDOWS_COLOURS = _core_.QUANTIZE_INCLUDE_WINDOWS_COLOURS
3252QUANTIZE_FILL_DESTINATION_IMAGE = _core_.QUANTIZE_FILL_DESTINATION_IMAGE
3253class Quantize(object):
3254 """Performs quantization, or colour reduction, on a wxImage."""
554f62e9
RD		 3255 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3256 def __init__(self): raise AttributeError, "No constructor defined"
3257 __repr__ = _swig_repr
c0de73ae
RD		 3258 def Quantize(*args, **kwargs):
3259 """
3260 Quantize(Image src, Image dest, int desiredNoColours=236, int flags=wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE) -> bool
3261
3262 Reduce the colours in the source image and put the result into the
3263 destination image, setting the palette in the destination if
3264 needed. Both images may be the same, to overwrite the source image.
3265 """
3266 return _core_.Quantize_Quantize(*args, **kwargs)
3267
3268 Quantize = staticmethod(Quantize)
554f62e9
RD		 3269Quantize_swigregister = _core_.Quantize_swigregister
3270Quantize_swigregister(Quantize)
c0de73ae
RD		 3271
3272def Quantize_Quantize(*args, **kwargs):
554f62e9 3273 """
c0de73ae
RD		 3274 Quantize_Quantize(Image src, Image dest, int desiredNoColours=236, int flags=wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE) -> bool
3275
3276 Reduce the colours in the source image and put the result into the
3277 destination image, setting the palette in the destination if
3278 needed. Both images may be the same, to overwrite the source image.
3279 """
554f62e9 3280 return _core_.Quantize_Quantize(*args, **kwargs)
c0de73ae 3281
d55e5bfc
RD		 3282#---------------------------------------------------------------------------
3283
3284class EvtHandler(Object):
093d3ff1 3285 """Proxy of C++ EvtHandler class"""
554f62e9
RD		 3286 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3287 __repr__ = _swig_repr
3288 def __init__(self, *args, **kwargs):
d55e5bfc 3289 """__init__(self) -> EvtHandler"""
554f62e9 3290 _core_.EvtHandler_swiginit(self,_core_.new_EvtHandler(*args, **kwargs))
d55e5bfc
RD		 3291 def GetNextHandler(*args, **kwargs):
3292 """GetNextHandler(self) -> EvtHandler"""
3293 return _core_.EvtHandler_GetNextHandler(*args, **kwargs)
3294
3295 def GetPreviousHandler(*args, **kwargs):
3296 """GetPreviousHandler(self) -> EvtHandler"""
3297 return _core_.EvtHandler_GetPreviousHandler(*args, **kwargs)
3298
3299 def SetNextHandler(*args, **kwargs):
3300 """SetNextHandler(self, EvtHandler handler)"""
3301 return _core_.EvtHandler_SetNextHandler(*args, **kwargs)
3302
3303 def SetPreviousHandler(*args, **kwargs):
3304 """SetPreviousHandler(self, EvtHandler handler)"""
3305 return _core_.EvtHandler_SetPreviousHandler(*args, **kwargs)
3306
3307 def GetEvtHandlerEnabled(*args, **kwargs):
3308 """GetEvtHandlerEnabled(self) -> bool"""
3309 return _core_.EvtHandler_GetEvtHandlerEnabled(*args, **kwargs)
3310
3311 def SetEvtHandlerEnabled(*args, **kwargs):
3312 """SetEvtHandlerEnabled(self, bool enabled)"""
3313 return _core_.EvtHandler_SetEvtHandlerEnabled(*args, **kwargs)
3314
3315 def ProcessEvent(*args, **kwargs):
3316 """ProcessEvent(self, Event event) -> bool"""
3317 return _core_.EvtHandler_ProcessEvent(*args, **kwargs)
3318
3319 def AddPendingEvent(*args, **kwargs):
3320 """AddPendingEvent(self, Event event)"""
3321 return _core_.EvtHandler_AddPendingEvent(*args, **kwargs)
3322
3323 def ProcessPendingEvents(*args, **kwargs):
3324 """ProcessPendingEvents(self)"""
3325 return _core_.EvtHandler_ProcessPendingEvents(*args, **kwargs)
3326
3327 def Connect(*args, **kwargs):
3328 """Connect(self, int id, int lastId, int eventType, PyObject func)"""
3329 return _core_.EvtHandler_Connect(*args, **kwargs)
3330
3331 def Disconnect(*args, **kwargs):
3332 """Disconnect(self, int id, int lastId=-1, wxEventType eventType=wxEVT_NULL) -> bool"""
3333 return _core_.EvtHandler_Disconnect(*args, **kwargs)
3334
3335 def _setOORInfo(*args, **kwargs):
093d3ff1 3336 """_setOORInfo(self, PyObject _self, bool incref=True)"""
7e08d4ef
RD		 3337 val = _core_.EvtHandler__setOORInfo(*args, **kwargs)
3338 args[0].thisown = 0
3339 return val
d55e5bfc
RD		 3340
3341 def Bind(self, event, handler, source=None, id=wx.ID_ANY, id2=wx.ID_ANY):
3342 """
3343 Bind an event to an event handler.
3344
caef1a4d
RD		 3345 :param event: One of the EVT_* objects that specifies the
3346 type of event to bind,
d55e5bfc 3347
caef1a4d
RD		 3348 :param handler: A callable object to be invoked when the
3349 event is delivered to self. Pass None to
3350 disconnect an event handler.
d55e5bfc 3351
caef1a4d
RD		 3352 :param source: Sometimes the event originates from a
3353 different window than self, but you still
3354 want to catch it in self. (For example, a
3355 button event delivered to a frame.) By
3356 passing the source of the event, the event
3357 handling system is able to differentiate
3358 between the same event type from different
3359 controls.
d55e5bfc 3360
caef1a4d
RD		 3361 :param id: Used to spcify the event source by ID instead
3362 of instance.
3363
3364 :param id2: Used when it is desirable to bind a handler
3365 to a range of IDs, such as with EVT_MENU_RANGE.
d55e5bfc
RD		 3366 """
3367 if source is not None:
3368 id = source.GetId()
3369 event.Bind(self, id, id2, handler)
3370
c24da6d6
RD		 3371 def Unbind(self, event, source=None, id=wx.ID_ANY, id2=wx.ID_ANY):
3372 """
3373 Disconencts the event handler binding for event from self.
3374 Returns True if successful.
3375 """
3376 if source is not None:
3377 id = source.GetId()
3378 return event.Unbind(self, id, id2)
d55e5bfc 3379
554f62e9
RD		 3380EvtHandler_swigregister = _core_.EvtHandler_swigregister
3381EvtHandler_swigregister(EvtHandler)
d55e5bfc
RD		 3382
3383#---------------------------------------------------------------------------
3384
3385class PyEventBinder(object):
3386 """
3387 Instances of this class are used to bind specific events to event
3388 handlers.
3389 """
3390 def __init__(self, evtType, expectedIDs=0):
3391 if expectedIDs not in [0, 1, 2]:
3392 raise ValueError, "Invalid number of expectedIDs"
3393 self.expectedIDs = expectedIDs
3394
3395 if type(evtType) == list or type(evtType) == tuple:
3396 self.evtType = evtType
3397 else:
3398 self.evtType = [evtType]
3399
3400
3401 def Bind(self, target, id1, id2, function):
3402 """Bind this set of event types to target."""
3403 for et in self.evtType:
3404 target.Connect(id1, id2, et, function)
3405
c24da6d6
RD		 3406
3407 def Unbind(self, target, id1, id2):
3408 """Remove an event binding."""
3409 success = 0
3410 for et in self.evtType:
3411 success += target.Disconnect(id1, id2, et)
3412 return success != 0
3413
d55e5bfc
RD		 3414
3415 def __call__(self, *args):
3416 """
3417 For backwards compatibility with the old EVT_* functions.
3418 Should be called with either (window, func), (window, ID,
3419 func) or (window, ID1, ID2, func) parameters depending on the
3420 type of the event.
3421 """
3422 assert len(args) == 2 + self.expectedIDs
3423 id1 = wx.ID_ANY
3424 id2 = wx.ID_ANY
3425 target = args[0]
3426 if self.expectedIDs == 0:
3427 func = args[1]
3428 elif self.expectedIDs == 1:
3429 id1 = args[1]
3430 func = args[2]
3431 elif self.expectedIDs == 2:
3432 id1 = args[1]
3433 id2 = args[2]
3434 func = args[3]
3435 else:
3436 raise ValueError, "Unexpected number of IDs"
3437
3438 self.Bind(target, id1, id2, func)
3439
3440
3441# These two are square pegs that don't fit the PyEventBinder hole...
3442def EVT_COMMAND(win, id, cmd, func):
3443 win.Connect(id, -1, cmd, func)
3444def EVT_COMMAND_RANGE(win, id1, id2, cmd, func):
3445 win.Connect(id1, id2, cmd, func)
3446
3447
3448#---------------------------------------------------------------------------
3449
3450#---------------------------------------------------------------------------
3451
3452EVENT_PROPAGATE_NONE = _core_.EVENT_PROPAGATE_NONE
3453EVENT_PROPAGATE_MAX = _core_.EVENT_PROPAGATE_MAX
3454
554f62e9
RD		 3455def NewEventType(*args):
3456 """NewEventType() -> wxEventType"""
3457 return _core_.NewEventType(*args)
d55e5bfc
RD		 3458wxEVT_NULL = _core_.wxEVT_NULL
3459wxEVT_FIRST = _core_.wxEVT_FIRST
3460wxEVT_USER_FIRST = _core_.wxEVT_USER_FIRST
3461wxEVT_COMMAND_BUTTON_CLICKED = _core_.wxEVT_COMMAND_BUTTON_CLICKED
3462wxEVT_COMMAND_CHECKBOX_CLICKED = _core_.wxEVT_COMMAND_CHECKBOX_CLICKED
3463wxEVT_COMMAND_CHOICE_SELECTED = _core_.wxEVT_COMMAND_CHOICE_SELECTED
3464wxEVT_COMMAND_LISTBOX_SELECTED = _core_.wxEVT_COMMAND_LISTBOX_SELECTED
3465wxEVT_COMMAND_LISTBOX_DOUBLECLICKED = _core_.wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
3466wxEVT_COMMAND_CHECKLISTBOX_TOGGLED = _core_.wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
3467wxEVT_COMMAND_MENU_SELECTED = _core_.wxEVT_COMMAND_MENU_SELECTED
3468wxEVT_COMMAND_TOOL_CLICKED = _core_.wxEVT_COMMAND_TOOL_CLICKED
3469wxEVT_COMMAND_SLIDER_UPDATED = _core_.wxEVT_COMMAND_SLIDER_UPDATED
3470wxEVT_COMMAND_RADIOBOX_SELECTED = _core_.wxEVT_COMMAND_RADIOBOX_SELECTED
3471wxEVT_COMMAND_RADIOBUTTON_SELECTED = _core_.wxEVT_COMMAND_RADIOBUTTON_SELECTED
3472wxEVT_COMMAND_SCROLLBAR_UPDATED = _core_.wxEVT_COMMAND_SCROLLBAR_UPDATED
3473wxEVT_COMMAND_VLBOX_SELECTED = _core_.wxEVT_COMMAND_VLBOX_SELECTED
3474wxEVT_COMMAND_COMBOBOX_SELECTED = _core_.wxEVT_COMMAND_COMBOBOX_SELECTED
3475wxEVT_COMMAND_TOOL_RCLICKED = _core_.wxEVT_COMMAND_TOOL_RCLICKED
3476wxEVT_COMMAND_TOOL_ENTER = _core_.wxEVT_COMMAND_TOOL_ENTER
3477wxEVT_LEFT_DOWN = _core_.wxEVT_LEFT_DOWN
3478wxEVT_LEFT_UP = _core_.wxEVT_LEFT_UP
3479wxEVT_MIDDLE_DOWN = _core_.wxEVT_MIDDLE_DOWN
3480wxEVT_MIDDLE_UP = _core_.wxEVT_MIDDLE_UP
3481wxEVT_RIGHT_DOWN = _core_.wxEVT_RIGHT_DOWN
3482wxEVT_RIGHT_UP = _core_.wxEVT_RIGHT_UP
3483wxEVT_MOTION = _core_.wxEVT_MOTION
3484wxEVT_ENTER_WINDOW = _core_.wxEVT_ENTER_WINDOW
3485wxEVT_LEAVE_WINDOW = _core_.wxEVT_LEAVE_WINDOW
3486wxEVT_LEFT_DCLICK = _core_.wxEVT_LEFT_DCLICK
3487wxEVT_MIDDLE_DCLICK = _core_.wxEVT_MIDDLE_DCLICK
3488wxEVT_RIGHT_DCLICK = _core_.wxEVT_RIGHT_DCLICK
3489wxEVT_SET_FOCUS = _core_.wxEVT_SET_FOCUS
3490wxEVT_KILL_FOCUS = _core_.wxEVT_KILL_FOCUS
3491wxEVT_CHILD_FOCUS = _core_.wxEVT_CHILD_FOCUS
3492wxEVT_MOUSEWHEEL = _core_.wxEVT_MOUSEWHEEL
3493wxEVT_NC_LEFT_DOWN = _core_.wxEVT_NC_LEFT_DOWN
3494wxEVT_NC_LEFT_UP = _core_.wxEVT_NC_LEFT_UP
3495wxEVT_NC_MIDDLE_DOWN = _core_.wxEVT_NC_MIDDLE_DOWN
3496wxEVT_NC_MIDDLE_UP = _core_.wxEVT_NC_MIDDLE_UP
3497wxEVT_NC_RIGHT_DOWN = _core_.wxEVT_NC_RIGHT_DOWN
3498wxEVT_NC_RIGHT_UP = _core_.wxEVT_NC_RIGHT_UP
3499wxEVT_NC_MOTION = _core_.wxEVT_NC_MOTION
3500wxEVT_NC_ENTER_WINDOW = _core_.wxEVT_NC_ENTER_WINDOW
3501wxEVT_NC_LEAVE_WINDOW = _core_.wxEVT_NC_LEAVE_WINDOW
3502wxEVT_NC_LEFT_DCLICK = _core_.wxEVT_NC_LEFT_DCLICK
3503wxEVT_NC_MIDDLE_DCLICK = _core_.wxEVT_NC_MIDDLE_DCLICK
3504wxEVT_NC_RIGHT_DCLICK = _core_.wxEVT_NC_RIGHT_DCLICK
3505wxEVT_CHAR = _core_.wxEVT_CHAR
3506wxEVT_CHAR_HOOK = _core_.wxEVT_CHAR_HOOK
3507wxEVT_NAVIGATION_KEY = _core_.wxEVT_NAVIGATION_KEY
3508wxEVT_KEY_DOWN = _core_.wxEVT_KEY_DOWN
3509wxEVT_KEY_UP = _core_.wxEVT_KEY_UP
3510wxEVT_HOTKEY = _core_.wxEVT_HOTKEY
3511wxEVT_SET_CURSOR = _core_.wxEVT_SET_CURSOR
3512wxEVT_SCROLL_TOP = _core_.wxEVT_SCROLL_TOP
3513wxEVT_SCROLL_BOTTOM = _core_.wxEVT_SCROLL_BOTTOM
3514wxEVT_SCROLL_LINEUP = _core_.wxEVT_SCROLL_LINEUP
3515wxEVT_SCROLL_LINEDOWN = _core_.wxEVT_SCROLL_LINEDOWN
3516wxEVT_SCROLL_PAGEUP = _core_.wxEVT_SCROLL_PAGEUP
3517wxEVT_SCROLL_PAGEDOWN = _core_.wxEVT_SCROLL_PAGEDOWN
3518wxEVT_SCROLL_THUMBTRACK = _core_.wxEVT_SCROLL_THUMBTRACK
3519wxEVT_SCROLL_THUMBRELEASE = _core_.wxEVT_SCROLL_THUMBRELEASE
db67f999
RD		 3520wxEVT_SCROLL_CHANGED = _core_.wxEVT_SCROLL_CHANGED
3521wxEVT_SCROLL_ENDSCROLL = wxEVT_SCROLL_CHANGED
d55e5bfc
RD		 3522wxEVT_SCROLLWIN_TOP = _core_.wxEVT_SCROLLWIN_TOP
3523wxEVT_SCROLLWIN_BOTTOM = _core_.wxEVT_SCROLLWIN_BOTTOM
3524wxEVT_SCROLLWIN_LINEUP = _core_.wxEVT_SCROLLWIN_LINEUP
3525wxEVT_SCROLLWIN_LINEDOWN = _core_.wxEVT_SCROLLWIN_LINEDOWN
3526wxEVT_SCROLLWIN_PAGEUP = _core_.wxEVT_SCROLLWIN_PAGEUP
3527wxEVT_SCROLLWIN_PAGEDOWN = _core_.wxEVT_SCROLLWIN_PAGEDOWN
3528wxEVT_SCROLLWIN_THUMBTRACK = _core_.wxEVT_SCROLLWIN_THUMBTRACK
3529wxEVT_SCROLLWIN_THUMBRELEASE = _core_.wxEVT_SCROLLWIN_THUMBRELEASE
3530wxEVT_SIZE = _core_.wxEVT_SIZE
3531wxEVT_MOVE = _core_.wxEVT_MOVE
3532wxEVT_CLOSE_WINDOW = _core_.wxEVT_CLOSE_WINDOW
3533wxEVT_END_SESSION = _core_.wxEVT_END_SESSION
3534wxEVT_QUERY_END_SESSION = _core_.wxEVT_QUERY_END_SESSION
3535wxEVT_ACTIVATE_APP = _core_.wxEVT_ACTIVATE_APP
3536wxEVT_POWER = _core_.wxEVT_POWER
3537wxEVT_ACTIVATE = _core_.wxEVT_ACTIVATE
3538wxEVT_CREATE = _core_.wxEVT_CREATE
3539wxEVT_DESTROY = _core_.wxEVT_DESTROY
3540wxEVT_SHOW = _core_.wxEVT_SHOW
3541wxEVT_ICONIZE = _core_.wxEVT_ICONIZE
3542wxEVT_MAXIMIZE = _core_.wxEVT_MAXIMIZE
3543wxEVT_MOUSE_CAPTURE_CHANGED = _core_.wxEVT_MOUSE_CAPTURE_CHANGED
3544wxEVT_PAINT = _core_.wxEVT_PAINT
3545wxEVT_ERASE_BACKGROUND = _core_.wxEVT_ERASE_BACKGROUND
3546wxEVT_NC_PAINT = _core_.wxEVT_NC_PAINT
3547wxEVT_PAINT_ICON = _core_.wxEVT_PAINT_ICON
3548wxEVT_MENU_OPEN = _core_.wxEVT_MENU_OPEN
3549wxEVT_MENU_CLOSE = _core_.wxEVT_MENU_CLOSE
3550wxEVT_MENU_HIGHLIGHT = _core_.wxEVT_MENU_HIGHLIGHT
3551wxEVT_CONTEXT_MENU = _core_.wxEVT_CONTEXT_MENU
3552wxEVT_SYS_COLOUR_CHANGED = _core_.wxEVT_SYS_COLOUR_CHANGED
3553wxEVT_DISPLAY_CHANGED = _core_.wxEVT_DISPLAY_CHANGED
3554wxEVT_SETTING_CHANGED = _core_.wxEVT_SETTING_CHANGED
3555wxEVT_QUERY_NEW_PALETTE = _core_.wxEVT_QUERY_NEW_PALETTE
3556wxEVT_PALETTE_CHANGED = _core_.wxEVT_PALETTE_CHANGED
3557wxEVT_DROP_FILES = _core_.wxEVT_DROP_FILES
3558wxEVT_DRAW_ITEM = _core_.wxEVT_DRAW_ITEM
3559wxEVT_MEASURE_ITEM = _core_.wxEVT_MEASURE_ITEM
3560wxEVT_COMPARE_ITEM = _core_.wxEVT_COMPARE_ITEM
3561wxEVT_INIT_DIALOG = _core_.wxEVT_INIT_DIALOG
3562wxEVT_IDLE = _core_.wxEVT_IDLE
3563wxEVT_UPDATE_UI = _core_.wxEVT_UPDATE_UI
3564wxEVT_SIZING = _core_.wxEVT_SIZING
3565wxEVT_MOVING = _core_.wxEVT_MOVING
88c6b281 3566wxEVT_HIBERNATE = _core_.wxEVT_HIBERNATE
d55e5bfc
RD		 3567wxEVT_COMMAND_LEFT_CLICK = _core_.wxEVT_COMMAND_LEFT_CLICK
3568wxEVT_COMMAND_LEFT_DCLICK = _core_.wxEVT_COMMAND_LEFT_DCLICK
3569wxEVT_COMMAND_RIGHT_CLICK = _core_.wxEVT_COMMAND_RIGHT_CLICK
3570wxEVT_COMMAND_RIGHT_DCLICK = _core_.wxEVT_COMMAND_RIGHT_DCLICK
3571wxEVT_COMMAND_SET_FOCUS = _core_.wxEVT_COMMAND_SET_FOCUS
3572wxEVT_COMMAND_KILL_FOCUS = _core_.wxEVT_COMMAND_KILL_FOCUS
3573wxEVT_COMMAND_ENTER = _core_.wxEVT_COMMAND_ENTER
3574#
3575# Create some event binders
3576EVT_SIZE = wx.PyEventBinder( wxEVT_SIZE )
3577EVT_SIZING = wx.PyEventBinder( wxEVT_SIZING )
3578EVT_MOVE = wx.PyEventBinder( wxEVT_MOVE )
3579EVT_MOVING = wx.PyEventBinder( wxEVT_MOVING )
3580EVT_CLOSE = wx.PyEventBinder( wxEVT_CLOSE_WINDOW )
3581EVT_END_SESSION = wx.PyEventBinder( wxEVT_END_SESSION )
3582EVT_QUERY_END_SESSION = wx.PyEventBinder( wxEVT_QUERY_END_SESSION )
3583EVT_PAINT = wx.PyEventBinder( wxEVT_PAINT )
3584EVT_NC_PAINT = wx.PyEventBinder( wxEVT_NC_PAINT )
3585EVT_ERASE_BACKGROUND = wx.PyEventBinder( wxEVT_ERASE_BACKGROUND )
3586EVT_CHAR = wx.PyEventBinder( wxEVT_CHAR )
3587EVT_KEY_DOWN = wx.PyEventBinder( wxEVT_KEY_DOWN )
3588EVT_KEY_UP = wx.PyEventBinder( wxEVT_KEY_UP )
3589EVT_HOTKEY = wx.PyEventBinder( wxEVT_HOTKEY, 1)
3590EVT_CHAR_HOOK = wx.PyEventBinder( wxEVT_CHAR_HOOK )
3591EVT_MENU_OPEN = wx.PyEventBinder( wxEVT_MENU_OPEN )
3592EVT_MENU_CLOSE = wx.PyEventBinder( wxEVT_MENU_CLOSE )
3593EVT_MENU_HIGHLIGHT = wx.PyEventBinder( wxEVT_MENU_HIGHLIGHT, 1)
3594EVT_MENU_HIGHLIGHT_ALL = wx.PyEventBinder( wxEVT_MENU_HIGHLIGHT )
3595EVT_SET_FOCUS = wx.PyEventBinder( wxEVT_SET_FOCUS )
3596EVT_KILL_FOCUS = wx.PyEventBinder( wxEVT_KILL_FOCUS )
3597EVT_CHILD_FOCUS = wx.PyEventBinder( wxEVT_CHILD_FOCUS )
3598EVT_ACTIVATE = wx.PyEventBinder( wxEVT_ACTIVATE )
3599EVT_ACTIVATE_APP = wx.PyEventBinder( wxEVT_ACTIVATE_APP )
88c6b281 3600EVT_HIBERNATE = wx.PyEventBinder( wxEVT_HIBERNATE )
d55e5bfc
RD		 3601EVT_END_SESSION = wx.PyEventBinder( wxEVT_END_SESSION )
3602EVT_QUERY_END_SESSION = wx.PyEventBinder( wxEVT_QUERY_END_SESSION )
3603EVT_DROP_FILES = wx.PyEventBinder( wxEVT_DROP_FILES )
3604EVT_INIT_DIALOG = wx.PyEventBinder( wxEVT_INIT_DIALOG )
3605EVT_SYS_COLOUR_CHANGED = wx.PyEventBinder( wxEVT_SYS_COLOUR_CHANGED )
3606EVT_DISPLAY_CHANGED = wx.PyEventBinder( wxEVT_DISPLAY_CHANGED )
3607EVT_SHOW = wx.PyEventBinder( wxEVT_SHOW )
3608EVT_MAXIMIZE = wx.PyEventBinder( wxEVT_MAXIMIZE )
3609EVT_ICONIZE = wx.PyEventBinder( wxEVT_ICONIZE )
3610EVT_NAVIGATION_KEY = wx.PyEventBinder( wxEVT_NAVIGATION_KEY )
3611EVT_PALETTE_CHANGED = wx.PyEventBinder( wxEVT_PALETTE_CHANGED )
3612EVT_QUERY_NEW_PALETTE = wx.PyEventBinder( wxEVT_QUERY_NEW_PALETTE )
3613EVT_WINDOW_CREATE = wx.PyEventBinder( wxEVT_CREATE )
3614EVT_WINDOW_DESTROY = wx.PyEventBinder( wxEVT_DESTROY )
3615EVT_SET_CURSOR = wx.PyEventBinder( wxEVT_SET_CURSOR )
3616EVT_MOUSE_CAPTURE_CHANGED = wx.PyEventBinder( wxEVT_MOUSE_CAPTURE_CHANGED )
3617
3618EVT_LEFT_DOWN = wx.PyEventBinder( wxEVT_LEFT_DOWN )
3619EVT_LEFT_UP = wx.PyEventBinder( wxEVT_LEFT_UP )
3620EVT_MIDDLE_DOWN = wx.PyEventBinder( wxEVT_MIDDLE_DOWN )
3621EVT_MIDDLE_UP = wx.PyEventBinder( wxEVT_MIDDLE_UP )
3622EVT_RIGHT_DOWN = wx.PyEventBinder( wxEVT_RIGHT_DOWN )
3623EVT_RIGHT_UP = wx.PyEventBinder( wxEVT_RIGHT_UP )
3624EVT_MOTION = wx.PyEventBinder( wxEVT_MOTION )
3625EVT_LEFT_DCLICK = wx.PyEventBinder( wxEVT_LEFT_DCLICK )
3626EVT_MIDDLE_DCLICK = wx.PyEventBinder( wxEVT_MIDDLE_DCLICK )
3627EVT_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_RIGHT_DCLICK )
3628EVT_LEAVE_WINDOW = wx.PyEventBinder( wxEVT_LEAVE_WINDOW )
3629EVT_ENTER_WINDOW = wx.PyEventBinder( wxEVT_ENTER_WINDOW )
3630EVT_MOUSEWHEEL = wx.PyEventBinder( wxEVT_MOUSEWHEEL )
3631
3632EVT_MOUSE_EVENTS = wx.PyEventBinder([ wxEVT_LEFT_DOWN,
3633 wxEVT_LEFT_UP,
3634 wxEVT_MIDDLE_DOWN,
3635 wxEVT_MIDDLE_UP,
3636 wxEVT_RIGHT_DOWN,
3637 wxEVT_RIGHT_UP,
3638 wxEVT_MOTION,
3639 wxEVT_LEFT_DCLICK,
3640 wxEVT_MIDDLE_DCLICK,
3641 wxEVT_RIGHT_DCLICK,
3642 wxEVT_ENTER_WINDOW,
3643 wxEVT_LEAVE_WINDOW,
3644 wxEVT_MOUSEWHEEL
3645 ])
3646
3647
3648# Scrolling from wxWindow (sent to wxScrolledWindow)
3649EVT_SCROLLWIN = wx.PyEventBinder([ wxEVT_SCROLLWIN_TOP,
3650 wxEVT_SCROLLWIN_BOTTOM,
3651 wxEVT_SCROLLWIN_LINEUP,
3652 wxEVT_SCROLLWIN_LINEDOWN,
3653 wxEVT_SCROLLWIN_PAGEUP,
3654 wxEVT_SCROLLWIN_PAGEDOWN,
3655 wxEVT_SCROLLWIN_THUMBTRACK,
3656 wxEVT_SCROLLWIN_THUMBRELEASE,
3657 ])
3658
3659EVT_SCROLLWIN_TOP = wx.PyEventBinder( wxEVT_SCROLLWIN_TOP )
3660EVT_SCROLLWIN_BOTTOM = wx.PyEventBinder( wxEVT_SCROLLWIN_BOTTOM )
3661EVT_SCROLLWIN_LINEUP = wx.PyEventBinder( wxEVT_SCROLLWIN_LINEUP )
3662EVT_SCROLLWIN_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLLWIN_LINEDOWN )
3663EVT_SCROLLWIN_PAGEUP = wx.PyEventBinder( wxEVT_SCROLLWIN_PAGEUP )
3664EVT_SCROLLWIN_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLLWIN_PAGEDOWN )
3665EVT_SCROLLWIN_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLLWIN_THUMBTRACK )
3666EVT_SCROLLWIN_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLLWIN_THUMBRELEASE )
3667
27fb7603 3668# Scrolling from wx.Slider and wx.ScrollBar
d55e5bfc
RD		 3669EVT_SCROLL = wx.PyEventBinder([ wxEVT_SCROLL_TOP,
3670 wxEVT_SCROLL_BOTTOM,
3671 wxEVT_SCROLL_LINEUP,
3672 wxEVT_SCROLL_LINEDOWN,
3673 wxEVT_SCROLL_PAGEUP,
3674 wxEVT_SCROLL_PAGEDOWN,
3675 wxEVT_SCROLL_THUMBTRACK,
3676 wxEVT_SCROLL_THUMBRELEASE,
db67f999 3677 wxEVT_SCROLL_CHANGED,
d55e5bfc
RD		 3678 ])
3679
3680EVT_SCROLL_TOP = wx.PyEventBinder( wxEVT_SCROLL_TOP )
3681EVT_SCROLL_BOTTOM = wx.PyEventBinder( wxEVT_SCROLL_BOTTOM )
3682EVT_SCROLL_LINEUP = wx.PyEventBinder( wxEVT_SCROLL_LINEUP )
3683EVT_SCROLL_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLL_LINEDOWN )
3684EVT_SCROLL_PAGEUP = wx.PyEventBinder( wxEVT_SCROLL_PAGEUP )
3685EVT_SCROLL_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLL_PAGEDOWN )
3686EVT_SCROLL_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLL_THUMBTRACK )
3687EVT_SCROLL_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE )
db67f999
RD		 3688EVT_SCROLL_CHANGED = wx.PyEventBinder( wxEVT_SCROLL_CHANGED )
3689EVT_SCROLL_ENDSCROLL = EVT_SCROLL_CHANGED
3690
27fb7603 3691# Scrolling from wx.Slider and wx.ScrollBar, with an id
d55e5bfc
RD		 3692EVT_COMMAND_SCROLL = wx.PyEventBinder([ wxEVT_SCROLL_TOP,
3693 wxEVT_SCROLL_BOTTOM,
3694 wxEVT_SCROLL_LINEUP,
3695 wxEVT_SCROLL_LINEDOWN,
3696 wxEVT_SCROLL_PAGEUP,
3697 wxEVT_SCROLL_PAGEDOWN,
3698 wxEVT_SCROLL_THUMBTRACK,
3699 wxEVT_SCROLL_THUMBRELEASE,
db67f999 3700 wxEVT_SCROLL_CHANGED,
d55e5bfc
RD		 3701 ], 1)
3702
3703EVT_COMMAND_SCROLL_TOP = wx.PyEventBinder( wxEVT_SCROLL_TOP, 1)
3704EVT_COMMAND_SCROLL_BOTTOM = wx.PyEventBinder( wxEVT_SCROLL_BOTTOM, 1)
3705EVT_COMMAND_SCROLL_LINEUP = wx.PyEventBinder( wxEVT_SCROLL_LINEUP, 1)
3706EVT_COMMAND_SCROLL_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLL_LINEDOWN, 1)
3707EVT_COMMAND_SCROLL_PAGEUP = wx.PyEventBinder( wxEVT_SCROLL_PAGEUP, 1)
3708EVT_COMMAND_SCROLL_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLL_PAGEDOWN, 1)
3709EVT_COMMAND_SCROLL_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLL_THUMBTRACK, 1)
3710EVT_COMMAND_SCROLL_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE, 1)
db67f999
RD		 3711EVT_COMMAND_SCROLL_CHANGED = wx.PyEventBinder( wxEVT_SCROLL_CHANGED, 1)
3712EVT_COMMAND_SCROLL_ENDSCROLL = EVT_COMMAND_SCROLL_CHANGED
d55e5bfc
RD		 3713
3714EVT_BUTTON = wx.PyEventBinder( wxEVT_COMMAND_BUTTON_CLICKED, 1)
3715EVT_CHECKBOX = wx.PyEventBinder( wxEVT_COMMAND_CHECKBOX_CLICKED, 1)
3716EVT_CHOICE = wx.PyEventBinder( wxEVT_COMMAND_CHOICE_SELECTED, 1)
3717EVT_LISTBOX = wx.PyEventBinder( wxEVT_COMMAND_LISTBOX_SELECTED, 1)
3718EVT_LISTBOX_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, 1)
3719EVT_MENU = wx.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED, 1)
3720EVT_MENU_RANGE = wx.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED, 2)
3721EVT_SLIDER = wx.PyEventBinder( wxEVT_COMMAND_SLIDER_UPDATED, 1)
3722EVT_RADIOBOX = wx.PyEventBinder( wxEVT_COMMAND_RADIOBOX_SELECTED, 1)
3723EVT_RADIOBUTTON = wx.PyEventBinder( wxEVT_COMMAND_RADIOBUTTON_SELECTED, 1)
3724
3725EVT_SCROLLBAR = wx.PyEventBinder( wxEVT_COMMAND_SCROLLBAR_UPDATED, 1)
3726EVT_VLBOX = wx.PyEventBinder( wxEVT_COMMAND_VLBOX_SELECTED, 1)
3727EVT_COMBOBOX = wx.PyEventBinder( wxEVT_COMMAND_COMBOBOX_SELECTED, 1)
3728EVT_TOOL = wx.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED, 1)
3729EVT_TOOL_RANGE = wx.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED, 2)
3730EVT_TOOL_RCLICKED = wx.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED, 1)
3731EVT_TOOL_RCLICKED_RANGE = wx.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED, 2)
3732EVT_TOOL_ENTER = wx.PyEventBinder( wxEVT_COMMAND_TOOL_ENTER, 1)
3733EVT_CHECKLISTBOX = wx.PyEventBinder( wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, 1)
3734
3735
3736EVT_COMMAND_LEFT_CLICK = wx.PyEventBinder( wxEVT_COMMAND_LEFT_CLICK, 1)
3737EVT_COMMAND_LEFT_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_LEFT_DCLICK, 1)
3738EVT_COMMAND_RIGHT_CLICK = wx.PyEventBinder( wxEVT_COMMAND_RIGHT_CLICK, 1)
3739EVT_COMMAND_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_RIGHT_DCLICK, 1)
3740EVT_COMMAND_SET_FOCUS = wx.PyEventBinder( wxEVT_COMMAND_SET_FOCUS, 1)
3741EVT_COMMAND_KILL_FOCUS = wx.PyEventBinder( wxEVT_COMMAND_KILL_FOCUS, 1)
3742EVT_COMMAND_ENTER = wx.PyEventBinder( wxEVT_COMMAND_ENTER, 1)
3743
3744EVT_IDLE = wx.PyEventBinder( wxEVT_IDLE )
3745
3746EVT_UPDATE_UI = wx.PyEventBinder( wxEVT_UPDATE_UI, 1)
3747EVT_UPDATE_UI_RANGE = wx.PyEventBinder( wxEVT_UPDATE_UI, 2)
3748
3749EVT_CONTEXT_MENU = wx.PyEventBinder( wxEVT_CONTEXT_MENU )
3750
3751
3752
3753#---------------------------------------------------------------------------
3754
3755class Event(Object):
27fb7603
RD		 3756 """
3757 An event is a structure holding information about an event passed to a
3758 callback or member function. wx.Event is an abstract base class for
3759 other event classes
3760 """
554f62e9
RD		 3761 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3762 def __init__(self): raise AttributeError, "No constructor defined"
3763 __repr__ = _swig_repr
3764 __swig_destroy__ = _core_.delete_Event
3765 __del__ = lambda self : None;
d55e5bfc 3766 def SetEventType(*args, **kwargs):
27fb7603
RD		 3767 """
3768 SetEventType(self, wxEventType typ)
3769
3770 Sets the specific type of the event.
3771 """
d55e5bfc
RD		 3772 return _core_.Event_SetEventType(*args, **kwargs)
3773
3774 def GetEventType(*args, **kwargs):
27fb7603
RD		 3775 """
3776 GetEventType(self) -> wxEventType
3777
3778 Returns the identifier of the given event type, such as
3779 ``wxEVT_COMMAND_BUTTON_CLICKED``.
3780 """
d55e5bfc
RD		 3781 return _core_.Event_GetEventType(*args, **kwargs)
3782
3783 def GetEventObject(*args, **kwargs):
27fb7603
RD		 3784 """
3785 GetEventObject(self) -> Object
3786
3787 Returns the object (usually a window) associated with the event, if
3788 any.
3789 """
d55e5bfc
RD		 3790 return _core_.Event_GetEventObject(*args, **kwargs)
3791
3792 def SetEventObject(*args, **kwargs):
27fb7603
RD		 3793 """
3794 SetEventObject(self, Object obj)
3795
3796 Sets the originating object, or in other words, obj is normally the
3797 object that is sending the event.
3798 """
d55e5bfc
RD		 3799 return _core_.Event_SetEventObject(*args, **kwargs)
3800
3801 def GetTimestamp(*args, **kwargs):
3802 """GetTimestamp(self) -> long"""
3803 return _core_.Event_GetTimestamp(*args, **kwargs)
3804
3805 def SetTimestamp(*args, **kwargs):
3806 """SetTimestamp(self, long ts=0)"""
3807 return _core_.Event_SetTimestamp(*args, **kwargs)
3808
3809 def GetId(*args, **kwargs):
27fb7603
RD		 3810 """
3811 GetId(self) -> int
3812
3813 Returns the identifier associated with this event, such as a button
3814 command id.
3815 """
d55e5bfc
RD		 3816 return _core_.Event_GetId(*args, **kwargs)
3817
3818 def SetId(*args, **kwargs):
27fb7603
RD		 3819 """
3820 SetId(self, int Id)
3821
3822 Set's the ID for the event. This is usually the ID of the window that
3823 is sending the event, but it can also be a command id from a menu
3824 item, etc.
3825 """
d55e5bfc
RD		 3826 return _core_.Event_SetId(*args, **kwargs)
3827
3828 def IsCommandEvent(*args, **kwargs):
27fb7603
RD		 3829 """
3830 IsCommandEvent(self) -> bool
3831
3832 Returns true if the event is or is derived from `wx.CommandEvent` else
3833 it returns false. Note: Exists only for optimization purposes.
3834 """
d55e5bfc
RD		 3835 return _core_.Event_IsCommandEvent(*args, **kwargs)
3836
3837 def Skip(*args, **kwargs):
51b83b37
RD		 3838 """
3839 Skip(self, bool skip=True)
3840
3841 Called by an event handler, it controls whether additional event
3842 handlers bound to this event will be called after the current event
3843 handler returns. Skip(false) (the default setting) will prevent
3844 additional event handlers from being called and control will be
3845 returned to the sender of the event immediately after the current
3846 handler has finished. Skip(True) will cause the event processing
3847 system to continue searching for a handler function for this event.
3848
3849 """
d55e5bfc
RD		 3850 return _core_.Event_Skip(*args, **kwargs)
3851
3852 def GetSkipped(*args, **kwargs):
27fb7603
RD		 3853 """
3854 GetSkipped(self) -> bool
3855
3856 Returns true if the event handler should be skipped, false otherwise.
3857 :see: `Skip`
3858 """
d55e5bfc
RD		 3859 return _core_.Event_GetSkipped(*args, **kwargs)
3860
3861 def ShouldPropagate(*args, **kwargs):
27fb7603
RD		 3862 """
3863 ShouldPropagate(self) -> bool
3864
3865 Test if this event should be propagated to the parent window or not,
3866 i.e. if the propagation level is currently greater than 0.
3867 """
d55e5bfc
RD		 3868 return _core_.Event_ShouldPropagate(*args, **kwargs)
3869
3870 def StopPropagation(*args, **kwargs):
27fb7603
RD		 3871 """
3872 StopPropagation(self) -> int
3873
3874 Stop the event from propagating to its parent window. Returns the old
3875 propagation level value which may be later passed to
3876 `ResumePropagation` to allow propagating the event again.
3877 """
d55e5bfc
RD		 3878 return _core_.Event_StopPropagation(*args, **kwargs)
3879
3880 def ResumePropagation(*args, **kwargs):
27fb7603
RD		 3881 """
3882 ResumePropagation(self, int propagationLevel)
3883
3884 Resume the event propagation by restoring the propagation level. (For
3885 example, you can use the value returned by an earlier call to
3886 `StopPropagation`.)
3887
3888 """
d55e5bfc
RD		 3889 return _core_.Event_ResumePropagation(*args, **kwargs)
3890
3891 def Clone(*args, **kwargs):
3892 """Clone(self) -> Event"""
3893 return _core_.Event_Clone(*args, **kwargs)
3894
554f62e9
RD		 3895Event_swigregister = _core_.Event_swigregister
3896Event_swigregister(Event)
d55e5bfc
RD		 3897
3898#---------------------------------------------------------------------------
3899
3900class PropagationDisabler(object):
27fb7603
RD		 3901 """
3902 Helper class to temporarily change an event not to propagate. Simply
3903 create an instance of this class and then whe it is destroyed the
3904 propogation of the event will be restored.
3905 """
554f62e9
RD		 3906 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3907 __repr__ = _swig_repr
3908 def __init__(self, *args, **kwargs):
27fb7603
RD		 3909 """
3910 __init__(self, Event event) -> PropagationDisabler
3911
3912 Helper class to temporarily change an event not to propagate. Simply
3913 create an instance of this class and then whe it is destroyed the
3914 propogation of the event will be restored.
3915 """
554f62e9
RD		 3916 _core_.PropagationDisabler_swiginit(self,_core_.new_PropagationDisabler(*args, **kwargs))
3917 __swig_destroy__ = _core_.delete_PropagationDisabler
3918 __del__ = lambda self : None;
3919PropagationDisabler_swigregister = _core_.PropagationDisabler_swigregister
3920PropagationDisabler_swigregister(PropagationDisabler)
d55e5bfc
RD		 3921
3922class PropagateOnce(object):
27fb7603
RD		 3923 """
3924 A helper class that will temporarily lower propagation level of an
3925 event. Simply create an instance of this class and then whe it is
3926 destroyed the propogation of the event will be restored.
3927 """
554f62e9
RD		 3928 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3929 __repr__ = _swig_repr
3930 def __init__(self, *args, **kwargs):
27fb7603
RD		 3931 """
3932 __init__(self, Event event) -> PropagateOnce
3933
3934 A helper class that will temporarily lower propagation level of an
3935 event. Simply create an instance of this class and then whe it is
3936 destroyed the propogation of the event will be restored.
3937 """
554f62e9
RD		 3938 _core_.PropagateOnce_swiginit(self,_core_.new_PropagateOnce(*args, **kwargs))
3939 __swig_destroy__ = _core_.delete_PropagateOnce
3940 __del__ = lambda self : None;
3941PropagateOnce_swigregister = _core_.PropagateOnce_swigregister
3942PropagateOnce_swigregister(PropagateOnce)
d55e5bfc
RD		 3943
3944#---------------------------------------------------------------------------
3945
3946class CommandEvent(Event):
27fb7603
RD		 3947 """
3948 This event class contains information about command events, which
3949 originate from a variety of simple controls, as well as menus and
3950 toolbars.
3951 """
554f62e9
RD		 3952 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3953 __repr__ = _swig_repr
3954 def __init__(self, *args, **kwargs):
27fb7603
RD		 3955 """
3956 __init__(self, wxEventType commandType=wxEVT_NULL, int winid=0) -> CommandEvent
3957
3958 This event class contains information about command events, which
3959 originate from a variety of simple controls, as well as menus and
3960 toolbars.
3961 """
554f62e9 3962 _core_.CommandEvent_swiginit(self,_core_.new_CommandEvent(*args, **kwargs))
d55e5bfc 3963 def GetSelection(*args, **kwargs):
27fb7603
RD		 3964 """
3965 GetSelection(self) -> int
3966
3967 Returns item index for a listbox or choice selection event (not valid
3968 for a deselection).
3969 """
d55e5bfc
RD		 3970 return _core_.CommandEvent_GetSelection(*args, **kwargs)
3971
3972 def SetString(*args, **kwargs):
3973 """SetString(self, String s)"""
3974 return _core_.CommandEvent_SetString(*args, **kwargs)
3975
3976 def GetString(*args, **kwargs):
27fb7603
RD		 3977 """
3978 GetString(self) -> String
3979
3980 Returns item string for a listbox or choice selection event (not valid
3981 for a deselection).
3982 """
d55e5bfc
RD		 3983 return _core_.CommandEvent_GetString(*args, **kwargs)
3984
3985 def IsChecked(*args, **kwargs):
27fb7603
RD		 3986 """
3987 IsChecked(self) -> bool
3988
3989 This method can be used with checkbox and menu events: for the
3990 checkboxes, the method returns true for a selection event and false
3991 for a deselection one. For the menu events, this method indicates if
3992 the menu item just has become checked or unchecked (and thus only
3993 makes sense for checkable menu items).
3994 """
d55e5bfc
RD		 3995 return _core_.CommandEvent_IsChecked(*args, **kwargs)
3996
3997 Checked = IsChecked
3998 def IsSelection(*args, **kwargs):
27fb7603
RD		 3999 """
4000 IsSelection(self) -> bool
4001
4002 For a listbox or similar event, returns true if it is a selection,
4003 false if it is a deselection.
4004 """
d55e5bfc
RD		 4005 return _core_.CommandEvent_IsSelection(*args, **kwargs)
4006
4007 def SetExtraLong(*args, **kwargs):
4008 """SetExtraLong(self, long extraLong)"""
4009 return _core_.CommandEvent_SetExtraLong(*args, **kwargs)
4010
4011 def GetExtraLong(*args, **kwargs):
27fb7603
RD		 4012 """
4013 GetExtraLong(self) -> long
4014
5ba5649b
RD		 4015 Returns extra information dependant on the event objects type. If the
4016 event comes from a listbox selection, it is a boolean determining
4017 whether the event was a selection (true) or a deselection (false). A
4018 listbox deselection only occurs for multiple-selection boxes, and in
4019 this case the index and string values are indeterminate and the
4020 listbox must be examined by the application.
27fb7603 4021 """
d55e5bfc
RD		 4022 return _core_.CommandEvent_GetExtraLong(*args, **kwargs)
4023
4024 def SetInt(*args, **kwargs):
4025 """SetInt(self, int i)"""
4026 return _core_.CommandEvent_SetInt(*args, **kwargs)
4027
4028 def GetInt(*args, **kwargs):
27fb7603
RD		 4029 """
4030 GetInt(self) -> long
4031
5ba5649b
RD		 4032 Returns the integer identifier corresponding to a listbox, choice or
4033 radiobox selection (only if the event was a selection, not a
4034 deselection), or a boolean value representing the value of a checkbox.
27fb7603 4035 """
d55e5bfc
RD		 4036 return _core_.CommandEvent_GetInt(*args, **kwargs)
4037
554f62e9
RD		 4038 def GetClientData(*args, **kwargs):
4039 """
4040 GetClientData(self) -> PyObject
4041
4042 Returns the client data object for a listbox or choice selection event, (if any.)
4043 """
4044 return _core_.CommandEvent_GetClientData(*args, **kwargs)
4045
4046 def SetClientData(*args, **kwargs):
4047 """
4048 SetClientData(self, PyObject clientData)
4049
4050 Associate the given client data with the item at position n.
4051 """
4052 return _core_.CommandEvent_SetClientData(*args, **kwargs)
4053
4054 GetClientObject = GetClientData
4055 SetClientObject = SetClientData
4056
d55e5bfc
RD		 4057 def Clone(*args, **kwargs):
4058 """Clone(self) -> Event"""
4059 return _core_.CommandEvent_Clone(*args, **kwargs)
4060
554f62e9
RD		 4061CommandEvent_swigregister = _core_.CommandEvent_swigregister
4062CommandEvent_swigregister(CommandEvent)
d55e5bfc
RD		 4063
4064#---------------------------------------------------------------------------
4065
4066class NotifyEvent(CommandEvent):
27fb7603
RD		 4067 """
4068 An instance of this class (or one of its derived classes) is sent from
4069 a control when the control's state is being changed and the control
4070 allows that change to be prevented from happening. The event handler
4071 can call `Veto` or `Allow` to tell the control what to do.
4072 """
554f62e9
RD		 4073 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4074 __repr__ = _swig_repr
4075 def __init__(self, *args, **kwargs):
27fb7603
RD		 4076 """
4077 __init__(self, wxEventType commandType=wxEVT_NULL, int winid=0) -> NotifyEvent
4078
4079 An instance of this class (or one of its derived classes) is sent from
4080 a control when the control's state is being changed and the control
4081 allows that change to be prevented from happening. The event handler
4082 can call `Veto` or `Allow` to tell the control what to do.
4083 """
554f62e9 4084 _core_.NotifyEvent_swiginit(self,_core_.new_NotifyEvent(*args, **kwargs))
d55e5bfc 4085 def Veto(*args, **kwargs):
27fb7603
RD		 4086 """
4087 Veto(self)
4088
4089 Prevents the change announced by this event from happening.
4090
4091 It is in general a good idea to notify the user about the reasons for
4092 vetoing the change because otherwise the applications behaviour (which
4093 just refuses to do what the user wants) might be quite surprising.
4094 """
d55e5bfc
RD		 4095 return _core_.NotifyEvent_Veto(*args, **kwargs)
4096
4097 def Allow(*args, **kwargs):
27fb7603
RD		 4098 """
4099 Allow(self)
4100
4101 This is the opposite of `Veto`: it explicitly allows the event to be
4102 processed. For most events it is not necessary to call this method as
4103 the events are allowed anyhow but some are forbidden by default (this
4104 will be mentioned in the corresponding event description).
4105 """
d55e5bfc
RD		 4106 return _core_.NotifyEvent_Allow(*args, **kwargs)
4107
4108 def IsAllowed(*args, **kwargs):
27fb7603
RD		 4109 """
4110 IsAllowed(self) -> bool
4111
4112 Returns true if the change is allowed (`Veto` hasn't been called) or
4113 false otherwise (if it was).
4114 """
d55e5bfc
RD		 4115 return _core_.NotifyEvent_IsAllowed(*args, **kwargs)
4116
554f62e9
RD		 4117NotifyEvent_swigregister = _core_.NotifyEvent_swigregister
4118NotifyEvent_swigregister(NotifyEvent)
d55e5bfc
RD		 4119
4120#---------------------------------------------------------------------------
4121
4122class ScrollEvent(CommandEvent):
27fb7603
RD		 4123 """
4124 A scroll event holds information about events sent from stand-alone
4125 scrollbars and sliders. Note that scrolled windows do not send
4126 instnaces of this event class, but send the `wx.ScrollWinEvent`
4127 instead.
4128 """
554f62e9
RD		 4129 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4130 __repr__ = _swig_repr
4131 def __init__(self, *args, **kwargs):
d55e5bfc
RD		 4132 """
4133 __init__(self, wxEventType commandType=wxEVT_NULL, int winid=0, int pos=0,
4134 int orient=0) -> ScrollEvent
4135 """
554f62e9 4136 _core_.ScrollEvent_swiginit(self,_core_.new_ScrollEvent(*args, **kwargs))
d55e5bfc 4137 def GetOrientation(*args, **kwargs):
27fb7603
RD		 4138 """
4139 GetOrientation(self) -> int
4140
4141 Returns wx.HORIZONTAL or wx.VERTICAL, depending on the orientation of
4142 the scrollbar.
4143 """
d55e5bfc
RD		 4144 return _core_.ScrollEvent_GetOrientation(*args, **kwargs)
4145
4146 def GetPosition(*args, **kwargs):
27fb7603
RD		 4147 """
4148 GetPosition(self) -> int
4149
4150 Returns the position of the scrollbar.
4151 """
d55e5bfc
RD		 4152 return _core_.ScrollEvent_GetPosition(*args, **kwargs)
4153
4154 def SetOrientation(*args, **kwargs):
4155 """SetOrientation(self, int orient)"""
4156 return _core_.ScrollEvent_SetOrientation(*args, **kwargs)
4157
4158 def SetPosition(*args, **kwargs):
4159 """SetPosition(self, int pos)"""
4160 return _core_.ScrollEvent_SetPosition(*args, **kwargs)
4161
554f62e9
RD		 4162ScrollEvent_swigregister = _core_.ScrollEvent_swigregister
4163ScrollEvent_swigregister(ScrollEvent)
d55e5bfc
RD		 4164
4165#---------------------------------------------------------------------------
4166
4167class ScrollWinEvent(Event):
27fb7603
RD		 4168 """
4169 A wx.ScrollWinEvent holds information about scrolling and is sent from
4170 scrolling windows.
4171 """
554f62e9
RD		 4172 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4173 __repr__ = _swig_repr
4174 def __init__(self, *args, **kwargs):
27fb7603
RD		 4175 """
4176 __init__(self, wxEventType commandType=wxEVT_NULL, int pos=0, int orient=0) -> ScrollWinEvent
4177
4178 A wx.ScrollWinEvent holds information about scrolling and is sent from
4179 scrolling windows.
4180 """
554f62e9 4181 _core_.ScrollWinEvent_swiginit(self,_core_.new_ScrollWinEvent(*args, **kwargs))
d55e5bfc 4182 def GetOrientation(*args, **kwargs):
27fb7603
RD		 4183 """
4184 GetOrientation(self) -> int
4185
4186 Returns wx.HORIZONTAL or wx.VERTICAL, depending on the orientation of
4187 the scrollbar.
4188 """
d55e5bfc
RD		 4189 return _core_.ScrollWinEvent_GetOrientation(*args, **kwargs)
4190
4191 def GetPosition(*args, **kwargs):
27fb7603
RD		 4192 """
4193 GetPosition(self) -> int
4194
4195 Returns the position of the scrollbar for the thumb track and release
4196 events. Note that this field can't be used for the other events, you
4197 need to query the window itself for the current position in that case.
4198 """
d55e5bfc
RD		 4199 return _core_.ScrollWinEvent_GetPosition(*args, **kwargs)
4200
4201 def SetOrientation(*args, **kwargs):
4202 """SetOrientation(self, int orient)"""
4203 return _core_.ScrollWinEvent_SetOrientation(*args, **kwargs)
4204
4205 def SetPosition(*args, **kwargs):
4206 """SetPosition(self, int pos)"""
4207 return _core_.ScrollWinEvent_SetPosition(*args, **kwargs)
4208
554f62e9
RD		 4209ScrollWinEvent_swigregister = _core_.ScrollWinEvent_swigregister
4210ScrollWinEvent_swigregister(ScrollWinEvent)
d55e5bfc
RD		 4211
4212#---------------------------------------------------------------------------
4213
4214MOUSE_BTN_ANY = _core_.MOUSE_BTN_ANY
4215MOUSE_BTN_NONE = _core_.MOUSE_BTN_NONE
4216MOUSE_BTN_LEFT = _core_.MOUSE_BTN_LEFT
4217MOUSE_BTN_MIDDLE = _core_.MOUSE_BTN_MIDDLE
4218MOUSE_BTN_RIGHT = _core_.MOUSE_BTN_RIGHT
4219class MouseEvent(Event):
27fb7603
RD		 4220 """
4221 This event class contains information about the events generated by
4222 the mouse: they include mouse buttons press and release events and
4223 mouse move events.
4224
4225 All mouse events involving the buttons use ``wx.MOUSE_BTN_LEFT`` for
4226 the left mouse button, ``wx.MOUSE_BTN_MIDDLE`` for the middle one and
4227 ``wx.MOUSE_BTN_RIGHT`` for the right one. Note that not all mice have
4228 a middle button so a portable application should avoid relying on the
4229 events from it.
4230
4231 Note the difference between methods like `LeftDown` and `LeftIsDown`:
4232 the former returns true when the event corresponds to the left mouse
4233 button click while the latter returns true if the left mouse button is
4234 currently being pressed. For example, when the user is dragging the
4235 mouse you can use `LeftIsDown` to test whether the left mouse button
4236 is (still) depressed. Also, by convention, if `LeftDown` returns true,
4237 `LeftIsDown` will also return true in wxWidgets whatever the
4238 underlying GUI behaviour is (which is platform-dependent). The same
4239 applies, of course, to other mouse buttons as well.
4240 """
554f62e9
RD		 4241 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4242 __repr__ = _swig_repr
4243 def __init__(self, *args, **kwargs):
27fb7603
RD		 4244 """
4245 __init__(self, wxEventType mouseType=wxEVT_NULL) -> MouseEvent
4246
4247 Constructs a wx.MouseEvent. Valid event types are:
4248
4249 * wxEVT_ENTER_WINDOW
4250 * wxEVT_LEAVE_WINDOW
4251 * wxEVT_LEFT_DOWN
4252 * wxEVT_LEFT_UP
4253 * wxEVT_LEFT_DCLICK
4254 * wxEVT_MIDDLE_DOWN
4255 * wxEVT_MIDDLE_UP
4256 * wxEVT_MIDDLE_DCLICK
4257 * wxEVT_RIGHT_DOWN
4258 * wxEVT_RIGHT_UP
4259 * wxEVT_RIGHT_DCLICK
4260 * wxEVT_MOTION
4261 * wxEVT_MOUSEWHEEL
4262 """
554f62e9 4263 _core_.MouseEvent_swiginit(self,_core_.new_MouseEvent(*args, **kwargs))
d55e5bfc 4264 def IsButton(*args, **kwargs):
27fb7603
RD		 4265 """
4266 IsButton(self) -> bool
4267
4268 Returns true if the event was a mouse button event (not necessarily a
4269 button down event - that may be tested using `ButtonDown`).
4270 """
d55e5bfc
RD		 4271 return _core_.MouseEvent_IsButton(*args, **kwargs)
4272
4273 def ButtonDown(*args, **kwargs):
27fb7603
RD		 4274 """
4275 ButtonDown(self, int but=MOUSE_BTN_ANY) -> bool
4276
5ba5649b
RD		 4277 If the argument is omitted, this returns true if the event was any
4278 mouse button down event. Otherwise the argument specifies which
4279 button-down event shold be checked for (see `Button` for the possible
4280 values).
27fb7603 4281 """
d55e5bfc
RD		 4282 return _core_.MouseEvent_ButtonDown(*args, **kwargs)
4283
4284 def ButtonDClick(*args, **kwargs):
27fb7603
RD		 4285 """
4286 ButtonDClick(self, int but=MOUSE_BTN_ANY) -> bool
4287
4288 If the argument is omitted, this returns true if the event was any
4289 mouse double click event. Otherwise the argument specifies which
4290 double click event to check for (see `Button` for the possible
4291 values).
4292 """
d55e5bfc
RD		 4293 return _core_.MouseEvent_ButtonDClick(*args, **kwargs)
4294
4295 def ButtonUp(*args, **kwargs):
27fb7603
RD		 4296 """
4297 ButtonUp(self, int but=MOUSE_BTN_ANY) -> bool
4298
4299 If the argument is omitted, this returns true if the event was any
5ba5649b
RD		 4300 mouse button up event. Otherwise the argument specifies which button
4301 up event to check for (see `Button` for the possible values).
27fb7603 4302 """
d55e5bfc
RD		 4303 return _core_.MouseEvent_ButtonUp(*args, **kwargs)
4304
4305 def Button(*args, **kwargs):
27fb7603
RD		 4306 """
4307 Button(self, int button) -> bool
4308
4309 Returns true if the identified mouse button is changing state. Valid
4310 values of button are:
4311
4312 ==================== =====================================
4313 wx.MOUSE_BTN_LEFT check if left button was pressed
4314 wx.MOUSE_BTN_MIDDLE check if middle button was pressed
4315 wx.MOUSE_BTN_RIGHT check if right button was pressed
4316 wx.MOUSE_BTN_ANY check if any button was pressed
4317 ==================== =====================================
4318
4319 """
d55e5bfc
RD		 4320 return _core_.MouseEvent_Button(*args, **kwargs)
4321
4322 def ButtonIsDown(*args, **kwargs):
4323 """ButtonIsDown(self, int but) -> bool"""
4324 return _core_.MouseEvent_ButtonIsDown(*args, **kwargs)
4325
4326 def GetButton(*args, **kwargs):
27fb7603
RD		 4327 """
4328 GetButton(self) -> int
4329
4330 Returns the mouse button which generated this event or
4331 wx.MOUSE_BTN_NONE if no button is involved (for mouse move, enter or
4332 leave event, for example). Otherwise wx.MOUSE_BTN_LEFT is returned for
4333 the left button down, up and double click events, wx.MOUSE_BTN_MIDDLE
4334 and wx.MOUSE_BTN_RIGHT for the same events for the middle and the
4335 right buttons respectively.
4336 """
d55e5bfc
RD		 4337 return _core_.MouseEvent_GetButton(*args, **kwargs)
4338
4339 def ControlDown(*args, **kwargs):
27fb7603
RD		 4340 """
4341 ControlDown(self) -> bool
4342
4343 Returns true if the control key was down at the time of the event.
4344 """
d55e5bfc
RD		 4345 return _core_.MouseEvent_ControlDown(*args, **kwargs)
4346
4347 def MetaDown(*args, **kwargs):
27fb7603
RD		 4348 """
4349 MetaDown(self) -> bool
4350
4351 Returns true if the Meta key was down at the time of the event.
4352 """
d55e5bfc
RD		 4353 return _core_.MouseEvent_MetaDown(*args, **kwargs)
4354
4355 def AltDown(*args, **kwargs):
27fb7603
RD		 4356 """
4357 AltDown(self) -> bool
4358
4359 Returns true if the Alt key was down at the time of the event.
4360 """
d55e5bfc
RD		 4361 return _core_.MouseEvent_AltDown(*args, **kwargs)
4362
4363 def ShiftDown(*args, **kwargs):
27fb7603
RD		 4364 """
4365 ShiftDown(self) -> bool
4366
4367 Returns true if the Shift key was down at the time of the event.
4368 """
d55e5bfc
RD		 4369 return _core_.MouseEvent_ShiftDown(*args, **kwargs)
4370
412d302d
RD		 4371 def CmdDown(*args, **kwargs):
4372 """
4373 CmdDown(self) -> bool
4374
4375 "Cmd" is a pseudo key which is the same as Control for PC and Unix
4376 platforms but the special "Apple" (a.k.a as "Command") key on
5ba5649b 4377 Macs. It often makes sense to use it instead of, say, `ControlDown`
412d302d 4378 because Cmd key is used for the same thing under Mac as Ctrl
27fb7603 4379 elsewhere. The Ctrl key still exists, it's just not used for this
412d302d
RD		 4380 purpose. So for non-Mac platforms this is the same as `ControlDown`
4381 and Macs this is the same as `MetaDown`.
4382 """
4383 return _core_.MouseEvent_CmdDown(*args, **kwargs)
4384
d55e5bfc 4385 def LeftDown(*args, **kwargs):
27fb7603
RD		 4386 """
4387 LeftDown(self) -> bool
4388
4389 Returns true if the left mouse button state changed to down.
4390 """
d55e5bfc
RD		 4391 return _core_.MouseEvent_LeftDown(*args, **kwargs)
4392
4393 def MiddleDown(*args, **kwargs):
27fb7603
RD		 4394 """
4395 MiddleDown(self) -> bool
4396
4397 Returns true if the middle mouse button state changed to down.
4398 """
d55e5bfc
RD		 4399 return _core_.MouseEvent_MiddleDown(*args, **kwargs)
4400
4401 def RightDown(*args, **kwargs):
27fb7603
RD		 4402 """
4403 RightDown(self) -> bool
4404
4405 Returns true if the right mouse button state changed to down.
4406 """
d55e5bfc
RD		 4407 return _core_.MouseEvent_RightDown(*args, **kwargs)
4408
4409 def LeftUp(*args, **kwargs):
27fb7603
RD		 4410 """
4411 LeftUp(self) -> bool
4412
4413 Returns true if the left mouse button state changed to up.
4414 """
d55e5bfc
RD		 4415 return _core_.MouseEvent_LeftUp(*args, **kwargs)
4416
4417 def MiddleUp(*args, **kwargs):
27fb7603
RD		 4418 """
4419 MiddleUp(self) -> bool
4420
4421 Returns true if the middle mouse button state changed to up.
4422 """
d55e5bfc
RD		 4423 return _core_.MouseEvent_MiddleUp(*args, **kwargs)
4424
4425 def RightUp(*args, **kwargs):
27fb7603
RD		 4426 """
4427 RightUp(self) -> bool
4428
4429 Returns true if the right mouse button state changed to up.
4430 """
d55e5bfc
RD		 4431 return _core_.MouseEvent_RightUp(*args, **kwargs)
4432
4433 def LeftDClick(*args, **kwargs):
27fb7603
RD		 4434 """
4435 LeftDClick(self) -> bool
4436
4437 Returns true if the event was a left button double click.
4438 """
d55e5bfc
RD		 4439 return _core_.MouseEvent_LeftDClick(*args, **kwargs)
4440
4441 def MiddleDClick(*args, **kwargs):
27fb7603
RD		 4442 """
4443 MiddleDClick(self) -> bool
4444
4445 Returns true if the event was a middle button double click.
4446 """
d55e5bfc
RD		 4447 return _core_.MouseEvent_MiddleDClick(*args, **kwargs)
4448
4449 def RightDClick(*args, **kwargs):
27fb7603
RD		 4450 """
4451 RightDClick(self) -> bool
4452
4453 Returns true if the event was a right button double click.
4454 """
d55e5bfc
RD		 4455 return _core_.MouseEvent_RightDClick(*args, **kwargs)
4456
4457 def LeftIsDown(*args, **kwargs):
27fb7603
RD		 4458 """
4459 LeftIsDown(self) -> bool
4460
4461 Returns true if the left mouse button is currently down, independent
4462 of the current event type.
4463
4464 Please notice that it is not the same as LeftDown which returns true
4465 if the left mouse button was just pressed. Rather, it describes the
4466 state of the mouse button before the event happened.
4467
4468 This event is usually used in the mouse event handlers which process
4469 "move mouse" messages to determine whether the user is (still)
4470 dragging the mouse.
4471 """
d55e5bfc
RD		 4472 return _core_.MouseEvent_LeftIsDown(*args, **kwargs)
4473
4474 def MiddleIsDown(*args, **kwargs):
27fb7603
RD		 4475 """
4476 MiddleIsDown(self) -> bool
4477
4478 Returns true if the middle mouse button is currently down, independent
4479 of the current event type.
4480 """
d55e5bfc
RD		 4481 return _core_.MouseEvent_MiddleIsDown(*args, **kwargs)
4482
4483 def RightIsDown(*args, **kwargs):
27fb7603
RD		 4484 """
4485 RightIsDown(self) -> bool
4486
4487 Returns true if the right mouse button is currently down, independent
4488 of the current event type.
4489 """
d55e5bfc
RD		 4490 return _core_.MouseEvent_RightIsDown(*args, **kwargs)
4491
4492 def Dragging(*args, **kwargs):
27fb7603
RD		 4493 """
4494 Dragging(self) -> bool
4495
4496 Returns true if this was a dragging event (motion while a button is
4497 depressed).
4498 """
d55e5bfc
RD		 4499 return _core_.MouseEvent_Dragging(*args, **kwargs)
4500
4501 def Moving(*args, **kwargs):
27fb7603
RD		 4502 """
4503 Moving(self) -> bool
4504
4505 Returns true if this was a motion event and no mouse buttons were
4506 pressed. If any mouse button is held pressed, then this method returns
4507 false and Dragging returns true.
4508 """
d55e5bfc
RD		 4509 return _core_.MouseEvent_Moving(*args, **kwargs)
4510
4511 def Entering(*args, **kwargs):
27fb7603
RD		 4512 """
4513 Entering(self) -> bool
4514
4515 Returns true if the mouse was entering the window.
4516 """
d55e5bfc
RD		 4517 return _core_.MouseEvent_Entering(*args, **kwargs)
4518
4519 def Leaving(*args, **kwargs):
27fb7603
RD		 4520 """
4521 Leaving(self) -> bool
4522
4523 Returns true if the mouse was leaving the window.
4524 """
d55e5bfc
RD		 4525 return _core_.MouseEvent_Leaving(*args, **kwargs)
4526
4527 def GetPosition(*args, **kwargs):
4528 """
4529 GetPosition(self) -> Point
4530
27fb7603
RD		 4531 Returns the pixel position of the mouse in window coordinates when the
4532 event happened.
d55e5bfc
RD		 4533 """
4534 return _core_.MouseEvent_GetPosition(*args, **kwargs)
4535
4536 def GetPositionTuple(*args, **kwargs):
4537 """
4538 GetPositionTuple() -> (x,y)
4539
27fb7603
RD		 4540 Returns the pixel position of the mouse in window coordinates when the
4541 event happened.
d55e5bfc
RD		 4542 """
4543 return _core_.MouseEvent_GetPositionTuple(*args, **kwargs)
4544
4545 def GetLogicalPosition(*args, **kwargs):
27fb7603
RD		 4546 """
4547 GetLogicalPosition(self, DC dc) -> Point
4548
4549 Returns the logical mouse position in pixels (i.e. translated
4550 according to the translation set for the DC, which usually indicates
4551 that the window has been scrolled).
4552 """
d55e5bfc
RD		 4553 return _core_.MouseEvent_GetLogicalPosition(*args, **kwargs)
4554
4555 def GetX(*args, **kwargs):
27fb7603
RD		 4556 """
4557 GetX(self) -> int
4558
4559 Returns X coordinate of the physical mouse event position.
4560 """
d55e5bfc
RD		 4561 return _core_.MouseEvent_GetX(*args, **kwargs)
4562
4563 def GetY(*args, **kwargs):
27fb7603
RD		 4564 """
4565 GetY(self) -> int
4566
4567 Returns Y coordinate of the physical mouse event position.
4568 """
d55e5bfc
RD		 4569 return _core_.MouseEvent_GetY(*args, **kwargs)
4570
4571 def GetWheelRotation(*args, **kwargs):
27fb7603
RD		 4572 """
4573 GetWheelRotation(self) -> int
4574
4575 Get wheel rotation, positive or negative indicates direction of
4576 rotation. Current devices all send an event when rotation is equal to
4577 +/-WheelDelta, but this allows for finer resolution devices to be
4578 created in the future. Because of this you shouldn't assume that one
4579 event is equal to 1 line or whatever, but you should be able to either
4580 do partial line scrolling or wait until +/-WheelDelta rotation values
4581 have been accumulated before scrolling.
4582 """
d55e5bfc
RD		 4583 return _core_.MouseEvent_GetWheelRotation(*args, **kwargs)
4584
4585 def GetWheelDelta(*args, **kwargs):
27fb7603
RD		 4586 """
4587 GetWheelDelta(self) -> int
4588
4589 Get wheel delta, normally 120. This is the threshold for action to be
4590 taken, and one such action (for example, scrolling one increment)
4591 should occur for each delta.
4592 """
d55e5bfc
RD		 4593 return _core_.MouseEvent_GetWheelDelta(*args, **kwargs)
4594
4595 def GetLinesPerAction(*args, **kwargs):
27fb7603
RD		 4596 """
4597 GetLinesPerAction(self) -> int
4598
4599 Returns the configured number of lines (or whatever) to be scrolled
4600 per wheel action. Defaults to three.
4601 """
d55e5bfc
RD		 4602 return _core_.MouseEvent_GetLinesPerAction(*args, **kwargs)
4603
4604 def IsPageScroll(*args, **kwargs):
27fb7603
RD		 4605 """
4606 IsPageScroll(self) -> bool
4607
4608 Returns true if the system has been setup to do page scrolling with
4609 the mouse wheel instead of line scrolling.
4610 """
d55e5bfc
RD		 4611 return _core_.MouseEvent_IsPageScroll(*args, **kwargs)
4612
4613 m_x = property(_core_.MouseEvent_m_x_get, _core_.MouseEvent_m_x_set)
4614 m_y = property(_core_.MouseEvent_m_y_get, _core_.MouseEvent_m_y_set)
4615 m_leftDown = property(_core_.MouseEvent_m_leftDown_get, _core_.MouseEvent_m_leftDown_set)
4616 m_middleDown = property(_core_.MouseEvent_m_middleDown_get, _core_.MouseEvent_m_middleDown_set)
4617 m_rightDown = property(_core_.MouseEvent_m_rightDown_get, _core_.MouseEvent_m_rightDown_set)
4618 m_controlDown = property(_core_.MouseEvent_m_controlDown_get, _core_.MouseEvent_m_controlDown_set)
4619 m_shiftDown = property(_core_.MouseEvent_m_shiftDown_get, _core_.MouseEvent_m_shiftDown_set)
4620 m_altDown = property(_core_.MouseEvent_m_altDown_get, _core_.MouseEvent_m_altDown_set)
4621 m_metaDown = property(_core_.MouseEvent_m_metaDown_get, _core_.MouseEvent_m_metaDown_set)
4622 m_wheelRotation = property(_core_.MouseEvent_m_wheelRotation_get, _core_.MouseEvent_m_wheelRotation_set)
4623 m_wheelDelta = property(_core_.MouseEvent_m_wheelDelta_get, _core_.MouseEvent_m_wheelDelta_set)
4624 m_linesPerAction = property(_core_.MouseEvent_m_linesPerAction_get, _core_.MouseEvent_m_linesPerAction_set)
554f62e9
RD		 4625MouseEvent_swigregister = _core_.MouseEvent_swigregister
4626MouseEvent_swigregister(MouseEvent)
d55e5bfc
RD		 4627
4628#---------------------------------------------------------------------------
4629
4630class SetCursorEvent(Event):
5ba5649b
RD		 4631 """
4632 A SetCursorEvent is generated when the mouse cursor is about to be set
4633 as a result of mouse motion. This event gives the application the
4634 chance to perform specific mouse cursor processing based on the
4635 current position of the mouse within the window. Use the `SetCursor`
4636 method to specify the cursor you want to be displayed.
4637 """
554f62e9
RD		 4638 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4639 __repr__ = _swig_repr
4640 def __init__(self, *args, **kwargs):
5ba5649b
RD		 4641 """
4642 __init__(self, int x=0, int y=0) -> SetCursorEvent
4643
4644 Construct a new `wx.SetCursorEvent`.
4645 """
554f62e9 4646 _core_.SetCursorEvent_swiginit(self,_core_.new_SetCursorEvent(*args, **kwargs))
d55e5bfc 4647 def GetX(*args, **kwargs):
5ba5649b
RD		 4648 """
4649 GetX(self) -> int
4650
4651 Returns the X coordinate of the mouse in client coordinates.
4652 """
d55e5bfc
RD		 4653 return _core_.SetCursorEvent_GetX(*args, **kwargs)
4654
4655 def GetY(*args, **kwargs):
5ba5649b
RD		 4656 """
4657 GetY(self) -> int
4658
4659 Returns the Y coordinate of the mouse in client coordinates.
4660 """
d55e5bfc
RD		 4661 return _core_.SetCursorEvent_GetY(*args, **kwargs)
4662
4663 def SetCursor(*args, **kwargs):
5ba5649b
RD		 4664 """
4665 SetCursor(self, Cursor cursor)
4666
4667 Sets the cursor associated with this event.
4668 """
d55e5bfc
RD		 4669 return _core_.SetCursorEvent_SetCursor(*args, **kwargs)
4670
4671 def GetCursor(*args, **kwargs):
5ba5649b
RD		 4672 """
4673 GetCursor(self) -> Cursor
4674
4675 Returns a reference to the cursor specified by this event.
4676 """
d55e5bfc
RD		 4677 return _core_.SetCursorEvent_GetCursor(*args, **kwargs)
4678
4679 def HasCursor(*args, **kwargs):
5ba5649b
RD		 4680 """
4681 HasCursor(self) -> bool
4682
4683 Returns true if the cursor specified by this event is a valid cursor.
4684 """
d55e5bfc
RD		 4685 return _core_.SetCursorEvent_HasCursor(*args, **kwargs)
4686
554f62e9
RD		 4687SetCursorEvent_swigregister = _core_.SetCursorEvent_swigregister
4688SetCursorEvent_swigregister(SetCursorEvent)
d55e5bfc
RD		 4689
4690#---------------------------------------------------------------------------
4691
4692class KeyEvent(Event):
5ba5649b
RD		 4693 """
4694 This event class contains information about keypress and character
4695 events. These events are only sent to the widget that currently has
4696 the keyboard focus.
4697
4698 Notice that there are three different kinds of keyboard events in
4699 wxWidgets: key down and up events and char events. The difference
4700 between the first two is clear - the first corresponds to a key press
4701 and the second to a key release - otherwise they are identical. Just
4702 note that if the key is maintained in a pressed state you will
4703 typically get a lot of (automatically generated) down events but only
4704 one up so it is wrong to assume that there is one up event
4705 corresponding to each down one.
4706
4707 Both key events provide untranslated key codes while the char event
4708 carries the translated one. The untranslated code for alphanumeric
4709 keys is always an upper case value. For the other keys it is one of
4710 WXK_XXX values from the keycodes table. The translated key is, in
4711 general, the character the user expects to appear as the result of the
4712 key combination when typing the text into a text entry zone, for
4713 example.
4714
4715 A few examples to clarify this (all assume that CAPS LOCK is unpressed
4716 and the standard US keyboard): when the 'A' key is pressed, the key
4717 down event key code is equal to ASCII A == 65. But the char event key
4718 code is ASCII a == 97. On the other hand, if you press both SHIFT and
4719 'A' keys simultaneously , the key code in key down event will still be
4720 just 'A' while the char event key code parameter will now be 'A' as
4721 well.
4722
4723 Although in this simple case it is clear that the correct key code
4724 could be found in the key down event handler by checking the value
4725 returned by `ShiftDown`, in general you should use EVT_CHAR for this
4726 as for non alphanumeric keys or non-US keyboard layouts the
4727 translation is keyboard-layout dependent and can only be done properly
4728 by the system itself.
4729
4730 Another kind of translation is done when the control key is pressed:
4731 for example, for CTRL-A key press the key down event still carries the
4732 same key code 'A' as usual but the char event will have key code of 1,
4733 the ASCII value of this key combination.
4734
4735 You may discover how the other keys on your system behave
4736 interactively by running the KeyEvents sample in the wxPython demo and
4737 pressing some keys while the blue box at the top has the keyboard
4738 focus.
4739
4740 **Note**: If a key down event is caught and the event handler does not
4741 call event.Skip() then the coresponding char event will not
4742 happen. This is by design and enables the programs that handle both
4743 types of events to be a bit simpler.
4744
4745 **Note for Windows programmers**: The key and char events in wxWidgets
4746 are similar to but slightly different from Windows WM_KEYDOWN and
4747 WM_CHAR events. In particular, Alt-x combination will generate a char
4748 event in wxWidgets (unless it is used as an accelerator).
4749
4750 **Tip**: be sure to call event.Skip() for events that you don't
4751 process in key event function, otherwise menu shortcuts may cease to
4752 work under Windows.
4753
4754 """
554f62e9
RD		 4755 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4756 __repr__ = _swig_repr
4757 def __init__(self, *args, **kwargs):
5ba5649b
RD		 4758 """
4759 __init__(self, wxEventType eventType=wxEVT_NULL) -> KeyEvent
4760
4761 Construct a new `wx.KeyEvent`. Valid event types are:
4762 *
4763 """
554f62e9 4764 _core_.KeyEvent_swiginit(self,_core_.new_KeyEvent(*args, **kwargs))
b1fcee84
RD		 4765 def GetModifiers(*args, **kwargs):
4766 """
4767 GetModifiers(self) -> int
4768
4769 Returns a bitmask of the current modifier settings. Can be used to
4770 check if the key event has exactly the given modifiers without having
4771 to explicitly check that the other modifiers are not down. For
4772 example::
4773
4774 if event.GetModifers() == wx.MOD_CONTROL:
4775 DoSomething()
4776
4777 """
4778 return _core_.KeyEvent_GetModifiers(*args, **kwargs)
4779
d55e5bfc 4780 def ControlDown(*args, **kwargs):
5ba5649b
RD		 4781 """
4782 ControlDown(self) -> bool
4783
4784 Returns ``True`` if the Control key was down at the time of the event.
4785 """
d55e5bfc
RD		 4786 return _core_.KeyEvent_ControlDown(*args, **kwargs)
4787
4788 def MetaDown(*args, **kwargs):
5ba5649b
RD		 4789 """
4790 MetaDown(self) -> bool
4791
4792 Returns ``True`` if the Meta key was down at the time of the event.
4793 """
d55e5bfc
RD		 4794 return _core_.KeyEvent_MetaDown(*args, **kwargs)
4795
4796 def AltDown(*args, **kwargs):
5ba5649b
RD		 4797 """
4798 AltDown(self) -> bool
4799
4800 Returns ``True`` if the Alt key was down at the time of the event.
4801 """
d55e5bfc
RD		 4802 return _core_.KeyEvent_AltDown(*args, **kwargs)
4803
4804 def ShiftDown(*args, **kwargs):
5ba5649b
RD		 4805 """
4806 ShiftDown(self) -> bool
4807
4808 Returns ``True`` if the Shift key was down at the time of the event.
4809 """
d55e5bfc
RD		 4810 return _core_.KeyEvent_ShiftDown(*args, **kwargs)
4811
412d302d
RD		 4812 def CmdDown(*args, **kwargs):
4813 """
4814 CmdDown(self) -> bool
4815
4816 "Cmd" is a pseudo key which is the same as Control for PC and Unix
4817 platforms but the special "Apple" (a.k.a as "Command") key on
5ba5649b 4818 Macs. It makes often sense to use it instead of, say, `ControlDown`
412d302d
RD		 4819 because Cmd key is used for the same thing under Mac as Ctrl
4820 elsewhere. The Ctrl still exists, it's just not used for this
4821 purpose. So for non-Mac platforms this is the same as `ControlDown`
4822 and Macs this is the same as `MetaDown`.
4823 """
4824 return _core_.KeyEvent_CmdDown(*args, **kwargs)
4825
d55e5bfc 4826 def HasModifiers(*args, **kwargs):
5ba5649b
RD		 4827 """
4828 HasModifiers(self) -> bool
4829
4830 Returns true if either CTRL or ALT keys was down at the time of the
4831 key event. Note that this function does not take into account neither
4832 SHIFT nor META key states (the reason for ignoring the latter is that
4833 it is common for NUMLOCK key to be configured as META under X but the
4834 key presses even while NUMLOCK is on should be still processed
4835 normally).
4836 """
d55e5bfc
RD		 4837 return _core_.KeyEvent_HasModifiers(*args, **kwargs)
4838
4839 def GetKeyCode(*args, **kwargs):
5ba5649b
RD		 4840 """
4841 GetKeyCode(self) -> int
4842
4843 Returns the virtual key code. ASCII events return normal ASCII values,
4844 while non-ASCII events return values such as WXK_LEFT for the left
4845 cursor key. See `wx.KeyEvent` for a full list of the virtual key
4846 codes.
4847
4848 Note that in Unicode build, the returned value is meaningful only if
4849 the user entered a character that can be represented in current
4850 locale's default charset. You can obtain the corresponding Unicode
4851 character using `GetUnicodeKey`.
4852 """
d55e5bfc
RD		 4853 return _core_.KeyEvent_GetKeyCode(*args, **kwargs)
4854
4855 KeyCode = GetKeyCode
19272049 4856 def GetUnicodeKey(*args, **kwargs):
5ba5649b
RD		 4857 """
4858 GetUnicodeKey(self) -> int
4859
4860 Returns the Unicode character corresponding to this key event. This
4861 function is only meaningfule in a Unicode build of wxPython.
4862 """
19272049 4863 return _core_.KeyEvent_GetUnicodeKey(*args, **kwargs)
d55e5bfc 4864
19272049 4865 GetUniChar = GetUnicodeKey
d55e5bfc 4866 def GetRawKeyCode(*args, **kwargs):
5ba5649b
RD		 4867 """
4868 GetRawKeyCode(self) -> unsigned int
4869
4870 Returns the raw key code for this event. This is a platform-dependent
4871 scan code which should only be used in advanced
4872 applications. Currently the raw key codes are not supported by all
4873 ports.
4874 """
d55e5bfc
RD		 4875 return _core_.KeyEvent_GetRawKeyCode(*args, **kwargs)
4876
4877 def GetRawKeyFlags(*args, **kwargs):
5ba5649b
RD		 4878 """
4879 GetRawKeyFlags(self) -> unsigned int
4880
4881 Returns the low level key flags for this event. The flags are
4882 platform-dependent and should only be used in advanced applications.
4883 Currently the raw key flags are not supported by all ports.
4884 """
d55e5bfc
RD		 4885 return _core_.KeyEvent_GetRawKeyFlags(*args, **kwargs)
4886
4887 def GetPosition(*args, **kwargs):
4888 """
4889 GetPosition(self) -> Point
4890
5ba5649b 4891 Find the position of the event, if applicable.
d55e5bfc
RD		 4892 """
4893 return _core_.KeyEvent_GetPosition(*args, **kwargs)
4894
4895 def GetPositionTuple(*args, **kwargs):
4896 """
4897 GetPositionTuple() -> (x,y)
4898
5ba5649b 4899 Find the position of the event, if applicable.
d55e5bfc
RD		 4900 """
4901 return _core_.KeyEvent_GetPositionTuple(*args, **kwargs)
4902
4903 def GetX(*args, **kwargs):
5ba5649b
RD		 4904 """
4905 GetX(self) -> int
4906
4907 Returns the X position (in client coordinates) of the event, if
4908 applicable.
4909 """
d55e5bfc
RD		 4910 return _core_.KeyEvent_GetX(*args, **kwargs)
4911
4912 def GetY(*args, **kwargs):
5ba5649b
RD		 4913 """
4914 GetY(self) -> int
4915
4916 Returns the Y position (in client coordinates) of the event, if
4917 applicable.
4918 """
d55e5bfc
RD		 4919 return _core_.KeyEvent_GetY(*args, **kwargs)
4920
4921 m_x = property(_core_.KeyEvent_m_x_get, _core_.KeyEvent_m_x_set)
4922 m_y = property(_core_.KeyEvent_m_y_get, _core_.KeyEvent_m_y_set)
4923 m_keyCode = property(_core_.KeyEvent_m_keyCode_get, _core_.KeyEvent_m_keyCode_set)
4924 m_controlDown = property(_core_.KeyEvent_m_controlDown_get, _core_.KeyEvent_m_controlDown_set)
4925 m_shiftDown = property(_core_.KeyEvent_m_shiftDown_get, _core_.KeyEvent_m_shiftDown_set)
4926 m_altDown = property(_core_.KeyEvent_m_altDown_get, _core_.KeyEvent_m_altDown_set)
4927 m_metaDown = property(_core_.KeyEvent_m_metaDown_get, _core_.KeyEvent_m_metaDown_set)
4928 m_scanCode = property(_core_.KeyEvent_m_scanCode_get, _core_.KeyEvent_m_scanCode_set)
4929 m_rawCode = property(_core_.KeyEvent_m_rawCode_get, _core_.KeyEvent_m_rawCode_set)
4930 m_rawFlags = property(_core_.KeyEvent_m_rawFlags_get, _core_.KeyEvent_m_rawFlags_set)
554f62e9
RD		 4931KeyEvent_swigregister = _core_.KeyEvent_swigregister
4932KeyEvent_swigregister(KeyEvent)
d55e5bfc
RD		 4933
4934#---------------------------------------------------------------------------
4935
4936class SizeEvent(Event):
5ba5649b
RD		 4937 """
4938 A size event holds information about size change events. The EVT_SIZE
4939 handler function will be called when the window it is bound to has
4940 been resized.
4941
4942 Note that the size passed is of the whole window: call
4943 `wx.Window.GetClientSize` for the area which may be used by the
4944 application.
4945
4946 When a window is resized, usually only a small part of the window is
4947 damaged and and that area is all that is in the update region for the
4948 next paint event. However, if your drawing depends on the size of the
4949 window, you may need to clear the DC explicitly and repaint the whole
4950 window. In which case, you may need to call `wx.Window.Refresh` to
4951 invalidate the entire window.
4952
4953 """
554f62e9
RD		 4954 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4955 __repr__ = _swig_repr
4956 def __init__(self, *args, **kwargs):
5ba5649b
RD		 4957 """
4958 __init__(self, Size sz=DefaultSize, int winid=0) -> SizeEvent
4959
4960 Construct a new ``wx.SizeEvent``.
4961 """
554f62e9 4962 _core_.SizeEvent_swiginit(self,_core_.new_SizeEvent(*args, **kwargs))
d55e5bfc 4963 def GetSize(*args, **kwargs):
5ba5649b
RD		 4964 """
4965 GetSize(self) -> Size
4966
4967 Returns the entire size of the window generating the size change
4968 event.
4969 """
d55e5bfc
RD		 4970 return _core_.SizeEvent_GetSize(*args, **kwargs)
4971
4972 def GetRect(*args, **kwargs):
4973 """GetRect(self) -> Rect"""
4974 return _core_.SizeEvent_GetRect(*args, **kwargs)
4975
4976 def SetRect(*args, **kwargs):
4977 """SetRect(self, Rect rect)"""
4978 return _core_.SizeEvent_SetRect(*args, **kwargs)
4979
4980 def SetSize(*args, **kwargs):
4981 """SetSize(self, Size size)"""
4982 return _core_.SizeEvent_SetSize(*args, **kwargs)
4983
4984 m_size = property(_core_.SizeEvent_m_size_get, _core_.SizeEvent_m_size_set)
4985 m_rect = property(_core_.SizeEvent_m_rect_get, _core_.SizeEvent_m_rect_set)
554f62e9
RD		 4986SizeEvent_swigregister = _core_.SizeEvent_swigregister
4987SizeEvent_swigregister(SizeEvent)
d55e5bfc
RD		 4988
4989#---------------------------------------------------------------------------
4990
4991class MoveEvent(Event):
5ba5649b
RD		 4992 """
4993 This event object is sent for EVT_MOVE event bindings when a window is
4994 moved to a new position.
4995 """
554f62e9
RD		 4996 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4997 __repr__ = _swig_repr
4998 def __init__(self, *args, **kwargs):
5ba5649b
RD		 4999 """
5000 __init__(self, Point pos=DefaultPosition, int winid=0) -> MoveEvent
5001
5002 Constructor.
5003 """
554f62e9 5004 _core_.MoveEvent_swiginit(self,_core_.new_MoveEvent(*args, **kwargs))
d55e5bfc 5005 def GetPosition(*args, **kwargs):
5ba5649b
RD		 5006 """
5007 GetPosition(self) -> Point
5008
5009 Returns the position of the window generating the move change event.
5010 """
d55e5bfc
RD		 5011 return _core_.MoveEvent_GetPosition(*args, **kwargs)
5012
5013 def GetRect(*args, **kwargs):
5014 """GetRect(self) -> Rect"""
5015 return _core_.MoveEvent_GetRect(*args, **kwargs)
5016
5017 def SetRect(*args, **kwargs):
5018 """SetRect(self, Rect rect)"""
5019 return _core_.MoveEvent_SetRect(*args, **kwargs)
5020
5021 def SetPosition(*args, **kwargs):
5022 """SetPosition(self, Point pos)"""
5023 return _core_.MoveEvent_SetPosition(*args, **kwargs)
5024
fef4c27a
RD		 5025 m_pos = property(GetPosition, SetPosition)
5026 m_rect = property(GetRect, SetRect)
5027
554f62e9
RD		 5028MoveEvent_swigregister = _core_.MoveEvent_swigregister
5029MoveEvent_swigregister(MoveEvent)
d55e5bfc
RD		 5030
5031#---------------------------------------------------------------------------
5032
5033class PaintEvent(Event):
5ba5649b
RD		 5034 """
5035 A paint event is sent when a window's contents needs to be repainted.
5036 Note that in an EVT_PAINT handler the application must *always* create
5037 a `wx.PaintDC` object, even if you do not use it. Otherwise MS
5038 Windows assumes that the window has not been painted yet and will send
5039 the event again, causing endless refreshes.
5040
5041 You can optimize painting by retrieving the rectangles that have been
5042 damaged using `wx.Window.GetUpdateRegion` and/or `wx.RegionIterator`,
5043 and only repainting these rectangles. The rectangles are in terms of
5044 the client area, and are unscrolled, so you will need to do some
5045 calculations using the current view position to obtain logical,
5046 scrolled units.
5047
5048 """
554f62e9
RD		 5049 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5050 __repr__ = _swig_repr
5051 def __init__(self, *args, **kwargs):
d55e5bfc 5052 """__init__(self, int Id=0) -> PaintEvent"""
554f62e9
RD		 5053 _core_.PaintEvent_swiginit(self,_core_.new_PaintEvent(*args, **kwargs))
5054PaintEvent_swigregister = _core_.PaintEvent_swigregister
5055PaintEvent_swigregister(PaintEvent)
d55e5bfc
RD		 5056
5057class NcPaintEvent(Event):
093d3ff1 5058 """Proxy of C++ NcPaintEvent class"""
554f62e9
RD		 5059 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5060 __repr__ = _swig_repr
5061 def __init__(self, *args, **kwargs):
d55e5bfc 5062 """__init__(self, int winid=0) -> NcPaintEvent"""
554f62e9
RD		 5063 _core_.NcPaintEvent_swiginit(self,_core_.new_NcPaintEvent(*args, **kwargs))
5064NcPaintEvent_swigregister = _core_.NcPaintEvent_swigregister
5065NcPaintEvent_swigregister(NcPaintEvent)
d55e5bfc
RD		 5066
5067#---------------------------------------------------------------------------
5068
5069class EraseEvent(Event):
5ba5649b
RD		 5070 """
5071 An erase event is sent whenever the background of a window needs to be
5072 repainted. To intercept this event use the EVT_ERASE_BACKGROUND event
5073 binder. On some platforms, such as GTK+, this event is simulated
5074 (simply generated just before the paint event) and may cause flicker.
5075
5076 To paint a custom background use the `GetDC` method and use the returned
5077 device context if it is not ``None``, otherwise create a temporary
5078 `wx.ClientDC` and draw on that.
5079
5080 """
554f62e9
RD		 5081 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5082 __repr__ = _swig_repr
5083 def __init__(self, *args, **kwargs):
5ba5649b
RD		 5084 """
5085 __init__(self, int Id=0, DC dc=None) -> EraseEvent
5086
5087 Constructor
5088 """
554f62e9 5089 _core_.EraseEvent_swiginit(self,_core_.new_EraseEvent(*args, **kwargs))
d55e5bfc 5090 def GetDC(*args, **kwargs):
5ba5649b
RD		 5091 """
5092 GetDC(self) -> DC
5093
5094 Returns the device context the event handler should draw upon. If
5095 ``None`` is returned then create a temporary `wx.ClientDC` and use
5096 that instead.
5097 """
d55e5bfc
RD		 5098 return _core_.EraseEvent_GetDC(*args, **kwargs)
5099
554f62e9
RD		 5100EraseEvent_swigregister = _core_.EraseEvent_swigregister
5101EraseEvent_swigregister(EraseEvent)
d55e5bfc
RD		 5102
5103#---------------------------------------------------------------------------
5104
5105class FocusEvent(Event):
5ba5649b
RD		 5106 """
5107 A focus event is sent when a window's focus changes. The window losing
5108 focus receives an EVT_KILL_FOCUS event while the window gaining it
5109 gets an EVT_SET_FOCUS event.
5110
5111 Notice that the set focus event happens both when the user gives focus
5112 to the window (whether using the mouse or keyboard) and when it is
5113 done from the program itself using `wx.Window.SetFocus`.
5114
5115 """
554f62e9
RD		 5116 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5117 __repr__ = _swig_repr
5118 def __init__(self, *args, **kwargs):
5ba5649b
RD		 5119 """
5120 __init__(self, wxEventType type=wxEVT_NULL, int winid=0) -> FocusEvent
5121
5122 Constructor
5123 """
554f62e9 5124 _core_.FocusEvent_swiginit(self,_core_.new_FocusEvent(*args, **kwargs))
d55e5bfc 5125 def GetWindow(*args, **kwargs):
5ba5649b
RD		 5126 """
5127 GetWindow(self) -> Window
5128
5129 Returns the other window associated with this event, that is the
5130 window which had the focus before for the EVT_SET_FOCUS event and the
5131 window which is going to receive focus for the wxEVT_KILL_FOCUS event.
5132
5133 Warning: the window returned may be None!
5134 """
d55e5bfc
RD		 5135 return _core_.FocusEvent_GetWindow(*args, **kwargs)
5136
5137 def SetWindow(*args, **kwargs):
5138 """SetWindow(self, Window win)"""
5139 return _core_.FocusEvent_SetWindow(*args, **kwargs)
5140
554f62e9
RD		 5141FocusEvent_swigregister = _core_.FocusEvent_swigregister
5142FocusEvent_swigregister(FocusEvent)
d55e5bfc
RD		 5143
5144#---------------------------------------------------------------------------
5145
5146class ChildFocusEvent(CommandEvent):
5ba5649b
RD		 5147 """
5148 wx.ChildFocusEvent notifies the parent that a child has received the
5149 focus. Unlike `wx.FocusEvent` it is propagated up the window
5150 heirarchy.
5151 """
554f62e9
RD		 5152 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5153 __repr__ = _swig_repr
5154 def __init__(self, *args, **kwargs):
5ba5649b
RD		 5155 """
5156 __init__(self, Window win=None) -> ChildFocusEvent
5157
5158 Constructor
5159 """
554f62e9 5160 _core_.ChildFocusEvent_swiginit(self,_core_.new_ChildFocusEvent(*args, **kwargs))
d55e5bfc 5161 def GetWindow(*args, **kwargs):
5ba5649b
RD		 5162 """
5163 GetWindow(self) -> Window
5164
5165 The window which has just received the focus.
5166 """
d55e5bfc
RD		 5167 return _core_.ChildFocusEvent_GetWindow(*args, **kwargs)
5168
554f62e9
RD		 5169ChildFocusEvent_swigregister = _core_.ChildFocusEvent_swigregister
5170ChildFocusEvent_swigregister(ChildFocusEvent)
d55e5bfc
RD		 5171
5172#---------------------------------------------------------------------------
5173
5174class ActivateEvent(Event):
5ba5649b
RD		 5175 """
5176 An activate event is sent when a top-level window or the entire
5177 application is being activated or deactivated.
5178
5179 A top-level window (a dialog or frame) receives an activate event when
5180 is being activated or deactivated. This is indicated visually by the
5181 title bar changing colour, and a subwindow gaining the keyboard focus.
5182 An application is activated or deactivated when one of its frames
5183 becomes activated, or a frame becomes inactivate resulting in all
5184 application frames being inactive.
5185
5186 Please note that usually you should call event.Skip() in your handlers
5187 for these events so the default handlers will still be called, as not
5188 doing so can result in strange effects.
5189
5190 """
554f62e9
RD		 5191 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5192 __repr__ = _swig_repr
5193 def __init__(self, *args, **kwargs):
5ba5649b
RD		 5194 """
5195 __init__(self, wxEventType type=wxEVT_NULL, bool active=True, int Id=0) -> ActivateEvent
5196
5197 Constructor
5198 """
554f62e9 5199 _core_.ActivateEvent_swiginit(self,_core_.new_ActivateEvent(*args, **kwargs))
d55e5bfc 5200 def GetActive(*args, **kwargs):
5ba5649b
RD		 5201 """
5202 GetActive(self) -> bool
5203
5204 Returns true if the application or window is being activated, false
5205 otherwise.
5206 """
d55e5bfc
RD		 5207 return _core_.ActivateEvent_GetActive(*args, **kwargs)
5208
554f62e9
RD		 5209ActivateEvent_swigregister = _core_.ActivateEvent_swigregister
5210ActivateEvent_swigregister(ActivateEvent)
d55e5bfc
RD		 5211
5212#---------------------------------------------------------------------------
5213
5214class InitDialogEvent(Event):
5ba5649b
RD		 5215 """
5216 A wx.InitDialogEvent is sent as a dialog is being initialised, or for
5217 any window when `wx.Window.InitDialog` is called. Handlers for this
5218 event can transfer data to the window, or anything else that should be
5219 done before the user begins editing the form. The default handler
5220 calls `wx.Window.TransferDataToWindow`.
5221 """
554f62e9
RD		 5222 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5223 __repr__ = _swig_repr
5224 def __init__(self, *args, **kwargs):
5ba5649b
RD		 5225 """
5226 __init__(self, int Id=0) -> InitDialogEvent
5227
5228 Constructor
5229 """
554f62e9
RD		 5230 _core_.InitDialogEvent_swiginit(self,_core_.new_InitDialogEvent(*args, **kwargs))
5231InitDialogEvent_swigregister = _core_.InitDialogEvent_swigregister
5232InitDialogEvent_swigregister(InitDialogEvent)
d55e5bfc
RD		 5233
5234#---------------------------------------------------------------------------
5235
5236class MenuEvent(Event):
5ba5649b
RD		 5237 """
5238 This class is used for a variety of menu-related events. Note that
5239 these do not include menu command events, which are handled by sending
5240 `wx.CommandEvent` objects.
5241
5242 The default handler for wx.EVT_MENU_HIGHLIGHT displays menu item help
5243 text in the first field of the status bar.
5244 """
554f62e9
RD		 5245 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5246 __repr__ = _swig_repr
5247 def __init__(self, *args, **kwargs):
5ba5649b
RD		 5248 """
5249 __init__(self, wxEventType type=wxEVT_NULL, int winid=0, Menu menu=None) -> MenuEvent
5250
5251 Constructor
5252 """
554f62e9 5253 _core_.MenuEvent_swiginit(self,_core_.new_MenuEvent(*args, **kwargs))
d55e5bfc 5254 def GetMenuId(*args, **kwargs):
5ba5649b
RD		 5255 """
5256 GetMenuId(self) -> int
5257
5258 Returns the menu identifier associated with the event. This method
5259 should be only used with the HIGHLIGHT events.
5260 """
d55e5bfc
RD		 5261 return _core_.MenuEvent_GetMenuId(*args, **kwargs)
5262
5263 def IsPopup(*args, **kwargs):
5ba5649b
RD		 5264 """
5265 IsPopup(self) -> bool
5266
5267 Returns ``True`` if the menu which is being opened or closed is a
5268 popup menu, ``False`` if it is a normal one. This method should only
5269 be used with the OPEN and CLOSE events.
5270 """
d55e5bfc
RD		 5271 return _core_.MenuEvent_IsPopup(*args, **kwargs)
5272
5273 def GetMenu(*args, **kwargs):
5ba5649b
RD		 5274 """
5275 GetMenu(self) -> Menu
5276
5277 Returns the menu which is being opened or closed. This method should
5278 only be used with the OPEN and CLOSE events.
5279 """
d55e5bfc
RD		 5280 return _core_.MenuEvent_GetMenu(*args, **kwargs)
5281
554f62e9
RD		 5282MenuEvent_swigregister = _core_.MenuEvent_swigregister
5283MenuEvent_swigregister(MenuEvent)
d55e5bfc
RD		 5284
5285#---------------------------------------------------------------------------
5286
5287class CloseEvent(Event):
5ba5649b
RD		 5288 """
5289 This event class contains information about window and session close
5290 events.
5291
5292 The handler function for EVT_CLOSE is called when the user has tried
5293 to close a a frame or dialog box using the window manager controls or
5294 the system menu. It can also be invoked by the application itself
5295 programmatically, for example by calling the `wx.Window.Close`
5296 function.
5297
5298 You should check whether the application is forcing the deletion of
5299 the window using `CanVeto`. If it returns ``False``, you must destroy
5300 the window using `wx.Window.Destroy`. If the return value is ``True``,
5301 it is up to you whether you respond by destroying the window or not.
5302 For example you may wish to display a message dialog prompting to save
5303 files or to cancel the close.
5304
5305 If you don't destroy the window, you should call `Veto` to let the
5306 calling code know that you did not destroy the window. This allows the
5307 `wx.Window.Close` function to return ``True`` or ``False`` depending
5308 on whether the close instruction was honored or not.
5309 """
554f62e9
RD		 5310 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5311 __repr__ = _swig_repr
5312 def __init__(self, *args, **kwargs):
5ba5649b
RD		 5313 """
5314 __init__(self, wxEventType type=wxEVT_NULL, int winid=0) -> CloseEvent
5315
5316 Constructor.
5317 """
554f62e9 5318 _core_.CloseEvent_swiginit(self,_core_.new_CloseEvent(*args, **kwargs))
d55e5bfc 5319 def SetLoggingOff(*args, **kwargs):
5ba5649b
RD		 5320 """
5321 SetLoggingOff(self, bool logOff)
5322
5323 Sets the 'logging off' flag.
5324 """
d55e5bfc
RD		 5325 return _core_.CloseEvent_SetLoggingOff(*args, **kwargs)
5326
5327 def GetLoggingOff(*args, **kwargs):
5ba5649b
RD		 5328 """
5329 GetLoggingOff(self) -> bool
5330
034e3677
RD		 5331 Returns ``True`` if the user is logging off or ``False`` if the
5332 system is shutting down. This method can only be called for end
5333 session and query end session events, it doesn't make sense for close
5334 window event.
5ba5649b 5335 """
d55e5bfc
RD		 5336 return _core_.CloseEvent_GetLoggingOff(*args, **kwargs)
5337
5338 def Veto(*args, **kwargs):
5ba5649b
RD		 5339 """
5340 Veto(self, bool veto=True)
5341
5342 Call this from your event handler to veto a system shutdown or to
5343 signal to the calling application that a window close did not happen.
5344
5345 You can only veto a shutdown or close if `CanVeto` returns true.
5346 """
d55e5bfc
RD		 5347 return _core_.CloseEvent_Veto(*args, **kwargs)
5348
5ba5649b
RD		 5349 def GetVeto(*args, **kwargs):
5350 """GetVeto(self) -> bool"""
5351 return _core_.CloseEvent_GetVeto(*args, **kwargs)
5352
d55e5bfc 5353 def SetCanVeto(*args, **kwargs):
5ba5649b
RD		 5354 """
5355 SetCanVeto(self, bool canVeto)
5356
5357 Sets the 'can veto' flag.
5358 """
d55e5bfc
RD		 5359 return _core_.CloseEvent_SetCanVeto(*args, **kwargs)
5360
5361 def CanVeto(*args, **kwargs):
5ba5649b
RD		 5362 """
5363 CanVeto(self) -> bool
d55e5bfc 5364
5ba5649b
RD		 5365 Returns true if you can veto a system shutdown or a window close
5366 event. Vetoing a window close event is not possible if the calling
5367 code wishes to force the application to exit, and so this function
5368 must be called to check this.
5369 """
5370 return _core_.CloseEvent_CanVeto(*args, **kwargs)
d55e5bfc 5371
554f62e9
RD		 5372CloseEvent_swigregister = _core_.CloseEvent_swigregister
5373CloseEvent_swigregister(CloseEvent)
d55e5bfc
RD		 5374
5375#---------------------------------------------------------------------------
5376
5377class ShowEvent(Event):
5ba5649b 5378 """An EVT_SHOW event is sent when a window is shown or hidden."""
554f62e9
RD		 5379 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5380 __repr__ = _swig_repr
5381 def __init__(self, *args, **kwargs):
5ba5649b
RD		 5382 """
5383 __init__(self, int winid=0, bool show=False) -> ShowEvent
5384
5385 An EVT_SHOW event is sent when a window is shown or hidden.
5386 """
554f62e9 5387 _core_.ShowEvent_swiginit(self,_core_.new_ShowEvent(*args, **kwargs))
d55e5bfc
RD		 5388 def SetShow(*args, **kwargs):
5389 """SetShow(self, bool show)"""
5390 return _core_.ShowEvent_SetShow(*args, **kwargs)
5391
5392 def GetShow(*args, **kwargs):
5393 """GetShow(self) -> bool"""
5394 return _core_.ShowEvent_GetShow(*args, **kwargs)
5395
554f62e9
RD		 5396ShowEvent_swigregister = _core_.ShowEvent_swigregister
5397ShowEvent_swigregister(ShowEvent)
d55e5bfc
RD		 5398
5399#---------------------------------------------------------------------------
5400
5401class IconizeEvent(Event):
5ba5649b
RD		 5402 """
5403 An EVT_ICONIZE event is sent when a frame is iconized (minimized) or
5404 restored.
5405 """
554f62e9
RD		 5406 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5407 __repr__ = _swig_repr
5408 def __init__(self, *args, **kwargs):
5ba5649b
RD		 5409 """
5410 __init__(self, int id=0, bool iconized=True) -> IconizeEvent
5411
5412 An EVT_ICONIZE event is sent when a frame is iconized (minimized) or
5413 restored.
5414 """
554f62e9 5415 _core_.IconizeEvent_swiginit(self,_core_.new_IconizeEvent(*args, **kwargs))
d55e5bfc 5416 def Iconized(*args, **kwargs):
5ba5649b
RD		 5417 """
5418 Iconized(self) -> bool
5419
5420 Returns ``True`` if the frame has been iconized, ``False`` if it has
5421 been restored.
5422 """
d55e5bfc
RD		 5423 return _core_.IconizeEvent_Iconized(*args, **kwargs)
5424
554f62e9
RD		 5425IconizeEvent_swigregister = _core_.IconizeEvent_swigregister
5426IconizeEvent_swigregister(IconizeEvent)
d55e5bfc
RD		 5427
5428#---------------------------------------------------------------------------
5429
5430class MaximizeEvent(Event):
5ba5649b 5431 """An EVT_MAXIMIZE event is sent when a frame is maximized or restored."""
554f62e9
RD		 5432 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5433 __repr__ = _swig_repr
5434 def __init__(self, *args, **kwargs):
5ba5649b
RD		 5435 """
5436 __init__(self, int id=0) -> MaximizeEvent
5437
5438 An EVT_MAXIMIZE event is sent when a frame is maximized or restored.
5439 """
554f62e9
RD		 5440 _core_.MaximizeEvent_swiginit(self,_core_.new_MaximizeEvent(*args, **kwargs))
5441MaximizeEvent_swigregister = _core_.MaximizeEvent_swigregister
5442MaximizeEvent_swigregister(MaximizeEvent)
d55e5bfc
RD		 5443
5444#---------------------------------------------------------------------------
5445
5446class DropFilesEvent(Event):
5ba5649b
RD		 5447 """
5448 This class is used for drop files events, that is, when files have
5449 been dropped onto the window. This functionality is only available
5450 under Windows. The window must have previously been enabled for
5451 dropping by calling `wx.Window.DragAcceptFiles`.
5452
5453 Important note: this is a separate implementation to the more general
5454 drag and drop implementation using `wx.FileDropTarget`, and etc. This
5455 implementation uses the older, Windows message-based approach of
5456 dropping files.
5457
5458 Use wx.EVT_DROP_FILES to bind an event handler to receive file drop
5459 events.
5460
5461 """
554f62e9
RD		 5462 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5463 def __init__(self): raise AttributeError, "No constructor defined"
5464 __repr__ = _swig_repr
d55e5bfc 5465 def GetPosition(*args, **kwargs):
5ba5649b
RD		 5466 """
5467 GetPosition(self) -> Point
5468
5469 Returns the position at which the files were dropped.
5470 """
d55e5bfc
RD		 5471 return _core_.DropFilesEvent_GetPosition(*args, **kwargs)
5472
5473 def GetNumberOfFiles(*args, **kwargs):
5ba5649b
RD		 5474 """
5475 GetNumberOfFiles(self) -> int
5476
5477 Returns the number of files dropped.
5478 """
d55e5bfc
RD		 5479 return _core_.DropFilesEvent_GetNumberOfFiles(*args, **kwargs)
5480
5481 def GetFiles(*args, **kwargs):
5ba5649b
RD		 5482 """
5483 GetFiles(self) -> PyObject
5484
5485 Returns a list of the filenames that were dropped.
5486 """
d55e5bfc
RD		 5487 return _core_.DropFilesEvent_GetFiles(*args, **kwargs)
5488
554f62e9
RD		 5489DropFilesEvent_swigregister = _core_.DropFilesEvent_swigregister
5490DropFilesEvent_swigregister(DropFilesEvent)
d55e5bfc
RD		 5491
5492#---------------------------------------------------------------------------
5493
5494UPDATE_UI_PROCESS_ALL = _core_.UPDATE_UI_PROCESS_ALL
5495UPDATE_UI_PROCESS_SPECIFIED = _core_.UPDATE_UI_PROCESS_SPECIFIED
5496class UpdateUIEvent(CommandEvent):
5ba5649b
RD		 5497 """
5498 This class is used for EVT_UPDATE_UI pseudo-events which are sent by
5499 wxWidgets to give an application the chance to update various user
5500 interface elements.
5501
5502 Without update UI events, an application has to work hard to
5503 check/uncheck, enable/disable, and set the text for elements such as
5504 menu items and toolbar buttons. The code for doing this has to be
5505 mixed up with the code that is invoked when an action is invoked for a
5506 menu item or button.
5507
5508 With update UI events, you define an event handler to look at the
5509 state of the application and change UI elements accordingly. wxWidgets
5510 will call your handler functions in idle time, so you don't have to
5511 worry where to call this code. In addition to being a clearer and more
5512 declarative method, it also means you don't have to worry whether
5513 you're updating a toolbar or menubar identifier. The same handler can
5514 update a menu item and toolbar button, if the ID values are the same.
5515
5516 Instead of directly manipulating the menu or button, you call
5517 functions in the event object, such as `Check`. wxWidgets will
5518 determine whether such a call has been made, and which UI element to
5519 update.
5520
5521 These events will work for popup menus as well as menubars. Just
5522 before a menu is popped up, `wx.Menu.UpdateUI` is called to process
5523 any UI events for the window that owns the menu.
5524
5525 If you find that the overhead of UI update processing is affecting
5526 your application, you can do one or both of the following:
5527
5528 1. Call `wx.UpdateUIEvent.SetMode` with a value of
5529 wx.UPDATE_UI_PROCESS_SPECIFIED, and set the extra style
5530 wx.WS_EX_PROCESS_UPDATE_EVENTS for every window that should
5531 receive update events. No other windows will receive update
5532 events.
5533
5534 2. Call `wx.UpdateUIEvent.SetUpdateInterval` with a millisecond
5535 value to set the delay between updates. You may need to call
5536 `wx.Window.UpdateWindowUI` at critical points, for example when
5537 a dialog is about to be shown, in case the user sees a slight
5538 delay before windows are updated.
5539
5540 Note that although events are sent in idle time, defining a EVT_IDLE
5541 handler for a window does not affect this because the events are sent
5542 from an internal idle handler.
5543
5544 wxWidgets tries to optimize update events on some platforms. On
5545 Windows and GTK+, events for menubar items are only sent when the menu
5546 is about to be shown, and not in idle time.
5547
5548 """
554f62e9
RD		 5549 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5550 __repr__ = _swig_repr
5551 def __init__(self, *args, **kwargs):
5ba5649b
RD		 5552 """
5553 __init__(self, int commandId=0) -> UpdateUIEvent
5554
5555 Constructor
5556 """
554f62e9 5557 _core_.UpdateUIEvent_swiginit(self,_core_.new_UpdateUIEvent(*args, **kwargs))
d55e5bfc 5558 def GetChecked(*args, **kwargs):
5ba5649b
RD		 5559 """
5560 GetChecked(self) -> bool
5561
5562 Returns ``True`` if the UI element should be checked.
5563 """
d55e5bfc
RD		 5564 return _core_.UpdateUIEvent_GetChecked(*args, **kwargs)
5565
5566 def GetEnabled(*args, **kwargs):
5ba5649b
RD		 5567 """
5568 GetEnabled(self) -> bool
5569
5570 Returns ``True`` if the UI element should be enabled.
5571 """
d55e5bfc
RD		 5572 return _core_.UpdateUIEvent_GetEnabled(*args, **kwargs)
5573
554f62e9
RD		 5574 def GetShown(*args, **kwargs):
5575 """
5576 GetShown(self) -> bool
5577
5578 Returns ``True`` if the UI element should be shown.
5579 """
5580 return _core_.UpdateUIEvent_GetShown(*args, **kwargs)
5581
d55e5bfc 5582 def GetText(*args, **kwargs):
5ba5649b
RD		 5583 """
5584 GetText(self) -> String
5585
5586 Returns the text that should be set for the UI element.
5587 """
d55e5bfc
RD		 5588 return _core_.UpdateUIEvent_GetText(*args, **kwargs)
5589
5590 def GetSetText(*args, **kwargs):
5ba5649b
RD		 5591 """
5592 GetSetText(self) -> bool
5593
5594 Returns ``True`` if the application has called `SetText`. For
5595 wxWidgets internal use only.
5596 """
d55e5bfc
RD		 5597 return _core_.UpdateUIEvent_GetSetText(*args, **kwargs)
5598
5599 def GetSetChecked(*args, **kwargs):
5ba5649b
RD		 5600 """
5601 GetSetChecked(self) -> bool
5602
5603 Returns ``True`` if the application has called `Check`. For wxWidgets
5604 internal use only.
5605 """
d55e5bfc
RD		 5606 return _core_.UpdateUIEvent_GetSetChecked(*args, **kwargs)
5607
5608 def GetSetEnabled(*args, **kwargs):
5ba5649b
RD		 5609 """
5610 GetSetEnabled(self) -> bool
5611
5612 Returns ``True`` if the application has called `Enable`. For wxWidgets
5613 internal use only.
5614 """
d55e5bfc
RD		 5615 return _core_.UpdateUIEvent_GetSetEnabled(*args, **kwargs)
5616
554f62e9
RD		 5617 def GetSetShown(*args, **kwargs):
5618 """
5619 GetSetShown(self) -> bool
5620
5621 Returns ``True`` if the application has called `Show`. For wxWidgets
5622 internal use only.
5623 """
5624 return _core_.UpdateUIEvent_GetSetShown(*args, **kwargs)
5625
d55e5bfc 5626 def Check(*args, **kwargs):
5ba5649b
RD		 5627 """
5628 Check(self, bool check)
5629
5630 Check or uncheck the UI element.
5631 """
d55e5bfc
RD		 5632 return _core_.UpdateUIEvent_Check(*args, **kwargs)
5633
5634 def Enable(*args, **kwargs):
5ba5649b
RD		 5635 """
5636 Enable(self, bool enable)
5637
5638 Enable or disable the UI element.
5639 """
d55e5bfc
RD		 5640 return _core_.UpdateUIEvent_Enable(*args, **kwargs)
5641
554f62e9
RD		 5642 def Show(*args, **kwargs):
5643 """
5644 Show(self, bool show)
5645
5646 Show or hide the UI element.
5647 """
5648 return _core_.UpdateUIEvent_Show(*args, **kwargs)
5649
d55e5bfc 5650 def SetText(*args, **kwargs):
5ba5649b
RD		 5651 """
5652 SetText(self, String text)
5653
5654 Sets the text for this UI element.
5655 """
d55e5bfc
RD		 5656 return _core_.UpdateUIEvent_SetText(*args, **kwargs)
5657
5658 def SetUpdateInterval(*args, **kwargs):
5ba5649b
RD		 5659 """
5660 SetUpdateInterval(long updateInterval)
5661
5662 Sets the interval between updates in milliseconds. Set to -1 to
5663 disable updates, or to 0 to update as frequently as possible. The
5664 default is 0.
5665
5666 Use this to reduce the overhead of UI update events if your
5667 application has a lot of windows. If you set the value to -1 or
5668 greater than 0, you may also need to call `wx.Window.UpdateWindowUI`
5669 at appropriate points in your application, such as when a dialog is
5670 about to be shown.
5671 """
d55e5bfc
RD		 5672 return _core_.UpdateUIEvent_SetUpdateInterval(*args, **kwargs)
5673
5674 SetUpdateInterval = staticmethod(SetUpdateInterval)
5675 def GetUpdateInterval(*args, **kwargs):
5ba5649b
RD		 5676 """
5677 GetUpdateInterval() -> long
5678
5679 Returns the current interval between updates in milliseconds. -1
5680 disables updates, 0 updates as frequently as possible.
5681 """
d55e5bfc
RD		 5682 return _core_.UpdateUIEvent_GetUpdateInterval(*args, **kwargs)
5683
5684 GetUpdateInterval = staticmethod(GetUpdateInterval)
5685 def CanUpdate(*args, **kwargs):
5ba5649b
RD		 5686 """
5687 CanUpdate(Window win) -> bool
5688
5689 Returns ``True`` if it is appropriate to update (send UI update events
5690 to) this window.
5691
5692 This function looks at the mode used (see `wx.UpdateUIEvent.SetMode`),
5693 the wx.WS_EX_PROCESS_UPDATE_EVENTS flag in window, the time update
5694 events were last sent in idle time, and the update interval, to
5695 determine whether events should be sent to this window now. By default
5696 this will always return true because the update mode is initially
5697 wx.UPDATE_UI_PROCESS_ALL and the interval is set to 0; so update
5698 events will be sent as often as possible. You can reduce the frequency
5699 that events are sent by changing the mode and/or setting an update
5700 interval.
5701
5702 """
d55e5bfc
RD		 5703 return _core_.UpdateUIEvent_CanUpdate(*args, **kwargs)
5704
5705 CanUpdate = staticmethod(CanUpdate)
5706 def ResetUpdateTime(*args, **kwargs):
5ba5649b
RD		 5707 """
5708 ResetUpdateTime()
5709
5710 Used internally to reset the last-updated time to the current time. It
5711 is assumed that update events are normally sent in idle time, so this
5712 is called at the end of idle processing.
5713 """
d55e5bfc
RD		 5714 return _core_.UpdateUIEvent_ResetUpdateTime(*args, **kwargs)
5715
5716 ResetUpdateTime = staticmethod(ResetUpdateTime)
5717 def SetMode(*args, **kwargs):
5ba5649b
RD		 5718 """
5719 SetMode(int mode)
5720
5721 Specify how wxWidgets will send update events: to all windows, or only
5722 to those which specify that they will process the events.
5723
5724 The mode may be one of the following values:
5725
5726 ============================= ==========================================
5727 wxUPDATE_UI_PROCESS_ALL Send UI update events to all windows. This
5728 is the default setting.
5729 wxUPDATE_UI_PROCESS_SPECIFIED Send UI update events only to windows that
5730 have the wx.WS_EX_PROCESS_UI_UPDATES extra
5731 style set.
5732 ============================= ==========================================
5733
5734 """
d55e5bfc
RD		 5735 return _core_.UpdateUIEvent_SetMode(*args, **kwargs)
5736
5737 SetMode = staticmethod(SetMode)
5738 def GetMode(*args, **kwargs):
5ba5649b
RD		 5739 """
5740 GetMode() -> int
5741
5742 Returns a value specifying how wxWidgets will send update events: to
5743 all windows, or only to those which specify that they will process the
5744 events.
5745 """
d55e5bfc
RD		 5746 return _core_.UpdateUIEvent_GetMode(*args, **kwargs)
5747
5748 GetMode = staticmethod(GetMode)
554f62e9
RD		 5749UpdateUIEvent_swigregister = _core_.UpdateUIEvent_swigregister
5750UpdateUIEvent_swigregister(UpdateUIEvent)
d55e5bfc
RD		 5751
5752def UpdateUIEvent_SetUpdateInterval(*args, **kwargs):
554f62e9 5753 """
5ba5649b
RD		 5754 UpdateUIEvent_SetUpdateInterval(long updateInterval)
5755
5756 Sets the interval between updates in milliseconds. Set to -1 to
5757 disable updates, or to 0 to update as frequently as possible. The
5758 default is 0.
5759
5760 Use this to reduce the overhead of UI update events if your
5761 application has a lot of windows. If you set the value to -1 or
5762 greater than 0, you may also need to call `wx.Window.UpdateWindowUI`
5763 at appropriate points in your application, such as when a dialog is
5764 about to be shown.
5765 """
554f62e9 5766 return _core_.UpdateUIEvent_SetUpdateInterval(*args, **kwargs)
d55e5bfc 5767
554f62e9
RD		 5768def UpdateUIEvent_GetUpdateInterval(*args):
5769 """
5ba5649b
RD		 5770 UpdateUIEvent_GetUpdateInterval() -> long
5771
5772 Returns the current interval between updates in milliseconds. -1
5773 disables updates, 0 updates as frequently as possible.
5774 """
554f62e9 5775 return _core_.UpdateUIEvent_GetUpdateInterval(*args)
d55e5bfc
RD		 5776
5777def UpdateUIEvent_CanUpdate(*args, **kwargs):
554f62e9 5778 """
5ba5649b
RD		 5779 UpdateUIEvent_CanUpdate(Window win) -> bool
5780
5781 Returns ``True`` if it is appropriate to update (send UI update events
5782 to) this window.
5783
5784 This function looks at the mode used (see `wx.UpdateUIEvent.SetMode`),
5785 the wx.WS_EX_PROCESS_UPDATE_EVENTS flag in window, the time update
5786 events were last sent in idle time, and the update interval, to
5787 determine whether events should be sent to this window now. By default
5788 this will always return true because the update mode is initially
5789 wx.UPDATE_UI_PROCESS_ALL and the interval is set to 0; so update
5790 events will be sent as often as possible. You can reduce the frequency
5791 that events are sent by changing the mode and/or setting an update
5792 interval.
5793
5794 """
554f62e9 5795 return _core_.UpdateUIEvent_CanUpdate(*args, **kwargs)
d55e5bfc 5796
554f62e9
RD		 5797def UpdateUIEvent_ResetUpdateTime(*args):
5798 """
5ba5649b
RD		 5799 UpdateUIEvent_ResetUpdateTime()
5800
5801 Used internally to reset the last-updated time to the current time. It
5802 is assumed that update events are normally sent in idle time, so this
5803 is called at the end of idle processing.
5804 """
554f62e9 5805 return _core_.UpdateUIEvent_ResetUpdateTime(*args)
d55e5bfc
RD		 5806
5807def UpdateUIEvent_SetMode(*args, **kwargs):
554f62e9 5808 """
5ba5649b
RD		 5809 UpdateUIEvent_SetMode(int mode)
5810
5811 Specify how wxWidgets will send update events: to all windows, or only
5812 to those which specify that they will process the events.
5813
5814 The mode may be one of the following values:
5815
5816 ============================= ==========================================
5817 wxUPDATE_UI_PROCESS_ALL Send UI update events to all windows. This
5818 is the default setting.
5819 wxUPDATE_UI_PROCESS_SPECIFIED Send UI update events only to windows that
5820 have the wx.WS_EX_PROCESS_UI_UPDATES extra
5821 style set.
5822 ============================= ==========================================
5823
5824 """
554f62e9 5825 return _core_.UpdateUIEvent_SetMode(*args, **kwargs)
d55e5bfc 5826
554f62e9
RD		 5827def UpdateUIEvent_GetMode(*args):
5828 """
5ba5649b
RD		 5829 UpdateUIEvent_GetMode() -> int
5830
5831 Returns a value specifying how wxWidgets will send update events: to
5832 all windows, or only to those which specify that they will process the
5833 events.
5834 """
554f62e9 5835 return _core_.UpdateUIEvent_GetMode(*args)
d55e5bfc
RD		 5836
5837#---------------------------------------------------------------------------
5838
5839class SysColourChangedEvent(Event):
5ba5649b
RD		 5840 """
5841 This class is used for EVT_SYS_COLOUR_CHANGED, which are generated
5842 when the user changes the colour settings using the control
5843 panel. This is only applicable under Windows.
5844
5845 The default event handler for this event propagates the event to child
5846 windows, since Windows only sends the events to top-level windows. If
5847 intercepting this event for a top-level window, remember to call
5848 `Skip` so the the base class handler will still be executed, or to
5849 pass the event on to the window's children explicitly.
5850
5851 """
554f62e9
RD		 5852 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5853 __repr__ = _swig_repr
5854 def __init__(self, *args, **kwargs):
5ba5649b
RD		 5855 """
5856 __init__(self) -> SysColourChangedEvent
5857
5858 Constructor
5859 """
554f62e9
RD		 5860 _core_.SysColourChangedEvent_swiginit(self,_core_.new_SysColourChangedEvent(*args, **kwargs))
5861SysColourChangedEvent_swigregister = _core_.SysColourChangedEvent_swigregister
5862SysColourChangedEvent_swigregister(SysColourChangedEvent)
d55e5bfc
RD		 5863
5864#---------------------------------------------------------------------------
5865
5866class MouseCaptureChangedEvent(Event):
5ba5649b
RD		 5867 """
5868 An mouse capture changed event (EVT_MOUSE_CAPTURE_CHANGED) is sent to
5869 a window that loses its mouse capture. This is called even if
5870 `wx.Window.ReleaseMouse` was called by the application code. Handling
5871 this event allows an application to cater for unexpected capture
5872 releases which might otherwise confuse mouse handling code.
5873
5874 This event is implemented under Windows only.
5875 """
554f62e9
RD		 5876 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5877 __repr__ = _swig_repr
5878 def __init__(self, *args, **kwargs):
5ba5649b
RD		 5879 """
5880 __init__(self, int winid=0, Window gainedCapture=None) -> MouseCaptureChangedEvent
5881
5882 Constructor
5883 """
554f62e9 5884 _core_.MouseCaptureChangedEvent_swiginit(self,_core_.new_MouseCaptureChangedEvent(*args, **kwargs))
d55e5bfc 5885 def GetCapturedWindow(*args, **kwargs):
5ba5649b
RD		 5886 """
5887 GetCapturedWindow(self) -> Window
5888
5889 Returns the window that gained the capture, or ``None`` if it was a
5890 non-wxWidgets window.
5891 """
d55e5bfc
RD		 5892 return _core_.MouseCaptureChangedEvent_GetCapturedWindow(*args, **kwargs)
5893
554f62e9
RD		 5894MouseCaptureChangedEvent_swigregister = _core_.MouseCaptureChangedEvent_swigregister
5895MouseCaptureChangedEvent_swigregister(MouseCaptureChangedEvent)
d55e5bfc
RD		 5896
5897#---------------------------------------------------------------------------
5898
5899class DisplayChangedEvent(Event):
5ba5649b
RD		 5900 """
5901 An EVT_DISPLAY_CHANGED event is sent to all windows when the display
5902 resolution has changed.
5903
5904 This event is implemented under Windows only.
5905 """
554f62e9
RD		 5906 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5907 __repr__ = _swig_repr
5908 def __init__(self, *args, **kwargs):
d55e5bfc 5909 """__init__(self) -> DisplayChangedEvent"""
554f62e9
RD		 5910 _core_.DisplayChangedEvent_swiginit(self,_core_.new_DisplayChangedEvent(*args, **kwargs))
5911DisplayChangedEvent_swigregister = _core_.DisplayChangedEvent_swigregister
5912DisplayChangedEvent_swigregister(DisplayChangedEvent)
d55e5bfc
RD		 5913
5914#---------------------------------------------------------------------------
5915
5916class PaletteChangedEvent(Event):
5ba5649b
RD		 5917 """
5918 An EVT_PALETTE_CHANGED event is sent when the system palette has
5919 changed, thereby giving each window a chance to redo their own to
5920 match.
5921
5922 This event is implemented under Windows only.
5923 """
554f62e9
RD		 5924 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5925 __repr__ = _swig_repr
5926 def __init__(self, *args, **kwargs):
5ba5649b
RD		 5927 """
5928 __init__(self, int id=0) -> PaletteChangedEvent
5929
5930 An EVT_PALETTE_CHANGED event is sent when the system palette has
5931 changed, thereby giving each window a chance to redo their own to
5932 match.
5933
5934 This event is implemented under Windows only.
5935 """
554f62e9 5936 _core_.PaletteChangedEvent_swiginit(self,_core_.new_PaletteChangedEvent(*args, **kwargs))
d55e5bfc
RD		 5937 def SetChangedWindow(*args, **kwargs):
5938 """SetChangedWindow(self, Window win)"""
5939 return _core_.PaletteChangedEvent_SetChangedWindow(*args, **kwargs)
5940
5941 def GetChangedWindow(*args, **kwargs):
5942 """GetChangedWindow(self) -> Window"""
5943 return _core_.PaletteChangedEvent_GetChangedWindow(*args, **kwargs)
5944
554f62e9
RD		 5945PaletteChangedEvent_swigregister = _core_.PaletteChangedEvent_swigregister
5946PaletteChangedEvent_swigregister(PaletteChangedEvent)
d55e5bfc
RD		 5947
5948#---------------------------------------------------------------------------
5949
5950class QueryNewPaletteEvent(Event):
5ba5649b
RD		 5951 """
5952 An EVT_QUERY_NEW_PALETE event indicates the window is getting keyboard
5953 focus and should re-do its palette.
5954
5955 This event is implemented under Windows only.
5956 """
554f62e9
RD		 5957 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5958 __repr__ = _swig_repr
5959 def __init__(self, *args, **kwargs):
5ba5649b
RD		 5960 """
5961 __init__(self, int winid=0) -> QueryNewPaletteEvent
5962
5963 Constructor.
5964 """
554f62e9 5965 _core_.QueryNewPaletteEvent_swiginit(self,_core_.new_QueryNewPaletteEvent(*args, **kwargs))
d55e5bfc 5966 def SetPaletteRealized(*args, **kwargs):
5ba5649b
RD		 5967 """
5968 SetPaletteRealized(self, bool realized)
5969
5970 App should set this if it changes the palette.
5971 """
d55e5bfc
RD		 5972 return _core_.QueryNewPaletteEvent_SetPaletteRealized(*args, **kwargs)
5973
5974 def GetPaletteRealized(*args, **kwargs):
5975 """GetPaletteRealized(self) -> bool"""
5976 return _core_.QueryNewPaletteEvent_GetPaletteRealized(*args, **kwargs)
5977
554f62e9
RD		 5978QueryNewPaletteEvent_swigregister = _core_.QueryNewPaletteEvent_swigregister
5979QueryNewPaletteEvent_swigregister(QueryNewPaletteEvent)
d55e5bfc
RD		 5980
5981#---------------------------------------------------------------------------
5982
5983class NavigationKeyEvent(Event):
5ba5649b
RD		 5984 """
5985 EVT_NAVIGATION_KEY events are used to control moving the focus between
5986 widgets, otherwise known as tab-traversal. You woudl normally not
5987 catch navigation events in applications as there are already
5988 appropriate handlers in `wx.Dialog` and `wx.Panel`, but you may find
5989 it useful to send navigation events in certain situations to change
5990 the focus in certain ways, although it's probably easier to just call
5991 `wx.Window.Navigate`.
5992 """
554f62e9
RD		 5993 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5994 __repr__ = _swig_repr
5995 def __init__(self, *args, **kwargs):
d55e5bfc 5996 """__init__(self) -> NavigationKeyEvent"""
554f62e9 5997 _core_.NavigationKeyEvent_swiginit(self,_core_.new_NavigationKeyEvent(*args, **kwargs))
d55e5bfc 5998 def GetDirection(*args, **kwargs):
5ba5649b
RD		 5999 """
6000 GetDirection(self) -> bool
6001
6002 Returns ``True`` if the direction is forward, ``False`` otherwise.
6003 """
d55e5bfc
RD		 6004 return _core_.NavigationKeyEvent_GetDirection(*args, **kwargs)
6005
6006 def SetDirection(*args, **kwargs):
5ba5649b
RD		 6007 """
6008 SetDirection(self, bool forward)
6009
6010 Specify the direction that the navigation should take. Usually the
6011 difference between using Tab and Shift-Tab.
6012 """
d55e5bfc
RD		 6013 return _core_.NavigationKeyEvent_SetDirection(*args, **kwargs)
6014
6015 def IsWindowChange(*args, **kwargs):
5ba5649b
RD		 6016 """
6017 IsWindowChange(self) -> bool
6018
6019 Returns ``True`` if window change is allowed.
6020 """
d55e5bfc
RD		 6021 return _core_.NavigationKeyEvent_IsWindowChange(*args, **kwargs)
6022
6023 def SetWindowChange(*args, **kwargs):
5ba5649b
RD		 6024 """
6025 SetWindowChange(self, bool ischange)
6026
6027 Specify if the navigation should be able to change parent windows.
6028 For example, changing notebook pages, etc. This is usually implemented
6029 by using Control-Tab.
6030 """
d55e5bfc
RD		 6031 return _core_.NavigationKeyEvent_SetWindowChange(*args, **kwargs)
6032
68350608 6033 def IsFromTab(*args, **kwargs):
5ba5649b
RD		 6034 """
6035 IsFromTab(self) -> bool
6036
6037 Returns ``True`` if the navigation event is originated from the Tab
6038 key.
6039 """
68350608
RD		 6040 return _core_.NavigationKeyEvent_IsFromTab(*args, **kwargs)
6041
6042 def SetFromTab(*args, **kwargs):
5ba5649b
RD		 6043 """
6044 SetFromTab(self, bool bIs)
6045
6046 Set to true under MSW if the event was generated using the tab key.
6047 This is required for proper navogation over radio buttons.
6048 """
68350608
RD		 6049 return _core_.NavigationKeyEvent_SetFromTab(*args, **kwargs)
6050
908b74cd 6051 def SetFlags(*args, **kwargs):
5ba5649b
RD		 6052 """
6053 SetFlags(self, long flags)
6054
6055 Set the navigation flags to a combination of the following:
6056
6057 * wx.NavigationKeyEvent.IsBackward
6058 * wx.NavigationKeyEvent.IsForward
6059 * wx.NavigationKeyEvent.WinChange
6060 * wx.NavigationKeyEvent.FromTab
6061
6062 """
908b74cd
RD		 6063 return _core_.NavigationKeyEvent_SetFlags(*args, **kwargs)
6064
d55e5bfc 6065 def GetCurrentFocus(*args, **kwargs):
5ba5649b
RD		 6066 """
6067 GetCurrentFocus(self) -> Window
6068
6069 Returns the child window which currenty has the focus. May be
6070 ``None``.
6071 """
d55e5bfc
RD		 6072 return _core_.NavigationKeyEvent_GetCurrentFocus(*args, **kwargs)
6073
6074 def SetCurrentFocus(*args, **kwargs):
5ba5649b
RD		 6075 """
6076 SetCurrentFocus(self, Window win)
6077
6078 Set the window that has the focus.
6079 """
d55e5bfc
RD		 6080 return _core_.NavigationKeyEvent_SetCurrentFocus(*args, **kwargs)
6081
b0f7404b 6082 IsBackward = _core_.NavigationKeyEvent_IsBackward
908b74cd
RD		 6083 IsForward = _core_.NavigationKeyEvent_IsForward
6084 WinChange = _core_.NavigationKeyEvent_WinChange
68350608 6085 FromTab = _core_.NavigationKeyEvent_FromTab
554f62e9
RD		 6086NavigationKeyEvent_swigregister = _core_.NavigationKeyEvent_swigregister
6087NavigationKeyEvent_swigregister(NavigationKeyEvent)
d55e5bfc
RD		 6088
6089#---------------------------------------------------------------------------
6090
6091class WindowCreateEvent(CommandEvent):
5ba5649b
RD		 6092 """
6093 The EVT_WINDOW_CREATE event is sent as soon as the window object (the
6094 underlying GUI object) exists.
6095 """
554f62e9
RD		 6096 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6097 __repr__ = _swig_repr
6098 def __init__(self, *args, **kwargs):
5ba5649b
RD		 6099 """
6100 __init__(self, Window win=None) -> WindowCreateEvent
6101
6102 The EVT_WINDOW_CREATE event is sent as soon as the window object (the
6103 underlying GUI object) exists.
6104 """
554f62e9 6105 _core_.WindowCreateEvent_swiginit(self,_core_.new_WindowCreateEvent(*args, **kwargs))
d55e5bfc 6106 def GetWindow(*args, **kwargs):
5ba5649b
RD		 6107 """
6108 GetWindow(self) -> Window
6109
6110 Returns the window that this event refers to.
6111 """
d55e5bfc
RD		 6112 return _core_.WindowCreateEvent_GetWindow(*args, **kwargs)
6113
554f62e9
RD		 6114WindowCreateEvent_swigregister = _core_.WindowCreateEvent_swigregister
6115WindowCreateEvent_swigregister(WindowCreateEvent)
d55e5bfc
RD		 6116
6117class WindowDestroyEvent(CommandEvent):
5ba5649b 6118 """
9d7dfdff
RD		 6119 The EVT_WINDOW_DESTROY event is sent from the `wx.Window` destructor
6120 when the GUI window is destroyed.
6121
6122 When a class derived from `wx.Window` is destroyed its destructor will
6123 have already run by the time this event is sent. Therefore this event
6124 will not usually be received at all by the window itself. Since it is
6125 received after the destructor has run, an object should not try to
6126 handle its own wx.WindowDestroyEvent, but it can be used to get
6127 notification of the destruction of another window.
5ba5649b 6128 """
554f62e9
RD		 6129 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6130 __repr__ = _swig_repr
6131 def __init__(self, *args, **kwargs):
5ba5649b
RD		 6132 """
6133 __init__(self, Window win=None) -> WindowDestroyEvent
6134
9d7dfdff
RD		 6135 The EVT_WINDOW_DESTROY event is sent from the `wx.Window` destructor
6136 when the GUI window is destroyed.
6137
6138 When a class derived from `wx.Window` is destroyed its destructor will
6139 have already run by the time this event is sent. Therefore this event
6140 will not usually be received at all by the window itself. Since it is
6141 received after the destructor has run, an object should not try to
6142 handle its own wx.WindowDestroyEvent, but it can be used to get
6143 notification of the destruction of another window.
5ba5649b 6144 """
554f62e9 6145 _core_.WindowDestroyEvent_swiginit(self,_core_.new_WindowDestroyEvent(*args, **kwargs))
d55e5bfc 6146 def GetWindow(*args, **kwargs):
5ba5649b
RD		 6147 """
6148 GetWindow(self) -> Window
6149
6150 Returns the window that this event refers to.
6151 """
d55e5bfc
RD		 6152 return _core_.WindowDestroyEvent_GetWindow(*args, **kwargs)
6153
554f62e9
RD		 6154WindowDestroyEvent_swigregister = _core_.WindowDestroyEvent_swigregister
6155WindowDestroyEvent_swigregister(WindowDestroyEvent)
d55e5bfc
RD		 6156
6157#---------------------------------------------------------------------------
6158
6159class ContextMenuEvent(CommandEvent):
5ba5649b
RD		 6160 """
6161 This class is used for context menu events (EVT_CONTECT_MENU,) sent to
6162 give the application a chance to show a context (popup) menu.
6163 """
554f62e9
RD		 6164 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6165 __repr__ = _swig_repr
6166 def __init__(self, *args, **kwargs):
5ba5649b
RD		 6167 """
6168 __init__(self, wxEventType type=wxEVT_NULL, int winid=0, Point pt=DefaultPosition) -> ContextMenuEvent
6169
6170 Constructor.
6171 """
554f62e9 6172 _core_.ContextMenuEvent_swiginit(self,_core_.new_ContextMenuEvent(*args, **kwargs))
d55e5bfc 6173 def GetPosition(*args, **kwargs):
5ba5649b
RD		 6174 """
6175 GetPosition(self) -> Point
6176
6177 Returns the position (in screen coordinants) at which the menu should
6178 be shown.
6179 """
d55e5bfc
RD		 6180 return _core_.ContextMenuEvent_GetPosition(*args, **kwargs)
6181
6182 def SetPosition(*args, **kwargs):
5ba5649b
RD		 6183 """
6184 SetPosition(self, Point pos)
6185
6186 Sets the position at which the menu should be shown.
6187 """
d55e5bfc
RD		 6188 return _core_.ContextMenuEvent_SetPosition(*args, **kwargs)
6189
554f62e9
RD		 6190ContextMenuEvent_swigregister = _core_.ContextMenuEvent_swigregister
6191ContextMenuEvent_swigregister(ContextMenuEvent)
d55e5bfc
RD		 6192
6193#---------------------------------------------------------------------------
6194
6195IDLE_PROCESS_ALL = _core_.IDLE_PROCESS_ALL
6196IDLE_PROCESS_SPECIFIED = _core_.IDLE_PROCESS_SPECIFIED
6197class IdleEvent(Event):
5ba5649b
RD		 6198 """
6199 This class is used for EVT_IDLE events, which are generated and sent
6200 when the application *becomes* idle. In other words, the when the
6201 event queue becomes empty then idle events are sent to all windows (by
6202 default) and as long as none of them call `RequestMore` then there are
6203 no more idle events until after the system event queue has some normal
6204 events and then becomes empty again.
6205
6206 By default, idle events are sent to all windows. If this is causing a
6207 significant overhead in your application, you can call
6208 `wx.IdleEvent.SetMode` with the value wx.IDLE_PROCESS_SPECIFIED, and
6209 set the wx.WS_EX_PROCESS_IDLE extra window style for every window
6210 which should receive idle events. Then idle events will only be sent
6211 to those windows and not to any others.
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) -> IdleEvent
6218
6219 Constructor
6220 """
554f62e9 6221 _core_.IdleEvent_swiginit(self,_core_.new_IdleEvent(*args, **kwargs))
d55e5bfc 6222 def RequestMore(*args, **kwargs):
5ba5649b
RD		 6223 """
6224 RequestMore(self, bool needMore=True)
6225
6226 Tells wxWidgets that more processing is required. This function can be
6227 called by an EVT_IDLE handler for a window to indicate that the
6228 application should forward the EVT_IDLE event once more to the
6229 application windows. If no window calls this function during its
6230 EVT_IDLE handler, then the application will remain in a passive event
6231 loop until a new event is posted to the application by the windowing
6232 system.
6233 """
d55e5bfc
RD		 6234 return _core_.IdleEvent_RequestMore(*args, **kwargs)
6235
6236 def MoreRequested(*args, **kwargs):
5ba5649b
RD		 6237 """
6238 MoreRequested(self) -> bool
6239
6240 Returns ``True`` if the OnIdle function processing this event
6241 requested more processing time.
6242 """
d55e5bfc
RD		 6243 return _core_.IdleEvent_MoreRequested(*args, **kwargs)
6244
6245 def SetMode(*args, **kwargs):
5ba5649b
RD		 6246 """
6247 SetMode(int mode)
6248
6249 Static method for specifying how wxWidgets will send idle events: to
6250 all windows, or only to those which specify that they will process the
6251 events.
6252
6253 The mode can be one of the following values:
6254
6255 ========================= ========================================
6256 wx.IDLE_PROCESS_ALL Send idle events to all windows
6257 wx.IDLE_PROCESS_SPECIFIED Send idle events only to windows that have
6258 the wx.WS_EX_PROCESS_IDLE extra style
6259 flag set.
6260 ========================= ========================================
6261
6262 """
d55e5bfc
RD		 6263 return _core_.IdleEvent_SetMode(*args, **kwargs)
6264
6265 SetMode = staticmethod(SetMode)
6266 def GetMode(*args, **kwargs):
5ba5649b
RD		 6267 """
6268 GetMode() -> int
6269
6270 Static method returning a value specifying how wxWidgets will send
6271 idle events: to all windows, or only to those which specify that they
6272 will process the events.
6273 """
d55e5bfc
RD		 6274 return _core_.IdleEvent_GetMode(*args, **kwargs)
6275
6276 GetMode = staticmethod(GetMode)
6277 def CanSend(*args, **kwargs):
5ba5649b
RD		 6278 """
6279 CanSend(Window win) -> bool
6280
6281 Returns ``True`` if it is appropriate to send idle events to this
6282 window.
6283
6284 This function looks at the mode used (see `wx.IdleEvent.SetMode`), and
6285 the wx.WS_EX_PROCESS_IDLE style in window to determine whether idle
6286 events should be sent to this window now. By default this will always
6287 return ``True`` because the update mode is initially
6288 wx.IDLE_PROCESS_ALL. You can change the mode to only send idle events
6289 to windows with the wx.WS_EX_PROCESS_IDLE extra window style set.
6290 """
d55e5bfc
RD		 6291 return _core_.IdleEvent_CanSend(*args, **kwargs)
6292
6293 CanSend = staticmethod(CanSend)
554f62e9
RD		 6294IdleEvent_swigregister = _core_.IdleEvent_swigregister
6295IdleEvent_swigregister(IdleEvent)
d55e5bfc
RD		 6296
6297def IdleEvent_SetMode(*args, **kwargs):
554f62e9 6298 """
5ba5649b
RD		 6299 IdleEvent_SetMode(int mode)
6300
6301 Static method for specifying how wxWidgets will send idle events: to
6302 all windows, or only to those which specify that they will process the
6303 events.
6304
6305 The mode can be one of the following values:
6306
6307 ========================= ========================================
6308 wx.IDLE_PROCESS_ALL Send idle events to all windows
6309 wx.IDLE_PROCESS_SPECIFIED Send idle events only to windows that have
6310 the wx.WS_EX_PROCESS_IDLE extra style
6311 flag set.
6312 ========================= ========================================
6313
6314 """
554f62e9 6315 return _core_.IdleEvent_SetMode(*args, **kwargs)
d55e5bfc 6316
554f62e9
RD		 6317def IdleEvent_GetMode(*args):
6318 """
5ba5649b
RD		 6319 IdleEvent_GetMode() -> int
6320
6321 Static method returning a value specifying how wxWidgets will send
6322 idle events: to all windows, or only to those which specify that they
6323 will process the events.
6324 """
554f62e9 6325 return _core_.IdleEvent_GetMode(*args)
d55e5bfc
RD		 6326
6327def IdleEvent_CanSend(*args, **kwargs):
554f62e9 6328 """
5ba5649b
RD		 6329 IdleEvent_CanSend(Window win) -> bool
6330
6331 Returns ``True`` if it is appropriate to send idle events to this
6332 window.
6333
6334 This function looks at the mode used (see `wx.IdleEvent.SetMode`), and
6335 the wx.WS_EX_PROCESS_IDLE style in window to determine whether idle
6336 events should be sent to this window now. By default this will always
6337 return ``True`` because the update mode is initially
6338 wx.IDLE_PROCESS_ALL. You can change the mode to only send idle events
6339 to windows with the wx.WS_EX_PROCESS_IDLE extra window style set.
6340 """
554f62e9 6341 return _core_.IdleEvent_CanSend(*args, **kwargs)
d55e5bfc
RD		 6342
6343#---------------------------------------------------------------------------
6344
6345class PyEvent(Event):
5ba5649b
RD		 6346 """
6347 wx.PyEvent can be used as a base class for implementing custom event
6348 types in Python. You should derived from this class instead of
6349 `wx.Event` because this class is Python-aware and is able to transport
6350 its Python bits safely through the wxWidgets event system and have
6351 them still be there when the event handler is invoked.
6352
6353 :see: `wx.PyCommandEvent`
6354
6355 """
554f62e9
RD		 6356 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6357 __repr__ = _swig_repr
6358 def __init__(self, *args, **kwargs):
5ba5649b 6359 """__init__(self, int winid=0, wxEventType eventType=wxEVT_NULL) -> PyEvent"""
554f62e9 6360 _core_.PyEvent_swiginit(self,_core_.new_PyEvent(*args, **kwargs))
5ba5649b 6361 self._SetSelf(self)
d55e5bfc 6362
554f62e9
RD		 6363 __swig_destroy__ = _core_.delete_PyEvent
6364 __del__ = lambda self : None;
5ba5649b
RD		 6365 def _SetSelf(*args, **kwargs):
6366 """_SetSelf(self, PyObject self)"""
6367 return _core_.PyEvent__SetSelf(*args, **kwargs)
d55e5bfc 6368
5ba5649b
RD		 6369 def _GetSelf(*args, **kwargs):
6370 """_GetSelf(self) -> PyObject"""
6371 return _core_.PyEvent__GetSelf(*args, **kwargs)
d55e5bfc 6372
554f62e9
RD		 6373PyEvent_swigregister = _core_.PyEvent_swigregister
6374PyEvent_swigregister(PyEvent)
d55e5bfc
RD		 6375
6376class PyCommandEvent(CommandEvent):
5ba5649b
RD		 6377 """
6378 wx.PyCommandEvent can be used as a base class for implementing custom
6379 event types in Python, where the event shoudl travel up to parent
6380 windows looking for a handler. You should derived from this class
6381 instead of `wx.CommandEvent` because this class is Python-aware and is
6382 able to transport its Python bits safely through the wxWidgets event
6383 system and have them still be there when the event handler is invoked.
6384
6385 :see: `wx.PyEvent`
6386
6387 """
554f62e9
RD		 6388 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6389 __repr__ = _swig_repr
6390 def __init__(self, *args, **kwargs):
5ba5649b 6391 """__init__(self, wxEventType eventType=wxEVT_NULL, int id=0) -> PyCommandEvent"""
554f62e9 6392 _core_.PyCommandEvent_swiginit(self,_core_.new_PyCommandEvent(*args, **kwargs))
5ba5649b 6393 self._SetSelf(self)
d55e5bfc 6394
554f62e9
RD		 6395 __swig_destroy__ = _core_.delete_PyCommandEvent
6396 __del__ = lambda self : None;
5ba5649b
RD		 6397 def _SetSelf(*args, **kwargs):
6398 """_SetSelf(self, PyObject self)"""
6399 return _core_.PyCommandEvent__SetSelf(*args, **kwargs)
d55e5bfc 6400
5ba5649b
RD		 6401 def _GetSelf(*args, **kwargs):
6402 """_GetSelf(self) -> PyObject"""
6403 return _core_.PyCommandEvent__GetSelf(*args, **kwargs)
d55e5bfc 6404
554f62e9
RD		 6405PyCommandEvent_swigregister = _core_.PyCommandEvent_swigregister
6406PyCommandEvent_swigregister(PyCommandEvent)
d55e5bfc 6407
53aa7709 6408class DateEvent(CommandEvent):
5ba5649b
RD		 6409 """
6410 This event class holds information about a date change event and is
6411 used together with `wx.DatePickerCtrl`. It also serves as a base class
6412 for `wx.calendar.CalendarEvent`. Bind these event types with
6413 EVT_DATE_CHANGED.
6414 """
554f62e9
RD		 6415 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6416 __repr__ = _swig_repr
6417 def __init__(self, *args, **kwargs):
53aa7709 6418 """__init__(self, Window win, DateTime dt, wxEventType type) -> DateEvent"""
554f62e9 6419 _core_.DateEvent_swiginit(self,_core_.new_DateEvent(*args, **kwargs))
53aa7709 6420 def GetDate(*args, **kwargs):
5ba5649b
RD		 6421 """
6422 GetDate(self) -> DateTime
6423
6424 Returns the date.
6425 """
53aa7709
RD		 6426 return _core_.DateEvent_GetDate(*args, **kwargs)
6427
6428 def SetDate(*args, **kwargs):
5ba5649b
RD		 6429 """
6430 SetDate(self, DateTime date)
6431
6432 Sets the date carried by the event, normally only used by the library
6433 internally.
6434 """
53aa7709
RD		 6435 return _core_.DateEvent_SetDate(*args, **kwargs)
6436
554f62e9
RD		 6437DateEvent_swigregister = _core_.DateEvent_swigregister
6438DateEvent_swigregister(DateEvent)
53aa7709
RD		 6439
6440wxEVT_DATE_CHANGED = _core_.wxEVT_DATE_CHANGED
6441EVT_DATE_CHANGED = wx.PyEventBinder( wxEVT_DATE_CHANGED, 1 )
6442
d55e5bfc
RD		 6443#---------------------------------------------------------------------------
6444
6445PYAPP_ASSERT_SUPPRESS = _core_.PYAPP_ASSERT_SUPPRESS
6446PYAPP_ASSERT_EXCEPTION = _core_.PYAPP_ASSERT_EXCEPTION
6447PYAPP_ASSERT_DIALOG = _core_.PYAPP_ASSERT_DIALOG
6448PYAPP_ASSERT_LOG = _core_.PYAPP_ASSERT_LOG
6449PRINT_WINDOWS = _core_.PRINT_WINDOWS
6450PRINT_POSTSCRIPT = _core_.PRINT_POSTSCRIPT
6451class PyApp(EvtHandler):
c24da6d6
RD		 6452 """
6453 The ``wx.PyApp`` class is an *implementation detail*, please use the
6454 `wx.App` class (or some other derived class) instead.
6455 """
554f62e9
RD		 6456 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6457 __repr__ = _swig_repr
6458 def __init__(self, *args, **kwargs):
d55e5bfc
RD		 6459 """
6460 __init__(self) -> PyApp
6461
6462 Create a new application object, starting the bootstrap process.
6463 """
554f62e9 6464 _core_.PyApp_swiginit(self,_core_.new_PyApp(*args, **kwargs))
70b7a5fe
RD		 6465 self._setCallbackInfo(self, PyApp, False)
6466 self._setOORInfo(self, False)
d55e5bfc 6467
554f62e9
RD		 6468 __swig_destroy__ = _core_.delete_PyApp
6469 __del__ = lambda self : None;
d55e5bfc 6470 def _setCallbackInfo(*args, **kwargs):
70b7a5fe 6471 """_setCallbackInfo(self, PyObject self, PyObject _class, bool incref)"""
d55e5bfc
RD		 6472 return _core_.PyApp__setCallbackInfo(*args, **kwargs)
6473
6474 def GetAppName(*args, **kwargs):
6475 """
6476 GetAppName(self) -> String
6477
6478 Get the application name.
6479 """
6480 return _core_.PyApp_GetAppName(*args, **kwargs)
6481
6482 def SetAppName(*args, **kwargs):
6483 """
6484 SetAppName(self, String name)
6485
c24da6d6
RD		 6486 Set the application name. This value may be used automatically by
6487 `wx.Config` and such.
d55e5bfc
RD		 6488 """
6489 return _core_.PyApp_SetAppName(*args, **kwargs)
6490
6491 def GetClassName(*args, **kwargs):
6492 """
6493 GetClassName(self) -> String
6494
6495 Get the application's class name.
6496 """
6497 return _core_.PyApp_GetClassName(*args, **kwargs)
6498
6499 def SetClassName(*args, **kwargs):
6500 """
6501 SetClassName(self, String name)
6502
c24da6d6
RD		 6503 Set the application's class name. This value may be used for
6504 X-resources if applicable for the platform
d55e5bfc
RD		 6505 """
6506 return _core_.PyApp_SetClassName(*args, **kwargs)
6507
6508 def GetVendorName(*args, **kwargs):
6509 """
6510 GetVendorName(self) -> String
6511
6512 Get the application's vendor name.
6513 """
6514 return _core_.PyApp_GetVendorName(*args, **kwargs)
6515
6516 def SetVendorName(*args, **kwargs):
6517 """
6518 SetVendorName(self, String name)
6519
c24da6d6
RD		 6520 Set the application's vendor name. This value may be used
6521 automatically by `wx.Config` and such.
d55e5bfc
RD		 6522 """
6523 return _core_.PyApp_SetVendorName(*args, **kwargs)
6524
6525 def GetTraits(*args, **kwargs):
6526 """
6527 GetTraits(self) -> wxAppTraits
6528
c24da6d6
RD		 6529 Return (and create if necessary) the app traits object to which we
6530 delegate for everything which either should be configurable by the
6531 user (then he can change the default behaviour simply by overriding
6532 CreateTraits() and returning his own traits object) or which is
6533 GUI/console dependent as then wx.AppTraits allows us to abstract the
6534 differences behind the common facade.
6535
6536 :todo: Add support for overriding CreateAppTraits in wxPython.
d55e5bfc
RD		 6537 """
6538 return _core_.PyApp_GetTraits(*args, **kwargs)
6539
6540 def ProcessPendingEvents(*args, **kwargs):
6541 """
6542 ProcessPendingEvents(self)
6543
c24da6d6
RD		 6544 Process all events in the Pending Events list -- it is necessary to
6545 call this function to process posted events. This normally happens
6546 during each event loop iteration.
d55e5bfc
RD		 6547 """
6548 return _core_.PyApp_ProcessPendingEvents(*args, **kwargs)
6549
6550 def Yield(*args, **kwargs):
6551 """
6552 Yield(self, bool onlyIfNeeded=False) -> bool
6553
c24da6d6
RD		 6554 Process all currently pending events right now, instead of waiting
6555 until return to the event loop. It is an error to call ``Yield``
6556 recursively unless the value of ``onlyIfNeeded`` is True.
d55e5bfc 6557
c24da6d6 6558 :warning: This function is dangerous as it can lead to unexpected
79fccf9d
RD		 6559 reentrancies (i.e. when called from an event handler it may
6560 result in calling the same event handler again), use with
6561 extreme care or, better, don't use at all!
d55e5bfc 6562
c24da6d6 6563 :see: `wx.Yield`, `wx.YieldIfNeeded`, `wx.SafeYield`
79fccf9d 6564
d55e5bfc
RD		 6565 """
6566 return _core_.PyApp_Yield(*args, **kwargs)
6567
6568 def WakeUpIdle(*args, **kwargs):
6569 """
6570 WakeUpIdle(self)
6571
c24da6d6
RD		 6572 Make sure that idle events are sent again.
6573 :see: `wx.WakeUpIdle`
d55e5bfc
RD		 6574 """
6575 return _core_.PyApp_WakeUpIdle(*args, **kwargs)
6576
84f85550
RD		 6577 def IsMainLoopRunning(*args, **kwargs):
6578 """
6579 IsMainLoopRunning() -> bool
6580
6581 Returns True if we're running the main loop, i.e. if the events can
6582 currently be dispatched.
6583 """
6584 return _core_.PyApp_IsMainLoopRunning(*args, **kwargs)
6585
6586 IsMainLoopRunning = staticmethod(IsMainLoopRunning)
d55e5bfc
RD		 6587 def MainLoop(*args, **kwargs):
6588 """
6589 MainLoop(self) -> int
6590
c24da6d6
RD		 6591 Execute the main GUI loop, the function doesn't normally return until
6592 all top level windows have been closed and destroyed.
d55e5bfc
RD		 6593 """
6594 return _core_.PyApp_MainLoop(*args, **kwargs)
6595
6596 def Exit(*args, **kwargs):
6597 """
6598 Exit(self)
6599
6600 Exit the main loop thus terminating the application.
c24da6d6 6601 :see: `wx.Exit`
d55e5bfc
RD		 6602 """
6603 return _core_.PyApp_Exit(*args, **kwargs)
6604
6605 def ExitMainLoop(*args, **kwargs):
6606 """
6607 ExitMainLoop(self)
6608
c24da6d6
RD		 6609 Exit the main GUI loop during the next iteration of the main
6610 loop, (i.e. it does not stop the program immediately!)
d55e5bfc
RD		 6611 """
6612 return _core_.PyApp_ExitMainLoop(*args, **kwargs)
6613
6614 def Pending(*args, **kwargs):
6615 """
6616 Pending(self) -> bool
6617
6618 Returns True if there are unprocessed events in the event queue.
6619 """
6620 return _core_.PyApp_Pending(*args, **kwargs)
6621
6622 def Dispatch(*args, **kwargs):
6623 """
6624 Dispatch(self) -> bool
6625
6626 Process the first event in the event queue (blocks until an event
6627 appears if there are none currently)
6628 """
6629 return _core_.PyApp_Dispatch(*args, **kwargs)
6630
6631 def ProcessIdle(*args, **kwargs):
6632 """
6633 ProcessIdle(self) -> bool
6634
c24da6d6
RD		 6635 Called from the MainLoop when the application becomes idle (there are
6636 no pending events) and sends a `wx.IdleEvent` to all interested
6637 parties. Returns True if more idle events are needed, False if not.
d55e5bfc
RD		 6638 """
6639 return _core_.PyApp_ProcessIdle(*args, **kwargs)
6640
6641 def SendIdleEvents(*args, **kwargs):
6642 """
6643 SendIdleEvents(self, Window win, IdleEvent event) -> bool
6644
c24da6d6
RD		 6645 Send idle event to window and all subwindows. Returns True if more
6646 idle time is requested.
d55e5bfc
RD		 6647 """
6648 return _core_.PyApp_SendIdleEvents(*args, **kwargs)
6649
6650 def IsActive(*args, **kwargs):
6651 """
6652 IsActive(self) -> bool
6653
6654 Return True if our app has focus.
6655 """
6656 return _core_.PyApp_IsActive(*args, **kwargs)
6657
6658 def SetTopWindow(*args, **kwargs):
6659 """
6660 SetTopWindow(self, Window win)
6661
c24da6d6 6662 Set the *main* top level window
d55e5bfc
RD		 6663 """
6664 return _core_.PyApp_SetTopWindow(*args, **kwargs)
6665
6666 def GetTopWindow(*args, **kwargs):
6667 """
6668 GetTopWindow(self) -> Window
6669
c24da6d6
RD		 6670 Return the *main* top level window (if it hadn't been set previously
6671 with SetTopWindow(), will return just some top level window and, if
6672 there not any, will return None)
d55e5bfc
RD		 6673 """
6674 return _core_.PyApp_GetTopWindow(*args, **kwargs)
6675
6676 def SetExitOnFrameDelete(*args, **kwargs):
6677 """
6678 SetExitOnFrameDelete(self, bool flag)
6679
c24da6d6
RD		 6680 Control the exit behaviour: by default, the program will exit the main
6681 loop (and so, usually, terminate) when the last top-level program
6682 window is deleted. Beware that if you disable this behaviour (with
6683 SetExitOnFrameDelete(False)), you'll have to call ExitMainLoop()
6684 explicitly from somewhere.
d55e5bfc
RD		 6685 """
6686 return _core_.PyApp_SetExitOnFrameDelete(*args, **kwargs)
6687
6688 def GetExitOnFrameDelete(*args, **kwargs):
6689 """
6690 GetExitOnFrameDelete(self) -> bool
6691
6692 Get the current exit behaviour setting.
6693 """
6694 return _core_.PyApp_GetExitOnFrameDelete(*args, **kwargs)
6695
6696 def SetUseBestVisual(*args, **kwargs):
6697 """
6698 SetUseBestVisual(self, bool flag)
6699
c24da6d6
RD		 6700 Set whether the app should try to use the best available visual on
6701 systems where more than one is available, (Sun, SGI, XFree86 4, etc.)
d55e5bfc
RD		 6702 """
6703 return _core_.PyApp_SetUseBestVisual(*args, **kwargs)
6704
6705 def GetUseBestVisual(*args, **kwargs):
6706 """
6707 GetUseBestVisual(self) -> bool
6708
6709 Get current UseBestVisual setting.
6710 """
6711 return _core_.PyApp_GetUseBestVisual(*args, **kwargs)
6712
6713 def SetPrintMode(*args, **kwargs):
6714 """SetPrintMode(self, int mode)"""
6715 return _core_.PyApp_SetPrintMode(*args, **kwargs)
6716
6717 def GetPrintMode(*args, **kwargs):
6718 """GetPrintMode(self) -> int"""
6719 return _core_.PyApp_GetPrintMode(*args, **kwargs)
6720
6721 def SetAssertMode(*args, **kwargs):
6722 """
6723 SetAssertMode(self, int mode)
6724
79fccf9d 6725 Set the OnAssert behaviour for debug and hybrid builds.
d55e5bfc
RD		 6726 """
6727 return _core_.PyApp_SetAssertMode(*args, **kwargs)
6728
6729 def GetAssertMode(*args, **kwargs):
6730 """
6731 GetAssertMode(self) -> int
6732
6733 Get the current OnAssert behaviour setting.
6734 """
6735 return _core_.PyApp_GetAssertMode(*args, **kwargs)
6736
6737 def GetMacSupportPCMenuShortcuts(*args, **kwargs):
c24da6d6 6738 """GetMacSupportPCMenuShortcuts() -> bool"""
d55e5bfc
RD		 6739 return _core_.PyApp_GetMacSupportPCMenuShortcuts(*args, **kwargs)
6740
6741 GetMacSupportPCMenuShortcuts = staticmethod(GetMacSupportPCMenuShortcuts)
6742 def GetMacAboutMenuItemId(*args, **kwargs):
c24da6d6 6743 """GetMacAboutMenuItemId() -> long"""
d55e5bfc
RD		 6744 return _core_.PyApp_GetMacAboutMenuItemId(*args, **kwargs)
6745
6746 GetMacAboutMenuItemId = staticmethod(GetMacAboutMenuItemId)
6747 def GetMacPreferencesMenuItemId(*args, **kwargs):
c24da6d6 6748 """GetMacPreferencesMenuItemId() -> long"""
d55e5bfc
RD		 6749 return _core_.PyApp_GetMacPreferencesMenuItemId(*args, **kwargs)
6750
6751 GetMacPreferencesMenuItemId = staticmethod(GetMacPreferencesMenuItemId)
6752 def GetMacExitMenuItemId(*args, **kwargs):
c24da6d6 6753 """GetMacExitMenuItemId() -> long"""
d55e5bfc
RD		 6754 return _core_.PyApp_GetMacExitMenuItemId(*args, **kwargs)
6755
6756 GetMacExitMenuItemId = staticmethod(GetMacExitMenuItemId)
6757 def GetMacHelpMenuTitleName(*args, **kwargs):
c24da6d6 6758 """GetMacHelpMenuTitleName() -> String"""
d55e5bfc
RD		 6759 return _core_.PyApp_GetMacHelpMenuTitleName(*args, **kwargs)
6760
6761 GetMacHelpMenuTitleName = staticmethod(GetMacHelpMenuTitleName)
6762 def SetMacSupportPCMenuShortcuts(*args, **kwargs):
c24da6d6 6763 """SetMacSupportPCMenuShortcuts(bool val)"""
d55e5bfc
RD		 6764 return _core_.PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs)
6765
6766 SetMacSupportPCMenuShortcuts = staticmethod(SetMacSupportPCMenuShortcuts)
6767 def SetMacAboutMenuItemId(*args, **kwargs):
c24da6d6 6768 """SetMacAboutMenuItemId(long val)"""
d55e5bfc
RD		 6769 return _core_.PyApp_SetMacAboutMenuItemId(*args, **kwargs)
6770
6771 SetMacAboutMenuItemId = staticmethod(SetMacAboutMenuItemId)
6772 def SetMacPreferencesMenuItemId(*args, **kwargs):
c24da6d6 6773 """SetMacPreferencesMenuItemId(long val)"""
d55e5bfc
RD		 6774 return _core_.PyApp_SetMacPreferencesMenuItemId(*args, **kwargs)
6775
6776 SetMacPreferencesMenuItemId = staticmethod(SetMacPreferencesMenuItemId)
6777 def SetMacExitMenuItemId(*args, **kwargs):
c24da6d6 6778 """SetMacExitMenuItemId(long val)"""
d55e5bfc
RD		 6779 return _core_.PyApp_SetMacExitMenuItemId(*args, **kwargs)
6780
6781 SetMacExitMenuItemId = staticmethod(SetMacExitMenuItemId)
6782 def SetMacHelpMenuTitleName(*args, **kwargs):
c24da6d6 6783 """SetMacHelpMenuTitleName(String val)"""
d55e5bfc
RD		 6784 return _core_.PyApp_SetMacHelpMenuTitleName(*args, **kwargs)
6785
6786 SetMacHelpMenuTitleName = staticmethod(SetMacHelpMenuTitleName)
6787 def _BootstrapApp(*args, **kwargs):
6788 """
6789 _BootstrapApp(self)
6790
6791 For internal use only
6792 """
6793 return _core_.PyApp__BootstrapApp(*args, **kwargs)
6794
6795 def GetComCtl32Version(*args, **kwargs):
6796 """
c24da6d6 6797 GetComCtl32Version() -> int
d55e5bfc 6798
c24da6d6
RD		 6799 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
6800 it wasn't found at all. Raises an exception on non-Windows platforms.
d55e5bfc
RD		 6801 """
6802 return _core_.PyApp_GetComCtl32Version(*args, **kwargs)
6803
6804 GetComCtl32Version = staticmethod(GetComCtl32Version)
554f62e9
RD		 6805PyApp_swigregister = _core_.PyApp_swigregister
6806PyApp_swigregister(PyApp)
d55e5bfc 6807
554f62e9
RD		 6808def PyApp_IsMainLoopRunning(*args):
6809 """
84f85550
RD		 6810 PyApp_IsMainLoopRunning() -> bool
6811
6812 Returns True if we're running the main loop, i.e. if the events can
6813 currently be dispatched.
6814 """
554f62e9 6815 return _core_.PyApp_IsMainLoopRunning(*args)
84f85550 6816
554f62e9
RD		 6817def PyApp_GetMacSupportPCMenuShortcuts(*args):
6818 """PyApp_GetMacSupportPCMenuShortcuts() -> bool"""
6819 return _core_.PyApp_GetMacSupportPCMenuShortcuts(*args)
d55e5bfc 6820
554f62e9
RD		 6821def PyApp_GetMacAboutMenuItemId(*args):
6822 """PyApp_GetMacAboutMenuItemId() -> long"""
6823 return _core_.PyApp_GetMacAboutMenuItemId(*args)
d55e5bfc 6824
554f62e9
RD		 6825def PyApp_GetMacPreferencesMenuItemId(*args):
6826 """PyApp_GetMacPreferencesMenuItemId() -> long"""
6827 return _core_.PyApp_GetMacPreferencesMenuItemId(*args)
d55e5bfc 6828
554f62e9
RD		 6829def PyApp_GetMacExitMenuItemId(*args):
6830 """PyApp_GetMacExitMenuItemId() -> long"""
6831 return _core_.PyApp_GetMacExitMenuItemId(*args)
d55e5bfc 6832
554f62e9
RD		 6833def PyApp_GetMacHelpMenuTitleName(*args):
6834 """PyApp_GetMacHelpMenuTitleName() -> String"""
6835 return _core_.PyApp_GetMacHelpMenuTitleName(*args)
d55e5bfc
RD		 6836
6837def PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs):
554f62e9
RD		 6838 """PyApp_SetMacSupportPCMenuShortcuts(bool val)"""
6839 return _core_.PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs)
d55e5bfc
RD		 6840
6841def PyApp_SetMacAboutMenuItemId(*args, **kwargs):
554f62e9
RD		 6842 """PyApp_SetMacAboutMenuItemId(long val)"""
6843 return _core_.PyApp_SetMacAboutMenuItemId(*args, **kwargs)
d55e5bfc
RD		 6844
6845def PyApp_SetMacPreferencesMenuItemId(*args, **kwargs):
554f62e9
RD		 6846 """PyApp_SetMacPreferencesMenuItemId(long val)"""
6847 return _core_.PyApp_SetMacPreferencesMenuItemId(*args, **kwargs)
d55e5bfc
RD		 6848
6849def PyApp_SetMacExitMenuItemId(*args, **kwargs):
554f62e9
RD		 6850 """PyApp_SetMacExitMenuItemId(long val)"""
6851 return _core_.PyApp_SetMacExitMenuItemId(*args, **kwargs)
d55e5bfc
RD		 6852
6853def PyApp_SetMacHelpMenuTitleName(*args, **kwargs):
554f62e9
RD		 6854 """PyApp_SetMacHelpMenuTitleName(String val)"""
6855 return _core_.PyApp_SetMacHelpMenuTitleName(*args, **kwargs)
d55e5bfc 6856
554f62e9
RD		 6857def PyApp_GetComCtl32Version(*args):
6858 """
d55e5bfc
RD		 6859 PyApp_GetComCtl32Version() -> int
6860
c24da6d6
RD		 6861 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
6862 it wasn't found at all. Raises an exception on non-Windows platforms.
d55e5bfc 6863 """
554f62e9 6864 return _core_.PyApp_GetComCtl32Version(*args)
d55e5bfc
RD		 6865
6866#---------------------------------------------------------------------------
6867
6868
554f62e9
RD		 6869def Exit(*args):
6870 """
d55e5bfc
RD		 6871 Exit()
6872
6873 Force an exit of the application. Convenience for wx.GetApp().Exit()
6874 """
554f62e9 6875 return _core_.Exit(*args)
d55e5bfc 6876
554f62e9
RD		 6877def Yield(*args):
6878 """
d55e5bfc
RD		 6879 Yield() -> bool
6880
6881 Yield to other apps/messages. Convenience for wx.GetApp().Yield()
6882 """
554f62e9 6883 return _core_.Yield(*args)
d55e5bfc 6884
554f62e9
RD		 6885def YieldIfNeeded(*args):
6886 """
d55e5bfc
RD		 6887 YieldIfNeeded() -> bool
6888
6889 Yield to other apps/messages. Convenience for wx.GetApp().Yield(True)
6890 """
554f62e9 6891 return _core_.YieldIfNeeded(*args)
d55e5bfc
RD		 6892
6893def SafeYield(*args, **kwargs):
554f62e9 6894 """
d55e5bfc
RD		 6895 SafeYield(Window win=None, bool onlyIfNeeded=False) -> bool
6896
c24da6d6
RD		 6897 This function is similar to `wx.Yield`, except that it disables the
6898 user input to all program windows before calling `wx.Yield` and
6899 re-enables it again afterwards. If ``win`` is not None, this window
6900 will remain enabled, allowing the implementation of some limited user
6901 interaction.
d55e5bfc 6902
c24da6d6 6903 :Returns: the result of the call to `wx.Yield`.
d55e5bfc 6904 """
554f62e9 6905 return _core_.SafeYield(*args, **kwargs)
d55e5bfc 6906
554f62e9
RD		 6907def WakeUpIdle(*args):
6908 """
d55e5bfc
RD		 6909 WakeUpIdle()
6910
c24da6d6
RD		 6911 Cause the message queue to become empty again, so idle events will be
6912 sent.
d55e5bfc 6913 """
554f62e9 6914 return _core_.WakeUpIdle(*args)
d55e5bfc
RD		 6915
6916def PostEvent(*args, **kwargs):
554f62e9 6917 """
d55e5bfc
RD		 6918 PostEvent(EvtHandler dest, Event event)
6919
c24da6d6
RD		 6920 Send an event to a window or other wx.EvtHandler to be processed
6921 later.
d55e5bfc 6922 """
554f62e9 6923 return _core_.PostEvent(*args, **kwargs)
d55e5bfc 6924
554f62e9
RD		 6925def App_CleanUp(*args):
6926 """
d55e5bfc
RD		 6927 App_CleanUp()
6928
79fccf9d 6929 For internal use only, it is used to cleanup after wxWidgets when
c24da6d6 6930 Python shuts down.
d55e5bfc 6931 """
554f62e9 6932 return _core_.App_CleanUp(*args)
d55e5bfc 6933
554f62e9
RD		 6934def GetApp(*args):
6935 """
d55e5bfc
RD		 6936 GetApp() -> PyApp
6937
6938 Return a reference to the current wx.App object.
6939 """
554f62e9 6940 return _core_.GetApp(*args)
5cbf236d
RD		 6941
6942def SetDefaultPyEncoding(*args, **kwargs):
554f62e9 6943 """
5cbf236d
RD		 6944 SetDefaultPyEncoding(string encoding)
6945
6946 Sets the encoding that wxPython will use when it needs to convert a
6947 Python string or unicode object to or from a wxString.
62d32a5f
RD		 6948
6949 The default encoding is the value of ``locale.getdefaultlocale()[1]``
6950 but please be aware that the default encoding within the same locale
6951 may be slightly different on different platforms. For example, please
6952 see http://www.alanwood.net/demos/charsetdiffs.html for differences
6953 between the common latin/roman encodings.
5cbf236d 6954 """
554f62e9 6955 return _core_.SetDefaultPyEncoding(*args, **kwargs)
5cbf236d 6956
554f62e9
RD		 6957def GetDefaultPyEncoding(*args):
6958 """
5cbf236d
RD		 6959 GetDefaultPyEncoding() -> string
6960
6961 Gets the current encoding that wxPython will use when it needs to
6962 convert a Python string or unicode object to or from a wxString.
6963 """
554f62e9 6964 return _core_.GetDefaultPyEncoding(*args)
d55e5bfc
RD		 6965#----------------------------------------------------------------------
6966
6967class PyOnDemandOutputWindow:
6968 """
6969 A class that can be used for redirecting Python's stdout and
6970 stderr streams. It will do nothing until something is wrriten to
6971 the stream at which point it will create a Frame with a text area
6972 and write the text there.
6973 """
6974 def __init__(self, title = "wxPython: stdout/stderr"):
6975 self.frame = None
6976 self.title = title
412d302d
RD		 6977 self.pos = wx.DefaultPosition
6978 self.size = (450, 300)
d55e5bfc
RD		 6979 self.parent = None
6980
6981 def SetParent(self, parent):
6982 """Set the window to be used as the popup Frame's parent."""
6983 self.parent = parent
6984
6985
6986 def CreateOutputWindow(self, st):
412d302d
RD		 6987 self.frame = wx.Frame(self.parent, -1, self.title, self.pos, self.size,
6988 style=wx.DEFAULT_FRAME_STYLE)
d55e5bfc 6989 self.text = wx.TextCtrl(self.frame, -1, "",
412d302d 6990 style=wx.TE_MULTILINE|wx.TE_READONLY)
d55e5bfc 6991 self.text.AppendText(st)
d55e5bfc
RD		 6992 self.frame.Show(True)
6993 EVT_CLOSE(self.frame, self.OnCloseWindow)
6994
6995
6996 def OnCloseWindow(self, event):
6997 if self.frame is not None:
6998 self.frame.Destroy()
6999 self.frame = None
7000 self.text = None
7001
7002
7003 # These methods provide the file-like output behaviour.
7004 def write(self, text):
7005 """
7006 Create the output window if needed and write the string to it.
7007 If not called in the context of the gui thread then uses
7008 CallAfter to do the work there.
7009 """
7010 if self.frame is None:
7011 if not wx.Thread_IsMain():
7012 wx.CallAfter(self.CreateOutputWindow, text)
7013 else:
7014 self.CreateOutputWindow(text)
7015 else:
7016 if not wx.Thread_IsMain():
7017 wx.CallAfter(self.text.AppendText, text)
7018 else:
7019 self.text.AppendText(text)
7020
7021
7022 def close(self):
7023 if self.frame is not None:
7024 wx.CallAfter(self.frame.Close)
7025
7026
19272049
RD		 7027 def flush(self):
7028 pass
7029
7030
d55e5bfc
RD		 7031
7032#----------------------------------------------------------------------
7033
7034_defRedirect = (wx.Platform == '__WXMSW__' or wx.Platform == '__WXMAC__')
7035
7036class App(wx.PyApp):
7037 """
c24da6d6
RD		 7038 The ``wx.App`` class represents the application and is used to:
7039
7040 * bootstrap the wxPython system and initialize the underlying
7041 gui toolkit
7042 * set and get application-wide properties
7043 * implement the windowing system main message or event loop,
7044 and to dispatch events to window instances
7045 * etc.
7046
7047 Every application must have a ``wx.App`` instance, and all
7048 creation of UI objects should be delayed until after the
7049 ``wx.App`` object has been created in order to ensure that the gui
7050 platform and wxWidgets have been fully initialized.
7051
7052 Normally you would derive from this class and implement an
7053 ``OnInit`` method that creates a frame and then calls
7054 ``self.SetTopWindow(frame)``.
7055
7056 :see: `wx.PySimpleApp` for a simpler app class that can be used
79fccf9d 7057 directly.
d55e5bfc 7058 """
c24da6d6 7059
d55e5bfc
RD		 7060 outputWindowClass = PyOnDemandOutputWindow
7061
c24da6d6
RD		 7062 def __init__(self, redirect=_defRedirect, filename=None,
7063 useBestVisual=False, clearSigInt=True):
7064 """
7065 Construct a ``wx.App`` object.
7066
7067 :param redirect: Should ``sys.stdout`` and ``sys.stderr`` be
7068 redirected? Defaults to True on Windows and Mac, False
7069 otherwise. If `filename` is None then output will be
7070 redirected to a window that pops up as needed. (You can
7071 control what kind of window is created for the output by
7072 resetting the class variable ``outputWindowClass`` to a
7073 class of your choosing.)
7074
7075 :param filename: The name of a file to redirect output to, if
7076 redirect is True.
7077
7078 :param useBestVisual: Should the app try to use the best
7079 available visual provided by the system (only relevant on
7080 systems that have more than one visual.) This parameter
7081 must be used instead of calling `SetUseBestVisual` later
7082 on because it must be set before the underlying GUI
7083 toolkit is initialized.
7084
7085 :param clearSigInt: Should SIGINT be cleared? This allows the
7086 app to terminate upon a Ctrl-C in the console like other
7087 GUI apps will.
7088
7089 :note: You should override OnInit to do applicaition
7090 initialization to ensure that the system, toolkit and
7091 wxWidgets are fully initialized.
7092 """
d55e5bfc
RD		 7093 wx.PyApp.__init__(self)
7094
7095 if wx.Platform == "__WXMAC__":
7096 try:
7097 import MacOS
7098 if not MacOS.WMAvailable():
7099 print """\
7100This program needs access to the screen. Please run with 'pythonw',
7101not 'python', and only when you are logged in on the main display of
7102your Mac."""
7103 _sys.exit(1)
b1f29bf7
RD		 7104 except SystemExit:
7105 raise
d55e5bfc
RD		 7106 except:
7107 pass
7108
7109 # This has to be done before OnInit
7110 self.SetUseBestVisual(useBestVisual)
7111
7112 # Set the default handler for SIGINT. This fixes a problem
7113 # where if Ctrl-C is pressed in the console that started this
7114 # app then it will not appear to do anything, (not even send
7115 # KeyboardInterrupt???) but will later segfault on exit. By
7116 # setting the default handler then the app will exit, as
7117 # expected (depending on platform.)
c24da6d6
RD		 7118 if clearSigInt:
7119 try:
7120 import signal
7121 signal.signal(signal.SIGINT, signal.SIG_DFL)
7122 except:
7123 pass
d55e5bfc
RD		 7124
7125 # Save and redirect the stdio to a window?
7126 self.stdioWin = None
7127 self.saveStdio = (_sys.stdout, _sys.stderr)
7128 if redirect:
7129 self.RedirectStdio(filename)
7130
8fb0e70a
RD		 7131 # Use Python's install prefix as the default
7132 wx.StandardPaths.Get().SetInstallPrefix(_sys.prefix)
7133
d55e5bfc
RD		 7134 # This finishes the initialization of wxWindows and then calls
7135 # the OnInit that should be present in the derived class
7136 self._BootstrapApp()
7137
7138
66af7a75
RD		 7139 def __del__(self, destroy=wx.PyApp.__del__):
7140 self.RestoreStdio() # Just in case the MainLoop was overridden
7141 destroy(self)
d55e5bfc 7142
70b7a5fe
RD		 7143 def Destroy(self):
7144 wx.PyApp.Destroy(self)
7145 self.thisown = 0
d55e5bfc
RD		 7146
7147 def SetTopWindow(self, frame):
7148 """Set the \"main\" top level window"""
7149 if self.stdioWin:
7150 self.stdioWin.SetParent(frame)
7151 wx.PyApp.SetTopWindow(self, frame)
7152
7153
7154 def MainLoop(self):
7155 """Execute the main GUI event loop"""
7156 wx.PyApp.MainLoop(self)
7157 self.RestoreStdio()
7158
7159
7160 def RedirectStdio(self, filename=None):
7161 """Redirect sys.stdout and sys.stderr to a file or a popup window."""
7162 if filename:
7163 _sys.stdout = _sys.stderr = open(filename, 'a')
7164 else:
7165 self.stdioWin = self.outputWindowClass()
7166 _sys.stdout = _sys.stderr = self.stdioWin
7167
7168
7169 def RestoreStdio(self):
66af7a75
RD		 7170 try:
7171 _sys.stdout, _sys.stderr = self.saveStdio
7172 except:
7173 pass
d55e5bfc
RD		 7174
7175
412d302d
RD		 7176 def SetOutputWindowAttributes(self, title=None, pos=None, size=None):
7177 """
7178 Set the title, position and/or size of the output window if
f5b96ee1
RD		 7179 the stdio has been redirected. This should be called before
7180 any output would cause the output window to be created.
412d302d
RD		 7181 """
7182 if self.stdioWin:
7183 if title is not None:
7184 self.stdioWin.title = title
7185 if pos is not None:
7186 self.stdioWin.pos = pos
7187 if size is not None:
7188 self.stdioWin.size = size
7189
7190
7191
d55e5bfc 7192
c24da6d6 7193# change from wx.PyApp_XX to wx.App_XX
d55e5bfc
RD		 7194App_GetMacSupportPCMenuShortcuts = _core_.PyApp_GetMacSupportPCMenuShortcuts
7195App_GetMacAboutMenuItemId = _core_.PyApp_GetMacAboutMenuItemId
7196App_GetMacPreferencesMenuItemId = _core_.PyApp_GetMacPreferencesMenuItemId
7197App_GetMacExitMenuItemId = _core_.PyApp_GetMacExitMenuItemId
7198App_GetMacHelpMenuTitleName = _core_.PyApp_GetMacHelpMenuTitleName
7199App_SetMacSupportPCMenuShortcuts = _core_.PyApp_SetMacSupportPCMenuShortcuts
7200App_SetMacAboutMenuItemId = _core_.PyApp_SetMacAboutMenuItemId
7201App_SetMacPreferencesMenuItemId = _core_.PyApp_SetMacPreferencesMenuItemId
7202App_SetMacExitMenuItemId = _core_.PyApp_SetMacExitMenuItemId
7203App_SetMacHelpMenuTitleName = _core_.PyApp_SetMacHelpMenuTitleName
7204App_GetComCtl32Version = _core_.PyApp_GetComCtl32Version
7205
7206#----------------------------------------------------------------------------
7207
7208class PySimpleApp(wx.App):
7209 """
7210 A simple application class. You can just create one of these and
7211 then then make your top level windows later, and not have to worry
c24da6d6 7212 about OnInit. For example::
d55e5bfc 7213
c24da6d6
RD		 7214 app = wx.PySimpleApp()
7215 frame = wx.Frame(None, title='Hello World')
7216 frame.Show()
7217 app.MainLoop()
7218
7219 :see: `wx.App`
7220 """
7221
7222 def __init__(self, redirect=False, filename=None,
7223 useBestVisual=False, clearSigInt=True):
7224 """
7225 :see: `wx.App.__init__`
7226 """
7227 wx.App.__init__(self, redirect, filename, useBestVisual, clearSigInt)
d55e5bfc
RD		 7228
7229 def OnInit(self):
d55e5bfc
RD		 7230 return True
7231
7232
c24da6d6 7233
d55e5bfc
RD		 7234# Is anybody using this one?
7235class PyWidgetTester(wx.App):
7236 def __init__(self, size = (250, 100)):
7237 self.size = size
7238 wx.App.__init__(self, 0)
7239
7240 def OnInit(self):
7241 self.frame = wx.Frame(None, -1, "Widget Tester", pos=(0,0), size=self.size)
7242 self.SetTopWindow(self.frame)
7243 return True
7244
c24da6d6
RD		 7245 def SetWidget(self, widgetClass, *args, **kwargs):
7246 w = widgetClass(self.frame, *args, **kwargs)
d55e5bfc
RD		 7247 self.frame.Show(True)
7248
7249#----------------------------------------------------------------------------
7250# DO NOT hold any other references to this object. This is how we
c24da6d6 7251# know when to cleanup system resources that wxWidgets is holding. When
d55e5bfc 7252# the sys module is unloaded, the refcount on sys.__wxPythonCleanup
c24da6d6 7253# goes to zero and it calls the wx.App_CleanUp function.
d55e5bfc
RD		 7254
7255class __wxPyCleanup:
7256 def __init__(self):
7257 self.cleanup = _core_.App_CleanUp
7258 def __del__(self):
7259 self.cleanup()
7260
7261_sys.__wxPythonCleanup = __wxPyCleanup()
7262
7263## # another possible solution, but it gets called too early...
c24da6d6
RD		 7264## import atexit
7265## atexit.register(_core_.wxApp_CleanUp)
d55e5bfc
RD		 7266
7267
7268#----------------------------------------------------------------------------
7269
7270#---------------------------------------------------------------------------
7271
ae8162c8 7272class EventLoop(object):
093d3ff1 7273 """Proxy of C++ EventLoop class"""
554f62e9
RD		 7274 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7275 __repr__ = _swig_repr
7276 def __init__(self, *args, **kwargs):
ae8162c8 7277 """__init__(self) -> EventLoop"""
554f62e9
RD		 7278 _core_.EventLoop_swiginit(self,_core_.new_EventLoop(*args, **kwargs))
7279 __swig_destroy__ = _core_.delete_EventLoop
7280 __del__ = lambda self : None;
ae8162c8
RD		 7281 def Run(*args, **kwargs):
7282 """Run(self) -> int"""
7283 return _core_.EventLoop_Run(*args, **kwargs)
7284
7285 def Exit(*args, **kwargs):
7286 """Exit(self, int rc=0)"""
7287 return _core_.EventLoop_Exit(*args, **kwargs)
7288
7289 def Pending(*args, **kwargs):
7290 """Pending(self) -> bool"""
7291 return _core_.EventLoop_Pending(*args, **kwargs)
7292
7293 def Dispatch(*args, **kwargs):
7294 """Dispatch(self) -> bool"""
7295 return _core_.EventLoop_Dispatch(*args, **kwargs)
7296
7297 def IsRunning(*args, **kwargs):
7298 """IsRunning(self) -> bool"""
7299 return _core_.EventLoop_IsRunning(*args, **kwargs)
7300
7301 def GetActive(*args, **kwargs):
7302 """GetActive() -> EventLoop"""
7303 return _core_.EventLoop_GetActive(*args, **kwargs)
7304
7305 GetActive = staticmethod(GetActive)
7306 def SetActive(*args, **kwargs):
7307 """SetActive(EventLoop loop)"""
7308 return _core_.EventLoop_SetActive(*args, **kwargs)
7309
7310 SetActive = staticmethod(SetActive)
554f62e9
RD		 7311EventLoop_swigregister = _core_.EventLoop_swigregister
7312EventLoop_swigregister(EventLoop)
ae8162c8 7313
554f62e9
RD		 7314def EventLoop_GetActive(*args):
7315 """EventLoop_GetActive() -> EventLoop"""
7316 return _core_.EventLoop_GetActive(*args)
ae8162c8
RD		 7317
7318def EventLoop_SetActive(*args, **kwargs):
554f62e9
RD		 7319 """EventLoop_SetActive(EventLoop loop)"""
7320 return _core_.EventLoop_SetActive(*args, **kwargs)
ae8162c8 7321
7449af73
RD		 7322class EventLoopActivator(object):
7323 """Proxy of C++ EventLoopActivator class"""
554f62e9
RD		 7324 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7325 __repr__ = _swig_repr
7326 def __init__(self, *args, **kwargs):
7449af73 7327 """__init__(self, EventLoop evtLoop) -> EventLoopActivator"""
554f62e9
RD		 7328 _core_.EventLoopActivator_swiginit(self,_core_.new_EventLoopActivator(*args, **kwargs))
7329 __swig_destroy__ = _core_.delete_EventLoopActivator
7330 __del__ = lambda self : None;
7331EventLoopActivator_swigregister = _core_.EventLoopActivator_swigregister
7332EventLoopActivator_swigregister(EventLoopActivator)
7449af73 7333
ae8162c8
RD		 7334#---------------------------------------------------------------------------
7335
d55e5bfc 7336class AcceleratorEntry(object):
c24da6d6
RD		 7337 """
7338 A class used to define items in an `wx.AcceleratorTable`. wxPython
7339 programs can choose to use wx.AcceleratorEntry objects, but using a
7340 list of 3-tuple of integers (flags, keyCode, cmdID) usually works just
79fccf9d 7341 as well. See `__init__` for of the tuple values.
c24da6d6
RD		 7342
7343 :see: `wx.AcceleratorTable`
7344 """
554f62e9
RD		 7345 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7346 __repr__ = _swig_repr
7347 def __init__(self, *args, **kwargs):
c24da6d6
RD		 7348 """
7349 __init__(self, int flags=0, int keyCode=0, int cmdID=0) -> AcceleratorEntry
7350
7351 Construct a wx.AcceleratorEntry.
c24da6d6 7352 """
554f62e9
RD		 7353 _core_.AcceleratorEntry_swiginit(self,_core_.new_AcceleratorEntry(*args, **kwargs))
7354 __swig_destroy__ = _core_.delete_AcceleratorEntry
7355 __del__ = lambda self : None;
d55e5bfc 7356 def Set(*args, **kwargs):
c24da6d6
RD		 7357 """
7358 Set(self, int flags, int keyCode, int cmd)
d55e5bfc 7359
c24da6d6
RD		 7360 (Re)set the attributes of a wx.AcceleratorEntry.
7361 :see `__init__`
7362 """
7363 return _core_.AcceleratorEntry_Set(*args, **kwargs)
d55e5bfc
RD		 7364
7365 def GetFlags(*args, **kwargs):
c24da6d6
RD		 7366 """
7367 GetFlags(self) -> int
7368
7369 Get the AcceleratorEntry's flags.
7370 """
d55e5bfc
RD		 7371 return _core_.AcceleratorEntry_GetFlags(*args, **kwargs)
7372
7373 def GetKeyCode(*args, **kwargs):
c24da6d6
RD		 7374 """
7375 GetKeyCode(self) -> int
7376
7377 Get the AcceleratorEntry's keycode.
7378 """
d55e5bfc
RD		 7379 return _core_.AcceleratorEntry_GetKeyCode(*args, **kwargs)
7380
7381 def GetCommand(*args, **kwargs):
c24da6d6
RD		 7382 """
7383 GetCommand(self) -> int
7384
7385 Get the AcceleratorEntry's command ID.
7386 """
d55e5bfc
RD		 7387 return _core_.AcceleratorEntry_GetCommand(*args, **kwargs)
7388
554f62e9
RD		 7389AcceleratorEntry_swigregister = _core_.AcceleratorEntry_swigregister
7390AcceleratorEntry_swigregister(AcceleratorEntry)
d55e5bfc
RD		 7391
7392class AcceleratorTable(Object):
c24da6d6
RD		 7393 """
7394 An accelerator table allows the application to specify a table of
7395 keyboard shortcuts for menus or other commands. On Windows, menu or
7396 button commands are supported; on GTK, only menu commands are
7397 supported.
c24da6d6 7398 """
554f62e9
RD		 7399 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7400 __repr__ = _swig_repr
7401 def __init__(self, *args, **kwargs):
d55e5bfc
RD		 7402 """
7403 __init__(entries) -> AcceleratorTable
7404
c24da6d6
RD		 7405 Construct an AcceleratorTable from a list of `wx.AcceleratorEntry`
7406 items or or of 3-tuples (flags, keyCode, cmdID)
7407
7408 :see: `wx.AcceleratorEntry`
d55e5bfc 7409 """
554f62e9
RD		 7410 _core_.AcceleratorTable_swiginit(self,_core_.new_AcceleratorTable(*args, **kwargs))
7411 __swig_destroy__ = _core_.delete_AcceleratorTable
7412 __del__ = lambda self : None;
d55e5bfc
RD		 7413 def Ok(*args, **kwargs):
7414 """Ok(self) -> bool"""
7415 return _core_.AcceleratorTable_Ok(*args, **kwargs)
7416
554f62e9
RD		 7417AcceleratorTable_swigregister = _core_.AcceleratorTable_swigregister
7418AcceleratorTable_swigregister(AcceleratorTable)
d55e5bfc
RD		 7419
7420
7421def GetAccelFromString(*args, **kwargs):
554f62e9
RD		 7422 """GetAccelFromString(String label) -> AcceleratorEntry"""
7423 return _core_.GetAccelFromString(*args, **kwargs)
d55e5bfc
RD		 7424#---------------------------------------------------------------------------
7425
7426class VisualAttributes(object):
7427 """struct containing all the visual attributes of a control"""
554f62e9
RD		 7428 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7429 __repr__ = _swig_repr
7430 def __init__(self, *args, **kwargs):
d55e5bfc
RD		 7431 """
7432 __init__(self) -> VisualAttributes
7433
7434 struct containing all the visual attributes of a control
7435 """
554f62e9
RD		 7436 _core_.VisualAttributes_swiginit(self,_core_.new_VisualAttributes(*args, **kwargs))
7437 __swig_destroy__ = _core_.delete_VisualAttributes
7438 __del__ = lambda self : None;
d55e5bfc
RD		 7439 font = property(_core_.VisualAttributes_font_get, _core_.VisualAttributes_font_set)
7440 colFg = property(_core_.VisualAttributes_colFg_get, _core_.VisualAttributes_colFg_set)
7441 colBg = property(_core_.VisualAttributes_colBg_get, _core_.VisualAttributes_colBg_set)
554f62e9
RD		 7442VisualAttributes_swigregister = _core_.VisualAttributes_swigregister
7443VisualAttributes_swigregister(VisualAttributes)
d55e5bfc
RD		 7444NullAcceleratorTable = cvar.NullAcceleratorTable
7445PanelNameStr = cvar.PanelNameStr
7446
7447WINDOW_VARIANT_NORMAL = _core_.WINDOW_VARIANT_NORMAL
7448WINDOW_VARIANT_SMALL = _core_.WINDOW_VARIANT_SMALL
7449WINDOW_VARIANT_MINI = _core_.WINDOW_VARIANT_MINI
7450WINDOW_VARIANT_LARGE = _core_.WINDOW_VARIANT_LARGE
7451WINDOW_VARIANT_MAX = _core_.WINDOW_VARIANT_MAX
7452class Window(EvtHandler):
7453 """
7454 wx.Window is the base class for all windows and represents any visible
7455 object on the screen. All controls, top level windows and so on are
7456 wx.Windows. Sizers and device contexts are not however, as they don't
7457 appear on screen themselves.
7458
7459 """
554f62e9
RD		 7460 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7461 __repr__ = _swig_repr
7462 def __init__(self, *args, **kwargs):
d55e5bfc
RD		 7463 """
7464 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
7465 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> Window
7466
7467 Construct and show a generic Window.
7468 """
554f62e9 7469 _core_.Window_swiginit(self,_core_.new_Window(*args, **kwargs))
d55e5bfc
RD		 7470 self._setOORInfo(self)
7471
7472 def Create(*args, **kwargs):
7473 """
7474 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
7475 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> bool
7476
7477 Create the GUI part of the Window for 2-phase creation mode.
7478 """
7479 return _core_.Window_Create(*args, **kwargs)
7480
7481 def Close(*args, **kwargs):
7482 """
7483 Close(self, bool force=False) -> bool
7484
7485 This function simply generates a EVT_CLOSE event whose handler usually
7486 tries to close the window. It doesn't close the window itself,
7487 however. If force is False (the default) then the window's close
7488 handler will be allowed to veto the destruction of the window.
d55e5bfc
RD		 7489 """
7490 return _core_.Window_Close(*args, **kwargs)
7491
7492 def Destroy(*args, **kwargs):
7493 """
7494 Destroy(self) -> bool
7495
7496 Destroys the window safely. Frames and dialogs are not destroyed
7497 immediately when this function is called -- they are added to a list
7498 of windows to be deleted on idle time, when all the window's events
7499 have been processed. This prevents problems with events being sent to
7500 non-existent windows.
7501
7502 Returns True if the window has either been successfully deleted, or it
7503 has been added to the list of windows pending real deletion.
7504 """
7e08d4ef
RD		 7505 val = _core_.Window_Destroy(*args, **kwargs)
7506 args[0].thisown = 0
7507 return val
d55e5bfc
RD		 7508
7509 def DestroyChildren(*args, **kwargs):
7510 """
7511 DestroyChildren(self) -> bool
7512
79fccf9d
RD		 7513 Destroys all children of a window. Called automatically by the
7514 destructor.
d55e5bfc
RD		 7515 """
7516 return _core_.Window_DestroyChildren(*args, **kwargs)
7517
7518 def IsBeingDeleted(*args, **kwargs):
7519 """
7520 IsBeingDeleted(self) -> bool
7521
7522 Is the window in the process of being deleted?
7523 """
7524 return _core_.Window_IsBeingDeleted(*args, **kwargs)
7525
d55e5bfc
RD		 7526 def SetLabel(*args, **kwargs):
7527 """
7528 SetLabel(self, String label)
7529
7530 Set the text which the window shows in its label if applicable.
7531 """
7532 return _core_.Window_SetLabel(*args, **kwargs)
7533
7534 def GetLabel(*args, **kwargs):
7535 """
7536 GetLabel(self) -> String
7537
79fccf9d
RD		 7538 Generic way of getting a label from any window, for identification
7539 purposes. The interpretation of this function differs from class to
7540 class. For frames and dialogs, the value returned is the title. For
7541 buttons or static text controls, it is the button text. This function
7542 can be useful for meta-programs such as testing tools or special-needs
7543 access programs)which need to identify windows by name.
d55e5bfc
RD		 7544 """
7545 return _core_.Window_GetLabel(*args, **kwargs)
7546
7547 def SetName(*args, **kwargs):
7548 """
7549 SetName(self, String name)
7550
79fccf9d
RD		 7551 Sets the window's name. The window name is used for ressource setting
7552 in X, it is not the same as the window title/label
d55e5bfc
RD		 7553 """
7554 return _core_.Window_SetName(*args, **kwargs)
7555
7556 def GetName(*args, **kwargs):
7557 """
7558 GetName(self) -> String
7559
79fccf9d
RD		 7560 Returns the windows name. This name is not guaranteed to be unique;
7561 it is up to the programmer to supply an appropriate name in the window
7562 constructor or via wx.Window.SetName.
d55e5bfc
RD		 7563 """
7564 return _core_.Window_GetName(*args, **kwargs)
7565
7566 def SetWindowVariant(*args, **kwargs):
7567 """
7568 SetWindowVariant(self, int variant)
7569
79fccf9d
RD		 7570 Sets the variant of the window/font size to use for this window, if
7571 the platform supports variants, for example, wxMac.
d55e5bfc
RD		 7572 """
7573 return _core_.Window_SetWindowVariant(*args, **kwargs)
7574
7575 def GetWindowVariant(*args, **kwargs):
7576 """GetWindowVariant(self) -> int"""
7577 return _core_.Window_GetWindowVariant(*args, **kwargs)
7578
7579 def SetId(*args, **kwargs):
7580 """
7581 SetId(self, int winid)
7582
7583 Sets the identifier of the window. Each window has an integer
7584 identifier. If the application has not provided one, an identifier
7585 will be generated. Normally, the identifier should be provided on
7586 creation and should not be modified subsequently.
7587 """
7588 return _core_.Window_SetId(*args, **kwargs)
7589
7590 def GetId(*args, **kwargs):
7591 """
7592 GetId(self) -> int
7593
7594 Returns the identifier of the window. Each window has an integer
7595 identifier. If the application has not provided one (or the default Id
7596 -1 is used) then an unique identifier with a negative value will be
7597 generated.
7598 """
7599 return _core_.Window_GetId(*args, **kwargs)
7600
7601 def NewControlId(*args, **kwargs):
7602 """
c24da6d6 7603 NewControlId() -> int
d55e5bfc
RD		 7604
7605 Generate a control id for the controls which were not given one.
7606 """
7607 return _core_.Window_NewControlId(*args, **kwargs)
7608
7609 NewControlId = staticmethod(NewControlId)
7610 def NextControlId(*args, **kwargs):
7611 """
c24da6d6 7612 NextControlId(int winid) -> int
d55e5bfc
RD		 7613
7614 Get the id of the control following the one with the given
79fccf9d 7615 autogenerated) id
d55e5bfc
RD		 7616 """
7617 return _core_.Window_NextControlId(*args, **kwargs)
7618
7619 NextControlId = staticmethod(NextControlId)
7620 def PrevControlId(*args, **kwargs):
7621 """
c24da6d6 7622 PrevControlId(int winid) -> int
d55e5bfc
RD		 7623
7624 Get the id of the control preceding the one with the given
79fccf9d 7625 autogenerated) id
d55e5bfc
RD		 7626 """
7627 return _core_.Window_PrevControlId(*args, **kwargs)
7628
7629 PrevControlId = staticmethod(PrevControlId)
7630 def SetSize(*args, **kwargs):
7631 """
7632 SetSize(self, Size size)
7633
7634 Sets the size of the window in pixels.
7635 """
7636 return _core_.Window_SetSize(*args, **kwargs)
7637
7638 def SetDimensions(*args, **kwargs):
7639 """
7640 SetDimensions(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)
7641
7642 Sets the position and size of the window in pixels. The sizeFlags
7643 parameter indicates the interpretation of the other params if they are
62d32a5f
RD		 7644 equal to -1.
7645
7646 ======================== ======================================
7647 wx.SIZE_AUTO A -1 indicates that a class-specific
7648 default should be used.
7649 wx.SIZE_USE_EXISTING Axisting dimensions should be used if
7650 -1 values are supplied.
7651 wxSIZE_ALLOW_MINUS_ONE Allow dimensions of -1 and less to be
7652 interpreted as real dimensions, not
7653 default values.
7654 ======================== ======================================
7655
d55e5bfc
RD		 7656 """
7657 return _core_.Window_SetDimensions(*args, **kwargs)
7658
7659 def SetRect(*args, **kwargs):
7660 """
7661 SetRect(self, Rect rect, int sizeFlags=SIZE_AUTO)
7662
7663 Sets the position and size of the window in pixels using a wx.Rect.
7664 """
7665 return _core_.Window_SetRect(*args, **kwargs)
7666
7667 def SetSizeWH(*args, **kwargs):
7668 """
7669 SetSizeWH(self, int width, int height)
7670
7671 Sets the size of the window in pixels.
7672 """
7673 return _core_.Window_SetSizeWH(*args, **kwargs)
7674
7675 def Move(*args, **kwargs):
7676 """
7677 Move(self, Point pt, int flags=SIZE_USE_EXISTING)
7678
7679 Moves the window to the given position.
7680 """
7681 return _core_.Window_Move(*args, **kwargs)
7682
7683 SetPosition = Move
7684 def MoveXY(*args, **kwargs):
7685 """
7686 MoveXY(self, int x, int y, int flags=SIZE_USE_EXISTING)
7687
7688 Moves the window to the given position.
7689 """
7690 return _core_.Window_MoveXY(*args, **kwargs)
7691
f8167d6e
RD		 7692 def SetBestFittingSize(*args, **kwargs):
7693 """
7694 SetBestFittingSize(self, Size size=DefaultSize)
7695
7696 A 'Smart' SetSize that will fill in default size components with the
7697 window's *best size* values. Also set's the minsize for use with sizers.
7698 """
7699 return _core_.Window_SetBestFittingSize(*args, **kwargs)
7700
d55e5bfc
RD		 7701 def Raise(*args, **kwargs):
7702 """
7703 Raise(self)
7704
9d7dfdff
RD		 7705 Raises the window to the top of the window hierarchy. In current
7706 version of wxWidgets this works both for manage and child windows.
d55e5bfc
RD		 7707 """
7708 return _core_.Window_Raise(*args, **kwargs)
7709
7710 def Lower(*args, **kwargs):
7711 """
7712 Lower(self)
7713
9d7dfdff
RD		 7714 Lowers the window to the bottom of the window hierarchy. In current
7715 version of wxWidgets this works both for manage and child windows.
d55e5bfc
RD		 7716 """
7717 return _core_.Window_Lower(*args, **kwargs)
7718
7719 def SetClientSize(*args, **kwargs):
7720 """
7721 SetClientSize(self, Size size)
7722
7723 This sets the size of the window client area in pixels. Using this
7724 function to size a window tends to be more device-independent than
7725 wx.Window.SetSize, since the application need not worry about what
7726 dimensions the border or title bar have when trying to fit the window
7727 around panel items, for example.
7728 """
7729 return _core_.Window_SetClientSize(*args, **kwargs)
7730
7731 def SetClientSizeWH(*args, **kwargs):
7732 """
7733 SetClientSizeWH(self, int width, int height)
7734
7735 This sets the size of the window client area in pixels. Using this
7736 function to size a window tends to be more device-independent than
7737 wx.Window.SetSize, since the application need not worry about what
7738 dimensions the border or title bar have when trying to fit the window
7739 around panel items, for example.
7740 """
7741 return _core_.Window_SetClientSizeWH(*args, **kwargs)
7742
7743 def SetClientRect(*args, **kwargs):
7744 """
7745 SetClientRect(self, Rect rect)
7746
7747 This sets the size of the window client area in pixels. Using this
7748 function to size a window tends to be more device-independent than
7749 wx.Window.SetSize, since the application need not worry about what
7750 dimensions the border or title bar have when trying to fit the window
7751 around panel items, for example.
7752 """
7753 return _core_.Window_SetClientRect(*args, **kwargs)
7754
7755 def GetPosition(*args, **kwargs):
7756 """
7757 GetPosition(self) -> Point
7758
1c71765a
RD		 7759 Get the window's position. Notice that the position is in client
7760 coordinates for child windows and screen coordinates for the top level
7761 ones, use `GetScreenPosition` if you need screen coordinates for all
7762 kinds of windows.
d55e5bfc
RD		 7763 """
7764 return _core_.Window_GetPosition(*args, **kwargs)
7765
7766 def GetPositionTuple(*args, **kwargs):
7767 """
7768 GetPositionTuple() -> (x,y)
7769
1c71765a
RD		 7770 Get the window's position. Notice that the position is in client
7771 coordinates for child windows and screen coordinates for the top level
7772 ones, use `GetScreenPosition` if you need screen coordinates for all
7773 kinds of windows.
d55e5bfc
RD		 7774 """
7775 return _core_.Window_GetPositionTuple(*args, **kwargs)
7776
1c71765a
RD		 7777 def GetScreenPosition(*args, **kwargs):
7778 """
7779 GetScreenPosition(self) -> Point
7780
7781 Get the position of the window in screen coordinantes.
7782 """
7783 return _core_.Window_GetScreenPosition(*args, **kwargs)
7784
7785 def GetScreenPositionTuple(*args, **kwargs):
7786 """
7787 GetScreenPositionTuple() -> (x,y)
7788
7789 Get the position of the window in screen coordinantes.
7790 """
7791 return _core_.Window_GetScreenPositionTuple(*args, **kwargs)
7792
7793 def GetScreenRect(*args, **kwargs):
7794 """
7795 GetScreenRect(self) -> Rect
7796
7797 Returns the size and position of the window in screen coordinantes as
7798 a `wx.Rect` object.
7799 """
7800 return _core_.Window_GetScreenRect(*args, **kwargs)
7801
d55e5bfc
RD		 7802 def GetSize(*args, **kwargs):
7803 """
7804 GetSize(self) -> Size
7805
7806 Get the window size.
7807 """
7808 return _core_.Window_GetSize(*args, **kwargs)
7809
7810 def GetSizeTuple(*args, **kwargs):
7811 """
7812 GetSizeTuple() -> (width, height)
7813
7814 Get the window size.
7815 """
7816 return _core_.Window_GetSizeTuple(*args, **kwargs)
7817
7818 def GetRect(*args, **kwargs):
7819 """
7820 GetRect(self) -> Rect
7821
1c71765a 7822 Returns the size and position of the window as a `wx.Rect` object.
d55e5bfc
RD		 7823 """
7824 return _core_.Window_GetRect(*args, **kwargs)
7825
7826 def GetClientSize(*args, **kwargs):
7827 """
7828 GetClientSize(self) -> Size
7829
7830 This gets the size of the window's 'client area' in pixels. The client
7831 area is the area which may be drawn on by the programmer, excluding
7832 title bar, border, scrollbars, etc.
7833 """
7834 return _core_.Window_GetClientSize(*args, **kwargs)
7835
7836 def GetClientSizeTuple(*args, **kwargs):
7837 """
7838 GetClientSizeTuple() -> (width, height)
7839
7840 This gets the size of the window's 'client area' in pixels. The client
7841 area is the area which may be drawn on by the programmer, excluding
7842 title bar, border, scrollbars, etc.
7843 """
7844 return _core_.Window_GetClientSizeTuple(*args, **kwargs)
7845
7846 def GetClientAreaOrigin(*args, **kwargs):
7847 """
7848 GetClientAreaOrigin(self) -> Point
7849
7850 Get the origin of the client area of the window relative to the
7851 window's top left corner (the client area may be shifted because of
7852 the borders, scrollbars, other decorations...)
7853 """
7854 return _core_.Window_GetClientAreaOrigin(*args, **kwargs)
7855
7856 def GetClientRect(*args, **kwargs):
7857 """
7858 GetClientRect(self) -> Rect
7859
629f3c1b 7860 Get the client area position and size as a `wx.Rect` object.
d55e5bfc
RD		 7861 """
7862 return _core_.Window_GetClientRect(*args, **kwargs)
7863
7864 def GetBestSize(*args, **kwargs):
7865 """
7866 GetBestSize(self) -> Size
7867
248ed943 7868 This function returns the best acceptable minimal size for the
79fccf9d
RD		 7869 window, if applicable. For example, for a static text control, it will
7870 be the minimal size such that the control label is not truncated. For
7871 windows containing subwindows (suzh aswx.Panel), the size returned by
7872 this function will be the same as the size the window would have had
7873 after calling Fit.
d55e5bfc
RD		 7874 """
7875 return _core_.Window_GetBestSize(*args, **kwargs)
7876
7877 def GetBestSizeTuple(*args, **kwargs):
7878 """
7879 GetBestSizeTuple() -> (width, height)
7880
248ed943 7881 This function returns the best acceptable minimal size for the
79fccf9d
RD		 7882 window, if applicable. For example, for a static text control, it will
7883 be the minimal size such that the control label is not truncated. For
7884 windows containing subwindows (suzh aswx.Panel), the size returned by
7885 this function will be the same as the size the window would have had
7886 after calling Fit.
d55e5bfc
RD		 7887 """
7888 return _core_.Window_GetBestSizeTuple(*args, **kwargs)
7889
a001823c
RD		 7890 def InvalidateBestSize(*args, **kwargs):
7891 """
7892 InvalidateBestSize(self)
7893
7894 Reset the cached best size value so it will be recalculated the next
7895 time it is needed.
7896 """
7897 return _core_.Window_InvalidateBestSize(*args, **kwargs)
7898
e2813725
RD		 7899 def CacheBestSize(*args, **kwargs):
7900 """
7901 CacheBestSize(self, Size size)
7902
7903 Cache the best size so it doesn't need to be calculated again, (at least until
7904 some properties of the window change.)
7905 """
7906 return _core_.Window_CacheBestSize(*args, **kwargs)
7907
a001823c
RD		 7908 def GetBestFittingSize(*args, **kwargs):
7909 """
7910 GetBestFittingSize(self) -> Size
7911
7912 This function will merge the window's best size into the window's
7913 minimum size, giving priority to the min size components, and returns
7914 the results.
7915
7916 """
7917 return _core_.Window_GetBestFittingSize(*args, **kwargs)
7918
d55e5bfc
RD		 7919 def GetAdjustedBestSize(*args, **kwargs):
7920 """
7921 GetAdjustedBestSize(self) -> Size
7922
7923 This method is similar to GetBestSize, except in one
7924 thing. GetBestSize should return the minimum untruncated size of the
7925 window, while this method will return the largest of BestSize and any
7926 user specified minimum size. ie. it is the minimum size the window
7927 should currently be drawn at, not the minimal size it can possibly
7928 tolerate.
7929 """
7930 return _core_.Window_GetAdjustedBestSize(*args, **kwargs)
7931
7932 def Center(*args, **kwargs):
7933 """
7934 Center(self, int direction=BOTH)
7935
7936 Centers the window. The parameter specifies the direction for
7937 cetering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may
7938 also include wx.CENTER_ON_SCREEN flag if you want to center the window
7939 on the entire screen and not on its parent window. If it is a
7940 top-level window and has no parent then it will always be centered
7941 relative to the screen.
7942 """
7943 return _core_.Window_Center(*args, **kwargs)
7944
7945 Centre = Center
d55e5bfc
RD		 7946 def CenterOnParent(*args, **kwargs):
7947 """
7948 CenterOnParent(self, int dir=BOTH)
7949
7950 Center with respect to the the parent window
7951 """
7952 return _core_.Window_CenterOnParent(*args, **kwargs)
7953
7954 CentreOnParent = CenterOnParent
7955 def Fit(*args, **kwargs):
7956 """
7957 Fit(self)
7958
7959 Sizes the window so that it fits around its subwindows. This function
7960 won't do anything if there are no subwindows and will only really work
7961 correctly if sizers are used for the subwindows layout. Also, if the
7962 window has exactly one subwindow it is better (faster and the result
7963 is more precise as Fit adds some margin to account for fuzziness of
7964 its calculations) to call window.SetClientSize(child.GetSize())
7965 instead of calling Fit.
7966 """
7967 return _core_.Window_Fit(*args, **kwargs)
7968
7969 def FitInside(*args, **kwargs):
7970 """
7971 FitInside(self)
7972
7973 Similar to Fit, but sizes the interior (virtual) size of a
7974 window. Mainly useful with scrolled windows to reset scrollbars after
7975 sizing changes that do not trigger a size event, and/or scrolled
7976 windows without an interior sizer. This function similarly won't do
7977 anything if there are no subwindows.
7978 """
7979 return _core_.Window_FitInside(*args, **kwargs)
7980
03837c5c 7981 def SetSizeHints(*args, **kwargs):
d55e5bfc
RD		 7982 """
7983 SetSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1,
7984 int incH=-1)
d55e5bfc
RD		 7985
7986 Allows specification of minimum and maximum window sizes, and window
7987 size increments. If a pair of values is not set (or set to -1), the
7988 default values will be used. If this function is called, the user
908b74cd
RD		 7989 will not be able to size the window outside the given bounds (if it is
7990 a top-level window.) Sizers will also inspect the minimum window size
7991 and will use that value if set when calculating layout.
7992
7993 The resizing increments are only significant under Motif or Xt.
d55e5bfc 7994 """
03837c5c 7995 return _core_.Window_SetSizeHints(*args, **kwargs)
d55e5bfc 7996
03837c5c
RD		 7997 def SetSizeHintsSz(*args, **kwargs):
7998 """
7999 SetSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize, Size incSize=DefaultSize)
8000
8001 Allows specification of minimum and maximum window sizes, and window
8002 size increments. If a pair of values is not set (or set to -1), the
8003 default values will be used. If this function is called, the user
8004 will not be able to size the window outside the given bounds (if it is
8005 a top-level window.) Sizers will also inspect the minimum window size
8006 and will use that value if set when calculating layout.
8007
8008 The resizing increments are only significant under Motif or Xt.
8009 """
8010 return _core_.Window_SetSizeHintsSz(*args, **kwargs)
8011
8012 def SetVirtualSizeHints(*args, **kwargs):
d55e5bfc 8013 """
908b74cd 8014 SetVirtualSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1)
d55e5bfc
RD		 8015
8016 Allows specification of minimum and maximum virtual window sizes. If a
8017 pair of values is not set (or set to -1), the default values will be
8018 used. If this function is called, the user will not be able to size
8019 the virtual area of the window outside the given bounds.
8020 """
03837c5c
RD		 8021 return _core_.Window_SetVirtualSizeHints(*args, **kwargs)
8022
8023 def SetVirtualSizeHintsSz(*args, **kwargs):
8024 """
8025 SetVirtualSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize)
8026
8027 Allows specification of minimum and maximum virtual window sizes. If a
8028 pair of values is not set (or set to -1), the default values will be
8029 used. If this function is called, the user will not be able to size
8030 the virtual area of the window outside the given bounds.
8031 """
8032 return _core_.Window_SetVirtualSizeHintsSz(*args, **kwargs)
d55e5bfc 8033
908b74cd
RD		 8034 def GetMaxSize(*args, **kwargs):
8035 """GetMaxSize(self) -> Size"""
8036 return _core_.Window_GetMaxSize(*args, **kwargs)
8037
8038 def GetMinSize(*args, **kwargs):
8039 """GetMinSize(self) -> Size"""
8040 return _core_.Window_GetMinSize(*args, **kwargs)
8041
8042 def SetMinSize(*args, **kwargs):
8043 """
8044 SetMinSize(self, Size minSize)
8045
8046 A more convenient method than `SetSizeHints` for setting just the
8047 min size.
8048 """
8049 return _core_.Window_SetMinSize(*args, **kwargs)
8050
8051 def SetMaxSize(*args, **kwargs):
8052 """
8053 SetMaxSize(self, Size maxSize)
8054
8055 A more convenient method than `SetSizeHints` for setting just the
8056 max size.
8057 """
8058 return _core_.Window_SetMaxSize(*args, **kwargs)
8059
d55e5bfc
RD		 8060 def GetMinWidth(*args, **kwargs):
8061 """GetMinWidth(self) -> int"""
8062 return _core_.Window_GetMinWidth(*args, **kwargs)
8063
8064 def GetMinHeight(*args, **kwargs):
8065 """GetMinHeight(self) -> int"""
8066 return _core_.Window_GetMinHeight(*args, **kwargs)
8067
8068 def GetMaxWidth(*args, **kwargs):
8069 """GetMaxWidth(self) -> int"""
8070 return _core_.Window_GetMaxWidth(*args, **kwargs)
8071
8072 def GetMaxHeight(*args, **kwargs):
8073 """GetMaxHeight(self) -> int"""
8074 return _core_.Window_GetMaxHeight(*args, **kwargs)
8075
d55e5bfc
RD		 8076 def SetVirtualSize(*args, **kwargs):
8077 """
8078 SetVirtualSize(self, Size size)
8079
8080 Set the the virtual size of a window in pixels. For most windows this
8081 is just the client area of the window, but for some like scrolled
8082 windows it is more or less independent of the screen window size.
8083 """
8084 return _core_.Window_SetVirtualSize(*args, **kwargs)
8085
8086 def SetVirtualSizeWH(*args, **kwargs):
8087 """
8088 SetVirtualSizeWH(self, int w, int h)
8089
8090 Set the the virtual size of a window in pixels. For most windows this
8091 is just the client area of the window, but for some like scrolled
8092 windows it is more or less independent of the screen window size.
8093 """
8094 return _core_.Window_SetVirtualSizeWH(*args, **kwargs)
8095
8096 def GetVirtualSize(*args, **kwargs):
8097 """
8098 GetVirtualSize(self) -> Size
8099
8100 Get the the virtual size of the window in pixels. For most windows
8101 this is just the client area of the window, but for some like scrolled
8102 windows it is more or less independent of the screen window size.
8103 """
8104 return _core_.Window_GetVirtualSize(*args, **kwargs)
8105
8106 def GetVirtualSizeTuple(*args, **kwargs):
8107 """
8108 GetVirtualSizeTuple() -> (width, height)
8109
8110 Get the the virtual size of the window in pixels. For most windows
8111 this is just the client area of the window, but for some like scrolled
8112 windows it is more or less independent of the screen window size.
8113 """
8114 return _core_.Window_GetVirtualSizeTuple(*args, **kwargs)
8115
8116 def GetBestVirtualSize(*args, **kwargs):
8117 """
8118 GetBestVirtualSize(self) -> Size
8119
8120 Return the largest of ClientSize and BestSize (as determined by a
8121 sizer, interior children, or other means)
8122 """
8123 return _core_.Window_GetBestVirtualSize(*args, **kwargs)
8124
8125 def Show(*args, **kwargs):
8126 """
8127 Show(self, bool show=True) -> bool
8128
8129 Shows or hides the window. You may need to call Raise for a top level
8130 window if you want to bring it to top, although this is not needed if
8131 Show is called immediately after the frame creation. Returns True if
8132 the window has been shown or hidden or False if nothing was done
8133 because it already was in the requested state.
8134 """
8135 return _core_.Window_Show(*args, **kwargs)
8136
8137 def Hide(*args, **kwargs):
8138 """
8139 Hide(self) -> bool
8140
8141 Equivalent to calling Show(False).
8142 """
8143 return _core_.Window_Hide(*args, **kwargs)
8144
8145 def Enable(*args, **kwargs):
8146 """
8147 Enable(self, bool enable=True) -> bool
8148
8149 Enable or disable the window for user input. Note that when a parent
8150 window is disabled, all of its children are disabled as well and they
8151 are reenabled again when the parent is. Returns true if the window
8152 has been enabled or disabled, false if nothing was done, i.e. if the
8153 window had already been in the specified state.
8154 """
8155 return _core_.Window_Enable(*args, **kwargs)
8156
8157 def Disable(*args, **kwargs):
8158 """
8159 Disable(self) -> bool
8160
8161 Disables the window, same as Enable(false).
8162 """
8163 return _core_.Window_Disable(*args, **kwargs)
8164
8165 def IsShown(*args, **kwargs):
8166 """
8167 IsShown(self) -> bool
8168
8169 Returns true if the window is shown, false if it has been hidden.
8170 """
8171 return _core_.Window_IsShown(*args, **kwargs)
8172
8173 def IsEnabled(*args, **kwargs):
8174 """
8175 IsEnabled(self) -> bool
8176
8177 Returns true if the window is enabled for input, false otherwise.
8178 """
8179 return _core_.Window_IsEnabled(*args, **kwargs)
8180
8181 def SetWindowStyleFlag(*args, **kwargs):
8182 """
8183 SetWindowStyleFlag(self, long style)
8184
79fccf9d
RD		 8185 Sets the style of the window. Please note that some styles cannot be
8186 changed after the window creation and that Refresh() might need to be
8187 called after changing the others for the change to take place
8188 immediately.
d55e5bfc
RD		 8189 """
8190 return _core_.Window_SetWindowStyleFlag(*args, **kwargs)
8191
8192 def GetWindowStyleFlag(*args, **kwargs):
8193 """
8194 GetWindowStyleFlag(self) -> long
8195
8196 Gets the window style that was passed to the constructor or Create
8197 method.
8198 """
8199 return _core_.Window_GetWindowStyleFlag(*args, **kwargs)
8200
8201 SetWindowStyle = SetWindowStyleFlag; GetWindowStyle = GetWindowStyleFlag
8202 def HasFlag(*args, **kwargs):
8203 """
8204 HasFlag(self, int flag) -> bool
8205
8206 Test if the given style is set for this window.
8207 """
8208 return _core_.Window_HasFlag(*args, **kwargs)
8209
8210 def IsRetained(*args, **kwargs):
8211 """
8212 IsRetained(self) -> bool
8213
8214 Returns true if the window is retained, false otherwise. Retained
8215 windows are only available on X platforms.
8216 """
8217 return _core_.Window_IsRetained(*args, **kwargs)
8218
8219 def SetExtraStyle(*args, **kwargs):
8220 """
8221 SetExtraStyle(self, long exStyle)
8222
8223 Sets the extra style bits for the window. Extra styles are the less
8224 often used style bits which can't be set with the constructor or with
8225 SetWindowStyleFlag()
8226 """
8227 return _core_.Window_SetExtraStyle(*args, **kwargs)
8228
8229 def GetExtraStyle(*args, **kwargs):
8230 """
8231 GetExtraStyle(self) -> long
8232
8233 Returns the extra style bits for the window.
8234 """
8235 return _core_.Window_GetExtraStyle(*args, **kwargs)
8236
8237 def MakeModal(*args, **kwargs):
8238 """
8239 MakeModal(self, bool modal=True)
8240
8241 Disables all other windows in the application so that the user can
8242 only interact with this window. Passing False will reverse this
8243 effect.
8244 """
8245 return _core_.Window_MakeModal(*args, **kwargs)
8246
8247 def SetThemeEnabled(*args, **kwargs):
8248 """
8249 SetThemeEnabled(self, bool enableTheme)
8250
8251 This function tells a window if it should use the system's "theme"
8252 code to draw the windows' background instead if its own background
8253 drawing code. This will only have an effect on platforms that support
8254 the notion of themes in user defined windows. One such platform is
8255 GTK+ where windows can have (very colourful) backgrounds defined by a
8256 user's selected theme.
8257
8258 Dialogs, notebook pages and the status bar have this flag set to true
8259 by default so that the default look and feel is simulated best.
8260 """
8261 return _core_.Window_SetThemeEnabled(*args, **kwargs)
8262
8263 def GetThemeEnabled(*args, **kwargs):
8264 """
8265 GetThemeEnabled(self) -> bool
8266
8267 Return the themeEnabled flag.
8268 """
8269 return _core_.Window_GetThemeEnabled(*args, **kwargs)
8270
8271 def SetFocus(*args, **kwargs):
8272 """
8273 SetFocus(self)
8274
8275 Set's the focus to this window, allowing it to receive keyboard input.
8276 """
8277 return _core_.Window_SetFocus(*args, **kwargs)
8278
8279 def SetFocusFromKbd(*args, **kwargs):
8280 """
8281 SetFocusFromKbd(self)
8282
8283 Set focus to this window as the result of a keyboard action. Normally
8284 only called internally.
8285 """
8286 return _core_.Window_SetFocusFromKbd(*args, **kwargs)
8287
8288 def FindFocus(*args, **kwargs):
8289 """
c24da6d6 8290 FindFocus() -> Window
d55e5bfc
RD		 8291
8292 Returns the window or control that currently has the keyboard focus,
8293 or None.
8294 """
8295 return _core_.Window_FindFocus(*args, **kwargs)
8296
8297 FindFocus = staticmethod(FindFocus)
8298 def AcceptsFocus(*args, **kwargs):
8299 """
8300 AcceptsFocus(self) -> bool
8301
8302 Can this window have focus?
8303 """
8304 return _core_.Window_AcceptsFocus(*args, **kwargs)
8305
8306 def AcceptsFocusFromKeyboard(*args, **kwargs):
8307 """
8308 AcceptsFocusFromKeyboard(self) -> bool
8309
8310 Can this window be given focus by keyboard navigation? if not, the
8311 only way to give it focus (provided it accepts it at all) is to click
8312 it.
8313 """
8314 return _core_.Window_AcceptsFocusFromKeyboard(*args, **kwargs)
8315
8316 def GetDefaultItem(*args, **kwargs):
8317 """
8318 GetDefaultItem(self) -> Window
8319
8320 Get the default child of this parent, i.e. the one which is activated
8321 by pressing <Enter> such as the OK button on a wx.Dialog.
8322 """
8323 return _core_.Window_GetDefaultItem(*args, **kwargs)
8324
8325 def SetDefaultItem(*args, **kwargs):
8326 """
8327 SetDefaultItem(self, Window child) -> Window
8328
8329 Set this child as default, return the old default.
8330 """
8331 return _core_.Window_SetDefaultItem(*args, **kwargs)
8332
8333 def SetTmpDefaultItem(*args, **kwargs):
8334 """
8335 SetTmpDefaultItem(self, Window win)
8336
8337 Set this child as temporary default
8338 """
8339 return _core_.Window_SetTmpDefaultItem(*args, **kwargs)
8340
908b74cd
RD		 8341 def Navigate(*args, **kwargs):
8342 """
8343 Navigate(self, int flags=NavigationKeyEvent.IsForward) -> bool
8344
a8eff060
RD		 8345 Does keyboard navigation from this window to another, by sending a
8346 `wx.NavigationKeyEvent`.
908b74cd
RD		 8347 """
8348 return _core_.Window_Navigate(*args, **kwargs)
8349
bf26d883
RD		 8350 def MoveAfterInTabOrder(*args, **kwargs):
8351 """
8352 MoveAfterInTabOrder(self, Window win)
8353
8354 Moves this window in the tab navigation order after the specified
8355 sibling window. This means that when the user presses the TAB key on
8356 that other window, the focus switches to this window.
8357
8358 The default tab order is the same as creation order. This function
8359 and `MoveBeforeInTabOrder` allow to change it after creating all the
8360 windows.
8361
8362 """
8363 return _core_.Window_MoveAfterInTabOrder(*args, **kwargs)
8364
8365 def MoveBeforeInTabOrder(*args, **kwargs):
8366 """
8367 MoveBeforeInTabOrder(self, Window win)
8368
8369 Same as `MoveAfterInTabOrder` except that it inserts this window just
8370 before win instead of putting it right after it.
8371 """
8372 return _core_.Window_MoveBeforeInTabOrder(*args, **kwargs)
8373
d55e5bfc
RD		 8374 def GetChildren(*args, **kwargs):
8375 """
8376 GetChildren(self) -> PyObject
8377
8378 Returns a list of the window's children. NOTE: Currently this is a
8379 copy of the child window list maintained by the window, so the return
8380 value of this function is only valid as long as the window's children
8381 do not change.
8382 """
8383 return _core_.Window_GetChildren(*args, **kwargs)
8384
8385 def GetParent(*args, **kwargs):
8386 """
8387 GetParent(self) -> Window
8388
8389 Returns the parent window of this window, or None if there isn't one.
8390 """
8391 return _core_.Window_GetParent(*args, **kwargs)
8392
8393 def GetGrandParent(*args, **kwargs):
8394 """
8395 GetGrandParent(self) -> Window
8396
79fccf9d
RD		 8397 Returns the parent of the parent of this window, or None if there
8398 isn't one.
d55e5bfc
RD		 8399 """
8400 return _core_.Window_GetGrandParent(*args, **kwargs)
8401
8402 def IsTopLevel(*args, **kwargs):
8403 """
8404 IsTopLevel(self) -> bool
8405
8406 Returns true if the given window is a top-level one. Currently all
8407 frames and dialogs are always considered to be top-level windows (even
8408 if they have a parent window).
8409 """
8410 return _core_.Window_IsTopLevel(*args, **kwargs)
8411
8412 def Reparent(*args, **kwargs):
8413 """
8414 Reparent(self, Window newParent) -> bool
8415
8416 Reparents the window, i.e the window will be removed from its current
8417 parent window (e.g. a non-standard toolbar in a wxFrame) and then
8418 re-inserted into another. Available on Windows and GTK. Returns True
8419 if the parent was changed, False otherwise (error or newParent ==
8420 oldParent)
8421 """
8422 return _core_.Window_Reparent(*args, **kwargs)
8423
8424 def AddChild(*args, **kwargs):
8425 """
8426 AddChild(self, Window child)
8427
8428 Adds a child window. This is called automatically by window creation
8429 functions so should not be required by the application programmer.
8430 """
8431 return _core_.Window_AddChild(*args, **kwargs)
8432
8433 def RemoveChild(*args, **kwargs):
8434 """
8435 RemoveChild(self, Window child)
8436
8437 Removes a child window. This is called automatically by window
8438 deletion functions so should not be required by the application
8439 programmer.
8440 """
8441 return _core_.Window_RemoveChild(*args, **kwargs)
8442
8443 def FindWindowById(*args, **kwargs):
8444 """
8445 FindWindowById(self, long winid) -> Window
8446
8447 Find a chld of this window by window ID
8448 """
8449 return _core_.Window_FindWindowById(*args, **kwargs)
8450
8451 def FindWindowByName(*args, **kwargs):
8452 """
8453 FindWindowByName(self, String name) -> Window
8454
8455 Find a child of this window by name
8456 """
8457 return _core_.Window_FindWindowByName(*args, **kwargs)
8458
8459 def GetEventHandler(*args, **kwargs):
8460 """
8461 GetEventHandler(self) -> EvtHandler
8462
8463 Returns the event handler for this window. By default, the window is
8464 its own event handler.
8465 """
8466 return _core_.Window_GetEventHandler(*args, **kwargs)
8467
8468 def SetEventHandler(*args, **kwargs):
8469 """
8470 SetEventHandler(self, EvtHandler handler)
8471
8472 Sets the event handler for this window. An event handler is an object
8473 that is capable of processing the events sent to a window. By default,
8474 the window is its own event handler, but an application may wish to
8475 substitute another, for example to allow central implementation of
8476 event-handling for a variety of different window classes.
8477
79fccf9d 8478 It is usually better to use `wx.Window.PushEventHandler` since this sets
d55e5bfc
RD		 8479 up a chain of event handlers, where an event not handled by one event
8480 handler is handed to the next one in the chain.
8481 """
8482 return _core_.Window_SetEventHandler(*args, **kwargs)
8483
8484 def PushEventHandler(*args, **kwargs):
8485 """
8486 PushEventHandler(self, EvtHandler handler)
8487
8488 Pushes this event handler onto the event handler stack for the window.
8489 An event handler is an object that is capable of processing the events
8490 sent to a window. By default, the window is its own event handler, but
8491 an application may wish to substitute another, for example to allow
8492 central implementation of event-handling for a variety of different
8493 window classes.
8494
8495 wx.Window.PushEventHandler allows an application to set up a chain of
8496 event handlers, where an event not handled by one event handler is
79fccf9d 8497 handed to the next one in the chain. Use `wx.Window.PopEventHandler` to
d55e5bfc
RD		 8498 remove the event handler.
8499 """
8500 return _core_.Window_PushEventHandler(*args, **kwargs)
8501
8502 def PopEventHandler(*args, **kwargs):
8503 """
8504 PopEventHandler(self, bool deleteHandler=False) -> EvtHandler
8505
8506 Removes and returns the top-most event handler on the event handler
8507 stack. If deleteHandler is True then the wx.EvtHandler object will be
8508 destroyed after it is popped.
8509 """
8510 return _core_.Window_PopEventHandler(*args, **kwargs)
8511
8512 def RemoveEventHandler(*args, **kwargs):
8513 """
8514 RemoveEventHandler(self, EvtHandler handler) -> bool
8515
79fccf9d
RD		 8516 Find the given handler in the event handler chain and remove (but not
8517 delete) it from the event handler chain, return True if it was found
8518 and False otherwise (this also results in an assert failure so this
8519 function should only be called when the handler is supposed to be
8520 there.)
d55e5bfc
RD		 8521 """
8522 return _core_.Window_RemoveEventHandler(*args, **kwargs)
8523
8524 def SetValidator(*args, **kwargs):
8525 """
8526 SetValidator(self, Validator validator)
8527
8528 Deletes the current validator (if any) and sets the window validator,
8529 having called wx.Validator.Clone to create a new validator of this
8530 type.
8531 """
8532 return _core_.Window_SetValidator(*args, **kwargs)
8533
8534 def GetValidator(*args, **kwargs):
8535 """
8536 GetValidator(self) -> Validator
8537
8538 Returns a pointer to the current validator for the window, or None if
8539 there is none.
8540 """
8541 return _core_.Window_GetValidator(*args, **kwargs)
8542
8543 def Validate(*args, **kwargs):
8544 """
8545 Validate(self) -> bool
8546
8547 Validates the current values of the child controls using their
79fccf9d
RD		 8548 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
8549 style flag set, the method will also call Validate() of all child
8550 windows. Returns false if any of the validations failed.
d55e5bfc
RD		 8551 """
8552 return _core_.Window_Validate(*args, **kwargs)
8553
8554 def TransferDataToWindow(*args, **kwargs):
8555 """
8556 TransferDataToWindow(self) -> bool
8557
79fccf9d
RD		 8558 Transfers values to child controls from data areas specified by their
8559 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
8560 style flag set, the method will also call TransferDataToWindow() of
8561 all child windows.
d55e5bfc
RD		 8562 """
8563 return _core_.Window_TransferDataToWindow(*args, **kwargs)
8564
8565 def TransferDataFromWindow(*args, **kwargs):
8566 """
8567 TransferDataFromWindow(self) -> bool
8568
79fccf9d
RD		 8569 Transfers values from child controls to data areas specified by their
8570 validators. Returns false if a transfer failed. If the window has
8571 wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will
8572 also call TransferDataFromWindow() of all child windows.
d55e5bfc
RD		 8573 """
8574 return _core_.Window_TransferDataFromWindow(*args, **kwargs)
8575
8576 def InitDialog(*args, **kwargs):
8577 """
8578 InitDialog(self)
8579
79fccf9d
RD		 8580 Sends an EVT_INIT_DIALOG event, whose handler usually transfers data
8581 to the dialog via validators.
d55e5bfc
RD		 8582 """
8583 return _core_.Window_InitDialog(*args, **kwargs)
8584
8585 def SetAcceleratorTable(*args, **kwargs):
8586 """
8587 SetAcceleratorTable(self, AcceleratorTable accel)
8588
8589 Sets the accelerator table for this window.
8590 """
8591 return _core_.Window_SetAcceleratorTable(*args, **kwargs)
8592
8593 def GetAcceleratorTable(*args, **kwargs):
8594 """
8595 GetAcceleratorTable(self) -> AcceleratorTable
8596
8597 Gets the accelerator table for this window.
8598 """
8599 return _core_.Window_GetAcceleratorTable(*args, **kwargs)
8600
8601 def RegisterHotKey(*args, **kwargs):
8602 """
8603 RegisterHotKey(self, int hotkeyId, int modifiers, int keycode) -> bool
8604
8605 Registers a system wide hotkey. Every time the user presses the hotkey
8606 registered here, this window will receive a hotkey event. It will
8607 receive the event even if the application is in the background and
8608 does not have the input focus because the user is working with some
8609 other application. To bind an event handler function to this hotkey
8610 use EVT_HOTKEY with an id equal to hotkeyId. Returns True if the
8611 hotkey was registered successfully.
8612 """
8613 return _core_.Window_RegisterHotKey(*args, **kwargs)
8614
8615 def UnregisterHotKey(*args, **kwargs):
8616 """
8617 UnregisterHotKey(self, int hotkeyId) -> bool
8618
8619 Unregisters a system wide hotkey.
8620 """
8621 return _core_.Window_UnregisterHotKey(*args, **kwargs)
8622
8623 def ConvertDialogPointToPixels(*args, **kwargs):
8624 """
8625 ConvertDialogPointToPixels(self, Point pt) -> Point
8626
8627 Converts a point or size from dialog units to pixels. Dialog units
8628 are used for maintaining a dialog's proportions even if the font
8629 changes. For the x dimension, the dialog units are multiplied by the
8630 average character width and then divided by 4. For the y dimension,
8631 the dialog units are multiplied by the average character height and
8632 then divided by 8.
8633 """
8634 return _core_.Window_ConvertDialogPointToPixels(*args, **kwargs)
8635
8636 def ConvertDialogSizeToPixels(*args, **kwargs):
8637 """
8638 ConvertDialogSizeToPixels(self, Size sz) -> Size
8639
8640 Converts a point or size from dialog units to pixels. Dialog units
8641 are used for maintaining a dialog's proportions even if the font
8642 changes. For the x dimension, the dialog units are multiplied by the
8643 average character width and then divided by 4. For the y dimension,
8644 the dialog units are multiplied by the average character height and
8645 then divided by 8.
8646 """
8647 return _core_.Window_ConvertDialogSizeToPixels(*args, **kwargs)
8648
8649 def DLG_PNT(*args, **kwargs):
8650 """
8651 DLG_PNT(self, Point pt) -> Point
8652
8653 Converts a point or size from dialog units to pixels. Dialog units
8654 are used for maintaining a dialog's proportions even if the font
8655 changes. For the x dimension, the dialog units are multiplied by the
8656 average character width and then divided by 4. For the y dimension,
8657 the dialog units are multiplied by the average character height and
8658 then divided by 8.
8659 """
8660 return _core_.Window_DLG_PNT(*args, **kwargs)
8661
8662 def DLG_SZE(*args, **kwargs):
8663 """
8664 DLG_SZE(self, Size sz) -> Size
8665
8666 Converts a point or size from dialog units to pixels. Dialog units
8667 are used for maintaining a dialog's proportions even if the font
8668 changes. For the x dimension, the dialog units are multiplied by the
8669 average character width and then divided by 4. For the y dimension,
8670 the dialog units are multiplied by the average character height and
8671 then divided by 8.
8672 """
8673 return _core_.Window_DLG_SZE(*args, **kwargs)
8674
8675 def ConvertPixelPointToDialog(*args, **kwargs):
8676 """ConvertPixelPointToDialog(self, Point pt) -> Point"""
8677 return _core_.Window_ConvertPixelPointToDialog(*args, **kwargs)
8678
8679 def ConvertPixelSizeToDialog(*args, **kwargs):
8680 """ConvertPixelSizeToDialog(self, Size sz) -> Size"""
8681 return _core_.Window_ConvertPixelSizeToDialog(*args, **kwargs)
8682
8683 def WarpPointer(*args, **kwargs):
8684 """
8685 WarpPointer(self, int x, int y)
8686
8687 Moves the pointer to the given position on the window.
8688
8689 NOTE: This function is not supported under Mac because Apple Human
8690 Interface Guidelines forbid moving the mouse cursor programmatically.
8691 """
8692 return _core_.Window_WarpPointer(*args, **kwargs)
8693
8694 def CaptureMouse(*args, **kwargs):
8695 """
8696 CaptureMouse(self)
8697
8698 Directs all mouse input to this window. Call wx.Window.ReleaseMouse to
8699 release the capture.
8700
8701 Note that wxWindows maintains the stack of windows having captured the
8702 mouse and when the mouse is released the capture returns to the window
8703 which had had captured it previously and it is only really released if
8704 there were no previous window. In particular, this means that you must
8705 release the mouse as many times as you capture it.
8706 """
8707 return _core_.Window_CaptureMouse(*args, **kwargs)
8708
8709 def ReleaseMouse(*args, **kwargs):
8710 """
8711 ReleaseMouse(self)
8712
8713 Releases mouse input captured with wx.Window.CaptureMouse.
8714 """
8715 return _core_.Window_ReleaseMouse(*args, **kwargs)
8716
8717 def GetCapture(*args, **kwargs):
8718 """
c24da6d6 8719 GetCapture() -> Window
d55e5bfc
RD		 8720
8721 Returns the window which currently captures the mouse or None
8722 """
8723 return _core_.Window_GetCapture(*args, **kwargs)
8724
8725 GetCapture = staticmethod(GetCapture)
8726 def HasCapture(*args, **kwargs):
8727 """
8728 HasCapture(self) -> bool
8729
8730 Returns true if this window has the current mouse capture.
8731 """
8732 return _core_.Window_HasCapture(*args, **kwargs)
8733
8734 def Refresh(*args, **kwargs):
8735 """
8736 Refresh(self, bool eraseBackground=True, Rect rect=None)
8737
8738 Mark the specified rectangle (or the whole window) as "dirty" so it
8739 will be repainted. Causes an EVT_PAINT event to be generated and sent
8740 to the window.
8741 """
8742 return _core_.Window_Refresh(*args, **kwargs)
8743
8744 def RefreshRect(*args, **kwargs):
8745 """
fef4c27a 8746 RefreshRect(self, Rect rect, bool eraseBackground=True)
d55e5bfc
RD		 8747
8748 Redraws the contents of the given rectangle: the area inside it will
8749 be repainted. This is the same as Refresh but has a nicer syntax.
8750 """
8751 return _core_.Window_RefreshRect(*args, **kwargs)
8752
8753 def Update(*args, **kwargs):
8754 """
8755 Update(self)
8756
8757 Calling this method immediately repaints the invalidated area of the
8758 window instead of waiting for the EVT_PAINT event to happen, (normally
8759 this would usually only happen when the flow of control returns to the
8760 event loop.) Notice that this function doesn't refresh the window and
8761 does nothing if the window has been already repainted. Use Refresh
8762 first if you want to immediately redraw the window (or some portion of
8763 it) unconditionally.
8764 """
8765 return _core_.Window_Update(*args, **kwargs)
8766
8767 def ClearBackground(*args, **kwargs):
8768 """
8769 ClearBackground(self)
8770
8771 Clears the window by filling it with the current background
8772 colour. Does not cause an erase background event to be generated.
8773 """
8774 return _core_.Window_ClearBackground(*args, **kwargs)
8775
8776 def Freeze(*args, **kwargs):
8777 """
8778 Freeze(self)
8779
79fccf9d
RD		 8780 Freezes the window or, in other words, prevents any updates from
8781 taking place on screen, the window is not redrawn at all. Thaw must be
8782 called to reenable window redrawing. Calls to Freeze/Thaw may be
8783 nested, with the actual Thaw being delayed until all the nesting has
8784 been undone.
d55e5bfc
RD		 8785
8786 This method is useful for visual appearance optimization (for example,
8787 it is a good idea to use it before inserting large amount of text into
8788 a wxTextCtrl under wxGTK) but is not implemented on all platforms nor
8789 for all controls so it is mostly just a hint to wxWindows and not a
8790 mandatory directive.
8791 """
8792 return _core_.Window_Freeze(*args, **kwargs)
8793
8794 def Thaw(*args, **kwargs):
8795 """
8796 Thaw(self)
8797
8798 Reenables window updating after a previous call to Freeze. Calls to
79fccf9d
RD		 8799 Freeze/Thaw may be nested, so Thaw must be called the same number of
8800 times that Freeze was before the window will be updated.
d55e5bfc
RD		 8801 """
8802 return _core_.Window_Thaw(*args, **kwargs)
8803
8804 def PrepareDC(*args, **kwargs):
8805 """
8806 PrepareDC(self, DC dc)
8807
8808 Call this function to prepare the device context for drawing a
8809 scrolled image. It sets the device origin according to the current
8810 scroll position.
8811 """
8812 return _core_.Window_PrepareDC(*args, **kwargs)
8813
8814 def GetUpdateRegion(*args, **kwargs):
8815 """
8816 GetUpdateRegion(self) -> Region
8817
8818 Returns the region specifying which parts of the window have been
8819 damaged. Should only be called within an EVT_PAINT handler.
8820 """
8821 return _core_.Window_GetUpdateRegion(*args, **kwargs)
8822
8823 def GetUpdateClientRect(*args, **kwargs):
8824 """
8825 GetUpdateClientRect(self) -> Rect
8826
8827 Get the update rectangle region bounding box in client coords.
8828 """
8829 return _core_.Window_GetUpdateClientRect(*args, **kwargs)
8830
8831 def IsExposed(*args, **kwargs):
8832 """
8833 IsExposed(self, int x, int y, int w=1, int h=1) -> bool
8834
8835 Returns true if the given point or rectangle area has been exposed
8836 since the last repaint. Call this in an paint event handler to
8837 optimize redrawing by only redrawing those areas, which have been
8838 exposed.
8839 """
8840 return _core_.Window_IsExposed(*args, **kwargs)
8841
8842 def IsExposedPoint(*args, **kwargs):
8843 """
8844 IsExposedPoint(self, Point pt) -> bool
8845
8846 Returns true if the given point or rectangle area has been exposed
8847 since the last repaint. Call this in an paint event handler to
8848 optimize redrawing by only redrawing those areas, which have been
8849 exposed.
8850 """
8851 return _core_.Window_IsExposedPoint(*args, **kwargs)
8852
8853 def IsExposedRect(*args, **kwargs):
8854 """
8855 IsExposedRect(self, Rect rect) -> bool
8856
8857 Returns true if the given point or rectangle area has been exposed
8858 since the last repaint. Call this in an paint event handler to
8859 optimize redrawing by only redrawing those areas, which have been
8860 exposed.
8861 """
8862 return _core_.Window_IsExposedRect(*args, **kwargs)
8863
8864 def GetDefaultAttributes(*args, **kwargs):
8865 """
8866 GetDefaultAttributes(self) -> VisualAttributes
8867
79fccf9d
RD		 8868 Get the default attributes for an instance of this class. This is
8869 useful if you want to use the same font or colour in your own control
8870 as in a standard control -- which is a much better idea than hard
8871 coding specific colours or fonts which might look completely out of
caef1a4d 8872 place on the user's system, especially if it uses themes.
d55e5bfc
RD		 8873 """
8874 return _core_.Window_GetDefaultAttributes(*args, **kwargs)
8875
8876 def GetClassDefaultAttributes(*args, **kwargs):
8877 """
c24da6d6 8878 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
d55e5bfc 8879
79fccf9d
RD		 8880 Get the default attributes for this class. This is useful if you want
8881 to use the same font or colour in your own control as in a standard
8882 control -- which is a much better idea than hard coding specific
caef1a4d
RD		 8883 colours or fonts which might look completely out of place on the
8884 user's system, especially if it uses themes.
d55e5bfc
RD		 8885
8886 The variant parameter is only relevant under Mac currently and is
79fccf9d 8887 ignore under other platforms. Under Mac, it will change the size of
caef1a4d
RD		 8888 the returned font. See `wx.Window.SetWindowVariant` for more about
8889 this.
d55e5bfc
RD		 8890 """
8891 return _core_.Window_GetClassDefaultAttributes(*args, **kwargs)
8892
8893 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
8894 def SetBackgroundColour(*args, **kwargs):
8895 """
8896 SetBackgroundColour(self, Colour colour) -> bool
8897
8898 Sets the background colour of the window. Returns True if the colour
8899 was changed. The background colour is usually painted by the default
8900 EVT_ERASE_BACKGROUND event handler function under Windows and
f8167d6e
RD		 8901 automatically under GTK. Using `wx.NullColour` will reset the window
8902 to the default background colour.
d55e5bfc 8903
caef1a4d 8904 Note that setting the background colour may not cause an immediate
f8167d6e 8905 refresh, so you may wish to call `ClearBackground` or `Refresh` after
d55e5bfc
RD		 8906 calling this function.
8907
f8167d6e
RD		 8908 Using this function will disable attempts to use themes for this
8909 window, if the system supports them. Use with care since usually the
8910 themes represent the appearance chosen by the user to be used for all
8911 applications on the system.
d55e5bfc
RD		 8912 """
8913 return _core_.Window_SetBackgroundColour(*args, **kwargs)
8914
412d302d
RD		 8915 def SetOwnBackgroundColour(*args, **kwargs):
8916 """SetOwnBackgroundColour(self, Colour colour)"""
8917 return _core_.Window_SetOwnBackgroundColour(*args, **kwargs)
d55e5bfc
RD		 8918
8919 def SetForegroundColour(*args, **kwargs):
8920 """
8921 SetForegroundColour(self, Colour colour) -> bool
8922
8923 Sets the foreground colour of the window. Returns True is the colour
8924 was changed. The interpretation of foreground colour is dependent on
8925 the window class; it may be the text colour or other colour, or it may
8926 not be used at all.
8927 """
8928 return _core_.Window_SetForegroundColour(*args, **kwargs)
8929
fa47d7a7
VS		 8930 def SetOwnForegroundColour(*args, **kwargs):
8931 """SetOwnForegroundColour(self, Colour colour)"""
8932 return _core_.Window_SetOwnForegroundColour(*args, **kwargs)
d55e5bfc
RD		 8933
8934 def GetBackgroundColour(*args, **kwargs):
8935 """
8936 GetBackgroundColour(self) -> Colour
8937
8938 Returns the background colour of the window.
8939 """
8940 return _core_.Window_GetBackgroundColour(*args, **kwargs)
8941
8942 def GetForegroundColour(*args, **kwargs):
8943 """
8944 GetForegroundColour(self) -> Colour
8945
8946 Returns the foreground colour of the window. The interpretation of
8947 foreground colour is dependent on the window class; it may be the text
8948 colour or other colour, or it may not be used at all.
8949 """
8950 return _core_.Window_GetForegroundColour(*args, **kwargs)
8951
dcb8fc74
RD		 8952 def InheritsBackgroundColour(*args, **kwargs):
8953 """InheritsBackgroundColour(self) -> bool"""
8954 return _core_.Window_InheritsBackgroundColour(*args, **kwargs)
8955
8956 def UseBgCol(*args, **kwargs):
8957 """UseBgCol(self) -> bool"""
8958 return _core_.Window_UseBgCol(*args, **kwargs)
8959
0f63ec68
RD		 8960 def SetBackgroundStyle(*args, **kwargs):
8961 """
8962 SetBackgroundStyle(self, int style) -> bool
8963
8964 Returns the background style of the window. The background style
8965 indicates how the background of the window is drawn.
8966
8967 ====================== ========================================
8968 wx.BG_STYLE_SYSTEM The background colour or pattern should
8969 be determined by the system
8970 wx.BG_STYLE_COLOUR The background should be a solid colour
8971 wx.BG_STYLE_CUSTOM The background will be implemented by the
8972 application.
8973 ====================== ========================================
8974
8975 On GTK+, use of wx.BG_STYLE_CUSTOM allows the flicker-free drawing of
8976 a custom background, such as a tiled bitmap. Currently the style has
8977 no effect on other platforms.
8978
8979 :see: `GetBackgroundStyle`, `SetBackgroundColour`
8980 """
8981 return _core_.Window_SetBackgroundStyle(*args, **kwargs)
8982
8983 def GetBackgroundStyle(*args, **kwargs):
8984 """
8985 GetBackgroundStyle(self) -> int
8986
8987 Returns the background style of the window.
8988
8989 :see: `SetBackgroundStyle`
8990 """
8991 return _core_.Window_GetBackgroundStyle(*args, **kwargs)
8992
51b83b37
RD		 8993 def HasTransparentBackground(*args, **kwargs):
8994 """
8995 HasTransparentBackground(self) -> bool
8996
8997 Returns True if this window's background is transparent (as, for
8998 example, for `wx.StaticText`) and should show the parent window's
8999 background.
9000
9001 This method is mostly used internally by the library itself and you
9002 normally shouldn't have to call it. You may, however, have to override
9003 it in your custom control classes to ensure that background is painted
9004 correctly.
9005 """
9006 return _core_.Window_HasTransparentBackground(*args, **kwargs)
9007
d55e5bfc
RD		 9008 def SetCursor(*args, **kwargs):
9009 """
9010 SetCursor(self, Cursor cursor) -> bool
9011
9012 Sets the window's cursor. Notice that the window cursor also sets it
9013 for the children of the window implicitly.
9014
9015 The cursor may be wx.NullCursor in which case the window cursor will
9016 be reset back to default.
9017 """
9018 return _core_.Window_SetCursor(*args, **kwargs)
9019
9020 def GetCursor(*args, **kwargs):
9021 """
9022 GetCursor(self) -> Cursor
9023
9024 Return the cursor associated with this window.
9025 """
9026 return _core_.Window_GetCursor(*args, **kwargs)
9027
9028 def SetFont(*args, **kwargs):
9029 """
9030 SetFont(self, Font font) -> bool
9031
9032 Sets the font for this window.
9033 """
9034 return _core_.Window_SetFont(*args, **kwargs)
9035
fa47d7a7
VS		 9036 def SetOwnFont(*args, **kwargs):
9037 """SetOwnFont(self, Font font)"""
9038 return _core_.Window_SetOwnFont(*args, **kwargs)
d55e5bfc
RD		 9039
9040 def GetFont(*args, **kwargs):
9041 """
9042 GetFont(self) -> Font
9043
9044 Returns the default font used for this window.
9045 """
9046 return _core_.Window_GetFont(*args, **kwargs)
9047
9048 def SetCaret(*args, **kwargs):
9049 """
9050 SetCaret(self, Caret caret)
9051
9052 Sets the caret associated with the window.
9053 """
9054 return _core_.Window_SetCaret(*args, **kwargs)
9055
9056 def GetCaret(*args, **kwargs):
9057 """
9058 GetCaret(self) -> Caret
9059
9060 Returns the caret associated with the window.
9061 """
9062 return _core_.Window_GetCaret(*args, **kwargs)
9063
9064 def GetCharHeight(*args, **kwargs):
9065 """
9066 GetCharHeight(self) -> int
9067
9068 Get the (average) character size for the current font.
9069 """
9070 return _core_.Window_GetCharHeight(*args, **kwargs)
9071
9072 def GetCharWidth(*args, **kwargs):
9073 """
9074 GetCharWidth(self) -> int
9075
9076 Get the (average) character size for the current font.
9077 """
9078 return _core_.Window_GetCharWidth(*args, **kwargs)
9079
9080 def GetTextExtent(*args, **kwargs):
a8eff060
RD		 9081 """
9082 GetTextExtent(String string) -> (width, height)
9083
9084 Get the width and height of the text using the current font.
9085 """
d55e5bfc
RD		 9086 return _core_.Window_GetTextExtent(*args, **kwargs)
9087
9088 def GetFullTextExtent(*args, **kwargs):
9089 """
9090 GetFullTextExtent(String string, Font font=None) ->
9091 (width, height, descent, externalLeading)
9092
9093 Get the width, height, decent and leading of the text using the
9094 current or specified font.
9095 """
9096 return _core_.Window_GetFullTextExtent(*args, **kwargs)
9097
9098 def ClientToScreenXY(*args, **kwargs):
9099 """
9100 ClientToScreenXY(int x, int y) -> (x,y)
9101
9102 Converts to screen coordinates from coordinates relative to this window.
9103 """
9104 return _core_.Window_ClientToScreenXY(*args, **kwargs)
9105
9106 def ScreenToClientXY(*args, **kwargs):
9107 """
9108 ScreenToClientXY(int x, int y) -> (x,y)
9109
9110 Converts from screen to client window coordinates.
9111 """
9112 return _core_.Window_ScreenToClientXY(*args, **kwargs)
9113
9114 def ClientToScreen(*args, **kwargs):
9115 """
9116 ClientToScreen(self, Point pt) -> Point
9117
9118 Converts to screen coordinates from coordinates relative to this window.
9119 """
9120 return _core_.Window_ClientToScreen(*args, **kwargs)
9121
9122 def ScreenToClient(*args, **kwargs):
9123 """
9124 ScreenToClient(self, Point pt) -> Point
9125
9126 Converts from screen to client window coordinates.
9127 """
9128 return _core_.Window_ScreenToClient(*args, **kwargs)
9129
9130 def HitTestXY(*args, **kwargs):
9131 """
9132 HitTestXY(self, int x, int y) -> int
9133
9134 Test where the given (in client coords) point lies
9135 """
9136 return _core_.Window_HitTestXY(*args, **kwargs)
9137
9138 def HitTest(*args, **kwargs):
9139 """
9140 HitTest(self, Point pt) -> int
9141
9142 Test where the given (in client coords) point lies
9143 """
9144 return _core_.Window_HitTest(*args, **kwargs)
9145
9146 def GetBorder(*args):
9147 """
9148 GetBorder(self, long flags) -> int
9149 GetBorder(self) -> int
9150
9151 Get border for the flags of this window
9152 """
9153 return _core_.Window_GetBorder(*args)
9154
9155 def UpdateWindowUI(*args, **kwargs):
9156 """
9157 UpdateWindowUI(self, long flags=UPDATE_UI_NONE)
9158
9159 This function sends EVT_UPDATE_UI events to the window. The particular
9160 implementation depends on the window; for example a wx.ToolBar will
9161 send an update UI event for each toolbar button, and a wx.Frame will
9162 send an update UI event for each menubar menu item. You can call this
9163 function from your application to ensure that your UI is up-to-date at
9164 a particular point in time (as far as your EVT_UPDATE_UI handlers are
9165 concerned). This may be necessary if you have called
5ba5649b 9166 `wx.UpdateUIEvent.SetMode` or `wx.UpdateUIEvent.SetUpdateInterval` to
d55e5bfc
RD		 9167 limit the overhead that wxWindows incurs by sending update UI events
9168 in idle time.
d55e5bfc
RD		 9169 """
9170 return _core_.Window_UpdateWindowUI(*args, **kwargs)
9171
9172 def PopupMenuXY(*args, **kwargs):
9173 """
7a0b95b0 9174 PopupMenuXY(self, Menu menu, int x=-1, int y=-1) -> bool
d55e5bfc 9175
7a0b95b0
RD		 9176 Pops up the given menu at the specified coordinates, relative to this window,
9177 and returns control when the user has dismissed the menu. If a menu item is
9178 selected, the corresponding menu event is generated and will be processed as
9179 usual. If the default position is given then the current position of the
9180 mouse cursor will be used.
d55e5bfc
RD		 9181 """
9182 return _core_.Window_PopupMenuXY(*args, **kwargs)
9183
9184 def PopupMenu(*args, **kwargs):
9185 """
7a0b95b0 9186 PopupMenu(self, Menu menu, Point pos=DefaultPosition) -> bool
d55e5bfc 9187
7a0b95b0
RD		 9188 Pops up the given menu at the specified coordinates, relative to this window,
9189 and returns control when the user has dismissed the menu. If a menu item is
9190 selected, the corresponding menu event is generated and will be processed as
9191 usual. If the default position is given then the current position of the
9192 mouse cursor will be used.
d55e5bfc
RD		 9193 """
9194 return _core_.Window_PopupMenu(*args, **kwargs)
9195
9196 def GetHandle(*args, **kwargs):
9197 """
9198 GetHandle(self) -> long
9199
9200 Returns the platform-specific handle (as a long integer) of the
9201 physical window. Currently on wxMac it returns the handle of the
9202 toplevel parent of the window.
9203 """
9204 return _core_.Window_GetHandle(*args, **kwargs)
9205
629e65c2
RD		 9206 def AssociateHandle(*args, **kwargs):
9207 """
9208 AssociateHandle(self, long handle)
9209
9210 Associate the window with a new native handle
9211 """
9212 return _core_.Window_AssociateHandle(*args, **kwargs)
9213
9214 def DissociateHandle(*args, **kwargs):
9215 """
9216 DissociateHandle(self)
9217
9218 Dissociate the current native handle from the window
9219 """
9220 return _core_.Window_DissociateHandle(*args, **kwargs)
9221
d55e5bfc
RD		 9222 def OnPaint(*args, **kwargs):
9223 """OnPaint(self, PaintEvent event)"""
9224 return _core_.Window_OnPaint(*args, **kwargs)
9225
9226 def HasScrollbar(*args, **kwargs):
9227 """
9228 HasScrollbar(self, int orient) -> bool
9229
9230 Does the window have the scrollbar for this orientation?
9231 """
9232 return _core_.Window_HasScrollbar(*args, **kwargs)
9233
9234 def SetScrollbar(*args, **kwargs):
9235 """
79fccf9d 9236 SetScrollbar(self, int orientation, int position, int thumbSize, int range,
d55e5bfc
RD		 9237 bool refresh=True)
9238
9239 Sets the scrollbar properties of a built-in scrollbar.
d55e5bfc
RD		 9240 """
9241 return _core_.Window_SetScrollbar(*args, **kwargs)
9242
9243 def SetScrollPos(*args, **kwargs):
9244 """
9245 SetScrollPos(self, int orientation, int pos, bool refresh=True)
9246
9247 Sets the position of one of the built-in scrollbars.
9248 """
9249 return _core_.Window_SetScrollPos(*args, **kwargs)
9250
9251 def GetScrollPos(*args, **kwargs):
9252 """
9253 GetScrollPos(self, int orientation) -> int
9254
9255 Returns the built-in scrollbar position.
9256 """
9257 return _core_.Window_GetScrollPos(*args, **kwargs)
9258
9259 def GetScrollThumb(*args, **kwargs):
9260 """
9261 GetScrollThumb(self, int orientation) -> int
9262
9263 Returns the built-in scrollbar thumb size.
9264 """
9265 return _core_.Window_GetScrollThumb(*args, **kwargs)
9266
9267 def GetScrollRange(*args, **kwargs):
9268 """
9269 GetScrollRange(self, int orientation) -> int
9270
9271 Returns the built-in scrollbar range.
9272 """
9273 return _core_.Window_GetScrollRange(*args, **kwargs)
9274
9275 def ScrollWindow(*args, **kwargs):
9276 """
9277 ScrollWindow(self, int dx, int dy, Rect rect=None)
9278
9279 Physically scrolls the pixels in the window and move child windows
9280 accordingly. Use this function to optimise your scrolling
9281 implementations, to minimise the area that must be redrawn. Note that
9282 it is rarely required to call this function from a user program.
d55e5bfc
RD		 9283 """
9284 return _core_.Window_ScrollWindow(*args, **kwargs)
9285
9286 def ScrollLines(*args, **kwargs):
9287 """
9288 ScrollLines(self, int lines) -> bool
9289
9290 If the platform and window class supports it, scrolls the window by
9291 the given number of lines down, if lines is positive, or up if lines
9292 is negative. Returns True if the window was scrolled, False if it was
9293 already on top/bottom and nothing was done.
9294 """
9295 return _core_.Window_ScrollLines(*args, **kwargs)
9296
9297 def ScrollPages(*args, **kwargs):
9298 """
9299 ScrollPages(self, int pages) -> bool
9300
79fccf9d 9301 If the platform and window class supports it, scrolls the window by
d55e5bfc
RD		 9302 the given number of pages down, if pages is positive, or up if pages
9303 is negative. Returns True if the window was scrolled, False if it was
9304 already on top/bottom and nothing was done.
9305 """
9306 return _core_.Window_ScrollPages(*args, **kwargs)
9307
9308 def LineUp(*args, **kwargs):
9309 """
9310 LineUp(self) -> bool
9311
9312 This is just a wrapper for ScrollLines(-1).
9313 """
9314 return _core_.Window_LineUp(*args, **kwargs)
9315
9316 def LineDown(*args, **kwargs):
9317 """
9318 LineDown(self) -> bool
9319
9320 This is just a wrapper for ScrollLines(1).
9321 """
9322 return _core_.Window_LineDown(*args, **kwargs)
9323
9324 def PageUp(*args, **kwargs):
9325 """
9326 PageUp(self) -> bool
9327
9328 This is just a wrapper for ScrollPages(-1).
9329 """
9330 return _core_.Window_PageUp(*args, **kwargs)
9331
9332 def PageDown(*args, **kwargs):
9333 """
9334 PageDown(self) -> bool
9335
9336 This is just a wrapper for ScrollPages(1).
9337 """
9338 return _core_.Window_PageDown(*args, **kwargs)
9339
9340 def SetHelpText(*args, **kwargs):
9341 """
9342 SetHelpText(self, String text)
9343
9344 Sets the help text to be used as context-sensitive help for this
9345 window. Note that the text is actually stored by the current
f52cbe90 9346 `wx.HelpProvider` implementation, and not in the window object itself.
d55e5bfc
RD		 9347 """
9348 return _core_.Window_SetHelpText(*args, **kwargs)
9349
9350 def SetHelpTextForId(*args, **kwargs):
9351 """
9352 SetHelpTextForId(self, String text)
9353
9354 Associate this help text with all windows with the same id as this
9355 one.
9356 """
9357 return _core_.Window_SetHelpTextForId(*args, **kwargs)
9358
9359 def GetHelpText(*args, **kwargs):
9360 """
9361 GetHelpText(self) -> String
9362
9363 Gets the help text to be used as context-sensitive help for this
9364 window. Note that the text is actually stored by the current
f52cbe90 9365 `wx.HelpProvider` implementation, and not in the window object itself.
d55e5bfc
RD		 9366 """
9367 return _core_.Window_GetHelpText(*args, **kwargs)
9368
9369 def SetToolTipString(*args, **kwargs):
9370 """
9371 SetToolTipString(self, String tip)
9372
9373 Attach a tooltip to the window.
9374 """
9375 return _core_.Window_SetToolTipString(*args, **kwargs)
9376
9377 def SetToolTip(*args, **kwargs):
9378 """
9379 SetToolTip(self, ToolTip tip)
9380
9381 Attach a tooltip to the window.
9382 """
9383 return _core_.Window_SetToolTip(*args, **kwargs)
9384
9385 def GetToolTip(*args, **kwargs):
9386 """
9387 GetToolTip(self) -> ToolTip
9388
9389 get the associated tooltip or None if none
9390 """
9391 return _core_.Window_GetToolTip(*args, **kwargs)
9392
9393 def SetDropTarget(*args, **kwargs):
9394 """
9395 SetDropTarget(self, DropTarget dropTarget)
9396
9397 Associates a drop target with this window. If the window already has
9398 a drop target, it is deleted.
9399 """
9400 return _core_.Window_SetDropTarget(*args, **kwargs)
9401
9402 def GetDropTarget(*args, **kwargs):
9403 """
9404 GetDropTarget(self) -> DropTarget
9405
9406 Returns the associated drop target, which may be None.
9407 """
9408 return _core_.Window_GetDropTarget(*args, **kwargs)
9409
9410 def DragAcceptFiles(*args, **kwargs):
9411 """
9412 DragAcceptFiles(self, bool accept)
9413
9414 Enables or disables eligibility for drop file events, EVT_DROP_FILES.
5ba5649b 9415 Only functional on Windows.
d55e5bfc
RD		 9416 """
9417 return _core_.Window_DragAcceptFiles(*args, **kwargs)
9418
9419 def SetConstraints(*args, **kwargs):
9420 """
9421 SetConstraints(self, LayoutConstraints constraints)
9422
9423 Sets the window to have the given layout constraints. If an existing
9424 layout constraints object is already owned by the window, it will be
9425 deleted. Pass None to disassociate and delete the window's current
9426 constraints.
9427
9428 You must call SetAutoLayout to tell a window to use the constraints
9429 automatically in its default EVT_SIZE handler; otherwise, you must
9430 handle EVT_SIZE yourself and call Layout() explicitly. When setting
9431 both a wx.LayoutConstraints and a wx.Sizer, only the sizer will have
9432 effect.
9433 """
9434 return _core_.Window_SetConstraints(*args, **kwargs)
9435
9436 def GetConstraints(*args, **kwargs):
9437 """
9438 GetConstraints(self) -> LayoutConstraints
9439
9440 Returns a pointer to the window's layout constraints, or None if there
9441 are none.
9442 """
9443 return _core_.Window_GetConstraints(*args, **kwargs)
9444
9445 def SetAutoLayout(*args, **kwargs):
9446 """
9447 SetAutoLayout(self, bool autoLayout)
9448
9449 Determines whether the Layout function will be called automatically
b1fcee84
RD		 9450 when the window is resized. lease note that this only happens for the
9451 windows usually used to contain children, namely `wx.Panel` and
9452 `wx.TopLevelWindow` (and the classes deriving from them).
9453
9454 This method is called implicitly by `SetSizer` but if you use
9455 `SetConstraints` you should call it manually or otherwise the window
9456 layout won't be correctly updated when its size changes.
d55e5bfc
RD		 9457 """
9458 return _core_.Window_SetAutoLayout(*args, **kwargs)
9459
9460 def GetAutoLayout(*args, **kwargs):
9461 """
9462 GetAutoLayout(self) -> bool
9463
9464 Returns the current autoLayout setting
9465 """
9466 return _core_.Window_GetAutoLayout(*args, **kwargs)
9467
9468 def Layout(*args, **kwargs):
9469 """
9470 Layout(self) -> bool
9471
9472 Invokes the constraint-based layout algorithm or the sizer-based
9473 algorithm for this window. See SetAutoLayout: when auto layout is on,
9474 this function gets called automatically by the default EVT_SIZE
9475 handler when the window is resized.
9476 """
9477 return _core_.Window_Layout(*args, **kwargs)
9478
9479 def SetSizer(*args, **kwargs):
9480 """
9481 SetSizer(self, Sizer sizer, bool deleteOld=True)
9482
9483 Sets the window to have the given layout sizer. The window will then
9484 own the object, and will take care of its deletion. If an existing
9485 layout sizer object is already owned by the window, it will be deleted
9486 if the deleteOld parameter is true. Note that this function will also
9487 call SetAutoLayout implicitly with a True parameter if the sizer is
ae8162c8 9488 non-None, and False otherwise.
d55e5bfc
RD		 9489 """
9490 return _core_.Window_SetSizer(*args, **kwargs)
9491
9492 def SetSizerAndFit(*args, **kwargs):
9493 """
9494 SetSizerAndFit(self, Sizer sizer, bool deleteOld=True)
9495
9496 The same as SetSizer, except it also sets the size hints for the
9497 window based on the sizer's minimum size.
9498 """
9499 return _core_.Window_SetSizerAndFit(*args, **kwargs)
9500
9501 def GetSizer(*args, **kwargs):
9502 """
9503 GetSizer(self) -> Sizer
9504
9505 Return the sizer associated with the window by a previous call to
9506 SetSizer or None if there isn't one.
9507 """
9508 return _core_.Window_GetSizer(*args, **kwargs)
9509
9510 def SetContainingSizer(*args, **kwargs):
9511 """
9512 SetContainingSizer(self, Sizer sizer)
9513
9514 This normally does not need to be called by application code. It is
9515 called internally when a window is added to a sizer, and is used so
9516 the window can remove itself from the sizer when it is destroyed.
9517 """
9518 return _core_.Window_SetContainingSizer(*args, **kwargs)
9519
9520 def GetContainingSizer(*args, **kwargs):
9521 """
9522 GetContainingSizer(self) -> Sizer
9523
9524 Return the sizer that this window is a member of, if any, otherwise None.
9525 """
9526 return _core_.Window_GetContainingSizer(*args, **kwargs)
9527
9528 def InheritAttributes(*args, **kwargs):
9529 """
9530 InheritAttributes(self)
9531
79fccf9d
RD		 9532 This function is (or should be, in case of custom controls) called
9533 during window creation to intelligently set up the window visual
9534 attributes, that is the font and the foreground and background
9535 colours.
9536
9537 By 'intelligently' the following is meant: by default, all windows use
9538 their own default attributes. However if some of the parent's
9539 attributes are explicitly changed (that is, using SetFont and not
fa47d7a7 9540 SetOwnFont) and if the corresponding attribute hadn't been
79fccf9d
RD		 9541 explicitly set for this window itself, then this window takes the same
9542 value as used by the parent. In addition, if the window overrides
9543 ShouldInheritColours to return false, the colours will not be changed
9544 no matter what and only the font might.
9545
ec9b55ca
RD		 9546 This rather complicated logic is necessary in order to accommodate the
9547 different usage scenarios. The most common one is when all default
79fccf9d
RD		 9548 attributes are used and in this case, nothing should be inherited as
9549 in modern GUIs different controls use different fonts (and colours)
9550 than their siblings so they can't inherit the same value from the
9551 parent. However it was also deemed desirable to allow to simply change
9552 the attributes of all children at once by just changing the font or
9553 colour of their common parent, hence in this case we do inherit the
9554 parents attributes.
9555
d55e5bfc
RD		 9556 """
9557 return _core_.Window_InheritAttributes(*args, **kwargs)
9558
9559 def ShouldInheritColours(*args, **kwargs):
9560 """
9561 ShouldInheritColours(self) -> bool
9562
9563 Return true from here to allow the colours of this window to be
79fccf9d
RD		 9564 changed by InheritAttributes, returning false forbids inheriting them
9565 from the parent window.
d55e5bfc 9566
79fccf9d
RD		 9567 The base class version returns false, but this method is overridden in
9568 wxControl where it returns true.
d55e5bfc
RD		 9569 """
9570 return _core_.Window_ShouldInheritColours(*args, **kwargs)
9571
9572 def PostCreate(self, pre):
9573 """
9574 Phase 3 of the 2-phase create <wink!>
9575 Call this method after precreating the window with the 2-phase create method.
9576 """
9577 self.this = pre.this
9578 self.thisown = pre.thisown
9579 pre.thisown = 0
9580 if hasattr(self, '_setOORInfo'):
9581 self._setOORInfo(self)
9582 if hasattr(self, '_setCallbackInfo'):
9583 self._setCallbackInfo(self, self.__class__)
9584
7e08d4ef
RD		 9585 def SendSizeEvent(self):
9586 self.GetEventhandler().ProcessEvent(wx.SizeEvent((-1,-1)))
9587
554f62e9
RD		 9588Window_swigregister = _core_.Window_swigregister
9589Window_swigregister(Window)
d55e5bfc
RD		 9590
9591def PreWindow(*args, **kwargs):
9592 """
9593 PreWindow() -> Window
9594
9595 Precreate a Window for 2-phase creation.
9596 """
9597 val = _core_.new_PreWindow(*args, **kwargs)
d55e5bfc
RD		 9598 return val
9599
554f62e9
RD		 9600def Window_NewControlId(*args):
9601 """
d55e5bfc
RD		 9602 Window_NewControlId() -> int
9603
9604 Generate a control id for the controls which were not given one.
9605 """
554f62e9 9606 return _core_.Window_NewControlId(*args)
d55e5bfc
RD		 9607
9608def Window_NextControlId(*args, **kwargs):
554f62e9 9609 """
d55e5bfc
RD		 9610 Window_NextControlId(int winid) -> int
9611
9612 Get the id of the control following the one with the given
79fccf9d 9613 autogenerated) id
d55e5bfc 9614 """
554f62e9 9615 return _core_.Window_NextControlId(*args, **kwargs)
d55e5bfc
RD		 9616
9617def Window_PrevControlId(*args, **kwargs):
554f62e9 9618 """
d55e5bfc
RD		 9619 Window_PrevControlId(int winid) -> int
9620
9621 Get the id of the control preceding the one with the given
79fccf9d 9622 autogenerated) id
d55e5bfc 9623 """
554f62e9 9624 return _core_.Window_PrevControlId(*args, **kwargs)
d55e5bfc 9625
554f62e9
RD		 9626def Window_FindFocus(*args):
9627 """
d55e5bfc
RD		 9628 Window_FindFocus() -> Window
9629
9630 Returns the window or control that currently has the keyboard focus,
9631 or None.
9632 """
554f62e9 9633 return _core_.Window_FindFocus(*args)
d55e5bfc 9634
554f62e9
RD		 9635def Window_GetCapture(*args):
9636 """
d55e5bfc
RD		 9637 Window_GetCapture() -> Window
9638
9639 Returns the window which currently captures the mouse or None
9640 """
554f62e9 9641 return _core_.Window_GetCapture(*args)
d55e5bfc
RD		 9642
9643def Window_GetClassDefaultAttributes(*args, **kwargs):
554f62e9 9644 """
d55e5bfc
RD		 9645 Window_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
9646
79fccf9d
RD		 9647 Get the default attributes for this class. This is useful if you want
9648 to use the same font or colour in your own control as in a standard
9649 control -- which is a much better idea than hard coding specific
caef1a4d
RD		 9650 colours or fonts which might look completely out of place on the
9651 user's system, especially if it uses themes.
d55e5bfc
RD		 9652
9653 The variant parameter is only relevant under Mac currently and is
79fccf9d 9654 ignore under other platforms. Under Mac, it will change the size of
caef1a4d
RD		 9655 the returned font. See `wx.Window.SetWindowVariant` for more about
9656 this.
d55e5bfc 9657 """
554f62e9 9658 return _core_.Window_GetClassDefaultAttributes(*args, **kwargs)
d55e5bfc
RD		 9659
9660def DLG_PNT(win, point_or_x, y=None):
9661 """
9662 Convenience function for converting a Point or (x,y) in
9663 dialog units to pixel units.
9664 """
9665 if y is None:
9666 return win.ConvertDialogPointToPixels(point_or_x)
9667 else:
9668 return win.ConvertDialogPointToPixels(wx.Point(point_or_x, y))
9669
9670def DLG_SZE(win, size_width, height=None):
9671 """
9672 Convenience function for converting a Size or (w,h) in
9673 dialog units to pixel units.
9674 """
9675 if height is None:
9676 return win.ConvertDialogSizeToPixels(size_width)
9677 else:
9678 return win.ConvertDialogSizeToPixels(wx.Size(size_width, height))
9679
9680
9681def FindWindowById(*args, **kwargs):
554f62e9 9682 """
d55e5bfc
RD		 9683 FindWindowById(long id, Window parent=None) -> Window
9684
9685 Find the first window in the application with the given id. If parent
9686 is None, the search will start from all top-level frames and dialog
9687 boxes; if non-None, the search will be limited to the given window
9688 hierarchy. The search is recursive in both cases.
9689 """
554f62e9 9690 return _core_.FindWindowById(*args, **kwargs)
d55e5bfc
RD		 9691
9692def FindWindowByName(*args, **kwargs):
554f62e9 9693 """
d55e5bfc
RD		 9694 FindWindowByName(String name, Window parent=None) -> Window
9695
9696 Find a window by its name (as given in a window constructor or Create
9697 function call). If parent is None, the search will start from all
9698 top-level frames and dialog boxes; if non-None, the search will be
9699 limited to the given window hierarchy. The search is recursive in both
9700 cases.
9701
9702 If no window with such name is found, wx.FindWindowByLabel is called.
9703 """
554f62e9 9704 return _core_.FindWindowByName(*args, **kwargs)
d55e5bfc
RD		 9705
9706def FindWindowByLabel(*args, **kwargs):
554f62e9 9707 """
d55e5bfc
RD		 9708 FindWindowByLabel(String label, Window parent=None) -> Window
9709
9710 Find a window by its label. Depending on the type of window, the label
9711 may be a window title or panel item label. If parent is None, the
9712 search will start from all top-level frames and dialog boxes; if
9713 non-None, the search will be limited to the given window
9714 hierarchy. The search is recursive in both cases.
9715 """
554f62e9 9716 return _core_.FindWindowByLabel(*args, **kwargs)
d55e5bfc
RD		 9717
9718def Window_FromHWND(*args, **kwargs):
554f62e9
RD		 9719 """Window_FromHWND(Window parent, unsigned long _hWnd) -> Window"""
9720 return _core_.Window_FromHWND(*args, **kwargs)
3215336e 9721
554f62e9
RD		 9722def GetTopLevelWindows(*args):
9723 """
3215336e
RD		 9724 GetTopLevelWindows() -> PyObject
9725
9726 Returns a list of the the application's top-level windows, (frames,
9727 dialogs, etc.) NOTE: Currently this is a copy of the list maintained
9728 by wxWidgets, and so it is only valid as long as no top-level windows
9729 are closed or new top-level windows are created.
9730
9731 """
554f62e9 9732 return _core_.GetTopLevelWindows(*args)
d55e5bfc
RD		 9733#---------------------------------------------------------------------------
9734
9735class Validator(EvtHandler):
093d3ff1 9736 """Proxy of C++ Validator class"""
554f62e9
RD		 9737 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
9738 __repr__ = _swig_repr
9739 def __init__(self, *args, **kwargs):
d55e5bfc 9740 """__init__(self) -> Validator"""
554f62e9 9741 _core_.Validator_swiginit(self,_core_.new_Validator(*args, **kwargs))
d55e5bfc
RD		 9742 self._setOORInfo(self)
9743
9744 def Clone(*args, **kwargs):
9745 """Clone(self) -> Validator"""
9746 return _core_.Validator_Clone(*args, **kwargs)
9747
9748 def Validate(*args, **kwargs):
9749 """Validate(self, Window parent) -> bool"""
9750 return _core_.Validator_Validate(*args, **kwargs)
9751
9752 def TransferToWindow(*args, **kwargs):
9753 """TransferToWindow(self) -> bool"""
9754 return _core_.Validator_TransferToWindow(*args, **kwargs)
9755
9756 def TransferFromWindow(*args, **kwargs):
9757 """TransferFromWindow(self) -> bool"""
9758 return _core_.Validator_TransferFromWindow(*args, **kwargs)
9759
9760 def GetWindow(*args, **kwargs):
9761 """GetWindow(self) -> Window"""
9762 return _core_.Validator_GetWindow(*args, **kwargs)
9763
9764 def SetWindow(*args, **kwargs):
9765 """SetWindow(self, Window window)"""
9766 return _core_.Validator_SetWindow(*args, **kwargs)
9767
9768 def IsSilent(*args, **kwargs):
c24da6d6 9769 """IsSilent() -> bool"""
d55e5bfc
RD		 9770 return _core_.Validator_IsSilent(*args, **kwargs)
9771
9772 IsSilent = staticmethod(IsSilent)
9773 def SetBellOnError(*args, **kwargs):
c24da6d6 9774 """SetBellOnError(int doIt=True)"""
d55e5bfc
RD		 9775 return _core_.Validator_SetBellOnError(*args, **kwargs)
9776
9777 SetBellOnError = staticmethod(SetBellOnError)
554f62e9
RD		 9778Validator_swigregister = _core_.Validator_swigregister
9779Validator_swigregister(Validator)
d55e5bfc 9780
554f62e9
RD		 9781def Validator_IsSilent(*args):
9782 """Validator_IsSilent() -> bool"""
9783 return _core_.Validator_IsSilent(*args)
d55e5bfc
RD		 9784
9785def Validator_SetBellOnError(*args, **kwargs):
554f62e9
RD		 9786 """Validator_SetBellOnError(int doIt=True)"""
9787 return _core_.Validator_SetBellOnError(*args, **kwargs)
d55e5bfc
RD		 9788
9789class PyValidator(Validator):
093d3ff1 9790 """Proxy of C++ PyValidator class"""
554f62e9
RD		 9791 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
9792 __repr__ = _swig_repr
9793 def __init__(self, *args, **kwargs):
d55e5bfc 9794 """__init__(self) -> PyValidator"""
554f62e9 9795 _core_.PyValidator_swiginit(self,_core_.new_PyValidator(*args, **kwargs))
d55e5bfc
RD		 9796
9797 self._setCallbackInfo(self, PyValidator, 1)
9798 self._setOORInfo(self)
9799
9800 def _setCallbackInfo(*args, **kwargs):
9801 """_setCallbackInfo(self, PyObject self, PyObject _class, int incref=True)"""
9802 return _core_.PyValidator__setCallbackInfo(*args, **kwargs)
9803
554f62e9
RD		 9804PyValidator_swigregister = _core_.PyValidator_swigregister
9805PyValidator_swigregister(PyValidator)
d55e5bfc
RD		 9806
9807#---------------------------------------------------------------------------
9808
9809class Menu(EvtHandler):
093d3ff1 9810 """Proxy of C++ Menu class"""
554f62e9
RD		 9811 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
9812 __repr__ = _swig_repr
9813 def __init__(self, *args, **kwargs):
d55e5bfc 9814 """__init__(self, String title=EmptyString, long style=0) -> Menu"""
554f62e9 9815 _core_.Menu_swiginit(self,_core_.new_Menu(*args, **kwargs))
d55e5bfc
RD		 9816 self._setOORInfo(self)
9817
9818 def Append(*args, **kwargs):
9819 """Append(self, int id, String text, String help=EmptyString, int kind=ITEM_NORMAL) -> MenuItem"""
9820 return _core_.Menu_Append(*args, **kwargs)
9821
9822 def AppendSeparator(*args, **kwargs):
9823 """AppendSeparator(self) -> MenuItem"""
9824 return _core_.Menu_AppendSeparator(*args, **kwargs)
9825
9826 def AppendCheckItem(*args, **kwargs):
9827 """AppendCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
9828 return _core_.Menu_AppendCheckItem(*args, **kwargs)
9829
9830 def AppendRadioItem(*args, **kwargs):
9831 """AppendRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
9832 return _core_.Menu_AppendRadioItem(*args, **kwargs)
9833
9834 def AppendMenu(*args, **kwargs):
9835 """AppendMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
9836 return _core_.Menu_AppendMenu(*args, **kwargs)
9837
9838 def AppendItem(*args, **kwargs):
9839 """AppendItem(self, MenuItem item) -> MenuItem"""
9840 return _core_.Menu_AppendItem(*args, **kwargs)
9841
d55e5bfc
RD		 9842 def InsertItem(*args, **kwargs):
9843 """InsertItem(self, size_t pos, MenuItem item) -> MenuItem"""
9844 return _core_.Menu_InsertItem(*args, **kwargs)
9845
554f62e9
RD		 9846 def PrependItem(*args, **kwargs):
9847 """PrependItem(self, MenuItem item) -> MenuItem"""
9848 return _core_.Menu_PrependItem(*args, **kwargs)
9849
9850 def Break(*args, **kwargs):
9851 """Break(self)"""
9852 return _core_.Menu_Break(*args, **kwargs)
9853
d55e5bfc
RD		 9854 def Insert(*args, **kwargs):
9855 """
9856 Insert(self, size_t pos, int id, String text, String help=EmptyString,
9857 int kind=ITEM_NORMAL) -> MenuItem
9858 """
9859 return _core_.Menu_Insert(*args, **kwargs)
9860
9861 def InsertSeparator(*args, **kwargs):
9862 """InsertSeparator(self, size_t pos) -> MenuItem"""
9863 return _core_.Menu_InsertSeparator(*args, **kwargs)
9864
9865 def InsertCheckItem(*args, **kwargs):
9866 """InsertCheckItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
9867 return _core_.Menu_InsertCheckItem(*args, **kwargs)
9868
9869 def InsertRadioItem(*args, **kwargs):
9870 """InsertRadioItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
9871 return _core_.Menu_InsertRadioItem(*args, **kwargs)
9872
9873 def InsertMenu(*args, **kwargs):
9874 """InsertMenu(self, size_t pos, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
9875 return _core_.Menu_InsertMenu(*args, **kwargs)
9876
d55e5bfc
RD		 9877 def Prepend(*args, **kwargs):
9878 """Prepend(self, int id, String text, String help=EmptyString, int kind=ITEM_NORMAL) -> MenuItem"""
9879 return _core_.Menu_Prepend(*args, **kwargs)
9880
9881 def PrependSeparator(*args, **kwargs):
9882 """PrependSeparator(self) -> MenuItem"""
9883 return _core_.Menu_PrependSeparator(*args, **kwargs)
9884
9885 def PrependCheckItem(*args, **kwargs):
9886 """PrependCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
9887 return _core_.Menu_PrependCheckItem(*args, **kwargs)
9888
9889 def PrependRadioItem(*args, **kwargs):
9890 """PrependRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
9891 return _core_.Menu_PrependRadioItem(*args, **kwargs)
9892
9893 def PrependMenu(*args, **kwargs):
9894 """PrependMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
9895 return _core_.Menu_PrependMenu(*args, **kwargs)
9896
9897 def Remove(*args, **kwargs):
9898 """Remove(self, int id) -> MenuItem"""
9899 return _core_.Menu_Remove(*args, **kwargs)
9900
9901 def RemoveItem(*args, **kwargs):
9902 """RemoveItem(self, MenuItem item) -> MenuItem"""
9903 return _core_.Menu_RemoveItem(*args, **kwargs)
9904
9905 def Delete(*args, **kwargs):
9906 """Delete(self, int id) -> bool"""
9907 return _core_.Menu_Delete(*args, **kwargs)
9908
9909 def DeleteItem(*args, **kwargs):
9910 """DeleteItem(self, MenuItem item) -> bool"""
9911 return _core_.Menu_DeleteItem(*args, **kwargs)
9912
9913 def Destroy(*args, **kwargs):
9914 """
9915 Destroy(self)
9916
9917 Deletes the C++ object this Python object is a proxy for.
9918 """
7e08d4ef
RD		 9919 val = _core_.Menu_Destroy(*args, **kwargs)
9920 args[0].thisown = 0
9921 return val
d55e5bfc
RD		 9922
9923 def DestroyId(*args, **kwargs):
9924 """
9925 DestroyId(self, int id) -> bool
9926
9927 Deletes the C++ object this Python object is a proxy for.
9928 """
7e08d4ef
RD		 9929 val = _core_.Menu_DestroyId(*args, **kwargs)
9930 args[0].thisown = 0
9931 return val
d55e5bfc
RD		 9932
9933 def DestroyItem(*args, **kwargs):
9934 """
9935 DestroyItem(self, MenuItem item) -> bool
9936
9937 Deletes the C++ object this Python object is a proxy for.
9938 """
7e08d4ef
RD		 9939 val = _core_.Menu_DestroyItem(*args, **kwargs)
9940 args[0].thisown = 0
9941 return val
d55e5bfc
RD		 9942
9943 def GetMenuItemCount(*args, **kwargs):
9944 """GetMenuItemCount(self) -> size_t"""
9945 return _core_.Menu_GetMenuItemCount(*args, **kwargs)
9946
9947 def GetMenuItems(*args, **kwargs):
9948 """GetMenuItems(self) -> PyObject"""
9949 return _core_.Menu_GetMenuItems(*args, **kwargs)
9950
9951 def FindItem(*args, **kwargs):
9952 """FindItem(self, String item) -> int"""
9953 return _core_.Menu_FindItem(*args, **kwargs)
9954
9955 def FindItemById(*args, **kwargs):
9956 """FindItemById(self, int id) -> MenuItem"""
9957 return _core_.Menu_FindItemById(*args, **kwargs)
9958
9959 def FindItemByPosition(*args, **kwargs):
9960 """FindItemByPosition(self, size_t position) -> MenuItem"""
9961 return _core_.Menu_FindItemByPosition(*args, **kwargs)
9962
9963 def Enable(*args, **kwargs):
9964 """Enable(self, int id, bool enable)"""
9965 return _core_.Menu_Enable(*args, **kwargs)
9966
9967 def IsEnabled(*args, **kwargs):
9968 """IsEnabled(self, int id) -> bool"""
9969 return _core_.Menu_IsEnabled(*args, **kwargs)
9970
9971 def Check(*args, **kwargs):
9972 """Check(self, int id, bool check)"""
9973 return _core_.Menu_Check(*args, **kwargs)
9974
9975 def IsChecked(*args, **kwargs):
9976 """IsChecked(self, int id) -> bool"""
9977 return _core_.Menu_IsChecked(*args, **kwargs)
9978
9979 def SetLabel(*args, **kwargs):
9980 """SetLabel(self, int id, String label)"""
9981 return _core_.Menu_SetLabel(*args, **kwargs)
9982
9983 def GetLabel(*args, **kwargs):
9984 """GetLabel(self, int id) -> String"""
9985 return _core_.Menu_GetLabel(*args, **kwargs)
9986
9987 def SetHelpString(*args, **kwargs):
9988 """SetHelpString(self, int id, String helpString)"""
9989 return _core_.Menu_SetHelpString(*args, **kwargs)
9990
9991 def GetHelpString(*args, **kwargs):
9992 """GetHelpString(self, int id) -> String"""
9993 return _core_.Menu_GetHelpString(*args, **kwargs)
9994
9995 def SetTitle(*args, **kwargs):
9996 """SetTitle(self, String title)"""
9997 return _core_.Menu_SetTitle(*args, **kwargs)
9998
9999 def GetTitle(*args, **kwargs):
10000 """GetTitle(self) -> String"""
10001 return _core_.Menu_GetTitle(*args, **kwargs)
10002
10003 def SetEventHandler(*args, **kwargs):
10004 """SetEventHandler(self, EvtHandler handler)"""
10005 return _core_.Menu_SetEventHandler(*args, **kwargs)
10006
10007 def GetEventHandler(*args, **kwargs):
10008 """GetEventHandler(self) -> EvtHandler"""
10009 return _core_.Menu_GetEventHandler(*args, **kwargs)
10010
10011 def SetInvokingWindow(*args, **kwargs):
10012 """SetInvokingWindow(self, Window win)"""
10013 return _core_.Menu_SetInvokingWindow(*args, **kwargs)
10014
10015 def GetInvokingWindow(*args, **kwargs):
10016 """GetInvokingWindow(self) -> Window"""
10017 return _core_.Menu_GetInvokingWindow(*args, **kwargs)
10018
10019 def GetStyle(*args, **kwargs):
10020 """GetStyle(self) -> long"""
10021 return _core_.Menu_GetStyle(*args, **kwargs)
10022
10023 def UpdateUI(*args, **kwargs):
10024 """UpdateUI(self, EvtHandler source=None)"""
10025 return _core_.Menu_UpdateUI(*args, **kwargs)
10026
10027 def GetMenuBar(*args, **kwargs):
10028 """GetMenuBar(self) -> MenuBar"""
10029 return _core_.Menu_GetMenuBar(*args, **kwargs)
10030
10031 def Attach(*args, **kwargs):
10032 """Attach(self, wxMenuBarBase menubar)"""
10033 return _core_.Menu_Attach(*args, **kwargs)
10034
10035 def Detach(*args, **kwargs):
10036 """Detach(self)"""
10037 return _core_.Menu_Detach(*args, **kwargs)
10038
10039 def IsAttached(*args, **kwargs):
10040 """IsAttached(self) -> bool"""
10041 return _core_.Menu_IsAttached(*args, **kwargs)
10042
10043 def SetParent(*args, **kwargs):
10044 """SetParent(self, Menu parent)"""
10045 return _core_.Menu_SetParent(*args, **kwargs)
10046
10047 def GetParent(*args, **kwargs):
10048 """GetParent(self) -> Menu"""
10049 return _core_.Menu_GetParent(*args, **kwargs)
10050
554f62e9
RD		 10051Menu_swigregister = _core_.Menu_swigregister
10052Menu_swigregister(Menu)
d55e5bfc
RD		 10053DefaultValidator = cvar.DefaultValidator
10054
10055#---------------------------------------------------------------------------
10056
10057class MenuBar(Window):
093d3ff1 10058 """Proxy of C++ MenuBar class"""
554f62e9
RD		 10059 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10060 __repr__ = _swig_repr
10061 def __init__(self, *args, **kwargs):
d55e5bfc 10062 """__init__(self, long style=0) -> MenuBar"""
554f62e9 10063 _core_.MenuBar_swiginit(self,_core_.new_MenuBar(*args, **kwargs))
d55e5bfc
RD		 10064 self._setOORInfo(self)
10065
10066 def Append(*args, **kwargs):
10067 """Append(self, Menu menu, String title) -> bool"""
10068 return _core_.MenuBar_Append(*args, **kwargs)
10069
10070 def Insert(*args, **kwargs):
10071 """Insert(self, size_t pos, Menu menu, String title) -> bool"""
10072 return _core_.MenuBar_Insert(*args, **kwargs)
10073
10074 def GetMenuCount(*args, **kwargs):
10075 """GetMenuCount(self) -> size_t"""
10076 return _core_.MenuBar_GetMenuCount(*args, **kwargs)
10077
10078 def GetMenu(*args, **kwargs):
10079 """GetMenu(self, size_t pos) -> Menu"""
10080 return _core_.MenuBar_GetMenu(*args, **kwargs)
10081
10082 def Replace(*args, **kwargs):
10083 """Replace(self, size_t pos, Menu menu, String title) -> Menu"""
10084 return _core_.MenuBar_Replace(*args, **kwargs)
10085
10086 def Remove(*args, **kwargs):
10087 """Remove(self, size_t pos) -> Menu"""
10088 return _core_.MenuBar_Remove(*args, **kwargs)
10089
10090 def EnableTop(*args, **kwargs):
10091 """EnableTop(self, size_t pos, bool enable)"""
10092 return _core_.MenuBar_EnableTop(*args, **kwargs)
10093
10094 def IsEnabledTop(*args, **kwargs):
10095 """IsEnabledTop(self, size_t pos) -> bool"""
10096 return _core_.MenuBar_IsEnabledTop(*args, **kwargs)
10097
10098 def SetLabelTop(*args, **kwargs):
10099 """SetLabelTop(self, size_t pos, String label)"""
10100 return _core_.MenuBar_SetLabelTop(*args, **kwargs)
10101
10102 def GetLabelTop(*args, **kwargs):
10103 """GetLabelTop(self, size_t pos) -> String"""
10104 return _core_.MenuBar_GetLabelTop(*args, **kwargs)
10105
10106 def FindMenuItem(*args, **kwargs):
10107 """FindMenuItem(self, String menu, String item) -> int"""
10108 return _core_.MenuBar_FindMenuItem(*args, **kwargs)
10109
10110 def FindItemById(*args, **kwargs):
10111 """FindItemById(self, int id) -> MenuItem"""
10112 return _core_.MenuBar_FindItemById(*args, **kwargs)
10113
10114 def FindMenu(*args, **kwargs):
10115 """FindMenu(self, String title) -> int"""
10116 return _core_.MenuBar_FindMenu(*args, **kwargs)
10117
10118 def Enable(*args, **kwargs):
10119 """Enable(self, int id, bool enable)"""
10120 return _core_.MenuBar_Enable(*args, **kwargs)
10121
10122 def Check(*args, **kwargs):
10123 """Check(self, int id, bool check)"""
10124 return _core_.MenuBar_Check(*args, **kwargs)
10125
10126 def IsChecked(*args, **kwargs):
10127 """IsChecked(self, int id) -> bool"""
10128 return _core_.MenuBar_IsChecked(*args, **kwargs)
10129
10130 def IsEnabled(*args, **kwargs):
10131 """IsEnabled(self, int id) -> bool"""
10132 return _core_.MenuBar_IsEnabled(*args, **kwargs)
10133
10134 def SetLabel(*args, **kwargs):
10135 """SetLabel(self, int id, String label)"""
10136 return _core_.MenuBar_SetLabel(*args, **kwargs)
10137
10138 def GetLabel(*args, **kwargs):
10139 """GetLabel(self, int id) -> String"""
10140 return _core_.MenuBar_GetLabel(*args, **kwargs)
10141
10142 def SetHelpString(*args, **kwargs):
10143 """SetHelpString(self, int id, String helpString)"""
10144 return _core_.MenuBar_SetHelpString(*args, **kwargs)
10145
10146 def GetHelpString(*args, **kwargs):
10147 """GetHelpString(self, int id) -> String"""
10148 return _core_.MenuBar_GetHelpString(*args, **kwargs)
10149
10150 def GetFrame(*args, **kwargs):
10151 """GetFrame(self) -> wxFrame"""
10152 return _core_.MenuBar_GetFrame(*args, **kwargs)
10153
10154 def IsAttached(*args, **kwargs):
10155 """IsAttached(self) -> bool"""
10156 return _core_.MenuBar_IsAttached(*args, **kwargs)
10157
10158 def Attach(*args, **kwargs):
10159 """Attach(self, wxFrame frame)"""
10160 return _core_.MenuBar_Attach(*args, **kwargs)
10161
10162 def Detach(*args, **kwargs):
10163 """Detach(self)"""
10164 return _core_.MenuBar_Detach(*args, **kwargs)
10165
db67f999
RD		 10166 def SetAutoWindowMenu(*args, **kwargs):
10167 """SetAutoWindowMenu(bool enable)"""
10168 return _core_.MenuBar_SetAutoWindowMenu(*args, **kwargs)
10169
10170 SetAutoWindowMenu = staticmethod(SetAutoWindowMenu)
10171 def GetAutoWindowMenu(*args, **kwargs):
10172 """GetAutoWindowMenu() -> bool"""
10173 return _core_.MenuBar_GetAutoWindowMenu(*args, **kwargs)
10174
10175 GetAutoWindowMenu = staticmethod(GetAutoWindowMenu)
554f62e9
RD		 10176MenuBar_swigregister = _core_.MenuBar_swigregister
10177MenuBar_swigregister(MenuBar)
d55e5bfc 10178
db67f999 10179def MenuBar_SetAutoWindowMenu(*args, **kwargs):
554f62e9
RD		 10180 """MenuBar_SetAutoWindowMenu(bool enable)"""
10181 return _core_.MenuBar_SetAutoWindowMenu(*args, **kwargs)
db67f999 10182
554f62e9
RD		 10183def MenuBar_GetAutoWindowMenu(*args):
10184 """MenuBar_GetAutoWindowMenu() -> bool"""
10185 return _core_.MenuBar_GetAutoWindowMenu(*args)
db67f999 10186
d55e5bfc
RD		 10187#---------------------------------------------------------------------------
10188
10189class MenuItem(Object):
093d3ff1 10190 """Proxy of C++ MenuItem class"""
554f62e9
RD		 10191 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10192 __repr__ = _swig_repr
10193 def __init__(self, *args, **kwargs):
d55e5bfc
RD		 10194 """
10195 __init__(self, Menu parentMenu=None, int id=ID_ANY, String text=EmptyString,
10196 String help=EmptyString, int kind=ITEM_NORMAL,
10197 Menu subMenu=None) -> MenuItem
10198 """
554f62e9
RD		 10199 _core_.MenuItem_swiginit(self,_core_.new_MenuItem(*args, **kwargs))
10200 __swig_destroy__ = _core_.delete_MenuItem
10201 __del__ = lambda self : None;
d55e5bfc
RD		 10202 def GetMenu(*args, **kwargs):
10203 """GetMenu(self) -> Menu"""
10204 return _core_.MenuItem_GetMenu(*args, **kwargs)
10205
10206 def SetMenu(*args, **kwargs):
10207 """SetMenu(self, Menu menu)"""
10208 return _core_.MenuItem_SetMenu(*args, **kwargs)
10209
10210 def SetId(*args, **kwargs):
10211 """SetId(self, int id)"""
10212 return _core_.MenuItem_SetId(*args, **kwargs)
10213
10214 def GetId(*args, **kwargs):
10215 """GetId(self) -> int"""
10216 return _core_.MenuItem_GetId(*args, **kwargs)
10217
10218 def IsSeparator(*args, **kwargs):
10219 """IsSeparator(self) -> bool"""
10220 return _core_.MenuItem_IsSeparator(*args, **kwargs)
10221
10222 def SetText(*args, **kwargs):
10223 """SetText(self, String str)"""
10224 return _core_.MenuItem_SetText(*args, **kwargs)
10225
10226 def GetLabel(*args, **kwargs):
10227 """GetLabel(self) -> String"""
10228 return _core_.MenuItem_GetLabel(*args, **kwargs)
10229
10230 def GetText(*args, **kwargs):
10231 """GetText(self) -> String"""
10232 return _core_.MenuItem_GetText(*args, **kwargs)
10233
10234 def GetLabelFromText(*args, **kwargs):
c24da6d6 10235 """GetLabelFromText(String text) -> String"""
d55e5bfc
RD		 10236 return _core_.MenuItem_GetLabelFromText(*args, **kwargs)
10237
10238 GetLabelFromText = staticmethod(GetLabelFromText)
10239 def GetKind(*args, **kwargs):
10240 """GetKind(self) -> int"""
10241 return _core_.MenuItem_GetKind(*args, **kwargs)
10242
10243 def SetKind(*args, **kwargs):
10244 """SetKind(self, int kind)"""
10245 return _core_.MenuItem_SetKind(*args, **kwargs)
10246
10247 def SetCheckable(*args, **kwargs):
10248 """SetCheckable(self, bool checkable)"""
10249 return _core_.MenuItem_SetCheckable(*args, **kwargs)
10250
10251 def IsCheckable(*args, **kwargs):
10252 """IsCheckable(self) -> bool"""
10253 return _core_.MenuItem_IsCheckable(*args, **kwargs)
10254
10255 def IsSubMenu(*args, **kwargs):
10256 """IsSubMenu(self) -> bool"""
10257 return _core_.MenuItem_IsSubMenu(*args, **kwargs)
10258
10259 def SetSubMenu(*args, **kwargs):
10260 """SetSubMenu(self, Menu menu)"""
10261 return _core_.MenuItem_SetSubMenu(*args, **kwargs)
10262
10263 def GetSubMenu(*args, **kwargs):
10264 """GetSubMenu(self) -> Menu"""
10265 return _core_.MenuItem_GetSubMenu(*args, **kwargs)
10266
10267 def Enable(*args, **kwargs):
10268 """Enable(self, bool enable=True)"""
10269 return _core_.MenuItem_Enable(*args, **kwargs)
10270
10271 def IsEnabled(*args, **kwargs):
10272 """IsEnabled(self) -> bool"""
10273 return _core_.MenuItem_IsEnabled(*args, **kwargs)
10274
10275 def Check(*args, **kwargs):
10276 """Check(self, bool check=True)"""
10277 return _core_.MenuItem_Check(*args, **kwargs)
10278
10279 def IsChecked(*args, **kwargs):
10280 """IsChecked(self) -> bool"""
10281 return _core_.MenuItem_IsChecked(*args, **kwargs)
10282
10283 def Toggle(*args, **kwargs):
10284 """Toggle(self)"""
10285 return _core_.MenuItem_Toggle(*args, **kwargs)
10286
10287 def SetHelp(*args, **kwargs):
10288 """SetHelp(self, String str)"""
10289 return _core_.MenuItem_SetHelp(*args, **kwargs)
10290
10291 def GetHelp(*args, **kwargs):
10292 """GetHelp(self) -> String"""
10293 return _core_.MenuItem_GetHelp(*args, **kwargs)
10294
10295 def GetAccel(*args, **kwargs):
10296 """GetAccel(self) -> AcceleratorEntry"""
10297 return _core_.MenuItem_GetAccel(*args, **kwargs)
10298
10299 def SetAccel(*args, **kwargs):
10300 """SetAccel(self, AcceleratorEntry accel)"""
10301 return _core_.MenuItem_SetAccel(*args, **kwargs)
10302
7449af73
RD		 10303 def SetBitmap(*args, **kwargs):
10304 """SetBitmap(self, Bitmap bitmap)"""
10305 return _core_.MenuItem_SetBitmap(*args, **kwargs)
10306
10307 def GetBitmap(*args, **kwargs):
10308 """GetBitmap(self) -> Bitmap"""
10309 return _core_.MenuItem_GetBitmap(*args, **kwargs)
10310
d55e5bfc
RD		 10311 def SetFont(*args, **kwargs):
10312 """SetFont(self, Font font)"""
10313 return _core_.MenuItem_SetFont(*args, **kwargs)
10314
10315 def GetFont(*args, **kwargs):
10316 """GetFont(self) -> Font"""
10317 return _core_.MenuItem_GetFont(*args, **kwargs)
10318
10319 def SetTextColour(*args, **kwargs):
10320 """SetTextColour(self, Colour colText)"""
10321 return _core_.MenuItem_SetTextColour(*args, **kwargs)
10322
10323 def GetTextColour(*args, **kwargs):
10324 """GetTextColour(self) -> Colour"""
10325 return _core_.MenuItem_GetTextColour(*args, **kwargs)
10326
10327 def SetBackgroundColour(*args, **kwargs):
10328 """SetBackgroundColour(self, Colour colBack)"""
10329 return _core_.MenuItem_SetBackgroundColour(*args, **kwargs)
10330
10331 def GetBackgroundColour(*args, **kwargs):
10332 """GetBackgroundColour(self) -> Colour"""
10333 return _core_.MenuItem_GetBackgroundColour(*args, **kwargs)
10334
10335 def SetBitmaps(*args, **kwargs):
10336 """SetBitmaps(self, Bitmap bmpChecked, Bitmap bmpUnchecked=wxNullBitmap)"""
10337 return _core_.MenuItem_SetBitmaps(*args, **kwargs)
10338
10339 def SetDisabledBitmap(*args, **kwargs):
10340 """SetDisabledBitmap(self, Bitmap bmpDisabled)"""
10341 return _core_.MenuItem_SetDisabledBitmap(*args, **kwargs)
10342
10343 def GetDisabledBitmap(*args, **kwargs):
10344 """GetDisabledBitmap(self) -> Bitmap"""
10345 return _core_.MenuItem_GetDisabledBitmap(*args, **kwargs)
10346
10347 def SetMarginWidth(*args, **kwargs):
10348 """SetMarginWidth(self, int nWidth)"""
10349 return _core_.MenuItem_SetMarginWidth(*args, **kwargs)
10350
10351 def GetMarginWidth(*args, **kwargs):
10352 """GetMarginWidth(self) -> int"""
10353 return _core_.MenuItem_GetMarginWidth(*args, **kwargs)
10354
10355 def GetDefaultMarginWidth(*args, **kwargs):
c24da6d6 10356 """GetDefaultMarginWidth() -> int"""
d55e5bfc
RD		 10357 return _core_.MenuItem_GetDefaultMarginWidth(*args, **kwargs)
10358
10359 GetDefaultMarginWidth = staticmethod(GetDefaultMarginWidth)
10360 def IsOwnerDrawn(*args, **kwargs):
10361 """IsOwnerDrawn(self) -> bool"""
10362 return _core_.MenuItem_IsOwnerDrawn(*args, **kwargs)
10363
10364 def SetOwnerDrawn(*args, **kwargs):
10365 """SetOwnerDrawn(self, bool ownerDrawn=True)"""
10366 return _core_.MenuItem_SetOwnerDrawn(*args, **kwargs)
10367
10368 def ResetOwnerDrawn(*args, **kwargs):
10369 """ResetOwnerDrawn(self)"""
10370 return _core_.MenuItem_ResetOwnerDrawn(*args, **kwargs)
10371
554f62e9
RD		 10372MenuItem_swigregister = _core_.MenuItem_swigregister
10373MenuItem_swigregister(MenuItem)
d55e5bfc
RD		 10374
10375def MenuItem_GetLabelFromText(*args, **kwargs):
554f62e9
RD		 10376 """MenuItem_GetLabelFromText(String text) -> String"""
10377 return _core_.MenuItem_GetLabelFromText(*args, **kwargs)
d55e5bfc 10378
554f62e9
RD		 10379def MenuItem_GetDefaultMarginWidth(*args):
10380 """MenuItem_GetDefaultMarginWidth() -> int"""
10381 return _core_.MenuItem_GetDefaultMarginWidth(*args)
d55e5bfc
RD		 10382
10383#---------------------------------------------------------------------------
10384
10385class Control(Window):
10386 """
10387 This is the base class for a control or 'widget'.
10388
79fccf9d
RD		 10389 A control is generally a small window which processes user input
10390 and/or displays one or more item of data.
d55e5bfc 10391 """
554f62e9
RD		 10392 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10393 __repr__ = _swig_repr
10394 def __init__(self, *args, **kwargs):
d55e5bfc 10395 """
248ed943
RD		 10396 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
10397 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
d55e5bfc
RD		 10398 String name=ControlNameStr) -> Control
10399
79fccf9d
RD		 10400 Create a Control. Normally you should only call this from a subclass'
10401 __init__ as a plain old wx.Control is not very useful.
d55e5bfc 10402 """
554f62e9 10403 _core_.Control_swiginit(self,_core_.new_Control(*args, **kwargs))
d55e5bfc
RD		 10404 self._setOORInfo(self)
10405
10406 def Create(*args, **kwargs):
10407 """
248ed943
RD		 10408 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
10409 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
d55e5bfc
RD		 10410 String name=ControlNameStr) -> bool
10411
10412 Do the 2nd phase and create the GUI control.
10413 """
10414 return _core_.Control_Create(*args, **kwargs)
10415
10416 def Command(*args, **kwargs):
10417 """
10418 Command(self, CommandEvent event)
10419
79fccf9d
RD		 10420 Simulates the effect of the user issuing a command to the item.
10421
10422 :see: `wx.CommandEvent`
10423
d55e5bfc
RD		 10424 """
10425 return _core_.Control_Command(*args, **kwargs)
10426
10427 def GetLabel(*args, **kwargs):
10428 """
10429 GetLabel(self) -> String
10430
10431 Return a control's text.
10432 """
10433 return _core_.Control_GetLabel(*args, **kwargs)
10434
a001823c 10435 def GetClassDefaultAttributes(*args, **kwargs):
f8167d6e 10436 """
a001823c 10437 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
f8167d6e 10438
a001823c
RD		 10439 Get the default attributes for this class. This is useful if you want
10440 to use the same font or colour in your own control as in a standard
10441 control -- which is a much better idea than hard coding specific
10442 colours or fonts which might look completely out of place on the
10443 user's system, especially if it uses themes.
f8167d6e 10444
a001823c
RD		 10445 The variant parameter is only relevant under Mac currently and is
10446 ignore under other platforms. Under Mac, it will change the size of
10447 the returned font. See `wx.Window.SetWindowVariant` for more about
10448 this.
f8167d6e 10449 """
d55e5bfc
RD		 10450 return _core_.Control_GetClassDefaultAttributes(*args, **kwargs)
10451
10452 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
554f62e9
RD		 10453Control_swigregister = _core_.Control_swigregister
10454Control_swigregister(Control)
d55e5bfc
RD		 10455ControlNameStr = cvar.ControlNameStr
10456
10457def PreControl(*args, **kwargs):
10458 """
10459 PreControl() -> Control
10460
10461 Precreate a Control control for 2-phase creation
10462 """
10463 val = _core_.new_PreControl(*args, **kwargs)
d55e5bfc
RD		 10464 return val
10465
10466def Control_GetClassDefaultAttributes(*args, **kwargs):
554f62e9 10467 """
a001823c
RD		 10468 Control_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
10469
10470 Get the default attributes for this class. This is useful if you want
10471 to use the same font or colour in your own control as in a standard
10472 control -- which is a much better idea than hard coding specific
10473 colours or fonts which might look completely out of place on the
10474 user's system, especially if it uses themes.
10475
10476 The variant parameter is only relevant under Mac currently and is
10477 ignore under other platforms. Under Mac, it will change the size of
10478 the returned font. See `wx.Window.SetWindowVariant` for more about
10479 this.
10480 """
554f62e9 10481 return _core_.Control_GetClassDefaultAttributes(*args, **kwargs)
d55e5bfc
RD		 10482
10483#---------------------------------------------------------------------------
10484
10485class ItemContainer(object):
10486 """
53aa7709
RD		 10487 The wx.ItemContainer class defines an interface which is implemented
10488 by all controls which have string subitems, each of which may be
10489 selected, such as `wx.ListBox`, `wx.CheckListBox`, `wx.Choice` as well
10490 as `wx.ComboBox` which implements an extended interface deriving from
79fccf9d 10491 this one.
d55e5bfc 10492
79fccf9d
RD		 10493 It defines the methods for accessing the control's items and although
10494 each of the derived classes implements them differently, they still
10495 all conform to the same interface.
d55e5bfc 10496
79fccf9d
RD		 10497 The items in a wx.ItemContainer have (non empty) string labels and,
10498 optionally, client data associated with them.
d55e5bfc
RD		 10499
10500 """
554f62e9
RD		 10501 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10502 def __init__(self): raise AttributeError, "No constructor defined"
10503 __repr__ = _swig_repr
d55e5bfc
RD		 10504 def Append(*args, **kwargs):
10505 """
10506 Append(self, String item, PyObject clientData=None) -> int
10507
79fccf9d
RD		 10508 Adds the item to the control, associating the given data with the item
10509 if not None. The return value is the index of the newly added item
10510 which may be different from the last one if the control is sorted (e.g.
10511 has wx.LB_SORT or wx.CB_SORT style).
d55e5bfc
RD		 10512 """
10513 return _core_.ItemContainer_Append(*args, **kwargs)
10514
10515 def AppendItems(*args, **kwargs):
10516 """
f5b96ee1 10517 AppendItems(self, List strings)
d55e5bfc 10518
79fccf9d
RD		 10519 Apend several items at once to the control. Notice that calling this
10520 method may be much faster than appending the items one by one if you
10521 need to add a lot of items.
d55e5bfc
RD		 10522 """
10523 return _core_.ItemContainer_AppendItems(*args, **kwargs)
10524
10525 def Insert(*args, **kwargs):
10526 """
50f151d7 10527 Insert(self, String item, unsigned int pos, PyObject clientData=None) -> int
d55e5bfc 10528
79fccf9d 10529 Insert an item into the control before the item at the ``pos`` index,
d55e5bfc
RD		 10530 optionally associating some data object with the item.
10531 """
10532 return _core_.ItemContainer_Insert(*args, **kwargs)
10533
10534 def Clear(*args, **kwargs):
10535 """
10536 Clear(self)
10537
10538 Removes all items from the control.
10539 """
10540 return _core_.ItemContainer_Clear(*args, **kwargs)
10541
10542 def Delete(*args, **kwargs):
10543 """
50f151d7 10544 Delete(self, unsigned int n)
d55e5bfc 10545
79fccf9d
RD		 10546 Deletes the item at the zero-based index 'n' from the control. Note
10547 that it is an error (signalled by a `wx.PyAssertionError` exception if
10548 enabled) to remove an item with the index negative or greater or equal
10549 than the number of items in the control.
d55e5bfc
RD		 10550 """
10551 return _core_.ItemContainer_Delete(*args, **kwargs)
10552
53aa7709
RD		 10553 def GetClientData(*args, **kwargs):
10554 """
50f151d7 10555 GetClientData(self, unsigned int n) -> PyObject
53aa7709
RD		 10556
10557 Returns the client data associated with the given item, (if any.)
10558 """
10559 return _core_.ItemContainer_GetClientData(*args, **kwargs)
10560
10561 def SetClientData(*args, **kwargs):
10562 """
50f151d7 10563 SetClientData(self, unsigned int n, PyObject clientData)
53aa7709
RD		 10564
10565 Associate the given client data with the item at position n.
10566 """
10567 return _core_.ItemContainer_SetClientData(*args, **kwargs)
10568
d55e5bfc
RD		 10569 def GetCount(*args, **kwargs):
10570 """
50f151d7 10571 GetCount(self) -> unsigned int
d55e5bfc
RD		 10572
10573 Returns the number of items in the control.
10574 """
10575 return _core_.ItemContainer_GetCount(*args, **kwargs)
10576
10577 def IsEmpty(*args, **kwargs):
10578 """
10579 IsEmpty(self) -> bool
10580
10581 Returns True if the control is empty or False if it has some items.
10582 """
10583 return _core_.ItemContainer_IsEmpty(*args, **kwargs)
10584
10585 def GetString(*args, **kwargs):
10586 """
50f151d7 10587 GetString(self, unsigned int n) -> String
d55e5bfc
RD		 10588
10589 Returns the label of the item with the given index.
10590 """
10591 return _core_.ItemContainer_GetString(*args, **kwargs)
10592
10593 def GetStrings(*args, **kwargs):
10594 """GetStrings(self) -> wxArrayString"""
10595 return _core_.ItemContainer_GetStrings(*args, **kwargs)
10596
10597 def SetString(*args, **kwargs):
10598 """
50f151d7 10599 SetString(self, unsigned int n, String s)
d55e5bfc
RD		 10600
10601 Sets the label for the given item.
10602 """
10603 return _core_.ItemContainer_SetString(*args, **kwargs)
10604
10605 def FindString(*args, **kwargs):
10606 """
10607 FindString(self, String s) -> int
10608
10609 Finds an item whose label matches the given string. Returns the
79fccf9d
RD		 10610 zero-based position of the item, or ``wx.NOT_FOUND`` if the string was not
10611 found.
d55e5bfc
RD		 10612 """
10613 return _core_.ItemContainer_FindString(*args, **kwargs)
10614
53aa7709 10615 def SetSelection(*args, **kwargs):
d55e5bfc 10616 """
53aa7709 10617 SetSelection(self, int n)
d55e5bfc
RD		 10618
10619 Sets the item at index 'n' to be the selected item.
10620 """
53aa7709 10621 return _core_.ItemContainer_SetSelection(*args, **kwargs)
d55e5bfc 10622
d55e5bfc
RD		 10623 def GetSelection(*args, **kwargs):
10624 """
10625 GetSelection(self) -> int
10626
79fccf9d
RD		 10627 Returns the index of the selected item or ``wx.NOT_FOUND`` if no item
10628 is selected.
d55e5bfc
RD		 10629 """
10630 return _core_.ItemContainer_GetSelection(*args, **kwargs)
10631
53aa7709
RD		 10632 def SetStringSelection(*args, **kwargs):
10633 """SetStringSelection(self, String s) -> bool"""
10634 return _core_.ItemContainer_SetStringSelection(*args, **kwargs)
10635
d55e5bfc
RD		 10636 def GetStringSelection(*args, **kwargs):
10637 """
10638 GetStringSelection(self) -> String
10639
79fccf9d
RD		 10640 Returns the label of the selected item or an empty string if no item
10641 is selected.
d55e5bfc
RD		 10642 """
10643 return _core_.ItemContainer_GetStringSelection(*args, **kwargs)
10644
53aa7709 10645 def Select(*args, **kwargs):
d55e5bfc 10646 """
53aa7709 10647 Select(self, int n)
d55e5bfc 10648
53aa7709
RD		 10649 This is the same as `SetSelection` and exists only because it is
10650 slightly more natural for controls which support multiple selection.
d55e5bfc 10651 """
53aa7709 10652 return _core_.ItemContainer_Select(*args, **kwargs)
d55e5bfc 10653
554f62e9
RD		 10654ItemContainer_swigregister = _core_.ItemContainer_swigregister
10655ItemContainer_swigregister(ItemContainer)
d55e5bfc
RD		 10656
10657#---------------------------------------------------------------------------
10658
10659class ControlWithItems(Control,ItemContainer):
10660 """
79fccf9d
RD		 10661 wx.ControlWithItems combines the ``wx.ItemContainer`` class with the
10662 wx.Control class, and is used for the base class of various controls
10663 that have items.
d55e5bfc 10664 """
554f62e9
RD		 10665 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10666 def __init__(self): raise AttributeError, "No constructor defined"
10667 __repr__ = _swig_repr
10668ControlWithItems_swigregister = _core_.ControlWithItems_swigregister
10669ControlWithItems_swigregister(ControlWithItems)
d55e5bfc
RD		 10670
10671#---------------------------------------------------------------------------
10672
10673class SizerItem(Object):
248ed943
RD		 10674 """
10675 The wx.SizerItem class is used to track the position, size and other
10676 attributes of each item managed by a `wx.Sizer`. In normal usage user
10677 code should never need to deal directly with a wx.SizerItem, but
10678 custom classes derived from `wx.PySizer` will probably need to use the
10679 collection of wx.SizerItems held by wx.Sizer when calculating layout.
10680
10681 :see: `wx.Sizer`, `wx.GBSizerItem`
10682 """
554f62e9
RD		 10683 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10684 __repr__ = _swig_repr
10685 def __init__(self, *args, **kwargs):
248ed943
RD		 10686 """
10687 __init__(self) -> SizerItem
10688
10689 Constructs an empty wx.SizerItem. Either a window, sizer or spacer
10690 size will need to be set before this item can be used in a Sizer.
10691
10692 You will probably never need to create a wx.SizerItem directly as they
10693 are created automatically when the sizer's Add, Insert or Prepend
10694 methods are called.
10695
10696 :see: `wx.SizerItemSpacer`, `wx.SizerItemWindow`, `wx.SizerItemSizer`
10697 """
554f62e9
RD		 10698 _core_.SizerItem_swiginit(self,_core_.new_SizerItem(*args, **kwargs))
10699 __swig_destroy__ = _core_.delete_SizerItem
10700 __del__ = lambda self : None;
d55e5bfc 10701 def DeleteWindows(*args, **kwargs):
248ed943
RD		 10702 """
10703 DeleteWindows(self)
10704
10705 Destroy the window or the windows in a subsizer, depending on the type
10706 of item.
10707 """
d55e5bfc
RD		 10708 return _core_.SizerItem_DeleteWindows(*args, **kwargs)
10709
10710 def DetachSizer(*args, **kwargs):
248ed943
RD		 10711 """
10712 DetachSizer(self)
10713
10714 Enable deleting the SizerItem without destroying the contained sizer.
10715 """
d55e5bfc
RD		 10716 return _core_.SizerItem_DetachSizer(*args, **kwargs)
10717
10718 def GetSize(*args, **kwargs):
248ed943
RD		 10719 """
10720 GetSize(self) -> Size
10721
10722 Get the current size of the item, as set in the last Layout.
10723 """
d55e5bfc
RD		 10724 return _core_.SizerItem_GetSize(*args, **kwargs)
10725
10726 def CalcMin(*args, **kwargs):
248ed943
RD		 10727 """
10728 CalcMin(self) -> Size
10729
10730 Calculates the minimum desired size for the item, including any space
10731 needed by borders.
10732 """
d55e5bfc
RD		 10733 return _core_.SizerItem_CalcMin(*args, **kwargs)
10734
10735 def SetDimension(*args, **kwargs):
248ed943
RD		 10736 """
10737 SetDimension(self, Point pos, Size size)
10738
10739 Set the position and size of the space allocated for this item by the
10740 sizer, and adjust the position and size of the item (window or
10741 subsizer) to be within that space taking alignment and borders into
10742 account.
10743 """
d55e5bfc
RD		 10744 return _core_.SizerItem_SetDimension(*args, **kwargs)
10745
10746 def GetMinSize(*args, **kwargs):
248ed943
RD		 10747 """
10748 GetMinSize(self) -> Size
10749
10750 Get the minimum size needed for the item.
10751 """
d55e5bfc
RD		 10752 return _core_.SizerItem_GetMinSize(*args, **kwargs)
10753
a001823c
RD		 10754 def GetMinSizeWithBorder(*args, **kwargs):
10755 """
10756 GetMinSizeWithBorder(self) -> Size
10757
10758 Get the minimum size needed for the item with space for the borders
10759 added, if needed.
10760 """
10761 return _core_.SizerItem_GetMinSizeWithBorder(*args, **kwargs)
10762
d55e5bfc
RD		 10763 def SetInitSize(*args, **kwargs):
10764 """SetInitSize(self, int x, int y)"""
10765 return _core_.SizerItem_SetInitSize(*args, **kwargs)
10766
10767 def SetRatioWH(*args, **kwargs):
248ed943
RD		 10768 """
10769 SetRatioWH(self, int width, int height)
10770
10771 Set the ratio item attribute.
10772 """
d55e5bfc
RD		 10773 return _core_.SizerItem_SetRatioWH(*args, **kwargs)
10774
10775 def SetRatioSize(*args, **kwargs):
248ed943
RD		 10776 """
10777 SetRatioSize(self, Size size)
10778
10779 Set the ratio item attribute.
10780 """
d55e5bfc
RD		 10781 return _core_.SizerItem_SetRatioSize(*args, **kwargs)
10782
10783 def SetRatio(*args, **kwargs):
248ed943
RD		 10784 """
10785 SetRatio(self, float ratio)
10786
10787 Set the ratio item attribute.
10788 """
d55e5bfc
RD		 10789 return _core_.SizerItem_SetRatio(*args, **kwargs)
10790
10791 def GetRatio(*args, **kwargs):
248ed943
RD		 10792 """
10793 GetRatio(self) -> float
10794
10795 Set the ratio item attribute.
10796 """
d55e5bfc
RD		 10797 return _core_.SizerItem_GetRatio(*args, **kwargs)
10798
c1cb24a4
RD		 10799 def GetRect(*args, **kwargs):
10800 """
10801 GetRect(self) -> Rect
10802
10803 Returns the rectangle that the sizer item should occupy
10804 """
10805 return _core_.SizerItem_GetRect(*args, **kwargs)
10806
d55e5bfc 10807 def IsWindow(*args, **kwargs):
248ed943
RD		 10808 """
10809 IsWindow(self) -> bool
10810
10811 Is this sizer item a window?
10812 """
d55e5bfc
RD		 10813 return _core_.SizerItem_IsWindow(*args, **kwargs)
10814
10815 def IsSizer(*args, **kwargs):
248ed943
RD		 10816 """
10817 IsSizer(self) -> bool
10818
10819 Is this sizer item a subsizer?
10820 """
d55e5bfc
RD		 10821 return _core_.SizerItem_IsSizer(*args, **kwargs)
10822
10823 def IsSpacer(*args, **kwargs):
248ed943
RD		 10824 """
10825 IsSpacer(self) -> bool
10826
10827 Is this sizer item a spacer?
10828 """
d55e5bfc
RD		 10829 return _core_.SizerItem_IsSpacer(*args, **kwargs)
10830
10831 def SetProportion(*args, **kwargs):
248ed943
RD		 10832 """
10833 SetProportion(self, int proportion)
10834
10835 Set the proportion value for this item.
10836 """
d55e5bfc
RD		 10837 return _core_.SizerItem_SetProportion(*args, **kwargs)
10838
10839 def GetProportion(*args, **kwargs):
248ed943
RD		 10840 """
10841 GetProportion(self) -> int
10842
10843 Get the proportion value for this item.
10844 """
d55e5bfc
RD		 10845 return _core_.SizerItem_GetProportion(*args, **kwargs)
10846
248ed943
RD		 10847 SetOption = wx._deprecated(SetProportion, "Please use `SetProportion` instead.")
10848 GetOption = wx._deprecated(GetProportion, "Please use `GetProportion` instead.")
d55e5bfc 10849 def SetFlag(*args, **kwargs):
248ed943
RD		 10850 """
10851 SetFlag(self, int flag)
10852
10853 Set the flag value for this item.
10854 """
d55e5bfc
RD		 10855 return _core_.SizerItem_SetFlag(*args, **kwargs)
10856
10857 def GetFlag(*args, **kwargs):
248ed943
RD		 10858 """
10859 GetFlag(self) -> int
10860
10861 Get the flag value for this item.
10862 """
d55e5bfc
RD		 10863 return _core_.SizerItem_GetFlag(*args, **kwargs)
10864
10865 def SetBorder(*args, **kwargs):
248ed943
RD		 10866 """
10867 SetBorder(self, int border)
10868
10869 Set the border value for this item.
10870 """
d55e5bfc
RD		 10871 return _core_.SizerItem_SetBorder(*args, **kwargs)
10872
10873 def GetBorder(*args, **kwargs):
248ed943
RD		 10874 """
10875 GetBorder(self) -> int
10876
10877 Get the border value for this item.
10878 """
d55e5bfc
RD		 10879 return _core_.SizerItem_GetBorder(*args, **kwargs)
10880
10881 def GetWindow(*args, **kwargs):
248ed943
RD		 10882 """
10883 GetWindow(self) -> Window
10884
10885 Get the window (if any) that is managed by this sizer item.
10886 """
d55e5bfc
RD		 10887 return _core_.SizerItem_GetWindow(*args, **kwargs)
10888
10889 def SetWindow(*args, **kwargs):
248ed943
RD		 10890 """
10891 SetWindow(self, Window window)
10892
10893 Set the window to be managed by this sizer item.
10894 """
d55e5bfc
RD		 10895 return _core_.SizerItem_SetWindow(*args, **kwargs)
10896
10897 def GetSizer(*args, **kwargs):
248ed943
RD		 10898 """
10899 GetSizer(self) -> Sizer
10900
10901 Get the subsizer (if any) that is managed by this sizer item.
10902 """
d55e5bfc
RD		 10903 return _core_.SizerItem_GetSizer(*args, **kwargs)
10904
10905 def SetSizer(*args, **kwargs):
248ed943
RD		 10906 """
10907 SetSizer(self, Sizer sizer)
10908
10909 Set the subsizer to be managed by this sizer item.
10910 """
d55e5bfc
RD		 10911 return _core_.SizerItem_SetSizer(*args, **kwargs)
10912
10913 def GetSpacer(*args, **kwargs):
248ed943
RD		 10914 """
10915 GetSpacer(self) -> Size
10916
10917 Get the size of the spacer managed by this sizer item.
10918 """
d55e5bfc
RD		 10919 return _core_.SizerItem_GetSpacer(*args, **kwargs)
10920
10921 def SetSpacer(*args, **kwargs):
248ed943
RD		 10922 """
10923 SetSpacer(self, Size size)
10924
10925 Set the size of the spacer to be managed by this sizer item.
10926 """
d55e5bfc
RD		 10927 return _core_.SizerItem_SetSpacer(*args, **kwargs)
10928
10929 def Show(*args, **kwargs):
248ed943
RD		 10930 """
10931 Show(self, bool show)
10932
10933 Set the show item attribute, which sizers use to determine if the item
10934 is to be made part of the layout or not. If the item is tracking a
10935 window then it is shown or hidden as needed.
10936 """
d55e5bfc
RD		 10937 return _core_.SizerItem_Show(*args, **kwargs)
10938
10939 def IsShown(*args, **kwargs):
248ed943
RD		 10940 """
10941 IsShown(self) -> bool
10942
10943 Is the item to be shown in the layout?
10944 """
d55e5bfc
RD		 10945 return _core_.SizerItem_IsShown(*args, **kwargs)
10946
10947 def GetPosition(*args, **kwargs):
248ed943
RD		 10948 """
10949 GetPosition(self) -> Point
10950
10951 Returns the current position of the item, as set in the last Layout.
10952 """
d55e5bfc
RD		 10953 return _core_.SizerItem_GetPosition(*args, **kwargs)
10954
10955 def GetUserData(*args, **kwargs):
248ed943
RD		 10956 """
10957 GetUserData(self) -> PyObject
10958
10959 Returns the userData associated with this sizer item, or None if there
10960 isn't any.
10961 """
d55e5bfc
RD		 10962 return _core_.SizerItem_GetUserData(*args, **kwargs)
10963
7449af73
RD		 10964 def SetUserData(*args, **kwargs):
10965 """
10966 SetUserData(self, PyObject userData)
10967
10968 Associate a Python object with this sizer item.
10969 """
10970 return _core_.SizerItem_SetUserData(*args, **kwargs)
10971
554f62e9
RD		 10972SizerItem_swigregister = _core_.SizerItem_swigregister
10973SizerItem_swigregister(SizerItem)
d55e5bfc 10974
248ed943 10975def SizerItemWindow(*args, **kwargs):
d55e5bfc 10976 """
248ed943
RD		 10977 SizerItemWindow(Window window, int proportion, int flag, int border,
10978 PyObject userData=None) -> SizerItem
10979
10980 Constructs a `wx.SizerItem` for tracking a window.
d55e5bfc 10981 """
248ed943 10982 val = _core_.new_SizerItemWindow(*args, **kwargs)
d55e5bfc
RD		 10983 return val
10984
248ed943 10985def SizerItemSpacer(*args, **kwargs):
d55e5bfc 10986 """
248ed943
RD		 10987 SizerItemSpacer(int width, int height, int proportion, int flag, int border,
10988 PyObject userData=None) -> SizerItem
10989
10990 Constructs a `wx.SizerItem` for tracking a spacer.
d55e5bfc 10991 """
248ed943 10992 val = _core_.new_SizerItemSpacer(*args, **kwargs)
d55e5bfc
RD		 10993 return val
10994
10995def SizerItemSizer(*args, **kwargs):
10996 """
10997 SizerItemSizer(Sizer sizer, int proportion, int flag, int border,
248ed943
RD		 10998 PyObject userData=None) -> SizerItem
10999
11000 Constructs a `wx.SizerItem` for tracking a subsizer
d55e5bfc
RD		 11001 """
11002 val = _core_.new_SizerItemSizer(*args, **kwargs)
d55e5bfc
RD		 11003 return val
11004
11005class Sizer(Object):
248ed943
RD		 11006 """
11007 wx.Sizer is the abstract base class used for laying out subwindows in
11008 a window. You cannot use wx.Sizer directly; instead, you will have to
11009 use one of the sizer classes derived from it such as `wx.BoxSizer`,
11010 `wx.StaticBoxSizer`, `wx.NotebookSizer`, `wx.GridSizer`, `wx.FlexGridSizer`
11011 and `wx.GridBagSizer`.
11012
11013 The concept implemented by sizers in wxWidgets is closely related to
11014 layout tools in other GUI toolkits, such as Java's AWT, the GTK
11015 toolkit or the Qt toolkit. It is based upon the idea of the individual
11016 subwindows reporting their minimal required size and their ability to
11017 get stretched if the size of the parent window has changed. This will
11018 most often mean that the programmer does not set the original size of
11019 a dialog in the beginning, rather the dialog will assigned a sizer and
11020 this sizer will be queried about the recommended size. The sizer in
11021 turn will query its children, which can be normal windows or contorls,
11022 empty space or other sizers, so that a hierarchy of sizers can be
11023 constructed. Note that wxSizer does not derive from wxWindow and thus
11024 do not interfere with tab ordering and requires very little resources
11025 compared to a real window on screen.
11026
11027 What makes sizers so well fitted for use in wxWidgets is the fact that
11028 every control reports its own minimal size and the algorithm can
11029 handle differences in font sizes or different window (dialog item)
11030 sizes on different platforms without problems. If for example the
11031 standard font as well as the overall design of Mac widgets requires
11032 more space than on Windows, then the initial size of a dialog using a
11033 sizer will automatically be bigger on Mac than on Windows.
11034 """
554f62e9
RD		 11035 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11036 def __init__(self): raise AttributeError, "No constructor defined"
11037 __repr__ = _swig_repr
11038 __swig_destroy__ = _core_.delete_Sizer
11039 __del__ = lambda self : None;
d55e5bfc
RD		 11040 def _setOORInfo(*args, **kwargs):
11041 """_setOORInfo(self, PyObject _self)"""
11042 return _core_.Sizer__setOORInfo(*args, **kwargs)
11043
11044 def Add(*args, **kwargs):
11045 """
248ed943 11046 Add(self, item, int proportion=0, int flag=0, int border=0,
c1cb24a4 11047 PyObject userData=None) -> wx.SizerItem
248ed943
RD		 11048
11049 Appends a child item to the sizer.
d55e5bfc
RD		 11050 """
11051 return _core_.Sizer_Add(*args, **kwargs)
11052
11053 def Insert(*args, **kwargs):
11054 """
248ed943 11055 Insert(self, int before, item, int proportion=0, int flag=0, int border=0,
c1cb24a4 11056 PyObject userData=None) -> wx.SizerItem
248ed943
RD		 11057
11058 Inserts a new item into the list of items managed by this sizer before
11059 the item at index *before*. See `Add` for a description of the parameters.
d55e5bfc
RD		 11060 """
11061 return _core_.Sizer_Insert(*args, **kwargs)
11062
11063 def Prepend(*args, **kwargs):
11064 """
248ed943 11065 Prepend(self, item, int proportion=0, int flag=0, int border=0,
c1cb24a4 11066 PyObject userData=None) -> wx.SizerItem
248ed943
RD		 11067
11068 Adds a new item to the begining of the list of sizer items managed by
11069 this sizer. See `Add` for a description of the parameters.
d55e5bfc
RD		 11070 """
11071 return _core_.Sizer_Prepend(*args, **kwargs)
11072
11073 def Remove(*args, **kwargs):
248ed943
RD		 11074 """
11075 Remove(self, item) -> bool
11076
11077 Removes an item from the sizer and destroys it. This method does not
11078 cause any layout or resizing to take place, call `Layout` to update
11079 the layout on screen after removing a child from the sizer. The
11080 *item* parameter can be either a window, a sizer, or the zero-based
11081 index of an item to remove. Returns True if the child item was found
11082 and removed.
11083 """
d55e5bfc
RD		 11084 return _core_.Sizer_Remove(*args, **kwargs)
11085
1a6bba1e 11086 def Detach(*args, **kwargs):
248ed943
RD		 11087 """
11088 Detach(self, item) -> bool
11089
11090 Detaches an item from the sizer without destroying it. This method
11091 does not cause any layout or resizing to take place, call `Layout` to
11092 do so. The *item* parameter can be either a window, a sizer, or the
11093 zero-based index of the item to be detached. Returns True if the child item
11094 was found and detached.
11095 """
1a6bba1e
RD		 11096 return _core_.Sizer_Detach(*args, **kwargs)
11097
c1cb24a4
RD		 11098 def GetItem(*args, **kwargs):
11099 """
11100 GetItem(self, item) -> wx.SizerItem
11101
11102 Returns the `wx.SizerItem` which holds the *item* given. The *item*
11103 parameter can be either a window, a sizer, or the zero-based index of
4d170c95 11104 the item to be found.
c1cb24a4
RD		 11105 """
11106 return _core_.Sizer_GetItem(*args, **kwargs)
11107
d55e5bfc
RD		 11108 def _SetItemMinSize(*args, **kwargs):
11109 """_SetItemMinSize(self, PyObject item, Size size)"""
11110 return _core_.Sizer__SetItemMinSize(*args, **kwargs)
11111
248ed943
RD		 11112 def SetItemMinSize(self, item, *args):
11113 """
11114 SetItemMinSize(self, item, Size size)
11115
11116 Sets the minimum size that will be allocated for an item in the sizer.
11117 The *item* parameter can be either a window, a sizer, or the
11118 zero-based index of the item. If a window or sizer is given then it
11119 will be searched for recursivly in subsizers if neccessary.
11120 """
11121 if len(args) == 2:
11122 # for backward compatibility accept separate width,height args too
11123 return self._SetItemMinSize(item, args)
11124 else:
11125 return self._SetItemMinSize(item, args[0])
11126
d55e5bfc 11127 def AddItem(*args, **kwargs):
248ed943
RD		 11128 """
11129 AddItem(self, SizerItem item)
11130
11131 Adds a `wx.SizerItem` to the sizer.
11132 """
d55e5bfc
RD		 11133 return _core_.Sizer_AddItem(*args, **kwargs)
11134
11135 def InsertItem(*args, **kwargs):
248ed943
RD		 11136 """
11137 InsertItem(self, int index, SizerItem item)
11138
11139 Inserts a `wx.SizerItem` to the sizer at the position given by *index*.
11140 """
d55e5bfc
RD		 11141 return _core_.Sizer_InsertItem(*args, **kwargs)
11142
11143 def PrependItem(*args, **kwargs):
248ed943
RD		 11144 """
11145 PrependItem(self, SizerItem item)
11146
11147 Prepends a `wx.SizerItem` to the sizer.
11148 """
d55e5bfc
RD		 11149 return _core_.Sizer_PrependItem(*args, **kwargs)
11150
248ed943 11151 def AddMany(self, items):
c24da6d6
RD		 11152 """
11153 AddMany is a convenience method for adding several items
11154 to a sizer at one time. Simply pass it a list of tuples,
11155 where each tuple consists of the parameters that you
11156 would normally pass to the `Add` method.
11157 """
248ed943
RD		 11158 for item in items:
11159 if type(item) != type(()) or (len(item) == 2 and type(item[0]) == type(1)):
11160 item = (item, )
11161 self.Add(*item)
d55e5bfc
RD		 11162
11163 # for backwards compatibility only, please do not use in new code
b9d6a5f3
RD		 11164 def AddWindow(self, *args, **kw):
11165 """Compatibility alias for `Add`."""
11166 return self.Add(*args, **kw)
11167 def AddSizer(self, *args, **kw):
11168 """Compatibility alias for `Add`."""
11169 return self.Add(*args, **kw)
11170 def AddSpacer(self, *args, **kw):
11171 """Compatibility alias for `Add`."""
11172 return self.Add(*args, **kw)
11173
11174 def PrependWindow(self, *args, **kw):
11175 """Compatibility alias for `Prepend`."""
11176 return self.Prepend(*args, **kw)
11177 def PrependSizer(self, *args, **kw):
11178 """Compatibility alias for `Prepend`."""
11179 return self.Prepend(*args, **kw)
11180 def PrependSpacer(self, *args, **kw):
11181 """Compatibility alias for `Prepend`."""
11182 return self.Prepend(*args, **kw)
11183
11184 def InsertWindow(self, *args, **kw):
11185 """Compatibility alias for `Insert`."""
11186 return self.Insert(*args, **kw)
11187 def InsertSizer(self, *args, **kw):
11188 """Compatibility alias for `Insert`."""
11189 return self.Insert(*args, **kw)
11190 def InsertSpacer(self, *args, **kw):
11191 """Compatibility alias for `Insert`."""
11192 return self.Insert(*args, **kw)
11193
11194 def RemoveWindow(self, *args, **kw):
11195 """Compatibility alias for `Remove`."""
11196 return self.Remove(*args, **kw)
11197 def RemoveSizer(self, *args, **kw):
11198 """Compatibility alias for `Remove`."""
11199 return self.Remove(*args, **kw)
11200 def RemovePos(self, *args, **kw):
11201 """Compatibility alias for `Remove`."""
11202 return self.Remove(*args, **kw)
d55e5bfc
RD		 11203
11204
d55e5bfc 11205 def SetDimension(*args, **kwargs):
248ed943
RD		 11206 """
11207 SetDimension(self, int x, int y, int width, int height)
11208
11209 Call this to force the sizer to take the given dimension and thus
11210 force the items owned by the sizer to resize themselves according to
11211 the rules defined by the parameter in the `Add`, `Insert` or `Prepend`
11212 methods.
11213 """
d55e5bfc
RD		 11214 return _core_.Sizer_SetDimension(*args, **kwargs)
11215
11216 def SetMinSize(*args, **kwargs):
248ed943
RD		 11217 """
11218 SetMinSize(self, Size size)
11219
11220 Call this to give the sizer a minimal size. Normally, the sizer will
11221 calculate its minimal size based purely on how much space its children
11222 need. After calling this method `GetMinSize` will return either the
11223 minimal size as requested by its children or the minimal size set
11224 here, depending on which is bigger.
11225 """
d55e5bfc
RD		 11226 return _core_.Sizer_SetMinSize(*args, **kwargs)
11227
11228 def GetSize(*args, **kwargs):
248ed943
RD		 11229 """
11230 GetSize(self) -> Size
11231
11232 Returns the current size of the space managed by the sizer.
11233 """
d55e5bfc
RD		 11234 return _core_.Sizer_GetSize(*args, **kwargs)
11235
11236 def GetPosition(*args, **kwargs):
248ed943
RD		 11237 """
11238 GetPosition(self) -> Point
11239
11240 Returns the current position of the sizer's managed space.
11241 """
d55e5bfc
RD		 11242 return _core_.Sizer_GetPosition(*args, **kwargs)
11243
11244 def GetMinSize(*args, **kwargs):
248ed943
RD		 11245 """
11246 GetMinSize(self) -> Size
11247
11248 Returns the minimal size of the sizer. This is either the combined
11249 minimal size of all the children and their borders or the minimal size
11250 set by SetMinSize, depending on which is bigger.
11251 """
d55e5bfc
RD		 11252 return _core_.Sizer_GetMinSize(*args, **kwargs)
11253
11254 def GetSizeTuple(self):
1a6bba1e 11255 return self.GetSize().Get()
d55e5bfc 11256 def GetPositionTuple(self):
1a6bba1e 11257 return self.GetPosition().Get()
d55e5bfc 11258 def GetMinSizeTuple(self):
1a6bba1e 11259 return self.GetMinSize().Get()
d55e5bfc
RD		 11260
11261 def RecalcSizes(*args, **kwargs):
248ed943
RD		 11262 """
11263 RecalcSizes(self)
11264
11265 Using the sizes calculated by `CalcMin` reposition and resize all the
11266 items managed by this sizer. You should not need to call this directly as
11267 it is called by `Layout`.
11268 """
d55e5bfc
RD		 11269 return _core_.Sizer_RecalcSizes(*args, **kwargs)
11270
11271 def CalcMin(*args, **kwargs):
248ed943
RD		 11272 """
11273 CalcMin(self) -> Size
11274
11275 This method is where the sizer will do the actual calculation of its
11276 children's minimal sizes. You should not need to call this directly as
11277 it is called by `Layout`.
11278 """
d55e5bfc
RD		 11279 return _core_.Sizer_CalcMin(*args, **kwargs)
11280
11281 def Layout(*args, **kwargs):
248ed943
RD		 11282 """
11283 Layout(self)
11284
11285 This method will force the recalculation and layout of the items
11286 controlled by the sizer using the current space allocated to the
11287 sizer. Normally this is called automatically from the owning window's
11288 EVT_SIZE handler, but it is also useful to call it from user code when
11289 one of the items in a sizer change size, or items are added or
11290 removed.
11291 """
d55e5bfc
RD		 11292 return _core_.Sizer_Layout(*args, **kwargs)
11293
11294 def Fit(*args, **kwargs):
248ed943
RD		 11295 """
11296 Fit(self, Window window) -> Size
11297
11298 Tell the sizer to resize the *window* to match the sizer's minimal
11299 size. This is commonly done in the constructor of the window itself in
11300 order to set its initial size to match the needs of the children as
11301 determined by the sizer. Returns the new size.
11302
11303 For a top level window this is the total window size, not the client size.
11304 """
d55e5bfc
RD		 11305 return _core_.Sizer_Fit(*args, **kwargs)
11306
11307 def FitInside(*args, **kwargs):
248ed943
RD		 11308 """
11309 FitInside(self, Window window)
11310
11311 Tell the sizer to resize the *virtual size* of the *window* to match the
11312 sizer's minimal size. This will not alter the on screen size of the
11313 window, but may cause the addition/removal/alteration of scrollbars
11314 required to view the virtual area in windows which manage it.
11315
11316 :see: `wx.ScrolledWindow.SetScrollbars`, `SetVirtualSizeHints`
11317
11318 """
d55e5bfc
RD		 11319 return _core_.Sizer_FitInside(*args, **kwargs)
11320
11321 def SetSizeHints(*args, **kwargs):
248ed943
RD		 11322 """
11323 SetSizeHints(self, Window window)
11324
11325 Tell the sizer to set (and `Fit`) the minimal size of the *window* to
11326 match the sizer's minimal size. This is commonly done in the
11327 constructor of the window itself if the window is resizable (as are
11328 many dialogs under Unix and frames on probably all platforms) in order
11329 to prevent the window from being sized smaller than the minimal size
11330 required by the sizer.
11331 """
d55e5bfc
RD		 11332 return _core_.Sizer_SetSizeHints(*args, **kwargs)
11333
11334 def SetVirtualSizeHints(*args, **kwargs):
248ed943
RD		 11335 """
11336 SetVirtualSizeHints(self, Window window)
11337
11338 Tell the sizer to set the minimal size of the window virtual area to
11339 match the sizer's minimal size. For windows with managed scrollbars
11340 this will set them appropriately.
11341
11342 :see: `wx.ScrolledWindow.SetScrollbars`
11343
11344 """
d55e5bfc
RD		 11345 return _core_.Sizer_SetVirtualSizeHints(*args, **kwargs)
11346
11347 def Clear(*args, **kwargs):
248ed943
RD		 11348 """
11349 Clear(self, bool deleteWindows=False)
11350
11351 Clear all items from the sizer, optionally destroying the window items
11352 as well.
11353 """
d55e5bfc
RD		 11354 return _core_.Sizer_Clear(*args, **kwargs)
11355
11356 def DeleteWindows(*args, **kwargs):
248ed943
RD		 11357 """
11358 DeleteWindows(self)
11359
11360 Destroy all windows managed by the sizer.
11361 """
d55e5bfc
RD		 11362 return _core_.Sizer_DeleteWindows(*args, **kwargs)
11363
11364 def GetChildren(*args, **kwargs):
248ed943 11365 """
51b83b37 11366 GetChildren(self) -> list
248ed943
RD		 11367
11368 Returns a list of all the `wx.SizerItem` objects managed by the sizer.
11369 """
d55e5bfc
RD		 11370 return _core_.Sizer_GetChildren(*args, **kwargs)
11371
11372 def Show(*args, **kwargs):
248ed943 11373 """
ae8162c8 11374 Show(self, item, bool show=True, bool recursive=false) -> bool
d55e5bfc 11375
248ed943
RD		 11376 Shows or hides an item managed by the sizer. To make a sizer item
11377 disappear or reappear, use Show followed by `Layout`. The *item*
11378 parameter can be either a window, a sizer, or the zero-based index of
629e65c2
RD		 11379 the item. Use the recursive parameter to show or hide an item in a
11380 subsizer. Returns True if the item was found.
248ed943
RD		 11381 """
11382 return _core_.Sizer_Show(*args, **kwargs)
d55e5bfc
RD		 11383
11384 def IsShown(*args, **kwargs):
248ed943
RD		 11385 """
11386 IsShown(self, item)
11387
b1fcee84 11388 Determines if the item is currently shown. To make a sizer
248ed943
RD		 11389 item disappear or reappear, use Show followed by `Layout`. The *item*
11390 parameter can be either a window, a sizer, or the zero-based index of
11391 the item.
11392 """
d55e5bfc
RD		 11393 return _core_.Sizer_IsShown(*args, **kwargs)
11394
629e65c2 11395 def Hide(self, item, recursive=False):
248ed943 11396 """
27fb7603 11397 A convenience method for `Show` (item, False, recursive).
248ed943 11398 """
06759a38 11399 return self.Show(item, False, recursive)
248ed943 11400
d55e5bfc 11401 def ShowItems(*args, **kwargs):
248ed943
RD		 11402 """
11403 ShowItems(self, bool show)
11404
84f85550 11405 Recursively call `wx.SizerItem.Show` on all sizer items.
248ed943 11406 """
d55e5bfc
RD		 11407 return _core_.Sizer_ShowItems(*args, **kwargs)
11408
554f62e9
RD		 11409Sizer_swigregister = _core_.Sizer_swigregister
11410Sizer_swigregister(Sizer)
d55e5bfc
RD		 11411
11412class PySizer(Sizer):
248ed943
RD		 11413 """
11414 wx.PySizer is a special version of `wx.Sizer` that has been
11415 instrumented to allow the C++ virtual methods to be overloaded in
11416 Python derived classes. You would derive from this class if you are
11417 wanting to implement a custom sizer in Python code. Simply implement
11418 `CalcMin` and `RecalcSizes` in the derived class and you're all set.
11419 For example::
11420
11421 class MySizer(wx.PySizer):
11422 def __init__(self):
11423 wx.PySizer.__init__(self)
11424
11425 def CalcMin(self):
11426 for item in self.GetChildren():
11427 # calculate the total minimum width and height needed
11428 # by all items in the sizer according to this sizer's
11429 # layout algorithm.
11430 ...
11431 return wx.Size(width, height)
11432
11433 def RecalcSizes(self):
11434 # find the space allotted to this sizer
11435 pos = self.GetPosition()
11436 size = self.GetSize()
11437 for item in self.GetChildren():
11438 # Recalculate (if necessary) the position and size of
11439 # each item and then call item.SetDimension to do the
11440 # actual positioning and sizing of the items within the
11441 # space alloted to this sizer.
11442 ...
11443 item.SetDimension(itemPos, itemSize)
11444
11445
11446 When `Layout` is called it first calls `CalcMin` followed by
11447 `RecalcSizes` so you can optimize a bit by saving the results of
62d32a5f 11448 `CalcMin` and reusing them in `RecalcSizes`.
248ed943
RD		 11449
11450 :see: `wx.SizerItem`, `wx.Sizer.GetChildren`
11451
11452
11453 """
554f62e9
RD		 11454 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11455 __repr__ = _swig_repr
11456 def __init__(self, *args, **kwargs):
248ed943
RD		 11457 """
11458 __init__(self) -> PySizer
11459
11460 Creates a wx.PySizer. Must be called from the __init__ in the derived
11461 class.
11462 """
554f62e9 11463 _core_.PySizer_swiginit(self,_core_.new_PySizer(*args, **kwargs))
d55e5bfc
RD		 11464 self._setCallbackInfo(self, PySizer);self._setOORInfo(self)
11465
11466 def _setCallbackInfo(*args, **kwargs):
11467 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
11468 return _core_.PySizer__setCallbackInfo(*args, **kwargs)
11469
554f62e9
RD		 11470PySizer_swigregister = _core_.PySizer_swigregister
11471PySizer_swigregister(PySizer)
d55e5bfc
RD		 11472
11473#---------------------------------------------------------------------------
11474
11475class BoxSizer(Sizer):
248ed943
RD		 11476 """
11477 The basic idea behind a box sizer is that windows will most often be
11478 laid out in rather simple basic geometry, typically in a row or a
11479 column or nested hierarchies of either. A wx.BoxSizer will lay out
11480 its items in a simple row or column, depending on the orientation
11481 parameter passed to the constructor.
11482 """
554f62e9
RD		 11483 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11484 __repr__ = _swig_repr
11485 def __init__(self, *args, **kwargs):
248ed943
RD		 11486 """
11487 __init__(self, int orient=HORIZONTAL) -> BoxSizer
11488
11489 Constructor for a wx.BoxSizer. *orient* may be one of ``wx.VERTICAL``
11490 or ``wx.HORIZONTAL`` for creating either a column sizer or a row
11491 sizer.
11492 """
554f62e9 11493 _core_.BoxSizer_swiginit(self,_core_.new_BoxSizer(*args, **kwargs))
d55e5bfc
RD		 11494 self._setOORInfo(self)
11495
11496 def GetOrientation(*args, **kwargs):
248ed943
RD		 11497 """
11498 GetOrientation(self) -> int
11499
11500 Returns the current orientation of the sizer.
11501 """
d55e5bfc
RD		 11502 return _core_.BoxSizer_GetOrientation(*args, **kwargs)
11503
11504 def SetOrientation(*args, **kwargs):
248ed943
RD		 11505 """
11506 SetOrientation(self, int orient)
d55e5bfc 11507
248ed943
RD		 11508 Resets the orientation of the sizer.
11509 """
11510 return _core_.BoxSizer_SetOrientation(*args, **kwargs)
d55e5bfc 11511
554f62e9
RD		 11512BoxSizer_swigregister = _core_.BoxSizer_swigregister
11513BoxSizer_swigregister(BoxSizer)
d55e5bfc
RD		 11514
11515#---------------------------------------------------------------------------
11516
11517class StaticBoxSizer(BoxSizer):
248ed943
RD		 11518 """
11519 wx.StaticBoxSizer derives from and functions identically to the
11520 `wx.BoxSizer` and adds a `wx.StaticBox` around the items that the sizer
11521 manages. Note that this static box must be created separately and
11522 passed to the sizer constructor.
11523 """
554f62e9
RD		 11524 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11525 __repr__ = _swig_repr
11526 def __init__(self, *args, **kwargs):
248ed943
RD		 11527 """
11528 __init__(self, StaticBox box, int orient=HORIZONTAL) -> StaticBoxSizer
11529
11530 Constructor. It takes an associated static box and the orientation
11531 *orient* as parameters - orient can be either of ``wx.VERTICAL`` or
11532 ``wx.HORIZONTAL``.
11533 """
554f62e9 11534 _core_.StaticBoxSizer_swiginit(self,_core_.new_StaticBoxSizer(*args, **kwargs))
d55e5bfc
RD		 11535 self._setOORInfo(self)
11536
11537 def GetStaticBox(*args, **kwargs):
248ed943
RD		 11538 """
11539 GetStaticBox(self) -> StaticBox
d55e5bfc 11540
248ed943
RD		 11541 Returns the static box associated with this sizer.
11542 """
11543 return _core_.StaticBoxSizer_GetStaticBox(*args, **kwargs)
d55e5bfc 11544
554f62e9
RD		 11545StaticBoxSizer_swigregister = _core_.StaticBoxSizer_swigregister
11546StaticBoxSizer_swigregister(StaticBoxSizer)
d55e5bfc
RD		 11547
11548#---------------------------------------------------------------------------
11549
11550class GridSizer(Sizer):
248ed943
RD		 11551 """
11552 A grid sizer is a sizer which lays out its children in a
11553 two-dimensional table with all cells having the same size. In other
11554 words, the width of each cell within the grid is the width of the
11555 widest item added to the sizer and the height of each grid cell is the
11556 height of the tallest item. An optional vertical and/or horizontal
11557 gap between items can also be specified (in pixels.)
11558
11559 Items are placed in the cells of the grid in the order they are added,
11560 in row-major order. In other words, the first row is filled first,
11561 then the second, and so on until all items have been added. (If
11562 neccessary, additional rows will be added as items are added.) If you
11563 need to have greater control over the cells that items are placed in
11564 then use the `wx.GridBagSizer`.
11565
11566 """
554f62e9
RD		 11567 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11568 __repr__ = _swig_repr
11569 def __init__(self, *args, **kwargs):
248ed943
RD		 11570 """
11571 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> GridSizer
11572
11573 Constructor for a wx.GridSizer. *rows* and *cols* determine the number
11574 of columns and rows in the sizer - if either of the parameters is
11575 zero, it will be calculated to from the total number of children in
11576 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
11577 define extra space between all children.
11578 """
554f62e9 11579 _core_.GridSizer_swiginit(self,_core_.new_GridSizer(*args, **kwargs))
d55e5bfc
RD		 11580 self._setOORInfo(self)
11581
d55e5bfc 11582 def SetCols(*args, **kwargs):
248ed943
RD		 11583 """
11584 SetCols(self, int cols)
11585
11586 Sets the number of columns in the sizer.
11587 """
d55e5bfc
RD		 11588 return _core_.GridSizer_SetCols(*args, **kwargs)
11589
11590 def SetRows(*args, **kwargs):
248ed943
RD		 11591 """
11592 SetRows(self, int rows)
11593
11594 Sets the number of rows in the sizer.
11595 """
d55e5bfc
RD		 11596 return _core_.GridSizer_SetRows(*args, **kwargs)
11597
11598 def SetVGap(*args, **kwargs):
248ed943
RD		 11599 """
11600 SetVGap(self, int gap)
11601
11602 Sets the vertical gap (in pixels) between the cells in the sizer.
11603 """
d55e5bfc
RD		 11604 return _core_.GridSizer_SetVGap(*args, **kwargs)
11605
11606 def SetHGap(*args, **kwargs):
248ed943
RD		 11607 """
11608 SetHGap(self, int gap)
11609
11610 Sets the horizontal gap (in pixels) between cells in the sizer
11611 """
d55e5bfc
RD		 11612 return _core_.GridSizer_SetHGap(*args, **kwargs)
11613
11614 def GetCols(*args, **kwargs):
248ed943
RD		 11615 """
11616 GetCols(self) -> int
11617
11618 Returns the number of columns in the sizer.
11619 """
d55e5bfc
RD		 11620 return _core_.GridSizer_GetCols(*args, **kwargs)
11621
11622 def GetRows(*args, **kwargs):
248ed943
RD		 11623 """
11624 GetRows(self) -> int
11625
11626 Returns the number of rows in the sizer.
11627 """
d55e5bfc
RD		 11628 return _core_.GridSizer_GetRows(*args, **kwargs)
11629
11630 def GetVGap(*args, **kwargs):
248ed943
RD		 11631 """
11632 GetVGap(self) -> int
11633
11634 Returns the vertical gap (in pixels) between the cells in the sizer.
11635 """
d55e5bfc
RD		 11636 return _core_.GridSizer_GetVGap(*args, **kwargs)
11637
11638 def GetHGap(*args, **kwargs):
248ed943
RD		 11639 """
11640 GetHGap(self) -> int
11641
11642 Returns the horizontal gap (in pixels) between cells in the sizer.
11643 """
d55e5bfc
RD		 11644 return _core_.GridSizer_GetHGap(*args, **kwargs)
11645
554f62e9
RD		 11646 def CalcRowsCols(self):
11647 """
11648 CalcRowsCols() -> (rows, cols)
d55e5bfc 11649
554f62e9
RD		 11650 Calculates how many rows and columns will be in the sizer based
11651 on the current number of items and also the rows, cols specified
11652 in the constructor.
11653 """
11654 nitems = len(self.GetChildren())
11655 rows = self.GetRows()
11656 cols = self.GetCols()
11657 assert rows != 0 or cols != 0, "Grid sizer must have either rows or columns fixed"
11658 if cols != 0:
11659 rows = (nitems + cols - 1) / cols
11660 elif rows != 0:
11661 cols = (nitems + rows - 1) / rows
11662 return (rows, cols)
11663
11664GridSizer_swigregister = _core_.GridSizer_swigregister
11665GridSizer_swigregister(GridSizer)
d55e5bfc
RD		 11666
11667#---------------------------------------------------------------------------
11668
11669FLEX_GROWMODE_NONE = _core_.FLEX_GROWMODE_NONE
11670FLEX_GROWMODE_SPECIFIED = _core_.FLEX_GROWMODE_SPECIFIED
11671FLEX_GROWMODE_ALL = _core_.FLEX_GROWMODE_ALL
11672class FlexGridSizer(GridSizer):
248ed943
RD		 11673 """
11674 A flex grid sizer is a sizer which lays out its children in a
11675 two-dimensional table with all table cells in one row having the same
11676 height and all cells in one column having the same width, but all
11677 rows or all columns are not necessarily the same height or width as in
11678 the `wx.GridSizer`.
11679
11680 wx.FlexGridSizer can also size items equally in one direction but
11681 unequally ("flexibly") in the other. If the sizer is only flexible
11682 in one direction (this can be changed using `SetFlexibleDirection`), it
11683 needs to be decided how the sizer should grow in the other ("non
11684 flexible") direction in order to fill the available space. The
11685 `SetNonFlexibleGrowMode` method serves this purpose.
11686
11687
11688 """
554f62e9
RD		 11689 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11690 __repr__ = _swig_repr
11691 def __init__(self, *args, **kwargs):
248ed943
RD		 11692 """
11693 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> FlexGridSizer
11694
11695 Constructor for a wx.FlexGridSizer. *rows* and *cols* determine the
11696 number of columns and rows in the sizer - if either of the parameters
11697 is zero, it will be calculated to from the total number of children in
11698 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
11699 define extra space between all children.
11700 """
554f62e9 11701 _core_.FlexGridSizer_swiginit(self,_core_.new_FlexGridSizer(*args, **kwargs))
d55e5bfc
RD		 11702 self._setOORInfo(self)
11703
248ed943
RD		 11704 def AddGrowableRow(*args, **kwargs):
11705 """
11706 AddGrowableRow(self, size_t idx, int proportion=0)
d55e5bfc 11707
248ed943
RD		 11708 Specifies that row *idx* (starting from zero) should be grown if there
11709 is extra space available to the sizer.
d55e5bfc 11710
248ed943
RD		 11711 The *proportion* parameter has the same meaning as the stretch factor
11712 for the box sizers except that if all proportions are 0, then all
11713 columns are resized equally (instead of not being resized at all).
11714 """
d55e5bfc
RD		 11715 return _core_.FlexGridSizer_AddGrowableRow(*args, **kwargs)
11716
11717 def RemoveGrowableRow(*args, **kwargs):
248ed943
RD		 11718 """
11719 RemoveGrowableRow(self, size_t idx)
11720
11721 Specifies that row *idx* is no longer growable.
11722 """
d55e5bfc
RD		 11723 return _core_.FlexGridSizer_RemoveGrowableRow(*args, **kwargs)
11724
11725 def AddGrowableCol(*args, **kwargs):
248ed943
RD		 11726 """
11727 AddGrowableCol(self, size_t idx, int proportion=0)
11728
11729 Specifies that column *idx* (starting from zero) should be grown if
11730 there is extra space available to the sizer.
11731
11732 The *proportion* parameter has the same meaning as the stretch factor
11733 for the box sizers except that if all proportions are 0, then all
11734 columns are resized equally (instead of not being resized at all).
11735 """
d55e5bfc
RD		 11736 return _core_.FlexGridSizer_AddGrowableCol(*args, **kwargs)
11737
11738 def RemoveGrowableCol(*args, **kwargs):
248ed943
RD		 11739 """
11740 RemoveGrowableCol(self, size_t idx)
11741
11742 Specifies that column *idx* is no longer growable.
11743 """
d55e5bfc
RD		 11744 return _core_.FlexGridSizer_RemoveGrowableCol(*args, **kwargs)
11745
11746 def SetFlexibleDirection(*args, **kwargs):
248ed943
RD		 11747 """
11748 SetFlexibleDirection(self, int direction)
11749
11750 Specifies whether the sizer should flexibly resize its columns, rows,
11751 or both. Argument *direction* can be one of the following values. Any
11752 other value is ignored.
11753
11754 ============== =======================================
11755 wx.VERTICAL Rows are flexibly sized.
11756 wx.HORIZONTAL Columns are flexibly sized.
11757 wx.BOTH Both rows and columns are flexibly sized
11758 (this is the default value).
11759 ============== =======================================
11760
11761 Note that this method does not trigger relayout.
11762
11763 """
d55e5bfc
RD		 11764 return _core_.FlexGridSizer_SetFlexibleDirection(*args, **kwargs)
11765
11766 def GetFlexibleDirection(*args, **kwargs):
248ed943
RD		 11767 """
11768 GetFlexibleDirection(self) -> int
11769
11770 Returns a value that specifies whether the sizer
11771 flexibly resizes its columns, rows, or both (default).
11772
11773 :see: `SetFlexibleDirection`
11774 """
d55e5bfc
RD		 11775 return _core_.FlexGridSizer_GetFlexibleDirection(*args, **kwargs)
11776
11777 def SetNonFlexibleGrowMode(*args, **kwargs):
248ed943
RD		 11778 """
11779 SetNonFlexibleGrowMode(self, int mode)
11780
11781 Specifies how the sizer should grow in the non-flexible direction if
11782 there is one (so `SetFlexibleDirection` must have been called
11783 previously). Argument *mode* can be one of the following values:
11784
11785 ========================== =================================================
11786 wx.FLEX_GROWMODE_NONE Sizer doesn't grow in the non flexible direction.
11787 wx.FLEX_GROWMODE_SPECIFIED Sizer honors growable columns/rows set with
11788 `AddGrowableCol` and `AddGrowableRow`. In this
11789 case equal sizing applies to minimum sizes of
11790 columns or rows (this is the default value).
11791 wx.FLEX_GROWMODE_ALL Sizer equally stretches all columns or rows in
11792 the non flexible direction, whether they are
11793 growable or not in the flexbile direction.
11794 ========================== =================================================
11795
11796 Note that this method does not trigger relayout.
11797
11798
11799 """
d55e5bfc
RD		 11800 return _core_.FlexGridSizer_SetNonFlexibleGrowMode(*args, **kwargs)
11801
11802 def GetNonFlexibleGrowMode(*args, **kwargs):
248ed943
RD		 11803 """
11804 GetNonFlexibleGrowMode(self) -> int
11805
11806 Returns the value that specifies how the sizer grows in the
11807 non-flexible direction if there is one.
11808
11809 :see: `SetNonFlexibleGrowMode`
11810 """
d55e5bfc
RD		 11811 return _core_.FlexGridSizer_GetNonFlexibleGrowMode(*args, **kwargs)
11812
11813 def GetRowHeights(*args, **kwargs):
a8eff060
RD		 11814 """
11815 GetRowHeights(self) -> list
11816
11817 Returns a list of integers representing the heights of each of the
11818 rows in the sizer.
11819 """
d55e5bfc
RD		 11820 return _core_.FlexGridSizer_GetRowHeights(*args, **kwargs)
11821
11822 def GetColWidths(*args, **kwargs):
a8eff060
RD		 11823 """
11824 GetColWidths(self) -> list
11825
11826 Returns a list of integers representing the widths of each of the
11827 columns in the sizer.
11828 """
d55e5bfc
RD		 11829 return _core_.FlexGridSizer_GetColWidths(*args, **kwargs)
11830
554f62e9
RD		 11831FlexGridSizer_swigregister = _core_.FlexGridSizer_swigregister
11832FlexGridSizer_swigregister(FlexGridSizer)
d55e5bfc 11833
62d32a5f
RD		 11834class StdDialogButtonSizer(BoxSizer):
11835 """
11836 A special sizer that knows how to order and position standard buttons
11837 in order to conform to the current platform's standards. You simply
11838 need to add each `wx.Button` to the sizer, and be sure to create the
53aa7709 11839 buttons using the standard ID's. Then call `Realize` and the sizer
62d32a5f
RD		 11840 will take care of the rest.
11841
11842 """
554f62e9
RD		 11843 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11844 __repr__ = _swig_repr
11845 def __init__(self, *args, **kwargs):
62d32a5f 11846 """__init__(self) -> StdDialogButtonSizer"""
554f62e9 11847 _core_.StdDialogButtonSizer_swiginit(self,_core_.new_StdDialogButtonSizer(*args, **kwargs))
62d32a5f
RD		 11848 def AddButton(*args, **kwargs):
11849 """
11850 AddButton(self, wxButton button)
11851
11852 Use this to add the buttons to this sizer. Do not use the `Add`
11853 method in the base class.
11854 """
11855 return _core_.StdDialogButtonSizer_AddButton(*args, **kwargs)
11856
53aa7709 11857 def Realize(*args, **kwargs):
62d32a5f 11858 """
53aa7709 11859 Realize(self)
62d32a5f
RD		 11860
11861 This funciton needs to be called after all the buttons have been added
11862 to the sizer. It will reorder them and position them in a platform
11863 specifc manner.
11864 """
53aa7709 11865 return _core_.StdDialogButtonSizer_Realize(*args, **kwargs)
51b83b37
RD		 11866
11867 def SetAffirmativeButton(*args, **kwargs):
11868 """SetAffirmativeButton(self, wxButton button)"""
11869 return _core_.StdDialogButtonSizer_SetAffirmativeButton(*args, **kwargs)
11870
11871 def SetNegativeButton(*args, **kwargs):
11872 """SetNegativeButton(self, wxButton button)"""
11873 return _core_.StdDialogButtonSizer_SetNegativeButton(*args, **kwargs)
11874
11875 def SetCancelButton(*args, **kwargs):
11876 """SetCancelButton(self, wxButton button)"""
11877 return _core_.StdDialogButtonSizer_SetCancelButton(*args, **kwargs)
62d32a5f
RD		 11878
11879 def GetAffirmativeButton(*args, **kwargs):
11880 """GetAffirmativeButton(self) -> wxButton"""
11881 return _core_.StdDialogButtonSizer_GetAffirmativeButton(*args, **kwargs)
11882
11883 def GetApplyButton(*args, **kwargs):
11884 """GetApplyButton(self) -> wxButton"""
11885 return _core_.StdDialogButtonSizer_GetApplyButton(*args, **kwargs)
11886
11887 def GetNegativeButton(*args, **kwargs):
11888 """GetNegativeButton(self) -> wxButton"""
11889 return _core_.StdDialogButtonSizer_GetNegativeButton(*args, **kwargs)
11890
11891 def GetCancelButton(*args, **kwargs):
11892 """GetCancelButton(self) -> wxButton"""
11893 return _core_.StdDialogButtonSizer_GetCancelButton(*args, **kwargs)
11894
11895 def GetHelpButton(*args, **kwargs):
11896 """GetHelpButton(self) -> wxButton"""
11897 return _core_.StdDialogButtonSizer_GetHelpButton(*args, **kwargs)
11898
554f62e9
RD		 11899StdDialogButtonSizer_swigregister = _core_.StdDialogButtonSizer_swigregister
11900StdDialogButtonSizer_swigregister(StdDialogButtonSizer)
62d32a5f 11901
d55e5bfc
RD		 11902#---------------------------------------------------------------------------
11903
11904class GBPosition(object):
248ed943
RD		 11905 """
11906 This class represents the position of an item in a virtual grid of
11907 rows and columns managed by a `wx.GridBagSizer`. wxPython has
11908 typemaps that will automatically convert from a 2-element sequence of
11909 integers to a wx.GBPosition, so you can use the more pythonic
11910 representation of the position nearly transparently in Python code.
11911 """
554f62e9
RD		 11912 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11913 __repr__ = _swig_repr
11914 def __init__(self, *args, **kwargs):
248ed943
RD		 11915 """
11916 __init__(self, int row=0, int col=0) -> GBPosition
11917
11918 This class represents the position of an item in a virtual grid of
11919 rows and columns managed by a `wx.GridBagSizer`. wxPython has
11920 typemaps that will automatically convert from a 2-element sequence of
11921 integers to a wx.GBPosition, so you can use the more pythonic
11922 representation of the position nearly transparently in Python code.
11923 """
554f62e9
RD		 11924 _core_.GBPosition_swiginit(self,_core_.new_GBPosition(*args, **kwargs))
11925 __swig_destroy__ = _core_.delete_GBPosition
11926 __del__ = lambda self : None;
d55e5bfc
RD		 11927 def GetRow(*args, **kwargs):
11928 """GetRow(self) -> int"""
11929 return _core_.GBPosition_GetRow(*args, **kwargs)
11930
11931 def GetCol(*args, **kwargs):
11932 """GetCol(self) -> int"""
11933 return _core_.GBPosition_GetCol(*args, **kwargs)
11934
11935 def SetRow(*args, **kwargs):
11936 """SetRow(self, int row)"""
11937 return _core_.GBPosition_SetRow(*args, **kwargs)
11938
11939 def SetCol(*args, **kwargs):
11940 """SetCol(self, int col)"""
11941 return _core_.GBPosition_SetCol(*args, **kwargs)
11942
11943 def __eq__(*args, **kwargs):
11944 """__eq__(self, GBPosition other) -> bool"""
11945 return _core_.GBPosition___eq__(*args, **kwargs)
11946
11947 def __ne__(*args, **kwargs):
11948 """__ne__(self, GBPosition other) -> bool"""
11949 return _core_.GBPosition___ne__(*args, **kwargs)
11950
11951 def Set(*args, **kwargs):
11952 """Set(self, int row=0, int col=0)"""
11953 return _core_.GBPosition_Set(*args, **kwargs)
11954
11955 def Get(*args, **kwargs):
11956 """Get(self) -> PyObject"""
11957 return _core_.GBPosition_Get(*args, **kwargs)
11958
79fccf9d 11959 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD		 11960 def __str__(self): return str(self.Get())
11961 def __repr__(self): return 'wx.GBPosition'+str(self.Get())
11962 def __len__(self): return len(self.Get())
11963 def __getitem__(self, index): return self.Get()[index]
11964 def __setitem__(self, index, val):
11965 if index == 0: self.SetRow(val)
11966 elif index == 1: self.SetCol(val)
11967 else: raise IndexError
11968 def __nonzero__(self): return self.Get() != (0,0)
11969 __safe_for_unpickling__ = True
11970 def __reduce__(self): return (wx.GBPosition, self.Get())
11971
11972 row = property(GetRow, SetRow)
11973 col = property(GetCol, SetCol)
11974
554f62e9
RD		 11975GBPosition_swigregister = _core_.GBPosition_swigregister
11976GBPosition_swigregister(GBPosition)
d55e5bfc
RD		 11977
11978class GBSpan(object):
248ed943
RD		 11979 """
11980 This class is used to hold the row and column spanning attributes of
11981 items in a `wx.GridBagSizer`. wxPython has typemaps that will
11982 automatically convert from a 2-element sequence of integers to a
11983 wx.GBSpan, so you can use the more pythonic representation of the span
11984 nearly transparently in Python code.
11985
11986 """
554f62e9
RD		 11987 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11988 __repr__ = _swig_repr
11989 def __init__(self, *args, **kwargs):
248ed943
RD		 11990 """
11991 __init__(self, int rowspan=1, int colspan=1) -> GBSpan
11992
11993 Construct a new wxGBSpan, optionally setting the rowspan and
11994 colspan. The default is (1,1). (Meaning that the item occupies one
11995 cell in each direction.
11996 """
554f62e9
RD		 11997 _core_.GBSpan_swiginit(self,_core_.new_GBSpan(*args, **kwargs))
11998 __swig_destroy__ = _core_.delete_GBSpan
11999 __del__ = lambda self : None;
d55e5bfc
RD		 12000 def GetRowspan(*args, **kwargs):
12001 """GetRowspan(self) -> int"""
12002 return _core_.GBSpan_GetRowspan(*args, **kwargs)
12003
12004 def GetColspan(*args, **kwargs):
12005 """GetColspan(self) -> int"""
12006 return _core_.GBSpan_GetColspan(*args, **kwargs)
12007
12008 def SetRowspan(*args, **kwargs):
12009 """SetRowspan(self, int rowspan)"""
12010 return _core_.GBSpan_SetRowspan(*args, **kwargs)
12011
12012 def SetColspan(*args, **kwargs):
12013 """SetColspan(self, int colspan)"""
12014 return _core_.GBSpan_SetColspan(*args, **kwargs)
12015
12016 def __eq__(*args, **kwargs):
12017 """__eq__(self, GBSpan other) -> bool"""
12018 return _core_.GBSpan___eq__(*args, **kwargs)
12019
12020 def __ne__(*args, **kwargs):
12021 """__ne__(self, GBSpan other) -> bool"""
12022 return _core_.GBSpan___ne__(*args, **kwargs)
12023
12024 def Set(*args, **kwargs):
12025 """Set(self, int rowspan=1, int colspan=1)"""
12026 return _core_.GBSpan_Set(*args, **kwargs)
12027
12028 def Get(*args, **kwargs):
12029 """Get(self) -> PyObject"""
12030 return _core_.GBSpan_Get(*args, **kwargs)
12031
79fccf9d 12032 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD		 12033 def __str__(self): return str(self.Get())
12034 def __repr__(self): return 'wx.GBSpan'+str(self.Get())
12035 def __len__(self): return len(self.Get())
12036 def __getitem__(self, index): return self.Get()[index]
12037 def __setitem__(self, index, val):
12038 if index == 0: self.SetRowspan(val)
12039 elif index == 1: self.SetColspan(val)
12040 else: raise IndexError
12041 def __nonzero__(self): return self.Get() != (0,0)
12042 __safe_for_unpickling__ = True
12043 def __reduce__(self): return (wx.GBSpan, self.Get())
12044
12045 rowspan = property(GetRowspan, SetRowspan)
12046 colspan = property(GetColspan, SetColspan)
12047
554f62e9
RD		 12048GBSpan_swigregister = _core_.GBSpan_swigregister
12049GBSpan_swigregister(GBSpan)
d55e5bfc
RD		 12050
12051class GBSizerItem(SizerItem):
248ed943
RD		 12052 """
12053 The wx.GBSizerItem class is used to track the additional data about
12054 items in a `wx.GridBagSizer` such as the item's position in the grid
12055 and how many rows or columns it spans.
12056
12057 """
554f62e9
RD		 12058 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12059 __repr__ = _swig_repr
12060 def __init__(self, *args, **kwargs):
248ed943
RD		 12061 """
12062 __init__(self) -> GBSizerItem
12063
12064 Constructs an empty wx.GBSizerItem. Either a window, sizer or spacer
12065 size will need to be set, as well as a position and span before this
12066 item can be used in a Sizer.
12067
12068 You will probably never need to create a wx.GBSizerItem directly as they
12069 are created automatically when the sizer's Add method is called.
12070 """
554f62e9
RD		 12071 _core_.GBSizerItem_swiginit(self,_core_.new_GBSizerItem(*args, **kwargs))
12072 __swig_destroy__ = _core_.delete_GBSizerItem
12073 __del__ = lambda self : None;
d55e5bfc 12074 def GetPos(*args, **kwargs):
248ed943
RD		 12075 """
12076 GetPos(self) -> GBPosition
12077
12078 Get the grid position of the item
12079 """
d55e5bfc
RD		 12080 return _core_.GBSizerItem_GetPos(*args, **kwargs)
12081
12082 def GetPosTuple(self): return self.GetPos().Get()
12083 def GetSpan(*args, **kwargs):
248ed943
RD		 12084 """
12085 GetSpan(self) -> GBSpan
12086
12087 Get the row and column spanning of the item
12088 """
d55e5bfc
RD		 12089 return _core_.GBSizerItem_GetSpan(*args, **kwargs)
12090
12091 def GetSpanTuple(self): return self.GetSpan().Get()
12092 def SetPos(*args, **kwargs):
248ed943
RD		 12093 """
12094 SetPos(self, GBPosition pos) -> bool
12095
12096 If the item is already a member of a sizer then first ensure that
12097 there is no other item that would intersect with this one at the new
12098 position, then set the new position. Returns True if the change is
12099 successful and after the next Layout() the item will be moved.
12100 """
d55e5bfc
RD		 12101 return _core_.GBSizerItem_SetPos(*args, **kwargs)
12102
12103 def SetSpan(*args, **kwargs):
248ed943
RD		 12104 """
12105 SetSpan(self, GBSpan span) -> bool
12106
12107 If the item is already a member of a sizer then first ensure that
12108 there is no other item that would intersect with this one with its new
12109 spanning size, then set the new spanning. Returns True if the change
12110 is successful and after the next Layout() the item will be resized.
12111
12112 """
d55e5bfc
RD		 12113 return _core_.GBSizerItem_SetSpan(*args, **kwargs)
12114
248ed943 12115 def Intersects(*args, **kwargs):
d55e5bfc
RD		 12116 """
12117 Intersects(self, GBSizerItem other) -> bool
248ed943
RD		 12118
12119 Returns True if this item and the other item instersect.
d55e5bfc 12120 """
248ed943
RD		 12121 return _core_.GBSizerItem_Intersects(*args, **kwargs)
12122
12123 def IntersectsPos(*args, **kwargs):
12124 """
12125 IntersectsPos(self, GBPosition pos, GBSpan span) -> bool
12126
12127 Returns True if the given pos/span would intersect with this item.
12128 """
12129 return _core_.GBSizerItem_IntersectsPos(*args, **kwargs)
d55e5bfc
RD		 12130
12131 def GetEndPos(*args, **kwargs):
248ed943
RD		 12132 """
12133 GetEndPos(self) -> GBPosition
12134
12135 Get the row and column of the endpoint of this item.
12136 """
d55e5bfc
RD		 12137 return _core_.GBSizerItem_GetEndPos(*args, **kwargs)
12138
12139 def GetGBSizer(*args, **kwargs):
248ed943
RD		 12140 """
12141 GetGBSizer(self) -> GridBagSizer
12142
12143 Get the sizer this item is a member of.
12144 """
d55e5bfc
RD		 12145 return _core_.GBSizerItem_GetGBSizer(*args, **kwargs)
12146
12147 def SetGBSizer(*args, **kwargs):
248ed943
RD		 12148 """
12149 SetGBSizer(self, GridBagSizer sizer)
12150
12151 Set the sizer this item is a member of.
12152 """
d55e5bfc
RD		 12153 return _core_.GBSizerItem_SetGBSizer(*args, **kwargs)
12154
554f62e9
RD		 12155GBSizerItem_swigregister = _core_.GBSizerItem_swigregister
12156GBSizerItem_swigregister(GBSizerItem)
d55e5bfc
RD		 12157DefaultSpan = cvar.DefaultSpan
12158
12159def GBSizerItemWindow(*args, **kwargs):
12160 """
12161 GBSizerItemWindow(Window window, GBPosition pos, GBSpan span, int flag,
248ed943
RD		 12162 int border, PyObject userData=None) -> GBSizerItem
12163
12164 Construct a `wx.GBSizerItem` for a window.
d55e5bfc
RD		 12165 """
12166 val = _core_.new_GBSizerItemWindow(*args, **kwargs)
d55e5bfc
RD		 12167 return val
12168
12169def GBSizerItemSizer(*args, **kwargs):
12170 """
12171 GBSizerItemSizer(Sizer sizer, GBPosition pos, GBSpan span, int flag,
248ed943
RD		 12172 int border, PyObject userData=None) -> GBSizerItem
12173
12174 Construct a `wx.GBSizerItem` for a sizer
d55e5bfc
RD		 12175 """
12176 val = _core_.new_GBSizerItemSizer(*args, **kwargs)
d55e5bfc
RD		 12177 return val
12178
12179def GBSizerItemSpacer(*args, **kwargs):
12180 """
12181 GBSizerItemSpacer(int width, int height, GBPosition pos, GBSpan span,
248ed943
RD		 12182 int flag, int border, PyObject userData=None) -> GBSizerItem
12183
12184 Construct a `wx.GBSizerItem` for a spacer.
d55e5bfc
RD		 12185 """
12186 val = _core_.new_GBSizerItemSpacer(*args, **kwargs)
d55e5bfc
RD		 12187 return val
12188
12189class GridBagSizer(FlexGridSizer):
248ed943
RD		 12190 """
12191 A `wx.Sizer` that can lay out items in a virtual grid like a
12192 `wx.FlexGridSizer` but in this case explicit positioning of the items
12193 is allowed using `wx.GBPosition`, and items can optionally span more
12194 than one row and/or column using `wx.GBSpan`. The total size of the
12195 virtual grid is determined by the largest row and column that items are
12196 positioned at, adjusted for spanning.
12197
12198 """
554f62e9
RD		 12199 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12200 __repr__ = _swig_repr
12201 def __init__(self, *args, **kwargs):
248ed943
RD		 12202 """
12203 __init__(self, int vgap=0, int hgap=0) -> GridBagSizer
12204
12205 Constructor, with optional parameters to specify the gap between the
12206 rows and columns.
12207 """
554f62e9 12208 _core_.GridBagSizer_swiginit(self,_core_.new_GridBagSizer(*args, **kwargs))
c9c2cf70
RD		 12209 self._setOORInfo(self)
12210
d55e5bfc
RD		 12211 def Add(*args, **kwargs):
12212 """
248ed943 12213 Add(self, item, GBPosition pos, GBSpan span=DefaultSpan, int flag=0,
c1cb24a4 12214 int border=0, userData=None) -> wx.GBSizerItem
248ed943
RD		 12215
12216 Adds an item to the sizer at the grid cell *pos*, optionally spanning
12217 more than one row or column as specified with *span*. The remaining
12218 args behave similarly to `wx.Sizer.Add`.
12219
12220 Returns True if the item was successfully placed at the given cell
12221 position, False if something was already there.
12222
d55e5bfc
RD		 12223 """
12224 return _core_.GridBagSizer_Add(*args, **kwargs)
12225
12226 def AddItem(*args, **kwargs):
248ed943 12227 """
c1cb24a4 12228 Add(self, GBSizerItem item) -> wx.GBSizerItem
248ed943
RD		 12229
12230 Add an item to the sizer using a `wx.GBSizerItem`. Returns True if
12231 the item was successfully placed at its given cell position, False if
12232 something was already there.
12233 """
d55e5bfc
RD		 12234 return _core_.GridBagSizer_AddItem(*args, **kwargs)
12235
84f85550
RD		 12236 def GetCellSize(*args, **kwargs):
12237 """
12238 GetCellSize(self, int row, int col) -> Size
12239
12240 Get the size of the specified cell, including hgap and
12241 vgap. Only valid after a Layout.
12242 """
12243 return _core_.GridBagSizer_GetCellSize(*args, **kwargs)
12244
d55e5bfc 12245 def GetEmptyCellSize(*args, **kwargs):
248ed943
RD		 12246 """
12247 GetEmptyCellSize(self) -> Size
12248
12249 Get the size used for cells in the grid with no item.
12250 """
d55e5bfc
RD		 12251 return _core_.GridBagSizer_GetEmptyCellSize(*args, **kwargs)
12252
12253 def SetEmptyCellSize(*args, **kwargs):
248ed943
RD		 12254 """
12255 SetEmptyCellSize(self, Size sz)
12256
12257 Set the size used for cells in the grid with no item.
12258 """
d55e5bfc
RD		 12259 return _core_.GridBagSizer_SetEmptyCellSize(*args, **kwargs)
12260
12261 def GetItemPosition(*args):
12262 """
248ed943
RD		 12263 GetItemPosition(self, item) -> GBPosition
12264
12265 Get the grid position of the specified *item* where *item* is either a
12266 window or subsizer that is a member of this sizer, or a zero-based
12267 index of an item.
d55e5bfc
RD		 12268 """
12269 return _core_.GridBagSizer_GetItemPosition(*args)
12270
12271 def SetItemPosition(*args):
12272 """
248ed943
RD		 12273 SetItemPosition(self, item, GBPosition pos) -> bool
12274
12275 Set the grid position of the specified *item* where *item* is either a
12276 window or subsizer that is a member of this sizer, or a zero-based
12277 index of an item. Returns True on success. If the move is not
12278 allowed (because an item is already there) then False is returned.
12279
d55e5bfc
RD		 12280 """
12281 return _core_.GridBagSizer_SetItemPosition(*args)
12282
12283 def GetItemSpan(*args):
12284 """
248ed943
RD		 12285 GetItemSpan(self, item) -> GBSpan
12286
12287 Get the row/col spanning of the specified *item* where *item* is
12288 either a window or subsizer that is a member of this sizer, or a
12289 zero-based index of an item.
d55e5bfc
RD		 12290 """
12291 return _core_.GridBagSizer_GetItemSpan(*args)
12292
12293 def SetItemSpan(*args):
12294 """
248ed943
RD		 12295 SetItemSpan(self, item, GBSpan span) -> bool
12296
12297 Set the row/col spanning of the specified *item* where *item* is
12298 either a window or subsizer that is a member of this sizer, or a
12299 zero-based index of an item. Returns True on success. If the move is
12300 not allowed (because an item is already there) then False is returned.
d55e5bfc
RD		 12301 """
12302 return _core_.GridBagSizer_SetItemSpan(*args)
12303
12304 def FindItem(*args):
12305 """
248ed943
RD		 12306 FindItem(self, item) -> GBSizerItem
12307
12308 Find the sizer item for the given window or subsizer, returns None if
12309 not found. (non-recursive)
d55e5bfc
RD		 12310 """
12311 return _core_.GridBagSizer_FindItem(*args)
12312
12313 def FindItemAtPosition(*args, **kwargs):
248ed943
RD		 12314 """
12315 FindItemAtPosition(self, GBPosition pos) -> GBSizerItem
12316
12317 Return the sizer item for the given grid cell, or None if there is no
12318 item at that position. (non-recursive)
12319 """
d55e5bfc
RD		 12320 return _core_.GridBagSizer_FindItemAtPosition(*args, **kwargs)
12321
12322 def FindItemAtPoint(*args, **kwargs):
248ed943
RD		 12323 """
12324 FindItemAtPoint(self, Point pt) -> GBSizerItem
12325
12326 Return the sizer item located at the point given in *pt*, or None if
12327 there is no item at that point. The (x,y) coordinates in pt correspond
12328 to the client coordinates of the window using the sizer for
12329 layout. (non-recursive)
12330 """
d55e5bfc
RD		 12331 return _core_.GridBagSizer_FindItemAtPoint(*args, **kwargs)
12332
248ed943
RD		 12333 def CheckForIntersection(*args, **kwargs):
12334 """
12335 CheckForIntersection(self, GBSizerItem item, GBSizerItem excludeItem=None) -> bool
d55e5bfc 12336
248ed943
RD		 12337 Look at all items and see if any intersect (or would overlap) the
12338 given *item*. Returns True if so, False if there would be no overlap.
12339 If an *excludeItem* is given then it will not be checked for
12340 intersection, for example it may be the item we are checking the
12341 position of.
d55e5bfc 12342
248ed943
RD		 12343 """
12344 return _core_.GridBagSizer_CheckForIntersection(*args, **kwargs)
d55e5bfc 12345
248ed943 12346 def CheckForIntersectionPos(*args, **kwargs):
d55e5bfc 12347 """
248ed943
RD		 12348 CheckForIntersectionPos(self, GBPosition pos, GBSpan span, GBSizerItem excludeItem=None) -> bool
12349
12350 Look at all items and see if any intersect (or would overlap) the
12351 given position and span. Returns True if so, False if there would be
12352 no overlap. If an *excludeItem* is given then it will not be checked
12353 for intersection, for example it may be the item we are checking the
12354 position of.
d55e5bfc 12355 """
248ed943 12356 return _core_.GridBagSizer_CheckForIntersectionPos(*args, **kwargs)
d55e5bfc 12357
554f62e9
RD		 12358GridBagSizer_swigregister = _core_.GridBagSizer_swigregister
12359GridBagSizer_swigregister(GridBagSizer)
d55e5bfc
RD		 12360
12361#---------------------------------------------------------------------------
12362
12363Left = _core_.Left
12364Top = _core_.Top
12365Right = _core_.Right
12366Bottom = _core_.Bottom
12367Width = _core_.Width
12368Height = _core_.Height
12369Centre = _core_.Centre
12370Center = _core_.Center
12371CentreX = _core_.CentreX
12372CentreY = _core_.CentreY
12373Unconstrained = _core_.Unconstrained
12374AsIs = _core_.AsIs
12375PercentOf = _core_.PercentOf
12376Above = _core_.Above
12377Below = _core_.Below
12378LeftOf = _core_.LeftOf
12379RightOf = _core_.RightOf
12380SameAs = _core_.SameAs
12381Absolute = _core_.Absolute
12382class IndividualLayoutConstraint(Object):
12383 """
79fccf9d
RD		 12384 Objects of this class are stored in the `wx.LayoutConstraints` class as
12385 one of eight possible constraints that a window can be involved in.
12386 You will never need to create an instance of
12387 wx.IndividualLayoutConstraint, rather you should create a
12388 `wx.LayoutConstraints` instance and use the individual contstraints
d55e5bfc 12389 that it contains.
d55e5bfc 12390 """
554f62e9
RD		 12391 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12392 def __init__(self): raise AttributeError, "No constructor defined"
12393 __repr__ = _swig_repr
d55e5bfc 12394 def Set(*args, **kwargs):
79fccf9d
RD		 12395 """
12396 Set(self, int rel, Window otherW, int otherE, int val=0, int marg=wxLAYOUT_DEFAULT_MARGIN)
12397
12398 Sets the properties of the constraint. Normally called by one of the
12399 convenience functions such as Above, RightOf, SameAs.
12400 """
d55e5bfc
RD		 12401 return _core_.IndividualLayoutConstraint_Set(*args, **kwargs)
12402
12403 def LeftOf(*args, **kwargs):
12404 """
12405 LeftOf(self, Window sibling, int marg=0)
12406
79fccf9d
RD		 12407 Constrains this edge to be to the left of the given window, with an
12408 optional margin. Implicitly, this is relative to the left edge of the
12409 other window.
d55e5bfc
RD		 12410 """
12411 return _core_.IndividualLayoutConstraint_LeftOf(*args, **kwargs)
12412
12413 def RightOf(*args, **kwargs):
12414 """
12415 RightOf(self, Window sibling, int marg=0)
12416
79fccf9d
RD		 12417 Constrains this edge to be to the right of the given window, with an
12418 optional margin. Implicitly, this is relative to the right edge of the
12419 other window.
d55e5bfc
RD		 12420 """
12421 return _core_.IndividualLayoutConstraint_RightOf(*args, **kwargs)
12422
12423 def Above(*args, **kwargs):
12424 """
12425 Above(self, Window sibling, int marg=0)
12426
79fccf9d
RD		 12427 Constrains this edge to be above the given window, with an optional
12428 margin. Implicitly, this is relative to the top edge of the other
12429 window.
d55e5bfc
RD		 12430 """
12431 return _core_.IndividualLayoutConstraint_Above(*args, **kwargs)
12432
12433 def Below(*args, **kwargs):
12434 """
12435 Below(self, Window sibling, int marg=0)
12436
79fccf9d
RD		 12437 Constrains this edge to be below the given window, with an optional
12438 margin. Implicitly, this is relative to the bottom edge of the other
12439 window.
d55e5bfc
RD		 12440 """
12441 return _core_.IndividualLayoutConstraint_Below(*args, **kwargs)
12442
12443 def SameAs(*args, **kwargs):
12444 """
12445 SameAs(self, Window otherW, int edge, int marg=0)
12446
79fccf9d
RD		 12447 Constrains this edge or dimension to be to the same as the edge of the
12448 given window, with an optional margin.
d55e5bfc
RD		 12449 """
12450 return _core_.IndividualLayoutConstraint_SameAs(*args, **kwargs)
12451
12452 def PercentOf(*args, **kwargs):
12453 """
12454 PercentOf(self, Window otherW, int wh, int per)
12455
79fccf9d
RD		 12456 Constrains this edge or dimension to be to a percentage of the given
12457 window, with an optional margin.
d55e5bfc
RD		 12458 """
12459 return _core_.IndividualLayoutConstraint_PercentOf(*args, **kwargs)
12460
12461 def Absolute(*args, **kwargs):
12462 """
12463 Absolute(self, int val)
12464
79fccf9d 12465 Constrains this edge or dimension to be the given absolute value.
d55e5bfc
RD		 12466 """
12467 return _core_.IndividualLayoutConstraint_Absolute(*args, **kwargs)
12468
12469 def Unconstrained(*args, **kwargs):
12470 """
12471 Unconstrained(self)
12472
79fccf9d
RD		 12473 Sets this edge or dimension to be unconstrained, that is, dependent on
12474 other edges and dimensions from which this value can be deduced.
d55e5bfc
RD		 12475 """
12476 return _core_.IndividualLayoutConstraint_Unconstrained(*args, **kwargs)
12477
12478 def AsIs(*args, **kwargs):
12479 """
12480 AsIs(self)
12481
79fccf9d
RD		 12482 Sets this edge or constraint to be whatever the window's value is at
12483 the moment. If either of the width and height constraints are *as is*,
12484 the window will not be resized, but moved instead. This is important
12485 when considering panel items which are intended to have a default
12486 size, such as a button, which may take its size from the size of the
12487 button label.
d55e5bfc
RD		 12488 """
12489 return _core_.IndividualLayoutConstraint_AsIs(*args, **kwargs)
12490
12491 def GetOtherWindow(*args, **kwargs):
12492 """GetOtherWindow(self) -> Window"""
12493 return _core_.IndividualLayoutConstraint_GetOtherWindow(*args, **kwargs)
12494
12495 def GetMyEdge(*args, **kwargs):
12496 """GetMyEdge(self) -> int"""
12497 return _core_.IndividualLayoutConstraint_GetMyEdge(*args, **kwargs)
12498
12499 def SetEdge(*args, **kwargs):
12500 """SetEdge(self, int which)"""
12501 return _core_.IndividualLayoutConstraint_SetEdge(*args, **kwargs)
12502
12503 def SetValue(*args, **kwargs):
12504 """SetValue(self, int v)"""
12505 return _core_.IndividualLayoutConstraint_SetValue(*args, **kwargs)
12506
12507 def GetMargin(*args, **kwargs):
12508 """GetMargin(self) -> int"""
12509 return _core_.IndividualLayoutConstraint_GetMargin(*args, **kwargs)
12510
12511 def SetMargin(*args, **kwargs):
12512 """SetMargin(self, int m)"""
12513 return _core_.IndividualLayoutConstraint_SetMargin(*args, **kwargs)
12514
12515 def GetValue(*args, **kwargs):
12516 """GetValue(self) -> int"""
12517 return _core_.IndividualLayoutConstraint_GetValue(*args, **kwargs)
12518
12519 def GetPercent(*args, **kwargs):
12520 """GetPercent(self) -> int"""
12521 return _core_.IndividualLayoutConstraint_GetPercent(*args, **kwargs)
12522
12523 def GetOtherEdge(*args, **kwargs):
12524 """GetOtherEdge(self) -> int"""
12525 return _core_.IndividualLayoutConstraint_GetOtherEdge(*args, **kwargs)
12526
12527 def GetDone(*args, **kwargs):
12528 """GetDone(self) -> bool"""
12529 return _core_.IndividualLayoutConstraint_GetDone(*args, **kwargs)
12530
12531 def SetDone(*args, **kwargs):
12532 """SetDone(self, bool d)"""
12533 return _core_.IndividualLayoutConstraint_SetDone(*args, **kwargs)
12534
12535 def GetRelationship(*args, **kwargs):
12536 """GetRelationship(self) -> int"""
12537 return _core_.IndividualLayoutConstraint_GetRelationship(*args, **kwargs)
12538
12539 def SetRelationship(*args, **kwargs):
12540 """SetRelationship(self, int r)"""
12541 return _core_.IndividualLayoutConstraint_SetRelationship(*args, **kwargs)
12542
12543 def ResetIfWin(*args, **kwargs):
12544 """
12545 ResetIfWin(self, Window otherW) -> bool
12546
12547 Reset constraint if it mentions otherWin
12548 """
12549 return _core_.IndividualLayoutConstraint_ResetIfWin(*args, **kwargs)
12550
12551 def SatisfyConstraint(*args, **kwargs):
12552 """
12553 SatisfyConstraint(self, LayoutConstraints constraints, Window win) -> bool
12554
12555 Try to satisfy constraint
12556 """
12557 return _core_.IndividualLayoutConstraint_SatisfyConstraint(*args, **kwargs)
12558
12559 def GetEdge(*args, **kwargs):
12560 """
12561 GetEdge(self, int which, Window thisWin, Window other) -> int
12562
12563 Get the value of this edge or dimension, or if this
12564 is not determinable, -1.
12565 """
12566 return _core_.IndividualLayoutConstraint_GetEdge(*args, **kwargs)
12567
554f62e9
RD		 12568IndividualLayoutConstraint_swigregister = _core_.IndividualLayoutConstraint_swigregister
12569IndividualLayoutConstraint_swigregister(IndividualLayoutConstraint)
d55e5bfc
RD		 12570
12571class LayoutConstraints(Object):
12572 """
79fccf9d
RD		 12573 **Note:** constraints are now deprecated and you should use sizers
12574 instead.
d55e5bfc 12575
79fccf9d
RD		 12576 Objects of this class can be associated with a window to define its
12577 layout constraints, with respect to siblings or its parent.
d55e5bfc
RD		 12578
12579 The class consists of the following eight constraints of class
12580 wx.IndividualLayoutConstraint, some or all of which should be accessed
12581 directly to set the appropriate constraints.
12582
12583 * left: represents the left hand edge of the window
12584 * right: represents the right hand edge of the window
12585 * top: represents the top edge of the window
12586 * bottom: represents the bottom edge of the window
12587 * width: represents the width of the window
12588 * height: represents the height of the window
12589 * centreX: represents the horizontal centre point of the window
12590 * centreY: represents the vertical centre point of the window
12591
79fccf9d
RD		 12592 Most constraints are initially set to have the relationship
12593 wxUnconstrained, which means that their values should be calculated by
12594 looking at known constraints. The exceptions are width and height,
12595 which are set to wxAsIs to ensure that if the user does not specify a
12596 constraint, the existing width and height will be used, to be
12597 compatible with panel items which often have take a default size. If
12598 the constraint is ``wx.AsIs``, the dimension will not be changed.
12599
12600 :see: `wx.IndividualLayoutConstraint`, `wx.Window.SetConstraints`
d55e5bfc
RD		 12601
12602 """
554f62e9
RD		 12603 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12604 __repr__ = _swig_repr
d55e5bfc
RD		 12605 left = property(_core_.LayoutConstraints_left_get)
12606 top = property(_core_.LayoutConstraints_top_get)
12607 right = property(_core_.LayoutConstraints_right_get)
12608 bottom = property(_core_.LayoutConstraints_bottom_get)
12609 width = property(_core_.LayoutConstraints_width_get)
12610 height = property(_core_.LayoutConstraints_height_get)
12611 centreX = property(_core_.LayoutConstraints_centreX_get)
12612 centreY = property(_core_.LayoutConstraints_centreY_get)
554f62e9 12613 def __init__(self, *args, **kwargs):
d55e5bfc 12614 """__init__(self) -> LayoutConstraints"""
554f62e9
RD		 12615 _core_.LayoutConstraints_swiginit(self,_core_.new_LayoutConstraints(*args, **kwargs))
12616 __swig_destroy__ = _core_.delete_LayoutConstraints
12617 __del__ = lambda self : None;
d55e5bfc
RD		 12618 def SatisfyConstraints(*args, **kwargs):
12619 """SatisfyConstraints(Window win) -> (areSatisfied, noChanges)"""
12620 return _core_.LayoutConstraints_SatisfyConstraints(*args, **kwargs)
12621
12622 def AreSatisfied(*args, **kwargs):
12623 """AreSatisfied(self) -> bool"""
12624 return _core_.LayoutConstraints_AreSatisfied(*args, **kwargs)
12625
554f62e9
RD		 12626LayoutConstraints_swigregister = _core_.LayoutConstraints_swigregister
12627LayoutConstraints_swigregister(LayoutConstraints)
d55e5bfc
RD		 12628
12629#----------------------------------------------------------------------------
12630
12631# Use Python's bool constants if available, make some if not
12632try:
12633 True
12634except NameError:
12635 __builtins__.True = 1==1
12636 __builtins__.False = 1==0
12637 def bool(value): return not not value
12638 __builtins__.bool = bool
12639
12640
12641
12642# workarounds for bad wxRTTI names
12643__wxPyPtrTypeMap['wxGauge95'] = 'wxGauge'
12644__wxPyPtrTypeMap['wxSlider95'] = 'wxSlider'
12645__wxPyPtrTypeMap['wxStatusBar95'] = 'wxStatusBar'
12646
12647
12648#----------------------------------------------------------------------------
12649# Load version numbers from __version__... Ensure that major and minor
0f63ec68 12650# versions are the same for both wxPython and wxWidgets.
d55e5bfc
RD		 12651
12652from __version__ import *
12653__version__ = VERSION_STRING
12654
0f63ec68
RD		 12655assert MAJOR_VERSION == _core_.MAJOR_VERSION, "wxPython/wxWidgets version mismatch"
12656assert MINOR_VERSION == _core_.MINOR_VERSION, "wxPython/wxWidgets version mismatch"
d55e5bfc
RD		 12657if RELEASE_VERSION != _core_.RELEASE_VERSION:
12658 import warnings
0f63ec68 12659 warnings.warn("wxPython/wxWidgets release number mismatch")
d55e5bfc
RD		 12660
12661#----------------------------------------------------------------------------
12662
70b7a5fe
RD		 12663# Set wxPython's default string<-->unicode conversion encoding from
12664# the locale, but only if Python's default hasn't been changed. (We
12665# assume that if the user has customized it already then that is the
12666# encoding we need to use as well.)
12667#
12668# The encoding selected here is used when string or unicode objects
12669# need to be converted in order to pass them to wxWidgets. Please be
12670# aware that the default encoding within the same locale may be
12671# slightly different on different platforms. For example, please see
62d32a5f
RD		 12672# http://www.alanwood.net/demos/charsetdiffs.html for differences
12673# between the common latin/roman encodings.
396fb509
RD		 12674
12675default = _sys.getdefaultencoding()
12676if default == 'ascii':
12677 import locale
12678 import codecs
12679 try:
12680 default = locale.getdefaultlocale()[1]
12681 codecs.lookup(default)
70b7a5fe 12682 except (ValueError, LookupError, TypeError):
396fb509
RD		 12683 default = _sys.getdefaultencoding()
12684 del locale
12685 del codecs
5cbf236d
RD		 12686if default:
12687 wx.SetDefaultPyEncoding(default)
12688del default
5cbf236d
RD		 12689
12690#----------------------------------------------------------------------------
12691
d55e5bfc
RD		 12692class PyDeadObjectError(AttributeError):
12693 pass
12694
12695class _wxPyDeadObject(object):
12696 """
12697 Instances of wx objects that are OOR capable will have their __class__
12698 changed to this class when the C++ object is deleted. This should help
12699 prevent crashes due to referencing a bogus C++ pointer.
12700 """
12701 reprStr = "wxPython wrapper for DELETED %s object! (The C++ object no longer exists.)"
12702 attrStr = "The C++ part of the %s object has been deleted, attribute access no longer allowed."
12703
12704 def __repr__(self):
12705 if not hasattr(self, "_name"):
12706 self._name = "[unknown]"
12707 return self.reprStr % self._name
12708
12709 def __getattr__(self, *args):
12710 if not hasattr(self, "_name"):
12711 self._name = "[unknown]"
12712 raise PyDeadObjectError(self.attrStr % self._name)
12713
12714 def __nonzero__(self):
12715 return 0
12716
12717
12718
12719class PyUnbornObjectError(AttributeError):
12720 pass
12721
12722class _wxPyUnbornObject(object):
12723 """
12724 Some stock objects are created when the wx._core module is
12725 imported, but their C++ instance is not created until the wx.App
12726 object is created and initialized. These object instances will
12727 temporarily have their __class__ changed to this class so an
12728 exception will be raised if they are used before the C++ instance
12729 is ready.
12730 """
12731
12732 reprStr = "wxPython wrapper for UNBORN object! (The C++ object is not initialized yet.)"
12733 attrStr = "The C++ part of this object has not been initialized, attribute access not allowed."
12734
12735 def __repr__(self):
12736 #if not hasattr(self, "_name"):
12737 # self._name = "[unknown]"
12738 return self.reprStr #% self._name
12739
12740 def __getattr__(self, *args):
12741 #if not hasattr(self, "_name"):
12742 # self._name = "[unknown]"
12743 raise PyUnbornObjectError(self.attrStr) # % self._name )
12744
12745 def __nonzero__(self):
12746 return 0
12747
12748
12749#----------------------------------------------------------------------------
d55e5bfc
RD		 12750
12751def CallAfter(callable, *args, **kw):
12752 """
12753 Call the specified function after the current and pending event
12754 handlers have been completed. This is also good for making GUI
0439c23b
RD		 12755 method calls from non-GUI threads. Any extra positional or
12756 keyword args are passed on to the callable when it is called.
12757
12758 :see: `wx.FutureCall`
d55e5bfc
RD		 12759 """
12760 app = wx.GetApp()
a001823c 12761 assert app is not None, 'No wx.App created yet'
d55e5bfc 12762
891bb194
RD		 12763 if not hasattr(app, "_CallAfterId"):
12764 app._CallAfterId = wx.NewEventType()
12765 app.Connect(-1, -1, app._CallAfterId,
12766 lambda event: event.callable(*event.args, **event.kw) )
d55e5bfc 12767 evt = wx.PyEvent()
891bb194 12768 evt.SetEventType(app._CallAfterId)
d55e5bfc
RD		 12769 evt.callable = callable
12770 evt.args = args
12771 evt.kw = kw
12772 wx.PostEvent(app, evt)
12773
d55e5bfc
RD		 12774#----------------------------------------------------------------------------
12775
12776
12777class FutureCall:
12778 """
8ac8dba0 12779 A convenience class for `wx.Timer`, that calls the given callable
d55e5bfc
RD		 12780 object once after the given amount of milliseconds, passing any
12781 positional or keyword args. The return value of the callable is
0439c23b 12782 availbale after it has been run with the `GetResult` method.
d55e5bfc
RD		 12783
12784 If you don't need to get the return value or restart the timer
12785 then there is no need to hold a reference to this object. It will
12786 hold a reference to itself while the timer is running (the timer
12787 has a reference to self.Notify) but the cycle will be broken when
12788 the timer completes, automatically cleaning up the wx.FutureCall
12789 object.
0439c23b
RD		 12790
12791 :see: `wx.CallAfter`
d55e5bfc
RD		 12792 """
12793 def __init__(self, millis, callable, *args, **kwargs):
12794 self.millis = millis
12795 self.callable = callable
12796 self.SetArgs(*args, **kwargs)
12797 self.runCount = 0
12798 self.running = False
12799 self.hasRun = False
12800 self.result = None
12801 self.timer = None
12802 self.Start()
12803
12804 def __del__(self):
12805 self.Stop()
12806
12807
12808 def Start(self, millis=None, *args, **kwargs):
12809 """
12810 (Re)start the timer
12811 """
12812 self.hasRun = False
12813 if millis is not None:
12814 self.millis = millis
12815 if args or kwargs:
12816 self.SetArgs(*args, **kwargs)
12817 self.Stop()
12818 self.timer = wx.PyTimer(self.Notify)
12819 self.timer.Start(self.millis, wx.TIMER_ONE_SHOT)
12820 self.running = True
12821 Restart = Start
12822
12823
12824 def Stop(self):
12825 """
12826 Stop and destroy the timer.
12827 """
12828 if self.timer is not None:
12829 self.timer.Stop()
12830 self.timer = None
12831
12832
12833 def GetInterval(self):
12834 if self.timer is not None:
12835 return self.timer.GetInterval()
12836 else:
12837 return 0
12838
12839
12840 def IsRunning(self):
12841 return self.timer is not None and self.timer.IsRunning()
12842
12843
12844 def SetArgs(self, *args, **kwargs):
12845 """
12846 (Re)set the args passed to the callable object. This is
12847 useful in conjunction with Restart if you want to schedule a
12848 new call to the same callable object but with different
12849 parameters.
12850 """
12851 self.args = args
12852 self.kwargs = kwargs
12853
12854
12855 def HasRun(self):
12856 return self.hasRun
12857
12858 def GetResult(self):
12859 return self.result
12860
12861 def Notify(self):
12862 """
12863 The timer has expired so call the callable.
12864 """
12865 if self.callable and getattr(self.callable, 'im_self', True):
12866 self.runCount += 1
12867 self.running = False
12868 self.result = self.callable(*self.args, **self.kwargs)
12869 self.hasRun = True
12870 if not self.running:
12871 # if it wasn't restarted, then cleanup
12872 wx.CallAfter(self.Stop)
12873
12874
12875
12876#----------------------------------------------------------------------------
12877# Control which items in this module should be documented by epydoc.
12878# We allow only classes and functions, which will help reduce the size
12879# of the docs by filtering out the zillions of constants, EVT objects,
12880# and etc that don't make much sense by themselves, but are instead
12881# documented (or will be) as part of the classes/functions/methods
12882# where they should be used.
12883
c24da6d6
RD		 12884class __DocFilter:
12885 """
12886 A filter for epydoc that only allows non-Ptr classes and
12887 fucntions, in order to reduce the clutter in the API docs.
12888 """
12889 def __init__(self, globals):
12890 self._globals = globals
12891
12892 def __call__(self, name):
12893 import types
12894 obj = self._globals.get(name, None)
12895 if type(obj) not in [type, types.ClassType, types.FunctionType, types.BuiltinFunctionType]:
12896 return False
554f62e9 12897 if name.startswith('_') or name.startswith('EVT') or name.endswith('_swigregister') or name.endswith('Ptr') :
c24da6d6
RD		 12898 return False
12899 return True
d55e5bfc
RD		 12900
12901#----------------------------------------------------------------------------
12902#----------------------------------------------------------------------------
12903
12904# Import other modules in this package that should show up in the
12905# "core" wx namespace
12906from _gdi import *
12907from _windows import *
12908from _controls import *
12909from _misc import *
12910
12911
12912# Fixup the stock objects since they can't be used yet. (They will be
12913# restored in wx.PyApp.OnInit.)
12914_core_._wxPyFixStockObjects()
12915
12916#----------------------------------------------------------------------------
12917#----------------------------------------------------------------------------
12918
12919
7449af73 12920
wxWidgets (Impactor)