]> git.saurik.com Git - wxWidgets.git/blame - wxPython/src/gtk/_core.py
IsTransparent and etc.
[wxWidgets.git] / wxPython / src / gtk / _core.py
CommitLineData
d14a1e28
RD
1# This file was created automatically by SWIG.
2# Don't modify this file, modify the SWIG interface instead.
3
54f9ee45 4import _core_
d14a1e28 5
093d3ff1
RD
6def _swig_setattr_nondynamic(self,class_type,name,value,static=1):
7 if (name == "this"):
8 if isinstance(value, class_type):
9 self.__dict__[name] = value.this
10 if hasattr(value,"thisown"): self.__dict__["thisown"] = value.thisown
11 del value.thisown
12 return
13 method = class_type.__swig_setmethods__.get(name,None)
14 if method: return method(self,value)
15 if (not static) or hasattr(self,name) or (name == "thisown"):
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):
24 method = class_type.__swig_getmethods__.get(name,None)
25 if method: return method(self)
26 raise AttributeError,name
27
28import types
29try:
30 _object = types.ObjectType
31 _newclass = 1
32except AttributeError:
33 class _object : pass
34 _newclass = 0
35del types
36
37
38def _swig_setattr_nondynamic_method(set):
39 def set_attr(self,name,value):
40 if hasattr(self,name) or (name in ("this", "thisown")):
41 set(self,name,value)
42 else:
43 raise AttributeError("You cannot add attributes to %s" % self)
44 return set_attr
45
46
d14a1e28
RD
47#// Give a reference to the dictionary of this module to the C++ extension
48#// code.
54f9ee45 49_core_._wxPySetDictionary(vars())
d14a1e28
RD
50
51#// A little trick to make 'wx' be a reference to this module so wx.Names can
52#// be used here.
53import sys as _sys
54wx = _sys.modules[__name__]
55
66c033b4
RD
56
57#----------------------------------------------------------------------------
58
59def _deprecated(callable, msg=None):
60 """
61 Create a wrapper function that will raise a DeprecationWarning
62 before calling the callable.
63 """
64 if msg is None:
65 msg = "%s is deprecated" % callable
66 def deprecatedWrapper(*args, **kwargs):
67 import warnings
68 warnings.warn(msg, DeprecationWarning, stacklevel=2)
69 return callable(*args, **kwargs)
70 deprecatedWrapper.__doc__ = msg
71 return deprecatedWrapper
72
73
74#----------------------------------------------------------------------------
75
54f9ee45
RD
76NOT_FOUND = _core_.NOT_FOUND
77VSCROLL = _core_.VSCROLL
78HSCROLL = _core_.HSCROLL
79CAPTION = _core_.CAPTION
80DOUBLE_BORDER = _core_.DOUBLE_BORDER
81SUNKEN_BORDER = _core_.SUNKEN_BORDER
82RAISED_BORDER = _core_.RAISED_BORDER
83BORDER = _core_.BORDER
84SIMPLE_BORDER = _core_.SIMPLE_BORDER
85STATIC_BORDER = _core_.STATIC_BORDER
86TRANSPARENT_WINDOW = _core_.TRANSPARENT_WINDOW
87NO_BORDER = _core_.NO_BORDER
88TAB_TRAVERSAL = _core_.TAB_TRAVERSAL
89WANTS_CHARS = _core_.WANTS_CHARS
90POPUP_WINDOW = _core_.POPUP_WINDOW
91CENTER_FRAME = _core_.CENTER_FRAME
92CENTRE_ON_SCREEN = _core_.CENTRE_ON_SCREEN
93CENTER_ON_SCREEN = _core_.CENTER_ON_SCREEN
54f9ee45
RD
94CLIP_CHILDREN = _core_.CLIP_CHILDREN
95CLIP_SIBLINGS = _core_.CLIP_SIBLINGS
96ALWAYS_SHOW_SB = _core_.ALWAYS_SHOW_SB
97RETAINED = _core_.RETAINED
98BACKINGSTORE = _core_.BACKINGSTORE
99COLOURED = _core_.COLOURED
100FIXED_LENGTH = _core_.FIXED_LENGTH
101LB_NEEDED_SB = _core_.LB_NEEDED_SB
102LB_ALWAYS_SB = _core_.LB_ALWAYS_SB
103LB_SORT = _core_.LB_SORT
104LB_SINGLE = _core_.LB_SINGLE
105LB_MULTIPLE = _core_.LB_MULTIPLE
106LB_EXTENDED = _core_.LB_EXTENDED
107LB_OWNERDRAW = _core_.LB_OWNERDRAW
108LB_HSCROLL = _core_.LB_HSCROLL
109PROCESS_ENTER = _core_.PROCESS_ENTER
110PASSWORD = _core_.PASSWORD
111CB_SIMPLE = _core_.CB_SIMPLE
112CB_DROPDOWN = _core_.CB_DROPDOWN
113CB_SORT = _core_.CB_SORT
114CB_READONLY = _core_.CB_READONLY
115RA_HORIZONTAL = _core_.RA_HORIZONTAL
116RA_VERTICAL = _core_.RA_VERTICAL
117RA_SPECIFY_ROWS = _core_.RA_SPECIFY_ROWS
118RA_SPECIFY_COLS = _core_.RA_SPECIFY_COLS
fef4c27a 119RA_USE_CHECKBOX = _core_.RA_USE_CHECKBOX
54f9ee45
RD
120RB_GROUP = _core_.RB_GROUP
121RB_SINGLE = _core_.RB_SINGLE
54f9ee45
RD
122SB_HORIZONTAL = _core_.SB_HORIZONTAL
123SB_VERTICAL = _core_.SB_VERTICAL
fef4c27a 124RB_USE_CHECKBOX = _core_.RB_USE_CHECKBOX
54f9ee45
RD
125ST_SIZEGRIP = _core_.ST_SIZEGRIP
126ST_NO_AUTORESIZE = _core_.ST_NO_AUTORESIZE
127FLOOD_SURFACE = _core_.FLOOD_SURFACE
128FLOOD_BORDER = _core_.FLOOD_BORDER
129ODDEVEN_RULE = _core_.ODDEVEN_RULE
130WINDING_RULE = _core_.WINDING_RULE
131TOOL_TOP = _core_.TOOL_TOP
132TOOL_BOTTOM = _core_.TOOL_BOTTOM
133TOOL_LEFT = _core_.TOOL_LEFT
134TOOL_RIGHT = _core_.TOOL_RIGHT
135OK = _core_.OK
136YES_NO = _core_.YES_NO
137CANCEL = _core_.CANCEL
138YES = _core_.YES
139NO = _core_.NO
140NO_DEFAULT = _core_.NO_DEFAULT
141YES_DEFAULT = _core_.YES_DEFAULT
142ICON_EXCLAMATION = _core_.ICON_EXCLAMATION
143ICON_HAND = _core_.ICON_HAND
144ICON_QUESTION = _core_.ICON_QUESTION
145ICON_INFORMATION = _core_.ICON_INFORMATION
146ICON_STOP = _core_.ICON_STOP
147ICON_ASTERISK = _core_.ICON_ASTERISK
148ICON_MASK = _core_.ICON_MASK
149ICON_WARNING = _core_.ICON_WARNING
150ICON_ERROR = _core_.ICON_ERROR
151FORWARD = _core_.FORWARD
152BACKWARD = _core_.BACKWARD
153RESET = _core_.RESET
154HELP = _core_.HELP
155MORE = _core_.MORE
156SETUP = _core_.SETUP
157SIZE_AUTO_WIDTH = _core_.SIZE_AUTO_WIDTH
158SIZE_AUTO_HEIGHT = _core_.SIZE_AUTO_HEIGHT
159SIZE_AUTO = _core_.SIZE_AUTO
160SIZE_USE_EXISTING = _core_.SIZE_USE_EXISTING
161SIZE_ALLOW_MINUS_ONE = _core_.SIZE_ALLOW_MINUS_ONE
162PORTRAIT = _core_.PORTRAIT
163LANDSCAPE = _core_.LANDSCAPE
164PRINT_QUALITY_HIGH = _core_.PRINT_QUALITY_HIGH
165PRINT_QUALITY_MEDIUM = _core_.PRINT_QUALITY_MEDIUM
166PRINT_QUALITY_LOW = _core_.PRINT_QUALITY_LOW
167PRINT_QUALITY_DRAFT = _core_.PRINT_QUALITY_DRAFT
168ID_ANY = _core_.ID_ANY
169ID_SEPARATOR = _core_.ID_SEPARATOR
170ID_LOWEST = _core_.ID_LOWEST
171ID_OPEN = _core_.ID_OPEN
172ID_CLOSE = _core_.ID_CLOSE
173ID_NEW = _core_.ID_NEW
174ID_SAVE = _core_.ID_SAVE
175ID_SAVEAS = _core_.ID_SAVEAS
176ID_REVERT = _core_.ID_REVERT
177ID_EXIT = _core_.ID_EXIT
178ID_UNDO = _core_.ID_UNDO
179ID_REDO = _core_.ID_REDO
180ID_HELP = _core_.ID_HELP
181ID_PRINT = _core_.ID_PRINT
182ID_PRINT_SETUP = _core_.ID_PRINT_SETUP
183ID_PREVIEW = _core_.ID_PREVIEW
184ID_ABOUT = _core_.ID_ABOUT
185ID_HELP_CONTENTS = _core_.ID_HELP_CONTENTS
186ID_HELP_COMMANDS = _core_.ID_HELP_COMMANDS
187ID_HELP_PROCEDURES = _core_.ID_HELP_PROCEDURES
188ID_HELP_CONTEXT = _core_.ID_HELP_CONTEXT
189ID_CLOSE_ALL = _core_.ID_CLOSE_ALL
190ID_PREFERENCES = _core_.ID_PREFERENCES
191ID_CUT = _core_.ID_CUT
192ID_COPY = _core_.ID_COPY
193ID_PASTE = _core_.ID_PASTE
194ID_CLEAR = _core_.ID_CLEAR
195ID_FIND = _core_.ID_FIND
196ID_DUPLICATE = _core_.ID_DUPLICATE
197ID_SELECTALL = _core_.ID_SELECTALL
198ID_DELETE = _core_.ID_DELETE
199ID_REPLACE = _core_.ID_REPLACE
200ID_REPLACE_ALL = _core_.ID_REPLACE_ALL
201ID_PROPERTIES = _core_.ID_PROPERTIES
202ID_VIEW_DETAILS = _core_.ID_VIEW_DETAILS
203ID_VIEW_LARGEICONS = _core_.ID_VIEW_LARGEICONS
204ID_VIEW_SMALLICONS = _core_.ID_VIEW_SMALLICONS
205ID_VIEW_LIST = _core_.ID_VIEW_LIST
206ID_VIEW_SORTDATE = _core_.ID_VIEW_SORTDATE
207ID_VIEW_SORTNAME = _core_.ID_VIEW_SORTNAME
208ID_VIEW_SORTSIZE = _core_.ID_VIEW_SORTSIZE
209ID_VIEW_SORTTYPE = _core_.ID_VIEW_SORTTYPE
210ID_FILE1 = _core_.ID_FILE1
211ID_FILE2 = _core_.ID_FILE2
212ID_FILE3 = _core_.ID_FILE3
213ID_FILE4 = _core_.ID_FILE4
214ID_FILE5 = _core_.ID_FILE5
215ID_FILE6 = _core_.ID_FILE6
216ID_FILE7 = _core_.ID_FILE7
217ID_FILE8 = _core_.ID_FILE8
218ID_FILE9 = _core_.ID_FILE9
219ID_OK = _core_.ID_OK
220ID_CANCEL = _core_.ID_CANCEL
221ID_APPLY = _core_.ID_APPLY
222ID_YES = _core_.ID_YES
223ID_NO = _core_.ID_NO
224ID_STATIC = _core_.ID_STATIC
225ID_FORWARD = _core_.ID_FORWARD
226ID_BACKWARD = _core_.ID_BACKWARD
227ID_DEFAULT = _core_.ID_DEFAULT
228ID_MORE = _core_.ID_MORE
229ID_SETUP = _core_.ID_SETUP
230ID_RESET = _core_.ID_RESET
231ID_CONTEXT_HELP = _core_.ID_CONTEXT_HELP
232ID_YESTOALL = _core_.ID_YESTOALL
233ID_NOTOALL = _core_.ID_NOTOALL
234ID_ABORT = _core_.ID_ABORT
235ID_RETRY = _core_.ID_RETRY
236ID_IGNORE = _core_.ID_IGNORE
7bc1e663
RD
237ID_ADD = _core_.ID_ADD
238ID_REMOVE = _core_.ID_REMOVE
239ID_UP = _core_.ID_UP
240ID_DOWN = _core_.ID_DOWN
241ID_HOME = _core_.ID_HOME
242ID_REFRESH = _core_.ID_REFRESH
243ID_STOP = _core_.ID_STOP
244ID_INDEX = _core_.ID_INDEX
245ID_BOLD = _core_.ID_BOLD
246ID_ITALIC = _core_.ID_ITALIC
247ID_JUSTIFY_CENTER = _core_.ID_JUSTIFY_CENTER
248ID_JUSTIFY_FILL = _core_.ID_JUSTIFY_FILL
249ID_JUSTIFY_RIGHT = _core_.ID_JUSTIFY_RIGHT
250ID_JUSTIFY_LEFT = _core_.ID_JUSTIFY_LEFT
251ID_UNDERLINE = _core_.ID_UNDERLINE
252ID_INDENT = _core_.ID_INDENT
253ID_UNINDENT = _core_.ID_UNINDENT
254ID_ZOOM_100 = _core_.ID_ZOOM_100
255ID_ZOOM_FIT = _core_.ID_ZOOM_FIT
256ID_ZOOM_IN = _core_.ID_ZOOM_IN
257ID_ZOOM_OUT = _core_.ID_ZOOM_OUT
258ID_UNDELETE = _core_.ID_UNDELETE
259ID_REVERT_TO_SAVED = _core_.ID_REVERT_TO_SAVED
54f9ee45
RD
260ID_HIGHEST = _core_.ID_HIGHEST
261OPEN = _core_.OPEN
262SAVE = _core_.SAVE
263HIDE_READONLY = _core_.HIDE_READONLY
264OVERWRITE_PROMPT = _core_.OVERWRITE_PROMPT
265FILE_MUST_EXIST = _core_.FILE_MUST_EXIST
266MULTIPLE = _core_.MULTIPLE
267CHANGE_DIR = _core_.CHANGE_DIR
268ACCEL_ALT = _core_.ACCEL_ALT
269ACCEL_CTRL = _core_.ACCEL_CTRL
270ACCEL_SHIFT = _core_.ACCEL_SHIFT
271ACCEL_NORMAL = _core_.ACCEL_NORMAL
272PD_AUTO_HIDE = _core_.PD_AUTO_HIDE
273PD_APP_MODAL = _core_.PD_APP_MODAL
274PD_CAN_ABORT = _core_.PD_CAN_ABORT
275PD_ELAPSED_TIME = _core_.PD_ELAPSED_TIME
276PD_ESTIMATED_TIME = _core_.PD_ESTIMATED_TIME
277PD_REMAINING_TIME = _core_.PD_REMAINING_TIME
e505d15e
RD
278PD_SMOOTH = _core_.PD_SMOOTH
279PD_CAN_SKIP = _core_.PD_CAN_SKIP
54f9ee45
RD
280DD_NEW_DIR_BUTTON = _core_.DD_NEW_DIR_BUTTON
281DD_DEFAULT_STYLE = _core_.DD_DEFAULT_STYLE
282MENU_TEAROFF = _core_.MENU_TEAROFF
283MB_DOCKABLE = _core_.MB_DOCKABLE
284NO_FULL_REPAINT_ON_RESIZE = _core_.NO_FULL_REPAINT_ON_RESIZE
285FULL_REPAINT_ON_RESIZE = _core_.FULL_REPAINT_ON_RESIZE
286LI_HORIZONTAL = _core_.LI_HORIZONTAL
287LI_VERTICAL = _core_.LI_VERTICAL
288WS_EX_VALIDATE_RECURSIVELY = _core_.WS_EX_VALIDATE_RECURSIVELY
289WS_EX_BLOCK_EVENTS = _core_.WS_EX_BLOCK_EVENTS
290WS_EX_TRANSIENT = _core_.WS_EX_TRANSIENT
291WS_EX_THEMED_BACKGROUND = _core_.WS_EX_THEMED_BACKGROUND
292WS_EX_PROCESS_IDLE = _core_.WS_EX_PROCESS_IDLE
293WS_EX_PROCESS_UI_UPDATES = _core_.WS_EX_PROCESS_UI_UPDATES
294MM_TEXT = _core_.MM_TEXT
295MM_LOMETRIC = _core_.MM_LOMETRIC
296MM_HIMETRIC = _core_.MM_HIMETRIC
297MM_LOENGLISH = _core_.MM_LOENGLISH
298MM_HIENGLISH = _core_.MM_HIENGLISH
299MM_TWIPS = _core_.MM_TWIPS
300MM_ISOTROPIC = _core_.MM_ISOTROPIC
301MM_ANISOTROPIC = _core_.MM_ANISOTROPIC
302MM_POINTS = _core_.MM_POINTS
303MM_METRIC = _core_.MM_METRIC
304CENTRE = _core_.CENTRE
305CENTER = _core_.CENTER
306HORIZONTAL = _core_.HORIZONTAL
307VERTICAL = _core_.VERTICAL
308BOTH = _core_.BOTH
309LEFT = _core_.LEFT
310RIGHT = _core_.RIGHT
311UP = _core_.UP
312DOWN = _core_.DOWN
313TOP = _core_.TOP
314BOTTOM = _core_.BOTTOM
315NORTH = _core_.NORTH
316SOUTH = _core_.SOUTH
317WEST = _core_.WEST
318EAST = _core_.EAST
319ALL = _core_.ALL
320ALIGN_NOT = _core_.ALIGN_NOT
321ALIGN_CENTER_HORIZONTAL = _core_.ALIGN_CENTER_HORIZONTAL
322ALIGN_CENTRE_HORIZONTAL = _core_.ALIGN_CENTRE_HORIZONTAL
323ALIGN_LEFT = _core_.ALIGN_LEFT
324ALIGN_TOP = _core_.ALIGN_TOP
325ALIGN_RIGHT = _core_.ALIGN_RIGHT
326ALIGN_BOTTOM = _core_.ALIGN_BOTTOM
327ALIGN_CENTER_VERTICAL = _core_.ALIGN_CENTER_VERTICAL
328ALIGN_CENTRE_VERTICAL = _core_.ALIGN_CENTRE_VERTICAL
329ALIGN_CENTER = _core_.ALIGN_CENTER
330ALIGN_CENTRE = _core_.ALIGN_CENTRE
331ALIGN_MASK = _core_.ALIGN_MASK
332STRETCH_NOT = _core_.STRETCH_NOT
333SHRINK = _core_.SHRINK
334GROW = _core_.GROW
335EXPAND = _core_.EXPAND
336SHAPED = _core_.SHAPED
337FIXED_MINSIZE = _core_.FIXED_MINSIZE
338TILE = _core_.TILE
339ADJUST_MINSIZE = _core_.ADJUST_MINSIZE
340BORDER_DEFAULT = _core_.BORDER_DEFAULT
341BORDER_NONE = _core_.BORDER_NONE
342BORDER_STATIC = _core_.BORDER_STATIC
343BORDER_SIMPLE = _core_.BORDER_SIMPLE
344BORDER_RAISED = _core_.BORDER_RAISED
345BORDER_SUNKEN = _core_.BORDER_SUNKEN
346BORDER_DOUBLE = _core_.BORDER_DOUBLE
347BORDER_MASK = _core_.BORDER_MASK
7bc1e663
RD
348BG_STYLE_SYSTEM = _core_.BG_STYLE_SYSTEM
349BG_STYLE_COLOUR = _core_.BG_STYLE_COLOUR
350BG_STYLE_CUSTOM = _core_.BG_STYLE_CUSTOM
54f9ee45
RD
351DEFAULT = _core_.DEFAULT
352DECORATIVE = _core_.DECORATIVE
353ROMAN = _core_.ROMAN
354SCRIPT = _core_.SCRIPT
355SWISS = _core_.SWISS
356MODERN = _core_.MODERN
357TELETYPE = _core_.TELETYPE
358VARIABLE = _core_.VARIABLE
359FIXED = _core_.FIXED
360NORMAL = _core_.NORMAL
361LIGHT = _core_.LIGHT
362BOLD = _core_.BOLD
363ITALIC = _core_.ITALIC
364SLANT = _core_.SLANT
365SOLID = _core_.SOLID
366DOT = _core_.DOT
367LONG_DASH = _core_.LONG_DASH
368SHORT_DASH = _core_.SHORT_DASH
369DOT_DASH = _core_.DOT_DASH
370USER_DASH = _core_.USER_DASH
371TRANSPARENT = _core_.TRANSPARENT
372STIPPLE = _core_.STIPPLE
373BDIAGONAL_HATCH = _core_.BDIAGONAL_HATCH
374CROSSDIAG_HATCH = _core_.CROSSDIAG_HATCH
375FDIAGONAL_HATCH = _core_.FDIAGONAL_HATCH
376CROSS_HATCH = _core_.CROSS_HATCH
377HORIZONTAL_HATCH = _core_.HORIZONTAL_HATCH
378VERTICAL_HATCH = _core_.VERTICAL_HATCH
379JOIN_BEVEL = _core_.JOIN_BEVEL
380JOIN_MITER = _core_.JOIN_MITER
381JOIN_ROUND = _core_.JOIN_ROUND
382CAP_ROUND = _core_.CAP_ROUND
383CAP_PROJECTING = _core_.CAP_PROJECTING
384CAP_BUTT = _core_.CAP_BUTT
385CLEAR = _core_.CLEAR
386XOR = _core_.XOR
387INVERT = _core_.INVERT
388OR_REVERSE = _core_.OR_REVERSE
389AND_REVERSE = _core_.AND_REVERSE
390COPY = _core_.COPY
391AND = _core_.AND
392AND_INVERT = _core_.AND_INVERT
393NO_OP = _core_.NO_OP
394NOR = _core_.NOR
395EQUIV = _core_.EQUIV
396SRC_INVERT = _core_.SRC_INVERT
397OR_INVERT = _core_.OR_INVERT
398NAND = _core_.NAND
399OR = _core_.OR
400SET = _core_.SET
401WXK_BACK = _core_.WXK_BACK
402WXK_TAB = _core_.WXK_TAB
403WXK_RETURN = _core_.WXK_RETURN
404WXK_ESCAPE = _core_.WXK_ESCAPE
405WXK_SPACE = _core_.WXK_SPACE
406WXK_DELETE = _core_.WXK_DELETE
407WXK_START = _core_.WXK_START
408WXK_LBUTTON = _core_.WXK_LBUTTON
409WXK_RBUTTON = _core_.WXK_RBUTTON
410WXK_CANCEL = _core_.WXK_CANCEL
411WXK_MBUTTON = _core_.WXK_MBUTTON
412WXK_CLEAR = _core_.WXK_CLEAR
413WXK_SHIFT = _core_.WXK_SHIFT
414WXK_ALT = _core_.WXK_ALT
415WXK_CONTROL = _core_.WXK_CONTROL
416WXK_MENU = _core_.WXK_MENU
417WXK_PAUSE = _core_.WXK_PAUSE
418WXK_CAPITAL = _core_.WXK_CAPITAL
419WXK_PRIOR = _core_.WXK_PRIOR
420WXK_NEXT = _core_.WXK_NEXT
421WXK_END = _core_.WXK_END
422WXK_HOME = _core_.WXK_HOME
423WXK_LEFT = _core_.WXK_LEFT
424WXK_UP = _core_.WXK_UP
425WXK_RIGHT = _core_.WXK_RIGHT
426WXK_DOWN = _core_.WXK_DOWN
427WXK_SELECT = _core_.WXK_SELECT
428WXK_PRINT = _core_.WXK_PRINT
429WXK_EXECUTE = _core_.WXK_EXECUTE
430WXK_SNAPSHOT = _core_.WXK_SNAPSHOT
431WXK_INSERT = _core_.WXK_INSERT
432WXK_HELP = _core_.WXK_HELP
433WXK_NUMPAD0 = _core_.WXK_NUMPAD0
434WXK_NUMPAD1 = _core_.WXK_NUMPAD1
435WXK_NUMPAD2 = _core_.WXK_NUMPAD2
436WXK_NUMPAD3 = _core_.WXK_NUMPAD3
437WXK_NUMPAD4 = _core_.WXK_NUMPAD4
438WXK_NUMPAD5 = _core_.WXK_NUMPAD5
439WXK_NUMPAD6 = _core_.WXK_NUMPAD6
440WXK_NUMPAD7 = _core_.WXK_NUMPAD7
441WXK_NUMPAD8 = _core_.WXK_NUMPAD8
442WXK_NUMPAD9 = _core_.WXK_NUMPAD9
443WXK_MULTIPLY = _core_.WXK_MULTIPLY
444WXK_ADD = _core_.WXK_ADD
445WXK_SEPARATOR = _core_.WXK_SEPARATOR
446WXK_SUBTRACT = _core_.WXK_SUBTRACT
447WXK_DECIMAL = _core_.WXK_DECIMAL
448WXK_DIVIDE = _core_.WXK_DIVIDE
449WXK_F1 = _core_.WXK_F1
450WXK_F2 = _core_.WXK_F2
451WXK_F3 = _core_.WXK_F3
452WXK_F4 = _core_.WXK_F4
453WXK_F5 = _core_.WXK_F5
454WXK_F6 = _core_.WXK_F6
455WXK_F7 = _core_.WXK_F7
456WXK_F8 = _core_.WXK_F8
457WXK_F9 = _core_.WXK_F9
458WXK_F10 = _core_.WXK_F10
459WXK_F11 = _core_.WXK_F11
460WXK_F12 = _core_.WXK_F12
461WXK_F13 = _core_.WXK_F13
462WXK_F14 = _core_.WXK_F14
463WXK_F15 = _core_.WXK_F15
464WXK_F16 = _core_.WXK_F16
465WXK_F17 = _core_.WXK_F17
466WXK_F18 = _core_.WXK_F18
467WXK_F19 = _core_.WXK_F19
468WXK_F20 = _core_.WXK_F20
469WXK_F21 = _core_.WXK_F21
470WXK_F22 = _core_.WXK_F22
471WXK_F23 = _core_.WXK_F23
472WXK_F24 = _core_.WXK_F24
473WXK_NUMLOCK = _core_.WXK_NUMLOCK
474WXK_SCROLL = _core_.WXK_SCROLL
475WXK_PAGEUP = _core_.WXK_PAGEUP
476WXK_PAGEDOWN = _core_.WXK_PAGEDOWN
477WXK_NUMPAD_SPACE = _core_.WXK_NUMPAD_SPACE
478WXK_NUMPAD_TAB = _core_.WXK_NUMPAD_TAB
479WXK_NUMPAD_ENTER = _core_.WXK_NUMPAD_ENTER
480WXK_NUMPAD_F1 = _core_.WXK_NUMPAD_F1
481WXK_NUMPAD_F2 = _core_.WXK_NUMPAD_F2
482WXK_NUMPAD_F3 = _core_.WXK_NUMPAD_F3
483WXK_NUMPAD_F4 = _core_.WXK_NUMPAD_F4
484WXK_NUMPAD_HOME = _core_.WXK_NUMPAD_HOME
485WXK_NUMPAD_LEFT = _core_.WXK_NUMPAD_LEFT
486WXK_NUMPAD_UP = _core_.WXK_NUMPAD_UP
487WXK_NUMPAD_RIGHT = _core_.WXK_NUMPAD_RIGHT
488WXK_NUMPAD_DOWN = _core_.WXK_NUMPAD_DOWN
489WXK_NUMPAD_PRIOR = _core_.WXK_NUMPAD_PRIOR
490WXK_NUMPAD_PAGEUP = _core_.WXK_NUMPAD_PAGEUP
491WXK_NUMPAD_NEXT = _core_.WXK_NUMPAD_NEXT
492WXK_NUMPAD_PAGEDOWN = _core_.WXK_NUMPAD_PAGEDOWN
493WXK_NUMPAD_END = _core_.WXK_NUMPAD_END
494WXK_NUMPAD_BEGIN = _core_.WXK_NUMPAD_BEGIN
495WXK_NUMPAD_INSERT = _core_.WXK_NUMPAD_INSERT
496WXK_NUMPAD_DELETE = _core_.WXK_NUMPAD_DELETE
497WXK_NUMPAD_EQUAL = _core_.WXK_NUMPAD_EQUAL
498WXK_NUMPAD_MULTIPLY = _core_.WXK_NUMPAD_MULTIPLY
499WXK_NUMPAD_ADD = _core_.WXK_NUMPAD_ADD
500WXK_NUMPAD_SEPARATOR = _core_.WXK_NUMPAD_SEPARATOR
501WXK_NUMPAD_SUBTRACT = _core_.WXK_NUMPAD_SUBTRACT
502WXK_NUMPAD_DECIMAL = _core_.WXK_NUMPAD_DECIMAL
503WXK_NUMPAD_DIVIDE = _core_.WXK_NUMPAD_DIVIDE
504WXK_WINDOWS_LEFT = _core_.WXK_WINDOWS_LEFT
505WXK_WINDOWS_RIGHT = _core_.WXK_WINDOWS_RIGHT
506WXK_WINDOWS_MENU = _core_.WXK_WINDOWS_MENU
88c6b281
RD
507WXK_COMMAND = _core_.WXK_COMMAND
508WXK_SPECIAL1 = _core_.WXK_SPECIAL1
509WXK_SPECIAL2 = _core_.WXK_SPECIAL2
510WXK_SPECIAL3 = _core_.WXK_SPECIAL3
511WXK_SPECIAL4 = _core_.WXK_SPECIAL4
512WXK_SPECIAL5 = _core_.WXK_SPECIAL5
513WXK_SPECIAL6 = _core_.WXK_SPECIAL6
514WXK_SPECIAL7 = _core_.WXK_SPECIAL7
515WXK_SPECIAL8 = _core_.WXK_SPECIAL8
516WXK_SPECIAL9 = _core_.WXK_SPECIAL9
517WXK_SPECIAL10 = _core_.WXK_SPECIAL10
518WXK_SPECIAL11 = _core_.WXK_SPECIAL11
519WXK_SPECIAL12 = _core_.WXK_SPECIAL12
520WXK_SPECIAL13 = _core_.WXK_SPECIAL13
521WXK_SPECIAL14 = _core_.WXK_SPECIAL14
522WXK_SPECIAL15 = _core_.WXK_SPECIAL15
523WXK_SPECIAL16 = _core_.WXK_SPECIAL16
524WXK_SPECIAL17 = _core_.WXK_SPECIAL17
525WXK_SPECIAL18 = _core_.WXK_SPECIAL18
526WXK_SPECIAL19 = _core_.WXK_SPECIAL19
527WXK_SPECIAL20 = _core_.WXK_SPECIAL20
54f9ee45
RD
528PAPER_NONE = _core_.PAPER_NONE
529PAPER_LETTER = _core_.PAPER_LETTER
530PAPER_LEGAL = _core_.PAPER_LEGAL
531PAPER_A4 = _core_.PAPER_A4
532PAPER_CSHEET = _core_.PAPER_CSHEET
533PAPER_DSHEET = _core_.PAPER_DSHEET
534PAPER_ESHEET = _core_.PAPER_ESHEET
535PAPER_LETTERSMALL = _core_.PAPER_LETTERSMALL
536PAPER_TABLOID = _core_.PAPER_TABLOID
537PAPER_LEDGER = _core_.PAPER_LEDGER
538PAPER_STATEMENT = _core_.PAPER_STATEMENT
539PAPER_EXECUTIVE = _core_.PAPER_EXECUTIVE
540PAPER_A3 = _core_.PAPER_A3
541PAPER_A4SMALL = _core_.PAPER_A4SMALL
542PAPER_A5 = _core_.PAPER_A5
543PAPER_B4 = _core_.PAPER_B4
544PAPER_B5 = _core_.PAPER_B5
545PAPER_FOLIO = _core_.PAPER_FOLIO
546PAPER_QUARTO = _core_.PAPER_QUARTO
547PAPER_10X14 = _core_.PAPER_10X14
548PAPER_11X17 = _core_.PAPER_11X17
549PAPER_NOTE = _core_.PAPER_NOTE
550PAPER_ENV_9 = _core_.PAPER_ENV_9
551PAPER_ENV_10 = _core_.PAPER_ENV_10
552PAPER_ENV_11 = _core_.PAPER_ENV_11
553PAPER_ENV_12 = _core_.PAPER_ENV_12
554PAPER_ENV_14 = _core_.PAPER_ENV_14
555PAPER_ENV_DL = _core_.PAPER_ENV_DL
556PAPER_ENV_C5 = _core_.PAPER_ENV_C5
557PAPER_ENV_C3 = _core_.PAPER_ENV_C3
558PAPER_ENV_C4 = _core_.PAPER_ENV_C4
559PAPER_ENV_C6 = _core_.PAPER_ENV_C6
560PAPER_ENV_C65 = _core_.PAPER_ENV_C65
561PAPER_ENV_B4 = _core_.PAPER_ENV_B4
562PAPER_ENV_B5 = _core_.PAPER_ENV_B5
563PAPER_ENV_B6 = _core_.PAPER_ENV_B6
564PAPER_ENV_ITALY = _core_.PAPER_ENV_ITALY
565PAPER_ENV_MONARCH = _core_.PAPER_ENV_MONARCH
566PAPER_ENV_PERSONAL = _core_.PAPER_ENV_PERSONAL
567PAPER_FANFOLD_US = _core_.PAPER_FANFOLD_US
568PAPER_FANFOLD_STD_GERMAN = _core_.PAPER_FANFOLD_STD_GERMAN
569PAPER_FANFOLD_LGL_GERMAN = _core_.PAPER_FANFOLD_LGL_GERMAN
570PAPER_ISO_B4 = _core_.PAPER_ISO_B4
571PAPER_JAPANESE_POSTCARD = _core_.PAPER_JAPANESE_POSTCARD
572PAPER_9X11 = _core_.PAPER_9X11
573PAPER_10X11 = _core_.PAPER_10X11
574PAPER_15X11 = _core_.PAPER_15X11
575PAPER_ENV_INVITE = _core_.PAPER_ENV_INVITE
576PAPER_LETTER_EXTRA = _core_.PAPER_LETTER_EXTRA
577PAPER_LEGAL_EXTRA = _core_.PAPER_LEGAL_EXTRA
578PAPER_TABLOID_EXTRA = _core_.PAPER_TABLOID_EXTRA
579PAPER_A4_EXTRA = _core_.PAPER_A4_EXTRA
580PAPER_LETTER_TRANSVERSE = _core_.PAPER_LETTER_TRANSVERSE
581PAPER_A4_TRANSVERSE = _core_.PAPER_A4_TRANSVERSE
582PAPER_LETTER_EXTRA_TRANSVERSE = _core_.PAPER_LETTER_EXTRA_TRANSVERSE
583PAPER_A_PLUS = _core_.PAPER_A_PLUS
584PAPER_B_PLUS = _core_.PAPER_B_PLUS
585PAPER_LETTER_PLUS = _core_.PAPER_LETTER_PLUS
586PAPER_A4_PLUS = _core_.PAPER_A4_PLUS
587PAPER_A5_TRANSVERSE = _core_.PAPER_A5_TRANSVERSE
588PAPER_B5_TRANSVERSE = _core_.PAPER_B5_TRANSVERSE
589PAPER_A3_EXTRA = _core_.PAPER_A3_EXTRA
590PAPER_A5_EXTRA = _core_.PAPER_A5_EXTRA
591PAPER_B5_EXTRA = _core_.PAPER_B5_EXTRA
592PAPER_A2 = _core_.PAPER_A2
593PAPER_A3_TRANSVERSE = _core_.PAPER_A3_TRANSVERSE
594PAPER_A3_EXTRA_TRANSVERSE = _core_.PAPER_A3_EXTRA_TRANSVERSE
595DUPLEX_SIMPLEX = _core_.DUPLEX_SIMPLEX
596DUPLEX_HORIZONTAL = _core_.DUPLEX_HORIZONTAL
597DUPLEX_VERTICAL = _core_.DUPLEX_VERTICAL
598ITEM_SEPARATOR = _core_.ITEM_SEPARATOR
599ITEM_NORMAL = _core_.ITEM_NORMAL
600ITEM_CHECK = _core_.ITEM_CHECK
601ITEM_RADIO = _core_.ITEM_RADIO
602ITEM_MAX = _core_.ITEM_MAX
603HT_NOWHERE = _core_.HT_NOWHERE
604HT_SCROLLBAR_FIRST = _core_.HT_SCROLLBAR_FIRST
605HT_SCROLLBAR_ARROW_LINE_1 = _core_.HT_SCROLLBAR_ARROW_LINE_1
606HT_SCROLLBAR_ARROW_LINE_2 = _core_.HT_SCROLLBAR_ARROW_LINE_2
607HT_SCROLLBAR_ARROW_PAGE_1 = _core_.HT_SCROLLBAR_ARROW_PAGE_1
608HT_SCROLLBAR_ARROW_PAGE_2 = _core_.HT_SCROLLBAR_ARROW_PAGE_2
609HT_SCROLLBAR_THUMB = _core_.HT_SCROLLBAR_THUMB
610HT_SCROLLBAR_BAR_1 = _core_.HT_SCROLLBAR_BAR_1
611HT_SCROLLBAR_BAR_2 = _core_.HT_SCROLLBAR_BAR_2
612HT_SCROLLBAR_LAST = _core_.HT_SCROLLBAR_LAST
613HT_WINDOW_OUTSIDE = _core_.HT_WINDOW_OUTSIDE
614HT_WINDOW_INSIDE = _core_.HT_WINDOW_INSIDE
615HT_WINDOW_VERT_SCROLLBAR = _core_.HT_WINDOW_VERT_SCROLLBAR
616HT_WINDOW_HORZ_SCROLLBAR = _core_.HT_WINDOW_HORZ_SCROLLBAR
617HT_WINDOW_CORNER = _core_.HT_WINDOW_CORNER
618HT_MAX = _core_.HT_MAX
619MOD_NONE = _core_.MOD_NONE
620MOD_ALT = _core_.MOD_ALT
621MOD_CONTROL = _core_.MOD_CONTROL
622MOD_SHIFT = _core_.MOD_SHIFT
623MOD_WIN = _core_.MOD_WIN
624UPDATE_UI_NONE = _core_.UPDATE_UI_NONE
625UPDATE_UI_RECURSE = _core_.UPDATE_UI_RECURSE
626UPDATE_UI_FROMIDLE = _core_.UPDATE_UI_FROMIDLE
d14a1e28
RD
627#---------------------------------------------------------------------------
628
629class Object(object):
0df68c9f
RD
630 """
631 The base class for most wx objects, although in wxPython not
632 much functionality is needed nor exposed.
633 """
d14a1e28
RD
634 def __init__(self): raise RuntimeError, "No constructor defined"
635 def __repr__(self):
636 return "<%s.%s; proxy of C++ wxObject instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
e811c8ce 637 def GetClassName(*args, **kwargs):
0df68c9f 638 """
a95a7133 639 GetClassName(self) -> String
e811c8ce 640
a95a7133 641 Returns the class name of the C++ class using wxRTTI.
0df68c9f 642 """
54f9ee45 643 return _core_.Object_GetClassName(*args, **kwargs)
e811c8ce
RD
644
645 def Destroy(*args, **kwargs):
0df68c9f 646 """
a95a7133 647 Destroy(self)
e811c8ce 648
0df68c9f
RD
649 Deletes the C++ object this Python object is a proxy for.
650 """
54f9ee45 651 return _core_.Object_Destroy(*args, **kwargs)
e811c8ce 652
d14a1e28
RD
653
654class ObjectPtr(Object):
655 def __init__(self, this):
656 self.this = this
657 if not hasattr(self,"thisown"): self.thisown = 0
658 self.__class__ = Object
54f9ee45
RD
659_core_.Object_swigregister(ObjectPtr)
660_wxPySetDictionary = _core_._wxPySetDictionary
d14a1e28 661
54f9ee45 662_wxPyFixStockObjects = _core_._wxPyFixStockObjects
3a04f143 663
54f9ee45 664cvar = _core_.cvar
196addbf 665EmptyString = cvar.EmptyString
d14a1e28
RD
666
667#---------------------------------------------------------------------------
668
54f9ee45
RD
669BITMAP_TYPE_INVALID = _core_.BITMAP_TYPE_INVALID
670BITMAP_TYPE_BMP = _core_.BITMAP_TYPE_BMP
671BITMAP_TYPE_ICO = _core_.BITMAP_TYPE_ICO
672BITMAP_TYPE_CUR = _core_.BITMAP_TYPE_CUR
673BITMAP_TYPE_XBM = _core_.BITMAP_TYPE_XBM
674BITMAP_TYPE_XBM_DATA = _core_.BITMAP_TYPE_XBM_DATA
675BITMAP_TYPE_XPM = _core_.BITMAP_TYPE_XPM
676BITMAP_TYPE_XPM_DATA = _core_.BITMAP_TYPE_XPM_DATA
677BITMAP_TYPE_TIF = _core_.BITMAP_TYPE_TIF
678BITMAP_TYPE_GIF = _core_.BITMAP_TYPE_GIF
679BITMAP_TYPE_PNG = _core_.BITMAP_TYPE_PNG
680BITMAP_TYPE_JPEG = _core_.BITMAP_TYPE_JPEG
681BITMAP_TYPE_PNM = _core_.BITMAP_TYPE_PNM
682BITMAP_TYPE_PCX = _core_.BITMAP_TYPE_PCX
683BITMAP_TYPE_PICT = _core_.BITMAP_TYPE_PICT
684BITMAP_TYPE_ICON = _core_.BITMAP_TYPE_ICON
685BITMAP_TYPE_ANI = _core_.BITMAP_TYPE_ANI
686BITMAP_TYPE_IFF = _core_.BITMAP_TYPE_IFF
687BITMAP_TYPE_MACCURSOR = _core_.BITMAP_TYPE_MACCURSOR
688BITMAP_TYPE_ANY = _core_.BITMAP_TYPE_ANY
689CURSOR_NONE = _core_.CURSOR_NONE
690CURSOR_ARROW = _core_.CURSOR_ARROW
691CURSOR_RIGHT_ARROW = _core_.CURSOR_RIGHT_ARROW
692CURSOR_BULLSEYE = _core_.CURSOR_BULLSEYE
693CURSOR_CHAR = _core_.CURSOR_CHAR
694CURSOR_CROSS = _core_.CURSOR_CROSS
695CURSOR_HAND = _core_.CURSOR_HAND
696CURSOR_IBEAM = _core_.CURSOR_IBEAM
697CURSOR_LEFT_BUTTON = _core_.CURSOR_LEFT_BUTTON
698CURSOR_MAGNIFIER = _core_.CURSOR_MAGNIFIER
699CURSOR_MIDDLE_BUTTON = _core_.CURSOR_MIDDLE_BUTTON
700CURSOR_NO_ENTRY = _core_.CURSOR_NO_ENTRY
701CURSOR_PAINT_BRUSH = _core_.CURSOR_PAINT_BRUSH
702CURSOR_PENCIL = _core_.CURSOR_PENCIL
703CURSOR_POINT_LEFT = _core_.CURSOR_POINT_LEFT
704CURSOR_POINT_RIGHT = _core_.CURSOR_POINT_RIGHT
705CURSOR_QUESTION_ARROW = _core_.CURSOR_QUESTION_ARROW
706CURSOR_RIGHT_BUTTON = _core_.CURSOR_RIGHT_BUTTON
707CURSOR_SIZENESW = _core_.CURSOR_SIZENESW
708CURSOR_SIZENS = _core_.CURSOR_SIZENS
709CURSOR_SIZENWSE = _core_.CURSOR_SIZENWSE
710CURSOR_SIZEWE = _core_.CURSOR_SIZEWE
711CURSOR_SIZING = _core_.CURSOR_SIZING
712CURSOR_SPRAYCAN = _core_.CURSOR_SPRAYCAN
713CURSOR_WAIT = _core_.CURSOR_WAIT
714CURSOR_WATCH = _core_.CURSOR_WATCH
715CURSOR_BLANK = _core_.CURSOR_BLANK
716CURSOR_DEFAULT = _core_.CURSOR_DEFAULT
717CURSOR_COPY_ARROW = _core_.CURSOR_COPY_ARROW
718CURSOR_ARROWWAIT = _core_.CURSOR_ARROWWAIT
719CURSOR_MAX = _core_.CURSOR_MAX
d14a1e28
RD
720#---------------------------------------------------------------------------
721
722class Size(object):
0df68c9f 723 """
41e2b43e 724 wx.Size is a useful data structure used to represent the size of
093d3ff1
RD
725 something. It simply contians integer width and height
726 proprtites. In most places in wxPython where a wx.Size is
727 expected a (width, height) tuple can be used instead.
0df68c9f 728 """
e811c8ce
RD
729 def __repr__(self):
730 return "<%s.%s; proxy of C++ wxSize instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
54f9ee45
RD
731 width = property(_core_.Size_width_get, _core_.Size_width_set)
732 height = property(_core_.Size_height_get, _core_.Size_height_set)
242b7b46 733 x = width; y = height
d14a1e28 734 def __init__(self, *args, **kwargs):
0df68c9f 735 """
a95a7133 736 __init__(self, int w=0, int h=0) -> Size
e811c8ce 737
0df68c9f
RD
738 Creates a size object.
739 """
54f9ee45 740 newobj = _core_.new_Size(*args, **kwargs)
d14a1e28
RD
741 self.this = newobj.this
742 self.thisown = 1
743 del newobj.thisown
54f9ee45 744 def __del__(self, destroy=_core_.delete_Size):
a95a7133 745 """__del__(self)"""
d14a1e28
RD
746 try:
747 if self.thisown: destroy(self)
748 except: pass
e811c8ce
RD
749
750 def __eq__(*args, **kwargs):
0df68c9f 751 """
a95a7133 752 __eq__(self, Size sz) -> bool
e811c8ce 753
0df68c9f
RD
754 Test for equality of wx.Size objects.
755 """
54f9ee45 756 return _core_.Size___eq__(*args, **kwargs)
e811c8ce
RD
757
758 def __ne__(*args, **kwargs):
0df68c9f 759 """
a95a7133 760 __ne__(self, Size sz) -> bool
e811c8ce 761
0df68c9f
RD
762 Test for inequality.
763 """
54f9ee45 764 return _core_.Size___ne__(*args, **kwargs)
e811c8ce
RD
765
766 def __add__(*args, **kwargs):
0df68c9f 767 """
a95a7133 768 __add__(self, Size sz) -> Size
e811c8ce 769
0df68c9f
RD
770 Add sz's proprties to this and return the result.
771 """
54f9ee45 772 return _core_.Size___add__(*args, **kwargs)
e811c8ce
RD
773
774 def __sub__(*args, **kwargs):
0df68c9f 775 """
a95a7133 776 __sub__(self, Size sz) -> Size
e811c8ce 777
0df68c9f
RD
778 Subtract sz's properties from this and return the result.
779 """
54f9ee45 780 return _core_.Size___sub__(*args, **kwargs)
e811c8ce
RD
781
782 def IncTo(*args, **kwargs):
0df68c9f 783 """
a95a7133 784 IncTo(self, Size sz)
e811c8ce 785
0df68c9f
RD
786 Increments this object so that both of its dimensions are not less
787 than the corresponding dimensions of the size.
788 """
54f9ee45 789 return _core_.Size_IncTo(*args, **kwargs)
e811c8ce
RD
790
791 def DecTo(*args, **kwargs):
0df68c9f 792 """
a95a7133 793 DecTo(self, Size sz)
e811c8ce 794
0df68c9f
RD
795 Decrements this object so that both of its dimensions are not greater
796 than the corresponding dimensions of the size.
797 """
54f9ee45 798 return _core_.Size_DecTo(*args, **kwargs)
e811c8ce
RD
799
800 def Set(*args, **kwargs):
0df68c9f 801 """
a95a7133 802 Set(self, int w, int h)
e811c8ce 803
0df68c9f
RD
804 Set both width and height.
805 """
54f9ee45 806 return _core_.Size_Set(*args, **kwargs)
e811c8ce
RD
807
808 def SetWidth(*args, **kwargs):
a95a7133 809 """SetWidth(self, int w)"""
54f9ee45 810 return _core_.Size_SetWidth(*args, **kwargs)
e811c8ce
RD
811
812 def SetHeight(*args, **kwargs):
a95a7133 813 """SetHeight(self, int h)"""
54f9ee45 814 return _core_.Size_SetHeight(*args, **kwargs)
e811c8ce
RD
815
816 def GetWidth(*args, **kwargs):
a95a7133 817 """GetWidth(self) -> int"""
54f9ee45 818 return _core_.Size_GetWidth(*args, **kwargs)
e811c8ce
RD
819
820 def GetHeight(*args, **kwargs):
a95a7133 821 """GetHeight(self) -> int"""
54f9ee45 822 return _core_.Size_GetHeight(*args, **kwargs)
e811c8ce 823
74a57fcd
RD
824 def IsFullySpecified(*args, **kwargs):
825 """
a95a7133 826 IsFullySpecified(self) -> bool
74a57fcd
RD
827
828 Returns True if both components of the size are non-default values.
829 """
54f9ee45 830 return _core_.Size_IsFullySpecified(*args, **kwargs)
74a57fcd
RD
831
832 def SetDefaults(*args, **kwargs):
833 """
a95a7133 834 SetDefaults(self, Size size)
74a57fcd 835
41e2b43e
RD
836 Combine this size with the other one replacing the default components
837 of this object (i.e. equal to -1) with those of the other.
74a57fcd 838 """
54f9ee45 839 return _core_.Size_SetDefaults(*args, **kwargs)
74a57fcd 840
e811c8ce 841 def Get(*args, **kwargs):
0df68c9f
RD
842 """
843 Get() -> (width,height)
e811c8ce 844
0df68c9f
RD
845 Returns the width and height properties as a tuple.
846 """
54f9ee45 847 return _core_.Size_Get(*args, **kwargs)
e811c8ce 848
41e2b43e 849 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
e811c8ce
RD
850 def __str__(self): return str(self.Get())
851 def __repr__(self): return 'wx.Size'+str(self.Get())
852 def __len__(self): return len(self.Get())
853 def __getitem__(self, index): return self.Get()[index]
d14a1e28
RD
854 def __setitem__(self, index, val):
855 if index == 0: self.width = val
856 elif index == 1: self.height = val
857 else: raise IndexError
e811c8ce 858 def __nonzero__(self): return self.Get() != (0,0)
74e96f3d
RD
859 __safe_for_unpickling__ = True
860 def __reduce__(self): return (wx.Size, self.Get())
d14a1e28
RD
861
862
863class SizePtr(Size):
864 def __init__(self, this):
865 self.this = this
866 if not hasattr(self,"thisown"): self.thisown = 0
867 self.__class__ = Size
54f9ee45 868_core_.Size_swigregister(SizePtr)
d14a1e28
RD
869
870#---------------------------------------------------------------------------
871
872class RealPoint(object):
0df68c9f 873 """
41e2b43e
RD
874 A data structure for representing a point or position with floating
875 point x and y properties. In wxPython most places that expect a
876 wx.RealPoint can also accept a (x,y) tuple.
0df68c9f 877 """
e811c8ce
RD
878 def __repr__(self):
879 return "<%s.%s; proxy of C++ wxRealPoint instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
54f9ee45
RD
880 x = property(_core_.RealPoint_x_get, _core_.RealPoint_x_set)
881 y = property(_core_.RealPoint_y_get, _core_.RealPoint_y_set)
d14a1e28 882 def __init__(self, *args, **kwargs):
0df68c9f 883 """
a95a7133 884 __init__(self, double x=0.0, double y=0.0) -> RealPoint
e811c8ce 885
0df68c9f
RD
886 Create a wx.RealPoint object
887 """
54f9ee45 888 newobj = _core_.new_RealPoint(*args, **kwargs)
d14a1e28
RD
889 self.this = newobj.this
890 self.thisown = 1
891 del newobj.thisown
54f9ee45 892 def __del__(self, destroy=_core_.delete_RealPoint):
a95a7133 893 """__del__(self)"""
d14a1e28
RD
894 try:
895 if self.thisown: destroy(self)
896 except: pass
e811c8ce
RD
897
898 def __eq__(*args, **kwargs):
0df68c9f 899 """
a95a7133 900 __eq__(self, RealPoint pt) -> bool
e811c8ce 901
0df68c9f
RD
902 Test for equality of wx.RealPoint objects.
903 """
54f9ee45 904 return _core_.RealPoint___eq__(*args, **kwargs)
e811c8ce
RD
905
906 def __ne__(*args, **kwargs):
0df68c9f 907 """
a95a7133 908 __ne__(self, RealPoint pt) -> bool
e811c8ce 909
0df68c9f
RD
910 Test for inequality of wx.RealPoint objects.
911 """
54f9ee45 912 return _core_.RealPoint___ne__(*args, **kwargs)
e811c8ce
RD
913
914 def __add__(*args, **kwargs):
0df68c9f 915 """
a95a7133 916 __add__(self, RealPoint pt) -> RealPoint
e811c8ce 917
0df68c9f
RD
918 Add pt's proprties to this and return the result.
919 """
54f9ee45 920 return _core_.RealPoint___add__(*args, **kwargs)
e811c8ce
RD
921
922 def __sub__(*args, **kwargs):
0df68c9f 923 """
a95a7133 924 __sub__(self, RealPoint pt) -> RealPoint
e811c8ce 925
0df68c9f
RD
926 Subtract pt's proprties from this and return the result
927 """
54f9ee45 928 return _core_.RealPoint___sub__(*args, **kwargs)
e811c8ce
RD
929
930 def Set(*args, **kwargs):
0df68c9f 931 """
a95a7133 932 Set(self, double x, double y)
e811c8ce 933
0df68c9f
RD
934 Set both the x and y properties
935 """
54f9ee45 936 return _core_.RealPoint_Set(*args, **kwargs)
e811c8ce
RD
937
938 def Get(*args, **kwargs):
0df68c9f
RD
939 """
940 Get() -> (x,y)
e811c8ce 941
0df68c9f
RD
942 Return the x and y properties as a tuple.
943 """
54f9ee45 944 return _core_.RealPoint_Get(*args, **kwargs)
e811c8ce 945
41e2b43e 946 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
e811c8ce
RD
947 def __str__(self): return str(self.Get())
948 def __repr__(self): return 'wx.RealPoint'+str(self.Get())
949 def __len__(self): return len(self.Get())
950 def __getitem__(self, index): return self.Get()[index]
d14a1e28 951 def __setitem__(self, index, val):
e811c8ce
RD
952 if index == 0: self.x = val
953 elif index == 1: self.y = val
d14a1e28 954 else: raise IndexError
e811c8ce 955 def __nonzero__(self): return self.Get() != (0.0, 0.0)
74e96f3d
RD
956 __safe_for_unpickling__ = True
957 def __reduce__(self): return (wx.RealPoint, self.Get())
d14a1e28
RD
958
959
960class RealPointPtr(RealPoint):
961 def __init__(self, this):
962 self.this = this
963 if not hasattr(self,"thisown"): self.thisown = 0
964 self.__class__ = RealPoint
54f9ee45 965_core_.RealPoint_swigregister(RealPointPtr)
d14a1e28
RD
966
967#---------------------------------------------------------------------------
968
969class Point(object):
0df68c9f 970 """
41e2b43e
RD
971 A data structure for representing a point or position with integer x
972 and y properties. Most places in wxPython that expect a wx.Point can
973 also accept a (x,y) tuple.
0df68c9f 974 """
e811c8ce
RD
975 def __repr__(self):
976 return "<%s.%s; proxy of C++ wxPoint instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
54f9ee45
RD
977 x = property(_core_.Point_x_get, _core_.Point_x_set)
978 y = property(_core_.Point_y_get, _core_.Point_y_set)
d14a1e28 979 def __init__(self, *args, **kwargs):
0df68c9f 980 """
a95a7133 981 __init__(self, int x=0, int y=0) -> Point
e811c8ce 982
0df68c9f
RD
983 Create a wx.Point object
984 """
54f9ee45 985 newobj = _core_.new_Point(*args, **kwargs)
d14a1e28
RD
986 self.this = newobj.this
987 self.thisown = 1
988 del newobj.thisown
54f9ee45 989 def __del__(self, destroy=_core_.delete_Point):
a95a7133 990 """__del__(self)"""
d14a1e28
RD
991 try:
992 if self.thisown: destroy(self)
993 except: pass
e811c8ce
RD
994
995 def __eq__(*args, **kwargs):
0df68c9f 996 """
a95a7133 997 __eq__(self, Point pt) -> bool
e811c8ce 998
0df68c9f
RD
999 Test for equality of wx.Point objects.
1000 """
54f9ee45 1001 return _core_.Point___eq__(*args, **kwargs)
e811c8ce
RD
1002
1003 def __ne__(*args, **kwargs):
0df68c9f 1004 """
a95a7133 1005 __ne__(self, Point pt) -> bool
e811c8ce 1006
0df68c9f
RD
1007 Test for inequality of wx.Point objects.
1008 """
54f9ee45 1009 return _core_.Point___ne__(*args, **kwargs)
e811c8ce
RD
1010
1011 def __add__(*args, **kwargs):
0df68c9f 1012 """
a95a7133 1013 __add__(self, Point pt) -> Point
e811c8ce 1014
0df68c9f
RD
1015 Add pt's proprties to this and return the result.
1016 """
54f9ee45 1017 return _core_.Point___add__(*args, **kwargs)
e811c8ce
RD
1018
1019 def __sub__(*args, **kwargs):
0df68c9f 1020 """
a95a7133 1021 __sub__(self, Point pt) -> Point
e811c8ce 1022
0df68c9f
RD
1023 Subtract pt's proprties from this and return the result
1024 """
54f9ee45 1025 return _core_.Point___sub__(*args, **kwargs)
e811c8ce
RD
1026
1027 def __iadd__(*args, **kwargs):
0df68c9f 1028 """
a95a7133 1029 __iadd__(self, Point pt) -> Point
e811c8ce 1030
0df68c9f
RD
1031 Add pt to this object.
1032 """
54f9ee45 1033 return _core_.Point___iadd__(*args, **kwargs)
e811c8ce
RD
1034
1035 def __isub__(*args, **kwargs):
0df68c9f 1036 """
a95a7133 1037 __isub__(self, Point pt) -> Point
e811c8ce 1038
0df68c9f
RD
1039 Subtract pt from this object.
1040 """
54f9ee45 1041 return _core_.Point___isub__(*args, **kwargs)
e811c8ce
RD
1042
1043 def Set(*args, **kwargs):
0df68c9f 1044 """
a95a7133 1045 Set(self, long x, long y)
e811c8ce 1046
0df68c9f
RD
1047 Set both the x and y properties
1048 """
54f9ee45 1049 return _core_.Point_Set(*args, **kwargs)
e811c8ce
RD
1050
1051 def Get(*args, **kwargs):
0df68c9f
RD
1052 """
1053 Get() -> (x,y)
e811c8ce 1054
0df68c9f
RD
1055 Return the x and y properties as a tuple.
1056 """
54f9ee45 1057 return _core_.Point_Get(*args, **kwargs)
e811c8ce 1058
41e2b43e 1059 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
e811c8ce
RD
1060 def __str__(self): return str(self.Get())
1061 def __repr__(self): return 'wx.Point'+str(self.Get())
1062 def __len__(self): return len(self.Get())
1063 def __getitem__(self, index): return self.Get()[index]
d14a1e28
RD
1064 def __setitem__(self, index, val):
1065 if index == 0: self.x = val
1066 elif index == 1: self.y = val
1067 else: raise IndexError
e811c8ce 1068 def __nonzero__(self): return self.Get() != (0,0)
74e96f3d
RD
1069 __safe_for_unpickling__ = True
1070 def __reduce__(self): return (wx.Point, self.Get())
d14a1e28
RD
1071
1072
1073class PointPtr(Point):
1074 def __init__(self, this):
1075 self.this = this
1076 if not hasattr(self,"thisown"): self.thisown = 0
1077 self.__class__ = Point
54f9ee45 1078_core_.Point_swigregister(PointPtr)
d14a1e28
RD
1079
1080#---------------------------------------------------------------------------
1081
1082class Rect(object):
0df68c9f 1083 """
41e2b43e
RD
1084 A class for representing and manipulating rectangles. It has x, y,
1085 width and height properties. In wxPython most palces that expect a
1086 wx.Rect can also accept a (x,y,width,height) tuple.
0df68c9f 1087 """
e811c8ce
RD
1088 def __repr__(self):
1089 return "<%s.%s; proxy of C++ wxRect instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 1090 def __init__(self, *args, **kwargs):
0df68c9f 1091 """
a95a7133 1092 __init__(self, int x=0, int y=0, int width=0, int height=0) -> Rect
e811c8ce 1093
0df68c9f
RD
1094 Create a new Rect object.
1095 """
54f9ee45 1096 newobj = _core_.new_Rect(*args, **kwargs)
d14a1e28
RD
1097 self.this = newobj.this
1098 self.thisown = 1
1099 del newobj.thisown
54f9ee45 1100 def __del__(self, destroy=_core_.delete_Rect):
a95a7133 1101 """__del__(self)"""
d14a1e28
RD
1102 try:
1103 if self.thisown: destroy(self)
1104 except: pass
e811c8ce
RD
1105
1106 def GetX(*args, **kwargs):
a95a7133 1107 """GetX(self) -> int"""
54f9ee45 1108 return _core_.Rect_GetX(*args, **kwargs)
e811c8ce
RD
1109
1110 def SetX(*args, **kwargs):
a95a7133 1111 """SetX(self, int x)"""
54f9ee45 1112 return _core_.Rect_SetX(*args, **kwargs)
e811c8ce
RD
1113
1114 def GetY(*args, **kwargs):
a95a7133 1115 """GetY(self) -> int"""
54f9ee45 1116 return _core_.Rect_GetY(*args, **kwargs)
e811c8ce
RD
1117
1118 def SetY(*args, **kwargs):
a95a7133 1119 """SetY(self, int y)"""
54f9ee45 1120 return _core_.Rect_SetY(*args, **kwargs)
e811c8ce
RD
1121
1122 def GetWidth(*args, **kwargs):
a95a7133 1123 """GetWidth(self) -> int"""
54f9ee45 1124 return _core_.Rect_GetWidth(*args, **kwargs)
e811c8ce
RD
1125
1126 def SetWidth(*args, **kwargs):
a95a7133 1127 """SetWidth(self, int w)"""
54f9ee45 1128 return _core_.Rect_SetWidth(*args, **kwargs)
e811c8ce
RD
1129
1130 def GetHeight(*args, **kwargs):
a95a7133 1131 """GetHeight(self) -> int"""
54f9ee45 1132 return _core_.Rect_GetHeight(*args, **kwargs)
e811c8ce
RD
1133
1134 def SetHeight(*args, **kwargs):
a95a7133 1135 """SetHeight(self, int h)"""
54f9ee45 1136 return _core_.Rect_SetHeight(*args, **kwargs)
e811c8ce
RD
1137
1138 def GetPosition(*args, **kwargs):
a95a7133 1139 """GetPosition(self) -> Point"""
54f9ee45 1140 return _core_.Rect_GetPosition(*args, **kwargs)
e811c8ce
RD
1141
1142 def SetPosition(*args, **kwargs):
a95a7133 1143 """SetPosition(self, Point p)"""
54f9ee45 1144 return _core_.Rect_SetPosition(*args, **kwargs)
e811c8ce
RD
1145
1146 def GetSize(*args, **kwargs):
a95a7133 1147 """GetSize(self) -> Size"""
54f9ee45 1148 return _core_.Rect_GetSize(*args, **kwargs)
e811c8ce
RD
1149
1150 def SetSize(*args, **kwargs):
a95a7133 1151 """SetSize(self, Size s)"""
54f9ee45 1152 return _core_.Rect_SetSize(*args, **kwargs)
e811c8ce 1153
aff4cc5c
RD
1154 def IsEmpty(*args, **kwargs):
1155 """IsEmpty(self) -> bool"""
1156 return _core_.Rect_IsEmpty(*args, **kwargs)
1157
c9c7117a 1158 def GetTopLeft(*args, **kwargs):
a95a7133 1159 """GetTopLeft(self) -> Point"""
54f9ee45 1160 return _core_.Rect_GetTopLeft(*args, **kwargs)
c9c7117a
RD
1161
1162 def SetTopLeft(*args, **kwargs):
a95a7133 1163 """SetTopLeft(self, Point p)"""
54f9ee45 1164 return _core_.Rect_SetTopLeft(*args, **kwargs)
c9c7117a
RD
1165
1166 def GetBottomRight(*args, **kwargs):
a95a7133 1167 """GetBottomRight(self) -> Point"""
54f9ee45 1168 return _core_.Rect_GetBottomRight(*args, **kwargs)
c9c7117a
RD
1169
1170 def SetBottomRight(*args, **kwargs):
a95a7133 1171 """SetBottomRight(self, Point p)"""
54f9ee45 1172 return _core_.Rect_SetBottomRight(*args, **kwargs)
c9c7117a 1173
e811c8ce 1174 def GetLeft(*args, **kwargs):
a95a7133 1175 """GetLeft(self) -> int"""
54f9ee45 1176 return _core_.Rect_GetLeft(*args, **kwargs)
e811c8ce
RD
1177
1178 def GetTop(*args, **kwargs):
a95a7133 1179 """GetTop(self) -> int"""
54f9ee45 1180 return _core_.Rect_GetTop(*args, **kwargs)
e811c8ce
RD
1181
1182 def GetBottom(*args, **kwargs):
a95a7133 1183 """GetBottom(self) -> int"""
54f9ee45 1184 return _core_.Rect_GetBottom(*args, **kwargs)
e811c8ce
RD
1185
1186 def GetRight(*args, **kwargs):
a95a7133 1187 """GetRight(self) -> int"""
54f9ee45 1188 return _core_.Rect_GetRight(*args, **kwargs)
e811c8ce
RD
1189
1190 def SetLeft(*args, **kwargs):
a95a7133 1191 """SetLeft(self, int left)"""
54f9ee45 1192 return _core_.Rect_SetLeft(*args, **kwargs)
e811c8ce
RD
1193
1194 def SetRight(*args, **kwargs):
a95a7133 1195 """SetRight(self, int right)"""
54f9ee45 1196 return _core_.Rect_SetRight(*args, **kwargs)
e811c8ce
RD
1197
1198 def SetTop(*args, **kwargs):
a95a7133 1199 """SetTop(self, int top)"""
54f9ee45 1200 return _core_.Rect_SetTop(*args, **kwargs)
e811c8ce
RD
1201
1202 def SetBottom(*args, **kwargs):
a95a7133 1203 """SetBottom(self, int bottom)"""
54f9ee45 1204 return _core_.Rect_SetBottom(*args, **kwargs)
e811c8ce
RD
1205
1206 position = property(GetPosition, SetPosition)
1207 size = property(GetSize, SetSize)
1208 left = property(GetLeft, SetLeft)
1209 right = property(GetRight, SetRight)
1210 top = property(GetTop, SetTop)
1211 bottom = property(GetBottom, SetBottom)
1212
1213 def Inflate(*args, **kwargs):
0df68c9f 1214 """
a95a7133 1215 Inflate(self, int dx, int dy) -> Rect
e811c8ce 1216
8e738329
RD
1217 Increases the size of the rectangle.
1218
1219 The left border is moved farther left and the right border is moved
1220 farther right by ``dx``. The upper border is moved farther up and the
1221 bottom border is moved farther down by ``dy``. (Note the the width and
1222 height of the rectangle thus change by ``2*dx`` and ``2*dy``,
1223 respectively.) If one or both of ``dx`` and ``dy`` are negative, the
1224 opposite happens: the rectangle size decreases in the respective
1225 direction.
1226
1227 The change is made to the rectangle inplace, if instead you need a
1228 copy that is inflated, preserving the original then make the copy
1229 first::
1230
1231 copy = wx.Rect(*original)
1232 copy.Inflate(10,15)
1233
1234
0df68c9f 1235 """
54f9ee45 1236 return _core_.Rect_Inflate(*args, **kwargs)
e811c8ce
RD
1237
1238 def Deflate(*args, **kwargs):
0df68c9f 1239 """
a95a7133 1240 Deflate(self, int dx, int dy) -> Rect
e811c8ce 1241
8e738329
RD
1242 Decrease the rectangle size. This method is the opposite of `Inflate`
1243 in that Deflate(a,b) is equivalent to Inflate(-a,-b). Please refer to
1244 `Inflate` for a full description.
0df68c9f 1245 """
54f9ee45 1246 return _core_.Rect_Deflate(*args, **kwargs)
e811c8ce
RD
1247
1248 def OffsetXY(*args, **kwargs):
0df68c9f 1249 """
a95a7133 1250 OffsetXY(self, int dx, int dy)
e811c8ce 1251
41e2b43e
RD
1252 Moves the rectangle by the specified offset. If dx is positive, the
1253 rectangle is moved to the right, if dy is positive, it is moved to the
1254 bottom, otherwise it is moved to the left or top respectively.
0df68c9f 1255 """
54f9ee45 1256 return _core_.Rect_OffsetXY(*args, **kwargs)
e811c8ce
RD
1257
1258 def Offset(*args, **kwargs):
0df68c9f 1259 """
a95a7133 1260 Offset(self, Point pt)
e811c8ce 1261
0df68c9f
RD
1262 Same as OffsetXY but uses dx,dy from Point
1263 """
54f9ee45 1264 return _core_.Rect_Offset(*args, **kwargs)
e811c8ce
RD
1265
1266 def Intersect(*args, **kwargs):
0df68c9f 1267 """
a95a7133 1268 Intersect(self, Rect rect) -> Rect
e811c8ce 1269
5cbf236d 1270 Returns the intersectsion of this rectangle and rect.
0df68c9f 1271 """
54f9ee45 1272 return _core_.Rect_Intersect(*args, **kwargs)
e811c8ce 1273
5cbf236d
RD
1274 def Union(*args, **kwargs):
1275 """
1276 Union(self, Rect rect) -> Rect
1277
1278 Returns the union of this rectangle and rect.
1279 """
1280 return _core_.Rect_Union(*args, **kwargs)
1281
e811c8ce 1282 def __add__(*args, **kwargs):
0df68c9f 1283 """
a95a7133 1284 __add__(self, Rect rect) -> Rect
e811c8ce 1285
0df68c9f
RD
1286 Add the properties of rect to this rectangle and return the result.
1287 """
54f9ee45 1288 return _core_.Rect___add__(*args, **kwargs)
e811c8ce
RD
1289
1290 def __iadd__(*args, **kwargs):
0df68c9f 1291 """
a95a7133 1292 __iadd__(self, Rect rect) -> Rect
e811c8ce 1293
0df68c9f
RD
1294 Add the properties of rect to this rectangle, updating this rectangle.
1295 """
54f9ee45 1296 return _core_.Rect___iadd__(*args, **kwargs)
e811c8ce
RD
1297
1298 def __eq__(*args, **kwargs):
0df68c9f 1299 """
a95a7133 1300 __eq__(self, Rect rect) -> bool
e811c8ce 1301
0df68c9f
RD
1302 Test for equality.
1303 """
54f9ee45 1304 return _core_.Rect___eq__(*args, **kwargs)
e811c8ce
RD
1305
1306 def __ne__(*args, **kwargs):
0df68c9f 1307 """
a95a7133 1308 __ne__(self, Rect rect) -> bool
e811c8ce 1309
0df68c9f
RD
1310 Test for inequality.
1311 """
54f9ee45 1312 return _core_.Rect___ne__(*args, **kwargs)
e811c8ce
RD
1313
1314 def InsideXY(*args, **kwargs):
0df68c9f 1315 """
a95a7133 1316 InsideXY(self, int x, int y) -> bool
e811c8ce 1317
0df68c9f
RD
1318 Return True if the point is (not strcitly) inside the rect.
1319 """
54f9ee45 1320 return _core_.Rect_InsideXY(*args, **kwargs)
e811c8ce
RD
1321
1322 def Inside(*args, **kwargs):
0df68c9f 1323 """
a95a7133 1324 Inside(self, Point pt) -> bool
e811c8ce 1325
0df68c9f
RD
1326 Return True if the point is (not strcitly) inside the rect.
1327 """
54f9ee45 1328 return _core_.Rect_Inside(*args, **kwargs)
e811c8ce
RD
1329
1330 def Intersects(*args, **kwargs):
0df68c9f 1331 """
a95a7133 1332 Intersects(self, Rect rect) -> bool
e811c8ce 1333
0df68c9f
RD
1334 Returns True if the rectangles have a non empty intersection.
1335 """
54f9ee45 1336 return _core_.Rect_Intersects(*args, **kwargs)
e811c8ce 1337
54f9ee45
RD
1338 x = property(_core_.Rect_x_get, _core_.Rect_x_set)
1339 y = property(_core_.Rect_y_get, _core_.Rect_y_set)
1340 width = property(_core_.Rect_width_get, _core_.Rect_width_set)
1341 height = property(_core_.Rect_height_get, _core_.Rect_height_set)
e811c8ce 1342 def Set(*args, **kwargs):
0df68c9f 1343 """
a95a7133 1344 Set(self, int x=0, int y=0, int width=0, int height=0)
e811c8ce 1345
0df68c9f
RD
1346 Set all rectangle properties.
1347 """
54f9ee45 1348 return _core_.Rect_Set(*args, **kwargs)
e811c8ce
RD
1349
1350 def Get(*args, **kwargs):
0df68c9f
RD
1351 """
1352 Get() -> (x,y,width,height)
e811c8ce 1353
0df68c9f
RD
1354 Return the rectangle properties as a tuple.
1355 """
54f9ee45 1356 return _core_.Rect_Get(*args, **kwargs)
e811c8ce 1357
41e2b43e 1358 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
e811c8ce
RD
1359 def __str__(self): return str(self.Get())
1360 def __repr__(self): return 'wx.Rect'+str(self.Get())
1361 def __len__(self): return len(self.Get())
1362 def __getitem__(self, index): return self.Get()[index]
d14a1e28
RD
1363 def __setitem__(self, index, val):
1364 if index == 0: self.x = val
1365 elif index == 1: self.y = val
1366 elif index == 2: self.width = val
1367 elif index == 3: self.height = val
1368 else: raise IndexError
e811c8ce 1369 def __nonzero__(self): return self.Get() != (0,0,0,0)
74e96f3d
RD
1370 __safe_for_unpickling__ = True
1371 def __reduce__(self): return (wx.Rect, self.Get())
d14a1e28
RD
1372
1373
1374class RectPtr(Rect):
1375 def __init__(self, this):
1376 self.this = this
1377 if not hasattr(self,"thisown"): self.thisown = 0
1378 self.__class__ = Rect
54f9ee45 1379_core_.Rect_swigregister(RectPtr)
d14a1e28
RD
1380
1381def RectPP(*args, **kwargs):
0df68c9f
RD
1382 """
1383 RectPP(Point topLeft, Point bottomRight) -> Rect
e811c8ce 1384
0df68c9f
RD
1385 Create a new Rect object from Points representing two corners.
1386 """
54f9ee45 1387 val = _core_.new_RectPP(*args, **kwargs)
d14a1e28
RD
1388 val.thisown = 1
1389 return val
1390
1391def RectPS(*args, **kwargs):
0df68c9f
RD
1392 """
1393 RectPS(Point pos, Size size) -> Rect
e811c8ce 1394
0df68c9f
RD
1395 Create a new Rect from a position and size.
1396 """
54f9ee45 1397 val = _core_.new_RectPS(*args, **kwargs)
d14a1e28
RD
1398 val.thisown = 1
1399 return val
1400
d3b6e4ff
RD
1401def RectS(*args, **kwargs):
1402 """
1403 RectS(Size size) -> Rect
1404
1405 Create a new Rect from a size only.
1406 """
1407 val = _core_.new_RectS(*args, **kwargs)
1408 val.thisown = 1
1409 return val
1410
d14a1e28 1411
e811c8ce 1412def IntersectRect(*args, **kwargs):
0df68c9f
RD
1413 """
1414 IntersectRect(Rect r1, Rect r2) -> Rect
e811c8ce 1415
0df68c9f
RD
1416 Calculate and return the intersection of r1 and r2.
1417 """
54f9ee45 1418 return _core_.IntersectRect(*args, **kwargs)
d14a1e28
RD
1419#---------------------------------------------------------------------------
1420
1421class Point2D(object):
41e2b43e
RD
1422 """
1423 wx.Point2Ds represent a point or a vector in a 2d coordinate system
1424 with floating point values.
1425 """
e811c8ce
RD
1426 def __repr__(self):
1427 return "<%s.%s; proxy of C++ wxPoint2D instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 1428 def __init__(self, *args, **kwargs):
0df68c9f 1429 """
a95a7133 1430 __init__(self, double x=0.0, double y=0.0) -> Point2D
e811c8ce 1431
0df68c9f
RD
1432 Create a w.Point2D object.
1433 """
54f9ee45 1434 newobj = _core_.new_Point2D(*args, **kwargs)
d14a1e28
RD
1435 self.this = newobj.this
1436 self.thisown = 1
1437 del newobj.thisown
e811c8ce 1438 def GetFloor(*args, **kwargs):
fd2dc343
RD
1439 """
1440 GetFloor() -> (x,y)
1441
1442 Convert to integer
1443 """
54f9ee45 1444 return _core_.Point2D_GetFloor(*args, **kwargs)
e811c8ce
RD
1445
1446 def GetRounded(*args, **kwargs):
fd2dc343
RD
1447 """
1448 GetRounded() -> (x,y)
1449
1450 Convert to integer
1451 """
54f9ee45 1452 return _core_.Point2D_GetRounded(*args, **kwargs)
e811c8ce
RD
1453
1454 def GetVectorLength(*args, **kwargs):
a95a7133 1455 """GetVectorLength(self) -> double"""
54f9ee45 1456 return _core_.Point2D_GetVectorLength(*args, **kwargs)
e811c8ce
RD
1457
1458 def GetVectorAngle(*args, **kwargs):
a95a7133 1459 """GetVectorAngle(self) -> double"""
54f9ee45 1460 return _core_.Point2D_GetVectorAngle(*args, **kwargs)
e811c8ce
RD
1461
1462 def SetVectorLength(*args, **kwargs):
a95a7133 1463 """SetVectorLength(self, double length)"""
54f9ee45 1464 return _core_.Point2D_SetVectorLength(*args, **kwargs)
e811c8ce
RD
1465
1466 def SetVectorAngle(*args, **kwargs):
a95a7133 1467 """SetVectorAngle(self, double degrees)"""
54f9ee45 1468 return _core_.Point2D_SetVectorAngle(*args, **kwargs)
e811c8ce 1469
d14a1e28
RD
1470 def SetPolarCoordinates(self, angle, length):
1471 self.SetVectorLength(length)
1472 self.SetVectorAngle(angle)
1473 def Normalize(self):
1474 self.SetVectorLength(1.0)
1475
e811c8ce 1476 def GetDistance(*args, **kwargs):
a95a7133 1477 """GetDistance(self, Point2D pt) -> double"""
54f9ee45 1478 return _core_.Point2D_GetDistance(*args, **kwargs)
e811c8ce
RD
1479
1480 def GetDistanceSquare(*args, **kwargs):
a95a7133 1481 """GetDistanceSquare(self, Point2D pt) -> double"""
54f9ee45 1482 return _core_.Point2D_GetDistanceSquare(*args, **kwargs)
e811c8ce
RD
1483
1484 def GetDotProduct(*args, **kwargs):
a95a7133 1485 """GetDotProduct(self, Point2D vec) -> double"""
54f9ee45 1486 return _core_.Point2D_GetDotProduct(*args, **kwargs)
e811c8ce
RD
1487
1488 def GetCrossProduct(*args, **kwargs):
a95a7133 1489 """GetCrossProduct(self, Point2D vec) -> double"""
54f9ee45 1490 return _core_.Point2D_GetCrossProduct(*args, **kwargs)
e811c8ce
RD
1491
1492 def __neg__(*args, **kwargs):
0df68c9f 1493 """
a95a7133 1494 __neg__(self) -> Point2D
e811c8ce 1495
0df68c9f
RD
1496 the reflection of this point
1497 """
54f9ee45 1498 return _core_.Point2D___neg__(*args, **kwargs)
e811c8ce
RD
1499
1500 def __iadd__(*args, **kwargs):
a95a7133 1501 """__iadd__(self, Point2D pt) -> Point2D"""
54f9ee45 1502 return _core_.Point2D___iadd__(*args, **kwargs)
e811c8ce
RD
1503
1504 def __isub__(*args, **kwargs):
a95a7133 1505 """__isub__(self, Point2D pt) -> Point2D"""
54f9ee45 1506 return _core_.Point2D___isub__(*args, **kwargs)
e811c8ce
RD
1507
1508 def __imul__(*args, **kwargs):
a95a7133 1509 """__imul__(self, Point2D pt) -> Point2D"""
54f9ee45 1510 return _core_.Point2D___imul__(*args, **kwargs)
e811c8ce
RD
1511
1512 def __idiv__(*args, **kwargs):
a95a7133 1513 """__idiv__(self, Point2D pt) -> Point2D"""
54f9ee45 1514 return _core_.Point2D___idiv__(*args, **kwargs)
e811c8ce
RD
1515
1516 def __eq__(*args, **kwargs):
0df68c9f 1517 """
a95a7133 1518 __eq__(self, Point2D pt) -> bool
e811c8ce 1519
0df68c9f
RD
1520 Test for equality
1521 """
54f9ee45 1522 return _core_.Point2D___eq__(*args, **kwargs)
e811c8ce
RD
1523
1524 def __ne__(*args, **kwargs):
0df68c9f 1525 """
a95a7133 1526 __ne__(self, Point2D pt) -> bool
e811c8ce 1527
0df68c9f
RD
1528 Test for inequality
1529 """
54f9ee45 1530 return _core_.Point2D___ne__(*args, **kwargs)
e811c8ce 1531
54f9ee45
RD
1532 x = property(_core_.Point2D_x_get, _core_.Point2D_x_set)
1533 y = property(_core_.Point2D_y_get, _core_.Point2D_y_set)
e811c8ce 1534 def Set(*args, **kwargs):
a95a7133 1535 """Set(self, double x=0, double y=0)"""
54f9ee45 1536 return _core_.Point2D_Set(*args, **kwargs)
e811c8ce
RD
1537
1538 def Get(*args, **kwargs):
0df68c9f
RD
1539 """
1540 Get() -> (x,y)
e811c8ce 1541
0df68c9f
RD
1542 Return x and y properties as a tuple.
1543 """
54f9ee45 1544 return _core_.Point2D_Get(*args, **kwargs)
e811c8ce 1545
41e2b43e 1546 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
e811c8ce
RD
1547 def __str__(self): return str(self.Get())
1548 def __repr__(self): return 'wx.Point2D'+str(self.Get())
1549 def __len__(self): return len(self.Get())
1550 def __getitem__(self, index): return self.Get()[index]
d14a1e28 1551 def __setitem__(self, index, val):
e811c8ce
RD
1552 if index == 0: self.x = val
1553 elif index == 1: self.y = val
d14a1e28 1554 else: raise IndexError
e811c8ce 1555 def __nonzero__(self): return self.Get() != (0.0, 0.0)
74e96f3d
RD
1556 __safe_for_unpickling__ = True
1557 def __reduce__(self): return (wx.Point2D, self.Get())
d14a1e28
RD
1558
1559
1560class Point2DPtr(Point2D):
1561 def __init__(self, this):
1562 self.this = this
1563 if not hasattr(self,"thisown"): self.thisown = 0
1564 self.__class__ = Point2D
54f9ee45 1565_core_.Point2D_swigregister(Point2DPtr)
d14a1e28
RD
1566
1567def Point2DCopy(*args, **kwargs):
0df68c9f
RD
1568 """
1569 Point2DCopy(Point2D pt) -> Point2D
e811c8ce 1570
0df68c9f
RD
1571 Create a w.Point2D object.
1572 """
54f9ee45 1573 val = _core_.new_Point2DCopy(*args, **kwargs)
d14a1e28
RD
1574 val.thisown = 1
1575 return val
1576
1577def Point2DFromPoint(*args, **kwargs):
0df68c9f
RD
1578 """
1579 Point2DFromPoint(Point pt) -> Point2D
e811c8ce 1580
0df68c9f
RD
1581 Create a w.Point2D object.
1582 """
54f9ee45 1583 val = _core_.new_Point2DFromPoint(*args, **kwargs)
d14a1e28
RD
1584 val.thisown = 1
1585 return val
1586
1587#---------------------------------------------------------------------------
1588
54f9ee45
RD
1589FromStart = _core_.FromStart
1590FromCurrent = _core_.FromCurrent
1591FromEnd = _core_.FromEnd
d14a1e28 1592class InputStream(object):
093d3ff1 1593 """Proxy of C++ InputStream class"""
e811c8ce
RD
1594 def __repr__(self):
1595 return "<%s.%s; proxy of C++ wxPyInputStream instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 1596 def __init__(self, *args, **kwargs):
a95a7133 1597 """__init__(self, PyObject p) -> InputStream"""
54f9ee45 1598 newobj = _core_.new_InputStream(*args, **kwargs)
d14a1e28
RD
1599 self.this = newobj.this
1600 self.thisown = 1
1601 del newobj.thisown
8fb0e70a
RD
1602 def __del__(self, destroy=_core_.delete_InputStream):
1603 """__del__(self)"""
1604 try:
1605 if self.thisown: destroy(self)
1606 except: pass
1607
e811c8ce 1608 def close(*args, **kwargs):
a95a7133 1609 """close(self)"""
54f9ee45 1610 return _core_.InputStream_close(*args, **kwargs)
e811c8ce
RD
1611
1612 def flush(*args, **kwargs):
a95a7133 1613 """flush(self)"""
54f9ee45 1614 return _core_.InputStream_flush(*args, **kwargs)
e811c8ce
RD
1615
1616 def eof(*args, **kwargs):
a95a7133 1617 """eof(self) -> bool"""
54f9ee45 1618 return _core_.InputStream_eof(*args, **kwargs)
e811c8ce
RD
1619
1620 def read(*args, **kwargs):
a95a7133 1621 """read(self, int size=-1) -> PyObject"""
54f9ee45 1622 return _core_.InputStream_read(*args, **kwargs)
e811c8ce
RD
1623
1624 def readline(*args, **kwargs):
a95a7133 1625 """readline(self, int size=-1) -> PyObject"""
54f9ee45 1626 return _core_.InputStream_readline(*args, **kwargs)
e811c8ce
RD
1627
1628 def readlines(*args, **kwargs):
a95a7133 1629 """readlines(self, int sizehint=-1) -> PyObject"""
54f9ee45 1630 return _core_.InputStream_readlines(*args, **kwargs)
e811c8ce
RD
1631
1632 def seek(*args, **kwargs):
a95a7133 1633 """seek(self, int offset, int whence=0)"""
54f9ee45 1634 return _core_.InputStream_seek(*args, **kwargs)
e811c8ce
RD
1635
1636 def tell(*args, **kwargs):
a95a7133 1637 """tell(self) -> int"""
54f9ee45 1638 return _core_.InputStream_tell(*args, **kwargs)
e811c8ce
RD
1639
1640 def Peek(*args, **kwargs):
a95a7133 1641 """Peek(self) -> char"""
54f9ee45 1642 return _core_.InputStream_Peek(*args, **kwargs)
e811c8ce
RD
1643
1644 def GetC(*args, **kwargs):
a95a7133 1645 """GetC(self) -> char"""
54f9ee45 1646 return _core_.InputStream_GetC(*args, **kwargs)
e811c8ce
RD
1647
1648 def LastRead(*args, **kwargs):
a95a7133 1649 """LastRead(self) -> size_t"""
54f9ee45 1650 return _core_.InputStream_LastRead(*args, **kwargs)
e811c8ce
RD
1651
1652 def CanRead(*args, **kwargs):
a95a7133 1653 """CanRead(self) -> bool"""
54f9ee45 1654 return _core_.InputStream_CanRead(*args, **kwargs)
e811c8ce
RD
1655
1656 def Eof(*args, **kwargs):
a95a7133 1657 """Eof(self) -> bool"""
54f9ee45 1658 return _core_.InputStream_Eof(*args, **kwargs)
e811c8ce
RD
1659
1660 def Ungetch(*args, **kwargs):
a95a7133 1661 """Ungetch(self, char c) -> bool"""
54f9ee45 1662 return _core_.InputStream_Ungetch(*args, **kwargs)
e811c8ce
RD
1663
1664 def SeekI(*args, **kwargs):
a95a7133 1665 """SeekI(self, long pos, int mode=FromStart) -> long"""
54f9ee45 1666 return _core_.InputStream_SeekI(*args, **kwargs)
e811c8ce
RD
1667
1668 def TellI(*args, **kwargs):
a95a7133 1669 """TellI(self) -> long"""
54f9ee45 1670 return _core_.InputStream_TellI(*args, **kwargs)
e811c8ce 1671
d14a1e28
RD
1672
1673class InputStreamPtr(InputStream):
1674 def __init__(self, this):
1675 self.this = this
1676 if not hasattr(self,"thisown"): self.thisown = 0
1677 self.__class__ = InputStream
54f9ee45 1678_core_.InputStream_swigregister(InputStreamPtr)
d14a1e28
RD
1679DefaultPosition = cvar.DefaultPosition
1680DefaultSize = cvar.DefaultSize
1681
1682class OutputStream(object):
093d3ff1 1683 """Proxy of C++ OutputStream class"""
d14a1e28
RD
1684 def __init__(self): raise RuntimeError, "No constructor defined"
1685 def __repr__(self):
1686 return "<%s.%s; proxy of C++ wxOutputStream instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
e811c8ce 1687 def write(*args, **kwargs):
a95a7133 1688 """write(self, PyObject obj)"""
54f9ee45 1689 return _core_.OutputStream_write(*args, **kwargs)
e811c8ce 1690
d14a1e28
RD
1691
1692class OutputStreamPtr(OutputStream):
1693 def __init__(self, this):
1694 self.this = this
1695 if not hasattr(self,"thisown"): self.thisown = 0
1696 self.__class__ = OutputStream
54f9ee45 1697_core_.OutputStream_swigregister(OutputStreamPtr)
d14a1e28
RD
1698
1699#---------------------------------------------------------------------------
1700
1701class FSFile(Object):
093d3ff1 1702 """Proxy of C++ FSFile class"""
e811c8ce
RD
1703 def __repr__(self):
1704 return "<%s.%s; proxy of C++ wxFSFile instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 1705 def __init__(self, *args, **kwargs):
0df68c9f 1706 """
a95a7133 1707 __init__(self, InputStream stream, String loc, String mimetype, String anchor,
196addbf 1708 DateTime modif) -> FSFile
0df68c9f 1709 """
54f9ee45 1710 newobj = _core_.new_FSFile(*args, **kwargs)
d14a1e28
RD
1711 self.this = newobj.this
1712 self.thisown = 1
1713 del newobj.thisown
e2950dbb 1714 self.thisown = 0 # It will normally be deleted by the user of the wx.FileSystem
4cf4100f 1715
54f9ee45 1716 def __del__(self, destroy=_core_.delete_FSFile):
a95a7133 1717 """__del__(self)"""
d14a1e28
RD
1718 try:
1719 if self.thisown: destroy(self)
1720 except: pass
e811c8ce
RD
1721
1722 def GetStream(*args, **kwargs):
a95a7133 1723 """GetStream(self) -> InputStream"""
54f9ee45 1724 return _core_.FSFile_GetStream(*args, **kwargs)
e811c8ce
RD
1725
1726 def GetMimeType(*args, **kwargs):
a95a7133 1727 """GetMimeType(self) -> String"""
54f9ee45 1728 return _core_.FSFile_GetMimeType(*args, **kwargs)
e811c8ce
RD
1729
1730 def GetLocation(*args, **kwargs):
a95a7133 1731 """GetLocation(self) -> String"""
54f9ee45 1732 return _core_.FSFile_GetLocation(*args, **kwargs)
e811c8ce
RD
1733
1734 def GetAnchor(*args, **kwargs):
a95a7133 1735 """GetAnchor(self) -> String"""
54f9ee45 1736 return _core_.FSFile_GetAnchor(*args, **kwargs)
e811c8ce
RD
1737
1738 def GetModificationTime(*args, **kwargs):
a95a7133 1739 """GetModificationTime(self) -> DateTime"""
54f9ee45 1740 return _core_.FSFile_GetModificationTime(*args, **kwargs)
e811c8ce 1741
d14a1e28
RD
1742
1743class FSFilePtr(FSFile):
1744 def __init__(self, this):
1745 self.this = this
1746 if not hasattr(self,"thisown"): self.thisown = 0
1747 self.__class__ = FSFile
54f9ee45 1748_core_.FSFile_swigregister(FSFilePtr)
d14a1e28
RD
1749
1750class CPPFileSystemHandler(object):
093d3ff1 1751 """Proxy of C++ CPPFileSystemHandler class"""
d14a1e28
RD
1752 def __init__(self): raise RuntimeError, "No constructor defined"
1753 def __repr__(self):
1754 return "<%s.%s; proxy of C++ wxFileSystemHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1755
1756class CPPFileSystemHandlerPtr(CPPFileSystemHandler):
1757 def __init__(self, this):
1758 self.this = this
1759 if not hasattr(self,"thisown"): self.thisown = 0
1760 self.__class__ = CPPFileSystemHandler
54f9ee45 1761_core_.CPPFileSystemHandler_swigregister(CPPFileSystemHandlerPtr)
d14a1e28
RD
1762
1763class FileSystemHandler(CPPFileSystemHandler):
093d3ff1 1764 """Proxy of C++ FileSystemHandler class"""
e811c8ce
RD
1765 def __repr__(self):
1766 return "<%s.%s; proxy of C++ wxPyFileSystemHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 1767 def __init__(self, *args, **kwargs):
a95a7133 1768 """__init__(self) -> FileSystemHandler"""
54f9ee45 1769 newobj = _core_.new_FileSystemHandler(*args, **kwargs)
d14a1e28
RD
1770 self.this = newobj.this
1771 self.thisown = 1
1772 del newobj.thisown
1773 self._setCallbackInfo(self, FileSystemHandler)
e811c8ce
RD
1774
1775 def _setCallbackInfo(*args, **kwargs):
a95a7133 1776 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
54f9ee45 1777 return _core_.FileSystemHandler__setCallbackInfo(*args, **kwargs)
e811c8ce
RD
1778
1779 def CanOpen(*args, **kwargs):
a95a7133 1780 """CanOpen(self, String location) -> bool"""
54f9ee45 1781 return _core_.FileSystemHandler_CanOpen(*args, **kwargs)
e811c8ce
RD
1782
1783 def OpenFile(*args, **kwargs):
a95a7133 1784 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
54f9ee45 1785 return _core_.FileSystemHandler_OpenFile(*args, **kwargs)
e811c8ce
RD
1786
1787 def FindFirst(*args, **kwargs):
a95a7133 1788 """FindFirst(self, String spec, int flags=0) -> String"""
54f9ee45 1789 return _core_.FileSystemHandler_FindFirst(*args, **kwargs)
e811c8ce
RD
1790
1791 def FindNext(*args, **kwargs):
a95a7133 1792 """FindNext(self) -> String"""
54f9ee45 1793 return _core_.FileSystemHandler_FindNext(*args, **kwargs)
e811c8ce
RD
1794
1795 def GetProtocol(*args, **kwargs):
a95a7133 1796 """GetProtocol(self, String location) -> String"""
54f9ee45 1797 return _core_.FileSystemHandler_GetProtocol(*args, **kwargs)
e811c8ce
RD
1798
1799 def GetLeftLocation(*args, **kwargs):
a95a7133 1800 """GetLeftLocation(self, String location) -> String"""
54f9ee45 1801 return _core_.FileSystemHandler_GetLeftLocation(*args, **kwargs)
e811c8ce
RD
1802
1803 def GetAnchor(*args, **kwargs):
a95a7133 1804 """GetAnchor(self, String location) -> String"""
54f9ee45 1805 return _core_.FileSystemHandler_GetAnchor(*args, **kwargs)
e811c8ce
RD
1806
1807 def GetRightLocation(*args, **kwargs):
a95a7133 1808 """GetRightLocation(self, String location) -> String"""
54f9ee45 1809 return _core_.FileSystemHandler_GetRightLocation(*args, **kwargs)
e811c8ce
RD
1810
1811 def GetMimeTypeFromExt(*args, **kwargs):
a95a7133 1812 """GetMimeTypeFromExt(self, String location) -> String"""
54f9ee45 1813 return _core_.FileSystemHandler_GetMimeTypeFromExt(*args, **kwargs)
e811c8ce 1814
d14a1e28
RD
1815
1816class FileSystemHandlerPtr(FileSystemHandler):
1817 def __init__(self, this):
1818 self.this = this
1819 if not hasattr(self,"thisown"): self.thisown = 0
1820 self.__class__ = FileSystemHandler
54f9ee45 1821_core_.FileSystemHandler_swigregister(FileSystemHandlerPtr)
d14a1e28
RD
1822
1823class FileSystem(Object):
093d3ff1 1824 """Proxy of C++ FileSystem class"""
e811c8ce
RD
1825 def __repr__(self):
1826 return "<%s.%s; proxy of C++ wxFileSystem instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 1827 def __init__(self, *args, **kwargs):
a95a7133 1828 """__init__(self) -> FileSystem"""
54f9ee45 1829 newobj = _core_.new_FileSystem(*args, **kwargs)
d14a1e28
RD
1830 self.this = newobj.this
1831 self.thisown = 1
1832 del newobj.thisown
54f9ee45 1833 def __del__(self, destroy=_core_.delete_FileSystem):
a95a7133 1834 """__del__(self)"""
d14a1e28
RD
1835 try:
1836 if self.thisown: destroy(self)
1837 except: pass
e811c8ce
RD
1838
1839 def ChangePathTo(*args, **kwargs):
a95a7133 1840 """ChangePathTo(self, String location, bool is_dir=False)"""
54f9ee45 1841 return _core_.FileSystem_ChangePathTo(*args, **kwargs)
e811c8ce
RD
1842
1843 def GetPath(*args, **kwargs):
a95a7133 1844 """GetPath(self) -> String"""
54f9ee45 1845 return _core_.FileSystem_GetPath(*args, **kwargs)
e811c8ce
RD
1846
1847 def OpenFile(*args, **kwargs):
a95a7133 1848 """OpenFile(self, String location) -> FSFile"""
54f9ee45 1849 return _core_.FileSystem_OpenFile(*args, **kwargs)
e811c8ce
RD
1850
1851 def FindFirst(*args, **kwargs):
a95a7133 1852 """FindFirst(self, String spec, int flags=0) -> String"""
54f9ee45 1853 return _core_.FileSystem_FindFirst(*args, **kwargs)
e811c8ce
RD
1854
1855 def FindNext(*args, **kwargs):
a95a7133 1856 """FindNext(self) -> String"""
54f9ee45 1857 return _core_.FileSystem_FindNext(*args, **kwargs)
e811c8ce
RD
1858
1859 def AddHandler(*args, **kwargs):
66c033b4 1860 """AddHandler(CPPFileSystemHandler handler)"""
54f9ee45 1861 return _core_.FileSystem_AddHandler(*args, **kwargs)
e811c8ce
RD
1862
1863 AddHandler = staticmethod(AddHandler)
1864 def CleanUpHandlers(*args, **kwargs):
66c033b4 1865 """CleanUpHandlers()"""
54f9ee45 1866 return _core_.FileSystem_CleanUpHandlers(*args, **kwargs)
e811c8ce
RD
1867
1868 CleanUpHandlers = staticmethod(CleanUpHandlers)
1869 def FileNameToURL(*args, **kwargs):
66c033b4 1870 """FileNameToURL(String filename) -> String"""
54f9ee45 1871 return _core_.FileSystem_FileNameToURL(*args, **kwargs)
e811c8ce
RD
1872
1873 FileNameToURL = staticmethod(FileNameToURL)
2ef75293
RD
1874 def URLToFileName(*args, **kwargs):
1875 """URLToFileName(String url) -> String"""
1876 return _core_.FileSystem_URLToFileName(*args, **kwargs)
1877
1878 URLToFileName = staticmethod(URLToFileName)
d14a1e28
RD
1879
1880class FileSystemPtr(FileSystem):
1881 def __init__(self, this):
1882 self.this = this
1883 if not hasattr(self,"thisown"): self.thisown = 0
1884 self.__class__ = FileSystem
54f9ee45 1885_core_.FileSystem_swigregister(FileSystemPtr)
d14a1e28 1886
e811c8ce
RD
1887def FileSystem_AddHandler(*args, **kwargs):
1888 """FileSystem_AddHandler(CPPFileSystemHandler handler)"""
54f9ee45 1889 return _core_.FileSystem_AddHandler(*args, **kwargs)
d14a1e28 1890
e811c8ce
RD
1891def FileSystem_CleanUpHandlers(*args, **kwargs):
1892 """FileSystem_CleanUpHandlers()"""
54f9ee45 1893 return _core_.FileSystem_CleanUpHandlers(*args, **kwargs)
d14a1e28 1894
e811c8ce 1895def FileSystem_FileNameToURL(*args, **kwargs):
196addbf 1896 """FileSystem_FileNameToURL(String filename) -> String"""
54f9ee45 1897 return _core_.FileSystem_FileNameToURL(*args, **kwargs)
d14a1e28 1898
e811c8ce 1899def FileSystem_URLToFileName(*args, **kwargs):
196addbf 1900 """FileSystem_URLToFileName(String url) -> String"""
54f9ee45 1901 return _core_.FileSystem_URLToFileName(*args, **kwargs)
2ef75293 1902
d14a1e28 1903class InternetFSHandler(CPPFileSystemHandler):
093d3ff1 1904 """Proxy of C++ InternetFSHandler class"""
e811c8ce
RD
1905 def __repr__(self):
1906 return "<%s.%s; proxy of C++ wxInternetFSHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 1907 def __init__(self, *args, **kwargs):
a95a7133 1908 """__init__(self) -> InternetFSHandler"""
54f9ee45 1909 newobj = _core_.new_InternetFSHandler(*args, **kwargs)
d14a1e28
RD
1910 self.this = newobj.this
1911 self.thisown = 1
1912 del newobj.thisown
e811c8ce 1913 def CanOpen(*args, **kwargs):
a95a7133 1914 """CanOpen(self, String location) -> bool"""
54f9ee45 1915 return _core_.InternetFSHandler_CanOpen(*args, **kwargs)
e811c8ce
RD
1916
1917 def OpenFile(*args, **kwargs):
a95a7133 1918 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
54f9ee45 1919 return _core_.InternetFSHandler_OpenFile(*args, **kwargs)
e811c8ce 1920
d14a1e28
RD
1921
1922class InternetFSHandlerPtr(InternetFSHandler):
1923 def __init__(self, this):
1924 self.this = this
1925 if not hasattr(self,"thisown"): self.thisown = 0
1926 self.__class__ = InternetFSHandler
54f9ee45 1927_core_.InternetFSHandler_swigregister(InternetFSHandlerPtr)
d14a1e28
RD
1928
1929class ZipFSHandler(CPPFileSystemHandler):
093d3ff1 1930 """Proxy of C++ ZipFSHandler class"""
e811c8ce
RD
1931 def __repr__(self):
1932 return "<%s.%s; proxy of C++ wxZipFSHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 1933 def __init__(self, *args, **kwargs):
a95a7133 1934 """__init__(self) -> ZipFSHandler"""
54f9ee45 1935 newobj = _core_.new_ZipFSHandler(*args, **kwargs)
d14a1e28
RD
1936 self.this = newobj.this
1937 self.thisown = 1
1938 del newobj.thisown
e811c8ce 1939 def CanOpen(*args, **kwargs):
a95a7133 1940 """CanOpen(self, String location) -> bool"""
54f9ee45 1941 return _core_.ZipFSHandler_CanOpen(*args, **kwargs)
e811c8ce
RD
1942
1943 def OpenFile(*args, **kwargs):
a95a7133 1944 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
54f9ee45 1945 return _core_.ZipFSHandler_OpenFile(*args, **kwargs)
e811c8ce
RD
1946
1947 def FindFirst(*args, **kwargs):
a95a7133 1948 """FindFirst(self, String spec, int flags=0) -> String"""
54f9ee45 1949 return _core_.ZipFSHandler_FindFirst(*args, **kwargs)
e811c8ce
RD
1950
1951 def FindNext(*args, **kwargs):
a95a7133 1952 """FindNext(self) -> String"""
54f9ee45 1953 return _core_.ZipFSHandler_FindNext(*args, **kwargs)
e811c8ce 1954
d14a1e28
RD
1955
1956class ZipFSHandlerPtr(ZipFSHandler):
1957 def __init__(self, this):
1958 self.this = this
1959 if not hasattr(self,"thisown"): self.thisown = 0
1960 self.__class__ = ZipFSHandler
54f9ee45 1961_core_.ZipFSHandler_swigregister(ZipFSHandlerPtr)
d14a1e28
RD
1962
1963
e811c8ce 1964def __wxMemoryFSHandler_AddFile_wxImage(*args, **kwargs):
196addbf 1965 """__wxMemoryFSHandler_AddFile_wxImage(String filename, Image image, long type)"""
54f9ee45 1966 return _core_.__wxMemoryFSHandler_AddFile_wxImage(*args, **kwargs)
d14a1e28 1967
e811c8ce 1968def __wxMemoryFSHandler_AddFile_wxBitmap(*args, **kwargs):
196addbf 1969 """__wxMemoryFSHandler_AddFile_wxBitmap(String filename, Bitmap bitmap, long type)"""
54f9ee45 1970 return _core_.__wxMemoryFSHandler_AddFile_wxBitmap(*args, **kwargs)
d14a1e28 1971
e811c8ce 1972def __wxMemoryFSHandler_AddFile_Data(*args, **kwargs):
196addbf 1973 """__wxMemoryFSHandler_AddFile_Data(String filename, PyObject data)"""
54f9ee45 1974 return _core_.__wxMemoryFSHandler_AddFile_Data(*args, **kwargs)
2ef75293
RD
1975def MemoryFSHandler_AddFile(filename, dataItem, imgType=-1):
1976 """
1977 Add 'file' to the memory filesystem. The dataItem parameter can
1978 either be a `wx.Bitmap`, `wx.Image` or a string that can contain
1979 arbitrary data. If a bitmap or image is used then the imgType
1980 parameter should specify what kind of image file it should be
1981 written as, wx.BITMAP_TYPE_PNG, etc.
1982 """
1983 if isinstance(dataItem, wx.Image):
1984 __wxMemoryFSHandler_AddFile_wxImage(filename, dataItem, imgType)
1985 elif isinstance(dataItem, wx.Bitmap):
1986 __wxMemoryFSHandler_AddFile_wxBitmap(filename, dataItem, imgType)
1987 elif type(dataItem) == str:
1988 __wxMemoryFSHandler_AddFile_Data(filename, dataItem)
1989 else:
1990 raise TypeError, 'wx.Image, wx.Bitmap or string expected'
d14a1e28
RD
1991
1992class MemoryFSHandler(CPPFileSystemHandler):
093d3ff1 1993 """Proxy of C++ MemoryFSHandler class"""
e811c8ce
RD
1994 def __repr__(self):
1995 return "<%s.%s; proxy of C++ wxMemoryFSHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 1996 def __init__(self, *args, **kwargs):
a95a7133 1997 """__init__(self) -> MemoryFSHandler"""
54f9ee45 1998 newobj = _core_.new_MemoryFSHandler(*args, **kwargs)
d14a1e28
RD
1999 self.this = newobj.this
2000 self.thisown = 1
2001 del newobj.thisown
e811c8ce 2002 def RemoveFile(*args, **kwargs):
66c033b4 2003 """RemoveFile(String filename)"""
54f9ee45 2004 return _core_.MemoryFSHandler_RemoveFile(*args, **kwargs)
e811c8ce
RD
2005
2006 RemoveFile = staticmethod(RemoveFile)
d14a1e28 2007 AddFile = staticmethod(MemoryFSHandler_AddFile)
e811c8ce 2008 def CanOpen(*args, **kwargs):
a95a7133 2009 """CanOpen(self, String location) -> bool"""
54f9ee45 2010 return _core_.MemoryFSHandler_CanOpen(*args, **kwargs)
e811c8ce
RD
2011
2012 def OpenFile(*args, **kwargs):
a95a7133 2013 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
54f9ee45 2014 return _core_.MemoryFSHandler_OpenFile(*args, **kwargs)
e811c8ce
RD
2015
2016 def FindFirst(*args, **kwargs):
a95a7133 2017 """FindFirst(self, String spec, int flags=0) -> String"""
54f9ee45 2018 return _core_.MemoryFSHandler_FindFirst(*args, **kwargs)
e811c8ce
RD
2019
2020 def FindNext(*args, **kwargs):
a95a7133 2021 """FindNext(self) -> String"""
54f9ee45 2022 return _core_.MemoryFSHandler_FindNext(*args, **kwargs)
e811c8ce 2023
d14a1e28
RD
2024
2025class MemoryFSHandlerPtr(MemoryFSHandler):
2026 def __init__(self, this):
2027 self.this = this
2028 if not hasattr(self,"thisown"): self.thisown = 0
2029 self.__class__ = MemoryFSHandler
54f9ee45 2030_core_.MemoryFSHandler_swigregister(MemoryFSHandlerPtr)
d14a1e28 2031
e811c8ce 2032def MemoryFSHandler_RemoveFile(*args, **kwargs):
196addbf 2033 """MemoryFSHandler_RemoveFile(String filename)"""
54f9ee45 2034 return _core_.MemoryFSHandler_RemoveFile(*args, **kwargs)
d14a1e28
RD
2035
2036#---------------------------------------------------------------------------
2037
2038class ImageHandler(Object):
093d3ff1 2039 """Proxy of C++ ImageHandler class"""
d14a1e28
RD
2040 def __init__(self): raise RuntimeError, "No constructor defined"
2041 def __repr__(self):
2042 return "<%s.%s; proxy of C++ wxImageHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
e811c8ce 2043 def GetName(*args, **kwargs):
a95a7133 2044 """GetName(self) -> String"""
54f9ee45 2045 return _core_.ImageHandler_GetName(*args, **kwargs)
e811c8ce
RD
2046
2047 def GetExtension(*args, **kwargs):
a95a7133 2048 """GetExtension(self) -> String"""
54f9ee45 2049 return _core_.ImageHandler_GetExtension(*args, **kwargs)
e811c8ce
RD
2050
2051 def GetType(*args, **kwargs):
a95a7133 2052 """GetType(self) -> long"""
54f9ee45 2053 return _core_.ImageHandler_GetType(*args, **kwargs)
e811c8ce
RD
2054
2055 def GetMimeType(*args, **kwargs):
a95a7133 2056 """GetMimeType(self) -> String"""
54f9ee45 2057 return _core_.ImageHandler_GetMimeType(*args, **kwargs)
e811c8ce
RD
2058
2059 def CanRead(*args, **kwargs):
a95a7133 2060 """CanRead(self, String name) -> bool"""
54f9ee45 2061 return _core_.ImageHandler_CanRead(*args, **kwargs)
e811c8ce
RD
2062
2063 def SetName(*args, **kwargs):
a95a7133 2064 """SetName(self, String name)"""
54f9ee45 2065 return _core_.ImageHandler_SetName(*args, **kwargs)
e811c8ce
RD
2066
2067 def SetExtension(*args, **kwargs):
a95a7133 2068 """SetExtension(self, String extension)"""
54f9ee45 2069 return _core_.ImageHandler_SetExtension(*args, **kwargs)
e811c8ce
RD
2070
2071 def SetType(*args, **kwargs):
a95a7133 2072 """SetType(self, long type)"""
54f9ee45 2073 return _core_.ImageHandler_SetType(*args, **kwargs)
e811c8ce
RD
2074
2075 def SetMimeType(*args, **kwargs):
a95a7133 2076 """SetMimeType(self, String mimetype)"""
54f9ee45 2077 return _core_.ImageHandler_SetMimeType(*args, **kwargs)
e811c8ce 2078
d14a1e28
RD
2079
2080class ImageHandlerPtr(ImageHandler):
2081 def __init__(self, this):
2082 self.this = this
2083 if not hasattr(self,"thisown"): self.thisown = 0
2084 self.__class__ = ImageHandler
54f9ee45 2085_core_.ImageHandler_swigregister(ImageHandlerPtr)
d14a1e28
RD
2086
2087class ImageHistogram(object):
093d3ff1 2088 """Proxy of C++ ImageHistogram class"""
e811c8ce
RD
2089 def __repr__(self):
2090 return "<%s.%s; proxy of C++ wxImageHistogram instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2091 def __init__(self, *args, **kwargs):
a95a7133 2092 """__init__(self) -> ImageHistogram"""
54f9ee45 2093 newobj = _core_.new_ImageHistogram(*args, **kwargs)
d14a1e28
RD
2094 self.this = newobj.this
2095 self.thisown = 1
2096 del newobj.thisown
e811c8ce 2097 def MakeKey(*args, **kwargs):
0df68c9f 2098 """
66c033b4 2099 MakeKey(unsigned char r, unsigned char g, unsigned char b) -> unsigned long
e811c8ce 2100
0df68c9f
RD
2101 Get the key in the histogram for the given RGB values
2102 """
54f9ee45 2103 return _core_.ImageHistogram_MakeKey(*args, **kwargs)
e811c8ce
RD
2104
2105 MakeKey = staticmethod(MakeKey)
2106 def FindFirstUnusedColour(*args, **kwargs):
fd2dc343
RD
2107 """
2108 FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)
2109
2110 Find first colour that is not used in the image and has higher RGB
2111 values than startR, startG, startB. Returns a tuple consisting of a
2112 success flag and rgb values.
2113 """
54f9ee45 2114 return _core_.ImageHistogram_FindFirstUnusedColour(*args, **kwargs)
e811c8ce 2115
f1cbd8fa
RD
2116 def GetCount(*args, **kwargs):
2117 """
2118 GetCount(self, unsigned long key) -> unsigned long
2119
2120 Returns the pixel count for the given key. Use `MakeKey` to create a
2121 key value from a RGB tripple.
2122 """
2123 return _core_.ImageHistogram_GetCount(*args, **kwargs)
2124
2125 def GetCountRGB(*args, **kwargs):
2126 """
2127 GetCountRGB(self, unsigned char r, unsigned char g, unsigned char b) -> unsigned long
2128
2129 Returns the pixel count for the given RGB values.
2130 """
2131 return _core_.ImageHistogram_GetCountRGB(*args, **kwargs)
2132
2133 def GetCountColour(*args, **kwargs):
2134 """
2135 GetCountColour(self, Colour colour) -> unsigned long
2136
2137 Returns the pixel count for the given `wx.Colour` value.
2138 """
2139 return _core_.ImageHistogram_GetCountColour(*args, **kwargs)
2140
d14a1e28
RD
2141
2142class ImageHistogramPtr(ImageHistogram):
2143 def __init__(self, this):
2144 self.this = this
2145 if not hasattr(self,"thisown"): self.thisown = 0
2146 self.__class__ = ImageHistogram
54f9ee45 2147_core_.ImageHistogram_swigregister(ImageHistogramPtr)
d14a1e28 2148
e811c8ce 2149def ImageHistogram_MakeKey(*args, **kwargs):
0df68c9f
RD
2150 """
2151 ImageHistogram_MakeKey(unsigned char r, unsigned char g, unsigned char b) -> unsigned long
e811c8ce 2152
0df68c9f
RD
2153 Get the key in the histogram for the given RGB values
2154 """
54f9ee45 2155 return _core_.ImageHistogram_MakeKey(*args, **kwargs)
d14a1e28
RD
2156
2157class Image(Object):
093d3ff1 2158 """Proxy of C++ Image class"""
e811c8ce
RD
2159 def __repr__(self):
2160 return "<%s.%s; proxy of C++ wxImage instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2161 def __init__(self, *args, **kwargs):
a95a7133 2162 """__init__(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> Image"""
54f9ee45 2163 newobj = _core_.new_Image(*args, **kwargs)
d14a1e28
RD
2164 self.this = newobj.this
2165 self.thisown = 1
2166 del newobj.thisown
54f9ee45 2167 def __del__(self, destroy=_core_.delete_Image):
a95a7133 2168 """__del__(self)"""
d14a1e28
RD
2169 try:
2170 if self.thisown: destroy(self)
2171 except: pass
e811c8ce
RD
2172
2173 def Create(*args, **kwargs):
a95a7133 2174 """Create(self, int width, int height)"""
54f9ee45 2175 return _core_.Image_Create(*args, **kwargs)
e811c8ce
RD
2176
2177 def Destroy(*args, **kwargs):
0df68c9f 2178 """
a95a7133 2179 Destroy(self)
e811c8ce 2180
0df68c9f
RD
2181 Deletes the C++ object this Python object is a proxy for.
2182 """
54f9ee45 2183 return _core_.Image_Destroy(*args, **kwargs)
e811c8ce
RD
2184
2185 def Scale(*args, **kwargs):
a95a7133 2186 """Scale(self, int width, int height) -> Image"""
54f9ee45 2187 return _core_.Image_Scale(*args, **kwargs)
e811c8ce
RD
2188
2189 def ShrinkBy(*args, **kwargs):
a95a7133 2190 """ShrinkBy(self, int xFactor, int yFactor) -> Image"""
54f9ee45 2191 return _core_.Image_ShrinkBy(*args, **kwargs)
e811c8ce
RD
2192
2193 def Rescale(*args, **kwargs):
a95a7133 2194 """Rescale(self, int width, int height) -> Image"""
54f9ee45 2195 return _core_.Image_Rescale(*args, **kwargs)
e811c8ce 2196
aff4cc5c
RD
2197 def Resize(*args, **kwargs):
2198 """Resize(self, Size size, Point pos, int r=-1, int g=-1, int b=-1) -> Image"""
2199 return _core_.Image_Resize(*args, **kwargs)
2200
e811c8ce 2201 def SetRGB(*args, **kwargs):
a95a7133 2202 """SetRGB(self, int x, int y, unsigned char r, unsigned char g, unsigned char b)"""
54f9ee45 2203 return _core_.Image_SetRGB(*args, **kwargs)
e811c8ce 2204
aff4cc5c
RD
2205 def SetRGBRect(*args, **kwargs):
2206 """SetRGBRect(self, Rect rect, unsigned char r, unsigned char g, unsigned char b)"""
2207 return _core_.Image_SetRGBRect(*args, **kwargs)
2208
e811c8ce 2209 def GetRed(*args, **kwargs):
a95a7133 2210 """GetRed(self, int x, int y) -> unsigned char"""
54f9ee45 2211 return _core_.Image_GetRed(*args, **kwargs)
e811c8ce
RD
2212
2213 def GetGreen(*args, **kwargs):
a95a7133 2214 """GetGreen(self, int x, int y) -> unsigned char"""
54f9ee45 2215 return _core_.Image_GetGreen(*args, **kwargs)
e811c8ce
RD
2216
2217 def GetBlue(*args, **kwargs):
a95a7133 2218 """GetBlue(self, int x, int y) -> unsigned char"""
54f9ee45 2219 return _core_.Image_GetBlue(*args, **kwargs)
e811c8ce
RD
2220
2221 def SetAlpha(*args, **kwargs):
a95a7133 2222 """SetAlpha(self, int x, int y, unsigned char alpha)"""
54f9ee45 2223 return _core_.Image_SetAlpha(*args, **kwargs)
e811c8ce
RD
2224
2225 def GetAlpha(*args, **kwargs):
a95a7133 2226 """GetAlpha(self, int x, int y) -> unsigned char"""
54f9ee45 2227 return _core_.Image_GetAlpha(*args, **kwargs)
e811c8ce
RD
2228
2229 def HasAlpha(*args, **kwargs):
a95a7133 2230 """HasAlpha(self) -> bool"""
54f9ee45 2231 return _core_.Image_HasAlpha(*args, **kwargs)
e811c8ce 2232
68350608
RD
2233 def InitAlpha(*args, **kwargs):
2234 """
2235 InitAlpha(self)
2236
2237 Initializes the image alpha channel data. It is an error to call it if
2238 the image already has alpha data. If it doesn't, alpha data will be by
2239 default initialized to all pixels being fully opaque. But if the image
2240 has a a mask colour, all mask pixels will be completely transparent.
2241 """
2242 return _core_.Image_InitAlpha(*args, **kwargs)
2243
e811c8ce 2244 def FindFirstUnusedColour(*args, **kwargs):
fd2dc343
RD
2245 """
2246 FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)
2247
2248 Find first colour that is not used in the image and has higher RGB
2249 values than startR, startG, startB. Returns a tuple consisting of a
2250 success flag and rgb values.
2251 """
54f9ee45 2252 return _core_.Image_FindFirstUnusedColour(*args, **kwargs)
e811c8ce 2253
4cf4100f
RD
2254 def ConvertAlphaToMask(*args, **kwargs):
2255 """
2256 ConvertAlphaToMask(self, byte threshold=128) -> bool
2257
2258 If the image has alpha channel, this method converts it to mask. All pixels
2259 with alpha value less than ``threshold`` are replaced with mask colour and the
2260 alpha channel is removed. Mask colour is chosen automatically using
2261 `FindFirstUnusedColour`.
2262
2263 If the image image doesn't have alpha channel, ConvertAlphaToMask does
2264 nothing.
2265 """
2266 return _core_.Image_ConvertAlphaToMask(*args, **kwargs)
2267
8fb0e70a
RD
2268 def ConvertColourToAlpha(*args, **kwargs):
2269 """
2270 ConvertColourToAlpha(self, unsigned char r, unsigned char g, unsigned char b) -> bool
2271
2272 This method converts an image where the original alpha information is
2273 only available as a shades of a colour (actually shades of grey)
2274 typically when you draw anti-aliased text into a bitmap. The DC
2275 drawing routines draw grey values on the black background although
2276 they actually mean to draw white with differnt alpha values. This
2277 method reverses it, assuming a black (!) background and white text.
2278 The method will then fill up the whole image with the colour given.
2279 """
2280 return _core_.Image_ConvertColourToAlpha(*args, **kwargs)
2281
e811c8ce 2282 def SetMaskFromImage(*args, **kwargs):
a95a7133 2283 """SetMaskFromImage(self, Image mask, byte mr, byte mg, byte mb) -> bool"""
54f9ee45 2284 return _core_.Image_SetMaskFromImage(*args, **kwargs)
e811c8ce
RD
2285
2286 def CanRead(*args, **kwargs):
66c033b4 2287 """CanRead(String name) -> bool"""
54f9ee45 2288 return _core_.Image_CanRead(*args, **kwargs)
e811c8ce
RD
2289
2290 CanRead = staticmethod(CanRead)
2291 def GetImageCount(*args, **kwargs):
66c033b4 2292 """GetImageCount(String name, long type=BITMAP_TYPE_ANY) -> int"""
54f9ee45 2293 return _core_.Image_GetImageCount(*args, **kwargs)
e811c8ce
RD
2294
2295 GetImageCount = staticmethod(GetImageCount)
2296 def LoadFile(*args, **kwargs):
a95a7133 2297 """LoadFile(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> bool"""
54f9ee45 2298 return _core_.Image_LoadFile(*args, **kwargs)
e811c8ce
RD
2299
2300 def LoadMimeFile(*args, **kwargs):
a95a7133 2301 """LoadMimeFile(self, String name, String mimetype, int index=-1) -> bool"""
54f9ee45 2302 return _core_.Image_LoadMimeFile(*args, **kwargs)
e811c8ce
RD
2303
2304 def SaveFile(*args, **kwargs):
a95a7133 2305 """SaveFile(self, String name, int type) -> bool"""
54f9ee45 2306 return _core_.Image_SaveFile(*args, **kwargs)
e811c8ce
RD
2307
2308 def SaveMimeFile(*args, **kwargs):
a95a7133 2309 """SaveMimeFile(self, String name, String mimetype) -> bool"""
54f9ee45 2310 return _core_.Image_SaveMimeFile(*args, **kwargs)
e811c8ce
RD
2311
2312 def CanReadStream(*args, **kwargs):
66c033b4 2313 """CanReadStream(InputStream stream) -> bool"""
54f9ee45 2314 return _core_.Image_CanReadStream(*args, **kwargs)
e811c8ce
RD
2315
2316 CanReadStream = staticmethod(CanReadStream)
2317 def LoadStream(*args, **kwargs):
a95a7133 2318 """LoadStream(self, InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> bool"""
54f9ee45 2319 return _core_.Image_LoadStream(*args, **kwargs)
e811c8ce
RD
2320
2321 def LoadMimeStream(*args, **kwargs):
a95a7133 2322 """LoadMimeStream(self, InputStream stream, String mimetype, int index=-1) -> bool"""
54f9ee45 2323 return _core_.Image_LoadMimeStream(*args, **kwargs)
e811c8ce
RD
2324
2325 def Ok(*args, **kwargs):
a95a7133 2326 """Ok(self) -> bool"""
54f9ee45 2327 return _core_.Image_Ok(*args, **kwargs)
e811c8ce
RD
2328
2329 def GetWidth(*args, **kwargs):
a95a7133 2330 """GetWidth(self) -> int"""
54f9ee45 2331 return _core_.Image_GetWidth(*args, **kwargs)
e811c8ce
RD
2332
2333 def GetHeight(*args, **kwargs):
a95a7133 2334 """GetHeight(self) -> int"""
54f9ee45 2335 return _core_.Image_GetHeight(*args, **kwargs)
e811c8ce 2336
b2df227b 2337 def GetSize(*args, **kwargs):
a95a7133 2338 """GetSize(self) -> Size"""
54f9ee45 2339 return _core_.Image_GetSize(*args, **kwargs)
b2df227b 2340
e811c8ce 2341 def GetSubImage(*args, **kwargs):
a95a7133 2342 """GetSubImage(self, Rect rect) -> Image"""
54f9ee45 2343 return _core_.Image_GetSubImage(*args, **kwargs)
e811c8ce 2344
aff4cc5c
RD
2345 def Size(*args, **kwargs):
2346 """Size(self, Size size, Point pos, int r=-1, int g=-1, int b=-1) -> Image"""
2347 return _core_.Image_Size(*args, **kwargs)
2348
e811c8ce 2349 def Copy(*args, **kwargs):
a95a7133 2350 """Copy(self) -> Image"""
54f9ee45 2351 return _core_.Image_Copy(*args, **kwargs)
e811c8ce
RD
2352
2353 def Paste(*args, **kwargs):
a95a7133 2354 """Paste(self, Image image, int x, int y)"""
54f9ee45 2355 return _core_.Image_Paste(*args, **kwargs)
e811c8ce
RD
2356
2357 def GetData(*args, **kwargs):
61d07ac7
RD
2358 """
2359 GetData(self) -> PyObject
2360
2361 Returns a string containing a copy of the RGB bytes of the image.
2362 """
54f9ee45 2363 return _core_.Image_GetData(*args, **kwargs)
e811c8ce
RD
2364
2365 def SetData(*args, **kwargs):
61d07ac7
RD
2366 """
2367 SetData(self, buffer data)
2368
2369 Resets the Image's RGB data from a buffer of RGB bytes. Accepts
2370 either a string or a buffer object holding the data and the length of
2371 the data must be width*height*3.
2372 """
54f9ee45 2373 return _core_.Image_SetData(*args, **kwargs)
e811c8ce
RD
2374
2375 def GetDataBuffer(*args, **kwargs):
61d07ac7
RD
2376 """
2377 GetDataBuffer(self) -> PyObject
2378
2379 Returns a writable Python buffer object that is pointing at the RGB
2380 image data buffer inside the wx.Image.
2381 """
54f9ee45 2382 return _core_.Image_GetDataBuffer(*args, **kwargs)
e811c8ce
RD
2383
2384 def SetDataBuffer(*args, **kwargs):
61d07ac7
RD
2385 """
2386 SetDataBuffer(self, buffer data)
2387
2388 Sets the internal image data pointer to point at a Python buffer
2389 object. This can save a copy of the data but you must ensure that the
2390 buffer object lives longer than the wx.Image does.
2391 """
54f9ee45 2392 return _core_.Image_SetDataBuffer(*args, **kwargs)
e811c8ce
RD
2393
2394 def GetAlphaData(*args, **kwargs):
61d07ac7
RD
2395 """
2396 GetAlphaData(self) -> PyObject
2397
2398 Returns a string containing a copy of the alpha bytes of the image.
2399 """
54f9ee45 2400 return _core_.Image_GetAlphaData(*args, **kwargs)
e811c8ce
RD
2401
2402 def SetAlphaData(*args, **kwargs):
61d07ac7
RD
2403 """
2404 SetAlphaData(self, buffer alpha)
2405
2406 Resets the Image's alpha data from a buffer of bytes. Accepts either
2407 a string or a buffer object holding the data and the length of the
2408 data must be width*height.
2409 """
54f9ee45 2410 return _core_.Image_SetAlphaData(*args, **kwargs)
e811c8ce
RD
2411
2412 def GetAlphaBuffer(*args, **kwargs):
a95a7133 2413 """GetAlphaBuffer(self) -> PyObject"""
54f9ee45 2414 return _core_.Image_GetAlphaBuffer(*args, **kwargs)
e811c8ce
RD
2415
2416 def SetAlphaBuffer(*args, **kwargs):
61d07ac7 2417 """SetAlphaBuffer(self, buffer alpha)"""
54f9ee45 2418 return _core_.Image_SetAlphaBuffer(*args, **kwargs)
e811c8ce
RD
2419
2420 def SetMaskColour(*args, **kwargs):
a95a7133 2421 """SetMaskColour(self, unsigned char r, unsigned char g, unsigned char b)"""
54f9ee45 2422 return _core_.Image_SetMaskColour(*args, **kwargs)
e811c8ce 2423
aff4cc5c
RD
2424 def GetOrFindMaskColour(*args, **kwargs):
2425 """
2426 GetOrFindMaskColour() -> (r,g,b)
2427
2428 Get the current mask colour or find a suitable colour.
2429 """
2430 return _core_.Image_GetOrFindMaskColour(*args, **kwargs)
2431
e811c8ce 2432 def GetMaskRed(*args, **kwargs):
a95a7133 2433 """GetMaskRed(self) -> unsigned char"""
54f9ee45 2434 return _core_.Image_GetMaskRed(*args, **kwargs)
e811c8ce
RD
2435
2436 def GetMaskGreen(*args, **kwargs):
a95a7133 2437 """GetMaskGreen(self) -> unsigned char"""
54f9ee45 2438 return _core_.Image_GetMaskGreen(*args, **kwargs)
e811c8ce
RD
2439
2440 def GetMaskBlue(*args, **kwargs):
a95a7133 2441 """GetMaskBlue(self) -> unsigned char"""
54f9ee45 2442 return _core_.Image_GetMaskBlue(*args, **kwargs)
e811c8ce
RD
2443
2444 def SetMask(*args, **kwargs):
a95a7133 2445 """SetMask(self, bool mask=True)"""
54f9ee45 2446 return _core_.Image_SetMask(*args, **kwargs)
e811c8ce
RD
2447
2448 def HasMask(*args, **kwargs):
a95a7133 2449 """HasMask(self) -> bool"""
54f9ee45 2450 return _core_.Image_HasMask(*args, **kwargs)
e811c8ce
RD
2451
2452 def Rotate(*args, **kwargs):
0df68c9f 2453 """
a95a7133 2454 Rotate(self, double angle, Point centre_of_rotation, bool interpolating=True,
0df68c9f
RD
2455 Point offset_after_rotation=None) -> Image
2456 """
54f9ee45 2457 return _core_.Image_Rotate(*args, **kwargs)
e811c8ce
RD
2458
2459 def Rotate90(*args, **kwargs):
a95a7133 2460 """Rotate90(self, bool clockwise=True) -> Image"""
54f9ee45 2461 return _core_.Image_Rotate90(*args, **kwargs)
e811c8ce
RD
2462
2463 def Mirror(*args, **kwargs):
a95a7133 2464 """Mirror(self, bool horizontally=True) -> Image"""
54f9ee45 2465 return _core_.Image_Mirror(*args, **kwargs)
e811c8ce
RD
2466
2467 def Replace(*args, **kwargs):
0df68c9f 2468 """
a95a7133 2469 Replace(self, unsigned char r1, unsigned char g1, unsigned char b1,
0df68c9f
RD
2470 unsigned char r2, unsigned char g2, unsigned char b2)
2471 """
54f9ee45 2472 return _core_.Image_Replace(*args, **kwargs)
e811c8ce
RD
2473
2474 def ConvertToMono(*args, **kwargs):
a95a7133 2475 """ConvertToMono(self, unsigned char r, unsigned char g, unsigned char b) -> Image"""
54f9ee45 2476 return _core_.Image_ConvertToMono(*args, **kwargs)
e811c8ce
RD
2477
2478 def SetOption(*args, **kwargs):
a95a7133 2479 """SetOption(self, String name, String value)"""
54f9ee45 2480 return _core_.Image_SetOption(*args, **kwargs)
e811c8ce
RD
2481
2482 def SetOptionInt(*args, **kwargs):
a95a7133 2483 """SetOptionInt(self, String name, int value)"""
54f9ee45 2484 return _core_.Image_SetOptionInt(*args, **kwargs)
e811c8ce
RD
2485
2486 def GetOption(*args, **kwargs):
a95a7133 2487 """GetOption(self, String name) -> String"""
54f9ee45 2488 return _core_.Image_GetOption(*args, **kwargs)
e811c8ce
RD
2489
2490 def GetOptionInt(*args, **kwargs):
a95a7133 2491 """GetOptionInt(self, String name) -> int"""
54f9ee45 2492 return _core_.Image_GetOptionInt(*args, **kwargs)
e811c8ce
RD
2493
2494 def HasOption(*args, **kwargs):
a95a7133 2495 """HasOption(self, String name) -> bool"""
54f9ee45 2496 return _core_.Image_HasOption(*args, **kwargs)
e811c8ce
RD
2497
2498 def CountColours(*args, **kwargs):
a95a7133 2499 """CountColours(self, unsigned long stopafter=(unsigned long) -1) -> unsigned long"""
54f9ee45 2500 return _core_.Image_CountColours(*args, **kwargs)
e811c8ce
RD
2501
2502 def ComputeHistogram(*args, **kwargs):
a95a7133 2503 """ComputeHistogram(self, ImageHistogram h) -> unsigned long"""
54f9ee45 2504 return _core_.Image_ComputeHistogram(*args, **kwargs)
e811c8ce
RD
2505
2506 def AddHandler(*args, **kwargs):
66c033b4 2507 """AddHandler(ImageHandler handler)"""
54f9ee45 2508 return _core_.Image_AddHandler(*args, **kwargs)
e811c8ce
RD
2509
2510 AddHandler = staticmethod(AddHandler)
2511 def InsertHandler(*args, **kwargs):
66c033b4 2512 """InsertHandler(ImageHandler handler)"""
54f9ee45 2513 return _core_.Image_InsertHandler(*args, **kwargs)
e811c8ce
RD
2514
2515 InsertHandler = staticmethod(InsertHandler)
2516 def RemoveHandler(*args, **kwargs):
66c033b4 2517 """RemoveHandler(String name) -> bool"""
54f9ee45 2518 return _core_.Image_RemoveHandler(*args, **kwargs)
e811c8ce
RD
2519
2520 RemoveHandler = staticmethod(RemoveHandler)
2521 def GetImageExtWildcard(*args, **kwargs):
66c033b4 2522 """GetImageExtWildcard() -> String"""
54f9ee45 2523 return _core_.Image_GetImageExtWildcard(*args, **kwargs)
e811c8ce
RD
2524
2525 GetImageExtWildcard = staticmethod(GetImageExtWildcard)
2526 def ConvertToBitmap(*args, **kwargs):
1fbf26be 2527 """ConvertToBitmap(self, int depth=-1) -> Bitmap"""
54f9ee45 2528 return _core_.Image_ConvertToBitmap(*args, **kwargs)
e811c8ce
RD
2529
2530 def ConvertToMonoBitmap(*args, **kwargs):
a95a7133 2531 """ConvertToMonoBitmap(self, unsigned char red, unsigned char green, unsigned char blue) -> Bitmap"""
54f9ee45 2532 return _core_.Image_ConvertToMonoBitmap(*args, **kwargs)
e811c8ce
RD
2533
2534 def __nonzero__(self): return self.Ok()
d14a1e28
RD
2535
2536class ImagePtr(Image):
2537 def __init__(self, this):
2538 self.this = this
2539 if not hasattr(self,"thisown"): self.thisown = 0
2540 self.__class__ = Image
54f9ee45 2541_core_.Image_swigregister(ImagePtr)
d14a1e28
RD
2542
2543def ImageFromMime(*args, **kwargs):
196addbf 2544 """ImageFromMime(String name, String mimetype, int index=-1) -> Image"""
54f9ee45 2545 val = _core_.new_ImageFromMime(*args, **kwargs)
d14a1e28
RD
2546 val.thisown = 1
2547 return val
2548
2549def ImageFromStream(*args, **kwargs):
196addbf 2550 """ImageFromStream(InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> Image"""
54f9ee45 2551 val = _core_.new_ImageFromStream(*args, **kwargs)
d14a1e28
RD
2552 val.thisown = 1
2553 return val
2554
2555def ImageFromStreamMime(*args, **kwargs):
196addbf 2556 """ImageFromStreamMime(InputStream stream, String mimetype, int index=-1) -> Image"""
54f9ee45 2557 val = _core_.new_ImageFromStreamMime(*args, **kwargs)
d14a1e28
RD
2558 val.thisown = 1
2559 return val
2560
66c033b4 2561def EmptyImage(*args, **kwargs):
61d07ac7
RD
2562 """
2563 EmptyImage(int width=0, int height=0, bool clear=True) -> Image
2564
2565 Construct an empty image of a given size, optionally setting all
2566 pixels to black.
2567 """
66c033b4 2568 val = _core_.new_EmptyImage(*args, **kwargs)
d14a1e28
RD
2569 val.thisown = 1
2570 return val
2571
2572def ImageFromBitmap(*args, **kwargs):
61d07ac7
RD
2573 """
2574 ImageFromBitmap(Bitmap bitmap) -> Image
2575
2576 Construct an Image from a `wx.Bitmap`.
2577 """
54f9ee45 2578 val = _core_.new_ImageFromBitmap(*args, **kwargs)
d14a1e28
RD
2579 val.thisown = 1
2580 return val
2581
2582def ImageFromData(*args, **kwargs):
61d07ac7
RD
2583 """
2584 ImageFromData(int width, int height, buffer data) -> Image
2585
2586 Construct an Image from a buffer of RGB bytes. Accepts either a
2587 string or a buffer object holding the data and the length of the data
2588 must be width*height*3.
2589 """
54f9ee45 2590 val = _core_.new_ImageFromData(*args, **kwargs)
d14a1e28
RD
2591 val.thisown = 1
2592 return val
2593
1823fbb4 2594def ImageFromDataWithAlpha(*args, **kwargs):
61d07ac7
RD
2595 """
2596 ImageFromDataWithAlpha(int width, int height, buffer data, buffer alpha) -> Image
2597
2598 Construct an Image from a buffer of RGB bytes with an Alpha channel.
2599 Accepts either a string or a buffer object holding the data and the
2600 length of the data must be width*height*3.
2601 """
1823fbb4
RD
2602 val = _core_.new_ImageFromDataWithAlpha(*args, **kwargs)
2603 val.thisown = 1
2604 return val
2605
e811c8ce 2606def Image_CanRead(*args, **kwargs):
196addbf 2607 """Image_CanRead(String name) -> bool"""
54f9ee45 2608 return _core_.Image_CanRead(*args, **kwargs)
d14a1e28 2609
e811c8ce 2610def Image_GetImageCount(*args, **kwargs):
196addbf 2611 """Image_GetImageCount(String name, long type=BITMAP_TYPE_ANY) -> int"""
54f9ee45 2612 return _core_.Image_GetImageCount(*args, **kwargs)
d14a1e28 2613
e811c8ce 2614def Image_CanReadStream(*args, **kwargs):
196addbf 2615 """Image_CanReadStream(InputStream stream) -> bool"""
54f9ee45 2616 return _core_.Image_CanReadStream(*args, **kwargs)
d14a1e28 2617
e811c8ce
RD
2618def Image_AddHandler(*args, **kwargs):
2619 """Image_AddHandler(ImageHandler handler)"""
54f9ee45 2620 return _core_.Image_AddHandler(*args, **kwargs)
d14a1e28 2621
e811c8ce
RD
2622def Image_InsertHandler(*args, **kwargs):
2623 """Image_InsertHandler(ImageHandler handler)"""
54f9ee45 2624 return _core_.Image_InsertHandler(*args, **kwargs)
d14a1e28 2625
e811c8ce 2626def Image_RemoveHandler(*args, **kwargs):
196addbf 2627 """Image_RemoveHandler(String name) -> bool"""
54f9ee45 2628 return _core_.Image_RemoveHandler(*args, **kwargs)
d14a1e28 2629
e811c8ce 2630def Image_GetImageExtWildcard(*args, **kwargs):
196addbf 2631 """Image_GetImageExtWildcard() -> String"""
54f9ee45 2632 return _core_.Image_GetImageExtWildcard(*args, **kwargs)
d14a1e28 2633
5e4ca4a8
RD
2634def InitAllImageHandlers():
2635 """
2636 The former functionality of InitAllImageHanders is now done internal to
2637 the _core_ extension module and so this function has become a simple NOP.
2638 """
2639 pass
d14a1e28 2640
54f9ee45
RD
2641IMAGE_RESOLUTION_INCHES = _core_.IMAGE_RESOLUTION_INCHES
2642IMAGE_RESOLUTION_CM = _core_.IMAGE_RESOLUTION_CM
b9d6a5f3
RD
2643PNG_TYPE_COLOUR = _core_.PNG_TYPE_COLOUR
2644PNG_TYPE_GREY = _core_.PNG_TYPE_GREY
2645PNG_TYPE_GREY_RED = _core_.PNG_TYPE_GREY_RED
54f9ee45
RD
2646BMP_24BPP = _core_.BMP_24BPP
2647BMP_8BPP = _core_.BMP_8BPP
2648BMP_8BPP_GREY = _core_.BMP_8BPP_GREY
2649BMP_8BPP_GRAY = _core_.BMP_8BPP_GRAY
2650BMP_8BPP_RED = _core_.BMP_8BPP_RED
2651BMP_8BPP_PALETTE = _core_.BMP_8BPP_PALETTE
2652BMP_4BPP = _core_.BMP_4BPP
2653BMP_1BPP = _core_.BMP_1BPP
2654BMP_1BPP_BW = _core_.BMP_1BPP_BW
d14a1e28 2655class BMPHandler(ImageHandler):
093d3ff1 2656 """Proxy of C++ BMPHandler class"""
e811c8ce
RD
2657 def __repr__(self):
2658 return "<%s.%s; proxy of C++ wxBMPHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2659 def __init__(self, *args, **kwargs):
a95a7133 2660 """__init__(self) -> BMPHandler"""
54f9ee45 2661 newobj = _core_.new_BMPHandler(*args, **kwargs)
d14a1e28
RD
2662 self.this = newobj.this
2663 self.thisown = 1
2664 del newobj.thisown
d14a1e28
RD
2665
2666class BMPHandlerPtr(BMPHandler):
2667 def __init__(self, this):
2668 self.this = this
2669 if not hasattr(self,"thisown"): self.thisown = 0
2670 self.__class__ = BMPHandler
54f9ee45 2671_core_.BMPHandler_swigregister(BMPHandlerPtr)
d14a1e28 2672NullImage = cvar.NullImage
0c243d93 2673IMAGE_OPTION_FILENAME = cvar.IMAGE_OPTION_FILENAME
d14a1e28
RD
2674IMAGE_OPTION_BMP_FORMAT = cvar.IMAGE_OPTION_BMP_FORMAT
2675IMAGE_OPTION_CUR_HOTSPOT_X = cvar.IMAGE_OPTION_CUR_HOTSPOT_X
2676IMAGE_OPTION_CUR_HOTSPOT_Y = cvar.IMAGE_OPTION_CUR_HOTSPOT_Y
2677IMAGE_OPTION_RESOLUTION = cvar.IMAGE_OPTION_RESOLUTION
0c243d93
RD
2678IMAGE_OPTION_RESOLUTIONX = cvar.IMAGE_OPTION_RESOLUTIONX
2679IMAGE_OPTION_RESOLUTIONY = cvar.IMAGE_OPTION_RESOLUTIONY
d14a1e28 2680IMAGE_OPTION_RESOLUTIONUNIT = cvar.IMAGE_OPTION_RESOLUTIONUNIT
24d7cbea 2681IMAGE_OPTION_QUALITY = cvar.IMAGE_OPTION_QUALITY
0c243d93
RD
2682IMAGE_OPTION_BITSPERSAMPLE = cvar.IMAGE_OPTION_BITSPERSAMPLE
2683IMAGE_OPTION_SAMPLESPERPIXEL = cvar.IMAGE_OPTION_SAMPLESPERPIXEL
2684IMAGE_OPTION_COMPRESSION = cvar.IMAGE_OPTION_COMPRESSION
2685IMAGE_OPTION_IMAGEDESCRIPTOR = cvar.IMAGE_OPTION_IMAGEDESCRIPTOR
b9d6a5f3
RD
2686IMAGE_OPTION_PNG_FORMAT = cvar.IMAGE_OPTION_PNG_FORMAT
2687IMAGE_OPTION_PNG_BITDEPTH = cvar.IMAGE_OPTION_PNG_BITDEPTH
d14a1e28
RD
2688
2689class ICOHandler(BMPHandler):
093d3ff1 2690 """Proxy of C++ ICOHandler class"""
e811c8ce
RD
2691 def __repr__(self):
2692 return "<%s.%s; proxy of C++ wxICOHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2693 def __init__(self, *args, **kwargs):
a95a7133 2694 """__init__(self) -> ICOHandler"""
54f9ee45 2695 newobj = _core_.new_ICOHandler(*args, **kwargs)
d14a1e28
RD
2696 self.this = newobj.this
2697 self.thisown = 1
2698 del newobj.thisown
d14a1e28
RD
2699
2700class ICOHandlerPtr(ICOHandler):
2701 def __init__(self, this):
2702 self.this = this
2703 if not hasattr(self,"thisown"): self.thisown = 0
2704 self.__class__ = ICOHandler
54f9ee45 2705_core_.ICOHandler_swigregister(ICOHandlerPtr)
d14a1e28
RD
2706
2707class CURHandler(ICOHandler):
093d3ff1 2708 """Proxy of C++ CURHandler class"""
e811c8ce
RD
2709 def __repr__(self):
2710 return "<%s.%s; proxy of C++ wxCURHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2711 def __init__(self, *args, **kwargs):
a95a7133 2712 """__init__(self) -> CURHandler"""
54f9ee45 2713 newobj = _core_.new_CURHandler(*args, **kwargs)
d14a1e28
RD
2714 self.this = newobj.this
2715 self.thisown = 1
2716 del newobj.thisown
d14a1e28
RD
2717
2718class CURHandlerPtr(CURHandler):
2719 def __init__(self, this):
2720 self.this = this
2721 if not hasattr(self,"thisown"): self.thisown = 0
2722 self.__class__ = CURHandler
54f9ee45 2723_core_.CURHandler_swigregister(CURHandlerPtr)
d14a1e28
RD
2724
2725class ANIHandler(CURHandler):
093d3ff1 2726 """Proxy of C++ ANIHandler class"""
e811c8ce
RD
2727 def __repr__(self):
2728 return "<%s.%s; proxy of C++ wxANIHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2729 def __init__(self, *args, **kwargs):
a95a7133 2730 """__init__(self) -> ANIHandler"""
54f9ee45 2731 newobj = _core_.new_ANIHandler(*args, **kwargs)
d14a1e28
RD
2732 self.this = newobj.this
2733 self.thisown = 1
2734 del newobj.thisown
d14a1e28
RD
2735
2736class ANIHandlerPtr(ANIHandler):
2737 def __init__(self, this):
2738 self.this = this
2739 if not hasattr(self,"thisown"): self.thisown = 0
2740 self.__class__ = ANIHandler
54f9ee45 2741_core_.ANIHandler_swigregister(ANIHandlerPtr)
d14a1e28
RD
2742
2743class PNGHandler(ImageHandler):
093d3ff1 2744 """Proxy of C++ PNGHandler class"""
e811c8ce
RD
2745 def __repr__(self):
2746 return "<%s.%s; proxy of C++ wxPNGHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2747 def __init__(self, *args, **kwargs):
a95a7133 2748 """__init__(self) -> PNGHandler"""
54f9ee45 2749 newobj = _core_.new_PNGHandler(*args, **kwargs)
d14a1e28
RD
2750 self.this = newobj.this
2751 self.thisown = 1
2752 del newobj.thisown
d14a1e28
RD
2753
2754class PNGHandlerPtr(PNGHandler):
2755 def __init__(self, this):
2756 self.this = this
2757 if not hasattr(self,"thisown"): self.thisown = 0
2758 self.__class__ = PNGHandler
54f9ee45 2759_core_.PNGHandler_swigregister(PNGHandlerPtr)
d14a1e28
RD
2760
2761class GIFHandler(ImageHandler):
093d3ff1 2762 """Proxy of C++ GIFHandler class"""
e811c8ce
RD
2763 def __repr__(self):
2764 return "<%s.%s; proxy of C++ wxGIFHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2765 def __init__(self, *args, **kwargs):
a95a7133 2766 """__init__(self) -> GIFHandler"""
54f9ee45 2767 newobj = _core_.new_GIFHandler(*args, **kwargs)
d14a1e28
RD
2768 self.this = newobj.this
2769 self.thisown = 1
2770 del newobj.thisown
d14a1e28
RD
2771
2772class GIFHandlerPtr(GIFHandler):
2773 def __init__(self, this):
2774 self.this = this
2775 if not hasattr(self,"thisown"): self.thisown = 0
2776 self.__class__ = GIFHandler
54f9ee45 2777_core_.GIFHandler_swigregister(GIFHandlerPtr)
d14a1e28
RD
2778
2779class PCXHandler(ImageHandler):
093d3ff1 2780 """Proxy of C++ PCXHandler class"""
e811c8ce
RD
2781 def __repr__(self):
2782 return "<%s.%s; proxy of C++ wxPCXHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2783 def __init__(self, *args, **kwargs):
a95a7133 2784 """__init__(self) -> PCXHandler"""
54f9ee45 2785 newobj = _core_.new_PCXHandler(*args, **kwargs)
d14a1e28
RD
2786 self.this = newobj.this
2787 self.thisown = 1
2788 del newobj.thisown
d14a1e28
RD
2789
2790class PCXHandlerPtr(PCXHandler):
2791 def __init__(self, this):
2792 self.this = this
2793 if not hasattr(self,"thisown"): self.thisown = 0
2794 self.__class__ = PCXHandler
54f9ee45 2795_core_.PCXHandler_swigregister(PCXHandlerPtr)
d14a1e28
RD
2796
2797class JPEGHandler(ImageHandler):
093d3ff1 2798 """Proxy of C++ JPEGHandler class"""
e811c8ce
RD
2799 def __repr__(self):
2800 return "<%s.%s; proxy of C++ wxJPEGHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2801 def __init__(self, *args, **kwargs):
a95a7133 2802 """__init__(self) -> JPEGHandler"""
54f9ee45 2803 newobj = _core_.new_JPEGHandler(*args, **kwargs)
d14a1e28
RD
2804 self.this = newobj.this
2805 self.thisown = 1
2806 del newobj.thisown
d14a1e28
RD
2807
2808class JPEGHandlerPtr(JPEGHandler):
2809 def __init__(self, this):
2810 self.this = this
2811 if not hasattr(self,"thisown"): self.thisown = 0
2812 self.__class__ = JPEGHandler
54f9ee45 2813_core_.JPEGHandler_swigregister(JPEGHandlerPtr)
d14a1e28
RD
2814
2815class PNMHandler(ImageHandler):
093d3ff1 2816 """Proxy of C++ PNMHandler class"""
e811c8ce
RD
2817 def __repr__(self):
2818 return "<%s.%s; proxy of C++ wxPNMHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2819 def __init__(self, *args, **kwargs):
a95a7133 2820 """__init__(self) -> PNMHandler"""
54f9ee45 2821 newobj = _core_.new_PNMHandler(*args, **kwargs)
d14a1e28
RD
2822 self.this = newobj.this
2823 self.thisown = 1
2824 del newobj.thisown
d14a1e28
RD
2825
2826class PNMHandlerPtr(PNMHandler):
2827 def __init__(self, this):
2828 self.this = this
2829 if not hasattr(self,"thisown"): self.thisown = 0
2830 self.__class__ = PNMHandler
54f9ee45 2831_core_.PNMHandler_swigregister(PNMHandlerPtr)
d14a1e28
RD
2832
2833class XPMHandler(ImageHandler):
093d3ff1 2834 """Proxy of C++ XPMHandler class"""
e811c8ce
RD
2835 def __repr__(self):
2836 return "<%s.%s; proxy of C++ wxXPMHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2837 def __init__(self, *args, **kwargs):
a95a7133 2838 """__init__(self) -> XPMHandler"""
54f9ee45 2839 newobj = _core_.new_XPMHandler(*args, **kwargs)
d14a1e28
RD
2840 self.this = newobj.this
2841 self.thisown = 1
2842 del newobj.thisown
d14a1e28
RD
2843
2844class XPMHandlerPtr(XPMHandler):
2845 def __init__(self, this):
2846 self.this = this
2847 if not hasattr(self,"thisown"): self.thisown = 0
2848 self.__class__ = XPMHandler
54f9ee45 2849_core_.XPMHandler_swigregister(XPMHandlerPtr)
d14a1e28
RD
2850
2851class TIFFHandler(ImageHandler):
093d3ff1 2852 """Proxy of C++ TIFFHandler class"""
e811c8ce
RD
2853 def __repr__(self):
2854 return "<%s.%s; proxy of C++ wxTIFFHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2855 def __init__(self, *args, **kwargs):
a95a7133 2856 """__init__(self) -> TIFFHandler"""
54f9ee45 2857 newobj = _core_.new_TIFFHandler(*args, **kwargs)
d14a1e28
RD
2858 self.this = newobj.this
2859 self.thisown = 1
2860 del newobj.thisown
d14a1e28
RD
2861
2862class TIFFHandlerPtr(TIFFHandler):
2863 def __init__(self, this):
2864 self.this = this
2865 if not hasattr(self,"thisown"): self.thisown = 0
2866 self.__class__ = TIFFHandler
54f9ee45 2867_core_.TIFFHandler_swigregister(TIFFHandlerPtr)
d14a1e28 2868
c0de73ae
RD
2869QUANTIZE_INCLUDE_WINDOWS_COLOURS = _core_.QUANTIZE_INCLUDE_WINDOWS_COLOURS
2870QUANTIZE_FILL_DESTINATION_IMAGE = _core_.QUANTIZE_FILL_DESTINATION_IMAGE
2871class Quantize(object):
2872 """Performs quantization, or colour reduction, on a wxImage."""
2873 def __init__(self): raise RuntimeError, "No constructor defined"
2874 def __repr__(self):
2875 return "<%s.%s; proxy of C++ wxQuantize instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2876 def Quantize(*args, **kwargs):
2877 """
2878 Quantize(Image src, Image dest, int desiredNoColours=236, int flags=wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE) -> bool
2879
2880 Reduce the colours in the source image and put the result into the
2881 destination image, setting the palette in the destination if
2882 needed. Both images may be the same, to overwrite the source image.
2883 """
2884 return _core_.Quantize_Quantize(*args, **kwargs)
2885
2886 Quantize = staticmethod(Quantize)
2887
2888class QuantizePtr(Quantize):
2889 def __init__(self, this):
2890 self.this = this
2891 if not hasattr(self,"thisown"): self.thisown = 0
2892 self.__class__ = Quantize
2893_core_.Quantize_swigregister(QuantizePtr)
2894
2895def Quantize_Quantize(*args, **kwargs):
2896 """
2897 Quantize_Quantize(Image src, Image dest, int desiredNoColours=236, int flags=wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE) -> bool
2898
2899 Reduce the colours in the source image and put the result into the
2900 destination image, setting the palette in the destination if
2901 needed. Both images may be the same, to overwrite the source image.
2902 """
2903 return _core_.Quantize_Quantize(*args, **kwargs)
2904
d14a1e28
RD
2905#---------------------------------------------------------------------------
2906
2907class EvtHandler(Object):
093d3ff1 2908 """Proxy of C++ EvtHandler class"""
e811c8ce
RD
2909 def __repr__(self):
2910 return "<%s.%s; proxy of C++ wxEvtHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2911 def __init__(self, *args, **kwargs):
a95a7133 2912 """__init__(self) -> EvtHandler"""
54f9ee45 2913 newobj = _core_.new_EvtHandler(*args, **kwargs)
d14a1e28
RD
2914 self.this = newobj.this
2915 self.thisown = 1
2916 del newobj.thisown
e811c8ce 2917 def GetNextHandler(*args, **kwargs):
a95a7133 2918 """GetNextHandler(self) -> EvtHandler"""
54f9ee45 2919 return _core_.EvtHandler_GetNextHandler(*args, **kwargs)
e811c8ce
RD
2920
2921 def GetPreviousHandler(*args, **kwargs):
a95a7133 2922 """GetPreviousHandler(self) -> EvtHandler"""
54f9ee45 2923 return _core_.EvtHandler_GetPreviousHandler(*args, **kwargs)
e811c8ce
RD
2924
2925 def SetNextHandler(*args, **kwargs):
a95a7133 2926 """SetNextHandler(self, EvtHandler handler)"""
54f9ee45 2927 return _core_.EvtHandler_SetNextHandler(*args, **kwargs)
e811c8ce
RD
2928
2929 def SetPreviousHandler(*args, **kwargs):
a95a7133 2930 """SetPreviousHandler(self, EvtHandler handler)"""
54f9ee45 2931 return _core_.EvtHandler_SetPreviousHandler(*args, **kwargs)
e811c8ce
RD
2932
2933 def GetEvtHandlerEnabled(*args, **kwargs):
a95a7133 2934 """GetEvtHandlerEnabled(self) -> bool"""
54f9ee45 2935 return _core_.EvtHandler_GetEvtHandlerEnabled(*args, **kwargs)
e811c8ce
RD
2936
2937 def SetEvtHandlerEnabled(*args, **kwargs):
a95a7133 2938 """SetEvtHandlerEnabled(self, bool enabled)"""
54f9ee45 2939 return _core_.EvtHandler_SetEvtHandlerEnabled(*args, **kwargs)
e811c8ce
RD
2940
2941 def ProcessEvent(*args, **kwargs):
a95a7133 2942 """ProcessEvent(self, Event event) -> bool"""
54f9ee45 2943 return _core_.EvtHandler_ProcessEvent(*args, **kwargs)
e811c8ce
RD
2944
2945 def AddPendingEvent(*args, **kwargs):
a95a7133 2946 """AddPendingEvent(self, Event event)"""
54f9ee45 2947 return _core_.EvtHandler_AddPendingEvent(*args, **kwargs)
e811c8ce
RD
2948
2949 def ProcessPendingEvents(*args, **kwargs):
a95a7133 2950 """ProcessPendingEvents(self)"""
54f9ee45 2951 return _core_.EvtHandler_ProcessPendingEvents(*args, **kwargs)
e811c8ce
RD
2952
2953 def Connect(*args, **kwargs):
a95a7133 2954 """Connect(self, int id, int lastId, int eventType, PyObject func)"""
54f9ee45 2955 return _core_.EvtHandler_Connect(*args, **kwargs)
e811c8ce
RD
2956
2957 def Disconnect(*args, **kwargs):
a95a7133 2958 """Disconnect(self, int id, int lastId=-1, wxEventType eventType=wxEVT_NULL) -> bool"""
54f9ee45 2959 return _core_.EvtHandler_Disconnect(*args, **kwargs)
e811c8ce
RD
2960
2961 def _setOORInfo(*args, **kwargs):
689b42ee 2962 """_setOORInfo(self, PyObject _self, bool incref=True)"""
54f9ee45 2963 return _core_.EvtHandler__setOORInfo(*args, **kwargs)
e811c8ce 2964
d14a1e28
RD
2965 def Bind(self, event, handler, source=None, id=wx.ID_ANY, id2=wx.ID_ANY):
2966 """
2967 Bind an event to an event handler.
2968
db3e571a
RD
2969 :param event: One of the EVT_* objects that specifies the
2970 type of event to bind,
d14a1e28 2971
db3e571a
RD
2972 :param handler: A callable object to be invoked when the
2973 event is delivered to self. Pass None to
2974 disconnect an event handler.
d14a1e28 2975
db3e571a
RD
2976 :param source: Sometimes the event originates from a
2977 different window than self, but you still
2978 want to catch it in self. (For example, a
2979 button event delivered to a frame.) By
2980 passing the source of the event, the event
2981 handling system is able to differentiate
2982 between the same event type from different
2983 controls.
d14a1e28 2984
db3e571a
RD
2985 :param id: Used to spcify the event source by ID instead
2986 of instance.
2987
2988 :param id2: Used when it is desirable to bind a handler
2989 to a range of IDs, such as with EVT_MENU_RANGE.
d14a1e28
RD
2990 """
2991 if source is not None:
2992 id = source.GetId()
2993 event.Bind(self, id, id2, handler)
2994
66c033b4
RD
2995 def Unbind(self, event, source=None, id=wx.ID_ANY, id2=wx.ID_ANY):
2996 """
2997 Disconencts the event handler binding for event from self.
2998 Returns True if successful.
2999 """
3000 if source is not None:
3001 id = source.GetId()
3002 return event.Unbind(self, id, id2)
d14a1e28 3003
d14a1e28
RD
3004
3005class EvtHandlerPtr(EvtHandler):
3006 def __init__(self, this):
3007 self.this = this
3008 if not hasattr(self,"thisown"): self.thisown = 0
3009 self.__class__ = EvtHandler
54f9ee45 3010_core_.EvtHandler_swigregister(EvtHandlerPtr)
d14a1e28
RD
3011
3012#---------------------------------------------------------------------------
3013
3014class PyEventBinder(object):
3015 """
3016 Instances of this class are used to bind specific events to event
3017 handlers.
3018 """
3019 def __init__(self, evtType, expectedIDs=0):
3020 if expectedIDs not in [0, 1, 2]:
3021 raise ValueError, "Invalid number of expectedIDs"
3022 self.expectedIDs = expectedIDs
3023
3024 if type(evtType) == list or type(evtType) == tuple:
3025 self.evtType = evtType
3026 else:
3027 self.evtType = [evtType]
3028
3029
3030 def Bind(self, target, id1, id2, function):
3031 """Bind this set of event types to target."""
3032 for et in self.evtType:
3033 target.Connect(id1, id2, et, function)
3034
66c033b4
RD
3035
3036 def Unbind(self, target, id1, id2):
3037 """Remove an event binding."""
3038 success = 0
3039 for et in self.evtType:
3040 success += target.Disconnect(id1, id2, et)
3041 return success != 0
3042
d14a1e28
RD
3043
3044 def __call__(self, *args):
3045 """
3046 For backwards compatibility with the old EVT_* functions.
3047 Should be called with either (window, func), (window, ID,
3048 func) or (window, ID1, ID2, func) parameters depending on the
3049 type of the event.
3050 """
3051 assert len(args) == 2 + self.expectedIDs
3052 id1 = wx.ID_ANY
3053 id2 = wx.ID_ANY
3054 target = args[0]
3055 if self.expectedIDs == 0:
3056 func = args[1]
3057 elif self.expectedIDs == 1:
3058 id1 = args[1]
3059 func = args[2]
3060 elif self.expectedIDs == 2:
3061 id1 = args[1]
3062 id2 = args[2]
3063 func = args[3]
3064 else:
3065 raise ValueError, "Unexpected number of IDs"
3066
3067 self.Bind(target, id1, id2, func)
3068
3069
3070# These two are square pegs that don't fit the PyEventBinder hole...
3071def EVT_COMMAND(win, id, cmd, func):
3072 win.Connect(id, -1, cmd, func)
3073def EVT_COMMAND_RANGE(win, id1, id2, cmd, func):
3074 win.Connect(id1, id2, cmd, func)
3075
3076
3077#---------------------------------------------------------------------------
3078
3079#---------------------------------------------------------------------------
3080
54f9ee45
RD
3081EVENT_PROPAGATE_NONE = _core_.EVENT_PROPAGATE_NONE
3082EVENT_PROPAGATE_MAX = _core_.EVENT_PROPAGATE_MAX
d14a1e28 3083
e811c8ce
RD
3084def NewEventType(*args, **kwargs):
3085 """NewEventType() -> wxEventType"""
54f9ee45
RD
3086 return _core_.NewEventType(*args, **kwargs)
3087wxEVT_NULL = _core_.wxEVT_NULL
3088wxEVT_FIRST = _core_.wxEVT_FIRST
3089wxEVT_USER_FIRST = _core_.wxEVT_USER_FIRST
3090wxEVT_COMMAND_BUTTON_CLICKED = _core_.wxEVT_COMMAND_BUTTON_CLICKED
3091wxEVT_COMMAND_CHECKBOX_CLICKED = _core_.wxEVT_COMMAND_CHECKBOX_CLICKED
3092wxEVT_COMMAND_CHOICE_SELECTED = _core_.wxEVT_COMMAND_CHOICE_SELECTED
3093wxEVT_COMMAND_LISTBOX_SELECTED = _core_.wxEVT_COMMAND_LISTBOX_SELECTED
3094wxEVT_COMMAND_LISTBOX_DOUBLECLICKED = _core_.wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
3095wxEVT_COMMAND_CHECKLISTBOX_TOGGLED = _core_.wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
3096wxEVT_COMMAND_MENU_SELECTED = _core_.wxEVT_COMMAND_MENU_SELECTED
3097wxEVT_COMMAND_TOOL_CLICKED = _core_.wxEVT_COMMAND_TOOL_CLICKED
3098wxEVT_COMMAND_SLIDER_UPDATED = _core_.wxEVT_COMMAND_SLIDER_UPDATED
3099wxEVT_COMMAND_RADIOBOX_SELECTED = _core_.wxEVT_COMMAND_RADIOBOX_SELECTED
3100wxEVT_COMMAND_RADIOBUTTON_SELECTED = _core_.wxEVT_COMMAND_RADIOBUTTON_SELECTED
3101wxEVT_COMMAND_SCROLLBAR_UPDATED = _core_.wxEVT_COMMAND_SCROLLBAR_UPDATED
3102wxEVT_COMMAND_VLBOX_SELECTED = _core_.wxEVT_COMMAND_VLBOX_SELECTED
3103wxEVT_COMMAND_COMBOBOX_SELECTED = _core_.wxEVT_COMMAND_COMBOBOX_SELECTED
3104wxEVT_COMMAND_TOOL_RCLICKED = _core_.wxEVT_COMMAND_TOOL_RCLICKED
3105wxEVT_COMMAND_TOOL_ENTER = _core_.wxEVT_COMMAND_TOOL_ENTER
3106wxEVT_LEFT_DOWN = _core_.wxEVT_LEFT_DOWN
3107wxEVT_LEFT_UP = _core_.wxEVT_LEFT_UP
3108wxEVT_MIDDLE_DOWN = _core_.wxEVT_MIDDLE_DOWN
3109wxEVT_MIDDLE_UP = _core_.wxEVT_MIDDLE_UP
3110wxEVT_RIGHT_DOWN = _core_.wxEVT_RIGHT_DOWN
3111wxEVT_RIGHT_UP = _core_.wxEVT_RIGHT_UP
3112wxEVT_MOTION = _core_.wxEVT_MOTION
3113wxEVT_ENTER_WINDOW = _core_.wxEVT_ENTER_WINDOW
3114wxEVT_LEAVE_WINDOW = _core_.wxEVT_LEAVE_WINDOW
3115wxEVT_LEFT_DCLICK = _core_.wxEVT_LEFT_DCLICK
3116wxEVT_MIDDLE_DCLICK = _core_.wxEVT_MIDDLE_DCLICK
3117wxEVT_RIGHT_DCLICK = _core_.wxEVT_RIGHT_DCLICK
3118wxEVT_SET_FOCUS = _core_.wxEVT_SET_FOCUS
3119wxEVT_KILL_FOCUS = _core_.wxEVT_KILL_FOCUS
3120wxEVT_CHILD_FOCUS = _core_.wxEVT_CHILD_FOCUS
3121wxEVT_MOUSEWHEEL = _core_.wxEVT_MOUSEWHEEL
3122wxEVT_NC_LEFT_DOWN = _core_.wxEVT_NC_LEFT_DOWN
3123wxEVT_NC_LEFT_UP = _core_.wxEVT_NC_LEFT_UP
3124wxEVT_NC_MIDDLE_DOWN = _core_.wxEVT_NC_MIDDLE_DOWN
3125wxEVT_NC_MIDDLE_UP = _core_.wxEVT_NC_MIDDLE_UP
3126wxEVT_NC_RIGHT_DOWN = _core_.wxEVT_NC_RIGHT_DOWN
3127wxEVT_NC_RIGHT_UP = _core_.wxEVT_NC_RIGHT_UP
3128wxEVT_NC_MOTION = _core_.wxEVT_NC_MOTION
3129wxEVT_NC_ENTER_WINDOW = _core_.wxEVT_NC_ENTER_WINDOW
3130wxEVT_NC_LEAVE_WINDOW = _core_.wxEVT_NC_LEAVE_WINDOW
3131wxEVT_NC_LEFT_DCLICK = _core_.wxEVT_NC_LEFT_DCLICK
3132wxEVT_NC_MIDDLE_DCLICK = _core_.wxEVT_NC_MIDDLE_DCLICK
3133wxEVT_NC_RIGHT_DCLICK = _core_.wxEVT_NC_RIGHT_DCLICK
3134wxEVT_CHAR = _core_.wxEVT_CHAR
3135wxEVT_CHAR_HOOK = _core_.wxEVT_CHAR_HOOK
3136wxEVT_NAVIGATION_KEY = _core_.wxEVT_NAVIGATION_KEY
3137wxEVT_KEY_DOWN = _core_.wxEVT_KEY_DOWN
3138wxEVT_KEY_UP = _core_.wxEVT_KEY_UP
3139wxEVT_HOTKEY = _core_.wxEVT_HOTKEY
3140wxEVT_SET_CURSOR = _core_.wxEVT_SET_CURSOR
3141wxEVT_SCROLL_TOP = _core_.wxEVT_SCROLL_TOP
3142wxEVT_SCROLL_BOTTOM = _core_.wxEVT_SCROLL_BOTTOM
3143wxEVT_SCROLL_LINEUP = _core_.wxEVT_SCROLL_LINEUP
3144wxEVT_SCROLL_LINEDOWN = _core_.wxEVT_SCROLL_LINEDOWN
3145wxEVT_SCROLL_PAGEUP = _core_.wxEVT_SCROLL_PAGEUP
3146wxEVT_SCROLL_PAGEDOWN = _core_.wxEVT_SCROLL_PAGEDOWN
3147wxEVT_SCROLL_THUMBTRACK = _core_.wxEVT_SCROLL_THUMBTRACK
3148wxEVT_SCROLL_THUMBRELEASE = _core_.wxEVT_SCROLL_THUMBRELEASE
3149wxEVT_SCROLL_ENDSCROLL = _core_.wxEVT_SCROLL_ENDSCROLL
3150wxEVT_SCROLLWIN_TOP = _core_.wxEVT_SCROLLWIN_TOP
3151wxEVT_SCROLLWIN_BOTTOM = _core_.wxEVT_SCROLLWIN_BOTTOM
3152wxEVT_SCROLLWIN_LINEUP = _core_.wxEVT_SCROLLWIN_LINEUP
3153wxEVT_SCROLLWIN_LINEDOWN = _core_.wxEVT_SCROLLWIN_LINEDOWN
3154wxEVT_SCROLLWIN_PAGEUP = _core_.wxEVT_SCROLLWIN_PAGEUP
3155wxEVT_SCROLLWIN_PAGEDOWN = _core_.wxEVT_SCROLLWIN_PAGEDOWN
3156wxEVT_SCROLLWIN_THUMBTRACK = _core_.wxEVT_SCROLLWIN_THUMBTRACK
3157wxEVT_SCROLLWIN_THUMBRELEASE = _core_.wxEVT_SCROLLWIN_THUMBRELEASE
3158wxEVT_SIZE = _core_.wxEVT_SIZE
3159wxEVT_MOVE = _core_.wxEVT_MOVE
3160wxEVT_CLOSE_WINDOW = _core_.wxEVT_CLOSE_WINDOW
3161wxEVT_END_SESSION = _core_.wxEVT_END_SESSION
3162wxEVT_QUERY_END_SESSION = _core_.wxEVT_QUERY_END_SESSION
3163wxEVT_ACTIVATE_APP = _core_.wxEVT_ACTIVATE_APP
3164wxEVT_POWER = _core_.wxEVT_POWER
3165wxEVT_ACTIVATE = _core_.wxEVT_ACTIVATE
3166wxEVT_CREATE = _core_.wxEVT_CREATE
3167wxEVT_DESTROY = _core_.wxEVT_DESTROY
3168wxEVT_SHOW = _core_.wxEVT_SHOW
3169wxEVT_ICONIZE = _core_.wxEVT_ICONIZE
3170wxEVT_MAXIMIZE = _core_.wxEVT_MAXIMIZE
3171wxEVT_MOUSE_CAPTURE_CHANGED = _core_.wxEVT_MOUSE_CAPTURE_CHANGED
3172wxEVT_PAINT = _core_.wxEVT_PAINT
3173wxEVT_ERASE_BACKGROUND = _core_.wxEVT_ERASE_BACKGROUND
3174wxEVT_NC_PAINT = _core_.wxEVT_NC_PAINT
3175wxEVT_PAINT_ICON = _core_.wxEVT_PAINT_ICON
3176wxEVT_MENU_OPEN = _core_.wxEVT_MENU_OPEN
3177wxEVT_MENU_CLOSE = _core_.wxEVT_MENU_CLOSE
3178wxEVT_MENU_HIGHLIGHT = _core_.wxEVT_MENU_HIGHLIGHT
3179wxEVT_CONTEXT_MENU = _core_.wxEVT_CONTEXT_MENU
3180wxEVT_SYS_COLOUR_CHANGED = _core_.wxEVT_SYS_COLOUR_CHANGED
3181wxEVT_DISPLAY_CHANGED = _core_.wxEVT_DISPLAY_CHANGED
3182wxEVT_SETTING_CHANGED = _core_.wxEVT_SETTING_CHANGED
3183wxEVT_QUERY_NEW_PALETTE = _core_.wxEVT_QUERY_NEW_PALETTE
3184wxEVT_PALETTE_CHANGED = _core_.wxEVT_PALETTE_CHANGED
3185wxEVT_DROP_FILES = _core_.wxEVT_DROP_FILES
3186wxEVT_DRAW_ITEM = _core_.wxEVT_DRAW_ITEM
3187wxEVT_MEASURE_ITEM = _core_.wxEVT_MEASURE_ITEM
3188wxEVT_COMPARE_ITEM = _core_.wxEVT_COMPARE_ITEM
3189wxEVT_INIT_DIALOG = _core_.wxEVT_INIT_DIALOG
3190wxEVT_IDLE = _core_.wxEVT_IDLE
3191wxEVT_UPDATE_UI = _core_.wxEVT_UPDATE_UI
3192wxEVT_SIZING = _core_.wxEVT_SIZING
3193wxEVT_MOVING = _core_.wxEVT_MOVING
88c6b281 3194wxEVT_HIBERNATE = _core_.wxEVT_HIBERNATE
54f9ee45
RD
3195wxEVT_COMMAND_LEFT_CLICK = _core_.wxEVT_COMMAND_LEFT_CLICK
3196wxEVT_COMMAND_LEFT_DCLICK = _core_.wxEVT_COMMAND_LEFT_DCLICK
3197wxEVT_COMMAND_RIGHT_CLICK = _core_.wxEVT_COMMAND_RIGHT_CLICK
3198wxEVT_COMMAND_RIGHT_DCLICK = _core_.wxEVT_COMMAND_RIGHT_DCLICK
3199wxEVT_COMMAND_SET_FOCUS = _core_.wxEVT_COMMAND_SET_FOCUS
3200wxEVT_COMMAND_KILL_FOCUS = _core_.wxEVT_COMMAND_KILL_FOCUS
3201wxEVT_COMMAND_ENTER = _core_.wxEVT_COMMAND_ENTER
d14a1e28
RD
3202#
3203# Create some event binders
3204EVT_SIZE = wx.PyEventBinder( wxEVT_SIZE )
3205EVT_SIZING = wx.PyEventBinder( wxEVT_SIZING )
3206EVT_MOVE = wx.PyEventBinder( wxEVT_MOVE )
3207EVT_MOVING = wx.PyEventBinder( wxEVT_MOVING )
3208EVT_CLOSE = wx.PyEventBinder( wxEVT_CLOSE_WINDOW )
3209EVT_END_SESSION = wx.PyEventBinder( wxEVT_END_SESSION )
3210EVT_QUERY_END_SESSION = wx.PyEventBinder( wxEVT_QUERY_END_SESSION )
3211EVT_PAINT = wx.PyEventBinder( wxEVT_PAINT )
3212EVT_NC_PAINT = wx.PyEventBinder( wxEVT_NC_PAINT )
3213EVT_ERASE_BACKGROUND = wx.PyEventBinder( wxEVT_ERASE_BACKGROUND )
3214EVT_CHAR = wx.PyEventBinder( wxEVT_CHAR )
3215EVT_KEY_DOWN = wx.PyEventBinder( wxEVT_KEY_DOWN )
3216EVT_KEY_UP = wx.PyEventBinder( wxEVT_KEY_UP )
3217EVT_HOTKEY = wx.PyEventBinder( wxEVT_HOTKEY, 1)
3218EVT_CHAR_HOOK = wx.PyEventBinder( wxEVT_CHAR_HOOK )
3219EVT_MENU_OPEN = wx.PyEventBinder( wxEVT_MENU_OPEN )
3220EVT_MENU_CLOSE = wx.PyEventBinder( wxEVT_MENU_CLOSE )
3221EVT_MENU_HIGHLIGHT = wx.PyEventBinder( wxEVT_MENU_HIGHLIGHT, 1)
3222EVT_MENU_HIGHLIGHT_ALL = wx.PyEventBinder( wxEVT_MENU_HIGHLIGHT )
3223EVT_SET_FOCUS = wx.PyEventBinder( wxEVT_SET_FOCUS )
3224EVT_KILL_FOCUS = wx.PyEventBinder( wxEVT_KILL_FOCUS )
3225EVT_CHILD_FOCUS = wx.PyEventBinder( wxEVT_CHILD_FOCUS )
3226EVT_ACTIVATE = wx.PyEventBinder( wxEVT_ACTIVATE )
3227EVT_ACTIVATE_APP = wx.PyEventBinder( wxEVT_ACTIVATE_APP )
88c6b281 3228EVT_HIBERNATE = wx.PyEventBinder( wxEVT_HIBERNATE )
d14a1e28
RD
3229EVT_END_SESSION = wx.PyEventBinder( wxEVT_END_SESSION )
3230EVT_QUERY_END_SESSION = wx.PyEventBinder( wxEVT_QUERY_END_SESSION )
3231EVT_DROP_FILES = wx.PyEventBinder( wxEVT_DROP_FILES )
3232EVT_INIT_DIALOG = wx.PyEventBinder( wxEVT_INIT_DIALOG )
3233EVT_SYS_COLOUR_CHANGED = wx.PyEventBinder( wxEVT_SYS_COLOUR_CHANGED )
3234EVT_DISPLAY_CHANGED = wx.PyEventBinder( wxEVT_DISPLAY_CHANGED )
3235EVT_SHOW = wx.PyEventBinder( wxEVT_SHOW )
3236EVT_MAXIMIZE = wx.PyEventBinder( wxEVT_MAXIMIZE )
3237EVT_ICONIZE = wx.PyEventBinder( wxEVT_ICONIZE )
3238EVT_NAVIGATION_KEY = wx.PyEventBinder( wxEVT_NAVIGATION_KEY )
3239EVT_PALETTE_CHANGED = wx.PyEventBinder( wxEVT_PALETTE_CHANGED )
3240EVT_QUERY_NEW_PALETTE = wx.PyEventBinder( wxEVT_QUERY_NEW_PALETTE )
3241EVT_WINDOW_CREATE = wx.PyEventBinder( wxEVT_CREATE )
3242EVT_WINDOW_DESTROY = wx.PyEventBinder( wxEVT_DESTROY )
3243EVT_SET_CURSOR = wx.PyEventBinder( wxEVT_SET_CURSOR )
3244EVT_MOUSE_CAPTURE_CHANGED = wx.PyEventBinder( wxEVT_MOUSE_CAPTURE_CHANGED )
3245
3246EVT_LEFT_DOWN = wx.PyEventBinder( wxEVT_LEFT_DOWN )
3247EVT_LEFT_UP = wx.PyEventBinder( wxEVT_LEFT_UP )
3248EVT_MIDDLE_DOWN = wx.PyEventBinder( wxEVT_MIDDLE_DOWN )
3249EVT_MIDDLE_UP = wx.PyEventBinder( wxEVT_MIDDLE_UP )
3250EVT_RIGHT_DOWN = wx.PyEventBinder( wxEVT_RIGHT_DOWN )
3251EVT_RIGHT_UP = wx.PyEventBinder( wxEVT_RIGHT_UP )
3252EVT_MOTION = wx.PyEventBinder( wxEVT_MOTION )
3253EVT_LEFT_DCLICK = wx.PyEventBinder( wxEVT_LEFT_DCLICK )
3254EVT_MIDDLE_DCLICK = wx.PyEventBinder( wxEVT_MIDDLE_DCLICK )
3255EVT_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_RIGHT_DCLICK )
3256EVT_LEAVE_WINDOW = wx.PyEventBinder( wxEVT_LEAVE_WINDOW )
3257EVT_ENTER_WINDOW = wx.PyEventBinder( wxEVT_ENTER_WINDOW )
3258EVT_MOUSEWHEEL = wx.PyEventBinder( wxEVT_MOUSEWHEEL )
3259
3260EVT_MOUSE_EVENTS = wx.PyEventBinder([ wxEVT_LEFT_DOWN,
3261 wxEVT_LEFT_UP,
3262 wxEVT_MIDDLE_DOWN,
3263 wxEVT_MIDDLE_UP,
3264 wxEVT_RIGHT_DOWN,
3265 wxEVT_RIGHT_UP,
3266 wxEVT_MOTION,
3267 wxEVT_LEFT_DCLICK,
3268 wxEVT_MIDDLE_DCLICK,
3269 wxEVT_RIGHT_DCLICK,
3270 wxEVT_ENTER_WINDOW,
3271 wxEVT_LEAVE_WINDOW,
3272 wxEVT_MOUSEWHEEL
3273 ])
3274
3275
3276# Scrolling from wxWindow (sent to wxScrolledWindow)
3277EVT_SCROLLWIN = wx.PyEventBinder([ wxEVT_SCROLLWIN_TOP,
3278 wxEVT_SCROLLWIN_BOTTOM,
3279 wxEVT_SCROLLWIN_LINEUP,
3280 wxEVT_SCROLLWIN_LINEDOWN,
3281 wxEVT_SCROLLWIN_PAGEUP,
3282 wxEVT_SCROLLWIN_PAGEDOWN,
3283 wxEVT_SCROLLWIN_THUMBTRACK,
3284 wxEVT_SCROLLWIN_THUMBRELEASE,
3285 ])
3286
3287EVT_SCROLLWIN_TOP = wx.PyEventBinder( wxEVT_SCROLLWIN_TOP )
3288EVT_SCROLLWIN_BOTTOM = wx.PyEventBinder( wxEVT_SCROLLWIN_BOTTOM )
3289EVT_SCROLLWIN_LINEUP = wx.PyEventBinder( wxEVT_SCROLLWIN_LINEUP )
3290EVT_SCROLLWIN_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLLWIN_LINEDOWN )
3291EVT_SCROLLWIN_PAGEUP = wx.PyEventBinder( wxEVT_SCROLLWIN_PAGEUP )
3292EVT_SCROLLWIN_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLLWIN_PAGEDOWN )
3293EVT_SCROLLWIN_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLLWIN_THUMBTRACK )
3294EVT_SCROLLWIN_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLLWIN_THUMBRELEASE )
3295
3296# Scrolling from wxSlider and wxScrollBar
3297EVT_SCROLL = wx.PyEventBinder([ wxEVT_SCROLL_TOP,
3298 wxEVT_SCROLL_BOTTOM,
3299 wxEVT_SCROLL_LINEUP,
3300 wxEVT_SCROLL_LINEDOWN,
3301 wxEVT_SCROLL_PAGEUP,
3302 wxEVT_SCROLL_PAGEDOWN,
3303 wxEVT_SCROLL_THUMBTRACK,
3304 wxEVT_SCROLL_THUMBRELEASE,
3305 wxEVT_SCROLL_ENDSCROLL,
3306 ])
3307
3308EVT_SCROLL_TOP = wx.PyEventBinder( wxEVT_SCROLL_TOP )
3309EVT_SCROLL_BOTTOM = wx.PyEventBinder( wxEVT_SCROLL_BOTTOM )
3310EVT_SCROLL_LINEUP = wx.PyEventBinder( wxEVT_SCROLL_LINEUP )
3311EVT_SCROLL_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLL_LINEDOWN )
3312EVT_SCROLL_PAGEUP = wx.PyEventBinder( wxEVT_SCROLL_PAGEUP )
3313EVT_SCROLL_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLL_PAGEDOWN )
3314EVT_SCROLL_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLL_THUMBTRACK )
3315EVT_SCROLL_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE )
3316EVT_SCROLL_ENDSCROLL = wx.PyEventBinder( wxEVT_SCROLL_ENDSCROLL )
3317
3318# Scrolling from wxSlider and wxScrollBar, with an id
3319EVT_COMMAND_SCROLL = wx.PyEventBinder([ wxEVT_SCROLL_TOP,
3320 wxEVT_SCROLL_BOTTOM,
3321 wxEVT_SCROLL_LINEUP,
3322 wxEVT_SCROLL_LINEDOWN,
3323 wxEVT_SCROLL_PAGEUP,
3324 wxEVT_SCROLL_PAGEDOWN,
3325 wxEVT_SCROLL_THUMBTRACK,
3326 wxEVT_SCROLL_THUMBRELEASE,
3327 wxEVT_SCROLL_ENDSCROLL,
3328 ], 1)
3329
3330EVT_COMMAND_SCROLL_TOP = wx.PyEventBinder( wxEVT_SCROLL_TOP, 1)
3331EVT_COMMAND_SCROLL_BOTTOM = wx.PyEventBinder( wxEVT_SCROLL_BOTTOM, 1)
3332EVT_COMMAND_SCROLL_LINEUP = wx.PyEventBinder( wxEVT_SCROLL_LINEUP, 1)
3333EVT_COMMAND_SCROLL_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLL_LINEDOWN, 1)
3334EVT_COMMAND_SCROLL_PAGEUP = wx.PyEventBinder( wxEVT_SCROLL_PAGEUP, 1)
3335EVT_COMMAND_SCROLL_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLL_PAGEDOWN, 1)
3336EVT_COMMAND_SCROLL_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLL_THUMBTRACK, 1)
3337EVT_COMMAND_SCROLL_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE, 1)
3338EVT_COMMAND_SCROLL_ENDSCROLL = wx.PyEventBinder( wxEVT_SCROLL_ENDSCROLL, 1)
3339
d14a1e28
RD
3340EVT_BUTTON = wx.PyEventBinder( wxEVT_COMMAND_BUTTON_CLICKED, 1)
3341EVT_CHECKBOX = wx.PyEventBinder( wxEVT_COMMAND_CHECKBOX_CLICKED, 1)
3342EVT_CHOICE = wx.PyEventBinder( wxEVT_COMMAND_CHOICE_SELECTED, 1)
3343EVT_LISTBOX = wx.PyEventBinder( wxEVT_COMMAND_LISTBOX_SELECTED, 1)
3344EVT_LISTBOX_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, 1)
3345EVT_MENU = wx.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED, 1)
3346EVT_MENU_RANGE = wx.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED, 2)
3347EVT_SLIDER = wx.PyEventBinder( wxEVT_COMMAND_SLIDER_UPDATED, 1)
3348EVT_RADIOBOX = wx.PyEventBinder( wxEVT_COMMAND_RADIOBOX_SELECTED, 1)
3349EVT_RADIOBUTTON = wx.PyEventBinder( wxEVT_COMMAND_RADIOBUTTON_SELECTED, 1)
3350
3351EVT_SCROLLBAR = wx.PyEventBinder( wxEVT_COMMAND_SCROLLBAR_UPDATED, 1)
3352EVT_VLBOX = wx.PyEventBinder( wxEVT_COMMAND_VLBOX_SELECTED, 1)
3353EVT_COMBOBOX = wx.PyEventBinder( wxEVT_COMMAND_COMBOBOX_SELECTED, 1)
3354EVT_TOOL = wx.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED, 1)
3355EVT_TOOL_RANGE = wx.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED, 2)
3356EVT_TOOL_RCLICKED = wx.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED, 1)
3357EVT_TOOL_RCLICKED_RANGE = wx.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED, 2)
3358EVT_TOOL_ENTER = wx.PyEventBinder( wxEVT_COMMAND_TOOL_ENTER, 1)
3359EVT_CHECKLISTBOX = wx.PyEventBinder( wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, 1)
3360
3361
3362EVT_COMMAND_LEFT_CLICK = wx.PyEventBinder( wxEVT_COMMAND_LEFT_CLICK, 1)
3363EVT_COMMAND_LEFT_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_LEFT_DCLICK, 1)
3364EVT_COMMAND_RIGHT_CLICK = wx.PyEventBinder( wxEVT_COMMAND_RIGHT_CLICK, 1)
3365EVT_COMMAND_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_RIGHT_DCLICK, 1)
3366EVT_COMMAND_SET_FOCUS = wx.PyEventBinder( wxEVT_COMMAND_SET_FOCUS, 1)
3367EVT_COMMAND_KILL_FOCUS = wx.PyEventBinder( wxEVT_COMMAND_KILL_FOCUS, 1)
3368EVT_COMMAND_ENTER = wx.PyEventBinder( wxEVT_COMMAND_ENTER, 1)
3369
3370EVT_IDLE = wx.PyEventBinder( wxEVT_IDLE )
3371
3372EVT_UPDATE_UI = wx.PyEventBinder( wxEVT_UPDATE_UI, 1)
3373EVT_UPDATE_UI_RANGE = wx.PyEventBinder( wxEVT_UPDATE_UI, 2)
3374
3375EVT_CONTEXT_MENU = wx.PyEventBinder( wxEVT_CONTEXT_MENU )
3376
3377
3378
3379#---------------------------------------------------------------------------
3380
3381class Event(Object):
093d3ff1 3382 """Proxy of C++ Event class"""
e811c8ce
RD
3383 def __init__(self): raise RuntimeError, "No constructor defined"
3384 def __repr__(self):
3385 return "<%s.%s; proxy of C++ wxEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
54f9ee45 3386 def __del__(self, destroy=_core_.delete_Event):
a95a7133 3387 """__del__(self)"""
d14a1e28
RD
3388 try:
3389 if self.thisown: destroy(self)
3390 except: pass
e811c8ce
RD
3391
3392 def SetEventType(*args, **kwargs):
a95a7133 3393 """SetEventType(self, wxEventType typ)"""
54f9ee45 3394 return _core_.Event_SetEventType(*args, **kwargs)
e811c8ce
RD
3395
3396 def GetEventType(*args, **kwargs):
a95a7133 3397 """GetEventType(self) -> wxEventType"""
54f9ee45 3398 return _core_.Event_GetEventType(*args, **kwargs)
e811c8ce
RD
3399
3400 def GetEventObject(*args, **kwargs):
a95a7133 3401 """GetEventObject(self) -> Object"""
54f9ee45 3402 return _core_.Event_GetEventObject(*args, **kwargs)
e811c8ce
RD
3403
3404 def SetEventObject(*args, **kwargs):
a95a7133 3405 """SetEventObject(self, Object obj)"""
54f9ee45 3406 return _core_.Event_SetEventObject(*args, **kwargs)
e811c8ce
RD
3407
3408 def GetTimestamp(*args, **kwargs):
a95a7133 3409 """GetTimestamp(self) -> long"""
54f9ee45 3410 return _core_.Event_GetTimestamp(*args, **kwargs)
e811c8ce
RD
3411
3412 def SetTimestamp(*args, **kwargs):
a95a7133 3413 """SetTimestamp(self, long ts=0)"""
54f9ee45 3414 return _core_.Event_SetTimestamp(*args, **kwargs)
e811c8ce
RD
3415
3416 def GetId(*args, **kwargs):
a95a7133 3417 """GetId(self) -> int"""
54f9ee45 3418 return _core_.Event_GetId(*args, **kwargs)
e811c8ce
RD
3419
3420 def SetId(*args, **kwargs):
a95a7133 3421 """SetId(self, int Id)"""
54f9ee45 3422 return _core_.Event_SetId(*args, **kwargs)
e811c8ce
RD
3423
3424 def IsCommandEvent(*args, **kwargs):
a95a7133 3425 """IsCommandEvent(self) -> bool"""
54f9ee45 3426 return _core_.Event_IsCommandEvent(*args, **kwargs)
e811c8ce
RD
3427
3428 def Skip(*args, **kwargs):
51b83b37
RD
3429 """
3430 Skip(self, bool skip=True)
3431
3432 Called by an event handler, it controls whether additional event
3433 handlers bound to this event will be called after the current event
3434 handler returns. Skip(false) (the default setting) will prevent
3435 additional event handlers from being called and control will be
3436 returned to the sender of the event immediately after the current
3437 handler has finished. Skip(True) will cause the event processing
3438 system to continue searching for a handler function for this event.
3439
3440 """
54f9ee45 3441 return _core_.Event_Skip(*args, **kwargs)
e811c8ce
RD
3442
3443 def GetSkipped(*args, **kwargs):
a95a7133 3444 """GetSkipped(self) -> bool"""
54f9ee45 3445 return _core_.Event_GetSkipped(*args, **kwargs)
e811c8ce
RD
3446
3447 def ShouldPropagate(*args, **kwargs):
a95a7133 3448 """ShouldPropagate(self) -> bool"""
54f9ee45 3449 return _core_.Event_ShouldPropagate(*args, **kwargs)
e811c8ce
RD
3450
3451 def StopPropagation(*args, **kwargs):
a95a7133 3452 """StopPropagation(self) -> int"""
54f9ee45 3453 return _core_.Event_StopPropagation(*args, **kwargs)
e811c8ce
RD
3454
3455 def ResumePropagation(*args, **kwargs):
a95a7133 3456 """ResumePropagation(self, int propagationLevel)"""
54f9ee45 3457 return _core_.Event_ResumePropagation(*args, **kwargs)
e811c8ce
RD
3458
3459 def Clone(*args, **kwargs):
a95a7133 3460 """Clone(self) -> Event"""
54f9ee45 3461 return _core_.Event_Clone(*args, **kwargs)
e811c8ce 3462
d14a1e28
RD
3463
3464class EventPtr(Event):
3465 def __init__(self, this):
3466 self.this = this
3467 if not hasattr(self,"thisown"): self.thisown = 0
3468 self.__class__ = Event
54f9ee45 3469_core_.Event_swigregister(EventPtr)
d14a1e28
RD
3470
3471#---------------------------------------------------------------------------
3472
3473class PropagationDisabler(object):
093d3ff1 3474 """Proxy of C++ PropagationDisabler class"""
e811c8ce
RD
3475 def __repr__(self):
3476 return "<%s.%s; proxy of C++ wxPropagationDisabler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3477 def __init__(self, *args, **kwargs):
a95a7133 3478 """__init__(self, Event event) -> PropagationDisabler"""
54f9ee45 3479 newobj = _core_.new_PropagationDisabler(*args, **kwargs)
d14a1e28
RD
3480 self.this = newobj.this
3481 self.thisown = 1
3482 del newobj.thisown
54f9ee45 3483 def __del__(self, destroy=_core_.delete_PropagationDisabler):
a95a7133 3484 """__del__(self)"""
d14a1e28
RD
3485 try:
3486 if self.thisown: destroy(self)
3487 except: pass
e811c8ce 3488
d14a1e28
RD
3489
3490class PropagationDisablerPtr(PropagationDisabler):
3491 def __init__(self, this):
3492 self.this = this
3493 if not hasattr(self,"thisown"): self.thisown = 0
3494 self.__class__ = PropagationDisabler
54f9ee45 3495_core_.PropagationDisabler_swigregister(PropagationDisablerPtr)
d14a1e28
RD
3496
3497class PropagateOnce(object):
093d3ff1 3498 """Proxy of C++ PropagateOnce class"""
e811c8ce
RD
3499 def __repr__(self):
3500 return "<%s.%s; proxy of C++ wxPropagateOnce instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3501 def __init__(self, *args, **kwargs):
a95a7133 3502 """__init__(self, Event event) -> PropagateOnce"""
54f9ee45 3503 newobj = _core_.new_PropagateOnce(*args, **kwargs)
d14a1e28
RD
3504 self.this = newobj.this
3505 self.thisown = 1
3506 del newobj.thisown
54f9ee45 3507 def __del__(self, destroy=_core_.delete_PropagateOnce):
a95a7133 3508 """__del__(self)"""
d14a1e28
RD
3509 try:
3510 if self.thisown: destroy(self)
3511 except: pass
e811c8ce 3512
d14a1e28
RD
3513
3514class PropagateOncePtr(PropagateOnce):
3515 def __init__(self, this):
3516 self.this = this
3517 if not hasattr(self,"thisown"): self.thisown = 0
3518 self.__class__ = PropagateOnce
54f9ee45 3519_core_.PropagateOnce_swigregister(PropagateOncePtr)
d14a1e28
RD
3520
3521#---------------------------------------------------------------------------
3522
3523class CommandEvent(Event):
093d3ff1 3524 """Proxy of C++ CommandEvent class"""
e811c8ce
RD
3525 def __repr__(self):
3526 return "<%s.%s; proxy of C++ wxCommandEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3527 def __init__(self, *args, **kwargs):
a95a7133 3528 """__init__(self, wxEventType commandType=wxEVT_NULL, int winid=0) -> CommandEvent"""
54f9ee45 3529 newobj = _core_.new_CommandEvent(*args, **kwargs)
d14a1e28
RD
3530 self.this = newobj.this
3531 self.thisown = 1
3532 del newobj.thisown
e811c8ce 3533 def GetSelection(*args, **kwargs):
a95a7133 3534 """GetSelection(self) -> int"""
54f9ee45 3535 return _core_.CommandEvent_GetSelection(*args, **kwargs)
e811c8ce
RD
3536
3537 def SetString(*args, **kwargs):
a95a7133 3538 """SetString(self, String s)"""
54f9ee45 3539 return _core_.CommandEvent_SetString(*args, **kwargs)
e811c8ce
RD
3540
3541 def GetString(*args, **kwargs):
a95a7133 3542 """GetString(self) -> String"""
54f9ee45 3543 return _core_.CommandEvent_GetString(*args, **kwargs)
e811c8ce
RD
3544
3545 def IsChecked(*args, **kwargs):
a95a7133 3546 """IsChecked(self) -> bool"""
54f9ee45 3547 return _core_.CommandEvent_IsChecked(*args, **kwargs)
e811c8ce 3548
242b7b46 3549 Checked = IsChecked
e811c8ce 3550 def IsSelection(*args, **kwargs):
a95a7133 3551 """IsSelection(self) -> bool"""
54f9ee45 3552 return _core_.CommandEvent_IsSelection(*args, **kwargs)
e811c8ce
RD
3553
3554 def SetExtraLong(*args, **kwargs):
a95a7133 3555 """SetExtraLong(self, long extraLong)"""
54f9ee45 3556 return _core_.CommandEvent_SetExtraLong(*args, **kwargs)
e811c8ce
RD
3557
3558 def GetExtraLong(*args, **kwargs):
a95a7133 3559 """GetExtraLong(self) -> long"""
54f9ee45 3560 return _core_.CommandEvent_GetExtraLong(*args, **kwargs)
e811c8ce
RD
3561
3562 def SetInt(*args, **kwargs):
a95a7133 3563 """SetInt(self, int i)"""
54f9ee45 3564 return _core_.CommandEvent_SetInt(*args, **kwargs)
e811c8ce
RD
3565
3566 def GetInt(*args, **kwargs):
a95a7133 3567 """GetInt(self) -> long"""
54f9ee45 3568 return _core_.CommandEvent_GetInt(*args, **kwargs)
e811c8ce
RD
3569
3570 def Clone(*args, **kwargs):
a95a7133 3571 """Clone(self) -> Event"""
54f9ee45 3572 return _core_.CommandEvent_Clone(*args, **kwargs)
e811c8ce 3573
d14a1e28
RD
3574
3575class CommandEventPtr(CommandEvent):
3576 def __init__(self, this):
3577 self.this = this
3578 if not hasattr(self,"thisown"): self.thisown = 0
3579 self.__class__ = CommandEvent
54f9ee45 3580_core_.CommandEvent_swigregister(CommandEventPtr)
d14a1e28
RD
3581
3582#---------------------------------------------------------------------------
3583
3584class NotifyEvent(CommandEvent):
093d3ff1 3585 """Proxy of C++ NotifyEvent class"""
e811c8ce
RD
3586 def __repr__(self):
3587 return "<%s.%s; proxy of C++ wxNotifyEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3588 def __init__(self, *args, **kwargs):
a95a7133 3589 """__init__(self, wxEventType commandType=wxEVT_NULL, int winid=0) -> NotifyEvent"""
54f9ee45 3590 newobj = _core_.new_NotifyEvent(*args, **kwargs)
d14a1e28
RD
3591 self.this = newobj.this
3592 self.thisown = 1
3593 del newobj.thisown
e811c8ce 3594 def Veto(*args, **kwargs):
a95a7133 3595 """Veto(self)"""
54f9ee45 3596 return _core_.NotifyEvent_Veto(*args, **kwargs)
e811c8ce
RD
3597
3598 def Allow(*args, **kwargs):
a95a7133 3599 """Allow(self)"""
54f9ee45 3600 return _core_.NotifyEvent_Allow(*args, **kwargs)
e811c8ce
RD
3601
3602 def IsAllowed(*args, **kwargs):
a95a7133 3603 """IsAllowed(self) -> bool"""
54f9ee45 3604 return _core_.NotifyEvent_IsAllowed(*args, **kwargs)
e811c8ce 3605
d14a1e28
RD
3606
3607class NotifyEventPtr(NotifyEvent):
3608 def __init__(self, this):
3609 self.this = this
3610 if not hasattr(self,"thisown"): self.thisown = 0
3611 self.__class__ = NotifyEvent
54f9ee45 3612_core_.NotifyEvent_swigregister(NotifyEventPtr)
d14a1e28
RD
3613
3614#---------------------------------------------------------------------------
3615
3616class ScrollEvent(CommandEvent):
093d3ff1 3617 """Proxy of C++ ScrollEvent class"""
e811c8ce
RD
3618 def __repr__(self):
3619 return "<%s.%s; proxy of C++ wxScrollEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3620 def __init__(self, *args, **kwargs):
0df68c9f 3621 """
a95a7133 3622 __init__(self, wxEventType commandType=wxEVT_NULL, int winid=0, int pos=0,
0df68c9f
RD
3623 int orient=0) -> ScrollEvent
3624 """
54f9ee45 3625 newobj = _core_.new_ScrollEvent(*args, **kwargs)
d14a1e28
RD
3626 self.this = newobj.this
3627 self.thisown = 1
3628 del newobj.thisown
e811c8ce 3629 def GetOrientation(*args, **kwargs):
a95a7133 3630 """GetOrientation(self) -> int"""
54f9ee45 3631 return _core_.ScrollEvent_GetOrientation(*args, **kwargs)
e811c8ce
RD
3632
3633 def GetPosition(*args, **kwargs):
a95a7133 3634 """GetPosition(self) -> int"""
54f9ee45 3635 return _core_.ScrollEvent_GetPosition(*args, **kwargs)
e811c8ce
RD
3636
3637 def SetOrientation(*args, **kwargs):
a95a7133 3638 """SetOrientation(self, int orient)"""
54f9ee45 3639 return _core_.ScrollEvent_SetOrientation(*args, **kwargs)
e811c8ce
RD
3640
3641 def SetPosition(*args, **kwargs):
a95a7133 3642 """SetPosition(self, int pos)"""
54f9ee45 3643 return _core_.ScrollEvent_SetPosition(*args, **kwargs)
e811c8ce 3644
d14a1e28
RD
3645
3646class ScrollEventPtr(ScrollEvent):
3647 def __init__(self, this):
3648 self.this = this
3649 if not hasattr(self,"thisown"): self.thisown = 0
3650 self.__class__ = ScrollEvent
54f9ee45 3651_core_.ScrollEvent_swigregister(ScrollEventPtr)
d14a1e28
RD
3652
3653#---------------------------------------------------------------------------
3654
3655class ScrollWinEvent(Event):
093d3ff1 3656 """Proxy of C++ ScrollWinEvent class"""
e811c8ce
RD
3657 def __repr__(self):
3658 return "<%s.%s; proxy of C++ wxScrollWinEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3659 def __init__(self, *args, **kwargs):
a95a7133 3660 """__init__(self, wxEventType commandType=wxEVT_NULL, int pos=0, int orient=0) -> ScrollWinEvent"""
54f9ee45 3661 newobj = _core_.new_ScrollWinEvent(*args, **kwargs)
d14a1e28
RD
3662 self.this = newobj.this
3663 self.thisown = 1
3664 del newobj.thisown
e811c8ce 3665 def GetOrientation(*args, **kwargs):
a95a7133 3666 """GetOrientation(self) -> int"""
54f9ee45 3667 return _core_.ScrollWinEvent_GetOrientation(*args, **kwargs)
e811c8ce
RD
3668
3669 def GetPosition(*args, **kwargs):
a95a7133 3670 """GetPosition(self) -> int"""
54f9ee45 3671 return _core_.ScrollWinEvent_GetPosition(*args, **kwargs)
e811c8ce
RD
3672
3673 def SetOrientation(*args, **kwargs):
a95a7133 3674 """SetOrientation(self, int orient)"""
54f9ee45 3675 return _core_.ScrollWinEvent_SetOrientation(*args, **kwargs)
e811c8ce
RD
3676
3677 def SetPosition(*args, **kwargs):
a95a7133 3678 """SetPosition(self, int pos)"""
54f9ee45 3679 return _core_.ScrollWinEvent_SetPosition(*args, **kwargs)
e811c8ce 3680
d14a1e28
RD
3681
3682class ScrollWinEventPtr(ScrollWinEvent):
3683 def __init__(self, this):
3684 self.this = this
3685 if not hasattr(self,"thisown"): self.thisown = 0
3686 self.__class__ = ScrollWinEvent
54f9ee45 3687_core_.ScrollWinEvent_swigregister(ScrollWinEventPtr)
d14a1e28
RD
3688
3689#---------------------------------------------------------------------------
3690
54f9ee45
RD
3691MOUSE_BTN_ANY = _core_.MOUSE_BTN_ANY
3692MOUSE_BTN_NONE = _core_.MOUSE_BTN_NONE
3693MOUSE_BTN_LEFT = _core_.MOUSE_BTN_LEFT
3694MOUSE_BTN_MIDDLE = _core_.MOUSE_BTN_MIDDLE
3695MOUSE_BTN_RIGHT = _core_.MOUSE_BTN_RIGHT
d14a1e28 3696class MouseEvent(Event):
093d3ff1 3697 """Proxy of C++ MouseEvent class"""
e811c8ce
RD
3698 def __repr__(self):
3699 return "<%s.%s; proxy of C++ wxMouseEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3700 def __init__(self, *args, **kwargs):
a95a7133 3701 """__init__(self, wxEventType mouseType=wxEVT_NULL) -> MouseEvent"""
54f9ee45 3702 newobj = _core_.new_MouseEvent(*args, **kwargs)
d14a1e28
RD
3703 self.this = newobj.this
3704 self.thisown = 1
3705 del newobj.thisown
e811c8ce 3706 def IsButton(*args, **kwargs):
a95a7133 3707 """IsButton(self) -> bool"""
54f9ee45 3708 return _core_.MouseEvent_IsButton(*args, **kwargs)
e811c8ce
RD
3709
3710 def ButtonDown(*args, **kwargs):
a95a7133 3711 """ButtonDown(self, int but=MOUSE_BTN_ANY) -> bool"""
54f9ee45 3712 return _core_.MouseEvent_ButtonDown(*args, **kwargs)
e811c8ce
RD
3713
3714 def ButtonDClick(*args, **kwargs):
a95a7133 3715 """ButtonDClick(self, int but=MOUSE_BTN_ANY) -> bool"""
54f9ee45 3716 return _core_.MouseEvent_ButtonDClick(*args, **kwargs)
e811c8ce
RD
3717
3718 def ButtonUp(*args, **kwargs):
a95a7133 3719 """ButtonUp(self, int but=MOUSE_BTN_ANY) -> bool"""
54f9ee45 3720 return _core_.MouseEvent_ButtonUp(*args, **kwargs)
e811c8ce
RD
3721
3722 def Button(*args, **kwargs):
a95a7133 3723 """Button(self, int but) -> bool"""
54f9ee45 3724 return _core_.MouseEvent_Button(*args, **kwargs)
e811c8ce
RD
3725
3726 def ButtonIsDown(*args, **kwargs):
a95a7133 3727 """ButtonIsDown(self, int but) -> bool"""
54f9ee45 3728 return _core_.MouseEvent_ButtonIsDown(*args, **kwargs)
e811c8ce
RD
3729
3730 def GetButton(*args, **kwargs):
a95a7133 3731 """GetButton(self) -> int"""
54f9ee45 3732 return _core_.MouseEvent_GetButton(*args, **kwargs)
e811c8ce
RD
3733
3734 def ControlDown(*args, **kwargs):
a95a7133 3735 """ControlDown(self) -> bool"""
54f9ee45 3736 return _core_.MouseEvent_ControlDown(*args, **kwargs)
e811c8ce
RD
3737
3738 def MetaDown(*args, **kwargs):
a95a7133 3739 """MetaDown(self) -> bool"""
54f9ee45 3740 return _core_.MouseEvent_MetaDown(*args, **kwargs)
e811c8ce
RD
3741
3742 def AltDown(*args, **kwargs):
a95a7133 3743 """AltDown(self) -> bool"""
54f9ee45 3744 return _core_.MouseEvent_AltDown(*args, **kwargs)
e811c8ce
RD
3745
3746 def ShiftDown(*args, **kwargs):
a95a7133 3747 """ShiftDown(self) -> bool"""
54f9ee45 3748 return _core_.MouseEvent_ShiftDown(*args, **kwargs)
e811c8ce 3749
412d302d
RD
3750 def CmdDown(*args, **kwargs):
3751 """
3752 CmdDown(self) -> bool
3753
3754 "Cmd" is a pseudo key which is the same as Control for PC and Unix
3755 platforms but the special "Apple" (a.k.a as "Command") key on
3756 Macs: it makes often sense to use it instead of, say, `ControlDown`
3757 because Cmd key is used for the same thing under Mac as Ctrl
3758 elsewhere. The Ctrl still exists, it's just not used for this
3759 purpose. So for non-Mac platforms this is the same as `ControlDown`
3760 and Macs this is the same as `MetaDown`.
3761 """
3762 return _core_.MouseEvent_CmdDown(*args, **kwargs)
3763
e811c8ce 3764 def LeftDown(*args, **kwargs):
a95a7133 3765 """LeftDown(self) -> bool"""
54f9ee45 3766 return _core_.MouseEvent_LeftDown(*args, **kwargs)
e811c8ce
RD
3767
3768 def MiddleDown(*args, **kwargs):
a95a7133 3769 """MiddleDown(self) -> bool"""
54f9ee45 3770 return _core_.MouseEvent_MiddleDown(*args, **kwargs)
e811c8ce
RD
3771
3772 def RightDown(*args, **kwargs):
a95a7133 3773 """RightDown(self) -> bool"""
54f9ee45 3774 return _core_.MouseEvent_RightDown(*args, **kwargs)
e811c8ce
RD
3775
3776 def LeftUp(*args, **kwargs):
a95a7133 3777 """LeftUp(self) -> bool"""
54f9ee45 3778 return _core_.MouseEvent_LeftUp(*args, **kwargs)
e811c8ce
RD
3779
3780 def MiddleUp(*args, **kwargs):
a95a7133 3781 """MiddleUp(self) -> bool"""
54f9ee45 3782 return _core_.MouseEvent_MiddleUp(*args, **kwargs)
e811c8ce
RD
3783
3784 def RightUp(*args, **kwargs):
a95a7133 3785 """RightUp(self) -> bool"""
54f9ee45 3786 return _core_.MouseEvent_RightUp(*args, **kwargs)
e811c8ce
RD
3787
3788 def LeftDClick(*args, **kwargs):
a95a7133 3789 """LeftDClick(self) -> bool"""
54f9ee45 3790 return _core_.MouseEvent_LeftDClick(*args, **kwargs)
e811c8ce
RD
3791
3792 def MiddleDClick(*args, **kwargs):
a95a7133 3793 """MiddleDClick(self) -> bool"""
54f9ee45 3794 return _core_.MouseEvent_MiddleDClick(*args, **kwargs)
e811c8ce
RD
3795
3796 def RightDClick(*args, **kwargs):
a95a7133 3797 """RightDClick(self) -> bool"""
54f9ee45 3798 return _core_.MouseEvent_RightDClick(*args, **kwargs)
e811c8ce
RD
3799
3800 def LeftIsDown(*args, **kwargs):
a95a7133 3801 """LeftIsDown(self) -> bool"""
54f9ee45 3802 return _core_.MouseEvent_LeftIsDown(*args, **kwargs)
e811c8ce
RD
3803
3804 def MiddleIsDown(*args, **kwargs):
a95a7133 3805 """MiddleIsDown(self) -> bool"""
54f9ee45 3806 return _core_.MouseEvent_MiddleIsDown(*args, **kwargs)
e811c8ce
RD
3807
3808 def RightIsDown(*args, **kwargs):
a95a7133 3809 """RightIsDown(self) -> bool"""
54f9ee45 3810 return _core_.MouseEvent_RightIsDown(*args, **kwargs)
e811c8ce
RD
3811
3812 def Dragging(*args, **kwargs):
a95a7133 3813 """Dragging(self) -> bool"""
54f9ee45 3814 return _core_.MouseEvent_Dragging(*args, **kwargs)
e811c8ce
RD
3815
3816 def Moving(*args, **kwargs):
a95a7133 3817 """Moving(self) -> bool"""
54f9ee45 3818 return _core_.MouseEvent_Moving(*args, **kwargs)
e811c8ce
RD
3819
3820 def Entering(*args, **kwargs):
a95a7133 3821 """Entering(self) -> bool"""
54f9ee45 3822 return _core_.MouseEvent_Entering(*args, **kwargs)
e811c8ce
RD
3823
3824 def Leaving(*args, **kwargs):
a95a7133 3825 """Leaving(self) -> bool"""
54f9ee45 3826 return _core_.MouseEvent_Leaving(*args, **kwargs)
e811c8ce
RD
3827
3828 def GetPosition(*args, **kwargs):
0df68c9f 3829 """
a95a7133 3830 GetPosition(self) -> Point
e811c8ce 3831
41e2b43e
RD
3832 Returns the position of the mouse in window coordinates when the event
3833 happened.
0df68c9f 3834 """
54f9ee45 3835 return _core_.MouseEvent_GetPosition(*args, **kwargs)
e811c8ce
RD
3836
3837 def GetPositionTuple(*args, **kwargs):
0df68c9f
RD
3838 """
3839 GetPositionTuple() -> (x,y)
e811c8ce 3840
41e2b43e
RD
3841 Returns the position of the mouse in window coordinates when the event
3842 happened.
0df68c9f 3843 """
54f9ee45 3844 return _core_.MouseEvent_GetPositionTuple(*args, **kwargs)
e811c8ce
RD
3845
3846 def GetLogicalPosition(*args, **kwargs):
a95a7133 3847 """GetLogicalPosition(self, DC dc) -> Point"""
54f9ee45 3848 return _core_.MouseEvent_GetLogicalPosition(*args, **kwargs)
e811c8ce
RD
3849
3850 def GetX(*args, **kwargs):
a95a7133 3851 """GetX(self) -> int"""
54f9ee45 3852 return _core_.MouseEvent_GetX(*args, **kwargs)
e811c8ce
RD
3853
3854 def GetY(*args, **kwargs):
a95a7133 3855 """GetY(self) -> int"""
54f9ee45 3856 return _core_.MouseEvent_GetY(*args, **kwargs)
e811c8ce
RD
3857
3858 def GetWheelRotation(*args, **kwargs):
a95a7133 3859 """GetWheelRotation(self) -> int"""
54f9ee45 3860 return _core_.MouseEvent_GetWheelRotation(*args, **kwargs)
e811c8ce
RD
3861
3862 def GetWheelDelta(*args, **kwargs):
a95a7133 3863 """GetWheelDelta(self) -> int"""
54f9ee45 3864 return _core_.MouseEvent_GetWheelDelta(*args, **kwargs)
e811c8ce
RD
3865
3866 def GetLinesPerAction(*args, **kwargs):
a95a7133 3867 """GetLinesPerAction(self) -> int"""
54f9ee45 3868 return _core_.MouseEvent_GetLinesPerAction(*args, **kwargs)
e811c8ce
RD
3869
3870 def IsPageScroll(*args, **kwargs):
a95a7133 3871 """IsPageScroll(self) -> bool"""
54f9ee45
RD
3872 return _core_.MouseEvent_IsPageScroll(*args, **kwargs)
3873
3874 m_x = property(_core_.MouseEvent_m_x_get, _core_.MouseEvent_m_x_set)
3875 m_y = property(_core_.MouseEvent_m_y_get, _core_.MouseEvent_m_y_set)
3876 m_leftDown = property(_core_.MouseEvent_m_leftDown_get, _core_.MouseEvent_m_leftDown_set)
3877 m_middleDown = property(_core_.MouseEvent_m_middleDown_get, _core_.MouseEvent_m_middleDown_set)
3878 m_rightDown = property(_core_.MouseEvent_m_rightDown_get, _core_.MouseEvent_m_rightDown_set)
3879 m_controlDown = property(_core_.MouseEvent_m_controlDown_get, _core_.MouseEvent_m_controlDown_set)
3880 m_shiftDown = property(_core_.MouseEvent_m_shiftDown_get, _core_.MouseEvent_m_shiftDown_set)
3881 m_altDown = property(_core_.MouseEvent_m_altDown_get, _core_.MouseEvent_m_altDown_set)
3882 m_metaDown = property(_core_.MouseEvent_m_metaDown_get, _core_.MouseEvent_m_metaDown_set)
3883 m_wheelRotation = property(_core_.MouseEvent_m_wheelRotation_get, _core_.MouseEvent_m_wheelRotation_set)
3884 m_wheelDelta = property(_core_.MouseEvent_m_wheelDelta_get, _core_.MouseEvent_m_wheelDelta_set)
3885 m_linesPerAction = property(_core_.MouseEvent_m_linesPerAction_get, _core_.MouseEvent_m_linesPerAction_set)
d14a1e28
RD
3886
3887class MouseEventPtr(MouseEvent):
3888 def __init__(self, this):
3889 self.this = this
3890 if not hasattr(self,"thisown"): self.thisown = 0
3891 self.__class__ = MouseEvent
54f9ee45 3892_core_.MouseEvent_swigregister(MouseEventPtr)
d14a1e28
RD
3893
3894#---------------------------------------------------------------------------
3895
3896class SetCursorEvent(Event):
093d3ff1 3897 """Proxy of C++ SetCursorEvent class"""
e811c8ce
RD
3898 def __repr__(self):
3899 return "<%s.%s; proxy of C++ wxSetCursorEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3900 def __init__(self, *args, **kwargs):
a95a7133 3901 """__init__(self, int x=0, int y=0) -> SetCursorEvent"""
54f9ee45 3902 newobj = _core_.new_SetCursorEvent(*args, **kwargs)
d14a1e28
RD
3903 self.this = newobj.this
3904 self.thisown = 1
3905 del newobj.thisown
e811c8ce 3906 def GetX(*args, **kwargs):
a95a7133 3907 """GetX(self) -> int"""
54f9ee45 3908 return _core_.SetCursorEvent_GetX(*args, **kwargs)
e811c8ce
RD
3909
3910 def GetY(*args, **kwargs):
a95a7133 3911 """GetY(self) -> int"""
54f9ee45 3912 return _core_.SetCursorEvent_GetY(*args, **kwargs)
e811c8ce
RD
3913
3914 def SetCursor(*args, **kwargs):
a95a7133 3915 """SetCursor(self, Cursor cursor)"""
54f9ee45 3916 return _core_.SetCursorEvent_SetCursor(*args, **kwargs)
e811c8ce
RD
3917
3918 def GetCursor(*args, **kwargs):
a95a7133 3919 """GetCursor(self) -> Cursor"""
54f9ee45 3920 return _core_.SetCursorEvent_GetCursor(*args, **kwargs)
e811c8ce
RD
3921
3922 def HasCursor(*args, **kwargs):
a95a7133 3923 """HasCursor(self) -> bool"""
54f9ee45 3924 return _core_.SetCursorEvent_HasCursor(*args, **kwargs)
e811c8ce 3925
d14a1e28
RD
3926
3927class SetCursorEventPtr(SetCursorEvent):
3928 def __init__(self, this):
3929 self.this = this
3930 if not hasattr(self,"thisown"): self.thisown = 0
3931 self.__class__ = SetCursorEvent
54f9ee45 3932_core_.SetCursorEvent_swigregister(SetCursorEventPtr)
d14a1e28
RD
3933
3934#---------------------------------------------------------------------------
3935
3936class KeyEvent(Event):
093d3ff1 3937 """Proxy of C++ KeyEvent class"""
e811c8ce
RD
3938 def __repr__(self):
3939 return "<%s.%s; proxy of C++ wxKeyEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3940 def __init__(self, *args, **kwargs):
a95a7133 3941 """__init__(self, wxEventType keyType=wxEVT_NULL) -> KeyEvent"""
54f9ee45 3942 newobj = _core_.new_KeyEvent(*args, **kwargs)
d14a1e28
RD
3943 self.this = newobj.this
3944 self.thisown = 1
3945 del newobj.thisown
e811c8ce 3946 def ControlDown(*args, **kwargs):
a95a7133 3947 """ControlDown(self) -> bool"""
54f9ee45 3948 return _core_.KeyEvent_ControlDown(*args, **kwargs)
e811c8ce
RD
3949
3950 def MetaDown(*args, **kwargs):
a95a7133 3951 """MetaDown(self) -> bool"""
54f9ee45 3952 return _core_.KeyEvent_MetaDown(*args, **kwargs)
e811c8ce
RD
3953
3954 def AltDown(*args, **kwargs):
a95a7133 3955 """AltDown(self) -> bool"""
54f9ee45 3956 return _core_.KeyEvent_AltDown(*args, **kwargs)
e811c8ce
RD
3957
3958 def ShiftDown(*args, **kwargs):
a95a7133 3959 """ShiftDown(self) -> bool"""
54f9ee45 3960 return _core_.KeyEvent_ShiftDown(*args, **kwargs)
e811c8ce 3961
412d302d
RD
3962 def CmdDown(*args, **kwargs):
3963 """
3964 CmdDown(self) -> bool
3965
3966 "Cmd" is a pseudo key which is the same as Control for PC and Unix
3967 platforms but the special "Apple" (a.k.a as "Command") key on
3968 Macs: it makes often sense to use it instead of, say, `ControlDown`
3969 because Cmd key is used for the same thing under Mac as Ctrl
3970 elsewhere. The Ctrl still exists, it's just not used for this
3971 purpose. So for non-Mac platforms this is the same as `ControlDown`
3972 and Macs this is the same as `MetaDown`.
3973 """
3974 return _core_.KeyEvent_CmdDown(*args, **kwargs)
3975
e811c8ce 3976 def HasModifiers(*args, **kwargs):
a95a7133 3977 """HasModifiers(self) -> bool"""
54f9ee45 3978 return _core_.KeyEvent_HasModifiers(*args, **kwargs)
e811c8ce
RD
3979
3980 def GetKeyCode(*args, **kwargs):
a95a7133 3981 """GetKeyCode(self) -> int"""
54f9ee45 3982 return _core_.KeyEvent_GetKeyCode(*args, **kwargs)
e811c8ce 3983
d14a1e28 3984 KeyCode = GetKeyCode
19272049
RD
3985 def GetUnicodeKey(*args, **kwargs):
3986 """GetUnicodeKey(self) -> int"""
3987 return _core_.KeyEvent_GetUnicodeKey(*args, **kwargs)
e811c8ce 3988
19272049 3989 GetUniChar = GetUnicodeKey
e811c8ce 3990 def GetRawKeyCode(*args, **kwargs):
a95a7133 3991 """GetRawKeyCode(self) -> unsigned int"""
54f9ee45 3992 return _core_.KeyEvent_GetRawKeyCode(*args, **kwargs)
e811c8ce
RD
3993
3994 def GetRawKeyFlags(*args, **kwargs):
a95a7133 3995 """GetRawKeyFlags(self) -> unsigned int"""
54f9ee45 3996 return _core_.KeyEvent_GetRawKeyFlags(*args, **kwargs)
e811c8ce
RD
3997
3998 def GetPosition(*args, **kwargs):
0df68c9f 3999 """
a95a7133 4000 GetPosition(self) -> Point
e811c8ce 4001
0df68c9f
RD
4002 Find the position of the event.
4003 """
54f9ee45 4004 return _core_.KeyEvent_GetPosition(*args, **kwargs)
e811c8ce
RD
4005
4006 def GetPositionTuple(*args, **kwargs):
0df68c9f
RD
4007 """
4008 GetPositionTuple() -> (x,y)
e811c8ce 4009
0df68c9f
RD
4010 Find the position of the event.
4011 """
54f9ee45 4012 return _core_.KeyEvent_GetPositionTuple(*args, **kwargs)
e811c8ce
RD
4013
4014 def GetX(*args, **kwargs):
a95a7133 4015 """GetX(self) -> int"""
54f9ee45 4016 return _core_.KeyEvent_GetX(*args, **kwargs)
e811c8ce
RD
4017
4018 def GetY(*args, **kwargs):
a95a7133 4019 """GetY(self) -> int"""
54f9ee45
RD
4020 return _core_.KeyEvent_GetY(*args, **kwargs)
4021
4022 m_x = property(_core_.KeyEvent_m_x_get, _core_.KeyEvent_m_x_set)
4023 m_y = property(_core_.KeyEvent_m_y_get, _core_.KeyEvent_m_y_set)
4024 m_keyCode = property(_core_.KeyEvent_m_keyCode_get, _core_.KeyEvent_m_keyCode_set)
4025 m_controlDown = property(_core_.KeyEvent_m_controlDown_get, _core_.KeyEvent_m_controlDown_set)
4026 m_shiftDown = property(_core_.KeyEvent_m_shiftDown_get, _core_.KeyEvent_m_shiftDown_set)
4027 m_altDown = property(_core_.KeyEvent_m_altDown_get, _core_.KeyEvent_m_altDown_set)
4028 m_metaDown = property(_core_.KeyEvent_m_metaDown_get, _core_.KeyEvent_m_metaDown_set)
4029 m_scanCode = property(_core_.KeyEvent_m_scanCode_get, _core_.KeyEvent_m_scanCode_set)
4030 m_rawCode = property(_core_.KeyEvent_m_rawCode_get, _core_.KeyEvent_m_rawCode_set)
4031 m_rawFlags = property(_core_.KeyEvent_m_rawFlags_get, _core_.KeyEvent_m_rawFlags_set)
d14a1e28
RD
4032
4033class KeyEventPtr(KeyEvent):
4034 def __init__(self, this):
4035 self.this = this
4036 if not hasattr(self,"thisown"): self.thisown = 0
4037 self.__class__ = KeyEvent
54f9ee45 4038_core_.KeyEvent_swigregister(KeyEventPtr)
d14a1e28
RD
4039
4040#---------------------------------------------------------------------------
4041
4042class SizeEvent(Event):
093d3ff1 4043 """Proxy of C++ SizeEvent class"""
e811c8ce
RD
4044 def __repr__(self):
4045 return "<%s.%s; proxy of C++ wxSizeEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4046 def __init__(self, *args, **kwargs):
a95a7133 4047 """__init__(self, Size sz=DefaultSize, int winid=0) -> SizeEvent"""
54f9ee45 4048 newobj = _core_.new_SizeEvent(*args, **kwargs)
d14a1e28
RD
4049 self.this = newobj.this
4050 self.thisown = 1
4051 del newobj.thisown
e811c8ce 4052 def GetSize(*args, **kwargs):
a95a7133 4053 """GetSize(self) -> Size"""
54f9ee45 4054 return _core_.SizeEvent_GetSize(*args, **kwargs)
e811c8ce
RD
4055
4056 def GetRect(*args, **kwargs):
a95a7133 4057 """GetRect(self) -> Rect"""
54f9ee45 4058 return _core_.SizeEvent_GetRect(*args, **kwargs)
e811c8ce
RD
4059
4060 def SetRect(*args, **kwargs):
a95a7133 4061 """SetRect(self, Rect rect)"""
54f9ee45 4062 return _core_.SizeEvent_SetRect(*args, **kwargs)
e811c8ce
RD
4063
4064 def SetSize(*args, **kwargs):
a95a7133 4065 """SetSize(self, Size size)"""
54f9ee45 4066 return _core_.SizeEvent_SetSize(*args, **kwargs)
e811c8ce 4067
54f9ee45
RD
4068 m_size = property(_core_.SizeEvent_m_size_get, _core_.SizeEvent_m_size_set)
4069 m_rect = property(_core_.SizeEvent_m_rect_get, _core_.SizeEvent_m_rect_set)
d14a1e28
RD
4070
4071class SizeEventPtr(SizeEvent):
4072 def __init__(self, this):
4073 self.this = this
4074 if not hasattr(self,"thisown"): self.thisown = 0
4075 self.__class__ = SizeEvent
54f9ee45 4076_core_.SizeEvent_swigregister(SizeEventPtr)
d14a1e28
RD
4077
4078#---------------------------------------------------------------------------
4079
4080class MoveEvent(Event):
093d3ff1 4081 """Proxy of C++ MoveEvent class"""
e811c8ce
RD
4082 def __repr__(self):
4083 return "<%s.%s; proxy of C++ wxMoveEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4084 def __init__(self, *args, **kwargs):
a95a7133 4085 """__init__(self, Point pos=DefaultPosition, int winid=0) -> MoveEvent"""
54f9ee45 4086 newobj = _core_.new_MoveEvent(*args, **kwargs)
d14a1e28
RD
4087 self.this = newobj.this
4088 self.thisown = 1
4089 del newobj.thisown
e811c8ce 4090 def GetPosition(*args, **kwargs):
a95a7133 4091 """GetPosition(self) -> Point"""
54f9ee45 4092 return _core_.MoveEvent_GetPosition(*args, **kwargs)
e811c8ce
RD
4093
4094 def GetRect(*args, **kwargs):
a95a7133 4095 """GetRect(self) -> Rect"""
54f9ee45 4096 return _core_.MoveEvent_GetRect(*args, **kwargs)
e811c8ce
RD
4097
4098 def SetRect(*args, **kwargs):
a95a7133 4099 """SetRect(self, Rect rect)"""
54f9ee45 4100 return _core_.MoveEvent_SetRect(*args, **kwargs)
e811c8ce
RD
4101
4102 def SetPosition(*args, **kwargs):
a95a7133 4103 """SetPosition(self, Point pos)"""
54f9ee45 4104 return _core_.MoveEvent_SetPosition(*args, **kwargs)
e811c8ce 4105
7557b9b5
RD
4106 m_pos = property(GetPosition, SetPosition)
4107 m_rect = property(GetRect, SetRect)
4108
d14a1e28
RD
4109
4110class MoveEventPtr(MoveEvent):
4111 def __init__(self, this):
4112 self.this = this
4113 if not hasattr(self,"thisown"): self.thisown = 0
4114 self.__class__ = MoveEvent
54f9ee45 4115_core_.MoveEvent_swigregister(MoveEventPtr)
d14a1e28
RD
4116
4117#---------------------------------------------------------------------------
4118
4119class PaintEvent(Event):
093d3ff1 4120 """Proxy of C++ PaintEvent class"""
e811c8ce
RD
4121 def __repr__(self):
4122 return "<%s.%s; proxy of C++ wxPaintEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4123 def __init__(self, *args, **kwargs):
a95a7133 4124 """__init__(self, int Id=0) -> PaintEvent"""
54f9ee45 4125 newobj = _core_.new_PaintEvent(*args, **kwargs)
d14a1e28
RD
4126 self.this = newobj.this
4127 self.thisown = 1
4128 del newobj.thisown
d14a1e28
RD
4129
4130class PaintEventPtr(PaintEvent):
4131 def __init__(self, this):
4132 self.this = this
4133 if not hasattr(self,"thisown"): self.thisown = 0
4134 self.__class__ = PaintEvent
54f9ee45 4135_core_.PaintEvent_swigregister(PaintEventPtr)
d14a1e28
RD
4136
4137class NcPaintEvent(Event):
093d3ff1 4138 """Proxy of C++ NcPaintEvent class"""
e811c8ce
RD
4139 def __repr__(self):
4140 return "<%s.%s; proxy of C++ wxNcPaintEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4141 def __init__(self, *args, **kwargs):
a95a7133 4142 """__init__(self, int winid=0) -> NcPaintEvent"""
54f9ee45 4143 newobj = _core_.new_NcPaintEvent(*args, **kwargs)
d14a1e28
RD
4144 self.this = newobj.this
4145 self.thisown = 1
4146 del newobj.thisown
d14a1e28
RD
4147
4148class NcPaintEventPtr(NcPaintEvent):
4149 def __init__(self, this):
4150 self.this = this
4151 if not hasattr(self,"thisown"): self.thisown = 0
4152 self.__class__ = NcPaintEvent
54f9ee45 4153_core_.NcPaintEvent_swigregister(NcPaintEventPtr)
d14a1e28
RD
4154
4155#---------------------------------------------------------------------------
4156
4157class EraseEvent(Event):
093d3ff1 4158 """Proxy of C++ EraseEvent class"""
e811c8ce
RD
4159 def __repr__(self):
4160 return "<%s.%s; proxy of C++ wxEraseEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4161 def __init__(self, *args, **kwargs):
a95a7133 4162 """__init__(self, int Id=0, DC dc=(wxDC *) NULL) -> EraseEvent"""
54f9ee45 4163 newobj = _core_.new_EraseEvent(*args, **kwargs)
d14a1e28
RD
4164 self.this = newobj.this
4165 self.thisown = 1
4166 del newobj.thisown
e811c8ce 4167 def GetDC(*args, **kwargs):
a95a7133 4168 """GetDC(self) -> DC"""
54f9ee45 4169 return _core_.EraseEvent_GetDC(*args, **kwargs)
e811c8ce 4170
d14a1e28
RD
4171
4172class EraseEventPtr(EraseEvent):
4173 def __init__(self, this):
4174 self.this = this
4175 if not hasattr(self,"thisown"): self.thisown = 0
4176 self.__class__ = EraseEvent
54f9ee45 4177_core_.EraseEvent_swigregister(EraseEventPtr)
d14a1e28
RD
4178
4179#---------------------------------------------------------------------------
4180
4181class FocusEvent(Event):
093d3ff1 4182 """Proxy of C++ FocusEvent class"""
e811c8ce
RD
4183 def __repr__(self):
4184 return "<%s.%s; proxy of C++ wxFocusEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4185 def __init__(self, *args, **kwargs):
a95a7133 4186 """__init__(self, wxEventType type=wxEVT_NULL, int winid=0) -> FocusEvent"""
54f9ee45 4187 newobj = _core_.new_FocusEvent(*args, **kwargs)
d14a1e28
RD
4188 self.this = newobj.this
4189 self.thisown = 1
4190 del newobj.thisown
e811c8ce 4191 def GetWindow(*args, **kwargs):
a95a7133 4192 """GetWindow(self) -> Window"""
54f9ee45 4193 return _core_.FocusEvent_GetWindow(*args, **kwargs)
e811c8ce
RD
4194
4195 def SetWindow(*args, **kwargs):
a95a7133 4196 """SetWindow(self, Window win)"""
54f9ee45 4197 return _core_.FocusEvent_SetWindow(*args, **kwargs)
e811c8ce 4198
d14a1e28
RD
4199
4200class FocusEventPtr(FocusEvent):
4201 def __init__(self, this):
4202 self.this = this
4203 if not hasattr(self,"thisown"): self.thisown = 0
4204 self.__class__ = FocusEvent
54f9ee45 4205_core_.FocusEvent_swigregister(FocusEventPtr)
d14a1e28
RD
4206
4207#---------------------------------------------------------------------------
4208
4209class ChildFocusEvent(CommandEvent):
093d3ff1 4210 """Proxy of C++ ChildFocusEvent class"""
e811c8ce
RD
4211 def __repr__(self):
4212 return "<%s.%s; proxy of C++ wxChildFocusEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4213 def __init__(self, *args, **kwargs):
a95a7133 4214 """__init__(self, Window win=None) -> ChildFocusEvent"""
54f9ee45 4215 newobj = _core_.new_ChildFocusEvent(*args, **kwargs)
d14a1e28
RD
4216 self.this = newobj.this
4217 self.thisown = 1
4218 del newobj.thisown
e811c8ce 4219 def GetWindow(*args, **kwargs):
a95a7133 4220 """GetWindow(self) -> Window"""
54f9ee45 4221 return _core_.ChildFocusEvent_GetWindow(*args, **kwargs)
e811c8ce 4222
d14a1e28
RD
4223
4224class ChildFocusEventPtr(ChildFocusEvent):
4225 def __init__(self, this):
4226 self.this = this
4227 if not hasattr(self,"thisown"): self.thisown = 0
4228 self.__class__ = ChildFocusEvent
54f9ee45 4229_core_.ChildFocusEvent_swigregister(ChildFocusEventPtr)
d14a1e28
RD
4230
4231#---------------------------------------------------------------------------
4232
4233class ActivateEvent(Event):
093d3ff1 4234 """Proxy of C++ ActivateEvent class"""
e811c8ce
RD
4235 def __repr__(self):
4236 return "<%s.%s; proxy of C++ wxActivateEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4237 def __init__(self, *args, **kwargs):
a95a7133 4238 """__init__(self, wxEventType type=wxEVT_NULL, bool active=True, int Id=0) -> ActivateEvent"""
54f9ee45 4239 newobj = _core_.new_ActivateEvent(*args, **kwargs)
d14a1e28
RD
4240 self.this = newobj.this
4241 self.thisown = 1
4242 del newobj.thisown
e811c8ce 4243 def GetActive(*args, **kwargs):
a95a7133 4244 """GetActive(self) -> bool"""
54f9ee45 4245 return _core_.ActivateEvent_GetActive(*args, **kwargs)
e811c8ce 4246
d14a1e28
RD
4247
4248class ActivateEventPtr(ActivateEvent):
4249 def __init__(self, this):
4250 self.this = this
4251 if not hasattr(self,"thisown"): self.thisown = 0
4252 self.__class__ = ActivateEvent
54f9ee45 4253_core_.ActivateEvent_swigregister(ActivateEventPtr)
d14a1e28
RD
4254
4255#---------------------------------------------------------------------------
4256
4257class InitDialogEvent(Event):
093d3ff1 4258 """Proxy of C++ InitDialogEvent class"""
e811c8ce
RD
4259 def __repr__(self):
4260 return "<%s.%s; proxy of C++ wxInitDialogEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4261 def __init__(self, *args, **kwargs):
a95a7133 4262 """__init__(self, int Id=0) -> InitDialogEvent"""
54f9ee45 4263 newobj = _core_.new_InitDialogEvent(*args, **kwargs)
d14a1e28
RD
4264 self.this = newobj.this
4265 self.thisown = 1
4266 del newobj.thisown
d14a1e28
RD
4267
4268class InitDialogEventPtr(InitDialogEvent):
4269 def __init__(self, this):
4270 self.this = this
4271 if not hasattr(self,"thisown"): self.thisown = 0
4272 self.__class__ = InitDialogEvent
54f9ee45 4273_core_.InitDialogEvent_swigregister(InitDialogEventPtr)
d14a1e28
RD
4274
4275#---------------------------------------------------------------------------
4276
4277class MenuEvent(Event):
093d3ff1 4278 """Proxy of C++ MenuEvent class"""
e811c8ce
RD
4279 def __repr__(self):
4280 return "<%s.%s; proxy of C++ wxMenuEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4281 def __init__(self, *args, **kwargs):
a95a7133 4282 """__init__(self, wxEventType type=wxEVT_NULL, int winid=0, Menu menu=None) -> MenuEvent"""
54f9ee45 4283 newobj = _core_.new_MenuEvent(*args, **kwargs)
d14a1e28
RD
4284 self.this = newobj.this
4285 self.thisown = 1
4286 del newobj.thisown
e811c8ce 4287 def GetMenuId(*args, **kwargs):
a95a7133 4288 """GetMenuId(self) -> int"""
54f9ee45 4289 return _core_.MenuEvent_GetMenuId(*args, **kwargs)
e811c8ce
RD
4290
4291 def IsPopup(*args, **kwargs):
a95a7133 4292 """IsPopup(self) -> bool"""
54f9ee45 4293 return _core_.MenuEvent_IsPopup(*args, **kwargs)
e811c8ce
RD
4294
4295 def GetMenu(*args, **kwargs):
a95a7133 4296 """GetMenu(self) -> Menu"""
54f9ee45 4297 return _core_.MenuEvent_GetMenu(*args, **kwargs)
e811c8ce 4298
d14a1e28
RD
4299
4300class MenuEventPtr(MenuEvent):
4301 def __init__(self, this):
4302 self.this = this
4303 if not hasattr(self,"thisown"): self.thisown = 0
4304 self.__class__ = MenuEvent
54f9ee45 4305_core_.MenuEvent_swigregister(MenuEventPtr)
d14a1e28
RD
4306
4307#---------------------------------------------------------------------------
4308
4309class CloseEvent(Event):
093d3ff1 4310 """Proxy of C++ CloseEvent class"""
e811c8ce
RD
4311 def __repr__(self):
4312 return "<%s.%s; proxy of C++ wxCloseEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4313 def __init__(self, *args, **kwargs):
a95a7133 4314 """__init__(self, wxEventType type=wxEVT_NULL, int winid=0) -> CloseEvent"""
54f9ee45 4315 newobj = _core_.new_CloseEvent(*args, **kwargs)
d14a1e28
RD
4316 self.this = newobj.this
4317 self.thisown = 1
4318 del newobj.thisown
e811c8ce 4319 def SetLoggingOff(*args, **kwargs):
a95a7133 4320 """SetLoggingOff(self, bool logOff)"""
54f9ee45 4321 return _core_.CloseEvent_SetLoggingOff(*args, **kwargs)
e811c8ce
RD
4322
4323 def GetLoggingOff(*args, **kwargs):
a95a7133 4324 """GetLoggingOff(self) -> bool"""
54f9ee45 4325 return _core_.CloseEvent_GetLoggingOff(*args, **kwargs)
e811c8ce
RD
4326
4327 def Veto(*args, **kwargs):
a95a7133 4328 """Veto(self, bool veto=True)"""
54f9ee45 4329 return _core_.CloseEvent_Veto(*args, **kwargs)
e811c8ce
RD
4330
4331 def SetCanVeto(*args, **kwargs):
a95a7133 4332 """SetCanVeto(self, bool canVeto)"""
54f9ee45 4333 return _core_.CloseEvent_SetCanVeto(*args, **kwargs)
e811c8ce
RD
4334
4335 def CanVeto(*args, **kwargs):
a95a7133 4336 """CanVeto(self) -> bool"""
54f9ee45 4337 return _core_.CloseEvent_CanVeto(*args, **kwargs)
e811c8ce
RD
4338
4339 def GetVeto(*args, **kwargs):
a95a7133 4340 """GetVeto(self) -> bool"""
54f9ee45 4341 return _core_.CloseEvent_GetVeto(*args, **kwargs)
e811c8ce 4342
d14a1e28
RD
4343
4344class CloseEventPtr(CloseEvent):
4345 def __init__(self, this):
4346 self.this = this
4347 if not hasattr(self,"thisown"): self.thisown = 0
4348 self.__class__ = CloseEvent
54f9ee45 4349_core_.CloseEvent_swigregister(CloseEventPtr)
d14a1e28
RD
4350
4351#---------------------------------------------------------------------------
4352
4353class ShowEvent(Event):
093d3ff1 4354 """Proxy of C++ ShowEvent class"""
e811c8ce
RD
4355 def __repr__(self):
4356 return "<%s.%s; proxy of C++ wxShowEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4357 def __init__(self, *args, **kwargs):
a95a7133 4358 """__init__(self, int winid=0, bool show=False) -> ShowEvent"""
54f9ee45 4359 newobj = _core_.new_ShowEvent(*args, **kwargs)
d14a1e28
RD
4360 self.this = newobj.this
4361 self.thisown = 1
4362 del newobj.thisown
e811c8ce 4363 def SetShow(*args, **kwargs):
a95a7133 4364 """SetShow(self, bool show)"""
54f9ee45 4365 return _core_.ShowEvent_SetShow(*args, **kwargs)
e811c8ce
RD
4366
4367 def GetShow(*args, **kwargs):
a95a7133 4368 """GetShow(self) -> bool"""
54f9ee45 4369 return _core_.ShowEvent_GetShow(*args, **kwargs)
e811c8ce 4370
d14a1e28
RD
4371
4372class ShowEventPtr(ShowEvent):
4373 def __init__(self, this):
4374 self.this = this
4375 if not hasattr(self,"thisown"): self.thisown = 0
4376 self.__class__ = ShowEvent
54f9ee45 4377_core_.ShowEvent_swigregister(ShowEventPtr)
d14a1e28
RD
4378
4379#---------------------------------------------------------------------------
4380
4381class IconizeEvent(Event):
093d3ff1 4382 """Proxy of C++ IconizeEvent class"""
e811c8ce
RD
4383 def __repr__(self):
4384 return "<%s.%s; proxy of C++ wxIconizeEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4385 def __init__(self, *args, **kwargs):
a95a7133 4386 """__init__(self, int id=0, bool iconized=True) -> IconizeEvent"""
54f9ee45 4387 newobj = _core_.new_IconizeEvent(*args, **kwargs)
d14a1e28
RD
4388 self.this = newobj.this
4389 self.thisown = 1
4390 del newobj.thisown
e811c8ce 4391 def Iconized(*args, **kwargs):
a95a7133 4392 """Iconized(self) -> bool"""
54f9ee45 4393 return _core_.IconizeEvent_Iconized(*args, **kwargs)
e811c8ce 4394
d14a1e28
RD
4395
4396class IconizeEventPtr(IconizeEvent):
4397 def __init__(self, this):
4398 self.this = this
4399 if not hasattr(self,"thisown"): self.thisown = 0
4400 self.__class__ = IconizeEvent
54f9ee45 4401_core_.IconizeEvent_swigregister(IconizeEventPtr)
d14a1e28
RD
4402
4403#---------------------------------------------------------------------------
4404
4405class MaximizeEvent(Event):
093d3ff1 4406 """Proxy of C++ MaximizeEvent class"""
e811c8ce
RD
4407 def __repr__(self):
4408 return "<%s.%s; proxy of C++ wxMaximizeEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4409 def __init__(self, *args, **kwargs):
a95a7133 4410 """__init__(self, int id=0) -> MaximizeEvent"""
54f9ee45 4411 newobj = _core_.new_MaximizeEvent(*args, **kwargs)
d14a1e28
RD
4412 self.this = newobj.this
4413 self.thisown = 1
4414 del newobj.thisown
d14a1e28
RD
4415
4416class MaximizeEventPtr(MaximizeEvent):
4417 def __init__(self, this):
4418 self.this = this
4419 if not hasattr(self,"thisown"): self.thisown = 0
4420 self.__class__ = MaximizeEvent
54f9ee45 4421_core_.MaximizeEvent_swigregister(MaximizeEventPtr)
d14a1e28
RD
4422
4423#---------------------------------------------------------------------------
4424
4425class DropFilesEvent(Event):
093d3ff1 4426 """Proxy of C++ DropFilesEvent class"""
d14a1e28
RD
4427 def __init__(self): raise RuntimeError, "No constructor defined"
4428 def __repr__(self):
4429 return "<%s.%s; proxy of C++ wxDropFilesEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
e811c8ce 4430 def GetPosition(*args, **kwargs):
a95a7133 4431 """GetPosition(self) -> Point"""
54f9ee45 4432 return _core_.DropFilesEvent_GetPosition(*args, **kwargs)
e811c8ce
RD
4433
4434 def GetNumberOfFiles(*args, **kwargs):
a95a7133 4435 """GetNumberOfFiles(self) -> int"""
54f9ee45 4436 return _core_.DropFilesEvent_GetNumberOfFiles(*args, **kwargs)
e811c8ce
RD
4437
4438 def GetFiles(*args, **kwargs):
a95a7133 4439 """GetFiles(self) -> PyObject"""
54f9ee45 4440 return _core_.DropFilesEvent_GetFiles(*args, **kwargs)
e811c8ce 4441
d14a1e28
RD
4442
4443class DropFilesEventPtr(DropFilesEvent):
4444 def __init__(self, this):
4445 self.this = this
4446 if not hasattr(self,"thisown"): self.thisown = 0
4447 self.__class__ = DropFilesEvent
54f9ee45 4448_core_.DropFilesEvent_swigregister(DropFilesEventPtr)
d14a1e28
RD
4449
4450#---------------------------------------------------------------------------
4451
54f9ee45
RD
4452UPDATE_UI_PROCESS_ALL = _core_.UPDATE_UI_PROCESS_ALL
4453UPDATE_UI_PROCESS_SPECIFIED = _core_.UPDATE_UI_PROCESS_SPECIFIED
d14a1e28 4454class UpdateUIEvent(CommandEvent):
093d3ff1 4455 """Proxy of C++ UpdateUIEvent class"""
e811c8ce
RD
4456 def __repr__(self):
4457 return "<%s.%s; proxy of C++ wxUpdateUIEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4458 def __init__(self, *args, **kwargs):
a95a7133 4459 """__init__(self, int commandId=0) -> UpdateUIEvent"""
54f9ee45 4460 newobj = _core_.new_UpdateUIEvent(*args, **kwargs)
d14a1e28
RD
4461 self.this = newobj.this
4462 self.thisown = 1
4463 del newobj.thisown
e811c8ce 4464 def GetChecked(*args, **kwargs):
a95a7133 4465 """GetChecked(self) -> bool"""
54f9ee45 4466 return _core_.UpdateUIEvent_GetChecked(*args, **kwargs)
e811c8ce
RD
4467
4468 def GetEnabled(*args, **kwargs):
a95a7133 4469 """GetEnabled(self) -> bool"""
54f9ee45 4470 return _core_.UpdateUIEvent_GetEnabled(*args, **kwargs)
e811c8ce
RD
4471
4472 def GetText(*args, **kwargs):
a95a7133 4473 """GetText(self) -> String"""
54f9ee45 4474 return _core_.UpdateUIEvent_GetText(*args, **kwargs)
e811c8ce
RD
4475
4476 def GetSetText(*args, **kwargs):
a95a7133 4477 """GetSetText(self) -> bool"""
54f9ee45 4478 return _core_.UpdateUIEvent_GetSetText(*args, **kwargs)
e811c8ce
RD
4479
4480 def GetSetChecked(*args, **kwargs):
a95a7133 4481 """GetSetChecked(self) -> bool"""
54f9ee45 4482 return _core_.UpdateUIEvent_GetSetChecked(*args, **kwargs)
e811c8ce
RD
4483
4484 def GetSetEnabled(*args, **kwargs):
a95a7133 4485 """GetSetEnabled(self) -> bool"""
54f9ee45 4486 return _core_.UpdateUIEvent_GetSetEnabled(*args, **kwargs)
e811c8ce
RD
4487
4488 def Check(*args, **kwargs):
a95a7133 4489 """Check(self, bool check)"""
54f9ee45 4490 return _core_.UpdateUIEvent_Check(*args, **kwargs)
e811c8ce
RD
4491
4492 def Enable(*args, **kwargs):
a95a7133 4493 """Enable(self, bool enable)"""
54f9ee45 4494 return _core_.UpdateUIEvent_Enable(*args, **kwargs)
e811c8ce
RD
4495
4496 def SetText(*args, **kwargs):
a95a7133 4497 """SetText(self, String text)"""
54f9ee45 4498 return _core_.UpdateUIEvent_SetText(*args, **kwargs)
e811c8ce
RD
4499
4500 def SetUpdateInterval(*args, **kwargs):
66c033b4 4501 """SetUpdateInterval(long updateInterval)"""
54f9ee45 4502 return _core_.UpdateUIEvent_SetUpdateInterval(*args, **kwargs)
e811c8ce
RD
4503
4504 SetUpdateInterval = staticmethod(SetUpdateInterval)
4505 def GetUpdateInterval(*args, **kwargs):
66c033b4 4506 """GetUpdateInterval() -> long"""
54f9ee45 4507 return _core_.UpdateUIEvent_GetUpdateInterval(*args, **kwargs)
e811c8ce
RD
4508
4509 GetUpdateInterval = staticmethod(GetUpdateInterval)
4510 def CanUpdate(*args, **kwargs):
66c033b4 4511 """CanUpdate(Window win) -> bool"""
54f9ee45 4512 return _core_.UpdateUIEvent_CanUpdate(*args, **kwargs)
e811c8ce
RD
4513
4514 CanUpdate = staticmethod(CanUpdate)
4515 def ResetUpdateTime(*args, **kwargs):
66c033b4 4516 """ResetUpdateTime()"""
54f9ee45 4517 return _core_.UpdateUIEvent_ResetUpdateTime(*args, **kwargs)
e811c8ce
RD
4518
4519 ResetUpdateTime = staticmethod(ResetUpdateTime)
4520 def SetMode(*args, **kwargs):
66c033b4 4521 """SetMode(int mode)"""
54f9ee45 4522 return _core_.UpdateUIEvent_SetMode(*args, **kwargs)
e811c8ce
RD
4523
4524 SetMode = staticmethod(SetMode)
4525 def GetMode(*args, **kwargs):
66c033b4 4526 """GetMode() -> int"""
54f9ee45 4527 return _core_.UpdateUIEvent_GetMode(*args, **kwargs)
e811c8ce
RD
4528
4529 GetMode = staticmethod(GetMode)
d14a1e28
RD
4530
4531class UpdateUIEventPtr(UpdateUIEvent):
4532 def __init__(self, this):
4533 self.this = this
4534 if not hasattr(self,"thisown"): self.thisown = 0
4535 self.__class__ = UpdateUIEvent
54f9ee45 4536_core_.UpdateUIEvent_swigregister(UpdateUIEventPtr)
d14a1e28 4537
e811c8ce
RD
4538def UpdateUIEvent_SetUpdateInterval(*args, **kwargs):
4539 """UpdateUIEvent_SetUpdateInterval(long updateInterval)"""
54f9ee45 4540 return _core_.UpdateUIEvent_SetUpdateInterval(*args, **kwargs)
d14a1e28 4541
e811c8ce
RD
4542def UpdateUIEvent_GetUpdateInterval(*args, **kwargs):
4543 """UpdateUIEvent_GetUpdateInterval() -> long"""
54f9ee45 4544 return _core_.UpdateUIEvent_GetUpdateInterval(*args, **kwargs)
d14a1e28 4545
e811c8ce
RD
4546def UpdateUIEvent_CanUpdate(*args, **kwargs):
4547 """UpdateUIEvent_CanUpdate(Window win) -> bool"""
54f9ee45 4548 return _core_.UpdateUIEvent_CanUpdate(*args, **kwargs)
d14a1e28 4549
e811c8ce
RD
4550def UpdateUIEvent_ResetUpdateTime(*args, **kwargs):
4551 """UpdateUIEvent_ResetUpdateTime()"""
54f9ee45 4552 return _core_.UpdateUIEvent_ResetUpdateTime(*args, **kwargs)
d14a1e28 4553
e811c8ce 4554def UpdateUIEvent_SetMode(*args, **kwargs):
196addbf 4555 """UpdateUIEvent_SetMode(int mode)"""
54f9ee45 4556 return _core_.UpdateUIEvent_SetMode(*args, **kwargs)
d14a1e28 4557
e811c8ce 4558def UpdateUIEvent_GetMode(*args, **kwargs):
196addbf 4559 """UpdateUIEvent_GetMode() -> int"""
54f9ee45 4560 return _core_.UpdateUIEvent_GetMode(*args, **kwargs)
d14a1e28
RD
4561
4562#---------------------------------------------------------------------------
4563
4564class SysColourChangedEvent(Event):
093d3ff1 4565 """Proxy of C++ SysColourChangedEvent class"""
e811c8ce
RD
4566 def __repr__(self):
4567 return "<%s.%s; proxy of C++ wxSysColourChangedEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4568 def __init__(self, *args, **kwargs):
a95a7133 4569 """__init__(self) -> SysColourChangedEvent"""
54f9ee45 4570 newobj = _core_.new_SysColourChangedEvent(*args, **kwargs)
d14a1e28
RD
4571 self.this = newobj.this
4572 self.thisown = 1
4573 del newobj.thisown
d14a1e28
RD
4574
4575class SysColourChangedEventPtr(SysColourChangedEvent):
4576 def __init__(self, this):
4577 self.this = this
4578 if not hasattr(self,"thisown"): self.thisown = 0
4579 self.__class__ = SysColourChangedEvent
54f9ee45 4580_core_.SysColourChangedEvent_swigregister(SysColourChangedEventPtr)
d14a1e28
RD
4581
4582#---------------------------------------------------------------------------
4583
4584class MouseCaptureChangedEvent(Event):
093d3ff1 4585 """Proxy of C++ MouseCaptureChangedEvent class"""
e811c8ce
RD
4586 def __repr__(self):
4587 return "<%s.%s; proxy of C++ wxMouseCaptureChangedEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4588 def __init__(self, *args, **kwargs):
a95a7133 4589 """__init__(self, int winid=0, Window gainedCapture=None) -> MouseCaptureChangedEvent"""
54f9ee45 4590 newobj = _core_.new_MouseCaptureChangedEvent(*args, **kwargs)
d14a1e28
RD
4591 self.this = newobj.this
4592 self.thisown = 1
4593 del newobj.thisown
e811c8ce 4594 def GetCapturedWindow(*args, **kwargs):
a95a7133 4595 """GetCapturedWindow(self) -> Window"""
54f9ee45 4596 return _core_.MouseCaptureChangedEvent_GetCapturedWindow(*args, **kwargs)
e811c8ce 4597
d14a1e28
RD
4598
4599class MouseCaptureChangedEventPtr(MouseCaptureChangedEvent):
4600 def __init__(self, this):
4601 self.this = this
4602 if not hasattr(self,"thisown"): self.thisown = 0
4603 self.__class__ = MouseCaptureChangedEvent
54f9ee45 4604_core_.MouseCaptureChangedEvent_swigregister(MouseCaptureChangedEventPtr)
d14a1e28
RD
4605
4606#---------------------------------------------------------------------------
4607
4608class DisplayChangedEvent(Event):
093d3ff1 4609 """Proxy of C++ DisplayChangedEvent class"""
e811c8ce
RD
4610 def __repr__(self):
4611 return "<%s.%s; proxy of C++ wxDisplayChangedEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4612 def __init__(self, *args, **kwargs):
a95a7133 4613 """__init__(self) -> DisplayChangedEvent"""
54f9ee45 4614 newobj = _core_.new_DisplayChangedEvent(*args, **kwargs)
d14a1e28
RD
4615 self.this = newobj.this
4616 self.thisown = 1
4617 del newobj.thisown
d14a1e28
RD
4618
4619class DisplayChangedEventPtr(DisplayChangedEvent):
4620 def __init__(self, this):
4621 self.this = this
4622 if not hasattr(self,"thisown"): self.thisown = 0
4623 self.__class__ = DisplayChangedEvent
54f9ee45 4624_core_.DisplayChangedEvent_swigregister(DisplayChangedEventPtr)
d14a1e28
RD
4625
4626#---------------------------------------------------------------------------
4627
4628class PaletteChangedEvent(Event):
093d3ff1 4629 """Proxy of C++ PaletteChangedEvent class"""
e811c8ce
RD
4630 def __repr__(self):
4631 return "<%s.%s; proxy of C++ wxPaletteChangedEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4632 def __init__(self, *args, **kwargs):
a95a7133 4633 """__init__(self, int id=0) -> PaletteChangedEvent"""
54f9ee45 4634 newobj = _core_.new_PaletteChangedEvent(*args, **kwargs)
d14a1e28
RD
4635 self.this = newobj.this
4636 self.thisown = 1
4637 del newobj.thisown
e811c8ce 4638 def SetChangedWindow(*args, **kwargs):
a95a7133 4639 """SetChangedWindow(self, Window win)"""
54f9ee45 4640 return _core_.PaletteChangedEvent_SetChangedWindow(*args, **kwargs)
e811c8ce
RD
4641
4642 def GetChangedWindow(*args, **kwargs):
a95a7133 4643 """GetChangedWindow(self) -> Window"""
54f9ee45 4644 return _core_.PaletteChangedEvent_GetChangedWindow(*args, **kwargs)
e811c8ce 4645
d14a1e28
RD
4646
4647class PaletteChangedEventPtr(PaletteChangedEvent):
4648 def __init__(self, this):
4649 self.this = this
4650 if not hasattr(self,"thisown"): self.thisown = 0
4651 self.__class__ = PaletteChangedEvent
54f9ee45 4652_core_.PaletteChangedEvent_swigregister(PaletteChangedEventPtr)
d14a1e28
RD
4653
4654#---------------------------------------------------------------------------
4655
4656class QueryNewPaletteEvent(Event):
093d3ff1 4657 """Proxy of C++ QueryNewPaletteEvent class"""
e811c8ce
RD
4658 def __repr__(self):
4659 return "<%s.%s; proxy of C++ wxQueryNewPaletteEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4660 def __init__(self, *args, **kwargs):
a95a7133 4661 """__init__(self, int winid=0) -> QueryNewPaletteEvent"""
54f9ee45 4662 newobj = _core_.new_QueryNewPaletteEvent(*args, **kwargs)
d14a1e28
RD
4663 self.this = newobj.this
4664 self.thisown = 1
4665 del newobj.thisown
e811c8ce 4666 def SetPaletteRealized(*args, **kwargs):
a95a7133 4667 """SetPaletteRealized(self, bool realized)"""
54f9ee45 4668 return _core_.QueryNewPaletteEvent_SetPaletteRealized(*args, **kwargs)
e811c8ce
RD
4669
4670 def GetPaletteRealized(*args, **kwargs):
a95a7133 4671 """GetPaletteRealized(self) -> bool"""
54f9ee45 4672 return _core_.QueryNewPaletteEvent_GetPaletteRealized(*args, **kwargs)
e811c8ce 4673
d14a1e28
RD
4674
4675class QueryNewPaletteEventPtr(QueryNewPaletteEvent):
4676 def __init__(self, this):
4677 self.this = this
4678 if not hasattr(self,"thisown"): self.thisown = 0
4679 self.__class__ = QueryNewPaletteEvent
54f9ee45 4680_core_.QueryNewPaletteEvent_swigregister(QueryNewPaletteEventPtr)
d14a1e28
RD
4681
4682#---------------------------------------------------------------------------
4683
4684class NavigationKeyEvent(Event):
093d3ff1 4685 """Proxy of C++ NavigationKeyEvent class"""
e811c8ce
RD
4686 def __repr__(self):
4687 return "<%s.%s; proxy of C++ wxNavigationKeyEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4688 def __init__(self, *args, **kwargs):
a95a7133 4689 """__init__(self) -> NavigationKeyEvent"""
54f9ee45 4690 newobj = _core_.new_NavigationKeyEvent(*args, **kwargs)
d14a1e28
RD
4691 self.this = newobj.this
4692 self.thisown = 1
4693 del newobj.thisown
e811c8ce 4694 def GetDirection(*args, **kwargs):
a95a7133 4695 """GetDirection(self) -> bool"""
54f9ee45 4696 return _core_.NavigationKeyEvent_GetDirection(*args, **kwargs)
e811c8ce
RD
4697
4698 def SetDirection(*args, **kwargs):
908b74cd 4699 """SetDirection(self, bool forward)"""
54f9ee45 4700 return _core_.NavigationKeyEvent_SetDirection(*args, **kwargs)
e811c8ce
RD
4701
4702 def IsWindowChange(*args, **kwargs):
a95a7133 4703 """IsWindowChange(self) -> bool"""
54f9ee45 4704 return _core_.NavigationKeyEvent_IsWindowChange(*args, **kwargs)
e811c8ce
RD
4705
4706 def SetWindowChange(*args, **kwargs):
908b74cd 4707 """SetWindowChange(self, bool ischange)"""
54f9ee45 4708 return _core_.NavigationKeyEvent_SetWindowChange(*args, **kwargs)
e811c8ce 4709
68350608
RD
4710 def IsFromTab(*args, **kwargs):
4711 """IsFromTab(self) -> bool"""
4712 return _core_.NavigationKeyEvent_IsFromTab(*args, **kwargs)
4713
4714 def SetFromTab(*args, **kwargs):
4715 """SetFromTab(self, bool bIs)"""
4716 return _core_.NavigationKeyEvent_SetFromTab(*args, **kwargs)
4717
908b74cd
RD
4718 def SetFlags(*args, **kwargs):
4719 """SetFlags(self, long flags)"""
4720 return _core_.NavigationKeyEvent_SetFlags(*args, **kwargs)
4721
e811c8ce 4722 def GetCurrentFocus(*args, **kwargs):
a95a7133 4723 """GetCurrentFocus(self) -> Window"""
54f9ee45 4724 return _core_.NavigationKeyEvent_GetCurrentFocus(*args, **kwargs)
e811c8ce
RD
4725
4726 def SetCurrentFocus(*args, **kwargs):
a95a7133 4727 """SetCurrentFocus(self, Window win)"""
54f9ee45 4728 return _core_.NavigationKeyEvent_SetCurrentFocus(*args, **kwargs)
e811c8ce 4729
b0f7404b 4730 IsBackward = _core_.NavigationKeyEvent_IsBackward
908b74cd
RD
4731 IsForward = _core_.NavigationKeyEvent_IsForward
4732 WinChange = _core_.NavigationKeyEvent_WinChange
68350608 4733 FromTab = _core_.NavigationKeyEvent_FromTab
d14a1e28
RD
4734
4735class NavigationKeyEventPtr(NavigationKeyEvent):
4736 def __init__(self, this):
4737 self.this = this
4738 if not hasattr(self,"thisown"): self.thisown = 0
4739 self.__class__ = NavigationKeyEvent
54f9ee45 4740_core_.NavigationKeyEvent_swigregister(NavigationKeyEventPtr)
d14a1e28
RD
4741
4742#---------------------------------------------------------------------------
4743
4744class WindowCreateEvent(CommandEvent):
093d3ff1 4745 """Proxy of C++ WindowCreateEvent class"""
e811c8ce
RD
4746 def __repr__(self):
4747 return "<%s.%s; proxy of C++ wxWindowCreateEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4748 def __init__(self, *args, **kwargs):
a95a7133 4749 """__init__(self, Window win=None) -> WindowCreateEvent"""
54f9ee45 4750 newobj = _core_.new_WindowCreateEvent(*args, **kwargs)
d14a1e28
RD
4751 self.this = newobj.this
4752 self.thisown = 1
4753 del newobj.thisown
e811c8ce 4754 def GetWindow(*args, **kwargs):
a95a7133 4755 """GetWindow(self) -> Window"""
54f9ee45 4756 return _core_.WindowCreateEvent_GetWindow(*args, **kwargs)
e811c8ce 4757
d14a1e28
RD
4758
4759class WindowCreateEventPtr(WindowCreateEvent):
4760 def __init__(self, this):
4761 self.this = this
4762 if not hasattr(self,"thisown"): self.thisown = 0
4763 self.__class__ = WindowCreateEvent
54f9ee45 4764_core_.WindowCreateEvent_swigregister(WindowCreateEventPtr)
d14a1e28
RD
4765
4766class WindowDestroyEvent(CommandEvent):
093d3ff1 4767 """Proxy of C++ WindowDestroyEvent class"""
e811c8ce
RD
4768 def __repr__(self):
4769 return "<%s.%s; proxy of C++ wxWindowDestroyEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4770 def __init__(self, *args, **kwargs):
a95a7133 4771 """__init__(self, Window win=None) -> WindowDestroyEvent"""
54f9ee45 4772 newobj = _core_.new_WindowDestroyEvent(*args, **kwargs)
d14a1e28
RD
4773 self.this = newobj.this
4774 self.thisown = 1
4775 del newobj.thisown
e811c8ce 4776 def GetWindow(*args, **kwargs):
a95a7133 4777 """GetWindow(self) -> Window"""
54f9ee45 4778 return _core_.WindowDestroyEvent_GetWindow(*args, **kwargs)
e811c8ce 4779
d14a1e28
RD
4780
4781class WindowDestroyEventPtr(WindowDestroyEvent):
4782 def __init__(self, this):
4783 self.this = this
4784 if not hasattr(self,"thisown"): self.thisown = 0
4785 self.__class__ = WindowDestroyEvent
54f9ee45 4786_core_.WindowDestroyEvent_swigregister(WindowDestroyEventPtr)
d14a1e28
RD
4787
4788#---------------------------------------------------------------------------
4789
4790class ContextMenuEvent(CommandEvent):
093d3ff1 4791 """Proxy of C++ ContextMenuEvent class"""
e811c8ce
RD
4792 def __repr__(self):
4793 return "<%s.%s; proxy of C++ wxContextMenuEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4794 def __init__(self, *args, **kwargs):
a95a7133 4795 """__init__(self, wxEventType type=wxEVT_NULL, int winid=0, Point pt=DefaultPosition) -> ContextMenuEvent"""
54f9ee45 4796 newobj = _core_.new_ContextMenuEvent(*args, **kwargs)
d14a1e28
RD
4797 self.this = newobj.this
4798 self.thisown = 1
4799 del newobj.thisown
e811c8ce 4800 def GetPosition(*args, **kwargs):
a95a7133 4801 """GetPosition(self) -> Point"""
54f9ee45 4802 return _core_.ContextMenuEvent_GetPosition(*args, **kwargs)
e811c8ce
RD
4803
4804 def SetPosition(*args, **kwargs):
a95a7133 4805 """SetPosition(self, Point pos)"""
54f9ee45 4806 return _core_.ContextMenuEvent_SetPosition(*args, **kwargs)
e811c8ce 4807
d14a1e28
RD
4808
4809class ContextMenuEventPtr(ContextMenuEvent):
4810 def __init__(self, this):
4811 self.this = this
4812 if not hasattr(self,"thisown"): self.thisown = 0
4813 self.__class__ = ContextMenuEvent
54f9ee45 4814_core_.ContextMenuEvent_swigregister(ContextMenuEventPtr)
d14a1e28
RD
4815
4816#---------------------------------------------------------------------------
4817
54f9ee45
RD
4818IDLE_PROCESS_ALL = _core_.IDLE_PROCESS_ALL
4819IDLE_PROCESS_SPECIFIED = _core_.IDLE_PROCESS_SPECIFIED
d14a1e28 4820class IdleEvent(Event):
093d3ff1 4821 """Proxy of C++ IdleEvent class"""
e811c8ce
RD
4822 def __repr__(self):
4823 return "<%s.%s; proxy of C++ wxIdleEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4824 def __init__(self, *args, **kwargs):
a95a7133 4825 """__init__(self) -> IdleEvent"""
54f9ee45 4826 newobj = _core_.new_IdleEvent(*args, **kwargs)
d14a1e28
RD
4827 self.this = newobj.this
4828 self.thisown = 1
4829 del newobj.thisown
e811c8ce 4830 def RequestMore(*args, **kwargs):
a95a7133 4831 """RequestMore(self, bool needMore=True)"""
54f9ee45 4832 return _core_.IdleEvent_RequestMore(*args, **kwargs)
e811c8ce
RD
4833
4834 def MoreRequested(*args, **kwargs):
a95a7133 4835 """MoreRequested(self) -> bool"""
54f9ee45 4836 return _core_.IdleEvent_MoreRequested(*args, **kwargs)
e811c8ce
RD
4837
4838 def SetMode(*args, **kwargs):
66c033b4 4839 """SetMode(int mode)"""
54f9ee45 4840 return _core_.IdleEvent_SetMode(*args, **kwargs)
e811c8ce
RD
4841
4842 SetMode = staticmethod(SetMode)
4843 def GetMode(*args, **kwargs):
66c033b4 4844 """GetMode() -> int"""
54f9ee45 4845 return _core_.IdleEvent_GetMode(*args, **kwargs)
e811c8ce
RD
4846
4847 GetMode = staticmethod(GetMode)
4848 def CanSend(*args, **kwargs):
66c033b4 4849 """CanSend(Window win) -> bool"""
54f9ee45 4850 return _core_.IdleEvent_CanSend(*args, **kwargs)
e811c8ce
RD
4851
4852 CanSend = staticmethod(CanSend)
d14a1e28
RD
4853
4854class IdleEventPtr(IdleEvent):
4855 def __init__(self, this):
4856 self.this = this
4857 if not hasattr(self,"thisown"): self.thisown = 0
4858 self.__class__ = IdleEvent
54f9ee45 4859_core_.IdleEvent_swigregister(IdleEventPtr)
d14a1e28 4860
e811c8ce 4861def IdleEvent_SetMode(*args, **kwargs):
196addbf 4862 """IdleEvent_SetMode(int mode)"""
54f9ee45 4863 return _core_.IdleEvent_SetMode(*args, **kwargs)
d14a1e28 4864
e811c8ce 4865def IdleEvent_GetMode(*args, **kwargs):
196addbf 4866 """IdleEvent_GetMode() -> int"""
54f9ee45 4867 return _core_.IdleEvent_GetMode(*args, **kwargs)
d14a1e28 4868
e811c8ce
RD
4869def IdleEvent_CanSend(*args, **kwargs):
4870 """IdleEvent_CanSend(Window win) -> bool"""
54f9ee45 4871 return _core_.IdleEvent_CanSend(*args, **kwargs)
d14a1e28
RD
4872
4873#---------------------------------------------------------------------------
4874
4875class PyEvent(Event):
093d3ff1 4876 """Proxy of C++ PyEvent class"""
e811c8ce
RD
4877 def __repr__(self):
4878 return "<%s.%s; proxy of C++ wxPyEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4879 def __init__(self, *args, **kwargs):
a95a7133 4880 """__init__(self, int winid=0, wxEventType commandType=wxEVT_NULL) -> PyEvent"""
54f9ee45 4881 newobj = _core_.new_PyEvent(*args, **kwargs)
d14a1e28
RD
4882 self.this = newobj.this
4883 self.thisown = 1
4884 del newobj.thisown
4885 self.SetSelf(self)
e811c8ce 4886
54f9ee45 4887 def __del__(self, destroy=_core_.delete_PyEvent):
a95a7133 4888 """__del__(self)"""
d14a1e28
RD
4889 try:
4890 if self.thisown: destroy(self)
4891 except: pass
e811c8ce
RD
4892
4893 def SetSelf(*args, **kwargs):
a95a7133 4894 """SetSelf(self, PyObject self)"""
54f9ee45 4895 return _core_.PyEvent_SetSelf(*args, **kwargs)
e811c8ce
RD
4896
4897 def GetSelf(*args, **kwargs):
a95a7133 4898 """GetSelf(self) -> PyObject"""
54f9ee45 4899 return _core_.PyEvent_GetSelf(*args, **kwargs)
e811c8ce 4900
d14a1e28
RD
4901
4902class PyEventPtr(PyEvent):
4903 def __init__(self, this):
4904 self.this = this
4905 if not hasattr(self,"thisown"): self.thisown = 0
4906 self.__class__ = PyEvent
54f9ee45 4907_core_.PyEvent_swigregister(PyEventPtr)
d14a1e28
RD
4908
4909class PyCommandEvent(CommandEvent):
093d3ff1 4910 """Proxy of C++ PyCommandEvent class"""
e811c8ce
RD
4911 def __repr__(self):
4912 return "<%s.%s; proxy of C++ wxPyCommandEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4913 def __init__(self, *args, **kwargs):
a95a7133 4914 """__init__(self, wxEventType commandType=wxEVT_NULL, int id=0) -> PyCommandEvent"""
54f9ee45 4915 newobj = _core_.new_PyCommandEvent(*args, **kwargs)
d14a1e28
RD
4916 self.this = newobj.this
4917 self.thisown = 1
4918 del newobj.thisown
4919 self.SetSelf(self)
e811c8ce 4920
54f9ee45 4921 def __del__(self, destroy=_core_.delete_PyCommandEvent):
a95a7133 4922 """__del__(self)"""
d14a1e28
RD
4923 try:
4924 if self.thisown: destroy(self)
4925 except: pass
e811c8ce
RD
4926
4927 def SetSelf(*args, **kwargs):
a95a7133 4928 """SetSelf(self, PyObject self)"""
54f9ee45 4929 return _core_.PyCommandEvent_SetSelf(*args, **kwargs)
e811c8ce
RD
4930
4931 def GetSelf(*args, **kwargs):
a95a7133 4932 """GetSelf(self) -> PyObject"""
54f9ee45 4933 return _core_.PyCommandEvent_GetSelf(*args, **kwargs)
e811c8ce 4934
d14a1e28
RD
4935
4936class PyCommandEventPtr(PyCommandEvent):
4937 def __init__(self, this):
4938 self.this = this
4939 if not hasattr(self,"thisown"): self.thisown = 0
4940 self.__class__ = PyCommandEvent
54f9ee45 4941_core_.PyCommandEvent_swigregister(PyCommandEventPtr)
d14a1e28 4942
53aa7709
RD
4943class DateEvent(CommandEvent):
4944 """Proxy of C++ DateEvent class"""
4945 def __repr__(self):
4946 return "<%s.%s; proxy of C++ wxDateEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4947 def __init__(self, *args, **kwargs):
4948 """__init__(self, Window win, DateTime dt, wxEventType type) -> DateEvent"""
4949 newobj = _core_.new_DateEvent(*args, **kwargs)
4950 self.this = newobj.this
4951 self.thisown = 1
4952 del newobj.thisown
4953 def GetDate(*args, **kwargs):
4954 """GetDate(self) -> DateTime"""
4955 return _core_.DateEvent_GetDate(*args, **kwargs)
4956
4957 def SetDate(*args, **kwargs):
4958 """SetDate(self, DateTime date)"""
4959 return _core_.DateEvent_SetDate(*args, **kwargs)
4960
4961
4962class DateEventPtr(DateEvent):
4963 def __init__(self, this):
4964 self.this = this
4965 if not hasattr(self,"thisown"): self.thisown = 0
4966 self.__class__ = DateEvent
4967_core_.DateEvent_swigregister(DateEventPtr)
4968
4969wxEVT_DATE_CHANGED = _core_.wxEVT_DATE_CHANGED
4970EVT_DATE_CHANGED = wx.PyEventBinder( wxEVT_DATE_CHANGED, 1 )
4971
d14a1e28
RD
4972#---------------------------------------------------------------------------
4973
54f9ee45
RD
4974PYAPP_ASSERT_SUPPRESS = _core_.PYAPP_ASSERT_SUPPRESS
4975PYAPP_ASSERT_EXCEPTION = _core_.PYAPP_ASSERT_EXCEPTION
4976PYAPP_ASSERT_DIALOG = _core_.PYAPP_ASSERT_DIALOG
4977PYAPP_ASSERT_LOG = _core_.PYAPP_ASSERT_LOG
4978PRINT_WINDOWS = _core_.PRINT_WINDOWS
4979PRINT_POSTSCRIPT = _core_.PRINT_POSTSCRIPT
d14a1e28 4980class PyApp(EvtHandler):
66c033b4
RD
4981 """
4982 The ``wx.PyApp`` class is an *implementation detail*, please use the
4983 `wx.App` class (or some other derived class) instead.
4984 """
e811c8ce
RD
4985 def __repr__(self):
4986 return "<%s.%s; proxy of C++ wxPyApp instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4987 def __init__(self, *args, **kwargs):
98e665d3 4988 """
a95a7133 4989 __init__(self) -> PyApp
98e665d3
RD
4990
4991 Create a new application object, starting the bootstrap process.
4992 """
54f9ee45 4993 newobj = _core_.new_PyApp(*args, **kwargs)
d14a1e28
RD
4994 self.this = newobj.this
4995 self.thisown = 1
4996 del newobj.thisown
4997 self._setCallbackInfo(self, PyApp)
4998 self._setOORInfo(self)
e811c8ce 4999
54f9ee45 5000 def __del__(self, destroy=_core_.delete_PyApp):
a95a7133 5001 """__del__(self)"""
d14a1e28
RD
5002 try:
5003 if self.thisown: destroy(self)
5004 except: pass
e811c8ce
RD
5005
5006 def _setCallbackInfo(*args, **kwargs):
a95a7133 5007 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
54f9ee45 5008 return _core_.PyApp__setCallbackInfo(*args, **kwargs)
e811c8ce
RD
5009
5010 def GetAppName(*args, **kwargs):
0df68c9f 5011 """
a95a7133 5012 GetAppName(self) -> String
6c3b4aae 5013
0df68c9f
RD
5014 Get the application name.
5015 """
54f9ee45 5016 return _core_.PyApp_GetAppName(*args, **kwargs)
e811c8ce
RD
5017
5018 def SetAppName(*args, **kwargs):
0df68c9f 5019 """
a95a7133 5020 SetAppName(self, String name)
6c3b4aae 5021
66c033b4
RD
5022 Set the application name. This value may be used automatically by
5023 `wx.Config` and such.
0df68c9f 5024 """
54f9ee45 5025 return _core_.PyApp_SetAppName(*args, **kwargs)
e811c8ce
RD
5026
5027 def GetClassName(*args, **kwargs):
0df68c9f 5028 """
a95a7133 5029 GetClassName(self) -> String
e811c8ce 5030
0df68c9f
RD
5031 Get the application's class name.
5032 """
54f9ee45 5033 return _core_.PyApp_GetClassName(*args, **kwargs)
e811c8ce
RD
5034
5035 def SetClassName(*args, **kwargs):
0df68c9f 5036 """
a95a7133 5037 SetClassName(self, String name)
6c3b4aae 5038
66c033b4
RD
5039 Set the application's class name. This value may be used for
5040 X-resources if applicable for the platform
0df68c9f 5041 """
54f9ee45 5042 return _core_.PyApp_SetClassName(*args, **kwargs)
e811c8ce
RD
5043
5044 def GetVendorName(*args, **kwargs):
0df68c9f 5045 """
a95a7133 5046 GetVendorName(self) -> String
6c3b4aae 5047
0df68c9f
RD
5048 Get the application's vendor name.
5049 """
54f9ee45 5050 return _core_.PyApp_GetVendorName(*args, **kwargs)
e811c8ce
RD
5051
5052 def SetVendorName(*args, **kwargs):
0df68c9f 5053 """
a95a7133 5054 SetVendorName(self, String name)
6c3b4aae 5055
66c033b4
RD
5056 Set the application's vendor name. This value may be used
5057 automatically by `wx.Config` and such.
0df68c9f 5058 """
54f9ee45 5059 return _core_.PyApp_SetVendorName(*args, **kwargs)
e811c8ce
RD
5060
5061 def GetTraits(*args, **kwargs):
0df68c9f 5062 """
a95a7133 5063 GetTraits(self) -> wxAppTraits
6c3b4aae 5064
66c033b4
RD
5065 Return (and create if necessary) the app traits object to which we
5066 delegate for everything which either should be configurable by the
5067 user (then he can change the default behaviour simply by overriding
5068 CreateTraits() and returning his own traits object) or which is
5069 GUI/console dependent as then wx.AppTraits allows us to abstract the
5070 differences behind the common facade.
5071
5072 :todo: Add support for overriding CreateAppTraits in wxPython.
0df68c9f 5073 """
54f9ee45 5074 return _core_.PyApp_GetTraits(*args, **kwargs)
e811c8ce
RD
5075
5076 def ProcessPendingEvents(*args, **kwargs):
0df68c9f 5077 """
a95a7133 5078 ProcessPendingEvents(self)
6c3b4aae 5079
66c033b4
RD
5080 Process all events in the Pending Events list -- it is necessary to
5081 call this function to process posted events. This normally happens
5082 during each event loop iteration.
0df68c9f 5083 """
54f9ee45 5084 return _core_.PyApp_ProcessPendingEvents(*args, **kwargs)
e811c8ce
RD
5085
5086 def Yield(*args, **kwargs):
0df68c9f 5087 """
a95a7133 5088 Yield(self, bool onlyIfNeeded=False) -> bool
6c3b4aae 5089
66c033b4
RD
5090 Process all currently pending events right now, instead of waiting
5091 until return to the event loop. It is an error to call ``Yield``
5092 recursively unless the value of ``onlyIfNeeded`` is True.
6c3b4aae 5093
66c033b4 5094 :warning: This function is dangerous as it can lead to unexpected
41e2b43e
RD
5095 reentrancies (i.e. when called from an event handler it may
5096 result in calling the same event handler again), use with
5097 extreme care or, better, don't use at all!
0df68c9f 5098
66c033b4 5099 :see: `wx.Yield`, `wx.YieldIfNeeded`, `wx.SafeYield`
41e2b43e 5100
0df68c9f 5101 """
54f9ee45 5102 return _core_.PyApp_Yield(*args, **kwargs)
e811c8ce
RD
5103
5104 def WakeUpIdle(*args, **kwargs):
0df68c9f 5105 """
a95a7133 5106 WakeUpIdle(self)
6c3b4aae 5107
66c033b4
RD
5108 Make sure that idle events are sent again.
5109 :see: `wx.WakeUpIdle`
0df68c9f 5110 """
54f9ee45 5111 return _core_.PyApp_WakeUpIdle(*args, **kwargs)
e811c8ce 5112
1fc3b23a
RD
5113 def IsMainLoopRunning(*args, **kwargs):
5114 """
5115 IsMainLoopRunning() -> bool
5116
5117 Returns True if we're running the main loop, i.e. if the events can
5118 currently be dispatched.
5119 """
5120 return _core_.PyApp_IsMainLoopRunning(*args, **kwargs)
5121
5122 IsMainLoopRunning = staticmethod(IsMainLoopRunning)
e811c8ce 5123 def MainLoop(*args, **kwargs):
0df68c9f 5124 """
a95a7133 5125 MainLoop(self) -> int
6c3b4aae 5126
66c033b4
RD
5127 Execute the main GUI loop, the function doesn't normally return until
5128 all top level windows have been closed and destroyed.
0df68c9f 5129 """
54f9ee45 5130 return _core_.PyApp_MainLoop(*args, **kwargs)
e811c8ce
RD
5131
5132 def Exit(*args, **kwargs):
0df68c9f 5133 """
a95a7133 5134 Exit(self)
6c3b4aae 5135
0df68c9f 5136 Exit the main loop thus terminating the application.
66c033b4 5137 :see: `wx.Exit`
0df68c9f 5138 """
54f9ee45 5139 return _core_.PyApp_Exit(*args, **kwargs)
e811c8ce
RD
5140
5141 def ExitMainLoop(*args, **kwargs):
0df68c9f 5142 """
a95a7133 5143 ExitMainLoop(self)
6c3b4aae 5144
66c033b4
RD
5145 Exit the main GUI loop during the next iteration of the main
5146 loop, (i.e. it does not stop the program immediately!)
0df68c9f 5147 """
54f9ee45 5148 return _core_.PyApp_ExitMainLoop(*args, **kwargs)
e811c8ce
RD
5149
5150 def Pending(*args, **kwargs):
0df68c9f 5151 """
a95a7133 5152 Pending(self) -> bool
6c3b4aae 5153
0df68c9f
RD
5154 Returns True if there are unprocessed events in the event queue.
5155 """
54f9ee45 5156 return _core_.PyApp_Pending(*args, **kwargs)
e811c8ce
RD
5157
5158 def Dispatch(*args, **kwargs):
0df68c9f 5159 """
a95a7133 5160 Dispatch(self) -> bool
6c3b4aae 5161
0df68c9f
RD
5162 Process the first event in the event queue (blocks until an event
5163 appears if there are none currently)
5164 """
54f9ee45 5165 return _core_.PyApp_Dispatch(*args, **kwargs)
e811c8ce
RD
5166
5167 def ProcessIdle(*args, **kwargs):
0df68c9f 5168 """
a95a7133 5169 ProcessIdle(self) -> bool
6c3b4aae 5170
66c033b4
RD
5171 Called from the MainLoop when the application becomes idle (there are
5172 no pending events) and sends a `wx.IdleEvent` to all interested
5173 parties. Returns True if more idle events are needed, False if not.
0df68c9f 5174 """
54f9ee45 5175 return _core_.PyApp_ProcessIdle(*args, **kwargs)
e811c8ce
RD
5176
5177 def SendIdleEvents(*args, **kwargs):
0df68c9f 5178 """
a95a7133 5179 SendIdleEvents(self, Window win, IdleEvent event) -> bool
e811c8ce 5180
66c033b4
RD
5181 Send idle event to window and all subwindows. Returns True if more
5182 idle time is requested.
0df68c9f 5183 """
54f9ee45 5184 return _core_.PyApp_SendIdleEvents(*args, **kwargs)
e811c8ce
RD
5185
5186 def IsActive(*args, **kwargs):
0df68c9f 5187 """
a95a7133 5188 IsActive(self) -> bool
6c3b4aae 5189
0df68c9f
RD
5190 Return True if our app has focus.
5191 """
54f9ee45 5192 return _core_.PyApp_IsActive(*args, **kwargs)
e811c8ce
RD
5193
5194 def SetTopWindow(*args, **kwargs):
0df68c9f 5195 """
a95a7133 5196 SetTopWindow(self, Window win)
6c3b4aae 5197
66c033b4 5198 Set the *main* top level window
0df68c9f 5199 """
54f9ee45 5200 return _core_.PyApp_SetTopWindow(*args, **kwargs)
e811c8ce
RD
5201
5202 def GetTopWindow(*args, **kwargs):
0df68c9f 5203 """
a95a7133 5204 GetTopWindow(self) -> Window
6c3b4aae 5205
66c033b4
RD
5206 Return the *main* top level window (if it hadn't been set previously
5207 with SetTopWindow(), will return just some top level window and, if
5208 there not any, will return None)
0df68c9f 5209 """
54f9ee45 5210 return _core_.PyApp_GetTopWindow(*args, **kwargs)
e811c8ce
RD
5211
5212 def SetExitOnFrameDelete(*args, **kwargs):
0df68c9f 5213 """
a95a7133 5214 SetExitOnFrameDelete(self, bool flag)
0df68c9f 5215
66c033b4
RD
5216 Control the exit behaviour: by default, the program will exit the main
5217 loop (and so, usually, terminate) when the last top-level program
5218 window is deleted. Beware that if you disable this behaviour (with
5219 SetExitOnFrameDelete(False)), you'll have to call ExitMainLoop()
5220 explicitly from somewhere.
0df68c9f 5221 """
54f9ee45 5222 return _core_.PyApp_SetExitOnFrameDelete(*args, **kwargs)
e811c8ce
RD
5223
5224 def GetExitOnFrameDelete(*args, **kwargs):
0df68c9f 5225 """
a95a7133 5226 GetExitOnFrameDelete(self) -> bool
6c3b4aae 5227
0df68c9f
RD
5228 Get the current exit behaviour setting.
5229 """
54f9ee45 5230 return _core_.PyApp_GetExitOnFrameDelete(*args, **kwargs)
e811c8ce
RD
5231
5232 def SetUseBestVisual(*args, **kwargs):
0df68c9f 5233 """
a95a7133 5234 SetUseBestVisual(self, bool flag)
6c3b4aae 5235
66c033b4
RD
5236 Set whether the app should try to use the best available visual on
5237 systems where more than one is available, (Sun, SGI, XFree86 4, etc.)
0df68c9f 5238 """
54f9ee45 5239 return _core_.PyApp_SetUseBestVisual(*args, **kwargs)
e811c8ce
RD
5240
5241 def GetUseBestVisual(*args, **kwargs):
0df68c9f 5242 """
a95a7133 5243 GetUseBestVisual(self) -> bool
6c3b4aae 5244
0df68c9f
RD
5245 Get current UseBestVisual setting.
5246 """
54f9ee45 5247 return _core_.PyApp_GetUseBestVisual(*args, **kwargs)
e811c8ce
RD
5248
5249 def SetPrintMode(*args, **kwargs):
a95a7133 5250 """SetPrintMode(self, int mode)"""
54f9ee45 5251 return _core_.PyApp_SetPrintMode(*args, **kwargs)
e811c8ce
RD
5252
5253 def GetPrintMode(*args, **kwargs):
a95a7133 5254 """GetPrintMode(self) -> int"""
54f9ee45 5255 return _core_.PyApp_GetPrintMode(*args, **kwargs)
e811c8ce 5256
e811c8ce 5257 def SetAssertMode(*args, **kwargs):
0df68c9f 5258 """
a95a7133 5259 SetAssertMode(self, int mode)
6c3b4aae 5260
41e2b43e 5261 Set the OnAssert behaviour for debug and hybrid builds.
0df68c9f 5262 """
54f9ee45 5263 return _core_.PyApp_SetAssertMode(*args, **kwargs)
e811c8ce 5264
6c3b4aae 5265 def GetAssertMode(*args, **kwargs):
0df68c9f 5266 """
a95a7133 5267 GetAssertMode(self) -> int
6c3b4aae 5268
0df68c9f
RD
5269 Get the current OnAssert behaviour setting.
5270 """
54f9ee45 5271 return _core_.PyApp_GetAssertMode(*args, **kwargs)
6c3b4aae 5272
e811c8ce 5273 def GetMacSupportPCMenuShortcuts(*args, **kwargs):
66c033b4 5274 """GetMacSupportPCMenuShortcuts() -> bool"""
54f9ee45 5275 return _core_.PyApp_GetMacSupportPCMenuShortcuts(*args, **kwargs)
e811c8ce
RD
5276
5277 GetMacSupportPCMenuShortcuts = staticmethod(GetMacSupportPCMenuShortcuts)
5278 def GetMacAboutMenuItemId(*args, **kwargs):
66c033b4 5279 """GetMacAboutMenuItemId() -> long"""
54f9ee45 5280 return _core_.PyApp_GetMacAboutMenuItemId(*args, **kwargs)
e811c8ce
RD
5281
5282 GetMacAboutMenuItemId = staticmethod(GetMacAboutMenuItemId)
5283 def GetMacPreferencesMenuItemId(*args, **kwargs):
66c033b4 5284 """GetMacPreferencesMenuItemId() -> long"""
54f9ee45 5285 return _core_.PyApp_GetMacPreferencesMenuItemId(*args, **kwargs)
e811c8ce
RD
5286
5287 GetMacPreferencesMenuItemId = staticmethod(GetMacPreferencesMenuItemId)
5288 def GetMacExitMenuItemId(*args, **kwargs):
66c033b4 5289 """GetMacExitMenuItemId() -> long"""
54f9ee45 5290 return _core_.PyApp_GetMacExitMenuItemId(*args, **kwargs)
e811c8ce
RD
5291
5292 GetMacExitMenuItemId = staticmethod(GetMacExitMenuItemId)
5293 def GetMacHelpMenuTitleName(*args, **kwargs):
66c033b4 5294 """GetMacHelpMenuTitleName() -> String"""
54f9ee45 5295 return _core_.PyApp_GetMacHelpMenuTitleName(*args, **kwargs)
e811c8ce
RD
5296
5297 GetMacHelpMenuTitleName = staticmethod(GetMacHelpMenuTitleName)
5298 def SetMacSupportPCMenuShortcuts(*args, **kwargs):
66c033b4 5299 """SetMacSupportPCMenuShortcuts(bool val)"""
54f9ee45 5300 return _core_.PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs)
e811c8ce
RD
5301
5302 SetMacSupportPCMenuShortcuts = staticmethod(SetMacSupportPCMenuShortcuts)
5303 def SetMacAboutMenuItemId(*args, **kwargs):
66c033b4 5304 """SetMacAboutMenuItemId(long val)"""
54f9ee45 5305 return _core_.PyApp_SetMacAboutMenuItemId(*args, **kwargs)
e811c8ce
RD
5306
5307 SetMacAboutMenuItemId = staticmethod(SetMacAboutMenuItemId)
5308 def SetMacPreferencesMenuItemId(*args, **kwargs):
66c033b4 5309 """SetMacPreferencesMenuItemId(long val)"""
54f9ee45 5310 return _core_.PyApp_SetMacPreferencesMenuItemId(*args, **kwargs)
e811c8ce
RD
5311
5312 SetMacPreferencesMenuItemId = staticmethod(SetMacPreferencesMenuItemId)
5313 def SetMacExitMenuItemId(*args, **kwargs):
66c033b4 5314 """SetMacExitMenuItemId(long val)"""
54f9ee45 5315 return _core_.PyApp_SetMacExitMenuItemId(*args, **kwargs)
e811c8ce
RD
5316
5317 SetMacExitMenuItemId = staticmethod(SetMacExitMenuItemId)
5318 def SetMacHelpMenuTitleName(*args, **kwargs):
66c033b4 5319 """SetMacHelpMenuTitleName(String val)"""
54f9ee45 5320 return _core_.PyApp_SetMacHelpMenuTitleName(*args, **kwargs)
e811c8ce
RD
5321
5322 SetMacHelpMenuTitleName = staticmethod(SetMacHelpMenuTitleName)
5323 def _BootstrapApp(*args, **kwargs):
0df68c9f 5324 """
a95a7133 5325 _BootstrapApp(self)
6c3b4aae 5326
0df68c9f
RD
5327 For internal use only
5328 """
54f9ee45 5329 return _core_.PyApp__BootstrapApp(*args, **kwargs)
e811c8ce
RD
5330
5331 def GetComCtl32Version(*args, **kwargs):
0df68c9f 5332 """
66c033b4 5333 GetComCtl32Version() -> int
6c3b4aae 5334
66c033b4
RD
5335 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
5336 it wasn't found at all. Raises an exception on non-Windows platforms.
0df68c9f 5337 """
54f9ee45 5338 return _core_.PyApp_GetComCtl32Version(*args, **kwargs)
e811c8ce
RD
5339
5340 GetComCtl32Version = staticmethod(GetComCtl32Version)
d14a1e28
RD
5341
5342class PyAppPtr(PyApp):
5343 def __init__(self, this):
5344 self.this = this
5345 if not hasattr(self,"thisown"): self.thisown = 0
5346 self.__class__ = PyApp
54f9ee45 5347_core_.PyApp_swigregister(PyAppPtr)
d14a1e28 5348
1fc3b23a
RD
5349def PyApp_IsMainLoopRunning(*args, **kwargs):
5350 """
5351 PyApp_IsMainLoopRunning() -> bool
5352
5353 Returns True if we're running the main loop, i.e. if the events can
5354 currently be dispatched.
5355 """
5356 return _core_.PyApp_IsMainLoopRunning(*args, **kwargs)
5357
e811c8ce
RD
5358def PyApp_GetMacSupportPCMenuShortcuts(*args, **kwargs):
5359 """PyApp_GetMacSupportPCMenuShortcuts() -> bool"""
54f9ee45 5360 return _core_.PyApp_GetMacSupportPCMenuShortcuts(*args, **kwargs)
d14a1e28 5361
e811c8ce
RD
5362def PyApp_GetMacAboutMenuItemId(*args, **kwargs):
5363 """PyApp_GetMacAboutMenuItemId() -> long"""
54f9ee45 5364 return _core_.PyApp_GetMacAboutMenuItemId(*args, **kwargs)
d14a1e28 5365
e811c8ce
RD
5366def PyApp_GetMacPreferencesMenuItemId(*args, **kwargs):
5367 """PyApp_GetMacPreferencesMenuItemId() -> long"""
54f9ee45 5368 return _core_.PyApp_GetMacPreferencesMenuItemId(*args, **kwargs)
d14a1e28 5369
e811c8ce
RD
5370def PyApp_GetMacExitMenuItemId(*args, **kwargs):
5371 """PyApp_GetMacExitMenuItemId() -> long"""
54f9ee45 5372 return _core_.PyApp_GetMacExitMenuItemId(*args, **kwargs)
d14a1e28 5373
e811c8ce 5374def PyApp_GetMacHelpMenuTitleName(*args, **kwargs):
196addbf 5375 """PyApp_GetMacHelpMenuTitleName() -> String"""
54f9ee45 5376 return _core_.PyApp_GetMacHelpMenuTitleName(*args, **kwargs)
d14a1e28 5377
e811c8ce
RD
5378def PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs):
5379 """PyApp_SetMacSupportPCMenuShortcuts(bool val)"""
54f9ee45 5380 return _core_.PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs)
d14a1e28 5381
e811c8ce
RD
5382def PyApp_SetMacAboutMenuItemId(*args, **kwargs):
5383 """PyApp_SetMacAboutMenuItemId(long val)"""
54f9ee45 5384 return _core_.PyApp_SetMacAboutMenuItemId(*args, **kwargs)
d14a1e28 5385
e811c8ce
RD
5386def PyApp_SetMacPreferencesMenuItemId(*args, **kwargs):
5387 """PyApp_SetMacPreferencesMenuItemId(long val)"""
54f9ee45 5388 return _core_.PyApp_SetMacPreferencesMenuItemId(*args, **kwargs)
d14a1e28 5389
e811c8ce
RD
5390def PyApp_SetMacExitMenuItemId(*args, **kwargs):
5391 """PyApp_SetMacExitMenuItemId(long val)"""
54f9ee45 5392 return _core_.PyApp_SetMacExitMenuItemId(*args, **kwargs)
d14a1e28 5393
e811c8ce 5394def PyApp_SetMacHelpMenuTitleName(*args, **kwargs):
196addbf 5395 """PyApp_SetMacHelpMenuTitleName(String val)"""
54f9ee45 5396 return _core_.PyApp_SetMacHelpMenuTitleName(*args, **kwargs)
d14a1e28 5397
e811c8ce 5398def PyApp_GetComCtl32Version(*args, **kwargs):
0df68c9f
RD
5399 """
5400 PyApp_GetComCtl32Version() -> int
6c3b4aae 5401
66c033b4
RD
5402 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
5403 it wasn't found at all. Raises an exception on non-Windows platforms.
0df68c9f 5404 """
54f9ee45 5405 return _core_.PyApp_GetComCtl32Version(*args, **kwargs)
d14a1e28
RD
5406
5407#---------------------------------------------------------------------------
5408
5409
e811c8ce 5410def Exit(*args, **kwargs):
0df68c9f
RD
5411 """
5412 Exit()
6c3b4aae 5413
0df68c9f
RD
5414 Force an exit of the application. Convenience for wx.GetApp().Exit()
5415 """
54f9ee45 5416 return _core_.Exit(*args, **kwargs)
d14a1e28 5417
e811c8ce 5418def Yield(*args, **kwargs):
0df68c9f
RD
5419 """
5420 Yield() -> bool
6c3b4aae 5421
0df68c9f
RD
5422 Yield to other apps/messages. Convenience for wx.GetApp().Yield()
5423 """
54f9ee45 5424 return _core_.Yield(*args, **kwargs)
d14a1e28 5425
e811c8ce 5426def YieldIfNeeded(*args, **kwargs):
0df68c9f
RD
5427 """
5428 YieldIfNeeded() -> bool
6c3b4aae 5429
0df68c9f
RD
5430 Yield to other apps/messages. Convenience for wx.GetApp().Yield(True)
5431 """
54f9ee45 5432 return _core_.YieldIfNeeded(*args, **kwargs)
d14a1e28 5433
e811c8ce 5434def SafeYield(*args, **kwargs):
0df68c9f
RD
5435 """
5436 SafeYield(Window win=None, bool onlyIfNeeded=False) -> bool
6c3b4aae 5437
66c033b4
RD
5438 This function is similar to `wx.Yield`, except that it disables the
5439 user input to all program windows before calling `wx.Yield` and
5440 re-enables it again afterwards. If ``win`` is not None, this window
5441 will remain enabled, allowing the implementation of some limited user
5442 interaction.
6c3b4aae 5443
66c033b4 5444 :Returns: the result of the call to `wx.Yield`.
0df68c9f 5445 """
54f9ee45 5446 return _core_.SafeYield(*args, **kwargs)
d14a1e28 5447
e811c8ce 5448def WakeUpIdle(*args, **kwargs):
0df68c9f
RD
5449 """
5450 WakeUpIdle()
6c3b4aae 5451
66c033b4
RD
5452 Cause the message queue to become empty again, so idle events will be
5453 sent.
0df68c9f 5454 """
54f9ee45 5455 return _core_.WakeUpIdle(*args, **kwargs)
d14a1e28 5456
e811c8ce 5457def PostEvent(*args, **kwargs):
0df68c9f
RD
5458 """
5459 PostEvent(EvtHandler dest, Event event)
6c3b4aae 5460
66c033b4
RD
5461 Send an event to a window or other wx.EvtHandler to be processed
5462 later.
0df68c9f 5463 """
54f9ee45 5464 return _core_.PostEvent(*args, **kwargs)
d14a1e28 5465
e811c8ce 5466def App_CleanUp(*args, **kwargs):
0df68c9f
RD
5467 """
5468 App_CleanUp()
6c3b4aae 5469
41e2b43e 5470 For internal use only, it is used to cleanup after wxWidgets when
66c033b4 5471 Python shuts down.
0df68c9f 5472 """
54f9ee45 5473 return _core_.App_CleanUp(*args, **kwargs)
d14a1e28 5474
e811c8ce 5475def GetApp(*args, **kwargs):
0df68c9f
RD
5476 """
5477 GetApp() -> PyApp
6c3b4aae 5478
196addbf 5479 Return a reference to the current wx.App object.
0df68c9f 5480 """
54f9ee45 5481 return _core_.GetApp(*args, **kwargs)
5cbf236d
RD
5482
5483def SetDefaultPyEncoding(*args, **kwargs):
5484 """
5485 SetDefaultPyEncoding(string encoding)
5486
5487 Sets the encoding that wxPython will use when it needs to convert a
5488 Python string or unicode object to or from a wxString.
e505d15e
RD
5489
5490 The default encoding is the value of ``locale.getdefaultlocale()[1]``
5491 but please be aware that the default encoding within the same locale
5492 may be slightly different on different platforms. For example, please
5493 see http://www.alanwood.net/demos/charsetdiffs.html for differences
5494 between the common latin/roman encodings.
5cbf236d
RD
5495 """
5496 return _core_.SetDefaultPyEncoding(*args, **kwargs)
5497
5498def GetDefaultPyEncoding(*args, **kwargs):
5499 """
5500 GetDefaultPyEncoding() -> string
5501
5502 Gets the current encoding that wxPython will use when it needs to
5503 convert a Python string or unicode object to or from a wxString.
5504 """
5505 return _core_.GetDefaultPyEncoding(*args, **kwargs)
d14a1e28
RD
5506#----------------------------------------------------------------------
5507
5508class PyOnDemandOutputWindow:
6c3b4aae
RD
5509 """
5510 A class that can be used for redirecting Python's stdout and
5511 stderr streams. It will do nothing until something is wrriten to
5512 the stream at which point it will create a Frame with a text area
5513 and write the text there.
5514 """
d14a1e28
RD
5515 def __init__(self, title = "wxPython: stdout/stderr"):
5516 self.frame = None
5517 self.title = title
412d302d
RD
5518 self.pos = wx.DefaultPosition
5519 self.size = (450, 300)
d14a1e28
RD
5520 self.parent = None
5521
5522 def SetParent(self, parent):
6c3b4aae 5523 """Set the window to be used as the popup Frame's parent."""
d14a1e28
RD
5524 self.parent = parent
5525
6c3b4aae
RD
5526
5527 def CreateOutputWindow(self, st):
412d302d
RD
5528 self.frame = wx.Frame(self.parent, -1, self.title, self.pos, self.size,
5529 style=wx.DEFAULT_FRAME_STYLE)
196addbf 5530 self.text = wx.TextCtrl(self.frame, -1, "",
412d302d 5531 style=wx.TE_MULTILINE|wx.TE_READONLY)
d1e20054 5532 self.text.AppendText(st)
6c3b4aae
RD
5533 self.frame.Show(True)
5534 EVT_CLOSE(self.frame, self.OnCloseWindow)
5535
d14a1e28 5536
7409c0c6
RD
5537 def OnCloseWindow(self, event):
5538 if self.frame is not None:
5539 self.frame.Destroy()
5540 self.frame = None
5541 self.text = None
5542
5543
d14a1e28 5544 # These methods provide the file-like output behaviour.
6c3b4aae
RD
5545 def write(self, text):
5546 """
5547 Create the output window if needed and write the string to it.
5548 If not called in the context of the gui thread then uses
5549 CallAfter to do the work there.
5550 """
5551 if self.frame is None:
5552 if not wx.Thread_IsMain():
5553 wx.CallAfter(self.CreateOutputWindow, text)
5554 else:
5555 self.CreateOutputWindow(text)
5556 else:
5557 if not wx.Thread_IsMain():
5558 wx.CallAfter(self.text.AppendText, text)
5559 else:
5560 self.text.AppendText(text)
5561
d14a1e28
RD
5562
5563 def close(self):
6c3b4aae
RD
5564 if self.frame is not None:
5565 wx.CallAfter(self.frame.Close)
5566
d14a1e28 5567
19272049
RD
5568 def flush(self):
5569 pass
5570
5571
d14a1e28
RD
5572
5573#----------------------------------------------------------------------
d14a1e28
RD
5574
5575_defRedirect = (wx.Platform == '__WXMSW__' or wx.Platform == '__WXMAC__')
5576
5577class App(wx.PyApp):
6c3b4aae 5578 """
66c033b4
RD
5579 The ``wx.App`` class represents the application and is used to:
5580
5581 * bootstrap the wxPython system and initialize the underlying
5582 gui toolkit
5583 * set and get application-wide properties
5584 * implement the windowing system main message or event loop,
5585 and to dispatch events to window instances
5586 * etc.
5587
5588 Every application must have a ``wx.App`` instance, and all
5589 creation of UI objects should be delayed until after the
03e37cd5
RD
5590 ``wx.App`` object has been created in order to ensure that the gui
5591 platform and wxWidgets have been fully initialized.
66c033b4
RD
5592
5593 Normally you would derive from this class and implement an
5594 ``OnInit`` method that creates a frame and then calls
5595 ``self.SetTopWindow(frame)``.
5596
03e37cd5 5597 :see: `wx.PySimpleApp` for a simpler app class that can be used
1c0f361b 5598 directly.
6c3b4aae 5599 """
66c033b4 5600
d14a1e28
RD
5601 outputWindowClass = PyOnDemandOutputWindow
5602
03e37cd5
RD
5603 def __init__(self, redirect=_defRedirect, filename=None,
5604 useBestVisual=False, clearSigInt=True):
66c033b4
RD
5605 """
5606 Construct a ``wx.App`` object.
5607
03e37cd5
RD
5608 :param redirect: Should ``sys.stdout`` and ``sys.stderr`` be
5609 redirected? Defaults to True on Windows and Mac, False
5610 otherwise. If `filename` is None then output will be
5611 redirected to a window that pops up as needed. (You can
5612 control what kind of window is created for the output by
5613 resetting the class variable ``outputWindowClass`` to a
5614 class of your choosing.)
66c033b4 5615
03e37cd5
RD
5616 :param filename: The name of a file to redirect output to, if
5617 redirect is True.
66c033b4
RD
5618
5619 :param useBestVisual: Should the app try to use the best
03e37cd5
RD
5620 available visual provided by the system (only relevant on
5621 systems that have more than one visual.) This parameter
5622 must be used instead of calling `SetUseBestVisual` later
5623 on because it must be set before the underlying GUI
5624 toolkit is initialized.
5625
5626 :param clearSigInt: Should SIGINT be cleared? This allows the
5627 app to terminate upon a Ctrl-C in the console like other
5628 GUI apps will.
66c033b4
RD
5629
5630 :note: You should override OnInit to do applicaition
5631 initialization to ensure that the system, toolkit and
5632 wxWidgets are fully initialized.
5633 """
d14a1e28
RD
5634 wx.PyApp.__init__(self)
5635
5636 if wx.Platform == "__WXMAC__":
5637 try:
5638 import MacOS
5639 if not MacOS.WMAvailable():
5640 print """\
5641This program needs access to the screen. Please run with 'pythonw',
5642not 'python', and only when you are logged in on the main display of
5643your Mac."""
5644 _sys.exit(1)
36cadbf7
RD
5645 except SystemExit:
5646 raise
d14a1e28
RD
5647 except:
5648 pass
5649
5650 # This has to be done before OnInit
5651 self.SetUseBestVisual(useBestVisual)
5652
5653 # Set the default handler for SIGINT. This fixes a problem
5654 # where if Ctrl-C is pressed in the console that started this
5655 # app then it will not appear to do anything, (not even send
5656 # KeyboardInterrupt???) but will later segfault on exit. By
5657 # setting the default handler then the app will exit, as
5658 # expected (depending on platform.)
03e37cd5
RD
5659 if clearSigInt:
5660 try:
5661 import signal
5662 signal.signal(signal.SIGINT, signal.SIG_DFL)
5663 except:
5664 pass
d14a1e28
RD
5665
5666 # Save and redirect the stdio to a window?
5667 self.stdioWin = None
5668 self.saveStdio = (_sys.stdout, _sys.stderr)
5669 if redirect:
5670 self.RedirectStdio(filename)
5671
8fb0e70a
RD
5672 # Use Python's install prefix as the default
5673 wx.StandardPaths.Get().SetInstallPrefix(_sys.prefix)
5674
d14a1e28
RD
5675 # This finishes the initialization of wxWindows and then calls
5676 # the OnInit that should be present in the derived class
5677 self._BootstrapApp()
5678
5679
5680 def __del__(self):
5681 try:
5682 self.RestoreStdio() # Just in case the MainLoop was overridden
5683 except:
5684 pass
5685
5686
5687 def SetTopWindow(self, frame):
1e0c8722 5688 """Set the \"main\" top level window"""
d14a1e28
RD
5689 if self.stdioWin:
5690 self.stdioWin.SetParent(frame)
5691 wx.PyApp.SetTopWindow(self, frame)
5692
5693
5694 def MainLoop(self):
1e0c8722 5695 """Execute the main GUI event loop"""
d14a1e28
RD
5696 wx.PyApp.MainLoop(self)
5697 self.RestoreStdio()
5698
5699
7409c0c6 5700 def RedirectStdio(self, filename=None):
1e0c8722 5701 """Redirect sys.stdout and sys.stderr to a file or a popup window."""
d14a1e28
RD
5702 if filename:
5703 _sys.stdout = _sys.stderr = open(filename, 'a')
5704 else:
5705 self.stdioWin = self.outputWindowClass()
5706 _sys.stdout = _sys.stderr = self.stdioWin
5707
5708
5709 def RestoreStdio(self):
5710 _sys.stdout, _sys.stderr = self.saveStdio
5711
5712
412d302d
RD
5713 def SetOutputWindowAttributes(self, title=None, pos=None, size=None):
5714 """
5715 Set the title, position and/or size of the output window if
f5b96ee1
RD
5716 the stdio has been redirected. This should be called before
5717 any output would cause the output window to be created.
412d302d
RD
5718 """
5719 if self.stdioWin:
5720 if title is not None:
5721 self.stdioWin.title = title
5722 if pos is not None:
5723 self.stdioWin.pos = pos
5724 if size is not None:
5725 self.stdioWin.size = size
5726
5727
5728
d14a1e28 5729
66c033b4 5730# change from wx.PyApp_XX to wx.App_XX
54f9ee45
RD
5731App_GetMacSupportPCMenuShortcuts = _core_.PyApp_GetMacSupportPCMenuShortcuts
5732App_GetMacAboutMenuItemId = _core_.PyApp_GetMacAboutMenuItemId
5733App_GetMacPreferencesMenuItemId = _core_.PyApp_GetMacPreferencesMenuItemId
5734App_GetMacExitMenuItemId = _core_.PyApp_GetMacExitMenuItemId
5735App_GetMacHelpMenuTitleName = _core_.PyApp_GetMacHelpMenuTitleName
5736App_SetMacSupportPCMenuShortcuts = _core_.PyApp_SetMacSupportPCMenuShortcuts
5737App_SetMacAboutMenuItemId = _core_.PyApp_SetMacAboutMenuItemId
5738App_SetMacPreferencesMenuItemId = _core_.PyApp_SetMacPreferencesMenuItemId
5739App_SetMacExitMenuItemId = _core_.PyApp_SetMacExitMenuItemId
5740App_SetMacHelpMenuTitleName = _core_.PyApp_SetMacHelpMenuTitleName
5741App_GetComCtl32Version = _core_.PyApp_GetComCtl32Version
d14a1e28
RD
5742
5743#----------------------------------------------------------------------------
5744
5745class PySimpleApp(wx.App):
6c3b4aae
RD
5746 """
5747 A simple application class. You can just create one of these and
5748 then then make your top level windows later, and not have to worry
66c033b4
RD
5749 about OnInit. For example::
5750
5751 app = wx.PySimpleApp()
5752 frame = wx.Frame(None, title='Hello World')
5753 frame.Show()
5754 app.MainLoop()
5755
5756 :see: `wx.App`
5757 """
6c3b4aae 5758
03e37cd5
RD
5759 def __init__(self, redirect=False, filename=None,
5760 useBestVisual=False, clearSigInt=True):
66c033b4
RD
5761 """
5762 :see: `wx.App.__init__`
5763 """
03e37cd5 5764 wx.App.__init__(self, redirect, filename, useBestVisual, clearSigInt)
6c3b4aae 5765
d14a1e28 5766 def OnInit(self):
d14a1e28
RD
5767 return True
5768
5769
66c033b4 5770
6c3b4aae 5771# Is anybody using this one?
d14a1e28
RD
5772class PyWidgetTester(wx.App):
5773 def __init__(self, size = (250, 100)):
5774 self.size = size
5775 wx.App.__init__(self, 0)
5776
5777 def OnInit(self):
196addbf 5778 self.frame = wx.Frame(None, -1, "Widget Tester", pos=(0,0), size=self.size)
d14a1e28
RD
5779 self.SetTopWindow(self.frame)
5780 return True
5781
66c033b4
RD
5782 def SetWidget(self, widgetClass, *args, **kwargs):
5783 w = widgetClass(self.frame, *args, **kwargs)
d14a1e28
RD
5784 self.frame.Show(True)
5785
5786#----------------------------------------------------------------------------
5787# DO NOT hold any other references to this object. This is how we
66c033b4 5788# know when to cleanup system resources that wxWidgets is holding. When
d14a1e28 5789# the sys module is unloaded, the refcount on sys.__wxPythonCleanup
66c033b4 5790# goes to zero and it calls the wx.App_CleanUp function.
d14a1e28
RD
5791
5792class __wxPyCleanup:
5793 def __init__(self):
54f9ee45 5794 self.cleanup = _core_.App_CleanUp
d14a1e28
RD
5795 def __del__(self):
5796 self.cleanup()
5797
5798_sys.__wxPythonCleanup = __wxPyCleanup()
5799
5800## # another possible solution, but it gets called too early...
66c033b4
RD
5801## import atexit
5802## atexit.register(_core_.wxApp_CleanUp)
d14a1e28
RD
5803
5804
5805#----------------------------------------------------------------------------
5806
5807#---------------------------------------------------------------------------
2ef75293
RD
5808
5809class EventLoop(object):
093d3ff1 5810 """Proxy of C++ EventLoop class"""
2ef75293
RD
5811 def __repr__(self):
5812 return "<%s.%s; proxy of C++ wxEventLoop instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5813 def __init__(self, *args, **kwargs):
5814 """__init__(self) -> EventLoop"""
5815 newobj = _core_.new_EventLoop(*args, **kwargs)
5816 self.this = newobj.this
5817 self.thisown = 1
5818 del newobj.thisown
5819 def __del__(self, destroy=_core_.delete_EventLoop):
5820 """__del__(self)"""
5821 try:
5822 if self.thisown: destroy(self)
5823 except: pass
5824
5825 def Run(*args, **kwargs):
5826 """Run(self) -> int"""
5827 return _core_.EventLoop_Run(*args, **kwargs)
5828
5829 def Exit(*args, **kwargs):
5830 """Exit(self, int rc=0)"""
5831 return _core_.EventLoop_Exit(*args, **kwargs)
5832
5833 def Pending(*args, **kwargs):
5834 """Pending(self) -> bool"""
5835 return _core_.EventLoop_Pending(*args, **kwargs)
5836
5837 def Dispatch(*args, **kwargs):
5838 """Dispatch(self) -> bool"""
5839 return _core_.EventLoop_Dispatch(*args, **kwargs)
5840
5841 def IsRunning(*args, **kwargs):
5842 """IsRunning(self) -> bool"""
5843 return _core_.EventLoop_IsRunning(*args, **kwargs)
5844
5845 def GetActive(*args, **kwargs):
5846 """GetActive() -> EventLoop"""
5847 return _core_.EventLoop_GetActive(*args, **kwargs)
5848
5849 GetActive = staticmethod(GetActive)
5850 def SetActive(*args, **kwargs):
5851 """SetActive(EventLoop loop)"""
5852 return _core_.EventLoop_SetActive(*args, **kwargs)
5853
5854 SetActive = staticmethod(SetActive)
5855
5856class EventLoopPtr(EventLoop):
5857 def __init__(self, this):
5858 self.this = this
5859 if not hasattr(self,"thisown"): self.thisown = 0
5860 self.__class__ = EventLoop
5861_core_.EventLoop_swigregister(EventLoopPtr)
5862
5863def EventLoop_GetActive(*args, **kwargs):
5864 """EventLoop_GetActive() -> EventLoop"""
5865 return _core_.EventLoop_GetActive(*args, **kwargs)
5866
5867def EventLoop_SetActive(*args, **kwargs):
5868 """EventLoop_SetActive(EventLoop loop)"""
5869 return _core_.EventLoop_SetActive(*args, **kwargs)
5870
5871#---------------------------------------------------------------------------
d14a1e28 5872
1e0c8722 5873class AcceleratorEntry(object):
66c033b4
RD
5874 """
5875 A class used to define items in an `wx.AcceleratorTable`. wxPython
5876 programs can choose to use wx.AcceleratorEntry objects, but using a
5877 list of 3-tuple of integers (flags, keyCode, cmdID) usually works just
41e2b43e 5878 as well. See `__init__` for of the tuple values.
66c033b4
RD
5879
5880 :see: `wx.AcceleratorTable`
5881 """
1e0c8722
RD
5882 def __repr__(self):
5883 return "<%s.%s; proxy of C++ wxAcceleratorEntry instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5884 def __init__(self, *args, **kwargs):
66c033b4
RD
5885 """
5886 __init__(self, int flags=0, int keyCode=0, int cmdID=0) -> AcceleratorEntry
5887
5888 Construct a wx.AcceleratorEntry.
66c033b4 5889 """
54f9ee45 5890 newobj = _core_.new_AcceleratorEntry(*args, **kwargs)
1e0c8722
RD
5891 self.this = newobj.this
5892 self.thisown = 1
5893 del newobj.thisown
54f9ee45 5894 def __del__(self, destroy=_core_.delete_AcceleratorEntry):
a95a7133 5895 """__del__(self)"""
1e0c8722
RD
5896 try:
5897 if self.thisown: destroy(self)
5898 except: pass
5899
5900 def Set(*args, **kwargs):
66c033b4
RD
5901 """
5902 Set(self, int flags, int keyCode, int cmd)
1e0c8722 5903
66c033b4
RD
5904 (Re)set the attributes of a wx.AcceleratorEntry.
5905 :see `__init__`
5906 """
5907 return _core_.AcceleratorEntry_Set(*args, **kwargs)
1e0c8722
RD
5908
5909 def GetFlags(*args, **kwargs):
66c033b4
RD
5910 """
5911 GetFlags(self) -> int
5912
5913 Get the AcceleratorEntry's flags.
5914 """
54f9ee45 5915 return _core_.AcceleratorEntry_GetFlags(*args, **kwargs)
1e0c8722
RD
5916
5917 def GetKeyCode(*args, **kwargs):
66c033b4
RD
5918 """
5919 GetKeyCode(self) -> int
5920
5921 Get the AcceleratorEntry's keycode.
5922 """
54f9ee45 5923 return _core_.AcceleratorEntry_GetKeyCode(*args, **kwargs)
1e0c8722
RD
5924
5925 def GetCommand(*args, **kwargs):
66c033b4
RD
5926 """
5927 GetCommand(self) -> int
5928
5929 Get the AcceleratorEntry's command ID.
5930 """
54f9ee45 5931 return _core_.AcceleratorEntry_GetCommand(*args, **kwargs)
1e0c8722
RD
5932
5933
5934class AcceleratorEntryPtr(AcceleratorEntry):
5935 def __init__(self, this):
5936 self.this = this
5937 if not hasattr(self,"thisown"): self.thisown = 0
5938 self.__class__ = AcceleratorEntry
54f9ee45 5939_core_.AcceleratorEntry_swigregister(AcceleratorEntryPtr)
1e0c8722
RD
5940
5941class AcceleratorTable(Object):
66c033b4
RD
5942 """
5943 An accelerator table allows the application to specify a table of
5944 keyboard shortcuts for menus or other commands. On Windows, menu or
5945 button commands are supported; on GTK, only menu commands are
5946 supported.
66c033b4 5947 """
1e0c8722
RD
5948 def __repr__(self):
5949 return "<%s.%s; proxy of C++ wxAcceleratorTable instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5950 def __init__(self, *args, **kwargs):
0df68c9f
RD
5951 """
5952 __init__(entries) -> AcceleratorTable
1e0c8722 5953
66c033b4
RD
5954 Construct an AcceleratorTable from a list of `wx.AcceleratorEntry`
5955 items or or of 3-tuples (flags, keyCode, cmdID)
5956
5957 :see: `wx.AcceleratorEntry`
0df68c9f 5958 """
54f9ee45 5959 newobj = _core_.new_AcceleratorTable(*args, **kwargs)
1e0c8722
RD
5960 self.this = newobj.this
5961 self.thisown = 1
5962 del newobj.thisown
54f9ee45 5963 def __del__(self, destroy=_core_.delete_AcceleratorTable):
a95a7133 5964 """__del__(self)"""
1e0c8722
RD
5965 try:
5966 if self.thisown: destroy(self)
5967 except: pass
5968
5969 def Ok(*args, **kwargs):
a95a7133 5970 """Ok(self) -> bool"""
54f9ee45 5971 return _core_.AcceleratorTable_Ok(*args, **kwargs)
1e0c8722
RD
5972
5973
5974class AcceleratorTablePtr(AcceleratorTable):
5975 def __init__(self, this):
5976 self.this = this
5977 if not hasattr(self,"thisown"): self.thisown = 0
5978 self.__class__ = AcceleratorTable
54f9ee45 5979_core_.AcceleratorTable_swigregister(AcceleratorTablePtr)
1e0c8722
RD
5980
5981
5982def GetAccelFromString(*args, **kwargs):
196addbf 5983 """GetAccelFromString(String label) -> AcceleratorEntry"""
54f9ee45 5984 return _core_.GetAccelFromString(*args, **kwargs)
1e0c8722
RD
5985#---------------------------------------------------------------------------
5986
74a57fcd
RD
5987class VisualAttributes(object):
5988 """struct containing all the visual attributes of a control"""
5989 def __repr__(self):
5990 return "<%s.%s; proxy of C++ wxVisualAttributes instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5991 def __init__(self, *args, **kwargs):
5992 """
a95a7133 5993 __init__(self) -> VisualAttributes
74a57fcd
RD
5994
5995 struct containing all the visual attributes of a control
5996 """
54f9ee45 5997 newobj = _core_.new_VisualAttributes(*args, **kwargs)
74a57fcd
RD
5998 self.this = newobj.this
5999 self.thisown = 1
6000 del newobj.thisown
54f9ee45 6001 def __del__(self, destroy=_core_.delete_VisualAttributes):
a95a7133 6002 """__del__(self)"""
74a57fcd
RD
6003 try:
6004 if self.thisown: destroy(self)
6005 except: pass
6006
54f9ee45
RD
6007 font = property(_core_.VisualAttributes_font_get, _core_.VisualAttributes_font_set)
6008 colFg = property(_core_.VisualAttributes_colFg_get, _core_.VisualAttributes_colFg_set)
6009 colBg = property(_core_.VisualAttributes_colBg_get, _core_.VisualAttributes_colBg_set)
74a57fcd
RD
6010
6011class VisualAttributesPtr(VisualAttributes):
6012 def __init__(self, this):
6013 self.this = this
6014 if not hasattr(self,"thisown"): self.thisown = 0
6015 self.__class__ = VisualAttributes
54f9ee45 6016_core_.VisualAttributes_swigregister(VisualAttributesPtr)
74a57fcd
RD
6017NullAcceleratorTable = cvar.NullAcceleratorTable
6018PanelNameStr = cvar.PanelNameStr
6019
54f9ee45
RD
6020WINDOW_VARIANT_NORMAL = _core_.WINDOW_VARIANT_NORMAL
6021WINDOW_VARIANT_SMALL = _core_.WINDOW_VARIANT_SMALL
6022WINDOW_VARIANT_MINI = _core_.WINDOW_VARIANT_MINI
6023WINDOW_VARIANT_LARGE = _core_.WINDOW_VARIANT_LARGE
6024WINDOW_VARIANT_MAX = _core_.WINDOW_VARIANT_MAX
d14a1e28 6025class Window(EvtHandler):
15afbcd0
RD
6026 """
6027 wx.Window is the base class for all windows and represents any visible
6028 object on the screen. All controls, top level windows and so on are
6029 wx.Windows. Sizers and device contexts are not however, as they don't
6030 appear on screen themselves.
6031
6032 """
e811c8ce
RD
6033 def __repr__(self):
6034 return "<%s.%s; proxy of C++ wxWindow instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 6035 def __init__(self, *args, **kwargs):
0df68c9f 6036 """
a95a7133 6037 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
74a57fcd 6038 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> Window
15afbcd0
RD
6039
6040 Construct and show a generic Window.
0df68c9f 6041 """
54f9ee45 6042 newobj = _core_.new_Window(*args, **kwargs)
d14a1e28
RD
6043 self.this = newobj.this
6044 self.thisown = 1
6045 del newobj.thisown
6046 self._setOORInfo(self)
d14a1e28 6047
e811c8ce 6048 def Create(*args, **kwargs):
0df68c9f 6049 """
a95a7133 6050 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
74a57fcd 6051 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> bool
15afbcd0
RD
6052
6053 Create the GUI part of the Window for 2-phase creation mode.
0df68c9f 6054 """
54f9ee45 6055 return _core_.Window_Create(*args, **kwargs)
d14a1e28 6056
e811c8ce 6057 def Close(*args, **kwargs):
15afbcd0 6058 """
a95a7133 6059 Close(self, bool force=False) -> bool
15afbcd0
RD
6060
6061 This function simply generates a EVT_CLOSE event whose handler usually
6062 tries to close the window. It doesn't close the window itself,
6063 however. If force is False (the default) then the window's close
6064 handler will be allowed to veto the destruction of the window.
15afbcd0 6065 """
54f9ee45 6066 return _core_.Window_Close(*args, **kwargs)
d14a1e28 6067
e811c8ce 6068 def Destroy(*args, **kwargs):
0df68c9f 6069 """
a95a7133 6070 Destroy(self) -> bool
d14a1e28 6071
15afbcd0
RD
6072 Destroys the window safely. Frames and dialogs are not destroyed
6073 immediately when this function is called -- they are added to a list
6074 of windows to be deleted on idle time, when all the window's events
6075 have been processed. This prevents problems with events being sent to
6076 non-existent windows.
6077
6078 Returns True if the window has either been successfully deleted, or it
6079 has been added to the list of windows pending real deletion.
0df68c9f 6080 """
54f9ee45 6081 return _core_.Window_Destroy(*args, **kwargs)
d14a1e28 6082
e811c8ce 6083 def DestroyChildren(*args, **kwargs):
15afbcd0 6084 """
a95a7133 6085 DestroyChildren(self) -> bool
15afbcd0 6086
41e2b43e
RD
6087 Destroys all children of a window. Called automatically by the
6088 destructor.
15afbcd0 6089 """
54f9ee45 6090 return _core_.Window_DestroyChildren(*args, **kwargs)
d14a1e28 6091
e811c8ce 6092 def IsBeingDeleted(*args, **kwargs):
15afbcd0 6093 """
a95a7133 6094 IsBeingDeleted(self) -> bool
15afbcd0
RD
6095
6096 Is the window in the process of being deleted?
6097 """
54f9ee45 6098 return _core_.Window_IsBeingDeleted(*args, **kwargs)
d14a1e28 6099
e811c8ce 6100 def SetTitle(*args, **kwargs):
15afbcd0 6101 """
a95a7133 6102 SetTitle(self, String title)
15afbcd0
RD
6103
6104 Sets the window's title. Applicable only to frames and dialogs.
6105 """
54f9ee45 6106 return _core_.Window_SetTitle(*args, **kwargs)
d14a1e28 6107
e811c8ce 6108 def GetTitle(*args, **kwargs):
15afbcd0 6109 """
a95a7133 6110 GetTitle(self) -> String
15afbcd0
RD
6111
6112 Gets the window's title. Applicable only to frames and dialogs.
6113 """
54f9ee45 6114 return _core_.Window_GetTitle(*args, **kwargs)
d14a1e28 6115
e811c8ce 6116 def SetLabel(*args, **kwargs):
15afbcd0 6117 """
a95a7133 6118 SetLabel(self, String label)
15afbcd0
RD
6119
6120 Set the text which the window shows in its label if applicable.
6121 """
54f9ee45 6122 return _core_.Window_SetLabel(*args, **kwargs)
d14a1e28 6123
e811c8ce 6124 def GetLabel(*args, **kwargs):
15afbcd0 6125 """
a95a7133 6126 GetLabel(self) -> String
15afbcd0 6127
41e2b43e
RD
6128 Generic way of getting a label from any window, for identification
6129 purposes. The interpretation of this function differs from class to
6130 class. For frames and dialogs, the value returned is the title. For
6131 buttons or static text controls, it is the button text. This function
6132 can be useful for meta-programs such as testing tools or special-needs
6133 access programs)which need to identify windows by name.
15afbcd0 6134 """
54f9ee45 6135 return _core_.Window_GetLabel(*args, **kwargs)
d14a1e28 6136
e811c8ce 6137 def SetName(*args, **kwargs):
15afbcd0 6138 """
a95a7133 6139 SetName(self, String name)
15afbcd0 6140
41e2b43e
RD
6141 Sets the window's name. The window name is used for ressource setting
6142 in X, it is not the same as the window title/label
15afbcd0 6143 """
54f9ee45 6144 return _core_.Window_SetName(*args, **kwargs)
d14a1e28 6145
e811c8ce 6146 def GetName(*args, **kwargs):
15afbcd0 6147 """
a95a7133 6148 GetName(self) -> String
15afbcd0 6149
41e2b43e
RD
6150 Returns the windows name. This name is not guaranteed to be unique;
6151 it is up to the programmer to supply an appropriate name in the window
6152 constructor or via wx.Window.SetName.
15afbcd0 6153 """
54f9ee45 6154 return _core_.Window_GetName(*args, **kwargs)
d14a1e28 6155
4276dc52
RD
6156 def SetWindowVariant(*args, **kwargs):
6157 """
a95a7133 6158 SetWindowVariant(self, int variant)
4276dc52 6159
41e2b43e
RD
6160 Sets the variant of the window/font size to use for this window, if
6161 the platform supports variants, for example, wxMac.
4276dc52 6162 """
54f9ee45 6163 return _core_.Window_SetWindowVariant(*args, **kwargs)
4276dc52
RD
6164
6165 def GetWindowVariant(*args, **kwargs):
a95a7133 6166 """GetWindowVariant(self) -> int"""
54f9ee45 6167 return _core_.Window_GetWindowVariant(*args, **kwargs)
4276dc52 6168
e811c8ce 6169 def SetId(*args, **kwargs):
15afbcd0 6170 """
a95a7133 6171 SetId(self, int winid)
15afbcd0
RD
6172
6173 Sets the identifier of the window. Each window has an integer
6174 identifier. If the application has not provided one, an identifier
6175 will be generated. Normally, the identifier should be provided on
6176 creation and should not be modified subsequently.
6177 """
54f9ee45 6178 return _core_.Window_SetId(*args, **kwargs)
d14a1e28 6179
e811c8ce 6180 def GetId(*args, **kwargs):
15afbcd0 6181 """
a95a7133 6182 GetId(self) -> int
15afbcd0
RD
6183
6184 Returns the identifier of the window. Each window has an integer
6185 identifier. If the application has not provided one (or the default Id
6186 -1 is used) then an unique identifier with a negative value will be
6187 generated.
6188 """
54f9ee45 6189 return _core_.Window_GetId(*args, **kwargs)
d14a1e28 6190
e811c8ce 6191 def NewControlId(*args, **kwargs):
15afbcd0 6192 """
66c033b4 6193 NewControlId() -> int
15afbcd0
RD
6194
6195 Generate a control id for the controls which were not given one.
6196 """
54f9ee45 6197 return _core_.Window_NewControlId(*args, **kwargs)
d14a1e28 6198
e811c8ce
RD
6199 NewControlId = staticmethod(NewControlId)
6200 def NextControlId(*args, **kwargs):
15afbcd0 6201 """
66c033b4 6202 NextControlId(int winid) -> int
15afbcd0
RD
6203
6204 Get the id of the control following the one with the given
41e2b43e 6205 autogenerated) id
15afbcd0 6206 """
54f9ee45 6207 return _core_.Window_NextControlId(*args, **kwargs)
d14a1e28 6208
e811c8ce
RD
6209 NextControlId = staticmethod(NextControlId)
6210 def PrevControlId(*args, **kwargs):
15afbcd0 6211 """
66c033b4 6212 PrevControlId(int winid) -> int
15afbcd0
RD
6213
6214 Get the id of the control preceding the one with the given
41e2b43e 6215 autogenerated) id
15afbcd0 6216 """
54f9ee45 6217 return _core_.Window_PrevControlId(*args, **kwargs)
d14a1e28 6218
e811c8ce
RD
6219 PrevControlId = staticmethod(PrevControlId)
6220 def SetSize(*args, **kwargs):
15afbcd0 6221 """
a95a7133 6222 SetSize(self, Size size)
15afbcd0
RD
6223
6224 Sets the size of the window in pixels.
6225 """
54f9ee45 6226 return _core_.Window_SetSize(*args, **kwargs)
d14a1e28 6227
e811c8ce 6228 def SetDimensions(*args, **kwargs):
15afbcd0 6229 """
a95a7133 6230 SetDimensions(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)
15afbcd0
RD
6231
6232 Sets the position and size of the window in pixels. The sizeFlags
6233 parameter indicates the interpretation of the other params if they are
e505d15e
RD
6234 equal to -1.
6235
6236 ======================== ======================================
6237 wx.SIZE_AUTO A -1 indicates that a class-specific
6238 default should be used.
6239 wx.SIZE_USE_EXISTING Axisting dimensions should be used if
6240 -1 values are supplied.
6241 wxSIZE_ALLOW_MINUS_ONE Allow dimensions of -1 and less to be
6242 interpreted as real dimensions, not
6243 default values.
6244 ======================== ======================================
6245
15afbcd0 6246 """
54f9ee45 6247 return _core_.Window_SetDimensions(*args, **kwargs)
d14a1e28 6248
e811c8ce 6249 def SetRect(*args, **kwargs):
15afbcd0 6250 """
a95a7133 6251 SetRect(self, Rect rect, int sizeFlags=SIZE_AUTO)
15afbcd0
RD
6252
6253 Sets the position and size of the window in pixels using a wx.Rect.
6254 """
54f9ee45 6255 return _core_.Window_SetRect(*args, **kwargs)
d14a1e28 6256
e811c8ce 6257 def SetSizeWH(*args, **kwargs):
15afbcd0 6258 """
a95a7133 6259 SetSizeWH(self, int width, int height)
15afbcd0
RD
6260
6261 Sets the size of the window in pixels.
6262 """
54f9ee45 6263 return _core_.Window_SetSizeWH(*args, **kwargs)
d14a1e28 6264
e811c8ce 6265 def Move(*args, **kwargs):
15afbcd0 6266 """
a95a7133 6267 Move(self, Point pt, int flags=SIZE_USE_EXISTING)
15afbcd0
RD
6268
6269 Moves the window to the given position.
6270 """
54f9ee45 6271 return _core_.Window_Move(*args, **kwargs)
d14a1e28 6272
e811c8ce
RD
6273 SetPosition = Move
6274 def MoveXY(*args, **kwargs):
15afbcd0 6275 """
a95a7133 6276 MoveXY(self, int x, int y, int flags=SIZE_USE_EXISTING)
15afbcd0
RD
6277
6278 Moves the window to the given position.
6279 """
54f9ee45 6280 return _core_.Window_MoveXY(*args, **kwargs)
e811c8ce 6281
f8167d6e
RD
6282 def SetBestFittingSize(*args, **kwargs):
6283 """
6284 SetBestFittingSize(self, Size size=DefaultSize)
6285
6286 A 'Smart' SetSize that will fill in default size components with the
6287 window's *best size* values. Also set's the minsize for use with sizers.
6288 """
6289 return _core_.Window_SetBestFittingSize(*args, **kwargs)
6290
e811c8ce 6291 def Raise(*args, **kwargs):
15afbcd0 6292 """
a95a7133 6293 Raise(self)
15afbcd0
RD
6294
6295 Raises the window to the top of the window hierarchy if it is a
6296 managed window (dialog or frame).
6297 """
54f9ee45 6298 return _core_.Window_Raise(*args, **kwargs)
e811c8ce
RD
6299
6300 def Lower(*args, **kwargs):
15afbcd0 6301 """
a95a7133 6302 Lower(self)
15afbcd0
RD
6303
6304 Lowers the window to the bottom of the window hierarchy if it is a
6305 managed window (dialog or frame).
6306 """
54f9ee45 6307 return _core_.Window_Lower(*args, **kwargs)
e811c8ce
RD
6308
6309 def SetClientSize(*args, **kwargs):
15afbcd0 6310 """
a95a7133 6311 SetClientSize(self, Size size)
15afbcd0
RD
6312
6313 This sets the size of the window client area in pixels. Using this
6314 function to size a window tends to be more device-independent than
6315 wx.Window.SetSize, since the application need not worry about what
6316 dimensions the border or title bar have when trying to fit the window
6317 around panel items, for example.
6318 """
54f9ee45 6319 return _core_.Window_SetClientSize(*args, **kwargs)
e811c8ce
RD
6320
6321 def SetClientSizeWH(*args, **kwargs):
15afbcd0 6322 """
a95a7133 6323 SetClientSizeWH(self, int width, int height)
15afbcd0
RD
6324
6325 This sets the size of the window client area in pixels. Using this
6326 function to size a window tends to be more device-independent than
6327 wx.Window.SetSize, since the application need not worry about what
6328 dimensions the border or title bar have when trying to fit the window
6329 around panel items, for example.
6330 """
54f9ee45 6331 return _core_.Window_SetClientSizeWH(*args, **kwargs)
e811c8ce
RD
6332
6333 def SetClientRect(*args, **kwargs):
15afbcd0 6334 """
a95a7133 6335 SetClientRect(self, Rect rect)
15afbcd0
RD
6336
6337 This sets the size of the window client area in pixels. Using this
6338 function to size a window tends to be more device-independent than
6339 wx.Window.SetSize, since the application need not worry about what
6340 dimensions the border or title bar have when trying to fit the window
6341 around panel items, for example.
6342 """
54f9ee45 6343 return _core_.Window_SetClientRect(*args, **kwargs)
e811c8ce
RD
6344
6345 def GetPosition(*args, **kwargs):
0df68c9f 6346 """
a95a7133 6347 GetPosition(self) -> Point
e811c8ce 6348
0df68c9f
RD
6349 Get the window's position.
6350 """
54f9ee45 6351 return _core_.Window_GetPosition(*args, **kwargs)
e811c8ce
RD
6352
6353 def GetPositionTuple(*args, **kwargs):
0df68c9f
RD
6354 """
6355 GetPositionTuple() -> (x,y)
e811c8ce 6356
0df68c9f
RD
6357 Get the window's position.
6358 """
54f9ee45 6359 return _core_.Window_GetPositionTuple(*args, **kwargs)
e811c8ce
RD
6360
6361 def GetSize(*args, **kwargs):
0df68c9f 6362 """
a95a7133 6363 GetSize(self) -> Size
e811c8ce 6364
0df68c9f
RD
6365 Get the window size.
6366 """
54f9ee45 6367 return _core_.Window_GetSize(*args, **kwargs)
e811c8ce
RD
6368
6369 def GetSizeTuple(*args, **kwargs):
0df68c9f
RD
6370 """
6371 GetSizeTuple() -> (width, height)
e811c8ce 6372
0df68c9f
RD
6373 Get the window size.
6374 """
54f9ee45 6375 return _core_.Window_GetSizeTuple(*args, **kwargs)
e811c8ce
RD
6376
6377 def GetRect(*args, **kwargs):
15afbcd0 6378 """
a95a7133 6379 GetRect(self) -> Rect
15afbcd0
RD
6380
6381 Returns the size and position of the window as a wx.Rect object.
6382 """
54f9ee45 6383 return _core_.Window_GetRect(*args, **kwargs)
e811c8ce
RD
6384
6385 def GetClientSize(*args, **kwargs):
0df68c9f 6386 """
a95a7133 6387 GetClientSize(self) -> Size
e811c8ce 6388
15afbcd0
RD
6389 This gets the size of the window's 'client area' in pixels. The client
6390 area is the area which may be drawn on by the programmer, excluding
6391 title bar, border, scrollbars, etc.
0df68c9f 6392 """
54f9ee45 6393 return _core_.Window_GetClientSize(*args, **kwargs)
e811c8ce
RD
6394
6395 def GetClientSizeTuple(*args, **kwargs):
0df68c9f
RD
6396 """
6397 GetClientSizeTuple() -> (width, height)
e811c8ce 6398
15afbcd0
RD
6399 This gets the size of the window's 'client area' in pixels. The client
6400 area is the area which may be drawn on by the programmer, excluding
6401 title bar, border, scrollbars, etc.
0df68c9f 6402 """
54f9ee45 6403 return _core_.Window_GetClientSizeTuple(*args, **kwargs)
e811c8ce
RD
6404
6405 def GetClientAreaOrigin(*args, **kwargs):
15afbcd0 6406 """
a95a7133 6407 GetClientAreaOrigin(self) -> Point
15afbcd0
RD
6408
6409 Get the origin of the client area of the window relative to the
6410 window's top left corner (the client area may be shifted because of
6411 the borders, scrollbars, other decorations...)
6412 """
54f9ee45 6413 return _core_.Window_GetClientAreaOrigin(*args, **kwargs)
e811c8ce
RD
6414
6415 def GetClientRect(*args, **kwargs):
15afbcd0 6416 """
a95a7133 6417 GetClientRect(self) -> Rect
15afbcd0 6418
61863841 6419 Get the client area position and size as a `wx.Rect` object.
15afbcd0 6420 """
54f9ee45 6421 return _core_.Window_GetClientRect(*args, **kwargs)
e811c8ce
RD
6422
6423 def GetBestSize(*args, **kwargs):
0df68c9f 6424 """
a95a7133 6425 GetBestSize(self) -> Size
e811c8ce 6426
248ed943 6427 This function returns the best acceptable minimal size for the
41e2b43e
RD
6428 window, if applicable. For example, for a static text control, it will
6429 be the minimal size such that the control label is not truncated. For
6430 windows containing subwindows (suzh aswx.Panel), the size returned by
6431 this function will be the same as the size the window would have had
6432 after calling Fit.
0df68c9f 6433 """
54f9ee45 6434 return _core_.Window_GetBestSize(*args, **kwargs)
e811c8ce
RD
6435
6436 def GetBestSizeTuple(*args, **kwargs):
0df68c9f
RD
6437 """
6438 GetBestSizeTuple() -> (width, height)
e811c8ce 6439
248ed943 6440 This function returns the best acceptable minimal size for the
41e2b43e
RD
6441 window, if applicable. For example, for a static text control, it will
6442 be the minimal size such that the control label is not truncated. For
6443 windows containing subwindows (suzh aswx.Panel), the size returned by
6444 this function will be the same as the size the window would have had
6445 after calling Fit.
0df68c9f 6446 """
54f9ee45 6447 return _core_.Window_GetBestSizeTuple(*args, **kwargs)
e811c8ce 6448
dfbb5885
RD
6449 def InvalidateBestSize(*args, **kwargs):
6450 """
6451 InvalidateBestSize(self)
6452
6453 Reset the cached best size value so it will be recalculated the next
6454 time it is needed.
6455 """
6456 return _core_.Window_InvalidateBestSize(*args, **kwargs)
6457
6458 def GetBestFittingSize(*args, **kwargs):
6459 """
6460 GetBestFittingSize(self) -> Size
6461
6462 This function will merge the window's best size into the window's
6463 minimum size, giving priority to the min size components, and returns
6464 the results.
6465
6466 """
6467 return _core_.Window_GetBestFittingSize(*args, **kwargs)
6468
e811c8ce 6469 def GetAdjustedBestSize(*args, **kwargs):
15afbcd0 6470 """
a95a7133 6471 GetAdjustedBestSize(self) -> Size
15afbcd0
RD
6472
6473 This method is similar to GetBestSize, except in one
6474 thing. GetBestSize should return the minimum untruncated size of the
6475 window, while this method will return the largest of BestSize and any
6476 user specified minimum size. ie. it is the minimum size the window
6477 should currently be drawn at, not the minimal size it can possibly
6478 tolerate.
6479 """
54f9ee45 6480 return _core_.Window_GetAdjustedBestSize(*args, **kwargs)
e811c8ce
RD
6481
6482 def Center(*args, **kwargs):
15afbcd0 6483 """
a95a7133 6484 Center(self, int direction=BOTH)
15afbcd0
RD
6485
6486 Centers the window. The parameter specifies the direction for
6487 cetering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may
6488 also include wx.CENTER_ON_SCREEN flag if you want to center the window
6489 on the entire screen and not on its parent window. If it is a
6490 top-level window and has no parent then it will always be centered
6491 relative to the screen.
6492 """
54f9ee45 6493 return _core_.Window_Center(*args, **kwargs)
e811c8ce
RD
6494
6495 Centre = Center
6496 def CenterOnScreen(*args, **kwargs):
15afbcd0 6497 """
a95a7133 6498 CenterOnScreen(self, int dir=BOTH)
15afbcd0
RD
6499
6500 Center on screen (only works for top level windows)
6501 """
54f9ee45 6502 return _core_.Window_CenterOnScreen(*args, **kwargs)
e811c8ce
RD
6503
6504 CentreOnScreen = CenterOnScreen
6505 def CenterOnParent(*args, **kwargs):
15afbcd0 6506 """
a95a7133 6507 CenterOnParent(self, int dir=BOTH)
15afbcd0
RD
6508
6509 Center with respect to the the parent window
6510 """
54f9ee45 6511 return _core_.Window_CenterOnParent(*args, **kwargs)
e811c8ce
RD
6512
6513 CentreOnParent = CenterOnParent
6514 def Fit(*args, **kwargs):
15afbcd0 6515 """
a95a7133 6516 Fit(self)
15afbcd0
RD
6517
6518 Sizes the window so that it fits around its subwindows. This function
6519 won't do anything if there are no subwindows and will only really work
6520 correctly if sizers are used for the subwindows layout. Also, if the
6521 window has exactly one subwindow it is better (faster and the result
6522 is more precise as Fit adds some margin to account for fuzziness of
6523 its calculations) to call window.SetClientSize(child.GetSize())
6524 instead of calling Fit.
6525 """
54f9ee45 6526 return _core_.Window_Fit(*args, **kwargs)
e811c8ce
RD
6527
6528 def FitInside(*args, **kwargs):
15afbcd0 6529 """
a95a7133 6530 FitInside(self)
15afbcd0
RD
6531
6532 Similar to Fit, but sizes the interior (virtual) size of a
6533 window. Mainly useful with scrolled windows to reset scrollbars after
6534 sizing changes that do not trigger a size event, and/or scrolled
6535 windows without an interior sizer. This function similarly won't do
6536 anything if there are no subwindows.
6537 """
54f9ee45 6538 return _core_.Window_FitInside(*args, **kwargs)
e811c8ce 6539
f16ab95d 6540 def SetSizeHints(*args, **kwargs):
0df68c9f 6541 """
a95a7133 6542 SetSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1,
0df68c9f 6543 int incH=-1)
15afbcd0
RD
6544
6545 Allows specification of minimum and maximum window sizes, and window
6546 size increments. If a pair of values is not set (or set to -1), the
6547 default values will be used. If this function is called, the user
908b74cd
RD
6548 will not be able to size the window outside the given bounds (if it is
6549 a top-level window.) Sizers will also inspect the minimum window size
6550 and will use that value if set when calculating layout.
6551
6552 The resizing increments are only significant under Motif or Xt.
0df68c9f 6553 """
f16ab95d 6554 return _core_.Window_SetSizeHints(*args, **kwargs)
e811c8ce 6555
f16ab95d
RD
6556 def SetSizeHintsSz(*args, **kwargs):
6557 """
6558 SetSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize, Size incSize=DefaultSize)
6559
6560 Allows specification of minimum and maximum window sizes, and window
6561 size increments. If a pair of values is not set (or set to -1), the
6562 default values will be used. If this function is called, the user
6563 will not be able to size the window outside the given bounds (if it is
6564 a top-level window.) Sizers will also inspect the minimum window size
6565 and will use that value if set when calculating layout.
6566
6567 The resizing increments are only significant under Motif or Xt.
6568 """
6569 return _core_.Window_SetSizeHintsSz(*args, **kwargs)
6570
6571 def SetVirtualSizeHints(*args, **kwargs):
15afbcd0 6572 """
908b74cd 6573 SetVirtualSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1)
15afbcd0
RD
6574
6575 Allows specification of minimum and maximum virtual window sizes. If a
6576 pair of values is not set (or set to -1), the default values will be
6577 used. If this function is called, the user will not be able to size
6578 the virtual area of the window outside the given bounds.
6579 """
f16ab95d
RD
6580 return _core_.Window_SetVirtualSizeHints(*args, **kwargs)
6581
6582 def SetVirtualSizeHintsSz(*args, **kwargs):
6583 """
6584 SetVirtualSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize)
6585
6586 Allows specification of minimum and maximum virtual window sizes. If a
6587 pair of values is not set (or set to -1), the default values will be
6588 used. If this function is called, the user will not be able to size
6589 the virtual area of the window outside the given bounds.
6590 """
6591 return _core_.Window_SetVirtualSizeHintsSz(*args, **kwargs)
e811c8ce 6592
908b74cd
RD
6593 def GetMaxSize(*args, **kwargs):
6594 """GetMaxSize(self) -> Size"""
6595 return _core_.Window_GetMaxSize(*args, **kwargs)
6596
6597 def GetMinSize(*args, **kwargs):
6598 """GetMinSize(self) -> Size"""
6599 return _core_.Window_GetMinSize(*args, **kwargs)
6600
6601 def SetMinSize(*args, **kwargs):
6602 """
6603 SetMinSize(self, Size minSize)
6604
6605 A more convenient method than `SetSizeHints` for setting just the
6606 min size.
6607 """
6608 return _core_.Window_SetMinSize(*args, **kwargs)
6609
6610 def SetMaxSize(*args, **kwargs):
6611 """
6612 SetMaxSize(self, Size maxSize)
6613
6614 A more convenient method than `SetSizeHints` for setting just the
6615 max size.
6616 """
6617 return _core_.Window_SetMaxSize(*args, **kwargs)
6618
e811c8ce 6619 def GetMinWidth(*args, **kwargs):
a95a7133 6620 """GetMinWidth(self) -> int"""
54f9ee45 6621 return _core_.Window_GetMinWidth(*args, **kwargs)
e811c8ce
RD
6622
6623 def GetMinHeight(*args, **kwargs):
a95a7133 6624 """GetMinHeight(self) -> int"""
54f9ee45 6625 return _core_.Window_GetMinHeight(*args, **kwargs)
e811c8ce
RD
6626
6627 def GetMaxWidth(*args, **kwargs):
a95a7133 6628 """GetMaxWidth(self) -> int"""
54f9ee45 6629 return _core_.Window_GetMaxWidth(*args, **kwargs)
e811c8ce
RD
6630
6631 def GetMaxHeight(*args, **kwargs):
a95a7133 6632 """GetMaxHeight(self) -> int"""
54f9ee45 6633 return _core_.Window_GetMaxHeight(*args, **kwargs)
e811c8ce 6634
e811c8ce 6635 def SetVirtualSize(*args, **kwargs):
0df68c9f 6636 """
a95a7133 6637 SetVirtualSize(self, Size size)
e811c8ce 6638
15afbcd0
RD
6639 Set the the virtual size of a window in pixels. For most windows this
6640 is just the client area of the window, but for some like scrolled
6641 windows it is more or less independent of the screen window size.
0df68c9f 6642 """
54f9ee45 6643 return _core_.Window_SetVirtualSize(*args, **kwargs)
e811c8ce
RD
6644
6645 def SetVirtualSizeWH(*args, **kwargs):
0df68c9f 6646 """
a95a7133 6647 SetVirtualSizeWH(self, int w, int h)
e811c8ce 6648
15afbcd0
RD
6649 Set the the virtual size of a window in pixels. For most windows this
6650 is just the client area of the window, but for some like scrolled
6651 windows it is more or less independent of the screen window size.
0df68c9f 6652 """
54f9ee45 6653 return _core_.Window_SetVirtualSizeWH(*args, **kwargs)
e811c8ce
RD
6654
6655 def GetVirtualSize(*args, **kwargs):
0df68c9f 6656 """
a95a7133 6657 GetVirtualSize(self) -> Size
e811c8ce 6658
15afbcd0
RD
6659 Get the the virtual size of the window in pixels. For most windows
6660 this is just the client area of the window, but for some like scrolled
6661 windows it is more or less independent of the screen window size.
0df68c9f 6662 """
54f9ee45 6663 return _core_.Window_GetVirtualSize(*args, **kwargs)
e811c8ce
RD
6664
6665 def GetVirtualSizeTuple(*args, **kwargs):
0df68c9f
RD
6666 """
6667 GetVirtualSizeTuple() -> (width, height)
e811c8ce 6668
15afbcd0
RD
6669 Get the the virtual size of the window in pixels. For most windows
6670 this is just the client area of the window, but for some like scrolled
6671 windows it is more or less independent of the screen window size.
0df68c9f 6672 """
54f9ee45 6673 return _core_.Window_GetVirtualSizeTuple(*args, **kwargs)
e811c8ce
RD
6674
6675 def GetBestVirtualSize(*args, **kwargs):
15afbcd0 6676 """
a95a7133 6677 GetBestVirtualSize(self) -> Size
15afbcd0
RD
6678
6679 Return the largest of ClientSize and BestSize (as determined by a
6680 sizer, interior children, or other means)
6681 """
54f9ee45 6682 return _core_.Window_GetBestVirtualSize(*args, **kwargs)
e811c8ce
RD
6683
6684 def Show(*args, **kwargs):
15afbcd0 6685 """
a95a7133 6686 Show(self, bool show=True) -> bool
15afbcd0
RD
6687
6688 Shows or hides the window. You may need to call Raise for a top level
6689 window if you want to bring it to top, although this is not needed if
6690 Show is called immediately after the frame creation. Returns True if
6691 the window has been shown or hidden or False if nothing was done
6692 because it already was in the requested state.
6693 """
54f9ee45 6694 return _core_.Window_Show(*args, **kwargs)
e811c8ce
RD
6695
6696 def Hide(*args, **kwargs):
15afbcd0 6697 """
a95a7133 6698 Hide(self) -> bool
15afbcd0
RD
6699
6700 Equivalent to calling Show(False).
6701 """
54f9ee45 6702 return _core_.Window_Hide(*args, **kwargs)
e811c8ce
RD
6703
6704 def Enable(*args, **kwargs):
15afbcd0 6705 """
a95a7133 6706 Enable(self, bool enable=True) -> bool
15afbcd0
RD
6707
6708 Enable or disable the window for user input. Note that when a parent
6709 window is disabled, all of its children are disabled as well and they
6710 are reenabled again when the parent is. Returns true if the window
6711 has been enabled or disabled, false if nothing was done, i.e. if the
6712 window had already been in the specified state.
6713 """
54f9ee45 6714 return _core_.Window_Enable(*args, **kwargs)
e811c8ce
RD
6715
6716 def Disable(*args, **kwargs):
15afbcd0 6717 """
a95a7133 6718 Disable(self) -> bool
15afbcd0
RD
6719
6720 Disables the window, same as Enable(false).
6721 """
54f9ee45 6722 return _core_.Window_Disable(*args, **kwargs)
e811c8ce
RD
6723
6724 def IsShown(*args, **kwargs):
15afbcd0 6725 """
a95a7133 6726 IsShown(self) -> bool
15afbcd0
RD
6727
6728 Returns true if the window is shown, false if it has been hidden.
6729 """
54f9ee45 6730 return _core_.Window_IsShown(*args, **kwargs)
e811c8ce
RD
6731
6732 def IsEnabled(*args, **kwargs):
15afbcd0 6733 """
a95a7133 6734 IsEnabled(self) -> bool
15afbcd0
RD
6735
6736 Returns true if the window is enabled for input, false otherwise.
6737 """
54f9ee45 6738 return _core_.Window_IsEnabled(*args, **kwargs)
e811c8ce
RD
6739
6740 def SetWindowStyleFlag(*args, **kwargs):
15afbcd0 6741 """
a95a7133 6742 SetWindowStyleFlag(self, long style)
15afbcd0 6743
41e2b43e
RD
6744 Sets the style of the window. Please note that some styles cannot be
6745 changed after the window creation and that Refresh() might need to be
6746 called after changing the others for the change to take place
6747 immediately.
15afbcd0 6748 """
54f9ee45 6749 return _core_.Window_SetWindowStyleFlag(*args, **kwargs)
e811c8ce
RD
6750
6751 def GetWindowStyleFlag(*args, **kwargs):
15afbcd0 6752 """
a95a7133 6753 GetWindowStyleFlag(self) -> long
e811c8ce 6754
15afbcd0
RD
6755 Gets the window style that was passed to the constructor or Create
6756 method.
6757 """
54f9ee45 6758 return _core_.Window_GetWindowStyleFlag(*args, **kwargs)
e811c8ce 6759
15afbcd0 6760 SetWindowStyle = SetWindowStyleFlag; GetWindowStyle = GetWindowStyleFlag
e811c8ce 6761 def HasFlag(*args, **kwargs):
15afbcd0 6762 """
a95a7133 6763 HasFlag(self, int flag) -> bool
15afbcd0
RD
6764
6765 Test if the given style is set for this window.
6766 """
54f9ee45 6767 return _core_.Window_HasFlag(*args, **kwargs)
e811c8ce
RD
6768
6769 def IsRetained(*args, **kwargs):
15afbcd0 6770 """
a95a7133 6771 IsRetained(self) -> bool
15afbcd0
RD
6772
6773 Returns true if the window is retained, false otherwise. Retained
6774 windows are only available on X platforms.
6775 """
54f9ee45 6776 return _core_.Window_IsRetained(*args, **kwargs)
e811c8ce
RD
6777
6778 def SetExtraStyle(*args, **kwargs):
15afbcd0 6779 """
a95a7133 6780 SetExtraStyle(self, long exStyle)
15afbcd0
RD
6781
6782 Sets the extra style bits for the window. Extra styles are the less
6783 often used style bits which can't be set with the constructor or with
6784 SetWindowStyleFlag()
6785 """
54f9ee45 6786 return _core_.Window_SetExtraStyle(*args, **kwargs)
e811c8ce
RD
6787
6788 def GetExtraStyle(*args, **kwargs):
15afbcd0 6789 """
a95a7133 6790 GetExtraStyle(self) -> long
15afbcd0
RD
6791
6792 Returns the extra style bits for the window.
6793 """
54f9ee45 6794 return _core_.Window_GetExtraStyle(*args, **kwargs)
e811c8ce
RD
6795
6796 def MakeModal(*args, **kwargs):
15afbcd0 6797 """
a95a7133 6798 MakeModal(self, bool modal=True)
15afbcd0
RD
6799
6800 Disables all other windows in the application so that the user can
6801 only interact with this window. Passing False will reverse this
6802 effect.
6803 """
54f9ee45 6804 return _core_.Window_MakeModal(*args, **kwargs)
e811c8ce
RD
6805
6806 def SetThemeEnabled(*args, **kwargs):
15afbcd0 6807 """
a95a7133 6808 SetThemeEnabled(self, bool enableTheme)
15afbcd0
RD
6809
6810 This function tells a window if it should use the system's "theme"
6811 code to draw the windows' background instead if its own background
6812 drawing code. This will only have an effect on platforms that support
6813 the notion of themes in user defined windows. One such platform is
6814 GTK+ where windows can have (very colourful) backgrounds defined by a
6815 user's selected theme.
6816
6817 Dialogs, notebook pages and the status bar have this flag set to true
6818 by default so that the default look and feel is simulated best.
6819 """
54f9ee45 6820 return _core_.Window_SetThemeEnabled(*args, **kwargs)
e811c8ce
RD
6821
6822 def GetThemeEnabled(*args, **kwargs):
15afbcd0 6823 """
a95a7133 6824 GetThemeEnabled(self) -> bool
e811c8ce 6825
15afbcd0
RD
6826 Return the themeEnabled flag.
6827 """
54f9ee45 6828 return _core_.Window_GetThemeEnabled(*args, **kwargs)
e811c8ce
RD
6829
6830 def SetFocus(*args, **kwargs):
15afbcd0 6831 """
a95a7133 6832 SetFocus(self)
15afbcd0
RD
6833
6834 Set's the focus to this window, allowing it to receive keyboard input.
6835 """
54f9ee45 6836 return _core_.Window_SetFocus(*args, **kwargs)
e811c8ce
RD
6837
6838 def SetFocusFromKbd(*args, **kwargs):
15afbcd0 6839 """
a95a7133 6840 SetFocusFromKbd(self)
15afbcd0
RD
6841
6842 Set focus to this window as the result of a keyboard action. Normally
6843 only called internally.
6844 """
54f9ee45 6845 return _core_.Window_SetFocusFromKbd(*args, **kwargs)
e811c8ce
RD
6846
6847 def FindFocus(*args, **kwargs):
15afbcd0 6848 """
66c033b4 6849 FindFocus() -> Window
15afbcd0
RD
6850
6851 Returns the window or control that currently has the keyboard focus,
6852 or None.
6853 """
54f9ee45 6854 return _core_.Window_FindFocus(*args, **kwargs)
e811c8ce
RD
6855
6856 FindFocus = staticmethod(FindFocus)
6857 def AcceptsFocus(*args, **kwargs):
15afbcd0 6858 """
a95a7133 6859 AcceptsFocus(self) -> bool
15afbcd0
RD
6860
6861 Can this window have focus?
6862 """
54f9ee45 6863 return _core_.Window_AcceptsFocus(*args, **kwargs)
e811c8ce
RD
6864
6865 def AcceptsFocusFromKeyboard(*args, **kwargs):
15afbcd0 6866 """
a95a7133 6867 AcceptsFocusFromKeyboard(self) -> bool
15afbcd0
RD
6868
6869 Can this window be given focus by keyboard navigation? if not, the
6870 only way to give it focus (provided it accepts it at all) is to click
6871 it.
6872 """
54f9ee45 6873 return _core_.Window_AcceptsFocusFromKeyboard(*args, **kwargs)
e811c8ce
RD
6874
6875 def GetDefaultItem(*args, **kwargs):
15afbcd0 6876 """
a95a7133 6877 GetDefaultItem(self) -> Window
15afbcd0
RD
6878
6879 Get the default child of this parent, i.e. the one which is activated
6880 by pressing <Enter> such as the OK button on a wx.Dialog.
6881 """
54f9ee45 6882 return _core_.Window_GetDefaultItem(*args, **kwargs)
e811c8ce
RD
6883
6884 def SetDefaultItem(*args, **kwargs):
15afbcd0 6885 """
a95a7133 6886 SetDefaultItem(self, Window child) -> Window
15afbcd0
RD
6887
6888 Set this child as default, return the old default.
6889 """
54f9ee45 6890 return _core_.Window_SetDefaultItem(*args, **kwargs)
e811c8ce
RD
6891
6892 def SetTmpDefaultItem(*args, **kwargs):
15afbcd0 6893 """
a95a7133 6894 SetTmpDefaultItem(self, Window win)
15afbcd0
RD
6895
6896 Set this child as temporary default
6897 """
54f9ee45 6898 return _core_.Window_SetTmpDefaultItem(*args, **kwargs)
e811c8ce 6899
908b74cd
RD
6900 def Navigate(*args, **kwargs):
6901 """
6902 Navigate(self, int flags=NavigationKeyEvent.IsForward) -> bool
6903
fd2dc343
RD
6904 Does keyboard navigation from this window to another, by sending a
6905 `wx.NavigationKeyEvent`.
908b74cd
RD
6906 """
6907 return _core_.Window_Navigate(*args, **kwargs)
6908
7f98d120
RD
6909 def MoveAfterInTabOrder(*args, **kwargs):
6910 """
6911 MoveAfterInTabOrder(self, Window win)
6912
6913 Moves this window in the tab navigation order after the specified
6914 sibling window. This means that when the user presses the TAB key on
6915 that other window, the focus switches to this window.
6916
6917 The default tab order is the same as creation order. This function
6918 and `MoveBeforeInTabOrder` allow to change it after creating all the
6919 windows.
6920
6921 """
6922 return _core_.Window_MoveAfterInTabOrder(*args, **kwargs)
6923
6924 def MoveBeforeInTabOrder(*args, **kwargs):
6925 """
6926 MoveBeforeInTabOrder(self, Window win)
6927
6928 Same as `MoveAfterInTabOrder` except that it inserts this window just
6929 before win instead of putting it right after it.
6930 """
6931 return _core_.Window_MoveBeforeInTabOrder(*args, **kwargs)
6932
e811c8ce 6933 def GetChildren(*args, **kwargs):
15afbcd0 6934 """
a95a7133 6935 GetChildren(self) -> PyObject
15afbcd0
RD
6936
6937 Returns a list of the window's children. NOTE: Currently this is a
6938 copy of the child window list maintained by the window, so the return
6939 value of this function is only valid as long as the window's children
6940 do not change.
6941 """
54f9ee45 6942 return _core_.Window_GetChildren(*args, **kwargs)
e811c8ce
RD
6943
6944 def GetParent(*args, **kwargs):
15afbcd0 6945 """
a95a7133 6946 GetParent(self) -> Window
15afbcd0
RD
6947
6948 Returns the parent window of this window, or None if there isn't one.
6949 """
54f9ee45 6950 return _core_.Window_GetParent(*args, **kwargs)
e811c8ce
RD
6951
6952 def GetGrandParent(*args, **kwargs):
15afbcd0 6953 """
a95a7133 6954 GetGrandParent(self) -> Window
15afbcd0 6955
41e2b43e
RD
6956 Returns the parent of the parent of this window, or None if there
6957 isn't one.
15afbcd0 6958 """
54f9ee45 6959 return _core_.Window_GetGrandParent(*args, **kwargs)
e811c8ce
RD
6960
6961 def IsTopLevel(*args, **kwargs):
15afbcd0 6962 """
a95a7133 6963 IsTopLevel(self) -> bool
15afbcd0
RD
6964
6965 Returns true if the given window is a top-level one. Currently all
6966 frames and dialogs are always considered to be top-level windows (even
6967 if they have a parent window).
6968 """
54f9ee45 6969 return _core_.Window_IsTopLevel(*args, **kwargs)
e811c8ce
RD
6970
6971 def Reparent(*args, **kwargs):
15afbcd0 6972 """
a95a7133 6973 Reparent(self, Window newParent) -> bool
15afbcd0
RD
6974
6975 Reparents the window, i.e the window will be removed from its current
6976 parent window (e.g. a non-standard toolbar in a wxFrame) and then
6977 re-inserted into another. Available on Windows and GTK. Returns True
6978 if the parent was changed, False otherwise (error or newParent ==
6979 oldParent)
6980 """
54f9ee45 6981 return _core_.Window_Reparent(*args, **kwargs)
e811c8ce
RD
6982
6983 def AddChild(*args, **kwargs):
15afbcd0 6984 """
a95a7133 6985 AddChild(self, Window child)
15afbcd0
RD
6986
6987 Adds a child window. This is called automatically by window creation
6988 functions so should not be required by the application programmer.
6989 """
54f9ee45 6990 return _core_.Window_AddChild(*args, **kwargs)
e811c8ce
RD
6991
6992 def RemoveChild(*args, **kwargs):
15afbcd0 6993 """
a95a7133 6994 RemoveChild(self, Window child)
15afbcd0
RD
6995
6996 Removes a child window. This is called automatically by window
6997 deletion functions so should not be required by the application
6998 programmer.
6999 """
54f9ee45 7000 return _core_.Window_RemoveChild(*args, **kwargs)
e811c8ce
RD
7001
7002 def FindWindowById(*args, **kwargs):
15afbcd0 7003 """
a95a7133 7004 FindWindowById(self, long winid) -> Window
15afbcd0
RD
7005
7006 Find a chld of this window by window ID
7007 """
54f9ee45 7008 return _core_.Window_FindWindowById(*args, **kwargs)
e811c8ce
RD
7009
7010 def FindWindowByName(*args, **kwargs):
15afbcd0 7011 """
a95a7133 7012 FindWindowByName(self, String name) -> Window
15afbcd0
RD
7013
7014 Find a child of this window by name
7015 """
54f9ee45 7016 return _core_.Window_FindWindowByName(*args, **kwargs)
e811c8ce
RD
7017
7018 def GetEventHandler(*args, **kwargs):
15afbcd0 7019 """
a95a7133 7020 GetEventHandler(self) -> EvtHandler
15afbcd0
RD
7021
7022 Returns the event handler for this window. By default, the window is
7023 its own event handler.
7024 """
54f9ee45 7025 return _core_.Window_GetEventHandler(*args, **kwargs)
e811c8ce
RD
7026
7027 def SetEventHandler(*args, **kwargs):
15afbcd0 7028 """
a95a7133 7029 SetEventHandler(self, EvtHandler handler)
15afbcd0
RD
7030
7031 Sets the event handler for this window. An event handler is an object
7032 that is capable of processing the events sent to a window. By default,
7033 the window is its own event handler, but an application may wish to
7034 substitute another, for example to allow central implementation of
7035 event-handling for a variety of different window classes.
7036
41e2b43e 7037 It is usually better to use `wx.Window.PushEventHandler` since this sets
15afbcd0
RD
7038 up a chain of event handlers, where an event not handled by one event
7039 handler is handed to the next one in the chain.
7040 """
54f9ee45 7041 return _core_.Window_SetEventHandler(*args, **kwargs)
e811c8ce
RD
7042
7043 def PushEventHandler(*args, **kwargs):
15afbcd0 7044 """
a95a7133 7045 PushEventHandler(self, EvtHandler handler)
15afbcd0
RD
7046
7047 Pushes this event handler onto the event handler stack for the window.
7048 An event handler is an object that is capable of processing the events
7049 sent to a window. By default, the window is its own event handler, but
7050 an application may wish to substitute another, for example to allow
7051 central implementation of event-handling for a variety of different
7052 window classes.
7053
7054 wx.Window.PushEventHandler allows an application to set up a chain of
7055 event handlers, where an event not handled by one event handler is
41e2b43e 7056 handed to the next one in the chain. Use `wx.Window.PopEventHandler` to
15afbcd0
RD
7057 remove the event handler.
7058 """
54f9ee45 7059 return _core_.Window_PushEventHandler(*args, **kwargs)
e811c8ce
RD
7060
7061 def PopEventHandler(*args, **kwargs):
15afbcd0 7062 """
a95a7133 7063 PopEventHandler(self, bool deleteHandler=False) -> EvtHandler
15afbcd0
RD
7064
7065 Removes and returns the top-most event handler on the event handler
7066 stack. If deleteHandler is True then the wx.EvtHandler object will be
7067 destroyed after it is popped.
7068 """
54f9ee45 7069 return _core_.Window_PopEventHandler(*args, **kwargs)
e811c8ce
RD
7070
7071 def RemoveEventHandler(*args, **kwargs):
15afbcd0 7072 """
a95a7133 7073 RemoveEventHandler(self, EvtHandler handler) -> bool
15afbcd0 7074
41e2b43e
RD
7075 Find the given handler in the event handler chain and remove (but not
7076 delete) it from the event handler chain, return True if it was found
7077 and False otherwise (this also results in an assert failure so this
7078 function should only be called when the handler is supposed to be
7079 there.)
15afbcd0 7080 """
54f9ee45 7081 return _core_.Window_RemoveEventHandler(*args, **kwargs)
e811c8ce
RD
7082
7083 def SetValidator(*args, **kwargs):
15afbcd0 7084 """
a95a7133 7085 SetValidator(self, Validator validator)
15afbcd0
RD
7086
7087 Deletes the current validator (if any) and sets the window validator,
7088 having called wx.Validator.Clone to create a new validator of this
7089 type.
7090 """
54f9ee45 7091 return _core_.Window_SetValidator(*args, **kwargs)
e811c8ce
RD
7092
7093 def GetValidator(*args, **kwargs):
15afbcd0 7094 """
a95a7133 7095 GetValidator(self) -> Validator
15afbcd0
RD
7096
7097 Returns a pointer to the current validator for the window, or None if
7098 there is none.
7099 """
54f9ee45 7100 return _core_.Window_GetValidator(*args, **kwargs)
e811c8ce 7101
74a57fcd
RD
7102 def Validate(*args, **kwargs):
7103 """
a95a7133 7104 Validate(self) -> bool
74a57fcd
RD
7105
7106 Validates the current values of the child controls using their
41e2b43e
RD
7107 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
7108 style flag set, the method will also call Validate() of all child
7109 windows. Returns false if any of the validations failed.
74a57fcd 7110 """
54f9ee45 7111 return _core_.Window_Validate(*args, **kwargs)
74a57fcd
RD
7112
7113 def TransferDataToWindow(*args, **kwargs):
7114 """
a95a7133 7115 TransferDataToWindow(self) -> bool
74a57fcd 7116
41e2b43e
RD
7117 Transfers values to child controls from data areas specified by their
7118 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
7119 style flag set, the method will also call TransferDataToWindow() of
7120 all child windows.
74a57fcd 7121 """
54f9ee45 7122 return _core_.Window_TransferDataToWindow(*args, **kwargs)
74a57fcd
RD
7123
7124 def TransferDataFromWindow(*args, **kwargs):
7125 """
a95a7133 7126 TransferDataFromWindow(self) -> bool
74a57fcd 7127
41e2b43e
RD
7128 Transfers values from child controls to data areas specified by their
7129 validators. Returns false if a transfer failed. If the window has
7130 wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will
7131 also call TransferDataFromWindow() of all child windows.
74a57fcd 7132 """
54f9ee45 7133 return _core_.Window_TransferDataFromWindow(*args, **kwargs)
74a57fcd
RD
7134
7135 def InitDialog(*args, **kwargs):
7136 """
a95a7133 7137 InitDialog(self)
74a57fcd 7138
41e2b43e
RD
7139 Sends an EVT_INIT_DIALOG event, whose handler usually transfers data
7140 to the dialog via validators.
74a57fcd 7141 """
54f9ee45 7142 return _core_.Window_InitDialog(*args, **kwargs)
74a57fcd 7143
e811c8ce 7144 def SetAcceleratorTable(*args, **kwargs):
15afbcd0 7145 """
a95a7133 7146 SetAcceleratorTable(self, AcceleratorTable accel)
15afbcd0
RD
7147
7148 Sets the accelerator table for this window.
7149 """
54f9ee45 7150 return _core_.Window_SetAcceleratorTable(*args, **kwargs)
e811c8ce
RD
7151
7152 def GetAcceleratorTable(*args, **kwargs):
15afbcd0 7153 """
a95a7133 7154 GetAcceleratorTable(self) -> AcceleratorTable
15afbcd0
RD
7155
7156 Gets the accelerator table for this window.
7157 """
54f9ee45 7158 return _core_.Window_GetAcceleratorTable(*args, **kwargs)
e811c8ce
RD
7159
7160 def RegisterHotKey(*args, **kwargs):
15afbcd0 7161 """
a95a7133 7162 RegisterHotKey(self, int hotkeyId, int modifiers, int keycode) -> bool
15afbcd0
RD
7163
7164 Registers a system wide hotkey. Every time the user presses the hotkey
7165 registered here, this window will receive a hotkey event. It will
7166 receive the event even if the application is in the background and
7167 does not have the input focus because the user is working with some
7168 other application. To bind an event handler function to this hotkey
7169 use EVT_HOTKEY with an id equal to hotkeyId. Returns True if the
7170 hotkey was registered successfully.
7171 """
54f9ee45 7172 return _core_.Window_RegisterHotKey(*args, **kwargs)
e811c8ce
RD
7173
7174 def UnregisterHotKey(*args, **kwargs):
15afbcd0 7175 """
a95a7133 7176 UnregisterHotKey(self, int hotkeyId) -> bool
15afbcd0
RD
7177
7178 Unregisters a system wide hotkey.
7179 """
54f9ee45 7180 return _core_.Window_UnregisterHotKey(*args, **kwargs)
e811c8ce
RD
7181
7182 def ConvertDialogPointToPixels(*args, **kwargs):
15afbcd0 7183 """
a95a7133 7184 ConvertDialogPointToPixels(self, Point pt) -> Point
15afbcd0
RD
7185
7186 Converts a point or size from dialog units to pixels. Dialog units
7187 are used for maintaining a dialog's proportions even if the font
7188 changes. For the x dimension, the dialog units are multiplied by the
7189 average character width and then divided by 4. For the y dimension,
7190 the dialog units are multiplied by the average character height and
7191 then divided by 8.
7192 """
54f9ee45 7193 return _core_.Window_ConvertDialogPointToPixels(*args, **kwargs)
e811c8ce
RD
7194
7195 def ConvertDialogSizeToPixels(*args, **kwargs):
15afbcd0 7196 """
a95a7133 7197 ConvertDialogSizeToPixels(self, Size sz) -> Size
15afbcd0
RD
7198
7199 Converts a point or size from dialog units to pixels. Dialog units
7200 are used for maintaining a dialog's proportions even if the font
7201 changes. For the x dimension, the dialog units are multiplied by the
7202 average character width and then divided by 4. For the y dimension,
7203 the dialog units are multiplied by the average character height and
7204 then divided by 8.
7205 """
54f9ee45 7206 return _core_.Window_ConvertDialogSizeToPixels(*args, **kwargs)
e811c8ce
RD
7207
7208 def DLG_PNT(*args, **kwargs):
15afbcd0 7209 """
a95a7133 7210 DLG_PNT(self, Point pt) -> Point
15afbcd0
RD
7211
7212 Converts a point or size from dialog units to pixels. Dialog units
7213 are used for maintaining a dialog's proportions even if the font
7214 changes. For the x dimension, the dialog units are multiplied by the
7215 average character width and then divided by 4. For the y dimension,
7216 the dialog units are multiplied by the average character height and
7217 then divided by 8.
7218 """
54f9ee45 7219 return _core_.Window_DLG_PNT(*args, **kwargs)
e811c8ce
RD
7220
7221 def DLG_SZE(*args, **kwargs):
15afbcd0 7222 """
a95a7133 7223 DLG_SZE(self, Size sz) -> Size
15afbcd0
RD
7224
7225 Converts a point or size from dialog units to pixels. Dialog units
7226 are used for maintaining a dialog's proportions even if the font
7227 changes. For the x dimension, the dialog units are multiplied by the
7228 average character width and then divided by 4. For the y dimension,
7229 the dialog units are multiplied by the average character height and
7230 then divided by 8.
7231 """
54f9ee45 7232 return _core_.Window_DLG_SZE(*args, **kwargs)
e811c8ce
RD
7233
7234 def ConvertPixelPointToDialog(*args, **kwargs):
a95a7133 7235 """ConvertPixelPointToDialog(self, Point pt) -> Point"""
54f9ee45 7236 return _core_.Window_ConvertPixelPointToDialog(*args, **kwargs)
e811c8ce
RD
7237
7238 def ConvertPixelSizeToDialog(*args, **kwargs):
a95a7133 7239 """ConvertPixelSizeToDialog(self, Size sz) -> Size"""
54f9ee45 7240 return _core_.Window_ConvertPixelSizeToDialog(*args, **kwargs)
e811c8ce
RD
7241
7242 def WarpPointer(*args, **kwargs):
15afbcd0 7243 """
a95a7133 7244 WarpPointer(self, int x, int y)
15afbcd0
RD
7245
7246 Moves the pointer to the given position on the window.
7247
7248 NOTE: This function is not supported under Mac because Apple Human
7249 Interface Guidelines forbid moving the mouse cursor programmatically.
7250 """
54f9ee45 7251 return _core_.Window_WarpPointer(*args, **kwargs)
e811c8ce
RD
7252
7253 def CaptureMouse(*args, **kwargs):
15afbcd0 7254 """
a95a7133 7255 CaptureMouse(self)
15afbcd0
RD
7256
7257 Directs all mouse input to this window. Call wx.Window.ReleaseMouse to
7258 release the capture.
7259
7260 Note that wxWindows maintains the stack of windows having captured the
7261 mouse and when the mouse is released the capture returns to the window
7262 which had had captured it previously and it is only really released if
7263 there were no previous window. In particular, this means that you must
7264 release the mouse as many times as you capture it.
7265 """
54f9ee45 7266 return _core_.Window_CaptureMouse(*args, **kwargs)
e811c8ce
RD
7267
7268 def ReleaseMouse(*args, **kwargs):
15afbcd0 7269 """
a95a7133 7270 ReleaseMouse(self)
15afbcd0
RD
7271
7272 Releases mouse input captured with wx.Window.CaptureMouse.
7273 """
54f9ee45 7274 return _core_.Window_ReleaseMouse(*args, **kwargs)
e811c8ce
RD
7275
7276 def GetCapture(*args, **kwargs):
15afbcd0 7277 """
66c033b4 7278 GetCapture() -> Window
15afbcd0
RD
7279
7280 Returns the window which currently captures the mouse or None
7281 """
54f9ee45 7282 return _core_.Window_GetCapture(*args, **kwargs)
e811c8ce
RD
7283
7284 GetCapture = staticmethod(GetCapture)
7285 def HasCapture(*args, **kwargs):
15afbcd0 7286 """
a95a7133 7287 HasCapture(self) -> bool
15afbcd0
RD
7288
7289 Returns true if this window has the current mouse capture.
7290 """
54f9ee45 7291 return _core_.Window_HasCapture(*args, **kwargs)
e811c8ce
RD
7292
7293 def Refresh(*args, **kwargs):
15afbcd0 7294 """
a95a7133 7295 Refresh(self, bool eraseBackground=True, Rect rect=None)
15afbcd0
RD
7296
7297 Mark the specified rectangle (or the whole window) as "dirty" so it
7298 will be repainted. Causes an EVT_PAINT event to be generated and sent
7299 to the window.
7300 """
54f9ee45 7301 return _core_.Window_Refresh(*args, **kwargs)
e811c8ce
RD
7302
7303 def RefreshRect(*args, **kwargs):
15afbcd0 7304 """
fef4c27a 7305 RefreshRect(self, Rect rect, bool eraseBackground=True)
15afbcd0
RD
7306
7307 Redraws the contents of the given rectangle: the area inside it will
7308 be repainted. This is the same as Refresh but has a nicer syntax.
7309 """
54f9ee45 7310 return _core_.Window_RefreshRect(*args, **kwargs)
e811c8ce
RD
7311
7312 def Update(*args, **kwargs):
15afbcd0 7313 """
a95a7133 7314 Update(self)
15afbcd0
RD
7315
7316 Calling this method immediately repaints the invalidated area of the
7317 window instead of waiting for the EVT_PAINT event to happen, (normally
7318 this would usually only happen when the flow of control returns to the
7319 event loop.) Notice that this function doesn't refresh the window and
7320 does nothing if the window has been already repainted. Use Refresh
7321 first if you want to immediately redraw the window (or some portion of
7322 it) unconditionally.
7323 """
54f9ee45 7324 return _core_.Window_Update(*args, **kwargs)
e811c8ce
RD
7325
7326 def ClearBackground(*args, **kwargs):
15afbcd0 7327 """
a95a7133 7328 ClearBackground(self)
15afbcd0
RD
7329
7330 Clears the window by filling it with the current background
7331 colour. Does not cause an erase background event to be generated.
7332 """
54f9ee45 7333 return _core_.Window_ClearBackground(*args, **kwargs)
e811c8ce
RD
7334
7335 def Freeze(*args, **kwargs):
15afbcd0 7336 """
a95a7133 7337 Freeze(self)
15afbcd0 7338
41e2b43e
RD
7339 Freezes the window or, in other words, prevents any updates from
7340 taking place on screen, the window is not redrawn at all. Thaw must be
7341 called to reenable window redrawing. Calls to Freeze/Thaw may be
7342 nested, with the actual Thaw being delayed until all the nesting has
7343 been undone.
15afbcd0
RD
7344
7345 This method is useful for visual appearance optimization (for example,
7346 it is a good idea to use it before inserting large amount of text into
7347 a wxTextCtrl under wxGTK) but is not implemented on all platforms nor
7348 for all controls so it is mostly just a hint to wxWindows and not a
7349 mandatory directive.
7350 """
54f9ee45 7351 return _core_.Window_Freeze(*args, **kwargs)
e811c8ce
RD
7352
7353 def Thaw(*args, **kwargs):
15afbcd0 7354 """
a95a7133 7355 Thaw(self)
15afbcd0 7356
4276dc52 7357 Reenables window updating after a previous call to Freeze. Calls to
41e2b43e
RD
7358 Freeze/Thaw may be nested, so Thaw must be called the same number of
7359 times that Freeze was before the window will be updated.
15afbcd0 7360 """
54f9ee45 7361 return _core_.Window_Thaw(*args, **kwargs)
e811c8ce
RD
7362
7363 def PrepareDC(*args, **kwargs):
15afbcd0 7364 """
a95a7133 7365 PrepareDC(self, DC dc)
15afbcd0
RD
7366
7367 Call this function to prepare the device context for drawing a
7368 scrolled image. It sets the device origin according to the current
7369 scroll position.
7370 """
54f9ee45 7371 return _core_.Window_PrepareDC(*args, **kwargs)
e811c8ce
RD
7372
7373 def GetUpdateRegion(*args, **kwargs):
15afbcd0 7374 """
a95a7133 7375 GetUpdateRegion(self) -> Region
15afbcd0
RD
7376
7377 Returns the region specifying which parts of the window have been
7378 damaged. Should only be called within an EVT_PAINT handler.
7379 """
54f9ee45 7380 return _core_.Window_GetUpdateRegion(*args, **kwargs)
e811c8ce
RD
7381
7382 def GetUpdateClientRect(*args, **kwargs):
15afbcd0 7383 """
a95a7133 7384 GetUpdateClientRect(self) -> Rect
15afbcd0
RD
7385
7386 Get the update rectangle region bounding box in client coords.
7387 """
54f9ee45 7388 return _core_.Window_GetUpdateClientRect(*args, **kwargs)
e811c8ce
RD
7389
7390 def IsExposed(*args, **kwargs):
15afbcd0 7391 """
a95a7133 7392 IsExposed(self, int x, int y, int w=1, int h=1) -> bool
15afbcd0
RD
7393
7394 Returns true if the given point or rectangle area has been exposed
7395 since the last repaint. Call this in an paint event handler to
7396 optimize redrawing by only redrawing those areas, which have been
7397 exposed.
7398 """
54f9ee45 7399 return _core_.Window_IsExposed(*args, **kwargs)
e811c8ce
RD
7400
7401 def IsExposedPoint(*args, **kwargs):
15afbcd0 7402 """
a95a7133 7403 IsExposedPoint(self, Point pt) -> bool
15afbcd0
RD
7404
7405 Returns true if the given point or rectangle area has been exposed
7406 since the last repaint. Call this in an paint event handler to
7407 optimize redrawing by only redrawing those areas, which have been
7408 exposed.
7409 """
54f9ee45 7410 return _core_.Window_IsExposedPoint(*args, **kwargs)
e811c8ce 7411
4276dc52 7412 def IsExposedRect(*args, **kwargs):
15afbcd0 7413 """
a95a7133 7414 IsExposedRect(self, Rect rect) -> bool
15afbcd0
RD
7415
7416 Returns true if the given point or rectangle area has been exposed
7417 since the last repaint. Call this in an paint event handler to
7418 optimize redrawing by only redrawing those areas, which have been
7419 exposed.
7420 """
54f9ee45 7421 return _core_.Window_IsExposedRect(*args, **kwargs)
e811c8ce 7422
74a57fcd
RD
7423 def GetDefaultAttributes(*args, **kwargs):
7424 """
a95a7133 7425 GetDefaultAttributes(self) -> VisualAttributes
74a57fcd 7426
41e2b43e
RD
7427 Get the default attributes for an instance of this class. This is
7428 useful if you want to use the same font or colour in your own control
7429 as in a standard control -- which is a much better idea than hard
7430 coding specific colours or fonts which might look completely out of
db3e571a 7431 place on the user's system, especially if it uses themes.
74a57fcd 7432 """
54f9ee45 7433 return _core_.Window_GetDefaultAttributes(*args, **kwargs)
74a57fcd
RD
7434
7435 def GetClassDefaultAttributes(*args, **kwargs):
7436 """
66c033b4 7437 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
74a57fcd 7438
41e2b43e
RD
7439 Get the default attributes for this class. This is useful if you want
7440 to use the same font or colour in your own control as in a standard
7441 control -- which is a much better idea than hard coding specific
db3e571a
RD
7442 colours or fonts which might look completely out of place on the
7443 user's system, especially if it uses themes.
74a57fcd
RD
7444
7445 The variant parameter is only relevant under Mac currently and is
41e2b43e 7446 ignore under other platforms. Under Mac, it will change the size of
db3e571a
RD
7447 the returned font. See `wx.Window.SetWindowVariant` for more about
7448 this.
74a57fcd 7449 """
54f9ee45 7450 return _core_.Window_GetClassDefaultAttributes(*args, **kwargs)
74a57fcd
RD
7451
7452 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
e811c8ce 7453 def SetBackgroundColour(*args, **kwargs):
15afbcd0 7454 """
a95a7133 7455 SetBackgroundColour(self, Colour colour) -> bool
15afbcd0
RD
7456
7457 Sets the background colour of the window. Returns True if the colour
7458 was changed. The background colour is usually painted by the default
7459 EVT_ERASE_BACKGROUND event handler function under Windows and
f8167d6e
RD
7460 automatically under GTK. Using `wx.NullColour` will reset the window
7461 to the default background colour.
15afbcd0 7462
db3e571a 7463 Note that setting the background colour may not cause an immediate
f8167d6e 7464 refresh, so you may wish to call `ClearBackground` or `Refresh` after
15afbcd0
RD
7465 calling this function.
7466
f8167d6e
RD
7467 Using this function will disable attempts to use themes for this
7468 window, if the system supports them. Use with care since usually the
7469 themes represent the appearance chosen by the user to be used for all
7470 applications on the system.
15afbcd0 7471 """
54f9ee45 7472 return _core_.Window_SetBackgroundColour(*args, **kwargs)
e811c8ce 7473
412d302d
RD
7474 def SetOwnBackgroundColour(*args, **kwargs):
7475 """SetOwnBackgroundColour(self, Colour colour)"""
7476 return _core_.Window_SetOwnBackgroundColour(*args, **kwargs)
b2df227b 7477
e811c8ce 7478 def SetForegroundColour(*args, **kwargs):
15afbcd0 7479 """
a95a7133 7480 SetForegroundColour(self, Colour colour) -> bool
15afbcd0
RD
7481
7482 Sets the foreground colour of the window. Returns True is the colour
7483 was changed. The interpretation of foreground colour is dependent on
7484 the window class; it may be the text colour or other colour, or it may
7485 not be used at all.
7486 """
54f9ee45 7487 return _core_.Window_SetForegroundColour(*args, **kwargs)
e811c8ce 7488
fa47d7a7
VS
7489 def SetOwnForegroundColour(*args, **kwargs):
7490 """SetOwnForegroundColour(self, Colour colour)"""
7491 return _core_.Window_SetOwnForegroundColour(*args, **kwargs)
b2df227b 7492
e811c8ce 7493 def GetBackgroundColour(*args, **kwargs):
15afbcd0 7494 """
a95a7133 7495 GetBackgroundColour(self) -> Colour
15afbcd0
RD
7496
7497 Returns the background colour of the window.
7498 """
54f9ee45 7499 return _core_.Window_GetBackgroundColour(*args, **kwargs)
e811c8ce
RD
7500
7501 def GetForegroundColour(*args, **kwargs):
15afbcd0 7502 """
a95a7133 7503 GetForegroundColour(self) -> Colour
15afbcd0
RD
7504
7505 Returns the foreground colour of the window. The interpretation of
7506 foreground colour is dependent on the window class; it may be the text
7507 colour or other colour, or it may not be used at all.
7508 """
54f9ee45 7509 return _core_.Window_GetForegroundColour(*args, **kwargs)
e811c8ce 7510
562ecc31
RD
7511 def InheritsBackgroundColour(*args, **kwargs):
7512 """InheritsBackgroundColour(self) -> bool"""
7513 return _core_.Window_InheritsBackgroundColour(*args, **kwargs)
7514
7515 def UseBgCol(*args, **kwargs):
7516 """UseBgCol(self) -> bool"""
7517 return _core_.Window_UseBgCol(*args, **kwargs)
7518
7bc1e663
RD
7519 def SetBackgroundStyle(*args, **kwargs):
7520 """
7521 SetBackgroundStyle(self, int style) -> bool
7522
7523 Returns the background style of the window. The background style
7524 indicates how the background of the window is drawn.
7525
7526 ====================== ========================================
7527 wx.BG_STYLE_SYSTEM The background colour or pattern should
7528 be determined by the system
7529 wx.BG_STYLE_COLOUR The background should be a solid colour
7530 wx.BG_STYLE_CUSTOM The background will be implemented by the
7531 application.
7532 ====================== ========================================
7533
7534 On GTK+, use of wx.BG_STYLE_CUSTOM allows the flicker-free drawing of
7535 a custom background, such as a tiled bitmap. Currently the style has
7536 no effect on other platforms.
7537
7538 :see: `GetBackgroundStyle`, `SetBackgroundColour`
7539 """
7540 return _core_.Window_SetBackgroundStyle(*args, **kwargs)
7541
7542 def GetBackgroundStyle(*args, **kwargs):
7543 """
7544 GetBackgroundStyle(self) -> int
7545
7546 Returns the background style of the window.
7547
7548 :see: `SetBackgroundStyle`
7549 """
7550 return _core_.Window_GetBackgroundStyle(*args, **kwargs)
7551
51b83b37
RD
7552 def HasTransparentBackground(*args, **kwargs):
7553 """
7554 HasTransparentBackground(self) -> bool
7555
7556 Returns True if this window's background is transparent (as, for
7557 example, for `wx.StaticText`) and should show the parent window's
7558 background.
7559
7560 This method is mostly used internally by the library itself and you
7561 normally shouldn't have to call it. You may, however, have to override
7562 it in your custom control classes to ensure that background is painted
7563 correctly.
7564 """
7565 return _core_.Window_HasTransparentBackground(*args, **kwargs)
7566
e811c8ce 7567 def SetCursor(*args, **kwargs):
15afbcd0 7568 """
a95a7133 7569 SetCursor(self, Cursor cursor) -> bool
15afbcd0
RD
7570
7571 Sets the window's cursor. Notice that the window cursor also sets it
7572 for the children of the window implicitly.
7573
7574 The cursor may be wx.NullCursor in which case the window cursor will
7575 be reset back to default.
7576 """
54f9ee45 7577 return _core_.Window_SetCursor(*args, **kwargs)
e811c8ce
RD
7578
7579 def GetCursor(*args, **kwargs):
15afbcd0 7580 """
a95a7133 7581 GetCursor(self) -> Cursor
15afbcd0
RD
7582
7583 Return the cursor associated with this window.
7584 """
54f9ee45 7585 return _core_.Window_GetCursor(*args, **kwargs)
e811c8ce
RD
7586
7587 def SetFont(*args, **kwargs):
15afbcd0 7588 """
a95a7133 7589 SetFont(self, Font font) -> bool
15afbcd0
RD
7590
7591 Sets the font for this window.
7592 """
54f9ee45 7593 return _core_.Window_SetFont(*args, **kwargs)
e811c8ce 7594
fa47d7a7
VS
7595 def SetOwnFont(*args, **kwargs):
7596 """SetOwnFont(self, Font font)"""
7597 return _core_.Window_SetOwnFont(*args, **kwargs)
b2df227b 7598
e811c8ce 7599 def GetFont(*args, **kwargs):
15afbcd0 7600 """
a95a7133 7601 GetFont(self) -> Font
15afbcd0 7602
4276dc52 7603 Returns the default font used for this window.
15afbcd0 7604 """
54f9ee45 7605 return _core_.Window_GetFont(*args, **kwargs)
e811c8ce
RD
7606
7607 def SetCaret(*args, **kwargs):
15afbcd0 7608 """
a95a7133 7609 SetCaret(self, Caret caret)
15afbcd0
RD
7610
7611 Sets the caret associated with the window.
7612 """
54f9ee45 7613 return _core_.Window_SetCaret(*args, **kwargs)
e811c8ce
RD
7614
7615 def GetCaret(*args, **kwargs):
15afbcd0 7616 """
a95a7133 7617 GetCaret(self) -> Caret
15afbcd0
RD
7618
7619 Returns the caret associated with the window.
7620 """
54f9ee45 7621 return _core_.Window_GetCaret(*args, **kwargs)
e811c8ce
RD
7622
7623 def GetCharHeight(*args, **kwargs):
15afbcd0 7624 """
a95a7133 7625 GetCharHeight(self) -> int
15afbcd0
RD
7626
7627 Get the (average) character size for the current font.
7628 """
54f9ee45 7629 return _core_.Window_GetCharHeight(*args, **kwargs)
e811c8ce
RD
7630
7631 def GetCharWidth(*args, **kwargs):
15afbcd0 7632 """
a95a7133 7633 GetCharWidth(self) -> int
15afbcd0
RD
7634
7635 Get the (average) character size for the current font.
7636 """
54f9ee45 7637 return _core_.Window_GetCharWidth(*args, **kwargs)
e811c8ce
RD
7638
7639 def GetTextExtent(*args, **kwargs):
fd2dc343
RD
7640 """
7641 GetTextExtent(String string) -> (width, height)
7642
7643 Get the width and height of the text using the current font.
7644 """
54f9ee45 7645 return _core_.Window_GetTextExtent(*args, **kwargs)
e811c8ce
RD
7646
7647 def GetFullTextExtent(*args, **kwargs):
0df68c9f 7648 """
196addbf 7649 GetFullTextExtent(String string, Font font=None) ->
0df68c9f 7650 (width, height, descent, externalLeading)
e811c8ce 7651
15afbcd0
RD
7652 Get the width, height, decent and leading of the text using the
7653 current or specified font.
0df68c9f 7654 """
54f9ee45 7655 return _core_.Window_GetFullTextExtent(*args, **kwargs)
e811c8ce
RD
7656
7657 def ClientToScreenXY(*args, **kwargs):
15afbcd0
RD
7658 """
7659 ClientToScreenXY(int x, int y) -> (x,y)
7660
7661 Converts to screen coordinates from coordinates relative to this window.
7662 """
54f9ee45 7663 return _core_.Window_ClientToScreenXY(*args, **kwargs)
e811c8ce
RD
7664
7665 def ScreenToClientXY(*args, **kwargs):
15afbcd0
RD
7666 """
7667 ScreenToClientXY(int x, int y) -> (x,y)
7668
7669 Converts from screen to client window coordinates.
7670 """
54f9ee45 7671 return _core_.Window_ScreenToClientXY(*args, **kwargs)
e811c8ce
RD
7672
7673 def ClientToScreen(*args, **kwargs):
15afbcd0 7674 """
a95a7133 7675 ClientToScreen(self, Point pt) -> Point
15afbcd0
RD
7676
7677 Converts to screen coordinates from coordinates relative to this window.
7678 """
54f9ee45 7679 return _core_.Window_ClientToScreen(*args, **kwargs)
e811c8ce
RD
7680
7681 def ScreenToClient(*args, **kwargs):
15afbcd0 7682 """
a95a7133 7683 ScreenToClient(self, Point pt) -> Point
15afbcd0
RD
7684
7685 Converts from screen to client window coordinates.
7686 """
54f9ee45 7687 return _core_.Window_ScreenToClient(*args, **kwargs)
e811c8ce
RD
7688
7689 def HitTestXY(*args, **kwargs):
15afbcd0 7690 """
a95a7133 7691 HitTestXY(self, int x, int y) -> int
15afbcd0
RD
7692
7693 Test where the given (in client coords) point lies
7694 """
54f9ee45 7695 return _core_.Window_HitTestXY(*args, **kwargs)
e811c8ce
RD
7696
7697 def HitTest(*args, **kwargs):
15afbcd0 7698 """
a95a7133 7699 HitTest(self, Point pt) -> int
15afbcd0
RD
7700
7701 Test where the given (in client coords) point lies
7702 """
54f9ee45 7703 return _core_.Window_HitTest(*args, **kwargs)
e811c8ce 7704
15afbcd0
RD
7705 def GetBorder(*args):
7706 """
a95a7133
RD
7707 GetBorder(self, long flags) -> int
7708 GetBorder(self) -> int
e811c8ce 7709
15afbcd0
RD
7710 Get border for the flags of this window
7711 """
54f9ee45 7712 return _core_.Window_GetBorder(*args)
e811c8ce
RD
7713
7714 def UpdateWindowUI(*args, **kwargs):
15afbcd0 7715 """
a95a7133 7716 UpdateWindowUI(self, long flags=UPDATE_UI_NONE)
15afbcd0
RD
7717
7718 This function sends EVT_UPDATE_UI events to the window. The particular
7719 implementation depends on the window; for example a wx.ToolBar will
7720 send an update UI event for each toolbar button, and a wx.Frame will
7721 send an update UI event for each menubar menu item. You can call this
7722 function from your application to ensure that your UI is up-to-date at
7723 a particular point in time (as far as your EVT_UPDATE_UI handlers are
7724 concerned). This may be necessary if you have called
7725 wx.UpdateUIEvent.SetMode or wx.UpdateUIEvent.SetUpdateInterval to
7726 limit the overhead that wxWindows incurs by sending update UI events
7727 in idle time.
15afbcd0 7728 """
54f9ee45 7729 return _core_.Window_UpdateWindowUI(*args, **kwargs)
e811c8ce
RD
7730
7731 def PopupMenuXY(*args, **kwargs):
15afbcd0 7732 """
b0503257 7733 PopupMenuXY(self, Menu menu, int x=-1, int y=-1) -> bool
15afbcd0 7734
b0503257
RD
7735 Pops up the given menu at the specified coordinates, relative to this window,
7736 and returns control when the user has dismissed the menu. If a menu item is
7737 selected, the corresponding menu event is generated and will be processed as
7738 usual. If the default position is given then the current position of the
7739 mouse cursor will be used.
15afbcd0 7740 """
54f9ee45 7741 return _core_.Window_PopupMenuXY(*args, **kwargs)
e811c8ce 7742
15afbcd0
RD
7743 def PopupMenu(*args, **kwargs):
7744 """
b0503257 7745 PopupMenu(self, Menu menu, Point pos=DefaultPosition) -> bool
15afbcd0 7746
b0503257
RD
7747 Pops up the given menu at the specified coordinates, relative to this window,
7748 and returns control when the user has dismissed the menu. If a menu item is
7749 selected, the corresponding menu event is generated and will be processed as
7750 usual. If the default position is given then the current position of the
7751 mouse cursor will be used.
15afbcd0 7752 """
54f9ee45 7753 return _core_.Window_PopupMenu(*args, **kwargs)
15afbcd0
RD
7754
7755 def GetHandle(*args, **kwargs):
7756 """
a95a7133 7757 GetHandle(self) -> long
15afbcd0
RD
7758
7759 Returns the platform-specific handle (as a long integer) of the
7760 physical window. Currently on wxMac it returns the handle of the
7761 toplevel parent of the window.
7762 """
54f9ee45 7763 return _core_.Window_GetHandle(*args, **kwargs)
15afbcd0 7764
7e63a440
RD
7765 def AssociateHandle(*args, **kwargs):
7766 """
7767 AssociateHandle(self, long handle)
7768
7769 Associate the window with a new native handle
7770 """
7771 return _core_.Window_AssociateHandle(*args, **kwargs)
7772
7773 def DissociateHandle(*args, **kwargs):
7774 """
7775 DissociateHandle(self)
7776
7777 Dissociate the current native handle from the window
7778 """
7779 return _core_.Window_DissociateHandle(*args, **kwargs)
7780
15afbcd0
RD
7781 def HasScrollbar(*args, **kwargs):
7782 """
a95a7133 7783 HasScrollbar(self, int orient) -> bool
15afbcd0
RD
7784
7785 Does the window have the scrollbar for this orientation?
7786 """
54f9ee45 7787 return _core_.Window_HasScrollbar(*args, **kwargs)
15afbcd0
RD
7788
7789 def SetScrollbar(*args, **kwargs):
7790 """
41e2b43e 7791 SetScrollbar(self, int orientation, int position, int thumbSize, int range,
15afbcd0
RD
7792 bool refresh=True)
7793
7794 Sets the scrollbar properties of a built-in scrollbar.
15afbcd0 7795 """
54f9ee45 7796 return _core_.Window_SetScrollbar(*args, **kwargs)
e811c8ce
RD
7797
7798 def SetScrollPos(*args, **kwargs):
15afbcd0 7799 """
a95a7133 7800 SetScrollPos(self, int orientation, int pos, bool refresh=True)
15afbcd0
RD
7801
7802 Sets the position of one of the built-in scrollbars.
7803 """
54f9ee45 7804 return _core_.Window_SetScrollPos(*args, **kwargs)
e811c8ce
RD
7805
7806 def GetScrollPos(*args, **kwargs):
15afbcd0 7807 """
a95a7133 7808 GetScrollPos(self, int orientation) -> int
15afbcd0
RD
7809
7810 Returns the built-in scrollbar position.
7811 """
54f9ee45 7812 return _core_.Window_GetScrollPos(*args, **kwargs)
e811c8ce
RD
7813
7814 def GetScrollThumb(*args, **kwargs):
15afbcd0 7815 """
a95a7133 7816 GetScrollThumb(self, int orientation) -> int
15afbcd0
RD
7817
7818 Returns the built-in scrollbar thumb size.
7819 """
54f9ee45 7820 return _core_.Window_GetScrollThumb(*args, **kwargs)
e811c8ce
RD
7821
7822 def GetScrollRange(*args, **kwargs):
15afbcd0 7823 """
a95a7133 7824 GetScrollRange(self, int orientation) -> int
15afbcd0
RD
7825
7826 Returns the built-in scrollbar range.
7827 """
54f9ee45 7828 return _core_.Window_GetScrollRange(*args, **kwargs)
e811c8ce
RD
7829
7830 def ScrollWindow(*args, **kwargs):
15afbcd0 7831 """
a95a7133 7832 ScrollWindow(self, int dx, int dy, Rect rect=None)
15afbcd0
RD
7833
7834 Physically scrolls the pixels in the window and move child windows
7835 accordingly. Use this function to optimise your scrolling
7836 implementations, to minimise the area that must be redrawn. Note that
7837 it is rarely required to call this function from a user program.
15afbcd0 7838 """
54f9ee45 7839 return _core_.Window_ScrollWindow(*args, **kwargs)
e811c8ce
RD
7840
7841 def ScrollLines(*args, **kwargs):
15afbcd0 7842 """
a95a7133 7843 ScrollLines(self, int lines) -> bool
15afbcd0
RD
7844
7845 If the platform and window class supports it, scrolls the window by
7846 the given number of lines down, if lines is positive, or up if lines
7847 is negative. Returns True if the window was scrolled, False if it was
7848 already on top/bottom and nothing was done.
7849 """
54f9ee45 7850 return _core_.Window_ScrollLines(*args, **kwargs)
e811c8ce
RD
7851
7852 def ScrollPages(*args, **kwargs):
15afbcd0 7853 """
a95a7133 7854 ScrollPages(self, int pages) -> bool
15afbcd0 7855
41e2b43e 7856 If the platform and window class supports it, scrolls the window by
15afbcd0
RD
7857 the given number of pages down, if pages is positive, or up if pages
7858 is negative. Returns True if the window was scrolled, False if it was
7859 already on top/bottom and nothing was done.
7860 """
54f9ee45 7861 return _core_.Window_ScrollPages(*args, **kwargs)
e811c8ce
RD
7862
7863 def LineUp(*args, **kwargs):
15afbcd0 7864 """
a95a7133 7865 LineUp(self) -> bool
15afbcd0
RD
7866
7867 This is just a wrapper for ScrollLines(-1).
7868 """
54f9ee45 7869 return _core_.Window_LineUp(*args, **kwargs)
e811c8ce
RD
7870
7871 def LineDown(*args, **kwargs):
15afbcd0 7872 """
a95a7133 7873 LineDown(self) -> bool
15afbcd0
RD
7874
7875 This is just a wrapper for ScrollLines(1).
7876 """
54f9ee45 7877 return _core_.Window_LineDown(*args, **kwargs)
e811c8ce
RD
7878
7879 def PageUp(*args, **kwargs):
15afbcd0 7880 """
a95a7133 7881 PageUp(self) -> bool
15afbcd0
RD
7882
7883 This is just a wrapper for ScrollPages(-1).
7884 """
54f9ee45 7885 return _core_.Window_PageUp(*args, **kwargs)
e811c8ce
RD
7886
7887 def PageDown(*args, **kwargs):
15afbcd0 7888 """
a95a7133 7889 PageDown(self) -> bool
15afbcd0
RD
7890
7891 This is just a wrapper for ScrollPages(1).
7892 """
54f9ee45 7893 return _core_.Window_PageDown(*args, **kwargs)
e811c8ce
RD
7894
7895 def SetHelpText(*args, **kwargs):
15afbcd0 7896 """
a95a7133 7897 SetHelpText(self, String text)
15afbcd0
RD
7898
7899 Sets the help text to be used as context-sensitive help for this
7900 window. Note that the text is actually stored by the current
7901 wxHelpProvider implementation, and not in the window object itself.
7902 """
54f9ee45 7903 return _core_.Window_SetHelpText(*args, **kwargs)
e811c8ce
RD
7904
7905 def SetHelpTextForId(*args, **kwargs):
15afbcd0 7906 """
a95a7133 7907 SetHelpTextForId(self, String text)
15afbcd0
RD
7908
7909 Associate this help text with all windows with the same id as this
7910 one.
7911 """
54f9ee45 7912 return _core_.Window_SetHelpTextForId(*args, **kwargs)
e811c8ce
RD
7913
7914 def GetHelpText(*args, **kwargs):
15afbcd0 7915 """
a95a7133 7916 GetHelpText(self) -> String
15afbcd0
RD
7917
7918 Gets the help text to be used as context-sensitive help for this
7919 window. Note that the text is actually stored by the current
7920 wxHelpProvider implementation, and not in the window object itself.
7921 """
54f9ee45 7922 return _core_.Window_GetHelpText(*args, **kwargs)
e811c8ce
RD
7923
7924 def SetToolTipString(*args, **kwargs):
15afbcd0 7925 """
a95a7133 7926 SetToolTipString(self, String tip)
15afbcd0
RD
7927
7928 Attach a tooltip to the window.
7929 """
54f9ee45 7930 return _core_.Window_SetToolTipString(*args, **kwargs)
e811c8ce
RD
7931
7932 def SetToolTip(*args, **kwargs):
15afbcd0 7933 """
a95a7133 7934 SetToolTip(self, ToolTip tip)
15afbcd0
RD
7935
7936 Attach a tooltip to the window.
7937 """
54f9ee45 7938 return _core_.Window_SetToolTip(*args, **kwargs)
e811c8ce
RD
7939
7940 def GetToolTip(*args, **kwargs):
15afbcd0 7941 """
a95a7133 7942 GetToolTip(self) -> ToolTip
15afbcd0
RD
7943
7944 get the associated tooltip or None if none
7945 """
54f9ee45 7946 return _core_.Window_GetToolTip(*args, **kwargs)
e811c8ce
RD
7947
7948 def SetDropTarget(*args, **kwargs):
15afbcd0 7949 """
a95a7133 7950 SetDropTarget(self, DropTarget dropTarget)
15afbcd0
RD
7951
7952 Associates a drop target with this window. If the window already has
7953 a drop target, it is deleted.
7954 """
54f9ee45 7955 return _core_.Window_SetDropTarget(*args, **kwargs)
e811c8ce
RD
7956
7957 def GetDropTarget(*args, **kwargs):
15afbcd0 7958 """
a95a7133 7959 GetDropTarget(self) -> DropTarget
15afbcd0
RD
7960
7961 Returns the associated drop target, which may be None.
7962 """
54f9ee45 7963 return _core_.Window_GetDropTarget(*args, **kwargs)
e811c8ce
RD
7964
7965 def SetConstraints(*args, **kwargs):
15afbcd0 7966 """
a95a7133 7967 SetConstraints(self, LayoutConstraints constraints)
15afbcd0
RD
7968
7969 Sets the window to have the given layout constraints. If an existing
7970 layout constraints object is already owned by the window, it will be
7971 deleted. Pass None to disassociate and delete the window's current
7972 constraints.
7973
7974 You must call SetAutoLayout to tell a window to use the constraints
7975 automatically in its default EVT_SIZE handler; otherwise, you must
7976 handle EVT_SIZE yourself and call Layout() explicitly. When setting
7977 both a wx.LayoutConstraints and a wx.Sizer, only the sizer will have
7978 effect.
7979 """
54f9ee45 7980 return _core_.Window_SetConstraints(*args, **kwargs)
e811c8ce
RD
7981
7982 def GetConstraints(*args, **kwargs):
15afbcd0 7983 """
a95a7133 7984 GetConstraints(self) -> LayoutConstraints
15afbcd0
RD
7985
7986 Returns a pointer to the window's layout constraints, or None if there
7987 are none.
7988 """
54f9ee45 7989 return _core_.Window_GetConstraints(*args, **kwargs)
e811c8ce
RD
7990
7991 def SetAutoLayout(*args, **kwargs):
15afbcd0 7992 """
a95a7133 7993 SetAutoLayout(self, bool autoLayout)
15afbcd0
RD
7994
7995 Determines whether the Layout function will be called automatically
7996 when the window is resized. It is called implicitly by SetSizer but
7997 if you use SetConstraints you should call it manually or otherwise the
7998 window layout won't be correctly updated when its size changes.
7999 """
54f9ee45 8000 return _core_.Window_SetAutoLayout(*args, **kwargs)
e811c8ce
RD
8001
8002 def GetAutoLayout(*args, **kwargs):
15afbcd0 8003 """
a95a7133 8004 GetAutoLayout(self) -> bool
15afbcd0
RD
8005
8006 Returns the current autoLayout setting
8007 """
54f9ee45 8008 return _core_.Window_GetAutoLayout(*args, **kwargs)
e811c8ce
RD
8009
8010 def Layout(*args, **kwargs):
15afbcd0 8011 """
a95a7133 8012 Layout(self) -> bool
15afbcd0
RD
8013
8014 Invokes the constraint-based layout algorithm or the sizer-based
8015 algorithm for this window. See SetAutoLayout: when auto layout is on,
8016 this function gets called automatically by the default EVT_SIZE
8017 handler when the window is resized.
8018 """
54f9ee45 8019 return _core_.Window_Layout(*args, **kwargs)
e811c8ce
RD
8020
8021 def SetSizer(*args, **kwargs):
15afbcd0 8022 """
a95a7133 8023 SetSizer(self, Sizer sizer, bool deleteOld=True)
15afbcd0
RD
8024
8025 Sets the window to have the given layout sizer. The window will then
8026 own the object, and will take care of its deletion. If an existing
8027 layout sizer object is already owned by the window, it will be deleted
8028 if the deleteOld parameter is true. Note that this function will also
8029 call SetAutoLayout implicitly with a True parameter if the sizer is
ae8162c8 8030 non-None, and False otherwise.
15afbcd0 8031 """
54f9ee45 8032 return _core_.Window_SetSizer(*args, **kwargs)
e811c8ce
RD
8033
8034 def SetSizerAndFit(*args, **kwargs):
15afbcd0 8035 """
a95a7133 8036 SetSizerAndFit(self, Sizer sizer, bool deleteOld=True)
15afbcd0
RD
8037
8038 The same as SetSizer, except it also sets the size hints for the
8039 window based on the sizer's minimum size.
8040 """
54f9ee45 8041 return _core_.Window_SetSizerAndFit(*args, **kwargs)
e811c8ce
RD
8042
8043 def GetSizer(*args, **kwargs):
15afbcd0 8044 """
a95a7133 8045 GetSizer(self) -> Sizer
15afbcd0
RD
8046
8047 Return the sizer associated with the window by a previous call to
8048 SetSizer or None if there isn't one.
8049 """
54f9ee45 8050 return _core_.Window_GetSizer(*args, **kwargs)
e811c8ce
RD
8051
8052 def SetContainingSizer(*args, **kwargs):
15afbcd0 8053 """
a95a7133 8054 SetContainingSizer(self, Sizer sizer)
15afbcd0
RD
8055
8056 This normally does not need to be called by application code. It is
8057 called internally when a window is added to a sizer, and is used so
8058 the window can remove itself from the sizer when it is destroyed.
8059 """
54f9ee45 8060 return _core_.Window_SetContainingSizer(*args, **kwargs)
e811c8ce
RD
8061
8062 def GetContainingSizer(*args, **kwargs):
15afbcd0 8063 """
a95a7133 8064 GetContainingSizer(self) -> Sizer
15afbcd0
RD
8065
8066 Return the sizer that this window is a member of, if any, otherwise None.
8067 """
54f9ee45 8068 return _core_.Window_GetContainingSizer(*args, **kwargs)
e811c8ce 8069
a95a7133
RD
8070 def InheritAttributes(*args, **kwargs):
8071 """
8072 InheritAttributes(self)
8073
41e2b43e
RD
8074 This function is (or should be, in case of custom controls) called
8075 during window creation to intelligently set up the window visual
8076 attributes, that is the font and the foreground and background
8077 colours.
8078
8079 By 'intelligently' the following is meant: by default, all windows use
8080 their own default attributes. However if some of the parent's
8081 attributes are explicitly changed (that is, using SetFont and not
fa47d7a7 8082 SetOwnFont) and if the corresponding attribute hadn't been
41e2b43e
RD
8083 explicitly set for this window itself, then this window takes the same
8084 value as used by the parent. In addition, if the window overrides
8085 ShouldInheritColours to return false, the colours will not be changed
8086 no matter what and only the font might.
8087
34621cc5 8088 This rather complicated logic is necessary in order to accommodate the
ec9b55ca 8089 different usage scenarios. The most common one is when all default
41e2b43e
RD
8090 attributes are used and in this case, nothing should be inherited as
8091 in modern GUIs different controls use different fonts (and colours)
8092 than their siblings so they can't inherit the same value from the
8093 parent. However it was also deemed desirable to allow to simply change
8094 the attributes of all children at once by just changing the font or
8095 colour of their common parent, hence in this case we do inherit the
8096 parents attributes.
8097
a95a7133 8098 """
54f9ee45 8099 return _core_.Window_InheritAttributes(*args, **kwargs)
a95a7133
RD
8100
8101 def ShouldInheritColours(*args, **kwargs):
8102 """
8103 ShouldInheritColours(self) -> bool
8104
8105 Return true from here to allow the colours of this window to be
41e2b43e
RD
8106 changed by InheritAttributes, returning false forbids inheriting them
8107 from the parent window.
a95a7133 8108
41e2b43e
RD
8109 The base class version returns false, but this method is overridden in
8110 wxControl where it returns true.
a95a7133 8111 """
54f9ee45 8112 return _core_.Window_ShouldInheritColours(*args, **kwargs)
a95a7133 8113
e811c8ce 8114 def PostCreate(self, pre):
15afbcd0
RD
8115 """
8116 Phase 3 of the 2-phase create <wink!>
8117 Call this method after precreating the window with the 2-phase create method.
8118 """
e811c8ce
RD
8119 self.this = pre.this
8120 self.thisown = pre.thisown
8121 pre.thisown = 0
8122 if hasattr(self, '_setOORInfo'):
8123 self._setOORInfo(self)
8124 if hasattr(self, '_setCallbackInfo'):
8125 self._setCallbackInfo(self, self.__class__)
8126
8127
8128class WindowPtr(Window):
8129 def __init__(self, this):
8130 self.this = this
8131 if not hasattr(self,"thisown"): self.thisown = 0
8132 self.__class__ = Window
54f9ee45 8133_core_.Window_swigregister(WindowPtr)
e811c8ce
RD
8134
8135def PreWindow(*args, **kwargs):
15afbcd0
RD
8136 """
8137 PreWindow() -> Window
8138
8139 Precreate a Window for 2-phase creation.
8140 """
54f9ee45 8141 val = _core_.new_PreWindow(*args, **kwargs)
e811c8ce
RD
8142 val.thisown = 1
8143 return val
8144
8145def Window_NewControlId(*args, **kwargs):
15afbcd0
RD
8146 """
8147 Window_NewControlId() -> int
8148
8149 Generate a control id for the controls which were not given one.
8150 """
54f9ee45 8151 return _core_.Window_NewControlId(*args, **kwargs)
e811c8ce
RD
8152
8153def Window_NextControlId(*args, **kwargs):
15afbcd0
RD
8154 """
8155 Window_NextControlId(int winid) -> int
8156
8157 Get the id of the control following the one with the given
41e2b43e 8158 autogenerated) id
15afbcd0 8159 """
54f9ee45 8160 return _core_.Window_NextControlId(*args, **kwargs)
e811c8ce
RD
8161
8162def Window_PrevControlId(*args, **kwargs):
15afbcd0
RD
8163 """
8164 Window_PrevControlId(int winid) -> int
8165
8166 Get the id of the control preceding the one with the given
41e2b43e 8167 autogenerated) id
15afbcd0 8168 """
54f9ee45 8169 return _core_.Window_PrevControlId(*args, **kwargs)
e811c8ce
RD
8170
8171def Window_FindFocus(*args, **kwargs):
15afbcd0
RD
8172 """
8173 Window_FindFocus() -> Window
8174
8175 Returns the window or control that currently has the keyboard focus,
8176 or None.
8177 """
54f9ee45 8178 return _core_.Window_FindFocus(*args, **kwargs)
e811c8ce
RD
8179
8180def Window_GetCapture(*args, **kwargs):
15afbcd0
RD
8181 """
8182 Window_GetCapture() -> Window
8183
8184 Returns the window which currently captures the mouse or None
8185 """
54f9ee45 8186 return _core_.Window_GetCapture(*args, **kwargs)
e811c8ce 8187
74a57fcd
RD
8188def Window_GetClassDefaultAttributes(*args, **kwargs):
8189 """
8190 Window_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
8191
41e2b43e
RD
8192 Get the default attributes for this class. This is useful if you want
8193 to use the same font or colour in your own control as in a standard
8194 control -- which is a much better idea than hard coding specific
db3e571a
RD
8195 colours or fonts which might look completely out of place on the
8196 user's system, especially if it uses themes.
74a57fcd
RD
8197
8198 The variant parameter is only relevant under Mac currently and is
41e2b43e 8199 ignore under other platforms. Under Mac, it will change the size of
db3e571a
RD
8200 the returned font. See `wx.Window.SetWindowVariant` for more about
8201 this.
74a57fcd 8202 """
54f9ee45 8203 return _core_.Window_GetClassDefaultAttributes(*args, **kwargs)
74a57fcd 8204
e811c8ce 8205def DLG_PNT(win, point_or_x, y=None):
15afbcd0
RD
8206 """
8207 Convenience function for converting a Point or (x,y) in
8208 dialog units to pixel units.
8209 """
e811c8ce
RD
8210 if y is None:
8211 return win.ConvertDialogPointToPixels(point_or_x)
8212 else:
fd3f2efe 8213 return win.ConvertDialogPointToPixels(wx.Point(point_or_x, y))
e811c8ce
RD
8214
8215def DLG_SZE(win, size_width, height=None):
15afbcd0
RD
8216 """
8217 Convenience function for converting a Size or (w,h) in
8218 dialog units to pixel units.
8219 """
e811c8ce
RD
8220 if height is None:
8221 return win.ConvertDialogSizeToPixels(size_width)
8222 else:
fd3f2efe 8223 return win.ConvertDialogSizeToPixels(wx.Size(size_width, height))
e811c8ce
RD
8224
8225
8226def FindWindowById(*args, **kwargs):
15afbcd0
RD
8227 """
8228 FindWindowById(long id, Window parent=None) -> Window
8229
8230 Find the first window in the application with the given id. If parent
8231 is None, the search will start from all top-level frames and dialog
8232 boxes; if non-None, the search will be limited to the given window
8233 hierarchy. The search is recursive in both cases.
8234 """
54f9ee45 8235 return _core_.FindWindowById(*args, **kwargs)
e811c8ce
RD
8236
8237def FindWindowByName(*args, **kwargs):
15afbcd0
RD
8238 """
8239 FindWindowByName(String name, Window parent=None) -> Window
8240
8241 Find a window by its name (as given in a window constructor or Create
8242 function call). If parent is None, the search will start from all
8243 top-level frames and dialog boxes; if non-None, the search will be
8244 limited to the given window hierarchy. The search is recursive in both
8245 cases.
8246
8247 If no window with such name is found, wx.FindWindowByLabel is called.
8248 """
54f9ee45 8249 return _core_.FindWindowByName(*args, **kwargs)
e811c8ce
RD
8250
8251def FindWindowByLabel(*args, **kwargs):
15afbcd0
RD
8252 """
8253 FindWindowByLabel(String label, Window parent=None) -> Window
8254
8255 Find a window by its label. Depending on the type of window, the label
8256 may be a window title or panel item label. If parent is None, the
8257 search will start from all top-level frames and dialog boxes; if
8258 non-None, the search will be limited to the given window
8259 hierarchy. The search is recursive in both cases.
8260 """
54f9ee45 8261 return _core_.FindWindowByLabel(*args, **kwargs)
e811c8ce
RD
8262
8263def Window_FromHWND(*args, **kwargs):
4276dc52 8264 """Window_FromHWND(Window parent, unsigned long _hWnd) -> Window"""
54f9ee45 8265 return _core_.Window_FromHWND(*args, **kwargs)
e811c8ce
RD
8266#---------------------------------------------------------------------------
8267
8268class Validator(EvtHandler):
093d3ff1 8269 """Proxy of C++ Validator class"""
e811c8ce
RD
8270 def __repr__(self):
8271 return "<%s.%s; proxy of C++ wxValidator instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
8272 def __init__(self, *args, **kwargs):
a95a7133 8273 """__init__(self) -> Validator"""
54f9ee45 8274 newobj = _core_.new_Validator(*args, **kwargs)
d14a1e28
RD
8275 self.this = newobj.this
8276 self.thisown = 1
8277 del newobj.thisown
8278 self._setOORInfo(self)
e811c8ce
RD
8279
8280 def Clone(*args, **kwargs):
a95a7133 8281 """Clone(self) -> Validator"""
54f9ee45 8282 return _core_.Validator_Clone(*args, **kwargs)
e811c8ce
RD
8283
8284 def Validate(*args, **kwargs):
a95a7133 8285 """Validate(self, Window parent) -> bool"""
54f9ee45 8286 return _core_.Validator_Validate(*args, **kwargs)
e811c8ce
RD
8287
8288 def TransferToWindow(*args, **kwargs):
a95a7133 8289 """TransferToWindow(self) -> bool"""
54f9ee45 8290 return _core_.Validator_TransferToWindow(*args, **kwargs)
e811c8ce
RD
8291
8292 def TransferFromWindow(*args, **kwargs):
a95a7133 8293 """TransferFromWindow(self) -> bool"""
54f9ee45 8294 return _core_.Validator_TransferFromWindow(*args, **kwargs)
e811c8ce
RD
8295
8296 def GetWindow(*args, **kwargs):
a95a7133 8297 """GetWindow(self) -> Window"""
54f9ee45 8298 return _core_.Validator_GetWindow(*args, **kwargs)
e811c8ce
RD
8299
8300 def SetWindow(*args, **kwargs):
a95a7133 8301 """SetWindow(self, Window window)"""
54f9ee45 8302 return _core_.Validator_SetWindow(*args, **kwargs)
e811c8ce
RD
8303
8304 def IsSilent(*args, **kwargs):
66c033b4 8305 """IsSilent() -> bool"""
54f9ee45 8306 return _core_.Validator_IsSilent(*args, **kwargs)
e811c8ce
RD
8307
8308 IsSilent = staticmethod(IsSilent)
8309 def SetBellOnError(*args, **kwargs):
66c033b4 8310 """SetBellOnError(int doIt=True)"""
54f9ee45 8311 return _core_.Validator_SetBellOnError(*args, **kwargs)
e811c8ce
RD
8312
8313 SetBellOnError = staticmethod(SetBellOnError)
8314
8315class ValidatorPtr(Validator):
8316 def __init__(self, this):
8317 self.this = this
8318 if not hasattr(self,"thisown"): self.thisown = 0
8319 self.__class__ = Validator
54f9ee45 8320_core_.Validator_swigregister(ValidatorPtr)
e811c8ce
RD
8321
8322def Validator_IsSilent(*args, **kwargs):
8323 """Validator_IsSilent() -> bool"""
54f9ee45 8324 return _core_.Validator_IsSilent(*args, **kwargs)
e811c8ce
RD
8325
8326def Validator_SetBellOnError(*args, **kwargs):
8327 """Validator_SetBellOnError(int doIt=True)"""
54f9ee45 8328 return _core_.Validator_SetBellOnError(*args, **kwargs)
e811c8ce
RD
8329
8330class PyValidator(Validator):
093d3ff1 8331 """Proxy of C++ PyValidator class"""
e811c8ce
RD
8332 def __repr__(self):
8333 return "<%s.%s; proxy of C++ wxPyValidator instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
8334 def __init__(self, *args, **kwargs):
a95a7133 8335 """__init__(self) -> PyValidator"""
54f9ee45 8336 newobj = _core_.new_PyValidator(*args, **kwargs)
e811c8ce
RD
8337 self.this = newobj.this
8338 self.thisown = 1
8339 del newobj.thisown
8340
8341 self._setCallbackInfo(self, PyValidator, 1)
8342 self._setOORInfo(self)
8343
8344 def _setCallbackInfo(*args, **kwargs):
a95a7133 8345 """_setCallbackInfo(self, PyObject self, PyObject _class, int incref=True)"""
54f9ee45 8346 return _core_.PyValidator__setCallbackInfo(*args, **kwargs)
e811c8ce
RD
8347
8348
8349class PyValidatorPtr(PyValidator):
8350 def __init__(self, this):
8351 self.this = this
8352 if not hasattr(self,"thisown"): self.thisown = 0
8353 self.__class__ = PyValidator
54f9ee45 8354_core_.PyValidator_swigregister(PyValidatorPtr)
e811c8ce
RD
8355
8356#---------------------------------------------------------------------------
8357
8358class Menu(EvtHandler):
093d3ff1 8359 """Proxy of C++ Menu class"""
d14a1e28
RD
8360 def __repr__(self):
8361 return "<%s.%s; proxy of C++ wxMenu instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
e811c8ce 8362 def __init__(self, *args, **kwargs):
a95a7133 8363 """__init__(self, String title=EmptyString, long style=0) -> Menu"""
54f9ee45 8364 newobj = _core_.new_Menu(*args, **kwargs)
e811c8ce
RD
8365 self.this = newobj.this
8366 self.thisown = 1
8367 del newobj.thisown
8368 self._setOORInfo(self)
8369
8370 def Append(*args, **kwargs):
a95a7133 8371 """Append(self, int id, String text, String help=EmptyString, int kind=ITEM_NORMAL) -> MenuItem"""
54f9ee45 8372 return _core_.Menu_Append(*args, **kwargs)
e811c8ce
RD
8373
8374 def AppendSeparator(*args, **kwargs):
a95a7133 8375 """AppendSeparator(self) -> MenuItem"""
54f9ee45 8376 return _core_.Menu_AppendSeparator(*args, **kwargs)
e811c8ce
RD
8377
8378 def AppendCheckItem(*args, **kwargs):
a95a7133 8379 """AppendCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
54f9ee45 8380 return _core_.Menu_AppendCheckItem(*args, **kwargs)
e811c8ce
RD
8381
8382 def AppendRadioItem(*args, **kwargs):
a95a7133 8383 """AppendRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
54f9ee45 8384 return _core_.Menu_AppendRadioItem(*args, **kwargs)
e811c8ce
RD
8385
8386 def AppendMenu(*args, **kwargs):
a95a7133 8387 """AppendMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
54f9ee45 8388 return _core_.Menu_AppendMenu(*args, **kwargs)
e811c8ce
RD
8389
8390 def AppendItem(*args, **kwargs):
a95a7133 8391 """AppendItem(self, MenuItem item) -> MenuItem"""
54f9ee45 8392 return _core_.Menu_AppendItem(*args, **kwargs)
e811c8ce
RD
8393
8394 def Break(*args, **kwargs):
a95a7133 8395 """Break(self)"""
54f9ee45 8396 return _core_.Menu_Break(*args, **kwargs)
e811c8ce
RD
8397
8398 def InsertItem(*args, **kwargs):
a95a7133 8399 """InsertItem(self, size_t pos, MenuItem item) -> MenuItem"""
54f9ee45 8400 return _core_.Menu_InsertItem(*args, **kwargs)
e811c8ce
RD
8401
8402 def Insert(*args, **kwargs):
0df68c9f 8403 """
a95a7133 8404 Insert(self, size_t pos, int id, String text, String help=EmptyString,
a41e16b6 8405 int kind=ITEM_NORMAL) -> MenuItem
0df68c9f 8406 """
54f9ee45 8407 return _core_.Menu_Insert(*args, **kwargs)
e811c8ce
RD
8408
8409 def InsertSeparator(*args, **kwargs):
a95a7133 8410 """InsertSeparator(self, size_t pos) -> MenuItem"""
54f9ee45 8411 return _core_.Menu_InsertSeparator(*args, **kwargs)
e811c8ce
RD
8412
8413 def InsertCheckItem(*args, **kwargs):
a95a7133 8414 """InsertCheckItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
54f9ee45 8415 return _core_.Menu_InsertCheckItem(*args, **kwargs)
e811c8ce
RD
8416
8417 def InsertRadioItem(*args, **kwargs):
a95a7133 8418 """InsertRadioItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
54f9ee45 8419 return _core_.Menu_InsertRadioItem(*args, **kwargs)
e811c8ce
RD
8420
8421 def InsertMenu(*args, **kwargs):
a95a7133 8422 """InsertMenu(self, size_t pos, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
54f9ee45 8423 return _core_.Menu_InsertMenu(*args, **kwargs)
e811c8ce
RD
8424
8425 def PrependItem(*args, **kwargs):
a95a7133 8426 """PrependItem(self, MenuItem item) -> MenuItem"""
54f9ee45 8427 return _core_.Menu_PrependItem(*args, **kwargs)
e811c8ce
RD
8428
8429 def Prepend(*args, **kwargs):
a95a7133 8430 """Prepend(self, int id, String text, String help=EmptyString, int kind=ITEM_NORMAL) -> MenuItem"""
54f9ee45 8431 return _core_.Menu_Prepend(*args, **kwargs)
e811c8ce
RD
8432
8433 def PrependSeparator(*args, **kwargs):
a95a7133 8434 """PrependSeparator(self) -> MenuItem"""
54f9ee45 8435 return _core_.Menu_PrependSeparator(*args, **kwargs)
e811c8ce
RD
8436
8437 def PrependCheckItem(*args, **kwargs):
a95a7133 8438 """PrependCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
54f9ee45 8439 return _core_.Menu_PrependCheckItem(*args, **kwargs)
e811c8ce
RD
8440
8441 def PrependRadioItem(*args, **kwargs):
a95a7133 8442 """PrependRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
54f9ee45 8443 return _core_.Menu_PrependRadioItem(*args, **kwargs)
e811c8ce
RD
8444
8445 def PrependMenu(*args, **kwargs):
a95a7133 8446 """PrependMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
54f9ee45 8447 return _core_.Menu_PrependMenu(*args, **kwargs)
e811c8ce
RD
8448
8449 def Remove(*args, **kwargs):
a95a7133 8450 """Remove(self, int id) -> MenuItem"""
54f9ee45 8451 return _core_.Menu_Remove(*args, **kwargs)
e811c8ce
RD
8452
8453 def RemoveItem(*args, **kwargs):
a95a7133 8454 """RemoveItem(self, MenuItem item) -> MenuItem"""
54f9ee45 8455 return _core_.Menu_RemoveItem(*args, **kwargs)
e811c8ce
RD
8456
8457 def Delete(*args, **kwargs):
a95a7133 8458 """Delete(self, int id) -> bool"""
54f9ee45 8459 return _core_.Menu_Delete(*args, **kwargs)
e811c8ce
RD
8460
8461 def DeleteItem(*args, **kwargs):
a95a7133 8462 """DeleteItem(self, MenuItem item) -> bool"""
54f9ee45 8463 return _core_.Menu_DeleteItem(*args, **kwargs)
e811c8ce
RD
8464
8465 def Destroy(*args, **kwargs):
0df68c9f 8466 """
a95a7133 8467 Destroy(self)
e811c8ce 8468
0df68c9f
RD
8469 Deletes the C++ object this Python object is a proxy for.
8470 """
54f9ee45 8471 return _core_.Menu_Destroy(*args, **kwargs)
e811c8ce
RD
8472
8473 def DestroyId(*args, **kwargs):
0df68c9f 8474 """
a95a7133 8475 DestroyId(self, int id) -> bool
e811c8ce 8476
0df68c9f
RD
8477 Deletes the C++ object this Python object is a proxy for.
8478 """
54f9ee45 8479 return _core_.Menu_DestroyId(*args, **kwargs)
e811c8ce
RD
8480
8481 def DestroyItem(*args, **kwargs):
0df68c9f 8482 """
a95a7133 8483 DestroyItem(self, MenuItem item) -> bool
e811c8ce 8484
0df68c9f
RD
8485 Deletes the C++ object this Python object is a proxy for.
8486 """
54f9ee45 8487 return _core_.Menu_DestroyItem(*args, **kwargs)
e811c8ce
RD
8488
8489 def GetMenuItemCount(*args, **kwargs):
a95a7133 8490 """GetMenuItemCount(self) -> size_t"""
54f9ee45 8491 return _core_.Menu_GetMenuItemCount(*args, **kwargs)
e811c8ce
RD
8492
8493 def GetMenuItems(*args, **kwargs):
a95a7133 8494 """GetMenuItems(self) -> PyObject"""
54f9ee45 8495 return _core_.Menu_GetMenuItems(*args, **kwargs)
e811c8ce
RD
8496
8497 def FindItem(*args, **kwargs):
a95a7133 8498 """FindItem(self, String item) -> int"""
54f9ee45 8499 return _core_.Menu_FindItem(*args, **kwargs)
e811c8ce
RD
8500
8501 def FindItemById(*args, **kwargs):
a95a7133 8502 """FindItemById(self, int id) -> MenuItem"""
54f9ee45 8503 return _core_.Menu_FindItemById(*args, **kwargs)
e811c8ce
RD
8504
8505 def FindItemByPosition(*args, **kwargs):
a95a7133 8506 """FindItemByPosition(self, size_t position) -> MenuItem"""
54f9ee45 8507 return _core_.Menu_FindItemByPosition(*args, **kwargs)
e811c8ce
RD
8508
8509 def Enable(*args, **kwargs):
a95a7133 8510 """Enable(self, int id, bool enable)"""
54f9ee45 8511 return _core_.Menu_Enable(*args, **kwargs)
e811c8ce
RD
8512
8513 def IsEnabled(*args, **kwargs):
a95a7133 8514 """IsEnabled(self, int id) -> bool"""
54f9ee45 8515 return _core_.Menu_IsEnabled(*args, **kwargs)
e811c8ce
RD
8516
8517 def Check(*args, **kwargs):
a95a7133 8518 """Check(self, int id, bool check)"""
54f9ee45 8519 return _core_.Menu_Check(*args, **kwargs)
e811c8ce
RD
8520
8521 def IsChecked(*args, **kwargs):
a95a7133 8522 """IsChecked(self, int id) -> bool"""
54f9ee45 8523 return _core_.Menu_IsChecked(*args, **kwargs)
e811c8ce
RD
8524
8525 def SetLabel(*args, **kwargs):
a95a7133 8526 """SetLabel(self, int id, String label)"""
54f9ee45 8527 return _core_.Menu_SetLabel(*args, **kwargs)
e811c8ce
RD
8528
8529 def GetLabel(*args, **kwargs):
a95a7133 8530 """GetLabel(self, int id) -> String"""
54f9ee45 8531 return _core_.Menu_GetLabel(*args, **kwargs)
e811c8ce
RD
8532
8533 def SetHelpString(*args, **kwargs):
a95a7133 8534 """SetHelpString(self, int id, String helpString)"""
54f9ee45 8535 return _core_.Menu_SetHelpString(*args, **kwargs)
e811c8ce
RD
8536
8537 def GetHelpString(*args, **kwargs):
a95a7133 8538 """GetHelpString(self, int id) -> String"""
54f9ee45 8539 return _core_.Menu_GetHelpString(*args, **kwargs)
e811c8ce
RD
8540
8541 def SetTitle(*args, **kwargs):
a95a7133 8542 """SetTitle(self, String title)"""
54f9ee45 8543 return _core_.Menu_SetTitle(*args, **kwargs)
e811c8ce
RD
8544
8545 def GetTitle(*args, **kwargs):
a95a7133 8546 """GetTitle(self) -> String"""
54f9ee45 8547 return _core_.Menu_GetTitle(*args, **kwargs)
e811c8ce
RD
8548
8549 def SetEventHandler(*args, **kwargs):
a95a7133 8550 """SetEventHandler(self, EvtHandler handler)"""
54f9ee45 8551 return _core_.Menu_SetEventHandler(*args, **kwargs)
e811c8ce
RD
8552
8553 def GetEventHandler(*args, **kwargs):
a95a7133 8554 """GetEventHandler(self) -> EvtHandler"""
54f9ee45 8555 return _core_.Menu_GetEventHandler(*args, **kwargs)
e811c8ce
RD
8556
8557 def SetInvokingWindow(*args, **kwargs):
a95a7133 8558 """SetInvokingWindow(self, Window win)"""
54f9ee45 8559 return _core_.Menu_SetInvokingWindow(*args, **kwargs)
e811c8ce
RD
8560
8561 def GetInvokingWindow(*args, **kwargs):
a95a7133 8562 """GetInvokingWindow(self) -> Window"""
54f9ee45 8563 return _core_.Menu_GetInvokingWindow(*args, **kwargs)
e811c8ce
RD
8564
8565 def GetStyle(*args, **kwargs):
a95a7133 8566 """GetStyle(self) -> long"""
54f9ee45 8567 return _core_.Menu_GetStyle(*args, **kwargs)
e811c8ce
RD
8568
8569 def UpdateUI(*args, **kwargs):
a95a7133 8570 """UpdateUI(self, EvtHandler source=None)"""
54f9ee45 8571 return _core_.Menu_UpdateUI(*args, **kwargs)
e811c8ce
RD
8572
8573 def GetMenuBar(*args, **kwargs):
a95a7133 8574 """GetMenuBar(self) -> MenuBar"""
54f9ee45 8575 return _core_.Menu_GetMenuBar(*args, **kwargs)
e811c8ce
RD
8576
8577 def Attach(*args, **kwargs):
a95a7133 8578 """Attach(self, wxMenuBarBase menubar)"""
54f9ee45 8579 return _core_.Menu_Attach(*args, **kwargs)
e811c8ce
RD
8580
8581 def Detach(*args, **kwargs):
a95a7133 8582 """Detach(self)"""
54f9ee45 8583 return _core_.Menu_Detach(*args, **kwargs)
e811c8ce
RD
8584
8585 def IsAttached(*args, **kwargs):
a95a7133 8586 """IsAttached(self) -> bool"""
54f9ee45 8587 return _core_.Menu_IsAttached(*args, **kwargs)
e811c8ce
RD
8588
8589 def SetParent(*args, **kwargs):
a95a7133 8590 """SetParent(self, Menu parent)"""
54f9ee45 8591 return _core_.Menu_SetParent(*args, **kwargs)
e811c8ce
RD
8592
8593 def GetParent(*args, **kwargs):
a95a7133 8594 """GetParent(self) -> Menu"""
54f9ee45 8595 return _core_.Menu_GetParent(*args, **kwargs)
e811c8ce 8596
d14a1e28
RD
8597
8598class MenuPtr(Menu):
8599 def __init__(self, this):
8600 self.this = this
8601 if not hasattr(self,"thisown"): self.thisown = 0
8602 self.__class__ = Menu
54f9ee45 8603_core_.Menu_swigregister(MenuPtr)
d14a1e28
RD
8604DefaultValidator = cvar.DefaultValidator
8605
8606#---------------------------------------------------------------------------
8607
8608class MenuBar(Window):
093d3ff1 8609 """Proxy of C++ MenuBar class"""
e811c8ce
RD
8610 def __repr__(self):
8611 return "<%s.%s; proxy of C++ wxMenuBar instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 8612 def __init__(self, *args, **kwargs):
a95a7133 8613 """__init__(self, long style=0) -> MenuBar"""
54f9ee45 8614 newobj = _core_.new_MenuBar(*args, **kwargs)
d14a1e28
RD
8615 self.this = newobj.this
8616 self.thisown = 1
8617 del newobj.thisown
8618 self._setOORInfo(self)
e811c8ce
RD
8619
8620 def Append(*args, **kwargs):
a95a7133 8621 """Append(self, Menu menu, String title) -> bool"""
54f9ee45 8622 return _core_.MenuBar_Append(*args, **kwargs)
e811c8ce
RD
8623
8624 def Insert(*args, **kwargs):
a95a7133 8625 """Insert(self, size_t pos, Menu menu, String title) -> bool"""
54f9ee45 8626 return _core_.MenuBar_Insert(*args, **kwargs)
e811c8ce
RD
8627
8628 def GetMenuCount(*args, **kwargs):
a95a7133 8629 """GetMenuCount(self) -> size_t"""
54f9ee45 8630 return _core_.MenuBar_GetMenuCount(*args, **kwargs)
e811c8ce
RD
8631
8632 def GetMenu(*args, **kwargs):
a95a7133 8633 """GetMenu(self, size_t pos) -> Menu"""
54f9ee45 8634 return _core_.MenuBar_GetMenu(*args, **kwargs)
e811c8ce
RD
8635
8636 def Replace(*args, **kwargs):
a95a7133 8637 """Replace(self, size_t pos, Menu menu, String title) -> Menu"""
54f9ee45 8638 return _core_.MenuBar_Replace(*args, **kwargs)
e811c8ce
RD
8639
8640 def Remove(*args, **kwargs):
a95a7133 8641 """Remove(self, size_t pos) -> Menu"""
54f9ee45 8642 return _core_.MenuBar_Remove(*args, **kwargs)
e811c8ce
RD
8643
8644 def EnableTop(*args, **kwargs):
a95a7133 8645 """EnableTop(self, size_t pos, bool enable)"""
54f9ee45 8646 return _core_.MenuBar_EnableTop(*args, **kwargs)
e811c8ce
RD
8647
8648 def IsEnabledTop(*args, **kwargs):
a95a7133 8649 """IsEnabledTop(self, size_t pos) -> bool"""
54f9ee45 8650 return _core_.MenuBar_IsEnabledTop(*args, **kwargs)
e811c8ce
RD
8651
8652 def SetLabelTop(*args, **kwargs):
a95a7133 8653 """SetLabelTop(self, size_t pos, String label)"""
54f9ee45 8654 return _core_.MenuBar_SetLabelTop(*args, **kwargs)
e811c8ce
RD
8655
8656 def GetLabelTop(*args, **kwargs):
a95a7133 8657 """GetLabelTop(self, size_t pos) -> String"""
54f9ee45 8658 return _core_.MenuBar_GetLabelTop(*args, **kwargs)
e811c8ce
RD
8659
8660 def FindMenuItem(*args, **kwargs):
a95a7133 8661 """FindMenuItem(self, String menu, String item) -> int"""
54f9ee45 8662 return _core_.MenuBar_FindMenuItem(*args, **kwargs)
e811c8ce
RD
8663
8664 def FindItemById(*args, **kwargs):
a95a7133 8665 """FindItemById(self, int id) -> MenuItem"""
54f9ee45 8666 return _core_.MenuBar_FindItemById(*args, **kwargs)
e811c8ce
RD
8667
8668 def FindMenu(*args, **kwargs):
a95a7133 8669 """FindMenu(self, String title) -> int"""
54f9ee45 8670 return _core_.MenuBar_FindMenu(*args, **kwargs)
e811c8ce
RD
8671
8672 def Enable(*args, **kwargs):
a95a7133 8673 """Enable(self, int id, bool enable)"""
54f9ee45 8674 return _core_.MenuBar_Enable(*args, **kwargs)
e811c8ce
RD
8675
8676 def Check(*args, **kwargs):
a95a7133 8677 """Check(self, int id, bool check)"""
54f9ee45 8678 return _core_.MenuBar_Check(*args, **kwargs)
e811c8ce
RD
8679
8680 def IsChecked(*args, **kwargs):
a95a7133 8681 """IsChecked(self, int id) -> bool"""
54f9ee45 8682 return _core_.MenuBar_IsChecked(*args, **kwargs)
e811c8ce
RD
8683
8684 def IsEnabled(*args, **kwargs):
a95a7133 8685 """IsEnabled(self, int id) -> bool"""
54f9ee45 8686 return _core_.MenuBar_IsEnabled(*args, **kwargs)
e811c8ce
RD
8687
8688 def SetLabel(*args, **kwargs):
a95a7133 8689 """SetLabel(self, int id, String label)"""
54f9ee45 8690 return _core_.MenuBar_SetLabel(*args, **kwargs)
e811c8ce
RD
8691
8692 def GetLabel(*args, **kwargs):
a95a7133 8693 """GetLabel(self, int id) -> String"""
54f9ee45 8694 return _core_.MenuBar_GetLabel(*args, **kwargs)
e811c8ce
RD
8695
8696 def SetHelpString(*args, **kwargs):
a95a7133 8697 """SetHelpString(self, int id, String helpString)"""
54f9ee45 8698 return _core_.MenuBar_SetHelpString(*args, **kwargs)
e811c8ce
RD
8699
8700 def GetHelpString(*args, **kwargs):
a95a7133 8701 """GetHelpString(self, int id) -> String"""
54f9ee45 8702 return _core_.MenuBar_GetHelpString(*args, **kwargs)
e811c8ce
RD
8703
8704 def GetFrame(*args, **kwargs):
a95a7133 8705 """GetFrame(self) -> wxFrame"""
54f9ee45 8706 return _core_.MenuBar_GetFrame(*args, **kwargs)
e811c8ce
RD
8707
8708 def IsAttached(*args, **kwargs):
a95a7133 8709 """IsAttached(self) -> bool"""
54f9ee45 8710 return _core_.MenuBar_IsAttached(*args, **kwargs)
e811c8ce
RD
8711
8712 def Attach(*args, **kwargs):
a95a7133 8713 """Attach(self, wxFrame frame)"""
54f9ee45 8714 return _core_.MenuBar_Attach(*args, **kwargs)
e811c8ce
RD
8715
8716 def Detach(*args, **kwargs):
a95a7133 8717 """Detach(self)"""
54f9ee45 8718 return _core_.MenuBar_Detach(*args, **kwargs)
e811c8ce 8719
d14a1e28
RD
8720
8721class MenuBarPtr(MenuBar):
8722 def __init__(self, this):
8723 self.this = this
8724 if not hasattr(self,"thisown"): self.thisown = 0
8725 self.__class__ = MenuBar
54f9ee45 8726_core_.MenuBar_swigregister(MenuBarPtr)
d14a1e28
RD
8727
8728#---------------------------------------------------------------------------
8729
8730class MenuItem(Object):
093d3ff1 8731 """Proxy of C++ MenuItem class"""
e811c8ce
RD
8732 def __repr__(self):
8733 return "<%s.%s; proxy of C++ wxMenuItem instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 8734 def __init__(self, *args, **kwargs):
0df68c9f 8735 """
a95a7133 8736 __init__(self, Menu parentMenu=None, int id=ID_ANY, String text=EmptyString,
196addbf
RD
8737 String help=EmptyString, int kind=ITEM_NORMAL,
8738 Menu subMenu=None) -> MenuItem
0df68c9f 8739 """
54f9ee45 8740 newobj = _core_.new_MenuItem(*args, **kwargs)
d14a1e28
RD
8741 self.this = newobj.this
8742 self.thisown = 1
8743 del newobj.thisown
e811c8ce 8744 def GetMenu(*args, **kwargs):
a95a7133 8745 """GetMenu(self) -> Menu"""
54f9ee45 8746 return _core_.MenuItem_GetMenu(*args, **kwargs)
e811c8ce
RD
8747
8748 def SetMenu(*args, **kwargs):
a95a7133 8749 """SetMenu(self, Menu menu)"""
54f9ee45 8750 return _core_.MenuItem_SetMenu(*args, **kwargs)
e811c8ce
RD
8751
8752 def SetId(*args, **kwargs):
a95a7133 8753 """SetId(self, int id)"""
54f9ee45 8754 return _core_.MenuItem_SetId(*args, **kwargs)
e811c8ce
RD
8755
8756 def GetId(*args, **kwargs):
a95a7133 8757 """GetId(self) -> int"""
54f9ee45 8758 return _core_.MenuItem_GetId(*args, **kwargs)
e811c8ce
RD
8759
8760 def IsSeparator(*args, **kwargs):
a95a7133 8761 """IsSeparator(self) -> bool"""
54f9ee45 8762 return _core_.MenuItem_IsSeparator(*args, **kwargs)
e811c8ce
RD
8763
8764 def SetText(*args, **kwargs):
a95a7133 8765 """SetText(self, String str)"""
54f9ee45 8766 return _core_.MenuItem_SetText(*args, **kwargs)
e811c8ce
RD
8767
8768 def GetLabel(*args, **kwargs):
a95a7133 8769 """GetLabel(self) -> String"""
54f9ee45 8770 return _core_.MenuItem_GetLabel(*args, **kwargs)
e811c8ce
RD
8771
8772 def GetText(*args, **kwargs):
a95a7133 8773 """GetText(self) -> String"""
54f9ee45 8774 return _core_.MenuItem_GetText(*args, **kwargs)
e811c8ce
RD
8775
8776 def GetLabelFromText(*args, **kwargs):
66c033b4 8777 """GetLabelFromText(String text) -> String"""
54f9ee45 8778 return _core_.MenuItem_GetLabelFromText(*args, **kwargs)
e811c8ce
RD
8779
8780 GetLabelFromText = staticmethod(GetLabelFromText)
8781 def GetKind(*args, **kwargs):
a95a7133 8782 """GetKind(self) -> int"""
54f9ee45 8783 return _core_.MenuItem_GetKind(*args, **kwargs)
e811c8ce 8784
a95a7133
RD
8785 def SetKind(*args, **kwargs):
8786 """SetKind(self, int kind)"""
54f9ee45 8787 return _core_.MenuItem_SetKind(*args, **kwargs)
a95a7133 8788
e811c8ce 8789 def SetCheckable(*args, **kwargs):
a95a7133 8790 """SetCheckable(self, bool checkable)"""
54f9ee45 8791 return _core_.MenuItem_SetCheckable(*args, **kwargs)
e811c8ce
RD
8792
8793 def IsCheckable(*args, **kwargs):
a95a7133 8794 """IsCheckable(self) -> bool"""
54f9ee45 8795 return _core_.MenuItem_IsCheckable(*args, **kwargs)
e811c8ce
RD
8796
8797 def IsSubMenu(*args, **kwargs):
a95a7133 8798 """IsSubMenu(self) -> bool"""
54f9ee45 8799 return _core_.MenuItem_IsSubMenu(*args, **kwargs)
e811c8ce
RD
8800
8801 def SetSubMenu(*args, **kwargs):
a95a7133 8802 """SetSubMenu(self, Menu menu)"""
54f9ee45 8803 return _core_.MenuItem_SetSubMenu(*args, **kwargs)
e811c8ce
RD
8804
8805 def GetSubMenu(*args, **kwargs):
a95a7133 8806 """GetSubMenu(self) -> Menu"""
54f9ee45 8807 return _core_.MenuItem_GetSubMenu(*args, **kwargs)
e811c8ce
RD
8808
8809 def Enable(*args, **kwargs):
a95a7133 8810 """Enable(self, bool enable=True)"""
54f9ee45 8811 return _core_.MenuItem_Enable(*args, **kwargs)
e811c8ce
RD
8812
8813 def IsEnabled(*args, **kwargs):
a95a7133 8814 """IsEnabled(self) -> bool"""
54f9ee45 8815 return _core_.MenuItem_IsEnabled(*args, **kwargs)
e811c8ce
RD
8816
8817 def Check(*args, **kwargs):
a95a7133 8818 """Check(self, bool check=True)"""
54f9ee45 8819 return _core_.MenuItem_Check(*args, **kwargs)
e811c8ce
RD
8820
8821 def IsChecked(*args, **kwargs):
a95a7133 8822 """IsChecked(self) -> bool"""
54f9ee45 8823 return _core_.MenuItem_IsChecked(*args, **kwargs)
e811c8ce
RD
8824
8825 def Toggle(*args, **kwargs):
a95a7133 8826 """Toggle(self)"""
54f9ee45 8827 return _core_.MenuItem_Toggle(*args, **kwargs)
e811c8ce
RD
8828
8829 def SetHelp(*args, **kwargs):
a95a7133 8830 """SetHelp(self, String str)"""
54f9ee45 8831 return _core_.MenuItem_SetHelp(*args, **kwargs)
e811c8ce
RD
8832
8833 def GetHelp(*args, **kwargs):
a95a7133 8834 """GetHelp(self) -> String"""
54f9ee45 8835 return _core_.MenuItem_GetHelp(*args, **kwargs)
e811c8ce
RD
8836
8837 def GetAccel(*args, **kwargs):
a95a7133 8838 """GetAccel(self) -> AcceleratorEntry"""
54f9ee45 8839 return _core_.MenuItem_GetAccel(*args, **kwargs)
e811c8ce
RD
8840
8841 def SetAccel(*args, **kwargs):
a95a7133 8842 """SetAccel(self, AcceleratorEntry accel)"""
54f9ee45 8843 return _core_.MenuItem_SetAccel(*args, **kwargs)
e811c8ce 8844
c1280d1e
RD
8845 def SetFont(*args, **kwargs):
8846 """SetFont(self, Font font)"""
8847 return _core_.MenuItem_SetFont(*args, **kwargs)
8848
8849 def GetFont(*args, **kwargs):
8850 """GetFont(self) -> Font"""
8851 return _core_.MenuItem_GetFont(*args, **kwargs)
8852
8853 def SetTextColour(*args, **kwargs):
8854 """SetTextColour(self, Colour colText)"""
8855 return _core_.MenuItem_SetTextColour(*args, **kwargs)
8856
8857 def GetTextColour(*args, **kwargs):
8858 """GetTextColour(self) -> Colour"""
8859 return _core_.MenuItem_GetTextColour(*args, **kwargs)
8860
8861 def SetBackgroundColour(*args, **kwargs):
8862 """SetBackgroundColour(self, Colour colBack)"""
8863 return _core_.MenuItem_SetBackgroundColour(*args, **kwargs)
8864
8865 def GetBackgroundColour(*args, **kwargs):
8866 """GetBackgroundColour(self) -> Colour"""
8867 return _core_.MenuItem_GetBackgroundColour(*args, **kwargs)
8868
8869 def SetBitmaps(*args, **kwargs):
8870 """SetBitmaps(self, Bitmap bmpChecked, Bitmap bmpUnchecked=wxNullBitmap)"""
8871 return _core_.MenuItem_SetBitmaps(*args, **kwargs)
8872
8873 def SetDisabledBitmap(*args, **kwargs):
8874 """SetDisabledBitmap(self, Bitmap bmpDisabled)"""
8875 return _core_.MenuItem_SetDisabledBitmap(*args, **kwargs)
8876
8877 def GetDisabledBitmap(*args, **kwargs):
8878 """GetDisabledBitmap(self) -> Bitmap"""
8879 return _core_.MenuItem_GetDisabledBitmap(*args, **kwargs)
8880
8881 def SetMarginWidth(*args, **kwargs):
8882 """SetMarginWidth(self, int nWidth)"""
8883 return _core_.MenuItem_SetMarginWidth(*args, **kwargs)
8884
8885 def GetMarginWidth(*args, **kwargs):
8886 """GetMarginWidth(self) -> int"""
8887 return _core_.MenuItem_GetMarginWidth(*args, **kwargs)
8888
e811c8ce 8889 def GetDefaultMarginWidth(*args, **kwargs):
66c033b4 8890 """GetDefaultMarginWidth() -> int"""
54f9ee45 8891 return _core_.MenuItem_GetDefaultMarginWidth(*args, **kwargs)
e811c8ce
RD
8892
8893 GetDefaultMarginWidth = staticmethod(GetDefaultMarginWidth)
c1280d1e
RD
8894 def IsOwnerDrawn(*args, **kwargs):
8895 """IsOwnerDrawn(self) -> bool"""
8896 return _core_.MenuItem_IsOwnerDrawn(*args, **kwargs)
8897
8898 def SetOwnerDrawn(*args, **kwargs):
8899 """SetOwnerDrawn(self, bool ownerDrawn=True)"""
8900 return _core_.MenuItem_SetOwnerDrawn(*args, **kwargs)
8901
8902 def ResetOwnerDrawn(*args, **kwargs):
8903 """ResetOwnerDrawn(self)"""
8904 return _core_.MenuItem_ResetOwnerDrawn(*args, **kwargs)
8905
e811c8ce 8906 def SetBitmap(*args, **kwargs):
a95a7133 8907 """SetBitmap(self, Bitmap bitmap)"""
54f9ee45 8908 return _core_.MenuItem_SetBitmap(*args, **kwargs)
e811c8ce
RD
8909
8910 def GetBitmap(*args, **kwargs):
a95a7133 8911 """GetBitmap(self) -> Bitmap"""
54f9ee45 8912 return _core_.MenuItem_GetBitmap(*args, **kwargs)
e811c8ce 8913
d14a1e28
RD
8914
8915class MenuItemPtr(MenuItem):
8916 def __init__(self, this):
8917 self.this = this
8918 if not hasattr(self,"thisown"): self.thisown = 0
8919 self.__class__ = MenuItem
54f9ee45 8920_core_.MenuItem_swigregister(MenuItemPtr)
d14a1e28 8921
e811c8ce 8922def MenuItem_GetLabelFromText(*args, **kwargs):
196addbf 8923 """MenuItem_GetLabelFromText(String text) -> String"""
54f9ee45 8924 return _core_.MenuItem_GetLabelFromText(*args, **kwargs)
d14a1e28 8925
e811c8ce
RD
8926def MenuItem_GetDefaultMarginWidth(*args, **kwargs):
8927 """MenuItem_GetDefaultMarginWidth() -> int"""
54f9ee45 8928 return _core_.MenuItem_GetDefaultMarginWidth(*args, **kwargs)
d14a1e28
RD
8929
8930#---------------------------------------------------------------------------
8931
8932class Control(Window):
15afbcd0
RD
8933 """
8934 This is the base class for a control or 'widget'.
8935
41e2b43e
RD
8936 A control is generally a small window which processes user input
8937 and/or displays one or more item of data.
15afbcd0 8938 """
e811c8ce
RD
8939 def __repr__(self):
8940 return "<%s.%s; proxy of C++ wxControl instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 8941 def __init__(self, *args, **kwargs):
0df68c9f 8942 """
248ed943
RD
8943 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
8944 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
b2dc1044 8945 String name=ControlNameStr) -> Control
15afbcd0 8946
41e2b43e
RD
8947 Create a Control. Normally you should only call this from a subclass'
8948 __init__ as a plain old wx.Control is not very useful.
0df68c9f 8949 """
54f9ee45 8950 newobj = _core_.new_Control(*args, **kwargs)
d14a1e28
RD
8951 self.this = newobj.this
8952 self.thisown = 1
8953 del newobj.thisown
8954 self._setOORInfo(self)
e811c8ce
RD
8955
8956 def Create(*args, **kwargs):
0df68c9f 8957 """
248ed943
RD
8958 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
8959 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
b2dc1044 8960 String name=ControlNameStr) -> bool
15afbcd0
RD
8961
8962 Do the 2nd phase and create the GUI control.
0df68c9f 8963 """
54f9ee45 8964 return _core_.Control_Create(*args, **kwargs)
e811c8ce
RD
8965
8966 def Command(*args, **kwargs):
15afbcd0 8967 """
a95a7133 8968 Command(self, CommandEvent event)
15afbcd0 8969
41e2b43e
RD
8970 Simulates the effect of the user issuing a command to the item.
8971
8972 :see: `wx.CommandEvent`
8973
15afbcd0 8974 """
54f9ee45 8975 return _core_.Control_Command(*args, **kwargs)
e811c8ce
RD
8976
8977 def GetLabel(*args, **kwargs):
15afbcd0 8978 """
a95a7133 8979 GetLabel(self) -> String
15afbcd0
RD
8980
8981 Return a control's text.
8982 """
54f9ee45 8983 return _core_.Control_GetLabel(*args, **kwargs)
e811c8ce
RD
8984
8985 def SetLabel(*args, **kwargs):
15afbcd0 8986 """
a95a7133 8987 SetLabel(self, String label)
15afbcd0
RD
8988
8989 Sets the item's text.
8990 """
54f9ee45 8991 return _core_.Control_SetLabel(*args, **kwargs)
e811c8ce 8992
74a57fcd 8993 def GetClassDefaultAttributes(*args, **kwargs):
110da5b0
RD
8994 """
8995 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
8996
8997 Get the default attributes for this class. This is useful if you want
8998 to use the same font or colour in your own control as in a standard
8999 control -- which is a much better idea than hard coding specific
9000 colours or fonts which might look completely out of place on the
9001 user's system, especially if it uses themes.
9002
9003 The variant parameter is only relevant under Mac currently and is
9004 ignore under other platforms. Under Mac, it will change the size of
9005 the returned font. See `wx.Window.SetWindowVariant` for more about
9006 this.
9007 """
54f9ee45 9008 return _core_.Control_GetClassDefaultAttributes(*args, **kwargs)
74a57fcd
RD
9009
9010 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
d14a1e28
RD
9011
9012class ControlPtr(Control):
9013 def __init__(self, this):
9014 self.this = this
9015 if not hasattr(self,"thisown"): self.thisown = 0
9016 self.__class__ = Control
54f9ee45 9017_core_.Control_swigregister(ControlPtr)
b2dc1044 9018ControlNameStr = cvar.ControlNameStr
d14a1e28
RD
9019
9020def PreControl(*args, **kwargs):
15afbcd0
RD
9021 """
9022 PreControl() -> Control
9023
9024 Precreate a Control control for 2-phase creation
9025 """
54f9ee45 9026 val = _core_.new_PreControl(*args, **kwargs)
d14a1e28
RD
9027 val.thisown = 1
9028 return val
9029
74a57fcd 9030def Control_GetClassDefaultAttributes(*args, **kwargs):
110da5b0
RD
9031 """
9032 Control_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
9033
9034 Get the default attributes for this class. This is useful if you want
9035 to use the same font or colour in your own control as in a standard
9036 control -- which is a much better idea than hard coding specific
9037 colours or fonts which might look completely out of place on the
9038 user's system, especially if it uses themes.
9039
9040 The variant parameter is only relevant under Mac currently and is
9041 ignore under other platforms. Under Mac, it will change the size of
9042 the returned font. See `wx.Window.SetWindowVariant` for more about
9043 this.
9044 """
54f9ee45 9045 return _core_.Control_GetClassDefaultAttributes(*args, **kwargs)
74a57fcd 9046
d14a1e28
RD
9047#---------------------------------------------------------------------------
9048
9049class ItemContainer(object):
15afbcd0 9050 """
53aa7709
RD
9051 The wx.ItemContainer class defines an interface which is implemented
9052 by all controls which have string subitems, each of which may be
9053 selected, such as `wx.ListBox`, `wx.CheckListBox`, `wx.Choice` as well
9054 as `wx.ComboBox` which implements an extended interface deriving from
41e2b43e 9055 this one.
15afbcd0 9056
41e2b43e
RD
9057 It defines the methods for accessing the control's items and although
9058 each of the derived classes implements them differently, they still
9059 all conform to the same interface.
15afbcd0 9060
41e2b43e
RD
9061 The items in a wx.ItemContainer have (non empty) string labels and,
9062 optionally, client data associated with them.
15afbcd0
RD
9063
9064 """
d14a1e28
RD
9065 def __init__(self): raise RuntimeError, "No constructor defined"
9066 def __repr__(self):
9067 return "<%s.%s; proxy of C++ wxItemContainer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
e811c8ce 9068 def Append(*args, **kwargs):
15afbcd0 9069 """
a95a7133 9070 Append(self, String item, PyObject clientData=None) -> int
15afbcd0 9071
41e2b43e
RD
9072 Adds the item to the control, associating the given data with the item
9073 if not None. The return value is the index of the newly added item
9074 which may be different from the last one if the control is sorted (e.g.
9075 has wx.LB_SORT or wx.CB_SORT style).
15afbcd0 9076 """
54f9ee45 9077 return _core_.ItemContainer_Append(*args, **kwargs)
e811c8ce
RD
9078
9079 def AppendItems(*args, **kwargs):
15afbcd0 9080 """
f5b96ee1 9081 AppendItems(self, List strings)
15afbcd0 9082
41e2b43e
RD
9083 Apend several items at once to the control. Notice that calling this
9084 method may be much faster than appending the items one by one if you
9085 need to add a lot of items.
15afbcd0 9086 """
54f9ee45 9087 return _core_.ItemContainer_AppendItems(*args, **kwargs)
e811c8ce
RD
9088
9089 def Insert(*args, **kwargs):
15afbcd0 9090 """
a95a7133 9091 Insert(self, String item, int pos, PyObject clientData=None) -> int
15afbcd0 9092
41e2b43e 9093 Insert an item into the control before the item at the ``pos`` index,
15afbcd0
RD
9094 optionally associating some data object with the item.
9095 """
54f9ee45 9096 return _core_.ItemContainer_Insert(*args, **kwargs)
e811c8ce
RD
9097
9098 def Clear(*args, **kwargs):
15afbcd0 9099 """
a95a7133 9100 Clear(self)
15afbcd0
RD
9101
9102 Removes all items from the control.
9103 """
54f9ee45 9104 return _core_.ItemContainer_Clear(*args, **kwargs)
e811c8ce
RD
9105
9106 def Delete(*args, **kwargs):
15afbcd0 9107 """
a95a7133 9108 Delete(self, int n)
15afbcd0 9109
41e2b43e
RD
9110 Deletes the item at the zero-based index 'n' from the control. Note
9111 that it is an error (signalled by a `wx.PyAssertionError` exception if
9112 enabled) to remove an item with the index negative or greater or equal
9113 than the number of items in the control.
15afbcd0 9114 """
54f9ee45 9115 return _core_.ItemContainer_Delete(*args, **kwargs)
e811c8ce 9116
53aa7709
RD
9117 def GetClientData(*args, **kwargs):
9118 """
9119 GetClientData(self, int n) -> PyObject
9120
9121 Returns the client data associated with the given item, (if any.)
9122 """
9123 return _core_.ItemContainer_GetClientData(*args, **kwargs)
9124
9125 def SetClientData(*args, **kwargs):
9126 """
9127 SetClientData(self, int n, PyObject clientData)
9128
9129 Associate the given client data with the item at position n.
9130 """
9131 return _core_.ItemContainer_SetClientData(*args, **kwargs)
9132
e811c8ce 9133 def GetCount(*args, **kwargs):
15afbcd0 9134 """
a95a7133 9135 GetCount(self) -> int
15afbcd0
RD
9136
9137 Returns the number of items in the control.
9138 """
54f9ee45 9139 return _core_.ItemContainer_GetCount(*args, **kwargs)
e811c8ce
RD
9140
9141 def IsEmpty(*args, **kwargs):
15afbcd0 9142 """
a95a7133 9143 IsEmpty(self) -> bool
15afbcd0
RD
9144
9145 Returns True if the control is empty or False if it has some items.
9146 """
54f9ee45 9147 return _core_.ItemContainer_IsEmpty(*args, **kwargs)
e811c8ce
RD
9148
9149 def GetString(*args, **kwargs):
15afbcd0 9150 """
a95a7133 9151 GetString(self, int n) -> String
15afbcd0
RD
9152
9153 Returns the label of the item with the given index.
9154 """
54f9ee45 9155 return _core_.ItemContainer_GetString(*args, **kwargs)
e811c8ce
RD
9156
9157 def GetStrings(*args, **kwargs):
a95a7133 9158 """GetStrings(self) -> wxArrayString"""
54f9ee45 9159 return _core_.ItemContainer_GetStrings(*args, **kwargs)
e811c8ce
RD
9160
9161 def SetString(*args, **kwargs):
15afbcd0 9162 """
a95a7133 9163 SetString(self, int n, String s)
15afbcd0
RD
9164
9165 Sets the label for the given item.
9166 """
54f9ee45 9167 return _core_.ItemContainer_SetString(*args, **kwargs)
e811c8ce
RD
9168
9169 def FindString(*args, **kwargs):
15afbcd0 9170 """
a95a7133 9171 FindString(self, String s) -> int
15afbcd0
RD
9172
9173 Finds an item whose label matches the given string. Returns the
41e2b43e
RD
9174 zero-based position of the item, or ``wx.NOT_FOUND`` if the string was not
9175 found.
15afbcd0 9176 """
54f9ee45 9177 return _core_.ItemContainer_FindString(*args, **kwargs)
e811c8ce 9178
53aa7709 9179 def SetSelection(*args, **kwargs):
15afbcd0 9180 """
53aa7709 9181 SetSelection(self, int n)
15afbcd0
RD
9182
9183 Sets the item at index 'n' to be the selected item.
9184 """
53aa7709 9185 return _core_.ItemContainer_SetSelection(*args, **kwargs)
e811c8ce
RD
9186
9187 def GetSelection(*args, **kwargs):
15afbcd0 9188 """
a95a7133 9189 GetSelection(self) -> int
15afbcd0 9190
41e2b43e
RD
9191 Returns the index of the selected item or ``wx.NOT_FOUND`` if no item
9192 is selected.
15afbcd0 9193 """
54f9ee45 9194 return _core_.ItemContainer_GetSelection(*args, **kwargs)
e811c8ce 9195
53aa7709
RD
9196 def SetStringSelection(*args, **kwargs):
9197 """SetStringSelection(self, String s) -> bool"""
9198 return _core_.ItemContainer_SetStringSelection(*args, **kwargs)
9199
e811c8ce 9200 def GetStringSelection(*args, **kwargs):
15afbcd0 9201 """
a95a7133 9202 GetStringSelection(self) -> String
15afbcd0 9203
41e2b43e
RD
9204 Returns the label of the selected item or an empty string if no item
9205 is selected.
15afbcd0 9206 """
54f9ee45 9207 return _core_.ItemContainer_GetStringSelection(*args, **kwargs)
e811c8ce 9208
53aa7709 9209 def Select(*args, **kwargs):
15afbcd0 9210 """
53aa7709 9211 Select(self, int n)
15afbcd0 9212
53aa7709
RD
9213 This is the same as `SetSelection` and exists only because it is
9214 slightly more natural for controls which support multiple selection.
15afbcd0 9215 """
53aa7709 9216 return _core_.ItemContainer_Select(*args, **kwargs)
e811c8ce 9217
d14a1e28
RD
9218
9219class ItemContainerPtr(ItemContainer):
9220 def __init__(self, this):
9221 self.this = this
9222 if not hasattr(self,"thisown"): self.thisown = 0
9223 self.__class__ = ItemContainer
54f9ee45 9224_core_.ItemContainer_swigregister(ItemContainerPtr)
d14a1e28
RD
9225
9226#---------------------------------------------------------------------------
9227
9228class ControlWithItems(Control,ItemContainer):
15afbcd0 9229 """
41e2b43e
RD
9230 wx.ControlWithItems combines the ``wx.ItemContainer`` class with the
9231 wx.Control class, and is used for the base class of various controls
9232 that have items.
15afbcd0 9233 """
d14a1e28
RD
9234 def __init__(self): raise RuntimeError, "No constructor defined"
9235 def __repr__(self):
9236 return "<%s.%s; proxy of C++ wxControlWithItems instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
9237
9238class ControlWithItemsPtr(ControlWithItems):
9239 def __init__(self, this):
9240 self.this = this
9241 if not hasattr(self,"thisown"): self.thisown = 0
9242 self.__class__ = ControlWithItems
54f9ee45 9243_core_.ControlWithItems_swigregister(ControlWithItemsPtr)
d14a1e28
RD
9244
9245#---------------------------------------------------------------------------
9246
9247class SizerItem(Object):
248ed943
RD
9248 """
9249 The wx.SizerItem class is used to track the position, size and other
9250 attributes of each item managed by a `wx.Sizer`. In normal usage user
9251 code should never need to deal directly with a wx.SizerItem, but
9252 custom classes derived from `wx.PySizer` will probably need to use the
9253 collection of wx.SizerItems held by wx.Sizer when calculating layout.
9254
9255 :see: `wx.Sizer`, `wx.GBSizerItem`
9256 """
e811c8ce
RD
9257 def __repr__(self):
9258 return "<%s.%s; proxy of C++ wxSizerItem instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 9259 def __init__(self, *args, **kwargs):
248ed943
RD
9260 """
9261 __init__(self) -> SizerItem
9262
9263 Constructs an empty wx.SizerItem. Either a window, sizer or spacer
9264 size will need to be set before this item can be used in a Sizer.
9265
9266 You will probably never need to create a wx.SizerItem directly as they
9267 are created automatically when the sizer's Add, Insert or Prepend
9268 methods are called.
9269
9270 :see: `wx.SizerItemSpacer`, `wx.SizerItemWindow`, `wx.SizerItemSizer`
9271 """
54f9ee45 9272 newobj = _core_.new_SizerItem(*args, **kwargs)
d14a1e28
RD
9273 self.this = newobj.this
9274 self.thisown = 1
9275 del newobj.thisown
e811c8ce 9276 def DeleteWindows(*args, **kwargs):
248ed943
RD
9277 """
9278 DeleteWindows(self)
9279
9280 Destroy the window or the windows in a subsizer, depending on the type
9281 of item.
9282 """
54f9ee45 9283 return _core_.SizerItem_DeleteWindows(*args, **kwargs)
e811c8ce
RD
9284
9285 def DetachSizer(*args, **kwargs):
248ed943
RD
9286 """
9287 DetachSizer(self)
9288
9289 Enable deleting the SizerItem without destroying the contained sizer.
9290 """
54f9ee45 9291 return _core_.SizerItem_DetachSizer(*args, **kwargs)
e811c8ce
RD
9292
9293 def GetSize(*args, **kwargs):
248ed943
RD
9294 """
9295 GetSize(self) -> Size
9296
9297 Get the current size of the item, as set in the last Layout.
9298 """
54f9ee45 9299 return _core_.SizerItem_GetSize(*args, **kwargs)
e811c8ce
RD
9300
9301 def CalcMin(*args, **kwargs):
248ed943
RD
9302 """
9303 CalcMin(self) -> Size
9304
9305 Calculates the minimum desired size for the item, including any space
9306 needed by borders.
9307 """
54f9ee45 9308 return _core_.SizerItem_CalcMin(*args, **kwargs)
e811c8ce
RD
9309
9310 def SetDimension(*args, **kwargs):
248ed943
RD
9311 """
9312 SetDimension(self, Point pos, Size size)
9313
9314 Set the position and size of the space allocated for this item by the
9315 sizer, and adjust the position and size of the item (window or
9316 subsizer) to be within that space taking alignment and borders into
9317 account.
9318 """
54f9ee45 9319 return _core_.SizerItem_SetDimension(*args, **kwargs)
e811c8ce
RD
9320
9321 def GetMinSize(*args, **kwargs):
248ed943
RD
9322 """
9323 GetMinSize(self) -> Size
9324
9325 Get the minimum size needed for the item.
9326 """
54f9ee45 9327 return _core_.SizerItem_GetMinSize(*args, **kwargs)
e811c8ce 9328
dfbb5885
RD
9329 def GetMinSizeWithBorder(*args, **kwargs):
9330 """
9331 GetMinSizeWithBorder(self) -> Size
9332
9333 Get the minimum size needed for the item with space for the borders
9334 added, if needed.
9335 """
9336 return _core_.SizerItem_GetMinSizeWithBorder(*args, **kwargs)
9337
e811c8ce 9338 def SetInitSize(*args, **kwargs):
a95a7133 9339 """SetInitSize(self, int x, int y)"""
54f9ee45 9340 return _core_.SizerItem_SetInitSize(*args, **kwargs)
e811c8ce
RD
9341
9342 def SetRatioWH(*args, **kwargs):
248ed943
RD
9343 """
9344 SetRatioWH(self, int width, int height)
9345
9346 Set the ratio item attribute.
9347 """
54f9ee45 9348 return _core_.SizerItem_SetRatioWH(*args, **kwargs)
e811c8ce
RD
9349
9350 def SetRatioSize(*args, **kwargs):
248ed943
RD
9351 """
9352 SetRatioSize(self, Size size)
9353
9354 Set the ratio item attribute.
9355 """
54f9ee45 9356 return _core_.SizerItem_SetRatioSize(*args, **kwargs)
e811c8ce
RD
9357
9358 def SetRatio(*args, **kwargs):
248ed943
RD
9359 """
9360 SetRatio(self, float ratio)
9361
9362 Set the ratio item attribute.
9363 """
54f9ee45 9364 return _core_.SizerItem_SetRatio(*args, **kwargs)
e811c8ce
RD
9365
9366 def GetRatio(*args, **kwargs):
248ed943
RD
9367 """
9368 GetRatio(self) -> float
9369
9370 Set the ratio item attribute.
9371 """
54f9ee45 9372 return _core_.SizerItem_GetRatio(*args, **kwargs)
e811c8ce 9373
d3b6e4ff
RD
9374 def GetRect(*args, **kwargs):
9375 """
9376 GetRect(self) -> Rect
9377
9378 Returns the rectangle that the sizer item should occupy
9379 """
9380 return _core_.SizerItem_GetRect(*args, **kwargs)
9381
e811c8ce 9382 def IsWindow(*args, **kwargs):
248ed943
RD
9383 """
9384 IsWindow(self) -> bool
9385
9386 Is this sizer item a window?
9387 """
54f9ee45 9388 return _core_.SizerItem_IsWindow(*args, **kwargs)
e811c8ce
RD
9389
9390 def IsSizer(*args, **kwargs):
248ed943
RD
9391 """
9392 IsSizer(self) -> bool
9393
9394 Is this sizer item a subsizer?
9395 """
54f9ee45 9396 return _core_.SizerItem_IsSizer(*args, **kwargs)
e811c8ce
RD
9397
9398 def IsSpacer(*args, **kwargs):
248ed943
RD
9399 """
9400 IsSpacer(self) -> bool
9401
9402 Is this sizer item a spacer?
9403 """
54f9ee45 9404 return _core_.SizerItem_IsSpacer(*args, **kwargs)
e811c8ce
RD
9405
9406 def SetProportion(*args, **kwargs):
248ed943
RD
9407 """
9408 SetProportion(self, int proportion)
9409
9410 Set the proportion value for this item.
9411 """
54f9ee45 9412 return _core_.SizerItem_SetProportion(*args, **kwargs)
e811c8ce
RD
9413
9414 def GetProportion(*args, **kwargs):
248ed943
RD
9415 """
9416 GetProportion(self) -> int
9417
9418 Get the proportion value for this item.
9419 """
54f9ee45 9420 return _core_.SizerItem_GetProportion(*args, **kwargs)
e811c8ce 9421
248ed943
RD
9422 SetOption = wx._deprecated(SetProportion, "Please use `SetProportion` instead.")
9423 GetOption = wx._deprecated(GetProportion, "Please use `GetProportion` instead.")
e811c8ce 9424 def SetFlag(*args, **kwargs):
248ed943
RD
9425 """
9426 SetFlag(self, int flag)
9427
9428 Set the flag value for this item.
9429 """
54f9ee45 9430 return _core_.SizerItem_SetFlag(*args, **kwargs)
e811c8ce
RD
9431
9432 def GetFlag(*args, **kwargs):
248ed943
RD
9433 """
9434 GetFlag(self) -> int
9435
9436 Get the flag value for this item.
9437 """
54f9ee45 9438 return _core_.SizerItem_GetFlag(*args, **kwargs)
e811c8ce
RD
9439
9440 def SetBorder(*args, **kwargs):
248ed943
RD
9441 """
9442 SetBorder(self, int border)
9443
9444 Set the border value for this item.
9445 """
54f9ee45 9446 return _core_.SizerItem_SetBorder(*args, **kwargs)
e811c8ce
RD
9447
9448 def GetBorder(*args, **kwargs):
248ed943
RD
9449 """
9450 GetBorder(self) -> int
9451
9452 Get the border value for this item.
9453 """
54f9ee45 9454 return _core_.SizerItem_GetBorder(*args, **kwargs)
e811c8ce
RD
9455
9456 def GetWindow(*args, **kwargs):
248ed943
RD
9457 """
9458 GetWindow(self) -> Window
9459
9460 Get the window (if any) that is managed by this sizer item.
9461 """
54f9ee45 9462 return _core_.SizerItem_GetWindow(*args, **kwargs)
e811c8ce
RD
9463
9464 def SetWindow(*args, **kwargs):
248ed943
RD
9465 """
9466 SetWindow(self, Window window)
9467
9468 Set the window to be managed by this sizer item.
9469 """
54f9ee45 9470 return _core_.SizerItem_SetWindow(*args, **kwargs)
e811c8ce
RD
9471
9472 def GetSizer(*args, **kwargs):
248ed943
RD
9473 """
9474 GetSizer(self) -> Sizer
9475
9476 Get the subsizer (if any) that is managed by this sizer item.
9477 """
54f9ee45 9478 return _core_.SizerItem_GetSizer(*args, **kwargs)
e811c8ce
RD
9479
9480 def SetSizer(*args, **kwargs):
248ed943
RD
9481 """
9482 SetSizer(self, Sizer sizer)
9483
9484 Set the subsizer to be managed by this sizer item.
9485 """
54f9ee45 9486 return _core_.SizerItem_SetSizer(*args, **kwargs)
e811c8ce
RD
9487
9488 def GetSpacer(*args, **kwargs):
248ed943
RD
9489 """
9490 GetSpacer(self) -> Size
9491
9492 Get the size of the spacer managed by this sizer item.
9493 """
54f9ee45 9494 return _core_.SizerItem_GetSpacer(*args, **kwargs)
e811c8ce
RD
9495
9496 def SetSpacer(*args, **kwargs):
248ed943
RD
9497 """
9498 SetSpacer(self, Size size)
9499
9500 Set the size of the spacer to be managed by this sizer item.
9501 """
54f9ee45 9502 return _core_.SizerItem_SetSpacer(*args, **kwargs)
e811c8ce
RD
9503
9504 def Show(*args, **kwargs):
248ed943
RD
9505 """
9506 Show(self, bool show)
9507
9508 Set the show item attribute, which sizers use to determine if the item
9509 is to be made part of the layout or not. If the item is tracking a
9510 window then it is shown or hidden as needed.
9511 """
54f9ee45 9512 return _core_.SizerItem_Show(*args, **kwargs)
e811c8ce
RD
9513
9514 def IsShown(*args, **kwargs):
248ed943
RD
9515 """
9516 IsShown(self) -> bool
9517
9518 Is the item to be shown in the layout?
9519 """
54f9ee45 9520 return _core_.SizerItem_IsShown(*args, **kwargs)
e811c8ce
RD
9521
9522 def GetPosition(*args, **kwargs):
248ed943
RD
9523 """
9524 GetPosition(self) -> Point
9525
9526 Returns the current position of the item, as set in the last Layout.
9527 """
54f9ee45 9528 return _core_.SizerItem_GetPosition(*args, **kwargs)
e811c8ce
RD
9529
9530 def GetUserData(*args, **kwargs):
248ed943
RD
9531 """
9532 GetUserData(self) -> PyObject
9533
9534 Returns the userData associated with this sizer item, or None if there
9535 isn't any.
9536 """
54f9ee45 9537 return _core_.SizerItem_GetUserData(*args, **kwargs)
e811c8ce 9538
d14a1e28
RD
9539
9540class SizerItemPtr(SizerItem):
9541 def __init__(self, this):
9542 self.this = this
9543 if not hasattr(self,"thisown"): self.thisown = 0
9544 self.__class__ = SizerItem
54f9ee45 9545_core_.SizerItem_swigregister(SizerItemPtr)
d14a1e28 9546
248ed943 9547def SizerItemWindow(*args, **kwargs):
0df68c9f 9548 """
248ed943
RD
9549 SizerItemWindow(Window window, int proportion, int flag, int border,
9550 PyObject userData=None) -> SizerItem
9551
9552 Constructs a `wx.SizerItem` for tracking a window.
0df68c9f 9553 """
248ed943 9554 val = _core_.new_SizerItemWindow(*args, **kwargs)
d14a1e28
RD
9555 val.thisown = 1
9556 return val
9557
248ed943 9558def SizerItemSpacer(*args, **kwargs):
0df68c9f 9559 """
248ed943
RD
9560 SizerItemSpacer(int width, int height, int proportion, int flag, int border,
9561 PyObject userData=None) -> SizerItem
9562
9563 Constructs a `wx.SizerItem` for tracking a spacer.
0df68c9f 9564 """
248ed943 9565 val = _core_.new_SizerItemSpacer(*args, **kwargs)
d14a1e28
RD
9566 val.thisown = 1
9567 return val
9568
9569def SizerItemSizer(*args, **kwargs):
0df68c9f
RD
9570 """
9571 SizerItemSizer(Sizer sizer, int proportion, int flag, int border,
248ed943
RD
9572 PyObject userData=None) -> SizerItem
9573
9574 Constructs a `wx.SizerItem` for tracking a subsizer
0df68c9f 9575 """
54f9ee45 9576 val = _core_.new_SizerItemSizer(*args, **kwargs)
d14a1e28
RD
9577 val.thisown = 1
9578 return val
9579
9580class Sizer(Object):
248ed943
RD
9581 """
9582 wx.Sizer is the abstract base class used for laying out subwindows in
9583 a window. You cannot use wx.Sizer directly; instead, you will have to
9584 use one of the sizer classes derived from it such as `wx.BoxSizer`,
9585 `wx.StaticBoxSizer`, `wx.NotebookSizer`, `wx.GridSizer`, `wx.FlexGridSizer`
9586 and `wx.GridBagSizer`.
9587
9588 The concept implemented by sizers in wxWidgets is closely related to
9589 layout tools in other GUI toolkits, such as Java's AWT, the GTK
9590 toolkit or the Qt toolkit. It is based upon the idea of the individual
9591 subwindows reporting their minimal required size and their ability to
9592 get stretched if the size of the parent window has changed. This will
9593 most often mean that the programmer does not set the original size of
9594 a dialog in the beginning, rather the dialog will assigned a sizer and
9595 this sizer will be queried about the recommended size. The sizer in
9596 turn will query its children, which can be normal windows or contorls,
9597 empty space or other sizers, so that a hierarchy of sizers can be
9598 constructed. Note that wxSizer does not derive from wxWindow and thus
9599 do not interfere with tab ordering and requires very little resources
9600 compared to a real window on screen.
9601
9602 What makes sizers so well fitted for use in wxWidgets is the fact that
9603 every control reports its own minimal size and the algorithm can
9604 handle differences in font sizes or different window (dialog item)
9605 sizes on different platforms without problems. If for example the
9606 standard font as well as the overall design of Mac widgets requires
9607 more space than on Windows, then the initial size of a dialog using a
9608 sizer will automatically be bigger on Mac than on Windows.
9609 """
e811c8ce
RD
9610 def __init__(self): raise RuntimeError, "No constructor defined"
9611 def __repr__(self):
9612 return "<%s.%s; proxy of C++ wxSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
9613 def _setOORInfo(*args, **kwargs):
a95a7133 9614 """_setOORInfo(self, PyObject _self)"""
54f9ee45 9615 return _core_.Sizer__setOORInfo(*args, **kwargs)
e811c8ce
RD
9616
9617 def Add(*args, **kwargs):
0df68c9f 9618 """
248ed943 9619 Add(self, item, int proportion=0, int flag=0, int border=0,
d3b6e4ff 9620 PyObject userData=None) -> wx.SizerItem
248ed943
RD
9621
9622 Appends a child item to the sizer.
0df68c9f 9623 """
54f9ee45 9624 return _core_.Sizer_Add(*args, **kwargs)
e811c8ce
RD
9625
9626 def Insert(*args, **kwargs):
0df68c9f 9627 """
248ed943 9628 Insert(self, int before, item, int proportion=0, int flag=0, int border=0,
d3b6e4ff 9629 PyObject userData=None) -> wx.SizerItem
248ed943
RD
9630
9631 Inserts a new item into the list of items managed by this sizer before
9632 the item at index *before*. See `Add` for a description of the parameters.
0df68c9f 9633 """
54f9ee45 9634 return _core_.Sizer_Insert(*args, **kwargs)
e811c8ce
RD
9635
9636 def Prepend(*args, **kwargs):
0df68c9f 9637 """
248ed943 9638 Prepend(self, item, int proportion=0, int flag=0, int border=0,
d3b6e4ff 9639 PyObject userData=None) -> wx.SizerItem
248ed943
RD
9640
9641 Adds a new item to the begining of the list of sizer items managed by
9642 this sizer. See `Add` for a description of the parameters.
0df68c9f 9643 """
54f9ee45 9644 return _core_.Sizer_Prepend(*args, **kwargs)
e811c8ce
RD
9645
9646 def Remove(*args, **kwargs):
248ed943
RD
9647 """
9648 Remove(self, item) -> bool
9649
9650 Removes an item from the sizer and destroys it. This method does not
9651 cause any layout or resizing to take place, call `Layout` to update
9652 the layout on screen after removing a child from the sizer. The
9653 *item* parameter can be either a window, a sizer, or the zero-based
9654 index of an item to remove. Returns True if the child item was found
9655 and removed.
9656 """
54f9ee45 9657 return _core_.Sizer_Remove(*args, **kwargs)
e811c8ce 9658
1c0f361b 9659 def Detach(*args, **kwargs):
248ed943
RD
9660 """
9661 Detach(self, item) -> bool
9662
9663 Detaches an item from the sizer without destroying it. This method
9664 does not cause any layout or resizing to take place, call `Layout` to
9665 do so. The *item* parameter can be either a window, a sizer, or the
9666 zero-based index of the item to be detached. Returns True if the child item
9667 was found and detached.
9668 """
1c0f361b
RD
9669 return _core_.Sizer_Detach(*args, **kwargs)
9670
d3b6e4ff
RD
9671 def GetItem(*args, **kwargs):
9672 """
9673 GetItem(self, item) -> wx.SizerItem
9674
9675 Returns the `wx.SizerItem` which holds the *item* given. The *item*
9676 parameter can be either a window, a sizer, or the zero-based index of
9677 the item to be detached.
9678 """
9679 return _core_.Sizer_GetItem(*args, **kwargs)
9680
e811c8ce 9681 def _SetItemMinSize(*args, **kwargs):
a95a7133 9682 """_SetItemMinSize(self, PyObject item, Size size)"""
54f9ee45 9683 return _core_.Sizer__SetItemMinSize(*args, **kwargs)
e811c8ce 9684
248ed943
RD
9685 def SetItemMinSize(self, item, *args):
9686 """
9687 SetItemMinSize(self, item, Size size)
9688
9689 Sets the minimum size that will be allocated for an item in the sizer.
9690 The *item* parameter can be either a window, a sizer, or the
9691 zero-based index of the item. If a window or sizer is given then it
9692 will be searched for recursivly in subsizers if neccessary.
9693 """
9694 if len(args) == 2:
9695 # for backward compatibility accept separate width,height args too
9696 return self._SetItemMinSize(item, args)
9697 else:
9698 return self._SetItemMinSize(item, args[0])
9699
e811c8ce 9700 def AddItem(*args, **kwargs):
248ed943
RD
9701 """
9702 AddItem(self, SizerItem item)
9703
9704 Adds a `wx.SizerItem` to the sizer.
9705 """
54f9ee45 9706 return _core_.Sizer_AddItem(*args, **kwargs)
e811c8ce
RD
9707
9708 def InsertItem(*args, **kwargs):
248ed943
RD
9709 """
9710 InsertItem(self, int index, SizerItem item)
9711
9712 Inserts a `wx.SizerItem` to the sizer at the position given by *index*.
9713 """
54f9ee45 9714 return _core_.Sizer_InsertItem(*args, **kwargs)
e811c8ce
RD
9715
9716 def PrependItem(*args, **kwargs):
248ed943
RD
9717 """
9718 PrependItem(self, SizerItem item)
9719
9720 Prepends a `wx.SizerItem` to the sizer.
9721 """
54f9ee45 9722 return _core_.Sizer_PrependItem(*args, **kwargs)
e811c8ce 9723
248ed943 9724 def AddMany(self, items):
66c033b4
RD
9725 """
9726 AddMany is a convenience method for adding several items
9727 to a sizer at one time. Simply pass it a list of tuples,
9728 where each tuple consists of the parameters that you
9729 would normally pass to the `Add` method.
9730 """
248ed943
RD
9731 for item in items:
9732 if type(item) != type(()) or (len(item) == 2 and type(item[0]) == type(1)):
9733 item = (item, )
9734 self.Add(*item)
d14a1e28 9735
74e96f3d 9736 # for backwards compatibility only, please do not use in new code
b9d6a5f3
RD
9737 def AddWindow(self, *args, **kw):
9738 """Compatibility alias for `Add`."""
9739 return self.Add(*args, **kw)
9740 def AddSizer(self, *args, **kw):
9741 """Compatibility alias for `Add`."""
9742 return self.Add(*args, **kw)
9743 def AddSpacer(self, *args, **kw):
9744 """Compatibility alias for `Add`."""
9745 return self.Add(*args, **kw)
9746
9747 def PrependWindow(self, *args, **kw):
9748 """Compatibility alias for `Prepend`."""
9749 return self.Prepend(*args, **kw)
9750 def PrependSizer(self, *args, **kw):
9751 """Compatibility alias for `Prepend`."""
9752 return self.Prepend(*args, **kw)
9753 def PrependSpacer(self, *args, **kw):
9754 """Compatibility alias for `Prepend`."""
9755 return self.Prepend(*args, **kw)
9756
9757 def InsertWindow(self, *args, **kw):
9758 """Compatibility alias for `Insert`."""
9759 return self.Insert(*args, **kw)
9760 def InsertSizer(self, *args, **kw):
9761 """Compatibility alias for `Insert`."""
9762 return self.Insert(*args, **kw)
9763 def InsertSpacer(self, *args, **kw):
9764 """Compatibility alias for `Insert`."""
9765 return self.Insert(*args, **kw)
9766
9767 def RemoveWindow(self, *args, **kw):
9768 """Compatibility alias for `Remove`."""
9769 return self.Remove(*args, **kw)
9770 def RemoveSizer(self, *args, **kw):
9771 """Compatibility alias for `Remove`."""
9772 return self.Remove(*args, **kw)
9773 def RemovePos(self, *args, **kw):
9774 """Compatibility alias for `Remove`."""
9775 return self.Remove(*args, **kw)
d14a1e28
RD
9776
9777
e811c8ce 9778 def SetDimension(*args, **kwargs):
248ed943
RD
9779 """
9780 SetDimension(self, int x, int y, int width, int height)
9781
9782 Call this to force the sizer to take the given dimension and thus
9783 force the items owned by the sizer to resize themselves according to
9784 the rules defined by the parameter in the `Add`, `Insert` or `Prepend`
9785 methods.
9786 """
54f9ee45 9787 return _core_.Sizer_SetDimension(*args, **kwargs)
e811c8ce
RD
9788
9789 def SetMinSize(*args, **kwargs):
248ed943
RD
9790 """
9791 SetMinSize(self, Size size)
9792
9793 Call this to give the sizer a minimal size. Normally, the sizer will
9794 calculate its minimal size based purely on how much space its children
9795 need. After calling this method `GetMinSize` will return either the
9796 minimal size as requested by its children or the minimal size set
9797 here, depending on which is bigger.
9798 """
54f9ee45 9799 return _core_.Sizer_SetMinSize(*args, **kwargs)
e811c8ce
RD
9800
9801 def GetSize(*args, **kwargs):
248ed943
RD
9802 """
9803 GetSize(self) -> Size
9804
9805 Returns the current size of the space managed by the sizer.
9806 """
54f9ee45 9807 return _core_.Sizer_GetSize(*args, **kwargs)
e811c8ce
RD
9808
9809 def GetPosition(*args, **kwargs):
248ed943
RD
9810 """
9811 GetPosition(self) -> Point
9812
9813 Returns the current position of the sizer's managed space.
9814 """
54f9ee45 9815 return _core_.Sizer_GetPosition(*args, **kwargs)
e811c8ce
RD
9816
9817 def GetMinSize(*args, **kwargs):
248ed943
RD
9818 """
9819 GetMinSize(self) -> Size
9820
9821 Returns the minimal size of the sizer. This is either the combined
9822 minimal size of all the children and their borders or the minimal size
9823 set by SetMinSize, depending on which is bigger.
9824 """
54f9ee45 9825 return _core_.Sizer_GetMinSize(*args, **kwargs)
e811c8ce 9826
d14a1e28 9827 def GetSizeTuple(self):
1c0f361b 9828 return self.GetSize().Get()
d14a1e28 9829 def GetPositionTuple(self):
1c0f361b 9830 return self.GetPosition().Get()
d14a1e28 9831 def GetMinSizeTuple(self):
1c0f361b 9832 return self.GetMinSize().Get()
d14a1e28 9833
e811c8ce 9834 def RecalcSizes(*args, **kwargs):
248ed943
RD
9835 """
9836 RecalcSizes(self)
9837
9838 Using the sizes calculated by `CalcMin` reposition and resize all the
9839 items managed by this sizer. You should not need to call this directly as
9840 it is called by `Layout`.
9841 """
54f9ee45 9842 return _core_.Sizer_RecalcSizes(*args, **kwargs)
e811c8ce
RD
9843
9844 def CalcMin(*args, **kwargs):
248ed943
RD
9845 """
9846 CalcMin(self) -> Size
9847
9848 This method is where the sizer will do the actual calculation of its
9849 children's minimal sizes. You should not need to call this directly as
9850 it is called by `Layout`.
9851 """
54f9ee45 9852 return _core_.Sizer_CalcMin(*args, **kwargs)
e811c8ce
RD
9853
9854 def Layout(*args, **kwargs):
248ed943
RD
9855 """
9856 Layout(self)
9857
9858 This method will force the recalculation and layout of the items
9859 controlled by the sizer using the current space allocated to the
9860 sizer. Normally this is called automatically from the owning window's
9861 EVT_SIZE handler, but it is also useful to call it from user code when
9862 one of the items in a sizer change size, or items are added or
9863 removed.
9864 """
54f9ee45 9865 return _core_.Sizer_Layout(*args, **kwargs)
e811c8ce
RD
9866
9867 def Fit(*args, **kwargs):
248ed943
RD
9868 """
9869 Fit(self, Window window) -> Size
9870
9871 Tell the sizer to resize the *window* to match the sizer's minimal
9872 size. This is commonly done in the constructor of the window itself in
9873 order to set its initial size to match the needs of the children as
9874 determined by the sizer. Returns the new size.
9875
9876 For a top level window this is the total window size, not the client size.
9877 """
54f9ee45 9878 return _core_.Sizer_Fit(*args, **kwargs)
e811c8ce
RD
9879
9880 def FitInside(*args, **kwargs):
248ed943
RD
9881 """
9882 FitInside(self, Window window)
9883
9884 Tell the sizer to resize the *virtual size* of the *window* to match the
9885 sizer's minimal size. This will not alter the on screen size of the
9886 window, but may cause the addition/removal/alteration of scrollbars
9887 required to view the virtual area in windows which manage it.
9888
9889 :see: `wx.ScrolledWindow.SetScrollbars`, `SetVirtualSizeHints`
9890
9891 """
54f9ee45 9892 return _core_.Sizer_FitInside(*args, **kwargs)
e811c8ce
RD
9893
9894 def SetSizeHints(*args, **kwargs):
248ed943
RD
9895 """
9896 SetSizeHints(self, Window window)
9897
9898 Tell the sizer to set (and `Fit`) the minimal size of the *window* to
9899 match the sizer's minimal size. This is commonly done in the
9900 constructor of the window itself if the window is resizable (as are
9901 many dialogs under Unix and frames on probably all platforms) in order
9902 to prevent the window from being sized smaller than the minimal size
9903 required by the sizer.
9904 """
54f9ee45 9905 return _core_.Sizer_SetSizeHints(*args, **kwargs)
e811c8ce
RD
9906
9907 def SetVirtualSizeHints(*args, **kwargs):
248ed943
RD
9908 """
9909 SetVirtualSizeHints(self, Window window)
9910
9911 Tell the sizer to set the minimal size of the window virtual area to
9912 match the sizer's minimal size. For windows with managed scrollbars
9913 this will set them appropriately.
9914
9915 :see: `wx.ScrolledWindow.SetScrollbars`
9916
9917 """
54f9ee45 9918 return _core_.Sizer_SetVirtualSizeHints(*args, **kwargs)
e811c8ce
RD
9919
9920 def Clear(*args, **kwargs):
248ed943
RD
9921 """
9922 Clear(self, bool deleteWindows=False)
9923
9924 Clear all items from the sizer, optionally destroying the window items
9925 as well.
9926 """
54f9ee45 9927 return _core_.Sizer_Clear(*args, **kwargs)
e811c8ce
RD
9928
9929 def DeleteWindows(*args, **kwargs):
248ed943
RD
9930 """
9931 DeleteWindows(self)
9932
9933 Destroy all windows managed by the sizer.
9934 """
54f9ee45 9935 return _core_.Sizer_DeleteWindows(*args, **kwargs)
e811c8ce
RD
9936
9937 def GetChildren(*args, **kwargs):
248ed943 9938 """
51b83b37 9939 GetChildren(self) -> list
248ed943
RD
9940
9941 Returns a list of all the `wx.SizerItem` objects managed by the sizer.
9942 """
54f9ee45 9943 return _core_.Sizer_GetChildren(*args, **kwargs)
e811c8ce
RD
9944
9945 def Show(*args, **kwargs):
248ed943 9946 """
ae8162c8 9947 Show(self, item, bool show=True, bool recursive=false) -> bool
e811c8ce 9948
248ed943
RD
9949 Shows or hides an item managed by the sizer. To make a sizer item
9950 disappear or reappear, use Show followed by `Layout`. The *item*
9951 parameter can be either a window, a sizer, or the zero-based index of
7e63a440
RD
9952 the item. Use the recursive parameter to show or hide an item in a
9953 subsizer. Returns True if the item was found.
248ed943
RD
9954 """
9955 return _core_.Sizer_Show(*args, **kwargs)
e811c8ce
RD
9956
9957 def IsShown(*args, **kwargs):
248ed943
RD
9958 """
9959 IsShown(self, item)
9960
9961 Determines if the item is currently shown. sizer. To make a sizer
9962 item disappear or reappear, use Show followed by `Layout`. The *item*
9963 parameter can be either a window, a sizer, or the zero-based index of
9964 the item.
9965 """
54f9ee45 9966 return _core_.Sizer_IsShown(*args, **kwargs)
e811c8ce 9967
7e63a440 9968 def Hide(self, item, recursive=False):
248ed943 9969 """
88c6b281 9970 A convenience method for `Show`(item, False, recursive).
248ed943 9971 """
06759a38 9972 return self.Show(item, False, recursive)
248ed943 9973
e811c8ce 9974 def ShowItems(*args, **kwargs):
248ed943
RD
9975 """
9976 ShowItems(self, bool show)
9977
84f85550 9978 Recursively call `wx.SizerItem.Show` on all sizer items.
248ed943 9979 """
54f9ee45 9980 return _core_.Sizer_ShowItems(*args, **kwargs)
e811c8ce 9981
d14a1e28
RD
9982
9983class SizerPtr(Sizer):
9984 def __init__(self, this):
9985 self.this = this
9986 if not hasattr(self,"thisown"): self.thisown = 0
9987 self.__class__ = Sizer
54f9ee45 9988_core_.Sizer_swigregister(SizerPtr)
d14a1e28
RD
9989
9990class PySizer(Sizer):
248ed943
RD
9991 """
9992 wx.PySizer is a special version of `wx.Sizer` that has been
9993 instrumented to allow the C++ virtual methods to be overloaded in
9994 Python derived classes. You would derive from this class if you are
9995 wanting to implement a custom sizer in Python code. Simply implement
9996 `CalcMin` and `RecalcSizes` in the derived class and you're all set.
9997 For example::
9998
9999 class MySizer(wx.PySizer):
10000 def __init__(self):
10001 wx.PySizer.__init__(self)
10002
10003 def CalcMin(self):
10004 for item in self.GetChildren():
10005 # calculate the total minimum width and height needed
10006 # by all items in the sizer according to this sizer's
10007 # layout algorithm.
10008 ...
10009 return wx.Size(width, height)
10010
10011 def RecalcSizes(self):
10012 # find the space allotted to this sizer
10013 pos = self.GetPosition()
10014 size = self.GetSize()
10015 for item in self.GetChildren():
10016 # Recalculate (if necessary) the position and size of
10017 # each item and then call item.SetDimension to do the
10018 # actual positioning and sizing of the items within the
10019 # space alloted to this sizer.
10020 ...
10021 item.SetDimension(itemPos, itemSize)
10022
10023
10024 When `Layout` is called it first calls `CalcMin` followed by
10025 `RecalcSizes` so you can optimize a bit by saving the results of
e505d15e 10026 `CalcMin` and reusing them in `RecalcSizes`.
248ed943
RD
10027
10028 :see: `wx.SizerItem`, `wx.Sizer.GetChildren`
10029
10030
10031 """
e811c8ce
RD
10032 def __repr__(self):
10033 return "<%s.%s; proxy of C++ wxPySizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 10034 def __init__(self, *args, **kwargs):
248ed943
RD
10035 """
10036 __init__(self) -> PySizer
10037
10038 Creates a wx.PySizer. Must be called from the __init__ in the derived
10039 class.
10040 """
54f9ee45 10041 newobj = _core_.new_PySizer(*args, **kwargs)
d14a1e28
RD
10042 self.this = newobj.this
10043 self.thisown = 1
10044 del newobj.thisown
10045 self._setCallbackInfo(self, PySizer);self._setOORInfo(self)
e811c8ce
RD
10046
10047 def _setCallbackInfo(*args, **kwargs):
a95a7133 10048 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
54f9ee45 10049 return _core_.PySizer__setCallbackInfo(*args, **kwargs)
e811c8ce 10050
d14a1e28
RD
10051
10052class PySizerPtr(PySizer):
10053 def __init__(self, this):
10054 self.this = this
10055 if not hasattr(self,"thisown"): self.thisown = 0
10056 self.__class__ = PySizer
54f9ee45 10057_core_.PySizer_swigregister(PySizerPtr)
d14a1e28
RD
10058
10059#---------------------------------------------------------------------------
10060
10061class BoxSizer(Sizer):
248ed943
RD
10062 """
10063 The basic idea behind a box sizer is that windows will most often be
10064 laid out in rather simple basic geometry, typically in a row or a
10065 column or nested hierarchies of either. A wx.BoxSizer will lay out
10066 its items in a simple row or column, depending on the orientation
10067 parameter passed to the constructor.
10068 """
e811c8ce
RD
10069 def __repr__(self):
10070 return "<%s.%s; proxy of C++ wxBoxSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 10071 def __init__(self, *args, **kwargs):
248ed943
RD
10072 """
10073 __init__(self, int orient=HORIZONTAL) -> BoxSizer
10074
10075 Constructor for a wx.BoxSizer. *orient* may be one of ``wx.VERTICAL``
10076 or ``wx.HORIZONTAL`` for creating either a column sizer or a row
10077 sizer.
10078 """
54f9ee45 10079 newobj = _core_.new_BoxSizer(*args, **kwargs)
d14a1e28
RD
10080 self.this = newobj.this
10081 self.thisown = 1
10082 del newobj.thisown
10083 self._setOORInfo(self)
e811c8ce
RD
10084
10085 def GetOrientation(*args, **kwargs):
248ed943
RD
10086 """
10087 GetOrientation(self) -> int
10088
10089 Returns the current orientation of the sizer.
10090 """
54f9ee45 10091 return _core_.BoxSizer_GetOrientation(*args, **kwargs)
e811c8ce
RD
10092
10093 def SetOrientation(*args, **kwargs):
248ed943
RD
10094 """
10095 SetOrientation(self, int orient)
e811c8ce 10096
248ed943
RD
10097 Resets the orientation of the sizer.
10098 """
10099 return _core_.BoxSizer_SetOrientation(*args, **kwargs)
e811c8ce 10100
d14a1e28
RD
10101
10102class BoxSizerPtr(BoxSizer):
10103 def __init__(self, this):
10104 self.this = this
10105 if not hasattr(self,"thisown"): self.thisown = 0
10106 self.__class__ = BoxSizer
54f9ee45 10107_core_.BoxSizer_swigregister(BoxSizerPtr)
d14a1e28
RD
10108
10109#---------------------------------------------------------------------------
10110
10111class StaticBoxSizer(BoxSizer):
248ed943
RD
10112 """
10113 wx.StaticBoxSizer derives from and functions identically to the
10114 `wx.BoxSizer` and adds a `wx.StaticBox` around the items that the sizer
10115 manages. Note that this static box must be created separately and
10116 passed to the sizer constructor.
10117 """
e811c8ce
RD
10118 def __repr__(self):
10119 return "<%s.%s; proxy of C++ wxStaticBoxSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 10120 def __init__(self, *args, **kwargs):
248ed943
RD
10121 """
10122 __init__(self, StaticBox box, int orient=HORIZONTAL) -> StaticBoxSizer
10123
10124 Constructor. It takes an associated static box and the orientation
10125 *orient* as parameters - orient can be either of ``wx.VERTICAL`` or
10126 ``wx.HORIZONTAL``.
10127 """
54f9ee45 10128 newobj = _core_.new_StaticBoxSizer(*args, **kwargs)
d14a1e28
RD
10129 self.this = newobj.this
10130 self.thisown = 1
10131 del newobj.thisown
10132 self._setOORInfo(self)
e811c8ce
RD
10133
10134 def GetStaticBox(*args, **kwargs):
248ed943
RD
10135 """
10136 GetStaticBox(self) -> StaticBox
e811c8ce 10137
248ed943
RD
10138 Returns the static box associated with this sizer.
10139 """
10140 return _core_.StaticBoxSizer_GetStaticBox(*args, **kwargs)
e811c8ce 10141
d14a1e28
RD
10142
10143class StaticBoxSizerPtr(StaticBoxSizer):
10144 def __init__(self, this):
10145 self.this = this
10146 if not hasattr(self,"thisown"): self.thisown = 0
10147 self.__class__ = StaticBoxSizer
54f9ee45 10148_core_.StaticBoxSizer_swigregister(StaticBoxSizerPtr)
d14a1e28
RD
10149
10150#---------------------------------------------------------------------------
10151
10152class GridSizer(Sizer):
248ed943
RD
10153 """
10154 A grid sizer is a sizer which lays out its children in a
10155 two-dimensional table with all cells having the same size. In other
10156 words, the width of each cell within the grid is the width of the
10157 widest item added to the sizer and the height of each grid cell is the
10158 height of the tallest item. An optional vertical and/or horizontal
10159 gap between items can also be specified (in pixels.)
10160
10161 Items are placed in the cells of the grid in the order they are added,
10162 in row-major order. In other words, the first row is filled first,
10163 then the second, and so on until all items have been added. (If
10164 neccessary, additional rows will be added as items are added.) If you
10165 need to have greater control over the cells that items are placed in
10166 then use the `wx.GridBagSizer`.
10167
10168 """
e811c8ce
RD
10169 def __repr__(self):
10170 return "<%s.%s; proxy of C++ wxGridSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 10171 def __init__(self, *args, **kwargs):
248ed943
RD
10172 """
10173 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> GridSizer
10174
10175 Constructor for a wx.GridSizer. *rows* and *cols* determine the number
10176 of columns and rows in the sizer - if either of the parameters is
10177 zero, it will be calculated to from the total number of children in
10178 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
10179 define extra space between all children.
10180 """
54f9ee45 10181 newobj = _core_.new_GridSizer(*args, **kwargs)
d14a1e28
RD
10182 self.this = newobj.this
10183 self.thisown = 1
10184 del newobj.thisown
10185 self._setOORInfo(self)
e811c8ce 10186
e811c8ce 10187 def SetCols(*args, **kwargs):
248ed943
RD
10188 """
10189 SetCols(self, int cols)
10190
10191 Sets the number of columns in the sizer.
10192 """
54f9ee45 10193 return _core_.GridSizer_SetCols(*args, **kwargs)
e811c8ce
RD
10194
10195 def SetRows(*args, **kwargs):
248ed943
RD
10196 """
10197 SetRows(self, int rows)
10198
10199 Sets the number of rows in the sizer.
10200 """
54f9ee45 10201 return _core_.GridSizer_SetRows(*args, **kwargs)
e811c8ce
RD
10202
10203 def SetVGap(*args, **kwargs):
248ed943
RD
10204 """
10205 SetVGap(self, int gap)
10206
10207 Sets the vertical gap (in pixels) between the cells in the sizer.
10208 """
54f9ee45 10209 return _core_.GridSizer_SetVGap(*args, **kwargs)
e811c8ce
RD
10210
10211 def SetHGap(*args, **kwargs):
248ed943
RD
10212 """
10213 SetHGap(self, int gap)
10214
10215 Sets the horizontal gap (in pixels) between cells in the sizer
10216 """
54f9ee45 10217 return _core_.GridSizer_SetHGap(*args, **kwargs)
e811c8ce
RD
10218
10219 def GetCols(*args, **kwargs):
248ed943
RD
10220 """
10221 GetCols(self) -> int
10222
10223 Returns the number of columns in the sizer.
10224 """
54f9ee45 10225 return _core_.GridSizer_GetCols(*args, **kwargs)
e811c8ce
RD
10226
10227 def GetRows(*args, **kwargs):
248ed943
RD
10228 """
10229 GetRows(self) -> int
10230
10231 Returns the number of rows in the sizer.
10232 """
54f9ee45 10233 return _core_.GridSizer_GetRows(*args, **kwargs)
e811c8ce
RD
10234
10235 def GetVGap(*args, **kwargs):
248ed943
RD
10236 """
10237 GetVGap(self) -> int
10238
10239 Returns the vertical gap (in pixels) between the cells in the sizer.
10240 """
54f9ee45 10241 return _core_.GridSizer_GetVGap(*args, **kwargs)
e811c8ce
RD
10242
10243 def GetHGap(*args, **kwargs):
248ed943
RD
10244 """
10245 GetHGap(self) -> int
10246
10247 Returns the horizontal gap (in pixels) between cells in the sizer.
10248 """
54f9ee45 10249 return _core_.GridSizer_GetHGap(*args, **kwargs)
e811c8ce 10250
d14a1e28
RD
10251
10252class GridSizerPtr(GridSizer):
10253 def __init__(self, this):
10254 self.this = this
10255 if not hasattr(self,"thisown"): self.thisown = 0
10256 self.__class__ = GridSizer
54f9ee45 10257_core_.GridSizer_swigregister(GridSizerPtr)
d14a1e28
RD
10258
10259#---------------------------------------------------------------------------
10260
54f9ee45
RD
10261FLEX_GROWMODE_NONE = _core_.FLEX_GROWMODE_NONE
10262FLEX_GROWMODE_SPECIFIED = _core_.FLEX_GROWMODE_SPECIFIED
10263FLEX_GROWMODE_ALL = _core_.FLEX_GROWMODE_ALL
d14a1e28 10264class FlexGridSizer(GridSizer):
248ed943
RD
10265 """
10266 A flex grid sizer is a sizer which lays out its children in a
10267 two-dimensional table with all table cells in one row having the same
10268 height and all cells in one column having the same width, but all
10269 rows or all columns are not necessarily the same height or width as in
10270 the `wx.GridSizer`.
10271
10272 wx.FlexGridSizer can also size items equally in one direction but
10273 unequally ("flexibly") in the other. If the sizer is only flexible
10274 in one direction (this can be changed using `SetFlexibleDirection`), it
10275 needs to be decided how the sizer should grow in the other ("non
10276 flexible") direction in order to fill the available space. The
10277 `SetNonFlexibleGrowMode` method serves this purpose.
10278
10279
10280 """
e811c8ce
RD
10281 def __repr__(self):
10282 return "<%s.%s; proxy of C++ wxFlexGridSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 10283 def __init__(self, *args, **kwargs):
248ed943
RD
10284 """
10285 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> FlexGridSizer
10286
10287 Constructor for a wx.FlexGridSizer. *rows* and *cols* determine the
10288 number of columns and rows in the sizer - if either of the parameters
10289 is zero, it will be calculated to from the total number of children in
10290 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
10291 define extra space between all children.
10292 """
54f9ee45 10293 newobj = _core_.new_FlexGridSizer(*args, **kwargs)
d14a1e28
RD
10294 self.this = newobj.this
10295 self.thisown = 1
10296 del newobj.thisown
10297 self._setOORInfo(self)
e811c8ce 10298
248ed943
RD
10299 def AddGrowableRow(*args, **kwargs):
10300 """
10301 AddGrowableRow(self, size_t idx, int proportion=0)
e811c8ce 10302
248ed943
RD
10303 Specifies that row *idx* (starting from zero) should be grown if there
10304 is extra space available to the sizer.
e811c8ce 10305
248ed943
RD
10306 The *proportion* parameter has the same meaning as the stretch factor
10307 for the box sizers except that if all proportions are 0, then all
10308 columns are resized equally (instead of not being resized at all).
10309 """
54f9ee45 10310 return _core_.FlexGridSizer_AddGrowableRow(*args, **kwargs)
e811c8ce
RD
10311
10312 def RemoveGrowableRow(*args, **kwargs):
248ed943
RD
10313 """
10314 RemoveGrowableRow(self, size_t idx)
10315
10316 Specifies that row *idx* is no longer growable.
10317 """
54f9ee45 10318 return _core_.FlexGridSizer_RemoveGrowableRow(*args, **kwargs)
e811c8ce
RD
10319
10320 def AddGrowableCol(*args, **kwargs):
248ed943
RD
10321 """
10322 AddGrowableCol(self, size_t idx, int proportion=0)
10323
10324 Specifies that column *idx* (starting from zero) should be grown if
10325 there is extra space available to the sizer.
10326
10327 The *proportion* parameter has the same meaning as the stretch factor
10328 for the box sizers except that if all proportions are 0, then all
10329 columns are resized equally (instead of not being resized at all).
10330 """
54f9ee45 10331 return _core_.FlexGridSizer_AddGrowableCol(*args, **kwargs)
e811c8ce
RD
10332
10333 def RemoveGrowableCol(*args, **kwargs):
248ed943
RD
10334 """
10335 RemoveGrowableCol(self, size_t idx)
10336
10337 Specifies that column *idx* is no longer growable.
10338 """
54f9ee45 10339 return _core_.FlexGridSizer_RemoveGrowableCol(*args, **kwargs)
e811c8ce
RD
10340
10341 def SetFlexibleDirection(*args, **kwargs):
248ed943
RD
10342 """
10343 SetFlexibleDirection(self, int direction)
10344
10345 Specifies whether the sizer should flexibly resize its columns, rows,
10346 or both. Argument *direction* can be one of the following values. Any
10347 other value is ignored.
10348
10349 ============== =======================================
10350 wx.VERTICAL Rows are flexibly sized.
10351 wx.HORIZONTAL Columns are flexibly sized.
10352 wx.BOTH Both rows and columns are flexibly sized
10353 (this is the default value).
10354 ============== =======================================
10355
10356 Note that this method does not trigger relayout.
10357
10358 """
54f9ee45 10359 return _core_.FlexGridSizer_SetFlexibleDirection(*args, **kwargs)
e811c8ce
RD
10360
10361 def GetFlexibleDirection(*args, **kwargs):
248ed943
RD
10362 """
10363 GetFlexibleDirection(self) -> int
10364
10365 Returns a value that specifies whether the sizer
10366 flexibly resizes its columns, rows, or both (default).
10367
10368 :see: `SetFlexibleDirection`
10369 """
54f9ee45 10370 return _core_.FlexGridSizer_GetFlexibleDirection(*args, **kwargs)
e811c8ce
RD
10371
10372 def SetNonFlexibleGrowMode(*args, **kwargs):
248ed943
RD
10373 """
10374 SetNonFlexibleGrowMode(self, int mode)
10375
10376 Specifies how the sizer should grow in the non-flexible direction if
10377 there is one (so `SetFlexibleDirection` must have been called
10378 previously). Argument *mode* can be one of the following values:
10379
10380 ========================== =================================================
10381 wx.FLEX_GROWMODE_NONE Sizer doesn't grow in the non flexible direction.
10382 wx.FLEX_GROWMODE_SPECIFIED Sizer honors growable columns/rows set with
10383 `AddGrowableCol` and `AddGrowableRow`. In this
10384 case equal sizing applies to minimum sizes of
10385 columns or rows (this is the default value).
10386 wx.FLEX_GROWMODE_ALL Sizer equally stretches all columns or rows in
10387 the non flexible direction, whether they are
10388 growable or not in the flexbile direction.
10389 ========================== =================================================
10390
10391 Note that this method does not trigger relayout.
10392
10393
10394 """
54f9ee45 10395 return _core_.FlexGridSizer_SetNonFlexibleGrowMode(*args, **kwargs)
e811c8ce
RD
10396
10397 def GetNonFlexibleGrowMode(*args, **kwargs):
248ed943
RD
10398 """
10399 GetNonFlexibleGrowMode(self) -> int
10400
10401 Returns the value that specifies how the sizer grows in the
10402 non-flexible direction if there is one.
10403
10404 :see: `SetNonFlexibleGrowMode`
10405 """
54f9ee45 10406 return _core_.FlexGridSizer_GetNonFlexibleGrowMode(*args, **kwargs)
e811c8ce
RD
10407
10408 def GetRowHeights(*args, **kwargs):
fd2dc343
RD
10409 """
10410 GetRowHeights(self) -> list
10411
10412 Returns a list of integers representing the heights of each of the
10413 rows in the sizer.
10414 """
54f9ee45 10415 return _core_.FlexGridSizer_GetRowHeights(*args, **kwargs)
e811c8ce
RD
10416
10417 def GetColWidths(*args, **kwargs):
fd2dc343
RD
10418 """
10419 GetColWidths(self) -> list
10420
10421 Returns a list of integers representing the widths of each of the
10422 columns in the sizer.
10423 """
54f9ee45 10424 return _core_.FlexGridSizer_GetColWidths(*args, **kwargs)
e811c8ce 10425
d14a1e28
RD
10426
10427class FlexGridSizerPtr(FlexGridSizer):
10428 def __init__(self, this):
10429 self.this = this
10430 if not hasattr(self,"thisown"): self.thisown = 0
10431 self.__class__ = FlexGridSizer
54f9ee45 10432_core_.FlexGridSizer_swigregister(FlexGridSizerPtr)
d14a1e28 10433
e505d15e
RD
10434class StdDialogButtonSizer(BoxSizer):
10435 """
10436 A special sizer that knows how to order and position standard buttons
10437 in order to conform to the current platform's standards. You simply
10438 need to add each `wx.Button` to the sizer, and be sure to create the
53aa7709 10439 buttons using the standard ID's. Then call `Realize` and the sizer
e505d15e
RD
10440 will take care of the rest.
10441
10442 """
10443 def __repr__(self):
10444 return "<%s.%s; proxy of C++ wxStdDialogButtonSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
10445 def __init__(self, *args, **kwargs):
10446 """__init__(self) -> StdDialogButtonSizer"""
10447 newobj = _core_.new_StdDialogButtonSizer(*args, **kwargs)
10448 self.this = newobj.this
10449 self.thisown = 1
10450 del newobj.thisown
10451 def AddButton(*args, **kwargs):
10452 """
10453 AddButton(self, wxButton button)
10454
10455 Use this to add the buttons to this sizer. Do not use the `Add`
10456 method in the base class.
10457 """
10458 return _core_.StdDialogButtonSizer_AddButton(*args, **kwargs)
10459
53aa7709 10460 def Realize(*args, **kwargs):
e505d15e 10461 """
53aa7709 10462 Realize(self)
e505d15e
RD
10463
10464 This funciton needs to be called after all the buttons have been added
10465 to the sizer. It will reorder them and position them in a platform
10466 specifc manner.
10467 """
53aa7709 10468 return _core_.StdDialogButtonSizer_Realize(*args, **kwargs)
51b83b37
RD
10469
10470 def SetAffirmativeButton(*args, **kwargs):
10471 """SetAffirmativeButton(self, wxButton button)"""
10472 return _core_.StdDialogButtonSizer_SetAffirmativeButton(*args, **kwargs)
10473
10474 def SetNegativeButton(*args, **kwargs):
10475 """SetNegativeButton(self, wxButton button)"""
10476 return _core_.StdDialogButtonSizer_SetNegativeButton(*args, **kwargs)
10477
10478 def SetCancelButton(*args, **kwargs):
10479 """SetCancelButton(self, wxButton button)"""
10480 return _core_.StdDialogButtonSizer_SetCancelButton(*args, **kwargs)
e505d15e
RD
10481
10482 def GetAffirmativeButton(*args, **kwargs):
10483 """GetAffirmativeButton(self) -> wxButton"""
10484 return _core_.StdDialogButtonSizer_GetAffirmativeButton(*args, **kwargs)
10485
10486 def GetApplyButton(*args, **kwargs):
10487 """GetApplyButton(self) -> wxButton"""
10488 return _core_.StdDialogButtonSizer_GetApplyButton(*args, **kwargs)
10489
10490 def GetNegativeButton(*args, **kwargs):
10491 """GetNegativeButton(self) -> wxButton"""
10492 return _core_.StdDialogButtonSizer_GetNegativeButton(*args, **kwargs)
10493
10494 def GetCancelButton(*args, **kwargs):
10495 """GetCancelButton(self) -> wxButton"""
10496 return _core_.StdDialogButtonSizer_GetCancelButton(*args, **kwargs)
10497
10498 def GetHelpButton(*args, **kwargs):
10499 """GetHelpButton(self) -> wxButton"""
10500 return _core_.StdDialogButtonSizer_GetHelpButton(*args, **kwargs)
10501
10502
10503class StdDialogButtonSizerPtr(StdDialogButtonSizer):
10504 def __init__(self, this):
10505 self.this = this
10506 if not hasattr(self,"thisown"): self.thisown = 0
10507 self.__class__ = StdDialogButtonSizer
10508_core_.StdDialogButtonSizer_swigregister(StdDialogButtonSizerPtr)
10509
d14a1e28
RD
10510#---------------------------------------------------------------------------
10511
10512class GBPosition(object):
248ed943
RD
10513 """
10514 This class represents the position of an item in a virtual grid of
10515 rows and columns managed by a `wx.GridBagSizer`. wxPython has
10516 typemaps that will automatically convert from a 2-element sequence of
10517 integers to a wx.GBPosition, so you can use the more pythonic
10518 representation of the position nearly transparently in Python code.
10519 """
e811c8ce
RD
10520 def __repr__(self):
10521 return "<%s.%s; proxy of C++ wxGBPosition instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 10522 def __init__(self, *args, **kwargs):
248ed943
RD
10523 """
10524 __init__(self, int row=0, int col=0) -> GBPosition
10525
10526 This class represents the position of an item in a virtual grid of
10527 rows and columns managed by a `wx.GridBagSizer`. wxPython has
10528 typemaps that will automatically convert from a 2-element sequence of
10529 integers to a wx.GBPosition, so you can use the more pythonic
10530 representation of the position nearly transparently in Python code.
10531 """
54f9ee45 10532 newobj = _core_.new_GBPosition(*args, **kwargs)
d14a1e28
RD
10533 self.this = newobj.this
10534 self.thisown = 1
10535 del newobj.thisown
e811c8ce 10536 def GetRow(*args, **kwargs):
a95a7133 10537 """GetRow(self) -> int"""
54f9ee45 10538 return _core_.GBPosition_GetRow(*args, **kwargs)
e811c8ce
RD
10539
10540 def GetCol(*args, **kwargs):
a95a7133 10541 """GetCol(self) -> int"""
54f9ee45 10542 return _core_.GBPosition_GetCol(*args, **kwargs)
e811c8ce
RD
10543
10544 def SetRow(*args, **kwargs):
a95a7133 10545 """SetRow(self, int row)"""
54f9ee45 10546 return _core_.GBPosition_SetRow(*args, **kwargs)
e811c8ce
RD
10547
10548 def SetCol(*args, **kwargs):
a95a7133 10549 """SetCol(self, int col)"""
54f9ee45 10550 return _core_.GBPosition_SetCol(*args, **kwargs)
e811c8ce
RD
10551
10552 def __eq__(*args, **kwargs):
a95a7133 10553 """__eq__(self, GBPosition other) -> bool"""
54f9ee45 10554 return _core_.GBPosition___eq__(*args, **kwargs)
e811c8ce
RD
10555
10556 def __ne__(*args, **kwargs):
a95a7133 10557 """__ne__(self, GBPosition other) -> bool"""
54f9ee45 10558 return _core_.GBPosition___ne__(*args, **kwargs)
e811c8ce
RD
10559
10560 def Set(*args, **kwargs):
a95a7133 10561 """Set(self, int row=0, int col=0)"""
54f9ee45 10562 return _core_.GBPosition_Set(*args, **kwargs)
e811c8ce
RD
10563
10564 def Get(*args, **kwargs):
a95a7133 10565 """Get(self) -> PyObject"""
54f9ee45 10566 return _core_.GBPosition_Get(*args, **kwargs)
e811c8ce 10567
41e2b43e 10568 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
e811c8ce
RD
10569 def __str__(self): return str(self.Get())
10570 def __repr__(self): return 'wx.GBPosition'+str(self.Get())
10571 def __len__(self): return len(self.Get())
10572 def __getitem__(self, index): return self.Get()[index]
d14a1e28
RD
10573 def __setitem__(self, index, val):
10574 if index == 0: self.SetRow(val)
10575 elif index == 1: self.SetCol(val)
10576 else: raise IndexError
e811c8ce 10577 def __nonzero__(self): return self.Get() != (0,0)
74e96f3d
RD
10578 __safe_for_unpickling__ = True
10579 def __reduce__(self): return (wx.GBPosition, self.Get())
d14a1e28
RD
10580
10581 row = property(GetRow, SetRow)
10582 col = property(GetCol, SetCol)
10583
10584
10585class GBPositionPtr(GBPosition):
10586 def __init__(self, this):
10587 self.this = this
10588 if not hasattr(self,"thisown"): self.thisown = 0
10589 self.__class__ = GBPosition
54f9ee45 10590_core_.GBPosition_swigregister(GBPositionPtr)
d14a1e28
RD
10591
10592class GBSpan(object):
248ed943
RD
10593 """
10594 This class is used to hold the row and column spanning attributes of
10595 items in a `wx.GridBagSizer`. wxPython has typemaps that will
10596 automatically convert from a 2-element sequence of integers to a
10597 wx.GBSpan, so you can use the more pythonic representation of the span
10598 nearly transparently in Python code.
10599
10600 """
e811c8ce
RD
10601 def __repr__(self):
10602 return "<%s.%s; proxy of C++ wxGBSpan instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 10603 def __init__(self, *args, **kwargs):
248ed943
RD
10604 """
10605 __init__(self, int rowspan=1, int colspan=1) -> GBSpan
10606
10607 Construct a new wxGBSpan, optionally setting the rowspan and
10608 colspan. The default is (1,1). (Meaning that the item occupies one
10609 cell in each direction.
10610 """
54f9ee45 10611 newobj = _core_.new_GBSpan(*args, **kwargs)
d14a1e28
RD
10612 self.this = newobj.this
10613 self.thisown = 1
10614 del newobj.thisown
e811c8ce 10615 def GetRowspan(*args, **kwargs):
a95a7133 10616 """GetRowspan(self) -> int"""
54f9ee45 10617 return _core_.GBSpan_GetRowspan(*args, **kwargs)
e811c8ce
RD
10618
10619 def GetColspan(*args, **kwargs):
a95a7133 10620 """GetColspan(self) -> int"""
54f9ee45 10621 return _core_.GBSpan_GetColspan(*args, **kwargs)
e811c8ce
RD
10622
10623 def SetRowspan(*args, **kwargs):
a95a7133 10624 """SetRowspan(self, int rowspan)"""
54f9ee45 10625 return _core_.GBSpan_SetRowspan(*args, **kwargs)
e811c8ce
RD
10626
10627 def SetColspan(*args, **kwargs):
a95a7133 10628 """SetColspan(self, int colspan)"""
54f9ee45 10629 return _core_.GBSpan_SetColspan(*args, **kwargs)
e811c8ce
RD
10630
10631 def __eq__(*args, **kwargs):
a95a7133 10632 """__eq__(self, GBSpan other) -> bool"""
54f9ee45 10633 return _core_.GBSpan___eq__(*args, **kwargs)
e811c8ce
RD
10634
10635 def __ne__(*args, **kwargs):
a95a7133 10636 """__ne__(self, GBSpan other) -> bool"""
54f9ee45 10637 return _core_.GBSpan___ne__(*args, **kwargs)
e811c8ce
RD
10638
10639 def Set(*args, **kwargs):
a95a7133 10640 """Set(self, int rowspan=1, int colspan=1)"""
54f9ee45 10641 return _core_.GBSpan_Set(*args, **kwargs)
e811c8ce
RD
10642
10643 def Get(*args, **kwargs):
a95a7133 10644 """Get(self) -> PyObject"""
54f9ee45 10645 return _core_.GBSpan_Get(*args, **kwargs)
e811c8ce 10646
41e2b43e 10647 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
e811c8ce
RD
10648 def __str__(self): return str(self.Get())
10649 def __repr__(self): return 'wx.GBSpan'+str(self.Get())
10650 def __len__(self): return len(self.Get())
10651 def __getitem__(self, index): return self.Get()[index]
d14a1e28
RD
10652 def __setitem__(self, index, val):
10653 if index == 0: self.SetRowspan(val)
10654 elif index == 1: self.SetColspan(val)
10655 else: raise IndexError
e811c8ce 10656 def __nonzero__(self): return self.Get() != (0,0)
74e96f3d
RD
10657 __safe_for_unpickling__ = True
10658 def __reduce__(self): return (wx.GBSpan, self.Get())
d14a1e28
RD
10659
10660 rowspan = property(GetRowspan, SetRowspan)
10661 colspan = property(GetColspan, SetColspan)
10662
10663
10664class GBSpanPtr(GBSpan):
10665 def __init__(self, this):
10666 self.this = this
10667 if not hasattr(self,"thisown"): self.thisown = 0
10668 self.__class__ = GBSpan
54f9ee45 10669_core_.GBSpan_swigregister(GBSpanPtr)
d14a1e28
RD
10670
10671class GBSizerItem(SizerItem):
248ed943
RD
10672 """
10673 The wx.GBSizerItem class is used to track the additional data about
10674 items in a `wx.GridBagSizer` such as the item's position in the grid
10675 and how many rows or columns it spans.
10676
10677 """
e811c8ce
RD
10678 def __repr__(self):
10679 return "<%s.%s; proxy of C++ wxGBSizerItem instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 10680 def __init__(self, *args, **kwargs):
248ed943
RD
10681 """
10682 __init__(self) -> GBSizerItem
10683
10684 Constructs an empty wx.GBSizerItem. Either a window, sizer or spacer
10685 size will need to be set, as well as a position and span before this
10686 item can be used in a Sizer.
10687
10688 You will probably never need to create a wx.GBSizerItem directly as they
10689 are created automatically when the sizer's Add method is called.
10690 """
54f9ee45 10691 newobj = _core_.new_GBSizerItem(*args, **kwargs)
d14a1e28
RD
10692 self.this = newobj.this
10693 self.thisown = 1
10694 del newobj.thisown
e811c8ce 10695 def GetPos(*args, **kwargs):
248ed943
RD
10696 """
10697 GetPos(self) -> GBPosition
10698
10699 Get the grid position of the item
10700 """
54f9ee45 10701 return _core_.GBSizerItem_GetPos(*args, **kwargs)
e811c8ce
RD
10702
10703 def GetPosTuple(self): return self.GetPos().Get()
10704 def GetSpan(*args, **kwargs):
248ed943
RD
10705 """
10706 GetSpan(self) -> GBSpan
10707
10708 Get the row and column spanning of the item
10709 """
54f9ee45 10710 return _core_.GBSizerItem_GetSpan(*args, **kwargs)
e811c8ce
RD
10711
10712 def GetSpanTuple(self): return self.GetSpan().Get()
10713 def SetPos(*args, **kwargs):
248ed943
RD
10714 """
10715 SetPos(self, GBPosition pos) -> bool
10716
10717 If the item is already a member of a sizer then first ensure that
10718 there is no other item that would intersect with this one at the new
10719 position, then set the new position. Returns True if the change is
10720 successful and after the next Layout() the item will be moved.
10721 """
54f9ee45 10722 return _core_.GBSizerItem_SetPos(*args, **kwargs)
e811c8ce
RD
10723
10724 def SetSpan(*args, **kwargs):
248ed943
RD
10725 """
10726 SetSpan(self, GBSpan span) -> bool
10727
10728 If the item is already a member of a sizer then first ensure that
10729 there is no other item that would intersect with this one with its new
10730 spanning size, then set the new spanning. Returns True if the change
10731 is successful and after the next Layout() the item will be resized.
10732
10733 """
54f9ee45 10734 return _core_.GBSizerItem_SetSpan(*args, **kwargs)
e811c8ce 10735
248ed943 10736 def Intersects(*args, **kwargs):
0df68c9f 10737 """
a95a7133 10738 Intersects(self, GBSizerItem other) -> bool
248ed943
RD
10739
10740 Returns True if this item and the other item instersect.
0df68c9f 10741 """
248ed943
RD
10742 return _core_.GBSizerItem_Intersects(*args, **kwargs)
10743
10744 def IntersectsPos(*args, **kwargs):
10745 """
10746 IntersectsPos(self, GBPosition pos, GBSpan span) -> bool
10747
10748 Returns True if the given pos/span would intersect with this item.
10749 """
10750 return _core_.GBSizerItem_IntersectsPos(*args, **kwargs)
e811c8ce
RD
10751
10752 def GetEndPos(*args, **kwargs):
248ed943
RD
10753 """
10754 GetEndPos(self) -> GBPosition
10755
10756 Get the row and column of the endpoint of this item.
10757 """
54f9ee45 10758 return _core_.GBSizerItem_GetEndPos(*args, **kwargs)
e811c8ce
RD
10759
10760 def GetGBSizer(*args, **kwargs):
248ed943
RD
10761 """
10762 GetGBSizer(self) -> GridBagSizer
10763
10764 Get the sizer this item is a member of.
10765 """
54f9ee45 10766 return _core_.GBSizerItem_GetGBSizer(*args, **kwargs)
e811c8ce
RD
10767
10768 def SetGBSizer(*args, **kwargs):
248ed943
RD
10769 """
10770 SetGBSizer(self, GridBagSizer sizer)
10771
10772 Set the sizer this item is a member of.
10773 """
54f9ee45 10774 return _core_.GBSizerItem_SetGBSizer(*args, **kwargs)
e811c8ce 10775
d14a1e28
RD
10776
10777class GBSizerItemPtr(GBSizerItem):
10778 def __init__(self, this):
10779 self.this = this
10780 if not hasattr(self,"thisown"): self.thisown = 0
10781 self.__class__ = GBSizerItem
54f9ee45 10782_core_.GBSizerItem_swigregister(GBSizerItemPtr)
d14a1e28
RD
10783DefaultSpan = cvar.DefaultSpan
10784
10785def GBSizerItemWindow(*args, **kwargs):
0df68c9f
RD
10786 """
10787 GBSizerItemWindow(Window window, GBPosition pos, GBSpan span, int flag,
248ed943
RD
10788 int border, PyObject userData=None) -> GBSizerItem
10789
10790 Construct a `wx.GBSizerItem` for a window.
0df68c9f 10791 """
54f9ee45 10792 val = _core_.new_GBSizerItemWindow(*args, **kwargs)
d14a1e28
RD
10793 val.thisown = 1
10794 return val
10795
10796def GBSizerItemSizer(*args, **kwargs):
0df68c9f
RD
10797 """
10798 GBSizerItemSizer(Sizer sizer, GBPosition pos, GBSpan span, int flag,
248ed943
RD
10799 int border, PyObject userData=None) -> GBSizerItem
10800
10801 Construct a `wx.GBSizerItem` for a sizer
0df68c9f 10802 """
54f9ee45 10803 val = _core_.new_GBSizerItemSizer(*args, **kwargs)
d14a1e28
RD
10804 val.thisown = 1
10805 return val
10806
10807def GBSizerItemSpacer(*args, **kwargs):
0df68c9f
RD
10808 """
10809 GBSizerItemSpacer(int width, int height, GBPosition pos, GBSpan span,
248ed943
RD
10810 int flag, int border, PyObject userData=None) -> GBSizerItem
10811
10812 Construct a `wx.GBSizerItem` for a spacer.
0df68c9f 10813 """
54f9ee45 10814 val = _core_.new_GBSizerItemSpacer(*args, **kwargs)
d14a1e28
RD
10815 val.thisown = 1
10816 return val
10817
10818class GridBagSizer(FlexGridSizer):
248ed943
RD
10819 """
10820 A `wx.Sizer` that can lay out items in a virtual grid like a
10821 `wx.FlexGridSizer` but in this case explicit positioning of the items
10822 is allowed using `wx.GBPosition`, and items can optionally span more
10823 than one row and/or column using `wx.GBSpan`. The total size of the
10824 virtual grid is determined by the largest row and column that items are
10825 positioned at, adjusted for spanning.
10826
10827 """
e811c8ce
RD
10828 def __repr__(self):
10829 return "<%s.%s; proxy of C++ wxGridBagSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 10830 def __init__(self, *args, **kwargs):
248ed943
RD
10831 """
10832 __init__(self, int vgap=0, int hgap=0) -> GridBagSizer
10833
10834 Constructor, with optional parameters to specify the gap between the
10835 rows and columns.
10836 """
54f9ee45 10837 newobj = _core_.new_GridBagSizer(*args, **kwargs)
d14a1e28
RD
10838 self.this = newobj.this
10839 self.thisown = 1
10840 del newobj.thisown
1823fbb4
RD
10841 self._setOORInfo(self)
10842
e811c8ce 10843 def Add(*args, **kwargs):
0df68c9f 10844 """
248ed943 10845 Add(self, item, GBPosition pos, GBSpan span=DefaultSpan, int flag=0,
d3b6e4ff 10846 int border=0, userData=None) -> wx.GBSizerItem
248ed943
RD
10847
10848 Adds an item to the sizer at the grid cell *pos*, optionally spanning
10849 more than one row or column as specified with *span*. The remaining
10850 args behave similarly to `wx.Sizer.Add`.
10851
10852 Returns True if the item was successfully placed at the given cell
10853 position, False if something was already there.
10854
0df68c9f 10855 """
54f9ee45 10856 return _core_.GridBagSizer_Add(*args, **kwargs)
e811c8ce
RD
10857
10858 def AddItem(*args, **kwargs):
248ed943 10859 """
d3b6e4ff 10860 Add(self, GBSizerItem item) -> wx.GBSizerItem
248ed943
RD
10861
10862 Add an item to the sizer using a `wx.GBSizerItem`. Returns True if
10863 the item was successfully placed at its given cell position, False if
10864 something was already there.
10865 """
54f9ee45 10866 return _core_.GridBagSizer_AddItem(*args, **kwargs)
e811c8ce 10867
84f85550
RD
10868 def GetCellSize(*args, **kwargs):
10869 """
10870 GetCellSize(self, int row, int col) -> Size
10871
10872 Get the size of the specified cell, including hgap and
10873 vgap. Only valid after a Layout.
10874 """
10875 return _core_.GridBagSizer_GetCellSize(*args, **kwargs)
10876
e811c8ce 10877 def GetEmptyCellSize(*args, **kwargs):
248ed943
RD
10878 """
10879 GetEmptyCellSize(self) -> Size
10880
10881 Get the size used for cells in the grid with no item.
10882 """
54f9ee45 10883 return _core_.GridBagSizer_GetEmptyCellSize(*args, **kwargs)
e811c8ce
RD
10884
10885 def SetEmptyCellSize(*args, **kwargs):
248ed943
RD
10886 """
10887 SetEmptyCellSize(self, Size sz)
10888
10889 Set the size used for cells in the grid with no item.
10890 """
54f9ee45 10891 return _core_.GridBagSizer_SetEmptyCellSize(*args, **kwargs)
e811c8ce
RD
10892
10893 def GetItemPosition(*args):
0df68c9f 10894 """
248ed943
RD
10895 GetItemPosition(self, item) -> GBPosition
10896
10897 Get the grid position of the specified *item* where *item* is either a
10898 window or subsizer that is a member of this sizer, or a zero-based
10899 index of an item.
0df68c9f 10900 """
54f9ee45 10901 return _core_.GridBagSizer_GetItemPosition(*args)
e811c8ce
RD
10902
10903 def SetItemPosition(*args):
0df68c9f 10904 """
248ed943
RD
10905 SetItemPosition(self, item, GBPosition pos) -> bool
10906
10907 Set the grid position of the specified *item* where *item* is either a
10908 window or subsizer that is a member of this sizer, or a zero-based
10909 index of an item. Returns True on success. If the move is not
10910 allowed (because an item is already there) then False is returned.
10911
0df68c9f 10912 """
54f9ee45 10913 return _core_.GridBagSizer_SetItemPosition(*args)
e811c8ce
RD
10914
10915 def GetItemSpan(*args):
0df68c9f 10916 """
248ed943
RD
10917 GetItemSpan(self, item) -> GBSpan
10918
10919 Get the row/col spanning of the specified *item* where *item* is
10920 either a window or subsizer that is a member of this sizer, or a
10921 zero-based index of an item.
0df68c9f 10922 """
54f9ee45 10923 return _core_.GridBagSizer_GetItemSpan(*args)
e811c8ce
RD
10924
10925 def SetItemSpan(*args):
0df68c9f 10926 """
248ed943
RD
10927 SetItemSpan(self, item, GBSpan span) -> bool
10928
10929 Set the row/col spanning of the specified *item* where *item* is
10930 either a window or subsizer that is a member of this sizer, or a
10931 zero-based index of an item. Returns True on success. If the move is
10932 not allowed (because an item is already there) then False is returned.
0df68c9f 10933 """
54f9ee45 10934 return _core_.GridBagSizer_SetItemSpan(*args)
e811c8ce
RD
10935
10936 def FindItem(*args):
0df68c9f 10937 """
248ed943
RD
10938 FindItem(self, item) -> GBSizerItem
10939
10940 Find the sizer item for the given window or subsizer, returns None if
10941 not found. (non-recursive)
0df68c9f 10942 """
54f9ee45 10943 return _core_.GridBagSizer_FindItem(*args)
e811c8ce
RD
10944
10945 def FindItemAtPosition(*args, **kwargs):
248ed943
RD
10946 """
10947 FindItemAtPosition(self, GBPosition pos) -> GBSizerItem
10948
10949 Return the sizer item for the given grid cell, or None if there is no
10950 item at that position. (non-recursive)
10951 """
54f9ee45 10952 return _core_.GridBagSizer_FindItemAtPosition(*args, **kwargs)
e811c8ce
RD
10953
10954 def FindItemAtPoint(*args, **kwargs):
248ed943
RD
10955 """
10956 FindItemAtPoint(self, Point pt) -> GBSizerItem
10957
10958 Return the sizer item located at the point given in *pt*, or None if
10959 there is no item at that point. The (x,y) coordinates in pt correspond
10960 to the client coordinates of the window using the sizer for
10961 layout. (non-recursive)
10962 """
54f9ee45 10963 return _core_.GridBagSizer_FindItemAtPoint(*args, **kwargs)
e811c8ce 10964
248ed943
RD
10965 def CheckForIntersection(*args, **kwargs):
10966 """
10967 CheckForIntersection(self, GBSizerItem item, GBSizerItem excludeItem=None) -> bool
e811c8ce 10968
248ed943
RD
10969 Look at all items and see if any intersect (or would overlap) the
10970 given *item*. Returns True if so, False if there would be no overlap.
10971 If an *excludeItem* is given then it will not be checked for
10972 intersection, for example it may be the item we are checking the
10973 position of.
e811c8ce 10974
248ed943
RD
10975 """
10976 return _core_.GridBagSizer_CheckForIntersection(*args, **kwargs)
e811c8ce 10977
248ed943 10978 def CheckForIntersectionPos(*args, **kwargs):
0df68c9f 10979 """
248ed943
RD
10980 CheckForIntersectionPos(self, GBPosition pos, GBSpan span, GBSizerItem excludeItem=None) -> bool
10981
10982 Look at all items and see if any intersect (or would overlap) the
10983 given position and span. Returns True if so, False if there would be
10984 no overlap. If an *excludeItem* is given then it will not be checked
10985 for intersection, for example it may be the item we are checking the
10986 position of.
0df68c9f 10987 """
248ed943 10988 return _core_.GridBagSizer_CheckForIntersectionPos(*args, **kwargs)
e811c8ce 10989
d14a1e28
RD
10990
10991class GridBagSizerPtr(GridBagSizer):
10992 def __init__(self, this):
10993 self.this = this
10994 if not hasattr(self,"thisown"): self.thisown = 0
10995 self.__class__ = GridBagSizer
54f9ee45 10996_core_.GridBagSizer_swigregister(GridBagSizerPtr)
d14a1e28
RD
10997
10998#---------------------------------------------------------------------------
10999
54f9ee45
RD
11000Left = _core_.Left
11001Top = _core_.Top
11002Right = _core_.Right
11003Bottom = _core_.Bottom
11004Width = _core_.Width
11005Height = _core_.Height
11006Centre = _core_.Centre
11007Center = _core_.Center
11008CentreX = _core_.CentreX
11009CentreY = _core_.CentreY
11010Unconstrained = _core_.Unconstrained
11011AsIs = _core_.AsIs
11012PercentOf = _core_.PercentOf
11013Above = _core_.Above
11014Below = _core_.Below
11015LeftOf = _core_.LeftOf
11016RightOf = _core_.RightOf
11017SameAs = _core_.SameAs
11018Absolute = _core_.Absolute
d14a1e28 11019class IndividualLayoutConstraint(Object):
15afbcd0 11020 """
41e2b43e
RD
11021 Objects of this class are stored in the `wx.LayoutConstraints` class as
11022 one of eight possible constraints that a window can be involved in.
11023 You will never need to create an instance of
11024 wx.IndividualLayoutConstraint, rather you should create a
11025 `wx.LayoutConstraints` instance and use the individual contstraints
15afbcd0 11026 that it contains.
15afbcd0 11027 """
d14a1e28
RD
11028 def __init__(self): raise RuntimeError, "No constructor defined"
11029 def __repr__(self):
11030 return "<%s.%s; proxy of C++ wxIndividualLayoutConstraint instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
e811c8ce 11031 def Set(*args, **kwargs):
41e2b43e
RD
11032 """
11033 Set(self, int rel, Window otherW, int otherE, int val=0, int marg=wxLAYOUT_DEFAULT_MARGIN)
11034
11035 Sets the properties of the constraint. Normally called by one of the
11036 convenience functions such as Above, RightOf, SameAs.
11037 """
54f9ee45 11038 return _core_.IndividualLayoutConstraint_Set(*args, **kwargs)
e811c8ce
RD
11039
11040 def LeftOf(*args, **kwargs):
15afbcd0 11041 """
a95a7133 11042 LeftOf(self, Window sibling, int marg=0)
15afbcd0 11043
41e2b43e
RD
11044 Constrains this edge to be to the left of the given window, with an
11045 optional margin. Implicitly, this is relative to the left edge of the
11046 other window.
15afbcd0 11047 """
54f9ee45 11048 return _core_.IndividualLayoutConstraint_LeftOf(*args, **kwargs)
e811c8ce
RD
11049
11050 def RightOf(*args, **kwargs):
15afbcd0 11051 """
a95a7133 11052 RightOf(self, Window sibling, int marg=0)
15afbcd0 11053
41e2b43e
RD
11054 Constrains this edge to be to the right of the given window, with an
11055 optional margin. Implicitly, this is relative to the right edge of the
11056 other window.
15afbcd0 11057 """
54f9ee45 11058 return _core_.IndividualLayoutConstraint_RightOf(*args, **kwargs)
e811c8ce
RD
11059
11060 def Above(*args, **kwargs):
15afbcd0 11061 """
a95a7133 11062 Above(self, Window sibling, int marg=0)
15afbcd0 11063
41e2b43e
RD
11064 Constrains this edge to be above the given window, with an optional
11065 margin. Implicitly, this is relative to the top edge of the other
11066 window.
15afbcd0 11067 """
54f9ee45 11068 return _core_.IndividualLayoutConstraint_Above(*args, **kwargs)
e811c8ce
RD
11069
11070 def Below(*args, **kwargs):
15afbcd0 11071 """
a95a7133 11072 Below(self, Window sibling, int marg=0)
15afbcd0 11073
41e2b43e
RD
11074 Constrains this edge to be below the given window, with an optional
11075 margin. Implicitly, this is relative to the bottom edge of the other
11076 window.
15afbcd0 11077 """
54f9ee45 11078 return _core_.IndividualLayoutConstraint_Below(*args, **kwargs)
e811c8ce
RD
11079
11080 def SameAs(*args, **kwargs):
15afbcd0 11081 """
a95a7133 11082 SameAs(self, Window otherW, int edge, int marg=0)
15afbcd0 11083
41e2b43e
RD
11084 Constrains this edge or dimension to be to the same as the edge of the
11085 given window, with an optional margin.
15afbcd0 11086 """
54f9ee45 11087 return _core_.IndividualLayoutConstraint_SameAs(*args, **kwargs)
e811c8ce
RD
11088
11089 def PercentOf(*args, **kwargs):
15afbcd0 11090 """
a95a7133 11091 PercentOf(self, Window otherW, int wh, int per)
15afbcd0 11092
41e2b43e
RD
11093 Constrains this edge or dimension to be to a percentage of the given
11094 window, with an optional margin.
15afbcd0 11095 """
54f9ee45 11096 return _core_.IndividualLayoutConstraint_PercentOf(*args, **kwargs)
e811c8ce
RD
11097
11098 def Absolute(*args, **kwargs):
15afbcd0 11099 """
a95a7133 11100 Absolute(self, int val)
15afbcd0 11101
41e2b43e 11102 Constrains this edge or dimension to be the given absolute value.
15afbcd0 11103 """
54f9ee45 11104 return _core_.IndividualLayoutConstraint_Absolute(*args, **kwargs)
e811c8ce
RD
11105
11106 def Unconstrained(*args, **kwargs):
15afbcd0 11107 """
a95a7133 11108 Unconstrained(self)
15afbcd0 11109
41e2b43e
RD
11110 Sets this edge or dimension to be unconstrained, that is, dependent on
11111 other edges and dimensions from which this value can be deduced.
15afbcd0 11112 """
54f9ee45 11113 return _core_.IndividualLayoutConstraint_Unconstrained(*args, **kwargs)
e811c8ce
RD
11114
11115 def AsIs(*args, **kwargs):
15afbcd0 11116 """
a95a7133 11117 AsIs(self)
15afbcd0 11118
41e2b43e
RD
11119 Sets this edge or constraint to be whatever the window's value is at
11120 the moment. If either of the width and height constraints are *as is*,
11121 the window will not be resized, but moved instead. This is important
11122 when considering panel items which are intended to have a default
11123 size, such as a button, which may take its size from the size of the
11124 button label.
15afbcd0 11125 """
54f9ee45 11126 return _core_.IndividualLayoutConstraint_AsIs(*args, **kwargs)
e811c8ce
RD
11127
11128 def GetOtherWindow(*args, **kwargs):
a95a7133 11129 """GetOtherWindow(self) -> Window"""
54f9ee45 11130 return _core_.IndividualLayoutConstraint_GetOtherWindow(*args, **kwargs)
e811c8ce
RD
11131
11132 def GetMyEdge(*args, **kwargs):
a95a7133 11133 """GetMyEdge(self) -> int"""
54f9ee45 11134 return _core_.IndividualLayoutConstraint_GetMyEdge(*args, **kwargs)
e811c8ce
RD
11135
11136 def SetEdge(*args, **kwargs):
a95a7133 11137 """SetEdge(self, int which)"""
54f9ee45 11138 return _core_.IndividualLayoutConstraint_SetEdge(*args, **kwargs)
e811c8ce
RD
11139
11140 def SetValue(*args, **kwargs):
a95a7133 11141 """SetValue(self, int v)"""
54f9ee45 11142 return _core_.IndividualLayoutConstraint_SetValue(*args, **kwargs)
e811c8ce
RD
11143
11144 def GetMargin(*args, **kwargs):
a95a7133 11145 """GetMargin(self) -> int"""
54f9ee45 11146 return _core_.IndividualLayoutConstraint_GetMargin(*args, **kwargs)
e811c8ce
RD
11147
11148 def SetMargin(*args, **kwargs):
a95a7133 11149 """SetMargin(self, int m)"""
54f9ee45 11150 return _core_.IndividualLayoutConstraint_SetMargin(*args, **kwargs)
e811c8ce
RD
11151
11152 def GetValue(*args, **kwargs):
a95a7133 11153 """GetValue(self) -> int"""
54f9ee45 11154 return _core_.IndividualLayoutConstraint_GetValue(*args, **kwargs)
e811c8ce
RD
11155
11156 def GetPercent(*args, **kwargs):
a95a7133 11157 """GetPercent(self) -> int"""
54f9ee45 11158 return _core_.IndividualLayoutConstraint_GetPercent(*args, **kwargs)
e811c8ce
RD
11159
11160 def GetOtherEdge(*args, **kwargs):
a95a7133 11161 """GetOtherEdge(self) -> int"""
54f9ee45 11162 return _core_.IndividualLayoutConstraint_GetOtherEdge(*args, **kwargs)
e811c8ce
RD
11163
11164 def GetDone(*args, **kwargs):
a95a7133 11165 """GetDone(self) -> bool"""
54f9ee45 11166 return _core_.IndividualLayoutConstraint_GetDone(*args, **kwargs)
e811c8ce
RD
11167
11168 def SetDone(*args, **kwargs):
a95a7133 11169 """SetDone(self, bool d)"""
54f9ee45 11170 return _core_.IndividualLayoutConstraint_SetDone(*args, **kwargs)
e811c8ce
RD
11171
11172 def GetRelationship(*args, **kwargs):
a95a7133 11173 """GetRelationship(self) -> int"""
54f9ee45 11174 return _core_.IndividualLayoutConstraint_GetRelationship(*args, **kwargs)
e811c8ce
RD
11175
11176 def SetRelationship(*args, **kwargs):
a95a7133 11177 """SetRelationship(self, int r)"""
54f9ee45 11178 return _core_.IndividualLayoutConstraint_SetRelationship(*args, **kwargs)
e811c8ce
RD
11179
11180 def ResetIfWin(*args, **kwargs):
15afbcd0 11181 """
a95a7133 11182 ResetIfWin(self, Window otherW) -> bool
15afbcd0
RD
11183
11184 Reset constraint if it mentions otherWin
11185 """
54f9ee45 11186 return _core_.IndividualLayoutConstraint_ResetIfWin(*args, **kwargs)
e811c8ce
RD
11187
11188 def SatisfyConstraint(*args, **kwargs):
15afbcd0 11189 """
a95a7133 11190 SatisfyConstraint(self, LayoutConstraints constraints, Window win) -> bool
15afbcd0
RD
11191
11192 Try to satisfy constraint
11193 """
54f9ee45 11194 return _core_.IndividualLayoutConstraint_SatisfyConstraint(*args, **kwargs)
e811c8ce
RD
11195
11196 def GetEdge(*args, **kwargs):
15afbcd0 11197 """
a95a7133 11198 GetEdge(self, int which, Window thisWin, Window other) -> int
15afbcd0
RD
11199
11200 Get the value of this edge or dimension, or if this
11201 is not determinable, -1.
11202 """
54f9ee45 11203 return _core_.IndividualLayoutConstraint_GetEdge(*args, **kwargs)
e811c8ce 11204
d14a1e28
RD
11205
11206class IndividualLayoutConstraintPtr(IndividualLayoutConstraint):
11207 def __init__(self, this):
11208 self.this = this
11209 if not hasattr(self,"thisown"): self.thisown = 0
11210 self.__class__ = IndividualLayoutConstraint
54f9ee45 11211_core_.IndividualLayoutConstraint_swigregister(IndividualLayoutConstraintPtr)
d14a1e28
RD
11212
11213class LayoutConstraints(Object):
15afbcd0 11214 """
41e2b43e
RD
11215 **Note:** constraints are now deprecated and you should use sizers
11216 instead.
15afbcd0 11217
41e2b43e
RD
11218 Objects of this class can be associated with a window to define its
11219 layout constraints, with respect to siblings or its parent.
15afbcd0
RD
11220
11221 The class consists of the following eight constraints of class
11222 wx.IndividualLayoutConstraint, some or all of which should be accessed
11223 directly to set the appropriate constraints.
11224
11225 * left: represents the left hand edge of the window
11226 * right: represents the right hand edge of the window
11227 * top: represents the top edge of the window
11228 * bottom: represents the bottom edge of the window
11229 * width: represents the width of the window
11230 * height: represents the height of the window
11231 * centreX: represents the horizontal centre point of the window
11232 * centreY: represents the vertical centre point of the window
11233
41e2b43e
RD
11234 Most constraints are initially set to have the relationship
11235 wxUnconstrained, which means that their values should be calculated by
11236 looking at known constraints. The exceptions are width and height,
11237 which are set to wxAsIs to ensure that if the user does not specify a
11238 constraint, the existing width and height will be used, to be
11239 compatible with panel items which often have take a default size. If
11240 the constraint is ``wx.AsIs``, the dimension will not be changed.
11241
11242 :see: `wx.IndividualLayoutConstraint`, `wx.Window.SetConstraints`
15afbcd0
RD
11243
11244 """
e811c8ce
RD
11245 def __repr__(self):
11246 return "<%s.%s; proxy of C++ wxLayoutConstraints instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
54f9ee45
RD
11247 left = property(_core_.LayoutConstraints_left_get)
11248 top = property(_core_.LayoutConstraints_top_get)
11249 right = property(_core_.LayoutConstraints_right_get)
11250 bottom = property(_core_.LayoutConstraints_bottom_get)
11251 width = property(_core_.LayoutConstraints_width_get)
11252 height = property(_core_.LayoutConstraints_height_get)
11253 centreX = property(_core_.LayoutConstraints_centreX_get)
11254 centreY = property(_core_.LayoutConstraints_centreY_get)
d14a1e28 11255 def __init__(self, *args, **kwargs):
a95a7133 11256 """__init__(self) -> LayoutConstraints"""
54f9ee45 11257 newobj = _core_.new_LayoutConstraints(*args, **kwargs)
d14a1e28
RD
11258 self.this = newobj.this
11259 self.thisown = 1
11260 del newobj.thisown
e811c8ce 11261 def SatisfyConstraints(*args, **kwargs):
6c3b4aae 11262 """SatisfyConstraints(Window win) -> (areSatisfied, noChanges)"""
54f9ee45 11263 return _core_.LayoutConstraints_SatisfyConstraints(*args, **kwargs)
e811c8ce
RD
11264
11265 def AreSatisfied(*args, **kwargs):
a95a7133 11266 """AreSatisfied(self) -> bool"""
54f9ee45 11267 return _core_.LayoutConstraints_AreSatisfied(*args, **kwargs)
e811c8ce 11268
d14a1e28
RD
11269
11270class LayoutConstraintsPtr(LayoutConstraints):
11271 def __init__(self, this):
11272 self.this = this
11273 if not hasattr(self,"thisown"): self.thisown = 0
11274 self.__class__ = LayoutConstraints
54f9ee45 11275_core_.LayoutConstraints_swigregister(LayoutConstraintsPtr)
d14a1e28
RD
11276
11277#----------------------------------------------------------------------------
11278
322913ce 11279# Use Python's bool constants if available, make some if not
d14a1e28
RD
11280try:
11281 True
11282except NameError:
322913ce
RD
11283 __builtins__.True = 1==1
11284 __builtins__.False = 1==0
4f89f6a3
RD
11285 def bool(value): return not not value
11286 __builtins__.bool = bool
d14a1e28 11287
d14a1e28
RD
11288
11289
11290# workarounds for bad wxRTTI names
11291__wxPyPtrTypeMap['wxGauge95'] = 'wxGauge'
11292__wxPyPtrTypeMap['wxSlider95'] = 'wxSlider'
11293__wxPyPtrTypeMap['wxStatusBar95'] = 'wxStatusBar'
11294
11295
11296#----------------------------------------------------------------------------
11297# Load version numbers from __version__... Ensure that major and minor
7bc1e663 11298# versions are the same for both wxPython and wxWidgets.
d14a1e28
RD
11299
11300from __version__ import *
11301__version__ = VERSION_STRING
11302
7bc1e663
RD
11303assert MAJOR_VERSION == _core_.MAJOR_VERSION, "wxPython/wxWidgets version mismatch"
11304assert MINOR_VERSION == _core_.MINOR_VERSION, "wxPython/wxWidgets version mismatch"
54f9ee45 11305if RELEASE_VERSION != _core_.RELEASE_VERSION:
d14a1e28 11306 import warnings
7bc1e663 11307 warnings.warn("wxPython/wxWidgets release number mismatch")
d14a1e28
RD
11308
11309#----------------------------------------------------------------------------
11310
e505d15e
RD
11311# Set the default string<-->unicode conversion encoding from the
11312# locale. This encoding is used when string or unicode objects need
11313# to be converted in order to pass them to wxWidgets. Please be aware
11314# that the default encoding within the same locale may be slightly
11315# different on different platforms. For example, please see
11316# http://www.alanwood.net/demos/charsetdiffs.html for differences
11317# between the common latin/roman encodings.
396fb509
RD
11318
11319default = _sys.getdefaultencoding()
11320if default == 'ascii':
11321 import locale
11322 import codecs
11323 try:
11324 default = locale.getdefaultlocale()[1]
11325 codecs.lookup(default)
11326 except (ValueError, LookupError):
11327 default = _sys.getdefaultencoding()
11328 del locale
11329 del codecs
5cbf236d
RD
11330if default:
11331 wx.SetDefaultPyEncoding(default)
11332del default
5cbf236d
RD
11333
11334#----------------------------------------------------------------------------
11335
d14a1e28
RD
11336class PyDeadObjectError(AttributeError):
11337 pass
11338
d14a1e28
RD
11339class _wxPyDeadObject(object):
11340 """
11341 Instances of wx objects that are OOR capable will have their __class__
11342 changed to this class when the C++ object is deleted. This should help
11343 prevent crashes due to referencing a bogus C++ pointer.
11344 """
11345 reprStr = "wxPython wrapper for DELETED %s object! (The C++ object no longer exists.)"
11346 attrStr = "The C++ part of the %s object has been deleted, attribute access no longer allowed."
11347
3a04f143 11348 def __repr__(self):
d14a1e28
RD
11349 if not hasattr(self, "_name"):
11350 self._name = "[unknown]"
11351 return self.reprStr % self._name
11352
3a04f143 11353 def __getattr__(self, *args):
d14a1e28
RD
11354 if not hasattr(self, "_name"):
11355 self._name = "[unknown]"
3a04f143
RD
11356 raise PyDeadObjectError(self.attrStr % self._name)
11357
11358 def __nonzero__(self):
11359 return 0
11360
11361
11362
11363class PyUnbornObjectError(AttributeError):
11364 pass
11365
11366class _wxPyUnbornObject(object):
11367 """
54f9ee45 11368 Some stock objects are created when the wx._core module is
3a04f143
RD
11369 imported, but their C++ instance is not created until the wx.App
11370 object is created and initialized. These object instances will
11371 temporarily have their __class__ changed to this class so an
11372 exception will be raised if they are used before the C++ instance
11373 is ready.
11374 """
11375
11376 reprStr = "wxPython wrapper for UNBORN object! (The C++ object is not initialized yet.)"
11377 attrStr = "The C++ part of this object has not been initialized, attribute access not allowed."
11378
11379 def __repr__(self):
11380 #if not hasattr(self, "_name"):
11381 # self._name = "[unknown]"
11382 return self.reprStr #% self._name
11383
11384 def __getattr__(self, *args):
11385 #if not hasattr(self, "_name"):
11386 # self._name = "[unknown]"
11387 raise PyUnbornObjectError(self.attrStr) # % self._name )
d14a1e28
RD
11388
11389 def __nonzero__(self):
11390 return 0
11391
11392
11393#----------------------------------------------------------------------------
d14a1e28
RD
11394
11395def CallAfter(callable, *args, **kw):
11396 """
11397 Call the specified function after the current and pending event
11398 handlers have been completed. This is also good for making GUI
61863841
RD
11399 method calls from non-GUI threads. Any extra positional or
11400 keyword args are passed on to the callable when it is called.
11401
11402 :see: `wx.FutureCall`
d14a1e28
RD
11403 """
11404 app = wx.GetApp()
dfbb5885 11405 assert app is not None, 'No wx.App created yet'
d14a1e28 11406
148275d3
RD
11407 if not hasattr(app, "_CallAfterId"):
11408 app._CallAfterId = wx.NewEventType()
11409 app.Connect(-1, -1, app._CallAfterId,
11410 lambda event: event.callable(*event.args, **event.kw) )
d14a1e28 11411 evt = wx.PyEvent()
148275d3 11412 evt.SetEventType(app._CallAfterId)
d14a1e28
RD
11413 evt.callable = callable
11414 evt.args = args
11415 evt.kw = kw
11416 wx.PostEvent(app, evt)
11417
d14a1e28
RD
11418#----------------------------------------------------------------------------
11419
11420
11421class FutureCall:
11422 """
8ac8dba0 11423 A convenience class for `wx.Timer`, that calls the given callable
d14a1e28
RD
11424 object once after the given amount of milliseconds, passing any
11425 positional or keyword args. The return value of the callable is
61863841 11426 availbale after it has been run with the `GetResult` method.
d14a1e28
RD
11427
11428 If you don't need to get the return value or restart the timer
11429 then there is no need to hold a reference to this object. It will
11430 hold a reference to itself while the timer is running (the timer
11431 has a reference to self.Notify) but the cycle will be broken when
11432 the timer completes, automatically cleaning up the wx.FutureCall
11433 object.
61863841
RD
11434
11435 :see: `wx.CallAfter`
d14a1e28
RD
11436 """
11437 def __init__(self, millis, callable, *args, **kwargs):
11438 self.millis = millis
11439 self.callable = callable
11440 self.SetArgs(*args, **kwargs)
11441 self.runCount = 0
4276dc52 11442 self.running = False
d14a1e28
RD
11443 self.hasRun = False
11444 self.result = None
11445 self.timer = None
11446 self.Start()
11447
11448 def __del__(self):
11449 self.Stop()
11450
11451
11452 def Start(self, millis=None, *args, **kwargs):
11453 """
11454 (Re)start the timer
11455 """
11456 self.hasRun = False
11457 if millis is not None:
11458 self.millis = millis
11459 if args or kwargs:
11460 self.SetArgs(*args, **kwargs)
11461 self.Stop()
11462 self.timer = wx.PyTimer(self.Notify)
11463 self.timer.Start(self.millis, wx.TIMER_ONE_SHOT)
4276dc52 11464 self.running = True
d14a1e28
RD
11465 Restart = Start
11466
11467
11468 def Stop(self):
11469 """
11470 Stop and destroy the timer.
11471 """
11472 if self.timer is not None:
11473 self.timer.Stop()
11474 self.timer = None
11475
11476
11477 def GetInterval(self):
11478 if self.timer is not None:
11479 return self.timer.GetInterval()
11480 else:
11481 return 0
11482
11483
11484 def IsRunning(self):
11485 return self.timer is not None and self.timer.IsRunning()
11486
11487
11488 def SetArgs(self, *args, **kwargs):
11489 """
11490 (Re)set the args passed to the callable object. This is
11491 useful in conjunction with Restart if you want to schedule a
11492 new call to the same callable object but with different
11493 parameters.
11494 """
11495 self.args = args
11496 self.kwargs = kwargs
11497
11498
11499 def HasRun(self):
11500 return self.hasRun
11501
11502 def GetResult(self):
11503 return self.result
11504
11505 def Notify(self):
11506 """
11507 The timer has expired so call the callable.
11508 """
11509 if self.callable and getattr(self.callable, 'im_self', True):
11510 self.runCount += 1
4276dc52 11511 self.running = False
d14a1e28
RD
11512 self.result = self.callable(*self.args, **self.kwargs)
11513 self.hasRun = True
4276dc52
RD
11514 if not self.running:
11515 # if it wasn't restarted, then cleanup
11516 wx.CallAfter(self.Stop)
d14a1e28
RD
11517
11518
a95a7133
RD
11519
11520#----------------------------------------------------------------------------
11521# Control which items in this module should be documented by epydoc.
11522# We allow only classes and functions, which will help reduce the size
11523# of the docs by filtering out the zillions of constants, EVT objects,
11524# and etc that don't make much sense by themselves, but are instead
11525# documented (or will be) as part of the classes/functions/methods
11526# where they should be used.
11527
66c033b4
RD
11528class __DocFilter:
11529 """
11530 A filter for epydoc that only allows non-Ptr classes and
11531 fucntions, in order to reduce the clutter in the API docs.
11532 """
11533 def __init__(self, globals):
11534 self._globals = globals
11535
11536 def __call__(self, name):
11537 import types
11538 obj = self._globals.get(name, None)
11539 if type(obj) not in [type, types.ClassType, types.FunctionType, types.BuiltinFunctionType]:
11540 return False
11541 if name.startswith('_') or name.endswith('Ptr') or name.startswith('EVT'):
11542 return False
11543 return True
a95a7133 11544
d14a1e28
RD
11545#----------------------------------------------------------------------------
11546#----------------------------------------------------------------------------
11547
11548# Import other modules in this package that should show up in the
11549# "core" wx namespace
54f9ee45
RD
11550from _gdi import *
11551from _windows import *
11552from _controls import *
11553from _misc import *
d14a1e28 11554
3a04f143
RD
11555
11556# Fixup the stock objects since they can't be used yet. (They will be
11557# restored in wx.PyApp.OnInit.)
54f9ee45 11558_core_._wxPyFixStockObjects()
3a04f143 11559
d14a1e28
RD
11560#----------------------------------------------------------------------------
11561#----------------------------------------------------------------------------
11562
11563