]> git.saurik.com Git - wxWidgets.git/blame - wxPython/src/gtk/_core.py
Oops, checked in wrong file by mistake. Reverted last change.
[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
94ED_CLIENT_MARGIN = _core_.ED_CLIENT_MARGIN
95ED_BUTTONS_BOTTOM = _core_.ED_BUTTONS_BOTTOM
96ED_BUTTONS_RIGHT = _core_.ED_BUTTONS_RIGHT
97ED_STATIC_LINE = _core_.ED_STATIC_LINE
98EXT_DIALOG_STYLE = _core_.EXT_DIALOG_STYLE
99CLIP_CHILDREN = _core_.CLIP_CHILDREN
100CLIP_SIBLINGS = _core_.CLIP_SIBLINGS
101ALWAYS_SHOW_SB = _core_.ALWAYS_SHOW_SB
102RETAINED = _core_.RETAINED
103BACKINGSTORE = _core_.BACKINGSTORE
104COLOURED = _core_.COLOURED
105FIXED_LENGTH = _core_.FIXED_LENGTH
106LB_NEEDED_SB = _core_.LB_NEEDED_SB
107LB_ALWAYS_SB = _core_.LB_ALWAYS_SB
108LB_SORT = _core_.LB_SORT
109LB_SINGLE = _core_.LB_SINGLE
110LB_MULTIPLE = _core_.LB_MULTIPLE
111LB_EXTENDED = _core_.LB_EXTENDED
112LB_OWNERDRAW = _core_.LB_OWNERDRAW
113LB_HSCROLL = _core_.LB_HSCROLL
114PROCESS_ENTER = _core_.PROCESS_ENTER
115PASSWORD = _core_.PASSWORD
116CB_SIMPLE = _core_.CB_SIMPLE
117CB_DROPDOWN = _core_.CB_DROPDOWN
118CB_SORT = _core_.CB_SORT
119CB_READONLY = _core_.CB_READONLY
120RA_HORIZONTAL = _core_.RA_HORIZONTAL
121RA_VERTICAL = _core_.RA_VERTICAL
122RA_SPECIFY_ROWS = _core_.RA_SPECIFY_ROWS
123RA_SPECIFY_COLS = _core_.RA_SPECIFY_COLS
fef4c27a 124RA_USE_CHECKBOX = _core_.RA_USE_CHECKBOX
54f9ee45
RD
125RB_GROUP = _core_.RB_GROUP
126RB_SINGLE = _core_.RB_SINGLE
54f9ee45
RD
127SB_HORIZONTAL = _core_.SB_HORIZONTAL
128SB_VERTICAL = _core_.SB_VERTICAL
fef4c27a 129RB_USE_CHECKBOX = _core_.RB_USE_CHECKBOX
54f9ee45
RD
130ST_SIZEGRIP = _core_.ST_SIZEGRIP
131ST_NO_AUTORESIZE = _core_.ST_NO_AUTORESIZE
132FLOOD_SURFACE = _core_.FLOOD_SURFACE
133FLOOD_BORDER = _core_.FLOOD_BORDER
134ODDEVEN_RULE = _core_.ODDEVEN_RULE
135WINDING_RULE = _core_.WINDING_RULE
136TOOL_TOP = _core_.TOOL_TOP
137TOOL_BOTTOM = _core_.TOOL_BOTTOM
138TOOL_LEFT = _core_.TOOL_LEFT
139TOOL_RIGHT = _core_.TOOL_RIGHT
140OK = _core_.OK
141YES_NO = _core_.YES_NO
142CANCEL = _core_.CANCEL
143YES = _core_.YES
144NO = _core_.NO
145NO_DEFAULT = _core_.NO_DEFAULT
146YES_DEFAULT = _core_.YES_DEFAULT
147ICON_EXCLAMATION = _core_.ICON_EXCLAMATION
148ICON_HAND = _core_.ICON_HAND
149ICON_QUESTION = _core_.ICON_QUESTION
150ICON_INFORMATION = _core_.ICON_INFORMATION
151ICON_STOP = _core_.ICON_STOP
152ICON_ASTERISK = _core_.ICON_ASTERISK
153ICON_MASK = _core_.ICON_MASK
154ICON_WARNING = _core_.ICON_WARNING
155ICON_ERROR = _core_.ICON_ERROR
156FORWARD = _core_.FORWARD
157BACKWARD = _core_.BACKWARD
158RESET = _core_.RESET
159HELP = _core_.HELP
160MORE = _core_.MORE
161SETUP = _core_.SETUP
162SIZE_AUTO_WIDTH = _core_.SIZE_AUTO_WIDTH
163SIZE_AUTO_HEIGHT = _core_.SIZE_AUTO_HEIGHT
164SIZE_AUTO = _core_.SIZE_AUTO
165SIZE_USE_EXISTING = _core_.SIZE_USE_EXISTING
166SIZE_ALLOW_MINUS_ONE = _core_.SIZE_ALLOW_MINUS_ONE
167PORTRAIT = _core_.PORTRAIT
168LANDSCAPE = _core_.LANDSCAPE
169PRINT_QUALITY_HIGH = _core_.PRINT_QUALITY_HIGH
170PRINT_QUALITY_MEDIUM = _core_.PRINT_QUALITY_MEDIUM
171PRINT_QUALITY_LOW = _core_.PRINT_QUALITY_LOW
172PRINT_QUALITY_DRAFT = _core_.PRINT_QUALITY_DRAFT
173ID_ANY = _core_.ID_ANY
174ID_SEPARATOR = _core_.ID_SEPARATOR
175ID_LOWEST = _core_.ID_LOWEST
176ID_OPEN = _core_.ID_OPEN
177ID_CLOSE = _core_.ID_CLOSE
178ID_NEW = _core_.ID_NEW
179ID_SAVE = _core_.ID_SAVE
180ID_SAVEAS = _core_.ID_SAVEAS
181ID_REVERT = _core_.ID_REVERT
182ID_EXIT = _core_.ID_EXIT
183ID_UNDO = _core_.ID_UNDO
184ID_REDO = _core_.ID_REDO
185ID_HELP = _core_.ID_HELP
186ID_PRINT = _core_.ID_PRINT
187ID_PRINT_SETUP = _core_.ID_PRINT_SETUP
188ID_PREVIEW = _core_.ID_PREVIEW
189ID_ABOUT = _core_.ID_ABOUT
190ID_HELP_CONTENTS = _core_.ID_HELP_CONTENTS
191ID_HELP_COMMANDS = _core_.ID_HELP_COMMANDS
192ID_HELP_PROCEDURES = _core_.ID_HELP_PROCEDURES
193ID_HELP_CONTEXT = _core_.ID_HELP_CONTEXT
194ID_CLOSE_ALL = _core_.ID_CLOSE_ALL
195ID_PREFERENCES = _core_.ID_PREFERENCES
196ID_CUT = _core_.ID_CUT
197ID_COPY = _core_.ID_COPY
198ID_PASTE = _core_.ID_PASTE
199ID_CLEAR = _core_.ID_CLEAR
200ID_FIND = _core_.ID_FIND
201ID_DUPLICATE = _core_.ID_DUPLICATE
202ID_SELECTALL = _core_.ID_SELECTALL
203ID_DELETE = _core_.ID_DELETE
204ID_REPLACE = _core_.ID_REPLACE
205ID_REPLACE_ALL = _core_.ID_REPLACE_ALL
206ID_PROPERTIES = _core_.ID_PROPERTIES
207ID_VIEW_DETAILS = _core_.ID_VIEW_DETAILS
208ID_VIEW_LARGEICONS = _core_.ID_VIEW_LARGEICONS
209ID_VIEW_SMALLICONS = _core_.ID_VIEW_SMALLICONS
210ID_VIEW_LIST = _core_.ID_VIEW_LIST
211ID_VIEW_SORTDATE = _core_.ID_VIEW_SORTDATE
212ID_VIEW_SORTNAME = _core_.ID_VIEW_SORTNAME
213ID_VIEW_SORTSIZE = _core_.ID_VIEW_SORTSIZE
214ID_VIEW_SORTTYPE = _core_.ID_VIEW_SORTTYPE
215ID_FILE1 = _core_.ID_FILE1
216ID_FILE2 = _core_.ID_FILE2
217ID_FILE3 = _core_.ID_FILE3
218ID_FILE4 = _core_.ID_FILE4
219ID_FILE5 = _core_.ID_FILE5
220ID_FILE6 = _core_.ID_FILE6
221ID_FILE7 = _core_.ID_FILE7
222ID_FILE8 = _core_.ID_FILE8
223ID_FILE9 = _core_.ID_FILE9
224ID_OK = _core_.ID_OK
225ID_CANCEL = _core_.ID_CANCEL
226ID_APPLY = _core_.ID_APPLY
227ID_YES = _core_.ID_YES
228ID_NO = _core_.ID_NO
229ID_STATIC = _core_.ID_STATIC
230ID_FORWARD = _core_.ID_FORWARD
231ID_BACKWARD = _core_.ID_BACKWARD
232ID_DEFAULT = _core_.ID_DEFAULT
233ID_MORE = _core_.ID_MORE
234ID_SETUP = _core_.ID_SETUP
235ID_RESET = _core_.ID_RESET
236ID_CONTEXT_HELP = _core_.ID_CONTEXT_HELP
237ID_YESTOALL = _core_.ID_YESTOALL
238ID_NOTOALL = _core_.ID_NOTOALL
239ID_ABORT = _core_.ID_ABORT
240ID_RETRY = _core_.ID_RETRY
241ID_IGNORE = _core_.ID_IGNORE
7bc1e663
RD
242ID_ADD = _core_.ID_ADD
243ID_REMOVE = _core_.ID_REMOVE
244ID_UP = _core_.ID_UP
245ID_DOWN = _core_.ID_DOWN
246ID_HOME = _core_.ID_HOME
247ID_REFRESH = _core_.ID_REFRESH
248ID_STOP = _core_.ID_STOP
249ID_INDEX = _core_.ID_INDEX
250ID_BOLD = _core_.ID_BOLD
251ID_ITALIC = _core_.ID_ITALIC
252ID_JUSTIFY_CENTER = _core_.ID_JUSTIFY_CENTER
253ID_JUSTIFY_FILL = _core_.ID_JUSTIFY_FILL
254ID_JUSTIFY_RIGHT = _core_.ID_JUSTIFY_RIGHT
255ID_JUSTIFY_LEFT = _core_.ID_JUSTIFY_LEFT
256ID_UNDERLINE = _core_.ID_UNDERLINE
257ID_INDENT = _core_.ID_INDENT
258ID_UNINDENT = _core_.ID_UNINDENT
259ID_ZOOM_100 = _core_.ID_ZOOM_100
260ID_ZOOM_FIT = _core_.ID_ZOOM_FIT
261ID_ZOOM_IN = _core_.ID_ZOOM_IN
262ID_ZOOM_OUT = _core_.ID_ZOOM_OUT
263ID_UNDELETE = _core_.ID_UNDELETE
264ID_REVERT_TO_SAVED = _core_.ID_REVERT_TO_SAVED
54f9ee45
RD
265ID_HIGHEST = _core_.ID_HIGHEST
266OPEN = _core_.OPEN
267SAVE = _core_.SAVE
268HIDE_READONLY = _core_.HIDE_READONLY
269OVERWRITE_PROMPT = _core_.OVERWRITE_PROMPT
270FILE_MUST_EXIST = _core_.FILE_MUST_EXIST
271MULTIPLE = _core_.MULTIPLE
272CHANGE_DIR = _core_.CHANGE_DIR
273ACCEL_ALT = _core_.ACCEL_ALT
274ACCEL_CTRL = _core_.ACCEL_CTRL
275ACCEL_SHIFT = _core_.ACCEL_SHIFT
276ACCEL_NORMAL = _core_.ACCEL_NORMAL
277PD_AUTO_HIDE = _core_.PD_AUTO_HIDE
278PD_APP_MODAL = _core_.PD_APP_MODAL
279PD_CAN_ABORT = _core_.PD_CAN_ABORT
280PD_ELAPSED_TIME = _core_.PD_ELAPSED_TIME
281PD_ESTIMATED_TIME = _core_.PD_ESTIMATED_TIME
282PD_REMAINING_TIME = _core_.PD_REMAINING_TIME
e505d15e
RD
283PD_SMOOTH = _core_.PD_SMOOTH
284PD_CAN_SKIP = _core_.PD_CAN_SKIP
54f9ee45
RD
285DD_NEW_DIR_BUTTON = _core_.DD_NEW_DIR_BUTTON
286DD_DEFAULT_STYLE = _core_.DD_DEFAULT_STYLE
287MENU_TEAROFF = _core_.MENU_TEAROFF
288MB_DOCKABLE = _core_.MB_DOCKABLE
289NO_FULL_REPAINT_ON_RESIZE = _core_.NO_FULL_REPAINT_ON_RESIZE
290FULL_REPAINT_ON_RESIZE = _core_.FULL_REPAINT_ON_RESIZE
291LI_HORIZONTAL = _core_.LI_HORIZONTAL
292LI_VERTICAL = _core_.LI_VERTICAL
293WS_EX_VALIDATE_RECURSIVELY = _core_.WS_EX_VALIDATE_RECURSIVELY
294WS_EX_BLOCK_EVENTS = _core_.WS_EX_BLOCK_EVENTS
295WS_EX_TRANSIENT = _core_.WS_EX_TRANSIENT
296WS_EX_THEMED_BACKGROUND = _core_.WS_EX_THEMED_BACKGROUND
297WS_EX_PROCESS_IDLE = _core_.WS_EX_PROCESS_IDLE
298WS_EX_PROCESS_UI_UPDATES = _core_.WS_EX_PROCESS_UI_UPDATES
299MM_TEXT = _core_.MM_TEXT
300MM_LOMETRIC = _core_.MM_LOMETRIC
301MM_HIMETRIC = _core_.MM_HIMETRIC
302MM_LOENGLISH = _core_.MM_LOENGLISH
303MM_HIENGLISH = _core_.MM_HIENGLISH
304MM_TWIPS = _core_.MM_TWIPS
305MM_ISOTROPIC = _core_.MM_ISOTROPIC
306MM_ANISOTROPIC = _core_.MM_ANISOTROPIC
307MM_POINTS = _core_.MM_POINTS
308MM_METRIC = _core_.MM_METRIC
309CENTRE = _core_.CENTRE
310CENTER = _core_.CENTER
311HORIZONTAL = _core_.HORIZONTAL
312VERTICAL = _core_.VERTICAL
313BOTH = _core_.BOTH
314LEFT = _core_.LEFT
315RIGHT = _core_.RIGHT
316UP = _core_.UP
317DOWN = _core_.DOWN
318TOP = _core_.TOP
319BOTTOM = _core_.BOTTOM
320NORTH = _core_.NORTH
321SOUTH = _core_.SOUTH
322WEST = _core_.WEST
323EAST = _core_.EAST
324ALL = _core_.ALL
325ALIGN_NOT = _core_.ALIGN_NOT
326ALIGN_CENTER_HORIZONTAL = _core_.ALIGN_CENTER_HORIZONTAL
327ALIGN_CENTRE_HORIZONTAL = _core_.ALIGN_CENTRE_HORIZONTAL
328ALIGN_LEFT = _core_.ALIGN_LEFT
329ALIGN_TOP = _core_.ALIGN_TOP
330ALIGN_RIGHT = _core_.ALIGN_RIGHT
331ALIGN_BOTTOM = _core_.ALIGN_BOTTOM
332ALIGN_CENTER_VERTICAL = _core_.ALIGN_CENTER_VERTICAL
333ALIGN_CENTRE_VERTICAL = _core_.ALIGN_CENTRE_VERTICAL
334ALIGN_CENTER = _core_.ALIGN_CENTER
335ALIGN_CENTRE = _core_.ALIGN_CENTRE
336ALIGN_MASK = _core_.ALIGN_MASK
337STRETCH_NOT = _core_.STRETCH_NOT
338SHRINK = _core_.SHRINK
339GROW = _core_.GROW
340EXPAND = _core_.EXPAND
341SHAPED = _core_.SHAPED
342FIXED_MINSIZE = _core_.FIXED_MINSIZE
343TILE = _core_.TILE
344ADJUST_MINSIZE = _core_.ADJUST_MINSIZE
345BORDER_DEFAULT = _core_.BORDER_DEFAULT
346BORDER_NONE = _core_.BORDER_NONE
347BORDER_STATIC = _core_.BORDER_STATIC
348BORDER_SIMPLE = _core_.BORDER_SIMPLE
349BORDER_RAISED = _core_.BORDER_RAISED
350BORDER_SUNKEN = _core_.BORDER_SUNKEN
351BORDER_DOUBLE = _core_.BORDER_DOUBLE
352BORDER_MASK = _core_.BORDER_MASK
7bc1e663
RD
353BG_STYLE_SYSTEM = _core_.BG_STYLE_SYSTEM
354BG_STYLE_COLOUR = _core_.BG_STYLE_COLOUR
355BG_STYLE_CUSTOM = _core_.BG_STYLE_CUSTOM
54f9ee45
RD
356DEFAULT = _core_.DEFAULT
357DECORATIVE = _core_.DECORATIVE
358ROMAN = _core_.ROMAN
359SCRIPT = _core_.SCRIPT
360SWISS = _core_.SWISS
361MODERN = _core_.MODERN
362TELETYPE = _core_.TELETYPE
363VARIABLE = _core_.VARIABLE
364FIXED = _core_.FIXED
365NORMAL = _core_.NORMAL
366LIGHT = _core_.LIGHT
367BOLD = _core_.BOLD
368ITALIC = _core_.ITALIC
369SLANT = _core_.SLANT
370SOLID = _core_.SOLID
371DOT = _core_.DOT
372LONG_DASH = _core_.LONG_DASH
373SHORT_DASH = _core_.SHORT_DASH
374DOT_DASH = _core_.DOT_DASH
375USER_DASH = _core_.USER_DASH
376TRANSPARENT = _core_.TRANSPARENT
377STIPPLE = _core_.STIPPLE
378BDIAGONAL_HATCH = _core_.BDIAGONAL_HATCH
379CROSSDIAG_HATCH = _core_.CROSSDIAG_HATCH
380FDIAGONAL_HATCH = _core_.FDIAGONAL_HATCH
381CROSS_HATCH = _core_.CROSS_HATCH
382HORIZONTAL_HATCH = _core_.HORIZONTAL_HATCH
383VERTICAL_HATCH = _core_.VERTICAL_HATCH
384JOIN_BEVEL = _core_.JOIN_BEVEL
385JOIN_MITER = _core_.JOIN_MITER
386JOIN_ROUND = _core_.JOIN_ROUND
387CAP_ROUND = _core_.CAP_ROUND
388CAP_PROJECTING = _core_.CAP_PROJECTING
389CAP_BUTT = _core_.CAP_BUTT
390CLEAR = _core_.CLEAR
391XOR = _core_.XOR
392INVERT = _core_.INVERT
393OR_REVERSE = _core_.OR_REVERSE
394AND_REVERSE = _core_.AND_REVERSE
395COPY = _core_.COPY
396AND = _core_.AND
397AND_INVERT = _core_.AND_INVERT
398NO_OP = _core_.NO_OP
399NOR = _core_.NOR
400EQUIV = _core_.EQUIV
401SRC_INVERT = _core_.SRC_INVERT
402OR_INVERT = _core_.OR_INVERT
403NAND = _core_.NAND
404OR = _core_.OR
405SET = _core_.SET
406WXK_BACK = _core_.WXK_BACK
407WXK_TAB = _core_.WXK_TAB
408WXK_RETURN = _core_.WXK_RETURN
409WXK_ESCAPE = _core_.WXK_ESCAPE
410WXK_SPACE = _core_.WXK_SPACE
411WXK_DELETE = _core_.WXK_DELETE
412WXK_START = _core_.WXK_START
413WXK_LBUTTON = _core_.WXK_LBUTTON
414WXK_RBUTTON = _core_.WXK_RBUTTON
415WXK_CANCEL = _core_.WXK_CANCEL
416WXK_MBUTTON = _core_.WXK_MBUTTON
417WXK_CLEAR = _core_.WXK_CLEAR
418WXK_SHIFT = _core_.WXK_SHIFT
419WXK_ALT = _core_.WXK_ALT
420WXK_CONTROL = _core_.WXK_CONTROL
421WXK_MENU = _core_.WXK_MENU
422WXK_PAUSE = _core_.WXK_PAUSE
423WXK_CAPITAL = _core_.WXK_CAPITAL
424WXK_PRIOR = _core_.WXK_PRIOR
425WXK_NEXT = _core_.WXK_NEXT
426WXK_END = _core_.WXK_END
427WXK_HOME = _core_.WXK_HOME
428WXK_LEFT = _core_.WXK_LEFT
429WXK_UP = _core_.WXK_UP
430WXK_RIGHT = _core_.WXK_RIGHT
431WXK_DOWN = _core_.WXK_DOWN
432WXK_SELECT = _core_.WXK_SELECT
433WXK_PRINT = _core_.WXK_PRINT
434WXK_EXECUTE = _core_.WXK_EXECUTE
435WXK_SNAPSHOT = _core_.WXK_SNAPSHOT
436WXK_INSERT = _core_.WXK_INSERT
437WXK_HELP = _core_.WXK_HELP
438WXK_NUMPAD0 = _core_.WXK_NUMPAD0
439WXK_NUMPAD1 = _core_.WXK_NUMPAD1
440WXK_NUMPAD2 = _core_.WXK_NUMPAD2
441WXK_NUMPAD3 = _core_.WXK_NUMPAD3
442WXK_NUMPAD4 = _core_.WXK_NUMPAD4
443WXK_NUMPAD5 = _core_.WXK_NUMPAD5
444WXK_NUMPAD6 = _core_.WXK_NUMPAD6
445WXK_NUMPAD7 = _core_.WXK_NUMPAD7
446WXK_NUMPAD8 = _core_.WXK_NUMPAD8
447WXK_NUMPAD9 = _core_.WXK_NUMPAD9
448WXK_MULTIPLY = _core_.WXK_MULTIPLY
449WXK_ADD = _core_.WXK_ADD
450WXK_SEPARATOR = _core_.WXK_SEPARATOR
451WXK_SUBTRACT = _core_.WXK_SUBTRACT
452WXK_DECIMAL = _core_.WXK_DECIMAL
453WXK_DIVIDE = _core_.WXK_DIVIDE
454WXK_F1 = _core_.WXK_F1
455WXK_F2 = _core_.WXK_F2
456WXK_F3 = _core_.WXK_F3
457WXK_F4 = _core_.WXK_F4
458WXK_F5 = _core_.WXK_F5
459WXK_F6 = _core_.WXK_F6
460WXK_F7 = _core_.WXK_F7
461WXK_F8 = _core_.WXK_F8
462WXK_F9 = _core_.WXK_F9
463WXK_F10 = _core_.WXK_F10
464WXK_F11 = _core_.WXK_F11
465WXK_F12 = _core_.WXK_F12
466WXK_F13 = _core_.WXK_F13
467WXK_F14 = _core_.WXK_F14
468WXK_F15 = _core_.WXK_F15
469WXK_F16 = _core_.WXK_F16
470WXK_F17 = _core_.WXK_F17
471WXK_F18 = _core_.WXK_F18
472WXK_F19 = _core_.WXK_F19
473WXK_F20 = _core_.WXK_F20
474WXK_F21 = _core_.WXK_F21
475WXK_F22 = _core_.WXK_F22
476WXK_F23 = _core_.WXK_F23
477WXK_F24 = _core_.WXK_F24
478WXK_NUMLOCK = _core_.WXK_NUMLOCK
479WXK_SCROLL = _core_.WXK_SCROLL
480WXK_PAGEUP = _core_.WXK_PAGEUP
481WXK_PAGEDOWN = _core_.WXK_PAGEDOWN
482WXK_NUMPAD_SPACE = _core_.WXK_NUMPAD_SPACE
483WXK_NUMPAD_TAB = _core_.WXK_NUMPAD_TAB
484WXK_NUMPAD_ENTER = _core_.WXK_NUMPAD_ENTER
485WXK_NUMPAD_F1 = _core_.WXK_NUMPAD_F1
486WXK_NUMPAD_F2 = _core_.WXK_NUMPAD_F2
487WXK_NUMPAD_F3 = _core_.WXK_NUMPAD_F3
488WXK_NUMPAD_F4 = _core_.WXK_NUMPAD_F4
489WXK_NUMPAD_HOME = _core_.WXK_NUMPAD_HOME
490WXK_NUMPAD_LEFT = _core_.WXK_NUMPAD_LEFT
491WXK_NUMPAD_UP = _core_.WXK_NUMPAD_UP
492WXK_NUMPAD_RIGHT = _core_.WXK_NUMPAD_RIGHT
493WXK_NUMPAD_DOWN = _core_.WXK_NUMPAD_DOWN
494WXK_NUMPAD_PRIOR = _core_.WXK_NUMPAD_PRIOR
495WXK_NUMPAD_PAGEUP = _core_.WXK_NUMPAD_PAGEUP
496WXK_NUMPAD_NEXT = _core_.WXK_NUMPAD_NEXT
497WXK_NUMPAD_PAGEDOWN = _core_.WXK_NUMPAD_PAGEDOWN
498WXK_NUMPAD_END = _core_.WXK_NUMPAD_END
499WXK_NUMPAD_BEGIN = _core_.WXK_NUMPAD_BEGIN
500WXK_NUMPAD_INSERT = _core_.WXK_NUMPAD_INSERT
501WXK_NUMPAD_DELETE = _core_.WXK_NUMPAD_DELETE
502WXK_NUMPAD_EQUAL = _core_.WXK_NUMPAD_EQUAL
503WXK_NUMPAD_MULTIPLY = _core_.WXK_NUMPAD_MULTIPLY
504WXK_NUMPAD_ADD = _core_.WXK_NUMPAD_ADD
505WXK_NUMPAD_SEPARATOR = _core_.WXK_NUMPAD_SEPARATOR
506WXK_NUMPAD_SUBTRACT = _core_.WXK_NUMPAD_SUBTRACT
507WXK_NUMPAD_DECIMAL = _core_.WXK_NUMPAD_DECIMAL
508WXK_NUMPAD_DIVIDE = _core_.WXK_NUMPAD_DIVIDE
509WXK_WINDOWS_LEFT = _core_.WXK_WINDOWS_LEFT
510WXK_WINDOWS_RIGHT = _core_.WXK_WINDOWS_RIGHT
511WXK_WINDOWS_MENU = _core_.WXK_WINDOWS_MENU
512PAPER_NONE = _core_.PAPER_NONE
513PAPER_LETTER = _core_.PAPER_LETTER
514PAPER_LEGAL = _core_.PAPER_LEGAL
515PAPER_A4 = _core_.PAPER_A4
516PAPER_CSHEET = _core_.PAPER_CSHEET
517PAPER_DSHEET = _core_.PAPER_DSHEET
518PAPER_ESHEET = _core_.PAPER_ESHEET
519PAPER_LETTERSMALL = _core_.PAPER_LETTERSMALL
520PAPER_TABLOID = _core_.PAPER_TABLOID
521PAPER_LEDGER = _core_.PAPER_LEDGER
522PAPER_STATEMENT = _core_.PAPER_STATEMENT
523PAPER_EXECUTIVE = _core_.PAPER_EXECUTIVE
524PAPER_A3 = _core_.PAPER_A3
525PAPER_A4SMALL = _core_.PAPER_A4SMALL
526PAPER_A5 = _core_.PAPER_A5
527PAPER_B4 = _core_.PAPER_B4
528PAPER_B5 = _core_.PAPER_B5
529PAPER_FOLIO = _core_.PAPER_FOLIO
530PAPER_QUARTO = _core_.PAPER_QUARTO
531PAPER_10X14 = _core_.PAPER_10X14
532PAPER_11X17 = _core_.PAPER_11X17
533PAPER_NOTE = _core_.PAPER_NOTE
534PAPER_ENV_9 = _core_.PAPER_ENV_9
535PAPER_ENV_10 = _core_.PAPER_ENV_10
536PAPER_ENV_11 = _core_.PAPER_ENV_11
537PAPER_ENV_12 = _core_.PAPER_ENV_12
538PAPER_ENV_14 = _core_.PAPER_ENV_14
539PAPER_ENV_DL = _core_.PAPER_ENV_DL
540PAPER_ENV_C5 = _core_.PAPER_ENV_C5
541PAPER_ENV_C3 = _core_.PAPER_ENV_C3
542PAPER_ENV_C4 = _core_.PAPER_ENV_C4
543PAPER_ENV_C6 = _core_.PAPER_ENV_C6
544PAPER_ENV_C65 = _core_.PAPER_ENV_C65
545PAPER_ENV_B4 = _core_.PAPER_ENV_B4
546PAPER_ENV_B5 = _core_.PAPER_ENV_B5
547PAPER_ENV_B6 = _core_.PAPER_ENV_B6
548PAPER_ENV_ITALY = _core_.PAPER_ENV_ITALY
549PAPER_ENV_MONARCH = _core_.PAPER_ENV_MONARCH
550PAPER_ENV_PERSONAL = _core_.PAPER_ENV_PERSONAL
551PAPER_FANFOLD_US = _core_.PAPER_FANFOLD_US
552PAPER_FANFOLD_STD_GERMAN = _core_.PAPER_FANFOLD_STD_GERMAN
553PAPER_FANFOLD_LGL_GERMAN = _core_.PAPER_FANFOLD_LGL_GERMAN
554PAPER_ISO_B4 = _core_.PAPER_ISO_B4
555PAPER_JAPANESE_POSTCARD = _core_.PAPER_JAPANESE_POSTCARD
556PAPER_9X11 = _core_.PAPER_9X11
557PAPER_10X11 = _core_.PAPER_10X11
558PAPER_15X11 = _core_.PAPER_15X11
559PAPER_ENV_INVITE = _core_.PAPER_ENV_INVITE
560PAPER_LETTER_EXTRA = _core_.PAPER_LETTER_EXTRA
561PAPER_LEGAL_EXTRA = _core_.PAPER_LEGAL_EXTRA
562PAPER_TABLOID_EXTRA = _core_.PAPER_TABLOID_EXTRA
563PAPER_A4_EXTRA = _core_.PAPER_A4_EXTRA
564PAPER_LETTER_TRANSVERSE = _core_.PAPER_LETTER_TRANSVERSE
565PAPER_A4_TRANSVERSE = _core_.PAPER_A4_TRANSVERSE
566PAPER_LETTER_EXTRA_TRANSVERSE = _core_.PAPER_LETTER_EXTRA_TRANSVERSE
567PAPER_A_PLUS = _core_.PAPER_A_PLUS
568PAPER_B_PLUS = _core_.PAPER_B_PLUS
569PAPER_LETTER_PLUS = _core_.PAPER_LETTER_PLUS
570PAPER_A4_PLUS = _core_.PAPER_A4_PLUS
571PAPER_A5_TRANSVERSE = _core_.PAPER_A5_TRANSVERSE
572PAPER_B5_TRANSVERSE = _core_.PAPER_B5_TRANSVERSE
573PAPER_A3_EXTRA = _core_.PAPER_A3_EXTRA
574PAPER_A5_EXTRA = _core_.PAPER_A5_EXTRA
575PAPER_B5_EXTRA = _core_.PAPER_B5_EXTRA
576PAPER_A2 = _core_.PAPER_A2
577PAPER_A3_TRANSVERSE = _core_.PAPER_A3_TRANSVERSE
578PAPER_A3_EXTRA_TRANSVERSE = _core_.PAPER_A3_EXTRA_TRANSVERSE
579DUPLEX_SIMPLEX = _core_.DUPLEX_SIMPLEX
580DUPLEX_HORIZONTAL = _core_.DUPLEX_HORIZONTAL
581DUPLEX_VERTICAL = _core_.DUPLEX_VERTICAL
582ITEM_SEPARATOR = _core_.ITEM_SEPARATOR
583ITEM_NORMAL = _core_.ITEM_NORMAL
584ITEM_CHECK = _core_.ITEM_CHECK
585ITEM_RADIO = _core_.ITEM_RADIO
586ITEM_MAX = _core_.ITEM_MAX
587HT_NOWHERE = _core_.HT_NOWHERE
588HT_SCROLLBAR_FIRST = _core_.HT_SCROLLBAR_FIRST
589HT_SCROLLBAR_ARROW_LINE_1 = _core_.HT_SCROLLBAR_ARROW_LINE_1
590HT_SCROLLBAR_ARROW_LINE_2 = _core_.HT_SCROLLBAR_ARROW_LINE_2
591HT_SCROLLBAR_ARROW_PAGE_1 = _core_.HT_SCROLLBAR_ARROW_PAGE_1
592HT_SCROLLBAR_ARROW_PAGE_2 = _core_.HT_SCROLLBAR_ARROW_PAGE_2
593HT_SCROLLBAR_THUMB = _core_.HT_SCROLLBAR_THUMB
594HT_SCROLLBAR_BAR_1 = _core_.HT_SCROLLBAR_BAR_1
595HT_SCROLLBAR_BAR_2 = _core_.HT_SCROLLBAR_BAR_2
596HT_SCROLLBAR_LAST = _core_.HT_SCROLLBAR_LAST
597HT_WINDOW_OUTSIDE = _core_.HT_WINDOW_OUTSIDE
598HT_WINDOW_INSIDE = _core_.HT_WINDOW_INSIDE
599HT_WINDOW_VERT_SCROLLBAR = _core_.HT_WINDOW_VERT_SCROLLBAR
600HT_WINDOW_HORZ_SCROLLBAR = _core_.HT_WINDOW_HORZ_SCROLLBAR
601HT_WINDOW_CORNER = _core_.HT_WINDOW_CORNER
602HT_MAX = _core_.HT_MAX
603MOD_NONE = _core_.MOD_NONE
604MOD_ALT = _core_.MOD_ALT
605MOD_CONTROL = _core_.MOD_CONTROL
606MOD_SHIFT = _core_.MOD_SHIFT
607MOD_WIN = _core_.MOD_WIN
608UPDATE_UI_NONE = _core_.UPDATE_UI_NONE
609UPDATE_UI_RECURSE = _core_.UPDATE_UI_RECURSE
610UPDATE_UI_FROMIDLE = _core_.UPDATE_UI_FROMIDLE
d14a1e28
RD
611#---------------------------------------------------------------------------
612
613class Object(object):
0df68c9f
RD
614 """
615 The base class for most wx objects, although in wxPython not
616 much functionality is needed nor exposed.
617 """
d14a1e28
RD
618 def __init__(self): raise RuntimeError, "No constructor defined"
619 def __repr__(self):
620 return "<%s.%s; proxy of C++ wxObject instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
e811c8ce 621 def GetClassName(*args, **kwargs):
0df68c9f 622 """
a95a7133 623 GetClassName(self) -> String
e811c8ce 624
a95a7133 625 Returns the class name of the C++ class using wxRTTI.
0df68c9f 626 """
54f9ee45 627 return _core_.Object_GetClassName(*args, **kwargs)
e811c8ce
RD
628
629 def Destroy(*args, **kwargs):
0df68c9f 630 """
a95a7133 631 Destroy(self)
e811c8ce 632
0df68c9f
RD
633 Deletes the C++ object this Python object is a proxy for.
634 """
54f9ee45 635 return _core_.Object_Destroy(*args, **kwargs)
e811c8ce 636
d14a1e28
RD
637
638class ObjectPtr(Object):
639 def __init__(self, this):
640 self.this = this
641 if not hasattr(self,"thisown"): self.thisown = 0
642 self.__class__ = Object
54f9ee45
RD
643_core_.Object_swigregister(ObjectPtr)
644_wxPySetDictionary = _core_._wxPySetDictionary
d14a1e28 645
54f9ee45 646_wxPyFixStockObjects = _core_._wxPyFixStockObjects
3a04f143 647
54f9ee45 648cvar = _core_.cvar
196addbf 649EmptyString = cvar.EmptyString
d14a1e28
RD
650
651#---------------------------------------------------------------------------
652
54f9ee45
RD
653BITMAP_TYPE_INVALID = _core_.BITMAP_TYPE_INVALID
654BITMAP_TYPE_BMP = _core_.BITMAP_TYPE_BMP
655BITMAP_TYPE_ICO = _core_.BITMAP_TYPE_ICO
656BITMAP_TYPE_CUR = _core_.BITMAP_TYPE_CUR
657BITMAP_TYPE_XBM = _core_.BITMAP_TYPE_XBM
658BITMAP_TYPE_XBM_DATA = _core_.BITMAP_TYPE_XBM_DATA
659BITMAP_TYPE_XPM = _core_.BITMAP_TYPE_XPM
660BITMAP_TYPE_XPM_DATA = _core_.BITMAP_TYPE_XPM_DATA
661BITMAP_TYPE_TIF = _core_.BITMAP_TYPE_TIF
662BITMAP_TYPE_GIF = _core_.BITMAP_TYPE_GIF
663BITMAP_TYPE_PNG = _core_.BITMAP_TYPE_PNG
664BITMAP_TYPE_JPEG = _core_.BITMAP_TYPE_JPEG
665BITMAP_TYPE_PNM = _core_.BITMAP_TYPE_PNM
666BITMAP_TYPE_PCX = _core_.BITMAP_TYPE_PCX
667BITMAP_TYPE_PICT = _core_.BITMAP_TYPE_PICT
668BITMAP_TYPE_ICON = _core_.BITMAP_TYPE_ICON
669BITMAP_TYPE_ANI = _core_.BITMAP_TYPE_ANI
670BITMAP_TYPE_IFF = _core_.BITMAP_TYPE_IFF
671BITMAP_TYPE_MACCURSOR = _core_.BITMAP_TYPE_MACCURSOR
672BITMAP_TYPE_ANY = _core_.BITMAP_TYPE_ANY
673CURSOR_NONE = _core_.CURSOR_NONE
674CURSOR_ARROW = _core_.CURSOR_ARROW
675CURSOR_RIGHT_ARROW = _core_.CURSOR_RIGHT_ARROW
676CURSOR_BULLSEYE = _core_.CURSOR_BULLSEYE
677CURSOR_CHAR = _core_.CURSOR_CHAR
678CURSOR_CROSS = _core_.CURSOR_CROSS
679CURSOR_HAND = _core_.CURSOR_HAND
680CURSOR_IBEAM = _core_.CURSOR_IBEAM
681CURSOR_LEFT_BUTTON = _core_.CURSOR_LEFT_BUTTON
682CURSOR_MAGNIFIER = _core_.CURSOR_MAGNIFIER
683CURSOR_MIDDLE_BUTTON = _core_.CURSOR_MIDDLE_BUTTON
684CURSOR_NO_ENTRY = _core_.CURSOR_NO_ENTRY
685CURSOR_PAINT_BRUSH = _core_.CURSOR_PAINT_BRUSH
686CURSOR_PENCIL = _core_.CURSOR_PENCIL
687CURSOR_POINT_LEFT = _core_.CURSOR_POINT_LEFT
688CURSOR_POINT_RIGHT = _core_.CURSOR_POINT_RIGHT
689CURSOR_QUESTION_ARROW = _core_.CURSOR_QUESTION_ARROW
690CURSOR_RIGHT_BUTTON = _core_.CURSOR_RIGHT_BUTTON
691CURSOR_SIZENESW = _core_.CURSOR_SIZENESW
692CURSOR_SIZENS = _core_.CURSOR_SIZENS
693CURSOR_SIZENWSE = _core_.CURSOR_SIZENWSE
694CURSOR_SIZEWE = _core_.CURSOR_SIZEWE
695CURSOR_SIZING = _core_.CURSOR_SIZING
696CURSOR_SPRAYCAN = _core_.CURSOR_SPRAYCAN
697CURSOR_WAIT = _core_.CURSOR_WAIT
698CURSOR_WATCH = _core_.CURSOR_WATCH
699CURSOR_BLANK = _core_.CURSOR_BLANK
700CURSOR_DEFAULT = _core_.CURSOR_DEFAULT
701CURSOR_COPY_ARROW = _core_.CURSOR_COPY_ARROW
702CURSOR_ARROWWAIT = _core_.CURSOR_ARROWWAIT
703CURSOR_MAX = _core_.CURSOR_MAX
d14a1e28
RD
704#---------------------------------------------------------------------------
705
706class Size(object):
0df68c9f 707 """
41e2b43e 708 wx.Size is a useful data structure used to represent the size of
093d3ff1
RD
709 something. It simply contians integer width and height
710 proprtites. In most places in wxPython where a wx.Size is
711 expected a (width, height) tuple can be used instead.
0df68c9f 712 """
e811c8ce
RD
713 def __repr__(self):
714 return "<%s.%s; proxy of C++ wxSize instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
54f9ee45
RD
715 width = property(_core_.Size_width_get, _core_.Size_width_set)
716 height = property(_core_.Size_height_get, _core_.Size_height_set)
242b7b46 717 x = width; y = height
d14a1e28 718 def __init__(self, *args, **kwargs):
0df68c9f 719 """
a95a7133 720 __init__(self, int w=0, int h=0) -> Size
e811c8ce 721
0df68c9f
RD
722 Creates a size object.
723 """
54f9ee45 724 newobj = _core_.new_Size(*args, **kwargs)
d14a1e28
RD
725 self.this = newobj.this
726 self.thisown = 1
727 del newobj.thisown
54f9ee45 728 def __del__(self, destroy=_core_.delete_Size):
a95a7133 729 """__del__(self)"""
d14a1e28
RD
730 try:
731 if self.thisown: destroy(self)
732 except: pass
e811c8ce
RD
733
734 def __eq__(*args, **kwargs):
0df68c9f 735 """
a95a7133 736 __eq__(self, Size sz) -> bool
e811c8ce 737
0df68c9f
RD
738 Test for equality of wx.Size objects.
739 """
54f9ee45 740 return _core_.Size___eq__(*args, **kwargs)
e811c8ce
RD
741
742 def __ne__(*args, **kwargs):
0df68c9f 743 """
a95a7133 744 __ne__(self, Size sz) -> bool
e811c8ce 745
0df68c9f
RD
746 Test for inequality.
747 """
54f9ee45 748 return _core_.Size___ne__(*args, **kwargs)
e811c8ce
RD
749
750 def __add__(*args, **kwargs):
0df68c9f 751 """
a95a7133 752 __add__(self, Size sz) -> Size
e811c8ce 753
0df68c9f
RD
754 Add sz's proprties to this and return the result.
755 """
54f9ee45 756 return _core_.Size___add__(*args, **kwargs)
e811c8ce
RD
757
758 def __sub__(*args, **kwargs):
0df68c9f 759 """
a95a7133 760 __sub__(self, Size sz) -> Size
e811c8ce 761
0df68c9f
RD
762 Subtract sz's properties from this and return the result.
763 """
54f9ee45 764 return _core_.Size___sub__(*args, **kwargs)
e811c8ce
RD
765
766 def IncTo(*args, **kwargs):
0df68c9f 767 """
a95a7133 768 IncTo(self, Size sz)
e811c8ce 769
0df68c9f
RD
770 Increments this object so that both of its dimensions are not less
771 than the corresponding dimensions of the size.
772 """
54f9ee45 773 return _core_.Size_IncTo(*args, **kwargs)
e811c8ce
RD
774
775 def DecTo(*args, **kwargs):
0df68c9f 776 """
a95a7133 777 DecTo(self, Size sz)
e811c8ce 778
0df68c9f
RD
779 Decrements this object so that both of its dimensions are not greater
780 than the corresponding dimensions of the size.
781 """
54f9ee45 782 return _core_.Size_DecTo(*args, **kwargs)
e811c8ce
RD
783
784 def Set(*args, **kwargs):
0df68c9f 785 """
a95a7133 786 Set(self, int w, int h)
e811c8ce 787
0df68c9f
RD
788 Set both width and height.
789 """
54f9ee45 790 return _core_.Size_Set(*args, **kwargs)
e811c8ce
RD
791
792 def SetWidth(*args, **kwargs):
a95a7133 793 """SetWidth(self, int w)"""
54f9ee45 794 return _core_.Size_SetWidth(*args, **kwargs)
e811c8ce
RD
795
796 def SetHeight(*args, **kwargs):
a95a7133 797 """SetHeight(self, int h)"""
54f9ee45 798 return _core_.Size_SetHeight(*args, **kwargs)
e811c8ce
RD
799
800 def GetWidth(*args, **kwargs):
a95a7133 801 """GetWidth(self) -> int"""
54f9ee45 802 return _core_.Size_GetWidth(*args, **kwargs)
e811c8ce
RD
803
804 def GetHeight(*args, **kwargs):
a95a7133 805 """GetHeight(self) -> int"""
54f9ee45 806 return _core_.Size_GetHeight(*args, **kwargs)
e811c8ce 807
74a57fcd
RD
808 def IsFullySpecified(*args, **kwargs):
809 """
a95a7133 810 IsFullySpecified(self) -> bool
74a57fcd
RD
811
812 Returns True if both components of the size are non-default values.
813 """
54f9ee45 814 return _core_.Size_IsFullySpecified(*args, **kwargs)
74a57fcd
RD
815
816 def SetDefaults(*args, **kwargs):
817 """
a95a7133 818 SetDefaults(self, Size size)
74a57fcd 819
41e2b43e
RD
820 Combine this size with the other one replacing the default components
821 of this object (i.e. equal to -1) with those of the other.
74a57fcd 822 """
54f9ee45 823 return _core_.Size_SetDefaults(*args, **kwargs)
74a57fcd 824
e811c8ce 825 def Get(*args, **kwargs):
0df68c9f
RD
826 """
827 Get() -> (width,height)
e811c8ce 828
0df68c9f
RD
829 Returns the width and height properties as a tuple.
830 """
54f9ee45 831 return _core_.Size_Get(*args, **kwargs)
e811c8ce 832
41e2b43e 833 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
e811c8ce
RD
834 def __str__(self): return str(self.Get())
835 def __repr__(self): return 'wx.Size'+str(self.Get())
836 def __len__(self): return len(self.Get())
837 def __getitem__(self, index): return self.Get()[index]
d14a1e28
RD
838 def __setitem__(self, index, val):
839 if index == 0: self.width = val
840 elif index == 1: self.height = val
841 else: raise IndexError
e811c8ce 842 def __nonzero__(self): return self.Get() != (0,0)
74e96f3d
RD
843 __safe_for_unpickling__ = True
844 def __reduce__(self): return (wx.Size, self.Get())
d14a1e28
RD
845
846
847class SizePtr(Size):
848 def __init__(self, this):
849 self.this = this
850 if not hasattr(self,"thisown"): self.thisown = 0
851 self.__class__ = Size
54f9ee45 852_core_.Size_swigregister(SizePtr)
d14a1e28
RD
853
854#---------------------------------------------------------------------------
855
856class RealPoint(object):
0df68c9f 857 """
41e2b43e
RD
858 A data structure for representing a point or position with floating
859 point x and y properties. In wxPython most places that expect a
860 wx.RealPoint can also accept a (x,y) tuple.
0df68c9f 861 """
e811c8ce
RD
862 def __repr__(self):
863 return "<%s.%s; proxy of C++ wxRealPoint instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
54f9ee45
RD
864 x = property(_core_.RealPoint_x_get, _core_.RealPoint_x_set)
865 y = property(_core_.RealPoint_y_get, _core_.RealPoint_y_set)
d14a1e28 866 def __init__(self, *args, **kwargs):
0df68c9f 867 """
a95a7133 868 __init__(self, double x=0.0, double y=0.0) -> RealPoint
e811c8ce 869
0df68c9f
RD
870 Create a wx.RealPoint object
871 """
54f9ee45 872 newobj = _core_.new_RealPoint(*args, **kwargs)
d14a1e28
RD
873 self.this = newobj.this
874 self.thisown = 1
875 del newobj.thisown
54f9ee45 876 def __del__(self, destroy=_core_.delete_RealPoint):
a95a7133 877 """__del__(self)"""
d14a1e28
RD
878 try:
879 if self.thisown: destroy(self)
880 except: pass
e811c8ce
RD
881
882 def __eq__(*args, **kwargs):
0df68c9f 883 """
a95a7133 884 __eq__(self, RealPoint pt) -> bool
e811c8ce 885
0df68c9f
RD
886 Test for equality of wx.RealPoint objects.
887 """
54f9ee45 888 return _core_.RealPoint___eq__(*args, **kwargs)
e811c8ce
RD
889
890 def __ne__(*args, **kwargs):
0df68c9f 891 """
a95a7133 892 __ne__(self, RealPoint pt) -> bool
e811c8ce 893
0df68c9f
RD
894 Test for inequality of wx.RealPoint objects.
895 """
54f9ee45 896 return _core_.RealPoint___ne__(*args, **kwargs)
e811c8ce
RD
897
898 def __add__(*args, **kwargs):
0df68c9f 899 """
a95a7133 900 __add__(self, RealPoint pt) -> RealPoint
e811c8ce 901
0df68c9f
RD
902 Add pt's proprties to this and return the result.
903 """
54f9ee45 904 return _core_.RealPoint___add__(*args, **kwargs)
e811c8ce
RD
905
906 def __sub__(*args, **kwargs):
0df68c9f 907 """
a95a7133 908 __sub__(self, RealPoint pt) -> RealPoint
e811c8ce 909
0df68c9f
RD
910 Subtract pt's proprties from this and return the result
911 """
54f9ee45 912 return _core_.RealPoint___sub__(*args, **kwargs)
e811c8ce
RD
913
914 def Set(*args, **kwargs):
0df68c9f 915 """
a95a7133 916 Set(self, double x, double y)
e811c8ce 917
0df68c9f
RD
918 Set both the x and y properties
919 """
54f9ee45 920 return _core_.RealPoint_Set(*args, **kwargs)
e811c8ce
RD
921
922 def Get(*args, **kwargs):
0df68c9f
RD
923 """
924 Get() -> (x,y)
e811c8ce 925
0df68c9f
RD
926 Return the x and y properties as a tuple.
927 """
54f9ee45 928 return _core_.RealPoint_Get(*args, **kwargs)
e811c8ce 929
41e2b43e 930 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
e811c8ce
RD
931 def __str__(self): return str(self.Get())
932 def __repr__(self): return 'wx.RealPoint'+str(self.Get())
933 def __len__(self): return len(self.Get())
934 def __getitem__(self, index): return self.Get()[index]
d14a1e28 935 def __setitem__(self, index, val):
e811c8ce
RD
936 if index == 0: self.x = val
937 elif index == 1: self.y = val
d14a1e28 938 else: raise IndexError
e811c8ce 939 def __nonzero__(self): return self.Get() != (0.0, 0.0)
74e96f3d
RD
940 __safe_for_unpickling__ = True
941 def __reduce__(self): return (wx.RealPoint, self.Get())
d14a1e28
RD
942
943
944class RealPointPtr(RealPoint):
945 def __init__(self, this):
946 self.this = this
947 if not hasattr(self,"thisown"): self.thisown = 0
948 self.__class__ = RealPoint
54f9ee45 949_core_.RealPoint_swigregister(RealPointPtr)
d14a1e28
RD
950
951#---------------------------------------------------------------------------
952
953class Point(object):
0df68c9f 954 """
41e2b43e
RD
955 A data structure for representing a point or position with integer x
956 and y properties. Most places in wxPython that expect a wx.Point can
957 also accept a (x,y) tuple.
0df68c9f 958 """
e811c8ce
RD
959 def __repr__(self):
960 return "<%s.%s; proxy of C++ wxPoint instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
54f9ee45
RD
961 x = property(_core_.Point_x_get, _core_.Point_x_set)
962 y = property(_core_.Point_y_get, _core_.Point_y_set)
d14a1e28 963 def __init__(self, *args, **kwargs):
0df68c9f 964 """
a95a7133 965 __init__(self, int x=0, int y=0) -> Point
e811c8ce 966
0df68c9f
RD
967 Create a wx.Point object
968 """
54f9ee45 969 newobj = _core_.new_Point(*args, **kwargs)
d14a1e28
RD
970 self.this = newobj.this
971 self.thisown = 1
972 del newobj.thisown
54f9ee45 973 def __del__(self, destroy=_core_.delete_Point):
a95a7133 974 """__del__(self)"""
d14a1e28
RD
975 try:
976 if self.thisown: destroy(self)
977 except: pass
e811c8ce
RD
978
979 def __eq__(*args, **kwargs):
0df68c9f 980 """
a95a7133 981 __eq__(self, Point pt) -> bool
e811c8ce 982
0df68c9f
RD
983 Test for equality of wx.Point objects.
984 """
54f9ee45 985 return _core_.Point___eq__(*args, **kwargs)
e811c8ce
RD
986
987 def __ne__(*args, **kwargs):
0df68c9f 988 """
a95a7133 989 __ne__(self, Point pt) -> bool
e811c8ce 990
0df68c9f
RD
991 Test for inequality of wx.Point objects.
992 """
54f9ee45 993 return _core_.Point___ne__(*args, **kwargs)
e811c8ce
RD
994
995 def __add__(*args, **kwargs):
0df68c9f 996 """
a95a7133 997 __add__(self, Point pt) -> Point
e811c8ce 998
0df68c9f
RD
999 Add pt's proprties to this and return the result.
1000 """
54f9ee45 1001 return _core_.Point___add__(*args, **kwargs)
e811c8ce
RD
1002
1003 def __sub__(*args, **kwargs):
0df68c9f 1004 """
a95a7133 1005 __sub__(self, Point pt) -> Point
e811c8ce 1006
0df68c9f
RD
1007 Subtract pt's proprties from this and return the result
1008 """
54f9ee45 1009 return _core_.Point___sub__(*args, **kwargs)
e811c8ce
RD
1010
1011 def __iadd__(*args, **kwargs):
0df68c9f 1012 """
a95a7133 1013 __iadd__(self, Point pt) -> Point
e811c8ce 1014
0df68c9f
RD
1015 Add pt to this object.
1016 """
54f9ee45 1017 return _core_.Point___iadd__(*args, **kwargs)
e811c8ce
RD
1018
1019 def __isub__(*args, **kwargs):
0df68c9f 1020 """
a95a7133 1021 __isub__(self, Point pt) -> Point
e811c8ce 1022
0df68c9f
RD
1023 Subtract pt from this object.
1024 """
54f9ee45 1025 return _core_.Point___isub__(*args, **kwargs)
e811c8ce
RD
1026
1027 def Set(*args, **kwargs):
0df68c9f 1028 """
a95a7133 1029 Set(self, long x, long y)
e811c8ce 1030
0df68c9f
RD
1031 Set both the x and y properties
1032 """
54f9ee45 1033 return _core_.Point_Set(*args, **kwargs)
e811c8ce
RD
1034
1035 def Get(*args, **kwargs):
0df68c9f
RD
1036 """
1037 Get() -> (x,y)
e811c8ce 1038
0df68c9f
RD
1039 Return the x and y properties as a tuple.
1040 """
54f9ee45 1041 return _core_.Point_Get(*args, **kwargs)
e811c8ce 1042
41e2b43e 1043 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
e811c8ce
RD
1044 def __str__(self): return str(self.Get())
1045 def __repr__(self): return 'wx.Point'+str(self.Get())
1046 def __len__(self): return len(self.Get())
1047 def __getitem__(self, index): return self.Get()[index]
d14a1e28
RD
1048 def __setitem__(self, index, val):
1049 if index == 0: self.x = val
1050 elif index == 1: self.y = val
1051 else: raise IndexError
e811c8ce 1052 def __nonzero__(self): return self.Get() != (0,0)
74e96f3d
RD
1053 __safe_for_unpickling__ = True
1054 def __reduce__(self): return (wx.Point, self.Get())
d14a1e28
RD
1055
1056
1057class PointPtr(Point):
1058 def __init__(self, this):
1059 self.this = this
1060 if not hasattr(self,"thisown"): self.thisown = 0
1061 self.__class__ = Point
54f9ee45 1062_core_.Point_swigregister(PointPtr)
d14a1e28
RD
1063
1064#---------------------------------------------------------------------------
1065
1066class Rect(object):
0df68c9f 1067 """
41e2b43e
RD
1068 A class for representing and manipulating rectangles. It has x, y,
1069 width and height properties. In wxPython most palces that expect a
1070 wx.Rect can also accept a (x,y,width,height) tuple.
0df68c9f 1071 """
e811c8ce
RD
1072 def __repr__(self):
1073 return "<%s.%s; proxy of C++ wxRect instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 1074 def __init__(self, *args, **kwargs):
0df68c9f 1075 """
a95a7133 1076 __init__(self, int x=0, int y=0, int width=0, int height=0) -> Rect
e811c8ce 1077
0df68c9f
RD
1078 Create a new Rect object.
1079 """
54f9ee45 1080 newobj = _core_.new_Rect(*args, **kwargs)
d14a1e28
RD
1081 self.this = newobj.this
1082 self.thisown = 1
1083 del newobj.thisown
54f9ee45 1084 def __del__(self, destroy=_core_.delete_Rect):
a95a7133 1085 """__del__(self)"""
d14a1e28
RD
1086 try:
1087 if self.thisown: destroy(self)
1088 except: pass
e811c8ce
RD
1089
1090 def GetX(*args, **kwargs):
a95a7133 1091 """GetX(self) -> int"""
54f9ee45 1092 return _core_.Rect_GetX(*args, **kwargs)
e811c8ce
RD
1093
1094 def SetX(*args, **kwargs):
a95a7133 1095 """SetX(self, int x)"""
54f9ee45 1096 return _core_.Rect_SetX(*args, **kwargs)
e811c8ce
RD
1097
1098 def GetY(*args, **kwargs):
a95a7133 1099 """GetY(self) -> int"""
54f9ee45 1100 return _core_.Rect_GetY(*args, **kwargs)
e811c8ce
RD
1101
1102 def SetY(*args, **kwargs):
a95a7133 1103 """SetY(self, int y)"""
54f9ee45 1104 return _core_.Rect_SetY(*args, **kwargs)
e811c8ce
RD
1105
1106 def GetWidth(*args, **kwargs):
a95a7133 1107 """GetWidth(self) -> int"""
54f9ee45 1108 return _core_.Rect_GetWidth(*args, **kwargs)
e811c8ce
RD
1109
1110 def SetWidth(*args, **kwargs):
a95a7133 1111 """SetWidth(self, int w)"""
54f9ee45 1112 return _core_.Rect_SetWidth(*args, **kwargs)
e811c8ce
RD
1113
1114 def GetHeight(*args, **kwargs):
a95a7133 1115 """GetHeight(self) -> int"""
54f9ee45 1116 return _core_.Rect_GetHeight(*args, **kwargs)
e811c8ce
RD
1117
1118 def SetHeight(*args, **kwargs):
a95a7133 1119 """SetHeight(self, int h)"""
54f9ee45 1120 return _core_.Rect_SetHeight(*args, **kwargs)
e811c8ce
RD
1121
1122 def GetPosition(*args, **kwargs):
a95a7133 1123 """GetPosition(self) -> Point"""
54f9ee45 1124 return _core_.Rect_GetPosition(*args, **kwargs)
e811c8ce
RD
1125
1126 def SetPosition(*args, **kwargs):
a95a7133 1127 """SetPosition(self, Point p)"""
54f9ee45 1128 return _core_.Rect_SetPosition(*args, **kwargs)
e811c8ce
RD
1129
1130 def GetSize(*args, **kwargs):
a95a7133 1131 """GetSize(self) -> Size"""
54f9ee45 1132 return _core_.Rect_GetSize(*args, **kwargs)
e811c8ce
RD
1133
1134 def SetSize(*args, **kwargs):
a95a7133 1135 """SetSize(self, Size s)"""
54f9ee45 1136 return _core_.Rect_SetSize(*args, **kwargs)
e811c8ce 1137
c9c7117a 1138 def GetTopLeft(*args, **kwargs):
a95a7133 1139 """GetTopLeft(self) -> Point"""
54f9ee45 1140 return _core_.Rect_GetTopLeft(*args, **kwargs)
c9c7117a
RD
1141
1142 def SetTopLeft(*args, **kwargs):
a95a7133 1143 """SetTopLeft(self, Point p)"""
54f9ee45 1144 return _core_.Rect_SetTopLeft(*args, **kwargs)
c9c7117a
RD
1145
1146 def GetBottomRight(*args, **kwargs):
a95a7133 1147 """GetBottomRight(self) -> Point"""
54f9ee45 1148 return _core_.Rect_GetBottomRight(*args, **kwargs)
c9c7117a
RD
1149
1150 def SetBottomRight(*args, **kwargs):
a95a7133 1151 """SetBottomRight(self, Point p)"""
54f9ee45 1152 return _core_.Rect_SetBottomRight(*args, **kwargs)
c9c7117a 1153
e811c8ce 1154 def GetLeft(*args, **kwargs):
a95a7133 1155 """GetLeft(self) -> int"""
54f9ee45 1156 return _core_.Rect_GetLeft(*args, **kwargs)
e811c8ce
RD
1157
1158 def GetTop(*args, **kwargs):
a95a7133 1159 """GetTop(self) -> int"""
54f9ee45 1160 return _core_.Rect_GetTop(*args, **kwargs)
e811c8ce
RD
1161
1162 def GetBottom(*args, **kwargs):
a95a7133 1163 """GetBottom(self) -> int"""
54f9ee45 1164 return _core_.Rect_GetBottom(*args, **kwargs)
e811c8ce
RD
1165
1166 def GetRight(*args, **kwargs):
a95a7133 1167 """GetRight(self) -> int"""
54f9ee45 1168 return _core_.Rect_GetRight(*args, **kwargs)
e811c8ce
RD
1169
1170 def SetLeft(*args, **kwargs):
a95a7133 1171 """SetLeft(self, int left)"""
54f9ee45 1172 return _core_.Rect_SetLeft(*args, **kwargs)
e811c8ce
RD
1173
1174 def SetRight(*args, **kwargs):
a95a7133 1175 """SetRight(self, int right)"""
54f9ee45 1176 return _core_.Rect_SetRight(*args, **kwargs)
e811c8ce
RD
1177
1178 def SetTop(*args, **kwargs):
a95a7133 1179 """SetTop(self, int top)"""
54f9ee45 1180 return _core_.Rect_SetTop(*args, **kwargs)
e811c8ce
RD
1181
1182 def SetBottom(*args, **kwargs):
a95a7133 1183 """SetBottom(self, int bottom)"""
54f9ee45 1184 return _core_.Rect_SetBottom(*args, **kwargs)
e811c8ce
RD
1185
1186 position = property(GetPosition, SetPosition)
1187 size = property(GetSize, SetSize)
1188 left = property(GetLeft, SetLeft)
1189 right = property(GetRight, SetRight)
1190 top = property(GetTop, SetTop)
1191 bottom = property(GetBottom, SetBottom)
1192
1193 def Inflate(*args, **kwargs):
0df68c9f 1194 """
a95a7133 1195 Inflate(self, int dx, int dy) -> Rect
e811c8ce 1196
8e738329
RD
1197 Increases the size of the rectangle.
1198
1199 The left border is moved farther left and the right border is moved
1200 farther right by ``dx``. The upper border is moved farther up and the
1201 bottom border is moved farther down by ``dy``. (Note the the width and
1202 height of the rectangle thus change by ``2*dx`` and ``2*dy``,
1203 respectively.) If one or both of ``dx`` and ``dy`` are negative, the
1204 opposite happens: the rectangle size decreases in the respective
1205 direction.
1206
1207 The change is made to the rectangle inplace, if instead you need a
1208 copy that is inflated, preserving the original then make the copy
1209 first::
1210
1211 copy = wx.Rect(*original)
1212 copy.Inflate(10,15)
1213
1214
0df68c9f 1215 """
54f9ee45 1216 return _core_.Rect_Inflate(*args, **kwargs)
e811c8ce
RD
1217
1218 def Deflate(*args, **kwargs):
0df68c9f 1219 """
a95a7133 1220 Deflate(self, int dx, int dy) -> Rect
e811c8ce 1221
8e738329
RD
1222 Decrease the rectangle size. This method is the opposite of `Inflate`
1223 in that Deflate(a,b) is equivalent to Inflate(-a,-b). Please refer to
1224 `Inflate` for a full description.
0df68c9f 1225 """
54f9ee45 1226 return _core_.Rect_Deflate(*args, **kwargs)
e811c8ce
RD
1227
1228 def OffsetXY(*args, **kwargs):
0df68c9f 1229 """
a95a7133 1230 OffsetXY(self, int dx, int dy)
e811c8ce 1231
41e2b43e
RD
1232 Moves the rectangle by the specified offset. If dx is positive, the
1233 rectangle is moved to the right, if dy is positive, it is moved to the
1234 bottom, otherwise it is moved to the left or top respectively.
0df68c9f 1235 """
54f9ee45 1236 return _core_.Rect_OffsetXY(*args, **kwargs)
e811c8ce
RD
1237
1238 def Offset(*args, **kwargs):
0df68c9f 1239 """
a95a7133 1240 Offset(self, Point pt)
e811c8ce 1241
0df68c9f
RD
1242 Same as OffsetXY but uses dx,dy from Point
1243 """
54f9ee45 1244 return _core_.Rect_Offset(*args, **kwargs)
e811c8ce
RD
1245
1246 def Intersect(*args, **kwargs):
0df68c9f 1247 """
a95a7133 1248 Intersect(self, Rect rect) -> Rect
e811c8ce 1249
5cbf236d 1250 Returns the intersectsion of this rectangle and rect.
0df68c9f 1251 """
54f9ee45 1252 return _core_.Rect_Intersect(*args, **kwargs)
e811c8ce 1253
5cbf236d
RD
1254 def Union(*args, **kwargs):
1255 """
1256 Union(self, Rect rect) -> Rect
1257
1258 Returns the union of this rectangle and rect.
1259 """
1260 return _core_.Rect_Union(*args, **kwargs)
1261
e811c8ce 1262 def __add__(*args, **kwargs):
0df68c9f 1263 """
a95a7133 1264 __add__(self, Rect rect) -> Rect
e811c8ce 1265
0df68c9f
RD
1266 Add the properties of rect to this rectangle and return the result.
1267 """
54f9ee45 1268 return _core_.Rect___add__(*args, **kwargs)
e811c8ce
RD
1269
1270 def __iadd__(*args, **kwargs):
0df68c9f 1271 """
a95a7133 1272 __iadd__(self, Rect rect) -> Rect
e811c8ce 1273
0df68c9f
RD
1274 Add the properties of rect to this rectangle, updating this rectangle.
1275 """
54f9ee45 1276 return _core_.Rect___iadd__(*args, **kwargs)
e811c8ce
RD
1277
1278 def __eq__(*args, **kwargs):
0df68c9f 1279 """
a95a7133 1280 __eq__(self, Rect rect) -> bool
e811c8ce 1281
0df68c9f
RD
1282 Test for equality.
1283 """
54f9ee45 1284 return _core_.Rect___eq__(*args, **kwargs)
e811c8ce
RD
1285
1286 def __ne__(*args, **kwargs):
0df68c9f 1287 """
a95a7133 1288 __ne__(self, Rect rect) -> bool
e811c8ce 1289
0df68c9f
RD
1290 Test for inequality.
1291 """
54f9ee45 1292 return _core_.Rect___ne__(*args, **kwargs)
e811c8ce
RD
1293
1294 def InsideXY(*args, **kwargs):
0df68c9f 1295 """
a95a7133 1296 InsideXY(self, int x, int y) -> bool
e811c8ce 1297
0df68c9f
RD
1298 Return True if the point is (not strcitly) inside the rect.
1299 """
54f9ee45 1300 return _core_.Rect_InsideXY(*args, **kwargs)
e811c8ce
RD
1301
1302 def Inside(*args, **kwargs):
0df68c9f 1303 """
a95a7133 1304 Inside(self, Point pt) -> bool
e811c8ce 1305
0df68c9f
RD
1306 Return True if the point is (not strcitly) inside the rect.
1307 """
54f9ee45 1308 return _core_.Rect_Inside(*args, **kwargs)
e811c8ce
RD
1309
1310 def Intersects(*args, **kwargs):
0df68c9f 1311 """
a95a7133 1312 Intersects(self, Rect rect) -> bool
e811c8ce 1313
0df68c9f
RD
1314 Returns True if the rectangles have a non empty intersection.
1315 """
54f9ee45 1316 return _core_.Rect_Intersects(*args, **kwargs)
e811c8ce 1317
54f9ee45
RD
1318 x = property(_core_.Rect_x_get, _core_.Rect_x_set)
1319 y = property(_core_.Rect_y_get, _core_.Rect_y_set)
1320 width = property(_core_.Rect_width_get, _core_.Rect_width_set)
1321 height = property(_core_.Rect_height_get, _core_.Rect_height_set)
e811c8ce 1322 def Set(*args, **kwargs):
0df68c9f 1323 """
a95a7133 1324 Set(self, int x=0, int y=0, int width=0, int height=0)
e811c8ce 1325
0df68c9f
RD
1326 Set all rectangle properties.
1327 """
54f9ee45 1328 return _core_.Rect_Set(*args, **kwargs)
e811c8ce
RD
1329
1330 def Get(*args, **kwargs):
0df68c9f
RD
1331 """
1332 Get() -> (x,y,width,height)
e811c8ce 1333
0df68c9f
RD
1334 Return the rectangle properties as a tuple.
1335 """
54f9ee45 1336 return _core_.Rect_Get(*args, **kwargs)
e811c8ce 1337
41e2b43e 1338 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
e811c8ce
RD
1339 def __str__(self): return str(self.Get())
1340 def __repr__(self): return 'wx.Rect'+str(self.Get())
1341 def __len__(self): return len(self.Get())
1342 def __getitem__(self, index): return self.Get()[index]
d14a1e28
RD
1343 def __setitem__(self, index, val):
1344 if index == 0: self.x = val
1345 elif index == 1: self.y = val
1346 elif index == 2: self.width = val
1347 elif index == 3: self.height = val
1348 else: raise IndexError
e811c8ce 1349 def __nonzero__(self): return self.Get() != (0,0,0,0)
74e96f3d
RD
1350 __safe_for_unpickling__ = True
1351 def __reduce__(self): return (wx.Rect, self.Get())
d14a1e28
RD
1352
1353
1354class RectPtr(Rect):
1355 def __init__(self, this):
1356 self.this = this
1357 if not hasattr(self,"thisown"): self.thisown = 0
1358 self.__class__ = Rect
54f9ee45 1359_core_.Rect_swigregister(RectPtr)
d14a1e28
RD
1360
1361def RectPP(*args, **kwargs):
0df68c9f
RD
1362 """
1363 RectPP(Point topLeft, Point bottomRight) -> Rect
e811c8ce 1364
0df68c9f
RD
1365 Create a new Rect object from Points representing two corners.
1366 """
54f9ee45 1367 val = _core_.new_RectPP(*args, **kwargs)
d14a1e28
RD
1368 val.thisown = 1
1369 return val
1370
1371def RectPS(*args, **kwargs):
0df68c9f
RD
1372 """
1373 RectPS(Point pos, Size size) -> Rect
e811c8ce 1374
0df68c9f
RD
1375 Create a new Rect from a position and size.
1376 """
54f9ee45 1377 val = _core_.new_RectPS(*args, **kwargs)
d14a1e28
RD
1378 val.thisown = 1
1379 return val
1380
d3b6e4ff
RD
1381def RectS(*args, **kwargs):
1382 """
1383 RectS(Size size) -> Rect
1384
1385 Create a new Rect from a size only.
1386 """
1387 val = _core_.new_RectS(*args, **kwargs)
1388 val.thisown = 1
1389 return val
1390
d14a1e28 1391
e811c8ce 1392def IntersectRect(*args, **kwargs):
0df68c9f
RD
1393 """
1394 IntersectRect(Rect r1, Rect r2) -> Rect
e811c8ce 1395
0df68c9f
RD
1396 Calculate and return the intersection of r1 and r2.
1397 """
54f9ee45 1398 return _core_.IntersectRect(*args, **kwargs)
d14a1e28
RD
1399#---------------------------------------------------------------------------
1400
1401class Point2D(object):
41e2b43e
RD
1402 """
1403 wx.Point2Ds represent a point or a vector in a 2d coordinate system
1404 with floating point values.
1405 """
e811c8ce
RD
1406 def __repr__(self):
1407 return "<%s.%s; proxy of C++ wxPoint2D instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 1408 def __init__(self, *args, **kwargs):
0df68c9f 1409 """
a95a7133 1410 __init__(self, double x=0.0, double y=0.0) -> Point2D
e811c8ce 1411
0df68c9f
RD
1412 Create a w.Point2D object.
1413 """
54f9ee45 1414 newobj = _core_.new_Point2D(*args, **kwargs)
d14a1e28
RD
1415 self.this = newobj.this
1416 self.thisown = 1
1417 del newobj.thisown
e811c8ce 1418 def GetFloor(*args, **kwargs):
fd2dc343
RD
1419 """
1420 GetFloor() -> (x,y)
1421
1422 Convert to integer
1423 """
54f9ee45 1424 return _core_.Point2D_GetFloor(*args, **kwargs)
e811c8ce
RD
1425
1426 def GetRounded(*args, **kwargs):
fd2dc343
RD
1427 """
1428 GetRounded() -> (x,y)
1429
1430 Convert to integer
1431 """
54f9ee45 1432 return _core_.Point2D_GetRounded(*args, **kwargs)
e811c8ce
RD
1433
1434 def GetVectorLength(*args, **kwargs):
a95a7133 1435 """GetVectorLength(self) -> double"""
54f9ee45 1436 return _core_.Point2D_GetVectorLength(*args, **kwargs)
e811c8ce
RD
1437
1438 def GetVectorAngle(*args, **kwargs):
a95a7133 1439 """GetVectorAngle(self) -> double"""
54f9ee45 1440 return _core_.Point2D_GetVectorAngle(*args, **kwargs)
e811c8ce
RD
1441
1442 def SetVectorLength(*args, **kwargs):
a95a7133 1443 """SetVectorLength(self, double length)"""
54f9ee45 1444 return _core_.Point2D_SetVectorLength(*args, **kwargs)
e811c8ce
RD
1445
1446 def SetVectorAngle(*args, **kwargs):
a95a7133 1447 """SetVectorAngle(self, double degrees)"""
54f9ee45 1448 return _core_.Point2D_SetVectorAngle(*args, **kwargs)
e811c8ce 1449
d14a1e28
RD
1450 def SetPolarCoordinates(self, angle, length):
1451 self.SetVectorLength(length)
1452 self.SetVectorAngle(angle)
1453 def Normalize(self):
1454 self.SetVectorLength(1.0)
1455
e811c8ce 1456 def GetDistance(*args, **kwargs):
a95a7133 1457 """GetDistance(self, Point2D pt) -> double"""
54f9ee45 1458 return _core_.Point2D_GetDistance(*args, **kwargs)
e811c8ce
RD
1459
1460 def GetDistanceSquare(*args, **kwargs):
a95a7133 1461 """GetDistanceSquare(self, Point2D pt) -> double"""
54f9ee45 1462 return _core_.Point2D_GetDistanceSquare(*args, **kwargs)
e811c8ce
RD
1463
1464 def GetDotProduct(*args, **kwargs):
a95a7133 1465 """GetDotProduct(self, Point2D vec) -> double"""
54f9ee45 1466 return _core_.Point2D_GetDotProduct(*args, **kwargs)
e811c8ce
RD
1467
1468 def GetCrossProduct(*args, **kwargs):
a95a7133 1469 """GetCrossProduct(self, Point2D vec) -> double"""
54f9ee45 1470 return _core_.Point2D_GetCrossProduct(*args, **kwargs)
e811c8ce
RD
1471
1472 def __neg__(*args, **kwargs):
0df68c9f 1473 """
a95a7133 1474 __neg__(self) -> Point2D
e811c8ce 1475
0df68c9f
RD
1476 the reflection of this point
1477 """
54f9ee45 1478 return _core_.Point2D___neg__(*args, **kwargs)
e811c8ce
RD
1479
1480 def __iadd__(*args, **kwargs):
a95a7133 1481 """__iadd__(self, Point2D pt) -> Point2D"""
54f9ee45 1482 return _core_.Point2D___iadd__(*args, **kwargs)
e811c8ce
RD
1483
1484 def __isub__(*args, **kwargs):
a95a7133 1485 """__isub__(self, Point2D pt) -> Point2D"""
54f9ee45 1486 return _core_.Point2D___isub__(*args, **kwargs)
e811c8ce
RD
1487
1488 def __imul__(*args, **kwargs):
a95a7133 1489 """__imul__(self, Point2D pt) -> Point2D"""
54f9ee45 1490 return _core_.Point2D___imul__(*args, **kwargs)
e811c8ce
RD
1491
1492 def __idiv__(*args, **kwargs):
a95a7133 1493 """__idiv__(self, Point2D pt) -> Point2D"""
54f9ee45 1494 return _core_.Point2D___idiv__(*args, **kwargs)
e811c8ce
RD
1495
1496 def __eq__(*args, **kwargs):
0df68c9f 1497 """
a95a7133 1498 __eq__(self, Point2D pt) -> bool
e811c8ce 1499
0df68c9f
RD
1500 Test for equality
1501 """
54f9ee45 1502 return _core_.Point2D___eq__(*args, **kwargs)
e811c8ce
RD
1503
1504 def __ne__(*args, **kwargs):
0df68c9f 1505 """
a95a7133 1506 __ne__(self, Point2D pt) -> bool
e811c8ce 1507
0df68c9f
RD
1508 Test for inequality
1509 """
54f9ee45 1510 return _core_.Point2D___ne__(*args, **kwargs)
e811c8ce 1511
54f9ee45
RD
1512 x = property(_core_.Point2D_x_get, _core_.Point2D_x_set)
1513 y = property(_core_.Point2D_y_get, _core_.Point2D_y_set)
e811c8ce 1514 def Set(*args, **kwargs):
a95a7133 1515 """Set(self, double x=0, double y=0)"""
54f9ee45 1516 return _core_.Point2D_Set(*args, **kwargs)
e811c8ce
RD
1517
1518 def Get(*args, **kwargs):
0df68c9f
RD
1519 """
1520 Get() -> (x,y)
e811c8ce 1521
0df68c9f
RD
1522 Return x and y properties as a tuple.
1523 """
54f9ee45 1524 return _core_.Point2D_Get(*args, **kwargs)
e811c8ce 1525
41e2b43e 1526 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
e811c8ce
RD
1527 def __str__(self): return str(self.Get())
1528 def __repr__(self): return 'wx.Point2D'+str(self.Get())
1529 def __len__(self): return len(self.Get())
1530 def __getitem__(self, index): return self.Get()[index]
d14a1e28 1531 def __setitem__(self, index, val):
e811c8ce
RD
1532 if index == 0: self.x = val
1533 elif index == 1: self.y = val
d14a1e28 1534 else: raise IndexError
e811c8ce 1535 def __nonzero__(self): return self.Get() != (0.0, 0.0)
74e96f3d
RD
1536 __safe_for_unpickling__ = True
1537 def __reduce__(self): return (wx.Point2D, self.Get())
d14a1e28
RD
1538
1539
1540class Point2DPtr(Point2D):
1541 def __init__(self, this):
1542 self.this = this
1543 if not hasattr(self,"thisown"): self.thisown = 0
1544 self.__class__ = Point2D
54f9ee45 1545_core_.Point2D_swigregister(Point2DPtr)
d14a1e28
RD
1546
1547def Point2DCopy(*args, **kwargs):
0df68c9f
RD
1548 """
1549 Point2DCopy(Point2D pt) -> Point2D
e811c8ce 1550
0df68c9f
RD
1551 Create a w.Point2D object.
1552 """
54f9ee45 1553 val = _core_.new_Point2DCopy(*args, **kwargs)
d14a1e28
RD
1554 val.thisown = 1
1555 return val
1556
1557def Point2DFromPoint(*args, **kwargs):
0df68c9f
RD
1558 """
1559 Point2DFromPoint(Point pt) -> Point2D
e811c8ce 1560
0df68c9f
RD
1561 Create a w.Point2D object.
1562 """
54f9ee45 1563 val = _core_.new_Point2DFromPoint(*args, **kwargs)
d14a1e28
RD
1564 val.thisown = 1
1565 return val
1566
1567#---------------------------------------------------------------------------
1568
54f9ee45
RD
1569FromStart = _core_.FromStart
1570FromCurrent = _core_.FromCurrent
1571FromEnd = _core_.FromEnd
d14a1e28 1572class InputStream(object):
093d3ff1 1573 """Proxy of C++ InputStream class"""
e811c8ce
RD
1574 def __repr__(self):
1575 return "<%s.%s; proxy of C++ wxPyInputStream instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 1576 def __init__(self, *args, **kwargs):
a95a7133 1577 """__init__(self, PyObject p) -> InputStream"""
54f9ee45 1578 newobj = _core_.new_InputStream(*args, **kwargs)
d14a1e28
RD
1579 self.this = newobj.this
1580 self.thisown = 1
1581 del newobj.thisown
8fb0e70a
RD
1582 def __del__(self, destroy=_core_.delete_InputStream):
1583 """__del__(self)"""
1584 try:
1585 if self.thisown: destroy(self)
1586 except: pass
1587
e811c8ce 1588 def close(*args, **kwargs):
a95a7133 1589 """close(self)"""
54f9ee45 1590 return _core_.InputStream_close(*args, **kwargs)
e811c8ce
RD
1591
1592 def flush(*args, **kwargs):
a95a7133 1593 """flush(self)"""
54f9ee45 1594 return _core_.InputStream_flush(*args, **kwargs)
e811c8ce
RD
1595
1596 def eof(*args, **kwargs):
a95a7133 1597 """eof(self) -> bool"""
54f9ee45 1598 return _core_.InputStream_eof(*args, **kwargs)
e811c8ce
RD
1599
1600 def read(*args, **kwargs):
a95a7133 1601 """read(self, int size=-1) -> PyObject"""
54f9ee45 1602 return _core_.InputStream_read(*args, **kwargs)
e811c8ce
RD
1603
1604 def readline(*args, **kwargs):
a95a7133 1605 """readline(self, int size=-1) -> PyObject"""
54f9ee45 1606 return _core_.InputStream_readline(*args, **kwargs)
e811c8ce
RD
1607
1608 def readlines(*args, **kwargs):
a95a7133 1609 """readlines(self, int sizehint=-1) -> PyObject"""
54f9ee45 1610 return _core_.InputStream_readlines(*args, **kwargs)
e811c8ce
RD
1611
1612 def seek(*args, **kwargs):
a95a7133 1613 """seek(self, int offset, int whence=0)"""
54f9ee45 1614 return _core_.InputStream_seek(*args, **kwargs)
e811c8ce
RD
1615
1616 def tell(*args, **kwargs):
a95a7133 1617 """tell(self) -> int"""
54f9ee45 1618 return _core_.InputStream_tell(*args, **kwargs)
e811c8ce
RD
1619
1620 def Peek(*args, **kwargs):
a95a7133 1621 """Peek(self) -> char"""
54f9ee45 1622 return _core_.InputStream_Peek(*args, **kwargs)
e811c8ce
RD
1623
1624 def GetC(*args, **kwargs):
a95a7133 1625 """GetC(self) -> char"""
54f9ee45 1626 return _core_.InputStream_GetC(*args, **kwargs)
e811c8ce
RD
1627
1628 def LastRead(*args, **kwargs):
a95a7133 1629 """LastRead(self) -> size_t"""
54f9ee45 1630 return _core_.InputStream_LastRead(*args, **kwargs)
e811c8ce
RD
1631
1632 def CanRead(*args, **kwargs):
a95a7133 1633 """CanRead(self) -> bool"""
54f9ee45 1634 return _core_.InputStream_CanRead(*args, **kwargs)
e811c8ce
RD
1635
1636 def Eof(*args, **kwargs):
a95a7133 1637 """Eof(self) -> bool"""
54f9ee45 1638 return _core_.InputStream_Eof(*args, **kwargs)
e811c8ce
RD
1639
1640 def Ungetch(*args, **kwargs):
a95a7133 1641 """Ungetch(self, char c) -> bool"""
54f9ee45 1642 return _core_.InputStream_Ungetch(*args, **kwargs)
e811c8ce
RD
1643
1644 def SeekI(*args, **kwargs):
a95a7133 1645 """SeekI(self, long pos, int mode=FromStart) -> long"""
54f9ee45 1646 return _core_.InputStream_SeekI(*args, **kwargs)
e811c8ce
RD
1647
1648 def TellI(*args, **kwargs):
a95a7133 1649 """TellI(self) -> long"""
54f9ee45 1650 return _core_.InputStream_TellI(*args, **kwargs)
e811c8ce 1651
d14a1e28
RD
1652
1653class InputStreamPtr(InputStream):
1654 def __init__(self, this):
1655 self.this = this
1656 if not hasattr(self,"thisown"): self.thisown = 0
1657 self.__class__ = InputStream
54f9ee45 1658_core_.InputStream_swigregister(InputStreamPtr)
d14a1e28
RD
1659DefaultPosition = cvar.DefaultPosition
1660DefaultSize = cvar.DefaultSize
1661
1662class OutputStream(object):
093d3ff1 1663 """Proxy of C++ OutputStream class"""
d14a1e28
RD
1664 def __init__(self): raise RuntimeError, "No constructor defined"
1665 def __repr__(self):
1666 return "<%s.%s; proxy of C++ wxOutputStream instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
e811c8ce 1667 def write(*args, **kwargs):
a95a7133 1668 """write(self, PyObject obj)"""
54f9ee45 1669 return _core_.OutputStream_write(*args, **kwargs)
e811c8ce 1670
d14a1e28
RD
1671
1672class OutputStreamPtr(OutputStream):
1673 def __init__(self, this):
1674 self.this = this
1675 if not hasattr(self,"thisown"): self.thisown = 0
1676 self.__class__ = OutputStream
54f9ee45 1677_core_.OutputStream_swigregister(OutputStreamPtr)
d14a1e28
RD
1678
1679#---------------------------------------------------------------------------
1680
1681class FSFile(Object):
093d3ff1 1682 """Proxy of C++ FSFile class"""
e811c8ce
RD
1683 def __repr__(self):
1684 return "<%s.%s; proxy of C++ wxFSFile instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 1685 def __init__(self, *args, **kwargs):
0df68c9f 1686 """
a95a7133 1687 __init__(self, InputStream stream, String loc, String mimetype, String anchor,
196addbf 1688 DateTime modif) -> FSFile
0df68c9f 1689 """
54f9ee45 1690 newobj = _core_.new_FSFile(*args, **kwargs)
d14a1e28
RD
1691 self.this = newobj.this
1692 self.thisown = 1
1693 del newobj.thisown
4cf4100f
RD
1694 self.thisown = 0 # It will normally be deleted by the user of the wxFileSystem
1695
54f9ee45 1696 def __del__(self, destroy=_core_.delete_FSFile):
a95a7133 1697 """__del__(self)"""
d14a1e28
RD
1698 try:
1699 if self.thisown: destroy(self)
1700 except: pass
e811c8ce
RD
1701
1702 def GetStream(*args, **kwargs):
a95a7133 1703 """GetStream(self) -> InputStream"""
54f9ee45 1704 return _core_.FSFile_GetStream(*args, **kwargs)
e811c8ce
RD
1705
1706 def GetMimeType(*args, **kwargs):
a95a7133 1707 """GetMimeType(self) -> String"""
54f9ee45 1708 return _core_.FSFile_GetMimeType(*args, **kwargs)
e811c8ce
RD
1709
1710 def GetLocation(*args, **kwargs):
a95a7133 1711 """GetLocation(self) -> String"""
54f9ee45 1712 return _core_.FSFile_GetLocation(*args, **kwargs)
e811c8ce
RD
1713
1714 def GetAnchor(*args, **kwargs):
a95a7133 1715 """GetAnchor(self) -> String"""
54f9ee45 1716 return _core_.FSFile_GetAnchor(*args, **kwargs)
e811c8ce
RD
1717
1718 def GetModificationTime(*args, **kwargs):
a95a7133 1719 """GetModificationTime(self) -> DateTime"""
54f9ee45 1720 return _core_.FSFile_GetModificationTime(*args, **kwargs)
e811c8ce 1721
d14a1e28
RD
1722
1723class FSFilePtr(FSFile):
1724 def __init__(self, this):
1725 self.this = this
1726 if not hasattr(self,"thisown"): self.thisown = 0
1727 self.__class__ = FSFile
54f9ee45 1728_core_.FSFile_swigregister(FSFilePtr)
d14a1e28
RD
1729
1730class CPPFileSystemHandler(object):
093d3ff1 1731 """Proxy of C++ CPPFileSystemHandler class"""
d14a1e28
RD
1732 def __init__(self): raise RuntimeError, "No constructor defined"
1733 def __repr__(self):
1734 return "<%s.%s; proxy of C++ wxFileSystemHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1735
1736class CPPFileSystemHandlerPtr(CPPFileSystemHandler):
1737 def __init__(self, this):
1738 self.this = this
1739 if not hasattr(self,"thisown"): self.thisown = 0
1740 self.__class__ = CPPFileSystemHandler
54f9ee45 1741_core_.CPPFileSystemHandler_swigregister(CPPFileSystemHandlerPtr)
d14a1e28
RD
1742
1743class FileSystemHandler(CPPFileSystemHandler):
093d3ff1 1744 """Proxy of C++ FileSystemHandler class"""
e811c8ce
RD
1745 def __repr__(self):
1746 return "<%s.%s; proxy of C++ wxPyFileSystemHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 1747 def __init__(self, *args, **kwargs):
a95a7133 1748 """__init__(self) -> FileSystemHandler"""
54f9ee45 1749 newobj = _core_.new_FileSystemHandler(*args, **kwargs)
d14a1e28
RD
1750 self.this = newobj.this
1751 self.thisown = 1
1752 del newobj.thisown
1753 self._setCallbackInfo(self, FileSystemHandler)
e811c8ce
RD
1754
1755 def _setCallbackInfo(*args, **kwargs):
a95a7133 1756 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
54f9ee45 1757 return _core_.FileSystemHandler__setCallbackInfo(*args, **kwargs)
e811c8ce
RD
1758
1759 def CanOpen(*args, **kwargs):
a95a7133 1760 """CanOpen(self, String location) -> bool"""
54f9ee45 1761 return _core_.FileSystemHandler_CanOpen(*args, **kwargs)
e811c8ce
RD
1762
1763 def OpenFile(*args, **kwargs):
a95a7133 1764 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
54f9ee45 1765 return _core_.FileSystemHandler_OpenFile(*args, **kwargs)
e811c8ce
RD
1766
1767 def FindFirst(*args, **kwargs):
a95a7133 1768 """FindFirst(self, String spec, int flags=0) -> String"""
54f9ee45 1769 return _core_.FileSystemHandler_FindFirst(*args, **kwargs)
e811c8ce
RD
1770
1771 def FindNext(*args, **kwargs):
a95a7133 1772 """FindNext(self) -> String"""
54f9ee45 1773 return _core_.FileSystemHandler_FindNext(*args, **kwargs)
e811c8ce
RD
1774
1775 def GetProtocol(*args, **kwargs):
a95a7133 1776 """GetProtocol(self, String location) -> String"""
54f9ee45 1777 return _core_.FileSystemHandler_GetProtocol(*args, **kwargs)
e811c8ce
RD
1778
1779 def GetLeftLocation(*args, **kwargs):
a95a7133 1780 """GetLeftLocation(self, String location) -> String"""
54f9ee45 1781 return _core_.FileSystemHandler_GetLeftLocation(*args, **kwargs)
e811c8ce
RD
1782
1783 def GetAnchor(*args, **kwargs):
a95a7133 1784 """GetAnchor(self, String location) -> String"""
54f9ee45 1785 return _core_.FileSystemHandler_GetAnchor(*args, **kwargs)
e811c8ce
RD
1786
1787 def GetRightLocation(*args, **kwargs):
a95a7133 1788 """GetRightLocation(self, String location) -> String"""
54f9ee45 1789 return _core_.FileSystemHandler_GetRightLocation(*args, **kwargs)
e811c8ce
RD
1790
1791 def GetMimeTypeFromExt(*args, **kwargs):
a95a7133 1792 """GetMimeTypeFromExt(self, String location) -> String"""
54f9ee45 1793 return _core_.FileSystemHandler_GetMimeTypeFromExt(*args, **kwargs)
e811c8ce 1794
d14a1e28
RD
1795
1796class FileSystemHandlerPtr(FileSystemHandler):
1797 def __init__(self, this):
1798 self.this = this
1799 if not hasattr(self,"thisown"): self.thisown = 0
1800 self.__class__ = FileSystemHandler
54f9ee45 1801_core_.FileSystemHandler_swigregister(FileSystemHandlerPtr)
d14a1e28
RD
1802
1803class FileSystem(Object):
093d3ff1 1804 """Proxy of C++ FileSystem class"""
e811c8ce
RD
1805 def __repr__(self):
1806 return "<%s.%s; proxy of C++ wxFileSystem instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 1807 def __init__(self, *args, **kwargs):
a95a7133 1808 """__init__(self) -> FileSystem"""
54f9ee45 1809 newobj = _core_.new_FileSystem(*args, **kwargs)
d14a1e28
RD
1810 self.this = newobj.this
1811 self.thisown = 1
1812 del newobj.thisown
54f9ee45 1813 def __del__(self, destroy=_core_.delete_FileSystem):
a95a7133 1814 """__del__(self)"""
d14a1e28
RD
1815 try:
1816 if self.thisown: destroy(self)
1817 except: pass
e811c8ce
RD
1818
1819 def ChangePathTo(*args, **kwargs):
a95a7133 1820 """ChangePathTo(self, String location, bool is_dir=False)"""
54f9ee45 1821 return _core_.FileSystem_ChangePathTo(*args, **kwargs)
e811c8ce
RD
1822
1823 def GetPath(*args, **kwargs):
a95a7133 1824 """GetPath(self) -> String"""
54f9ee45 1825 return _core_.FileSystem_GetPath(*args, **kwargs)
e811c8ce
RD
1826
1827 def OpenFile(*args, **kwargs):
a95a7133 1828 """OpenFile(self, String location) -> FSFile"""
54f9ee45 1829 return _core_.FileSystem_OpenFile(*args, **kwargs)
e811c8ce
RD
1830
1831 def FindFirst(*args, **kwargs):
a95a7133 1832 """FindFirst(self, String spec, int flags=0) -> String"""
54f9ee45 1833 return _core_.FileSystem_FindFirst(*args, **kwargs)
e811c8ce
RD
1834
1835 def FindNext(*args, **kwargs):
a95a7133 1836 """FindNext(self) -> String"""
54f9ee45 1837 return _core_.FileSystem_FindNext(*args, **kwargs)
e811c8ce
RD
1838
1839 def AddHandler(*args, **kwargs):
66c033b4 1840 """AddHandler(CPPFileSystemHandler handler)"""
54f9ee45 1841 return _core_.FileSystem_AddHandler(*args, **kwargs)
e811c8ce
RD
1842
1843 AddHandler = staticmethod(AddHandler)
1844 def CleanUpHandlers(*args, **kwargs):
66c033b4 1845 """CleanUpHandlers()"""
54f9ee45 1846 return _core_.FileSystem_CleanUpHandlers(*args, **kwargs)
e811c8ce
RD
1847
1848 CleanUpHandlers = staticmethod(CleanUpHandlers)
1849 def FileNameToURL(*args, **kwargs):
66c033b4 1850 """FileNameToURL(String filename) -> String"""
54f9ee45 1851 return _core_.FileSystem_FileNameToURL(*args, **kwargs)
e811c8ce
RD
1852
1853 FileNameToURL = staticmethod(FileNameToURL)
2ef75293
RD
1854 def URLToFileName(*args, **kwargs):
1855 """URLToFileName(String url) -> String"""
1856 return _core_.FileSystem_URLToFileName(*args, **kwargs)
1857
1858 URLToFileName = staticmethod(URLToFileName)
d14a1e28
RD
1859
1860class FileSystemPtr(FileSystem):
1861 def __init__(self, this):
1862 self.this = this
1863 if not hasattr(self,"thisown"): self.thisown = 0
1864 self.__class__ = FileSystem
54f9ee45 1865_core_.FileSystem_swigregister(FileSystemPtr)
d14a1e28 1866
e811c8ce
RD
1867def FileSystem_AddHandler(*args, **kwargs):
1868 """FileSystem_AddHandler(CPPFileSystemHandler handler)"""
54f9ee45 1869 return _core_.FileSystem_AddHandler(*args, **kwargs)
d14a1e28 1870
e811c8ce
RD
1871def FileSystem_CleanUpHandlers(*args, **kwargs):
1872 """FileSystem_CleanUpHandlers()"""
54f9ee45 1873 return _core_.FileSystem_CleanUpHandlers(*args, **kwargs)
d14a1e28 1874
e811c8ce 1875def FileSystem_FileNameToURL(*args, **kwargs):
196addbf 1876 """FileSystem_FileNameToURL(String filename) -> String"""
54f9ee45 1877 return _core_.FileSystem_FileNameToURL(*args, **kwargs)
d14a1e28 1878
e811c8ce 1879def FileSystem_URLToFileName(*args, **kwargs):
196addbf 1880 """FileSystem_URLToFileName(String url) -> String"""
54f9ee45 1881 return _core_.FileSystem_URLToFileName(*args, **kwargs)
2ef75293 1882
d14a1e28 1883class InternetFSHandler(CPPFileSystemHandler):
093d3ff1 1884 """Proxy of C++ InternetFSHandler class"""
e811c8ce
RD
1885 def __repr__(self):
1886 return "<%s.%s; proxy of C++ wxInternetFSHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 1887 def __init__(self, *args, **kwargs):
a95a7133 1888 """__init__(self) -> InternetFSHandler"""
54f9ee45 1889 newobj = _core_.new_InternetFSHandler(*args, **kwargs)
d14a1e28
RD
1890 self.this = newobj.this
1891 self.thisown = 1
1892 del newobj.thisown
e811c8ce 1893 def CanOpen(*args, **kwargs):
a95a7133 1894 """CanOpen(self, String location) -> bool"""
54f9ee45 1895 return _core_.InternetFSHandler_CanOpen(*args, **kwargs)
e811c8ce
RD
1896
1897 def OpenFile(*args, **kwargs):
a95a7133 1898 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
54f9ee45 1899 return _core_.InternetFSHandler_OpenFile(*args, **kwargs)
e811c8ce 1900
d14a1e28
RD
1901
1902class InternetFSHandlerPtr(InternetFSHandler):
1903 def __init__(self, this):
1904 self.this = this
1905 if not hasattr(self,"thisown"): self.thisown = 0
1906 self.__class__ = InternetFSHandler
54f9ee45 1907_core_.InternetFSHandler_swigregister(InternetFSHandlerPtr)
d14a1e28
RD
1908
1909class ZipFSHandler(CPPFileSystemHandler):
093d3ff1 1910 """Proxy of C++ ZipFSHandler class"""
e811c8ce
RD
1911 def __repr__(self):
1912 return "<%s.%s; proxy of C++ wxZipFSHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 1913 def __init__(self, *args, **kwargs):
a95a7133 1914 """__init__(self) -> ZipFSHandler"""
54f9ee45 1915 newobj = _core_.new_ZipFSHandler(*args, **kwargs)
d14a1e28
RD
1916 self.this = newobj.this
1917 self.thisown = 1
1918 del newobj.thisown
e811c8ce 1919 def CanOpen(*args, **kwargs):
a95a7133 1920 """CanOpen(self, String location) -> bool"""
54f9ee45 1921 return _core_.ZipFSHandler_CanOpen(*args, **kwargs)
e811c8ce
RD
1922
1923 def OpenFile(*args, **kwargs):
a95a7133 1924 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
54f9ee45 1925 return _core_.ZipFSHandler_OpenFile(*args, **kwargs)
e811c8ce
RD
1926
1927 def FindFirst(*args, **kwargs):
a95a7133 1928 """FindFirst(self, String spec, int flags=0) -> String"""
54f9ee45 1929 return _core_.ZipFSHandler_FindFirst(*args, **kwargs)
e811c8ce
RD
1930
1931 def FindNext(*args, **kwargs):
a95a7133 1932 """FindNext(self) -> String"""
54f9ee45 1933 return _core_.ZipFSHandler_FindNext(*args, **kwargs)
e811c8ce 1934
d14a1e28
RD
1935
1936class ZipFSHandlerPtr(ZipFSHandler):
1937 def __init__(self, this):
1938 self.this = this
1939 if not hasattr(self,"thisown"): self.thisown = 0
1940 self.__class__ = ZipFSHandler
54f9ee45 1941_core_.ZipFSHandler_swigregister(ZipFSHandlerPtr)
d14a1e28
RD
1942
1943
e811c8ce 1944def __wxMemoryFSHandler_AddFile_wxImage(*args, **kwargs):
196addbf 1945 """__wxMemoryFSHandler_AddFile_wxImage(String filename, Image image, long type)"""
54f9ee45 1946 return _core_.__wxMemoryFSHandler_AddFile_wxImage(*args, **kwargs)
d14a1e28 1947
e811c8ce 1948def __wxMemoryFSHandler_AddFile_wxBitmap(*args, **kwargs):
196addbf 1949 """__wxMemoryFSHandler_AddFile_wxBitmap(String filename, Bitmap bitmap, long type)"""
54f9ee45 1950 return _core_.__wxMemoryFSHandler_AddFile_wxBitmap(*args, **kwargs)
d14a1e28 1951
e811c8ce 1952def __wxMemoryFSHandler_AddFile_Data(*args, **kwargs):
196addbf 1953 """__wxMemoryFSHandler_AddFile_Data(String filename, PyObject data)"""
54f9ee45 1954 return _core_.__wxMemoryFSHandler_AddFile_Data(*args, **kwargs)
2ef75293
RD
1955def MemoryFSHandler_AddFile(filename, dataItem, imgType=-1):
1956 """
1957 Add 'file' to the memory filesystem. The dataItem parameter can
1958 either be a `wx.Bitmap`, `wx.Image` or a string that can contain
1959 arbitrary data. If a bitmap or image is used then the imgType
1960 parameter should specify what kind of image file it should be
1961 written as, wx.BITMAP_TYPE_PNG, etc.
1962 """
1963 if isinstance(dataItem, wx.Image):
1964 __wxMemoryFSHandler_AddFile_wxImage(filename, dataItem, imgType)
1965 elif isinstance(dataItem, wx.Bitmap):
1966 __wxMemoryFSHandler_AddFile_wxBitmap(filename, dataItem, imgType)
1967 elif type(dataItem) == str:
1968 __wxMemoryFSHandler_AddFile_Data(filename, dataItem)
1969 else:
1970 raise TypeError, 'wx.Image, wx.Bitmap or string expected'
d14a1e28
RD
1971
1972class MemoryFSHandler(CPPFileSystemHandler):
093d3ff1 1973 """Proxy of C++ MemoryFSHandler class"""
e811c8ce
RD
1974 def __repr__(self):
1975 return "<%s.%s; proxy of C++ wxMemoryFSHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 1976 def __init__(self, *args, **kwargs):
a95a7133 1977 """__init__(self) -> MemoryFSHandler"""
54f9ee45 1978 newobj = _core_.new_MemoryFSHandler(*args, **kwargs)
d14a1e28
RD
1979 self.this = newobj.this
1980 self.thisown = 1
1981 del newobj.thisown
e811c8ce 1982 def RemoveFile(*args, **kwargs):
66c033b4 1983 """RemoveFile(String filename)"""
54f9ee45 1984 return _core_.MemoryFSHandler_RemoveFile(*args, **kwargs)
e811c8ce
RD
1985
1986 RemoveFile = staticmethod(RemoveFile)
d14a1e28 1987 AddFile = staticmethod(MemoryFSHandler_AddFile)
e811c8ce 1988 def CanOpen(*args, **kwargs):
a95a7133 1989 """CanOpen(self, String location) -> bool"""
54f9ee45 1990 return _core_.MemoryFSHandler_CanOpen(*args, **kwargs)
e811c8ce
RD
1991
1992 def OpenFile(*args, **kwargs):
a95a7133 1993 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
54f9ee45 1994 return _core_.MemoryFSHandler_OpenFile(*args, **kwargs)
e811c8ce
RD
1995
1996 def FindFirst(*args, **kwargs):
a95a7133 1997 """FindFirst(self, String spec, int flags=0) -> String"""
54f9ee45 1998 return _core_.MemoryFSHandler_FindFirst(*args, **kwargs)
e811c8ce
RD
1999
2000 def FindNext(*args, **kwargs):
a95a7133 2001 """FindNext(self) -> String"""
54f9ee45 2002 return _core_.MemoryFSHandler_FindNext(*args, **kwargs)
e811c8ce 2003
d14a1e28
RD
2004
2005class MemoryFSHandlerPtr(MemoryFSHandler):
2006 def __init__(self, this):
2007 self.this = this
2008 if not hasattr(self,"thisown"): self.thisown = 0
2009 self.__class__ = MemoryFSHandler
54f9ee45 2010_core_.MemoryFSHandler_swigregister(MemoryFSHandlerPtr)
d14a1e28 2011
e811c8ce 2012def MemoryFSHandler_RemoveFile(*args, **kwargs):
196addbf 2013 """MemoryFSHandler_RemoveFile(String filename)"""
54f9ee45 2014 return _core_.MemoryFSHandler_RemoveFile(*args, **kwargs)
d14a1e28
RD
2015
2016#---------------------------------------------------------------------------
2017
2018class ImageHandler(Object):
093d3ff1 2019 """Proxy of C++ ImageHandler class"""
d14a1e28
RD
2020 def __init__(self): raise RuntimeError, "No constructor defined"
2021 def __repr__(self):
2022 return "<%s.%s; proxy of C++ wxImageHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
e811c8ce 2023 def GetName(*args, **kwargs):
a95a7133 2024 """GetName(self) -> String"""
54f9ee45 2025 return _core_.ImageHandler_GetName(*args, **kwargs)
e811c8ce
RD
2026
2027 def GetExtension(*args, **kwargs):
a95a7133 2028 """GetExtension(self) -> String"""
54f9ee45 2029 return _core_.ImageHandler_GetExtension(*args, **kwargs)
e811c8ce
RD
2030
2031 def GetType(*args, **kwargs):
a95a7133 2032 """GetType(self) -> long"""
54f9ee45 2033 return _core_.ImageHandler_GetType(*args, **kwargs)
e811c8ce
RD
2034
2035 def GetMimeType(*args, **kwargs):
a95a7133 2036 """GetMimeType(self) -> String"""
54f9ee45 2037 return _core_.ImageHandler_GetMimeType(*args, **kwargs)
e811c8ce
RD
2038
2039 def CanRead(*args, **kwargs):
a95a7133 2040 """CanRead(self, String name) -> bool"""
54f9ee45 2041 return _core_.ImageHandler_CanRead(*args, **kwargs)
e811c8ce
RD
2042
2043 def SetName(*args, **kwargs):
a95a7133 2044 """SetName(self, String name)"""
54f9ee45 2045 return _core_.ImageHandler_SetName(*args, **kwargs)
e811c8ce
RD
2046
2047 def SetExtension(*args, **kwargs):
a95a7133 2048 """SetExtension(self, String extension)"""
54f9ee45 2049 return _core_.ImageHandler_SetExtension(*args, **kwargs)
e811c8ce
RD
2050
2051 def SetType(*args, **kwargs):
a95a7133 2052 """SetType(self, long type)"""
54f9ee45 2053 return _core_.ImageHandler_SetType(*args, **kwargs)
e811c8ce
RD
2054
2055 def SetMimeType(*args, **kwargs):
a95a7133 2056 """SetMimeType(self, String mimetype)"""
54f9ee45 2057 return _core_.ImageHandler_SetMimeType(*args, **kwargs)
e811c8ce 2058
d14a1e28
RD
2059
2060class ImageHandlerPtr(ImageHandler):
2061 def __init__(self, this):
2062 self.this = this
2063 if not hasattr(self,"thisown"): self.thisown = 0
2064 self.__class__ = ImageHandler
54f9ee45 2065_core_.ImageHandler_swigregister(ImageHandlerPtr)
d14a1e28
RD
2066
2067class ImageHistogram(object):
093d3ff1 2068 """Proxy of C++ ImageHistogram class"""
e811c8ce
RD
2069 def __repr__(self):
2070 return "<%s.%s; proxy of C++ wxImageHistogram instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2071 def __init__(self, *args, **kwargs):
a95a7133 2072 """__init__(self) -> ImageHistogram"""
54f9ee45 2073 newobj = _core_.new_ImageHistogram(*args, **kwargs)
d14a1e28
RD
2074 self.this = newobj.this
2075 self.thisown = 1
2076 del newobj.thisown
e811c8ce 2077 def MakeKey(*args, **kwargs):
0df68c9f 2078 """
66c033b4 2079 MakeKey(unsigned char r, unsigned char g, unsigned char b) -> unsigned long
e811c8ce 2080
0df68c9f
RD
2081 Get the key in the histogram for the given RGB values
2082 """
54f9ee45 2083 return _core_.ImageHistogram_MakeKey(*args, **kwargs)
e811c8ce
RD
2084
2085 MakeKey = staticmethod(MakeKey)
2086 def FindFirstUnusedColour(*args, **kwargs):
fd2dc343
RD
2087 """
2088 FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)
2089
2090 Find first colour that is not used in the image and has higher RGB
2091 values than startR, startG, startB. Returns a tuple consisting of a
2092 success flag and rgb values.
2093 """
54f9ee45 2094 return _core_.ImageHistogram_FindFirstUnusedColour(*args, **kwargs)
e811c8ce 2095
d14a1e28
RD
2096
2097class ImageHistogramPtr(ImageHistogram):
2098 def __init__(self, this):
2099 self.this = this
2100 if not hasattr(self,"thisown"): self.thisown = 0
2101 self.__class__ = ImageHistogram
54f9ee45 2102_core_.ImageHistogram_swigregister(ImageHistogramPtr)
d14a1e28 2103
e811c8ce 2104def ImageHistogram_MakeKey(*args, **kwargs):
0df68c9f
RD
2105 """
2106 ImageHistogram_MakeKey(unsigned char r, unsigned char g, unsigned char b) -> unsigned long
e811c8ce 2107
0df68c9f
RD
2108 Get the key in the histogram for the given RGB values
2109 """
54f9ee45 2110 return _core_.ImageHistogram_MakeKey(*args, **kwargs)
d14a1e28
RD
2111
2112class Image(Object):
093d3ff1 2113 """Proxy of C++ Image class"""
e811c8ce
RD
2114 def __repr__(self):
2115 return "<%s.%s; proxy of C++ wxImage instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2116 def __init__(self, *args, **kwargs):
a95a7133 2117 """__init__(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> Image"""
54f9ee45 2118 newobj = _core_.new_Image(*args, **kwargs)
d14a1e28
RD
2119 self.this = newobj.this
2120 self.thisown = 1
2121 del newobj.thisown
54f9ee45 2122 def __del__(self, destroy=_core_.delete_Image):
a95a7133 2123 """__del__(self)"""
d14a1e28
RD
2124 try:
2125 if self.thisown: destroy(self)
2126 except: pass
e811c8ce
RD
2127
2128 def Create(*args, **kwargs):
a95a7133 2129 """Create(self, int width, int height)"""
54f9ee45 2130 return _core_.Image_Create(*args, **kwargs)
e811c8ce
RD
2131
2132 def Destroy(*args, **kwargs):
0df68c9f 2133 """
a95a7133 2134 Destroy(self)
e811c8ce 2135
0df68c9f
RD
2136 Deletes the C++ object this Python object is a proxy for.
2137 """
54f9ee45 2138 return _core_.Image_Destroy(*args, **kwargs)
e811c8ce
RD
2139
2140 def Scale(*args, **kwargs):
a95a7133 2141 """Scale(self, int width, int height) -> Image"""
54f9ee45 2142 return _core_.Image_Scale(*args, **kwargs)
e811c8ce
RD
2143
2144 def ShrinkBy(*args, **kwargs):
a95a7133 2145 """ShrinkBy(self, int xFactor, int yFactor) -> Image"""
54f9ee45 2146 return _core_.Image_ShrinkBy(*args, **kwargs)
e811c8ce
RD
2147
2148 def Rescale(*args, **kwargs):
a95a7133 2149 """Rescale(self, int width, int height) -> Image"""
54f9ee45 2150 return _core_.Image_Rescale(*args, **kwargs)
e811c8ce
RD
2151
2152 def SetRGB(*args, **kwargs):
a95a7133 2153 """SetRGB(self, int x, int y, unsigned char r, unsigned char g, unsigned char b)"""
54f9ee45 2154 return _core_.Image_SetRGB(*args, **kwargs)
e811c8ce
RD
2155
2156 def GetRed(*args, **kwargs):
a95a7133 2157 """GetRed(self, int x, int y) -> unsigned char"""
54f9ee45 2158 return _core_.Image_GetRed(*args, **kwargs)
e811c8ce
RD
2159
2160 def GetGreen(*args, **kwargs):
a95a7133 2161 """GetGreen(self, int x, int y) -> unsigned char"""
54f9ee45 2162 return _core_.Image_GetGreen(*args, **kwargs)
e811c8ce
RD
2163
2164 def GetBlue(*args, **kwargs):
a95a7133 2165 """GetBlue(self, int x, int y) -> unsigned char"""
54f9ee45 2166 return _core_.Image_GetBlue(*args, **kwargs)
e811c8ce
RD
2167
2168 def SetAlpha(*args, **kwargs):
a95a7133 2169 """SetAlpha(self, int x, int y, unsigned char alpha)"""
54f9ee45 2170 return _core_.Image_SetAlpha(*args, **kwargs)
e811c8ce
RD
2171
2172 def GetAlpha(*args, **kwargs):
a95a7133 2173 """GetAlpha(self, int x, int y) -> unsigned char"""
54f9ee45 2174 return _core_.Image_GetAlpha(*args, **kwargs)
e811c8ce
RD
2175
2176 def HasAlpha(*args, **kwargs):
a95a7133 2177 """HasAlpha(self) -> bool"""
54f9ee45 2178 return _core_.Image_HasAlpha(*args, **kwargs)
e811c8ce 2179
68350608
RD
2180 def InitAlpha(*args, **kwargs):
2181 """
2182 InitAlpha(self)
2183
2184 Initializes the image alpha channel data. It is an error to call it if
2185 the image already has alpha data. If it doesn't, alpha data will be by
2186 default initialized to all pixels being fully opaque. But if the image
2187 has a a mask colour, all mask pixels will be completely transparent.
2188 """
2189 return _core_.Image_InitAlpha(*args, **kwargs)
2190
e811c8ce 2191 def FindFirstUnusedColour(*args, **kwargs):
fd2dc343
RD
2192 """
2193 FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)
2194
2195 Find first colour that is not used in the image and has higher RGB
2196 values than startR, startG, startB. Returns a tuple consisting of a
2197 success flag and rgb values.
2198 """
54f9ee45 2199 return _core_.Image_FindFirstUnusedColour(*args, **kwargs)
e811c8ce 2200
4cf4100f
RD
2201 def ConvertAlphaToMask(*args, **kwargs):
2202 """
2203 ConvertAlphaToMask(self, byte threshold=128) -> bool
2204
2205 If the image has alpha channel, this method converts it to mask. All pixels
2206 with alpha value less than ``threshold`` are replaced with mask colour and the
2207 alpha channel is removed. Mask colour is chosen automatically using
2208 `FindFirstUnusedColour`.
2209
2210 If the image image doesn't have alpha channel, ConvertAlphaToMask does
2211 nothing.
2212 """
2213 return _core_.Image_ConvertAlphaToMask(*args, **kwargs)
2214
8fb0e70a
RD
2215 def ConvertColourToAlpha(*args, **kwargs):
2216 """
2217 ConvertColourToAlpha(self, unsigned char r, unsigned char g, unsigned char b) -> bool
2218
2219 This method converts an image where the original alpha information is
2220 only available as a shades of a colour (actually shades of grey)
2221 typically when you draw anti-aliased text into a bitmap. The DC
2222 drawing routines draw grey values on the black background although
2223 they actually mean to draw white with differnt alpha values. This
2224 method reverses it, assuming a black (!) background and white text.
2225 The method will then fill up the whole image with the colour given.
2226 """
2227 return _core_.Image_ConvertColourToAlpha(*args, **kwargs)
2228
e811c8ce 2229 def SetMaskFromImage(*args, **kwargs):
a95a7133 2230 """SetMaskFromImage(self, Image mask, byte mr, byte mg, byte mb) -> bool"""
54f9ee45 2231 return _core_.Image_SetMaskFromImage(*args, **kwargs)
e811c8ce
RD
2232
2233 def CanRead(*args, **kwargs):
66c033b4 2234 """CanRead(String name) -> bool"""
54f9ee45 2235 return _core_.Image_CanRead(*args, **kwargs)
e811c8ce
RD
2236
2237 CanRead = staticmethod(CanRead)
2238 def GetImageCount(*args, **kwargs):
66c033b4 2239 """GetImageCount(String name, long type=BITMAP_TYPE_ANY) -> int"""
54f9ee45 2240 return _core_.Image_GetImageCount(*args, **kwargs)
e811c8ce
RD
2241
2242 GetImageCount = staticmethod(GetImageCount)
2243 def LoadFile(*args, **kwargs):
a95a7133 2244 """LoadFile(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> bool"""
54f9ee45 2245 return _core_.Image_LoadFile(*args, **kwargs)
e811c8ce
RD
2246
2247 def LoadMimeFile(*args, **kwargs):
a95a7133 2248 """LoadMimeFile(self, String name, String mimetype, int index=-1) -> bool"""
54f9ee45 2249 return _core_.Image_LoadMimeFile(*args, **kwargs)
e811c8ce
RD
2250
2251 def SaveFile(*args, **kwargs):
a95a7133 2252 """SaveFile(self, String name, int type) -> bool"""
54f9ee45 2253 return _core_.Image_SaveFile(*args, **kwargs)
e811c8ce
RD
2254
2255 def SaveMimeFile(*args, **kwargs):
a95a7133 2256 """SaveMimeFile(self, String name, String mimetype) -> bool"""
54f9ee45 2257 return _core_.Image_SaveMimeFile(*args, **kwargs)
e811c8ce
RD
2258
2259 def CanReadStream(*args, **kwargs):
66c033b4 2260 """CanReadStream(InputStream stream) -> bool"""
54f9ee45 2261 return _core_.Image_CanReadStream(*args, **kwargs)
e811c8ce
RD
2262
2263 CanReadStream = staticmethod(CanReadStream)
2264 def LoadStream(*args, **kwargs):
a95a7133 2265 """LoadStream(self, InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> bool"""
54f9ee45 2266 return _core_.Image_LoadStream(*args, **kwargs)
e811c8ce
RD
2267
2268 def LoadMimeStream(*args, **kwargs):
a95a7133 2269 """LoadMimeStream(self, InputStream stream, String mimetype, int index=-1) -> bool"""
54f9ee45 2270 return _core_.Image_LoadMimeStream(*args, **kwargs)
e811c8ce
RD
2271
2272 def Ok(*args, **kwargs):
a95a7133 2273 """Ok(self) -> bool"""
54f9ee45 2274 return _core_.Image_Ok(*args, **kwargs)
e811c8ce
RD
2275
2276 def GetWidth(*args, **kwargs):
a95a7133 2277 """GetWidth(self) -> int"""
54f9ee45 2278 return _core_.Image_GetWidth(*args, **kwargs)
e811c8ce
RD
2279
2280 def GetHeight(*args, **kwargs):
a95a7133 2281 """GetHeight(self) -> int"""
54f9ee45 2282 return _core_.Image_GetHeight(*args, **kwargs)
e811c8ce 2283
b2df227b 2284 def GetSize(*args, **kwargs):
a95a7133 2285 """GetSize(self) -> Size"""
54f9ee45 2286 return _core_.Image_GetSize(*args, **kwargs)
b2df227b 2287
e811c8ce 2288 def GetSubImage(*args, **kwargs):
a95a7133 2289 """GetSubImage(self, Rect rect) -> Image"""
54f9ee45 2290 return _core_.Image_GetSubImage(*args, **kwargs)
e811c8ce
RD
2291
2292 def Copy(*args, **kwargs):
a95a7133 2293 """Copy(self) -> Image"""
54f9ee45 2294 return _core_.Image_Copy(*args, **kwargs)
e811c8ce
RD
2295
2296 def Paste(*args, **kwargs):
a95a7133 2297 """Paste(self, Image image, int x, int y)"""
54f9ee45 2298 return _core_.Image_Paste(*args, **kwargs)
e811c8ce
RD
2299
2300 def GetData(*args, **kwargs):
a95a7133 2301 """GetData(self) -> PyObject"""
54f9ee45 2302 return _core_.Image_GetData(*args, **kwargs)
e811c8ce
RD
2303
2304 def SetData(*args, **kwargs):
a95a7133 2305 """SetData(self, PyObject data)"""
54f9ee45 2306 return _core_.Image_SetData(*args, **kwargs)
e811c8ce
RD
2307
2308 def GetDataBuffer(*args, **kwargs):
a95a7133 2309 """GetDataBuffer(self) -> PyObject"""
54f9ee45 2310 return _core_.Image_GetDataBuffer(*args, **kwargs)
e811c8ce
RD
2311
2312 def SetDataBuffer(*args, **kwargs):
a95a7133 2313 """SetDataBuffer(self, PyObject data)"""
54f9ee45 2314 return _core_.Image_SetDataBuffer(*args, **kwargs)
e811c8ce
RD
2315
2316 def GetAlphaData(*args, **kwargs):
a95a7133 2317 """GetAlphaData(self) -> PyObject"""
54f9ee45 2318 return _core_.Image_GetAlphaData(*args, **kwargs)
e811c8ce
RD
2319
2320 def SetAlphaData(*args, **kwargs):
a95a7133 2321 """SetAlphaData(self, PyObject data)"""
54f9ee45 2322 return _core_.Image_SetAlphaData(*args, **kwargs)
e811c8ce
RD
2323
2324 def GetAlphaBuffer(*args, **kwargs):
a95a7133 2325 """GetAlphaBuffer(self) -> PyObject"""
54f9ee45 2326 return _core_.Image_GetAlphaBuffer(*args, **kwargs)
e811c8ce
RD
2327
2328 def SetAlphaBuffer(*args, **kwargs):
a95a7133 2329 """SetAlphaBuffer(self, PyObject data)"""
54f9ee45 2330 return _core_.Image_SetAlphaBuffer(*args, **kwargs)
e811c8ce
RD
2331
2332 def SetMaskColour(*args, **kwargs):
a95a7133 2333 """SetMaskColour(self, unsigned char r, unsigned char g, unsigned char b)"""
54f9ee45 2334 return _core_.Image_SetMaskColour(*args, **kwargs)
e811c8ce
RD
2335
2336 def GetMaskRed(*args, **kwargs):
a95a7133 2337 """GetMaskRed(self) -> unsigned char"""
54f9ee45 2338 return _core_.Image_GetMaskRed(*args, **kwargs)
e811c8ce
RD
2339
2340 def GetMaskGreen(*args, **kwargs):
a95a7133 2341 """GetMaskGreen(self) -> unsigned char"""
54f9ee45 2342 return _core_.Image_GetMaskGreen(*args, **kwargs)
e811c8ce
RD
2343
2344 def GetMaskBlue(*args, **kwargs):
a95a7133 2345 """GetMaskBlue(self) -> unsigned char"""
54f9ee45 2346 return _core_.Image_GetMaskBlue(*args, **kwargs)
e811c8ce
RD
2347
2348 def SetMask(*args, **kwargs):
a95a7133 2349 """SetMask(self, bool mask=True)"""
54f9ee45 2350 return _core_.Image_SetMask(*args, **kwargs)
e811c8ce
RD
2351
2352 def HasMask(*args, **kwargs):
a95a7133 2353 """HasMask(self) -> bool"""
54f9ee45 2354 return _core_.Image_HasMask(*args, **kwargs)
e811c8ce
RD
2355
2356 def Rotate(*args, **kwargs):
0df68c9f 2357 """
a95a7133 2358 Rotate(self, double angle, Point centre_of_rotation, bool interpolating=True,
0df68c9f
RD
2359 Point offset_after_rotation=None) -> Image
2360 """
54f9ee45 2361 return _core_.Image_Rotate(*args, **kwargs)
e811c8ce
RD
2362
2363 def Rotate90(*args, **kwargs):
a95a7133 2364 """Rotate90(self, bool clockwise=True) -> Image"""
54f9ee45 2365 return _core_.Image_Rotate90(*args, **kwargs)
e811c8ce
RD
2366
2367 def Mirror(*args, **kwargs):
a95a7133 2368 """Mirror(self, bool horizontally=True) -> Image"""
54f9ee45 2369 return _core_.Image_Mirror(*args, **kwargs)
e811c8ce
RD
2370
2371 def Replace(*args, **kwargs):
0df68c9f 2372 """
a95a7133 2373 Replace(self, unsigned char r1, unsigned char g1, unsigned char b1,
0df68c9f
RD
2374 unsigned char r2, unsigned char g2, unsigned char b2)
2375 """
54f9ee45 2376 return _core_.Image_Replace(*args, **kwargs)
e811c8ce
RD
2377
2378 def ConvertToMono(*args, **kwargs):
a95a7133 2379 """ConvertToMono(self, unsigned char r, unsigned char g, unsigned char b) -> Image"""
54f9ee45 2380 return _core_.Image_ConvertToMono(*args, **kwargs)
e811c8ce
RD
2381
2382 def SetOption(*args, **kwargs):
a95a7133 2383 """SetOption(self, String name, String value)"""
54f9ee45 2384 return _core_.Image_SetOption(*args, **kwargs)
e811c8ce
RD
2385
2386 def SetOptionInt(*args, **kwargs):
a95a7133 2387 """SetOptionInt(self, String name, int value)"""
54f9ee45 2388 return _core_.Image_SetOptionInt(*args, **kwargs)
e811c8ce
RD
2389
2390 def GetOption(*args, **kwargs):
a95a7133 2391 """GetOption(self, String name) -> String"""
54f9ee45 2392 return _core_.Image_GetOption(*args, **kwargs)
e811c8ce
RD
2393
2394 def GetOptionInt(*args, **kwargs):
a95a7133 2395 """GetOptionInt(self, String name) -> int"""
54f9ee45 2396 return _core_.Image_GetOptionInt(*args, **kwargs)
e811c8ce
RD
2397
2398 def HasOption(*args, **kwargs):
a95a7133 2399 """HasOption(self, String name) -> bool"""
54f9ee45 2400 return _core_.Image_HasOption(*args, **kwargs)
e811c8ce
RD
2401
2402 def CountColours(*args, **kwargs):
a95a7133 2403 """CountColours(self, unsigned long stopafter=(unsigned long) -1) -> unsigned long"""
54f9ee45 2404 return _core_.Image_CountColours(*args, **kwargs)
e811c8ce
RD
2405
2406 def ComputeHistogram(*args, **kwargs):
a95a7133 2407 """ComputeHistogram(self, ImageHistogram h) -> unsigned long"""
54f9ee45 2408 return _core_.Image_ComputeHistogram(*args, **kwargs)
e811c8ce
RD
2409
2410 def AddHandler(*args, **kwargs):
66c033b4 2411 """AddHandler(ImageHandler handler)"""
54f9ee45 2412 return _core_.Image_AddHandler(*args, **kwargs)
e811c8ce
RD
2413
2414 AddHandler = staticmethod(AddHandler)
2415 def InsertHandler(*args, **kwargs):
66c033b4 2416 """InsertHandler(ImageHandler handler)"""
54f9ee45 2417 return _core_.Image_InsertHandler(*args, **kwargs)
e811c8ce
RD
2418
2419 InsertHandler = staticmethod(InsertHandler)
2420 def RemoveHandler(*args, **kwargs):
66c033b4 2421 """RemoveHandler(String name) -> bool"""
54f9ee45 2422 return _core_.Image_RemoveHandler(*args, **kwargs)
e811c8ce
RD
2423
2424 RemoveHandler = staticmethod(RemoveHandler)
2425 def GetImageExtWildcard(*args, **kwargs):
66c033b4 2426 """GetImageExtWildcard() -> String"""
54f9ee45 2427 return _core_.Image_GetImageExtWildcard(*args, **kwargs)
e811c8ce
RD
2428
2429 GetImageExtWildcard = staticmethod(GetImageExtWildcard)
2430 def ConvertToBitmap(*args, **kwargs):
1fbf26be 2431 """ConvertToBitmap(self, int depth=-1) -> Bitmap"""
54f9ee45 2432 return _core_.Image_ConvertToBitmap(*args, **kwargs)
e811c8ce
RD
2433
2434 def ConvertToMonoBitmap(*args, **kwargs):
a95a7133 2435 """ConvertToMonoBitmap(self, unsigned char red, unsigned char green, unsigned char blue) -> Bitmap"""
54f9ee45 2436 return _core_.Image_ConvertToMonoBitmap(*args, **kwargs)
e811c8ce
RD
2437
2438 def __nonzero__(self): return self.Ok()
d14a1e28
RD
2439
2440class ImagePtr(Image):
2441 def __init__(self, this):
2442 self.this = this
2443 if not hasattr(self,"thisown"): self.thisown = 0
2444 self.__class__ = Image
54f9ee45 2445_core_.Image_swigregister(ImagePtr)
d14a1e28
RD
2446
2447def ImageFromMime(*args, **kwargs):
196addbf 2448 """ImageFromMime(String name, String mimetype, int index=-1) -> Image"""
54f9ee45 2449 val = _core_.new_ImageFromMime(*args, **kwargs)
d14a1e28
RD
2450 val.thisown = 1
2451 return val
2452
2453def ImageFromStream(*args, **kwargs):
196addbf 2454 """ImageFromStream(InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> Image"""
54f9ee45 2455 val = _core_.new_ImageFromStream(*args, **kwargs)
d14a1e28
RD
2456 val.thisown = 1
2457 return val
2458
2459def ImageFromStreamMime(*args, **kwargs):
196addbf 2460 """ImageFromStreamMime(InputStream stream, String mimetype, int index=-1) -> Image"""
54f9ee45 2461 val = _core_.new_ImageFromStreamMime(*args, **kwargs)
d14a1e28
RD
2462 val.thisown = 1
2463 return val
2464
66c033b4
RD
2465def EmptyImage(*args, **kwargs):
2466 """EmptyImage(int width=0, int height=0, bool clear=True) -> Image"""
2467 val = _core_.new_EmptyImage(*args, **kwargs)
d14a1e28
RD
2468 val.thisown = 1
2469 return val
2470
2471def ImageFromBitmap(*args, **kwargs):
196addbf 2472 """ImageFromBitmap(Bitmap bitmap) -> Image"""
54f9ee45 2473 val = _core_.new_ImageFromBitmap(*args, **kwargs)
d14a1e28
RD
2474 val.thisown = 1
2475 return val
2476
2477def ImageFromData(*args, **kwargs):
e811c8ce 2478 """ImageFromData(int width, int height, unsigned char data) -> Image"""
54f9ee45 2479 val = _core_.new_ImageFromData(*args, **kwargs)
d14a1e28
RD
2480 val.thisown = 1
2481 return val
2482
1823fbb4
RD
2483def ImageFromDataWithAlpha(*args, **kwargs):
2484 """ImageFromDataWithAlpha(int width, int height, unsigned char data, unsigned char alpha) -> Image"""
2485 val = _core_.new_ImageFromDataWithAlpha(*args, **kwargs)
2486 val.thisown = 1
2487 return val
2488
e811c8ce 2489def Image_CanRead(*args, **kwargs):
196addbf 2490 """Image_CanRead(String name) -> bool"""
54f9ee45 2491 return _core_.Image_CanRead(*args, **kwargs)
d14a1e28 2492
e811c8ce 2493def Image_GetImageCount(*args, **kwargs):
196addbf 2494 """Image_GetImageCount(String name, long type=BITMAP_TYPE_ANY) -> int"""
54f9ee45 2495 return _core_.Image_GetImageCount(*args, **kwargs)
d14a1e28 2496
e811c8ce 2497def Image_CanReadStream(*args, **kwargs):
196addbf 2498 """Image_CanReadStream(InputStream stream) -> bool"""
54f9ee45 2499 return _core_.Image_CanReadStream(*args, **kwargs)
d14a1e28 2500
e811c8ce
RD
2501def Image_AddHandler(*args, **kwargs):
2502 """Image_AddHandler(ImageHandler handler)"""
54f9ee45 2503 return _core_.Image_AddHandler(*args, **kwargs)
d14a1e28 2504
e811c8ce
RD
2505def Image_InsertHandler(*args, **kwargs):
2506 """Image_InsertHandler(ImageHandler handler)"""
54f9ee45 2507 return _core_.Image_InsertHandler(*args, **kwargs)
d14a1e28 2508
e811c8ce 2509def Image_RemoveHandler(*args, **kwargs):
196addbf 2510 """Image_RemoveHandler(String name) -> bool"""
54f9ee45 2511 return _core_.Image_RemoveHandler(*args, **kwargs)
d14a1e28 2512
e811c8ce 2513def Image_GetImageExtWildcard(*args, **kwargs):
196addbf 2514 """Image_GetImageExtWildcard() -> String"""
54f9ee45 2515 return _core_.Image_GetImageExtWildcard(*args, **kwargs)
d14a1e28 2516
5e4ca4a8
RD
2517def InitAllImageHandlers():
2518 """
2519 The former functionality of InitAllImageHanders is now done internal to
2520 the _core_ extension module and so this function has become a simple NOP.
2521 """
2522 pass
d14a1e28 2523
54f9ee45
RD
2524IMAGE_RESOLUTION_INCHES = _core_.IMAGE_RESOLUTION_INCHES
2525IMAGE_RESOLUTION_CM = _core_.IMAGE_RESOLUTION_CM
2526BMP_24BPP = _core_.BMP_24BPP
2527BMP_8BPP = _core_.BMP_8BPP
2528BMP_8BPP_GREY = _core_.BMP_8BPP_GREY
2529BMP_8BPP_GRAY = _core_.BMP_8BPP_GRAY
2530BMP_8BPP_RED = _core_.BMP_8BPP_RED
2531BMP_8BPP_PALETTE = _core_.BMP_8BPP_PALETTE
2532BMP_4BPP = _core_.BMP_4BPP
2533BMP_1BPP = _core_.BMP_1BPP
2534BMP_1BPP_BW = _core_.BMP_1BPP_BW
d14a1e28 2535class BMPHandler(ImageHandler):
093d3ff1 2536 """Proxy of C++ BMPHandler class"""
e811c8ce
RD
2537 def __repr__(self):
2538 return "<%s.%s; proxy of C++ wxBMPHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2539 def __init__(self, *args, **kwargs):
a95a7133 2540 """__init__(self) -> BMPHandler"""
54f9ee45 2541 newobj = _core_.new_BMPHandler(*args, **kwargs)
d14a1e28
RD
2542 self.this = newobj.this
2543 self.thisown = 1
2544 del newobj.thisown
d14a1e28
RD
2545
2546class BMPHandlerPtr(BMPHandler):
2547 def __init__(self, this):
2548 self.this = this
2549 if not hasattr(self,"thisown"): self.thisown = 0
2550 self.__class__ = BMPHandler
54f9ee45 2551_core_.BMPHandler_swigregister(BMPHandlerPtr)
d14a1e28 2552NullImage = cvar.NullImage
0c243d93 2553IMAGE_OPTION_FILENAME = cvar.IMAGE_OPTION_FILENAME
d14a1e28
RD
2554IMAGE_OPTION_BMP_FORMAT = cvar.IMAGE_OPTION_BMP_FORMAT
2555IMAGE_OPTION_CUR_HOTSPOT_X = cvar.IMAGE_OPTION_CUR_HOTSPOT_X
2556IMAGE_OPTION_CUR_HOTSPOT_Y = cvar.IMAGE_OPTION_CUR_HOTSPOT_Y
2557IMAGE_OPTION_RESOLUTION = cvar.IMAGE_OPTION_RESOLUTION
0c243d93
RD
2558IMAGE_OPTION_RESOLUTIONX = cvar.IMAGE_OPTION_RESOLUTIONX
2559IMAGE_OPTION_RESOLUTIONY = cvar.IMAGE_OPTION_RESOLUTIONY
d14a1e28 2560IMAGE_OPTION_RESOLUTIONUNIT = cvar.IMAGE_OPTION_RESOLUTIONUNIT
24d7cbea 2561IMAGE_OPTION_QUALITY = cvar.IMAGE_OPTION_QUALITY
0c243d93
RD
2562IMAGE_OPTION_BITSPERSAMPLE = cvar.IMAGE_OPTION_BITSPERSAMPLE
2563IMAGE_OPTION_SAMPLESPERPIXEL = cvar.IMAGE_OPTION_SAMPLESPERPIXEL
2564IMAGE_OPTION_COMPRESSION = cvar.IMAGE_OPTION_COMPRESSION
2565IMAGE_OPTION_IMAGEDESCRIPTOR = cvar.IMAGE_OPTION_IMAGEDESCRIPTOR
d14a1e28
RD
2566
2567class ICOHandler(BMPHandler):
093d3ff1 2568 """Proxy of C++ ICOHandler class"""
e811c8ce
RD
2569 def __repr__(self):
2570 return "<%s.%s; proxy of C++ wxICOHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2571 def __init__(self, *args, **kwargs):
a95a7133 2572 """__init__(self) -> ICOHandler"""
54f9ee45 2573 newobj = _core_.new_ICOHandler(*args, **kwargs)
d14a1e28
RD
2574 self.this = newobj.this
2575 self.thisown = 1
2576 del newobj.thisown
d14a1e28
RD
2577
2578class ICOHandlerPtr(ICOHandler):
2579 def __init__(self, this):
2580 self.this = this
2581 if not hasattr(self,"thisown"): self.thisown = 0
2582 self.__class__ = ICOHandler
54f9ee45 2583_core_.ICOHandler_swigregister(ICOHandlerPtr)
d14a1e28
RD
2584
2585class CURHandler(ICOHandler):
093d3ff1 2586 """Proxy of C++ CURHandler class"""
e811c8ce
RD
2587 def __repr__(self):
2588 return "<%s.%s; proxy of C++ wxCURHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2589 def __init__(self, *args, **kwargs):
a95a7133 2590 """__init__(self) -> CURHandler"""
54f9ee45 2591 newobj = _core_.new_CURHandler(*args, **kwargs)
d14a1e28
RD
2592 self.this = newobj.this
2593 self.thisown = 1
2594 del newobj.thisown
d14a1e28
RD
2595
2596class CURHandlerPtr(CURHandler):
2597 def __init__(self, this):
2598 self.this = this
2599 if not hasattr(self,"thisown"): self.thisown = 0
2600 self.__class__ = CURHandler
54f9ee45 2601_core_.CURHandler_swigregister(CURHandlerPtr)
d14a1e28
RD
2602
2603class ANIHandler(CURHandler):
093d3ff1 2604 """Proxy of C++ ANIHandler class"""
e811c8ce
RD
2605 def __repr__(self):
2606 return "<%s.%s; proxy of C++ wxANIHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2607 def __init__(self, *args, **kwargs):
a95a7133 2608 """__init__(self) -> ANIHandler"""
54f9ee45 2609 newobj = _core_.new_ANIHandler(*args, **kwargs)
d14a1e28
RD
2610 self.this = newobj.this
2611 self.thisown = 1
2612 del newobj.thisown
d14a1e28
RD
2613
2614class ANIHandlerPtr(ANIHandler):
2615 def __init__(self, this):
2616 self.this = this
2617 if not hasattr(self,"thisown"): self.thisown = 0
2618 self.__class__ = ANIHandler
54f9ee45 2619_core_.ANIHandler_swigregister(ANIHandlerPtr)
d14a1e28
RD
2620
2621class PNGHandler(ImageHandler):
093d3ff1 2622 """Proxy of C++ PNGHandler class"""
e811c8ce
RD
2623 def __repr__(self):
2624 return "<%s.%s; proxy of C++ wxPNGHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2625 def __init__(self, *args, **kwargs):
a95a7133 2626 """__init__(self) -> PNGHandler"""
54f9ee45 2627 newobj = _core_.new_PNGHandler(*args, **kwargs)
d14a1e28
RD
2628 self.this = newobj.this
2629 self.thisown = 1
2630 del newobj.thisown
d14a1e28
RD
2631
2632class PNGHandlerPtr(PNGHandler):
2633 def __init__(self, this):
2634 self.this = this
2635 if not hasattr(self,"thisown"): self.thisown = 0
2636 self.__class__ = PNGHandler
54f9ee45 2637_core_.PNGHandler_swigregister(PNGHandlerPtr)
d14a1e28
RD
2638
2639class GIFHandler(ImageHandler):
093d3ff1 2640 """Proxy of C++ GIFHandler class"""
e811c8ce
RD
2641 def __repr__(self):
2642 return "<%s.%s; proxy of C++ wxGIFHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2643 def __init__(self, *args, **kwargs):
a95a7133 2644 """__init__(self) -> GIFHandler"""
54f9ee45 2645 newobj = _core_.new_GIFHandler(*args, **kwargs)
d14a1e28
RD
2646 self.this = newobj.this
2647 self.thisown = 1
2648 del newobj.thisown
d14a1e28
RD
2649
2650class GIFHandlerPtr(GIFHandler):
2651 def __init__(self, this):
2652 self.this = this
2653 if not hasattr(self,"thisown"): self.thisown = 0
2654 self.__class__ = GIFHandler
54f9ee45 2655_core_.GIFHandler_swigregister(GIFHandlerPtr)
d14a1e28
RD
2656
2657class PCXHandler(ImageHandler):
093d3ff1 2658 """Proxy of C++ PCXHandler class"""
e811c8ce
RD
2659 def __repr__(self):
2660 return "<%s.%s; proxy of C++ wxPCXHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2661 def __init__(self, *args, **kwargs):
a95a7133 2662 """__init__(self) -> PCXHandler"""
54f9ee45 2663 newobj = _core_.new_PCXHandler(*args, **kwargs)
d14a1e28
RD
2664 self.this = newobj.this
2665 self.thisown = 1
2666 del newobj.thisown
d14a1e28
RD
2667
2668class PCXHandlerPtr(PCXHandler):
2669 def __init__(self, this):
2670 self.this = this
2671 if not hasattr(self,"thisown"): self.thisown = 0
2672 self.__class__ = PCXHandler
54f9ee45 2673_core_.PCXHandler_swigregister(PCXHandlerPtr)
d14a1e28
RD
2674
2675class JPEGHandler(ImageHandler):
093d3ff1 2676 """Proxy of C++ JPEGHandler class"""
e811c8ce
RD
2677 def __repr__(self):
2678 return "<%s.%s; proxy of C++ wxJPEGHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2679 def __init__(self, *args, **kwargs):
a95a7133 2680 """__init__(self) -> JPEGHandler"""
54f9ee45 2681 newobj = _core_.new_JPEGHandler(*args, **kwargs)
d14a1e28
RD
2682 self.this = newobj.this
2683 self.thisown = 1
2684 del newobj.thisown
d14a1e28
RD
2685
2686class JPEGHandlerPtr(JPEGHandler):
2687 def __init__(self, this):
2688 self.this = this
2689 if not hasattr(self,"thisown"): self.thisown = 0
2690 self.__class__ = JPEGHandler
54f9ee45 2691_core_.JPEGHandler_swigregister(JPEGHandlerPtr)
d14a1e28
RD
2692
2693class PNMHandler(ImageHandler):
093d3ff1 2694 """Proxy of C++ PNMHandler class"""
e811c8ce
RD
2695 def __repr__(self):
2696 return "<%s.%s; proxy of C++ wxPNMHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2697 def __init__(self, *args, **kwargs):
a95a7133 2698 """__init__(self) -> PNMHandler"""
54f9ee45 2699 newobj = _core_.new_PNMHandler(*args, **kwargs)
d14a1e28
RD
2700 self.this = newobj.this
2701 self.thisown = 1
2702 del newobj.thisown
d14a1e28
RD
2703
2704class PNMHandlerPtr(PNMHandler):
2705 def __init__(self, this):
2706 self.this = this
2707 if not hasattr(self,"thisown"): self.thisown = 0
2708 self.__class__ = PNMHandler
54f9ee45 2709_core_.PNMHandler_swigregister(PNMHandlerPtr)
d14a1e28
RD
2710
2711class XPMHandler(ImageHandler):
093d3ff1 2712 """Proxy of C++ XPMHandler class"""
e811c8ce
RD
2713 def __repr__(self):
2714 return "<%s.%s; proxy of C++ wxXPMHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2715 def __init__(self, *args, **kwargs):
a95a7133 2716 """__init__(self) -> XPMHandler"""
54f9ee45 2717 newobj = _core_.new_XPMHandler(*args, **kwargs)
d14a1e28
RD
2718 self.this = newobj.this
2719 self.thisown = 1
2720 del newobj.thisown
d14a1e28
RD
2721
2722class XPMHandlerPtr(XPMHandler):
2723 def __init__(self, this):
2724 self.this = this
2725 if not hasattr(self,"thisown"): self.thisown = 0
2726 self.__class__ = XPMHandler
54f9ee45 2727_core_.XPMHandler_swigregister(XPMHandlerPtr)
d14a1e28
RD
2728
2729class TIFFHandler(ImageHandler):
093d3ff1 2730 """Proxy of C++ TIFFHandler class"""
e811c8ce
RD
2731 def __repr__(self):
2732 return "<%s.%s; proxy of C++ wxTIFFHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2733 def __init__(self, *args, **kwargs):
a95a7133 2734 """__init__(self) -> TIFFHandler"""
54f9ee45 2735 newobj = _core_.new_TIFFHandler(*args, **kwargs)
d14a1e28
RD
2736 self.this = newobj.this
2737 self.thisown = 1
2738 del newobj.thisown
d14a1e28
RD
2739
2740class TIFFHandlerPtr(TIFFHandler):
2741 def __init__(self, this):
2742 self.this = this
2743 if not hasattr(self,"thisown"): self.thisown = 0
2744 self.__class__ = TIFFHandler
54f9ee45 2745_core_.TIFFHandler_swigregister(TIFFHandlerPtr)
d14a1e28 2746
c0de73ae
RD
2747QUANTIZE_INCLUDE_WINDOWS_COLOURS = _core_.QUANTIZE_INCLUDE_WINDOWS_COLOURS
2748QUANTIZE_FILL_DESTINATION_IMAGE = _core_.QUANTIZE_FILL_DESTINATION_IMAGE
2749class Quantize(object):
2750 """Performs quantization, or colour reduction, on a wxImage."""
2751 def __init__(self): raise RuntimeError, "No constructor defined"
2752 def __repr__(self):
2753 return "<%s.%s; proxy of C++ wxQuantize instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2754 def Quantize(*args, **kwargs):
2755 """
2756 Quantize(Image src, Image dest, int desiredNoColours=236, int flags=wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE) -> bool
2757
2758 Reduce the colours in the source image and put the result into the
2759 destination image, setting the palette in the destination if
2760 needed. Both images may be the same, to overwrite the source image.
2761 """
2762 return _core_.Quantize_Quantize(*args, **kwargs)
2763
2764 Quantize = staticmethod(Quantize)
2765
2766class QuantizePtr(Quantize):
2767 def __init__(self, this):
2768 self.this = this
2769 if not hasattr(self,"thisown"): self.thisown = 0
2770 self.__class__ = Quantize
2771_core_.Quantize_swigregister(QuantizePtr)
2772
2773def Quantize_Quantize(*args, **kwargs):
2774 """
2775 Quantize_Quantize(Image src, Image dest, int desiredNoColours=236, int flags=wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE) -> bool
2776
2777 Reduce the colours in the source image and put the result into the
2778 destination image, setting the palette in the destination if
2779 needed. Both images may be the same, to overwrite the source image.
2780 """
2781 return _core_.Quantize_Quantize(*args, **kwargs)
2782
d14a1e28
RD
2783#---------------------------------------------------------------------------
2784
2785class EvtHandler(Object):
093d3ff1 2786 """Proxy of C++ EvtHandler class"""
e811c8ce
RD
2787 def __repr__(self):
2788 return "<%s.%s; proxy of C++ wxEvtHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2789 def __init__(self, *args, **kwargs):
a95a7133 2790 """__init__(self) -> EvtHandler"""
54f9ee45 2791 newobj = _core_.new_EvtHandler(*args, **kwargs)
d14a1e28
RD
2792 self.this = newobj.this
2793 self.thisown = 1
2794 del newobj.thisown
e811c8ce 2795 def GetNextHandler(*args, **kwargs):
a95a7133 2796 """GetNextHandler(self) -> EvtHandler"""
54f9ee45 2797 return _core_.EvtHandler_GetNextHandler(*args, **kwargs)
e811c8ce
RD
2798
2799 def GetPreviousHandler(*args, **kwargs):
a95a7133 2800 """GetPreviousHandler(self) -> EvtHandler"""
54f9ee45 2801 return _core_.EvtHandler_GetPreviousHandler(*args, **kwargs)
e811c8ce
RD
2802
2803 def SetNextHandler(*args, **kwargs):
a95a7133 2804 """SetNextHandler(self, EvtHandler handler)"""
54f9ee45 2805 return _core_.EvtHandler_SetNextHandler(*args, **kwargs)
e811c8ce
RD
2806
2807 def SetPreviousHandler(*args, **kwargs):
a95a7133 2808 """SetPreviousHandler(self, EvtHandler handler)"""
54f9ee45 2809 return _core_.EvtHandler_SetPreviousHandler(*args, **kwargs)
e811c8ce
RD
2810
2811 def GetEvtHandlerEnabled(*args, **kwargs):
a95a7133 2812 """GetEvtHandlerEnabled(self) -> bool"""
54f9ee45 2813 return _core_.EvtHandler_GetEvtHandlerEnabled(*args, **kwargs)
e811c8ce
RD
2814
2815 def SetEvtHandlerEnabled(*args, **kwargs):
a95a7133 2816 """SetEvtHandlerEnabled(self, bool enabled)"""
54f9ee45 2817 return _core_.EvtHandler_SetEvtHandlerEnabled(*args, **kwargs)
e811c8ce
RD
2818
2819 def ProcessEvent(*args, **kwargs):
a95a7133 2820 """ProcessEvent(self, Event event) -> bool"""
54f9ee45 2821 return _core_.EvtHandler_ProcessEvent(*args, **kwargs)
e811c8ce
RD
2822
2823 def AddPendingEvent(*args, **kwargs):
a95a7133 2824 """AddPendingEvent(self, Event event)"""
54f9ee45 2825 return _core_.EvtHandler_AddPendingEvent(*args, **kwargs)
e811c8ce
RD
2826
2827 def ProcessPendingEvents(*args, **kwargs):
a95a7133 2828 """ProcessPendingEvents(self)"""
54f9ee45 2829 return _core_.EvtHandler_ProcessPendingEvents(*args, **kwargs)
e811c8ce
RD
2830
2831 def Connect(*args, **kwargs):
a95a7133 2832 """Connect(self, int id, int lastId, int eventType, PyObject func)"""
54f9ee45 2833 return _core_.EvtHandler_Connect(*args, **kwargs)
e811c8ce
RD
2834
2835 def Disconnect(*args, **kwargs):
a95a7133 2836 """Disconnect(self, int id, int lastId=-1, wxEventType eventType=wxEVT_NULL) -> bool"""
54f9ee45 2837 return _core_.EvtHandler_Disconnect(*args, **kwargs)
e811c8ce
RD
2838
2839 def _setOORInfo(*args, **kwargs):
689b42ee 2840 """_setOORInfo(self, PyObject _self, bool incref=True)"""
54f9ee45 2841 return _core_.EvtHandler__setOORInfo(*args, **kwargs)
e811c8ce 2842
d14a1e28
RD
2843 def Bind(self, event, handler, source=None, id=wx.ID_ANY, id2=wx.ID_ANY):
2844 """
2845 Bind an event to an event handler.
2846
db3e571a
RD
2847 :param event: One of the EVT_* objects that specifies the
2848 type of event to bind,
d14a1e28 2849
db3e571a
RD
2850 :param handler: A callable object to be invoked when the
2851 event is delivered to self. Pass None to
2852 disconnect an event handler.
d14a1e28 2853
db3e571a
RD
2854 :param source: Sometimes the event originates from a
2855 different window than self, but you still
2856 want to catch it in self. (For example, a
2857 button event delivered to a frame.) By
2858 passing the source of the event, the event
2859 handling system is able to differentiate
2860 between the same event type from different
2861 controls.
d14a1e28 2862
db3e571a
RD
2863 :param id: Used to spcify the event source by ID instead
2864 of instance.
2865
2866 :param id2: Used when it is desirable to bind a handler
2867 to a range of IDs, such as with EVT_MENU_RANGE.
d14a1e28
RD
2868 """
2869 if source is not None:
2870 id = source.GetId()
2871 event.Bind(self, id, id2, handler)
2872
66c033b4
RD
2873 def Unbind(self, event, source=None, id=wx.ID_ANY, id2=wx.ID_ANY):
2874 """
2875 Disconencts the event handler binding for event from self.
2876 Returns True if successful.
2877 """
2878 if source is not None:
2879 id = source.GetId()
2880 return event.Unbind(self, id, id2)
d14a1e28 2881
d14a1e28
RD
2882
2883class EvtHandlerPtr(EvtHandler):
2884 def __init__(self, this):
2885 self.this = this
2886 if not hasattr(self,"thisown"): self.thisown = 0
2887 self.__class__ = EvtHandler
54f9ee45 2888_core_.EvtHandler_swigregister(EvtHandlerPtr)
d14a1e28
RD
2889
2890#---------------------------------------------------------------------------
2891
2892class PyEventBinder(object):
2893 """
2894 Instances of this class are used to bind specific events to event
2895 handlers.
2896 """
2897 def __init__(self, evtType, expectedIDs=0):
2898 if expectedIDs not in [0, 1, 2]:
2899 raise ValueError, "Invalid number of expectedIDs"
2900 self.expectedIDs = expectedIDs
2901
2902 if type(evtType) == list or type(evtType) == tuple:
2903 self.evtType = evtType
2904 else:
2905 self.evtType = [evtType]
2906
2907
2908 def Bind(self, target, id1, id2, function):
2909 """Bind this set of event types to target."""
2910 for et in self.evtType:
2911 target.Connect(id1, id2, et, function)
2912
66c033b4
RD
2913
2914 def Unbind(self, target, id1, id2):
2915 """Remove an event binding."""
2916 success = 0
2917 for et in self.evtType:
2918 success += target.Disconnect(id1, id2, et)
2919 return success != 0
2920
d14a1e28
RD
2921
2922 def __call__(self, *args):
2923 """
2924 For backwards compatibility with the old EVT_* functions.
2925 Should be called with either (window, func), (window, ID,
2926 func) or (window, ID1, ID2, func) parameters depending on the
2927 type of the event.
2928 """
2929 assert len(args) == 2 + self.expectedIDs
2930 id1 = wx.ID_ANY
2931 id2 = wx.ID_ANY
2932 target = args[0]
2933 if self.expectedIDs == 0:
2934 func = args[1]
2935 elif self.expectedIDs == 1:
2936 id1 = args[1]
2937 func = args[2]
2938 elif self.expectedIDs == 2:
2939 id1 = args[1]
2940 id2 = args[2]
2941 func = args[3]
2942 else:
2943 raise ValueError, "Unexpected number of IDs"
2944
2945 self.Bind(target, id1, id2, func)
2946
2947
2948# These two are square pegs that don't fit the PyEventBinder hole...
2949def EVT_COMMAND(win, id, cmd, func):
2950 win.Connect(id, -1, cmd, func)
2951def EVT_COMMAND_RANGE(win, id1, id2, cmd, func):
2952 win.Connect(id1, id2, cmd, func)
2953
2954
2955#---------------------------------------------------------------------------
2956
2957#---------------------------------------------------------------------------
2958
54f9ee45
RD
2959EVENT_PROPAGATE_NONE = _core_.EVENT_PROPAGATE_NONE
2960EVENT_PROPAGATE_MAX = _core_.EVENT_PROPAGATE_MAX
d14a1e28 2961
e811c8ce
RD
2962def NewEventType(*args, **kwargs):
2963 """NewEventType() -> wxEventType"""
54f9ee45
RD
2964 return _core_.NewEventType(*args, **kwargs)
2965wxEVT_NULL = _core_.wxEVT_NULL
2966wxEVT_FIRST = _core_.wxEVT_FIRST
2967wxEVT_USER_FIRST = _core_.wxEVT_USER_FIRST
2968wxEVT_COMMAND_BUTTON_CLICKED = _core_.wxEVT_COMMAND_BUTTON_CLICKED
2969wxEVT_COMMAND_CHECKBOX_CLICKED = _core_.wxEVT_COMMAND_CHECKBOX_CLICKED
2970wxEVT_COMMAND_CHOICE_SELECTED = _core_.wxEVT_COMMAND_CHOICE_SELECTED
2971wxEVT_COMMAND_LISTBOX_SELECTED = _core_.wxEVT_COMMAND_LISTBOX_SELECTED
2972wxEVT_COMMAND_LISTBOX_DOUBLECLICKED = _core_.wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
2973wxEVT_COMMAND_CHECKLISTBOX_TOGGLED = _core_.wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
2974wxEVT_COMMAND_MENU_SELECTED = _core_.wxEVT_COMMAND_MENU_SELECTED
2975wxEVT_COMMAND_TOOL_CLICKED = _core_.wxEVT_COMMAND_TOOL_CLICKED
2976wxEVT_COMMAND_SLIDER_UPDATED = _core_.wxEVT_COMMAND_SLIDER_UPDATED
2977wxEVT_COMMAND_RADIOBOX_SELECTED = _core_.wxEVT_COMMAND_RADIOBOX_SELECTED
2978wxEVT_COMMAND_RADIOBUTTON_SELECTED = _core_.wxEVT_COMMAND_RADIOBUTTON_SELECTED
2979wxEVT_COMMAND_SCROLLBAR_UPDATED = _core_.wxEVT_COMMAND_SCROLLBAR_UPDATED
2980wxEVT_COMMAND_VLBOX_SELECTED = _core_.wxEVT_COMMAND_VLBOX_SELECTED
2981wxEVT_COMMAND_COMBOBOX_SELECTED = _core_.wxEVT_COMMAND_COMBOBOX_SELECTED
2982wxEVT_COMMAND_TOOL_RCLICKED = _core_.wxEVT_COMMAND_TOOL_RCLICKED
2983wxEVT_COMMAND_TOOL_ENTER = _core_.wxEVT_COMMAND_TOOL_ENTER
2984wxEVT_LEFT_DOWN = _core_.wxEVT_LEFT_DOWN
2985wxEVT_LEFT_UP = _core_.wxEVT_LEFT_UP
2986wxEVT_MIDDLE_DOWN = _core_.wxEVT_MIDDLE_DOWN
2987wxEVT_MIDDLE_UP = _core_.wxEVT_MIDDLE_UP
2988wxEVT_RIGHT_DOWN = _core_.wxEVT_RIGHT_DOWN
2989wxEVT_RIGHT_UP = _core_.wxEVT_RIGHT_UP
2990wxEVT_MOTION = _core_.wxEVT_MOTION
2991wxEVT_ENTER_WINDOW = _core_.wxEVT_ENTER_WINDOW
2992wxEVT_LEAVE_WINDOW = _core_.wxEVT_LEAVE_WINDOW
2993wxEVT_LEFT_DCLICK = _core_.wxEVT_LEFT_DCLICK
2994wxEVT_MIDDLE_DCLICK = _core_.wxEVT_MIDDLE_DCLICK
2995wxEVT_RIGHT_DCLICK = _core_.wxEVT_RIGHT_DCLICK
2996wxEVT_SET_FOCUS = _core_.wxEVT_SET_FOCUS
2997wxEVT_KILL_FOCUS = _core_.wxEVT_KILL_FOCUS
2998wxEVT_CHILD_FOCUS = _core_.wxEVT_CHILD_FOCUS
2999wxEVT_MOUSEWHEEL = _core_.wxEVT_MOUSEWHEEL
3000wxEVT_NC_LEFT_DOWN = _core_.wxEVT_NC_LEFT_DOWN
3001wxEVT_NC_LEFT_UP = _core_.wxEVT_NC_LEFT_UP
3002wxEVT_NC_MIDDLE_DOWN = _core_.wxEVT_NC_MIDDLE_DOWN
3003wxEVT_NC_MIDDLE_UP = _core_.wxEVT_NC_MIDDLE_UP
3004wxEVT_NC_RIGHT_DOWN = _core_.wxEVT_NC_RIGHT_DOWN
3005wxEVT_NC_RIGHT_UP = _core_.wxEVT_NC_RIGHT_UP
3006wxEVT_NC_MOTION = _core_.wxEVT_NC_MOTION
3007wxEVT_NC_ENTER_WINDOW = _core_.wxEVT_NC_ENTER_WINDOW
3008wxEVT_NC_LEAVE_WINDOW = _core_.wxEVT_NC_LEAVE_WINDOW
3009wxEVT_NC_LEFT_DCLICK = _core_.wxEVT_NC_LEFT_DCLICK
3010wxEVT_NC_MIDDLE_DCLICK = _core_.wxEVT_NC_MIDDLE_DCLICK
3011wxEVT_NC_RIGHT_DCLICK = _core_.wxEVT_NC_RIGHT_DCLICK
3012wxEVT_CHAR = _core_.wxEVT_CHAR
3013wxEVT_CHAR_HOOK = _core_.wxEVT_CHAR_HOOK
3014wxEVT_NAVIGATION_KEY = _core_.wxEVT_NAVIGATION_KEY
3015wxEVT_KEY_DOWN = _core_.wxEVT_KEY_DOWN
3016wxEVT_KEY_UP = _core_.wxEVT_KEY_UP
3017wxEVT_HOTKEY = _core_.wxEVT_HOTKEY
3018wxEVT_SET_CURSOR = _core_.wxEVT_SET_CURSOR
3019wxEVT_SCROLL_TOP = _core_.wxEVT_SCROLL_TOP
3020wxEVT_SCROLL_BOTTOM = _core_.wxEVT_SCROLL_BOTTOM
3021wxEVT_SCROLL_LINEUP = _core_.wxEVT_SCROLL_LINEUP
3022wxEVT_SCROLL_LINEDOWN = _core_.wxEVT_SCROLL_LINEDOWN
3023wxEVT_SCROLL_PAGEUP = _core_.wxEVT_SCROLL_PAGEUP
3024wxEVT_SCROLL_PAGEDOWN = _core_.wxEVT_SCROLL_PAGEDOWN
3025wxEVT_SCROLL_THUMBTRACK = _core_.wxEVT_SCROLL_THUMBTRACK
3026wxEVT_SCROLL_THUMBRELEASE = _core_.wxEVT_SCROLL_THUMBRELEASE
3027wxEVT_SCROLL_ENDSCROLL = _core_.wxEVT_SCROLL_ENDSCROLL
3028wxEVT_SCROLLWIN_TOP = _core_.wxEVT_SCROLLWIN_TOP
3029wxEVT_SCROLLWIN_BOTTOM = _core_.wxEVT_SCROLLWIN_BOTTOM
3030wxEVT_SCROLLWIN_LINEUP = _core_.wxEVT_SCROLLWIN_LINEUP
3031wxEVT_SCROLLWIN_LINEDOWN = _core_.wxEVT_SCROLLWIN_LINEDOWN
3032wxEVT_SCROLLWIN_PAGEUP = _core_.wxEVT_SCROLLWIN_PAGEUP
3033wxEVT_SCROLLWIN_PAGEDOWN = _core_.wxEVT_SCROLLWIN_PAGEDOWN
3034wxEVT_SCROLLWIN_THUMBTRACK = _core_.wxEVT_SCROLLWIN_THUMBTRACK
3035wxEVT_SCROLLWIN_THUMBRELEASE = _core_.wxEVT_SCROLLWIN_THUMBRELEASE
3036wxEVT_SIZE = _core_.wxEVT_SIZE
3037wxEVT_MOVE = _core_.wxEVT_MOVE
3038wxEVT_CLOSE_WINDOW = _core_.wxEVT_CLOSE_WINDOW
3039wxEVT_END_SESSION = _core_.wxEVT_END_SESSION
3040wxEVT_QUERY_END_SESSION = _core_.wxEVT_QUERY_END_SESSION
3041wxEVT_ACTIVATE_APP = _core_.wxEVT_ACTIVATE_APP
3042wxEVT_POWER = _core_.wxEVT_POWER
3043wxEVT_ACTIVATE = _core_.wxEVT_ACTIVATE
3044wxEVT_CREATE = _core_.wxEVT_CREATE
3045wxEVT_DESTROY = _core_.wxEVT_DESTROY
3046wxEVT_SHOW = _core_.wxEVT_SHOW
3047wxEVT_ICONIZE = _core_.wxEVT_ICONIZE
3048wxEVT_MAXIMIZE = _core_.wxEVT_MAXIMIZE
3049wxEVT_MOUSE_CAPTURE_CHANGED = _core_.wxEVT_MOUSE_CAPTURE_CHANGED
3050wxEVT_PAINT = _core_.wxEVT_PAINT
3051wxEVT_ERASE_BACKGROUND = _core_.wxEVT_ERASE_BACKGROUND
3052wxEVT_NC_PAINT = _core_.wxEVT_NC_PAINT
3053wxEVT_PAINT_ICON = _core_.wxEVT_PAINT_ICON
3054wxEVT_MENU_OPEN = _core_.wxEVT_MENU_OPEN
3055wxEVT_MENU_CLOSE = _core_.wxEVT_MENU_CLOSE
3056wxEVT_MENU_HIGHLIGHT = _core_.wxEVT_MENU_HIGHLIGHT
3057wxEVT_CONTEXT_MENU = _core_.wxEVT_CONTEXT_MENU
3058wxEVT_SYS_COLOUR_CHANGED = _core_.wxEVT_SYS_COLOUR_CHANGED
3059wxEVT_DISPLAY_CHANGED = _core_.wxEVT_DISPLAY_CHANGED
3060wxEVT_SETTING_CHANGED = _core_.wxEVT_SETTING_CHANGED
3061wxEVT_QUERY_NEW_PALETTE = _core_.wxEVT_QUERY_NEW_PALETTE
3062wxEVT_PALETTE_CHANGED = _core_.wxEVT_PALETTE_CHANGED
3063wxEVT_DROP_FILES = _core_.wxEVT_DROP_FILES
3064wxEVT_DRAW_ITEM = _core_.wxEVT_DRAW_ITEM
3065wxEVT_MEASURE_ITEM = _core_.wxEVT_MEASURE_ITEM
3066wxEVT_COMPARE_ITEM = _core_.wxEVT_COMPARE_ITEM
3067wxEVT_INIT_DIALOG = _core_.wxEVT_INIT_DIALOG
3068wxEVT_IDLE = _core_.wxEVT_IDLE
3069wxEVT_UPDATE_UI = _core_.wxEVT_UPDATE_UI
3070wxEVT_SIZING = _core_.wxEVT_SIZING
3071wxEVT_MOVING = _core_.wxEVT_MOVING
3072wxEVT_COMMAND_LEFT_CLICK = _core_.wxEVT_COMMAND_LEFT_CLICK
3073wxEVT_COMMAND_LEFT_DCLICK = _core_.wxEVT_COMMAND_LEFT_DCLICK
3074wxEVT_COMMAND_RIGHT_CLICK = _core_.wxEVT_COMMAND_RIGHT_CLICK
3075wxEVT_COMMAND_RIGHT_DCLICK = _core_.wxEVT_COMMAND_RIGHT_DCLICK
3076wxEVT_COMMAND_SET_FOCUS = _core_.wxEVT_COMMAND_SET_FOCUS
3077wxEVT_COMMAND_KILL_FOCUS = _core_.wxEVT_COMMAND_KILL_FOCUS
3078wxEVT_COMMAND_ENTER = _core_.wxEVT_COMMAND_ENTER
d14a1e28
RD
3079#
3080# Create some event binders
3081EVT_SIZE = wx.PyEventBinder( wxEVT_SIZE )
3082EVT_SIZING = wx.PyEventBinder( wxEVT_SIZING )
3083EVT_MOVE = wx.PyEventBinder( wxEVT_MOVE )
3084EVT_MOVING = wx.PyEventBinder( wxEVT_MOVING )
3085EVT_CLOSE = wx.PyEventBinder( wxEVT_CLOSE_WINDOW )
3086EVT_END_SESSION = wx.PyEventBinder( wxEVT_END_SESSION )
3087EVT_QUERY_END_SESSION = wx.PyEventBinder( wxEVT_QUERY_END_SESSION )
3088EVT_PAINT = wx.PyEventBinder( wxEVT_PAINT )
3089EVT_NC_PAINT = wx.PyEventBinder( wxEVT_NC_PAINT )
3090EVT_ERASE_BACKGROUND = wx.PyEventBinder( wxEVT_ERASE_BACKGROUND )
3091EVT_CHAR = wx.PyEventBinder( wxEVT_CHAR )
3092EVT_KEY_DOWN = wx.PyEventBinder( wxEVT_KEY_DOWN )
3093EVT_KEY_UP = wx.PyEventBinder( wxEVT_KEY_UP )
3094EVT_HOTKEY = wx.PyEventBinder( wxEVT_HOTKEY, 1)
3095EVT_CHAR_HOOK = wx.PyEventBinder( wxEVT_CHAR_HOOK )
3096EVT_MENU_OPEN = wx.PyEventBinder( wxEVT_MENU_OPEN )
3097EVT_MENU_CLOSE = wx.PyEventBinder( wxEVT_MENU_CLOSE )
3098EVT_MENU_HIGHLIGHT = wx.PyEventBinder( wxEVT_MENU_HIGHLIGHT, 1)
3099EVT_MENU_HIGHLIGHT_ALL = wx.PyEventBinder( wxEVT_MENU_HIGHLIGHT )
3100EVT_SET_FOCUS = wx.PyEventBinder( wxEVT_SET_FOCUS )
3101EVT_KILL_FOCUS = wx.PyEventBinder( wxEVT_KILL_FOCUS )
3102EVT_CHILD_FOCUS = wx.PyEventBinder( wxEVT_CHILD_FOCUS )
3103EVT_ACTIVATE = wx.PyEventBinder( wxEVT_ACTIVATE )
3104EVT_ACTIVATE_APP = wx.PyEventBinder( wxEVT_ACTIVATE_APP )
3105EVT_END_SESSION = wx.PyEventBinder( wxEVT_END_SESSION )
3106EVT_QUERY_END_SESSION = wx.PyEventBinder( wxEVT_QUERY_END_SESSION )
3107EVT_DROP_FILES = wx.PyEventBinder( wxEVT_DROP_FILES )
3108EVT_INIT_DIALOG = wx.PyEventBinder( wxEVT_INIT_DIALOG )
3109EVT_SYS_COLOUR_CHANGED = wx.PyEventBinder( wxEVT_SYS_COLOUR_CHANGED )
3110EVT_DISPLAY_CHANGED = wx.PyEventBinder( wxEVT_DISPLAY_CHANGED )
3111EVT_SHOW = wx.PyEventBinder( wxEVT_SHOW )
3112EVT_MAXIMIZE = wx.PyEventBinder( wxEVT_MAXIMIZE )
3113EVT_ICONIZE = wx.PyEventBinder( wxEVT_ICONIZE )
3114EVT_NAVIGATION_KEY = wx.PyEventBinder( wxEVT_NAVIGATION_KEY )
3115EVT_PALETTE_CHANGED = wx.PyEventBinder( wxEVT_PALETTE_CHANGED )
3116EVT_QUERY_NEW_PALETTE = wx.PyEventBinder( wxEVT_QUERY_NEW_PALETTE )
3117EVT_WINDOW_CREATE = wx.PyEventBinder( wxEVT_CREATE )
3118EVT_WINDOW_DESTROY = wx.PyEventBinder( wxEVT_DESTROY )
3119EVT_SET_CURSOR = wx.PyEventBinder( wxEVT_SET_CURSOR )
3120EVT_MOUSE_CAPTURE_CHANGED = wx.PyEventBinder( wxEVT_MOUSE_CAPTURE_CHANGED )
3121
3122EVT_LEFT_DOWN = wx.PyEventBinder( wxEVT_LEFT_DOWN )
3123EVT_LEFT_UP = wx.PyEventBinder( wxEVT_LEFT_UP )
3124EVT_MIDDLE_DOWN = wx.PyEventBinder( wxEVT_MIDDLE_DOWN )
3125EVT_MIDDLE_UP = wx.PyEventBinder( wxEVT_MIDDLE_UP )
3126EVT_RIGHT_DOWN = wx.PyEventBinder( wxEVT_RIGHT_DOWN )
3127EVT_RIGHT_UP = wx.PyEventBinder( wxEVT_RIGHT_UP )
3128EVT_MOTION = wx.PyEventBinder( wxEVT_MOTION )
3129EVT_LEFT_DCLICK = wx.PyEventBinder( wxEVT_LEFT_DCLICK )
3130EVT_MIDDLE_DCLICK = wx.PyEventBinder( wxEVT_MIDDLE_DCLICK )
3131EVT_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_RIGHT_DCLICK )
3132EVT_LEAVE_WINDOW = wx.PyEventBinder( wxEVT_LEAVE_WINDOW )
3133EVT_ENTER_WINDOW = wx.PyEventBinder( wxEVT_ENTER_WINDOW )
3134EVT_MOUSEWHEEL = wx.PyEventBinder( wxEVT_MOUSEWHEEL )
3135
3136EVT_MOUSE_EVENTS = wx.PyEventBinder([ wxEVT_LEFT_DOWN,
3137 wxEVT_LEFT_UP,
3138 wxEVT_MIDDLE_DOWN,
3139 wxEVT_MIDDLE_UP,
3140 wxEVT_RIGHT_DOWN,
3141 wxEVT_RIGHT_UP,
3142 wxEVT_MOTION,
3143 wxEVT_LEFT_DCLICK,
3144 wxEVT_MIDDLE_DCLICK,
3145 wxEVT_RIGHT_DCLICK,
3146 wxEVT_ENTER_WINDOW,
3147 wxEVT_LEAVE_WINDOW,
3148 wxEVT_MOUSEWHEEL
3149 ])
3150
3151
3152# Scrolling from wxWindow (sent to wxScrolledWindow)
3153EVT_SCROLLWIN = wx.PyEventBinder([ wxEVT_SCROLLWIN_TOP,
3154 wxEVT_SCROLLWIN_BOTTOM,
3155 wxEVT_SCROLLWIN_LINEUP,
3156 wxEVT_SCROLLWIN_LINEDOWN,
3157 wxEVT_SCROLLWIN_PAGEUP,
3158 wxEVT_SCROLLWIN_PAGEDOWN,
3159 wxEVT_SCROLLWIN_THUMBTRACK,
3160 wxEVT_SCROLLWIN_THUMBRELEASE,
3161 ])
3162
3163EVT_SCROLLWIN_TOP = wx.PyEventBinder( wxEVT_SCROLLWIN_TOP )
3164EVT_SCROLLWIN_BOTTOM = wx.PyEventBinder( wxEVT_SCROLLWIN_BOTTOM )
3165EVT_SCROLLWIN_LINEUP = wx.PyEventBinder( wxEVT_SCROLLWIN_LINEUP )
3166EVT_SCROLLWIN_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLLWIN_LINEDOWN )
3167EVT_SCROLLWIN_PAGEUP = wx.PyEventBinder( wxEVT_SCROLLWIN_PAGEUP )
3168EVT_SCROLLWIN_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLLWIN_PAGEDOWN )
3169EVT_SCROLLWIN_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLLWIN_THUMBTRACK )
3170EVT_SCROLLWIN_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLLWIN_THUMBRELEASE )
3171
3172# Scrolling from wxSlider and wxScrollBar
3173EVT_SCROLL = wx.PyEventBinder([ wxEVT_SCROLL_TOP,
3174 wxEVT_SCROLL_BOTTOM,
3175 wxEVT_SCROLL_LINEUP,
3176 wxEVT_SCROLL_LINEDOWN,
3177 wxEVT_SCROLL_PAGEUP,
3178 wxEVT_SCROLL_PAGEDOWN,
3179 wxEVT_SCROLL_THUMBTRACK,
3180 wxEVT_SCROLL_THUMBRELEASE,
3181 wxEVT_SCROLL_ENDSCROLL,
3182 ])
3183
3184EVT_SCROLL_TOP = wx.PyEventBinder( wxEVT_SCROLL_TOP )
3185EVT_SCROLL_BOTTOM = wx.PyEventBinder( wxEVT_SCROLL_BOTTOM )
3186EVT_SCROLL_LINEUP = wx.PyEventBinder( wxEVT_SCROLL_LINEUP )
3187EVT_SCROLL_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLL_LINEDOWN )
3188EVT_SCROLL_PAGEUP = wx.PyEventBinder( wxEVT_SCROLL_PAGEUP )
3189EVT_SCROLL_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLL_PAGEDOWN )
3190EVT_SCROLL_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLL_THUMBTRACK )
3191EVT_SCROLL_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE )
3192EVT_SCROLL_ENDSCROLL = wx.PyEventBinder( wxEVT_SCROLL_ENDSCROLL )
3193
3194# Scrolling from wxSlider and wxScrollBar, with an id
3195EVT_COMMAND_SCROLL = wx.PyEventBinder([ wxEVT_SCROLL_TOP,
3196 wxEVT_SCROLL_BOTTOM,
3197 wxEVT_SCROLL_LINEUP,
3198 wxEVT_SCROLL_LINEDOWN,
3199 wxEVT_SCROLL_PAGEUP,
3200 wxEVT_SCROLL_PAGEDOWN,
3201 wxEVT_SCROLL_THUMBTRACK,
3202 wxEVT_SCROLL_THUMBRELEASE,
3203 wxEVT_SCROLL_ENDSCROLL,
3204 ], 1)
3205
3206EVT_COMMAND_SCROLL_TOP = wx.PyEventBinder( wxEVT_SCROLL_TOP, 1)
3207EVT_COMMAND_SCROLL_BOTTOM = wx.PyEventBinder( wxEVT_SCROLL_BOTTOM, 1)
3208EVT_COMMAND_SCROLL_LINEUP = wx.PyEventBinder( wxEVT_SCROLL_LINEUP, 1)
3209EVT_COMMAND_SCROLL_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLL_LINEDOWN, 1)
3210EVT_COMMAND_SCROLL_PAGEUP = wx.PyEventBinder( wxEVT_SCROLL_PAGEUP, 1)
3211EVT_COMMAND_SCROLL_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLL_PAGEDOWN, 1)
3212EVT_COMMAND_SCROLL_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLL_THUMBTRACK, 1)
3213EVT_COMMAND_SCROLL_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE, 1)
3214EVT_COMMAND_SCROLL_ENDSCROLL = wx.PyEventBinder( wxEVT_SCROLL_ENDSCROLL, 1)
3215
d14a1e28
RD
3216EVT_BUTTON = wx.PyEventBinder( wxEVT_COMMAND_BUTTON_CLICKED, 1)
3217EVT_CHECKBOX = wx.PyEventBinder( wxEVT_COMMAND_CHECKBOX_CLICKED, 1)
3218EVT_CHOICE = wx.PyEventBinder( wxEVT_COMMAND_CHOICE_SELECTED, 1)
3219EVT_LISTBOX = wx.PyEventBinder( wxEVT_COMMAND_LISTBOX_SELECTED, 1)
3220EVT_LISTBOX_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, 1)
3221EVT_MENU = wx.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED, 1)
3222EVT_MENU_RANGE = wx.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED, 2)
3223EVT_SLIDER = wx.PyEventBinder( wxEVT_COMMAND_SLIDER_UPDATED, 1)
3224EVT_RADIOBOX = wx.PyEventBinder( wxEVT_COMMAND_RADIOBOX_SELECTED, 1)
3225EVT_RADIOBUTTON = wx.PyEventBinder( wxEVT_COMMAND_RADIOBUTTON_SELECTED, 1)
3226
3227EVT_SCROLLBAR = wx.PyEventBinder( wxEVT_COMMAND_SCROLLBAR_UPDATED, 1)
3228EVT_VLBOX = wx.PyEventBinder( wxEVT_COMMAND_VLBOX_SELECTED, 1)
3229EVT_COMBOBOX = wx.PyEventBinder( wxEVT_COMMAND_COMBOBOX_SELECTED, 1)
3230EVT_TOOL = wx.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED, 1)
3231EVT_TOOL_RANGE = wx.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED, 2)
3232EVT_TOOL_RCLICKED = wx.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED, 1)
3233EVT_TOOL_RCLICKED_RANGE = wx.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED, 2)
3234EVT_TOOL_ENTER = wx.PyEventBinder( wxEVT_COMMAND_TOOL_ENTER, 1)
3235EVT_CHECKLISTBOX = wx.PyEventBinder( wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, 1)
3236
3237
3238EVT_COMMAND_LEFT_CLICK = wx.PyEventBinder( wxEVT_COMMAND_LEFT_CLICK, 1)
3239EVT_COMMAND_LEFT_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_LEFT_DCLICK, 1)
3240EVT_COMMAND_RIGHT_CLICK = wx.PyEventBinder( wxEVT_COMMAND_RIGHT_CLICK, 1)
3241EVT_COMMAND_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_RIGHT_DCLICK, 1)
3242EVT_COMMAND_SET_FOCUS = wx.PyEventBinder( wxEVT_COMMAND_SET_FOCUS, 1)
3243EVT_COMMAND_KILL_FOCUS = wx.PyEventBinder( wxEVT_COMMAND_KILL_FOCUS, 1)
3244EVT_COMMAND_ENTER = wx.PyEventBinder( wxEVT_COMMAND_ENTER, 1)
3245
3246EVT_IDLE = wx.PyEventBinder( wxEVT_IDLE )
3247
3248EVT_UPDATE_UI = wx.PyEventBinder( wxEVT_UPDATE_UI, 1)
3249EVT_UPDATE_UI_RANGE = wx.PyEventBinder( wxEVT_UPDATE_UI, 2)
3250
3251EVT_CONTEXT_MENU = wx.PyEventBinder( wxEVT_CONTEXT_MENU )
3252
3253
3254
3255#---------------------------------------------------------------------------
3256
3257class Event(Object):
093d3ff1 3258 """Proxy of C++ Event class"""
e811c8ce
RD
3259 def __init__(self): raise RuntimeError, "No constructor defined"
3260 def __repr__(self):
3261 return "<%s.%s; proxy of C++ wxEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
54f9ee45 3262 def __del__(self, destroy=_core_.delete_Event):
a95a7133 3263 """__del__(self)"""
d14a1e28
RD
3264 try:
3265 if self.thisown: destroy(self)
3266 except: pass
e811c8ce
RD
3267
3268 def SetEventType(*args, **kwargs):
a95a7133 3269 """SetEventType(self, wxEventType typ)"""
54f9ee45 3270 return _core_.Event_SetEventType(*args, **kwargs)
e811c8ce
RD
3271
3272 def GetEventType(*args, **kwargs):
a95a7133 3273 """GetEventType(self) -> wxEventType"""
54f9ee45 3274 return _core_.Event_GetEventType(*args, **kwargs)
e811c8ce
RD
3275
3276 def GetEventObject(*args, **kwargs):
a95a7133 3277 """GetEventObject(self) -> Object"""
54f9ee45 3278 return _core_.Event_GetEventObject(*args, **kwargs)
e811c8ce
RD
3279
3280 def SetEventObject(*args, **kwargs):
a95a7133 3281 """SetEventObject(self, Object obj)"""
54f9ee45 3282 return _core_.Event_SetEventObject(*args, **kwargs)
e811c8ce
RD
3283
3284 def GetTimestamp(*args, **kwargs):
a95a7133 3285 """GetTimestamp(self) -> long"""
54f9ee45 3286 return _core_.Event_GetTimestamp(*args, **kwargs)
e811c8ce
RD
3287
3288 def SetTimestamp(*args, **kwargs):
a95a7133 3289 """SetTimestamp(self, long ts=0)"""
54f9ee45 3290 return _core_.Event_SetTimestamp(*args, **kwargs)
e811c8ce
RD
3291
3292 def GetId(*args, **kwargs):
a95a7133 3293 """GetId(self) -> int"""
54f9ee45 3294 return _core_.Event_GetId(*args, **kwargs)
e811c8ce
RD
3295
3296 def SetId(*args, **kwargs):
a95a7133 3297 """SetId(self, int Id)"""
54f9ee45 3298 return _core_.Event_SetId(*args, **kwargs)
e811c8ce
RD
3299
3300 def IsCommandEvent(*args, **kwargs):
a95a7133 3301 """IsCommandEvent(self) -> bool"""
54f9ee45 3302 return _core_.Event_IsCommandEvent(*args, **kwargs)
e811c8ce
RD
3303
3304 def Skip(*args, **kwargs):
51b83b37
RD
3305 """
3306 Skip(self, bool skip=True)
3307
3308 Called by an event handler, it controls whether additional event
3309 handlers bound to this event will be called after the current event
3310 handler returns. Skip(false) (the default setting) will prevent
3311 additional event handlers from being called and control will be
3312 returned to the sender of the event immediately after the current
3313 handler has finished. Skip(True) will cause the event processing
3314 system to continue searching for a handler function for this event.
3315
3316 """
54f9ee45 3317 return _core_.Event_Skip(*args, **kwargs)
e811c8ce
RD
3318
3319 def GetSkipped(*args, **kwargs):
a95a7133 3320 """GetSkipped(self) -> bool"""
54f9ee45 3321 return _core_.Event_GetSkipped(*args, **kwargs)
e811c8ce
RD
3322
3323 def ShouldPropagate(*args, **kwargs):
a95a7133 3324 """ShouldPropagate(self) -> bool"""
54f9ee45 3325 return _core_.Event_ShouldPropagate(*args, **kwargs)
e811c8ce
RD
3326
3327 def StopPropagation(*args, **kwargs):
a95a7133 3328 """StopPropagation(self) -> int"""
54f9ee45 3329 return _core_.Event_StopPropagation(*args, **kwargs)
e811c8ce
RD
3330
3331 def ResumePropagation(*args, **kwargs):
a95a7133 3332 """ResumePropagation(self, int propagationLevel)"""
54f9ee45 3333 return _core_.Event_ResumePropagation(*args, **kwargs)
e811c8ce
RD
3334
3335 def Clone(*args, **kwargs):
a95a7133 3336 """Clone(self) -> Event"""
54f9ee45 3337 return _core_.Event_Clone(*args, **kwargs)
e811c8ce 3338
d14a1e28
RD
3339
3340class EventPtr(Event):
3341 def __init__(self, this):
3342 self.this = this
3343 if not hasattr(self,"thisown"): self.thisown = 0
3344 self.__class__ = Event
54f9ee45 3345_core_.Event_swigregister(EventPtr)
d14a1e28
RD
3346
3347#---------------------------------------------------------------------------
3348
3349class PropagationDisabler(object):
093d3ff1 3350 """Proxy of C++ PropagationDisabler class"""
e811c8ce
RD
3351 def __repr__(self):
3352 return "<%s.%s; proxy of C++ wxPropagationDisabler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3353 def __init__(self, *args, **kwargs):
a95a7133 3354 """__init__(self, Event event) -> PropagationDisabler"""
54f9ee45 3355 newobj = _core_.new_PropagationDisabler(*args, **kwargs)
d14a1e28
RD
3356 self.this = newobj.this
3357 self.thisown = 1
3358 del newobj.thisown
54f9ee45 3359 def __del__(self, destroy=_core_.delete_PropagationDisabler):
a95a7133 3360 """__del__(self)"""
d14a1e28
RD
3361 try:
3362 if self.thisown: destroy(self)
3363 except: pass
e811c8ce 3364
d14a1e28
RD
3365
3366class PropagationDisablerPtr(PropagationDisabler):
3367 def __init__(self, this):
3368 self.this = this
3369 if not hasattr(self,"thisown"): self.thisown = 0
3370 self.__class__ = PropagationDisabler
54f9ee45 3371_core_.PropagationDisabler_swigregister(PropagationDisablerPtr)
d14a1e28
RD
3372
3373class PropagateOnce(object):
093d3ff1 3374 """Proxy of C++ PropagateOnce class"""
e811c8ce
RD
3375 def __repr__(self):
3376 return "<%s.%s; proxy of C++ wxPropagateOnce instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3377 def __init__(self, *args, **kwargs):
a95a7133 3378 """__init__(self, Event event) -> PropagateOnce"""
54f9ee45 3379 newobj = _core_.new_PropagateOnce(*args, **kwargs)
d14a1e28
RD
3380 self.this = newobj.this
3381 self.thisown = 1
3382 del newobj.thisown
54f9ee45 3383 def __del__(self, destroy=_core_.delete_PropagateOnce):
a95a7133 3384 """__del__(self)"""
d14a1e28
RD
3385 try:
3386 if self.thisown: destroy(self)
3387 except: pass
e811c8ce 3388
d14a1e28
RD
3389
3390class PropagateOncePtr(PropagateOnce):
3391 def __init__(self, this):
3392 self.this = this
3393 if not hasattr(self,"thisown"): self.thisown = 0
3394 self.__class__ = PropagateOnce
54f9ee45 3395_core_.PropagateOnce_swigregister(PropagateOncePtr)
d14a1e28
RD
3396
3397#---------------------------------------------------------------------------
3398
3399class CommandEvent(Event):
093d3ff1 3400 """Proxy of C++ CommandEvent class"""
e811c8ce
RD
3401 def __repr__(self):
3402 return "<%s.%s; proxy of C++ wxCommandEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3403 def __init__(self, *args, **kwargs):
a95a7133 3404 """__init__(self, wxEventType commandType=wxEVT_NULL, int winid=0) -> CommandEvent"""
54f9ee45 3405 newobj = _core_.new_CommandEvent(*args, **kwargs)
d14a1e28
RD
3406 self.this = newobj.this
3407 self.thisown = 1
3408 del newobj.thisown
e811c8ce 3409 def GetSelection(*args, **kwargs):
a95a7133 3410 """GetSelection(self) -> int"""
54f9ee45 3411 return _core_.CommandEvent_GetSelection(*args, **kwargs)
e811c8ce
RD
3412
3413 def SetString(*args, **kwargs):
a95a7133 3414 """SetString(self, String s)"""
54f9ee45 3415 return _core_.CommandEvent_SetString(*args, **kwargs)
e811c8ce
RD
3416
3417 def GetString(*args, **kwargs):
a95a7133 3418 """GetString(self) -> String"""
54f9ee45 3419 return _core_.CommandEvent_GetString(*args, **kwargs)
e811c8ce
RD
3420
3421 def IsChecked(*args, **kwargs):
a95a7133 3422 """IsChecked(self) -> bool"""
54f9ee45 3423 return _core_.CommandEvent_IsChecked(*args, **kwargs)
e811c8ce 3424
242b7b46 3425 Checked = IsChecked
e811c8ce 3426 def IsSelection(*args, **kwargs):
a95a7133 3427 """IsSelection(self) -> bool"""
54f9ee45 3428 return _core_.CommandEvent_IsSelection(*args, **kwargs)
e811c8ce
RD
3429
3430 def SetExtraLong(*args, **kwargs):
a95a7133 3431 """SetExtraLong(self, long extraLong)"""
54f9ee45 3432 return _core_.CommandEvent_SetExtraLong(*args, **kwargs)
e811c8ce
RD
3433
3434 def GetExtraLong(*args, **kwargs):
a95a7133 3435 """GetExtraLong(self) -> long"""
54f9ee45 3436 return _core_.CommandEvent_GetExtraLong(*args, **kwargs)
e811c8ce
RD
3437
3438 def SetInt(*args, **kwargs):
a95a7133 3439 """SetInt(self, int i)"""
54f9ee45 3440 return _core_.CommandEvent_SetInt(*args, **kwargs)
e811c8ce
RD
3441
3442 def GetInt(*args, **kwargs):
a95a7133 3443 """GetInt(self) -> long"""
54f9ee45 3444 return _core_.CommandEvent_GetInt(*args, **kwargs)
e811c8ce
RD
3445
3446 def Clone(*args, **kwargs):
a95a7133 3447 """Clone(self) -> Event"""
54f9ee45 3448 return _core_.CommandEvent_Clone(*args, **kwargs)
e811c8ce 3449
d14a1e28
RD
3450
3451class CommandEventPtr(CommandEvent):
3452 def __init__(self, this):
3453 self.this = this
3454 if not hasattr(self,"thisown"): self.thisown = 0
3455 self.__class__ = CommandEvent
54f9ee45 3456_core_.CommandEvent_swigregister(CommandEventPtr)
d14a1e28
RD
3457
3458#---------------------------------------------------------------------------
3459
3460class NotifyEvent(CommandEvent):
093d3ff1 3461 """Proxy of C++ NotifyEvent class"""
e811c8ce
RD
3462 def __repr__(self):
3463 return "<%s.%s; proxy of C++ wxNotifyEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3464 def __init__(self, *args, **kwargs):
a95a7133 3465 """__init__(self, wxEventType commandType=wxEVT_NULL, int winid=0) -> NotifyEvent"""
54f9ee45 3466 newobj = _core_.new_NotifyEvent(*args, **kwargs)
d14a1e28
RD
3467 self.this = newobj.this
3468 self.thisown = 1
3469 del newobj.thisown
e811c8ce 3470 def Veto(*args, **kwargs):
a95a7133 3471 """Veto(self)"""
54f9ee45 3472 return _core_.NotifyEvent_Veto(*args, **kwargs)
e811c8ce
RD
3473
3474 def Allow(*args, **kwargs):
a95a7133 3475 """Allow(self)"""
54f9ee45 3476 return _core_.NotifyEvent_Allow(*args, **kwargs)
e811c8ce
RD
3477
3478 def IsAllowed(*args, **kwargs):
a95a7133 3479 """IsAllowed(self) -> bool"""
54f9ee45 3480 return _core_.NotifyEvent_IsAllowed(*args, **kwargs)
e811c8ce 3481
d14a1e28
RD
3482
3483class NotifyEventPtr(NotifyEvent):
3484 def __init__(self, this):
3485 self.this = this
3486 if not hasattr(self,"thisown"): self.thisown = 0
3487 self.__class__ = NotifyEvent
54f9ee45 3488_core_.NotifyEvent_swigregister(NotifyEventPtr)
d14a1e28
RD
3489
3490#---------------------------------------------------------------------------
3491
3492class ScrollEvent(CommandEvent):
093d3ff1 3493 """Proxy of C++ ScrollEvent class"""
e811c8ce
RD
3494 def __repr__(self):
3495 return "<%s.%s; proxy of C++ wxScrollEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3496 def __init__(self, *args, **kwargs):
0df68c9f 3497 """
a95a7133 3498 __init__(self, wxEventType commandType=wxEVT_NULL, int winid=0, int pos=0,
0df68c9f
RD
3499 int orient=0) -> ScrollEvent
3500 """
54f9ee45 3501 newobj = _core_.new_ScrollEvent(*args, **kwargs)
d14a1e28
RD
3502 self.this = newobj.this
3503 self.thisown = 1
3504 del newobj.thisown
e811c8ce 3505 def GetOrientation(*args, **kwargs):
a95a7133 3506 """GetOrientation(self) -> int"""
54f9ee45 3507 return _core_.ScrollEvent_GetOrientation(*args, **kwargs)
e811c8ce
RD
3508
3509 def GetPosition(*args, **kwargs):
a95a7133 3510 """GetPosition(self) -> int"""
54f9ee45 3511 return _core_.ScrollEvent_GetPosition(*args, **kwargs)
e811c8ce
RD
3512
3513 def SetOrientation(*args, **kwargs):
a95a7133 3514 """SetOrientation(self, int orient)"""
54f9ee45 3515 return _core_.ScrollEvent_SetOrientation(*args, **kwargs)
e811c8ce
RD
3516
3517 def SetPosition(*args, **kwargs):
a95a7133 3518 """SetPosition(self, int pos)"""
54f9ee45 3519 return _core_.ScrollEvent_SetPosition(*args, **kwargs)
e811c8ce 3520
d14a1e28
RD
3521
3522class ScrollEventPtr(ScrollEvent):
3523 def __init__(self, this):
3524 self.this = this
3525 if not hasattr(self,"thisown"): self.thisown = 0
3526 self.__class__ = ScrollEvent
54f9ee45 3527_core_.ScrollEvent_swigregister(ScrollEventPtr)
d14a1e28
RD
3528
3529#---------------------------------------------------------------------------
3530
3531class ScrollWinEvent(Event):
093d3ff1 3532 """Proxy of C++ ScrollWinEvent class"""
e811c8ce
RD
3533 def __repr__(self):
3534 return "<%s.%s; proxy of C++ wxScrollWinEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3535 def __init__(self, *args, **kwargs):
a95a7133 3536 """__init__(self, wxEventType commandType=wxEVT_NULL, int pos=0, int orient=0) -> ScrollWinEvent"""
54f9ee45 3537 newobj = _core_.new_ScrollWinEvent(*args, **kwargs)
d14a1e28
RD
3538 self.this = newobj.this
3539 self.thisown = 1
3540 del newobj.thisown
e811c8ce 3541 def GetOrientation(*args, **kwargs):
a95a7133 3542 """GetOrientation(self) -> int"""
54f9ee45 3543 return _core_.ScrollWinEvent_GetOrientation(*args, **kwargs)
e811c8ce
RD
3544
3545 def GetPosition(*args, **kwargs):
a95a7133 3546 """GetPosition(self) -> int"""
54f9ee45 3547 return _core_.ScrollWinEvent_GetPosition(*args, **kwargs)
e811c8ce
RD
3548
3549 def SetOrientation(*args, **kwargs):
a95a7133 3550 """SetOrientation(self, int orient)"""
54f9ee45 3551 return _core_.ScrollWinEvent_SetOrientation(*args, **kwargs)
e811c8ce
RD
3552
3553 def SetPosition(*args, **kwargs):
a95a7133 3554 """SetPosition(self, int pos)"""
54f9ee45 3555 return _core_.ScrollWinEvent_SetPosition(*args, **kwargs)
e811c8ce 3556
d14a1e28
RD
3557
3558class ScrollWinEventPtr(ScrollWinEvent):
3559 def __init__(self, this):
3560 self.this = this
3561 if not hasattr(self,"thisown"): self.thisown = 0
3562 self.__class__ = ScrollWinEvent
54f9ee45 3563_core_.ScrollWinEvent_swigregister(ScrollWinEventPtr)
d14a1e28
RD
3564
3565#---------------------------------------------------------------------------
3566
54f9ee45
RD
3567MOUSE_BTN_ANY = _core_.MOUSE_BTN_ANY
3568MOUSE_BTN_NONE = _core_.MOUSE_BTN_NONE
3569MOUSE_BTN_LEFT = _core_.MOUSE_BTN_LEFT
3570MOUSE_BTN_MIDDLE = _core_.MOUSE_BTN_MIDDLE
3571MOUSE_BTN_RIGHT = _core_.MOUSE_BTN_RIGHT
d14a1e28 3572class MouseEvent(Event):
093d3ff1 3573 """Proxy of C++ MouseEvent class"""
e811c8ce
RD
3574 def __repr__(self):
3575 return "<%s.%s; proxy of C++ wxMouseEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3576 def __init__(self, *args, **kwargs):
a95a7133 3577 """__init__(self, wxEventType mouseType=wxEVT_NULL) -> MouseEvent"""
54f9ee45 3578 newobj = _core_.new_MouseEvent(*args, **kwargs)
d14a1e28
RD
3579 self.this = newobj.this
3580 self.thisown = 1
3581 del newobj.thisown
e811c8ce 3582 def IsButton(*args, **kwargs):
a95a7133 3583 """IsButton(self) -> bool"""
54f9ee45 3584 return _core_.MouseEvent_IsButton(*args, **kwargs)
e811c8ce
RD
3585
3586 def ButtonDown(*args, **kwargs):
a95a7133 3587 """ButtonDown(self, int but=MOUSE_BTN_ANY) -> bool"""
54f9ee45 3588 return _core_.MouseEvent_ButtonDown(*args, **kwargs)
e811c8ce
RD
3589
3590 def ButtonDClick(*args, **kwargs):
a95a7133 3591 """ButtonDClick(self, int but=MOUSE_BTN_ANY) -> bool"""
54f9ee45 3592 return _core_.MouseEvent_ButtonDClick(*args, **kwargs)
e811c8ce
RD
3593
3594 def ButtonUp(*args, **kwargs):
a95a7133 3595 """ButtonUp(self, int but=MOUSE_BTN_ANY) -> bool"""
54f9ee45 3596 return _core_.MouseEvent_ButtonUp(*args, **kwargs)
e811c8ce
RD
3597
3598 def Button(*args, **kwargs):
a95a7133 3599 """Button(self, int but) -> bool"""
54f9ee45 3600 return _core_.MouseEvent_Button(*args, **kwargs)
e811c8ce
RD
3601
3602 def ButtonIsDown(*args, **kwargs):
a95a7133 3603 """ButtonIsDown(self, int but) -> bool"""
54f9ee45 3604 return _core_.MouseEvent_ButtonIsDown(*args, **kwargs)
e811c8ce
RD
3605
3606 def GetButton(*args, **kwargs):
a95a7133 3607 """GetButton(self) -> int"""
54f9ee45 3608 return _core_.MouseEvent_GetButton(*args, **kwargs)
e811c8ce
RD
3609
3610 def ControlDown(*args, **kwargs):
a95a7133 3611 """ControlDown(self) -> bool"""
54f9ee45 3612 return _core_.MouseEvent_ControlDown(*args, **kwargs)
e811c8ce
RD
3613
3614 def MetaDown(*args, **kwargs):
a95a7133 3615 """MetaDown(self) -> bool"""
54f9ee45 3616 return _core_.MouseEvent_MetaDown(*args, **kwargs)
e811c8ce
RD
3617
3618 def AltDown(*args, **kwargs):
a95a7133 3619 """AltDown(self) -> bool"""
54f9ee45 3620 return _core_.MouseEvent_AltDown(*args, **kwargs)
e811c8ce
RD
3621
3622 def ShiftDown(*args, **kwargs):
a95a7133 3623 """ShiftDown(self) -> bool"""
54f9ee45 3624 return _core_.MouseEvent_ShiftDown(*args, **kwargs)
e811c8ce 3625
412d302d
RD
3626 def CmdDown(*args, **kwargs):
3627 """
3628 CmdDown(self) -> bool
3629
3630 "Cmd" is a pseudo key which is the same as Control for PC and Unix
3631 platforms but the special "Apple" (a.k.a as "Command") key on
3632 Macs: it makes often sense to use it instead of, say, `ControlDown`
3633 because Cmd key is used for the same thing under Mac as Ctrl
3634 elsewhere. The Ctrl still exists, it's just not used for this
3635 purpose. So for non-Mac platforms this is the same as `ControlDown`
3636 and Macs this is the same as `MetaDown`.
3637 """
3638 return _core_.MouseEvent_CmdDown(*args, **kwargs)
3639
e811c8ce 3640 def LeftDown(*args, **kwargs):
a95a7133 3641 """LeftDown(self) -> bool"""
54f9ee45 3642 return _core_.MouseEvent_LeftDown(*args, **kwargs)
e811c8ce
RD
3643
3644 def MiddleDown(*args, **kwargs):
a95a7133 3645 """MiddleDown(self) -> bool"""
54f9ee45 3646 return _core_.MouseEvent_MiddleDown(*args, **kwargs)
e811c8ce
RD
3647
3648 def RightDown(*args, **kwargs):
a95a7133 3649 """RightDown(self) -> bool"""
54f9ee45 3650 return _core_.MouseEvent_RightDown(*args, **kwargs)
e811c8ce
RD
3651
3652 def LeftUp(*args, **kwargs):
a95a7133 3653 """LeftUp(self) -> bool"""
54f9ee45 3654 return _core_.MouseEvent_LeftUp(*args, **kwargs)
e811c8ce
RD
3655
3656 def MiddleUp(*args, **kwargs):
a95a7133 3657 """MiddleUp(self) -> bool"""
54f9ee45 3658 return _core_.MouseEvent_MiddleUp(*args, **kwargs)
e811c8ce
RD
3659
3660 def RightUp(*args, **kwargs):
a95a7133 3661 """RightUp(self) -> bool"""
54f9ee45 3662 return _core_.MouseEvent_RightUp(*args, **kwargs)
e811c8ce
RD
3663
3664 def LeftDClick(*args, **kwargs):
a95a7133 3665 """LeftDClick(self) -> bool"""
54f9ee45 3666 return _core_.MouseEvent_LeftDClick(*args, **kwargs)
e811c8ce
RD
3667
3668 def MiddleDClick(*args, **kwargs):
a95a7133 3669 """MiddleDClick(self) -> bool"""
54f9ee45 3670 return _core_.MouseEvent_MiddleDClick(*args, **kwargs)
e811c8ce
RD
3671
3672 def RightDClick(*args, **kwargs):
a95a7133 3673 """RightDClick(self) -> bool"""
54f9ee45 3674 return _core_.MouseEvent_RightDClick(*args, **kwargs)
e811c8ce
RD
3675
3676 def LeftIsDown(*args, **kwargs):
a95a7133 3677 """LeftIsDown(self) -> bool"""
54f9ee45 3678 return _core_.MouseEvent_LeftIsDown(*args, **kwargs)
e811c8ce
RD
3679
3680 def MiddleIsDown(*args, **kwargs):
a95a7133 3681 """MiddleIsDown(self) -> bool"""
54f9ee45 3682 return _core_.MouseEvent_MiddleIsDown(*args, **kwargs)
e811c8ce
RD
3683
3684 def RightIsDown(*args, **kwargs):
a95a7133 3685 """RightIsDown(self) -> bool"""
54f9ee45 3686 return _core_.MouseEvent_RightIsDown(*args, **kwargs)
e811c8ce
RD
3687
3688 def Dragging(*args, **kwargs):
a95a7133 3689 """Dragging(self) -> bool"""
54f9ee45 3690 return _core_.MouseEvent_Dragging(*args, **kwargs)
e811c8ce
RD
3691
3692 def Moving(*args, **kwargs):
a95a7133 3693 """Moving(self) -> bool"""
54f9ee45 3694 return _core_.MouseEvent_Moving(*args, **kwargs)
e811c8ce
RD
3695
3696 def Entering(*args, **kwargs):
a95a7133 3697 """Entering(self) -> bool"""
54f9ee45 3698 return _core_.MouseEvent_Entering(*args, **kwargs)
e811c8ce
RD
3699
3700 def Leaving(*args, **kwargs):
a95a7133 3701 """Leaving(self) -> bool"""
54f9ee45 3702 return _core_.MouseEvent_Leaving(*args, **kwargs)
e811c8ce
RD
3703
3704 def GetPosition(*args, **kwargs):
0df68c9f 3705 """
a95a7133 3706 GetPosition(self) -> Point
e811c8ce 3707
41e2b43e
RD
3708 Returns the position of the mouse in window coordinates when the event
3709 happened.
0df68c9f 3710 """
54f9ee45 3711 return _core_.MouseEvent_GetPosition(*args, **kwargs)
e811c8ce
RD
3712
3713 def GetPositionTuple(*args, **kwargs):
0df68c9f
RD
3714 """
3715 GetPositionTuple() -> (x,y)
e811c8ce 3716
41e2b43e
RD
3717 Returns the position of the mouse in window coordinates when the event
3718 happened.
0df68c9f 3719 """
54f9ee45 3720 return _core_.MouseEvent_GetPositionTuple(*args, **kwargs)
e811c8ce
RD
3721
3722 def GetLogicalPosition(*args, **kwargs):
a95a7133 3723 """GetLogicalPosition(self, DC dc) -> Point"""
54f9ee45 3724 return _core_.MouseEvent_GetLogicalPosition(*args, **kwargs)
e811c8ce
RD
3725
3726 def GetX(*args, **kwargs):
a95a7133 3727 """GetX(self) -> int"""
54f9ee45 3728 return _core_.MouseEvent_GetX(*args, **kwargs)
e811c8ce
RD
3729
3730 def GetY(*args, **kwargs):
a95a7133 3731 """GetY(self) -> int"""
54f9ee45 3732 return _core_.MouseEvent_GetY(*args, **kwargs)
e811c8ce
RD
3733
3734 def GetWheelRotation(*args, **kwargs):
a95a7133 3735 """GetWheelRotation(self) -> int"""
54f9ee45 3736 return _core_.MouseEvent_GetWheelRotation(*args, **kwargs)
e811c8ce
RD
3737
3738 def GetWheelDelta(*args, **kwargs):
a95a7133 3739 """GetWheelDelta(self) -> int"""
54f9ee45 3740 return _core_.MouseEvent_GetWheelDelta(*args, **kwargs)
e811c8ce
RD
3741
3742 def GetLinesPerAction(*args, **kwargs):
a95a7133 3743 """GetLinesPerAction(self) -> int"""
54f9ee45 3744 return _core_.MouseEvent_GetLinesPerAction(*args, **kwargs)
e811c8ce
RD
3745
3746 def IsPageScroll(*args, **kwargs):
a95a7133 3747 """IsPageScroll(self) -> bool"""
54f9ee45
RD
3748 return _core_.MouseEvent_IsPageScroll(*args, **kwargs)
3749
3750 m_x = property(_core_.MouseEvent_m_x_get, _core_.MouseEvent_m_x_set)
3751 m_y = property(_core_.MouseEvent_m_y_get, _core_.MouseEvent_m_y_set)
3752 m_leftDown = property(_core_.MouseEvent_m_leftDown_get, _core_.MouseEvent_m_leftDown_set)
3753 m_middleDown = property(_core_.MouseEvent_m_middleDown_get, _core_.MouseEvent_m_middleDown_set)
3754 m_rightDown = property(_core_.MouseEvent_m_rightDown_get, _core_.MouseEvent_m_rightDown_set)
3755 m_controlDown = property(_core_.MouseEvent_m_controlDown_get, _core_.MouseEvent_m_controlDown_set)
3756 m_shiftDown = property(_core_.MouseEvent_m_shiftDown_get, _core_.MouseEvent_m_shiftDown_set)
3757 m_altDown = property(_core_.MouseEvent_m_altDown_get, _core_.MouseEvent_m_altDown_set)
3758 m_metaDown = property(_core_.MouseEvent_m_metaDown_get, _core_.MouseEvent_m_metaDown_set)
3759 m_wheelRotation = property(_core_.MouseEvent_m_wheelRotation_get, _core_.MouseEvent_m_wheelRotation_set)
3760 m_wheelDelta = property(_core_.MouseEvent_m_wheelDelta_get, _core_.MouseEvent_m_wheelDelta_set)
3761 m_linesPerAction = property(_core_.MouseEvent_m_linesPerAction_get, _core_.MouseEvent_m_linesPerAction_set)
d14a1e28
RD
3762
3763class MouseEventPtr(MouseEvent):
3764 def __init__(self, this):
3765 self.this = this
3766 if not hasattr(self,"thisown"): self.thisown = 0
3767 self.__class__ = MouseEvent
54f9ee45 3768_core_.MouseEvent_swigregister(MouseEventPtr)
d14a1e28
RD
3769
3770#---------------------------------------------------------------------------
3771
3772class SetCursorEvent(Event):
093d3ff1 3773 """Proxy of C++ SetCursorEvent class"""
e811c8ce
RD
3774 def __repr__(self):
3775 return "<%s.%s; proxy of C++ wxSetCursorEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3776 def __init__(self, *args, **kwargs):
a95a7133 3777 """__init__(self, int x=0, int y=0) -> SetCursorEvent"""
54f9ee45 3778 newobj = _core_.new_SetCursorEvent(*args, **kwargs)
d14a1e28
RD
3779 self.this = newobj.this
3780 self.thisown = 1
3781 del newobj.thisown
e811c8ce 3782 def GetX(*args, **kwargs):
a95a7133 3783 """GetX(self) -> int"""
54f9ee45 3784 return _core_.SetCursorEvent_GetX(*args, **kwargs)
e811c8ce
RD
3785
3786 def GetY(*args, **kwargs):
a95a7133 3787 """GetY(self) -> int"""
54f9ee45 3788 return _core_.SetCursorEvent_GetY(*args, **kwargs)
e811c8ce
RD
3789
3790 def SetCursor(*args, **kwargs):
a95a7133 3791 """SetCursor(self, Cursor cursor)"""
54f9ee45 3792 return _core_.SetCursorEvent_SetCursor(*args, **kwargs)
e811c8ce
RD
3793
3794 def GetCursor(*args, **kwargs):
a95a7133 3795 """GetCursor(self) -> Cursor"""
54f9ee45 3796 return _core_.SetCursorEvent_GetCursor(*args, **kwargs)
e811c8ce
RD
3797
3798 def HasCursor(*args, **kwargs):
a95a7133 3799 """HasCursor(self) -> bool"""
54f9ee45 3800 return _core_.SetCursorEvent_HasCursor(*args, **kwargs)
e811c8ce 3801
d14a1e28
RD
3802
3803class SetCursorEventPtr(SetCursorEvent):
3804 def __init__(self, this):
3805 self.this = this
3806 if not hasattr(self,"thisown"): self.thisown = 0
3807 self.__class__ = SetCursorEvent
54f9ee45 3808_core_.SetCursorEvent_swigregister(SetCursorEventPtr)
d14a1e28
RD
3809
3810#---------------------------------------------------------------------------
3811
3812class KeyEvent(Event):
093d3ff1 3813 """Proxy of C++ KeyEvent class"""
e811c8ce
RD
3814 def __repr__(self):
3815 return "<%s.%s; proxy of C++ wxKeyEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3816 def __init__(self, *args, **kwargs):
a95a7133 3817 """__init__(self, wxEventType keyType=wxEVT_NULL) -> KeyEvent"""
54f9ee45 3818 newobj = _core_.new_KeyEvent(*args, **kwargs)
d14a1e28
RD
3819 self.this = newobj.this
3820 self.thisown = 1
3821 del newobj.thisown
e811c8ce 3822 def ControlDown(*args, **kwargs):
a95a7133 3823 """ControlDown(self) -> bool"""
54f9ee45 3824 return _core_.KeyEvent_ControlDown(*args, **kwargs)
e811c8ce
RD
3825
3826 def MetaDown(*args, **kwargs):
a95a7133 3827 """MetaDown(self) -> bool"""
54f9ee45 3828 return _core_.KeyEvent_MetaDown(*args, **kwargs)
e811c8ce
RD
3829
3830 def AltDown(*args, **kwargs):
a95a7133 3831 """AltDown(self) -> bool"""
54f9ee45 3832 return _core_.KeyEvent_AltDown(*args, **kwargs)
e811c8ce
RD
3833
3834 def ShiftDown(*args, **kwargs):
a95a7133 3835 """ShiftDown(self) -> bool"""
54f9ee45 3836 return _core_.KeyEvent_ShiftDown(*args, **kwargs)
e811c8ce 3837
412d302d
RD
3838 def CmdDown(*args, **kwargs):
3839 """
3840 CmdDown(self) -> bool
3841
3842 "Cmd" is a pseudo key which is the same as Control for PC and Unix
3843 platforms but the special "Apple" (a.k.a as "Command") key on
3844 Macs: it makes often sense to use it instead of, say, `ControlDown`
3845 because Cmd key is used for the same thing under Mac as Ctrl
3846 elsewhere. The Ctrl still exists, it's just not used for this
3847 purpose. So for non-Mac platforms this is the same as `ControlDown`
3848 and Macs this is the same as `MetaDown`.
3849 """
3850 return _core_.KeyEvent_CmdDown(*args, **kwargs)
3851
e811c8ce 3852 def HasModifiers(*args, **kwargs):
a95a7133 3853 """HasModifiers(self) -> bool"""
54f9ee45 3854 return _core_.KeyEvent_HasModifiers(*args, **kwargs)
e811c8ce
RD
3855
3856 def GetKeyCode(*args, **kwargs):
a95a7133 3857 """GetKeyCode(self) -> int"""
54f9ee45 3858 return _core_.KeyEvent_GetKeyCode(*args, **kwargs)
e811c8ce 3859
d14a1e28 3860 KeyCode = GetKeyCode
19272049
RD
3861 def GetUnicodeKey(*args, **kwargs):
3862 """GetUnicodeKey(self) -> int"""
3863 return _core_.KeyEvent_GetUnicodeKey(*args, **kwargs)
e811c8ce 3864
19272049 3865 GetUniChar = GetUnicodeKey
e811c8ce 3866 def GetRawKeyCode(*args, **kwargs):
a95a7133 3867 """GetRawKeyCode(self) -> unsigned int"""
54f9ee45 3868 return _core_.KeyEvent_GetRawKeyCode(*args, **kwargs)
e811c8ce
RD
3869
3870 def GetRawKeyFlags(*args, **kwargs):
a95a7133 3871 """GetRawKeyFlags(self) -> unsigned int"""
54f9ee45 3872 return _core_.KeyEvent_GetRawKeyFlags(*args, **kwargs)
e811c8ce
RD
3873
3874 def GetPosition(*args, **kwargs):
0df68c9f 3875 """
a95a7133 3876 GetPosition(self) -> Point
e811c8ce 3877
0df68c9f
RD
3878 Find the position of the event.
3879 """
54f9ee45 3880 return _core_.KeyEvent_GetPosition(*args, **kwargs)
e811c8ce
RD
3881
3882 def GetPositionTuple(*args, **kwargs):
0df68c9f
RD
3883 """
3884 GetPositionTuple() -> (x,y)
e811c8ce 3885
0df68c9f
RD
3886 Find the position of the event.
3887 """
54f9ee45 3888 return _core_.KeyEvent_GetPositionTuple(*args, **kwargs)
e811c8ce
RD
3889
3890 def GetX(*args, **kwargs):
a95a7133 3891 """GetX(self) -> int"""
54f9ee45 3892 return _core_.KeyEvent_GetX(*args, **kwargs)
e811c8ce
RD
3893
3894 def GetY(*args, **kwargs):
a95a7133 3895 """GetY(self) -> int"""
54f9ee45
RD
3896 return _core_.KeyEvent_GetY(*args, **kwargs)
3897
3898 m_x = property(_core_.KeyEvent_m_x_get, _core_.KeyEvent_m_x_set)
3899 m_y = property(_core_.KeyEvent_m_y_get, _core_.KeyEvent_m_y_set)
3900 m_keyCode = property(_core_.KeyEvent_m_keyCode_get, _core_.KeyEvent_m_keyCode_set)
3901 m_controlDown = property(_core_.KeyEvent_m_controlDown_get, _core_.KeyEvent_m_controlDown_set)
3902 m_shiftDown = property(_core_.KeyEvent_m_shiftDown_get, _core_.KeyEvent_m_shiftDown_set)
3903 m_altDown = property(_core_.KeyEvent_m_altDown_get, _core_.KeyEvent_m_altDown_set)
3904 m_metaDown = property(_core_.KeyEvent_m_metaDown_get, _core_.KeyEvent_m_metaDown_set)
3905 m_scanCode = property(_core_.KeyEvent_m_scanCode_get, _core_.KeyEvent_m_scanCode_set)
3906 m_rawCode = property(_core_.KeyEvent_m_rawCode_get, _core_.KeyEvent_m_rawCode_set)
3907 m_rawFlags = property(_core_.KeyEvent_m_rawFlags_get, _core_.KeyEvent_m_rawFlags_set)
d14a1e28
RD
3908
3909class KeyEventPtr(KeyEvent):
3910 def __init__(self, this):
3911 self.this = this
3912 if not hasattr(self,"thisown"): self.thisown = 0
3913 self.__class__ = KeyEvent
54f9ee45 3914_core_.KeyEvent_swigregister(KeyEventPtr)
d14a1e28
RD
3915
3916#---------------------------------------------------------------------------
3917
3918class SizeEvent(Event):
093d3ff1 3919 """Proxy of C++ SizeEvent class"""
e811c8ce
RD
3920 def __repr__(self):
3921 return "<%s.%s; proxy of C++ wxSizeEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3922 def __init__(self, *args, **kwargs):
a95a7133 3923 """__init__(self, Size sz=DefaultSize, int winid=0) -> SizeEvent"""
54f9ee45 3924 newobj = _core_.new_SizeEvent(*args, **kwargs)
d14a1e28
RD
3925 self.this = newobj.this
3926 self.thisown = 1
3927 del newobj.thisown
e811c8ce 3928 def GetSize(*args, **kwargs):
a95a7133 3929 """GetSize(self) -> Size"""
54f9ee45 3930 return _core_.SizeEvent_GetSize(*args, **kwargs)
e811c8ce
RD
3931
3932 def GetRect(*args, **kwargs):
a95a7133 3933 """GetRect(self) -> Rect"""
54f9ee45 3934 return _core_.SizeEvent_GetRect(*args, **kwargs)
e811c8ce
RD
3935
3936 def SetRect(*args, **kwargs):
a95a7133 3937 """SetRect(self, Rect rect)"""
54f9ee45 3938 return _core_.SizeEvent_SetRect(*args, **kwargs)
e811c8ce
RD
3939
3940 def SetSize(*args, **kwargs):
a95a7133 3941 """SetSize(self, Size size)"""
54f9ee45 3942 return _core_.SizeEvent_SetSize(*args, **kwargs)
e811c8ce 3943
54f9ee45
RD
3944 m_size = property(_core_.SizeEvent_m_size_get, _core_.SizeEvent_m_size_set)
3945 m_rect = property(_core_.SizeEvent_m_rect_get, _core_.SizeEvent_m_rect_set)
d14a1e28
RD
3946
3947class SizeEventPtr(SizeEvent):
3948 def __init__(self, this):
3949 self.this = this
3950 if not hasattr(self,"thisown"): self.thisown = 0
3951 self.__class__ = SizeEvent
54f9ee45 3952_core_.SizeEvent_swigregister(SizeEventPtr)
d14a1e28
RD
3953
3954#---------------------------------------------------------------------------
3955
3956class MoveEvent(Event):
093d3ff1 3957 """Proxy of C++ MoveEvent class"""
e811c8ce
RD
3958 def __repr__(self):
3959 return "<%s.%s; proxy of C++ wxMoveEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3960 def __init__(self, *args, **kwargs):
a95a7133 3961 """__init__(self, Point pos=DefaultPosition, int winid=0) -> MoveEvent"""
54f9ee45 3962 newobj = _core_.new_MoveEvent(*args, **kwargs)
d14a1e28
RD
3963 self.this = newobj.this
3964 self.thisown = 1
3965 del newobj.thisown
e811c8ce 3966 def GetPosition(*args, **kwargs):
a95a7133 3967 """GetPosition(self) -> Point"""
54f9ee45 3968 return _core_.MoveEvent_GetPosition(*args, **kwargs)
e811c8ce
RD
3969
3970 def GetRect(*args, **kwargs):
a95a7133 3971 """GetRect(self) -> Rect"""
54f9ee45 3972 return _core_.MoveEvent_GetRect(*args, **kwargs)
e811c8ce
RD
3973
3974 def SetRect(*args, **kwargs):
a95a7133 3975 """SetRect(self, Rect rect)"""
54f9ee45 3976 return _core_.MoveEvent_SetRect(*args, **kwargs)
e811c8ce
RD
3977
3978 def SetPosition(*args, **kwargs):
a95a7133 3979 """SetPosition(self, Point pos)"""
54f9ee45 3980 return _core_.MoveEvent_SetPosition(*args, **kwargs)
e811c8ce 3981
7557b9b5
RD
3982 m_pos = property(GetPosition, SetPosition)
3983 m_rect = property(GetRect, SetRect)
3984
d14a1e28
RD
3985
3986class MoveEventPtr(MoveEvent):
3987 def __init__(self, this):
3988 self.this = this
3989 if not hasattr(self,"thisown"): self.thisown = 0
3990 self.__class__ = MoveEvent
54f9ee45 3991_core_.MoveEvent_swigregister(MoveEventPtr)
d14a1e28
RD
3992
3993#---------------------------------------------------------------------------
3994
3995class PaintEvent(Event):
093d3ff1 3996 """Proxy of C++ PaintEvent class"""
e811c8ce
RD
3997 def __repr__(self):
3998 return "<%s.%s; proxy of C++ wxPaintEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3999 def __init__(self, *args, **kwargs):
a95a7133 4000 """__init__(self, int Id=0) -> PaintEvent"""
54f9ee45 4001 newobj = _core_.new_PaintEvent(*args, **kwargs)
d14a1e28
RD
4002 self.this = newobj.this
4003 self.thisown = 1
4004 del newobj.thisown
d14a1e28
RD
4005
4006class PaintEventPtr(PaintEvent):
4007 def __init__(self, this):
4008 self.this = this
4009 if not hasattr(self,"thisown"): self.thisown = 0
4010 self.__class__ = PaintEvent
54f9ee45 4011_core_.PaintEvent_swigregister(PaintEventPtr)
d14a1e28
RD
4012
4013class NcPaintEvent(Event):
093d3ff1 4014 """Proxy of C++ NcPaintEvent class"""
e811c8ce
RD
4015 def __repr__(self):
4016 return "<%s.%s; proxy of C++ wxNcPaintEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4017 def __init__(self, *args, **kwargs):
a95a7133 4018 """__init__(self, int winid=0) -> NcPaintEvent"""
54f9ee45 4019 newobj = _core_.new_NcPaintEvent(*args, **kwargs)
d14a1e28
RD
4020 self.this = newobj.this
4021 self.thisown = 1
4022 del newobj.thisown
d14a1e28
RD
4023
4024class NcPaintEventPtr(NcPaintEvent):
4025 def __init__(self, this):
4026 self.this = this
4027 if not hasattr(self,"thisown"): self.thisown = 0
4028 self.__class__ = NcPaintEvent
54f9ee45 4029_core_.NcPaintEvent_swigregister(NcPaintEventPtr)
d14a1e28
RD
4030
4031#---------------------------------------------------------------------------
4032
4033class EraseEvent(Event):
093d3ff1 4034 """Proxy of C++ EraseEvent class"""
e811c8ce
RD
4035 def __repr__(self):
4036 return "<%s.%s; proxy of C++ wxEraseEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4037 def __init__(self, *args, **kwargs):
a95a7133 4038 """__init__(self, int Id=0, DC dc=(wxDC *) NULL) -> EraseEvent"""
54f9ee45 4039 newobj = _core_.new_EraseEvent(*args, **kwargs)
d14a1e28
RD
4040 self.this = newobj.this
4041 self.thisown = 1
4042 del newobj.thisown
e811c8ce 4043 def GetDC(*args, **kwargs):
a95a7133 4044 """GetDC(self) -> DC"""
54f9ee45 4045 return _core_.EraseEvent_GetDC(*args, **kwargs)
e811c8ce 4046
d14a1e28
RD
4047
4048class EraseEventPtr(EraseEvent):
4049 def __init__(self, this):
4050 self.this = this
4051 if not hasattr(self,"thisown"): self.thisown = 0
4052 self.__class__ = EraseEvent
54f9ee45 4053_core_.EraseEvent_swigregister(EraseEventPtr)
d14a1e28
RD
4054
4055#---------------------------------------------------------------------------
4056
4057class FocusEvent(Event):
093d3ff1 4058 """Proxy of C++ FocusEvent class"""
e811c8ce
RD
4059 def __repr__(self):
4060 return "<%s.%s; proxy of C++ wxFocusEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4061 def __init__(self, *args, **kwargs):
a95a7133 4062 """__init__(self, wxEventType type=wxEVT_NULL, int winid=0) -> FocusEvent"""
54f9ee45 4063 newobj = _core_.new_FocusEvent(*args, **kwargs)
d14a1e28
RD
4064 self.this = newobj.this
4065 self.thisown = 1
4066 del newobj.thisown
e811c8ce 4067 def GetWindow(*args, **kwargs):
a95a7133 4068 """GetWindow(self) -> Window"""
54f9ee45 4069 return _core_.FocusEvent_GetWindow(*args, **kwargs)
e811c8ce
RD
4070
4071 def SetWindow(*args, **kwargs):
a95a7133 4072 """SetWindow(self, Window win)"""
54f9ee45 4073 return _core_.FocusEvent_SetWindow(*args, **kwargs)
e811c8ce 4074
d14a1e28
RD
4075
4076class FocusEventPtr(FocusEvent):
4077 def __init__(self, this):
4078 self.this = this
4079 if not hasattr(self,"thisown"): self.thisown = 0
4080 self.__class__ = FocusEvent
54f9ee45 4081_core_.FocusEvent_swigregister(FocusEventPtr)
d14a1e28
RD
4082
4083#---------------------------------------------------------------------------
4084
4085class ChildFocusEvent(CommandEvent):
093d3ff1 4086 """Proxy of C++ ChildFocusEvent class"""
e811c8ce
RD
4087 def __repr__(self):
4088 return "<%s.%s; proxy of C++ wxChildFocusEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4089 def __init__(self, *args, **kwargs):
a95a7133 4090 """__init__(self, Window win=None) -> ChildFocusEvent"""
54f9ee45 4091 newobj = _core_.new_ChildFocusEvent(*args, **kwargs)
d14a1e28
RD
4092 self.this = newobj.this
4093 self.thisown = 1
4094 del newobj.thisown
e811c8ce 4095 def GetWindow(*args, **kwargs):
a95a7133 4096 """GetWindow(self) -> Window"""
54f9ee45 4097 return _core_.ChildFocusEvent_GetWindow(*args, **kwargs)
e811c8ce 4098
d14a1e28
RD
4099
4100class ChildFocusEventPtr(ChildFocusEvent):
4101 def __init__(self, this):
4102 self.this = this
4103 if not hasattr(self,"thisown"): self.thisown = 0
4104 self.__class__ = ChildFocusEvent
54f9ee45 4105_core_.ChildFocusEvent_swigregister(ChildFocusEventPtr)
d14a1e28
RD
4106
4107#---------------------------------------------------------------------------
4108
4109class ActivateEvent(Event):
093d3ff1 4110 """Proxy of C++ ActivateEvent class"""
e811c8ce
RD
4111 def __repr__(self):
4112 return "<%s.%s; proxy of C++ wxActivateEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4113 def __init__(self, *args, **kwargs):
a95a7133 4114 """__init__(self, wxEventType type=wxEVT_NULL, bool active=True, int Id=0) -> ActivateEvent"""
54f9ee45 4115 newobj = _core_.new_ActivateEvent(*args, **kwargs)
d14a1e28
RD
4116 self.this = newobj.this
4117 self.thisown = 1
4118 del newobj.thisown
e811c8ce 4119 def GetActive(*args, **kwargs):
a95a7133 4120 """GetActive(self) -> bool"""
54f9ee45 4121 return _core_.ActivateEvent_GetActive(*args, **kwargs)
e811c8ce 4122
d14a1e28
RD
4123
4124class ActivateEventPtr(ActivateEvent):
4125 def __init__(self, this):
4126 self.this = this
4127 if not hasattr(self,"thisown"): self.thisown = 0
4128 self.__class__ = ActivateEvent
54f9ee45 4129_core_.ActivateEvent_swigregister(ActivateEventPtr)
d14a1e28
RD
4130
4131#---------------------------------------------------------------------------
4132
4133class InitDialogEvent(Event):
093d3ff1 4134 """Proxy of C++ InitDialogEvent class"""
e811c8ce
RD
4135 def __repr__(self):
4136 return "<%s.%s; proxy of C++ wxInitDialogEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4137 def __init__(self, *args, **kwargs):
a95a7133 4138 """__init__(self, int Id=0) -> InitDialogEvent"""
54f9ee45 4139 newobj = _core_.new_InitDialogEvent(*args, **kwargs)
d14a1e28
RD
4140 self.this = newobj.this
4141 self.thisown = 1
4142 del newobj.thisown
d14a1e28
RD
4143
4144class InitDialogEventPtr(InitDialogEvent):
4145 def __init__(self, this):
4146 self.this = this
4147 if not hasattr(self,"thisown"): self.thisown = 0
4148 self.__class__ = InitDialogEvent
54f9ee45 4149_core_.InitDialogEvent_swigregister(InitDialogEventPtr)
d14a1e28
RD
4150
4151#---------------------------------------------------------------------------
4152
4153class MenuEvent(Event):
093d3ff1 4154 """Proxy of C++ MenuEvent class"""
e811c8ce
RD
4155 def __repr__(self):
4156 return "<%s.%s; proxy of C++ wxMenuEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4157 def __init__(self, *args, **kwargs):
a95a7133 4158 """__init__(self, wxEventType type=wxEVT_NULL, int winid=0, Menu menu=None) -> MenuEvent"""
54f9ee45 4159 newobj = _core_.new_MenuEvent(*args, **kwargs)
d14a1e28
RD
4160 self.this = newobj.this
4161 self.thisown = 1
4162 del newobj.thisown
e811c8ce 4163 def GetMenuId(*args, **kwargs):
a95a7133 4164 """GetMenuId(self) -> int"""
54f9ee45 4165 return _core_.MenuEvent_GetMenuId(*args, **kwargs)
e811c8ce
RD
4166
4167 def IsPopup(*args, **kwargs):
a95a7133 4168 """IsPopup(self) -> bool"""
54f9ee45 4169 return _core_.MenuEvent_IsPopup(*args, **kwargs)
e811c8ce
RD
4170
4171 def GetMenu(*args, **kwargs):
a95a7133 4172 """GetMenu(self) -> Menu"""
54f9ee45 4173 return _core_.MenuEvent_GetMenu(*args, **kwargs)
e811c8ce 4174
d14a1e28
RD
4175
4176class MenuEventPtr(MenuEvent):
4177 def __init__(self, this):
4178 self.this = this
4179 if not hasattr(self,"thisown"): self.thisown = 0
4180 self.__class__ = MenuEvent
54f9ee45 4181_core_.MenuEvent_swigregister(MenuEventPtr)
d14a1e28
RD
4182
4183#---------------------------------------------------------------------------
4184
4185class CloseEvent(Event):
093d3ff1 4186 """Proxy of C++ CloseEvent class"""
e811c8ce
RD
4187 def __repr__(self):
4188 return "<%s.%s; proxy of C++ wxCloseEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4189 def __init__(self, *args, **kwargs):
a95a7133 4190 """__init__(self, wxEventType type=wxEVT_NULL, int winid=0) -> CloseEvent"""
54f9ee45 4191 newobj = _core_.new_CloseEvent(*args, **kwargs)
d14a1e28
RD
4192 self.this = newobj.this
4193 self.thisown = 1
4194 del newobj.thisown
e811c8ce 4195 def SetLoggingOff(*args, **kwargs):
a95a7133 4196 """SetLoggingOff(self, bool logOff)"""
54f9ee45 4197 return _core_.CloseEvent_SetLoggingOff(*args, **kwargs)
e811c8ce
RD
4198
4199 def GetLoggingOff(*args, **kwargs):
a95a7133 4200 """GetLoggingOff(self) -> bool"""
54f9ee45 4201 return _core_.CloseEvent_GetLoggingOff(*args, **kwargs)
e811c8ce
RD
4202
4203 def Veto(*args, **kwargs):
a95a7133 4204 """Veto(self, bool veto=True)"""
54f9ee45 4205 return _core_.CloseEvent_Veto(*args, **kwargs)
e811c8ce
RD
4206
4207 def SetCanVeto(*args, **kwargs):
a95a7133 4208 """SetCanVeto(self, bool canVeto)"""
54f9ee45 4209 return _core_.CloseEvent_SetCanVeto(*args, **kwargs)
e811c8ce
RD
4210
4211 def CanVeto(*args, **kwargs):
a95a7133 4212 """CanVeto(self) -> bool"""
54f9ee45 4213 return _core_.CloseEvent_CanVeto(*args, **kwargs)
e811c8ce
RD
4214
4215 def GetVeto(*args, **kwargs):
a95a7133 4216 """GetVeto(self) -> bool"""
54f9ee45 4217 return _core_.CloseEvent_GetVeto(*args, **kwargs)
e811c8ce 4218
d14a1e28
RD
4219
4220class CloseEventPtr(CloseEvent):
4221 def __init__(self, this):
4222 self.this = this
4223 if not hasattr(self,"thisown"): self.thisown = 0
4224 self.__class__ = CloseEvent
54f9ee45 4225_core_.CloseEvent_swigregister(CloseEventPtr)
d14a1e28
RD
4226
4227#---------------------------------------------------------------------------
4228
4229class ShowEvent(Event):
093d3ff1 4230 """Proxy of C++ ShowEvent class"""
e811c8ce
RD
4231 def __repr__(self):
4232 return "<%s.%s; proxy of C++ wxShowEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4233 def __init__(self, *args, **kwargs):
a95a7133 4234 """__init__(self, int winid=0, bool show=False) -> ShowEvent"""
54f9ee45 4235 newobj = _core_.new_ShowEvent(*args, **kwargs)
d14a1e28
RD
4236 self.this = newobj.this
4237 self.thisown = 1
4238 del newobj.thisown
e811c8ce 4239 def SetShow(*args, **kwargs):
a95a7133 4240 """SetShow(self, bool show)"""
54f9ee45 4241 return _core_.ShowEvent_SetShow(*args, **kwargs)
e811c8ce
RD
4242
4243 def GetShow(*args, **kwargs):
a95a7133 4244 """GetShow(self) -> bool"""
54f9ee45 4245 return _core_.ShowEvent_GetShow(*args, **kwargs)
e811c8ce 4246
d14a1e28
RD
4247
4248class ShowEventPtr(ShowEvent):
4249 def __init__(self, this):
4250 self.this = this
4251 if not hasattr(self,"thisown"): self.thisown = 0
4252 self.__class__ = ShowEvent
54f9ee45 4253_core_.ShowEvent_swigregister(ShowEventPtr)
d14a1e28
RD
4254
4255#---------------------------------------------------------------------------
4256
4257class IconizeEvent(Event):
093d3ff1 4258 """Proxy of C++ IconizeEvent class"""
e811c8ce
RD
4259 def __repr__(self):
4260 return "<%s.%s; proxy of C++ wxIconizeEvent 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, bool iconized=True) -> IconizeEvent"""
54f9ee45 4263 newobj = _core_.new_IconizeEvent(*args, **kwargs)
d14a1e28
RD
4264 self.this = newobj.this
4265 self.thisown = 1
4266 del newobj.thisown
e811c8ce 4267 def Iconized(*args, **kwargs):
a95a7133 4268 """Iconized(self) -> bool"""
54f9ee45 4269 return _core_.IconizeEvent_Iconized(*args, **kwargs)
e811c8ce 4270
d14a1e28
RD
4271
4272class IconizeEventPtr(IconizeEvent):
4273 def __init__(self, this):
4274 self.this = this
4275 if not hasattr(self,"thisown"): self.thisown = 0
4276 self.__class__ = IconizeEvent
54f9ee45 4277_core_.IconizeEvent_swigregister(IconizeEventPtr)
d14a1e28
RD
4278
4279#---------------------------------------------------------------------------
4280
4281class MaximizeEvent(Event):
093d3ff1 4282 """Proxy of C++ MaximizeEvent class"""
e811c8ce
RD
4283 def __repr__(self):
4284 return "<%s.%s; proxy of C++ wxMaximizeEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4285 def __init__(self, *args, **kwargs):
a95a7133 4286 """__init__(self, int id=0) -> MaximizeEvent"""
54f9ee45 4287 newobj = _core_.new_MaximizeEvent(*args, **kwargs)
d14a1e28
RD
4288 self.this = newobj.this
4289 self.thisown = 1
4290 del newobj.thisown
d14a1e28
RD
4291
4292class MaximizeEventPtr(MaximizeEvent):
4293 def __init__(self, this):
4294 self.this = this
4295 if not hasattr(self,"thisown"): self.thisown = 0
4296 self.__class__ = MaximizeEvent
54f9ee45 4297_core_.MaximizeEvent_swigregister(MaximizeEventPtr)
d14a1e28
RD
4298
4299#---------------------------------------------------------------------------
4300
4301class DropFilesEvent(Event):
093d3ff1 4302 """Proxy of C++ DropFilesEvent class"""
d14a1e28
RD
4303 def __init__(self): raise RuntimeError, "No constructor defined"
4304 def __repr__(self):
4305 return "<%s.%s; proxy of C++ wxDropFilesEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
e811c8ce 4306 def GetPosition(*args, **kwargs):
a95a7133 4307 """GetPosition(self) -> Point"""
54f9ee45 4308 return _core_.DropFilesEvent_GetPosition(*args, **kwargs)
e811c8ce
RD
4309
4310 def GetNumberOfFiles(*args, **kwargs):
a95a7133 4311 """GetNumberOfFiles(self) -> int"""
54f9ee45 4312 return _core_.DropFilesEvent_GetNumberOfFiles(*args, **kwargs)
e811c8ce
RD
4313
4314 def GetFiles(*args, **kwargs):
a95a7133 4315 """GetFiles(self) -> PyObject"""
54f9ee45 4316 return _core_.DropFilesEvent_GetFiles(*args, **kwargs)
e811c8ce 4317
d14a1e28
RD
4318
4319class DropFilesEventPtr(DropFilesEvent):
4320 def __init__(self, this):
4321 self.this = this
4322 if not hasattr(self,"thisown"): self.thisown = 0
4323 self.__class__ = DropFilesEvent
54f9ee45 4324_core_.DropFilesEvent_swigregister(DropFilesEventPtr)
d14a1e28
RD
4325
4326#---------------------------------------------------------------------------
4327
54f9ee45
RD
4328UPDATE_UI_PROCESS_ALL = _core_.UPDATE_UI_PROCESS_ALL
4329UPDATE_UI_PROCESS_SPECIFIED = _core_.UPDATE_UI_PROCESS_SPECIFIED
d14a1e28 4330class UpdateUIEvent(CommandEvent):
093d3ff1 4331 """Proxy of C++ UpdateUIEvent class"""
e811c8ce
RD
4332 def __repr__(self):
4333 return "<%s.%s; proxy of C++ wxUpdateUIEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4334 def __init__(self, *args, **kwargs):
a95a7133 4335 """__init__(self, int commandId=0) -> UpdateUIEvent"""
54f9ee45 4336 newobj = _core_.new_UpdateUIEvent(*args, **kwargs)
d14a1e28
RD
4337 self.this = newobj.this
4338 self.thisown = 1
4339 del newobj.thisown
e811c8ce 4340 def GetChecked(*args, **kwargs):
a95a7133 4341 """GetChecked(self) -> bool"""
54f9ee45 4342 return _core_.UpdateUIEvent_GetChecked(*args, **kwargs)
e811c8ce
RD
4343
4344 def GetEnabled(*args, **kwargs):
a95a7133 4345 """GetEnabled(self) -> bool"""
54f9ee45 4346 return _core_.UpdateUIEvent_GetEnabled(*args, **kwargs)
e811c8ce
RD
4347
4348 def GetText(*args, **kwargs):
a95a7133 4349 """GetText(self) -> String"""
54f9ee45 4350 return _core_.UpdateUIEvent_GetText(*args, **kwargs)
e811c8ce
RD
4351
4352 def GetSetText(*args, **kwargs):
a95a7133 4353 """GetSetText(self) -> bool"""
54f9ee45 4354 return _core_.UpdateUIEvent_GetSetText(*args, **kwargs)
e811c8ce
RD
4355
4356 def GetSetChecked(*args, **kwargs):
a95a7133 4357 """GetSetChecked(self) -> bool"""
54f9ee45 4358 return _core_.UpdateUIEvent_GetSetChecked(*args, **kwargs)
e811c8ce
RD
4359
4360 def GetSetEnabled(*args, **kwargs):
a95a7133 4361 """GetSetEnabled(self) -> bool"""
54f9ee45 4362 return _core_.UpdateUIEvent_GetSetEnabled(*args, **kwargs)
e811c8ce
RD
4363
4364 def Check(*args, **kwargs):
a95a7133 4365 """Check(self, bool check)"""
54f9ee45 4366 return _core_.UpdateUIEvent_Check(*args, **kwargs)
e811c8ce
RD
4367
4368 def Enable(*args, **kwargs):
a95a7133 4369 """Enable(self, bool enable)"""
54f9ee45 4370 return _core_.UpdateUIEvent_Enable(*args, **kwargs)
e811c8ce
RD
4371
4372 def SetText(*args, **kwargs):
a95a7133 4373 """SetText(self, String text)"""
54f9ee45 4374 return _core_.UpdateUIEvent_SetText(*args, **kwargs)
e811c8ce
RD
4375
4376 def SetUpdateInterval(*args, **kwargs):
66c033b4 4377 """SetUpdateInterval(long updateInterval)"""
54f9ee45 4378 return _core_.UpdateUIEvent_SetUpdateInterval(*args, **kwargs)
e811c8ce
RD
4379
4380 SetUpdateInterval = staticmethod(SetUpdateInterval)
4381 def GetUpdateInterval(*args, **kwargs):
66c033b4 4382 """GetUpdateInterval() -> long"""
54f9ee45 4383 return _core_.UpdateUIEvent_GetUpdateInterval(*args, **kwargs)
e811c8ce
RD
4384
4385 GetUpdateInterval = staticmethod(GetUpdateInterval)
4386 def CanUpdate(*args, **kwargs):
66c033b4 4387 """CanUpdate(Window win) -> bool"""
54f9ee45 4388 return _core_.UpdateUIEvent_CanUpdate(*args, **kwargs)
e811c8ce
RD
4389
4390 CanUpdate = staticmethod(CanUpdate)
4391 def ResetUpdateTime(*args, **kwargs):
66c033b4 4392 """ResetUpdateTime()"""
54f9ee45 4393 return _core_.UpdateUIEvent_ResetUpdateTime(*args, **kwargs)
e811c8ce
RD
4394
4395 ResetUpdateTime = staticmethod(ResetUpdateTime)
4396 def SetMode(*args, **kwargs):
66c033b4 4397 """SetMode(int mode)"""
54f9ee45 4398 return _core_.UpdateUIEvent_SetMode(*args, **kwargs)
e811c8ce
RD
4399
4400 SetMode = staticmethod(SetMode)
4401 def GetMode(*args, **kwargs):
66c033b4 4402 """GetMode() -> int"""
54f9ee45 4403 return _core_.UpdateUIEvent_GetMode(*args, **kwargs)
e811c8ce
RD
4404
4405 GetMode = staticmethod(GetMode)
d14a1e28
RD
4406
4407class UpdateUIEventPtr(UpdateUIEvent):
4408 def __init__(self, this):
4409 self.this = this
4410 if not hasattr(self,"thisown"): self.thisown = 0
4411 self.__class__ = UpdateUIEvent
54f9ee45 4412_core_.UpdateUIEvent_swigregister(UpdateUIEventPtr)
d14a1e28 4413
e811c8ce
RD
4414def UpdateUIEvent_SetUpdateInterval(*args, **kwargs):
4415 """UpdateUIEvent_SetUpdateInterval(long updateInterval)"""
54f9ee45 4416 return _core_.UpdateUIEvent_SetUpdateInterval(*args, **kwargs)
d14a1e28 4417
e811c8ce
RD
4418def UpdateUIEvent_GetUpdateInterval(*args, **kwargs):
4419 """UpdateUIEvent_GetUpdateInterval() -> long"""
54f9ee45 4420 return _core_.UpdateUIEvent_GetUpdateInterval(*args, **kwargs)
d14a1e28 4421
e811c8ce
RD
4422def UpdateUIEvent_CanUpdate(*args, **kwargs):
4423 """UpdateUIEvent_CanUpdate(Window win) -> bool"""
54f9ee45 4424 return _core_.UpdateUIEvent_CanUpdate(*args, **kwargs)
d14a1e28 4425
e811c8ce
RD
4426def UpdateUIEvent_ResetUpdateTime(*args, **kwargs):
4427 """UpdateUIEvent_ResetUpdateTime()"""
54f9ee45 4428 return _core_.UpdateUIEvent_ResetUpdateTime(*args, **kwargs)
d14a1e28 4429
e811c8ce 4430def UpdateUIEvent_SetMode(*args, **kwargs):
196addbf 4431 """UpdateUIEvent_SetMode(int mode)"""
54f9ee45 4432 return _core_.UpdateUIEvent_SetMode(*args, **kwargs)
d14a1e28 4433
e811c8ce 4434def UpdateUIEvent_GetMode(*args, **kwargs):
196addbf 4435 """UpdateUIEvent_GetMode() -> int"""
54f9ee45 4436 return _core_.UpdateUIEvent_GetMode(*args, **kwargs)
d14a1e28
RD
4437
4438#---------------------------------------------------------------------------
4439
4440class SysColourChangedEvent(Event):
093d3ff1 4441 """Proxy of C++ SysColourChangedEvent class"""
e811c8ce
RD
4442 def __repr__(self):
4443 return "<%s.%s; proxy of C++ wxSysColourChangedEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4444 def __init__(self, *args, **kwargs):
a95a7133 4445 """__init__(self) -> SysColourChangedEvent"""
54f9ee45 4446 newobj = _core_.new_SysColourChangedEvent(*args, **kwargs)
d14a1e28
RD
4447 self.this = newobj.this
4448 self.thisown = 1
4449 del newobj.thisown
d14a1e28
RD
4450
4451class SysColourChangedEventPtr(SysColourChangedEvent):
4452 def __init__(self, this):
4453 self.this = this
4454 if not hasattr(self,"thisown"): self.thisown = 0
4455 self.__class__ = SysColourChangedEvent
54f9ee45 4456_core_.SysColourChangedEvent_swigregister(SysColourChangedEventPtr)
d14a1e28
RD
4457
4458#---------------------------------------------------------------------------
4459
4460class MouseCaptureChangedEvent(Event):
093d3ff1 4461 """Proxy of C++ MouseCaptureChangedEvent class"""
e811c8ce
RD
4462 def __repr__(self):
4463 return "<%s.%s; proxy of C++ wxMouseCaptureChangedEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4464 def __init__(self, *args, **kwargs):
a95a7133 4465 """__init__(self, int winid=0, Window gainedCapture=None) -> MouseCaptureChangedEvent"""
54f9ee45 4466 newobj = _core_.new_MouseCaptureChangedEvent(*args, **kwargs)
d14a1e28
RD
4467 self.this = newobj.this
4468 self.thisown = 1
4469 del newobj.thisown
e811c8ce 4470 def GetCapturedWindow(*args, **kwargs):
a95a7133 4471 """GetCapturedWindow(self) -> Window"""
54f9ee45 4472 return _core_.MouseCaptureChangedEvent_GetCapturedWindow(*args, **kwargs)
e811c8ce 4473
d14a1e28
RD
4474
4475class MouseCaptureChangedEventPtr(MouseCaptureChangedEvent):
4476 def __init__(self, this):
4477 self.this = this
4478 if not hasattr(self,"thisown"): self.thisown = 0
4479 self.__class__ = MouseCaptureChangedEvent
54f9ee45 4480_core_.MouseCaptureChangedEvent_swigregister(MouseCaptureChangedEventPtr)
d14a1e28
RD
4481
4482#---------------------------------------------------------------------------
4483
4484class DisplayChangedEvent(Event):
093d3ff1 4485 """Proxy of C++ DisplayChangedEvent class"""
e811c8ce
RD
4486 def __repr__(self):
4487 return "<%s.%s; proxy of C++ wxDisplayChangedEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4488 def __init__(self, *args, **kwargs):
a95a7133 4489 """__init__(self) -> DisplayChangedEvent"""
54f9ee45 4490 newobj = _core_.new_DisplayChangedEvent(*args, **kwargs)
d14a1e28
RD
4491 self.this = newobj.this
4492 self.thisown = 1
4493 del newobj.thisown
d14a1e28
RD
4494
4495class DisplayChangedEventPtr(DisplayChangedEvent):
4496 def __init__(self, this):
4497 self.this = this
4498 if not hasattr(self,"thisown"): self.thisown = 0
4499 self.__class__ = DisplayChangedEvent
54f9ee45 4500_core_.DisplayChangedEvent_swigregister(DisplayChangedEventPtr)
d14a1e28
RD
4501
4502#---------------------------------------------------------------------------
4503
4504class PaletteChangedEvent(Event):
093d3ff1 4505 """Proxy of C++ PaletteChangedEvent class"""
e811c8ce
RD
4506 def __repr__(self):
4507 return "<%s.%s; proxy of C++ wxPaletteChangedEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4508 def __init__(self, *args, **kwargs):
a95a7133 4509 """__init__(self, int id=0) -> PaletteChangedEvent"""
54f9ee45 4510 newobj = _core_.new_PaletteChangedEvent(*args, **kwargs)
d14a1e28
RD
4511 self.this = newobj.this
4512 self.thisown = 1
4513 del newobj.thisown
e811c8ce 4514 def SetChangedWindow(*args, **kwargs):
a95a7133 4515 """SetChangedWindow(self, Window win)"""
54f9ee45 4516 return _core_.PaletteChangedEvent_SetChangedWindow(*args, **kwargs)
e811c8ce
RD
4517
4518 def GetChangedWindow(*args, **kwargs):
a95a7133 4519 """GetChangedWindow(self) -> Window"""
54f9ee45 4520 return _core_.PaletteChangedEvent_GetChangedWindow(*args, **kwargs)
e811c8ce 4521
d14a1e28
RD
4522
4523class PaletteChangedEventPtr(PaletteChangedEvent):
4524 def __init__(self, this):
4525 self.this = this
4526 if not hasattr(self,"thisown"): self.thisown = 0
4527 self.__class__ = PaletteChangedEvent
54f9ee45 4528_core_.PaletteChangedEvent_swigregister(PaletteChangedEventPtr)
d14a1e28
RD
4529
4530#---------------------------------------------------------------------------
4531
4532class QueryNewPaletteEvent(Event):
093d3ff1 4533 """Proxy of C++ QueryNewPaletteEvent class"""
e811c8ce
RD
4534 def __repr__(self):
4535 return "<%s.%s; proxy of C++ wxQueryNewPaletteEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4536 def __init__(self, *args, **kwargs):
a95a7133 4537 """__init__(self, int winid=0) -> QueryNewPaletteEvent"""
54f9ee45 4538 newobj = _core_.new_QueryNewPaletteEvent(*args, **kwargs)
d14a1e28
RD
4539 self.this = newobj.this
4540 self.thisown = 1
4541 del newobj.thisown
e811c8ce 4542 def SetPaletteRealized(*args, **kwargs):
a95a7133 4543 """SetPaletteRealized(self, bool realized)"""
54f9ee45 4544 return _core_.QueryNewPaletteEvent_SetPaletteRealized(*args, **kwargs)
e811c8ce
RD
4545
4546 def GetPaletteRealized(*args, **kwargs):
a95a7133 4547 """GetPaletteRealized(self) -> bool"""
54f9ee45 4548 return _core_.QueryNewPaletteEvent_GetPaletteRealized(*args, **kwargs)
e811c8ce 4549
d14a1e28
RD
4550
4551class QueryNewPaletteEventPtr(QueryNewPaletteEvent):
4552 def __init__(self, this):
4553 self.this = this
4554 if not hasattr(self,"thisown"): self.thisown = 0
4555 self.__class__ = QueryNewPaletteEvent
54f9ee45 4556_core_.QueryNewPaletteEvent_swigregister(QueryNewPaletteEventPtr)
d14a1e28
RD
4557
4558#---------------------------------------------------------------------------
4559
4560class NavigationKeyEvent(Event):
093d3ff1 4561 """Proxy of C++ NavigationKeyEvent class"""
e811c8ce
RD
4562 def __repr__(self):
4563 return "<%s.%s; proxy of C++ wxNavigationKeyEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4564 def __init__(self, *args, **kwargs):
a95a7133 4565 """__init__(self) -> NavigationKeyEvent"""
54f9ee45 4566 newobj = _core_.new_NavigationKeyEvent(*args, **kwargs)
d14a1e28
RD
4567 self.this = newobj.this
4568 self.thisown = 1
4569 del newobj.thisown
e811c8ce 4570 def GetDirection(*args, **kwargs):
a95a7133 4571 """GetDirection(self) -> bool"""
54f9ee45 4572 return _core_.NavigationKeyEvent_GetDirection(*args, **kwargs)
e811c8ce
RD
4573
4574 def SetDirection(*args, **kwargs):
908b74cd 4575 """SetDirection(self, bool forward)"""
54f9ee45 4576 return _core_.NavigationKeyEvent_SetDirection(*args, **kwargs)
e811c8ce
RD
4577
4578 def IsWindowChange(*args, **kwargs):
a95a7133 4579 """IsWindowChange(self) -> bool"""
54f9ee45 4580 return _core_.NavigationKeyEvent_IsWindowChange(*args, **kwargs)
e811c8ce
RD
4581
4582 def SetWindowChange(*args, **kwargs):
908b74cd 4583 """SetWindowChange(self, bool ischange)"""
54f9ee45 4584 return _core_.NavigationKeyEvent_SetWindowChange(*args, **kwargs)
e811c8ce 4585
68350608
RD
4586 def IsFromTab(*args, **kwargs):
4587 """IsFromTab(self) -> bool"""
4588 return _core_.NavigationKeyEvent_IsFromTab(*args, **kwargs)
4589
4590 def SetFromTab(*args, **kwargs):
4591 """SetFromTab(self, bool bIs)"""
4592 return _core_.NavigationKeyEvent_SetFromTab(*args, **kwargs)
4593
908b74cd
RD
4594 def SetFlags(*args, **kwargs):
4595 """SetFlags(self, long flags)"""
4596 return _core_.NavigationKeyEvent_SetFlags(*args, **kwargs)
4597
e811c8ce 4598 def GetCurrentFocus(*args, **kwargs):
a95a7133 4599 """GetCurrentFocus(self) -> Window"""
54f9ee45 4600 return _core_.NavigationKeyEvent_GetCurrentFocus(*args, **kwargs)
e811c8ce
RD
4601
4602 def SetCurrentFocus(*args, **kwargs):
a95a7133 4603 """SetCurrentFocus(self, Window win)"""
54f9ee45 4604 return _core_.NavigationKeyEvent_SetCurrentFocus(*args, **kwargs)
e811c8ce 4605
b0f7404b 4606 IsBackward = _core_.NavigationKeyEvent_IsBackward
908b74cd
RD
4607 IsForward = _core_.NavigationKeyEvent_IsForward
4608 WinChange = _core_.NavigationKeyEvent_WinChange
68350608 4609 FromTab = _core_.NavigationKeyEvent_FromTab
d14a1e28
RD
4610
4611class NavigationKeyEventPtr(NavigationKeyEvent):
4612 def __init__(self, this):
4613 self.this = this
4614 if not hasattr(self,"thisown"): self.thisown = 0
4615 self.__class__ = NavigationKeyEvent
54f9ee45 4616_core_.NavigationKeyEvent_swigregister(NavigationKeyEventPtr)
d14a1e28
RD
4617
4618#---------------------------------------------------------------------------
4619
4620class WindowCreateEvent(CommandEvent):
093d3ff1 4621 """Proxy of C++ WindowCreateEvent class"""
e811c8ce
RD
4622 def __repr__(self):
4623 return "<%s.%s; proxy of C++ wxWindowCreateEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4624 def __init__(self, *args, **kwargs):
a95a7133 4625 """__init__(self, Window win=None) -> WindowCreateEvent"""
54f9ee45 4626 newobj = _core_.new_WindowCreateEvent(*args, **kwargs)
d14a1e28
RD
4627 self.this = newobj.this
4628 self.thisown = 1
4629 del newobj.thisown
e811c8ce 4630 def GetWindow(*args, **kwargs):
a95a7133 4631 """GetWindow(self) -> Window"""
54f9ee45 4632 return _core_.WindowCreateEvent_GetWindow(*args, **kwargs)
e811c8ce 4633
d14a1e28
RD
4634
4635class WindowCreateEventPtr(WindowCreateEvent):
4636 def __init__(self, this):
4637 self.this = this
4638 if not hasattr(self,"thisown"): self.thisown = 0
4639 self.__class__ = WindowCreateEvent
54f9ee45 4640_core_.WindowCreateEvent_swigregister(WindowCreateEventPtr)
d14a1e28
RD
4641
4642class WindowDestroyEvent(CommandEvent):
093d3ff1 4643 """Proxy of C++ WindowDestroyEvent class"""
e811c8ce
RD
4644 def __repr__(self):
4645 return "<%s.%s; proxy of C++ wxWindowDestroyEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4646 def __init__(self, *args, **kwargs):
a95a7133 4647 """__init__(self, Window win=None) -> WindowDestroyEvent"""
54f9ee45 4648 newobj = _core_.new_WindowDestroyEvent(*args, **kwargs)
d14a1e28
RD
4649 self.this = newobj.this
4650 self.thisown = 1
4651 del newobj.thisown
e811c8ce 4652 def GetWindow(*args, **kwargs):
a95a7133 4653 """GetWindow(self) -> Window"""
54f9ee45 4654 return _core_.WindowDestroyEvent_GetWindow(*args, **kwargs)
e811c8ce 4655
d14a1e28
RD
4656
4657class WindowDestroyEventPtr(WindowDestroyEvent):
4658 def __init__(self, this):
4659 self.this = this
4660 if not hasattr(self,"thisown"): self.thisown = 0
4661 self.__class__ = WindowDestroyEvent
54f9ee45 4662_core_.WindowDestroyEvent_swigregister(WindowDestroyEventPtr)
d14a1e28
RD
4663
4664#---------------------------------------------------------------------------
4665
4666class ContextMenuEvent(CommandEvent):
093d3ff1 4667 """Proxy of C++ ContextMenuEvent class"""
e811c8ce
RD
4668 def __repr__(self):
4669 return "<%s.%s; proxy of C++ wxContextMenuEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4670 def __init__(self, *args, **kwargs):
a95a7133 4671 """__init__(self, wxEventType type=wxEVT_NULL, int winid=0, Point pt=DefaultPosition) -> ContextMenuEvent"""
54f9ee45 4672 newobj = _core_.new_ContextMenuEvent(*args, **kwargs)
d14a1e28
RD
4673 self.this = newobj.this
4674 self.thisown = 1
4675 del newobj.thisown
e811c8ce 4676 def GetPosition(*args, **kwargs):
a95a7133 4677 """GetPosition(self) -> Point"""
54f9ee45 4678 return _core_.ContextMenuEvent_GetPosition(*args, **kwargs)
e811c8ce
RD
4679
4680 def SetPosition(*args, **kwargs):
a95a7133 4681 """SetPosition(self, Point pos)"""
54f9ee45 4682 return _core_.ContextMenuEvent_SetPosition(*args, **kwargs)
e811c8ce 4683
d14a1e28
RD
4684
4685class ContextMenuEventPtr(ContextMenuEvent):
4686 def __init__(self, this):
4687 self.this = this
4688 if not hasattr(self,"thisown"): self.thisown = 0
4689 self.__class__ = ContextMenuEvent
54f9ee45 4690_core_.ContextMenuEvent_swigregister(ContextMenuEventPtr)
d14a1e28
RD
4691
4692#---------------------------------------------------------------------------
4693
54f9ee45
RD
4694IDLE_PROCESS_ALL = _core_.IDLE_PROCESS_ALL
4695IDLE_PROCESS_SPECIFIED = _core_.IDLE_PROCESS_SPECIFIED
d14a1e28 4696class IdleEvent(Event):
093d3ff1 4697 """Proxy of C++ IdleEvent class"""
e811c8ce
RD
4698 def __repr__(self):
4699 return "<%s.%s; proxy of C++ wxIdleEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4700 def __init__(self, *args, **kwargs):
a95a7133 4701 """__init__(self) -> IdleEvent"""
54f9ee45 4702 newobj = _core_.new_IdleEvent(*args, **kwargs)
d14a1e28
RD
4703 self.this = newobj.this
4704 self.thisown = 1
4705 del newobj.thisown
e811c8ce 4706 def RequestMore(*args, **kwargs):
a95a7133 4707 """RequestMore(self, bool needMore=True)"""
54f9ee45 4708 return _core_.IdleEvent_RequestMore(*args, **kwargs)
e811c8ce
RD
4709
4710 def MoreRequested(*args, **kwargs):
a95a7133 4711 """MoreRequested(self) -> bool"""
54f9ee45 4712 return _core_.IdleEvent_MoreRequested(*args, **kwargs)
e811c8ce
RD
4713
4714 def SetMode(*args, **kwargs):
66c033b4 4715 """SetMode(int mode)"""
54f9ee45 4716 return _core_.IdleEvent_SetMode(*args, **kwargs)
e811c8ce
RD
4717
4718 SetMode = staticmethod(SetMode)
4719 def GetMode(*args, **kwargs):
66c033b4 4720 """GetMode() -> int"""
54f9ee45 4721 return _core_.IdleEvent_GetMode(*args, **kwargs)
e811c8ce
RD
4722
4723 GetMode = staticmethod(GetMode)
4724 def CanSend(*args, **kwargs):
66c033b4 4725 """CanSend(Window win) -> bool"""
54f9ee45 4726 return _core_.IdleEvent_CanSend(*args, **kwargs)
e811c8ce
RD
4727
4728 CanSend = staticmethod(CanSend)
d14a1e28
RD
4729
4730class IdleEventPtr(IdleEvent):
4731 def __init__(self, this):
4732 self.this = this
4733 if not hasattr(self,"thisown"): self.thisown = 0
4734 self.__class__ = IdleEvent
54f9ee45 4735_core_.IdleEvent_swigregister(IdleEventPtr)
d14a1e28 4736
e811c8ce 4737def IdleEvent_SetMode(*args, **kwargs):
196addbf 4738 """IdleEvent_SetMode(int mode)"""
54f9ee45 4739 return _core_.IdleEvent_SetMode(*args, **kwargs)
d14a1e28 4740
e811c8ce 4741def IdleEvent_GetMode(*args, **kwargs):
196addbf 4742 """IdleEvent_GetMode() -> int"""
54f9ee45 4743 return _core_.IdleEvent_GetMode(*args, **kwargs)
d14a1e28 4744
e811c8ce
RD
4745def IdleEvent_CanSend(*args, **kwargs):
4746 """IdleEvent_CanSend(Window win) -> bool"""
54f9ee45 4747 return _core_.IdleEvent_CanSend(*args, **kwargs)
d14a1e28
RD
4748
4749#---------------------------------------------------------------------------
4750
4751class PyEvent(Event):
093d3ff1 4752 """Proxy of C++ PyEvent class"""
e811c8ce
RD
4753 def __repr__(self):
4754 return "<%s.%s; proxy of C++ wxPyEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4755 def __init__(self, *args, **kwargs):
a95a7133 4756 """__init__(self, int winid=0, wxEventType commandType=wxEVT_NULL) -> PyEvent"""
54f9ee45 4757 newobj = _core_.new_PyEvent(*args, **kwargs)
d14a1e28
RD
4758 self.this = newobj.this
4759 self.thisown = 1
4760 del newobj.thisown
4761 self.SetSelf(self)
e811c8ce 4762
54f9ee45 4763 def __del__(self, destroy=_core_.delete_PyEvent):
a95a7133 4764 """__del__(self)"""
d14a1e28
RD
4765 try:
4766 if self.thisown: destroy(self)
4767 except: pass
e811c8ce
RD
4768
4769 def SetSelf(*args, **kwargs):
a95a7133 4770 """SetSelf(self, PyObject self)"""
54f9ee45 4771 return _core_.PyEvent_SetSelf(*args, **kwargs)
e811c8ce
RD
4772
4773 def GetSelf(*args, **kwargs):
a95a7133 4774 """GetSelf(self) -> PyObject"""
54f9ee45 4775 return _core_.PyEvent_GetSelf(*args, **kwargs)
e811c8ce 4776
d14a1e28
RD
4777
4778class PyEventPtr(PyEvent):
4779 def __init__(self, this):
4780 self.this = this
4781 if not hasattr(self,"thisown"): self.thisown = 0
4782 self.__class__ = PyEvent
54f9ee45 4783_core_.PyEvent_swigregister(PyEventPtr)
d14a1e28
RD
4784
4785class PyCommandEvent(CommandEvent):
093d3ff1 4786 """Proxy of C++ PyCommandEvent class"""
e811c8ce
RD
4787 def __repr__(self):
4788 return "<%s.%s; proxy of C++ wxPyCommandEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4789 def __init__(self, *args, **kwargs):
a95a7133 4790 """__init__(self, wxEventType commandType=wxEVT_NULL, int id=0) -> PyCommandEvent"""
54f9ee45 4791 newobj = _core_.new_PyCommandEvent(*args, **kwargs)
d14a1e28
RD
4792 self.this = newobj.this
4793 self.thisown = 1
4794 del newobj.thisown
4795 self.SetSelf(self)
e811c8ce 4796
54f9ee45 4797 def __del__(self, destroy=_core_.delete_PyCommandEvent):
a95a7133 4798 """__del__(self)"""
d14a1e28
RD
4799 try:
4800 if self.thisown: destroy(self)
4801 except: pass
e811c8ce
RD
4802
4803 def SetSelf(*args, **kwargs):
a95a7133 4804 """SetSelf(self, PyObject self)"""
54f9ee45 4805 return _core_.PyCommandEvent_SetSelf(*args, **kwargs)
e811c8ce
RD
4806
4807 def GetSelf(*args, **kwargs):
a95a7133 4808 """GetSelf(self) -> PyObject"""
54f9ee45 4809 return _core_.PyCommandEvent_GetSelf(*args, **kwargs)
e811c8ce 4810
d14a1e28
RD
4811
4812class PyCommandEventPtr(PyCommandEvent):
4813 def __init__(self, this):
4814 self.this = this
4815 if not hasattr(self,"thisown"): self.thisown = 0
4816 self.__class__ = PyCommandEvent
54f9ee45 4817_core_.PyCommandEvent_swigregister(PyCommandEventPtr)
d14a1e28 4818
53aa7709
RD
4819class DateEvent(CommandEvent):
4820 """Proxy of C++ DateEvent class"""
4821 def __repr__(self):
4822 return "<%s.%s; proxy of C++ wxDateEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4823 def __init__(self, *args, **kwargs):
4824 """__init__(self, Window win, DateTime dt, wxEventType type) -> DateEvent"""
4825 newobj = _core_.new_DateEvent(*args, **kwargs)
4826 self.this = newobj.this
4827 self.thisown = 1
4828 del newobj.thisown
4829 def GetDate(*args, **kwargs):
4830 """GetDate(self) -> DateTime"""
4831 return _core_.DateEvent_GetDate(*args, **kwargs)
4832
4833 def SetDate(*args, **kwargs):
4834 """SetDate(self, DateTime date)"""
4835 return _core_.DateEvent_SetDate(*args, **kwargs)
4836
4837
4838class DateEventPtr(DateEvent):
4839 def __init__(self, this):
4840 self.this = this
4841 if not hasattr(self,"thisown"): self.thisown = 0
4842 self.__class__ = DateEvent
4843_core_.DateEvent_swigregister(DateEventPtr)
4844
4845wxEVT_DATE_CHANGED = _core_.wxEVT_DATE_CHANGED
4846EVT_DATE_CHANGED = wx.PyEventBinder( wxEVT_DATE_CHANGED, 1 )
4847
d14a1e28
RD
4848#---------------------------------------------------------------------------
4849
54f9ee45
RD
4850PYAPP_ASSERT_SUPPRESS = _core_.PYAPP_ASSERT_SUPPRESS
4851PYAPP_ASSERT_EXCEPTION = _core_.PYAPP_ASSERT_EXCEPTION
4852PYAPP_ASSERT_DIALOG = _core_.PYAPP_ASSERT_DIALOG
4853PYAPP_ASSERT_LOG = _core_.PYAPP_ASSERT_LOG
4854PRINT_WINDOWS = _core_.PRINT_WINDOWS
4855PRINT_POSTSCRIPT = _core_.PRINT_POSTSCRIPT
d14a1e28 4856class PyApp(EvtHandler):
66c033b4
RD
4857 """
4858 The ``wx.PyApp`` class is an *implementation detail*, please use the
4859 `wx.App` class (or some other derived class) instead.
4860 """
e811c8ce
RD
4861 def __repr__(self):
4862 return "<%s.%s; proxy of C++ wxPyApp instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4863 def __init__(self, *args, **kwargs):
98e665d3 4864 """
a95a7133 4865 __init__(self) -> PyApp
98e665d3
RD
4866
4867 Create a new application object, starting the bootstrap process.
4868 """
54f9ee45 4869 newobj = _core_.new_PyApp(*args, **kwargs)
d14a1e28
RD
4870 self.this = newobj.this
4871 self.thisown = 1
4872 del newobj.thisown
4873 self._setCallbackInfo(self, PyApp)
4874 self._setOORInfo(self)
e811c8ce 4875
54f9ee45 4876 def __del__(self, destroy=_core_.delete_PyApp):
a95a7133 4877 """__del__(self)"""
d14a1e28
RD
4878 try:
4879 if self.thisown: destroy(self)
4880 except: pass
e811c8ce
RD
4881
4882 def _setCallbackInfo(*args, **kwargs):
a95a7133 4883 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
54f9ee45 4884 return _core_.PyApp__setCallbackInfo(*args, **kwargs)
e811c8ce
RD
4885
4886 def GetAppName(*args, **kwargs):
0df68c9f 4887 """
a95a7133 4888 GetAppName(self) -> String
6c3b4aae 4889
0df68c9f
RD
4890 Get the application name.
4891 """
54f9ee45 4892 return _core_.PyApp_GetAppName(*args, **kwargs)
e811c8ce
RD
4893
4894 def SetAppName(*args, **kwargs):
0df68c9f 4895 """
a95a7133 4896 SetAppName(self, String name)
6c3b4aae 4897
66c033b4
RD
4898 Set the application name. This value may be used automatically by
4899 `wx.Config` and such.
0df68c9f 4900 """
54f9ee45 4901 return _core_.PyApp_SetAppName(*args, **kwargs)
e811c8ce
RD
4902
4903 def GetClassName(*args, **kwargs):
0df68c9f 4904 """
a95a7133 4905 GetClassName(self) -> String
e811c8ce 4906
0df68c9f
RD
4907 Get the application's class name.
4908 """
54f9ee45 4909 return _core_.PyApp_GetClassName(*args, **kwargs)
e811c8ce
RD
4910
4911 def SetClassName(*args, **kwargs):
0df68c9f 4912 """
a95a7133 4913 SetClassName(self, String name)
6c3b4aae 4914
66c033b4
RD
4915 Set the application's class name. This value may be used for
4916 X-resources if applicable for the platform
0df68c9f 4917 """
54f9ee45 4918 return _core_.PyApp_SetClassName(*args, **kwargs)
e811c8ce
RD
4919
4920 def GetVendorName(*args, **kwargs):
0df68c9f 4921 """
a95a7133 4922 GetVendorName(self) -> String
6c3b4aae 4923
0df68c9f
RD
4924 Get the application's vendor name.
4925 """
54f9ee45 4926 return _core_.PyApp_GetVendorName(*args, **kwargs)
e811c8ce
RD
4927
4928 def SetVendorName(*args, **kwargs):
0df68c9f 4929 """
a95a7133 4930 SetVendorName(self, String name)
6c3b4aae 4931
66c033b4
RD
4932 Set the application's vendor name. This value may be used
4933 automatically by `wx.Config` and such.
0df68c9f 4934 """
54f9ee45 4935 return _core_.PyApp_SetVendorName(*args, **kwargs)
e811c8ce
RD
4936
4937 def GetTraits(*args, **kwargs):
0df68c9f 4938 """
a95a7133 4939 GetTraits(self) -> wxAppTraits
6c3b4aae 4940
66c033b4
RD
4941 Return (and create if necessary) the app traits object to which we
4942 delegate for everything which either should be configurable by the
4943 user (then he can change the default behaviour simply by overriding
4944 CreateTraits() and returning his own traits object) or which is
4945 GUI/console dependent as then wx.AppTraits allows us to abstract the
4946 differences behind the common facade.
4947
4948 :todo: Add support for overriding CreateAppTraits in wxPython.
0df68c9f 4949 """
54f9ee45 4950 return _core_.PyApp_GetTraits(*args, **kwargs)
e811c8ce
RD
4951
4952 def ProcessPendingEvents(*args, **kwargs):
0df68c9f 4953 """
a95a7133 4954 ProcessPendingEvents(self)
6c3b4aae 4955
66c033b4
RD
4956 Process all events in the Pending Events list -- it is necessary to
4957 call this function to process posted events. This normally happens
4958 during each event loop iteration.
0df68c9f 4959 """
54f9ee45 4960 return _core_.PyApp_ProcessPendingEvents(*args, **kwargs)
e811c8ce
RD
4961
4962 def Yield(*args, **kwargs):
0df68c9f 4963 """
a95a7133 4964 Yield(self, bool onlyIfNeeded=False) -> bool
6c3b4aae 4965
66c033b4
RD
4966 Process all currently pending events right now, instead of waiting
4967 until return to the event loop. It is an error to call ``Yield``
4968 recursively unless the value of ``onlyIfNeeded`` is True.
6c3b4aae 4969
66c033b4 4970 :warning: This function is dangerous as it can lead to unexpected
41e2b43e
RD
4971 reentrancies (i.e. when called from an event handler it may
4972 result in calling the same event handler again), use with
4973 extreme care or, better, don't use at all!
0df68c9f 4974
66c033b4 4975 :see: `wx.Yield`, `wx.YieldIfNeeded`, `wx.SafeYield`
41e2b43e 4976
0df68c9f 4977 """
54f9ee45 4978 return _core_.PyApp_Yield(*args, **kwargs)
e811c8ce
RD
4979
4980 def WakeUpIdle(*args, **kwargs):
0df68c9f 4981 """
a95a7133 4982 WakeUpIdle(self)
6c3b4aae 4983
66c033b4
RD
4984 Make sure that idle events are sent again.
4985 :see: `wx.WakeUpIdle`
0df68c9f 4986 """
54f9ee45 4987 return _core_.PyApp_WakeUpIdle(*args, **kwargs)
e811c8ce 4988
1fc3b23a
RD
4989 def IsMainLoopRunning(*args, **kwargs):
4990 """
4991 IsMainLoopRunning() -> bool
4992
4993 Returns True if we're running the main loop, i.e. if the events can
4994 currently be dispatched.
4995 """
4996 return _core_.PyApp_IsMainLoopRunning(*args, **kwargs)
4997
4998 IsMainLoopRunning = staticmethod(IsMainLoopRunning)
e811c8ce 4999 def MainLoop(*args, **kwargs):
0df68c9f 5000 """
a95a7133 5001 MainLoop(self) -> int
6c3b4aae 5002
66c033b4
RD
5003 Execute the main GUI loop, the function doesn't normally return until
5004 all top level windows have been closed and destroyed.
0df68c9f 5005 """
54f9ee45 5006 return _core_.PyApp_MainLoop(*args, **kwargs)
e811c8ce
RD
5007
5008 def Exit(*args, **kwargs):
0df68c9f 5009 """
a95a7133 5010 Exit(self)
6c3b4aae 5011
0df68c9f 5012 Exit the main loop thus terminating the application.
66c033b4 5013 :see: `wx.Exit`
0df68c9f 5014 """
54f9ee45 5015 return _core_.PyApp_Exit(*args, **kwargs)
e811c8ce
RD
5016
5017 def ExitMainLoop(*args, **kwargs):
0df68c9f 5018 """
a95a7133 5019 ExitMainLoop(self)
6c3b4aae 5020
66c033b4
RD
5021 Exit the main GUI loop during the next iteration of the main
5022 loop, (i.e. it does not stop the program immediately!)
0df68c9f 5023 """
54f9ee45 5024 return _core_.PyApp_ExitMainLoop(*args, **kwargs)
e811c8ce
RD
5025
5026 def Pending(*args, **kwargs):
0df68c9f 5027 """
a95a7133 5028 Pending(self) -> bool
6c3b4aae 5029
0df68c9f
RD
5030 Returns True if there are unprocessed events in the event queue.
5031 """
54f9ee45 5032 return _core_.PyApp_Pending(*args, **kwargs)
e811c8ce
RD
5033
5034 def Dispatch(*args, **kwargs):
0df68c9f 5035 """
a95a7133 5036 Dispatch(self) -> bool
6c3b4aae 5037
0df68c9f
RD
5038 Process the first event in the event queue (blocks until an event
5039 appears if there are none currently)
5040 """
54f9ee45 5041 return _core_.PyApp_Dispatch(*args, **kwargs)
e811c8ce
RD
5042
5043 def ProcessIdle(*args, **kwargs):
0df68c9f 5044 """
a95a7133 5045 ProcessIdle(self) -> bool
6c3b4aae 5046
66c033b4
RD
5047 Called from the MainLoop when the application becomes idle (there are
5048 no pending events) and sends a `wx.IdleEvent` to all interested
5049 parties. Returns True if more idle events are needed, False if not.
0df68c9f 5050 """
54f9ee45 5051 return _core_.PyApp_ProcessIdle(*args, **kwargs)
e811c8ce
RD
5052
5053 def SendIdleEvents(*args, **kwargs):
0df68c9f 5054 """
a95a7133 5055 SendIdleEvents(self, Window win, IdleEvent event) -> bool
e811c8ce 5056
66c033b4
RD
5057 Send idle event to window and all subwindows. Returns True if more
5058 idle time is requested.
0df68c9f 5059 """
54f9ee45 5060 return _core_.PyApp_SendIdleEvents(*args, **kwargs)
e811c8ce
RD
5061
5062 def IsActive(*args, **kwargs):
0df68c9f 5063 """
a95a7133 5064 IsActive(self) -> bool
6c3b4aae 5065
0df68c9f
RD
5066 Return True if our app has focus.
5067 """
54f9ee45 5068 return _core_.PyApp_IsActive(*args, **kwargs)
e811c8ce
RD
5069
5070 def SetTopWindow(*args, **kwargs):
0df68c9f 5071 """
a95a7133 5072 SetTopWindow(self, Window win)
6c3b4aae 5073
66c033b4 5074 Set the *main* top level window
0df68c9f 5075 """
54f9ee45 5076 return _core_.PyApp_SetTopWindow(*args, **kwargs)
e811c8ce
RD
5077
5078 def GetTopWindow(*args, **kwargs):
0df68c9f 5079 """
a95a7133 5080 GetTopWindow(self) -> Window
6c3b4aae 5081
66c033b4
RD
5082 Return the *main* top level window (if it hadn't been set previously
5083 with SetTopWindow(), will return just some top level window and, if
5084 there not any, will return None)
0df68c9f 5085 """
54f9ee45 5086 return _core_.PyApp_GetTopWindow(*args, **kwargs)
e811c8ce
RD
5087
5088 def SetExitOnFrameDelete(*args, **kwargs):
0df68c9f 5089 """
a95a7133 5090 SetExitOnFrameDelete(self, bool flag)
0df68c9f 5091
66c033b4
RD
5092 Control the exit behaviour: by default, the program will exit the main
5093 loop (and so, usually, terminate) when the last top-level program
5094 window is deleted. Beware that if you disable this behaviour (with
5095 SetExitOnFrameDelete(False)), you'll have to call ExitMainLoop()
5096 explicitly from somewhere.
0df68c9f 5097 """
54f9ee45 5098 return _core_.PyApp_SetExitOnFrameDelete(*args, **kwargs)
e811c8ce
RD
5099
5100 def GetExitOnFrameDelete(*args, **kwargs):
0df68c9f 5101 """
a95a7133 5102 GetExitOnFrameDelete(self) -> bool
6c3b4aae 5103
0df68c9f
RD
5104 Get the current exit behaviour setting.
5105 """
54f9ee45 5106 return _core_.PyApp_GetExitOnFrameDelete(*args, **kwargs)
e811c8ce
RD
5107
5108 def SetUseBestVisual(*args, **kwargs):
0df68c9f 5109 """
a95a7133 5110 SetUseBestVisual(self, bool flag)
6c3b4aae 5111
66c033b4
RD
5112 Set whether the app should try to use the best available visual on
5113 systems where more than one is available, (Sun, SGI, XFree86 4, etc.)
0df68c9f 5114 """
54f9ee45 5115 return _core_.PyApp_SetUseBestVisual(*args, **kwargs)
e811c8ce
RD
5116
5117 def GetUseBestVisual(*args, **kwargs):
0df68c9f 5118 """
a95a7133 5119 GetUseBestVisual(self) -> bool
6c3b4aae 5120
0df68c9f
RD
5121 Get current UseBestVisual setting.
5122 """
54f9ee45 5123 return _core_.PyApp_GetUseBestVisual(*args, **kwargs)
e811c8ce
RD
5124
5125 def SetPrintMode(*args, **kwargs):
a95a7133 5126 """SetPrintMode(self, int mode)"""
54f9ee45 5127 return _core_.PyApp_SetPrintMode(*args, **kwargs)
e811c8ce
RD
5128
5129 def GetPrintMode(*args, **kwargs):
a95a7133 5130 """GetPrintMode(self) -> int"""
54f9ee45 5131 return _core_.PyApp_GetPrintMode(*args, **kwargs)
e811c8ce 5132
e811c8ce 5133 def SetAssertMode(*args, **kwargs):
0df68c9f 5134 """
a95a7133 5135 SetAssertMode(self, int mode)
6c3b4aae 5136
41e2b43e 5137 Set the OnAssert behaviour for debug and hybrid builds.
0df68c9f 5138 """
54f9ee45 5139 return _core_.PyApp_SetAssertMode(*args, **kwargs)
e811c8ce 5140
6c3b4aae 5141 def GetAssertMode(*args, **kwargs):
0df68c9f 5142 """
a95a7133 5143 GetAssertMode(self) -> int
6c3b4aae 5144
0df68c9f
RD
5145 Get the current OnAssert behaviour setting.
5146 """
54f9ee45 5147 return _core_.PyApp_GetAssertMode(*args, **kwargs)
6c3b4aae 5148
e811c8ce 5149 def GetMacSupportPCMenuShortcuts(*args, **kwargs):
66c033b4 5150 """GetMacSupportPCMenuShortcuts() -> bool"""
54f9ee45 5151 return _core_.PyApp_GetMacSupportPCMenuShortcuts(*args, **kwargs)
e811c8ce
RD
5152
5153 GetMacSupportPCMenuShortcuts = staticmethod(GetMacSupportPCMenuShortcuts)
5154 def GetMacAboutMenuItemId(*args, **kwargs):
66c033b4 5155 """GetMacAboutMenuItemId() -> long"""
54f9ee45 5156 return _core_.PyApp_GetMacAboutMenuItemId(*args, **kwargs)
e811c8ce
RD
5157
5158 GetMacAboutMenuItemId = staticmethod(GetMacAboutMenuItemId)
5159 def GetMacPreferencesMenuItemId(*args, **kwargs):
66c033b4 5160 """GetMacPreferencesMenuItemId() -> long"""
54f9ee45 5161 return _core_.PyApp_GetMacPreferencesMenuItemId(*args, **kwargs)
e811c8ce
RD
5162
5163 GetMacPreferencesMenuItemId = staticmethod(GetMacPreferencesMenuItemId)
5164 def GetMacExitMenuItemId(*args, **kwargs):
66c033b4 5165 """GetMacExitMenuItemId() -> long"""
54f9ee45 5166 return _core_.PyApp_GetMacExitMenuItemId(*args, **kwargs)
e811c8ce
RD
5167
5168 GetMacExitMenuItemId = staticmethod(GetMacExitMenuItemId)
5169 def GetMacHelpMenuTitleName(*args, **kwargs):
66c033b4 5170 """GetMacHelpMenuTitleName() -> String"""
54f9ee45 5171 return _core_.PyApp_GetMacHelpMenuTitleName(*args, **kwargs)
e811c8ce
RD
5172
5173 GetMacHelpMenuTitleName = staticmethod(GetMacHelpMenuTitleName)
5174 def SetMacSupportPCMenuShortcuts(*args, **kwargs):
66c033b4 5175 """SetMacSupportPCMenuShortcuts(bool val)"""
54f9ee45 5176 return _core_.PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs)
e811c8ce
RD
5177
5178 SetMacSupportPCMenuShortcuts = staticmethod(SetMacSupportPCMenuShortcuts)
5179 def SetMacAboutMenuItemId(*args, **kwargs):
66c033b4 5180 """SetMacAboutMenuItemId(long val)"""
54f9ee45 5181 return _core_.PyApp_SetMacAboutMenuItemId(*args, **kwargs)
e811c8ce
RD
5182
5183 SetMacAboutMenuItemId = staticmethod(SetMacAboutMenuItemId)
5184 def SetMacPreferencesMenuItemId(*args, **kwargs):
66c033b4 5185 """SetMacPreferencesMenuItemId(long val)"""
54f9ee45 5186 return _core_.PyApp_SetMacPreferencesMenuItemId(*args, **kwargs)
e811c8ce
RD
5187
5188 SetMacPreferencesMenuItemId = staticmethod(SetMacPreferencesMenuItemId)
5189 def SetMacExitMenuItemId(*args, **kwargs):
66c033b4 5190 """SetMacExitMenuItemId(long val)"""
54f9ee45 5191 return _core_.PyApp_SetMacExitMenuItemId(*args, **kwargs)
e811c8ce
RD
5192
5193 SetMacExitMenuItemId = staticmethod(SetMacExitMenuItemId)
5194 def SetMacHelpMenuTitleName(*args, **kwargs):
66c033b4 5195 """SetMacHelpMenuTitleName(String val)"""
54f9ee45 5196 return _core_.PyApp_SetMacHelpMenuTitleName(*args, **kwargs)
e811c8ce
RD
5197
5198 SetMacHelpMenuTitleName = staticmethod(SetMacHelpMenuTitleName)
5199 def _BootstrapApp(*args, **kwargs):
0df68c9f 5200 """
a95a7133 5201 _BootstrapApp(self)
6c3b4aae 5202
0df68c9f
RD
5203 For internal use only
5204 """
54f9ee45 5205 return _core_.PyApp__BootstrapApp(*args, **kwargs)
e811c8ce
RD
5206
5207 def GetComCtl32Version(*args, **kwargs):
0df68c9f 5208 """
66c033b4 5209 GetComCtl32Version() -> int
6c3b4aae 5210
66c033b4
RD
5211 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
5212 it wasn't found at all. Raises an exception on non-Windows platforms.
0df68c9f 5213 """
54f9ee45 5214 return _core_.PyApp_GetComCtl32Version(*args, **kwargs)
e811c8ce
RD
5215
5216 GetComCtl32Version = staticmethod(GetComCtl32Version)
d14a1e28
RD
5217
5218class PyAppPtr(PyApp):
5219 def __init__(self, this):
5220 self.this = this
5221 if not hasattr(self,"thisown"): self.thisown = 0
5222 self.__class__ = PyApp
54f9ee45 5223_core_.PyApp_swigregister(PyAppPtr)
d14a1e28 5224
1fc3b23a
RD
5225def PyApp_IsMainLoopRunning(*args, **kwargs):
5226 """
5227 PyApp_IsMainLoopRunning() -> bool
5228
5229 Returns True if we're running the main loop, i.e. if the events can
5230 currently be dispatched.
5231 """
5232 return _core_.PyApp_IsMainLoopRunning(*args, **kwargs)
5233
e811c8ce
RD
5234def PyApp_GetMacSupportPCMenuShortcuts(*args, **kwargs):
5235 """PyApp_GetMacSupportPCMenuShortcuts() -> bool"""
54f9ee45 5236 return _core_.PyApp_GetMacSupportPCMenuShortcuts(*args, **kwargs)
d14a1e28 5237
e811c8ce
RD
5238def PyApp_GetMacAboutMenuItemId(*args, **kwargs):
5239 """PyApp_GetMacAboutMenuItemId() -> long"""
54f9ee45 5240 return _core_.PyApp_GetMacAboutMenuItemId(*args, **kwargs)
d14a1e28 5241
e811c8ce
RD
5242def PyApp_GetMacPreferencesMenuItemId(*args, **kwargs):
5243 """PyApp_GetMacPreferencesMenuItemId() -> long"""
54f9ee45 5244 return _core_.PyApp_GetMacPreferencesMenuItemId(*args, **kwargs)
d14a1e28 5245
e811c8ce
RD
5246def PyApp_GetMacExitMenuItemId(*args, **kwargs):
5247 """PyApp_GetMacExitMenuItemId() -> long"""
54f9ee45 5248 return _core_.PyApp_GetMacExitMenuItemId(*args, **kwargs)
d14a1e28 5249
e811c8ce 5250def PyApp_GetMacHelpMenuTitleName(*args, **kwargs):
196addbf 5251 """PyApp_GetMacHelpMenuTitleName() -> String"""
54f9ee45 5252 return _core_.PyApp_GetMacHelpMenuTitleName(*args, **kwargs)
d14a1e28 5253
e811c8ce
RD
5254def PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs):
5255 """PyApp_SetMacSupportPCMenuShortcuts(bool val)"""
54f9ee45 5256 return _core_.PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs)
d14a1e28 5257
e811c8ce
RD
5258def PyApp_SetMacAboutMenuItemId(*args, **kwargs):
5259 """PyApp_SetMacAboutMenuItemId(long val)"""
54f9ee45 5260 return _core_.PyApp_SetMacAboutMenuItemId(*args, **kwargs)
d14a1e28 5261
e811c8ce
RD
5262def PyApp_SetMacPreferencesMenuItemId(*args, **kwargs):
5263 """PyApp_SetMacPreferencesMenuItemId(long val)"""
54f9ee45 5264 return _core_.PyApp_SetMacPreferencesMenuItemId(*args, **kwargs)
d14a1e28 5265
e811c8ce
RD
5266def PyApp_SetMacExitMenuItemId(*args, **kwargs):
5267 """PyApp_SetMacExitMenuItemId(long val)"""
54f9ee45 5268 return _core_.PyApp_SetMacExitMenuItemId(*args, **kwargs)
d14a1e28 5269
e811c8ce 5270def PyApp_SetMacHelpMenuTitleName(*args, **kwargs):
196addbf 5271 """PyApp_SetMacHelpMenuTitleName(String val)"""
54f9ee45 5272 return _core_.PyApp_SetMacHelpMenuTitleName(*args, **kwargs)
d14a1e28 5273
e811c8ce 5274def PyApp_GetComCtl32Version(*args, **kwargs):
0df68c9f
RD
5275 """
5276 PyApp_GetComCtl32Version() -> int
6c3b4aae 5277
66c033b4
RD
5278 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
5279 it wasn't found at all. Raises an exception on non-Windows platforms.
0df68c9f 5280 """
54f9ee45 5281 return _core_.PyApp_GetComCtl32Version(*args, **kwargs)
d14a1e28
RD
5282
5283#---------------------------------------------------------------------------
5284
5285
e811c8ce 5286def Exit(*args, **kwargs):
0df68c9f
RD
5287 """
5288 Exit()
6c3b4aae 5289
0df68c9f
RD
5290 Force an exit of the application. Convenience for wx.GetApp().Exit()
5291 """
54f9ee45 5292 return _core_.Exit(*args, **kwargs)
d14a1e28 5293
e811c8ce 5294def Yield(*args, **kwargs):
0df68c9f
RD
5295 """
5296 Yield() -> bool
6c3b4aae 5297
0df68c9f
RD
5298 Yield to other apps/messages. Convenience for wx.GetApp().Yield()
5299 """
54f9ee45 5300 return _core_.Yield(*args, **kwargs)
d14a1e28 5301
e811c8ce 5302def YieldIfNeeded(*args, **kwargs):
0df68c9f
RD
5303 """
5304 YieldIfNeeded() -> bool
6c3b4aae 5305
0df68c9f
RD
5306 Yield to other apps/messages. Convenience for wx.GetApp().Yield(True)
5307 """
54f9ee45 5308 return _core_.YieldIfNeeded(*args, **kwargs)
d14a1e28 5309
e811c8ce 5310def SafeYield(*args, **kwargs):
0df68c9f
RD
5311 """
5312 SafeYield(Window win=None, bool onlyIfNeeded=False) -> bool
6c3b4aae 5313
66c033b4
RD
5314 This function is similar to `wx.Yield`, except that it disables the
5315 user input to all program windows before calling `wx.Yield` and
5316 re-enables it again afterwards. If ``win`` is not None, this window
5317 will remain enabled, allowing the implementation of some limited user
5318 interaction.
6c3b4aae 5319
66c033b4 5320 :Returns: the result of the call to `wx.Yield`.
0df68c9f 5321 """
54f9ee45 5322 return _core_.SafeYield(*args, **kwargs)
d14a1e28 5323
e811c8ce 5324def WakeUpIdle(*args, **kwargs):
0df68c9f
RD
5325 """
5326 WakeUpIdle()
6c3b4aae 5327
66c033b4
RD
5328 Cause the message queue to become empty again, so idle events will be
5329 sent.
0df68c9f 5330 """
54f9ee45 5331 return _core_.WakeUpIdle(*args, **kwargs)
d14a1e28 5332
e811c8ce 5333def PostEvent(*args, **kwargs):
0df68c9f
RD
5334 """
5335 PostEvent(EvtHandler dest, Event event)
6c3b4aae 5336
66c033b4
RD
5337 Send an event to a window or other wx.EvtHandler to be processed
5338 later.
0df68c9f 5339 """
54f9ee45 5340 return _core_.PostEvent(*args, **kwargs)
d14a1e28 5341
e811c8ce 5342def App_CleanUp(*args, **kwargs):
0df68c9f
RD
5343 """
5344 App_CleanUp()
6c3b4aae 5345
41e2b43e 5346 For internal use only, it is used to cleanup after wxWidgets when
66c033b4 5347 Python shuts down.
0df68c9f 5348 """
54f9ee45 5349 return _core_.App_CleanUp(*args, **kwargs)
d14a1e28 5350
e811c8ce 5351def GetApp(*args, **kwargs):
0df68c9f
RD
5352 """
5353 GetApp() -> PyApp
6c3b4aae 5354
196addbf 5355 Return a reference to the current wx.App object.
0df68c9f 5356 """
54f9ee45 5357 return _core_.GetApp(*args, **kwargs)
5cbf236d
RD
5358
5359def SetDefaultPyEncoding(*args, **kwargs):
5360 """
5361 SetDefaultPyEncoding(string encoding)
5362
5363 Sets the encoding that wxPython will use when it needs to convert a
5364 Python string or unicode object to or from a wxString.
e505d15e
RD
5365
5366 The default encoding is the value of ``locale.getdefaultlocale()[1]``
5367 but please be aware that the default encoding within the same locale
5368 may be slightly different on different platforms. For example, please
5369 see http://www.alanwood.net/demos/charsetdiffs.html for differences
5370 between the common latin/roman encodings.
5cbf236d
RD
5371 """
5372 return _core_.SetDefaultPyEncoding(*args, **kwargs)
5373
5374def GetDefaultPyEncoding(*args, **kwargs):
5375 """
5376 GetDefaultPyEncoding() -> string
5377
5378 Gets the current encoding that wxPython will use when it needs to
5379 convert a Python string or unicode object to or from a wxString.
5380 """
5381 return _core_.GetDefaultPyEncoding(*args, **kwargs)
d14a1e28
RD
5382#----------------------------------------------------------------------
5383
5384class PyOnDemandOutputWindow:
6c3b4aae
RD
5385 """
5386 A class that can be used for redirecting Python's stdout and
5387 stderr streams. It will do nothing until something is wrriten to
5388 the stream at which point it will create a Frame with a text area
5389 and write the text there.
5390 """
d14a1e28
RD
5391 def __init__(self, title = "wxPython: stdout/stderr"):
5392 self.frame = None
5393 self.title = title
412d302d
RD
5394 self.pos = wx.DefaultPosition
5395 self.size = (450, 300)
d14a1e28
RD
5396 self.parent = None
5397
5398 def SetParent(self, parent):
6c3b4aae 5399 """Set the window to be used as the popup Frame's parent."""
d14a1e28
RD
5400 self.parent = parent
5401
6c3b4aae
RD
5402
5403 def CreateOutputWindow(self, st):
412d302d
RD
5404 self.frame = wx.Frame(self.parent, -1, self.title, self.pos, self.size,
5405 style=wx.DEFAULT_FRAME_STYLE)
196addbf 5406 self.text = wx.TextCtrl(self.frame, -1, "",
412d302d 5407 style=wx.TE_MULTILINE|wx.TE_READONLY)
d1e20054 5408 self.text.AppendText(st)
6c3b4aae
RD
5409 self.frame.Show(True)
5410 EVT_CLOSE(self.frame, self.OnCloseWindow)
5411
d14a1e28 5412
7409c0c6
RD
5413 def OnCloseWindow(self, event):
5414 if self.frame is not None:
5415 self.frame.Destroy()
5416 self.frame = None
5417 self.text = None
5418
5419
d14a1e28 5420 # These methods provide the file-like output behaviour.
6c3b4aae
RD
5421 def write(self, text):
5422 """
5423 Create the output window if needed and write the string to it.
5424 If not called in the context of the gui thread then uses
5425 CallAfter to do the work there.
5426 """
5427 if self.frame is None:
5428 if not wx.Thread_IsMain():
5429 wx.CallAfter(self.CreateOutputWindow, text)
5430 else:
5431 self.CreateOutputWindow(text)
5432 else:
5433 if not wx.Thread_IsMain():
5434 wx.CallAfter(self.text.AppendText, text)
5435 else:
5436 self.text.AppendText(text)
5437
d14a1e28
RD
5438
5439 def close(self):
6c3b4aae
RD
5440 if self.frame is not None:
5441 wx.CallAfter(self.frame.Close)
5442
d14a1e28 5443
19272049
RD
5444 def flush(self):
5445 pass
5446
5447
d14a1e28
RD
5448
5449#----------------------------------------------------------------------
d14a1e28
RD
5450
5451_defRedirect = (wx.Platform == '__WXMSW__' or wx.Platform == '__WXMAC__')
5452
5453class App(wx.PyApp):
6c3b4aae 5454 """
66c033b4
RD
5455 The ``wx.App`` class represents the application and is used to:
5456
5457 * bootstrap the wxPython system and initialize the underlying
5458 gui toolkit
5459 * set and get application-wide properties
5460 * implement the windowing system main message or event loop,
5461 and to dispatch events to window instances
5462 * etc.
5463
5464 Every application must have a ``wx.App`` instance, and all
5465 creation of UI objects should be delayed until after the
03e37cd5
RD
5466 ``wx.App`` object has been created in order to ensure that the gui
5467 platform and wxWidgets have been fully initialized.
66c033b4
RD
5468
5469 Normally you would derive from this class and implement an
5470 ``OnInit`` method that creates a frame and then calls
5471 ``self.SetTopWindow(frame)``.
5472
03e37cd5 5473 :see: `wx.PySimpleApp` for a simpler app class that can be used
1c0f361b 5474 directly.
6c3b4aae 5475 """
66c033b4 5476
d14a1e28
RD
5477 outputWindowClass = PyOnDemandOutputWindow
5478
03e37cd5
RD
5479 def __init__(self, redirect=_defRedirect, filename=None,
5480 useBestVisual=False, clearSigInt=True):
66c033b4
RD
5481 """
5482 Construct a ``wx.App`` object.
5483
03e37cd5
RD
5484 :param redirect: Should ``sys.stdout`` and ``sys.stderr`` be
5485 redirected? Defaults to True on Windows and Mac, False
5486 otherwise. If `filename` is None then output will be
5487 redirected to a window that pops up as needed. (You can
5488 control what kind of window is created for the output by
5489 resetting the class variable ``outputWindowClass`` to a
5490 class of your choosing.)
66c033b4 5491
03e37cd5
RD
5492 :param filename: The name of a file to redirect output to, if
5493 redirect is True.
66c033b4
RD
5494
5495 :param useBestVisual: Should the app try to use the best
03e37cd5
RD
5496 available visual provided by the system (only relevant on
5497 systems that have more than one visual.) This parameter
5498 must be used instead of calling `SetUseBestVisual` later
5499 on because it must be set before the underlying GUI
5500 toolkit is initialized.
5501
5502 :param clearSigInt: Should SIGINT be cleared? This allows the
5503 app to terminate upon a Ctrl-C in the console like other
5504 GUI apps will.
66c033b4
RD
5505
5506 :note: You should override OnInit to do applicaition
5507 initialization to ensure that the system, toolkit and
5508 wxWidgets are fully initialized.
5509 """
d14a1e28
RD
5510 wx.PyApp.__init__(self)
5511
5512 if wx.Platform == "__WXMAC__":
5513 try:
5514 import MacOS
5515 if not MacOS.WMAvailable():
5516 print """\
5517This program needs access to the screen. Please run with 'pythonw',
5518not 'python', and only when you are logged in on the main display of
5519your Mac."""
5520 _sys.exit(1)
36cadbf7
RD
5521 except SystemExit:
5522 raise
d14a1e28
RD
5523 except:
5524 pass
5525
5526 # This has to be done before OnInit
5527 self.SetUseBestVisual(useBestVisual)
5528
5529 # Set the default handler for SIGINT. This fixes a problem
5530 # where if Ctrl-C is pressed in the console that started this
5531 # app then it will not appear to do anything, (not even send
5532 # KeyboardInterrupt???) but will later segfault on exit. By
5533 # setting the default handler then the app will exit, as
5534 # expected (depending on platform.)
03e37cd5
RD
5535 if clearSigInt:
5536 try:
5537 import signal
5538 signal.signal(signal.SIGINT, signal.SIG_DFL)
5539 except:
5540 pass
d14a1e28
RD
5541
5542 # Save and redirect the stdio to a window?
5543 self.stdioWin = None
5544 self.saveStdio = (_sys.stdout, _sys.stderr)
5545 if redirect:
5546 self.RedirectStdio(filename)
5547
8fb0e70a
RD
5548 # Use Python's install prefix as the default
5549 wx.StandardPaths.Get().SetInstallPrefix(_sys.prefix)
5550
d14a1e28
RD
5551 # This finishes the initialization of wxWindows and then calls
5552 # the OnInit that should be present in the derived class
5553 self._BootstrapApp()
5554
5555
5556 def __del__(self):
5557 try:
5558 self.RestoreStdio() # Just in case the MainLoop was overridden
5559 except:
5560 pass
5561
5562
5563 def SetTopWindow(self, frame):
1e0c8722 5564 """Set the \"main\" top level window"""
d14a1e28
RD
5565 if self.stdioWin:
5566 self.stdioWin.SetParent(frame)
5567 wx.PyApp.SetTopWindow(self, frame)
5568
5569
5570 def MainLoop(self):
1e0c8722 5571 """Execute the main GUI event loop"""
d14a1e28
RD
5572 wx.PyApp.MainLoop(self)
5573 self.RestoreStdio()
5574
5575
7409c0c6 5576 def RedirectStdio(self, filename=None):
1e0c8722 5577 """Redirect sys.stdout and sys.stderr to a file or a popup window."""
d14a1e28
RD
5578 if filename:
5579 _sys.stdout = _sys.stderr = open(filename, 'a')
5580 else:
5581 self.stdioWin = self.outputWindowClass()
5582 _sys.stdout = _sys.stderr = self.stdioWin
5583
5584
5585 def RestoreStdio(self):
5586 _sys.stdout, _sys.stderr = self.saveStdio
5587
5588
412d302d
RD
5589 def SetOutputWindowAttributes(self, title=None, pos=None, size=None):
5590 """
5591 Set the title, position and/or size of the output window if
f5b96ee1
RD
5592 the stdio has been redirected. This should be called before
5593 any output would cause the output window to be created.
412d302d
RD
5594 """
5595 if self.stdioWin:
5596 if title is not None:
5597 self.stdioWin.title = title
5598 if pos is not None:
5599 self.stdioWin.pos = pos
5600 if size is not None:
5601 self.stdioWin.size = size
5602
5603
5604
d14a1e28 5605
66c033b4 5606# change from wx.PyApp_XX to wx.App_XX
54f9ee45
RD
5607App_GetMacSupportPCMenuShortcuts = _core_.PyApp_GetMacSupportPCMenuShortcuts
5608App_GetMacAboutMenuItemId = _core_.PyApp_GetMacAboutMenuItemId
5609App_GetMacPreferencesMenuItemId = _core_.PyApp_GetMacPreferencesMenuItemId
5610App_GetMacExitMenuItemId = _core_.PyApp_GetMacExitMenuItemId
5611App_GetMacHelpMenuTitleName = _core_.PyApp_GetMacHelpMenuTitleName
5612App_SetMacSupportPCMenuShortcuts = _core_.PyApp_SetMacSupportPCMenuShortcuts
5613App_SetMacAboutMenuItemId = _core_.PyApp_SetMacAboutMenuItemId
5614App_SetMacPreferencesMenuItemId = _core_.PyApp_SetMacPreferencesMenuItemId
5615App_SetMacExitMenuItemId = _core_.PyApp_SetMacExitMenuItemId
5616App_SetMacHelpMenuTitleName = _core_.PyApp_SetMacHelpMenuTitleName
5617App_GetComCtl32Version = _core_.PyApp_GetComCtl32Version
d14a1e28
RD
5618
5619#----------------------------------------------------------------------------
5620
5621class PySimpleApp(wx.App):
6c3b4aae
RD
5622 """
5623 A simple application class. You can just create one of these and
5624 then then make your top level windows later, and not have to worry
66c033b4
RD
5625 about OnInit. For example::
5626
5627 app = wx.PySimpleApp()
5628 frame = wx.Frame(None, title='Hello World')
5629 frame.Show()
5630 app.MainLoop()
5631
5632 :see: `wx.App`
5633 """
6c3b4aae 5634
03e37cd5
RD
5635 def __init__(self, redirect=False, filename=None,
5636 useBestVisual=False, clearSigInt=True):
66c033b4
RD
5637 """
5638 :see: `wx.App.__init__`
5639 """
03e37cd5 5640 wx.App.__init__(self, redirect, filename, useBestVisual, clearSigInt)
6c3b4aae 5641
d14a1e28 5642 def OnInit(self):
d14a1e28
RD
5643 return True
5644
5645
66c033b4 5646
6c3b4aae 5647# Is anybody using this one?
d14a1e28
RD
5648class PyWidgetTester(wx.App):
5649 def __init__(self, size = (250, 100)):
5650 self.size = size
5651 wx.App.__init__(self, 0)
5652
5653 def OnInit(self):
196addbf 5654 self.frame = wx.Frame(None, -1, "Widget Tester", pos=(0,0), size=self.size)
d14a1e28
RD
5655 self.SetTopWindow(self.frame)
5656 return True
5657
66c033b4
RD
5658 def SetWidget(self, widgetClass, *args, **kwargs):
5659 w = widgetClass(self.frame, *args, **kwargs)
d14a1e28
RD
5660 self.frame.Show(True)
5661
5662#----------------------------------------------------------------------------
5663# DO NOT hold any other references to this object. This is how we
66c033b4 5664# know when to cleanup system resources that wxWidgets is holding. When
d14a1e28 5665# the sys module is unloaded, the refcount on sys.__wxPythonCleanup
66c033b4 5666# goes to zero and it calls the wx.App_CleanUp function.
d14a1e28
RD
5667
5668class __wxPyCleanup:
5669 def __init__(self):
54f9ee45 5670 self.cleanup = _core_.App_CleanUp
d14a1e28
RD
5671 def __del__(self):
5672 self.cleanup()
5673
5674_sys.__wxPythonCleanup = __wxPyCleanup()
5675
5676## # another possible solution, but it gets called too early...
66c033b4
RD
5677## import atexit
5678## atexit.register(_core_.wxApp_CleanUp)
d14a1e28
RD
5679
5680
5681#----------------------------------------------------------------------------
5682
5683#---------------------------------------------------------------------------
2ef75293
RD
5684
5685class EventLoop(object):
093d3ff1 5686 """Proxy of C++ EventLoop class"""
2ef75293
RD
5687 def __repr__(self):
5688 return "<%s.%s; proxy of C++ wxEventLoop instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5689 def __init__(self, *args, **kwargs):
5690 """__init__(self) -> EventLoop"""
5691 newobj = _core_.new_EventLoop(*args, **kwargs)
5692 self.this = newobj.this
5693 self.thisown = 1
5694 del newobj.thisown
5695 def __del__(self, destroy=_core_.delete_EventLoop):
5696 """__del__(self)"""
5697 try:
5698 if self.thisown: destroy(self)
5699 except: pass
5700
5701 def Run(*args, **kwargs):
5702 """Run(self) -> int"""
5703 return _core_.EventLoop_Run(*args, **kwargs)
5704
5705 def Exit(*args, **kwargs):
5706 """Exit(self, int rc=0)"""
5707 return _core_.EventLoop_Exit(*args, **kwargs)
5708
5709 def Pending(*args, **kwargs):
5710 """Pending(self) -> bool"""
5711 return _core_.EventLoop_Pending(*args, **kwargs)
5712
5713 def Dispatch(*args, **kwargs):
5714 """Dispatch(self) -> bool"""
5715 return _core_.EventLoop_Dispatch(*args, **kwargs)
5716
5717 def IsRunning(*args, **kwargs):
5718 """IsRunning(self) -> bool"""
5719 return _core_.EventLoop_IsRunning(*args, **kwargs)
5720
5721 def GetActive(*args, **kwargs):
5722 """GetActive() -> EventLoop"""
5723 return _core_.EventLoop_GetActive(*args, **kwargs)
5724
5725 GetActive = staticmethod(GetActive)
5726 def SetActive(*args, **kwargs):
5727 """SetActive(EventLoop loop)"""
5728 return _core_.EventLoop_SetActive(*args, **kwargs)
5729
5730 SetActive = staticmethod(SetActive)
5731
5732class EventLoopPtr(EventLoop):
5733 def __init__(self, this):
5734 self.this = this
5735 if not hasattr(self,"thisown"): self.thisown = 0
5736 self.__class__ = EventLoop
5737_core_.EventLoop_swigregister(EventLoopPtr)
5738
5739def EventLoop_GetActive(*args, **kwargs):
5740 """EventLoop_GetActive() -> EventLoop"""
5741 return _core_.EventLoop_GetActive(*args, **kwargs)
5742
5743def EventLoop_SetActive(*args, **kwargs):
5744 """EventLoop_SetActive(EventLoop loop)"""
5745 return _core_.EventLoop_SetActive(*args, **kwargs)
5746
5747#---------------------------------------------------------------------------
d14a1e28 5748
1e0c8722 5749class AcceleratorEntry(object):
66c033b4
RD
5750 """
5751 A class used to define items in an `wx.AcceleratorTable`. wxPython
5752 programs can choose to use wx.AcceleratorEntry objects, but using a
5753 list of 3-tuple of integers (flags, keyCode, cmdID) usually works just
41e2b43e 5754 as well. See `__init__` for of the tuple values.
66c033b4
RD
5755
5756 :see: `wx.AcceleratorTable`
5757 """
1e0c8722
RD
5758 def __repr__(self):
5759 return "<%s.%s; proxy of C++ wxAcceleratorEntry instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5760 def __init__(self, *args, **kwargs):
66c033b4
RD
5761 """
5762 __init__(self, int flags=0, int keyCode=0, int cmdID=0) -> AcceleratorEntry
5763
5764 Construct a wx.AcceleratorEntry.
66c033b4 5765 """
54f9ee45 5766 newobj = _core_.new_AcceleratorEntry(*args, **kwargs)
1e0c8722
RD
5767 self.this = newobj.this
5768 self.thisown = 1
5769 del newobj.thisown
54f9ee45 5770 def __del__(self, destroy=_core_.delete_AcceleratorEntry):
a95a7133 5771 """__del__(self)"""
1e0c8722
RD
5772 try:
5773 if self.thisown: destroy(self)
5774 except: pass
5775
5776 def Set(*args, **kwargs):
66c033b4
RD
5777 """
5778 Set(self, int flags, int keyCode, int cmd)
1e0c8722 5779
66c033b4
RD
5780 (Re)set the attributes of a wx.AcceleratorEntry.
5781 :see `__init__`
5782 """
5783 return _core_.AcceleratorEntry_Set(*args, **kwargs)
1e0c8722
RD
5784
5785 def GetFlags(*args, **kwargs):
66c033b4
RD
5786 """
5787 GetFlags(self) -> int
5788
5789 Get the AcceleratorEntry's flags.
5790 """
54f9ee45 5791 return _core_.AcceleratorEntry_GetFlags(*args, **kwargs)
1e0c8722
RD
5792
5793 def GetKeyCode(*args, **kwargs):
66c033b4
RD
5794 """
5795 GetKeyCode(self) -> int
5796
5797 Get the AcceleratorEntry's keycode.
5798 """
54f9ee45 5799 return _core_.AcceleratorEntry_GetKeyCode(*args, **kwargs)
1e0c8722
RD
5800
5801 def GetCommand(*args, **kwargs):
66c033b4
RD
5802 """
5803 GetCommand(self) -> int
5804
5805 Get the AcceleratorEntry's command ID.
5806 """
54f9ee45 5807 return _core_.AcceleratorEntry_GetCommand(*args, **kwargs)
1e0c8722
RD
5808
5809
5810class AcceleratorEntryPtr(AcceleratorEntry):
5811 def __init__(self, this):
5812 self.this = this
5813 if not hasattr(self,"thisown"): self.thisown = 0
5814 self.__class__ = AcceleratorEntry
54f9ee45 5815_core_.AcceleratorEntry_swigregister(AcceleratorEntryPtr)
1e0c8722
RD
5816
5817class AcceleratorTable(Object):
66c033b4
RD
5818 """
5819 An accelerator table allows the application to specify a table of
5820 keyboard shortcuts for menus or other commands. On Windows, menu or
5821 button commands are supported; on GTK, only menu commands are
5822 supported.
66c033b4 5823 """
1e0c8722
RD
5824 def __repr__(self):
5825 return "<%s.%s; proxy of C++ wxAcceleratorTable instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5826 def __init__(self, *args, **kwargs):
0df68c9f
RD
5827 """
5828 __init__(entries) -> AcceleratorTable
1e0c8722 5829
66c033b4
RD
5830 Construct an AcceleratorTable from a list of `wx.AcceleratorEntry`
5831 items or or of 3-tuples (flags, keyCode, cmdID)
5832
5833 :see: `wx.AcceleratorEntry`
0df68c9f 5834 """
54f9ee45 5835 newobj = _core_.new_AcceleratorTable(*args, **kwargs)
1e0c8722
RD
5836 self.this = newobj.this
5837 self.thisown = 1
5838 del newobj.thisown
54f9ee45 5839 def __del__(self, destroy=_core_.delete_AcceleratorTable):
a95a7133 5840 """__del__(self)"""
1e0c8722
RD
5841 try:
5842 if self.thisown: destroy(self)
5843 except: pass
5844
5845 def Ok(*args, **kwargs):
a95a7133 5846 """Ok(self) -> bool"""
54f9ee45 5847 return _core_.AcceleratorTable_Ok(*args, **kwargs)
1e0c8722
RD
5848
5849
5850class AcceleratorTablePtr(AcceleratorTable):
5851 def __init__(self, this):
5852 self.this = this
5853 if not hasattr(self,"thisown"): self.thisown = 0
5854 self.__class__ = AcceleratorTable
54f9ee45 5855_core_.AcceleratorTable_swigregister(AcceleratorTablePtr)
1e0c8722
RD
5856
5857
5858def GetAccelFromString(*args, **kwargs):
196addbf 5859 """GetAccelFromString(String label) -> AcceleratorEntry"""
54f9ee45 5860 return _core_.GetAccelFromString(*args, **kwargs)
1e0c8722
RD
5861#---------------------------------------------------------------------------
5862
74a57fcd
RD
5863class VisualAttributes(object):
5864 """struct containing all the visual attributes of a control"""
5865 def __repr__(self):
5866 return "<%s.%s; proxy of C++ wxVisualAttributes instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5867 def __init__(self, *args, **kwargs):
5868 """
a95a7133 5869 __init__(self) -> VisualAttributes
74a57fcd
RD
5870
5871 struct containing all the visual attributes of a control
5872 """
54f9ee45 5873 newobj = _core_.new_VisualAttributes(*args, **kwargs)
74a57fcd
RD
5874 self.this = newobj.this
5875 self.thisown = 1
5876 del newobj.thisown
54f9ee45 5877 def __del__(self, destroy=_core_.delete_VisualAttributes):
a95a7133 5878 """__del__(self)"""
74a57fcd
RD
5879 try:
5880 if self.thisown: destroy(self)
5881 except: pass
5882
54f9ee45
RD
5883 font = property(_core_.VisualAttributes_font_get, _core_.VisualAttributes_font_set)
5884 colFg = property(_core_.VisualAttributes_colFg_get, _core_.VisualAttributes_colFg_set)
5885 colBg = property(_core_.VisualAttributes_colBg_get, _core_.VisualAttributes_colBg_set)
74a57fcd
RD
5886
5887class VisualAttributesPtr(VisualAttributes):
5888 def __init__(self, this):
5889 self.this = this
5890 if not hasattr(self,"thisown"): self.thisown = 0
5891 self.__class__ = VisualAttributes
54f9ee45 5892_core_.VisualAttributes_swigregister(VisualAttributesPtr)
74a57fcd
RD
5893NullAcceleratorTable = cvar.NullAcceleratorTable
5894PanelNameStr = cvar.PanelNameStr
5895
54f9ee45
RD
5896WINDOW_VARIANT_NORMAL = _core_.WINDOW_VARIANT_NORMAL
5897WINDOW_VARIANT_SMALL = _core_.WINDOW_VARIANT_SMALL
5898WINDOW_VARIANT_MINI = _core_.WINDOW_VARIANT_MINI
5899WINDOW_VARIANT_LARGE = _core_.WINDOW_VARIANT_LARGE
5900WINDOW_VARIANT_MAX = _core_.WINDOW_VARIANT_MAX
d14a1e28 5901class Window(EvtHandler):
15afbcd0
RD
5902 """
5903 wx.Window is the base class for all windows and represents any visible
5904 object on the screen. All controls, top level windows and so on are
5905 wx.Windows. Sizers and device contexts are not however, as they don't
5906 appear on screen themselves.
5907
5908 """
e811c8ce
RD
5909 def __repr__(self):
5910 return "<%s.%s; proxy of C++ wxWindow instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 5911 def __init__(self, *args, **kwargs):
0df68c9f 5912 """
a95a7133 5913 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
74a57fcd 5914 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> Window
15afbcd0
RD
5915
5916 Construct and show a generic Window.
0df68c9f 5917 """
54f9ee45 5918 newobj = _core_.new_Window(*args, **kwargs)
d14a1e28
RD
5919 self.this = newobj.this
5920 self.thisown = 1
5921 del newobj.thisown
5922 self._setOORInfo(self)
d14a1e28 5923
e811c8ce 5924 def Create(*args, **kwargs):
0df68c9f 5925 """
a95a7133 5926 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
74a57fcd 5927 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> bool
15afbcd0
RD
5928
5929 Create the GUI part of the Window for 2-phase creation mode.
0df68c9f 5930 """
54f9ee45 5931 return _core_.Window_Create(*args, **kwargs)
d14a1e28 5932
e811c8ce 5933 def Close(*args, **kwargs):
15afbcd0 5934 """
a95a7133 5935 Close(self, bool force=False) -> bool
15afbcd0
RD
5936
5937 This function simply generates a EVT_CLOSE event whose handler usually
5938 tries to close the window. It doesn't close the window itself,
5939 however. If force is False (the default) then the window's close
5940 handler will be allowed to veto the destruction of the window.
15afbcd0 5941 """
54f9ee45 5942 return _core_.Window_Close(*args, **kwargs)
d14a1e28 5943
e811c8ce 5944 def Destroy(*args, **kwargs):
0df68c9f 5945 """
a95a7133 5946 Destroy(self) -> bool
d14a1e28 5947
15afbcd0
RD
5948 Destroys the window safely. Frames and dialogs are not destroyed
5949 immediately when this function is called -- they are added to a list
5950 of windows to be deleted on idle time, when all the window's events
5951 have been processed. This prevents problems with events being sent to
5952 non-existent windows.
5953
5954 Returns True if the window has either been successfully deleted, or it
5955 has been added to the list of windows pending real deletion.
0df68c9f 5956 """
54f9ee45 5957 return _core_.Window_Destroy(*args, **kwargs)
d14a1e28 5958
e811c8ce 5959 def DestroyChildren(*args, **kwargs):
15afbcd0 5960 """
a95a7133 5961 DestroyChildren(self) -> bool
15afbcd0 5962
41e2b43e
RD
5963 Destroys all children of a window. Called automatically by the
5964 destructor.
15afbcd0 5965 """
54f9ee45 5966 return _core_.Window_DestroyChildren(*args, **kwargs)
d14a1e28 5967
e811c8ce 5968 def IsBeingDeleted(*args, **kwargs):
15afbcd0 5969 """
a95a7133 5970 IsBeingDeleted(self) -> bool
15afbcd0
RD
5971
5972 Is the window in the process of being deleted?
5973 """
54f9ee45 5974 return _core_.Window_IsBeingDeleted(*args, **kwargs)
d14a1e28 5975
e811c8ce 5976 def SetTitle(*args, **kwargs):
15afbcd0 5977 """
a95a7133 5978 SetTitle(self, String title)
15afbcd0
RD
5979
5980 Sets the window's title. Applicable only to frames and dialogs.
5981 """
54f9ee45 5982 return _core_.Window_SetTitle(*args, **kwargs)
d14a1e28 5983
e811c8ce 5984 def GetTitle(*args, **kwargs):
15afbcd0 5985 """
a95a7133 5986 GetTitle(self) -> String
15afbcd0
RD
5987
5988 Gets the window's title. Applicable only to frames and dialogs.
5989 """
54f9ee45 5990 return _core_.Window_GetTitle(*args, **kwargs)
d14a1e28 5991
e811c8ce 5992 def SetLabel(*args, **kwargs):
15afbcd0 5993 """
a95a7133 5994 SetLabel(self, String label)
15afbcd0
RD
5995
5996 Set the text which the window shows in its label if applicable.
5997 """
54f9ee45 5998 return _core_.Window_SetLabel(*args, **kwargs)
d14a1e28 5999
e811c8ce 6000 def GetLabel(*args, **kwargs):
15afbcd0 6001 """
a95a7133 6002 GetLabel(self) -> String
15afbcd0 6003
41e2b43e
RD
6004 Generic way of getting a label from any window, for identification
6005 purposes. The interpretation of this function differs from class to
6006 class. For frames and dialogs, the value returned is the title. For
6007 buttons or static text controls, it is the button text. This function
6008 can be useful for meta-programs such as testing tools or special-needs
6009 access programs)which need to identify windows by name.
15afbcd0 6010 """
54f9ee45 6011 return _core_.Window_GetLabel(*args, **kwargs)
d14a1e28 6012
e811c8ce 6013 def SetName(*args, **kwargs):
15afbcd0 6014 """
a95a7133 6015 SetName(self, String name)
15afbcd0 6016
41e2b43e
RD
6017 Sets the window's name. The window name is used for ressource setting
6018 in X, it is not the same as the window title/label
15afbcd0 6019 """
54f9ee45 6020 return _core_.Window_SetName(*args, **kwargs)
d14a1e28 6021
e811c8ce 6022 def GetName(*args, **kwargs):
15afbcd0 6023 """
a95a7133 6024 GetName(self) -> String
15afbcd0 6025
41e2b43e
RD
6026 Returns the windows name. This name is not guaranteed to be unique;
6027 it is up to the programmer to supply an appropriate name in the window
6028 constructor or via wx.Window.SetName.
15afbcd0 6029 """
54f9ee45 6030 return _core_.Window_GetName(*args, **kwargs)
d14a1e28 6031
4276dc52
RD
6032 def SetWindowVariant(*args, **kwargs):
6033 """
a95a7133 6034 SetWindowVariant(self, int variant)
4276dc52 6035
41e2b43e
RD
6036 Sets the variant of the window/font size to use for this window, if
6037 the platform supports variants, for example, wxMac.
4276dc52 6038 """
54f9ee45 6039 return _core_.Window_SetWindowVariant(*args, **kwargs)
4276dc52
RD
6040
6041 def GetWindowVariant(*args, **kwargs):
a95a7133 6042 """GetWindowVariant(self) -> int"""
54f9ee45 6043 return _core_.Window_GetWindowVariant(*args, **kwargs)
4276dc52 6044
e811c8ce 6045 def SetId(*args, **kwargs):
15afbcd0 6046 """
a95a7133 6047 SetId(self, int winid)
15afbcd0
RD
6048
6049 Sets the identifier of the window. Each window has an integer
6050 identifier. If the application has not provided one, an identifier
6051 will be generated. Normally, the identifier should be provided on
6052 creation and should not be modified subsequently.
6053 """
54f9ee45 6054 return _core_.Window_SetId(*args, **kwargs)
d14a1e28 6055
e811c8ce 6056 def GetId(*args, **kwargs):
15afbcd0 6057 """
a95a7133 6058 GetId(self) -> int
15afbcd0
RD
6059
6060 Returns the identifier of the window. Each window has an integer
6061 identifier. If the application has not provided one (or the default Id
6062 -1 is used) then an unique identifier with a negative value will be
6063 generated.
6064 """
54f9ee45 6065 return _core_.Window_GetId(*args, **kwargs)
d14a1e28 6066
e811c8ce 6067 def NewControlId(*args, **kwargs):
15afbcd0 6068 """
66c033b4 6069 NewControlId() -> int
15afbcd0
RD
6070
6071 Generate a control id for the controls which were not given one.
6072 """
54f9ee45 6073 return _core_.Window_NewControlId(*args, **kwargs)
d14a1e28 6074
e811c8ce
RD
6075 NewControlId = staticmethod(NewControlId)
6076 def NextControlId(*args, **kwargs):
15afbcd0 6077 """
66c033b4 6078 NextControlId(int winid) -> int
15afbcd0
RD
6079
6080 Get the id of the control following the one with the given
41e2b43e 6081 autogenerated) id
15afbcd0 6082 """
54f9ee45 6083 return _core_.Window_NextControlId(*args, **kwargs)
d14a1e28 6084
e811c8ce
RD
6085 NextControlId = staticmethod(NextControlId)
6086 def PrevControlId(*args, **kwargs):
15afbcd0 6087 """
66c033b4 6088 PrevControlId(int winid) -> int
15afbcd0
RD
6089
6090 Get the id of the control preceding the one with the given
41e2b43e 6091 autogenerated) id
15afbcd0 6092 """
54f9ee45 6093 return _core_.Window_PrevControlId(*args, **kwargs)
d14a1e28 6094
e811c8ce
RD
6095 PrevControlId = staticmethod(PrevControlId)
6096 def SetSize(*args, **kwargs):
15afbcd0 6097 """
a95a7133 6098 SetSize(self, Size size)
15afbcd0
RD
6099
6100 Sets the size of the window in pixels.
6101 """
54f9ee45 6102 return _core_.Window_SetSize(*args, **kwargs)
d14a1e28 6103
e811c8ce 6104 def SetDimensions(*args, **kwargs):
15afbcd0 6105 """
a95a7133 6106 SetDimensions(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)
15afbcd0
RD
6107
6108 Sets the position and size of the window in pixels. The sizeFlags
6109 parameter indicates the interpretation of the other params if they are
e505d15e
RD
6110 equal to -1.
6111
6112 ======================== ======================================
6113 wx.SIZE_AUTO A -1 indicates that a class-specific
6114 default should be used.
6115 wx.SIZE_USE_EXISTING Axisting dimensions should be used if
6116 -1 values are supplied.
6117 wxSIZE_ALLOW_MINUS_ONE Allow dimensions of -1 and less to be
6118 interpreted as real dimensions, not
6119 default values.
6120 ======================== ======================================
6121
15afbcd0 6122 """
54f9ee45 6123 return _core_.Window_SetDimensions(*args, **kwargs)
d14a1e28 6124
e811c8ce 6125 def SetRect(*args, **kwargs):
15afbcd0 6126 """
a95a7133 6127 SetRect(self, Rect rect, int sizeFlags=SIZE_AUTO)
15afbcd0
RD
6128
6129 Sets the position and size of the window in pixels using a wx.Rect.
6130 """
54f9ee45 6131 return _core_.Window_SetRect(*args, **kwargs)
d14a1e28 6132
e811c8ce 6133 def SetSizeWH(*args, **kwargs):
15afbcd0 6134 """
a95a7133 6135 SetSizeWH(self, int width, int height)
15afbcd0
RD
6136
6137 Sets the size of the window in pixels.
6138 """
54f9ee45 6139 return _core_.Window_SetSizeWH(*args, **kwargs)
d14a1e28 6140
e811c8ce 6141 def Move(*args, **kwargs):
15afbcd0 6142 """
a95a7133 6143 Move(self, Point pt, int flags=SIZE_USE_EXISTING)
15afbcd0
RD
6144
6145 Moves the window to the given position.
6146 """
54f9ee45 6147 return _core_.Window_Move(*args, **kwargs)
d14a1e28 6148
e811c8ce
RD
6149 SetPosition = Move
6150 def MoveXY(*args, **kwargs):
15afbcd0 6151 """
a95a7133 6152 MoveXY(self, int x, int y, int flags=SIZE_USE_EXISTING)
15afbcd0
RD
6153
6154 Moves the window to the given position.
6155 """
54f9ee45 6156 return _core_.Window_MoveXY(*args, **kwargs)
e811c8ce 6157
f8167d6e
RD
6158 def SetBestFittingSize(*args, **kwargs):
6159 """
6160 SetBestFittingSize(self, Size size=DefaultSize)
6161
6162 A 'Smart' SetSize that will fill in default size components with the
6163 window's *best size* values. Also set's the minsize for use with sizers.
6164 """
6165 return _core_.Window_SetBestFittingSize(*args, **kwargs)
6166
e811c8ce 6167 def Raise(*args, **kwargs):
15afbcd0 6168 """
a95a7133 6169 Raise(self)
15afbcd0
RD
6170
6171 Raises the window to the top of the window hierarchy if it is a
6172 managed window (dialog or frame).
6173 """
54f9ee45 6174 return _core_.Window_Raise(*args, **kwargs)
e811c8ce
RD
6175
6176 def Lower(*args, **kwargs):
15afbcd0 6177 """
a95a7133 6178 Lower(self)
15afbcd0
RD
6179
6180 Lowers the window to the bottom of the window hierarchy if it is a
6181 managed window (dialog or frame).
6182 """
54f9ee45 6183 return _core_.Window_Lower(*args, **kwargs)
e811c8ce
RD
6184
6185 def SetClientSize(*args, **kwargs):
15afbcd0 6186 """
a95a7133 6187 SetClientSize(self, Size size)
15afbcd0
RD
6188
6189 This sets the size of the window client area in pixels. Using this
6190 function to size a window tends to be more device-independent than
6191 wx.Window.SetSize, since the application need not worry about what
6192 dimensions the border or title bar have when trying to fit the window
6193 around panel items, for example.
6194 """
54f9ee45 6195 return _core_.Window_SetClientSize(*args, **kwargs)
e811c8ce
RD
6196
6197 def SetClientSizeWH(*args, **kwargs):
15afbcd0 6198 """
a95a7133 6199 SetClientSizeWH(self, int width, int height)
15afbcd0
RD
6200
6201 This sets the size of the window client area in pixels. Using this
6202 function to size a window tends to be more device-independent than
6203 wx.Window.SetSize, since the application need not worry about what
6204 dimensions the border or title bar have when trying to fit the window
6205 around panel items, for example.
6206 """
54f9ee45 6207 return _core_.Window_SetClientSizeWH(*args, **kwargs)
e811c8ce
RD
6208
6209 def SetClientRect(*args, **kwargs):
15afbcd0 6210 """
a95a7133 6211 SetClientRect(self, Rect rect)
15afbcd0
RD
6212
6213 This sets the size of the window client area in pixels. Using this
6214 function to size a window tends to be more device-independent than
6215 wx.Window.SetSize, since the application need not worry about what
6216 dimensions the border or title bar have when trying to fit the window
6217 around panel items, for example.
6218 """
54f9ee45 6219 return _core_.Window_SetClientRect(*args, **kwargs)
e811c8ce
RD
6220
6221 def GetPosition(*args, **kwargs):
0df68c9f 6222 """
a95a7133 6223 GetPosition(self) -> Point
e811c8ce 6224
0df68c9f
RD
6225 Get the window's position.
6226 """
54f9ee45 6227 return _core_.Window_GetPosition(*args, **kwargs)
e811c8ce
RD
6228
6229 def GetPositionTuple(*args, **kwargs):
0df68c9f
RD
6230 """
6231 GetPositionTuple() -> (x,y)
e811c8ce 6232
0df68c9f
RD
6233 Get the window's position.
6234 """
54f9ee45 6235 return _core_.Window_GetPositionTuple(*args, **kwargs)
e811c8ce
RD
6236
6237 def GetSize(*args, **kwargs):
0df68c9f 6238 """
a95a7133 6239 GetSize(self) -> Size
e811c8ce 6240
0df68c9f
RD
6241 Get the window size.
6242 """
54f9ee45 6243 return _core_.Window_GetSize(*args, **kwargs)
e811c8ce
RD
6244
6245 def GetSizeTuple(*args, **kwargs):
0df68c9f
RD
6246 """
6247 GetSizeTuple() -> (width, height)
e811c8ce 6248
0df68c9f
RD
6249 Get the window size.
6250 """
54f9ee45 6251 return _core_.Window_GetSizeTuple(*args, **kwargs)
e811c8ce
RD
6252
6253 def GetRect(*args, **kwargs):
15afbcd0 6254 """
a95a7133 6255 GetRect(self) -> Rect
15afbcd0
RD
6256
6257 Returns the size and position of the window as a wx.Rect object.
6258 """
54f9ee45 6259 return _core_.Window_GetRect(*args, **kwargs)
e811c8ce
RD
6260
6261 def GetClientSize(*args, **kwargs):
0df68c9f 6262 """
a95a7133 6263 GetClientSize(self) -> Size
e811c8ce 6264
15afbcd0
RD
6265 This gets the size of the window's 'client area' in pixels. The client
6266 area is the area which may be drawn on by the programmer, excluding
6267 title bar, border, scrollbars, etc.
0df68c9f 6268 """
54f9ee45 6269 return _core_.Window_GetClientSize(*args, **kwargs)
e811c8ce
RD
6270
6271 def GetClientSizeTuple(*args, **kwargs):
0df68c9f
RD
6272 """
6273 GetClientSizeTuple() -> (width, height)
e811c8ce 6274
15afbcd0
RD
6275 This gets the size of the window's 'client area' in pixels. The client
6276 area is the area which may be drawn on by the programmer, excluding
6277 title bar, border, scrollbars, etc.
0df68c9f 6278 """
54f9ee45 6279 return _core_.Window_GetClientSizeTuple(*args, **kwargs)
e811c8ce
RD
6280
6281 def GetClientAreaOrigin(*args, **kwargs):
15afbcd0 6282 """
a95a7133 6283 GetClientAreaOrigin(self) -> Point
15afbcd0
RD
6284
6285 Get the origin of the client area of the window relative to the
6286 window's top left corner (the client area may be shifted because of
6287 the borders, scrollbars, other decorations...)
6288 """
54f9ee45 6289 return _core_.Window_GetClientAreaOrigin(*args, **kwargs)
e811c8ce
RD
6290
6291 def GetClientRect(*args, **kwargs):
15afbcd0 6292 """
a95a7133 6293 GetClientRect(self) -> Rect
15afbcd0 6294
61863841 6295 Get the client area position and size as a `wx.Rect` object.
15afbcd0 6296 """
54f9ee45 6297 return _core_.Window_GetClientRect(*args, **kwargs)
e811c8ce
RD
6298
6299 def GetBestSize(*args, **kwargs):
0df68c9f 6300 """
a95a7133 6301 GetBestSize(self) -> Size
e811c8ce 6302
248ed943 6303 This function returns the best acceptable minimal size for the
41e2b43e
RD
6304 window, if applicable. For example, for a static text control, it will
6305 be the minimal size such that the control label is not truncated. For
6306 windows containing subwindows (suzh aswx.Panel), the size returned by
6307 this function will be the same as the size the window would have had
6308 after calling Fit.
0df68c9f 6309 """
54f9ee45 6310 return _core_.Window_GetBestSize(*args, **kwargs)
e811c8ce
RD
6311
6312 def GetBestSizeTuple(*args, **kwargs):
0df68c9f
RD
6313 """
6314 GetBestSizeTuple() -> (width, height)
e811c8ce 6315
248ed943 6316 This function returns the best acceptable minimal size for the
41e2b43e
RD
6317 window, if applicable. For example, for a static text control, it will
6318 be the minimal size such that the control label is not truncated. For
6319 windows containing subwindows (suzh aswx.Panel), the size returned by
6320 this function will be the same as the size the window would have had
6321 after calling Fit.
0df68c9f 6322 """
54f9ee45 6323 return _core_.Window_GetBestSizeTuple(*args, **kwargs)
e811c8ce 6324
dfbb5885
RD
6325 def InvalidateBestSize(*args, **kwargs):
6326 """
6327 InvalidateBestSize(self)
6328
6329 Reset the cached best size value so it will be recalculated the next
6330 time it is needed.
6331 """
6332 return _core_.Window_InvalidateBestSize(*args, **kwargs)
6333
6334 def GetBestFittingSize(*args, **kwargs):
6335 """
6336 GetBestFittingSize(self) -> Size
6337
6338 This function will merge the window's best size into the window's
6339 minimum size, giving priority to the min size components, and returns
6340 the results.
6341
6342 """
6343 return _core_.Window_GetBestFittingSize(*args, **kwargs)
6344
e811c8ce 6345 def GetAdjustedBestSize(*args, **kwargs):
15afbcd0 6346 """
a95a7133 6347 GetAdjustedBestSize(self) -> Size
15afbcd0
RD
6348
6349 This method is similar to GetBestSize, except in one
6350 thing. GetBestSize should return the minimum untruncated size of the
6351 window, while this method will return the largest of BestSize and any
6352 user specified minimum size. ie. it is the minimum size the window
6353 should currently be drawn at, not the minimal size it can possibly
6354 tolerate.
6355 """
54f9ee45 6356 return _core_.Window_GetAdjustedBestSize(*args, **kwargs)
e811c8ce
RD
6357
6358 def Center(*args, **kwargs):
15afbcd0 6359 """
a95a7133 6360 Center(self, int direction=BOTH)
15afbcd0
RD
6361
6362 Centers the window. The parameter specifies the direction for
6363 cetering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may
6364 also include wx.CENTER_ON_SCREEN flag if you want to center the window
6365 on the entire screen and not on its parent window. If it is a
6366 top-level window and has no parent then it will always be centered
6367 relative to the screen.
6368 """
54f9ee45 6369 return _core_.Window_Center(*args, **kwargs)
e811c8ce
RD
6370
6371 Centre = Center
6372 def CenterOnScreen(*args, **kwargs):
15afbcd0 6373 """
a95a7133 6374 CenterOnScreen(self, int dir=BOTH)
15afbcd0
RD
6375
6376 Center on screen (only works for top level windows)
6377 """
54f9ee45 6378 return _core_.Window_CenterOnScreen(*args, **kwargs)
e811c8ce
RD
6379
6380 CentreOnScreen = CenterOnScreen
6381 def CenterOnParent(*args, **kwargs):
15afbcd0 6382 """
a95a7133 6383 CenterOnParent(self, int dir=BOTH)
15afbcd0
RD
6384
6385 Center with respect to the the parent window
6386 """
54f9ee45 6387 return _core_.Window_CenterOnParent(*args, **kwargs)
e811c8ce
RD
6388
6389 CentreOnParent = CenterOnParent
6390 def Fit(*args, **kwargs):
15afbcd0 6391 """
a95a7133 6392 Fit(self)
15afbcd0
RD
6393
6394 Sizes the window so that it fits around its subwindows. This function
6395 won't do anything if there are no subwindows and will only really work
6396 correctly if sizers are used for the subwindows layout. Also, if the
6397 window has exactly one subwindow it is better (faster and the result
6398 is more precise as Fit adds some margin to account for fuzziness of
6399 its calculations) to call window.SetClientSize(child.GetSize())
6400 instead of calling Fit.
6401 """
54f9ee45 6402 return _core_.Window_Fit(*args, **kwargs)
e811c8ce
RD
6403
6404 def FitInside(*args, **kwargs):
15afbcd0 6405 """
a95a7133 6406 FitInside(self)
15afbcd0
RD
6407
6408 Similar to Fit, but sizes the interior (virtual) size of a
6409 window. Mainly useful with scrolled windows to reset scrollbars after
6410 sizing changes that do not trigger a size event, and/or scrolled
6411 windows without an interior sizer. This function similarly won't do
6412 anything if there are no subwindows.
6413 """
54f9ee45 6414 return _core_.Window_FitInside(*args, **kwargs)
e811c8ce 6415
f16ab95d 6416 def SetSizeHints(*args, **kwargs):
0df68c9f 6417 """
a95a7133 6418 SetSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1,
0df68c9f 6419 int incH=-1)
15afbcd0
RD
6420
6421 Allows specification of minimum and maximum window sizes, and window
6422 size increments. If a pair of values is not set (or set to -1), the
6423 default values will be used. If this function is called, the user
908b74cd
RD
6424 will not be able to size the window outside the given bounds (if it is
6425 a top-level window.) Sizers will also inspect the minimum window size
6426 and will use that value if set when calculating layout.
6427
6428 The resizing increments are only significant under Motif or Xt.
0df68c9f 6429 """
f16ab95d 6430 return _core_.Window_SetSizeHints(*args, **kwargs)
e811c8ce 6431
f16ab95d
RD
6432 def SetSizeHintsSz(*args, **kwargs):
6433 """
6434 SetSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize, Size incSize=DefaultSize)
6435
6436 Allows specification of minimum and maximum window sizes, and window
6437 size increments. If a pair of values is not set (or set to -1), the
6438 default values will be used. If this function is called, the user
6439 will not be able to size the window outside the given bounds (if it is
6440 a top-level window.) Sizers will also inspect the minimum window size
6441 and will use that value if set when calculating layout.
6442
6443 The resizing increments are only significant under Motif or Xt.
6444 """
6445 return _core_.Window_SetSizeHintsSz(*args, **kwargs)
6446
6447 def SetVirtualSizeHints(*args, **kwargs):
15afbcd0 6448 """
908b74cd 6449 SetVirtualSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1)
15afbcd0
RD
6450
6451 Allows specification of minimum and maximum virtual window sizes. If a
6452 pair of values is not set (or set to -1), the default values will be
6453 used. If this function is called, the user will not be able to size
6454 the virtual area of the window outside the given bounds.
6455 """
f16ab95d
RD
6456 return _core_.Window_SetVirtualSizeHints(*args, **kwargs)
6457
6458 def SetVirtualSizeHintsSz(*args, **kwargs):
6459 """
6460 SetVirtualSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize)
6461
6462 Allows specification of minimum and maximum virtual window sizes. If a
6463 pair of values is not set (or set to -1), the default values will be
6464 used. If this function is called, the user will not be able to size
6465 the virtual area of the window outside the given bounds.
6466 """
6467 return _core_.Window_SetVirtualSizeHintsSz(*args, **kwargs)
e811c8ce 6468
908b74cd
RD
6469 def GetMaxSize(*args, **kwargs):
6470 """GetMaxSize(self) -> Size"""
6471 return _core_.Window_GetMaxSize(*args, **kwargs)
6472
6473 def GetMinSize(*args, **kwargs):
6474 """GetMinSize(self) -> Size"""
6475 return _core_.Window_GetMinSize(*args, **kwargs)
6476
6477 def SetMinSize(*args, **kwargs):
6478 """
6479 SetMinSize(self, Size minSize)
6480
6481 A more convenient method than `SetSizeHints` for setting just the
6482 min size.
6483 """
6484 return _core_.Window_SetMinSize(*args, **kwargs)
6485
6486 def SetMaxSize(*args, **kwargs):
6487 """
6488 SetMaxSize(self, Size maxSize)
6489
6490 A more convenient method than `SetSizeHints` for setting just the
6491 max size.
6492 """
6493 return _core_.Window_SetMaxSize(*args, **kwargs)
6494
e811c8ce 6495 def GetMinWidth(*args, **kwargs):
a95a7133 6496 """GetMinWidth(self) -> int"""
54f9ee45 6497 return _core_.Window_GetMinWidth(*args, **kwargs)
e811c8ce
RD
6498
6499 def GetMinHeight(*args, **kwargs):
a95a7133 6500 """GetMinHeight(self) -> int"""
54f9ee45 6501 return _core_.Window_GetMinHeight(*args, **kwargs)
e811c8ce
RD
6502
6503 def GetMaxWidth(*args, **kwargs):
a95a7133 6504 """GetMaxWidth(self) -> int"""
54f9ee45 6505 return _core_.Window_GetMaxWidth(*args, **kwargs)
e811c8ce
RD
6506
6507 def GetMaxHeight(*args, **kwargs):
a95a7133 6508 """GetMaxHeight(self) -> int"""
54f9ee45 6509 return _core_.Window_GetMaxHeight(*args, **kwargs)
e811c8ce 6510
e811c8ce 6511 def SetVirtualSize(*args, **kwargs):
0df68c9f 6512 """
a95a7133 6513 SetVirtualSize(self, Size size)
e811c8ce 6514
15afbcd0
RD
6515 Set the the virtual size of a window in pixels. For most windows this
6516 is just the client area of the window, but for some like scrolled
6517 windows it is more or less independent of the screen window size.
0df68c9f 6518 """
54f9ee45 6519 return _core_.Window_SetVirtualSize(*args, **kwargs)
e811c8ce
RD
6520
6521 def SetVirtualSizeWH(*args, **kwargs):
0df68c9f 6522 """
a95a7133 6523 SetVirtualSizeWH(self, int w, int h)
e811c8ce 6524
15afbcd0
RD
6525 Set the the virtual size of a window in pixels. For most windows this
6526 is just the client area of the window, but for some like scrolled
6527 windows it is more or less independent of the screen window size.
0df68c9f 6528 """
54f9ee45 6529 return _core_.Window_SetVirtualSizeWH(*args, **kwargs)
e811c8ce
RD
6530
6531 def GetVirtualSize(*args, **kwargs):
0df68c9f 6532 """
a95a7133 6533 GetVirtualSize(self) -> Size
e811c8ce 6534
15afbcd0
RD
6535 Get the the virtual size of the window in pixels. For most windows
6536 this is just the client area of the window, but for some like scrolled
6537 windows it is more or less independent of the screen window size.
0df68c9f 6538 """
54f9ee45 6539 return _core_.Window_GetVirtualSize(*args, **kwargs)
e811c8ce
RD
6540
6541 def GetVirtualSizeTuple(*args, **kwargs):
0df68c9f
RD
6542 """
6543 GetVirtualSizeTuple() -> (width, height)
e811c8ce 6544
15afbcd0
RD
6545 Get the the virtual size of the window in pixels. For most windows
6546 this is just the client area of the window, but for some like scrolled
6547 windows it is more or less independent of the screen window size.
0df68c9f 6548 """
54f9ee45 6549 return _core_.Window_GetVirtualSizeTuple(*args, **kwargs)
e811c8ce
RD
6550
6551 def GetBestVirtualSize(*args, **kwargs):
15afbcd0 6552 """
a95a7133 6553 GetBestVirtualSize(self) -> Size
15afbcd0
RD
6554
6555 Return the largest of ClientSize and BestSize (as determined by a
6556 sizer, interior children, or other means)
6557 """
54f9ee45 6558 return _core_.Window_GetBestVirtualSize(*args, **kwargs)
e811c8ce
RD
6559
6560 def Show(*args, **kwargs):
15afbcd0 6561 """
a95a7133 6562 Show(self, bool show=True) -> bool
15afbcd0
RD
6563
6564 Shows or hides the window. You may need to call Raise for a top level
6565 window if you want to bring it to top, although this is not needed if
6566 Show is called immediately after the frame creation. Returns True if
6567 the window has been shown or hidden or False if nothing was done
6568 because it already was in the requested state.
6569 """
54f9ee45 6570 return _core_.Window_Show(*args, **kwargs)
e811c8ce
RD
6571
6572 def Hide(*args, **kwargs):
15afbcd0 6573 """
a95a7133 6574 Hide(self) -> bool
15afbcd0
RD
6575
6576 Equivalent to calling Show(False).
6577 """
54f9ee45 6578 return _core_.Window_Hide(*args, **kwargs)
e811c8ce
RD
6579
6580 def Enable(*args, **kwargs):
15afbcd0 6581 """
a95a7133 6582 Enable(self, bool enable=True) -> bool
15afbcd0
RD
6583
6584 Enable or disable the window for user input. Note that when a parent
6585 window is disabled, all of its children are disabled as well and they
6586 are reenabled again when the parent is. Returns true if the window
6587 has been enabled or disabled, false if nothing was done, i.e. if the
6588 window had already been in the specified state.
6589 """
54f9ee45 6590 return _core_.Window_Enable(*args, **kwargs)
e811c8ce
RD
6591
6592 def Disable(*args, **kwargs):
15afbcd0 6593 """
a95a7133 6594 Disable(self) -> bool
15afbcd0
RD
6595
6596 Disables the window, same as Enable(false).
6597 """
54f9ee45 6598 return _core_.Window_Disable(*args, **kwargs)
e811c8ce
RD
6599
6600 def IsShown(*args, **kwargs):
15afbcd0 6601 """
a95a7133 6602 IsShown(self) -> bool
15afbcd0
RD
6603
6604 Returns true if the window is shown, false if it has been hidden.
6605 """
54f9ee45 6606 return _core_.Window_IsShown(*args, **kwargs)
e811c8ce
RD
6607
6608 def IsEnabled(*args, **kwargs):
15afbcd0 6609 """
a95a7133 6610 IsEnabled(self) -> bool
15afbcd0
RD
6611
6612 Returns true if the window is enabled for input, false otherwise.
6613 """
54f9ee45 6614 return _core_.Window_IsEnabled(*args, **kwargs)
e811c8ce
RD
6615
6616 def SetWindowStyleFlag(*args, **kwargs):
15afbcd0 6617 """
a95a7133 6618 SetWindowStyleFlag(self, long style)
15afbcd0 6619
41e2b43e
RD
6620 Sets the style of the window. Please note that some styles cannot be
6621 changed after the window creation and that Refresh() might need to be
6622 called after changing the others for the change to take place
6623 immediately.
15afbcd0 6624 """
54f9ee45 6625 return _core_.Window_SetWindowStyleFlag(*args, **kwargs)
e811c8ce
RD
6626
6627 def GetWindowStyleFlag(*args, **kwargs):
15afbcd0 6628 """
a95a7133 6629 GetWindowStyleFlag(self) -> long
e811c8ce 6630
15afbcd0
RD
6631 Gets the window style that was passed to the constructor or Create
6632 method.
6633 """
54f9ee45 6634 return _core_.Window_GetWindowStyleFlag(*args, **kwargs)
e811c8ce 6635
15afbcd0 6636 SetWindowStyle = SetWindowStyleFlag; GetWindowStyle = GetWindowStyleFlag
e811c8ce 6637 def HasFlag(*args, **kwargs):
15afbcd0 6638 """
a95a7133 6639 HasFlag(self, int flag) -> bool
15afbcd0
RD
6640
6641 Test if the given style is set for this window.
6642 """
54f9ee45 6643 return _core_.Window_HasFlag(*args, **kwargs)
e811c8ce
RD
6644
6645 def IsRetained(*args, **kwargs):
15afbcd0 6646 """
a95a7133 6647 IsRetained(self) -> bool
15afbcd0
RD
6648
6649 Returns true if the window is retained, false otherwise. Retained
6650 windows are only available on X platforms.
6651 """
54f9ee45 6652 return _core_.Window_IsRetained(*args, **kwargs)
e811c8ce
RD
6653
6654 def SetExtraStyle(*args, **kwargs):
15afbcd0 6655 """
a95a7133 6656 SetExtraStyle(self, long exStyle)
15afbcd0
RD
6657
6658 Sets the extra style bits for the window. Extra styles are the less
6659 often used style bits which can't be set with the constructor or with
6660 SetWindowStyleFlag()
6661 """
54f9ee45 6662 return _core_.Window_SetExtraStyle(*args, **kwargs)
e811c8ce
RD
6663
6664 def GetExtraStyle(*args, **kwargs):
15afbcd0 6665 """
a95a7133 6666 GetExtraStyle(self) -> long
15afbcd0
RD
6667
6668 Returns the extra style bits for the window.
6669 """
54f9ee45 6670 return _core_.Window_GetExtraStyle(*args, **kwargs)
e811c8ce
RD
6671
6672 def MakeModal(*args, **kwargs):
15afbcd0 6673 """
a95a7133 6674 MakeModal(self, bool modal=True)
15afbcd0
RD
6675
6676 Disables all other windows in the application so that the user can
6677 only interact with this window. Passing False will reverse this
6678 effect.
6679 """
54f9ee45 6680 return _core_.Window_MakeModal(*args, **kwargs)
e811c8ce
RD
6681
6682 def SetThemeEnabled(*args, **kwargs):
15afbcd0 6683 """
a95a7133 6684 SetThemeEnabled(self, bool enableTheme)
15afbcd0
RD
6685
6686 This function tells a window if it should use the system's "theme"
6687 code to draw the windows' background instead if its own background
6688 drawing code. This will only have an effect on platforms that support
6689 the notion of themes in user defined windows. One such platform is
6690 GTK+ where windows can have (very colourful) backgrounds defined by a
6691 user's selected theme.
6692
6693 Dialogs, notebook pages and the status bar have this flag set to true
6694 by default so that the default look and feel is simulated best.
6695 """
54f9ee45 6696 return _core_.Window_SetThemeEnabled(*args, **kwargs)
e811c8ce
RD
6697
6698 def GetThemeEnabled(*args, **kwargs):
15afbcd0 6699 """
a95a7133 6700 GetThemeEnabled(self) -> bool
e811c8ce 6701
15afbcd0
RD
6702 Return the themeEnabled flag.
6703 """
54f9ee45 6704 return _core_.Window_GetThemeEnabled(*args, **kwargs)
e811c8ce
RD
6705
6706 def SetFocus(*args, **kwargs):
15afbcd0 6707 """
a95a7133 6708 SetFocus(self)
15afbcd0
RD
6709
6710 Set's the focus to this window, allowing it to receive keyboard input.
6711 """
54f9ee45 6712 return _core_.Window_SetFocus(*args, **kwargs)
e811c8ce
RD
6713
6714 def SetFocusFromKbd(*args, **kwargs):
15afbcd0 6715 """
a95a7133 6716 SetFocusFromKbd(self)
15afbcd0
RD
6717
6718 Set focus to this window as the result of a keyboard action. Normally
6719 only called internally.
6720 """
54f9ee45 6721 return _core_.Window_SetFocusFromKbd(*args, **kwargs)
e811c8ce
RD
6722
6723 def FindFocus(*args, **kwargs):
15afbcd0 6724 """
66c033b4 6725 FindFocus() -> Window
15afbcd0
RD
6726
6727 Returns the window or control that currently has the keyboard focus,
6728 or None.
6729 """
54f9ee45 6730 return _core_.Window_FindFocus(*args, **kwargs)
e811c8ce
RD
6731
6732 FindFocus = staticmethod(FindFocus)
6733 def AcceptsFocus(*args, **kwargs):
15afbcd0 6734 """
a95a7133 6735 AcceptsFocus(self) -> bool
15afbcd0
RD
6736
6737 Can this window have focus?
6738 """
54f9ee45 6739 return _core_.Window_AcceptsFocus(*args, **kwargs)
e811c8ce
RD
6740
6741 def AcceptsFocusFromKeyboard(*args, **kwargs):
15afbcd0 6742 """
a95a7133 6743 AcceptsFocusFromKeyboard(self) -> bool
15afbcd0
RD
6744
6745 Can this window be given focus by keyboard navigation? if not, the
6746 only way to give it focus (provided it accepts it at all) is to click
6747 it.
6748 """
54f9ee45 6749 return _core_.Window_AcceptsFocusFromKeyboard(*args, **kwargs)
e811c8ce
RD
6750
6751 def GetDefaultItem(*args, **kwargs):
15afbcd0 6752 """
a95a7133 6753 GetDefaultItem(self) -> Window
15afbcd0
RD
6754
6755 Get the default child of this parent, i.e. the one which is activated
6756 by pressing <Enter> such as the OK button on a wx.Dialog.
6757 """
54f9ee45 6758 return _core_.Window_GetDefaultItem(*args, **kwargs)
e811c8ce
RD
6759
6760 def SetDefaultItem(*args, **kwargs):
15afbcd0 6761 """
a95a7133 6762 SetDefaultItem(self, Window child) -> Window
15afbcd0
RD
6763
6764 Set this child as default, return the old default.
6765 """
54f9ee45 6766 return _core_.Window_SetDefaultItem(*args, **kwargs)
e811c8ce
RD
6767
6768 def SetTmpDefaultItem(*args, **kwargs):
15afbcd0 6769 """
a95a7133 6770 SetTmpDefaultItem(self, Window win)
15afbcd0
RD
6771
6772 Set this child as temporary default
6773 """
54f9ee45 6774 return _core_.Window_SetTmpDefaultItem(*args, **kwargs)
e811c8ce 6775
908b74cd
RD
6776 def Navigate(*args, **kwargs):
6777 """
6778 Navigate(self, int flags=NavigationKeyEvent.IsForward) -> bool
6779
fd2dc343
RD
6780 Does keyboard navigation from this window to another, by sending a
6781 `wx.NavigationKeyEvent`.
908b74cd
RD
6782 """
6783 return _core_.Window_Navigate(*args, **kwargs)
6784
7f98d120
RD
6785 def MoveAfterInTabOrder(*args, **kwargs):
6786 """
6787 MoveAfterInTabOrder(self, Window win)
6788
6789 Moves this window in the tab navigation order after the specified
6790 sibling window. This means that when the user presses the TAB key on
6791 that other window, the focus switches to this window.
6792
6793 The default tab order is the same as creation order. This function
6794 and `MoveBeforeInTabOrder` allow to change it after creating all the
6795 windows.
6796
6797 """
6798 return _core_.Window_MoveAfterInTabOrder(*args, **kwargs)
6799
6800 def MoveBeforeInTabOrder(*args, **kwargs):
6801 """
6802 MoveBeforeInTabOrder(self, Window win)
6803
6804 Same as `MoveAfterInTabOrder` except that it inserts this window just
6805 before win instead of putting it right after it.
6806 """
6807 return _core_.Window_MoveBeforeInTabOrder(*args, **kwargs)
6808
e811c8ce 6809 def GetChildren(*args, **kwargs):
15afbcd0 6810 """
a95a7133 6811 GetChildren(self) -> PyObject
15afbcd0
RD
6812
6813 Returns a list of the window's children. NOTE: Currently this is a
6814 copy of the child window list maintained by the window, so the return
6815 value of this function is only valid as long as the window's children
6816 do not change.
6817 """
54f9ee45 6818 return _core_.Window_GetChildren(*args, **kwargs)
e811c8ce
RD
6819
6820 def GetParent(*args, **kwargs):
15afbcd0 6821 """
a95a7133 6822 GetParent(self) -> Window
15afbcd0
RD
6823
6824 Returns the parent window of this window, or None if there isn't one.
6825 """
54f9ee45 6826 return _core_.Window_GetParent(*args, **kwargs)
e811c8ce
RD
6827
6828 def GetGrandParent(*args, **kwargs):
15afbcd0 6829 """
a95a7133 6830 GetGrandParent(self) -> Window
15afbcd0 6831
41e2b43e
RD
6832 Returns the parent of the parent of this window, or None if there
6833 isn't one.
15afbcd0 6834 """
54f9ee45 6835 return _core_.Window_GetGrandParent(*args, **kwargs)
e811c8ce
RD
6836
6837 def IsTopLevel(*args, **kwargs):
15afbcd0 6838 """
a95a7133 6839 IsTopLevel(self) -> bool
15afbcd0
RD
6840
6841 Returns true if the given window is a top-level one. Currently all
6842 frames and dialogs are always considered to be top-level windows (even
6843 if they have a parent window).
6844 """
54f9ee45 6845 return _core_.Window_IsTopLevel(*args, **kwargs)
e811c8ce
RD
6846
6847 def Reparent(*args, **kwargs):
15afbcd0 6848 """
a95a7133 6849 Reparent(self, Window newParent) -> bool
15afbcd0
RD
6850
6851 Reparents the window, i.e the window will be removed from its current
6852 parent window (e.g. a non-standard toolbar in a wxFrame) and then
6853 re-inserted into another. Available on Windows and GTK. Returns True
6854 if the parent was changed, False otherwise (error or newParent ==
6855 oldParent)
6856 """
54f9ee45 6857 return _core_.Window_Reparent(*args, **kwargs)
e811c8ce
RD
6858
6859 def AddChild(*args, **kwargs):
15afbcd0 6860 """
a95a7133 6861 AddChild(self, Window child)
15afbcd0
RD
6862
6863 Adds a child window. This is called automatically by window creation
6864 functions so should not be required by the application programmer.
6865 """
54f9ee45 6866 return _core_.Window_AddChild(*args, **kwargs)
e811c8ce
RD
6867
6868 def RemoveChild(*args, **kwargs):
15afbcd0 6869 """
a95a7133 6870 RemoveChild(self, Window child)
15afbcd0
RD
6871
6872 Removes a child window. This is called automatically by window
6873 deletion functions so should not be required by the application
6874 programmer.
6875 """
54f9ee45 6876 return _core_.Window_RemoveChild(*args, **kwargs)
e811c8ce
RD
6877
6878 def FindWindowById(*args, **kwargs):
15afbcd0 6879 """
a95a7133 6880 FindWindowById(self, long winid) -> Window
15afbcd0
RD
6881
6882 Find a chld of this window by window ID
6883 """
54f9ee45 6884 return _core_.Window_FindWindowById(*args, **kwargs)
e811c8ce
RD
6885
6886 def FindWindowByName(*args, **kwargs):
15afbcd0 6887 """
a95a7133 6888 FindWindowByName(self, String name) -> Window
15afbcd0
RD
6889
6890 Find a child of this window by name
6891 """
54f9ee45 6892 return _core_.Window_FindWindowByName(*args, **kwargs)
e811c8ce
RD
6893
6894 def GetEventHandler(*args, **kwargs):
15afbcd0 6895 """
a95a7133 6896 GetEventHandler(self) -> EvtHandler
15afbcd0
RD
6897
6898 Returns the event handler for this window. By default, the window is
6899 its own event handler.
6900 """
54f9ee45 6901 return _core_.Window_GetEventHandler(*args, **kwargs)
e811c8ce
RD
6902
6903 def SetEventHandler(*args, **kwargs):
15afbcd0 6904 """
a95a7133 6905 SetEventHandler(self, EvtHandler handler)
15afbcd0
RD
6906
6907 Sets the event handler for this window. An event handler is an object
6908 that is capable of processing the events sent to a window. By default,
6909 the window is its own event handler, but an application may wish to
6910 substitute another, for example to allow central implementation of
6911 event-handling for a variety of different window classes.
6912
41e2b43e 6913 It is usually better to use `wx.Window.PushEventHandler` since this sets
15afbcd0
RD
6914 up a chain of event handlers, where an event not handled by one event
6915 handler is handed to the next one in the chain.
6916 """
54f9ee45 6917 return _core_.Window_SetEventHandler(*args, **kwargs)
e811c8ce
RD
6918
6919 def PushEventHandler(*args, **kwargs):
15afbcd0 6920 """
a95a7133 6921 PushEventHandler(self, EvtHandler handler)
15afbcd0
RD
6922
6923 Pushes this event handler onto the event handler stack for the window.
6924 An event handler is an object that is capable of processing the events
6925 sent to a window. By default, the window is its own event handler, but
6926 an application may wish to substitute another, for example to allow
6927 central implementation of event-handling for a variety of different
6928 window classes.
6929
6930 wx.Window.PushEventHandler allows an application to set up a chain of
6931 event handlers, where an event not handled by one event handler is
41e2b43e 6932 handed to the next one in the chain. Use `wx.Window.PopEventHandler` to
15afbcd0
RD
6933 remove the event handler.
6934 """
54f9ee45 6935 return _core_.Window_PushEventHandler(*args, **kwargs)
e811c8ce
RD
6936
6937 def PopEventHandler(*args, **kwargs):
15afbcd0 6938 """
a95a7133 6939 PopEventHandler(self, bool deleteHandler=False) -> EvtHandler
15afbcd0
RD
6940
6941 Removes and returns the top-most event handler on the event handler
6942 stack. If deleteHandler is True then the wx.EvtHandler object will be
6943 destroyed after it is popped.
6944 """
54f9ee45 6945 return _core_.Window_PopEventHandler(*args, **kwargs)
e811c8ce
RD
6946
6947 def RemoveEventHandler(*args, **kwargs):
15afbcd0 6948 """
a95a7133 6949 RemoveEventHandler(self, EvtHandler handler) -> bool
15afbcd0 6950
41e2b43e
RD
6951 Find the given handler in the event handler chain and remove (but not
6952 delete) it from the event handler chain, return True if it was found
6953 and False otherwise (this also results in an assert failure so this
6954 function should only be called when the handler is supposed to be
6955 there.)
15afbcd0 6956 """
54f9ee45 6957 return _core_.Window_RemoveEventHandler(*args, **kwargs)
e811c8ce
RD
6958
6959 def SetValidator(*args, **kwargs):
15afbcd0 6960 """
a95a7133 6961 SetValidator(self, Validator validator)
15afbcd0
RD
6962
6963 Deletes the current validator (if any) and sets the window validator,
6964 having called wx.Validator.Clone to create a new validator of this
6965 type.
6966 """
54f9ee45 6967 return _core_.Window_SetValidator(*args, **kwargs)
e811c8ce
RD
6968
6969 def GetValidator(*args, **kwargs):
15afbcd0 6970 """
a95a7133 6971 GetValidator(self) -> Validator
15afbcd0
RD
6972
6973 Returns a pointer to the current validator for the window, or None if
6974 there is none.
6975 """
54f9ee45 6976 return _core_.Window_GetValidator(*args, **kwargs)
e811c8ce 6977
74a57fcd
RD
6978 def Validate(*args, **kwargs):
6979 """
a95a7133 6980 Validate(self) -> bool
74a57fcd
RD
6981
6982 Validates the current values of the child controls using their
41e2b43e
RD
6983 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
6984 style flag set, the method will also call Validate() of all child
6985 windows. Returns false if any of the validations failed.
74a57fcd 6986 """
54f9ee45 6987 return _core_.Window_Validate(*args, **kwargs)
74a57fcd
RD
6988
6989 def TransferDataToWindow(*args, **kwargs):
6990 """
a95a7133 6991 TransferDataToWindow(self) -> bool
74a57fcd 6992
41e2b43e
RD
6993 Transfers values to child controls from data areas specified by their
6994 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
6995 style flag set, the method will also call TransferDataToWindow() of
6996 all child windows.
74a57fcd 6997 """
54f9ee45 6998 return _core_.Window_TransferDataToWindow(*args, **kwargs)
74a57fcd
RD
6999
7000 def TransferDataFromWindow(*args, **kwargs):
7001 """
a95a7133 7002 TransferDataFromWindow(self) -> bool
74a57fcd 7003
41e2b43e
RD
7004 Transfers values from child controls to data areas specified by their
7005 validators. Returns false if a transfer failed. If the window has
7006 wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will
7007 also call TransferDataFromWindow() of all child windows.
74a57fcd 7008 """
54f9ee45 7009 return _core_.Window_TransferDataFromWindow(*args, **kwargs)
74a57fcd
RD
7010
7011 def InitDialog(*args, **kwargs):
7012 """
a95a7133 7013 InitDialog(self)
74a57fcd 7014
41e2b43e
RD
7015 Sends an EVT_INIT_DIALOG event, whose handler usually transfers data
7016 to the dialog via validators.
74a57fcd 7017 """
54f9ee45 7018 return _core_.Window_InitDialog(*args, **kwargs)
74a57fcd 7019
e811c8ce 7020 def SetAcceleratorTable(*args, **kwargs):
15afbcd0 7021 """
a95a7133 7022 SetAcceleratorTable(self, AcceleratorTable accel)
15afbcd0
RD
7023
7024 Sets the accelerator table for this window.
7025 """
54f9ee45 7026 return _core_.Window_SetAcceleratorTable(*args, **kwargs)
e811c8ce
RD
7027
7028 def GetAcceleratorTable(*args, **kwargs):
15afbcd0 7029 """
a95a7133 7030 GetAcceleratorTable(self) -> AcceleratorTable
15afbcd0
RD
7031
7032 Gets the accelerator table for this window.
7033 """
54f9ee45 7034 return _core_.Window_GetAcceleratorTable(*args, **kwargs)
e811c8ce
RD
7035
7036 def RegisterHotKey(*args, **kwargs):
15afbcd0 7037 """
a95a7133 7038 RegisterHotKey(self, int hotkeyId, int modifiers, int keycode) -> bool
15afbcd0
RD
7039
7040 Registers a system wide hotkey. Every time the user presses the hotkey
7041 registered here, this window will receive a hotkey event. It will
7042 receive the event even if the application is in the background and
7043 does not have the input focus because the user is working with some
7044 other application. To bind an event handler function to this hotkey
7045 use EVT_HOTKEY with an id equal to hotkeyId. Returns True if the
7046 hotkey was registered successfully.
7047 """
54f9ee45 7048 return _core_.Window_RegisterHotKey(*args, **kwargs)
e811c8ce
RD
7049
7050 def UnregisterHotKey(*args, **kwargs):
15afbcd0 7051 """
a95a7133 7052 UnregisterHotKey(self, int hotkeyId) -> bool
15afbcd0
RD
7053
7054 Unregisters a system wide hotkey.
7055 """
54f9ee45 7056 return _core_.Window_UnregisterHotKey(*args, **kwargs)
e811c8ce
RD
7057
7058 def ConvertDialogPointToPixels(*args, **kwargs):
15afbcd0 7059 """
a95a7133 7060 ConvertDialogPointToPixels(self, Point pt) -> Point
15afbcd0
RD
7061
7062 Converts a point or size from dialog units to pixels. Dialog units
7063 are used for maintaining a dialog's proportions even if the font
7064 changes. For the x dimension, the dialog units are multiplied by the
7065 average character width and then divided by 4. For the y dimension,
7066 the dialog units are multiplied by the average character height and
7067 then divided by 8.
7068 """
54f9ee45 7069 return _core_.Window_ConvertDialogPointToPixels(*args, **kwargs)
e811c8ce
RD
7070
7071 def ConvertDialogSizeToPixels(*args, **kwargs):
15afbcd0 7072 """
a95a7133 7073 ConvertDialogSizeToPixels(self, Size sz) -> Size
15afbcd0
RD
7074
7075 Converts a point or size from dialog units to pixels. Dialog units
7076 are used for maintaining a dialog's proportions even if the font
7077 changes. For the x dimension, the dialog units are multiplied by the
7078 average character width and then divided by 4. For the y dimension,
7079 the dialog units are multiplied by the average character height and
7080 then divided by 8.
7081 """
54f9ee45 7082 return _core_.Window_ConvertDialogSizeToPixels(*args, **kwargs)
e811c8ce
RD
7083
7084 def DLG_PNT(*args, **kwargs):
15afbcd0 7085 """
a95a7133 7086 DLG_PNT(self, Point pt) -> Point
15afbcd0
RD
7087
7088 Converts a point or size from dialog units to pixels. Dialog units
7089 are used for maintaining a dialog's proportions even if the font
7090 changes. For the x dimension, the dialog units are multiplied by the
7091 average character width and then divided by 4. For the y dimension,
7092 the dialog units are multiplied by the average character height and
7093 then divided by 8.
7094 """
54f9ee45 7095 return _core_.Window_DLG_PNT(*args, **kwargs)
e811c8ce
RD
7096
7097 def DLG_SZE(*args, **kwargs):
15afbcd0 7098 """
a95a7133 7099 DLG_SZE(self, Size sz) -> Size
15afbcd0
RD
7100
7101 Converts a point or size from dialog units to pixels. Dialog units
7102 are used for maintaining a dialog's proportions even if the font
7103 changes. For the x dimension, the dialog units are multiplied by the
7104 average character width and then divided by 4. For the y dimension,
7105 the dialog units are multiplied by the average character height and
7106 then divided by 8.
7107 """
54f9ee45 7108 return _core_.Window_DLG_SZE(*args, **kwargs)
e811c8ce
RD
7109
7110 def ConvertPixelPointToDialog(*args, **kwargs):
a95a7133 7111 """ConvertPixelPointToDialog(self, Point pt) -> Point"""
54f9ee45 7112 return _core_.Window_ConvertPixelPointToDialog(*args, **kwargs)
e811c8ce
RD
7113
7114 def ConvertPixelSizeToDialog(*args, **kwargs):
a95a7133 7115 """ConvertPixelSizeToDialog(self, Size sz) -> Size"""
54f9ee45 7116 return _core_.Window_ConvertPixelSizeToDialog(*args, **kwargs)
e811c8ce
RD
7117
7118 def WarpPointer(*args, **kwargs):
15afbcd0 7119 """
a95a7133 7120 WarpPointer(self, int x, int y)
15afbcd0
RD
7121
7122 Moves the pointer to the given position on the window.
7123
7124 NOTE: This function is not supported under Mac because Apple Human
7125 Interface Guidelines forbid moving the mouse cursor programmatically.
7126 """
54f9ee45 7127 return _core_.Window_WarpPointer(*args, **kwargs)
e811c8ce
RD
7128
7129 def CaptureMouse(*args, **kwargs):
15afbcd0 7130 """
a95a7133 7131 CaptureMouse(self)
15afbcd0
RD
7132
7133 Directs all mouse input to this window. Call wx.Window.ReleaseMouse to
7134 release the capture.
7135
7136 Note that wxWindows maintains the stack of windows having captured the
7137 mouse and when the mouse is released the capture returns to the window
7138 which had had captured it previously and it is only really released if
7139 there were no previous window. In particular, this means that you must
7140 release the mouse as many times as you capture it.
7141 """
54f9ee45 7142 return _core_.Window_CaptureMouse(*args, **kwargs)
e811c8ce
RD
7143
7144 def ReleaseMouse(*args, **kwargs):
15afbcd0 7145 """
a95a7133 7146 ReleaseMouse(self)
15afbcd0
RD
7147
7148 Releases mouse input captured with wx.Window.CaptureMouse.
7149 """
54f9ee45 7150 return _core_.Window_ReleaseMouse(*args, **kwargs)
e811c8ce
RD
7151
7152 def GetCapture(*args, **kwargs):
15afbcd0 7153 """
66c033b4 7154 GetCapture() -> Window
15afbcd0
RD
7155
7156 Returns the window which currently captures the mouse or None
7157 """
54f9ee45 7158 return _core_.Window_GetCapture(*args, **kwargs)
e811c8ce
RD
7159
7160 GetCapture = staticmethod(GetCapture)
7161 def HasCapture(*args, **kwargs):
15afbcd0 7162 """
a95a7133 7163 HasCapture(self) -> bool
15afbcd0
RD
7164
7165 Returns true if this window has the current mouse capture.
7166 """
54f9ee45 7167 return _core_.Window_HasCapture(*args, **kwargs)
e811c8ce
RD
7168
7169 def Refresh(*args, **kwargs):
15afbcd0 7170 """
a95a7133 7171 Refresh(self, bool eraseBackground=True, Rect rect=None)
15afbcd0
RD
7172
7173 Mark the specified rectangle (or the whole window) as "dirty" so it
7174 will be repainted. Causes an EVT_PAINT event to be generated and sent
7175 to the window.
7176 """
54f9ee45 7177 return _core_.Window_Refresh(*args, **kwargs)
e811c8ce
RD
7178
7179 def RefreshRect(*args, **kwargs):
15afbcd0 7180 """
fef4c27a 7181 RefreshRect(self, Rect rect, bool eraseBackground=True)
15afbcd0
RD
7182
7183 Redraws the contents of the given rectangle: the area inside it will
7184 be repainted. This is the same as Refresh but has a nicer syntax.
7185 """
54f9ee45 7186 return _core_.Window_RefreshRect(*args, **kwargs)
e811c8ce
RD
7187
7188 def Update(*args, **kwargs):
15afbcd0 7189 """
a95a7133 7190 Update(self)
15afbcd0
RD
7191
7192 Calling this method immediately repaints the invalidated area of the
7193 window instead of waiting for the EVT_PAINT event to happen, (normally
7194 this would usually only happen when the flow of control returns to the
7195 event loop.) Notice that this function doesn't refresh the window and
7196 does nothing if the window has been already repainted. Use Refresh
7197 first if you want to immediately redraw the window (or some portion of
7198 it) unconditionally.
7199 """
54f9ee45 7200 return _core_.Window_Update(*args, **kwargs)
e811c8ce
RD
7201
7202 def ClearBackground(*args, **kwargs):
15afbcd0 7203 """
a95a7133 7204 ClearBackground(self)
15afbcd0
RD
7205
7206 Clears the window by filling it with the current background
7207 colour. Does not cause an erase background event to be generated.
7208 """
54f9ee45 7209 return _core_.Window_ClearBackground(*args, **kwargs)
e811c8ce
RD
7210
7211 def Freeze(*args, **kwargs):
15afbcd0 7212 """
a95a7133 7213 Freeze(self)
15afbcd0 7214
41e2b43e
RD
7215 Freezes the window or, in other words, prevents any updates from
7216 taking place on screen, the window is not redrawn at all. Thaw must be
7217 called to reenable window redrawing. Calls to Freeze/Thaw may be
7218 nested, with the actual Thaw being delayed until all the nesting has
7219 been undone.
15afbcd0
RD
7220
7221 This method is useful for visual appearance optimization (for example,
7222 it is a good idea to use it before inserting large amount of text into
7223 a wxTextCtrl under wxGTK) but is not implemented on all platforms nor
7224 for all controls so it is mostly just a hint to wxWindows and not a
7225 mandatory directive.
7226 """
54f9ee45 7227 return _core_.Window_Freeze(*args, **kwargs)
e811c8ce
RD
7228
7229 def Thaw(*args, **kwargs):
15afbcd0 7230 """
a95a7133 7231 Thaw(self)
15afbcd0 7232
4276dc52 7233 Reenables window updating after a previous call to Freeze. Calls to
41e2b43e
RD
7234 Freeze/Thaw may be nested, so Thaw must be called the same number of
7235 times that Freeze was before the window will be updated.
15afbcd0 7236 """
54f9ee45 7237 return _core_.Window_Thaw(*args, **kwargs)
e811c8ce
RD
7238
7239 def PrepareDC(*args, **kwargs):
15afbcd0 7240 """
a95a7133 7241 PrepareDC(self, DC dc)
15afbcd0
RD
7242
7243 Call this function to prepare the device context for drawing a
7244 scrolled image. It sets the device origin according to the current
7245 scroll position.
7246 """
54f9ee45 7247 return _core_.Window_PrepareDC(*args, **kwargs)
e811c8ce
RD
7248
7249 def GetUpdateRegion(*args, **kwargs):
15afbcd0 7250 """
a95a7133 7251 GetUpdateRegion(self) -> Region
15afbcd0
RD
7252
7253 Returns the region specifying which parts of the window have been
7254 damaged. Should only be called within an EVT_PAINT handler.
7255 """
54f9ee45 7256 return _core_.Window_GetUpdateRegion(*args, **kwargs)
e811c8ce
RD
7257
7258 def GetUpdateClientRect(*args, **kwargs):
15afbcd0 7259 """
a95a7133 7260 GetUpdateClientRect(self) -> Rect
15afbcd0
RD
7261
7262 Get the update rectangle region bounding box in client coords.
7263 """
54f9ee45 7264 return _core_.Window_GetUpdateClientRect(*args, **kwargs)
e811c8ce
RD
7265
7266 def IsExposed(*args, **kwargs):
15afbcd0 7267 """
a95a7133 7268 IsExposed(self, int x, int y, int w=1, int h=1) -> bool
15afbcd0
RD
7269
7270 Returns true if the given point or rectangle area has been exposed
7271 since the last repaint. Call this in an paint event handler to
7272 optimize redrawing by only redrawing those areas, which have been
7273 exposed.
7274 """
54f9ee45 7275 return _core_.Window_IsExposed(*args, **kwargs)
e811c8ce
RD
7276
7277 def IsExposedPoint(*args, **kwargs):
15afbcd0 7278 """
a95a7133 7279 IsExposedPoint(self, Point pt) -> bool
15afbcd0
RD
7280
7281 Returns true if the given point or rectangle area has been exposed
7282 since the last repaint. Call this in an paint event handler to
7283 optimize redrawing by only redrawing those areas, which have been
7284 exposed.
7285 """
54f9ee45 7286 return _core_.Window_IsExposedPoint(*args, **kwargs)
e811c8ce 7287
4276dc52 7288 def IsExposedRect(*args, **kwargs):
15afbcd0 7289 """
a95a7133 7290 IsExposedRect(self, Rect rect) -> bool
15afbcd0
RD
7291
7292 Returns true if the given point or rectangle area has been exposed
7293 since the last repaint. Call this in an paint event handler to
7294 optimize redrawing by only redrawing those areas, which have been
7295 exposed.
7296 """
54f9ee45 7297 return _core_.Window_IsExposedRect(*args, **kwargs)
e811c8ce 7298
74a57fcd
RD
7299 def GetDefaultAttributes(*args, **kwargs):
7300 """
a95a7133 7301 GetDefaultAttributes(self) -> VisualAttributes
74a57fcd 7302
41e2b43e
RD
7303 Get the default attributes for an instance of this class. This is
7304 useful if you want to use the same font or colour in your own control
7305 as in a standard control -- which is a much better idea than hard
7306 coding specific colours or fonts which might look completely out of
db3e571a 7307 place on the user's system, especially if it uses themes.
74a57fcd 7308 """
54f9ee45 7309 return _core_.Window_GetDefaultAttributes(*args, **kwargs)
74a57fcd
RD
7310
7311 def GetClassDefaultAttributes(*args, **kwargs):
7312 """
66c033b4 7313 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
74a57fcd 7314
41e2b43e
RD
7315 Get the default attributes for this class. This is useful if you want
7316 to use the same font or colour in your own control as in a standard
7317 control -- which is a much better idea than hard coding specific
db3e571a
RD
7318 colours or fonts which might look completely out of place on the
7319 user's system, especially if it uses themes.
74a57fcd
RD
7320
7321 The variant parameter is only relevant under Mac currently and is
41e2b43e 7322 ignore under other platforms. Under Mac, it will change the size of
db3e571a
RD
7323 the returned font. See `wx.Window.SetWindowVariant` for more about
7324 this.
74a57fcd 7325 """
54f9ee45 7326 return _core_.Window_GetClassDefaultAttributes(*args, **kwargs)
74a57fcd
RD
7327
7328 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
e811c8ce 7329 def SetBackgroundColour(*args, **kwargs):
15afbcd0 7330 """
a95a7133 7331 SetBackgroundColour(self, Colour colour) -> bool
15afbcd0
RD
7332
7333 Sets the background colour of the window. Returns True if the colour
7334 was changed. The background colour is usually painted by the default
7335 EVT_ERASE_BACKGROUND event handler function under Windows and
f8167d6e
RD
7336 automatically under GTK. Using `wx.NullColour` will reset the window
7337 to the default background colour.
15afbcd0 7338
db3e571a 7339 Note that setting the background colour may not cause an immediate
f8167d6e 7340 refresh, so you may wish to call `ClearBackground` or `Refresh` after
15afbcd0
RD
7341 calling this function.
7342
f8167d6e
RD
7343 Using this function will disable attempts to use themes for this
7344 window, if the system supports them. Use with care since usually the
7345 themes represent the appearance chosen by the user to be used for all
7346 applications on the system.
15afbcd0 7347 """
54f9ee45 7348 return _core_.Window_SetBackgroundColour(*args, **kwargs)
e811c8ce 7349
412d302d
RD
7350 def SetOwnBackgroundColour(*args, **kwargs):
7351 """SetOwnBackgroundColour(self, Colour colour)"""
7352 return _core_.Window_SetOwnBackgroundColour(*args, **kwargs)
b2df227b 7353
e811c8ce 7354 def SetForegroundColour(*args, **kwargs):
15afbcd0 7355 """
a95a7133 7356 SetForegroundColour(self, Colour colour) -> bool
15afbcd0
RD
7357
7358 Sets the foreground colour of the window. Returns True is the colour
7359 was changed. The interpretation of foreground colour is dependent on
7360 the window class; it may be the text colour or other colour, or it may
7361 not be used at all.
7362 """
54f9ee45 7363 return _core_.Window_SetForegroundColour(*args, **kwargs)
e811c8ce 7364
fa47d7a7
VS
7365 def SetOwnForegroundColour(*args, **kwargs):
7366 """SetOwnForegroundColour(self, Colour colour)"""
7367 return _core_.Window_SetOwnForegroundColour(*args, **kwargs)
b2df227b 7368
e811c8ce 7369 def GetBackgroundColour(*args, **kwargs):
15afbcd0 7370 """
a95a7133 7371 GetBackgroundColour(self) -> Colour
15afbcd0
RD
7372
7373 Returns the background colour of the window.
7374 """
54f9ee45 7375 return _core_.Window_GetBackgroundColour(*args, **kwargs)
e811c8ce
RD
7376
7377 def GetForegroundColour(*args, **kwargs):
15afbcd0 7378 """
a95a7133 7379 GetForegroundColour(self) -> Colour
15afbcd0
RD
7380
7381 Returns the foreground colour of the window. The interpretation of
7382 foreground colour is dependent on the window class; it may be the text
7383 colour or other colour, or it may not be used at all.
7384 """
54f9ee45 7385 return _core_.Window_GetForegroundColour(*args, **kwargs)
e811c8ce 7386
7bc1e663
RD
7387 def SetBackgroundStyle(*args, **kwargs):
7388 """
7389 SetBackgroundStyle(self, int style) -> bool
7390
7391 Returns the background style of the window. The background style
7392 indicates how the background of the window is drawn.
7393
7394 ====================== ========================================
7395 wx.BG_STYLE_SYSTEM The background colour or pattern should
7396 be determined by the system
7397 wx.BG_STYLE_COLOUR The background should be a solid colour
7398 wx.BG_STYLE_CUSTOM The background will be implemented by the
7399 application.
7400 ====================== ========================================
7401
7402 On GTK+, use of wx.BG_STYLE_CUSTOM allows the flicker-free drawing of
7403 a custom background, such as a tiled bitmap. Currently the style has
7404 no effect on other platforms.
7405
7406 :see: `GetBackgroundStyle`, `SetBackgroundColour`
7407 """
7408 return _core_.Window_SetBackgroundStyle(*args, **kwargs)
7409
7410 def GetBackgroundStyle(*args, **kwargs):
7411 """
7412 GetBackgroundStyle(self) -> int
7413
7414 Returns the background style of the window.
7415
7416 :see: `SetBackgroundStyle`
7417 """
7418 return _core_.Window_GetBackgroundStyle(*args, **kwargs)
7419
51b83b37
RD
7420 def HasTransparentBackground(*args, **kwargs):
7421 """
7422 HasTransparentBackground(self) -> bool
7423
7424 Returns True if this window's background is transparent (as, for
7425 example, for `wx.StaticText`) and should show the parent window's
7426 background.
7427
7428 This method is mostly used internally by the library itself and you
7429 normally shouldn't have to call it. You may, however, have to override
7430 it in your custom control classes to ensure that background is painted
7431 correctly.
7432 """
7433 return _core_.Window_HasTransparentBackground(*args, **kwargs)
7434
e811c8ce 7435 def SetCursor(*args, **kwargs):
15afbcd0 7436 """
a95a7133 7437 SetCursor(self, Cursor cursor) -> bool
15afbcd0
RD
7438
7439 Sets the window's cursor. Notice that the window cursor also sets it
7440 for the children of the window implicitly.
7441
7442 The cursor may be wx.NullCursor in which case the window cursor will
7443 be reset back to default.
7444 """
54f9ee45 7445 return _core_.Window_SetCursor(*args, **kwargs)
e811c8ce
RD
7446
7447 def GetCursor(*args, **kwargs):
15afbcd0 7448 """
a95a7133 7449 GetCursor(self) -> Cursor
15afbcd0
RD
7450
7451 Return the cursor associated with this window.
7452 """
54f9ee45 7453 return _core_.Window_GetCursor(*args, **kwargs)
e811c8ce
RD
7454
7455 def SetFont(*args, **kwargs):
15afbcd0 7456 """
a95a7133 7457 SetFont(self, Font font) -> bool
15afbcd0
RD
7458
7459 Sets the font for this window.
7460 """
54f9ee45 7461 return _core_.Window_SetFont(*args, **kwargs)
e811c8ce 7462
fa47d7a7
VS
7463 def SetOwnFont(*args, **kwargs):
7464 """SetOwnFont(self, Font font)"""
7465 return _core_.Window_SetOwnFont(*args, **kwargs)
b2df227b 7466
e811c8ce 7467 def GetFont(*args, **kwargs):
15afbcd0 7468 """
a95a7133 7469 GetFont(self) -> Font
15afbcd0 7470
4276dc52 7471 Returns the default font used for this window.
15afbcd0 7472 """
54f9ee45 7473 return _core_.Window_GetFont(*args, **kwargs)
e811c8ce
RD
7474
7475 def SetCaret(*args, **kwargs):
15afbcd0 7476 """
a95a7133 7477 SetCaret(self, Caret caret)
15afbcd0
RD
7478
7479 Sets the caret associated with the window.
7480 """
54f9ee45 7481 return _core_.Window_SetCaret(*args, **kwargs)
e811c8ce
RD
7482
7483 def GetCaret(*args, **kwargs):
15afbcd0 7484 """
a95a7133 7485 GetCaret(self) -> Caret
15afbcd0
RD
7486
7487 Returns the caret associated with the window.
7488 """
54f9ee45 7489 return _core_.Window_GetCaret(*args, **kwargs)
e811c8ce
RD
7490
7491 def GetCharHeight(*args, **kwargs):
15afbcd0 7492 """
a95a7133 7493 GetCharHeight(self) -> int
15afbcd0
RD
7494
7495 Get the (average) character size for the current font.
7496 """
54f9ee45 7497 return _core_.Window_GetCharHeight(*args, **kwargs)
e811c8ce
RD
7498
7499 def GetCharWidth(*args, **kwargs):
15afbcd0 7500 """
a95a7133 7501 GetCharWidth(self) -> int
15afbcd0
RD
7502
7503 Get the (average) character size for the current font.
7504 """
54f9ee45 7505 return _core_.Window_GetCharWidth(*args, **kwargs)
e811c8ce
RD
7506
7507 def GetTextExtent(*args, **kwargs):
fd2dc343
RD
7508 """
7509 GetTextExtent(String string) -> (width, height)
7510
7511 Get the width and height of the text using the current font.
7512 """
54f9ee45 7513 return _core_.Window_GetTextExtent(*args, **kwargs)
e811c8ce
RD
7514
7515 def GetFullTextExtent(*args, **kwargs):
0df68c9f 7516 """
196addbf 7517 GetFullTextExtent(String string, Font font=None) ->
0df68c9f 7518 (width, height, descent, externalLeading)
e811c8ce 7519
15afbcd0
RD
7520 Get the width, height, decent and leading of the text using the
7521 current or specified font.
0df68c9f 7522 """
54f9ee45 7523 return _core_.Window_GetFullTextExtent(*args, **kwargs)
e811c8ce
RD
7524
7525 def ClientToScreenXY(*args, **kwargs):
15afbcd0
RD
7526 """
7527 ClientToScreenXY(int x, int y) -> (x,y)
7528
7529 Converts to screen coordinates from coordinates relative to this window.
7530 """
54f9ee45 7531 return _core_.Window_ClientToScreenXY(*args, **kwargs)
e811c8ce
RD
7532
7533 def ScreenToClientXY(*args, **kwargs):
15afbcd0
RD
7534 """
7535 ScreenToClientXY(int x, int y) -> (x,y)
7536
7537 Converts from screen to client window coordinates.
7538 """
54f9ee45 7539 return _core_.Window_ScreenToClientXY(*args, **kwargs)
e811c8ce
RD
7540
7541 def ClientToScreen(*args, **kwargs):
15afbcd0 7542 """
a95a7133 7543 ClientToScreen(self, Point pt) -> Point
15afbcd0
RD
7544
7545 Converts to screen coordinates from coordinates relative to this window.
7546 """
54f9ee45 7547 return _core_.Window_ClientToScreen(*args, **kwargs)
e811c8ce
RD
7548
7549 def ScreenToClient(*args, **kwargs):
15afbcd0 7550 """
a95a7133 7551 ScreenToClient(self, Point pt) -> Point
15afbcd0
RD
7552
7553 Converts from screen to client window coordinates.
7554 """
54f9ee45 7555 return _core_.Window_ScreenToClient(*args, **kwargs)
e811c8ce
RD
7556
7557 def HitTestXY(*args, **kwargs):
15afbcd0 7558 """
a95a7133 7559 HitTestXY(self, int x, int y) -> int
15afbcd0
RD
7560
7561 Test where the given (in client coords) point lies
7562 """
54f9ee45 7563 return _core_.Window_HitTestXY(*args, **kwargs)
e811c8ce
RD
7564
7565 def HitTest(*args, **kwargs):
15afbcd0 7566 """
a95a7133 7567 HitTest(self, Point pt) -> int
15afbcd0
RD
7568
7569 Test where the given (in client coords) point lies
7570 """
54f9ee45 7571 return _core_.Window_HitTest(*args, **kwargs)
e811c8ce 7572
15afbcd0
RD
7573 def GetBorder(*args):
7574 """
a95a7133
RD
7575 GetBorder(self, long flags) -> int
7576 GetBorder(self) -> int
e811c8ce 7577
15afbcd0
RD
7578 Get border for the flags of this window
7579 """
54f9ee45 7580 return _core_.Window_GetBorder(*args)
e811c8ce
RD
7581
7582 def UpdateWindowUI(*args, **kwargs):
15afbcd0 7583 """
a95a7133 7584 UpdateWindowUI(self, long flags=UPDATE_UI_NONE)
15afbcd0
RD
7585
7586 This function sends EVT_UPDATE_UI events to the window. The particular
7587 implementation depends on the window; for example a wx.ToolBar will
7588 send an update UI event for each toolbar button, and a wx.Frame will
7589 send an update UI event for each menubar menu item. You can call this
7590 function from your application to ensure that your UI is up-to-date at
7591 a particular point in time (as far as your EVT_UPDATE_UI handlers are
7592 concerned). This may be necessary if you have called
7593 wx.UpdateUIEvent.SetMode or wx.UpdateUIEvent.SetUpdateInterval to
7594 limit the overhead that wxWindows incurs by sending update UI events
7595 in idle time.
15afbcd0 7596 """
54f9ee45 7597 return _core_.Window_UpdateWindowUI(*args, **kwargs)
e811c8ce
RD
7598
7599 def PopupMenuXY(*args, **kwargs):
15afbcd0 7600 """
b0503257 7601 PopupMenuXY(self, Menu menu, int x=-1, int y=-1) -> bool
15afbcd0 7602
b0503257
RD
7603 Pops up the given menu at the specified coordinates, relative to this window,
7604 and returns control when the user has dismissed the menu. If a menu item is
7605 selected, the corresponding menu event is generated and will be processed as
7606 usual. If the default position is given then the current position of the
7607 mouse cursor will be used.
15afbcd0 7608 """
54f9ee45 7609 return _core_.Window_PopupMenuXY(*args, **kwargs)
e811c8ce 7610
15afbcd0
RD
7611 def PopupMenu(*args, **kwargs):
7612 """
b0503257 7613 PopupMenu(self, Menu menu, Point pos=DefaultPosition) -> bool
15afbcd0 7614
b0503257
RD
7615 Pops up the given menu at the specified coordinates, relative to this window,
7616 and returns control when the user has dismissed the menu. If a menu item is
7617 selected, the corresponding menu event is generated and will be processed as
7618 usual. If the default position is given then the current position of the
7619 mouse cursor will be used.
15afbcd0 7620 """
54f9ee45 7621 return _core_.Window_PopupMenu(*args, **kwargs)
15afbcd0
RD
7622
7623 def GetHandle(*args, **kwargs):
7624 """
a95a7133 7625 GetHandle(self) -> long
15afbcd0
RD
7626
7627 Returns the platform-specific handle (as a long integer) of the
7628 physical window. Currently on wxMac it returns the handle of the
7629 toplevel parent of the window.
7630 """
54f9ee45 7631 return _core_.Window_GetHandle(*args, **kwargs)
15afbcd0 7632
7e63a440
RD
7633 def AssociateHandle(*args, **kwargs):
7634 """
7635 AssociateHandle(self, long handle)
7636
7637 Associate the window with a new native handle
7638 """
7639 return _core_.Window_AssociateHandle(*args, **kwargs)
7640
7641 def DissociateHandle(*args, **kwargs):
7642 """
7643 DissociateHandle(self)
7644
7645 Dissociate the current native handle from the window
7646 """
7647 return _core_.Window_DissociateHandle(*args, **kwargs)
7648
15afbcd0
RD
7649 def HasScrollbar(*args, **kwargs):
7650 """
a95a7133 7651 HasScrollbar(self, int orient) -> bool
15afbcd0
RD
7652
7653 Does the window have the scrollbar for this orientation?
7654 """
54f9ee45 7655 return _core_.Window_HasScrollbar(*args, **kwargs)
15afbcd0
RD
7656
7657 def SetScrollbar(*args, **kwargs):
7658 """
41e2b43e 7659 SetScrollbar(self, int orientation, int position, int thumbSize, int range,
15afbcd0
RD
7660 bool refresh=True)
7661
7662 Sets the scrollbar properties of a built-in scrollbar.
15afbcd0 7663 """
54f9ee45 7664 return _core_.Window_SetScrollbar(*args, **kwargs)
e811c8ce
RD
7665
7666 def SetScrollPos(*args, **kwargs):
15afbcd0 7667 """
a95a7133 7668 SetScrollPos(self, int orientation, int pos, bool refresh=True)
15afbcd0
RD
7669
7670 Sets the position of one of the built-in scrollbars.
7671 """
54f9ee45 7672 return _core_.Window_SetScrollPos(*args, **kwargs)
e811c8ce
RD
7673
7674 def GetScrollPos(*args, **kwargs):
15afbcd0 7675 """
a95a7133 7676 GetScrollPos(self, int orientation) -> int
15afbcd0
RD
7677
7678 Returns the built-in scrollbar position.
7679 """
54f9ee45 7680 return _core_.Window_GetScrollPos(*args, **kwargs)
e811c8ce
RD
7681
7682 def GetScrollThumb(*args, **kwargs):
15afbcd0 7683 """
a95a7133 7684 GetScrollThumb(self, int orientation) -> int
15afbcd0
RD
7685
7686 Returns the built-in scrollbar thumb size.
7687 """
54f9ee45 7688 return _core_.Window_GetScrollThumb(*args, **kwargs)
e811c8ce
RD
7689
7690 def GetScrollRange(*args, **kwargs):
15afbcd0 7691 """
a95a7133 7692 GetScrollRange(self, int orientation) -> int
15afbcd0
RD
7693
7694 Returns the built-in scrollbar range.
7695 """
54f9ee45 7696 return _core_.Window_GetScrollRange(*args, **kwargs)
e811c8ce
RD
7697
7698 def ScrollWindow(*args, **kwargs):
15afbcd0 7699 """
a95a7133 7700 ScrollWindow(self, int dx, int dy, Rect rect=None)
15afbcd0
RD
7701
7702 Physically scrolls the pixels in the window and move child windows
7703 accordingly. Use this function to optimise your scrolling
7704 implementations, to minimise the area that must be redrawn. Note that
7705 it is rarely required to call this function from a user program.
15afbcd0 7706 """
54f9ee45 7707 return _core_.Window_ScrollWindow(*args, **kwargs)
e811c8ce
RD
7708
7709 def ScrollLines(*args, **kwargs):
15afbcd0 7710 """
a95a7133 7711 ScrollLines(self, int lines) -> bool
15afbcd0
RD
7712
7713 If the platform and window class supports it, scrolls the window by
7714 the given number of lines down, if lines is positive, or up if lines
7715 is negative. Returns True if the window was scrolled, False if it was
7716 already on top/bottom and nothing was done.
7717 """
54f9ee45 7718 return _core_.Window_ScrollLines(*args, **kwargs)
e811c8ce
RD
7719
7720 def ScrollPages(*args, **kwargs):
15afbcd0 7721 """
a95a7133 7722 ScrollPages(self, int pages) -> bool
15afbcd0 7723
41e2b43e 7724 If the platform and window class supports it, scrolls the window by
15afbcd0
RD
7725 the given number of pages down, if pages is positive, or up if pages
7726 is negative. Returns True if the window was scrolled, False if it was
7727 already on top/bottom and nothing was done.
7728 """
54f9ee45 7729 return _core_.Window_ScrollPages(*args, **kwargs)
e811c8ce
RD
7730
7731 def LineUp(*args, **kwargs):
15afbcd0 7732 """
a95a7133 7733 LineUp(self) -> bool
15afbcd0
RD
7734
7735 This is just a wrapper for ScrollLines(-1).
7736 """
54f9ee45 7737 return _core_.Window_LineUp(*args, **kwargs)
e811c8ce
RD
7738
7739 def LineDown(*args, **kwargs):
15afbcd0 7740 """
a95a7133 7741 LineDown(self) -> bool
15afbcd0
RD
7742
7743 This is just a wrapper for ScrollLines(1).
7744 """
54f9ee45 7745 return _core_.Window_LineDown(*args, **kwargs)
e811c8ce
RD
7746
7747 def PageUp(*args, **kwargs):
15afbcd0 7748 """
a95a7133 7749 PageUp(self) -> bool
15afbcd0
RD
7750
7751 This is just a wrapper for ScrollPages(-1).
7752 """
54f9ee45 7753 return _core_.Window_PageUp(*args, **kwargs)
e811c8ce
RD
7754
7755 def PageDown(*args, **kwargs):
15afbcd0 7756 """
a95a7133 7757 PageDown(self) -> bool
15afbcd0
RD
7758
7759 This is just a wrapper for ScrollPages(1).
7760 """
54f9ee45 7761 return _core_.Window_PageDown(*args, **kwargs)
e811c8ce
RD
7762
7763 def SetHelpText(*args, **kwargs):
15afbcd0 7764 """
a95a7133 7765 SetHelpText(self, String text)
15afbcd0
RD
7766
7767 Sets the help text to be used as context-sensitive help for this
7768 window. Note that the text is actually stored by the current
7769 wxHelpProvider implementation, and not in the window object itself.
7770 """
54f9ee45 7771 return _core_.Window_SetHelpText(*args, **kwargs)
e811c8ce
RD
7772
7773 def SetHelpTextForId(*args, **kwargs):
15afbcd0 7774 """
a95a7133 7775 SetHelpTextForId(self, String text)
15afbcd0
RD
7776
7777 Associate this help text with all windows with the same id as this
7778 one.
7779 """
54f9ee45 7780 return _core_.Window_SetHelpTextForId(*args, **kwargs)
e811c8ce
RD
7781
7782 def GetHelpText(*args, **kwargs):
15afbcd0 7783 """
a95a7133 7784 GetHelpText(self) -> String
15afbcd0
RD
7785
7786 Gets the help text to be used as context-sensitive help for this
7787 window. Note that the text is actually stored by the current
7788 wxHelpProvider implementation, and not in the window object itself.
7789 """
54f9ee45 7790 return _core_.Window_GetHelpText(*args, **kwargs)
e811c8ce
RD
7791
7792 def SetToolTipString(*args, **kwargs):
15afbcd0 7793 """
a95a7133 7794 SetToolTipString(self, String tip)
15afbcd0
RD
7795
7796 Attach a tooltip to the window.
7797 """
54f9ee45 7798 return _core_.Window_SetToolTipString(*args, **kwargs)
e811c8ce
RD
7799
7800 def SetToolTip(*args, **kwargs):
15afbcd0 7801 """
a95a7133 7802 SetToolTip(self, ToolTip tip)
15afbcd0
RD
7803
7804 Attach a tooltip to the window.
7805 """
54f9ee45 7806 return _core_.Window_SetToolTip(*args, **kwargs)
e811c8ce
RD
7807
7808 def GetToolTip(*args, **kwargs):
15afbcd0 7809 """
a95a7133 7810 GetToolTip(self) -> ToolTip
15afbcd0
RD
7811
7812 get the associated tooltip or None if none
7813 """
54f9ee45 7814 return _core_.Window_GetToolTip(*args, **kwargs)
e811c8ce
RD
7815
7816 def SetDropTarget(*args, **kwargs):
15afbcd0 7817 """
a95a7133 7818 SetDropTarget(self, DropTarget dropTarget)
15afbcd0
RD
7819
7820 Associates a drop target with this window. If the window already has
7821 a drop target, it is deleted.
7822 """
54f9ee45 7823 return _core_.Window_SetDropTarget(*args, **kwargs)
e811c8ce
RD
7824
7825 def GetDropTarget(*args, **kwargs):
15afbcd0 7826 """
a95a7133 7827 GetDropTarget(self) -> DropTarget
15afbcd0
RD
7828
7829 Returns the associated drop target, which may be None.
7830 """
54f9ee45 7831 return _core_.Window_GetDropTarget(*args, **kwargs)
e811c8ce
RD
7832
7833 def SetConstraints(*args, **kwargs):
15afbcd0 7834 """
a95a7133 7835 SetConstraints(self, LayoutConstraints constraints)
15afbcd0
RD
7836
7837 Sets the window to have the given layout constraints. If an existing
7838 layout constraints object is already owned by the window, it will be
7839 deleted. Pass None to disassociate and delete the window's current
7840 constraints.
7841
7842 You must call SetAutoLayout to tell a window to use the constraints
7843 automatically in its default EVT_SIZE handler; otherwise, you must
7844 handle EVT_SIZE yourself and call Layout() explicitly. When setting
7845 both a wx.LayoutConstraints and a wx.Sizer, only the sizer will have
7846 effect.
7847 """
54f9ee45 7848 return _core_.Window_SetConstraints(*args, **kwargs)
e811c8ce
RD
7849
7850 def GetConstraints(*args, **kwargs):
15afbcd0 7851 """
a95a7133 7852 GetConstraints(self) -> LayoutConstraints
15afbcd0
RD
7853
7854 Returns a pointer to the window's layout constraints, or None if there
7855 are none.
7856 """
54f9ee45 7857 return _core_.Window_GetConstraints(*args, **kwargs)
e811c8ce
RD
7858
7859 def SetAutoLayout(*args, **kwargs):
15afbcd0 7860 """
a95a7133 7861 SetAutoLayout(self, bool autoLayout)
15afbcd0
RD
7862
7863 Determines whether the Layout function will be called automatically
7864 when the window is resized. It is called implicitly by SetSizer but
7865 if you use SetConstraints you should call it manually or otherwise the
7866 window layout won't be correctly updated when its size changes.
7867 """
54f9ee45 7868 return _core_.Window_SetAutoLayout(*args, **kwargs)
e811c8ce
RD
7869
7870 def GetAutoLayout(*args, **kwargs):
15afbcd0 7871 """
a95a7133 7872 GetAutoLayout(self) -> bool
15afbcd0
RD
7873
7874 Returns the current autoLayout setting
7875 """
54f9ee45 7876 return _core_.Window_GetAutoLayout(*args, **kwargs)
e811c8ce
RD
7877
7878 def Layout(*args, **kwargs):
15afbcd0 7879 """
a95a7133 7880 Layout(self) -> bool
15afbcd0
RD
7881
7882 Invokes the constraint-based layout algorithm or the sizer-based
7883 algorithm for this window. See SetAutoLayout: when auto layout is on,
7884 this function gets called automatically by the default EVT_SIZE
7885 handler when the window is resized.
7886 """
54f9ee45 7887 return _core_.Window_Layout(*args, **kwargs)
e811c8ce
RD
7888
7889 def SetSizer(*args, **kwargs):
15afbcd0 7890 """
a95a7133 7891 SetSizer(self, Sizer sizer, bool deleteOld=True)
15afbcd0
RD
7892
7893 Sets the window to have the given layout sizer. The window will then
7894 own the object, and will take care of its deletion. If an existing
7895 layout sizer object is already owned by the window, it will be deleted
7896 if the deleteOld parameter is true. Note that this function will also
7897 call SetAutoLayout implicitly with a True parameter if the sizer is
ae8162c8 7898 non-None, and False otherwise.
15afbcd0 7899 """
54f9ee45 7900 return _core_.Window_SetSizer(*args, **kwargs)
e811c8ce
RD
7901
7902 def SetSizerAndFit(*args, **kwargs):
15afbcd0 7903 """
a95a7133 7904 SetSizerAndFit(self, Sizer sizer, bool deleteOld=True)
15afbcd0
RD
7905
7906 The same as SetSizer, except it also sets the size hints for the
7907 window based on the sizer's minimum size.
7908 """
54f9ee45 7909 return _core_.Window_SetSizerAndFit(*args, **kwargs)
e811c8ce
RD
7910
7911 def GetSizer(*args, **kwargs):
15afbcd0 7912 """
a95a7133 7913 GetSizer(self) -> Sizer
15afbcd0
RD
7914
7915 Return the sizer associated with the window by a previous call to
7916 SetSizer or None if there isn't one.
7917 """
54f9ee45 7918 return _core_.Window_GetSizer(*args, **kwargs)
e811c8ce
RD
7919
7920 def SetContainingSizer(*args, **kwargs):
15afbcd0 7921 """
a95a7133 7922 SetContainingSizer(self, Sizer sizer)
15afbcd0
RD
7923
7924 This normally does not need to be called by application code. It is
7925 called internally when a window is added to a sizer, and is used so
7926 the window can remove itself from the sizer when it is destroyed.
7927 """
54f9ee45 7928 return _core_.Window_SetContainingSizer(*args, **kwargs)
e811c8ce
RD
7929
7930 def GetContainingSizer(*args, **kwargs):
15afbcd0 7931 """
a95a7133 7932 GetContainingSizer(self) -> Sizer
15afbcd0
RD
7933
7934 Return the sizer that this window is a member of, if any, otherwise None.
7935 """
54f9ee45 7936 return _core_.Window_GetContainingSizer(*args, **kwargs)
e811c8ce 7937
a95a7133
RD
7938 def InheritAttributes(*args, **kwargs):
7939 """
7940 InheritAttributes(self)
7941
41e2b43e
RD
7942 This function is (or should be, in case of custom controls) called
7943 during window creation to intelligently set up the window visual
7944 attributes, that is the font and the foreground and background
7945 colours.
7946
7947 By 'intelligently' the following is meant: by default, all windows use
7948 their own default attributes. However if some of the parent's
7949 attributes are explicitly changed (that is, using SetFont and not
fa47d7a7 7950 SetOwnFont) and if the corresponding attribute hadn't been
41e2b43e
RD
7951 explicitly set for this window itself, then this window takes the same
7952 value as used by the parent. In addition, if the window overrides
7953 ShouldInheritColours to return false, the colours will not be changed
7954 no matter what and only the font might.
7955
34621cc5 7956 This rather complicated logic is necessary in order to accommodate the
ec9b55ca 7957 different usage scenarios. The most common one is when all default
41e2b43e
RD
7958 attributes are used and in this case, nothing should be inherited as
7959 in modern GUIs different controls use different fonts (and colours)
7960 than their siblings so they can't inherit the same value from the
7961 parent. However it was also deemed desirable to allow to simply change
7962 the attributes of all children at once by just changing the font or
7963 colour of their common parent, hence in this case we do inherit the
7964 parents attributes.
7965
a95a7133 7966 """
54f9ee45 7967 return _core_.Window_InheritAttributes(*args, **kwargs)
a95a7133
RD
7968
7969 def ShouldInheritColours(*args, **kwargs):
7970 """
7971 ShouldInheritColours(self) -> bool
7972
7973 Return true from here to allow the colours of this window to be
41e2b43e
RD
7974 changed by InheritAttributes, returning false forbids inheriting them
7975 from the parent window.
a95a7133 7976
41e2b43e
RD
7977 The base class version returns false, but this method is overridden in
7978 wxControl where it returns true.
a95a7133 7979 """
54f9ee45 7980 return _core_.Window_ShouldInheritColours(*args, **kwargs)
a95a7133 7981
e811c8ce 7982 def PostCreate(self, pre):
15afbcd0
RD
7983 """
7984 Phase 3 of the 2-phase create <wink!>
7985 Call this method after precreating the window with the 2-phase create method.
7986 """
e811c8ce
RD
7987 self.this = pre.this
7988 self.thisown = pre.thisown
7989 pre.thisown = 0
7990 if hasattr(self, '_setOORInfo'):
7991 self._setOORInfo(self)
7992 if hasattr(self, '_setCallbackInfo'):
7993 self._setCallbackInfo(self, self.__class__)
7994
7995
7996class WindowPtr(Window):
7997 def __init__(self, this):
7998 self.this = this
7999 if not hasattr(self,"thisown"): self.thisown = 0
8000 self.__class__ = Window
54f9ee45 8001_core_.Window_swigregister(WindowPtr)
e811c8ce
RD
8002
8003def PreWindow(*args, **kwargs):
15afbcd0
RD
8004 """
8005 PreWindow() -> Window
8006
8007 Precreate a Window for 2-phase creation.
8008 """
54f9ee45 8009 val = _core_.new_PreWindow(*args, **kwargs)
e811c8ce
RD
8010 val.thisown = 1
8011 return val
8012
8013def Window_NewControlId(*args, **kwargs):
15afbcd0
RD
8014 """
8015 Window_NewControlId() -> int
8016
8017 Generate a control id for the controls which were not given one.
8018 """
54f9ee45 8019 return _core_.Window_NewControlId(*args, **kwargs)
e811c8ce
RD
8020
8021def Window_NextControlId(*args, **kwargs):
15afbcd0
RD
8022 """
8023 Window_NextControlId(int winid) -> int
8024
8025 Get the id of the control following the one with the given
41e2b43e 8026 autogenerated) id
15afbcd0 8027 """
54f9ee45 8028 return _core_.Window_NextControlId(*args, **kwargs)
e811c8ce
RD
8029
8030def Window_PrevControlId(*args, **kwargs):
15afbcd0
RD
8031 """
8032 Window_PrevControlId(int winid) -> int
8033
8034 Get the id of the control preceding the one with the given
41e2b43e 8035 autogenerated) id
15afbcd0 8036 """
54f9ee45 8037 return _core_.Window_PrevControlId(*args, **kwargs)
e811c8ce
RD
8038
8039def Window_FindFocus(*args, **kwargs):
15afbcd0
RD
8040 """
8041 Window_FindFocus() -> Window
8042
8043 Returns the window or control that currently has the keyboard focus,
8044 or None.
8045 """
54f9ee45 8046 return _core_.Window_FindFocus(*args, **kwargs)
e811c8ce
RD
8047
8048def Window_GetCapture(*args, **kwargs):
15afbcd0
RD
8049 """
8050 Window_GetCapture() -> Window
8051
8052 Returns the window which currently captures the mouse or None
8053 """
54f9ee45 8054 return _core_.Window_GetCapture(*args, **kwargs)
e811c8ce 8055
74a57fcd
RD
8056def Window_GetClassDefaultAttributes(*args, **kwargs):
8057 """
8058 Window_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
8059
41e2b43e
RD
8060 Get the default attributes for this class. This is useful if you want
8061 to use the same font or colour in your own control as in a standard
8062 control -- which is a much better idea than hard coding specific
db3e571a
RD
8063 colours or fonts which might look completely out of place on the
8064 user's system, especially if it uses themes.
74a57fcd
RD
8065
8066 The variant parameter is only relevant under Mac currently and is
41e2b43e 8067 ignore under other platforms. Under Mac, it will change the size of
db3e571a
RD
8068 the returned font. See `wx.Window.SetWindowVariant` for more about
8069 this.
74a57fcd 8070 """
54f9ee45 8071 return _core_.Window_GetClassDefaultAttributes(*args, **kwargs)
74a57fcd 8072
e811c8ce 8073def DLG_PNT(win, point_or_x, y=None):
15afbcd0
RD
8074 """
8075 Convenience function for converting a Point or (x,y) in
8076 dialog units to pixel units.
8077 """
e811c8ce
RD
8078 if y is None:
8079 return win.ConvertDialogPointToPixels(point_or_x)
8080 else:
fd3f2efe 8081 return win.ConvertDialogPointToPixels(wx.Point(point_or_x, y))
e811c8ce
RD
8082
8083def DLG_SZE(win, size_width, height=None):
15afbcd0
RD
8084 """
8085 Convenience function for converting a Size or (w,h) in
8086 dialog units to pixel units.
8087 """
e811c8ce
RD
8088 if height is None:
8089 return win.ConvertDialogSizeToPixels(size_width)
8090 else:
fd3f2efe 8091 return win.ConvertDialogSizeToPixels(wx.Size(size_width, height))
e811c8ce
RD
8092
8093
8094def FindWindowById(*args, **kwargs):
15afbcd0
RD
8095 """
8096 FindWindowById(long id, Window parent=None) -> Window
8097
8098 Find the first window in the application with the given id. If parent
8099 is None, the search will start from all top-level frames and dialog
8100 boxes; if non-None, the search will be limited to the given window
8101 hierarchy. The search is recursive in both cases.
8102 """
54f9ee45 8103 return _core_.FindWindowById(*args, **kwargs)
e811c8ce
RD
8104
8105def FindWindowByName(*args, **kwargs):
15afbcd0
RD
8106 """
8107 FindWindowByName(String name, Window parent=None) -> Window
8108
8109 Find a window by its name (as given in a window constructor or Create
8110 function call). If parent is None, the search will start from all
8111 top-level frames and dialog boxes; if non-None, the search will be
8112 limited to the given window hierarchy. The search is recursive in both
8113 cases.
8114
8115 If no window with such name is found, wx.FindWindowByLabel is called.
8116 """
54f9ee45 8117 return _core_.FindWindowByName(*args, **kwargs)
e811c8ce
RD
8118
8119def FindWindowByLabel(*args, **kwargs):
15afbcd0
RD
8120 """
8121 FindWindowByLabel(String label, Window parent=None) -> Window
8122
8123 Find a window by its label. Depending on the type of window, the label
8124 may be a window title or panel item label. If parent is None, the
8125 search will start from all top-level frames and dialog boxes; if
8126 non-None, the search will be limited to the given window
8127 hierarchy. The search is recursive in both cases.
8128 """
54f9ee45 8129 return _core_.FindWindowByLabel(*args, **kwargs)
e811c8ce
RD
8130
8131def Window_FromHWND(*args, **kwargs):
4276dc52 8132 """Window_FromHWND(Window parent, unsigned long _hWnd) -> Window"""
54f9ee45 8133 return _core_.Window_FromHWND(*args, **kwargs)
e811c8ce
RD
8134#---------------------------------------------------------------------------
8135
8136class Validator(EvtHandler):
093d3ff1 8137 """Proxy of C++ Validator class"""
e811c8ce
RD
8138 def __repr__(self):
8139 return "<%s.%s; proxy of C++ wxValidator instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
8140 def __init__(self, *args, **kwargs):
a95a7133 8141 """__init__(self) -> Validator"""
54f9ee45 8142 newobj = _core_.new_Validator(*args, **kwargs)
d14a1e28
RD
8143 self.this = newobj.this
8144 self.thisown = 1
8145 del newobj.thisown
8146 self._setOORInfo(self)
e811c8ce
RD
8147
8148 def Clone(*args, **kwargs):
a95a7133 8149 """Clone(self) -> Validator"""
54f9ee45 8150 return _core_.Validator_Clone(*args, **kwargs)
e811c8ce
RD
8151
8152 def Validate(*args, **kwargs):
a95a7133 8153 """Validate(self, Window parent) -> bool"""
54f9ee45 8154 return _core_.Validator_Validate(*args, **kwargs)
e811c8ce
RD
8155
8156 def TransferToWindow(*args, **kwargs):
a95a7133 8157 """TransferToWindow(self) -> bool"""
54f9ee45 8158 return _core_.Validator_TransferToWindow(*args, **kwargs)
e811c8ce
RD
8159
8160 def TransferFromWindow(*args, **kwargs):
a95a7133 8161 """TransferFromWindow(self) -> bool"""
54f9ee45 8162 return _core_.Validator_TransferFromWindow(*args, **kwargs)
e811c8ce
RD
8163
8164 def GetWindow(*args, **kwargs):
a95a7133 8165 """GetWindow(self) -> Window"""
54f9ee45 8166 return _core_.Validator_GetWindow(*args, **kwargs)
e811c8ce
RD
8167
8168 def SetWindow(*args, **kwargs):
a95a7133 8169 """SetWindow(self, Window window)"""
54f9ee45 8170 return _core_.Validator_SetWindow(*args, **kwargs)
e811c8ce
RD
8171
8172 def IsSilent(*args, **kwargs):
66c033b4 8173 """IsSilent() -> bool"""
54f9ee45 8174 return _core_.Validator_IsSilent(*args, **kwargs)
e811c8ce
RD
8175
8176 IsSilent = staticmethod(IsSilent)
8177 def SetBellOnError(*args, **kwargs):
66c033b4 8178 """SetBellOnError(int doIt=True)"""
54f9ee45 8179 return _core_.Validator_SetBellOnError(*args, **kwargs)
e811c8ce
RD
8180
8181 SetBellOnError = staticmethod(SetBellOnError)
8182
8183class ValidatorPtr(Validator):
8184 def __init__(self, this):
8185 self.this = this
8186 if not hasattr(self,"thisown"): self.thisown = 0
8187 self.__class__ = Validator
54f9ee45 8188_core_.Validator_swigregister(ValidatorPtr)
e811c8ce
RD
8189
8190def Validator_IsSilent(*args, **kwargs):
8191 """Validator_IsSilent() -> bool"""
54f9ee45 8192 return _core_.Validator_IsSilent(*args, **kwargs)
e811c8ce
RD
8193
8194def Validator_SetBellOnError(*args, **kwargs):
8195 """Validator_SetBellOnError(int doIt=True)"""
54f9ee45 8196 return _core_.Validator_SetBellOnError(*args, **kwargs)
e811c8ce
RD
8197
8198class PyValidator(Validator):
093d3ff1 8199 """Proxy of C++ PyValidator class"""
e811c8ce
RD
8200 def __repr__(self):
8201 return "<%s.%s; proxy of C++ wxPyValidator instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
8202 def __init__(self, *args, **kwargs):
a95a7133 8203 """__init__(self) -> PyValidator"""
54f9ee45 8204 newobj = _core_.new_PyValidator(*args, **kwargs)
e811c8ce
RD
8205 self.this = newobj.this
8206 self.thisown = 1
8207 del newobj.thisown
8208
8209 self._setCallbackInfo(self, PyValidator, 1)
8210 self._setOORInfo(self)
8211
8212 def _setCallbackInfo(*args, **kwargs):
a95a7133 8213 """_setCallbackInfo(self, PyObject self, PyObject _class, int incref=True)"""
54f9ee45 8214 return _core_.PyValidator__setCallbackInfo(*args, **kwargs)
e811c8ce
RD
8215
8216
8217class PyValidatorPtr(PyValidator):
8218 def __init__(self, this):
8219 self.this = this
8220 if not hasattr(self,"thisown"): self.thisown = 0
8221 self.__class__ = PyValidator
54f9ee45 8222_core_.PyValidator_swigregister(PyValidatorPtr)
e811c8ce
RD
8223
8224#---------------------------------------------------------------------------
8225
8226class Menu(EvtHandler):
093d3ff1 8227 """Proxy of C++ Menu class"""
d14a1e28
RD
8228 def __repr__(self):
8229 return "<%s.%s; proxy of C++ wxMenu instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
e811c8ce 8230 def __init__(self, *args, **kwargs):
a95a7133 8231 """__init__(self, String title=EmptyString, long style=0) -> Menu"""
54f9ee45 8232 newobj = _core_.new_Menu(*args, **kwargs)
e811c8ce
RD
8233 self.this = newobj.this
8234 self.thisown = 1
8235 del newobj.thisown
8236 self._setOORInfo(self)
8237
8238 def Append(*args, **kwargs):
a95a7133 8239 """Append(self, int id, String text, String help=EmptyString, int kind=ITEM_NORMAL) -> MenuItem"""
54f9ee45 8240 return _core_.Menu_Append(*args, **kwargs)
e811c8ce
RD
8241
8242 def AppendSeparator(*args, **kwargs):
a95a7133 8243 """AppendSeparator(self) -> MenuItem"""
54f9ee45 8244 return _core_.Menu_AppendSeparator(*args, **kwargs)
e811c8ce
RD
8245
8246 def AppendCheckItem(*args, **kwargs):
a95a7133 8247 """AppendCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
54f9ee45 8248 return _core_.Menu_AppendCheckItem(*args, **kwargs)
e811c8ce
RD
8249
8250 def AppendRadioItem(*args, **kwargs):
a95a7133 8251 """AppendRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
54f9ee45 8252 return _core_.Menu_AppendRadioItem(*args, **kwargs)
e811c8ce
RD
8253
8254 def AppendMenu(*args, **kwargs):
a95a7133 8255 """AppendMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
54f9ee45 8256 return _core_.Menu_AppendMenu(*args, **kwargs)
e811c8ce
RD
8257
8258 def AppendItem(*args, **kwargs):
a95a7133 8259 """AppendItem(self, MenuItem item) -> MenuItem"""
54f9ee45 8260 return _core_.Menu_AppendItem(*args, **kwargs)
e811c8ce
RD
8261
8262 def Break(*args, **kwargs):
a95a7133 8263 """Break(self)"""
54f9ee45 8264 return _core_.Menu_Break(*args, **kwargs)
e811c8ce
RD
8265
8266 def InsertItem(*args, **kwargs):
a95a7133 8267 """InsertItem(self, size_t pos, MenuItem item) -> MenuItem"""
54f9ee45 8268 return _core_.Menu_InsertItem(*args, **kwargs)
e811c8ce
RD
8269
8270 def Insert(*args, **kwargs):
0df68c9f 8271 """
a95a7133 8272 Insert(self, size_t pos, int id, String text, String help=EmptyString,
a41e16b6 8273 int kind=ITEM_NORMAL) -> MenuItem
0df68c9f 8274 """
54f9ee45 8275 return _core_.Menu_Insert(*args, **kwargs)
e811c8ce
RD
8276
8277 def InsertSeparator(*args, **kwargs):
a95a7133 8278 """InsertSeparator(self, size_t pos) -> MenuItem"""
54f9ee45 8279 return _core_.Menu_InsertSeparator(*args, **kwargs)
e811c8ce
RD
8280
8281 def InsertCheckItem(*args, **kwargs):
a95a7133 8282 """InsertCheckItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
54f9ee45 8283 return _core_.Menu_InsertCheckItem(*args, **kwargs)
e811c8ce
RD
8284
8285 def InsertRadioItem(*args, **kwargs):
a95a7133 8286 """InsertRadioItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
54f9ee45 8287 return _core_.Menu_InsertRadioItem(*args, **kwargs)
e811c8ce
RD
8288
8289 def InsertMenu(*args, **kwargs):
a95a7133 8290 """InsertMenu(self, size_t pos, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
54f9ee45 8291 return _core_.Menu_InsertMenu(*args, **kwargs)
e811c8ce
RD
8292
8293 def PrependItem(*args, **kwargs):
a95a7133 8294 """PrependItem(self, MenuItem item) -> MenuItem"""
54f9ee45 8295 return _core_.Menu_PrependItem(*args, **kwargs)
e811c8ce
RD
8296
8297 def Prepend(*args, **kwargs):
a95a7133 8298 """Prepend(self, int id, String text, String help=EmptyString, int kind=ITEM_NORMAL) -> MenuItem"""
54f9ee45 8299 return _core_.Menu_Prepend(*args, **kwargs)
e811c8ce
RD
8300
8301 def PrependSeparator(*args, **kwargs):
a95a7133 8302 """PrependSeparator(self) -> MenuItem"""
54f9ee45 8303 return _core_.Menu_PrependSeparator(*args, **kwargs)
e811c8ce
RD
8304
8305 def PrependCheckItem(*args, **kwargs):
a95a7133 8306 """PrependCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
54f9ee45 8307 return _core_.Menu_PrependCheckItem(*args, **kwargs)
e811c8ce
RD
8308
8309 def PrependRadioItem(*args, **kwargs):
a95a7133 8310 """PrependRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
54f9ee45 8311 return _core_.Menu_PrependRadioItem(*args, **kwargs)
e811c8ce
RD
8312
8313 def PrependMenu(*args, **kwargs):
a95a7133 8314 """PrependMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
54f9ee45 8315 return _core_.Menu_PrependMenu(*args, **kwargs)
e811c8ce
RD
8316
8317 def Remove(*args, **kwargs):
a95a7133 8318 """Remove(self, int id) -> MenuItem"""
54f9ee45 8319 return _core_.Menu_Remove(*args, **kwargs)
e811c8ce
RD
8320
8321 def RemoveItem(*args, **kwargs):
a95a7133 8322 """RemoveItem(self, MenuItem item) -> MenuItem"""
54f9ee45 8323 return _core_.Menu_RemoveItem(*args, **kwargs)
e811c8ce
RD
8324
8325 def Delete(*args, **kwargs):
a95a7133 8326 """Delete(self, int id) -> bool"""
54f9ee45 8327 return _core_.Menu_Delete(*args, **kwargs)
e811c8ce
RD
8328
8329 def DeleteItem(*args, **kwargs):
a95a7133 8330 """DeleteItem(self, MenuItem item) -> bool"""
54f9ee45 8331 return _core_.Menu_DeleteItem(*args, **kwargs)
e811c8ce
RD
8332
8333 def Destroy(*args, **kwargs):
0df68c9f 8334 """
a95a7133 8335 Destroy(self)
e811c8ce 8336
0df68c9f
RD
8337 Deletes the C++ object this Python object is a proxy for.
8338 """
54f9ee45 8339 return _core_.Menu_Destroy(*args, **kwargs)
e811c8ce
RD
8340
8341 def DestroyId(*args, **kwargs):
0df68c9f 8342 """
a95a7133 8343 DestroyId(self, int id) -> bool
e811c8ce 8344
0df68c9f
RD
8345 Deletes the C++ object this Python object is a proxy for.
8346 """
54f9ee45 8347 return _core_.Menu_DestroyId(*args, **kwargs)
e811c8ce
RD
8348
8349 def DestroyItem(*args, **kwargs):
0df68c9f 8350 """
a95a7133 8351 DestroyItem(self, MenuItem item) -> bool
e811c8ce 8352
0df68c9f
RD
8353 Deletes the C++ object this Python object is a proxy for.
8354 """
54f9ee45 8355 return _core_.Menu_DestroyItem(*args, **kwargs)
e811c8ce
RD
8356
8357 def GetMenuItemCount(*args, **kwargs):
a95a7133 8358 """GetMenuItemCount(self) -> size_t"""
54f9ee45 8359 return _core_.Menu_GetMenuItemCount(*args, **kwargs)
e811c8ce
RD
8360
8361 def GetMenuItems(*args, **kwargs):
a95a7133 8362 """GetMenuItems(self) -> PyObject"""
54f9ee45 8363 return _core_.Menu_GetMenuItems(*args, **kwargs)
e811c8ce
RD
8364
8365 def FindItem(*args, **kwargs):
a95a7133 8366 """FindItem(self, String item) -> int"""
54f9ee45 8367 return _core_.Menu_FindItem(*args, **kwargs)
e811c8ce
RD
8368
8369 def FindItemById(*args, **kwargs):
a95a7133 8370 """FindItemById(self, int id) -> MenuItem"""
54f9ee45 8371 return _core_.Menu_FindItemById(*args, **kwargs)
e811c8ce
RD
8372
8373 def FindItemByPosition(*args, **kwargs):
a95a7133 8374 """FindItemByPosition(self, size_t position) -> MenuItem"""
54f9ee45 8375 return _core_.Menu_FindItemByPosition(*args, **kwargs)
e811c8ce
RD
8376
8377 def Enable(*args, **kwargs):
a95a7133 8378 """Enable(self, int id, bool enable)"""
54f9ee45 8379 return _core_.Menu_Enable(*args, **kwargs)
e811c8ce
RD
8380
8381 def IsEnabled(*args, **kwargs):
a95a7133 8382 """IsEnabled(self, int id) -> bool"""
54f9ee45 8383 return _core_.Menu_IsEnabled(*args, **kwargs)
e811c8ce
RD
8384
8385 def Check(*args, **kwargs):
a95a7133 8386 """Check(self, int id, bool check)"""
54f9ee45 8387 return _core_.Menu_Check(*args, **kwargs)
e811c8ce
RD
8388
8389 def IsChecked(*args, **kwargs):
a95a7133 8390 """IsChecked(self, int id) -> bool"""
54f9ee45 8391 return _core_.Menu_IsChecked(*args, **kwargs)
e811c8ce
RD
8392
8393 def SetLabel(*args, **kwargs):
a95a7133 8394 """SetLabel(self, int id, String label)"""
54f9ee45 8395 return _core_.Menu_SetLabel(*args, **kwargs)
e811c8ce
RD
8396
8397 def GetLabel(*args, **kwargs):
a95a7133 8398 """GetLabel(self, int id) -> String"""
54f9ee45 8399 return _core_.Menu_GetLabel(*args, **kwargs)
e811c8ce
RD
8400
8401 def SetHelpString(*args, **kwargs):
a95a7133 8402 """SetHelpString(self, int id, String helpString)"""
54f9ee45 8403 return _core_.Menu_SetHelpString(*args, **kwargs)
e811c8ce
RD
8404
8405 def GetHelpString(*args, **kwargs):
a95a7133 8406 """GetHelpString(self, int id) -> String"""
54f9ee45 8407 return _core_.Menu_GetHelpString(*args, **kwargs)
e811c8ce
RD
8408
8409 def SetTitle(*args, **kwargs):
a95a7133 8410 """SetTitle(self, String title)"""
54f9ee45 8411 return _core_.Menu_SetTitle(*args, **kwargs)
e811c8ce
RD
8412
8413 def GetTitle(*args, **kwargs):
a95a7133 8414 """GetTitle(self) -> String"""
54f9ee45 8415 return _core_.Menu_GetTitle(*args, **kwargs)
e811c8ce
RD
8416
8417 def SetEventHandler(*args, **kwargs):
a95a7133 8418 """SetEventHandler(self, EvtHandler handler)"""
54f9ee45 8419 return _core_.Menu_SetEventHandler(*args, **kwargs)
e811c8ce
RD
8420
8421 def GetEventHandler(*args, **kwargs):
a95a7133 8422 """GetEventHandler(self) -> EvtHandler"""
54f9ee45 8423 return _core_.Menu_GetEventHandler(*args, **kwargs)
e811c8ce
RD
8424
8425 def SetInvokingWindow(*args, **kwargs):
a95a7133 8426 """SetInvokingWindow(self, Window win)"""
54f9ee45 8427 return _core_.Menu_SetInvokingWindow(*args, **kwargs)
e811c8ce
RD
8428
8429 def GetInvokingWindow(*args, **kwargs):
a95a7133 8430 """GetInvokingWindow(self) -> Window"""
54f9ee45 8431 return _core_.Menu_GetInvokingWindow(*args, **kwargs)
e811c8ce
RD
8432
8433 def GetStyle(*args, **kwargs):
a95a7133 8434 """GetStyle(self) -> long"""
54f9ee45 8435 return _core_.Menu_GetStyle(*args, **kwargs)
e811c8ce
RD
8436
8437 def UpdateUI(*args, **kwargs):
a95a7133 8438 """UpdateUI(self, EvtHandler source=None)"""
54f9ee45 8439 return _core_.Menu_UpdateUI(*args, **kwargs)
e811c8ce
RD
8440
8441 def GetMenuBar(*args, **kwargs):
a95a7133 8442 """GetMenuBar(self) -> MenuBar"""
54f9ee45 8443 return _core_.Menu_GetMenuBar(*args, **kwargs)
e811c8ce
RD
8444
8445 def Attach(*args, **kwargs):
a95a7133 8446 """Attach(self, wxMenuBarBase menubar)"""
54f9ee45 8447 return _core_.Menu_Attach(*args, **kwargs)
e811c8ce
RD
8448
8449 def Detach(*args, **kwargs):
a95a7133 8450 """Detach(self)"""
54f9ee45 8451 return _core_.Menu_Detach(*args, **kwargs)
e811c8ce
RD
8452
8453 def IsAttached(*args, **kwargs):
a95a7133 8454 """IsAttached(self) -> bool"""
54f9ee45 8455 return _core_.Menu_IsAttached(*args, **kwargs)
e811c8ce
RD
8456
8457 def SetParent(*args, **kwargs):
a95a7133 8458 """SetParent(self, Menu parent)"""
54f9ee45 8459 return _core_.Menu_SetParent(*args, **kwargs)
e811c8ce
RD
8460
8461 def GetParent(*args, **kwargs):
a95a7133 8462 """GetParent(self) -> Menu"""
54f9ee45 8463 return _core_.Menu_GetParent(*args, **kwargs)
e811c8ce 8464
d14a1e28
RD
8465
8466class MenuPtr(Menu):
8467 def __init__(self, this):
8468 self.this = this
8469 if not hasattr(self,"thisown"): self.thisown = 0
8470 self.__class__ = Menu
54f9ee45 8471_core_.Menu_swigregister(MenuPtr)
d14a1e28
RD
8472DefaultValidator = cvar.DefaultValidator
8473
8474#---------------------------------------------------------------------------
8475
8476class MenuBar(Window):
093d3ff1 8477 """Proxy of C++ MenuBar class"""
e811c8ce
RD
8478 def __repr__(self):
8479 return "<%s.%s; proxy of C++ wxMenuBar instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 8480 def __init__(self, *args, **kwargs):
a95a7133 8481 """__init__(self, long style=0) -> MenuBar"""
54f9ee45 8482 newobj = _core_.new_MenuBar(*args, **kwargs)
d14a1e28
RD
8483 self.this = newobj.this
8484 self.thisown = 1
8485 del newobj.thisown
8486 self._setOORInfo(self)
e811c8ce
RD
8487
8488 def Append(*args, **kwargs):
a95a7133 8489 """Append(self, Menu menu, String title) -> bool"""
54f9ee45 8490 return _core_.MenuBar_Append(*args, **kwargs)
e811c8ce
RD
8491
8492 def Insert(*args, **kwargs):
a95a7133 8493 """Insert(self, size_t pos, Menu menu, String title) -> bool"""
54f9ee45 8494 return _core_.MenuBar_Insert(*args, **kwargs)
e811c8ce
RD
8495
8496 def GetMenuCount(*args, **kwargs):
a95a7133 8497 """GetMenuCount(self) -> size_t"""
54f9ee45 8498 return _core_.MenuBar_GetMenuCount(*args, **kwargs)
e811c8ce
RD
8499
8500 def GetMenu(*args, **kwargs):
a95a7133 8501 """GetMenu(self, size_t pos) -> Menu"""
54f9ee45 8502 return _core_.MenuBar_GetMenu(*args, **kwargs)
e811c8ce
RD
8503
8504 def Replace(*args, **kwargs):
a95a7133 8505 """Replace(self, size_t pos, Menu menu, String title) -> Menu"""
54f9ee45 8506 return _core_.MenuBar_Replace(*args, **kwargs)
e811c8ce
RD
8507
8508 def Remove(*args, **kwargs):
a95a7133 8509 """Remove(self, size_t pos) -> Menu"""
54f9ee45 8510 return _core_.MenuBar_Remove(*args, **kwargs)
e811c8ce
RD
8511
8512 def EnableTop(*args, **kwargs):
a95a7133 8513 """EnableTop(self, size_t pos, bool enable)"""
54f9ee45 8514 return _core_.MenuBar_EnableTop(*args, **kwargs)
e811c8ce
RD
8515
8516 def IsEnabledTop(*args, **kwargs):
a95a7133 8517 """IsEnabledTop(self, size_t pos) -> bool"""
54f9ee45 8518 return _core_.MenuBar_IsEnabledTop(*args, **kwargs)
e811c8ce
RD
8519
8520 def SetLabelTop(*args, **kwargs):
a95a7133 8521 """SetLabelTop(self, size_t pos, String label)"""
54f9ee45 8522 return _core_.MenuBar_SetLabelTop(*args, **kwargs)
e811c8ce
RD
8523
8524 def GetLabelTop(*args, **kwargs):
a95a7133 8525 """GetLabelTop(self, size_t pos) -> String"""
54f9ee45 8526 return _core_.MenuBar_GetLabelTop(*args, **kwargs)
e811c8ce
RD
8527
8528 def FindMenuItem(*args, **kwargs):
a95a7133 8529 """FindMenuItem(self, String menu, String item) -> int"""
54f9ee45 8530 return _core_.MenuBar_FindMenuItem(*args, **kwargs)
e811c8ce
RD
8531
8532 def FindItemById(*args, **kwargs):
a95a7133 8533 """FindItemById(self, int id) -> MenuItem"""
54f9ee45 8534 return _core_.MenuBar_FindItemById(*args, **kwargs)
e811c8ce
RD
8535
8536 def FindMenu(*args, **kwargs):
a95a7133 8537 """FindMenu(self, String title) -> int"""
54f9ee45 8538 return _core_.MenuBar_FindMenu(*args, **kwargs)
e811c8ce
RD
8539
8540 def Enable(*args, **kwargs):
a95a7133 8541 """Enable(self, int id, bool enable)"""
54f9ee45 8542 return _core_.MenuBar_Enable(*args, **kwargs)
e811c8ce
RD
8543
8544 def Check(*args, **kwargs):
a95a7133 8545 """Check(self, int id, bool check)"""
54f9ee45 8546 return _core_.MenuBar_Check(*args, **kwargs)
e811c8ce
RD
8547
8548 def IsChecked(*args, **kwargs):
a95a7133 8549 """IsChecked(self, int id) -> bool"""
54f9ee45 8550 return _core_.MenuBar_IsChecked(*args, **kwargs)
e811c8ce
RD
8551
8552 def IsEnabled(*args, **kwargs):
a95a7133 8553 """IsEnabled(self, int id) -> bool"""
54f9ee45 8554 return _core_.MenuBar_IsEnabled(*args, **kwargs)
e811c8ce
RD
8555
8556 def SetLabel(*args, **kwargs):
a95a7133 8557 """SetLabel(self, int id, String label)"""
54f9ee45 8558 return _core_.MenuBar_SetLabel(*args, **kwargs)
e811c8ce
RD
8559
8560 def GetLabel(*args, **kwargs):
a95a7133 8561 """GetLabel(self, int id) -> String"""
54f9ee45 8562 return _core_.MenuBar_GetLabel(*args, **kwargs)
e811c8ce
RD
8563
8564 def SetHelpString(*args, **kwargs):
a95a7133 8565 """SetHelpString(self, int id, String helpString)"""
54f9ee45 8566 return _core_.MenuBar_SetHelpString(*args, **kwargs)
e811c8ce
RD
8567
8568 def GetHelpString(*args, **kwargs):
a95a7133 8569 """GetHelpString(self, int id) -> String"""
54f9ee45 8570 return _core_.MenuBar_GetHelpString(*args, **kwargs)
e811c8ce
RD
8571
8572 def GetFrame(*args, **kwargs):
a95a7133 8573 """GetFrame(self) -> wxFrame"""
54f9ee45 8574 return _core_.MenuBar_GetFrame(*args, **kwargs)
e811c8ce
RD
8575
8576 def IsAttached(*args, **kwargs):
a95a7133 8577 """IsAttached(self) -> bool"""
54f9ee45 8578 return _core_.MenuBar_IsAttached(*args, **kwargs)
e811c8ce
RD
8579
8580 def Attach(*args, **kwargs):
a95a7133 8581 """Attach(self, wxFrame frame)"""
54f9ee45 8582 return _core_.MenuBar_Attach(*args, **kwargs)
e811c8ce
RD
8583
8584 def Detach(*args, **kwargs):
a95a7133 8585 """Detach(self)"""
54f9ee45 8586 return _core_.MenuBar_Detach(*args, **kwargs)
e811c8ce 8587
d14a1e28
RD
8588
8589class MenuBarPtr(MenuBar):
8590 def __init__(self, this):
8591 self.this = this
8592 if not hasattr(self,"thisown"): self.thisown = 0
8593 self.__class__ = MenuBar
54f9ee45 8594_core_.MenuBar_swigregister(MenuBarPtr)
d14a1e28
RD
8595
8596#---------------------------------------------------------------------------
8597
8598class MenuItem(Object):
093d3ff1 8599 """Proxy of C++ MenuItem class"""
e811c8ce
RD
8600 def __repr__(self):
8601 return "<%s.%s; proxy of C++ wxMenuItem instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 8602 def __init__(self, *args, **kwargs):
0df68c9f 8603 """
a95a7133 8604 __init__(self, Menu parentMenu=None, int id=ID_ANY, String text=EmptyString,
196addbf
RD
8605 String help=EmptyString, int kind=ITEM_NORMAL,
8606 Menu subMenu=None) -> MenuItem
0df68c9f 8607 """
54f9ee45 8608 newobj = _core_.new_MenuItem(*args, **kwargs)
d14a1e28
RD
8609 self.this = newobj.this
8610 self.thisown = 1
8611 del newobj.thisown
e811c8ce 8612 def GetMenu(*args, **kwargs):
a95a7133 8613 """GetMenu(self) -> Menu"""
54f9ee45 8614 return _core_.MenuItem_GetMenu(*args, **kwargs)
e811c8ce
RD
8615
8616 def SetMenu(*args, **kwargs):
a95a7133 8617 """SetMenu(self, Menu menu)"""
54f9ee45 8618 return _core_.MenuItem_SetMenu(*args, **kwargs)
e811c8ce
RD
8619
8620 def SetId(*args, **kwargs):
a95a7133 8621 """SetId(self, int id)"""
54f9ee45 8622 return _core_.MenuItem_SetId(*args, **kwargs)
e811c8ce
RD
8623
8624 def GetId(*args, **kwargs):
a95a7133 8625 """GetId(self) -> int"""
54f9ee45 8626 return _core_.MenuItem_GetId(*args, **kwargs)
e811c8ce
RD
8627
8628 def IsSeparator(*args, **kwargs):
a95a7133 8629 """IsSeparator(self) -> bool"""
54f9ee45 8630 return _core_.MenuItem_IsSeparator(*args, **kwargs)
e811c8ce
RD
8631
8632 def SetText(*args, **kwargs):
a95a7133 8633 """SetText(self, String str)"""
54f9ee45 8634 return _core_.MenuItem_SetText(*args, **kwargs)
e811c8ce
RD
8635
8636 def GetLabel(*args, **kwargs):
a95a7133 8637 """GetLabel(self) -> String"""
54f9ee45 8638 return _core_.MenuItem_GetLabel(*args, **kwargs)
e811c8ce
RD
8639
8640 def GetText(*args, **kwargs):
a95a7133 8641 """GetText(self) -> String"""
54f9ee45 8642 return _core_.MenuItem_GetText(*args, **kwargs)
e811c8ce
RD
8643
8644 def GetLabelFromText(*args, **kwargs):
66c033b4 8645 """GetLabelFromText(String text) -> String"""
54f9ee45 8646 return _core_.MenuItem_GetLabelFromText(*args, **kwargs)
e811c8ce
RD
8647
8648 GetLabelFromText = staticmethod(GetLabelFromText)
8649 def GetKind(*args, **kwargs):
a95a7133 8650 """GetKind(self) -> int"""
54f9ee45 8651 return _core_.MenuItem_GetKind(*args, **kwargs)
e811c8ce 8652
a95a7133
RD
8653 def SetKind(*args, **kwargs):
8654 """SetKind(self, int kind)"""
54f9ee45 8655 return _core_.MenuItem_SetKind(*args, **kwargs)
a95a7133 8656
e811c8ce 8657 def SetCheckable(*args, **kwargs):
a95a7133 8658 """SetCheckable(self, bool checkable)"""
54f9ee45 8659 return _core_.MenuItem_SetCheckable(*args, **kwargs)
e811c8ce
RD
8660
8661 def IsCheckable(*args, **kwargs):
a95a7133 8662 """IsCheckable(self) -> bool"""
54f9ee45 8663 return _core_.MenuItem_IsCheckable(*args, **kwargs)
e811c8ce
RD
8664
8665 def IsSubMenu(*args, **kwargs):
a95a7133 8666 """IsSubMenu(self) -> bool"""
54f9ee45 8667 return _core_.MenuItem_IsSubMenu(*args, **kwargs)
e811c8ce
RD
8668
8669 def SetSubMenu(*args, **kwargs):
a95a7133 8670 """SetSubMenu(self, Menu menu)"""
54f9ee45 8671 return _core_.MenuItem_SetSubMenu(*args, **kwargs)
e811c8ce
RD
8672
8673 def GetSubMenu(*args, **kwargs):
a95a7133 8674 """GetSubMenu(self) -> Menu"""
54f9ee45 8675 return _core_.MenuItem_GetSubMenu(*args, **kwargs)
e811c8ce
RD
8676
8677 def Enable(*args, **kwargs):
a95a7133 8678 """Enable(self, bool enable=True)"""
54f9ee45 8679 return _core_.MenuItem_Enable(*args, **kwargs)
e811c8ce
RD
8680
8681 def IsEnabled(*args, **kwargs):
a95a7133 8682 """IsEnabled(self) -> bool"""
54f9ee45 8683 return _core_.MenuItem_IsEnabled(*args, **kwargs)
e811c8ce
RD
8684
8685 def Check(*args, **kwargs):
a95a7133 8686 """Check(self, bool check=True)"""
54f9ee45 8687 return _core_.MenuItem_Check(*args, **kwargs)
e811c8ce
RD
8688
8689 def IsChecked(*args, **kwargs):
a95a7133 8690 """IsChecked(self) -> bool"""
54f9ee45 8691 return _core_.MenuItem_IsChecked(*args, **kwargs)
e811c8ce
RD
8692
8693 def Toggle(*args, **kwargs):
a95a7133 8694 """Toggle(self)"""
54f9ee45 8695 return _core_.MenuItem_Toggle(*args, **kwargs)
e811c8ce
RD
8696
8697 def SetHelp(*args, **kwargs):
a95a7133 8698 """SetHelp(self, String str)"""
54f9ee45 8699 return _core_.MenuItem_SetHelp(*args, **kwargs)
e811c8ce
RD
8700
8701 def GetHelp(*args, **kwargs):
a95a7133 8702 """GetHelp(self) -> String"""
54f9ee45 8703 return _core_.MenuItem_GetHelp(*args, **kwargs)
e811c8ce
RD
8704
8705 def GetAccel(*args, **kwargs):
a95a7133 8706 """GetAccel(self) -> AcceleratorEntry"""
54f9ee45 8707 return _core_.MenuItem_GetAccel(*args, **kwargs)
e811c8ce
RD
8708
8709 def SetAccel(*args, **kwargs):
a95a7133 8710 """SetAccel(self, AcceleratorEntry accel)"""
54f9ee45 8711 return _core_.MenuItem_SetAccel(*args, **kwargs)
e811c8ce 8712
c1280d1e
RD
8713 def SetFont(*args, **kwargs):
8714 """SetFont(self, Font font)"""
8715 return _core_.MenuItem_SetFont(*args, **kwargs)
8716
8717 def GetFont(*args, **kwargs):
8718 """GetFont(self) -> Font"""
8719 return _core_.MenuItem_GetFont(*args, **kwargs)
8720
8721 def SetTextColour(*args, **kwargs):
8722 """SetTextColour(self, Colour colText)"""
8723 return _core_.MenuItem_SetTextColour(*args, **kwargs)
8724
8725 def GetTextColour(*args, **kwargs):
8726 """GetTextColour(self) -> Colour"""
8727 return _core_.MenuItem_GetTextColour(*args, **kwargs)
8728
8729 def SetBackgroundColour(*args, **kwargs):
8730 """SetBackgroundColour(self, Colour colBack)"""
8731 return _core_.MenuItem_SetBackgroundColour(*args, **kwargs)
8732
8733 def GetBackgroundColour(*args, **kwargs):
8734 """GetBackgroundColour(self) -> Colour"""
8735 return _core_.MenuItem_GetBackgroundColour(*args, **kwargs)
8736
8737 def SetBitmaps(*args, **kwargs):
8738 """SetBitmaps(self, Bitmap bmpChecked, Bitmap bmpUnchecked=wxNullBitmap)"""
8739 return _core_.MenuItem_SetBitmaps(*args, **kwargs)
8740
8741 def SetDisabledBitmap(*args, **kwargs):
8742 """SetDisabledBitmap(self, Bitmap bmpDisabled)"""
8743 return _core_.MenuItem_SetDisabledBitmap(*args, **kwargs)
8744
8745 def GetDisabledBitmap(*args, **kwargs):
8746 """GetDisabledBitmap(self) -> Bitmap"""
8747 return _core_.MenuItem_GetDisabledBitmap(*args, **kwargs)
8748
8749 def SetMarginWidth(*args, **kwargs):
8750 """SetMarginWidth(self, int nWidth)"""
8751 return _core_.MenuItem_SetMarginWidth(*args, **kwargs)
8752
8753 def GetMarginWidth(*args, **kwargs):
8754 """GetMarginWidth(self) -> int"""
8755 return _core_.MenuItem_GetMarginWidth(*args, **kwargs)
8756
e811c8ce 8757 def GetDefaultMarginWidth(*args, **kwargs):
66c033b4 8758 """GetDefaultMarginWidth() -> int"""
54f9ee45 8759 return _core_.MenuItem_GetDefaultMarginWidth(*args, **kwargs)
e811c8ce
RD
8760
8761 GetDefaultMarginWidth = staticmethod(GetDefaultMarginWidth)
c1280d1e
RD
8762 def IsOwnerDrawn(*args, **kwargs):
8763 """IsOwnerDrawn(self) -> bool"""
8764 return _core_.MenuItem_IsOwnerDrawn(*args, **kwargs)
8765
8766 def SetOwnerDrawn(*args, **kwargs):
8767 """SetOwnerDrawn(self, bool ownerDrawn=True)"""
8768 return _core_.MenuItem_SetOwnerDrawn(*args, **kwargs)
8769
8770 def ResetOwnerDrawn(*args, **kwargs):
8771 """ResetOwnerDrawn(self)"""
8772 return _core_.MenuItem_ResetOwnerDrawn(*args, **kwargs)
8773
e811c8ce 8774 def SetBitmap(*args, **kwargs):
a95a7133 8775 """SetBitmap(self, Bitmap bitmap)"""
54f9ee45 8776 return _core_.MenuItem_SetBitmap(*args, **kwargs)
e811c8ce
RD
8777
8778 def GetBitmap(*args, **kwargs):
a95a7133 8779 """GetBitmap(self) -> Bitmap"""
54f9ee45 8780 return _core_.MenuItem_GetBitmap(*args, **kwargs)
e811c8ce 8781
d14a1e28
RD
8782
8783class MenuItemPtr(MenuItem):
8784 def __init__(self, this):
8785 self.this = this
8786 if not hasattr(self,"thisown"): self.thisown = 0
8787 self.__class__ = MenuItem
54f9ee45 8788_core_.MenuItem_swigregister(MenuItemPtr)
d14a1e28 8789
e811c8ce 8790def MenuItem_GetLabelFromText(*args, **kwargs):
196addbf 8791 """MenuItem_GetLabelFromText(String text) -> String"""
54f9ee45 8792 return _core_.MenuItem_GetLabelFromText(*args, **kwargs)
d14a1e28 8793
e811c8ce
RD
8794def MenuItem_GetDefaultMarginWidth(*args, **kwargs):
8795 """MenuItem_GetDefaultMarginWidth() -> int"""
54f9ee45 8796 return _core_.MenuItem_GetDefaultMarginWidth(*args, **kwargs)
d14a1e28
RD
8797
8798#---------------------------------------------------------------------------
8799
8800class Control(Window):
15afbcd0
RD
8801 """
8802 This is the base class for a control or 'widget'.
8803
41e2b43e
RD
8804 A control is generally a small window which processes user input
8805 and/or displays one or more item of data.
15afbcd0 8806 """
e811c8ce
RD
8807 def __repr__(self):
8808 return "<%s.%s; proxy of C++ wxControl instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 8809 def __init__(self, *args, **kwargs):
0df68c9f 8810 """
248ed943
RD
8811 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
8812 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
b2dc1044 8813 String name=ControlNameStr) -> Control
15afbcd0 8814
41e2b43e
RD
8815 Create a Control. Normally you should only call this from a subclass'
8816 __init__ as a plain old wx.Control is not very useful.
0df68c9f 8817 """
54f9ee45 8818 newobj = _core_.new_Control(*args, **kwargs)
d14a1e28
RD
8819 self.this = newobj.this
8820 self.thisown = 1
8821 del newobj.thisown
8822 self._setOORInfo(self)
e811c8ce
RD
8823
8824 def Create(*args, **kwargs):
0df68c9f 8825 """
248ed943
RD
8826 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
8827 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
b2dc1044 8828 String name=ControlNameStr) -> bool
15afbcd0
RD
8829
8830 Do the 2nd phase and create the GUI control.
0df68c9f 8831 """
54f9ee45 8832 return _core_.Control_Create(*args, **kwargs)
e811c8ce
RD
8833
8834 def Command(*args, **kwargs):
15afbcd0 8835 """
a95a7133 8836 Command(self, CommandEvent event)
15afbcd0 8837
41e2b43e
RD
8838 Simulates the effect of the user issuing a command to the item.
8839
8840 :see: `wx.CommandEvent`
8841
15afbcd0 8842 """
54f9ee45 8843 return _core_.Control_Command(*args, **kwargs)
e811c8ce
RD
8844
8845 def GetLabel(*args, **kwargs):
15afbcd0 8846 """
a95a7133 8847 GetLabel(self) -> String
15afbcd0
RD
8848
8849 Return a control's text.
8850 """
54f9ee45 8851 return _core_.Control_GetLabel(*args, **kwargs)
e811c8ce
RD
8852
8853 def SetLabel(*args, **kwargs):
15afbcd0 8854 """
a95a7133 8855 SetLabel(self, String label)
15afbcd0
RD
8856
8857 Sets the item's text.
8858 """
54f9ee45 8859 return _core_.Control_SetLabel(*args, **kwargs)
e811c8ce 8860
74a57fcd 8861 def GetClassDefaultAttributes(*args, **kwargs):
110da5b0
RD
8862 """
8863 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
8864
8865 Get the default attributes for this class. This is useful if you want
8866 to use the same font or colour in your own control as in a standard
8867 control -- which is a much better idea than hard coding specific
8868 colours or fonts which might look completely out of place on the
8869 user's system, especially if it uses themes.
8870
8871 The variant parameter is only relevant under Mac currently and is
8872 ignore under other platforms. Under Mac, it will change the size of
8873 the returned font. See `wx.Window.SetWindowVariant` for more about
8874 this.
8875 """
54f9ee45 8876 return _core_.Control_GetClassDefaultAttributes(*args, **kwargs)
74a57fcd
RD
8877
8878 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
d14a1e28
RD
8879
8880class ControlPtr(Control):
8881 def __init__(self, this):
8882 self.this = this
8883 if not hasattr(self,"thisown"): self.thisown = 0
8884 self.__class__ = Control
54f9ee45 8885_core_.Control_swigregister(ControlPtr)
b2dc1044 8886ControlNameStr = cvar.ControlNameStr
d14a1e28
RD
8887
8888def PreControl(*args, **kwargs):
15afbcd0
RD
8889 """
8890 PreControl() -> Control
8891
8892 Precreate a Control control for 2-phase creation
8893 """
54f9ee45 8894 val = _core_.new_PreControl(*args, **kwargs)
d14a1e28
RD
8895 val.thisown = 1
8896 return val
8897
74a57fcd 8898def Control_GetClassDefaultAttributes(*args, **kwargs):
110da5b0
RD
8899 """
8900 Control_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
8901
8902 Get the default attributes for this class. This is useful if you want
8903 to use the same font or colour in your own control as in a standard
8904 control -- which is a much better idea than hard coding specific
8905 colours or fonts which might look completely out of place on the
8906 user's system, especially if it uses themes.
8907
8908 The variant parameter is only relevant under Mac currently and is
8909 ignore under other platforms. Under Mac, it will change the size of
8910 the returned font. See `wx.Window.SetWindowVariant` for more about
8911 this.
8912 """
54f9ee45 8913 return _core_.Control_GetClassDefaultAttributes(*args, **kwargs)
74a57fcd 8914
d14a1e28
RD
8915#---------------------------------------------------------------------------
8916
8917class ItemContainer(object):
15afbcd0 8918 """
53aa7709
RD
8919 The wx.ItemContainer class defines an interface which is implemented
8920 by all controls which have string subitems, each of which may be
8921 selected, such as `wx.ListBox`, `wx.CheckListBox`, `wx.Choice` as well
8922 as `wx.ComboBox` which implements an extended interface deriving from
41e2b43e 8923 this one.
15afbcd0 8924
41e2b43e
RD
8925 It defines the methods for accessing the control's items and although
8926 each of the derived classes implements them differently, they still
8927 all conform to the same interface.
15afbcd0 8928
41e2b43e
RD
8929 The items in a wx.ItemContainer have (non empty) string labels and,
8930 optionally, client data associated with them.
15afbcd0
RD
8931
8932 """
d14a1e28
RD
8933 def __init__(self): raise RuntimeError, "No constructor defined"
8934 def __repr__(self):
8935 return "<%s.%s; proxy of C++ wxItemContainer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
e811c8ce 8936 def Append(*args, **kwargs):
15afbcd0 8937 """
a95a7133 8938 Append(self, String item, PyObject clientData=None) -> int
15afbcd0 8939
41e2b43e
RD
8940 Adds the item to the control, associating the given data with the item
8941 if not None. The return value is the index of the newly added item
8942 which may be different from the last one if the control is sorted (e.g.
8943 has wx.LB_SORT or wx.CB_SORT style).
15afbcd0 8944 """
54f9ee45 8945 return _core_.ItemContainer_Append(*args, **kwargs)
e811c8ce
RD
8946
8947 def AppendItems(*args, **kwargs):
15afbcd0 8948 """
f5b96ee1 8949 AppendItems(self, List strings)
15afbcd0 8950
41e2b43e
RD
8951 Apend several items at once to the control. Notice that calling this
8952 method may be much faster than appending the items one by one if you
8953 need to add a lot of items.
15afbcd0 8954 """
54f9ee45 8955 return _core_.ItemContainer_AppendItems(*args, **kwargs)
e811c8ce
RD
8956
8957 def Insert(*args, **kwargs):
15afbcd0 8958 """
a95a7133 8959 Insert(self, String item, int pos, PyObject clientData=None) -> int
15afbcd0 8960
41e2b43e 8961 Insert an item into the control before the item at the ``pos`` index,
15afbcd0
RD
8962 optionally associating some data object with the item.
8963 """
54f9ee45 8964 return _core_.ItemContainer_Insert(*args, **kwargs)
e811c8ce
RD
8965
8966 def Clear(*args, **kwargs):
15afbcd0 8967 """
a95a7133 8968 Clear(self)
15afbcd0
RD
8969
8970 Removes all items from the control.
8971 """
54f9ee45 8972 return _core_.ItemContainer_Clear(*args, **kwargs)
e811c8ce
RD
8973
8974 def Delete(*args, **kwargs):
15afbcd0 8975 """
a95a7133 8976 Delete(self, int n)
15afbcd0 8977
41e2b43e
RD
8978 Deletes the item at the zero-based index 'n' from the control. Note
8979 that it is an error (signalled by a `wx.PyAssertionError` exception if
8980 enabled) to remove an item with the index negative or greater or equal
8981 than the number of items in the control.
15afbcd0 8982 """
54f9ee45 8983 return _core_.ItemContainer_Delete(*args, **kwargs)
e811c8ce 8984
53aa7709
RD
8985 def GetClientData(*args, **kwargs):
8986 """
8987 GetClientData(self, int n) -> PyObject
8988
8989 Returns the client data associated with the given item, (if any.)
8990 """
8991 return _core_.ItemContainer_GetClientData(*args, **kwargs)
8992
8993 def SetClientData(*args, **kwargs):
8994 """
8995 SetClientData(self, int n, PyObject clientData)
8996
8997 Associate the given client data with the item at position n.
8998 """
8999 return _core_.ItemContainer_SetClientData(*args, **kwargs)
9000
e811c8ce 9001 def GetCount(*args, **kwargs):
15afbcd0 9002 """
a95a7133 9003 GetCount(self) -> int
15afbcd0
RD
9004
9005 Returns the number of items in the control.
9006 """
54f9ee45 9007 return _core_.ItemContainer_GetCount(*args, **kwargs)
e811c8ce
RD
9008
9009 def IsEmpty(*args, **kwargs):
15afbcd0 9010 """
a95a7133 9011 IsEmpty(self) -> bool
15afbcd0
RD
9012
9013 Returns True if the control is empty or False if it has some items.
9014 """
54f9ee45 9015 return _core_.ItemContainer_IsEmpty(*args, **kwargs)
e811c8ce
RD
9016
9017 def GetString(*args, **kwargs):
15afbcd0 9018 """
a95a7133 9019 GetString(self, int n) -> String
15afbcd0
RD
9020
9021 Returns the label of the item with the given index.
9022 """
54f9ee45 9023 return _core_.ItemContainer_GetString(*args, **kwargs)
e811c8ce
RD
9024
9025 def GetStrings(*args, **kwargs):
a95a7133 9026 """GetStrings(self) -> wxArrayString"""
54f9ee45 9027 return _core_.ItemContainer_GetStrings(*args, **kwargs)
e811c8ce
RD
9028
9029 def SetString(*args, **kwargs):
15afbcd0 9030 """
a95a7133 9031 SetString(self, int n, String s)
15afbcd0
RD
9032
9033 Sets the label for the given item.
9034 """
54f9ee45 9035 return _core_.ItemContainer_SetString(*args, **kwargs)
e811c8ce
RD
9036
9037 def FindString(*args, **kwargs):
15afbcd0 9038 """
a95a7133 9039 FindString(self, String s) -> int
15afbcd0
RD
9040
9041 Finds an item whose label matches the given string. Returns the
41e2b43e
RD
9042 zero-based position of the item, or ``wx.NOT_FOUND`` if the string was not
9043 found.
15afbcd0 9044 """
54f9ee45 9045 return _core_.ItemContainer_FindString(*args, **kwargs)
e811c8ce 9046
53aa7709 9047 def SetSelection(*args, **kwargs):
15afbcd0 9048 """
53aa7709 9049 SetSelection(self, int n)
15afbcd0
RD
9050
9051 Sets the item at index 'n' to be the selected item.
9052 """
53aa7709 9053 return _core_.ItemContainer_SetSelection(*args, **kwargs)
e811c8ce
RD
9054
9055 def GetSelection(*args, **kwargs):
15afbcd0 9056 """
a95a7133 9057 GetSelection(self) -> int
15afbcd0 9058
41e2b43e
RD
9059 Returns the index of the selected item or ``wx.NOT_FOUND`` if no item
9060 is selected.
15afbcd0 9061 """
54f9ee45 9062 return _core_.ItemContainer_GetSelection(*args, **kwargs)
e811c8ce 9063
53aa7709
RD
9064 def SetStringSelection(*args, **kwargs):
9065 """SetStringSelection(self, String s) -> bool"""
9066 return _core_.ItemContainer_SetStringSelection(*args, **kwargs)
9067
e811c8ce 9068 def GetStringSelection(*args, **kwargs):
15afbcd0 9069 """
a95a7133 9070 GetStringSelection(self) -> String
15afbcd0 9071
41e2b43e
RD
9072 Returns the label of the selected item or an empty string if no item
9073 is selected.
15afbcd0 9074 """
54f9ee45 9075 return _core_.ItemContainer_GetStringSelection(*args, **kwargs)
e811c8ce 9076
53aa7709 9077 def Select(*args, **kwargs):
15afbcd0 9078 """
53aa7709 9079 Select(self, int n)
15afbcd0 9080
53aa7709
RD
9081 This is the same as `SetSelection` and exists only because it is
9082 slightly more natural for controls which support multiple selection.
15afbcd0 9083 """
53aa7709 9084 return _core_.ItemContainer_Select(*args, **kwargs)
e811c8ce 9085
d14a1e28
RD
9086
9087class ItemContainerPtr(ItemContainer):
9088 def __init__(self, this):
9089 self.this = this
9090 if not hasattr(self,"thisown"): self.thisown = 0
9091 self.__class__ = ItemContainer
54f9ee45 9092_core_.ItemContainer_swigregister(ItemContainerPtr)
d14a1e28
RD
9093
9094#---------------------------------------------------------------------------
9095
9096class ControlWithItems(Control,ItemContainer):
15afbcd0 9097 """
41e2b43e
RD
9098 wx.ControlWithItems combines the ``wx.ItemContainer`` class with the
9099 wx.Control class, and is used for the base class of various controls
9100 that have items.
15afbcd0 9101 """
d14a1e28
RD
9102 def __init__(self): raise RuntimeError, "No constructor defined"
9103 def __repr__(self):
9104 return "<%s.%s; proxy of C++ wxControlWithItems instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
9105
9106class ControlWithItemsPtr(ControlWithItems):
9107 def __init__(self, this):
9108 self.this = this
9109 if not hasattr(self,"thisown"): self.thisown = 0
9110 self.__class__ = ControlWithItems
54f9ee45 9111_core_.ControlWithItems_swigregister(ControlWithItemsPtr)
d14a1e28
RD
9112
9113#---------------------------------------------------------------------------
9114
9115class SizerItem(Object):
248ed943
RD
9116 """
9117 The wx.SizerItem class is used to track the position, size and other
9118 attributes of each item managed by a `wx.Sizer`. In normal usage user
9119 code should never need to deal directly with a wx.SizerItem, but
9120 custom classes derived from `wx.PySizer` will probably need to use the
9121 collection of wx.SizerItems held by wx.Sizer when calculating layout.
9122
9123 :see: `wx.Sizer`, `wx.GBSizerItem`
9124 """
e811c8ce
RD
9125 def __repr__(self):
9126 return "<%s.%s; proxy of C++ wxSizerItem instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 9127 def __init__(self, *args, **kwargs):
248ed943
RD
9128 """
9129 __init__(self) -> SizerItem
9130
9131 Constructs an empty wx.SizerItem. Either a window, sizer or spacer
9132 size will need to be set before this item can be used in a Sizer.
9133
9134 You will probably never need to create a wx.SizerItem directly as they
9135 are created automatically when the sizer's Add, Insert or Prepend
9136 methods are called.
9137
9138 :see: `wx.SizerItemSpacer`, `wx.SizerItemWindow`, `wx.SizerItemSizer`
9139 """
54f9ee45 9140 newobj = _core_.new_SizerItem(*args, **kwargs)
d14a1e28
RD
9141 self.this = newobj.this
9142 self.thisown = 1
9143 del newobj.thisown
e811c8ce 9144 def DeleteWindows(*args, **kwargs):
248ed943
RD
9145 """
9146 DeleteWindows(self)
9147
9148 Destroy the window or the windows in a subsizer, depending on the type
9149 of item.
9150 """
54f9ee45 9151 return _core_.SizerItem_DeleteWindows(*args, **kwargs)
e811c8ce
RD
9152
9153 def DetachSizer(*args, **kwargs):
248ed943
RD
9154 """
9155 DetachSizer(self)
9156
9157 Enable deleting the SizerItem without destroying the contained sizer.
9158 """
54f9ee45 9159 return _core_.SizerItem_DetachSizer(*args, **kwargs)
e811c8ce
RD
9160
9161 def GetSize(*args, **kwargs):
248ed943
RD
9162 """
9163 GetSize(self) -> Size
9164
9165 Get the current size of the item, as set in the last Layout.
9166 """
54f9ee45 9167 return _core_.SizerItem_GetSize(*args, **kwargs)
e811c8ce
RD
9168
9169 def CalcMin(*args, **kwargs):
248ed943
RD
9170 """
9171 CalcMin(self) -> Size
9172
9173 Calculates the minimum desired size for the item, including any space
9174 needed by borders.
9175 """
54f9ee45 9176 return _core_.SizerItem_CalcMin(*args, **kwargs)
e811c8ce
RD
9177
9178 def SetDimension(*args, **kwargs):
248ed943
RD
9179 """
9180 SetDimension(self, Point pos, Size size)
9181
9182 Set the position and size of the space allocated for this item by the
9183 sizer, and adjust the position and size of the item (window or
9184 subsizer) to be within that space taking alignment and borders into
9185 account.
9186 """
54f9ee45 9187 return _core_.SizerItem_SetDimension(*args, **kwargs)
e811c8ce
RD
9188
9189 def GetMinSize(*args, **kwargs):
248ed943
RD
9190 """
9191 GetMinSize(self) -> Size
9192
9193 Get the minimum size needed for the item.
9194 """
54f9ee45 9195 return _core_.SizerItem_GetMinSize(*args, **kwargs)
e811c8ce 9196
dfbb5885
RD
9197 def GetMinSizeWithBorder(*args, **kwargs):
9198 """
9199 GetMinSizeWithBorder(self) -> Size
9200
9201 Get the minimum size needed for the item with space for the borders
9202 added, if needed.
9203 """
9204 return _core_.SizerItem_GetMinSizeWithBorder(*args, **kwargs)
9205
e811c8ce 9206 def SetInitSize(*args, **kwargs):
a95a7133 9207 """SetInitSize(self, int x, int y)"""
54f9ee45 9208 return _core_.SizerItem_SetInitSize(*args, **kwargs)
e811c8ce
RD
9209
9210 def SetRatioWH(*args, **kwargs):
248ed943
RD
9211 """
9212 SetRatioWH(self, int width, int height)
9213
9214 Set the ratio item attribute.
9215 """
54f9ee45 9216 return _core_.SizerItem_SetRatioWH(*args, **kwargs)
e811c8ce
RD
9217
9218 def SetRatioSize(*args, **kwargs):
248ed943
RD
9219 """
9220 SetRatioSize(self, Size size)
9221
9222 Set the ratio item attribute.
9223 """
54f9ee45 9224 return _core_.SizerItem_SetRatioSize(*args, **kwargs)
e811c8ce
RD
9225
9226 def SetRatio(*args, **kwargs):
248ed943
RD
9227 """
9228 SetRatio(self, float ratio)
9229
9230 Set the ratio item attribute.
9231 """
54f9ee45 9232 return _core_.SizerItem_SetRatio(*args, **kwargs)
e811c8ce
RD
9233
9234 def GetRatio(*args, **kwargs):
248ed943
RD
9235 """
9236 GetRatio(self) -> float
9237
9238 Set the ratio item attribute.
9239 """
54f9ee45 9240 return _core_.SizerItem_GetRatio(*args, **kwargs)
e811c8ce 9241
d3b6e4ff
RD
9242 def GetRect(*args, **kwargs):
9243 """
9244 GetRect(self) -> Rect
9245
9246 Returns the rectangle that the sizer item should occupy
9247 """
9248 return _core_.SizerItem_GetRect(*args, **kwargs)
9249
e811c8ce 9250 def IsWindow(*args, **kwargs):
248ed943
RD
9251 """
9252 IsWindow(self) -> bool
9253
9254 Is this sizer item a window?
9255 """
54f9ee45 9256 return _core_.SizerItem_IsWindow(*args, **kwargs)
e811c8ce
RD
9257
9258 def IsSizer(*args, **kwargs):
248ed943
RD
9259 """
9260 IsSizer(self) -> bool
9261
9262 Is this sizer item a subsizer?
9263 """
54f9ee45 9264 return _core_.SizerItem_IsSizer(*args, **kwargs)
e811c8ce
RD
9265
9266 def IsSpacer(*args, **kwargs):
248ed943
RD
9267 """
9268 IsSpacer(self) -> bool
9269
9270 Is this sizer item a spacer?
9271 """
54f9ee45 9272 return _core_.SizerItem_IsSpacer(*args, **kwargs)
e811c8ce
RD
9273
9274 def SetProportion(*args, **kwargs):
248ed943
RD
9275 """
9276 SetProportion(self, int proportion)
9277
9278 Set the proportion value for this item.
9279 """
54f9ee45 9280 return _core_.SizerItem_SetProportion(*args, **kwargs)
e811c8ce
RD
9281
9282 def GetProportion(*args, **kwargs):
248ed943
RD
9283 """
9284 GetProportion(self) -> int
9285
9286 Get the proportion value for this item.
9287 """
54f9ee45 9288 return _core_.SizerItem_GetProportion(*args, **kwargs)
e811c8ce 9289
248ed943
RD
9290 SetOption = wx._deprecated(SetProportion, "Please use `SetProportion` instead.")
9291 GetOption = wx._deprecated(GetProportion, "Please use `GetProportion` instead.")
e811c8ce 9292 def SetFlag(*args, **kwargs):
248ed943
RD
9293 """
9294 SetFlag(self, int flag)
9295
9296 Set the flag value for this item.
9297 """
54f9ee45 9298 return _core_.SizerItem_SetFlag(*args, **kwargs)
e811c8ce
RD
9299
9300 def GetFlag(*args, **kwargs):
248ed943
RD
9301 """
9302 GetFlag(self) -> int
9303
9304 Get the flag value for this item.
9305 """
54f9ee45 9306 return _core_.SizerItem_GetFlag(*args, **kwargs)
e811c8ce
RD
9307
9308 def SetBorder(*args, **kwargs):
248ed943
RD
9309 """
9310 SetBorder(self, int border)
9311
9312 Set the border value for this item.
9313 """
54f9ee45 9314 return _core_.SizerItem_SetBorder(*args, **kwargs)
e811c8ce
RD
9315
9316 def GetBorder(*args, **kwargs):
248ed943
RD
9317 """
9318 GetBorder(self) -> int
9319
9320 Get the border value for this item.
9321 """
54f9ee45 9322 return _core_.SizerItem_GetBorder(*args, **kwargs)
e811c8ce
RD
9323
9324 def GetWindow(*args, **kwargs):
248ed943
RD
9325 """
9326 GetWindow(self) -> Window
9327
9328 Get the window (if any) that is managed by this sizer item.
9329 """
54f9ee45 9330 return _core_.SizerItem_GetWindow(*args, **kwargs)
e811c8ce
RD
9331
9332 def SetWindow(*args, **kwargs):
248ed943
RD
9333 """
9334 SetWindow(self, Window window)
9335
9336 Set the window to be managed by this sizer item.
9337 """
54f9ee45 9338 return _core_.SizerItem_SetWindow(*args, **kwargs)
e811c8ce
RD
9339
9340 def GetSizer(*args, **kwargs):
248ed943
RD
9341 """
9342 GetSizer(self) -> Sizer
9343
9344 Get the subsizer (if any) that is managed by this sizer item.
9345 """
54f9ee45 9346 return _core_.SizerItem_GetSizer(*args, **kwargs)
e811c8ce
RD
9347
9348 def SetSizer(*args, **kwargs):
248ed943
RD
9349 """
9350 SetSizer(self, Sizer sizer)
9351
9352 Set the subsizer to be managed by this sizer item.
9353 """
54f9ee45 9354 return _core_.SizerItem_SetSizer(*args, **kwargs)
e811c8ce
RD
9355
9356 def GetSpacer(*args, **kwargs):
248ed943
RD
9357 """
9358 GetSpacer(self) -> Size
9359
9360 Get the size of the spacer managed by this sizer item.
9361 """
54f9ee45 9362 return _core_.SizerItem_GetSpacer(*args, **kwargs)
e811c8ce
RD
9363
9364 def SetSpacer(*args, **kwargs):
248ed943
RD
9365 """
9366 SetSpacer(self, Size size)
9367
9368 Set the size of the spacer to be managed by this sizer item.
9369 """
54f9ee45 9370 return _core_.SizerItem_SetSpacer(*args, **kwargs)
e811c8ce
RD
9371
9372 def Show(*args, **kwargs):
248ed943
RD
9373 """
9374 Show(self, bool show)
9375
9376 Set the show item attribute, which sizers use to determine if the item
9377 is to be made part of the layout or not. If the item is tracking a
9378 window then it is shown or hidden as needed.
9379 """
54f9ee45 9380 return _core_.SizerItem_Show(*args, **kwargs)
e811c8ce
RD
9381
9382 def IsShown(*args, **kwargs):
248ed943
RD
9383 """
9384 IsShown(self) -> bool
9385
9386 Is the item to be shown in the layout?
9387 """
54f9ee45 9388 return _core_.SizerItem_IsShown(*args, **kwargs)
e811c8ce
RD
9389
9390 def GetPosition(*args, **kwargs):
248ed943
RD
9391 """
9392 GetPosition(self) -> Point
9393
9394 Returns the current position of the item, as set in the last Layout.
9395 """
54f9ee45 9396 return _core_.SizerItem_GetPosition(*args, **kwargs)
e811c8ce
RD
9397
9398 def GetUserData(*args, **kwargs):
248ed943
RD
9399 """
9400 GetUserData(self) -> PyObject
9401
9402 Returns the userData associated with this sizer item, or None if there
9403 isn't any.
9404 """
54f9ee45 9405 return _core_.SizerItem_GetUserData(*args, **kwargs)
e811c8ce 9406
d14a1e28
RD
9407
9408class SizerItemPtr(SizerItem):
9409 def __init__(self, this):
9410 self.this = this
9411 if not hasattr(self,"thisown"): self.thisown = 0
9412 self.__class__ = SizerItem
54f9ee45 9413_core_.SizerItem_swigregister(SizerItemPtr)
d14a1e28 9414
248ed943 9415def SizerItemWindow(*args, **kwargs):
0df68c9f 9416 """
248ed943
RD
9417 SizerItemWindow(Window window, int proportion, int flag, int border,
9418 PyObject userData=None) -> SizerItem
9419
9420 Constructs a `wx.SizerItem` for tracking a window.
0df68c9f 9421 """
248ed943 9422 val = _core_.new_SizerItemWindow(*args, **kwargs)
d14a1e28
RD
9423 val.thisown = 1
9424 return val
9425
248ed943 9426def SizerItemSpacer(*args, **kwargs):
0df68c9f 9427 """
248ed943
RD
9428 SizerItemSpacer(int width, int height, int proportion, int flag, int border,
9429 PyObject userData=None) -> SizerItem
9430
9431 Constructs a `wx.SizerItem` for tracking a spacer.
0df68c9f 9432 """
248ed943 9433 val = _core_.new_SizerItemSpacer(*args, **kwargs)
d14a1e28
RD
9434 val.thisown = 1
9435 return val
9436
9437def SizerItemSizer(*args, **kwargs):
0df68c9f
RD
9438 """
9439 SizerItemSizer(Sizer sizer, int proportion, int flag, int border,
248ed943
RD
9440 PyObject userData=None) -> SizerItem
9441
9442 Constructs a `wx.SizerItem` for tracking a subsizer
0df68c9f 9443 """
54f9ee45 9444 val = _core_.new_SizerItemSizer(*args, **kwargs)
d14a1e28
RD
9445 val.thisown = 1
9446 return val
9447
9448class Sizer(Object):
248ed943
RD
9449 """
9450 wx.Sizer is the abstract base class used for laying out subwindows in
9451 a window. You cannot use wx.Sizer directly; instead, you will have to
9452 use one of the sizer classes derived from it such as `wx.BoxSizer`,
9453 `wx.StaticBoxSizer`, `wx.NotebookSizer`, `wx.GridSizer`, `wx.FlexGridSizer`
9454 and `wx.GridBagSizer`.
9455
9456 The concept implemented by sizers in wxWidgets is closely related to
9457 layout tools in other GUI toolkits, such as Java's AWT, the GTK
9458 toolkit or the Qt toolkit. It is based upon the idea of the individual
9459 subwindows reporting their minimal required size and their ability to
9460 get stretched if the size of the parent window has changed. This will
9461 most often mean that the programmer does not set the original size of
9462 a dialog in the beginning, rather the dialog will assigned a sizer and
9463 this sizer will be queried about the recommended size. The sizer in
9464 turn will query its children, which can be normal windows or contorls,
9465 empty space or other sizers, so that a hierarchy of sizers can be
9466 constructed. Note that wxSizer does not derive from wxWindow and thus
9467 do not interfere with tab ordering and requires very little resources
9468 compared to a real window on screen.
9469
9470 What makes sizers so well fitted for use in wxWidgets is the fact that
9471 every control reports its own minimal size and the algorithm can
9472 handle differences in font sizes or different window (dialog item)
9473 sizes on different platforms without problems. If for example the
9474 standard font as well as the overall design of Mac widgets requires
9475 more space than on Windows, then the initial size of a dialog using a
9476 sizer will automatically be bigger on Mac than on Windows.
9477 """
e811c8ce
RD
9478 def __init__(self): raise RuntimeError, "No constructor defined"
9479 def __repr__(self):
9480 return "<%s.%s; proxy of C++ wxSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
9481 def _setOORInfo(*args, **kwargs):
a95a7133 9482 """_setOORInfo(self, PyObject _self)"""
54f9ee45 9483 return _core_.Sizer__setOORInfo(*args, **kwargs)
e811c8ce
RD
9484
9485 def Add(*args, **kwargs):
0df68c9f 9486 """
248ed943 9487 Add(self, item, int proportion=0, int flag=0, int border=0,
d3b6e4ff 9488 PyObject userData=None) -> wx.SizerItem
248ed943
RD
9489
9490 Appends a child item to the sizer.
0df68c9f 9491 """
54f9ee45 9492 return _core_.Sizer_Add(*args, **kwargs)
e811c8ce
RD
9493
9494 def Insert(*args, **kwargs):
0df68c9f 9495 """
248ed943 9496 Insert(self, int before, item, int proportion=0, int flag=0, int border=0,
d3b6e4ff 9497 PyObject userData=None) -> wx.SizerItem
248ed943
RD
9498
9499 Inserts a new item into the list of items managed by this sizer before
9500 the item at index *before*. See `Add` for a description of the parameters.
0df68c9f 9501 """
54f9ee45 9502 return _core_.Sizer_Insert(*args, **kwargs)
e811c8ce
RD
9503
9504 def Prepend(*args, **kwargs):
0df68c9f 9505 """
248ed943 9506 Prepend(self, item, int proportion=0, int flag=0, int border=0,
d3b6e4ff 9507 PyObject userData=None) -> wx.SizerItem
248ed943
RD
9508
9509 Adds a new item to the begining of the list of sizer items managed by
9510 this sizer. See `Add` for a description of the parameters.
0df68c9f 9511 """
54f9ee45 9512 return _core_.Sizer_Prepend(*args, **kwargs)
e811c8ce
RD
9513
9514 def Remove(*args, **kwargs):
248ed943
RD
9515 """
9516 Remove(self, item) -> bool
9517
9518 Removes an item from the sizer and destroys it. This method does not
9519 cause any layout or resizing to take place, call `Layout` to update
9520 the layout on screen after removing a child from the sizer. The
9521 *item* parameter can be either a window, a sizer, or the zero-based
9522 index of an item to remove. Returns True if the child item was found
9523 and removed.
9524 """
54f9ee45 9525 return _core_.Sizer_Remove(*args, **kwargs)
e811c8ce 9526
1c0f361b 9527 def Detach(*args, **kwargs):
248ed943
RD
9528 """
9529 Detach(self, item) -> bool
9530
9531 Detaches an item from the sizer without destroying it. This method
9532 does not cause any layout or resizing to take place, call `Layout` to
9533 do so. The *item* parameter can be either a window, a sizer, or the
9534 zero-based index of the item to be detached. Returns True if the child item
9535 was found and detached.
9536 """
1c0f361b
RD
9537 return _core_.Sizer_Detach(*args, **kwargs)
9538
d3b6e4ff
RD
9539 def GetItem(*args, **kwargs):
9540 """
9541 GetItem(self, item) -> wx.SizerItem
9542
9543 Returns the `wx.SizerItem` which holds the *item* given. The *item*
9544 parameter can be either a window, a sizer, or the zero-based index of
9545 the item to be detached.
9546 """
9547 return _core_.Sizer_GetItem(*args, **kwargs)
9548
e811c8ce 9549 def _SetItemMinSize(*args, **kwargs):
a95a7133 9550 """_SetItemMinSize(self, PyObject item, Size size)"""
54f9ee45 9551 return _core_.Sizer__SetItemMinSize(*args, **kwargs)
e811c8ce 9552
248ed943
RD
9553 def SetItemMinSize(self, item, *args):
9554 """
9555 SetItemMinSize(self, item, Size size)
9556
9557 Sets the minimum size that will be allocated for an item in the sizer.
9558 The *item* parameter can be either a window, a sizer, or the
9559 zero-based index of the item. If a window or sizer is given then it
9560 will be searched for recursivly in subsizers if neccessary.
9561 """
9562 if len(args) == 2:
9563 # for backward compatibility accept separate width,height args too
9564 return self._SetItemMinSize(item, args)
9565 else:
9566 return self._SetItemMinSize(item, args[0])
9567
e811c8ce 9568 def AddItem(*args, **kwargs):
248ed943
RD
9569 """
9570 AddItem(self, SizerItem item)
9571
9572 Adds a `wx.SizerItem` to the sizer.
9573 """
54f9ee45 9574 return _core_.Sizer_AddItem(*args, **kwargs)
e811c8ce
RD
9575
9576 def InsertItem(*args, **kwargs):
248ed943
RD
9577 """
9578 InsertItem(self, int index, SizerItem item)
9579
9580 Inserts a `wx.SizerItem` to the sizer at the position given by *index*.
9581 """
54f9ee45 9582 return _core_.Sizer_InsertItem(*args, **kwargs)
e811c8ce
RD
9583
9584 def PrependItem(*args, **kwargs):
248ed943
RD
9585 """
9586 PrependItem(self, SizerItem item)
9587
9588 Prepends a `wx.SizerItem` to the sizer.
9589 """
54f9ee45 9590 return _core_.Sizer_PrependItem(*args, **kwargs)
e811c8ce 9591
248ed943 9592 def AddMany(self, items):
66c033b4
RD
9593 """
9594 AddMany is a convenience method for adding several items
9595 to a sizer at one time. Simply pass it a list of tuples,
9596 where each tuple consists of the parameters that you
9597 would normally pass to the `Add` method.
9598 """
248ed943
RD
9599 for item in items:
9600 if type(item) != type(()) or (len(item) == 2 and type(item[0]) == type(1)):
9601 item = (item, )
9602 self.Add(*item)
d14a1e28 9603
74e96f3d 9604 # for backwards compatibility only, please do not use in new code
66c033b4
RD
9605 AddWindow = wx._deprecated(Add, "AddWindow is deprecated, use `Add` instead.")
9606 AddSizer = wx._deprecated(Add, "AddSizer is deprecated, use `Add` instead.")
9607 AddSpacer = wx._deprecated(Add, "AddSpacer is deprecated, use `Add` instead.")
9608 PrependWindow = wx._deprecated(Prepend, "PrependWindow is deprecated, use `Prepend` instead.")
9609 PrependSizer = wx._deprecated(Prepend, "PrependSizer is deprecated, use `Prepend` instead.")
9610 PrependSpacer = wx._deprecated(Prepend, "PrependSpacer is deprecated, use `Prepend` instead.")
9611 InsertWindow = wx._deprecated(Insert, "InsertWindow is deprecated, use `Insert` instead.")
9612 InsertSizer = wx._deprecated(Insert, "InsertSizer is deprecated, use `Insert` instead.")
9613 InsertSpacer = wx._deprecated(Insert, "InsertSpacer is deprecated, use `Insert` instead.")
9614 RemoveWindow = wx._deprecated(Remove, "RemoveWindow is deprecated, use `Remove` instead.")
9615 RemoveSizer = wx._deprecated(Remove, "RemoveSizer is deprecated, use `Remove` instead.")
9616 RemovePos = wx._deprecated(Remove, "RemovePos is deprecated, use `Remove` instead.")
d14a1e28
RD
9617
9618
e811c8ce 9619 def SetDimension(*args, **kwargs):
248ed943
RD
9620 """
9621 SetDimension(self, int x, int y, int width, int height)
9622
9623 Call this to force the sizer to take the given dimension and thus
9624 force the items owned by the sizer to resize themselves according to
9625 the rules defined by the parameter in the `Add`, `Insert` or `Prepend`
9626 methods.
9627 """
54f9ee45 9628 return _core_.Sizer_SetDimension(*args, **kwargs)
e811c8ce
RD
9629
9630 def SetMinSize(*args, **kwargs):
248ed943
RD
9631 """
9632 SetMinSize(self, Size size)
9633
9634 Call this to give the sizer a minimal size. Normally, the sizer will
9635 calculate its minimal size based purely on how much space its children
9636 need. After calling this method `GetMinSize` will return either the
9637 minimal size as requested by its children or the minimal size set
9638 here, depending on which is bigger.
9639 """
54f9ee45 9640 return _core_.Sizer_SetMinSize(*args, **kwargs)
e811c8ce
RD
9641
9642 def GetSize(*args, **kwargs):
248ed943
RD
9643 """
9644 GetSize(self) -> Size
9645
9646 Returns the current size of the space managed by the sizer.
9647 """
54f9ee45 9648 return _core_.Sizer_GetSize(*args, **kwargs)
e811c8ce
RD
9649
9650 def GetPosition(*args, **kwargs):
248ed943
RD
9651 """
9652 GetPosition(self) -> Point
9653
9654 Returns the current position of the sizer's managed space.
9655 """
54f9ee45 9656 return _core_.Sizer_GetPosition(*args, **kwargs)
e811c8ce
RD
9657
9658 def GetMinSize(*args, **kwargs):
248ed943
RD
9659 """
9660 GetMinSize(self) -> Size
9661
9662 Returns the minimal size of the sizer. This is either the combined
9663 minimal size of all the children and their borders or the minimal size
9664 set by SetMinSize, depending on which is bigger.
9665 """
54f9ee45 9666 return _core_.Sizer_GetMinSize(*args, **kwargs)
e811c8ce 9667
d14a1e28 9668 def GetSizeTuple(self):
1c0f361b 9669 return self.GetSize().Get()
d14a1e28 9670 def GetPositionTuple(self):
1c0f361b 9671 return self.GetPosition().Get()
d14a1e28 9672 def GetMinSizeTuple(self):
1c0f361b 9673 return self.GetMinSize().Get()
d14a1e28 9674
e811c8ce 9675 def RecalcSizes(*args, **kwargs):
248ed943
RD
9676 """
9677 RecalcSizes(self)
9678
9679 Using the sizes calculated by `CalcMin` reposition and resize all the
9680 items managed by this sizer. You should not need to call this directly as
9681 it is called by `Layout`.
9682 """
54f9ee45 9683 return _core_.Sizer_RecalcSizes(*args, **kwargs)
e811c8ce
RD
9684
9685 def CalcMin(*args, **kwargs):
248ed943
RD
9686 """
9687 CalcMin(self) -> Size
9688
9689 This method is where the sizer will do the actual calculation of its
9690 children's minimal sizes. You should not need to call this directly as
9691 it is called by `Layout`.
9692 """
54f9ee45 9693 return _core_.Sizer_CalcMin(*args, **kwargs)
e811c8ce
RD
9694
9695 def Layout(*args, **kwargs):
248ed943
RD
9696 """
9697 Layout(self)
9698
9699 This method will force the recalculation and layout of the items
9700 controlled by the sizer using the current space allocated to the
9701 sizer. Normally this is called automatically from the owning window's
9702 EVT_SIZE handler, but it is also useful to call it from user code when
9703 one of the items in a sizer change size, or items are added or
9704 removed.
9705 """
54f9ee45 9706 return _core_.Sizer_Layout(*args, **kwargs)
e811c8ce
RD
9707
9708 def Fit(*args, **kwargs):
248ed943
RD
9709 """
9710 Fit(self, Window window) -> Size
9711
9712 Tell the sizer to resize the *window* to match the sizer's minimal
9713 size. This is commonly done in the constructor of the window itself in
9714 order to set its initial size to match the needs of the children as
9715 determined by the sizer. Returns the new size.
9716
9717 For a top level window this is the total window size, not the client size.
9718 """
54f9ee45 9719 return _core_.Sizer_Fit(*args, **kwargs)
e811c8ce
RD
9720
9721 def FitInside(*args, **kwargs):
248ed943
RD
9722 """
9723 FitInside(self, Window window)
9724
9725 Tell the sizer to resize the *virtual size* of the *window* to match the
9726 sizer's minimal size. This will not alter the on screen size of the
9727 window, but may cause the addition/removal/alteration of scrollbars
9728 required to view the virtual area in windows which manage it.
9729
9730 :see: `wx.ScrolledWindow.SetScrollbars`, `SetVirtualSizeHints`
9731
9732 """
54f9ee45 9733 return _core_.Sizer_FitInside(*args, **kwargs)
e811c8ce
RD
9734
9735 def SetSizeHints(*args, **kwargs):
248ed943
RD
9736 """
9737 SetSizeHints(self, Window window)
9738
9739 Tell the sizer to set (and `Fit`) the minimal size of the *window* to
9740 match the sizer's minimal size. This is commonly done in the
9741 constructor of the window itself if the window is resizable (as are
9742 many dialogs under Unix and frames on probably all platforms) in order
9743 to prevent the window from being sized smaller than the minimal size
9744 required by the sizer.
9745 """
54f9ee45 9746 return _core_.Sizer_SetSizeHints(*args, **kwargs)
e811c8ce
RD
9747
9748 def SetVirtualSizeHints(*args, **kwargs):
248ed943
RD
9749 """
9750 SetVirtualSizeHints(self, Window window)
9751
9752 Tell the sizer to set the minimal size of the window virtual area to
9753 match the sizer's minimal size. For windows with managed scrollbars
9754 this will set them appropriately.
9755
9756 :see: `wx.ScrolledWindow.SetScrollbars`
9757
9758 """
54f9ee45 9759 return _core_.Sizer_SetVirtualSizeHints(*args, **kwargs)
e811c8ce
RD
9760
9761 def Clear(*args, **kwargs):
248ed943
RD
9762 """
9763 Clear(self, bool deleteWindows=False)
9764
9765 Clear all items from the sizer, optionally destroying the window items
9766 as well.
9767 """
54f9ee45 9768 return _core_.Sizer_Clear(*args, **kwargs)
e811c8ce
RD
9769
9770 def DeleteWindows(*args, **kwargs):
248ed943
RD
9771 """
9772 DeleteWindows(self)
9773
9774 Destroy all windows managed by the sizer.
9775 """
54f9ee45 9776 return _core_.Sizer_DeleteWindows(*args, **kwargs)
e811c8ce
RD
9777
9778 def GetChildren(*args, **kwargs):
248ed943 9779 """
51b83b37 9780 GetChildren(self) -> list
248ed943
RD
9781
9782 Returns a list of all the `wx.SizerItem` objects managed by the sizer.
9783 """
54f9ee45 9784 return _core_.Sizer_GetChildren(*args, **kwargs)
e811c8ce
RD
9785
9786 def Show(*args, **kwargs):
248ed943 9787 """
ae8162c8 9788 Show(self, item, bool show=True, bool recursive=false) -> bool
e811c8ce 9789
248ed943
RD
9790 Shows or hides an item managed by the sizer. To make a sizer item
9791 disappear or reappear, use Show followed by `Layout`. The *item*
9792 parameter can be either a window, a sizer, or the zero-based index of
7e63a440
RD
9793 the item. Use the recursive parameter to show or hide an item in a
9794 subsizer. Returns True if the item was found.
248ed943
RD
9795 """
9796 return _core_.Sizer_Show(*args, **kwargs)
e811c8ce
RD
9797
9798 def IsShown(*args, **kwargs):
248ed943
RD
9799 """
9800 IsShown(self, item)
9801
9802 Determines if the item is currently shown. sizer. To make a sizer
9803 item disappear or reappear, use Show followed by `Layout`. The *item*
9804 parameter can be either a window, a sizer, or the zero-based index of
9805 the item.
9806 """
54f9ee45 9807 return _core_.Sizer_IsShown(*args, **kwargs)
e811c8ce 9808
7e63a440 9809 def Hide(self, item, recursive=False):
248ed943 9810 """
7e63a440 9811 A convenience method for Show(item, False, recursive).
248ed943 9812 """
06759a38 9813 return self.Show(item, False, recursive)
248ed943 9814
e811c8ce 9815 def ShowItems(*args, **kwargs):
248ed943
RD
9816 """
9817 ShowItems(self, bool show)
9818
84f85550 9819 Recursively call `wx.SizerItem.Show` on all sizer items.
248ed943 9820 """
54f9ee45 9821 return _core_.Sizer_ShowItems(*args, **kwargs)
e811c8ce 9822
d14a1e28
RD
9823
9824class SizerPtr(Sizer):
9825 def __init__(self, this):
9826 self.this = this
9827 if not hasattr(self,"thisown"): self.thisown = 0
9828 self.__class__ = Sizer
54f9ee45 9829_core_.Sizer_swigregister(SizerPtr)
d14a1e28
RD
9830
9831class PySizer(Sizer):
248ed943
RD
9832 """
9833 wx.PySizer is a special version of `wx.Sizer` that has been
9834 instrumented to allow the C++ virtual methods to be overloaded in
9835 Python derived classes. You would derive from this class if you are
9836 wanting to implement a custom sizer in Python code. Simply implement
9837 `CalcMin` and `RecalcSizes` in the derived class and you're all set.
9838 For example::
9839
9840 class MySizer(wx.PySizer):
9841 def __init__(self):
9842 wx.PySizer.__init__(self)
9843
9844 def CalcMin(self):
9845 for item in self.GetChildren():
9846 # calculate the total minimum width and height needed
9847 # by all items in the sizer according to this sizer's
9848 # layout algorithm.
9849 ...
9850 return wx.Size(width, height)
9851
9852 def RecalcSizes(self):
9853 # find the space allotted to this sizer
9854 pos = self.GetPosition()
9855 size = self.GetSize()
9856 for item in self.GetChildren():
9857 # Recalculate (if necessary) the position and size of
9858 # each item and then call item.SetDimension to do the
9859 # actual positioning and sizing of the items within the
9860 # space alloted to this sizer.
9861 ...
9862 item.SetDimension(itemPos, itemSize)
9863
9864
9865 When `Layout` is called it first calls `CalcMin` followed by
9866 `RecalcSizes` so you can optimize a bit by saving the results of
e505d15e 9867 `CalcMin` and reusing them in `RecalcSizes`.
248ed943
RD
9868
9869 :see: `wx.SizerItem`, `wx.Sizer.GetChildren`
9870
9871
9872 """
e811c8ce
RD
9873 def __repr__(self):
9874 return "<%s.%s; proxy of C++ wxPySizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 9875 def __init__(self, *args, **kwargs):
248ed943
RD
9876 """
9877 __init__(self) -> PySizer
9878
9879 Creates a wx.PySizer. Must be called from the __init__ in the derived
9880 class.
9881 """
54f9ee45 9882 newobj = _core_.new_PySizer(*args, **kwargs)
d14a1e28
RD
9883 self.this = newobj.this
9884 self.thisown = 1
9885 del newobj.thisown
9886 self._setCallbackInfo(self, PySizer);self._setOORInfo(self)
e811c8ce
RD
9887
9888 def _setCallbackInfo(*args, **kwargs):
a95a7133 9889 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
54f9ee45 9890 return _core_.PySizer__setCallbackInfo(*args, **kwargs)
e811c8ce 9891
d14a1e28
RD
9892
9893class PySizerPtr(PySizer):
9894 def __init__(self, this):
9895 self.this = this
9896 if not hasattr(self,"thisown"): self.thisown = 0
9897 self.__class__ = PySizer
54f9ee45 9898_core_.PySizer_swigregister(PySizerPtr)
d14a1e28
RD
9899
9900#---------------------------------------------------------------------------
9901
9902class BoxSizer(Sizer):
248ed943
RD
9903 """
9904 The basic idea behind a box sizer is that windows will most often be
9905 laid out in rather simple basic geometry, typically in a row or a
9906 column or nested hierarchies of either. A wx.BoxSizer will lay out
9907 its items in a simple row or column, depending on the orientation
9908 parameter passed to the constructor.
9909 """
e811c8ce
RD
9910 def __repr__(self):
9911 return "<%s.%s; proxy of C++ wxBoxSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 9912 def __init__(self, *args, **kwargs):
248ed943
RD
9913 """
9914 __init__(self, int orient=HORIZONTAL) -> BoxSizer
9915
9916 Constructor for a wx.BoxSizer. *orient* may be one of ``wx.VERTICAL``
9917 or ``wx.HORIZONTAL`` for creating either a column sizer or a row
9918 sizer.
9919 """
54f9ee45 9920 newobj = _core_.new_BoxSizer(*args, **kwargs)
d14a1e28
RD
9921 self.this = newobj.this
9922 self.thisown = 1
9923 del newobj.thisown
9924 self._setOORInfo(self)
e811c8ce
RD
9925
9926 def GetOrientation(*args, **kwargs):
248ed943
RD
9927 """
9928 GetOrientation(self) -> int
9929
9930 Returns the current orientation of the sizer.
9931 """
54f9ee45 9932 return _core_.BoxSizer_GetOrientation(*args, **kwargs)
e811c8ce
RD
9933
9934 def SetOrientation(*args, **kwargs):
248ed943
RD
9935 """
9936 SetOrientation(self, int orient)
e811c8ce 9937
248ed943
RD
9938 Resets the orientation of the sizer.
9939 """
9940 return _core_.BoxSizer_SetOrientation(*args, **kwargs)
e811c8ce 9941
d14a1e28
RD
9942
9943class BoxSizerPtr(BoxSizer):
9944 def __init__(self, this):
9945 self.this = this
9946 if not hasattr(self,"thisown"): self.thisown = 0
9947 self.__class__ = BoxSizer
54f9ee45 9948_core_.BoxSizer_swigregister(BoxSizerPtr)
d14a1e28
RD
9949
9950#---------------------------------------------------------------------------
9951
9952class StaticBoxSizer(BoxSizer):
248ed943
RD
9953 """
9954 wx.StaticBoxSizer derives from and functions identically to the
9955 `wx.BoxSizer` and adds a `wx.StaticBox` around the items that the sizer
9956 manages. Note that this static box must be created separately and
9957 passed to the sizer constructor.
9958 """
e811c8ce
RD
9959 def __repr__(self):
9960 return "<%s.%s; proxy of C++ wxStaticBoxSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 9961 def __init__(self, *args, **kwargs):
248ed943
RD
9962 """
9963 __init__(self, StaticBox box, int orient=HORIZONTAL) -> StaticBoxSizer
9964
9965 Constructor. It takes an associated static box and the orientation
9966 *orient* as parameters - orient can be either of ``wx.VERTICAL`` or
9967 ``wx.HORIZONTAL``.
9968 """
54f9ee45 9969 newobj = _core_.new_StaticBoxSizer(*args, **kwargs)
d14a1e28
RD
9970 self.this = newobj.this
9971 self.thisown = 1
9972 del newobj.thisown
9973 self._setOORInfo(self)
e811c8ce
RD
9974
9975 def GetStaticBox(*args, **kwargs):
248ed943
RD
9976 """
9977 GetStaticBox(self) -> StaticBox
e811c8ce 9978
248ed943
RD
9979 Returns the static box associated with this sizer.
9980 """
9981 return _core_.StaticBoxSizer_GetStaticBox(*args, **kwargs)
e811c8ce 9982
d14a1e28
RD
9983
9984class StaticBoxSizerPtr(StaticBoxSizer):
9985 def __init__(self, this):
9986 self.this = this
9987 if not hasattr(self,"thisown"): self.thisown = 0
9988 self.__class__ = StaticBoxSizer
54f9ee45 9989_core_.StaticBoxSizer_swigregister(StaticBoxSizerPtr)
d14a1e28
RD
9990
9991#---------------------------------------------------------------------------
9992
9993class GridSizer(Sizer):
248ed943
RD
9994 """
9995 A grid sizer is a sizer which lays out its children in a
9996 two-dimensional table with all cells having the same size. In other
9997 words, the width of each cell within the grid is the width of the
9998 widest item added to the sizer and the height of each grid cell is the
9999 height of the tallest item. An optional vertical and/or horizontal
10000 gap between items can also be specified (in pixels.)
10001
10002 Items are placed in the cells of the grid in the order they are added,
10003 in row-major order. In other words, the first row is filled first,
10004 then the second, and so on until all items have been added. (If
10005 neccessary, additional rows will be added as items are added.) If you
10006 need to have greater control over the cells that items are placed in
10007 then use the `wx.GridBagSizer`.
10008
10009 """
e811c8ce
RD
10010 def __repr__(self):
10011 return "<%s.%s; proxy of C++ wxGridSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 10012 def __init__(self, *args, **kwargs):
248ed943
RD
10013 """
10014 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> GridSizer
10015
10016 Constructor for a wx.GridSizer. *rows* and *cols* determine the number
10017 of columns and rows in the sizer - if either of the parameters is
10018 zero, it will be calculated to from the total number of children in
10019 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
10020 define extra space between all children.
10021 """
54f9ee45 10022 newobj = _core_.new_GridSizer(*args, **kwargs)
d14a1e28
RD
10023 self.this = newobj.this
10024 self.thisown = 1
10025 del newobj.thisown
10026 self._setOORInfo(self)
e811c8ce 10027
e811c8ce 10028 def SetCols(*args, **kwargs):
248ed943
RD
10029 """
10030 SetCols(self, int cols)
10031
10032 Sets the number of columns in the sizer.
10033 """
54f9ee45 10034 return _core_.GridSizer_SetCols(*args, **kwargs)
e811c8ce
RD
10035
10036 def SetRows(*args, **kwargs):
248ed943
RD
10037 """
10038 SetRows(self, int rows)
10039
10040 Sets the number of rows in the sizer.
10041 """
54f9ee45 10042 return _core_.GridSizer_SetRows(*args, **kwargs)
e811c8ce
RD
10043
10044 def SetVGap(*args, **kwargs):
248ed943
RD
10045 """
10046 SetVGap(self, int gap)
10047
10048 Sets the vertical gap (in pixels) between the cells in the sizer.
10049 """
54f9ee45 10050 return _core_.GridSizer_SetVGap(*args, **kwargs)
e811c8ce
RD
10051
10052 def SetHGap(*args, **kwargs):
248ed943
RD
10053 """
10054 SetHGap(self, int gap)
10055
10056 Sets the horizontal gap (in pixels) between cells in the sizer
10057 """
54f9ee45 10058 return _core_.GridSizer_SetHGap(*args, **kwargs)
e811c8ce
RD
10059
10060 def GetCols(*args, **kwargs):
248ed943
RD
10061 """
10062 GetCols(self) -> int
10063
10064 Returns the number of columns in the sizer.
10065 """
54f9ee45 10066 return _core_.GridSizer_GetCols(*args, **kwargs)
e811c8ce
RD
10067
10068 def GetRows(*args, **kwargs):
248ed943
RD
10069 """
10070 GetRows(self) -> int
10071
10072 Returns the number of rows in the sizer.
10073 """
54f9ee45 10074 return _core_.GridSizer_GetRows(*args, **kwargs)
e811c8ce
RD
10075
10076 def GetVGap(*args, **kwargs):
248ed943
RD
10077 """
10078 GetVGap(self) -> int
10079
10080 Returns the vertical gap (in pixels) between the cells in the sizer.
10081 """
54f9ee45 10082 return _core_.GridSizer_GetVGap(*args, **kwargs)
e811c8ce
RD
10083
10084 def GetHGap(*args, **kwargs):
248ed943
RD
10085 """
10086 GetHGap(self) -> int
10087
10088 Returns the horizontal gap (in pixels) between cells in the sizer.
10089 """
54f9ee45 10090 return _core_.GridSizer_GetHGap(*args, **kwargs)
e811c8ce 10091
d14a1e28
RD
10092
10093class GridSizerPtr(GridSizer):
10094 def __init__(self, this):
10095 self.this = this
10096 if not hasattr(self,"thisown"): self.thisown = 0
10097 self.__class__ = GridSizer
54f9ee45 10098_core_.GridSizer_swigregister(GridSizerPtr)
d14a1e28
RD
10099
10100#---------------------------------------------------------------------------
10101
54f9ee45
RD
10102FLEX_GROWMODE_NONE = _core_.FLEX_GROWMODE_NONE
10103FLEX_GROWMODE_SPECIFIED = _core_.FLEX_GROWMODE_SPECIFIED
10104FLEX_GROWMODE_ALL = _core_.FLEX_GROWMODE_ALL
d14a1e28 10105class FlexGridSizer(GridSizer):
248ed943
RD
10106 """
10107 A flex grid sizer is a sizer which lays out its children in a
10108 two-dimensional table with all table cells in one row having the same
10109 height and all cells in one column having the same width, but all
10110 rows or all columns are not necessarily the same height or width as in
10111 the `wx.GridSizer`.
10112
10113 wx.FlexGridSizer can also size items equally in one direction but
10114 unequally ("flexibly") in the other. If the sizer is only flexible
10115 in one direction (this can be changed using `SetFlexibleDirection`), it
10116 needs to be decided how the sizer should grow in the other ("non
10117 flexible") direction in order to fill the available space. The
10118 `SetNonFlexibleGrowMode` method serves this purpose.
10119
10120
10121 """
e811c8ce
RD
10122 def __repr__(self):
10123 return "<%s.%s; proxy of C++ wxFlexGridSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 10124 def __init__(self, *args, **kwargs):
248ed943
RD
10125 """
10126 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> FlexGridSizer
10127
10128 Constructor for a wx.FlexGridSizer. *rows* and *cols* determine the
10129 number of columns and rows in the sizer - if either of the parameters
10130 is zero, it will be calculated to from the total number of children in
10131 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
10132 define extra space between all children.
10133 """
54f9ee45 10134 newobj = _core_.new_FlexGridSizer(*args, **kwargs)
d14a1e28
RD
10135 self.this = newobj.this
10136 self.thisown = 1
10137 del newobj.thisown
10138 self._setOORInfo(self)
e811c8ce 10139
248ed943
RD
10140 def AddGrowableRow(*args, **kwargs):
10141 """
10142 AddGrowableRow(self, size_t idx, int proportion=0)
e811c8ce 10143
248ed943
RD
10144 Specifies that row *idx* (starting from zero) should be grown if there
10145 is extra space available to the sizer.
e811c8ce 10146
248ed943
RD
10147 The *proportion* parameter has the same meaning as the stretch factor
10148 for the box sizers except that if all proportions are 0, then all
10149 columns are resized equally (instead of not being resized at all).
10150 """
54f9ee45 10151 return _core_.FlexGridSizer_AddGrowableRow(*args, **kwargs)
e811c8ce
RD
10152
10153 def RemoveGrowableRow(*args, **kwargs):
248ed943
RD
10154 """
10155 RemoveGrowableRow(self, size_t idx)
10156
10157 Specifies that row *idx* is no longer growable.
10158 """
54f9ee45 10159 return _core_.FlexGridSizer_RemoveGrowableRow(*args, **kwargs)
e811c8ce
RD
10160
10161 def AddGrowableCol(*args, **kwargs):
248ed943
RD
10162 """
10163 AddGrowableCol(self, size_t idx, int proportion=0)
10164
10165 Specifies that column *idx* (starting from zero) should be grown if
10166 there is extra space available to the sizer.
10167
10168 The *proportion* parameter has the same meaning as the stretch factor
10169 for the box sizers except that if all proportions are 0, then all
10170 columns are resized equally (instead of not being resized at all).
10171 """
54f9ee45 10172 return _core_.FlexGridSizer_AddGrowableCol(*args, **kwargs)
e811c8ce
RD
10173
10174 def RemoveGrowableCol(*args, **kwargs):
248ed943
RD
10175 """
10176 RemoveGrowableCol(self, size_t idx)
10177
10178 Specifies that column *idx* is no longer growable.
10179 """
54f9ee45 10180 return _core_.FlexGridSizer_RemoveGrowableCol(*args, **kwargs)
e811c8ce
RD
10181
10182 def SetFlexibleDirection(*args, **kwargs):
248ed943
RD
10183 """
10184 SetFlexibleDirection(self, int direction)
10185
10186 Specifies whether the sizer should flexibly resize its columns, rows,
10187 or both. Argument *direction* can be one of the following values. Any
10188 other value is ignored.
10189
10190 ============== =======================================
10191 wx.VERTICAL Rows are flexibly sized.
10192 wx.HORIZONTAL Columns are flexibly sized.
10193 wx.BOTH Both rows and columns are flexibly sized
10194 (this is the default value).
10195 ============== =======================================
10196
10197 Note that this method does not trigger relayout.
10198
10199 """
54f9ee45 10200 return _core_.FlexGridSizer_SetFlexibleDirection(*args, **kwargs)
e811c8ce
RD
10201
10202 def GetFlexibleDirection(*args, **kwargs):
248ed943
RD
10203 """
10204 GetFlexibleDirection(self) -> int
10205
10206 Returns a value that specifies whether the sizer
10207 flexibly resizes its columns, rows, or both (default).
10208
10209 :see: `SetFlexibleDirection`
10210 """
54f9ee45 10211 return _core_.FlexGridSizer_GetFlexibleDirection(*args, **kwargs)
e811c8ce
RD
10212
10213 def SetNonFlexibleGrowMode(*args, **kwargs):
248ed943
RD
10214 """
10215 SetNonFlexibleGrowMode(self, int mode)
10216
10217 Specifies how the sizer should grow in the non-flexible direction if
10218 there is one (so `SetFlexibleDirection` must have been called
10219 previously). Argument *mode* can be one of the following values:
10220
10221 ========================== =================================================
10222 wx.FLEX_GROWMODE_NONE Sizer doesn't grow in the non flexible direction.
10223 wx.FLEX_GROWMODE_SPECIFIED Sizer honors growable columns/rows set with
10224 `AddGrowableCol` and `AddGrowableRow`. In this
10225 case equal sizing applies to minimum sizes of
10226 columns or rows (this is the default value).
10227 wx.FLEX_GROWMODE_ALL Sizer equally stretches all columns or rows in
10228 the non flexible direction, whether they are
10229 growable or not in the flexbile direction.
10230 ========================== =================================================
10231
10232 Note that this method does not trigger relayout.
10233
10234
10235 """
54f9ee45 10236 return _core_.FlexGridSizer_SetNonFlexibleGrowMode(*args, **kwargs)
e811c8ce
RD
10237
10238 def GetNonFlexibleGrowMode(*args, **kwargs):
248ed943
RD
10239 """
10240 GetNonFlexibleGrowMode(self) -> int
10241
10242 Returns the value that specifies how the sizer grows in the
10243 non-flexible direction if there is one.
10244
10245 :see: `SetNonFlexibleGrowMode`
10246 """
54f9ee45 10247 return _core_.FlexGridSizer_GetNonFlexibleGrowMode(*args, **kwargs)
e811c8ce
RD
10248
10249 def GetRowHeights(*args, **kwargs):
fd2dc343
RD
10250 """
10251 GetRowHeights(self) -> list
10252
10253 Returns a list of integers representing the heights of each of the
10254 rows in the sizer.
10255 """
54f9ee45 10256 return _core_.FlexGridSizer_GetRowHeights(*args, **kwargs)
e811c8ce
RD
10257
10258 def GetColWidths(*args, **kwargs):
fd2dc343
RD
10259 """
10260 GetColWidths(self) -> list
10261
10262 Returns a list of integers representing the widths of each of the
10263 columns in the sizer.
10264 """
54f9ee45 10265 return _core_.FlexGridSizer_GetColWidths(*args, **kwargs)
e811c8ce 10266
d14a1e28
RD
10267
10268class FlexGridSizerPtr(FlexGridSizer):
10269 def __init__(self, this):
10270 self.this = this
10271 if not hasattr(self,"thisown"): self.thisown = 0
10272 self.__class__ = FlexGridSizer
54f9ee45 10273_core_.FlexGridSizer_swigregister(FlexGridSizerPtr)
d14a1e28 10274
e505d15e
RD
10275class StdDialogButtonSizer(BoxSizer):
10276 """
10277 A special sizer that knows how to order and position standard buttons
10278 in order to conform to the current platform's standards. You simply
10279 need to add each `wx.Button` to the sizer, and be sure to create the
53aa7709 10280 buttons using the standard ID's. Then call `Realize` and the sizer
e505d15e
RD
10281 will take care of the rest.
10282
10283 """
10284 def __repr__(self):
10285 return "<%s.%s; proxy of C++ wxStdDialogButtonSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
10286 def __init__(self, *args, **kwargs):
10287 """__init__(self) -> StdDialogButtonSizer"""
10288 newobj = _core_.new_StdDialogButtonSizer(*args, **kwargs)
10289 self.this = newobj.this
10290 self.thisown = 1
10291 del newobj.thisown
10292 def AddButton(*args, **kwargs):
10293 """
10294 AddButton(self, wxButton button)
10295
10296 Use this to add the buttons to this sizer. Do not use the `Add`
10297 method in the base class.
10298 """
10299 return _core_.StdDialogButtonSizer_AddButton(*args, **kwargs)
10300
53aa7709 10301 def Realize(*args, **kwargs):
e505d15e 10302 """
53aa7709 10303 Realize(self)
e505d15e
RD
10304
10305 This funciton needs to be called after all the buttons have been added
10306 to the sizer. It will reorder them and position them in a platform
10307 specifc manner.
10308 """
53aa7709 10309 return _core_.StdDialogButtonSizer_Realize(*args, **kwargs)
51b83b37
RD
10310
10311 def SetAffirmativeButton(*args, **kwargs):
10312 """SetAffirmativeButton(self, wxButton button)"""
10313 return _core_.StdDialogButtonSizer_SetAffirmativeButton(*args, **kwargs)
10314
10315 def SetNegativeButton(*args, **kwargs):
10316 """SetNegativeButton(self, wxButton button)"""
10317 return _core_.StdDialogButtonSizer_SetNegativeButton(*args, **kwargs)
10318
10319 def SetCancelButton(*args, **kwargs):
10320 """SetCancelButton(self, wxButton button)"""
10321 return _core_.StdDialogButtonSizer_SetCancelButton(*args, **kwargs)
e505d15e
RD
10322
10323 def GetAffirmativeButton(*args, **kwargs):
10324 """GetAffirmativeButton(self) -> wxButton"""
10325 return _core_.StdDialogButtonSizer_GetAffirmativeButton(*args, **kwargs)
10326
10327 def GetApplyButton(*args, **kwargs):
10328 """GetApplyButton(self) -> wxButton"""
10329 return _core_.StdDialogButtonSizer_GetApplyButton(*args, **kwargs)
10330
10331 def GetNegativeButton(*args, **kwargs):
10332 """GetNegativeButton(self) -> wxButton"""
10333 return _core_.StdDialogButtonSizer_GetNegativeButton(*args, **kwargs)
10334
10335 def GetCancelButton(*args, **kwargs):
10336 """GetCancelButton(self) -> wxButton"""
10337 return _core_.StdDialogButtonSizer_GetCancelButton(*args, **kwargs)
10338
10339 def GetHelpButton(*args, **kwargs):
10340 """GetHelpButton(self) -> wxButton"""
10341 return _core_.StdDialogButtonSizer_GetHelpButton(*args, **kwargs)
10342
10343
10344class StdDialogButtonSizerPtr(StdDialogButtonSizer):
10345 def __init__(self, this):
10346 self.this = this
10347 if not hasattr(self,"thisown"): self.thisown = 0
10348 self.__class__ = StdDialogButtonSizer
10349_core_.StdDialogButtonSizer_swigregister(StdDialogButtonSizerPtr)
10350
d14a1e28
RD
10351#---------------------------------------------------------------------------
10352
10353class GBPosition(object):
248ed943
RD
10354 """
10355 This class represents the position of an item in a virtual grid of
10356 rows and columns managed by a `wx.GridBagSizer`. wxPython has
10357 typemaps that will automatically convert from a 2-element sequence of
10358 integers to a wx.GBPosition, so you can use the more pythonic
10359 representation of the position nearly transparently in Python code.
10360 """
e811c8ce
RD
10361 def __repr__(self):
10362 return "<%s.%s; proxy of C++ wxGBPosition instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 10363 def __init__(self, *args, **kwargs):
248ed943
RD
10364 """
10365 __init__(self, int row=0, int col=0) -> GBPosition
10366
10367 This class represents the position of an item in a virtual grid of
10368 rows and columns managed by a `wx.GridBagSizer`. wxPython has
10369 typemaps that will automatically convert from a 2-element sequence of
10370 integers to a wx.GBPosition, so you can use the more pythonic
10371 representation of the position nearly transparently in Python code.
10372 """
54f9ee45 10373 newobj = _core_.new_GBPosition(*args, **kwargs)
d14a1e28
RD
10374 self.this = newobj.this
10375 self.thisown = 1
10376 del newobj.thisown
e811c8ce 10377 def GetRow(*args, **kwargs):
a95a7133 10378 """GetRow(self) -> int"""
54f9ee45 10379 return _core_.GBPosition_GetRow(*args, **kwargs)
e811c8ce
RD
10380
10381 def GetCol(*args, **kwargs):
a95a7133 10382 """GetCol(self) -> int"""
54f9ee45 10383 return _core_.GBPosition_GetCol(*args, **kwargs)
e811c8ce
RD
10384
10385 def SetRow(*args, **kwargs):
a95a7133 10386 """SetRow(self, int row)"""
54f9ee45 10387 return _core_.GBPosition_SetRow(*args, **kwargs)
e811c8ce
RD
10388
10389 def SetCol(*args, **kwargs):
a95a7133 10390 """SetCol(self, int col)"""
54f9ee45 10391 return _core_.GBPosition_SetCol(*args, **kwargs)
e811c8ce
RD
10392
10393 def __eq__(*args, **kwargs):
a95a7133 10394 """__eq__(self, GBPosition other) -> bool"""
54f9ee45 10395 return _core_.GBPosition___eq__(*args, **kwargs)
e811c8ce
RD
10396
10397 def __ne__(*args, **kwargs):
a95a7133 10398 """__ne__(self, GBPosition other) -> bool"""
54f9ee45 10399 return _core_.GBPosition___ne__(*args, **kwargs)
e811c8ce
RD
10400
10401 def Set(*args, **kwargs):
a95a7133 10402 """Set(self, int row=0, int col=0)"""
54f9ee45 10403 return _core_.GBPosition_Set(*args, **kwargs)
e811c8ce
RD
10404
10405 def Get(*args, **kwargs):
a95a7133 10406 """Get(self) -> PyObject"""
54f9ee45 10407 return _core_.GBPosition_Get(*args, **kwargs)
e811c8ce 10408
41e2b43e 10409 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
e811c8ce
RD
10410 def __str__(self): return str(self.Get())
10411 def __repr__(self): return 'wx.GBPosition'+str(self.Get())
10412 def __len__(self): return len(self.Get())
10413 def __getitem__(self, index): return self.Get()[index]
d14a1e28
RD
10414 def __setitem__(self, index, val):
10415 if index == 0: self.SetRow(val)
10416 elif index == 1: self.SetCol(val)
10417 else: raise IndexError
e811c8ce 10418 def __nonzero__(self): return self.Get() != (0,0)
74e96f3d
RD
10419 __safe_for_unpickling__ = True
10420 def __reduce__(self): return (wx.GBPosition, self.Get())
d14a1e28
RD
10421
10422 row = property(GetRow, SetRow)
10423 col = property(GetCol, SetCol)
10424
10425
10426class GBPositionPtr(GBPosition):
10427 def __init__(self, this):
10428 self.this = this
10429 if not hasattr(self,"thisown"): self.thisown = 0
10430 self.__class__ = GBPosition
54f9ee45 10431_core_.GBPosition_swigregister(GBPositionPtr)
d14a1e28
RD
10432
10433class GBSpan(object):
248ed943
RD
10434 """
10435 This class is used to hold the row and column spanning attributes of
10436 items in a `wx.GridBagSizer`. wxPython has typemaps that will
10437 automatically convert from a 2-element sequence of integers to a
10438 wx.GBSpan, so you can use the more pythonic representation of the span
10439 nearly transparently in Python code.
10440
10441 """
e811c8ce
RD
10442 def __repr__(self):
10443 return "<%s.%s; proxy of C++ wxGBSpan instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 10444 def __init__(self, *args, **kwargs):
248ed943
RD
10445 """
10446 __init__(self, int rowspan=1, int colspan=1) -> GBSpan
10447
10448 Construct a new wxGBSpan, optionally setting the rowspan and
10449 colspan. The default is (1,1). (Meaning that the item occupies one
10450 cell in each direction.
10451 """
54f9ee45 10452 newobj = _core_.new_GBSpan(*args, **kwargs)
d14a1e28
RD
10453 self.this = newobj.this
10454 self.thisown = 1
10455 del newobj.thisown
e811c8ce 10456 def GetRowspan(*args, **kwargs):
a95a7133 10457 """GetRowspan(self) -> int"""
54f9ee45 10458 return _core_.GBSpan_GetRowspan(*args, **kwargs)
e811c8ce
RD
10459
10460 def GetColspan(*args, **kwargs):
a95a7133 10461 """GetColspan(self) -> int"""
54f9ee45 10462 return _core_.GBSpan_GetColspan(*args, **kwargs)
e811c8ce
RD
10463
10464 def SetRowspan(*args, **kwargs):
a95a7133 10465 """SetRowspan(self, int rowspan)"""
54f9ee45 10466 return _core_.GBSpan_SetRowspan(*args, **kwargs)
e811c8ce
RD
10467
10468 def SetColspan(*args, **kwargs):
a95a7133 10469 """SetColspan(self, int colspan)"""
54f9ee45 10470 return _core_.GBSpan_SetColspan(*args, **kwargs)
e811c8ce
RD
10471
10472 def __eq__(*args, **kwargs):
a95a7133 10473 """__eq__(self, GBSpan other) -> bool"""
54f9ee45 10474 return _core_.GBSpan___eq__(*args, **kwargs)
e811c8ce
RD
10475
10476 def __ne__(*args, **kwargs):
a95a7133 10477 """__ne__(self, GBSpan other) -> bool"""
54f9ee45 10478 return _core_.GBSpan___ne__(*args, **kwargs)
e811c8ce
RD
10479
10480 def Set(*args, **kwargs):
a95a7133 10481 """Set(self, int rowspan=1, int colspan=1)"""
54f9ee45 10482 return _core_.GBSpan_Set(*args, **kwargs)
e811c8ce
RD
10483
10484 def Get(*args, **kwargs):
a95a7133 10485 """Get(self) -> PyObject"""
54f9ee45 10486 return _core_.GBSpan_Get(*args, **kwargs)
e811c8ce 10487
41e2b43e 10488 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
e811c8ce
RD
10489 def __str__(self): return str(self.Get())
10490 def __repr__(self): return 'wx.GBSpan'+str(self.Get())
10491 def __len__(self): return len(self.Get())
10492 def __getitem__(self, index): return self.Get()[index]
d14a1e28
RD
10493 def __setitem__(self, index, val):
10494 if index == 0: self.SetRowspan(val)
10495 elif index == 1: self.SetColspan(val)
10496 else: raise IndexError
e811c8ce 10497 def __nonzero__(self): return self.Get() != (0,0)
74e96f3d
RD
10498 __safe_for_unpickling__ = True
10499 def __reduce__(self): return (wx.GBSpan, self.Get())
d14a1e28
RD
10500
10501 rowspan = property(GetRowspan, SetRowspan)
10502 colspan = property(GetColspan, SetColspan)
10503
10504
10505class GBSpanPtr(GBSpan):
10506 def __init__(self, this):
10507 self.this = this
10508 if not hasattr(self,"thisown"): self.thisown = 0
10509 self.__class__ = GBSpan
54f9ee45 10510_core_.GBSpan_swigregister(GBSpanPtr)
d14a1e28
RD
10511
10512class GBSizerItem(SizerItem):
248ed943
RD
10513 """
10514 The wx.GBSizerItem class is used to track the additional data about
10515 items in a `wx.GridBagSizer` such as the item's position in the grid
10516 and how many rows or columns it spans.
10517
10518 """
e811c8ce
RD
10519 def __repr__(self):
10520 return "<%s.%s; proxy of C++ wxGBSizerItem instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 10521 def __init__(self, *args, **kwargs):
248ed943
RD
10522 """
10523 __init__(self) -> GBSizerItem
10524
10525 Constructs an empty wx.GBSizerItem. Either a window, sizer or spacer
10526 size will need to be set, as well as a position and span before this
10527 item can be used in a Sizer.
10528
10529 You will probably never need to create a wx.GBSizerItem directly as they
10530 are created automatically when the sizer's Add method is called.
10531 """
54f9ee45 10532 newobj = _core_.new_GBSizerItem(*args, **kwargs)
d14a1e28
RD
10533 self.this = newobj.this
10534 self.thisown = 1
10535 del newobj.thisown
e811c8ce 10536 def GetPos(*args, **kwargs):
248ed943
RD
10537 """
10538 GetPos(self) -> GBPosition
10539
10540 Get the grid position of the item
10541 """
54f9ee45 10542 return _core_.GBSizerItem_GetPos(*args, **kwargs)
e811c8ce
RD
10543
10544 def GetPosTuple(self): return self.GetPos().Get()
10545 def GetSpan(*args, **kwargs):
248ed943
RD
10546 """
10547 GetSpan(self) -> GBSpan
10548
10549 Get the row and column spanning of the item
10550 """
54f9ee45 10551 return _core_.GBSizerItem_GetSpan(*args, **kwargs)
e811c8ce
RD
10552
10553 def GetSpanTuple(self): return self.GetSpan().Get()
10554 def SetPos(*args, **kwargs):
248ed943
RD
10555 """
10556 SetPos(self, GBPosition pos) -> bool
10557
10558 If the item is already a member of a sizer then first ensure that
10559 there is no other item that would intersect with this one at the new
10560 position, then set the new position. Returns True if the change is
10561 successful and after the next Layout() the item will be moved.
10562 """
54f9ee45 10563 return _core_.GBSizerItem_SetPos(*args, **kwargs)
e811c8ce
RD
10564
10565 def SetSpan(*args, **kwargs):
248ed943
RD
10566 """
10567 SetSpan(self, GBSpan span) -> bool
10568
10569 If the item is already a member of a sizer then first ensure that
10570 there is no other item that would intersect with this one with its new
10571 spanning size, then set the new spanning. Returns True if the change
10572 is successful and after the next Layout() the item will be resized.
10573
10574 """
54f9ee45 10575 return _core_.GBSizerItem_SetSpan(*args, **kwargs)
e811c8ce 10576
248ed943 10577 def Intersects(*args, **kwargs):
0df68c9f 10578 """
a95a7133 10579 Intersects(self, GBSizerItem other) -> bool
248ed943
RD
10580
10581 Returns True if this item and the other item instersect.
0df68c9f 10582 """
248ed943
RD
10583 return _core_.GBSizerItem_Intersects(*args, **kwargs)
10584
10585 def IntersectsPos(*args, **kwargs):
10586 """
10587 IntersectsPos(self, GBPosition pos, GBSpan span) -> bool
10588
10589 Returns True if the given pos/span would intersect with this item.
10590 """
10591 return _core_.GBSizerItem_IntersectsPos(*args, **kwargs)
e811c8ce
RD
10592
10593 def GetEndPos(*args, **kwargs):
248ed943
RD
10594 """
10595 GetEndPos(self) -> GBPosition
10596
10597 Get the row and column of the endpoint of this item.
10598 """
54f9ee45 10599 return _core_.GBSizerItem_GetEndPos(*args, **kwargs)
e811c8ce
RD
10600
10601 def GetGBSizer(*args, **kwargs):
248ed943
RD
10602 """
10603 GetGBSizer(self) -> GridBagSizer
10604
10605 Get the sizer this item is a member of.
10606 """
54f9ee45 10607 return _core_.GBSizerItem_GetGBSizer(*args, **kwargs)
e811c8ce
RD
10608
10609 def SetGBSizer(*args, **kwargs):
248ed943
RD
10610 """
10611 SetGBSizer(self, GridBagSizer sizer)
10612
10613 Set the sizer this item is a member of.
10614 """
54f9ee45 10615 return _core_.GBSizerItem_SetGBSizer(*args, **kwargs)
e811c8ce 10616
d14a1e28
RD
10617
10618class GBSizerItemPtr(GBSizerItem):
10619 def __init__(self, this):
10620 self.this = this
10621 if not hasattr(self,"thisown"): self.thisown = 0
10622 self.__class__ = GBSizerItem
54f9ee45 10623_core_.GBSizerItem_swigregister(GBSizerItemPtr)
d14a1e28
RD
10624DefaultSpan = cvar.DefaultSpan
10625
10626def GBSizerItemWindow(*args, **kwargs):
0df68c9f
RD
10627 """
10628 GBSizerItemWindow(Window window, GBPosition pos, GBSpan span, int flag,
248ed943
RD
10629 int border, PyObject userData=None) -> GBSizerItem
10630
10631 Construct a `wx.GBSizerItem` for a window.
0df68c9f 10632 """
54f9ee45 10633 val = _core_.new_GBSizerItemWindow(*args, **kwargs)
d14a1e28
RD
10634 val.thisown = 1
10635 return val
10636
10637def GBSizerItemSizer(*args, **kwargs):
0df68c9f
RD
10638 """
10639 GBSizerItemSizer(Sizer sizer, GBPosition pos, GBSpan span, int flag,
248ed943
RD
10640 int border, PyObject userData=None) -> GBSizerItem
10641
10642 Construct a `wx.GBSizerItem` for a sizer
0df68c9f 10643 """
54f9ee45 10644 val = _core_.new_GBSizerItemSizer(*args, **kwargs)
d14a1e28
RD
10645 val.thisown = 1
10646 return val
10647
10648def GBSizerItemSpacer(*args, **kwargs):
0df68c9f
RD
10649 """
10650 GBSizerItemSpacer(int width, int height, GBPosition pos, GBSpan span,
248ed943
RD
10651 int flag, int border, PyObject userData=None) -> GBSizerItem
10652
10653 Construct a `wx.GBSizerItem` for a spacer.
0df68c9f 10654 """
54f9ee45 10655 val = _core_.new_GBSizerItemSpacer(*args, **kwargs)
d14a1e28
RD
10656 val.thisown = 1
10657 return val
10658
10659class GridBagSizer(FlexGridSizer):
248ed943
RD
10660 """
10661 A `wx.Sizer` that can lay out items in a virtual grid like a
10662 `wx.FlexGridSizer` but in this case explicit positioning of the items
10663 is allowed using `wx.GBPosition`, and items can optionally span more
10664 than one row and/or column using `wx.GBSpan`. The total size of the
10665 virtual grid is determined by the largest row and column that items are
10666 positioned at, adjusted for spanning.
10667
10668 """
e811c8ce
RD
10669 def __repr__(self):
10670 return "<%s.%s; proxy of C++ wxGridBagSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 10671 def __init__(self, *args, **kwargs):
248ed943
RD
10672 """
10673 __init__(self, int vgap=0, int hgap=0) -> GridBagSizer
10674
10675 Constructor, with optional parameters to specify the gap between the
10676 rows and columns.
10677 """
54f9ee45 10678 newobj = _core_.new_GridBagSizer(*args, **kwargs)
d14a1e28
RD
10679 self.this = newobj.this
10680 self.thisown = 1
10681 del newobj.thisown
1823fbb4
RD
10682 self._setOORInfo(self)
10683
e811c8ce 10684 def Add(*args, **kwargs):
0df68c9f 10685 """
248ed943 10686 Add(self, item, GBPosition pos, GBSpan span=DefaultSpan, int flag=0,
d3b6e4ff 10687 int border=0, userData=None) -> wx.GBSizerItem
248ed943
RD
10688
10689 Adds an item to the sizer at the grid cell *pos*, optionally spanning
10690 more than one row or column as specified with *span*. The remaining
10691 args behave similarly to `wx.Sizer.Add`.
10692
10693 Returns True if the item was successfully placed at the given cell
10694 position, False if something was already there.
10695
0df68c9f 10696 """
54f9ee45 10697 return _core_.GridBagSizer_Add(*args, **kwargs)
e811c8ce
RD
10698
10699 def AddItem(*args, **kwargs):
248ed943 10700 """
d3b6e4ff 10701 Add(self, GBSizerItem item) -> wx.GBSizerItem
248ed943
RD
10702
10703 Add an item to the sizer using a `wx.GBSizerItem`. Returns True if
10704 the item was successfully placed at its given cell position, False if
10705 something was already there.
10706 """
54f9ee45 10707 return _core_.GridBagSizer_AddItem(*args, **kwargs)
e811c8ce 10708
84f85550
RD
10709 def GetCellSize(*args, **kwargs):
10710 """
10711 GetCellSize(self, int row, int col) -> Size
10712
10713 Get the size of the specified cell, including hgap and
10714 vgap. Only valid after a Layout.
10715 """
10716 return _core_.GridBagSizer_GetCellSize(*args, **kwargs)
10717
e811c8ce 10718 def GetEmptyCellSize(*args, **kwargs):
248ed943
RD
10719 """
10720 GetEmptyCellSize(self) -> Size
10721
10722 Get the size used for cells in the grid with no item.
10723 """
54f9ee45 10724 return _core_.GridBagSizer_GetEmptyCellSize(*args, **kwargs)
e811c8ce
RD
10725
10726 def SetEmptyCellSize(*args, **kwargs):
248ed943
RD
10727 """
10728 SetEmptyCellSize(self, Size sz)
10729
10730 Set the size used for cells in the grid with no item.
10731 """
54f9ee45 10732 return _core_.GridBagSizer_SetEmptyCellSize(*args, **kwargs)
e811c8ce
RD
10733
10734 def GetItemPosition(*args):
0df68c9f 10735 """
248ed943
RD
10736 GetItemPosition(self, item) -> GBPosition
10737
10738 Get the grid position of the specified *item* where *item* is either a
10739 window or subsizer that is a member of this sizer, or a zero-based
10740 index of an item.
0df68c9f 10741 """
54f9ee45 10742 return _core_.GridBagSizer_GetItemPosition(*args)
e811c8ce
RD
10743
10744 def SetItemPosition(*args):
0df68c9f 10745 """
248ed943
RD
10746 SetItemPosition(self, item, GBPosition pos) -> bool
10747
10748 Set the grid position of the specified *item* where *item* is either a
10749 window or subsizer that is a member of this sizer, or a zero-based
10750 index of an item. Returns True on success. If the move is not
10751 allowed (because an item is already there) then False is returned.
10752
0df68c9f 10753 """
54f9ee45 10754 return _core_.GridBagSizer_SetItemPosition(*args)
e811c8ce
RD
10755
10756 def GetItemSpan(*args):
0df68c9f 10757 """
248ed943
RD
10758 GetItemSpan(self, item) -> GBSpan
10759
10760 Get the row/col spanning of the specified *item* where *item* is
10761 either a window or subsizer that is a member of this sizer, or a
10762 zero-based index of an item.
0df68c9f 10763 """
54f9ee45 10764 return _core_.GridBagSizer_GetItemSpan(*args)
e811c8ce
RD
10765
10766 def SetItemSpan(*args):
0df68c9f 10767 """
248ed943
RD
10768 SetItemSpan(self, item, GBSpan span) -> bool
10769
10770 Set the row/col spanning of the specified *item* where *item* is
10771 either a window or subsizer that is a member of this sizer, or a
10772 zero-based index of an item. Returns True on success. If the move is
10773 not allowed (because an item is already there) then False is returned.
0df68c9f 10774 """
54f9ee45 10775 return _core_.GridBagSizer_SetItemSpan(*args)
e811c8ce
RD
10776
10777 def FindItem(*args):
0df68c9f 10778 """
248ed943
RD
10779 FindItem(self, item) -> GBSizerItem
10780
10781 Find the sizer item for the given window or subsizer, returns None if
10782 not found. (non-recursive)
0df68c9f 10783 """
54f9ee45 10784 return _core_.GridBagSizer_FindItem(*args)
e811c8ce
RD
10785
10786 def FindItemAtPosition(*args, **kwargs):
248ed943
RD
10787 """
10788 FindItemAtPosition(self, GBPosition pos) -> GBSizerItem
10789
10790 Return the sizer item for the given grid cell, or None if there is no
10791 item at that position. (non-recursive)
10792 """
54f9ee45 10793 return _core_.GridBagSizer_FindItemAtPosition(*args, **kwargs)
e811c8ce
RD
10794
10795 def FindItemAtPoint(*args, **kwargs):
248ed943
RD
10796 """
10797 FindItemAtPoint(self, Point pt) -> GBSizerItem
10798
10799 Return the sizer item located at the point given in *pt*, or None if
10800 there is no item at that point. The (x,y) coordinates in pt correspond
10801 to the client coordinates of the window using the sizer for
10802 layout. (non-recursive)
10803 """
54f9ee45 10804 return _core_.GridBagSizer_FindItemAtPoint(*args, **kwargs)
e811c8ce 10805
248ed943
RD
10806 def CheckForIntersection(*args, **kwargs):
10807 """
10808 CheckForIntersection(self, GBSizerItem item, GBSizerItem excludeItem=None) -> bool
e811c8ce 10809
248ed943
RD
10810 Look at all items and see if any intersect (or would overlap) the
10811 given *item*. Returns True if so, False if there would be no overlap.
10812 If an *excludeItem* is given then it will not be checked for
10813 intersection, for example it may be the item we are checking the
10814 position of.
e811c8ce 10815
248ed943
RD
10816 """
10817 return _core_.GridBagSizer_CheckForIntersection(*args, **kwargs)
e811c8ce 10818
248ed943 10819 def CheckForIntersectionPos(*args, **kwargs):
0df68c9f 10820 """
248ed943
RD
10821 CheckForIntersectionPos(self, GBPosition pos, GBSpan span, GBSizerItem excludeItem=None) -> bool
10822
10823 Look at all items and see if any intersect (or would overlap) the
10824 given position and span. Returns True if so, False if there would be
10825 no overlap. If an *excludeItem* is given then it will not be checked
10826 for intersection, for example it may be the item we are checking the
10827 position of.
0df68c9f 10828 """
248ed943 10829 return _core_.GridBagSizer_CheckForIntersectionPos(*args, **kwargs)
e811c8ce 10830
d14a1e28
RD
10831
10832class GridBagSizerPtr(GridBagSizer):
10833 def __init__(self, this):
10834 self.this = this
10835 if not hasattr(self,"thisown"): self.thisown = 0
10836 self.__class__ = GridBagSizer
54f9ee45 10837_core_.GridBagSizer_swigregister(GridBagSizerPtr)
d14a1e28
RD
10838
10839#---------------------------------------------------------------------------
10840
54f9ee45
RD
10841Left = _core_.Left
10842Top = _core_.Top
10843Right = _core_.Right
10844Bottom = _core_.Bottom
10845Width = _core_.Width
10846Height = _core_.Height
10847Centre = _core_.Centre
10848Center = _core_.Center
10849CentreX = _core_.CentreX
10850CentreY = _core_.CentreY
10851Unconstrained = _core_.Unconstrained
10852AsIs = _core_.AsIs
10853PercentOf = _core_.PercentOf
10854Above = _core_.Above
10855Below = _core_.Below
10856LeftOf = _core_.LeftOf
10857RightOf = _core_.RightOf
10858SameAs = _core_.SameAs
10859Absolute = _core_.Absolute
d14a1e28 10860class IndividualLayoutConstraint(Object):
15afbcd0 10861 """
41e2b43e
RD
10862 Objects of this class are stored in the `wx.LayoutConstraints` class as
10863 one of eight possible constraints that a window can be involved in.
10864 You will never need to create an instance of
10865 wx.IndividualLayoutConstraint, rather you should create a
10866 `wx.LayoutConstraints` instance and use the individual contstraints
15afbcd0 10867 that it contains.
15afbcd0 10868 """
d14a1e28
RD
10869 def __init__(self): raise RuntimeError, "No constructor defined"
10870 def __repr__(self):
10871 return "<%s.%s; proxy of C++ wxIndividualLayoutConstraint instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
e811c8ce 10872 def Set(*args, **kwargs):
41e2b43e
RD
10873 """
10874 Set(self, int rel, Window otherW, int otherE, int val=0, int marg=wxLAYOUT_DEFAULT_MARGIN)
10875
10876 Sets the properties of the constraint. Normally called by one of the
10877 convenience functions such as Above, RightOf, SameAs.
10878 """
54f9ee45 10879 return _core_.IndividualLayoutConstraint_Set(*args, **kwargs)
e811c8ce
RD
10880
10881 def LeftOf(*args, **kwargs):
15afbcd0 10882 """
a95a7133 10883 LeftOf(self, Window sibling, int marg=0)
15afbcd0 10884
41e2b43e
RD
10885 Constrains this edge to be to the left of the given window, with an
10886 optional margin. Implicitly, this is relative to the left edge of the
10887 other window.
15afbcd0 10888 """
54f9ee45 10889 return _core_.IndividualLayoutConstraint_LeftOf(*args, **kwargs)
e811c8ce
RD
10890
10891 def RightOf(*args, **kwargs):
15afbcd0 10892 """
a95a7133 10893 RightOf(self, Window sibling, int marg=0)
15afbcd0 10894
41e2b43e
RD
10895 Constrains this edge to be to the right of the given window, with an
10896 optional margin. Implicitly, this is relative to the right edge of the
10897 other window.
15afbcd0 10898 """
54f9ee45 10899 return _core_.IndividualLayoutConstraint_RightOf(*args, **kwargs)
e811c8ce
RD
10900
10901 def Above(*args, **kwargs):
15afbcd0 10902 """
a95a7133 10903 Above(self, Window sibling, int marg=0)
15afbcd0 10904
41e2b43e
RD
10905 Constrains this edge to be above the given window, with an optional
10906 margin. Implicitly, this is relative to the top edge of the other
10907 window.
15afbcd0 10908 """
54f9ee45 10909 return _core_.IndividualLayoutConstraint_Above(*args, **kwargs)
e811c8ce
RD
10910
10911 def Below(*args, **kwargs):
15afbcd0 10912 """
a95a7133 10913 Below(self, Window sibling, int marg=0)
15afbcd0 10914
41e2b43e
RD
10915 Constrains this edge to be below the given window, with an optional
10916 margin. Implicitly, this is relative to the bottom edge of the other
10917 window.
15afbcd0 10918 """
54f9ee45 10919 return _core_.IndividualLayoutConstraint_Below(*args, **kwargs)
e811c8ce
RD
10920
10921 def SameAs(*args, **kwargs):
15afbcd0 10922 """
a95a7133 10923 SameAs(self, Window otherW, int edge, int marg=0)
15afbcd0 10924
41e2b43e
RD
10925 Constrains this edge or dimension to be to the same as the edge of the
10926 given window, with an optional margin.
15afbcd0 10927 """
54f9ee45 10928 return _core_.IndividualLayoutConstraint_SameAs(*args, **kwargs)
e811c8ce
RD
10929
10930 def PercentOf(*args, **kwargs):
15afbcd0 10931 """
a95a7133 10932 PercentOf(self, Window otherW, int wh, int per)
15afbcd0 10933
41e2b43e
RD
10934 Constrains this edge or dimension to be to a percentage of the given
10935 window, with an optional margin.
15afbcd0 10936 """
54f9ee45 10937 return _core_.IndividualLayoutConstraint_PercentOf(*args, **kwargs)
e811c8ce
RD
10938
10939 def Absolute(*args, **kwargs):
15afbcd0 10940 """
a95a7133 10941 Absolute(self, int val)
15afbcd0 10942
41e2b43e 10943 Constrains this edge or dimension to be the given absolute value.
15afbcd0 10944 """
54f9ee45 10945 return _core_.IndividualLayoutConstraint_Absolute(*args, **kwargs)
e811c8ce
RD
10946
10947 def Unconstrained(*args, **kwargs):
15afbcd0 10948 """
a95a7133 10949 Unconstrained(self)
15afbcd0 10950
41e2b43e
RD
10951 Sets this edge or dimension to be unconstrained, that is, dependent on
10952 other edges and dimensions from which this value can be deduced.
15afbcd0 10953 """
54f9ee45 10954 return _core_.IndividualLayoutConstraint_Unconstrained(*args, **kwargs)
e811c8ce
RD
10955
10956 def AsIs(*args, **kwargs):
15afbcd0 10957 """
a95a7133 10958 AsIs(self)
15afbcd0 10959
41e2b43e
RD
10960 Sets this edge or constraint to be whatever the window's value is at
10961 the moment. If either of the width and height constraints are *as is*,
10962 the window will not be resized, but moved instead. This is important
10963 when considering panel items which are intended to have a default
10964 size, such as a button, which may take its size from the size of the
10965 button label.
15afbcd0 10966 """
54f9ee45 10967 return _core_.IndividualLayoutConstraint_AsIs(*args, **kwargs)
e811c8ce
RD
10968
10969 def GetOtherWindow(*args, **kwargs):
a95a7133 10970 """GetOtherWindow(self) -> Window"""
54f9ee45 10971 return _core_.IndividualLayoutConstraint_GetOtherWindow(*args, **kwargs)
e811c8ce
RD
10972
10973 def GetMyEdge(*args, **kwargs):
a95a7133 10974 """GetMyEdge(self) -> int"""
54f9ee45 10975 return _core_.IndividualLayoutConstraint_GetMyEdge(*args, **kwargs)
e811c8ce
RD
10976
10977 def SetEdge(*args, **kwargs):
a95a7133 10978 """SetEdge(self, int which)"""
54f9ee45 10979 return _core_.IndividualLayoutConstraint_SetEdge(*args, **kwargs)
e811c8ce
RD
10980
10981 def SetValue(*args, **kwargs):
a95a7133 10982 """SetValue(self, int v)"""
54f9ee45 10983 return _core_.IndividualLayoutConstraint_SetValue(*args, **kwargs)
e811c8ce
RD
10984
10985 def GetMargin(*args, **kwargs):
a95a7133 10986 """GetMargin(self) -> int"""
54f9ee45 10987 return _core_.IndividualLayoutConstraint_GetMargin(*args, **kwargs)
e811c8ce
RD
10988
10989 def SetMargin(*args, **kwargs):
a95a7133 10990 """SetMargin(self, int m)"""
54f9ee45 10991 return _core_.IndividualLayoutConstraint_SetMargin(*args, **kwargs)
e811c8ce
RD
10992
10993 def GetValue(*args, **kwargs):
a95a7133 10994 """GetValue(self) -> int"""
54f9ee45 10995 return _core_.IndividualLayoutConstraint_GetValue(*args, **kwargs)
e811c8ce
RD
10996
10997 def GetPercent(*args, **kwargs):
a95a7133 10998 """GetPercent(self) -> int"""
54f9ee45 10999 return _core_.IndividualLayoutConstraint_GetPercent(*args, **kwargs)
e811c8ce
RD
11000
11001 def GetOtherEdge(*args, **kwargs):
a95a7133 11002 """GetOtherEdge(self) -> int"""
54f9ee45 11003 return _core_.IndividualLayoutConstraint_GetOtherEdge(*args, **kwargs)
e811c8ce
RD
11004
11005 def GetDone(*args, **kwargs):
a95a7133 11006 """GetDone(self) -> bool"""
54f9ee45 11007 return _core_.IndividualLayoutConstraint_GetDone(*args, **kwargs)
e811c8ce
RD
11008
11009 def SetDone(*args, **kwargs):
a95a7133 11010 """SetDone(self, bool d)"""
54f9ee45 11011 return _core_.IndividualLayoutConstraint_SetDone(*args, **kwargs)
e811c8ce
RD
11012
11013 def GetRelationship(*args, **kwargs):
a95a7133 11014 """GetRelationship(self) -> int"""
54f9ee45 11015 return _core_.IndividualLayoutConstraint_GetRelationship(*args, **kwargs)
e811c8ce
RD
11016
11017 def SetRelationship(*args, **kwargs):
a95a7133 11018 """SetRelationship(self, int r)"""
54f9ee45 11019 return _core_.IndividualLayoutConstraint_SetRelationship(*args, **kwargs)
e811c8ce
RD
11020
11021 def ResetIfWin(*args, **kwargs):
15afbcd0 11022 """
a95a7133 11023 ResetIfWin(self, Window otherW) -> bool
15afbcd0
RD
11024
11025 Reset constraint if it mentions otherWin
11026 """
54f9ee45 11027 return _core_.IndividualLayoutConstraint_ResetIfWin(*args, **kwargs)
e811c8ce
RD
11028
11029 def SatisfyConstraint(*args, **kwargs):
15afbcd0 11030 """
a95a7133 11031 SatisfyConstraint(self, LayoutConstraints constraints, Window win) -> bool
15afbcd0
RD
11032
11033 Try to satisfy constraint
11034 """
54f9ee45 11035 return _core_.IndividualLayoutConstraint_SatisfyConstraint(*args, **kwargs)
e811c8ce
RD
11036
11037 def GetEdge(*args, **kwargs):
15afbcd0 11038 """
a95a7133 11039 GetEdge(self, int which, Window thisWin, Window other) -> int
15afbcd0
RD
11040
11041 Get the value of this edge or dimension, or if this
11042 is not determinable, -1.
11043 """
54f9ee45 11044 return _core_.IndividualLayoutConstraint_GetEdge(*args, **kwargs)
e811c8ce 11045
d14a1e28
RD
11046
11047class IndividualLayoutConstraintPtr(IndividualLayoutConstraint):
11048 def __init__(self, this):
11049 self.this = this
11050 if not hasattr(self,"thisown"): self.thisown = 0
11051 self.__class__ = IndividualLayoutConstraint
54f9ee45 11052_core_.IndividualLayoutConstraint_swigregister(IndividualLayoutConstraintPtr)
d14a1e28
RD
11053
11054class LayoutConstraints(Object):
15afbcd0 11055 """
41e2b43e
RD
11056 **Note:** constraints are now deprecated and you should use sizers
11057 instead.
15afbcd0 11058
41e2b43e
RD
11059 Objects of this class can be associated with a window to define its
11060 layout constraints, with respect to siblings or its parent.
15afbcd0
RD
11061
11062 The class consists of the following eight constraints of class
11063 wx.IndividualLayoutConstraint, some or all of which should be accessed
11064 directly to set the appropriate constraints.
11065
11066 * left: represents the left hand edge of the window
11067 * right: represents the right hand edge of the window
11068 * top: represents the top edge of the window
11069 * bottom: represents the bottom edge of the window
11070 * width: represents the width of the window
11071 * height: represents the height of the window
11072 * centreX: represents the horizontal centre point of the window
11073 * centreY: represents the vertical centre point of the window
11074
41e2b43e
RD
11075 Most constraints are initially set to have the relationship
11076 wxUnconstrained, which means that their values should be calculated by
11077 looking at known constraints. The exceptions are width and height,
11078 which are set to wxAsIs to ensure that if the user does not specify a
11079 constraint, the existing width and height will be used, to be
11080 compatible with panel items which often have take a default size. If
11081 the constraint is ``wx.AsIs``, the dimension will not be changed.
11082
11083 :see: `wx.IndividualLayoutConstraint`, `wx.Window.SetConstraints`
15afbcd0
RD
11084
11085 """
e811c8ce
RD
11086 def __repr__(self):
11087 return "<%s.%s; proxy of C++ wxLayoutConstraints instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
54f9ee45
RD
11088 left = property(_core_.LayoutConstraints_left_get)
11089 top = property(_core_.LayoutConstraints_top_get)
11090 right = property(_core_.LayoutConstraints_right_get)
11091 bottom = property(_core_.LayoutConstraints_bottom_get)
11092 width = property(_core_.LayoutConstraints_width_get)
11093 height = property(_core_.LayoutConstraints_height_get)
11094 centreX = property(_core_.LayoutConstraints_centreX_get)
11095 centreY = property(_core_.LayoutConstraints_centreY_get)
d14a1e28 11096 def __init__(self, *args, **kwargs):
a95a7133 11097 """__init__(self) -> LayoutConstraints"""
54f9ee45 11098 newobj = _core_.new_LayoutConstraints(*args, **kwargs)
d14a1e28
RD
11099 self.this = newobj.this
11100 self.thisown = 1
11101 del newobj.thisown
e811c8ce 11102 def SatisfyConstraints(*args, **kwargs):
6c3b4aae 11103 """SatisfyConstraints(Window win) -> (areSatisfied, noChanges)"""
54f9ee45 11104 return _core_.LayoutConstraints_SatisfyConstraints(*args, **kwargs)
e811c8ce
RD
11105
11106 def AreSatisfied(*args, **kwargs):
a95a7133 11107 """AreSatisfied(self) -> bool"""
54f9ee45 11108 return _core_.LayoutConstraints_AreSatisfied(*args, **kwargs)
e811c8ce 11109
d14a1e28
RD
11110
11111class LayoutConstraintsPtr(LayoutConstraints):
11112 def __init__(self, this):
11113 self.this = this
11114 if not hasattr(self,"thisown"): self.thisown = 0
11115 self.__class__ = LayoutConstraints
54f9ee45 11116_core_.LayoutConstraints_swigregister(LayoutConstraintsPtr)
d14a1e28
RD
11117
11118#----------------------------------------------------------------------------
11119
322913ce 11120# Use Python's bool constants if available, make some if not
d14a1e28
RD
11121try:
11122 True
11123except NameError:
322913ce
RD
11124 __builtins__.True = 1==1
11125 __builtins__.False = 1==0
4f89f6a3
RD
11126 def bool(value): return not not value
11127 __builtins__.bool = bool
d14a1e28 11128
d14a1e28
RD
11129
11130
11131# workarounds for bad wxRTTI names
11132__wxPyPtrTypeMap['wxGauge95'] = 'wxGauge'
11133__wxPyPtrTypeMap['wxSlider95'] = 'wxSlider'
11134__wxPyPtrTypeMap['wxStatusBar95'] = 'wxStatusBar'
11135
11136
11137#----------------------------------------------------------------------------
11138# Load version numbers from __version__... Ensure that major and minor
7bc1e663 11139# versions are the same for both wxPython and wxWidgets.
d14a1e28
RD
11140
11141from __version__ import *
11142__version__ = VERSION_STRING
11143
7bc1e663
RD
11144assert MAJOR_VERSION == _core_.MAJOR_VERSION, "wxPython/wxWidgets version mismatch"
11145assert MINOR_VERSION == _core_.MINOR_VERSION, "wxPython/wxWidgets version mismatch"
54f9ee45 11146if RELEASE_VERSION != _core_.RELEASE_VERSION:
d14a1e28 11147 import warnings
7bc1e663 11148 warnings.warn("wxPython/wxWidgets release number mismatch")
d14a1e28
RD
11149
11150#----------------------------------------------------------------------------
11151
e505d15e
RD
11152# Set the default string<-->unicode conversion encoding from the
11153# locale. This encoding is used when string or unicode objects need
11154# to be converted in order to pass them to wxWidgets. Please be aware
11155# that the default encoding within the same locale may be slightly
11156# different on different platforms. For example, please see
11157# http://www.alanwood.net/demos/charsetdiffs.html for differences
11158# between the common latin/roman encodings.
5cbf236d
RD
11159import locale
11160default = locale.getdefaultlocale()[1]
11161if default:
11162 wx.SetDefaultPyEncoding(default)
11163del default
11164del locale
11165
11166#----------------------------------------------------------------------------
11167
d14a1e28
RD
11168class PyDeadObjectError(AttributeError):
11169 pass
11170
d14a1e28
RD
11171class _wxPyDeadObject(object):
11172 """
11173 Instances of wx objects that are OOR capable will have their __class__
11174 changed to this class when the C++ object is deleted. This should help
11175 prevent crashes due to referencing a bogus C++ pointer.
11176 """
11177 reprStr = "wxPython wrapper for DELETED %s object! (The C++ object no longer exists.)"
11178 attrStr = "The C++ part of the %s object has been deleted, attribute access no longer allowed."
11179
3a04f143 11180 def __repr__(self):
d14a1e28
RD
11181 if not hasattr(self, "_name"):
11182 self._name = "[unknown]"
11183 return self.reprStr % self._name
11184
3a04f143 11185 def __getattr__(self, *args):
d14a1e28
RD
11186 if not hasattr(self, "_name"):
11187 self._name = "[unknown]"
3a04f143
RD
11188 raise PyDeadObjectError(self.attrStr % self._name)
11189
11190 def __nonzero__(self):
11191 return 0
11192
11193
11194
11195class PyUnbornObjectError(AttributeError):
11196 pass
11197
11198class _wxPyUnbornObject(object):
11199 """
54f9ee45 11200 Some stock objects are created when the wx._core module is
3a04f143
RD
11201 imported, but their C++ instance is not created until the wx.App
11202 object is created and initialized. These object instances will
11203 temporarily have their __class__ changed to this class so an
11204 exception will be raised if they are used before the C++ instance
11205 is ready.
11206 """
11207
11208 reprStr = "wxPython wrapper for UNBORN object! (The C++ object is not initialized yet.)"
11209 attrStr = "The C++ part of this object has not been initialized, attribute access not allowed."
11210
11211 def __repr__(self):
11212 #if not hasattr(self, "_name"):
11213 # self._name = "[unknown]"
11214 return self.reprStr #% self._name
11215
11216 def __getattr__(self, *args):
11217 #if not hasattr(self, "_name"):
11218 # self._name = "[unknown]"
11219 raise PyUnbornObjectError(self.attrStr) # % self._name )
d14a1e28
RD
11220
11221 def __nonzero__(self):
11222 return 0
11223
11224
11225#----------------------------------------------------------------------------
d14a1e28
RD
11226
11227def CallAfter(callable, *args, **kw):
11228 """
11229 Call the specified function after the current and pending event
11230 handlers have been completed. This is also good for making GUI
61863841
RD
11231 method calls from non-GUI threads. Any extra positional or
11232 keyword args are passed on to the callable when it is called.
11233
11234 :see: `wx.FutureCall`
d14a1e28
RD
11235 """
11236 app = wx.GetApp()
dfbb5885 11237 assert app is not None, 'No wx.App created yet'
d14a1e28 11238
148275d3
RD
11239 if not hasattr(app, "_CallAfterId"):
11240 app._CallAfterId = wx.NewEventType()
11241 app.Connect(-1, -1, app._CallAfterId,
11242 lambda event: event.callable(*event.args, **event.kw) )
d14a1e28 11243 evt = wx.PyEvent()
148275d3 11244 evt.SetEventType(app._CallAfterId)
d14a1e28
RD
11245 evt.callable = callable
11246 evt.args = args
11247 evt.kw = kw
11248 wx.PostEvent(app, evt)
11249
d14a1e28
RD
11250#----------------------------------------------------------------------------
11251
11252
11253class FutureCall:
11254 """
8ac8dba0 11255 A convenience class for `wx.Timer`, that calls the given callable
d14a1e28
RD
11256 object once after the given amount of milliseconds, passing any
11257 positional or keyword args. The return value of the callable is
61863841 11258 availbale after it has been run with the `GetResult` method.
d14a1e28
RD
11259
11260 If you don't need to get the return value or restart the timer
11261 then there is no need to hold a reference to this object. It will
11262 hold a reference to itself while the timer is running (the timer
11263 has a reference to self.Notify) but the cycle will be broken when
11264 the timer completes, automatically cleaning up the wx.FutureCall
11265 object.
61863841
RD
11266
11267 :see: `wx.CallAfter`
d14a1e28
RD
11268 """
11269 def __init__(self, millis, callable, *args, **kwargs):
11270 self.millis = millis
11271 self.callable = callable
11272 self.SetArgs(*args, **kwargs)
11273 self.runCount = 0
4276dc52 11274 self.running = False
d14a1e28
RD
11275 self.hasRun = False
11276 self.result = None
11277 self.timer = None
11278 self.Start()
11279
11280 def __del__(self):
11281 self.Stop()
11282
11283
11284 def Start(self, millis=None, *args, **kwargs):
11285 """
11286 (Re)start the timer
11287 """
11288 self.hasRun = False
11289 if millis is not None:
11290 self.millis = millis
11291 if args or kwargs:
11292 self.SetArgs(*args, **kwargs)
11293 self.Stop()
11294 self.timer = wx.PyTimer(self.Notify)
11295 self.timer.Start(self.millis, wx.TIMER_ONE_SHOT)
4276dc52 11296 self.running = True
d14a1e28
RD
11297 Restart = Start
11298
11299
11300 def Stop(self):
11301 """
11302 Stop and destroy the timer.
11303 """
11304 if self.timer is not None:
11305 self.timer.Stop()
11306 self.timer = None
11307
11308
11309 def GetInterval(self):
11310 if self.timer is not None:
11311 return self.timer.GetInterval()
11312 else:
11313 return 0
11314
11315
11316 def IsRunning(self):
11317 return self.timer is not None and self.timer.IsRunning()
11318
11319
11320 def SetArgs(self, *args, **kwargs):
11321 """
11322 (Re)set the args passed to the callable object. This is
11323 useful in conjunction with Restart if you want to schedule a
11324 new call to the same callable object but with different
11325 parameters.
11326 """
11327 self.args = args
11328 self.kwargs = kwargs
11329
11330
11331 def HasRun(self):
11332 return self.hasRun
11333
11334 def GetResult(self):
11335 return self.result
11336
11337 def Notify(self):
11338 """
11339 The timer has expired so call the callable.
11340 """
11341 if self.callable and getattr(self.callable, 'im_self', True):
11342 self.runCount += 1
4276dc52 11343 self.running = False
d14a1e28
RD
11344 self.result = self.callable(*self.args, **self.kwargs)
11345 self.hasRun = True
4276dc52
RD
11346 if not self.running:
11347 # if it wasn't restarted, then cleanup
11348 wx.CallAfter(self.Stop)
d14a1e28
RD
11349
11350
a95a7133
RD
11351
11352#----------------------------------------------------------------------------
11353# Control which items in this module should be documented by epydoc.
11354# We allow only classes and functions, which will help reduce the size
11355# of the docs by filtering out the zillions of constants, EVT objects,
11356# and etc that don't make much sense by themselves, but are instead
11357# documented (or will be) as part of the classes/functions/methods
11358# where they should be used.
11359
66c033b4
RD
11360class __DocFilter:
11361 """
11362 A filter for epydoc that only allows non-Ptr classes and
11363 fucntions, in order to reduce the clutter in the API docs.
11364 """
11365 def __init__(self, globals):
11366 self._globals = globals
11367
11368 def __call__(self, name):
11369 import types
11370 obj = self._globals.get(name, None)
11371 if type(obj) not in [type, types.ClassType, types.FunctionType, types.BuiltinFunctionType]:
11372 return False
11373 if name.startswith('_') or name.endswith('Ptr') or name.startswith('EVT'):
11374 return False
11375 return True
a95a7133 11376
d14a1e28
RD
11377#----------------------------------------------------------------------------
11378#----------------------------------------------------------------------------
11379
11380# Import other modules in this package that should show up in the
11381# "core" wx namespace
54f9ee45
RD
11382from _gdi import *
11383from _windows import *
11384from _controls import *
11385from _misc import *
d14a1e28 11386
3a04f143
RD
11387
11388# Fixup the stock objects since they can't be used yet. (They will be
11389# restored in wx.PyApp.OnInit.)
54f9ee45 11390_core_._wxPyFixStockObjects()
3a04f143 11391
d14a1e28
RD
11392#----------------------------------------------------------------------------
11393#----------------------------------------------------------------------------
11394
11395