]> git.saurik.com Git - wxWidgets.git/blame - wxPython/src/gtk/_core.py
bug fixes for using wxTransientPopupWindow and wxDP_ALLOWNONE support from Andreas...
[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
RD
2179
2180 def FindFirstUnusedColour(*args, **kwargs):
fd2dc343
RD
2181 """
2182 FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)
2183
2184 Find first colour that is not used in the image and has higher RGB
2185 values than startR, startG, startB. Returns a tuple consisting of a
2186 success flag and rgb values.
2187 """
54f9ee45 2188 return _core_.Image_FindFirstUnusedColour(*args, **kwargs)
e811c8ce 2189
4cf4100f
RD
2190 def ConvertAlphaToMask(*args, **kwargs):
2191 """
2192 ConvertAlphaToMask(self, byte threshold=128) -> bool
2193
2194 If the image has alpha channel, this method converts it to mask. All pixels
2195 with alpha value less than ``threshold`` are replaced with mask colour and the
2196 alpha channel is removed. Mask colour is chosen automatically using
2197 `FindFirstUnusedColour`.
2198
2199 If the image image doesn't have alpha channel, ConvertAlphaToMask does
2200 nothing.
2201 """
2202 return _core_.Image_ConvertAlphaToMask(*args, **kwargs)
2203
8fb0e70a
RD
2204 def ConvertColourToAlpha(*args, **kwargs):
2205 """
2206 ConvertColourToAlpha(self, unsigned char r, unsigned char g, unsigned char b) -> bool
2207
2208 This method converts an image where the original alpha information is
2209 only available as a shades of a colour (actually shades of grey)
2210 typically when you draw anti-aliased text into a bitmap. The DC
2211 drawing routines draw grey values on the black background although
2212 they actually mean to draw white with differnt alpha values. This
2213 method reverses it, assuming a black (!) background and white text.
2214 The method will then fill up the whole image with the colour given.
2215 """
2216 return _core_.Image_ConvertColourToAlpha(*args, **kwargs)
2217
e811c8ce 2218 def SetMaskFromImage(*args, **kwargs):
a95a7133 2219 """SetMaskFromImage(self, Image mask, byte mr, byte mg, byte mb) -> bool"""
54f9ee45 2220 return _core_.Image_SetMaskFromImage(*args, **kwargs)
e811c8ce
RD
2221
2222 def CanRead(*args, **kwargs):
66c033b4 2223 """CanRead(String name) -> bool"""
54f9ee45 2224 return _core_.Image_CanRead(*args, **kwargs)
e811c8ce
RD
2225
2226 CanRead = staticmethod(CanRead)
2227 def GetImageCount(*args, **kwargs):
66c033b4 2228 """GetImageCount(String name, long type=BITMAP_TYPE_ANY) -> int"""
54f9ee45 2229 return _core_.Image_GetImageCount(*args, **kwargs)
e811c8ce
RD
2230
2231 GetImageCount = staticmethod(GetImageCount)
2232 def LoadFile(*args, **kwargs):
a95a7133 2233 """LoadFile(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> bool"""
54f9ee45 2234 return _core_.Image_LoadFile(*args, **kwargs)
e811c8ce
RD
2235
2236 def LoadMimeFile(*args, **kwargs):
a95a7133 2237 """LoadMimeFile(self, String name, String mimetype, int index=-1) -> bool"""
54f9ee45 2238 return _core_.Image_LoadMimeFile(*args, **kwargs)
e811c8ce
RD
2239
2240 def SaveFile(*args, **kwargs):
a95a7133 2241 """SaveFile(self, String name, int type) -> bool"""
54f9ee45 2242 return _core_.Image_SaveFile(*args, **kwargs)
e811c8ce
RD
2243
2244 def SaveMimeFile(*args, **kwargs):
a95a7133 2245 """SaveMimeFile(self, String name, String mimetype) -> bool"""
54f9ee45 2246 return _core_.Image_SaveMimeFile(*args, **kwargs)
e811c8ce
RD
2247
2248 def CanReadStream(*args, **kwargs):
66c033b4 2249 """CanReadStream(InputStream stream) -> bool"""
54f9ee45 2250 return _core_.Image_CanReadStream(*args, **kwargs)
e811c8ce
RD
2251
2252 CanReadStream = staticmethod(CanReadStream)
2253 def LoadStream(*args, **kwargs):
a95a7133 2254 """LoadStream(self, InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> bool"""
54f9ee45 2255 return _core_.Image_LoadStream(*args, **kwargs)
e811c8ce
RD
2256
2257 def LoadMimeStream(*args, **kwargs):
a95a7133 2258 """LoadMimeStream(self, InputStream stream, String mimetype, int index=-1) -> bool"""
54f9ee45 2259 return _core_.Image_LoadMimeStream(*args, **kwargs)
e811c8ce
RD
2260
2261 def Ok(*args, **kwargs):
a95a7133 2262 """Ok(self) -> bool"""
54f9ee45 2263 return _core_.Image_Ok(*args, **kwargs)
e811c8ce
RD
2264
2265 def GetWidth(*args, **kwargs):
a95a7133 2266 """GetWidth(self) -> int"""
54f9ee45 2267 return _core_.Image_GetWidth(*args, **kwargs)
e811c8ce
RD
2268
2269 def GetHeight(*args, **kwargs):
a95a7133 2270 """GetHeight(self) -> int"""
54f9ee45 2271 return _core_.Image_GetHeight(*args, **kwargs)
e811c8ce 2272
b2df227b 2273 def GetSize(*args, **kwargs):
a95a7133 2274 """GetSize(self) -> Size"""
54f9ee45 2275 return _core_.Image_GetSize(*args, **kwargs)
b2df227b 2276
e811c8ce 2277 def GetSubImage(*args, **kwargs):
a95a7133 2278 """GetSubImage(self, Rect rect) -> Image"""
54f9ee45 2279 return _core_.Image_GetSubImage(*args, **kwargs)
e811c8ce
RD
2280
2281 def Copy(*args, **kwargs):
a95a7133 2282 """Copy(self) -> Image"""
54f9ee45 2283 return _core_.Image_Copy(*args, **kwargs)
e811c8ce
RD
2284
2285 def Paste(*args, **kwargs):
a95a7133 2286 """Paste(self, Image image, int x, int y)"""
54f9ee45 2287 return _core_.Image_Paste(*args, **kwargs)
e811c8ce
RD
2288
2289 def GetData(*args, **kwargs):
a95a7133 2290 """GetData(self) -> PyObject"""
54f9ee45 2291 return _core_.Image_GetData(*args, **kwargs)
e811c8ce
RD
2292
2293 def SetData(*args, **kwargs):
a95a7133 2294 """SetData(self, PyObject data)"""
54f9ee45 2295 return _core_.Image_SetData(*args, **kwargs)
e811c8ce
RD
2296
2297 def GetDataBuffer(*args, **kwargs):
a95a7133 2298 """GetDataBuffer(self) -> PyObject"""
54f9ee45 2299 return _core_.Image_GetDataBuffer(*args, **kwargs)
e811c8ce
RD
2300
2301 def SetDataBuffer(*args, **kwargs):
a95a7133 2302 """SetDataBuffer(self, PyObject data)"""
54f9ee45 2303 return _core_.Image_SetDataBuffer(*args, **kwargs)
e811c8ce
RD
2304
2305 def GetAlphaData(*args, **kwargs):
a95a7133 2306 """GetAlphaData(self) -> PyObject"""
54f9ee45 2307 return _core_.Image_GetAlphaData(*args, **kwargs)
e811c8ce
RD
2308
2309 def SetAlphaData(*args, **kwargs):
a95a7133 2310 """SetAlphaData(self, PyObject data)"""
54f9ee45 2311 return _core_.Image_SetAlphaData(*args, **kwargs)
e811c8ce
RD
2312
2313 def GetAlphaBuffer(*args, **kwargs):
a95a7133 2314 """GetAlphaBuffer(self) -> PyObject"""
54f9ee45 2315 return _core_.Image_GetAlphaBuffer(*args, **kwargs)
e811c8ce
RD
2316
2317 def SetAlphaBuffer(*args, **kwargs):
a95a7133 2318 """SetAlphaBuffer(self, PyObject data)"""
54f9ee45 2319 return _core_.Image_SetAlphaBuffer(*args, **kwargs)
e811c8ce
RD
2320
2321 def SetMaskColour(*args, **kwargs):
a95a7133 2322 """SetMaskColour(self, unsigned char r, unsigned char g, unsigned char b)"""
54f9ee45 2323 return _core_.Image_SetMaskColour(*args, **kwargs)
e811c8ce
RD
2324
2325 def GetMaskRed(*args, **kwargs):
a95a7133 2326 """GetMaskRed(self) -> unsigned char"""
54f9ee45 2327 return _core_.Image_GetMaskRed(*args, **kwargs)
e811c8ce
RD
2328
2329 def GetMaskGreen(*args, **kwargs):
a95a7133 2330 """GetMaskGreen(self) -> unsigned char"""
54f9ee45 2331 return _core_.Image_GetMaskGreen(*args, **kwargs)
e811c8ce
RD
2332
2333 def GetMaskBlue(*args, **kwargs):
a95a7133 2334 """GetMaskBlue(self) -> unsigned char"""
54f9ee45 2335 return _core_.Image_GetMaskBlue(*args, **kwargs)
e811c8ce
RD
2336
2337 def SetMask(*args, **kwargs):
a95a7133 2338 """SetMask(self, bool mask=True)"""
54f9ee45 2339 return _core_.Image_SetMask(*args, **kwargs)
e811c8ce
RD
2340
2341 def HasMask(*args, **kwargs):
a95a7133 2342 """HasMask(self) -> bool"""
54f9ee45 2343 return _core_.Image_HasMask(*args, **kwargs)
e811c8ce
RD
2344
2345 def Rotate(*args, **kwargs):
0df68c9f 2346 """
a95a7133 2347 Rotate(self, double angle, Point centre_of_rotation, bool interpolating=True,
0df68c9f
RD
2348 Point offset_after_rotation=None) -> Image
2349 """
54f9ee45 2350 return _core_.Image_Rotate(*args, **kwargs)
e811c8ce
RD
2351
2352 def Rotate90(*args, **kwargs):
a95a7133 2353 """Rotate90(self, bool clockwise=True) -> Image"""
54f9ee45 2354 return _core_.Image_Rotate90(*args, **kwargs)
e811c8ce
RD
2355
2356 def Mirror(*args, **kwargs):
a95a7133 2357 """Mirror(self, bool horizontally=True) -> Image"""
54f9ee45 2358 return _core_.Image_Mirror(*args, **kwargs)
e811c8ce
RD
2359
2360 def Replace(*args, **kwargs):
0df68c9f 2361 """
a95a7133 2362 Replace(self, unsigned char r1, unsigned char g1, unsigned char b1,
0df68c9f
RD
2363 unsigned char r2, unsigned char g2, unsigned char b2)
2364 """
54f9ee45 2365 return _core_.Image_Replace(*args, **kwargs)
e811c8ce
RD
2366
2367 def ConvertToMono(*args, **kwargs):
a95a7133 2368 """ConvertToMono(self, unsigned char r, unsigned char g, unsigned char b) -> Image"""
54f9ee45 2369 return _core_.Image_ConvertToMono(*args, **kwargs)
e811c8ce
RD
2370
2371 def SetOption(*args, **kwargs):
a95a7133 2372 """SetOption(self, String name, String value)"""
54f9ee45 2373 return _core_.Image_SetOption(*args, **kwargs)
e811c8ce
RD
2374
2375 def SetOptionInt(*args, **kwargs):
a95a7133 2376 """SetOptionInt(self, String name, int value)"""
54f9ee45 2377 return _core_.Image_SetOptionInt(*args, **kwargs)
e811c8ce
RD
2378
2379 def GetOption(*args, **kwargs):
a95a7133 2380 """GetOption(self, String name) -> String"""
54f9ee45 2381 return _core_.Image_GetOption(*args, **kwargs)
e811c8ce
RD
2382
2383 def GetOptionInt(*args, **kwargs):
a95a7133 2384 """GetOptionInt(self, String name) -> int"""
54f9ee45 2385 return _core_.Image_GetOptionInt(*args, **kwargs)
e811c8ce
RD
2386
2387 def HasOption(*args, **kwargs):
a95a7133 2388 """HasOption(self, String name) -> bool"""
54f9ee45 2389 return _core_.Image_HasOption(*args, **kwargs)
e811c8ce
RD
2390
2391 def CountColours(*args, **kwargs):
a95a7133 2392 """CountColours(self, unsigned long stopafter=(unsigned long) -1) -> unsigned long"""
54f9ee45 2393 return _core_.Image_CountColours(*args, **kwargs)
e811c8ce
RD
2394
2395 def ComputeHistogram(*args, **kwargs):
a95a7133 2396 """ComputeHistogram(self, ImageHistogram h) -> unsigned long"""
54f9ee45 2397 return _core_.Image_ComputeHistogram(*args, **kwargs)
e811c8ce
RD
2398
2399 def AddHandler(*args, **kwargs):
66c033b4 2400 """AddHandler(ImageHandler handler)"""
54f9ee45 2401 return _core_.Image_AddHandler(*args, **kwargs)
e811c8ce
RD
2402
2403 AddHandler = staticmethod(AddHandler)
2404 def InsertHandler(*args, **kwargs):
66c033b4 2405 """InsertHandler(ImageHandler handler)"""
54f9ee45 2406 return _core_.Image_InsertHandler(*args, **kwargs)
e811c8ce
RD
2407
2408 InsertHandler = staticmethod(InsertHandler)
2409 def RemoveHandler(*args, **kwargs):
66c033b4 2410 """RemoveHandler(String name) -> bool"""
54f9ee45 2411 return _core_.Image_RemoveHandler(*args, **kwargs)
e811c8ce
RD
2412
2413 RemoveHandler = staticmethod(RemoveHandler)
2414 def GetImageExtWildcard(*args, **kwargs):
66c033b4 2415 """GetImageExtWildcard() -> String"""
54f9ee45 2416 return _core_.Image_GetImageExtWildcard(*args, **kwargs)
e811c8ce
RD
2417
2418 GetImageExtWildcard = staticmethod(GetImageExtWildcard)
2419 def ConvertToBitmap(*args, **kwargs):
1fbf26be 2420 """ConvertToBitmap(self, int depth=-1) -> Bitmap"""
54f9ee45 2421 return _core_.Image_ConvertToBitmap(*args, **kwargs)
e811c8ce
RD
2422
2423 def ConvertToMonoBitmap(*args, **kwargs):
a95a7133 2424 """ConvertToMonoBitmap(self, unsigned char red, unsigned char green, unsigned char blue) -> Bitmap"""
54f9ee45 2425 return _core_.Image_ConvertToMonoBitmap(*args, **kwargs)
e811c8ce
RD
2426
2427 def __nonzero__(self): return self.Ok()
d14a1e28
RD
2428
2429class ImagePtr(Image):
2430 def __init__(self, this):
2431 self.this = this
2432 if not hasattr(self,"thisown"): self.thisown = 0
2433 self.__class__ = Image
54f9ee45 2434_core_.Image_swigregister(ImagePtr)
d14a1e28
RD
2435
2436def ImageFromMime(*args, **kwargs):
196addbf 2437 """ImageFromMime(String name, String mimetype, int index=-1) -> Image"""
54f9ee45 2438 val = _core_.new_ImageFromMime(*args, **kwargs)
d14a1e28
RD
2439 val.thisown = 1
2440 return val
2441
2442def ImageFromStream(*args, **kwargs):
196addbf 2443 """ImageFromStream(InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> Image"""
54f9ee45 2444 val = _core_.new_ImageFromStream(*args, **kwargs)
d14a1e28
RD
2445 val.thisown = 1
2446 return val
2447
2448def ImageFromStreamMime(*args, **kwargs):
196addbf 2449 """ImageFromStreamMime(InputStream stream, String mimetype, int index=-1) -> Image"""
54f9ee45 2450 val = _core_.new_ImageFromStreamMime(*args, **kwargs)
d14a1e28
RD
2451 val.thisown = 1
2452 return val
2453
66c033b4
RD
2454def EmptyImage(*args, **kwargs):
2455 """EmptyImage(int width=0, int height=0, bool clear=True) -> Image"""
2456 val = _core_.new_EmptyImage(*args, **kwargs)
d14a1e28
RD
2457 val.thisown = 1
2458 return val
2459
2460def ImageFromBitmap(*args, **kwargs):
196addbf 2461 """ImageFromBitmap(Bitmap bitmap) -> Image"""
54f9ee45 2462 val = _core_.new_ImageFromBitmap(*args, **kwargs)
d14a1e28
RD
2463 val.thisown = 1
2464 return val
2465
2466def ImageFromData(*args, **kwargs):
e811c8ce 2467 """ImageFromData(int width, int height, unsigned char data) -> Image"""
54f9ee45 2468 val = _core_.new_ImageFromData(*args, **kwargs)
d14a1e28
RD
2469 val.thisown = 1
2470 return val
2471
1823fbb4
RD
2472def ImageFromDataWithAlpha(*args, **kwargs):
2473 """ImageFromDataWithAlpha(int width, int height, unsigned char data, unsigned char alpha) -> Image"""
2474 val = _core_.new_ImageFromDataWithAlpha(*args, **kwargs)
2475 val.thisown = 1
2476 return val
2477
e811c8ce 2478def Image_CanRead(*args, **kwargs):
196addbf 2479 """Image_CanRead(String name) -> bool"""
54f9ee45 2480 return _core_.Image_CanRead(*args, **kwargs)
d14a1e28 2481
e811c8ce 2482def Image_GetImageCount(*args, **kwargs):
196addbf 2483 """Image_GetImageCount(String name, long type=BITMAP_TYPE_ANY) -> int"""
54f9ee45 2484 return _core_.Image_GetImageCount(*args, **kwargs)
d14a1e28 2485
e811c8ce 2486def Image_CanReadStream(*args, **kwargs):
196addbf 2487 """Image_CanReadStream(InputStream stream) -> bool"""
54f9ee45 2488 return _core_.Image_CanReadStream(*args, **kwargs)
d14a1e28 2489
e811c8ce
RD
2490def Image_AddHandler(*args, **kwargs):
2491 """Image_AddHandler(ImageHandler handler)"""
54f9ee45 2492 return _core_.Image_AddHandler(*args, **kwargs)
d14a1e28 2493
e811c8ce
RD
2494def Image_InsertHandler(*args, **kwargs):
2495 """Image_InsertHandler(ImageHandler handler)"""
54f9ee45 2496 return _core_.Image_InsertHandler(*args, **kwargs)
d14a1e28 2497
e811c8ce 2498def Image_RemoveHandler(*args, **kwargs):
196addbf 2499 """Image_RemoveHandler(String name) -> bool"""
54f9ee45 2500 return _core_.Image_RemoveHandler(*args, **kwargs)
d14a1e28 2501
e811c8ce 2502def Image_GetImageExtWildcard(*args, **kwargs):
196addbf 2503 """Image_GetImageExtWildcard() -> String"""
54f9ee45 2504 return _core_.Image_GetImageExtWildcard(*args, **kwargs)
d14a1e28 2505
5e4ca4a8
RD
2506def InitAllImageHandlers():
2507 """
2508 The former functionality of InitAllImageHanders is now done internal to
2509 the _core_ extension module and so this function has become a simple NOP.
2510 """
2511 pass
d14a1e28 2512
54f9ee45
RD
2513IMAGE_RESOLUTION_INCHES = _core_.IMAGE_RESOLUTION_INCHES
2514IMAGE_RESOLUTION_CM = _core_.IMAGE_RESOLUTION_CM
2515BMP_24BPP = _core_.BMP_24BPP
2516BMP_8BPP = _core_.BMP_8BPP
2517BMP_8BPP_GREY = _core_.BMP_8BPP_GREY
2518BMP_8BPP_GRAY = _core_.BMP_8BPP_GRAY
2519BMP_8BPP_RED = _core_.BMP_8BPP_RED
2520BMP_8BPP_PALETTE = _core_.BMP_8BPP_PALETTE
2521BMP_4BPP = _core_.BMP_4BPP
2522BMP_1BPP = _core_.BMP_1BPP
2523BMP_1BPP_BW = _core_.BMP_1BPP_BW
d14a1e28 2524class BMPHandler(ImageHandler):
093d3ff1 2525 """Proxy of C++ BMPHandler class"""
e811c8ce
RD
2526 def __repr__(self):
2527 return "<%s.%s; proxy of C++ wxBMPHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2528 def __init__(self, *args, **kwargs):
a95a7133 2529 """__init__(self) -> BMPHandler"""
54f9ee45 2530 newobj = _core_.new_BMPHandler(*args, **kwargs)
d14a1e28
RD
2531 self.this = newobj.this
2532 self.thisown = 1
2533 del newobj.thisown
d14a1e28
RD
2534
2535class BMPHandlerPtr(BMPHandler):
2536 def __init__(self, this):
2537 self.this = this
2538 if not hasattr(self,"thisown"): self.thisown = 0
2539 self.__class__ = BMPHandler
54f9ee45 2540_core_.BMPHandler_swigregister(BMPHandlerPtr)
d14a1e28
RD
2541NullImage = cvar.NullImage
2542IMAGE_OPTION_BMP_FORMAT = cvar.IMAGE_OPTION_BMP_FORMAT
2543IMAGE_OPTION_CUR_HOTSPOT_X = cvar.IMAGE_OPTION_CUR_HOTSPOT_X
2544IMAGE_OPTION_CUR_HOTSPOT_Y = cvar.IMAGE_OPTION_CUR_HOTSPOT_Y
2545IMAGE_OPTION_RESOLUTION = cvar.IMAGE_OPTION_RESOLUTION
2546IMAGE_OPTION_RESOLUTIONUNIT = cvar.IMAGE_OPTION_RESOLUTIONUNIT
2547
2548class ICOHandler(BMPHandler):
093d3ff1 2549 """Proxy of C++ ICOHandler class"""
e811c8ce
RD
2550 def __repr__(self):
2551 return "<%s.%s; proxy of C++ wxICOHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2552 def __init__(self, *args, **kwargs):
a95a7133 2553 """__init__(self) -> ICOHandler"""
54f9ee45 2554 newobj = _core_.new_ICOHandler(*args, **kwargs)
d14a1e28
RD
2555 self.this = newobj.this
2556 self.thisown = 1
2557 del newobj.thisown
d14a1e28
RD
2558
2559class ICOHandlerPtr(ICOHandler):
2560 def __init__(self, this):
2561 self.this = this
2562 if not hasattr(self,"thisown"): self.thisown = 0
2563 self.__class__ = ICOHandler
54f9ee45 2564_core_.ICOHandler_swigregister(ICOHandlerPtr)
d14a1e28
RD
2565
2566class CURHandler(ICOHandler):
093d3ff1 2567 """Proxy of C++ CURHandler class"""
e811c8ce
RD
2568 def __repr__(self):
2569 return "<%s.%s; proxy of C++ wxCURHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2570 def __init__(self, *args, **kwargs):
a95a7133 2571 """__init__(self) -> CURHandler"""
54f9ee45 2572 newobj = _core_.new_CURHandler(*args, **kwargs)
d14a1e28
RD
2573 self.this = newobj.this
2574 self.thisown = 1
2575 del newobj.thisown
d14a1e28
RD
2576
2577class CURHandlerPtr(CURHandler):
2578 def __init__(self, this):
2579 self.this = this
2580 if not hasattr(self,"thisown"): self.thisown = 0
2581 self.__class__ = CURHandler
54f9ee45 2582_core_.CURHandler_swigregister(CURHandlerPtr)
d14a1e28
RD
2583
2584class ANIHandler(CURHandler):
093d3ff1 2585 """Proxy of C++ ANIHandler class"""
e811c8ce
RD
2586 def __repr__(self):
2587 return "<%s.%s; proxy of C++ wxANIHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2588 def __init__(self, *args, **kwargs):
a95a7133 2589 """__init__(self) -> ANIHandler"""
54f9ee45 2590 newobj = _core_.new_ANIHandler(*args, **kwargs)
d14a1e28
RD
2591 self.this = newobj.this
2592 self.thisown = 1
2593 del newobj.thisown
d14a1e28
RD
2594
2595class ANIHandlerPtr(ANIHandler):
2596 def __init__(self, this):
2597 self.this = this
2598 if not hasattr(self,"thisown"): self.thisown = 0
2599 self.__class__ = ANIHandler
54f9ee45 2600_core_.ANIHandler_swigregister(ANIHandlerPtr)
d14a1e28
RD
2601
2602class PNGHandler(ImageHandler):
093d3ff1 2603 """Proxy of C++ PNGHandler class"""
e811c8ce
RD
2604 def __repr__(self):
2605 return "<%s.%s; proxy of C++ wxPNGHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2606 def __init__(self, *args, **kwargs):
a95a7133 2607 """__init__(self) -> PNGHandler"""
54f9ee45 2608 newobj = _core_.new_PNGHandler(*args, **kwargs)
d14a1e28
RD
2609 self.this = newobj.this
2610 self.thisown = 1
2611 del newobj.thisown
d14a1e28
RD
2612
2613class PNGHandlerPtr(PNGHandler):
2614 def __init__(self, this):
2615 self.this = this
2616 if not hasattr(self,"thisown"): self.thisown = 0
2617 self.__class__ = PNGHandler
54f9ee45 2618_core_.PNGHandler_swigregister(PNGHandlerPtr)
d14a1e28
RD
2619
2620class GIFHandler(ImageHandler):
093d3ff1 2621 """Proxy of C++ GIFHandler class"""
e811c8ce
RD
2622 def __repr__(self):
2623 return "<%s.%s; proxy of C++ wxGIFHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2624 def __init__(self, *args, **kwargs):
a95a7133 2625 """__init__(self) -> GIFHandler"""
54f9ee45 2626 newobj = _core_.new_GIFHandler(*args, **kwargs)
d14a1e28
RD
2627 self.this = newobj.this
2628 self.thisown = 1
2629 del newobj.thisown
d14a1e28
RD
2630
2631class GIFHandlerPtr(GIFHandler):
2632 def __init__(self, this):
2633 self.this = this
2634 if not hasattr(self,"thisown"): self.thisown = 0
2635 self.__class__ = GIFHandler
54f9ee45 2636_core_.GIFHandler_swigregister(GIFHandlerPtr)
d14a1e28
RD
2637
2638class PCXHandler(ImageHandler):
093d3ff1 2639 """Proxy of C++ PCXHandler class"""
e811c8ce
RD
2640 def __repr__(self):
2641 return "<%s.%s; proxy of C++ wxPCXHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2642 def __init__(self, *args, **kwargs):
a95a7133 2643 """__init__(self) -> PCXHandler"""
54f9ee45 2644 newobj = _core_.new_PCXHandler(*args, **kwargs)
d14a1e28
RD
2645 self.this = newobj.this
2646 self.thisown = 1
2647 del newobj.thisown
d14a1e28
RD
2648
2649class PCXHandlerPtr(PCXHandler):
2650 def __init__(self, this):
2651 self.this = this
2652 if not hasattr(self,"thisown"): self.thisown = 0
2653 self.__class__ = PCXHandler
54f9ee45 2654_core_.PCXHandler_swigregister(PCXHandlerPtr)
d14a1e28
RD
2655
2656class JPEGHandler(ImageHandler):
093d3ff1 2657 """Proxy of C++ JPEGHandler class"""
e811c8ce
RD
2658 def __repr__(self):
2659 return "<%s.%s; proxy of C++ wxJPEGHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2660 def __init__(self, *args, **kwargs):
a95a7133 2661 """__init__(self) -> JPEGHandler"""
54f9ee45 2662 newobj = _core_.new_JPEGHandler(*args, **kwargs)
d14a1e28
RD
2663 self.this = newobj.this
2664 self.thisown = 1
2665 del newobj.thisown
d14a1e28
RD
2666
2667class JPEGHandlerPtr(JPEGHandler):
2668 def __init__(self, this):
2669 self.this = this
2670 if not hasattr(self,"thisown"): self.thisown = 0
2671 self.__class__ = JPEGHandler
54f9ee45 2672_core_.JPEGHandler_swigregister(JPEGHandlerPtr)
d14a1e28
RD
2673
2674class PNMHandler(ImageHandler):
093d3ff1 2675 """Proxy of C++ PNMHandler class"""
e811c8ce
RD
2676 def __repr__(self):
2677 return "<%s.%s; proxy of C++ wxPNMHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2678 def __init__(self, *args, **kwargs):
a95a7133 2679 """__init__(self) -> PNMHandler"""
54f9ee45 2680 newobj = _core_.new_PNMHandler(*args, **kwargs)
d14a1e28
RD
2681 self.this = newobj.this
2682 self.thisown = 1
2683 del newobj.thisown
d14a1e28
RD
2684
2685class PNMHandlerPtr(PNMHandler):
2686 def __init__(self, this):
2687 self.this = this
2688 if not hasattr(self,"thisown"): self.thisown = 0
2689 self.__class__ = PNMHandler
54f9ee45 2690_core_.PNMHandler_swigregister(PNMHandlerPtr)
d14a1e28
RD
2691
2692class XPMHandler(ImageHandler):
093d3ff1 2693 """Proxy of C++ XPMHandler class"""
e811c8ce
RD
2694 def __repr__(self):
2695 return "<%s.%s; proxy of C++ wxXPMHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2696 def __init__(self, *args, **kwargs):
a95a7133 2697 """__init__(self) -> XPMHandler"""
54f9ee45 2698 newobj = _core_.new_XPMHandler(*args, **kwargs)
d14a1e28
RD
2699 self.this = newobj.this
2700 self.thisown = 1
2701 del newobj.thisown
d14a1e28
RD
2702
2703class XPMHandlerPtr(XPMHandler):
2704 def __init__(self, this):
2705 self.this = this
2706 if not hasattr(self,"thisown"): self.thisown = 0
2707 self.__class__ = XPMHandler
54f9ee45 2708_core_.XPMHandler_swigregister(XPMHandlerPtr)
d14a1e28
RD
2709
2710class TIFFHandler(ImageHandler):
093d3ff1 2711 """Proxy of C++ TIFFHandler class"""
e811c8ce
RD
2712 def __repr__(self):
2713 return "<%s.%s; proxy of C++ wxTIFFHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2714 def __init__(self, *args, **kwargs):
a95a7133 2715 """__init__(self) -> TIFFHandler"""
54f9ee45 2716 newobj = _core_.new_TIFFHandler(*args, **kwargs)
d14a1e28
RD
2717 self.this = newobj.this
2718 self.thisown = 1
2719 del newobj.thisown
d14a1e28
RD
2720
2721class TIFFHandlerPtr(TIFFHandler):
2722 def __init__(self, this):
2723 self.this = this
2724 if not hasattr(self,"thisown"): self.thisown = 0
2725 self.__class__ = TIFFHandler
54f9ee45 2726_core_.TIFFHandler_swigregister(TIFFHandlerPtr)
d14a1e28 2727
c0de73ae
RD
2728QUANTIZE_INCLUDE_WINDOWS_COLOURS = _core_.QUANTIZE_INCLUDE_WINDOWS_COLOURS
2729QUANTIZE_FILL_DESTINATION_IMAGE = _core_.QUANTIZE_FILL_DESTINATION_IMAGE
2730class Quantize(object):
2731 """Performs quantization, or colour reduction, on a wxImage."""
2732 def __init__(self): raise RuntimeError, "No constructor defined"
2733 def __repr__(self):
2734 return "<%s.%s; proxy of C++ wxQuantize instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2735 def Quantize(*args, **kwargs):
2736 """
2737 Quantize(Image src, Image dest, int desiredNoColours=236, int flags=wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE) -> bool
2738
2739 Reduce the colours in the source image and put the result into the
2740 destination image, setting the palette in the destination if
2741 needed. Both images may be the same, to overwrite the source image.
2742 """
2743 return _core_.Quantize_Quantize(*args, **kwargs)
2744
2745 Quantize = staticmethod(Quantize)
2746
2747class QuantizePtr(Quantize):
2748 def __init__(self, this):
2749 self.this = this
2750 if not hasattr(self,"thisown"): self.thisown = 0
2751 self.__class__ = Quantize
2752_core_.Quantize_swigregister(QuantizePtr)
2753
2754def Quantize_Quantize(*args, **kwargs):
2755 """
2756 Quantize_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
d14a1e28
RD
2764#---------------------------------------------------------------------------
2765
2766class EvtHandler(Object):
093d3ff1 2767 """Proxy of C++ EvtHandler class"""
e811c8ce
RD
2768 def __repr__(self):
2769 return "<%s.%s; proxy of C++ wxEvtHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2770 def __init__(self, *args, **kwargs):
a95a7133 2771 """__init__(self) -> EvtHandler"""
54f9ee45 2772 newobj = _core_.new_EvtHandler(*args, **kwargs)
d14a1e28
RD
2773 self.this = newobj.this
2774 self.thisown = 1
2775 del newobj.thisown
e811c8ce 2776 def GetNextHandler(*args, **kwargs):
a95a7133 2777 """GetNextHandler(self) -> EvtHandler"""
54f9ee45 2778 return _core_.EvtHandler_GetNextHandler(*args, **kwargs)
e811c8ce
RD
2779
2780 def GetPreviousHandler(*args, **kwargs):
a95a7133 2781 """GetPreviousHandler(self) -> EvtHandler"""
54f9ee45 2782 return _core_.EvtHandler_GetPreviousHandler(*args, **kwargs)
e811c8ce
RD
2783
2784 def SetNextHandler(*args, **kwargs):
a95a7133 2785 """SetNextHandler(self, EvtHandler handler)"""
54f9ee45 2786 return _core_.EvtHandler_SetNextHandler(*args, **kwargs)
e811c8ce
RD
2787
2788 def SetPreviousHandler(*args, **kwargs):
a95a7133 2789 """SetPreviousHandler(self, EvtHandler handler)"""
54f9ee45 2790 return _core_.EvtHandler_SetPreviousHandler(*args, **kwargs)
e811c8ce
RD
2791
2792 def GetEvtHandlerEnabled(*args, **kwargs):
a95a7133 2793 """GetEvtHandlerEnabled(self) -> bool"""
54f9ee45 2794 return _core_.EvtHandler_GetEvtHandlerEnabled(*args, **kwargs)
e811c8ce
RD
2795
2796 def SetEvtHandlerEnabled(*args, **kwargs):
a95a7133 2797 """SetEvtHandlerEnabled(self, bool enabled)"""
54f9ee45 2798 return _core_.EvtHandler_SetEvtHandlerEnabled(*args, **kwargs)
e811c8ce
RD
2799
2800 def ProcessEvent(*args, **kwargs):
a95a7133 2801 """ProcessEvent(self, Event event) -> bool"""
54f9ee45 2802 return _core_.EvtHandler_ProcessEvent(*args, **kwargs)
e811c8ce
RD
2803
2804 def AddPendingEvent(*args, **kwargs):
a95a7133 2805 """AddPendingEvent(self, Event event)"""
54f9ee45 2806 return _core_.EvtHandler_AddPendingEvent(*args, **kwargs)
e811c8ce
RD
2807
2808 def ProcessPendingEvents(*args, **kwargs):
a95a7133 2809 """ProcessPendingEvents(self)"""
54f9ee45 2810 return _core_.EvtHandler_ProcessPendingEvents(*args, **kwargs)
e811c8ce
RD
2811
2812 def Connect(*args, **kwargs):
a95a7133 2813 """Connect(self, int id, int lastId, int eventType, PyObject func)"""
54f9ee45 2814 return _core_.EvtHandler_Connect(*args, **kwargs)
e811c8ce
RD
2815
2816 def Disconnect(*args, **kwargs):
a95a7133 2817 """Disconnect(self, int id, int lastId=-1, wxEventType eventType=wxEVT_NULL) -> bool"""
54f9ee45 2818 return _core_.EvtHandler_Disconnect(*args, **kwargs)
e811c8ce
RD
2819
2820 def _setOORInfo(*args, **kwargs):
689b42ee 2821 """_setOORInfo(self, PyObject _self, bool incref=True)"""
54f9ee45 2822 return _core_.EvtHandler__setOORInfo(*args, **kwargs)
e811c8ce 2823
d14a1e28
RD
2824 def Bind(self, event, handler, source=None, id=wx.ID_ANY, id2=wx.ID_ANY):
2825 """
2826 Bind an event to an event handler.
2827
db3e571a
RD
2828 :param event: One of the EVT_* objects that specifies the
2829 type of event to bind,
d14a1e28 2830
db3e571a
RD
2831 :param handler: A callable object to be invoked when the
2832 event is delivered to self. Pass None to
2833 disconnect an event handler.
d14a1e28 2834
db3e571a
RD
2835 :param source: Sometimes the event originates from a
2836 different window than self, but you still
2837 want to catch it in self. (For example, a
2838 button event delivered to a frame.) By
2839 passing the source of the event, the event
2840 handling system is able to differentiate
2841 between the same event type from different
2842 controls.
d14a1e28 2843
db3e571a
RD
2844 :param id: Used to spcify the event source by ID instead
2845 of instance.
2846
2847 :param id2: Used when it is desirable to bind a handler
2848 to a range of IDs, such as with EVT_MENU_RANGE.
d14a1e28
RD
2849 """
2850 if source is not None:
2851 id = source.GetId()
2852 event.Bind(self, id, id2, handler)
2853
66c033b4
RD
2854 def Unbind(self, event, source=None, id=wx.ID_ANY, id2=wx.ID_ANY):
2855 """
2856 Disconencts the event handler binding for event from self.
2857 Returns True if successful.
2858 """
2859 if source is not None:
2860 id = source.GetId()
2861 return event.Unbind(self, id, id2)
d14a1e28 2862
d14a1e28
RD
2863
2864class EvtHandlerPtr(EvtHandler):
2865 def __init__(self, this):
2866 self.this = this
2867 if not hasattr(self,"thisown"): self.thisown = 0
2868 self.__class__ = EvtHandler
54f9ee45 2869_core_.EvtHandler_swigregister(EvtHandlerPtr)
d14a1e28
RD
2870
2871#---------------------------------------------------------------------------
2872
2873class PyEventBinder(object):
2874 """
2875 Instances of this class are used to bind specific events to event
2876 handlers.
2877 """
2878 def __init__(self, evtType, expectedIDs=0):
2879 if expectedIDs not in [0, 1, 2]:
2880 raise ValueError, "Invalid number of expectedIDs"
2881 self.expectedIDs = expectedIDs
2882
2883 if type(evtType) == list or type(evtType) == tuple:
2884 self.evtType = evtType
2885 else:
2886 self.evtType = [evtType]
2887
2888
2889 def Bind(self, target, id1, id2, function):
2890 """Bind this set of event types to target."""
2891 for et in self.evtType:
2892 target.Connect(id1, id2, et, function)
2893
66c033b4
RD
2894
2895 def Unbind(self, target, id1, id2):
2896 """Remove an event binding."""
2897 success = 0
2898 for et in self.evtType:
2899 success += target.Disconnect(id1, id2, et)
2900 return success != 0
2901
d14a1e28
RD
2902
2903 def __call__(self, *args):
2904 """
2905 For backwards compatibility with the old EVT_* functions.
2906 Should be called with either (window, func), (window, ID,
2907 func) or (window, ID1, ID2, func) parameters depending on the
2908 type of the event.
2909 """
2910 assert len(args) == 2 + self.expectedIDs
2911 id1 = wx.ID_ANY
2912 id2 = wx.ID_ANY
2913 target = args[0]
2914 if self.expectedIDs == 0:
2915 func = args[1]
2916 elif self.expectedIDs == 1:
2917 id1 = args[1]
2918 func = args[2]
2919 elif self.expectedIDs == 2:
2920 id1 = args[1]
2921 id2 = args[2]
2922 func = args[3]
2923 else:
2924 raise ValueError, "Unexpected number of IDs"
2925
2926 self.Bind(target, id1, id2, func)
2927
2928
2929# These two are square pegs that don't fit the PyEventBinder hole...
2930def EVT_COMMAND(win, id, cmd, func):
2931 win.Connect(id, -1, cmd, func)
2932def EVT_COMMAND_RANGE(win, id1, id2, cmd, func):
2933 win.Connect(id1, id2, cmd, func)
2934
2935
2936#---------------------------------------------------------------------------
2937
2938#---------------------------------------------------------------------------
2939
54f9ee45
RD
2940EVENT_PROPAGATE_NONE = _core_.EVENT_PROPAGATE_NONE
2941EVENT_PROPAGATE_MAX = _core_.EVENT_PROPAGATE_MAX
d14a1e28 2942
e811c8ce
RD
2943def NewEventType(*args, **kwargs):
2944 """NewEventType() -> wxEventType"""
54f9ee45
RD
2945 return _core_.NewEventType(*args, **kwargs)
2946wxEVT_NULL = _core_.wxEVT_NULL
2947wxEVT_FIRST = _core_.wxEVT_FIRST
2948wxEVT_USER_FIRST = _core_.wxEVT_USER_FIRST
2949wxEVT_COMMAND_BUTTON_CLICKED = _core_.wxEVT_COMMAND_BUTTON_CLICKED
2950wxEVT_COMMAND_CHECKBOX_CLICKED = _core_.wxEVT_COMMAND_CHECKBOX_CLICKED
2951wxEVT_COMMAND_CHOICE_SELECTED = _core_.wxEVT_COMMAND_CHOICE_SELECTED
2952wxEVT_COMMAND_LISTBOX_SELECTED = _core_.wxEVT_COMMAND_LISTBOX_SELECTED
2953wxEVT_COMMAND_LISTBOX_DOUBLECLICKED = _core_.wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
2954wxEVT_COMMAND_CHECKLISTBOX_TOGGLED = _core_.wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
2955wxEVT_COMMAND_MENU_SELECTED = _core_.wxEVT_COMMAND_MENU_SELECTED
2956wxEVT_COMMAND_TOOL_CLICKED = _core_.wxEVT_COMMAND_TOOL_CLICKED
2957wxEVT_COMMAND_SLIDER_UPDATED = _core_.wxEVT_COMMAND_SLIDER_UPDATED
2958wxEVT_COMMAND_RADIOBOX_SELECTED = _core_.wxEVT_COMMAND_RADIOBOX_SELECTED
2959wxEVT_COMMAND_RADIOBUTTON_SELECTED = _core_.wxEVT_COMMAND_RADIOBUTTON_SELECTED
2960wxEVT_COMMAND_SCROLLBAR_UPDATED = _core_.wxEVT_COMMAND_SCROLLBAR_UPDATED
2961wxEVT_COMMAND_VLBOX_SELECTED = _core_.wxEVT_COMMAND_VLBOX_SELECTED
2962wxEVT_COMMAND_COMBOBOX_SELECTED = _core_.wxEVT_COMMAND_COMBOBOX_SELECTED
2963wxEVT_COMMAND_TOOL_RCLICKED = _core_.wxEVT_COMMAND_TOOL_RCLICKED
2964wxEVT_COMMAND_TOOL_ENTER = _core_.wxEVT_COMMAND_TOOL_ENTER
2965wxEVT_LEFT_DOWN = _core_.wxEVT_LEFT_DOWN
2966wxEVT_LEFT_UP = _core_.wxEVT_LEFT_UP
2967wxEVT_MIDDLE_DOWN = _core_.wxEVT_MIDDLE_DOWN
2968wxEVT_MIDDLE_UP = _core_.wxEVT_MIDDLE_UP
2969wxEVT_RIGHT_DOWN = _core_.wxEVT_RIGHT_DOWN
2970wxEVT_RIGHT_UP = _core_.wxEVT_RIGHT_UP
2971wxEVT_MOTION = _core_.wxEVT_MOTION
2972wxEVT_ENTER_WINDOW = _core_.wxEVT_ENTER_WINDOW
2973wxEVT_LEAVE_WINDOW = _core_.wxEVT_LEAVE_WINDOW
2974wxEVT_LEFT_DCLICK = _core_.wxEVT_LEFT_DCLICK
2975wxEVT_MIDDLE_DCLICK = _core_.wxEVT_MIDDLE_DCLICK
2976wxEVT_RIGHT_DCLICK = _core_.wxEVT_RIGHT_DCLICK
2977wxEVT_SET_FOCUS = _core_.wxEVT_SET_FOCUS
2978wxEVT_KILL_FOCUS = _core_.wxEVT_KILL_FOCUS
2979wxEVT_CHILD_FOCUS = _core_.wxEVT_CHILD_FOCUS
2980wxEVT_MOUSEWHEEL = _core_.wxEVT_MOUSEWHEEL
2981wxEVT_NC_LEFT_DOWN = _core_.wxEVT_NC_LEFT_DOWN
2982wxEVT_NC_LEFT_UP = _core_.wxEVT_NC_LEFT_UP
2983wxEVT_NC_MIDDLE_DOWN = _core_.wxEVT_NC_MIDDLE_DOWN
2984wxEVT_NC_MIDDLE_UP = _core_.wxEVT_NC_MIDDLE_UP
2985wxEVT_NC_RIGHT_DOWN = _core_.wxEVT_NC_RIGHT_DOWN
2986wxEVT_NC_RIGHT_UP = _core_.wxEVT_NC_RIGHT_UP
2987wxEVT_NC_MOTION = _core_.wxEVT_NC_MOTION
2988wxEVT_NC_ENTER_WINDOW = _core_.wxEVT_NC_ENTER_WINDOW
2989wxEVT_NC_LEAVE_WINDOW = _core_.wxEVT_NC_LEAVE_WINDOW
2990wxEVT_NC_LEFT_DCLICK = _core_.wxEVT_NC_LEFT_DCLICK
2991wxEVT_NC_MIDDLE_DCLICK = _core_.wxEVT_NC_MIDDLE_DCLICK
2992wxEVT_NC_RIGHT_DCLICK = _core_.wxEVT_NC_RIGHT_DCLICK
2993wxEVT_CHAR = _core_.wxEVT_CHAR
2994wxEVT_CHAR_HOOK = _core_.wxEVT_CHAR_HOOK
2995wxEVT_NAVIGATION_KEY = _core_.wxEVT_NAVIGATION_KEY
2996wxEVT_KEY_DOWN = _core_.wxEVT_KEY_DOWN
2997wxEVT_KEY_UP = _core_.wxEVT_KEY_UP
2998wxEVT_HOTKEY = _core_.wxEVT_HOTKEY
2999wxEVT_SET_CURSOR = _core_.wxEVT_SET_CURSOR
3000wxEVT_SCROLL_TOP = _core_.wxEVT_SCROLL_TOP
3001wxEVT_SCROLL_BOTTOM = _core_.wxEVT_SCROLL_BOTTOM
3002wxEVT_SCROLL_LINEUP = _core_.wxEVT_SCROLL_LINEUP
3003wxEVT_SCROLL_LINEDOWN = _core_.wxEVT_SCROLL_LINEDOWN
3004wxEVT_SCROLL_PAGEUP = _core_.wxEVT_SCROLL_PAGEUP
3005wxEVT_SCROLL_PAGEDOWN = _core_.wxEVT_SCROLL_PAGEDOWN
3006wxEVT_SCROLL_THUMBTRACK = _core_.wxEVT_SCROLL_THUMBTRACK
3007wxEVT_SCROLL_THUMBRELEASE = _core_.wxEVT_SCROLL_THUMBRELEASE
3008wxEVT_SCROLL_ENDSCROLL = _core_.wxEVT_SCROLL_ENDSCROLL
3009wxEVT_SCROLLWIN_TOP = _core_.wxEVT_SCROLLWIN_TOP
3010wxEVT_SCROLLWIN_BOTTOM = _core_.wxEVT_SCROLLWIN_BOTTOM
3011wxEVT_SCROLLWIN_LINEUP = _core_.wxEVT_SCROLLWIN_LINEUP
3012wxEVT_SCROLLWIN_LINEDOWN = _core_.wxEVT_SCROLLWIN_LINEDOWN
3013wxEVT_SCROLLWIN_PAGEUP = _core_.wxEVT_SCROLLWIN_PAGEUP
3014wxEVT_SCROLLWIN_PAGEDOWN = _core_.wxEVT_SCROLLWIN_PAGEDOWN
3015wxEVT_SCROLLWIN_THUMBTRACK = _core_.wxEVT_SCROLLWIN_THUMBTRACK
3016wxEVT_SCROLLWIN_THUMBRELEASE = _core_.wxEVT_SCROLLWIN_THUMBRELEASE
3017wxEVT_SIZE = _core_.wxEVT_SIZE
3018wxEVT_MOVE = _core_.wxEVT_MOVE
3019wxEVT_CLOSE_WINDOW = _core_.wxEVT_CLOSE_WINDOW
3020wxEVT_END_SESSION = _core_.wxEVT_END_SESSION
3021wxEVT_QUERY_END_SESSION = _core_.wxEVT_QUERY_END_SESSION
3022wxEVT_ACTIVATE_APP = _core_.wxEVT_ACTIVATE_APP
3023wxEVT_POWER = _core_.wxEVT_POWER
3024wxEVT_ACTIVATE = _core_.wxEVT_ACTIVATE
3025wxEVT_CREATE = _core_.wxEVT_CREATE
3026wxEVT_DESTROY = _core_.wxEVT_DESTROY
3027wxEVT_SHOW = _core_.wxEVT_SHOW
3028wxEVT_ICONIZE = _core_.wxEVT_ICONIZE
3029wxEVT_MAXIMIZE = _core_.wxEVT_MAXIMIZE
3030wxEVT_MOUSE_CAPTURE_CHANGED = _core_.wxEVT_MOUSE_CAPTURE_CHANGED
3031wxEVT_PAINT = _core_.wxEVT_PAINT
3032wxEVT_ERASE_BACKGROUND = _core_.wxEVT_ERASE_BACKGROUND
3033wxEVT_NC_PAINT = _core_.wxEVT_NC_PAINT
3034wxEVT_PAINT_ICON = _core_.wxEVT_PAINT_ICON
3035wxEVT_MENU_OPEN = _core_.wxEVT_MENU_OPEN
3036wxEVT_MENU_CLOSE = _core_.wxEVT_MENU_CLOSE
3037wxEVT_MENU_HIGHLIGHT = _core_.wxEVT_MENU_HIGHLIGHT
3038wxEVT_CONTEXT_MENU = _core_.wxEVT_CONTEXT_MENU
3039wxEVT_SYS_COLOUR_CHANGED = _core_.wxEVT_SYS_COLOUR_CHANGED
3040wxEVT_DISPLAY_CHANGED = _core_.wxEVT_DISPLAY_CHANGED
3041wxEVT_SETTING_CHANGED = _core_.wxEVT_SETTING_CHANGED
3042wxEVT_QUERY_NEW_PALETTE = _core_.wxEVT_QUERY_NEW_PALETTE
3043wxEVT_PALETTE_CHANGED = _core_.wxEVT_PALETTE_CHANGED
3044wxEVT_DROP_FILES = _core_.wxEVT_DROP_FILES
3045wxEVT_DRAW_ITEM = _core_.wxEVT_DRAW_ITEM
3046wxEVT_MEASURE_ITEM = _core_.wxEVT_MEASURE_ITEM
3047wxEVT_COMPARE_ITEM = _core_.wxEVT_COMPARE_ITEM
3048wxEVT_INIT_DIALOG = _core_.wxEVT_INIT_DIALOG
3049wxEVT_IDLE = _core_.wxEVT_IDLE
3050wxEVT_UPDATE_UI = _core_.wxEVT_UPDATE_UI
3051wxEVT_SIZING = _core_.wxEVT_SIZING
3052wxEVT_MOVING = _core_.wxEVT_MOVING
3053wxEVT_COMMAND_LEFT_CLICK = _core_.wxEVT_COMMAND_LEFT_CLICK
3054wxEVT_COMMAND_LEFT_DCLICK = _core_.wxEVT_COMMAND_LEFT_DCLICK
3055wxEVT_COMMAND_RIGHT_CLICK = _core_.wxEVT_COMMAND_RIGHT_CLICK
3056wxEVT_COMMAND_RIGHT_DCLICK = _core_.wxEVT_COMMAND_RIGHT_DCLICK
3057wxEVT_COMMAND_SET_FOCUS = _core_.wxEVT_COMMAND_SET_FOCUS
3058wxEVT_COMMAND_KILL_FOCUS = _core_.wxEVT_COMMAND_KILL_FOCUS
3059wxEVT_COMMAND_ENTER = _core_.wxEVT_COMMAND_ENTER
d14a1e28
RD
3060#
3061# Create some event binders
3062EVT_SIZE = wx.PyEventBinder( wxEVT_SIZE )
3063EVT_SIZING = wx.PyEventBinder( wxEVT_SIZING )
3064EVT_MOVE = wx.PyEventBinder( wxEVT_MOVE )
3065EVT_MOVING = wx.PyEventBinder( wxEVT_MOVING )
3066EVT_CLOSE = wx.PyEventBinder( wxEVT_CLOSE_WINDOW )
3067EVT_END_SESSION = wx.PyEventBinder( wxEVT_END_SESSION )
3068EVT_QUERY_END_SESSION = wx.PyEventBinder( wxEVT_QUERY_END_SESSION )
3069EVT_PAINT = wx.PyEventBinder( wxEVT_PAINT )
3070EVT_NC_PAINT = wx.PyEventBinder( wxEVT_NC_PAINT )
3071EVT_ERASE_BACKGROUND = wx.PyEventBinder( wxEVT_ERASE_BACKGROUND )
3072EVT_CHAR = wx.PyEventBinder( wxEVT_CHAR )
3073EVT_KEY_DOWN = wx.PyEventBinder( wxEVT_KEY_DOWN )
3074EVT_KEY_UP = wx.PyEventBinder( wxEVT_KEY_UP )
3075EVT_HOTKEY = wx.PyEventBinder( wxEVT_HOTKEY, 1)
3076EVT_CHAR_HOOK = wx.PyEventBinder( wxEVT_CHAR_HOOK )
3077EVT_MENU_OPEN = wx.PyEventBinder( wxEVT_MENU_OPEN )
3078EVT_MENU_CLOSE = wx.PyEventBinder( wxEVT_MENU_CLOSE )
3079EVT_MENU_HIGHLIGHT = wx.PyEventBinder( wxEVT_MENU_HIGHLIGHT, 1)
3080EVT_MENU_HIGHLIGHT_ALL = wx.PyEventBinder( wxEVT_MENU_HIGHLIGHT )
3081EVT_SET_FOCUS = wx.PyEventBinder( wxEVT_SET_FOCUS )
3082EVT_KILL_FOCUS = wx.PyEventBinder( wxEVT_KILL_FOCUS )
3083EVT_CHILD_FOCUS = wx.PyEventBinder( wxEVT_CHILD_FOCUS )
3084EVT_ACTIVATE = wx.PyEventBinder( wxEVT_ACTIVATE )
3085EVT_ACTIVATE_APP = wx.PyEventBinder( wxEVT_ACTIVATE_APP )
3086EVT_END_SESSION = wx.PyEventBinder( wxEVT_END_SESSION )
3087EVT_QUERY_END_SESSION = wx.PyEventBinder( wxEVT_QUERY_END_SESSION )
3088EVT_DROP_FILES = wx.PyEventBinder( wxEVT_DROP_FILES )
3089EVT_INIT_DIALOG = wx.PyEventBinder( wxEVT_INIT_DIALOG )
3090EVT_SYS_COLOUR_CHANGED = wx.PyEventBinder( wxEVT_SYS_COLOUR_CHANGED )
3091EVT_DISPLAY_CHANGED = wx.PyEventBinder( wxEVT_DISPLAY_CHANGED )
3092EVT_SHOW = wx.PyEventBinder( wxEVT_SHOW )
3093EVT_MAXIMIZE = wx.PyEventBinder( wxEVT_MAXIMIZE )
3094EVT_ICONIZE = wx.PyEventBinder( wxEVT_ICONIZE )
3095EVT_NAVIGATION_KEY = wx.PyEventBinder( wxEVT_NAVIGATION_KEY )
3096EVT_PALETTE_CHANGED = wx.PyEventBinder( wxEVT_PALETTE_CHANGED )
3097EVT_QUERY_NEW_PALETTE = wx.PyEventBinder( wxEVT_QUERY_NEW_PALETTE )
3098EVT_WINDOW_CREATE = wx.PyEventBinder( wxEVT_CREATE )
3099EVT_WINDOW_DESTROY = wx.PyEventBinder( wxEVT_DESTROY )
3100EVT_SET_CURSOR = wx.PyEventBinder( wxEVT_SET_CURSOR )
3101EVT_MOUSE_CAPTURE_CHANGED = wx.PyEventBinder( wxEVT_MOUSE_CAPTURE_CHANGED )
3102
3103EVT_LEFT_DOWN = wx.PyEventBinder( wxEVT_LEFT_DOWN )
3104EVT_LEFT_UP = wx.PyEventBinder( wxEVT_LEFT_UP )
3105EVT_MIDDLE_DOWN = wx.PyEventBinder( wxEVT_MIDDLE_DOWN )
3106EVT_MIDDLE_UP = wx.PyEventBinder( wxEVT_MIDDLE_UP )
3107EVT_RIGHT_DOWN = wx.PyEventBinder( wxEVT_RIGHT_DOWN )
3108EVT_RIGHT_UP = wx.PyEventBinder( wxEVT_RIGHT_UP )
3109EVT_MOTION = wx.PyEventBinder( wxEVT_MOTION )
3110EVT_LEFT_DCLICK = wx.PyEventBinder( wxEVT_LEFT_DCLICK )
3111EVT_MIDDLE_DCLICK = wx.PyEventBinder( wxEVT_MIDDLE_DCLICK )
3112EVT_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_RIGHT_DCLICK )
3113EVT_LEAVE_WINDOW = wx.PyEventBinder( wxEVT_LEAVE_WINDOW )
3114EVT_ENTER_WINDOW = wx.PyEventBinder( wxEVT_ENTER_WINDOW )
3115EVT_MOUSEWHEEL = wx.PyEventBinder( wxEVT_MOUSEWHEEL )
3116
3117EVT_MOUSE_EVENTS = wx.PyEventBinder([ wxEVT_LEFT_DOWN,
3118 wxEVT_LEFT_UP,
3119 wxEVT_MIDDLE_DOWN,
3120 wxEVT_MIDDLE_UP,
3121 wxEVT_RIGHT_DOWN,
3122 wxEVT_RIGHT_UP,
3123 wxEVT_MOTION,
3124 wxEVT_LEFT_DCLICK,
3125 wxEVT_MIDDLE_DCLICK,
3126 wxEVT_RIGHT_DCLICK,
3127 wxEVT_ENTER_WINDOW,
3128 wxEVT_LEAVE_WINDOW,
3129 wxEVT_MOUSEWHEEL
3130 ])
3131
3132
3133# Scrolling from wxWindow (sent to wxScrolledWindow)
3134EVT_SCROLLWIN = wx.PyEventBinder([ wxEVT_SCROLLWIN_TOP,
3135 wxEVT_SCROLLWIN_BOTTOM,
3136 wxEVT_SCROLLWIN_LINEUP,
3137 wxEVT_SCROLLWIN_LINEDOWN,
3138 wxEVT_SCROLLWIN_PAGEUP,
3139 wxEVT_SCROLLWIN_PAGEDOWN,
3140 wxEVT_SCROLLWIN_THUMBTRACK,
3141 wxEVT_SCROLLWIN_THUMBRELEASE,
3142 ])
3143
3144EVT_SCROLLWIN_TOP = wx.PyEventBinder( wxEVT_SCROLLWIN_TOP )
3145EVT_SCROLLWIN_BOTTOM = wx.PyEventBinder( wxEVT_SCROLLWIN_BOTTOM )
3146EVT_SCROLLWIN_LINEUP = wx.PyEventBinder( wxEVT_SCROLLWIN_LINEUP )
3147EVT_SCROLLWIN_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLLWIN_LINEDOWN )
3148EVT_SCROLLWIN_PAGEUP = wx.PyEventBinder( wxEVT_SCROLLWIN_PAGEUP )
3149EVT_SCROLLWIN_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLLWIN_PAGEDOWN )
3150EVT_SCROLLWIN_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLLWIN_THUMBTRACK )
3151EVT_SCROLLWIN_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLLWIN_THUMBRELEASE )
3152
3153# Scrolling from wxSlider and wxScrollBar
3154EVT_SCROLL = wx.PyEventBinder([ wxEVT_SCROLL_TOP,
3155 wxEVT_SCROLL_BOTTOM,
3156 wxEVT_SCROLL_LINEUP,
3157 wxEVT_SCROLL_LINEDOWN,
3158 wxEVT_SCROLL_PAGEUP,
3159 wxEVT_SCROLL_PAGEDOWN,
3160 wxEVT_SCROLL_THUMBTRACK,
3161 wxEVT_SCROLL_THUMBRELEASE,
3162 wxEVT_SCROLL_ENDSCROLL,
3163 ])
3164
3165EVT_SCROLL_TOP = wx.PyEventBinder( wxEVT_SCROLL_TOP )
3166EVT_SCROLL_BOTTOM = wx.PyEventBinder( wxEVT_SCROLL_BOTTOM )
3167EVT_SCROLL_LINEUP = wx.PyEventBinder( wxEVT_SCROLL_LINEUP )
3168EVT_SCROLL_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLL_LINEDOWN )
3169EVT_SCROLL_PAGEUP = wx.PyEventBinder( wxEVT_SCROLL_PAGEUP )
3170EVT_SCROLL_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLL_PAGEDOWN )
3171EVT_SCROLL_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLL_THUMBTRACK )
3172EVT_SCROLL_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE )
3173EVT_SCROLL_ENDSCROLL = wx.PyEventBinder( wxEVT_SCROLL_ENDSCROLL )
3174
3175# Scrolling from wxSlider and wxScrollBar, with an id
3176EVT_COMMAND_SCROLL = wx.PyEventBinder([ wxEVT_SCROLL_TOP,
3177 wxEVT_SCROLL_BOTTOM,
3178 wxEVT_SCROLL_LINEUP,
3179 wxEVT_SCROLL_LINEDOWN,
3180 wxEVT_SCROLL_PAGEUP,
3181 wxEVT_SCROLL_PAGEDOWN,
3182 wxEVT_SCROLL_THUMBTRACK,
3183 wxEVT_SCROLL_THUMBRELEASE,
3184 wxEVT_SCROLL_ENDSCROLL,
3185 ], 1)
3186
3187EVT_COMMAND_SCROLL_TOP = wx.PyEventBinder( wxEVT_SCROLL_TOP, 1)
3188EVT_COMMAND_SCROLL_BOTTOM = wx.PyEventBinder( wxEVT_SCROLL_BOTTOM, 1)
3189EVT_COMMAND_SCROLL_LINEUP = wx.PyEventBinder( wxEVT_SCROLL_LINEUP, 1)
3190EVT_COMMAND_SCROLL_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLL_LINEDOWN, 1)
3191EVT_COMMAND_SCROLL_PAGEUP = wx.PyEventBinder( wxEVT_SCROLL_PAGEUP, 1)
3192EVT_COMMAND_SCROLL_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLL_PAGEDOWN, 1)
3193EVT_COMMAND_SCROLL_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLL_THUMBTRACK, 1)
3194EVT_COMMAND_SCROLL_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE, 1)
3195EVT_COMMAND_SCROLL_ENDSCROLL = wx.PyEventBinder( wxEVT_SCROLL_ENDSCROLL, 1)
3196
d14a1e28
RD
3197EVT_BUTTON = wx.PyEventBinder( wxEVT_COMMAND_BUTTON_CLICKED, 1)
3198EVT_CHECKBOX = wx.PyEventBinder( wxEVT_COMMAND_CHECKBOX_CLICKED, 1)
3199EVT_CHOICE = wx.PyEventBinder( wxEVT_COMMAND_CHOICE_SELECTED, 1)
3200EVT_LISTBOX = wx.PyEventBinder( wxEVT_COMMAND_LISTBOX_SELECTED, 1)
3201EVT_LISTBOX_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, 1)
3202EVT_MENU = wx.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED, 1)
3203EVT_MENU_RANGE = wx.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED, 2)
3204EVT_SLIDER = wx.PyEventBinder( wxEVT_COMMAND_SLIDER_UPDATED, 1)
3205EVT_RADIOBOX = wx.PyEventBinder( wxEVT_COMMAND_RADIOBOX_SELECTED, 1)
3206EVT_RADIOBUTTON = wx.PyEventBinder( wxEVT_COMMAND_RADIOBUTTON_SELECTED, 1)
3207
3208EVT_SCROLLBAR = wx.PyEventBinder( wxEVT_COMMAND_SCROLLBAR_UPDATED, 1)
3209EVT_VLBOX = wx.PyEventBinder( wxEVT_COMMAND_VLBOX_SELECTED, 1)
3210EVT_COMBOBOX = wx.PyEventBinder( wxEVT_COMMAND_COMBOBOX_SELECTED, 1)
3211EVT_TOOL = wx.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED, 1)
3212EVT_TOOL_RANGE = wx.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED, 2)
3213EVT_TOOL_RCLICKED = wx.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED, 1)
3214EVT_TOOL_RCLICKED_RANGE = wx.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED, 2)
3215EVT_TOOL_ENTER = wx.PyEventBinder( wxEVT_COMMAND_TOOL_ENTER, 1)
3216EVT_CHECKLISTBOX = wx.PyEventBinder( wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, 1)
3217
3218
3219EVT_COMMAND_LEFT_CLICK = wx.PyEventBinder( wxEVT_COMMAND_LEFT_CLICK, 1)
3220EVT_COMMAND_LEFT_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_LEFT_DCLICK, 1)
3221EVT_COMMAND_RIGHT_CLICK = wx.PyEventBinder( wxEVT_COMMAND_RIGHT_CLICK, 1)
3222EVT_COMMAND_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_RIGHT_DCLICK, 1)
3223EVT_COMMAND_SET_FOCUS = wx.PyEventBinder( wxEVT_COMMAND_SET_FOCUS, 1)
3224EVT_COMMAND_KILL_FOCUS = wx.PyEventBinder( wxEVT_COMMAND_KILL_FOCUS, 1)
3225EVT_COMMAND_ENTER = wx.PyEventBinder( wxEVT_COMMAND_ENTER, 1)
3226
3227EVT_IDLE = wx.PyEventBinder( wxEVT_IDLE )
3228
3229EVT_UPDATE_UI = wx.PyEventBinder( wxEVT_UPDATE_UI, 1)
3230EVT_UPDATE_UI_RANGE = wx.PyEventBinder( wxEVT_UPDATE_UI, 2)
3231
3232EVT_CONTEXT_MENU = wx.PyEventBinder( wxEVT_CONTEXT_MENU )
3233
3234
3235
3236#---------------------------------------------------------------------------
3237
3238class Event(Object):
093d3ff1 3239 """Proxy of C++ Event class"""
e811c8ce
RD
3240 def __init__(self): raise RuntimeError, "No constructor defined"
3241 def __repr__(self):
3242 return "<%s.%s; proxy of C++ wxEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
54f9ee45 3243 def __del__(self, destroy=_core_.delete_Event):
a95a7133 3244 """__del__(self)"""
d14a1e28
RD
3245 try:
3246 if self.thisown: destroy(self)
3247 except: pass
e811c8ce
RD
3248
3249 def SetEventType(*args, **kwargs):
a95a7133 3250 """SetEventType(self, wxEventType typ)"""
54f9ee45 3251 return _core_.Event_SetEventType(*args, **kwargs)
e811c8ce
RD
3252
3253 def GetEventType(*args, **kwargs):
a95a7133 3254 """GetEventType(self) -> wxEventType"""
54f9ee45 3255 return _core_.Event_GetEventType(*args, **kwargs)
e811c8ce
RD
3256
3257 def GetEventObject(*args, **kwargs):
a95a7133 3258 """GetEventObject(self) -> Object"""
54f9ee45 3259 return _core_.Event_GetEventObject(*args, **kwargs)
e811c8ce
RD
3260
3261 def SetEventObject(*args, **kwargs):
a95a7133 3262 """SetEventObject(self, Object obj)"""
54f9ee45 3263 return _core_.Event_SetEventObject(*args, **kwargs)
e811c8ce
RD
3264
3265 def GetTimestamp(*args, **kwargs):
a95a7133 3266 """GetTimestamp(self) -> long"""
54f9ee45 3267 return _core_.Event_GetTimestamp(*args, **kwargs)
e811c8ce
RD
3268
3269 def SetTimestamp(*args, **kwargs):
a95a7133 3270 """SetTimestamp(self, long ts=0)"""
54f9ee45 3271 return _core_.Event_SetTimestamp(*args, **kwargs)
e811c8ce
RD
3272
3273 def GetId(*args, **kwargs):
a95a7133 3274 """GetId(self) -> int"""
54f9ee45 3275 return _core_.Event_GetId(*args, **kwargs)
e811c8ce
RD
3276
3277 def SetId(*args, **kwargs):
a95a7133 3278 """SetId(self, int Id)"""
54f9ee45 3279 return _core_.Event_SetId(*args, **kwargs)
e811c8ce
RD
3280
3281 def IsCommandEvent(*args, **kwargs):
a95a7133 3282 """IsCommandEvent(self) -> bool"""
54f9ee45 3283 return _core_.Event_IsCommandEvent(*args, **kwargs)
e811c8ce
RD
3284
3285 def Skip(*args, **kwargs):
51b83b37
RD
3286 """
3287 Skip(self, bool skip=True)
3288
3289 Called by an event handler, it controls whether additional event
3290 handlers bound to this event will be called after the current event
3291 handler returns. Skip(false) (the default setting) will prevent
3292 additional event handlers from being called and control will be
3293 returned to the sender of the event immediately after the current
3294 handler has finished. Skip(True) will cause the event processing
3295 system to continue searching for a handler function for this event.
3296
3297 """
54f9ee45 3298 return _core_.Event_Skip(*args, **kwargs)
e811c8ce
RD
3299
3300 def GetSkipped(*args, **kwargs):
a95a7133 3301 """GetSkipped(self) -> bool"""
54f9ee45 3302 return _core_.Event_GetSkipped(*args, **kwargs)
e811c8ce
RD
3303
3304 def ShouldPropagate(*args, **kwargs):
a95a7133 3305 """ShouldPropagate(self) -> bool"""
54f9ee45 3306 return _core_.Event_ShouldPropagate(*args, **kwargs)
e811c8ce
RD
3307
3308 def StopPropagation(*args, **kwargs):
a95a7133 3309 """StopPropagation(self) -> int"""
54f9ee45 3310 return _core_.Event_StopPropagation(*args, **kwargs)
e811c8ce
RD
3311
3312 def ResumePropagation(*args, **kwargs):
a95a7133 3313 """ResumePropagation(self, int propagationLevel)"""
54f9ee45 3314 return _core_.Event_ResumePropagation(*args, **kwargs)
e811c8ce
RD
3315
3316 def Clone(*args, **kwargs):
a95a7133 3317 """Clone(self) -> Event"""
54f9ee45 3318 return _core_.Event_Clone(*args, **kwargs)
e811c8ce 3319
d14a1e28
RD
3320
3321class EventPtr(Event):
3322 def __init__(self, this):
3323 self.this = this
3324 if not hasattr(self,"thisown"): self.thisown = 0
3325 self.__class__ = Event
54f9ee45 3326_core_.Event_swigregister(EventPtr)
d14a1e28
RD
3327
3328#---------------------------------------------------------------------------
3329
3330class PropagationDisabler(object):
093d3ff1 3331 """Proxy of C++ PropagationDisabler class"""
e811c8ce
RD
3332 def __repr__(self):
3333 return "<%s.%s; proxy of C++ wxPropagationDisabler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3334 def __init__(self, *args, **kwargs):
a95a7133 3335 """__init__(self, Event event) -> PropagationDisabler"""
54f9ee45 3336 newobj = _core_.new_PropagationDisabler(*args, **kwargs)
d14a1e28
RD
3337 self.this = newobj.this
3338 self.thisown = 1
3339 del newobj.thisown
54f9ee45 3340 def __del__(self, destroy=_core_.delete_PropagationDisabler):
a95a7133 3341 """__del__(self)"""
d14a1e28
RD
3342 try:
3343 if self.thisown: destroy(self)
3344 except: pass
e811c8ce 3345
d14a1e28
RD
3346
3347class PropagationDisablerPtr(PropagationDisabler):
3348 def __init__(self, this):
3349 self.this = this
3350 if not hasattr(self,"thisown"): self.thisown = 0
3351 self.__class__ = PropagationDisabler
54f9ee45 3352_core_.PropagationDisabler_swigregister(PropagationDisablerPtr)
d14a1e28
RD
3353
3354class PropagateOnce(object):
093d3ff1 3355 """Proxy of C++ PropagateOnce class"""
e811c8ce
RD
3356 def __repr__(self):
3357 return "<%s.%s; proxy of C++ wxPropagateOnce instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3358 def __init__(self, *args, **kwargs):
a95a7133 3359 """__init__(self, Event event) -> PropagateOnce"""
54f9ee45 3360 newobj = _core_.new_PropagateOnce(*args, **kwargs)
d14a1e28
RD
3361 self.this = newobj.this
3362 self.thisown = 1
3363 del newobj.thisown
54f9ee45 3364 def __del__(self, destroy=_core_.delete_PropagateOnce):
a95a7133 3365 """__del__(self)"""
d14a1e28
RD
3366 try:
3367 if self.thisown: destroy(self)
3368 except: pass
e811c8ce 3369
d14a1e28
RD
3370
3371class PropagateOncePtr(PropagateOnce):
3372 def __init__(self, this):
3373 self.this = this
3374 if not hasattr(self,"thisown"): self.thisown = 0
3375 self.__class__ = PropagateOnce
54f9ee45 3376_core_.PropagateOnce_swigregister(PropagateOncePtr)
d14a1e28
RD
3377
3378#---------------------------------------------------------------------------
3379
3380class CommandEvent(Event):
093d3ff1 3381 """Proxy of C++ CommandEvent class"""
e811c8ce
RD
3382 def __repr__(self):
3383 return "<%s.%s; proxy of C++ wxCommandEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3384 def __init__(self, *args, **kwargs):
a95a7133 3385 """__init__(self, wxEventType commandType=wxEVT_NULL, int winid=0) -> CommandEvent"""
54f9ee45 3386 newobj = _core_.new_CommandEvent(*args, **kwargs)
d14a1e28
RD
3387 self.this = newobj.this
3388 self.thisown = 1
3389 del newobj.thisown
e811c8ce 3390 def GetSelection(*args, **kwargs):
a95a7133 3391 """GetSelection(self) -> int"""
54f9ee45 3392 return _core_.CommandEvent_GetSelection(*args, **kwargs)
e811c8ce
RD
3393
3394 def SetString(*args, **kwargs):
a95a7133 3395 """SetString(self, String s)"""
54f9ee45 3396 return _core_.CommandEvent_SetString(*args, **kwargs)
e811c8ce
RD
3397
3398 def GetString(*args, **kwargs):
a95a7133 3399 """GetString(self) -> String"""
54f9ee45 3400 return _core_.CommandEvent_GetString(*args, **kwargs)
e811c8ce
RD
3401
3402 def IsChecked(*args, **kwargs):
a95a7133 3403 """IsChecked(self) -> bool"""
54f9ee45 3404 return _core_.CommandEvent_IsChecked(*args, **kwargs)
e811c8ce 3405
242b7b46 3406 Checked = IsChecked
e811c8ce 3407 def IsSelection(*args, **kwargs):
a95a7133 3408 """IsSelection(self) -> bool"""
54f9ee45 3409 return _core_.CommandEvent_IsSelection(*args, **kwargs)
e811c8ce
RD
3410
3411 def SetExtraLong(*args, **kwargs):
a95a7133 3412 """SetExtraLong(self, long extraLong)"""
54f9ee45 3413 return _core_.CommandEvent_SetExtraLong(*args, **kwargs)
e811c8ce
RD
3414
3415 def GetExtraLong(*args, **kwargs):
a95a7133 3416 """GetExtraLong(self) -> long"""
54f9ee45 3417 return _core_.CommandEvent_GetExtraLong(*args, **kwargs)
e811c8ce
RD
3418
3419 def SetInt(*args, **kwargs):
a95a7133 3420 """SetInt(self, int i)"""
54f9ee45 3421 return _core_.CommandEvent_SetInt(*args, **kwargs)
e811c8ce
RD
3422
3423 def GetInt(*args, **kwargs):
a95a7133 3424 """GetInt(self) -> long"""
54f9ee45 3425 return _core_.CommandEvent_GetInt(*args, **kwargs)
e811c8ce
RD
3426
3427 def Clone(*args, **kwargs):
a95a7133 3428 """Clone(self) -> Event"""
54f9ee45 3429 return _core_.CommandEvent_Clone(*args, **kwargs)
e811c8ce 3430
d14a1e28
RD
3431
3432class CommandEventPtr(CommandEvent):
3433 def __init__(self, this):
3434 self.this = this
3435 if not hasattr(self,"thisown"): self.thisown = 0
3436 self.__class__ = CommandEvent
54f9ee45 3437_core_.CommandEvent_swigregister(CommandEventPtr)
d14a1e28
RD
3438
3439#---------------------------------------------------------------------------
3440
3441class NotifyEvent(CommandEvent):
093d3ff1 3442 """Proxy of C++ NotifyEvent class"""
e811c8ce
RD
3443 def __repr__(self):
3444 return "<%s.%s; proxy of C++ wxNotifyEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3445 def __init__(self, *args, **kwargs):
a95a7133 3446 """__init__(self, wxEventType commandType=wxEVT_NULL, int winid=0) -> NotifyEvent"""
54f9ee45 3447 newobj = _core_.new_NotifyEvent(*args, **kwargs)
d14a1e28
RD
3448 self.this = newobj.this
3449 self.thisown = 1
3450 del newobj.thisown
e811c8ce 3451 def Veto(*args, **kwargs):
a95a7133 3452 """Veto(self)"""
54f9ee45 3453 return _core_.NotifyEvent_Veto(*args, **kwargs)
e811c8ce
RD
3454
3455 def Allow(*args, **kwargs):
a95a7133 3456 """Allow(self)"""
54f9ee45 3457 return _core_.NotifyEvent_Allow(*args, **kwargs)
e811c8ce
RD
3458
3459 def IsAllowed(*args, **kwargs):
a95a7133 3460 """IsAllowed(self) -> bool"""
54f9ee45 3461 return _core_.NotifyEvent_IsAllowed(*args, **kwargs)
e811c8ce 3462
d14a1e28
RD
3463
3464class NotifyEventPtr(NotifyEvent):
3465 def __init__(self, this):
3466 self.this = this
3467 if not hasattr(self,"thisown"): self.thisown = 0
3468 self.__class__ = NotifyEvent
54f9ee45 3469_core_.NotifyEvent_swigregister(NotifyEventPtr)
d14a1e28
RD
3470
3471#---------------------------------------------------------------------------
3472
3473class ScrollEvent(CommandEvent):
093d3ff1 3474 """Proxy of C++ ScrollEvent class"""
e811c8ce
RD
3475 def __repr__(self):
3476 return "<%s.%s; proxy of C++ wxScrollEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3477 def __init__(self, *args, **kwargs):
0df68c9f 3478 """
a95a7133 3479 __init__(self, wxEventType commandType=wxEVT_NULL, int winid=0, int pos=0,
0df68c9f
RD
3480 int orient=0) -> ScrollEvent
3481 """
54f9ee45 3482 newobj = _core_.new_ScrollEvent(*args, **kwargs)
d14a1e28
RD
3483 self.this = newobj.this
3484 self.thisown = 1
3485 del newobj.thisown
e811c8ce 3486 def GetOrientation(*args, **kwargs):
a95a7133 3487 """GetOrientation(self) -> int"""
54f9ee45 3488 return _core_.ScrollEvent_GetOrientation(*args, **kwargs)
e811c8ce
RD
3489
3490 def GetPosition(*args, **kwargs):
a95a7133 3491 """GetPosition(self) -> int"""
54f9ee45 3492 return _core_.ScrollEvent_GetPosition(*args, **kwargs)
e811c8ce
RD
3493
3494 def SetOrientation(*args, **kwargs):
a95a7133 3495 """SetOrientation(self, int orient)"""
54f9ee45 3496 return _core_.ScrollEvent_SetOrientation(*args, **kwargs)
e811c8ce
RD
3497
3498 def SetPosition(*args, **kwargs):
a95a7133 3499 """SetPosition(self, int pos)"""
54f9ee45 3500 return _core_.ScrollEvent_SetPosition(*args, **kwargs)
e811c8ce 3501
d14a1e28
RD
3502
3503class ScrollEventPtr(ScrollEvent):
3504 def __init__(self, this):
3505 self.this = this
3506 if not hasattr(self,"thisown"): self.thisown = 0
3507 self.__class__ = ScrollEvent
54f9ee45 3508_core_.ScrollEvent_swigregister(ScrollEventPtr)
d14a1e28
RD
3509
3510#---------------------------------------------------------------------------
3511
3512class ScrollWinEvent(Event):
093d3ff1 3513 """Proxy of C++ ScrollWinEvent class"""
e811c8ce
RD
3514 def __repr__(self):
3515 return "<%s.%s; proxy of C++ wxScrollWinEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3516 def __init__(self, *args, **kwargs):
a95a7133 3517 """__init__(self, wxEventType commandType=wxEVT_NULL, int pos=0, int orient=0) -> ScrollWinEvent"""
54f9ee45 3518 newobj = _core_.new_ScrollWinEvent(*args, **kwargs)
d14a1e28
RD
3519 self.this = newobj.this
3520 self.thisown = 1
3521 del newobj.thisown
e811c8ce 3522 def GetOrientation(*args, **kwargs):
a95a7133 3523 """GetOrientation(self) -> int"""
54f9ee45 3524 return _core_.ScrollWinEvent_GetOrientation(*args, **kwargs)
e811c8ce
RD
3525
3526 def GetPosition(*args, **kwargs):
a95a7133 3527 """GetPosition(self) -> int"""
54f9ee45 3528 return _core_.ScrollWinEvent_GetPosition(*args, **kwargs)
e811c8ce
RD
3529
3530 def SetOrientation(*args, **kwargs):
a95a7133 3531 """SetOrientation(self, int orient)"""
54f9ee45 3532 return _core_.ScrollWinEvent_SetOrientation(*args, **kwargs)
e811c8ce
RD
3533
3534 def SetPosition(*args, **kwargs):
a95a7133 3535 """SetPosition(self, int pos)"""
54f9ee45 3536 return _core_.ScrollWinEvent_SetPosition(*args, **kwargs)
e811c8ce 3537
d14a1e28
RD
3538
3539class ScrollWinEventPtr(ScrollWinEvent):
3540 def __init__(self, this):
3541 self.this = this
3542 if not hasattr(self,"thisown"): self.thisown = 0
3543 self.__class__ = ScrollWinEvent
54f9ee45 3544_core_.ScrollWinEvent_swigregister(ScrollWinEventPtr)
d14a1e28
RD
3545
3546#---------------------------------------------------------------------------
3547
54f9ee45
RD
3548MOUSE_BTN_ANY = _core_.MOUSE_BTN_ANY
3549MOUSE_BTN_NONE = _core_.MOUSE_BTN_NONE
3550MOUSE_BTN_LEFT = _core_.MOUSE_BTN_LEFT
3551MOUSE_BTN_MIDDLE = _core_.MOUSE_BTN_MIDDLE
3552MOUSE_BTN_RIGHT = _core_.MOUSE_BTN_RIGHT
d14a1e28 3553class MouseEvent(Event):
093d3ff1 3554 """Proxy of C++ MouseEvent class"""
e811c8ce
RD
3555 def __repr__(self):
3556 return "<%s.%s; proxy of C++ wxMouseEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3557 def __init__(self, *args, **kwargs):
a95a7133 3558 """__init__(self, wxEventType mouseType=wxEVT_NULL) -> MouseEvent"""
54f9ee45 3559 newobj = _core_.new_MouseEvent(*args, **kwargs)
d14a1e28
RD
3560 self.this = newobj.this
3561 self.thisown = 1
3562 del newobj.thisown
e811c8ce 3563 def IsButton(*args, **kwargs):
a95a7133 3564 """IsButton(self) -> bool"""
54f9ee45 3565 return _core_.MouseEvent_IsButton(*args, **kwargs)
e811c8ce
RD
3566
3567 def ButtonDown(*args, **kwargs):
a95a7133 3568 """ButtonDown(self, int but=MOUSE_BTN_ANY) -> bool"""
54f9ee45 3569 return _core_.MouseEvent_ButtonDown(*args, **kwargs)
e811c8ce
RD
3570
3571 def ButtonDClick(*args, **kwargs):
a95a7133 3572 """ButtonDClick(self, int but=MOUSE_BTN_ANY) -> bool"""
54f9ee45 3573 return _core_.MouseEvent_ButtonDClick(*args, **kwargs)
e811c8ce
RD
3574
3575 def ButtonUp(*args, **kwargs):
a95a7133 3576 """ButtonUp(self, int but=MOUSE_BTN_ANY) -> bool"""
54f9ee45 3577 return _core_.MouseEvent_ButtonUp(*args, **kwargs)
e811c8ce
RD
3578
3579 def Button(*args, **kwargs):
a95a7133 3580 """Button(self, int but) -> bool"""
54f9ee45 3581 return _core_.MouseEvent_Button(*args, **kwargs)
e811c8ce
RD
3582
3583 def ButtonIsDown(*args, **kwargs):
a95a7133 3584 """ButtonIsDown(self, int but) -> bool"""
54f9ee45 3585 return _core_.MouseEvent_ButtonIsDown(*args, **kwargs)
e811c8ce
RD
3586
3587 def GetButton(*args, **kwargs):
a95a7133 3588 """GetButton(self) -> int"""
54f9ee45 3589 return _core_.MouseEvent_GetButton(*args, **kwargs)
e811c8ce
RD
3590
3591 def ControlDown(*args, **kwargs):
a95a7133 3592 """ControlDown(self) -> bool"""
54f9ee45 3593 return _core_.MouseEvent_ControlDown(*args, **kwargs)
e811c8ce
RD
3594
3595 def MetaDown(*args, **kwargs):
a95a7133 3596 """MetaDown(self) -> bool"""
54f9ee45 3597 return _core_.MouseEvent_MetaDown(*args, **kwargs)
e811c8ce
RD
3598
3599 def AltDown(*args, **kwargs):
a95a7133 3600 """AltDown(self) -> bool"""
54f9ee45 3601 return _core_.MouseEvent_AltDown(*args, **kwargs)
e811c8ce
RD
3602
3603 def ShiftDown(*args, **kwargs):
a95a7133 3604 """ShiftDown(self) -> bool"""
54f9ee45 3605 return _core_.MouseEvent_ShiftDown(*args, **kwargs)
e811c8ce 3606
412d302d
RD
3607 def CmdDown(*args, **kwargs):
3608 """
3609 CmdDown(self) -> bool
3610
3611 "Cmd" is a pseudo key which is the same as Control for PC and Unix
3612 platforms but the special "Apple" (a.k.a as "Command") key on
3613 Macs: it makes often sense to use it instead of, say, `ControlDown`
3614 because Cmd key is used for the same thing under Mac as Ctrl
3615 elsewhere. The Ctrl still exists, it's just not used for this
3616 purpose. So for non-Mac platforms this is the same as `ControlDown`
3617 and Macs this is the same as `MetaDown`.
3618 """
3619 return _core_.MouseEvent_CmdDown(*args, **kwargs)
3620
e811c8ce 3621 def LeftDown(*args, **kwargs):
a95a7133 3622 """LeftDown(self) -> bool"""
54f9ee45 3623 return _core_.MouseEvent_LeftDown(*args, **kwargs)
e811c8ce
RD
3624
3625 def MiddleDown(*args, **kwargs):
a95a7133 3626 """MiddleDown(self) -> bool"""
54f9ee45 3627 return _core_.MouseEvent_MiddleDown(*args, **kwargs)
e811c8ce
RD
3628
3629 def RightDown(*args, **kwargs):
a95a7133 3630 """RightDown(self) -> bool"""
54f9ee45 3631 return _core_.MouseEvent_RightDown(*args, **kwargs)
e811c8ce
RD
3632
3633 def LeftUp(*args, **kwargs):
a95a7133 3634 """LeftUp(self) -> bool"""
54f9ee45 3635 return _core_.MouseEvent_LeftUp(*args, **kwargs)
e811c8ce
RD
3636
3637 def MiddleUp(*args, **kwargs):
a95a7133 3638 """MiddleUp(self) -> bool"""
54f9ee45 3639 return _core_.MouseEvent_MiddleUp(*args, **kwargs)
e811c8ce
RD
3640
3641 def RightUp(*args, **kwargs):
a95a7133 3642 """RightUp(self) -> bool"""
54f9ee45 3643 return _core_.MouseEvent_RightUp(*args, **kwargs)
e811c8ce
RD
3644
3645 def LeftDClick(*args, **kwargs):
a95a7133 3646 """LeftDClick(self) -> bool"""
54f9ee45 3647 return _core_.MouseEvent_LeftDClick(*args, **kwargs)
e811c8ce
RD
3648
3649 def MiddleDClick(*args, **kwargs):
a95a7133 3650 """MiddleDClick(self) -> bool"""
54f9ee45 3651 return _core_.MouseEvent_MiddleDClick(*args, **kwargs)
e811c8ce
RD
3652
3653 def RightDClick(*args, **kwargs):
a95a7133 3654 """RightDClick(self) -> bool"""
54f9ee45 3655 return _core_.MouseEvent_RightDClick(*args, **kwargs)
e811c8ce
RD
3656
3657 def LeftIsDown(*args, **kwargs):
a95a7133 3658 """LeftIsDown(self) -> bool"""
54f9ee45 3659 return _core_.MouseEvent_LeftIsDown(*args, **kwargs)
e811c8ce
RD
3660
3661 def MiddleIsDown(*args, **kwargs):
a95a7133 3662 """MiddleIsDown(self) -> bool"""
54f9ee45 3663 return _core_.MouseEvent_MiddleIsDown(*args, **kwargs)
e811c8ce
RD
3664
3665 def RightIsDown(*args, **kwargs):
a95a7133 3666 """RightIsDown(self) -> bool"""
54f9ee45 3667 return _core_.MouseEvent_RightIsDown(*args, **kwargs)
e811c8ce
RD
3668
3669 def Dragging(*args, **kwargs):
a95a7133 3670 """Dragging(self) -> bool"""
54f9ee45 3671 return _core_.MouseEvent_Dragging(*args, **kwargs)
e811c8ce
RD
3672
3673 def Moving(*args, **kwargs):
a95a7133 3674 """Moving(self) -> bool"""
54f9ee45 3675 return _core_.MouseEvent_Moving(*args, **kwargs)
e811c8ce
RD
3676
3677 def Entering(*args, **kwargs):
a95a7133 3678 """Entering(self) -> bool"""
54f9ee45 3679 return _core_.MouseEvent_Entering(*args, **kwargs)
e811c8ce
RD
3680
3681 def Leaving(*args, **kwargs):
a95a7133 3682 """Leaving(self) -> bool"""
54f9ee45 3683 return _core_.MouseEvent_Leaving(*args, **kwargs)
e811c8ce
RD
3684
3685 def GetPosition(*args, **kwargs):
0df68c9f 3686 """
a95a7133 3687 GetPosition(self) -> Point
e811c8ce 3688
41e2b43e
RD
3689 Returns the position of the mouse in window coordinates when the event
3690 happened.
0df68c9f 3691 """
54f9ee45 3692 return _core_.MouseEvent_GetPosition(*args, **kwargs)
e811c8ce
RD
3693
3694 def GetPositionTuple(*args, **kwargs):
0df68c9f
RD
3695 """
3696 GetPositionTuple() -> (x,y)
e811c8ce 3697
41e2b43e
RD
3698 Returns the position of the mouse in window coordinates when the event
3699 happened.
0df68c9f 3700 """
54f9ee45 3701 return _core_.MouseEvent_GetPositionTuple(*args, **kwargs)
e811c8ce
RD
3702
3703 def GetLogicalPosition(*args, **kwargs):
a95a7133 3704 """GetLogicalPosition(self, DC dc) -> Point"""
54f9ee45 3705 return _core_.MouseEvent_GetLogicalPosition(*args, **kwargs)
e811c8ce
RD
3706
3707 def GetX(*args, **kwargs):
a95a7133 3708 """GetX(self) -> int"""
54f9ee45 3709 return _core_.MouseEvent_GetX(*args, **kwargs)
e811c8ce
RD
3710
3711 def GetY(*args, **kwargs):
a95a7133 3712 """GetY(self) -> int"""
54f9ee45 3713 return _core_.MouseEvent_GetY(*args, **kwargs)
e811c8ce
RD
3714
3715 def GetWheelRotation(*args, **kwargs):
a95a7133 3716 """GetWheelRotation(self) -> int"""
54f9ee45 3717 return _core_.MouseEvent_GetWheelRotation(*args, **kwargs)
e811c8ce
RD
3718
3719 def GetWheelDelta(*args, **kwargs):
a95a7133 3720 """GetWheelDelta(self) -> int"""
54f9ee45 3721 return _core_.MouseEvent_GetWheelDelta(*args, **kwargs)
e811c8ce
RD
3722
3723 def GetLinesPerAction(*args, **kwargs):
a95a7133 3724 """GetLinesPerAction(self) -> int"""
54f9ee45 3725 return _core_.MouseEvent_GetLinesPerAction(*args, **kwargs)
e811c8ce
RD
3726
3727 def IsPageScroll(*args, **kwargs):
a95a7133 3728 """IsPageScroll(self) -> bool"""
54f9ee45
RD
3729 return _core_.MouseEvent_IsPageScroll(*args, **kwargs)
3730
3731 m_x = property(_core_.MouseEvent_m_x_get, _core_.MouseEvent_m_x_set)
3732 m_y = property(_core_.MouseEvent_m_y_get, _core_.MouseEvent_m_y_set)
3733 m_leftDown = property(_core_.MouseEvent_m_leftDown_get, _core_.MouseEvent_m_leftDown_set)
3734 m_middleDown = property(_core_.MouseEvent_m_middleDown_get, _core_.MouseEvent_m_middleDown_set)
3735 m_rightDown = property(_core_.MouseEvent_m_rightDown_get, _core_.MouseEvent_m_rightDown_set)
3736 m_controlDown = property(_core_.MouseEvent_m_controlDown_get, _core_.MouseEvent_m_controlDown_set)
3737 m_shiftDown = property(_core_.MouseEvent_m_shiftDown_get, _core_.MouseEvent_m_shiftDown_set)
3738 m_altDown = property(_core_.MouseEvent_m_altDown_get, _core_.MouseEvent_m_altDown_set)
3739 m_metaDown = property(_core_.MouseEvent_m_metaDown_get, _core_.MouseEvent_m_metaDown_set)
3740 m_wheelRotation = property(_core_.MouseEvent_m_wheelRotation_get, _core_.MouseEvent_m_wheelRotation_set)
3741 m_wheelDelta = property(_core_.MouseEvent_m_wheelDelta_get, _core_.MouseEvent_m_wheelDelta_set)
3742 m_linesPerAction = property(_core_.MouseEvent_m_linesPerAction_get, _core_.MouseEvent_m_linesPerAction_set)
d14a1e28
RD
3743
3744class MouseEventPtr(MouseEvent):
3745 def __init__(self, this):
3746 self.this = this
3747 if not hasattr(self,"thisown"): self.thisown = 0
3748 self.__class__ = MouseEvent
54f9ee45 3749_core_.MouseEvent_swigregister(MouseEventPtr)
d14a1e28
RD
3750
3751#---------------------------------------------------------------------------
3752
3753class SetCursorEvent(Event):
093d3ff1 3754 """Proxy of C++ SetCursorEvent class"""
e811c8ce
RD
3755 def __repr__(self):
3756 return "<%s.%s; proxy of C++ wxSetCursorEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3757 def __init__(self, *args, **kwargs):
a95a7133 3758 """__init__(self, int x=0, int y=0) -> SetCursorEvent"""
54f9ee45 3759 newobj = _core_.new_SetCursorEvent(*args, **kwargs)
d14a1e28
RD
3760 self.this = newobj.this
3761 self.thisown = 1
3762 del newobj.thisown
e811c8ce 3763 def GetX(*args, **kwargs):
a95a7133 3764 """GetX(self) -> int"""
54f9ee45 3765 return _core_.SetCursorEvent_GetX(*args, **kwargs)
e811c8ce
RD
3766
3767 def GetY(*args, **kwargs):
a95a7133 3768 """GetY(self) -> int"""
54f9ee45 3769 return _core_.SetCursorEvent_GetY(*args, **kwargs)
e811c8ce
RD
3770
3771 def SetCursor(*args, **kwargs):
a95a7133 3772 """SetCursor(self, Cursor cursor)"""
54f9ee45 3773 return _core_.SetCursorEvent_SetCursor(*args, **kwargs)
e811c8ce
RD
3774
3775 def GetCursor(*args, **kwargs):
a95a7133 3776 """GetCursor(self) -> Cursor"""
54f9ee45 3777 return _core_.SetCursorEvent_GetCursor(*args, **kwargs)
e811c8ce
RD
3778
3779 def HasCursor(*args, **kwargs):
a95a7133 3780 """HasCursor(self) -> bool"""
54f9ee45 3781 return _core_.SetCursorEvent_HasCursor(*args, **kwargs)
e811c8ce 3782
d14a1e28
RD
3783
3784class SetCursorEventPtr(SetCursorEvent):
3785 def __init__(self, this):
3786 self.this = this
3787 if not hasattr(self,"thisown"): self.thisown = 0
3788 self.__class__ = SetCursorEvent
54f9ee45 3789_core_.SetCursorEvent_swigregister(SetCursorEventPtr)
d14a1e28
RD
3790
3791#---------------------------------------------------------------------------
3792
3793class KeyEvent(Event):
093d3ff1 3794 """Proxy of C++ KeyEvent class"""
e811c8ce
RD
3795 def __repr__(self):
3796 return "<%s.%s; proxy of C++ wxKeyEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3797 def __init__(self, *args, **kwargs):
a95a7133 3798 """__init__(self, wxEventType keyType=wxEVT_NULL) -> KeyEvent"""
54f9ee45 3799 newobj = _core_.new_KeyEvent(*args, **kwargs)
d14a1e28
RD
3800 self.this = newobj.this
3801 self.thisown = 1
3802 del newobj.thisown
e811c8ce 3803 def ControlDown(*args, **kwargs):
a95a7133 3804 """ControlDown(self) -> bool"""
54f9ee45 3805 return _core_.KeyEvent_ControlDown(*args, **kwargs)
e811c8ce
RD
3806
3807 def MetaDown(*args, **kwargs):
a95a7133 3808 """MetaDown(self) -> bool"""
54f9ee45 3809 return _core_.KeyEvent_MetaDown(*args, **kwargs)
e811c8ce
RD
3810
3811 def AltDown(*args, **kwargs):
a95a7133 3812 """AltDown(self) -> bool"""
54f9ee45 3813 return _core_.KeyEvent_AltDown(*args, **kwargs)
e811c8ce
RD
3814
3815 def ShiftDown(*args, **kwargs):
a95a7133 3816 """ShiftDown(self) -> bool"""
54f9ee45 3817 return _core_.KeyEvent_ShiftDown(*args, **kwargs)
e811c8ce 3818
412d302d
RD
3819 def CmdDown(*args, **kwargs):
3820 """
3821 CmdDown(self) -> bool
3822
3823 "Cmd" is a pseudo key which is the same as Control for PC and Unix
3824 platforms but the special "Apple" (a.k.a as "Command") key on
3825 Macs: it makes often sense to use it instead of, say, `ControlDown`
3826 because Cmd key is used for the same thing under Mac as Ctrl
3827 elsewhere. The Ctrl still exists, it's just not used for this
3828 purpose. So for non-Mac platforms this is the same as `ControlDown`
3829 and Macs this is the same as `MetaDown`.
3830 """
3831 return _core_.KeyEvent_CmdDown(*args, **kwargs)
3832
e811c8ce 3833 def HasModifiers(*args, **kwargs):
a95a7133 3834 """HasModifiers(self) -> bool"""
54f9ee45 3835 return _core_.KeyEvent_HasModifiers(*args, **kwargs)
e811c8ce
RD
3836
3837 def GetKeyCode(*args, **kwargs):
a95a7133 3838 """GetKeyCode(self) -> int"""
54f9ee45 3839 return _core_.KeyEvent_GetKeyCode(*args, **kwargs)
e811c8ce 3840
d14a1e28 3841 KeyCode = GetKeyCode
19272049
RD
3842 def GetUnicodeKey(*args, **kwargs):
3843 """GetUnicodeKey(self) -> int"""
3844 return _core_.KeyEvent_GetUnicodeKey(*args, **kwargs)
e811c8ce 3845
19272049 3846 GetUniChar = GetUnicodeKey
e811c8ce 3847 def GetRawKeyCode(*args, **kwargs):
a95a7133 3848 """GetRawKeyCode(self) -> unsigned int"""
54f9ee45 3849 return _core_.KeyEvent_GetRawKeyCode(*args, **kwargs)
e811c8ce
RD
3850
3851 def GetRawKeyFlags(*args, **kwargs):
a95a7133 3852 """GetRawKeyFlags(self) -> unsigned int"""
54f9ee45 3853 return _core_.KeyEvent_GetRawKeyFlags(*args, **kwargs)
e811c8ce
RD
3854
3855 def GetPosition(*args, **kwargs):
0df68c9f 3856 """
a95a7133 3857 GetPosition(self) -> Point
e811c8ce 3858
0df68c9f
RD
3859 Find the position of the event.
3860 """
54f9ee45 3861 return _core_.KeyEvent_GetPosition(*args, **kwargs)
e811c8ce
RD
3862
3863 def GetPositionTuple(*args, **kwargs):
0df68c9f
RD
3864 """
3865 GetPositionTuple() -> (x,y)
e811c8ce 3866
0df68c9f
RD
3867 Find the position of the event.
3868 """
54f9ee45 3869 return _core_.KeyEvent_GetPositionTuple(*args, **kwargs)
e811c8ce
RD
3870
3871 def GetX(*args, **kwargs):
a95a7133 3872 """GetX(self) -> int"""
54f9ee45 3873 return _core_.KeyEvent_GetX(*args, **kwargs)
e811c8ce
RD
3874
3875 def GetY(*args, **kwargs):
a95a7133 3876 """GetY(self) -> int"""
54f9ee45
RD
3877 return _core_.KeyEvent_GetY(*args, **kwargs)
3878
3879 m_x = property(_core_.KeyEvent_m_x_get, _core_.KeyEvent_m_x_set)
3880 m_y = property(_core_.KeyEvent_m_y_get, _core_.KeyEvent_m_y_set)
3881 m_keyCode = property(_core_.KeyEvent_m_keyCode_get, _core_.KeyEvent_m_keyCode_set)
3882 m_controlDown = property(_core_.KeyEvent_m_controlDown_get, _core_.KeyEvent_m_controlDown_set)
3883 m_shiftDown = property(_core_.KeyEvent_m_shiftDown_get, _core_.KeyEvent_m_shiftDown_set)
3884 m_altDown = property(_core_.KeyEvent_m_altDown_get, _core_.KeyEvent_m_altDown_set)
3885 m_metaDown = property(_core_.KeyEvent_m_metaDown_get, _core_.KeyEvent_m_metaDown_set)
3886 m_scanCode = property(_core_.KeyEvent_m_scanCode_get, _core_.KeyEvent_m_scanCode_set)
3887 m_rawCode = property(_core_.KeyEvent_m_rawCode_get, _core_.KeyEvent_m_rawCode_set)
3888 m_rawFlags = property(_core_.KeyEvent_m_rawFlags_get, _core_.KeyEvent_m_rawFlags_set)
d14a1e28
RD
3889
3890class KeyEventPtr(KeyEvent):
3891 def __init__(self, this):
3892 self.this = this
3893 if not hasattr(self,"thisown"): self.thisown = 0
3894 self.__class__ = KeyEvent
54f9ee45 3895_core_.KeyEvent_swigregister(KeyEventPtr)
d14a1e28
RD
3896
3897#---------------------------------------------------------------------------
3898
3899class SizeEvent(Event):
093d3ff1 3900 """Proxy of C++ SizeEvent class"""
e811c8ce
RD
3901 def __repr__(self):
3902 return "<%s.%s; proxy of C++ wxSizeEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3903 def __init__(self, *args, **kwargs):
a95a7133 3904 """__init__(self, Size sz=DefaultSize, int winid=0) -> SizeEvent"""
54f9ee45 3905 newobj = _core_.new_SizeEvent(*args, **kwargs)
d14a1e28
RD
3906 self.this = newobj.this
3907 self.thisown = 1
3908 del newobj.thisown
e811c8ce 3909 def GetSize(*args, **kwargs):
a95a7133 3910 """GetSize(self) -> Size"""
54f9ee45 3911 return _core_.SizeEvent_GetSize(*args, **kwargs)
e811c8ce
RD
3912
3913 def GetRect(*args, **kwargs):
a95a7133 3914 """GetRect(self) -> Rect"""
54f9ee45 3915 return _core_.SizeEvent_GetRect(*args, **kwargs)
e811c8ce
RD
3916
3917 def SetRect(*args, **kwargs):
a95a7133 3918 """SetRect(self, Rect rect)"""
54f9ee45 3919 return _core_.SizeEvent_SetRect(*args, **kwargs)
e811c8ce
RD
3920
3921 def SetSize(*args, **kwargs):
a95a7133 3922 """SetSize(self, Size size)"""
54f9ee45 3923 return _core_.SizeEvent_SetSize(*args, **kwargs)
e811c8ce 3924
54f9ee45
RD
3925 m_size = property(_core_.SizeEvent_m_size_get, _core_.SizeEvent_m_size_set)
3926 m_rect = property(_core_.SizeEvent_m_rect_get, _core_.SizeEvent_m_rect_set)
d14a1e28
RD
3927
3928class SizeEventPtr(SizeEvent):
3929 def __init__(self, this):
3930 self.this = this
3931 if not hasattr(self,"thisown"): self.thisown = 0
3932 self.__class__ = SizeEvent
54f9ee45 3933_core_.SizeEvent_swigregister(SizeEventPtr)
d14a1e28
RD
3934
3935#---------------------------------------------------------------------------
3936
3937class MoveEvent(Event):
093d3ff1 3938 """Proxy of C++ MoveEvent class"""
e811c8ce
RD
3939 def __repr__(self):
3940 return "<%s.%s; proxy of C++ wxMoveEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3941 def __init__(self, *args, **kwargs):
a95a7133 3942 """__init__(self, Point pos=DefaultPosition, int winid=0) -> MoveEvent"""
54f9ee45 3943 newobj = _core_.new_MoveEvent(*args, **kwargs)
d14a1e28
RD
3944 self.this = newobj.this
3945 self.thisown = 1
3946 del newobj.thisown
e811c8ce 3947 def GetPosition(*args, **kwargs):
a95a7133 3948 """GetPosition(self) -> Point"""
54f9ee45 3949 return _core_.MoveEvent_GetPosition(*args, **kwargs)
e811c8ce
RD
3950
3951 def GetRect(*args, **kwargs):
a95a7133 3952 """GetRect(self) -> Rect"""
54f9ee45 3953 return _core_.MoveEvent_GetRect(*args, **kwargs)
e811c8ce
RD
3954
3955 def SetRect(*args, **kwargs):
a95a7133 3956 """SetRect(self, Rect rect)"""
54f9ee45 3957 return _core_.MoveEvent_SetRect(*args, **kwargs)
e811c8ce
RD
3958
3959 def SetPosition(*args, **kwargs):
a95a7133 3960 """SetPosition(self, Point pos)"""
54f9ee45 3961 return _core_.MoveEvent_SetPosition(*args, **kwargs)
e811c8ce 3962
7557b9b5
RD
3963 m_pos = property(GetPosition, SetPosition)
3964 m_rect = property(GetRect, SetRect)
3965
d14a1e28
RD
3966
3967class MoveEventPtr(MoveEvent):
3968 def __init__(self, this):
3969 self.this = this
3970 if not hasattr(self,"thisown"): self.thisown = 0
3971 self.__class__ = MoveEvent
54f9ee45 3972_core_.MoveEvent_swigregister(MoveEventPtr)
d14a1e28
RD
3973
3974#---------------------------------------------------------------------------
3975
3976class PaintEvent(Event):
093d3ff1 3977 """Proxy of C++ PaintEvent class"""
e811c8ce
RD
3978 def __repr__(self):
3979 return "<%s.%s; proxy of C++ wxPaintEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3980 def __init__(self, *args, **kwargs):
a95a7133 3981 """__init__(self, int Id=0) -> PaintEvent"""
54f9ee45 3982 newobj = _core_.new_PaintEvent(*args, **kwargs)
d14a1e28
RD
3983 self.this = newobj.this
3984 self.thisown = 1
3985 del newobj.thisown
d14a1e28
RD
3986
3987class PaintEventPtr(PaintEvent):
3988 def __init__(self, this):
3989 self.this = this
3990 if not hasattr(self,"thisown"): self.thisown = 0
3991 self.__class__ = PaintEvent
54f9ee45 3992_core_.PaintEvent_swigregister(PaintEventPtr)
d14a1e28
RD
3993
3994class NcPaintEvent(Event):
093d3ff1 3995 """Proxy of C++ NcPaintEvent class"""
e811c8ce
RD
3996 def __repr__(self):
3997 return "<%s.%s; proxy of C++ wxNcPaintEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3998 def __init__(self, *args, **kwargs):
a95a7133 3999 """__init__(self, int winid=0) -> NcPaintEvent"""
54f9ee45 4000 newobj = _core_.new_NcPaintEvent(*args, **kwargs)
d14a1e28
RD
4001 self.this = newobj.this
4002 self.thisown = 1
4003 del newobj.thisown
d14a1e28
RD
4004
4005class NcPaintEventPtr(NcPaintEvent):
4006 def __init__(self, this):
4007 self.this = this
4008 if not hasattr(self,"thisown"): self.thisown = 0
4009 self.__class__ = NcPaintEvent
54f9ee45 4010_core_.NcPaintEvent_swigregister(NcPaintEventPtr)
d14a1e28
RD
4011
4012#---------------------------------------------------------------------------
4013
4014class EraseEvent(Event):
093d3ff1 4015 """Proxy of C++ EraseEvent class"""
e811c8ce
RD
4016 def __repr__(self):
4017 return "<%s.%s; proxy of C++ wxEraseEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4018 def __init__(self, *args, **kwargs):
a95a7133 4019 """__init__(self, int Id=0, DC dc=(wxDC *) NULL) -> EraseEvent"""
54f9ee45 4020 newobj = _core_.new_EraseEvent(*args, **kwargs)
d14a1e28
RD
4021 self.this = newobj.this
4022 self.thisown = 1
4023 del newobj.thisown
e811c8ce 4024 def GetDC(*args, **kwargs):
a95a7133 4025 """GetDC(self) -> DC"""
54f9ee45 4026 return _core_.EraseEvent_GetDC(*args, **kwargs)
e811c8ce 4027
d14a1e28
RD
4028
4029class EraseEventPtr(EraseEvent):
4030 def __init__(self, this):
4031 self.this = this
4032 if not hasattr(self,"thisown"): self.thisown = 0
4033 self.__class__ = EraseEvent
54f9ee45 4034_core_.EraseEvent_swigregister(EraseEventPtr)
d14a1e28
RD
4035
4036#---------------------------------------------------------------------------
4037
4038class FocusEvent(Event):
093d3ff1 4039 """Proxy of C++ FocusEvent class"""
e811c8ce
RD
4040 def __repr__(self):
4041 return "<%s.%s; proxy of C++ wxFocusEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4042 def __init__(self, *args, **kwargs):
a95a7133 4043 """__init__(self, wxEventType type=wxEVT_NULL, int winid=0) -> FocusEvent"""
54f9ee45 4044 newobj = _core_.new_FocusEvent(*args, **kwargs)
d14a1e28
RD
4045 self.this = newobj.this
4046 self.thisown = 1
4047 del newobj.thisown
e811c8ce 4048 def GetWindow(*args, **kwargs):
a95a7133 4049 """GetWindow(self) -> Window"""
54f9ee45 4050 return _core_.FocusEvent_GetWindow(*args, **kwargs)
e811c8ce
RD
4051
4052 def SetWindow(*args, **kwargs):
a95a7133 4053 """SetWindow(self, Window win)"""
54f9ee45 4054 return _core_.FocusEvent_SetWindow(*args, **kwargs)
e811c8ce 4055
d14a1e28
RD
4056
4057class FocusEventPtr(FocusEvent):
4058 def __init__(self, this):
4059 self.this = this
4060 if not hasattr(self,"thisown"): self.thisown = 0
4061 self.__class__ = FocusEvent
54f9ee45 4062_core_.FocusEvent_swigregister(FocusEventPtr)
d14a1e28
RD
4063
4064#---------------------------------------------------------------------------
4065
4066class ChildFocusEvent(CommandEvent):
093d3ff1 4067 """Proxy of C++ ChildFocusEvent class"""
e811c8ce
RD
4068 def __repr__(self):
4069 return "<%s.%s; proxy of C++ wxChildFocusEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4070 def __init__(self, *args, **kwargs):
a95a7133 4071 """__init__(self, Window win=None) -> ChildFocusEvent"""
54f9ee45 4072 newobj = _core_.new_ChildFocusEvent(*args, **kwargs)
d14a1e28
RD
4073 self.this = newobj.this
4074 self.thisown = 1
4075 del newobj.thisown
e811c8ce 4076 def GetWindow(*args, **kwargs):
a95a7133 4077 """GetWindow(self) -> Window"""
54f9ee45 4078 return _core_.ChildFocusEvent_GetWindow(*args, **kwargs)
e811c8ce 4079
d14a1e28
RD
4080
4081class ChildFocusEventPtr(ChildFocusEvent):
4082 def __init__(self, this):
4083 self.this = this
4084 if not hasattr(self,"thisown"): self.thisown = 0
4085 self.__class__ = ChildFocusEvent
54f9ee45 4086_core_.ChildFocusEvent_swigregister(ChildFocusEventPtr)
d14a1e28
RD
4087
4088#---------------------------------------------------------------------------
4089
4090class ActivateEvent(Event):
093d3ff1 4091 """Proxy of C++ ActivateEvent class"""
e811c8ce
RD
4092 def __repr__(self):
4093 return "<%s.%s; proxy of C++ wxActivateEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4094 def __init__(self, *args, **kwargs):
a95a7133 4095 """__init__(self, wxEventType type=wxEVT_NULL, bool active=True, int Id=0) -> ActivateEvent"""
54f9ee45 4096 newobj = _core_.new_ActivateEvent(*args, **kwargs)
d14a1e28
RD
4097 self.this = newobj.this
4098 self.thisown = 1
4099 del newobj.thisown
e811c8ce 4100 def GetActive(*args, **kwargs):
a95a7133 4101 """GetActive(self) -> bool"""
54f9ee45 4102 return _core_.ActivateEvent_GetActive(*args, **kwargs)
e811c8ce 4103
d14a1e28
RD
4104
4105class ActivateEventPtr(ActivateEvent):
4106 def __init__(self, this):
4107 self.this = this
4108 if not hasattr(self,"thisown"): self.thisown = 0
4109 self.__class__ = ActivateEvent
54f9ee45 4110_core_.ActivateEvent_swigregister(ActivateEventPtr)
d14a1e28
RD
4111
4112#---------------------------------------------------------------------------
4113
4114class InitDialogEvent(Event):
093d3ff1 4115 """Proxy of C++ InitDialogEvent class"""
e811c8ce
RD
4116 def __repr__(self):
4117 return "<%s.%s; proxy of C++ wxInitDialogEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4118 def __init__(self, *args, **kwargs):
a95a7133 4119 """__init__(self, int Id=0) -> InitDialogEvent"""
54f9ee45 4120 newobj = _core_.new_InitDialogEvent(*args, **kwargs)
d14a1e28
RD
4121 self.this = newobj.this
4122 self.thisown = 1
4123 del newobj.thisown
d14a1e28
RD
4124
4125class InitDialogEventPtr(InitDialogEvent):
4126 def __init__(self, this):
4127 self.this = this
4128 if not hasattr(self,"thisown"): self.thisown = 0
4129 self.__class__ = InitDialogEvent
54f9ee45 4130_core_.InitDialogEvent_swigregister(InitDialogEventPtr)
d14a1e28
RD
4131
4132#---------------------------------------------------------------------------
4133
4134class MenuEvent(Event):
093d3ff1 4135 """Proxy of C++ MenuEvent class"""
e811c8ce
RD
4136 def __repr__(self):
4137 return "<%s.%s; proxy of C++ wxMenuEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4138 def __init__(self, *args, **kwargs):
a95a7133 4139 """__init__(self, wxEventType type=wxEVT_NULL, int winid=0, Menu menu=None) -> MenuEvent"""
54f9ee45 4140 newobj = _core_.new_MenuEvent(*args, **kwargs)
d14a1e28
RD
4141 self.this = newobj.this
4142 self.thisown = 1
4143 del newobj.thisown
e811c8ce 4144 def GetMenuId(*args, **kwargs):
a95a7133 4145 """GetMenuId(self) -> int"""
54f9ee45 4146 return _core_.MenuEvent_GetMenuId(*args, **kwargs)
e811c8ce
RD
4147
4148 def IsPopup(*args, **kwargs):
a95a7133 4149 """IsPopup(self) -> bool"""
54f9ee45 4150 return _core_.MenuEvent_IsPopup(*args, **kwargs)
e811c8ce
RD
4151
4152 def GetMenu(*args, **kwargs):
a95a7133 4153 """GetMenu(self) -> Menu"""
54f9ee45 4154 return _core_.MenuEvent_GetMenu(*args, **kwargs)
e811c8ce 4155
d14a1e28
RD
4156
4157class MenuEventPtr(MenuEvent):
4158 def __init__(self, this):
4159 self.this = this
4160 if not hasattr(self,"thisown"): self.thisown = 0
4161 self.__class__ = MenuEvent
54f9ee45 4162_core_.MenuEvent_swigregister(MenuEventPtr)
d14a1e28
RD
4163
4164#---------------------------------------------------------------------------
4165
4166class CloseEvent(Event):
093d3ff1 4167 """Proxy of C++ CloseEvent class"""
e811c8ce
RD
4168 def __repr__(self):
4169 return "<%s.%s; proxy of C++ wxCloseEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4170 def __init__(self, *args, **kwargs):
a95a7133 4171 """__init__(self, wxEventType type=wxEVT_NULL, int winid=0) -> CloseEvent"""
54f9ee45 4172 newobj = _core_.new_CloseEvent(*args, **kwargs)
d14a1e28
RD
4173 self.this = newobj.this
4174 self.thisown = 1
4175 del newobj.thisown
e811c8ce 4176 def SetLoggingOff(*args, **kwargs):
a95a7133 4177 """SetLoggingOff(self, bool logOff)"""
54f9ee45 4178 return _core_.CloseEvent_SetLoggingOff(*args, **kwargs)
e811c8ce
RD
4179
4180 def GetLoggingOff(*args, **kwargs):
a95a7133 4181 """GetLoggingOff(self) -> bool"""
54f9ee45 4182 return _core_.CloseEvent_GetLoggingOff(*args, **kwargs)
e811c8ce
RD
4183
4184 def Veto(*args, **kwargs):
a95a7133 4185 """Veto(self, bool veto=True)"""
54f9ee45 4186 return _core_.CloseEvent_Veto(*args, **kwargs)
e811c8ce
RD
4187
4188 def SetCanVeto(*args, **kwargs):
a95a7133 4189 """SetCanVeto(self, bool canVeto)"""
54f9ee45 4190 return _core_.CloseEvent_SetCanVeto(*args, **kwargs)
e811c8ce
RD
4191
4192 def CanVeto(*args, **kwargs):
a95a7133 4193 """CanVeto(self) -> bool"""
54f9ee45 4194 return _core_.CloseEvent_CanVeto(*args, **kwargs)
e811c8ce
RD
4195
4196 def GetVeto(*args, **kwargs):
a95a7133 4197 """GetVeto(self) -> bool"""
54f9ee45 4198 return _core_.CloseEvent_GetVeto(*args, **kwargs)
e811c8ce 4199
d14a1e28
RD
4200
4201class CloseEventPtr(CloseEvent):
4202 def __init__(self, this):
4203 self.this = this
4204 if not hasattr(self,"thisown"): self.thisown = 0
4205 self.__class__ = CloseEvent
54f9ee45 4206_core_.CloseEvent_swigregister(CloseEventPtr)
d14a1e28
RD
4207
4208#---------------------------------------------------------------------------
4209
4210class ShowEvent(Event):
093d3ff1 4211 """Proxy of C++ ShowEvent class"""
e811c8ce
RD
4212 def __repr__(self):
4213 return "<%s.%s; proxy of C++ wxShowEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4214 def __init__(self, *args, **kwargs):
a95a7133 4215 """__init__(self, int winid=0, bool show=False) -> ShowEvent"""
54f9ee45 4216 newobj = _core_.new_ShowEvent(*args, **kwargs)
d14a1e28
RD
4217 self.this = newobj.this
4218 self.thisown = 1
4219 del newobj.thisown
e811c8ce 4220 def SetShow(*args, **kwargs):
a95a7133 4221 """SetShow(self, bool show)"""
54f9ee45 4222 return _core_.ShowEvent_SetShow(*args, **kwargs)
e811c8ce
RD
4223
4224 def GetShow(*args, **kwargs):
a95a7133 4225 """GetShow(self) -> bool"""
54f9ee45 4226 return _core_.ShowEvent_GetShow(*args, **kwargs)
e811c8ce 4227
d14a1e28
RD
4228
4229class ShowEventPtr(ShowEvent):
4230 def __init__(self, this):
4231 self.this = this
4232 if not hasattr(self,"thisown"): self.thisown = 0
4233 self.__class__ = ShowEvent
54f9ee45 4234_core_.ShowEvent_swigregister(ShowEventPtr)
d14a1e28
RD
4235
4236#---------------------------------------------------------------------------
4237
4238class IconizeEvent(Event):
093d3ff1 4239 """Proxy of C++ IconizeEvent class"""
e811c8ce
RD
4240 def __repr__(self):
4241 return "<%s.%s; proxy of C++ wxIconizeEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4242 def __init__(self, *args, **kwargs):
a95a7133 4243 """__init__(self, int id=0, bool iconized=True) -> IconizeEvent"""
54f9ee45 4244 newobj = _core_.new_IconizeEvent(*args, **kwargs)
d14a1e28
RD
4245 self.this = newobj.this
4246 self.thisown = 1
4247 del newobj.thisown
e811c8ce 4248 def Iconized(*args, **kwargs):
a95a7133 4249 """Iconized(self) -> bool"""
54f9ee45 4250 return _core_.IconizeEvent_Iconized(*args, **kwargs)
e811c8ce 4251
d14a1e28
RD
4252
4253class IconizeEventPtr(IconizeEvent):
4254 def __init__(self, this):
4255 self.this = this
4256 if not hasattr(self,"thisown"): self.thisown = 0
4257 self.__class__ = IconizeEvent
54f9ee45 4258_core_.IconizeEvent_swigregister(IconizeEventPtr)
d14a1e28
RD
4259
4260#---------------------------------------------------------------------------
4261
4262class MaximizeEvent(Event):
093d3ff1 4263 """Proxy of C++ MaximizeEvent class"""
e811c8ce
RD
4264 def __repr__(self):
4265 return "<%s.%s; proxy of C++ wxMaximizeEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4266 def __init__(self, *args, **kwargs):
a95a7133 4267 """__init__(self, int id=0) -> MaximizeEvent"""
54f9ee45 4268 newobj = _core_.new_MaximizeEvent(*args, **kwargs)
d14a1e28
RD
4269 self.this = newobj.this
4270 self.thisown = 1
4271 del newobj.thisown
d14a1e28
RD
4272
4273class MaximizeEventPtr(MaximizeEvent):
4274 def __init__(self, this):
4275 self.this = this
4276 if not hasattr(self,"thisown"): self.thisown = 0
4277 self.__class__ = MaximizeEvent
54f9ee45 4278_core_.MaximizeEvent_swigregister(MaximizeEventPtr)
d14a1e28
RD
4279
4280#---------------------------------------------------------------------------
4281
4282class DropFilesEvent(Event):
093d3ff1 4283 """Proxy of C++ DropFilesEvent class"""
d14a1e28
RD
4284 def __init__(self): raise RuntimeError, "No constructor defined"
4285 def __repr__(self):
4286 return "<%s.%s; proxy of C++ wxDropFilesEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
e811c8ce 4287 def GetPosition(*args, **kwargs):
a95a7133 4288 """GetPosition(self) -> Point"""
54f9ee45 4289 return _core_.DropFilesEvent_GetPosition(*args, **kwargs)
e811c8ce
RD
4290
4291 def GetNumberOfFiles(*args, **kwargs):
a95a7133 4292 """GetNumberOfFiles(self) -> int"""
54f9ee45 4293 return _core_.DropFilesEvent_GetNumberOfFiles(*args, **kwargs)
e811c8ce
RD
4294
4295 def GetFiles(*args, **kwargs):
a95a7133 4296 """GetFiles(self) -> PyObject"""
54f9ee45 4297 return _core_.DropFilesEvent_GetFiles(*args, **kwargs)
e811c8ce 4298
d14a1e28
RD
4299
4300class DropFilesEventPtr(DropFilesEvent):
4301 def __init__(self, this):
4302 self.this = this
4303 if not hasattr(self,"thisown"): self.thisown = 0
4304 self.__class__ = DropFilesEvent
54f9ee45 4305_core_.DropFilesEvent_swigregister(DropFilesEventPtr)
d14a1e28
RD
4306
4307#---------------------------------------------------------------------------
4308
54f9ee45
RD
4309UPDATE_UI_PROCESS_ALL = _core_.UPDATE_UI_PROCESS_ALL
4310UPDATE_UI_PROCESS_SPECIFIED = _core_.UPDATE_UI_PROCESS_SPECIFIED
d14a1e28 4311class UpdateUIEvent(CommandEvent):
093d3ff1 4312 """Proxy of C++ UpdateUIEvent class"""
e811c8ce
RD
4313 def __repr__(self):
4314 return "<%s.%s; proxy of C++ wxUpdateUIEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4315 def __init__(self, *args, **kwargs):
a95a7133 4316 """__init__(self, int commandId=0) -> UpdateUIEvent"""
54f9ee45 4317 newobj = _core_.new_UpdateUIEvent(*args, **kwargs)
d14a1e28
RD
4318 self.this = newobj.this
4319 self.thisown = 1
4320 del newobj.thisown
e811c8ce 4321 def GetChecked(*args, **kwargs):
a95a7133 4322 """GetChecked(self) -> bool"""
54f9ee45 4323 return _core_.UpdateUIEvent_GetChecked(*args, **kwargs)
e811c8ce
RD
4324
4325 def GetEnabled(*args, **kwargs):
a95a7133 4326 """GetEnabled(self) -> bool"""
54f9ee45 4327 return _core_.UpdateUIEvent_GetEnabled(*args, **kwargs)
e811c8ce
RD
4328
4329 def GetText(*args, **kwargs):
a95a7133 4330 """GetText(self) -> String"""
54f9ee45 4331 return _core_.UpdateUIEvent_GetText(*args, **kwargs)
e811c8ce
RD
4332
4333 def GetSetText(*args, **kwargs):
a95a7133 4334 """GetSetText(self) -> bool"""
54f9ee45 4335 return _core_.UpdateUIEvent_GetSetText(*args, **kwargs)
e811c8ce
RD
4336
4337 def GetSetChecked(*args, **kwargs):
a95a7133 4338 """GetSetChecked(self) -> bool"""
54f9ee45 4339 return _core_.UpdateUIEvent_GetSetChecked(*args, **kwargs)
e811c8ce
RD
4340
4341 def GetSetEnabled(*args, **kwargs):
a95a7133 4342 """GetSetEnabled(self) -> bool"""
54f9ee45 4343 return _core_.UpdateUIEvent_GetSetEnabled(*args, **kwargs)
e811c8ce
RD
4344
4345 def Check(*args, **kwargs):
a95a7133 4346 """Check(self, bool check)"""
54f9ee45 4347 return _core_.UpdateUIEvent_Check(*args, **kwargs)
e811c8ce
RD
4348
4349 def Enable(*args, **kwargs):
a95a7133 4350 """Enable(self, bool enable)"""
54f9ee45 4351 return _core_.UpdateUIEvent_Enable(*args, **kwargs)
e811c8ce
RD
4352
4353 def SetText(*args, **kwargs):
a95a7133 4354 """SetText(self, String text)"""
54f9ee45 4355 return _core_.UpdateUIEvent_SetText(*args, **kwargs)
e811c8ce
RD
4356
4357 def SetUpdateInterval(*args, **kwargs):
66c033b4 4358 """SetUpdateInterval(long updateInterval)"""
54f9ee45 4359 return _core_.UpdateUIEvent_SetUpdateInterval(*args, **kwargs)
e811c8ce
RD
4360
4361 SetUpdateInterval = staticmethod(SetUpdateInterval)
4362 def GetUpdateInterval(*args, **kwargs):
66c033b4 4363 """GetUpdateInterval() -> long"""
54f9ee45 4364 return _core_.UpdateUIEvent_GetUpdateInterval(*args, **kwargs)
e811c8ce
RD
4365
4366 GetUpdateInterval = staticmethod(GetUpdateInterval)
4367 def CanUpdate(*args, **kwargs):
66c033b4 4368 """CanUpdate(Window win) -> bool"""
54f9ee45 4369 return _core_.UpdateUIEvent_CanUpdate(*args, **kwargs)
e811c8ce
RD
4370
4371 CanUpdate = staticmethod(CanUpdate)
4372 def ResetUpdateTime(*args, **kwargs):
66c033b4 4373 """ResetUpdateTime()"""
54f9ee45 4374 return _core_.UpdateUIEvent_ResetUpdateTime(*args, **kwargs)
e811c8ce
RD
4375
4376 ResetUpdateTime = staticmethod(ResetUpdateTime)
4377 def SetMode(*args, **kwargs):
66c033b4 4378 """SetMode(int mode)"""
54f9ee45 4379 return _core_.UpdateUIEvent_SetMode(*args, **kwargs)
e811c8ce
RD
4380
4381 SetMode = staticmethod(SetMode)
4382 def GetMode(*args, **kwargs):
66c033b4 4383 """GetMode() -> int"""
54f9ee45 4384 return _core_.UpdateUIEvent_GetMode(*args, **kwargs)
e811c8ce
RD
4385
4386 GetMode = staticmethod(GetMode)
d14a1e28
RD
4387
4388class UpdateUIEventPtr(UpdateUIEvent):
4389 def __init__(self, this):
4390 self.this = this
4391 if not hasattr(self,"thisown"): self.thisown = 0
4392 self.__class__ = UpdateUIEvent
54f9ee45 4393_core_.UpdateUIEvent_swigregister(UpdateUIEventPtr)
d14a1e28 4394
e811c8ce
RD
4395def UpdateUIEvent_SetUpdateInterval(*args, **kwargs):
4396 """UpdateUIEvent_SetUpdateInterval(long updateInterval)"""
54f9ee45 4397 return _core_.UpdateUIEvent_SetUpdateInterval(*args, **kwargs)
d14a1e28 4398
e811c8ce
RD
4399def UpdateUIEvent_GetUpdateInterval(*args, **kwargs):
4400 """UpdateUIEvent_GetUpdateInterval() -> long"""
54f9ee45 4401 return _core_.UpdateUIEvent_GetUpdateInterval(*args, **kwargs)
d14a1e28 4402
e811c8ce
RD
4403def UpdateUIEvent_CanUpdate(*args, **kwargs):
4404 """UpdateUIEvent_CanUpdate(Window win) -> bool"""
54f9ee45 4405 return _core_.UpdateUIEvent_CanUpdate(*args, **kwargs)
d14a1e28 4406
e811c8ce
RD
4407def UpdateUIEvent_ResetUpdateTime(*args, **kwargs):
4408 """UpdateUIEvent_ResetUpdateTime()"""
54f9ee45 4409 return _core_.UpdateUIEvent_ResetUpdateTime(*args, **kwargs)
d14a1e28 4410
e811c8ce 4411def UpdateUIEvent_SetMode(*args, **kwargs):
196addbf 4412 """UpdateUIEvent_SetMode(int mode)"""
54f9ee45 4413 return _core_.UpdateUIEvent_SetMode(*args, **kwargs)
d14a1e28 4414
e811c8ce 4415def UpdateUIEvent_GetMode(*args, **kwargs):
196addbf 4416 """UpdateUIEvent_GetMode() -> int"""
54f9ee45 4417 return _core_.UpdateUIEvent_GetMode(*args, **kwargs)
d14a1e28
RD
4418
4419#---------------------------------------------------------------------------
4420
4421class SysColourChangedEvent(Event):
093d3ff1 4422 """Proxy of C++ SysColourChangedEvent class"""
e811c8ce
RD
4423 def __repr__(self):
4424 return "<%s.%s; proxy of C++ wxSysColourChangedEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4425 def __init__(self, *args, **kwargs):
a95a7133 4426 """__init__(self) -> SysColourChangedEvent"""
54f9ee45 4427 newobj = _core_.new_SysColourChangedEvent(*args, **kwargs)
d14a1e28
RD
4428 self.this = newobj.this
4429 self.thisown = 1
4430 del newobj.thisown
d14a1e28
RD
4431
4432class SysColourChangedEventPtr(SysColourChangedEvent):
4433 def __init__(self, this):
4434 self.this = this
4435 if not hasattr(self,"thisown"): self.thisown = 0
4436 self.__class__ = SysColourChangedEvent
54f9ee45 4437_core_.SysColourChangedEvent_swigregister(SysColourChangedEventPtr)
d14a1e28
RD
4438
4439#---------------------------------------------------------------------------
4440
4441class MouseCaptureChangedEvent(Event):
093d3ff1 4442 """Proxy of C++ MouseCaptureChangedEvent class"""
e811c8ce
RD
4443 def __repr__(self):
4444 return "<%s.%s; proxy of C++ wxMouseCaptureChangedEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4445 def __init__(self, *args, **kwargs):
a95a7133 4446 """__init__(self, int winid=0, Window gainedCapture=None) -> MouseCaptureChangedEvent"""
54f9ee45 4447 newobj = _core_.new_MouseCaptureChangedEvent(*args, **kwargs)
d14a1e28
RD
4448 self.this = newobj.this
4449 self.thisown = 1
4450 del newobj.thisown
e811c8ce 4451 def GetCapturedWindow(*args, **kwargs):
a95a7133 4452 """GetCapturedWindow(self) -> Window"""
54f9ee45 4453 return _core_.MouseCaptureChangedEvent_GetCapturedWindow(*args, **kwargs)
e811c8ce 4454
d14a1e28
RD
4455
4456class MouseCaptureChangedEventPtr(MouseCaptureChangedEvent):
4457 def __init__(self, this):
4458 self.this = this
4459 if not hasattr(self,"thisown"): self.thisown = 0
4460 self.__class__ = MouseCaptureChangedEvent
54f9ee45 4461_core_.MouseCaptureChangedEvent_swigregister(MouseCaptureChangedEventPtr)
d14a1e28
RD
4462
4463#---------------------------------------------------------------------------
4464
4465class DisplayChangedEvent(Event):
093d3ff1 4466 """Proxy of C++ DisplayChangedEvent class"""
e811c8ce
RD
4467 def __repr__(self):
4468 return "<%s.%s; proxy of C++ wxDisplayChangedEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4469 def __init__(self, *args, **kwargs):
a95a7133 4470 """__init__(self) -> DisplayChangedEvent"""
54f9ee45 4471 newobj = _core_.new_DisplayChangedEvent(*args, **kwargs)
d14a1e28
RD
4472 self.this = newobj.this
4473 self.thisown = 1
4474 del newobj.thisown
d14a1e28
RD
4475
4476class DisplayChangedEventPtr(DisplayChangedEvent):
4477 def __init__(self, this):
4478 self.this = this
4479 if not hasattr(self,"thisown"): self.thisown = 0
4480 self.__class__ = DisplayChangedEvent
54f9ee45 4481_core_.DisplayChangedEvent_swigregister(DisplayChangedEventPtr)
d14a1e28
RD
4482
4483#---------------------------------------------------------------------------
4484
4485class PaletteChangedEvent(Event):
093d3ff1 4486 """Proxy of C++ PaletteChangedEvent class"""
e811c8ce
RD
4487 def __repr__(self):
4488 return "<%s.%s; proxy of C++ wxPaletteChangedEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4489 def __init__(self, *args, **kwargs):
a95a7133 4490 """__init__(self, int id=0) -> PaletteChangedEvent"""
54f9ee45 4491 newobj = _core_.new_PaletteChangedEvent(*args, **kwargs)
d14a1e28
RD
4492 self.this = newobj.this
4493 self.thisown = 1
4494 del newobj.thisown
e811c8ce 4495 def SetChangedWindow(*args, **kwargs):
a95a7133 4496 """SetChangedWindow(self, Window win)"""
54f9ee45 4497 return _core_.PaletteChangedEvent_SetChangedWindow(*args, **kwargs)
e811c8ce
RD
4498
4499 def GetChangedWindow(*args, **kwargs):
a95a7133 4500 """GetChangedWindow(self) -> Window"""
54f9ee45 4501 return _core_.PaletteChangedEvent_GetChangedWindow(*args, **kwargs)
e811c8ce 4502
d14a1e28
RD
4503
4504class PaletteChangedEventPtr(PaletteChangedEvent):
4505 def __init__(self, this):
4506 self.this = this
4507 if not hasattr(self,"thisown"): self.thisown = 0
4508 self.__class__ = PaletteChangedEvent
54f9ee45 4509_core_.PaletteChangedEvent_swigregister(PaletteChangedEventPtr)
d14a1e28
RD
4510
4511#---------------------------------------------------------------------------
4512
4513class QueryNewPaletteEvent(Event):
093d3ff1 4514 """Proxy of C++ QueryNewPaletteEvent class"""
e811c8ce
RD
4515 def __repr__(self):
4516 return "<%s.%s; proxy of C++ wxQueryNewPaletteEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4517 def __init__(self, *args, **kwargs):
a95a7133 4518 """__init__(self, int winid=0) -> QueryNewPaletteEvent"""
54f9ee45 4519 newobj = _core_.new_QueryNewPaletteEvent(*args, **kwargs)
d14a1e28
RD
4520 self.this = newobj.this
4521 self.thisown = 1
4522 del newobj.thisown
e811c8ce 4523 def SetPaletteRealized(*args, **kwargs):
a95a7133 4524 """SetPaletteRealized(self, bool realized)"""
54f9ee45 4525 return _core_.QueryNewPaletteEvent_SetPaletteRealized(*args, **kwargs)
e811c8ce
RD
4526
4527 def GetPaletteRealized(*args, **kwargs):
a95a7133 4528 """GetPaletteRealized(self) -> bool"""
54f9ee45 4529 return _core_.QueryNewPaletteEvent_GetPaletteRealized(*args, **kwargs)
e811c8ce 4530
d14a1e28
RD
4531
4532class QueryNewPaletteEventPtr(QueryNewPaletteEvent):
4533 def __init__(self, this):
4534 self.this = this
4535 if not hasattr(self,"thisown"): self.thisown = 0
4536 self.__class__ = QueryNewPaletteEvent
54f9ee45 4537_core_.QueryNewPaletteEvent_swigregister(QueryNewPaletteEventPtr)
d14a1e28
RD
4538
4539#---------------------------------------------------------------------------
4540
4541class NavigationKeyEvent(Event):
093d3ff1 4542 """Proxy of C++ NavigationKeyEvent class"""
e811c8ce
RD
4543 def __repr__(self):
4544 return "<%s.%s; proxy of C++ wxNavigationKeyEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4545 def __init__(self, *args, **kwargs):
a95a7133 4546 """__init__(self) -> NavigationKeyEvent"""
54f9ee45 4547 newobj = _core_.new_NavigationKeyEvent(*args, **kwargs)
d14a1e28
RD
4548 self.this = newobj.this
4549 self.thisown = 1
4550 del newobj.thisown
e811c8ce 4551 def GetDirection(*args, **kwargs):
a95a7133 4552 """GetDirection(self) -> bool"""
54f9ee45 4553 return _core_.NavigationKeyEvent_GetDirection(*args, **kwargs)
e811c8ce
RD
4554
4555 def SetDirection(*args, **kwargs):
908b74cd 4556 """SetDirection(self, bool forward)"""
54f9ee45 4557 return _core_.NavigationKeyEvent_SetDirection(*args, **kwargs)
e811c8ce
RD
4558
4559 def IsWindowChange(*args, **kwargs):
a95a7133 4560 """IsWindowChange(self) -> bool"""
54f9ee45 4561 return _core_.NavigationKeyEvent_IsWindowChange(*args, **kwargs)
e811c8ce
RD
4562
4563 def SetWindowChange(*args, **kwargs):
908b74cd 4564 """SetWindowChange(self, bool ischange)"""
54f9ee45 4565 return _core_.NavigationKeyEvent_SetWindowChange(*args, **kwargs)
e811c8ce 4566
908b74cd
RD
4567 def SetFlags(*args, **kwargs):
4568 """SetFlags(self, long flags)"""
4569 return _core_.NavigationKeyEvent_SetFlags(*args, **kwargs)
4570
e811c8ce 4571 def GetCurrentFocus(*args, **kwargs):
a95a7133 4572 """GetCurrentFocus(self) -> Window"""
54f9ee45 4573 return _core_.NavigationKeyEvent_GetCurrentFocus(*args, **kwargs)
e811c8ce
RD
4574
4575 def SetCurrentFocus(*args, **kwargs):
a95a7133 4576 """SetCurrentFocus(self, Window win)"""
54f9ee45 4577 return _core_.NavigationKeyEvent_SetCurrentFocus(*args, **kwargs)
e811c8ce 4578
b0f7404b 4579 IsBackward = _core_.NavigationKeyEvent_IsBackward
908b74cd
RD
4580 IsForward = _core_.NavigationKeyEvent_IsForward
4581 WinChange = _core_.NavigationKeyEvent_WinChange
d14a1e28
RD
4582
4583class NavigationKeyEventPtr(NavigationKeyEvent):
4584 def __init__(self, this):
4585 self.this = this
4586 if not hasattr(self,"thisown"): self.thisown = 0
4587 self.__class__ = NavigationKeyEvent
54f9ee45 4588_core_.NavigationKeyEvent_swigregister(NavigationKeyEventPtr)
d14a1e28
RD
4589
4590#---------------------------------------------------------------------------
4591
4592class WindowCreateEvent(CommandEvent):
093d3ff1 4593 """Proxy of C++ WindowCreateEvent class"""
e811c8ce
RD
4594 def __repr__(self):
4595 return "<%s.%s; proxy of C++ wxWindowCreateEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4596 def __init__(self, *args, **kwargs):
a95a7133 4597 """__init__(self, Window win=None) -> WindowCreateEvent"""
54f9ee45 4598 newobj = _core_.new_WindowCreateEvent(*args, **kwargs)
d14a1e28
RD
4599 self.this = newobj.this
4600 self.thisown = 1
4601 del newobj.thisown
e811c8ce 4602 def GetWindow(*args, **kwargs):
a95a7133 4603 """GetWindow(self) -> Window"""
54f9ee45 4604 return _core_.WindowCreateEvent_GetWindow(*args, **kwargs)
e811c8ce 4605
d14a1e28
RD
4606
4607class WindowCreateEventPtr(WindowCreateEvent):
4608 def __init__(self, this):
4609 self.this = this
4610 if not hasattr(self,"thisown"): self.thisown = 0
4611 self.__class__ = WindowCreateEvent
54f9ee45 4612_core_.WindowCreateEvent_swigregister(WindowCreateEventPtr)
d14a1e28
RD
4613
4614class WindowDestroyEvent(CommandEvent):
093d3ff1 4615 """Proxy of C++ WindowDestroyEvent class"""
e811c8ce
RD
4616 def __repr__(self):
4617 return "<%s.%s; proxy of C++ wxWindowDestroyEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4618 def __init__(self, *args, **kwargs):
a95a7133 4619 """__init__(self, Window win=None) -> WindowDestroyEvent"""
54f9ee45 4620 newobj = _core_.new_WindowDestroyEvent(*args, **kwargs)
d14a1e28
RD
4621 self.this = newobj.this
4622 self.thisown = 1
4623 del newobj.thisown
e811c8ce 4624 def GetWindow(*args, **kwargs):
a95a7133 4625 """GetWindow(self) -> Window"""
54f9ee45 4626 return _core_.WindowDestroyEvent_GetWindow(*args, **kwargs)
e811c8ce 4627
d14a1e28
RD
4628
4629class WindowDestroyEventPtr(WindowDestroyEvent):
4630 def __init__(self, this):
4631 self.this = this
4632 if not hasattr(self,"thisown"): self.thisown = 0
4633 self.__class__ = WindowDestroyEvent
54f9ee45 4634_core_.WindowDestroyEvent_swigregister(WindowDestroyEventPtr)
d14a1e28
RD
4635
4636#---------------------------------------------------------------------------
4637
4638class ContextMenuEvent(CommandEvent):
093d3ff1 4639 """Proxy of C++ ContextMenuEvent class"""
e811c8ce
RD
4640 def __repr__(self):
4641 return "<%s.%s; proxy of C++ wxContextMenuEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4642 def __init__(self, *args, **kwargs):
a95a7133 4643 """__init__(self, wxEventType type=wxEVT_NULL, int winid=0, Point pt=DefaultPosition) -> ContextMenuEvent"""
54f9ee45 4644 newobj = _core_.new_ContextMenuEvent(*args, **kwargs)
d14a1e28
RD
4645 self.this = newobj.this
4646 self.thisown = 1
4647 del newobj.thisown
e811c8ce 4648 def GetPosition(*args, **kwargs):
a95a7133 4649 """GetPosition(self) -> Point"""
54f9ee45 4650 return _core_.ContextMenuEvent_GetPosition(*args, **kwargs)
e811c8ce
RD
4651
4652 def SetPosition(*args, **kwargs):
a95a7133 4653 """SetPosition(self, Point pos)"""
54f9ee45 4654 return _core_.ContextMenuEvent_SetPosition(*args, **kwargs)
e811c8ce 4655
d14a1e28
RD
4656
4657class ContextMenuEventPtr(ContextMenuEvent):
4658 def __init__(self, this):
4659 self.this = this
4660 if not hasattr(self,"thisown"): self.thisown = 0
4661 self.__class__ = ContextMenuEvent
54f9ee45 4662_core_.ContextMenuEvent_swigregister(ContextMenuEventPtr)
d14a1e28
RD
4663
4664#---------------------------------------------------------------------------
4665
54f9ee45
RD
4666IDLE_PROCESS_ALL = _core_.IDLE_PROCESS_ALL
4667IDLE_PROCESS_SPECIFIED = _core_.IDLE_PROCESS_SPECIFIED
d14a1e28 4668class IdleEvent(Event):
093d3ff1 4669 """Proxy of C++ IdleEvent class"""
e811c8ce
RD
4670 def __repr__(self):
4671 return "<%s.%s; proxy of C++ wxIdleEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4672 def __init__(self, *args, **kwargs):
a95a7133 4673 """__init__(self) -> IdleEvent"""
54f9ee45 4674 newobj = _core_.new_IdleEvent(*args, **kwargs)
d14a1e28
RD
4675 self.this = newobj.this
4676 self.thisown = 1
4677 del newobj.thisown
e811c8ce 4678 def RequestMore(*args, **kwargs):
a95a7133 4679 """RequestMore(self, bool needMore=True)"""
54f9ee45 4680 return _core_.IdleEvent_RequestMore(*args, **kwargs)
e811c8ce
RD
4681
4682 def MoreRequested(*args, **kwargs):
a95a7133 4683 """MoreRequested(self) -> bool"""
54f9ee45 4684 return _core_.IdleEvent_MoreRequested(*args, **kwargs)
e811c8ce
RD
4685
4686 def SetMode(*args, **kwargs):
66c033b4 4687 """SetMode(int mode)"""
54f9ee45 4688 return _core_.IdleEvent_SetMode(*args, **kwargs)
e811c8ce
RD
4689
4690 SetMode = staticmethod(SetMode)
4691 def GetMode(*args, **kwargs):
66c033b4 4692 """GetMode() -> int"""
54f9ee45 4693 return _core_.IdleEvent_GetMode(*args, **kwargs)
e811c8ce
RD
4694
4695 GetMode = staticmethod(GetMode)
4696 def CanSend(*args, **kwargs):
66c033b4 4697 """CanSend(Window win) -> bool"""
54f9ee45 4698 return _core_.IdleEvent_CanSend(*args, **kwargs)
e811c8ce
RD
4699
4700 CanSend = staticmethod(CanSend)
d14a1e28
RD
4701
4702class IdleEventPtr(IdleEvent):
4703 def __init__(self, this):
4704 self.this = this
4705 if not hasattr(self,"thisown"): self.thisown = 0
4706 self.__class__ = IdleEvent
54f9ee45 4707_core_.IdleEvent_swigregister(IdleEventPtr)
d14a1e28 4708
e811c8ce 4709def IdleEvent_SetMode(*args, **kwargs):
196addbf 4710 """IdleEvent_SetMode(int mode)"""
54f9ee45 4711 return _core_.IdleEvent_SetMode(*args, **kwargs)
d14a1e28 4712
e811c8ce 4713def IdleEvent_GetMode(*args, **kwargs):
196addbf 4714 """IdleEvent_GetMode() -> int"""
54f9ee45 4715 return _core_.IdleEvent_GetMode(*args, **kwargs)
d14a1e28 4716
e811c8ce
RD
4717def IdleEvent_CanSend(*args, **kwargs):
4718 """IdleEvent_CanSend(Window win) -> bool"""
54f9ee45 4719 return _core_.IdleEvent_CanSend(*args, **kwargs)
d14a1e28
RD
4720
4721#---------------------------------------------------------------------------
4722
4723class PyEvent(Event):
093d3ff1 4724 """Proxy of C++ PyEvent class"""
e811c8ce
RD
4725 def __repr__(self):
4726 return "<%s.%s; proxy of C++ wxPyEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4727 def __init__(self, *args, **kwargs):
a95a7133 4728 """__init__(self, int winid=0, wxEventType commandType=wxEVT_NULL) -> PyEvent"""
54f9ee45 4729 newobj = _core_.new_PyEvent(*args, **kwargs)
d14a1e28
RD
4730 self.this = newobj.this
4731 self.thisown = 1
4732 del newobj.thisown
4733 self.SetSelf(self)
e811c8ce 4734
54f9ee45 4735 def __del__(self, destroy=_core_.delete_PyEvent):
a95a7133 4736 """__del__(self)"""
d14a1e28
RD
4737 try:
4738 if self.thisown: destroy(self)
4739 except: pass
e811c8ce
RD
4740
4741 def SetSelf(*args, **kwargs):
a95a7133 4742 """SetSelf(self, PyObject self)"""
54f9ee45 4743 return _core_.PyEvent_SetSelf(*args, **kwargs)
e811c8ce
RD
4744
4745 def GetSelf(*args, **kwargs):
a95a7133 4746 """GetSelf(self) -> PyObject"""
54f9ee45 4747 return _core_.PyEvent_GetSelf(*args, **kwargs)
e811c8ce 4748
d14a1e28
RD
4749
4750class PyEventPtr(PyEvent):
4751 def __init__(self, this):
4752 self.this = this
4753 if not hasattr(self,"thisown"): self.thisown = 0
4754 self.__class__ = PyEvent
54f9ee45 4755_core_.PyEvent_swigregister(PyEventPtr)
d14a1e28
RD
4756
4757class PyCommandEvent(CommandEvent):
093d3ff1 4758 """Proxy of C++ PyCommandEvent class"""
e811c8ce
RD
4759 def __repr__(self):
4760 return "<%s.%s; proxy of C++ wxPyCommandEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4761 def __init__(self, *args, **kwargs):
a95a7133 4762 """__init__(self, wxEventType commandType=wxEVT_NULL, int id=0) -> PyCommandEvent"""
54f9ee45 4763 newobj = _core_.new_PyCommandEvent(*args, **kwargs)
d14a1e28
RD
4764 self.this = newobj.this
4765 self.thisown = 1
4766 del newobj.thisown
4767 self.SetSelf(self)
e811c8ce 4768
54f9ee45 4769 def __del__(self, destroy=_core_.delete_PyCommandEvent):
a95a7133 4770 """__del__(self)"""
d14a1e28
RD
4771 try:
4772 if self.thisown: destroy(self)
4773 except: pass
e811c8ce
RD
4774
4775 def SetSelf(*args, **kwargs):
a95a7133 4776 """SetSelf(self, PyObject self)"""
54f9ee45 4777 return _core_.PyCommandEvent_SetSelf(*args, **kwargs)
e811c8ce
RD
4778
4779 def GetSelf(*args, **kwargs):
a95a7133 4780 """GetSelf(self) -> PyObject"""
54f9ee45 4781 return _core_.PyCommandEvent_GetSelf(*args, **kwargs)
e811c8ce 4782
d14a1e28
RD
4783
4784class PyCommandEventPtr(PyCommandEvent):
4785 def __init__(self, this):
4786 self.this = this
4787 if not hasattr(self,"thisown"): self.thisown = 0
4788 self.__class__ = PyCommandEvent
54f9ee45 4789_core_.PyCommandEvent_swigregister(PyCommandEventPtr)
d14a1e28
RD
4790
4791#---------------------------------------------------------------------------
4792
54f9ee45
RD
4793PYAPP_ASSERT_SUPPRESS = _core_.PYAPP_ASSERT_SUPPRESS
4794PYAPP_ASSERT_EXCEPTION = _core_.PYAPP_ASSERT_EXCEPTION
4795PYAPP_ASSERT_DIALOG = _core_.PYAPP_ASSERT_DIALOG
4796PYAPP_ASSERT_LOG = _core_.PYAPP_ASSERT_LOG
4797PRINT_WINDOWS = _core_.PRINT_WINDOWS
4798PRINT_POSTSCRIPT = _core_.PRINT_POSTSCRIPT
d14a1e28 4799class PyApp(EvtHandler):
66c033b4
RD
4800 """
4801 The ``wx.PyApp`` class is an *implementation detail*, please use the
4802 `wx.App` class (or some other derived class) instead.
4803 """
e811c8ce
RD
4804 def __repr__(self):
4805 return "<%s.%s; proxy of C++ wxPyApp instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4806 def __init__(self, *args, **kwargs):
98e665d3 4807 """
a95a7133 4808 __init__(self) -> PyApp
98e665d3
RD
4809
4810 Create a new application object, starting the bootstrap process.
4811 """
54f9ee45 4812 newobj = _core_.new_PyApp(*args, **kwargs)
d14a1e28
RD
4813 self.this = newobj.this
4814 self.thisown = 1
4815 del newobj.thisown
4816 self._setCallbackInfo(self, PyApp)
4817 self._setOORInfo(self)
e811c8ce 4818
54f9ee45 4819 def __del__(self, destroy=_core_.delete_PyApp):
a95a7133 4820 """__del__(self)"""
d14a1e28
RD
4821 try:
4822 if self.thisown: destroy(self)
4823 except: pass
e811c8ce
RD
4824
4825 def _setCallbackInfo(*args, **kwargs):
a95a7133 4826 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
54f9ee45 4827 return _core_.PyApp__setCallbackInfo(*args, **kwargs)
e811c8ce
RD
4828
4829 def GetAppName(*args, **kwargs):
0df68c9f 4830 """
a95a7133 4831 GetAppName(self) -> String
6c3b4aae 4832
0df68c9f
RD
4833 Get the application name.
4834 """
54f9ee45 4835 return _core_.PyApp_GetAppName(*args, **kwargs)
e811c8ce
RD
4836
4837 def SetAppName(*args, **kwargs):
0df68c9f 4838 """
a95a7133 4839 SetAppName(self, String name)
6c3b4aae 4840
66c033b4
RD
4841 Set the application name. This value may be used automatically by
4842 `wx.Config` and such.
0df68c9f 4843 """
54f9ee45 4844 return _core_.PyApp_SetAppName(*args, **kwargs)
e811c8ce
RD
4845
4846 def GetClassName(*args, **kwargs):
0df68c9f 4847 """
a95a7133 4848 GetClassName(self) -> String
e811c8ce 4849
0df68c9f
RD
4850 Get the application's class name.
4851 """
54f9ee45 4852 return _core_.PyApp_GetClassName(*args, **kwargs)
e811c8ce
RD
4853
4854 def SetClassName(*args, **kwargs):
0df68c9f 4855 """
a95a7133 4856 SetClassName(self, String name)
6c3b4aae 4857
66c033b4
RD
4858 Set the application's class name. This value may be used for
4859 X-resources if applicable for the platform
0df68c9f 4860 """
54f9ee45 4861 return _core_.PyApp_SetClassName(*args, **kwargs)
e811c8ce
RD
4862
4863 def GetVendorName(*args, **kwargs):
0df68c9f 4864 """
a95a7133 4865 GetVendorName(self) -> String
6c3b4aae 4866
0df68c9f
RD
4867 Get the application's vendor name.
4868 """
54f9ee45 4869 return _core_.PyApp_GetVendorName(*args, **kwargs)
e811c8ce
RD
4870
4871 def SetVendorName(*args, **kwargs):
0df68c9f 4872 """
a95a7133 4873 SetVendorName(self, String name)
6c3b4aae 4874
66c033b4
RD
4875 Set the application's vendor name. This value may be used
4876 automatically by `wx.Config` and such.
0df68c9f 4877 """
54f9ee45 4878 return _core_.PyApp_SetVendorName(*args, **kwargs)
e811c8ce
RD
4879
4880 def GetTraits(*args, **kwargs):
0df68c9f 4881 """
a95a7133 4882 GetTraits(self) -> wxAppTraits
6c3b4aae 4883
66c033b4
RD
4884 Return (and create if necessary) the app traits object to which we
4885 delegate for everything which either should be configurable by the
4886 user (then he can change the default behaviour simply by overriding
4887 CreateTraits() and returning his own traits object) or which is
4888 GUI/console dependent as then wx.AppTraits allows us to abstract the
4889 differences behind the common facade.
4890
4891 :todo: Add support for overriding CreateAppTraits in wxPython.
0df68c9f 4892 """
54f9ee45 4893 return _core_.PyApp_GetTraits(*args, **kwargs)
e811c8ce
RD
4894
4895 def ProcessPendingEvents(*args, **kwargs):
0df68c9f 4896 """
a95a7133 4897 ProcessPendingEvents(self)
6c3b4aae 4898
66c033b4
RD
4899 Process all events in the Pending Events list -- it is necessary to
4900 call this function to process posted events. This normally happens
4901 during each event loop iteration.
0df68c9f 4902 """
54f9ee45 4903 return _core_.PyApp_ProcessPendingEvents(*args, **kwargs)
e811c8ce
RD
4904
4905 def Yield(*args, **kwargs):
0df68c9f 4906 """
a95a7133 4907 Yield(self, bool onlyIfNeeded=False) -> bool
6c3b4aae 4908
66c033b4
RD
4909 Process all currently pending events right now, instead of waiting
4910 until return to the event loop. It is an error to call ``Yield``
4911 recursively unless the value of ``onlyIfNeeded`` is True.
6c3b4aae 4912
66c033b4 4913 :warning: This function is dangerous as it can lead to unexpected
41e2b43e
RD
4914 reentrancies (i.e. when called from an event handler it may
4915 result in calling the same event handler again), use with
4916 extreme care or, better, don't use at all!
0df68c9f 4917
66c033b4 4918 :see: `wx.Yield`, `wx.YieldIfNeeded`, `wx.SafeYield`
41e2b43e 4919
0df68c9f 4920 """
54f9ee45 4921 return _core_.PyApp_Yield(*args, **kwargs)
e811c8ce
RD
4922
4923 def WakeUpIdle(*args, **kwargs):
0df68c9f 4924 """
a95a7133 4925 WakeUpIdle(self)
6c3b4aae 4926
66c033b4
RD
4927 Make sure that idle events are sent again.
4928 :see: `wx.WakeUpIdle`
0df68c9f 4929 """
54f9ee45 4930 return _core_.PyApp_WakeUpIdle(*args, **kwargs)
e811c8ce 4931
1fc3b23a
RD
4932 def IsMainLoopRunning(*args, **kwargs):
4933 """
4934 IsMainLoopRunning() -> bool
4935
4936 Returns True if we're running the main loop, i.e. if the events can
4937 currently be dispatched.
4938 """
4939 return _core_.PyApp_IsMainLoopRunning(*args, **kwargs)
4940
4941 IsMainLoopRunning = staticmethod(IsMainLoopRunning)
e811c8ce 4942 def MainLoop(*args, **kwargs):
0df68c9f 4943 """
a95a7133 4944 MainLoop(self) -> int
6c3b4aae 4945
66c033b4
RD
4946 Execute the main GUI loop, the function doesn't normally return until
4947 all top level windows have been closed and destroyed.
0df68c9f 4948 """
54f9ee45 4949 return _core_.PyApp_MainLoop(*args, **kwargs)
e811c8ce
RD
4950
4951 def Exit(*args, **kwargs):
0df68c9f 4952 """
a95a7133 4953 Exit(self)
6c3b4aae 4954
0df68c9f 4955 Exit the main loop thus terminating the application.
66c033b4 4956 :see: `wx.Exit`
0df68c9f 4957 """
54f9ee45 4958 return _core_.PyApp_Exit(*args, **kwargs)
e811c8ce
RD
4959
4960 def ExitMainLoop(*args, **kwargs):
0df68c9f 4961 """
a95a7133 4962 ExitMainLoop(self)
6c3b4aae 4963
66c033b4
RD
4964 Exit the main GUI loop during the next iteration of the main
4965 loop, (i.e. it does not stop the program immediately!)
0df68c9f 4966 """
54f9ee45 4967 return _core_.PyApp_ExitMainLoop(*args, **kwargs)
e811c8ce
RD
4968
4969 def Pending(*args, **kwargs):
0df68c9f 4970 """
a95a7133 4971 Pending(self) -> bool
6c3b4aae 4972
0df68c9f
RD
4973 Returns True if there are unprocessed events in the event queue.
4974 """
54f9ee45 4975 return _core_.PyApp_Pending(*args, **kwargs)
e811c8ce
RD
4976
4977 def Dispatch(*args, **kwargs):
0df68c9f 4978 """
a95a7133 4979 Dispatch(self) -> bool
6c3b4aae 4980
0df68c9f
RD
4981 Process the first event in the event queue (blocks until an event
4982 appears if there are none currently)
4983 """
54f9ee45 4984 return _core_.PyApp_Dispatch(*args, **kwargs)
e811c8ce
RD
4985
4986 def ProcessIdle(*args, **kwargs):
0df68c9f 4987 """
a95a7133 4988 ProcessIdle(self) -> bool
6c3b4aae 4989
66c033b4
RD
4990 Called from the MainLoop when the application becomes idle (there are
4991 no pending events) and sends a `wx.IdleEvent` to all interested
4992 parties. Returns True if more idle events are needed, False if not.
0df68c9f 4993 """
54f9ee45 4994 return _core_.PyApp_ProcessIdle(*args, **kwargs)
e811c8ce
RD
4995
4996 def SendIdleEvents(*args, **kwargs):
0df68c9f 4997 """
a95a7133 4998 SendIdleEvents(self, Window win, IdleEvent event) -> bool
e811c8ce 4999
66c033b4
RD
5000 Send idle event to window and all subwindows. Returns True if more
5001 idle time is requested.
0df68c9f 5002 """
54f9ee45 5003 return _core_.PyApp_SendIdleEvents(*args, **kwargs)
e811c8ce
RD
5004
5005 def IsActive(*args, **kwargs):
0df68c9f 5006 """
a95a7133 5007 IsActive(self) -> bool
6c3b4aae 5008
0df68c9f
RD
5009 Return True if our app has focus.
5010 """
54f9ee45 5011 return _core_.PyApp_IsActive(*args, **kwargs)
e811c8ce
RD
5012
5013 def SetTopWindow(*args, **kwargs):
0df68c9f 5014 """
a95a7133 5015 SetTopWindow(self, Window win)
6c3b4aae 5016
66c033b4 5017 Set the *main* top level window
0df68c9f 5018 """
54f9ee45 5019 return _core_.PyApp_SetTopWindow(*args, **kwargs)
e811c8ce
RD
5020
5021 def GetTopWindow(*args, **kwargs):
0df68c9f 5022 """
a95a7133 5023 GetTopWindow(self) -> Window
6c3b4aae 5024
66c033b4
RD
5025 Return the *main* top level window (if it hadn't been set previously
5026 with SetTopWindow(), will return just some top level window and, if
5027 there not any, will return None)
0df68c9f 5028 """
54f9ee45 5029 return _core_.PyApp_GetTopWindow(*args, **kwargs)
e811c8ce
RD
5030
5031 def SetExitOnFrameDelete(*args, **kwargs):
0df68c9f 5032 """
a95a7133 5033 SetExitOnFrameDelete(self, bool flag)
0df68c9f 5034
66c033b4
RD
5035 Control the exit behaviour: by default, the program will exit the main
5036 loop (and so, usually, terminate) when the last top-level program
5037 window is deleted. Beware that if you disable this behaviour (with
5038 SetExitOnFrameDelete(False)), you'll have to call ExitMainLoop()
5039 explicitly from somewhere.
0df68c9f 5040 """
54f9ee45 5041 return _core_.PyApp_SetExitOnFrameDelete(*args, **kwargs)
e811c8ce
RD
5042
5043 def GetExitOnFrameDelete(*args, **kwargs):
0df68c9f 5044 """
a95a7133 5045 GetExitOnFrameDelete(self) -> bool
6c3b4aae 5046
0df68c9f
RD
5047 Get the current exit behaviour setting.
5048 """
54f9ee45 5049 return _core_.PyApp_GetExitOnFrameDelete(*args, **kwargs)
e811c8ce
RD
5050
5051 def SetUseBestVisual(*args, **kwargs):
0df68c9f 5052 """
a95a7133 5053 SetUseBestVisual(self, bool flag)
6c3b4aae 5054
66c033b4
RD
5055 Set whether the app should try to use the best available visual on
5056 systems where more than one is available, (Sun, SGI, XFree86 4, etc.)
0df68c9f 5057 """
54f9ee45 5058 return _core_.PyApp_SetUseBestVisual(*args, **kwargs)
e811c8ce
RD
5059
5060 def GetUseBestVisual(*args, **kwargs):
0df68c9f 5061 """
a95a7133 5062 GetUseBestVisual(self) -> bool
6c3b4aae 5063
0df68c9f
RD
5064 Get current UseBestVisual setting.
5065 """
54f9ee45 5066 return _core_.PyApp_GetUseBestVisual(*args, **kwargs)
e811c8ce
RD
5067
5068 def SetPrintMode(*args, **kwargs):
a95a7133 5069 """SetPrintMode(self, int mode)"""
54f9ee45 5070 return _core_.PyApp_SetPrintMode(*args, **kwargs)
e811c8ce
RD
5071
5072 def GetPrintMode(*args, **kwargs):
a95a7133 5073 """GetPrintMode(self) -> int"""
54f9ee45 5074 return _core_.PyApp_GetPrintMode(*args, **kwargs)
e811c8ce 5075
e811c8ce 5076 def SetAssertMode(*args, **kwargs):
0df68c9f 5077 """
a95a7133 5078 SetAssertMode(self, int mode)
6c3b4aae 5079
41e2b43e 5080 Set the OnAssert behaviour for debug and hybrid builds.
0df68c9f 5081 """
54f9ee45 5082 return _core_.PyApp_SetAssertMode(*args, **kwargs)
e811c8ce 5083
6c3b4aae 5084 def GetAssertMode(*args, **kwargs):
0df68c9f 5085 """
a95a7133 5086 GetAssertMode(self) -> int
6c3b4aae 5087
0df68c9f
RD
5088 Get the current OnAssert behaviour setting.
5089 """
54f9ee45 5090 return _core_.PyApp_GetAssertMode(*args, **kwargs)
6c3b4aae 5091
e811c8ce 5092 def GetMacSupportPCMenuShortcuts(*args, **kwargs):
66c033b4 5093 """GetMacSupportPCMenuShortcuts() -> bool"""
54f9ee45 5094 return _core_.PyApp_GetMacSupportPCMenuShortcuts(*args, **kwargs)
e811c8ce
RD
5095
5096 GetMacSupportPCMenuShortcuts = staticmethod(GetMacSupportPCMenuShortcuts)
5097 def GetMacAboutMenuItemId(*args, **kwargs):
66c033b4 5098 """GetMacAboutMenuItemId() -> long"""
54f9ee45 5099 return _core_.PyApp_GetMacAboutMenuItemId(*args, **kwargs)
e811c8ce
RD
5100
5101 GetMacAboutMenuItemId = staticmethod(GetMacAboutMenuItemId)
5102 def GetMacPreferencesMenuItemId(*args, **kwargs):
66c033b4 5103 """GetMacPreferencesMenuItemId() -> long"""
54f9ee45 5104 return _core_.PyApp_GetMacPreferencesMenuItemId(*args, **kwargs)
e811c8ce
RD
5105
5106 GetMacPreferencesMenuItemId = staticmethod(GetMacPreferencesMenuItemId)
5107 def GetMacExitMenuItemId(*args, **kwargs):
66c033b4 5108 """GetMacExitMenuItemId() -> long"""
54f9ee45 5109 return _core_.PyApp_GetMacExitMenuItemId(*args, **kwargs)
e811c8ce
RD
5110
5111 GetMacExitMenuItemId = staticmethod(GetMacExitMenuItemId)
5112 def GetMacHelpMenuTitleName(*args, **kwargs):
66c033b4 5113 """GetMacHelpMenuTitleName() -> String"""
54f9ee45 5114 return _core_.PyApp_GetMacHelpMenuTitleName(*args, **kwargs)
e811c8ce
RD
5115
5116 GetMacHelpMenuTitleName = staticmethod(GetMacHelpMenuTitleName)
5117 def SetMacSupportPCMenuShortcuts(*args, **kwargs):
66c033b4 5118 """SetMacSupportPCMenuShortcuts(bool val)"""
54f9ee45 5119 return _core_.PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs)
e811c8ce
RD
5120
5121 SetMacSupportPCMenuShortcuts = staticmethod(SetMacSupportPCMenuShortcuts)
5122 def SetMacAboutMenuItemId(*args, **kwargs):
66c033b4 5123 """SetMacAboutMenuItemId(long val)"""
54f9ee45 5124 return _core_.PyApp_SetMacAboutMenuItemId(*args, **kwargs)
e811c8ce
RD
5125
5126 SetMacAboutMenuItemId = staticmethod(SetMacAboutMenuItemId)
5127 def SetMacPreferencesMenuItemId(*args, **kwargs):
66c033b4 5128 """SetMacPreferencesMenuItemId(long val)"""
54f9ee45 5129 return _core_.PyApp_SetMacPreferencesMenuItemId(*args, **kwargs)
e811c8ce
RD
5130
5131 SetMacPreferencesMenuItemId = staticmethod(SetMacPreferencesMenuItemId)
5132 def SetMacExitMenuItemId(*args, **kwargs):
66c033b4 5133 """SetMacExitMenuItemId(long val)"""
54f9ee45 5134 return _core_.PyApp_SetMacExitMenuItemId(*args, **kwargs)
e811c8ce
RD
5135
5136 SetMacExitMenuItemId = staticmethod(SetMacExitMenuItemId)
5137 def SetMacHelpMenuTitleName(*args, **kwargs):
66c033b4 5138 """SetMacHelpMenuTitleName(String val)"""
54f9ee45 5139 return _core_.PyApp_SetMacHelpMenuTitleName(*args, **kwargs)
e811c8ce
RD
5140
5141 SetMacHelpMenuTitleName = staticmethod(SetMacHelpMenuTitleName)
5142 def _BootstrapApp(*args, **kwargs):
0df68c9f 5143 """
a95a7133 5144 _BootstrapApp(self)
6c3b4aae 5145
0df68c9f
RD
5146 For internal use only
5147 """
54f9ee45 5148 return _core_.PyApp__BootstrapApp(*args, **kwargs)
e811c8ce
RD
5149
5150 def GetComCtl32Version(*args, **kwargs):
0df68c9f 5151 """
66c033b4 5152 GetComCtl32Version() -> int
6c3b4aae 5153
66c033b4
RD
5154 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
5155 it wasn't found at all. Raises an exception on non-Windows platforms.
0df68c9f 5156 """
54f9ee45 5157 return _core_.PyApp_GetComCtl32Version(*args, **kwargs)
e811c8ce
RD
5158
5159 GetComCtl32Version = staticmethod(GetComCtl32Version)
d14a1e28
RD
5160
5161class PyAppPtr(PyApp):
5162 def __init__(self, this):
5163 self.this = this
5164 if not hasattr(self,"thisown"): self.thisown = 0
5165 self.__class__ = PyApp
54f9ee45 5166_core_.PyApp_swigregister(PyAppPtr)
d14a1e28 5167
1fc3b23a
RD
5168def PyApp_IsMainLoopRunning(*args, **kwargs):
5169 """
5170 PyApp_IsMainLoopRunning() -> bool
5171
5172 Returns True if we're running the main loop, i.e. if the events can
5173 currently be dispatched.
5174 """
5175 return _core_.PyApp_IsMainLoopRunning(*args, **kwargs)
5176
e811c8ce
RD
5177def PyApp_GetMacSupportPCMenuShortcuts(*args, **kwargs):
5178 """PyApp_GetMacSupportPCMenuShortcuts() -> bool"""
54f9ee45 5179 return _core_.PyApp_GetMacSupportPCMenuShortcuts(*args, **kwargs)
d14a1e28 5180
e811c8ce
RD
5181def PyApp_GetMacAboutMenuItemId(*args, **kwargs):
5182 """PyApp_GetMacAboutMenuItemId() -> long"""
54f9ee45 5183 return _core_.PyApp_GetMacAboutMenuItemId(*args, **kwargs)
d14a1e28 5184
e811c8ce
RD
5185def PyApp_GetMacPreferencesMenuItemId(*args, **kwargs):
5186 """PyApp_GetMacPreferencesMenuItemId() -> long"""
54f9ee45 5187 return _core_.PyApp_GetMacPreferencesMenuItemId(*args, **kwargs)
d14a1e28 5188
e811c8ce
RD
5189def PyApp_GetMacExitMenuItemId(*args, **kwargs):
5190 """PyApp_GetMacExitMenuItemId() -> long"""
54f9ee45 5191 return _core_.PyApp_GetMacExitMenuItemId(*args, **kwargs)
d14a1e28 5192
e811c8ce 5193def PyApp_GetMacHelpMenuTitleName(*args, **kwargs):
196addbf 5194 """PyApp_GetMacHelpMenuTitleName() -> String"""
54f9ee45 5195 return _core_.PyApp_GetMacHelpMenuTitleName(*args, **kwargs)
d14a1e28 5196
e811c8ce
RD
5197def PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs):
5198 """PyApp_SetMacSupportPCMenuShortcuts(bool val)"""
54f9ee45 5199 return _core_.PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs)
d14a1e28 5200
e811c8ce
RD
5201def PyApp_SetMacAboutMenuItemId(*args, **kwargs):
5202 """PyApp_SetMacAboutMenuItemId(long val)"""
54f9ee45 5203 return _core_.PyApp_SetMacAboutMenuItemId(*args, **kwargs)
d14a1e28 5204
e811c8ce
RD
5205def PyApp_SetMacPreferencesMenuItemId(*args, **kwargs):
5206 """PyApp_SetMacPreferencesMenuItemId(long val)"""
54f9ee45 5207 return _core_.PyApp_SetMacPreferencesMenuItemId(*args, **kwargs)
d14a1e28 5208
e811c8ce
RD
5209def PyApp_SetMacExitMenuItemId(*args, **kwargs):
5210 """PyApp_SetMacExitMenuItemId(long val)"""
54f9ee45 5211 return _core_.PyApp_SetMacExitMenuItemId(*args, **kwargs)
d14a1e28 5212
e811c8ce 5213def PyApp_SetMacHelpMenuTitleName(*args, **kwargs):
196addbf 5214 """PyApp_SetMacHelpMenuTitleName(String val)"""
54f9ee45 5215 return _core_.PyApp_SetMacHelpMenuTitleName(*args, **kwargs)
d14a1e28 5216
e811c8ce 5217def PyApp_GetComCtl32Version(*args, **kwargs):
0df68c9f
RD
5218 """
5219 PyApp_GetComCtl32Version() -> int
6c3b4aae 5220
66c033b4
RD
5221 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
5222 it wasn't found at all. Raises an exception on non-Windows platforms.
0df68c9f 5223 """
54f9ee45 5224 return _core_.PyApp_GetComCtl32Version(*args, **kwargs)
d14a1e28
RD
5225
5226#---------------------------------------------------------------------------
5227
5228
e811c8ce 5229def Exit(*args, **kwargs):
0df68c9f
RD
5230 """
5231 Exit()
6c3b4aae 5232
0df68c9f
RD
5233 Force an exit of the application. Convenience for wx.GetApp().Exit()
5234 """
54f9ee45 5235 return _core_.Exit(*args, **kwargs)
d14a1e28 5236
e811c8ce 5237def Yield(*args, **kwargs):
0df68c9f
RD
5238 """
5239 Yield() -> bool
6c3b4aae 5240
0df68c9f
RD
5241 Yield to other apps/messages. Convenience for wx.GetApp().Yield()
5242 """
54f9ee45 5243 return _core_.Yield(*args, **kwargs)
d14a1e28 5244
e811c8ce 5245def YieldIfNeeded(*args, **kwargs):
0df68c9f
RD
5246 """
5247 YieldIfNeeded() -> bool
6c3b4aae 5248
0df68c9f
RD
5249 Yield to other apps/messages. Convenience for wx.GetApp().Yield(True)
5250 """
54f9ee45 5251 return _core_.YieldIfNeeded(*args, **kwargs)
d14a1e28 5252
e811c8ce 5253def SafeYield(*args, **kwargs):
0df68c9f
RD
5254 """
5255 SafeYield(Window win=None, bool onlyIfNeeded=False) -> bool
6c3b4aae 5256
66c033b4
RD
5257 This function is similar to `wx.Yield`, except that it disables the
5258 user input to all program windows before calling `wx.Yield` and
5259 re-enables it again afterwards. If ``win`` is not None, this window
5260 will remain enabled, allowing the implementation of some limited user
5261 interaction.
6c3b4aae 5262
66c033b4 5263 :Returns: the result of the call to `wx.Yield`.
0df68c9f 5264 """
54f9ee45 5265 return _core_.SafeYield(*args, **kwargs)
d14a1e28 5266
e811c8ce 5267def WakeUpIdle(*args, **kwargs):
0df68c9f
RD
5268 """
5269 WakeUpIdle()
6c3b4aae 5270
66c033b4
RD
5271 Cause the message queue to become empty again, so idle events will be
5272 sent.
0df68c9f 5273 """
54f9ee45 5274 return _core_.WakeUpIdle(*args, **kwargs)
d14a1e28 5275
e811c8ce 5276def PostEvent(*args, **kwargs):
0df68c9f
RD
5277 """
5278 PostEvent(EvtHandler dest, Event event)
6c3b4aae 5279
66c033b4
RD
5280 Send an event to a window or other wx.EvtHandler to be processed
5281 later.
0df68c9f 5282 """
54f9ee45 5283 return _core_.PostEvent(*args, **kwargs)
d14a1e28 5284
e811c8ce 5285def App_CleanUp(*args, **kwargs):
0df68c9f
RD
5286 """
5287 App_CleanUp()
6c3b4aae 5288
41e2b43e 5289 For internal use only, it is used to cleanup after wxWidgets when
66c033b4 5290 Python shuts down.
0df68c9f 5291 """
54f9ee45 5292 return _core_.App_CleanUp(*args, **kwargs)
d14a1e28 5293
e811c8ce 5294def GetApp(*args, **kwargs):
0df68c9f
RD
5295 """
5296 GetApp() -> PyApp
6c3b4aae 5297
196addbf 5298 Return a reference to the current wx.App object.
0df68c9f 5299 """
54f9ee45 5300 return _core_.GetApp(*args, **kwargs)
5cbf236d
RD
5301
5302def SetDefaultPyEncoding(*args, **kwargs):
5303 """
5304 SetDefaultPyEncoding(string encoding)
5305
5306 Sets the encoding that wxPython will use when it needs to convert a
5307 Python string or unicode object to or from a wxString.
e505d15e
RD
5308
5309 The default encoding is the value of ``locale.getdefaultlocale()[1]``
5310 but please be aware that the default encoding within the same locale
5311 may be slightly different on different platforms. For example, please
5312 see http://www.alanwood.net/demos/charsetdiffs.html for differences
5313 between the common latin/roman encodings.
5cbf236d
RD
5314 """
5315 return _core_.SetDefaultPyEncoding(*args, **kwargs)
5316
5317def GetDefaultPyEncoding(*args, **kwargs):
5318 """
5319 GetDefaultPyEncoding() -> string
5320
5321 Gets the current encoding that wxPython will use when it needs to
5322 convert a Python string or unicode object to or from a wxString.
5323 """
5324 return _core_.GetDefaultPyEncoding(*args, **kwargs)
d14a1e28
RD
5325#----------------------------------------------------------------------
5326
5327class PyOnDemandOutputWindow:
6c3b4aae
RD
5328 """
5329 A class that can be used for redirecting Python's stdout and
5330 stderr streams. It will do nothing until something is wrriten to
5331 the stream at which point it will create a Frame with a text area
5332 and write the text there.
5333 """
d14a1e28
RD
5334 def __init__(self, title = "wxPython: stdout/stderr"):
5335 self.frame = None
5336 self.title = title
412d302d
RD
5337 self.pos = wx.DefaultPosition
5338 self.size = (450, 300)
d14a1e28
RD
5339 self.parent = None
5340
5341 def SetParent(self, parent):
6c3b4aae 5342 """Set the window to be used as the popup Frame's parent."""
d14a1e28
RD
5343 self.parent = parent
5344
6c3b4aae
RD
5345
5346 def CreateOutputWindow(self, st):
412d302d
RD
5347 self.frame = wx.Frame(self.parent, -1, self.title, self.pos, self.size,
5348 style=wx.DEFAULT_FRAME_STYLE)
196addbf 5349 self.text = wx.TextCtrl(self.frame, -1, "",
412d302d 5350 style=wx.TE_MULTILINE|wx.TE_READONLY)
d1e20054 5351 self.text.AppendText(st)
6c3b4aae
RD
5352 self.frame.Show(True)
5353 EVT_CLOSE(self.frame, self.OnCloseWindow)
5354
d14a1e28 5355
7409c0c6
RD
5356 def OnCloseWindow(self, event):
5357 if self.frame is not None:
5358 self.frame.Destroy()
5359 self.frame = None
5360 self.text = None
5361
5362
d14a1e28 5363 # These methods provide the file-like output behaviour.
6c3b4aae
RD
5364 def write(self, text):
5365 """
5366 Create the output window if needed and write the string to it.
5367 If not called in the context of the gui thread then uses
5368 CallAfter to do the work there.
5369 """
5370 if self.frame is None:
5371 if not wx.Thread_IsMain():
5372 wx.CallAfter(self.CreateOutputWindow, text)
5373 else:
5374 self.CreateOutputWindow(text)
5375 else:
5376 if not wx.Thread_IsMain():
5377 wx.CallAfter(self.text.AppendText, text)
5378 else:
5379 self.text.AppendText(text)
5380
d14a1e28
RD
5381
5382 def close(self):
6c3b4aae
RD
5383 if self.frame is not None:
5384 wx.CallAfter(self.frame.Close)
5385
d14a1e28 5386
19272049
RD
5387 def flush(self):
5388 pass
5389
5390
d14a1e28
RD
5391
5392#----------------------------------------------------------------------
d14a1e28
RD
5393
5394_defRedirect = (wx.Platform == '__WXMSW__' or wx.Platform == '__WXMAC__')
5395
5396class App(wx.PyApp):
6c3b4aae 5397 """
66c033b4
RD
5398 The ``wx.App`` class represents the application and is used to:
5399
5400 * bootstrap the wxPython system and initialize the underlying
5401 gui toolkit
5402 * set and get application-wide properties
5403 * implement the windowing system main message or event loop,
5404 and to dispatch events to window instances
5405 * etc.
5406
5407 Every application must have a ``wx.App`` instance, and all
5408 creation of UI objects should be delayed until after the
03e37cd5
RD
5409 ``wx.App`` object has been created in order to ensure that the gui
5410 platform and wxWidgets have been fully initialized.
66c033b4
RD
5411
5412 Normally you would derive from this class and implement an
5413 ``OnInit`` method that creates a frame and then calls
5414 ``self.SetTopWindow(frame)``.
5415
03e37cd5 5416 :see: `wx.PySimpleApp` for a simpler app class that can be used
1c0f361b 5417 directly.
6c3b4aae 5418 """
66c033b4 5419
d14a1e28
RD
5420 outputWindowClass = PyOnDemandOutputWindow
5421
03e37cd5
RD
5422 def __init__(self, redirect=_defRedirect, filename=None,
5423 useBestVisual=False, clearSigInt=True):
66c033b4
RD
5424 """
5425 Construct a ``wx.App`` object.
5426
03e37cd5
RD
5427 :param redirect: Should ``sys.stdout`` and ``sys.stderr`` be
5428 redirected? Defaults to True on Windows and Mac, False
5429 otherwise. If `filename` is None then output will be
5430 redirected to a window that pops up as needed. (You can
5431 control what kind of window is created for the output by
5432 resetting the class variable ``outputWindowClass`` to a
5433 class of your choosing.)
66c033b4 5434
03e37cd5
RD
5435 :param filename: The name of a file to redirect output to, if
5436 redirect is True.
66c033b4
RD
5437
5438 :param useBestVisual: Should the app try to use the best
03e37cd5
RD
5439 available visual provided by the system (only relevant on
5440 systems that have more than one visual.) This parameter
5441 must be used instead of calling `SetUseBestVisual` later
5442 on because it must be set before the underlying GUI
5443 toolkit is initialized.
5444
5445 :param clearSigInt: Should SIGINT be cleared? This allows the
5446 app to terminate upon a Ctrl-C in the console like other
5447 GUI apps will.
66c033b4
RD
5448
5449 :note: You should override OnInit to do applicaition
5450 initialization to ensure that the system, toolkit and
5451 wxWidgets are fully initialized.
5452 """
d14a1e28
RD
5453 wx.PyApp.__init__(self)
5454
5455 if wx.Platform == "__WXMAC__":
5456 try:
5457 import MacOS
5458 if not MacOS.WMAvailable():
5459 print """\
5460This program needs access to the screen. Please run with 'pythonw',
5461not 'python', and only when you are logged in on the main display of
5462your Mac."""
5463 _sys.exit(1)
36cadbf7
RD
5464 except SystemExit:
5465 raise
d14a1e28
RD
5466 except:
5467 pass
5468
5469 # This has to be done before OnInit
5470 self.SetUseBestVisual(useBestVisual)
5471
5472 # Set the default handler for SIGINT. This fixes a problem
5473 # where if Ctrl-C is pressed in the console that started this
5474 # app then it will not appear to do anything, (not even send
5475 # KeyboardInterrupt???) but will later segfault on exit. By
5476 # setting the default handler then the app will exit, as
5477 # expected (depending on platform.)
03e37cd5
RD
5478 if clearSigInt:
5479 try:
5480 import signal
5481 signal.signal(signal.SIGINT, signal.SIG_DFL)
5482 except:
5483 pass
d14a1e28
RD
5484
5485 # Save and redirect the stdio to a window?
5486 self.stdioWin = None
5487 self.saveStdio = (_sys.stdout, _sys.stderr)
5488 if redirect:
5489 self.RedirectStdio(filename)
5490
8fb0e70a
RD
5491 # Use Python's install prefix as the default
5492 wx.StandardPaths.Get().SetInstallPrefix(_sys.prefix)
5493
d14a1e28
RD
5494 # This finishes the initialization of wxWindows and then calls
5495 # the OnInit that should be present in the derived class
5496 self._BootstrapApp()
5497
5498
5499 def __del__(self):
5500 try:
5501 self.RestoreStdio() # Just in case the MainLoop was overridden
5502 except:
5503 pass
5504
5505
5506 def SetTopWindow(self, frame):
1e0c8722 5507 """Set the \"main\" top level window"""
d14a1e28
RD
5508 if self.stdioWin:
5509 self.stdioWin.SetParent(frame)
5510 wx.PyApp.SetTopWindow(self, frame)
5511
5512
5513 def MainLoop(self):
1e0c8722 5514 """Execute the main GUI event loop"""
d14a1e28
RD
5515 wx.PyApp.MainLoop(self)
5516 self.RestoreStdio()
5517
5518
7409c0c6 5519 def RedirectStdio(self, filename=None):
1e0c8722 5520 """Redirect sys.stdout and sys.stderr to a file or a popup window."""
d14a1e28
RD
5521 if filename:
5522 _sys.stdout = _sys.stderr = open(filename, 'a')
5523 else:
5524 self.stdioWin = self.outputWindowClass()
5525 _sys.stdout = _sys.stderr = self.stdioWin
5526
5527
5528 def RestoreStdio(self):
5529 _sys.stdout, _sys.stderr = self.saveStdio
5530
5531
412d302d
RD
5532 def SetOutputWindowAttributes(self, title=None, pos=None, size=None):
5533 """
5534 Set the title, position and/or size of the output window if
f5b96ee1
RD
5535 the stdio has been redirected. This should be called before
5536 any output would cause the output window to be created.
412d302d
RD
5537 """
5538 if self.stdioWin:
5539 if title is not None:
5540 self.stdioWin.title = title
5541 if pos is not None:
5542 self.stdioWin.pos = pos
5543 if size is not None:
5544 self.stdioWin.size = size
5545
5546
5547
d14a1e28 5548
66c033b4 5549# change from wx.PyApp_XX to wx.App_XX
54f9ee45
RD
5550App_GetMacSupportPCMenuShortcuts = _core_.PyApp_GetMacSupportPCMenuShortcuts
5551App_GetMacAboutMenuItemId = _core_.PyApp_GetMacAboutMenuItemId
5552App_GetMacPreferencesMenuItemId = _core_.PyApp_GetMacPreferencesMenuItemId
5553App_GetMacExitMenuItemId = _core_.PyApp_GetMacExitMenuItemId
5554App_GetMacHelpMenuTitleName = _core_.PyApp_GetMacHelpMenuTitleName
5555App_SetMacSupportPCMenuShortcuts = _core_.PyApp_SetMacSupportPCMenuShortcuts
5556App_SetMacAboutMenuItemId = _core_.PyApp_SetMacAboutMenuItemId
5557App_SetMacPreferencesMenuItemId = _core_.PyApp_SetMacPreferencesMenuItemId
5558App_SetMacExitMenuItemId = _core_.PyApp_SetMacExitMenuItemId
5559App_SetMacHelpMenuTitleName = _core_.PyApp_SetMacHelpMenuTitleName
5560App_GetComCtl32Version = _core_.PyApp_GetComCtl32Version
d14a1e28
RD
5561
5562#----------------------------------------------------------------------------
5563
5564class PySimpleApp(wx.App):
6c3b4aae
RD
5565 """
5566 A simple application class. You can just create one of these and
5567 then then make your top level windows later, and not have to worry
66c033b4
RD
5568 about OnInit. For example::
5569
5570 app = wx.PySimpleApp()
5571 frame = wx.Frame(None, title='Hello World')
5572 frame.Show()
5573 app.MainLoop()
5574
5575 :see: `wx.App`
5576 """
6c3b4aae 5577
03e37cd5
RD
5578 def __init__(self, redirect=False, filename=None,
5579 useBestVisual=False, clearSigInt=True):
66c033b4
RD
5580 """
5581 :see: `wx.App.__init__`
5582 """
03e37cd5 5583 wx.App.__init__(self, redirect, filename, useBestVisual, clearSigInt)
6c3b4aae 5584
d14a1e28 5585 def OnInit(self):
d14a1e28
RD
5586 return True
5587
5588
66c033b4 5589
6c3b4aae 5590# Is anybody using this one?
d14a1e28
RD
5591class PyWidgetTester(wx.App):
5592 def __init__(self, size = (250, 100)):
5593 self.size = size
5594 wx.App.__init__(self, 0)
5595
5596 def OnInit(self):
196addbf 5597 self.frame = wx.Frame(None, -1, "Widget Tester", pos=(0,0), size=self.size)
d14a1e28
RD
5598 self.SetTopWindow(self.frame)
5599 return True
5600
66c033b4
RD
5601 def SetWidget(self, widgetClass, *args, **kwargs):
5602 w = widgetClass(self.frame, *args, **kwargs)
d14a1e28
RD
5603 self.frame.Show(True)
5604
5605#----------------------------------------------------------------------------
5606# DO NOT hold any other references to this object. This is how we
66c033b4 5607# know when to cleanup system resources that wxWidgets is holding. When
d14a1e28 5608# the sys module is unloaded, the refcount on sys.__wxPythonCleanup
66c033b4 5609# goes to zero and it calls the wx.App_CleanUp function.
d14a1e28
RD
5610
5611class __wxPyCleanup:
5612 def __init__(self):
54f9ee45 5613 self.cleanup = _core_.App_CleanUp
d14a1e28
RD
5614 def __del__(self):
5615 self.cleanup()
5616
5617_sys.__wxPythonCleanup = __wxPyCleanup()
5618
5619## # another possible solution, but it gets called too early...
66c033b4
RD
5620## import atexit
5621## atexit.register(_core_.wxApp_CleanUp)
d14a1e28
RD
5622
5623
5624#----------------------------------------------------------------------------
5625
5626#---------------------------------------------------------------------------
2ef75293
RD
5627
5628class EventLoop(object):
093d3ff1 5629 """Proxy of C++ EventLoop class"""
2ef75293
RD
5630 def __repr__(self):
5631 return "<%s.%s; proxy of C++ wxEventLoop instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5632 def __init__(self, *args, **kwargs):
5633 """__init__(self) -> EventLoop"""
5634 newobj = _core_.new_EventLoop(*args, **kwargs)
5635 self.this = newobj.this
5636 self.thisown = 1
5637 del newobj.thisown
5638 def __del__(self, destroy=_core_.delete_EventLoop):
5639 """__del__(self)"""
5640 try:
5641 if self.thisown: destroy(self)
5642 except: pass
5643
5644 def Run(*args, **kwargs):
5645 """Run(self) -> int"""
5646 return _core_.EventLoop_Run(*args, **kwargs)
5647
5648 def Exit(*args, **kwargs):
5649 """Exit(self, int rc=0)"""
5650 return _core_.EventLoop_Exit(*args, **kwargs)
5651
5652 def Pending(*args, **kwargs):
5653 """Pending(self) -> bool"""
5654 return _core_.EventLoop_Pending(*args, **kwargs)
5655
5656 def Dispatch(*args, **kwargs):
5657 """Dispatch(self) -> bool"""
5658 return _core_.EventLoop_Dispatch(*args, **kwargs)
5659
5660 def IsRunning(*args, **kwargs):
5661 """IsRunning(self) -> bool"""
5662 return _core_.EventLoop_IsRunning(*args, **kwargs)
5663
5664 def GetActive(*args, **kwargs):
5665 """GetActive() -> EventLoop"""
5666 return _core_.EventLoop_GetActive(*args, **kwargs)
5667
5668 GetActive = staticmethod(GetActive)
5669 def SetActive(*args, **kwargs):
5670 """SetActive(EventLoop loop)"""
5671 return _core_.EventLoop_SetActive(*args, **kwargs)
5672
5673 SetActive = staticmethod(SetActive)
5674
5675class EventLoopPtr(EventLoop):
5676 def __init__(self, this):
5677 self.this = this
5678 if not hasattr(self,"thisown"): self.thisown = 0
5679 self.__class__ = EventLoop
5680_core_.EventLoop_swigregister(EventLoopPtr)
5681
5682def EventLoop_GetActive(*args, **kwargs):
5683 """EventLoop_GetActive() -> EventLoop"""
5684 return _core_.EventLoop_GetActive(*args, **kwargs)
5685
5686def EventLoop_SetActive(*args, **kwargs):
5687 """EventLoop_SetActive(EventLoop loop)"""
5688 return _core_.EventLoop_SetActive(*args, **kwargs)
5689
5690#---------------------------------------------------------------------------
d14a1e28 5691
1e0c8722 5692class AcceleratorEntry(object):
66c033b4
RD
5693 """
5694 A class used to define items in an `wx.AcceleratorTable`. wxPython
5695 programs can choose to use wx.AcceleratorEntry objects, but using a
5696 list of 3-tuple of integers (flags, keyCode, cmdID) usually works just
41e2b43e 5697 as well. See `__init__` for of the tuple values.
66c033b4
RD
5698
5699 :see: `wx.AcceleratorTable`
5700 """
1e0c8722
RD
5701 def __repr__(self):
5702 return "<%s.%s; proxy of C++ wxAcceleratorEntry instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5703 def __init__(self, *args, **kwargs):
66c033b4
RD
5704 """
5705 __init__(self, int flags=0, int keyCode=0, int cmdID=0) -> AcceleratorEntry
5706
5707 Construct a wx.AcceleratorEntry.
66c033b4 5708 """
54f9ee45 5709 newobj = _core_.new_AcceleratorEntry(*args, **kwargs)
1e0c8722
RD
5710 self.this = newobj.this
5711 self.thisown = 1
5712 del newobj.thisown
54f9ee45 5713 def __del__(self, destroy=_core_.delete_AcceleratorEntry):
a95a7133 5714 """__del__(self)"""
1e0c8722
RD
5715 try:
5716 if self.thisown: destroy(self)
5717 except: pass
5718
5719 def Set(*args, **kwargs):
66c033b4
RD
5720 """
5721 Set(self, int flags, int keyCode, int cmd)
1e0c8722 5722
66c033b4
RD
5723 (Re)set the attributes of a wx.AcceleratorEntry.
5724 :see `__init__`
5725 """
5726 return _core_.AcceleratorEntry_Set(*args, **kwargs)
1e0c8722
RD
5727
5728 def GetFlags(*args, **kwargs):
66c033b4
RD
5729 """
5730 GetFlags(self) -> int
5731
5732 Get the AcceleratorEntry's flags.
5733 """
54f9ee45 5734 return _core_.AcceleratorEntry_GetFlags(*args, **kwargs)
1e0c8722
RD
5735
5736 def GetKeyCode(*args, **kwargs):
66c033b4
RD
5737 """
5738 GetKeyCode(self) -> int
5739
5740 Get the AcceleratorEntry's keycode.
5741 """
54f9ee45 5742 return _core_.AcceleratorEntry_GetKeyCode(*args, **kwargs)
1e0c8722
RD
5743
5744 def GetCommand(*args, **kwargs):
66c033b4
RD
5745 """
5746 GetCommand(self) -> int
5747
5748 Get the AcceleratorEntry's command ID.
5749 """
54f9ee45 5750 return _core_.AcceleratorEntry_GetCommand(*args, **kwargs)
1e0c8722
RD
5751
5752
5753class AcceleratorEntryPtr(AcceleratorEntry):
5754 def __init__(self, this):
5755 self.this = this
5756 if not hasattr(self,"thisown"): self.thisown = 0
5757 self.__class__ = AcceleratorEntry
54f9ee45 5758_core_.AcceleratorEntry_swigregister(AcceleratorEntryPtr)
1e0c8722
RD
5759
5760class AcceleratorTable(Object):
66c033b4
RD
5761 """
5762 An accelerator table allows the application to specify a table of
5763 keyboard shortcuts for menus or other commands. On Windows, menu or
5764 button commands are supported; on GTK, only menu commands are
5765 supported.
66c033b4 5766 """
1e0c8722
RD
5767 def __repr__(self):
5768 return "<%s.%s; proxy of C++ wxAcceleratorTable instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5769 def __init__(self, *args, **kwargs):
0df68c9f
RD
5770 """
5771 __init__(entries) -> AcceleratorTable
1e0c8722 5772
66c033b4
RD
5773 Construct an AcceleratorTable from a list of `wx.AcceleratorEntry`
5774 items or or of 3-tuples (flags, keyCode, cmdID)
5775
5776 :see: `wx.AcceleratorEntry`
0df68c9f 5777 """
54f9ee45 5778 newobj = _core_.new_AcceleratorTable(*args, **kwargs)
1e0c8722
RD
5779 self.this = newobj.this
5780 self.thisown = 1
5781 del newobj.thisown
54f9ee45 5782 def __del__(self, destroy=_core_.delete_AcceleratorTable):
a95a7133 5783 """__del__(self)"""
1e0c8722
RD
5784 try:
5785 if self.thisown: destroy(self)
5786 except: pass
5787
5788 def Ok(*args, **kwargs):
a95a7133 5789 """Ok(self) -> bool"""
54f9ee45 5790 return _core_.AcceleratorTable_Ok(*args, **kwargs)
1e0c8722
RD
5791
5792
5793class AcceleratorTablePtr(AcceleratorTable):
5794 def __init__(self, this):
5795 self.this = this
5796 if not hasattr(self,"thisown"): self.thisown = 0
5797 self.__class__ = AcceleratorTable
54f9ee45 5798_core_.AcceleratorTable_swigregister(AcceleratorTablePtr)
1e0c8722
RD
5799
5800
5801def GetAccelFromString(*args, **kwargs):
196addbf 5802 """GetAccelFromString(String label) -> AcceleratorEntry"""
54f9ee45 5803 return _core_.GetAccelFromString(*args, **kwargs)
1e0c8722
RD
5804#---------------------------------------------------------------------------
5805
74a57fcd
RD
5806class VisualAttributes(object):
5807 """struct containing all the visual attributes of a control"""
5808 def __repr__(self):
5809 return "<%s.%s; proxy of C++ wxVisualAttributes instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5810 def __init__(self, *args, **kwargs):
5811 """
a95a7133 5812 __init__(self) -> VisualAttributes
74a57fcd
RD
5813
5814 struct containing all the visual attributes of a control
5815 """
54f9ee45 5816 newobj = _core_.new_VisualAttributes(*args, **kwargs)
74a57fcd
RD
5817 self.this = newobj.this
5818 self.thisown = 1
5819 del newobj.thisown
54f9ee45 5820 def __del__(self, destroy=_core_.delete_VisualAttributes):
a95a7133 5821 """__del__(self)"""
74a57fcd
RD
5822 try:
5823 if self.thisown: destroy(self)
5824 except: pass
5825
54f9ee45
RD
5826 font = property(_core_.VisualAttributes_font_get, _core_.VisualAttributes_font_set)
5827 colFg = property(_core_.VisualAttributes_colFg_get, _core_.VisualAttributes_colFg_set)
5828 colBg = property(_core_.VisualAttributes_colBg_get, _core_.VisualAttributes_colBg_set)
74a57fcd
RD
5829
5830class VisualAttributesPtr(VisualAttributes):
5831 def __init__(self, this):
5832 self.this = this
5833 if not hasattr(self,"thisown"): self.thisown = 0
5834 self.__class__ = VisualAttributes
54f9ee45 5835_core_.VisualAttributes_swigregister(VisualAttributesPtr)
74a57fcd
RD
5836NullAcceleratorTable = cvar.NullAcceleratorTable
5837PanelNameStr = cvar.PanelNameStr
5838
54f9ee45
RD
5839WINDOW_VARIANT_NORMAL = _core_.WINDOW_VARIANT_NORMAL
5840WINDOW_VARIANT_SMALL = _core_.WINDOW_VARIANT_SMALL
5841WINDOW_VARIANT_MINI = _core_.WINDOW_VARIANT_MINI
5842WINDOW_VARIANT_LARGE = _core_.WINDOW_VARIANT_LARGE
5843WINDOW_VARIANT_MAX = _core_.WINDOW_VARIANT_MAX
d14a1e28 5844class Window(EvtHandler):
15afbcd0
RD
5845 """
5846 wx.Window is the base class for all windows and represents any visible
5847 object on the screen. All controls, top level windows and so on are
5848 wx.Windows. Sizers and device contexts are not however, as they don't
5849 appear on screen themselves.
5850
5851 """
e811c8ce
RD
5852 def __repr__(self):
5853 return "<%s.%s; proxy of C++ wxWindow instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 5854 def __init__(self, *args, **kwargs):
0df68c9f 5855 """
a95a7133 5856 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
74a57fcd 5857 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> Window
15afbcd0
RD
5858
5859 Construct and show a generic Window.
0df68c9f 5860 """
54f9ee45 5861 newobj = _core_.new_Window(*args, **kwargs)
d14a1e28
RD
5862 self.this = newobj.this
5863 self.thisown = 1
5864 del newobj.thisown
5865 self._setOORInfo(self)
d14a1e28 5866
e811c8ce 5867 def Create(*args, **kwargs):
0df68c9f 5868 """
a95a7133 5869 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
74a57fcd 5870 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> bool
15afbcd0
RD
5871
5872 Create the GUI part of the Window for 2-phase creation mode.
0df68c9f 5873 """
54f9ee45 5874 return _core_.Window_Create(*args, **kwargs)
d14a1e28 5875
e811c8ce 5876 def Close(*args, **kwargs):
15afbcd0 5877 """
a95a7133 5878 Close(self, bool force=False) -> bool
15afbcd0
RD
5879
5880 This function simply generates a EVT_CLOSE event whose handler usually
5881 tries to close the window. It doesn't close the window itself,
5882 however. If force is False (the default) then the window's close
5883 handler will be allowed to veto the destruction of the window.
15afbcd0 5884 """
54f9ee45 5885 return _core_.Window_Close(*args, **kwargs)
d14a1e28 5886
e811c8ce 5887 def Destroy(*args, **kwargs):
0df68c9f 5888 """
a95a7133 5889 Destroy(self) -> bool
d14a1e28 5890
15afbcd0
RD
5891 Destroys the window safely. Frames and dialogs are not destroyed
5892 immediately when this function is called -- they are added to a list
5893 of windows to be deleted on idle time, when all the window's events
5894 have been processed. This prevents problems with events being sent to
5895 non-existent windows.
5896
5897 Returns True if the window has either been successfully deleted, or it
5898 has been added to the list of windows pending real deletion.
0df68c9f 5899 """
54f9ee45 5900 return _core_.Window_Destroy(*args, **kwargs)
d14a1e28 5901
e811c8ce 5902 def DestroyChildren(*args, **kwargs):
15afbcd0 5903 """
a95a7133 5904 DestroyChildren(self) -> bool
15afbcd0 5905
41e2b43e
RD
5906 Destroys all children of a window. Called automatically by the
5907 destructor.
15afbcd0 5908 """
54f9ee45 5909 return _core_.Window_DestroyChildren(*args, **kwargs)
d14a1e28 5910
e811c8ce 5911 def IsBeingDeleted(*args, **kwargs):
15afbcd0 5912 """
a95a7133 5913 IsBeingDeleted(self) -> bool
15afbcd0
RD
5914
5915 Is the window in the process of being deleted?
5916 """
54f9ee45 5917 return _core_.Window_IsBeingDeleted(*args, **kwargs)
d14a1e28 5918
e811c8ce 5919 def SetTitle(*args, **kwargs):
15afbcd0 5920 """
a95a7133 5921 SetTitle(self, String title)
15afbcd0
RD
5922
5923 Sets the window's title. Applicable only to frames and dialogs.
5924 """
54f9ee45 5925 return _core_.Window_SetTitle(*args, **kwargs)
d14a1e28 5926
e811c8ce 5927 def GetTitle(*args, **kwargs):
15afbcd0 5928 """
a95a7133 5929 GetTitle(self) -> String
15afbcd0
RD
5930
5931 Gets the window's title. Applicable only to frames and dialogs.
5932 """
54f9ee45 5933 return _core_.Window_GetTitle(*args, **kwargs)
d14a1e28 5934
e811c8ce 5935 def SetLabel(*args, **kwargs):
15afbcd0 5936 """
a95a7133 5937 SetLabel(self, String label)
15afbcd0
RD
5938
5939 Set the text which the window shows in its label if applicable.
5940 """
54f9ee45 5941 return _core_.Window_SetLabel(*args, **kwargs)
d14a1e28 5942
e811c8ce 5943 def GetLabel(*args, **kwargs):
15afbcd0 5944 """
a95a7133 5945 GetLabel(self) -> String
15afbcd0 5946
41e2b43e
RD
5947 Generic way of getting a label from any window, for identification
5948 purposes. The interpretation of this function differs from class to
5949 class. For frames and dialogs, the value returned is the title. For
5950 buttons or static text controls, it is the button text. This function
5951 can be useful for meta-programs such as testing tools or special-needs
5952 access programs)which need to identify windows by name.
15afbcd0 5953 """
54f9ee45 5954 return _core_.Window_GetLabel(*args, **kwargs)
d14a1e28 5955
e811c8ce 5956 def SetName(*args, **kwargs):
15afbcd0 5957 """
a95a7133 5958 SetName(self, String name)
15afbcd0 5959
41e2b43e
RD
5960 Sets the window's name. The window name is used for ressource setting
5961 in X, it is not the same as the window title/label
15afbcd0 5962 """
54f9ee45 5963 return _core_.Window_SetName(*args, **kwargs)
d14a1e28 5964
e811c8ce 5965 def GetName(*args, **kwargs):
15afbcd0 5966 """
a95a7133 5967 GetName(self) -> String
15afbcd0 5968
41e2b43e
RD
5969 Returns the windows name. This name is not guaranteed to be unique;
5970 it is up to the programmer to supply an appropriate name in the window
5971 constructor or via wx.Window.SetName.
15afbcd0 5972 """
54f9ee45 5973 return _core_.Window_GetName(*args, **kwargs)
d14a1e28 5974
4276dc52
RD
5975 def SetWindowVariant(*args, **kwargs):
5976 """
a95a7133 5977 SetWindowVariant(self, int variant)
4276dc52 5978
41e2b43e
RD
5979 Sets the variant of the window/font size to use for this window, if
5980 the platform supports variants, for example, wxMac.
4276dc52 5981 """
54f9ee45 5982 return _core_.Window_SetWindowVariant(*args, **kwargs)
4276dc52
RD
5983
5984 def GetWindowVariant(*args, **kwargs):
a95a7133 5985 """GetWindowVariant(self) -> int"""
54f9ee45 5986 return _core_.Window_GetWindowVariant(*args, **kwargs)
4276dc52 5987
e811c8ce 5988 def SetId(*args, **kwargs):
15afbcd0 5989 """
a95a7133 5990 SetId(self, int winid)
15afbcd0
RD
5991
5992 Sets the identifier of the window. Each window has an integer
5993 identifier. If the application has not provided one, an identifier
5994 will be generated. Normally, the identifier should be provided on
5995 creation and should not be modified subsequently.
5996 """
54f9ee45 5997 return _core_.Window_SetId(*args, **kwargs)
d14a1e28 5998
e811c8ce 5999 def GetId(*args, **kwargs):
15afbcd0 6000 """
a95a7133 6001 GetId(self) -> int
15afbcd0
RD
6002
6003 Returns the identifier of the window. Each window has an integer
6004 identifier. If the application has not provided one (or the default Id
6005 -1 is used) then an unique identifier with a negative value will be
6006 generated.
6007 """
54f9ee45 6008 return _core_.Window_GetId(*args, **kwargs)
d14a1e28 6009
e811c8ce 6010 def NewControlId(*args, **kwargs):
15afbcd0 6011 """
66c033b4 6012 NewControlId() -> int
15afbcd0
RD
6013
6014 Generate a control id for the controls which were not given one.
6015 """
54f9ee45 6016 return _core_.Window_NewControlId(*args, **kwargs)
d14a1e28 6017
e811c8ce
RD
6018 NewControlId = staticmethod(NewControlId)
6019 def NextControlId(*args, **kwargs):
15afbcd0 6020 """
66c033b4 6021 NextControlId(int winid) -> int
15afbcd0
RD
6022
6023 Get the id of the control following the one with the given
41e2b43e 6024 autogenerated) id
15afbcd0 6025 """
54f9ee45 6026 return _core_.Window_NextControlId(*args, **kwargs)
d14a1e28 6027
e811c8ce
RD
6028 NextControlId = staticmethod(NextControlId)
6029 def PrevControlId(*args, **kwargs):
15afbcd0 6030 """
66c033b4 6031 PrevControlId(int winid) -> int
15afbcd0
RD
6032
6033 Get the id of the control preceding the one with the given
41e2b43e 6034 autogenerated) id
15afbcd0 6035 """
54f9ee45 6036 return _core_.Window_PrevControlId(*args, **kwargs)
d14a1e28 6037
e811c8ce
RD
6038 PrevControlId = staticmethod(PrevControlId)
6039 def SetSize(*args, **kwargs):
15afbcd0 6040 """
a95a7133 6041 SetSize(self, Size size)
15afbcd0
RD
6042
6043 Sets the size of the window in pixels.
6044 """
54f9ee45 6045 return _core_.Window_SetSize(*args, **kwargs)
d14a1e28 6046
e811c8ce 6047 def SetDimensions(*args, **kwargs):
15afbcd0 6048 """
a95a7133 6049 SetDimensions(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)
15afbcd0
RD
6050
6051 Sets the position and size of the window in pixels. The sizeFlags
6052 parameter indicates the interpretation of the other params if they are
e505d15e
RD
6053 equal to -1.
6054
6055 ======================== ======================================
6056 wx.SIZE_AUTO A -1 indicates that a class-specific
6057 default should be used.
6058 wx.SIZE_USE_EXISTING Axisting dimensions should be used if
6059 -1 values are supplied.
6060 wxSIZE_ALLOW_MINUS_ONE Allow dimensions of -1 and less to be
6061 interpreted as real dimensions, not
6062 default values.
6063 ======================== ======================================
6064
15afbcd0 6065 """
54f9ee45 6066 return _core_.Window_SetDimensions(*args, **kwargs)
d14a1e28 6067
e811c8ce 6068 def SetRect(*args, **kwargs):
15afbcd0 6069 """
a95a7133 6070 SetRect(self, Rect rect, int sizeFlags=SIZE_AUTO)
15afbcd0
RD
6071
6072 Sets the position and size of the window in pixels using a wx.Rect.
6073 """
54f9ee45 6074 return _core_.Window_SetRect(*args, **kwargs)
d14a1e28 6075
e811c8ce 6076 def SetSizeWH(*args, **kwargs):
15afbcd0 6077 """
a95a7133 6078 SetSizeWH(self, int width, int height)
15afbcd0
RD
6079
6080 Sets the size of the window in pixels.
6081 """
54f9ee45 6082 return _core_.Window_SetSizeWH(*args, **kwargs)
d14a1e28 6083
e811c8ce 6084 def Move(*args, **kwargs):
15afbcd0 6085 """
a95a7133 6086 Move(self, Point pt, int flags=SIZE_USE_EXISTING)
15afbcd0
RD
6087
6088 Moves the window to the given position.
6089 """
54f9ee45 6090 return _core_.Window_Move(*args, **kwargs)
d14a1e28 6091
e811c8ce
RD
6092 SetPosition = Move
6093 def MoveXY(*args, **kwargs):
15afbcd0 6094 """
a95a7133 6095 MoveXY(self, int x, int y, int flags=SIZE_USE_EXISTING)
15afbcd0
RD
6096
6097 Moves the window to the given position.
6098 """
54f9ee45 6099 return _core_.Window_MoveXY(*args, **kwargs)
e811c8ce 6100
f8167d6e
RD
6101 def SetBestFittingSize(*args, **kwargs):
6102 """
6103 SetBestFittingSize(self, Size size=DefaultSize)
6104
6105 A 'Smart' SetSize that will fill in default size components with the
6106 window's *best size* values. Also set's the minsize for use with sizers.
6107 """
6108 return _core_.Window_SetBestFittingSize(*args, **kwargs)
6109
e811c8ce 6110 def Raise(*args, **kwargs):
15afbcd0 6111 """
a95a7133 6112 Raise(self)
15afbcd0
RD
6113
6114 Raises the window to the top of the window hierarchy if it is a
6115 managed window (dialog or frame).
6116 """
54f9ee45 6117 return _core_.Window_Raise(*args, **kwargs)
e811c8ce
RD
6118
6119 def Lower(*args, **kwargs):
15afbcd0 6120 """
a95a7133 6121 Lower(self)
15afbcd0
RD
6122
6123 Lowers the window to the bottom of the window hierarchy if it is a
6124 managed window (dialog or frame).
6125 """
54f9ee45 6126 return _core_.Window_Lower(*args, **kwargs)
e811c8ce
RD
6127
6128 def SetClientSize(*args, **kwargs):
15afbcd0 6129 """
a95a7133 6130 SetClientSize(self, Size size)
15afbcd0
RD
6131
6132 This sets the size of the window client area in pixels. Using this
6133 function to size a window tends to be more device-independent than
6134 wx.Window.SetSize, since the application need not worry about what
6135 dimensions the border or title bar have when trying to fit the window
6136 around panel items, for example.
6137 """
54f9ee45 6138 return _core_.Window_SetClientSize(*args, **kwargs)
e811c8ce
RD
6139
6140 def SetClientSizeWH(*args, **kwargs):
15afbcd0 6141 """
a95a7133 6142 SetClientSizeWH(self, int width, int height)
15afbcd0
RD
6143
6144 This sets the size of the window client area in pixels. Using this
6145 function to size a window tends to be more device-independent than
6146 wx.Window.SetSize, since the application need not worry about what
6147 dimensions the border or title bar have when trying to fit the window
6148 around panel items, for example.
6149 """
54f9ee45 6150 return _core_.Window_SetClientSizeWH(*args, **kwargs)
e811c8ce
RD
6151
6152 def SetClientRect(*args, **kwargs):
15afbcd0 6153 """
a95a7133 6154 SetClientRect(self, Rect rect)
15afbcd0
RD
6155
6156 This sets the size of the window client area in pixels. Using this
6157 function to size a window tends to be more device-independent than
6158 wx.Window.SetSize, since the application need not worry about what
6159 dimensions the border or title bar have when trying to fit the window
6160 around panel items, for example.
6161 """
54f9ee45 6162 return _core_.Window_SetClientRect(*args, **kwargs)
e811c8ce
RD
6163
6164 def GetPosition(*args, **kwargs):
0df68c9f 6165 """
a95a7133 6166 GetPosition(self) -> Point
e811c8ce 6167
0df68c9f
RD
6168 Get the window's position.
6169 """
54f9ee45 6170 return _core_.Window_GetPosition(*args, **kwargs)
e811c8ce
RD
6171
6172 def GetPositionTuple(*args, **kwargs):
0df68c9f
RD
6173 """
6174 GetPositionTuple() -> (x,y)
e811c8ce 6175
0df68c9f
RD
6176 Get the window's position.
6177 """
54f9ee45 6178 return _core_.Window_GetPositionTuple(*args, **kwargs)
e811c8ce
RD
6179
6180 def GetSize(*args, **kwargs):
0df68c9f 6181 """
a95a7133 6182 GetSize(self) -> Size
e811c8ce 6183
0df68c9f
RD
6184 Get the window size.
6185 """
54f9ee45 6186 return _core_.Window_GetSize(*args, **kwargs)
e811c8ce
RD
6187
6188 def GetSizeTuple(*args, **kwargs):
0df68c9f
RD
6189 """
6190 GetSizeTuple() -> (width, height)
e811c8ce 6191
0df68c9f
RD
6192 Get the window size.
6193 """
54f9ee45 6194 return _core_.Window_GetSizeTuple(*args, **kwargs)
e811c8ce
RD
6195
6196 def GetRect(*args, **kwargs):
15afbcd0 6197 """
a95a7133 6198 GetRect(self) -> Rect
15afbcd0
RD
6199
6200 Returns the size and position of the window as a wx.Rect object.
6201 """
54f9ee45 6202 return _core_.Window_GetRect(*args, **kwargs)
e811c8ce
RD
6203
6204 def GetClientSize(*args, **kwargs):
0df68c9f 6205 """
a95a7133 6206 GetClientSize(self) -> Size
e811c8ce 6207
15afbcd0
RD
6208 This gets the size of the window's 'client area' in pixels. The client
6209 area is the area which may be drawn on by the programmer, excluding
6210 title bar, border, scrollbars, etc.
0df68c9f 6211 """
54f9ee45 6212 return _core_.Window_GetClientSize(*args, **kwargs)
e811c8ce
RD
6213
6214 def GetClientSizeTuple(*args, **kwargs):
0df68c9f
RD
6215 """
6216 GetClientSizeTuple() -> (width, height)
e811c8ce 6217
15afbcd0
RD
6218 This gets the size of the window's 'client area' in pixels. The client
6219 area is the area which may be drawn on by the programmer, excluding
6220 title bar, border, scrollbars, etc.
0df68c9f 6221 """
54f9ee45 6222 return _core_.Window_GetClientSizeTuple(*args, **kwargs)
e811c8ce
RD
6223
6224 def GetClientAreaOrigin(*args, **kwargs):
15afbcd0 6225 """
a95a7133 6226 GetClientAreaOrigin(self) -> Point
15afbcd0
RD
6227
6228 Get the origin of the client area of the window relative to the
6229 window's top left corner (the client area may be shifted because of
6230 the borders, scrollbars, other decorations...)
6231 """
54f9ee45 6232 return _core_.Window_GetClientAreaOrigin(*args, **kwargs)
e811c8ce
RD
6233
6234 def GetClientRect(*args, **kwargs):
15afbcd0 6235 """
a95a7133 6236 GetClientRect(self) -> Rect
15afbcd0 6237
61863841 6238 Get the client area position and size as a `wx.Rect` object.
15afbcd0 6239 """
54f9ee45 6240 return _core_.Window_GetClientRect(*args, **kwargs)
e811c8ce
RD
6241
6242 def GetBestSize(*args, **kwargs):
0df68c9f 6243 """
a95a7133 6244 GetBestSize(self) -> Size
e811c8ce 6245
248ed943 6246 This function returns the best acceptable minimal size for the
41e2b43e
RD
6247 window, if applicable. For example, for a static text control, it will
6248 be the minimal size such that the control label is not truncated. For
6249 windows containing subwindows (suzh aswx.Panel), the size returned by
6250 this function will be the same as the size the window would have had
6251 after calling Fit.
0df68c9f 6252 """
54f9ee45 6253 return _core_.Window_GetBestSize(*args, **kwargs)
e811c8ce
RD
6254
6255 def GetBestSizeTuple(*args, **kwargs):
0df68c9f
RD
6256 """
6257 GetBestSizeTuple() -> (width, height)
e811c8ce 6258
248ed943 6259 This function returns the best acceptable minimal size for the
41e2b43e
RD
6260 window, if applicable. For example, for a static text control, it will
6261 be the minimal size such that the control label is not truncated. For
6262 windows containing subwindows (suzh aswx.Panel), the size returned by
6263 this function will be the same as the size the window would have had
6264 after calling Fit.
0df68c9f 6265 """
54f9ee45 6266 return _core_.Window_GetBestSizeTuple(*args, **kwargs)
e811c8ce 6267
dfbb5885
RD
6268 def InvalidateBestSize(*args, **kwargs):
6269 """
6270 InvalidateBestSize(self)
6271
6272 Reset the cached best size value so it will be recalculated the next
6273 time it is needed.
6274 """
6275 return _core_.Window_InvalidateBestSize(*args, **kwargs)
6276
6277 def GetBestFittingSize(*args, **kwargs):
6278 """
6279 GetBestFittingSize(self) -> Size
6280
6281 This function will merge the window's best size into the window's
6282 minimum size, giving priority to the min size components, and returns
6283 the results.
6284
6285 """
6286 return _core_.Window_GetBestFittingSize(*args, **kwargs)
6287
e811c8ce 6288 def GetAdjustedBestSize(*args, **kwargs):
15afbcd0 6289 """
a95a7133 6290 GetAdjustedBestSize(self) -> Size
15afbcd0
RD
6291
6292 This method is similar to GetBestSize, except in one
6293 thing. GetBestSize should return the minimum untruncated size of the
6294 window, while this method will return the largest of BestSize and any
6295 user specified minimum size. ie. it is the minimum size the window
6296 should currently be drawn at, not the minimal size it can possibly
6297 tolerate.
6298 """
54f9ee45 6299 return _core_.Window_GetAdjustedBestSize(*args, **kwargs)
e811c8ce
RD
6300
6301 def Center(*args, **kwargs):
15afbcd0 6302 """
a95a7133 6303 Center(self, int direction=BOTH)
15afbcd0
RD
6304
6305 Centers the window. The parameter specifies the direction for
6306 cetering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may
6307 also include wx.CENTER_ON_SCREEN flag if you want to center the window
6308 on the entire screen and not on its parent window. If it is a
6309 top-level window and has no parent then it will always be centered
6310 relative to the screen.
6311 """
54f9ee45 6312 return _core_.Window_Center(*args, **kwargs)
e811c8ce
RD
6313
6314 Centre = Center
6315 def CenterOnScreen(*args, **kwargs):
15afbcd0 6316 """
a95a7133 6317 CenterOnScreen(self, int dir=BOTH)
15afbcd0
RD
6318
6319 Center on screen (only works for top level windows)
6320 """
54f9ee45 6321 return _core_.Window_CenterOnScreen(*args, **kwargs)
e811c8ce
RD
6322
6323 CentreOnScreen = CenterOnScreen
6324 def CenterOnParent(*args, **kwargs):
15afbcd0 6325 """
a95a7133 6326 CenterOnParent(self, int dir=BOTH)
15afbcd0
RD
6327
6328 Center with respect to the the parent window
6329 """
54f9ee45 6330 return _core_.Window_CenterOnParent(*args, **kwargs)
e811c8ce
RD
6331
6332 CentreOnParent = CenterOnParent
6333 def Fit(*args, **kwargs):
15afbcd0 6334 """
a95a7133 6335 Fit(self)
15afbcd0
RD
6336
6337 Sizes the window so that it fits around its subwindows. This function
6338 won't do anything if there are no subwindows and will only really work
6339 correctly if sizers are used for the subwindows layout. Also, if the
6340 window has exactly one subwindow it is better (faster and the result
6341 is more precise as Fit adds some margin to account for fuzziness of
6342 its calculations) to call window.SetClientSize(child.GetSize())
6343 instead of calling Fit.
6344 """
54f9ee45 6345 return _core_.Window_Fit(*args, **kwargs)
e811c8ce
RD
6346
6347 def FitInside(*args, **kwargs):
15afbcd0 6348 """
a95a7133 6349 FitInside(self)
15afbcd0
RD
6350
6351 Similar to Fit, but sizes the interior (virtual) size of a
6352 window. Mainly useful with scrolled windows to reset scrollbars after
6353 sizing changes that do not trigger a size event, and/or scrolled
6354 windows without an interior sizer. This function similarly won't do
6355 anything if there are no subwindows.
6356 """
54f9ee45 6357 return _core_.Window_FitInside(*args, **kwargs)
e811c8ce 6358
f16ab95d 6359 def SetSizeHints(*args, **kwargs):
0df68c9f 6360 """
a95a7133 6361 SetSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1,
0df68c9f 6362 int incH=-1)
15afbcd0
RD
6363
6364 Allows specification of minimum and maximum window sizes, and window
6365 size increments. If a pair of values is not set (or set to -1), the
6366 default values will be used. If this function is called, the user
908b74cd
RD
6367 will not be able to size the window outside the given bounds (if it is
6368 a top-level window.) Sizers will also inspect the minimum window size
6369 and will use that value if set when calculating layout.
6370
6371 The resizing increments are only significant under Motif or Xt.
0df68c9f 6372 """
f16ab95d 6373 return _core_.Window_SetSizeHints(*args, **kwargs)
e811c8ce 6374
f16ab95d
RD
6375 def SetSizeHintsSz(*args, **kwargs):
6376 """
6377 SetSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize, Size incSize=DefaultSize)
6378
6379 Allows specification of minimum and maximum window sizes, and window
6380 size increments. If a pair of values is not set (or set to -1), the
6381 default values will be used. If this function is called, the user
6382 will not be able to size the window outside the given bounds (if it is
6383 a top-level window.) Sizers will also inspect the minimum window size
6384 and will use that value if set when calculating layout.
6385
6386 The resizing increments are only significant under Motif or Xt.
6387 """
6388 return _core_.Window_SetSizeHintsSz(*args, **kwargs)
6389
6390 def SetVirtualSizeHints(*args, **kwargs):
15afbcd0 6391 """
908b74cd 6392 SetVirtualSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1)
15afbcd0
RD
6393
6394 Allows specification of minimum and maximum virtual window sizes. If a
6395 pair of values is not set (or set to -1), the default values will be
6396 used. If this function is called, the user will not be able to size
6397 the virtual area of the window outside the given bounds.
6398 """
f16ab95d
RD
6399 return _core_.Window_SetVirtualSizeHints(*args, **kwargs)
6400
6401 def SetVirtualSizeHintsSz(*args, **kwargs):
6402 """
6403 SetVirtualSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize)
6404
6405 Allows specification of minimum and maximum virtual window sizes. If a
6406 pair of values is not set (or set to -1), the default values will be
6407 used. If this function is called, the user will not be able to size
6408 the virtual area of the window outside the given bounds.
6409 """
6410 return _core_.Window_SetVirtualSizeHintsSz(*args, **kwargs)
e811c8ce 6411
908b74cd
RD
6412 def GetMaxSize(*args, **kwargs):
6413 """GetMaxSize(self) -> Size"""
6414 return _core_.Window_GetMaxSize(*args, **kwargs)
6415
6416 def GetMinSize(*args, **kwargs):
6417 """GetMinSize(self) -> Size"""
6418 return _core_.Window_GetMinSize(*args, **kwargs)
6419
6420 def SetMinSize(*args, **kwargs):
6421 """
6422 SetMinSize(self, Size minSize)
6423
6424 A more convenient method than `SetSizeHints` for setting just the
6425 min size.
6426 """
6427 return _core_.Window_SetMinSize(*args, **kwargs)
6428
6429 def SetMaxSize(*args, **kwargs):
6430 """
6431 SetMaxSize(self, Size maxSize)
6432
6433 A more convenient method than `SetSizeHints` for setting just the
6434 max size.
6435 """
6436 return _core_.Window_SetMaxSize(*args, **kwargs)
6437
e811c8ce 6438 def GetMinWidth(*args, **kwargs):
a95a7133 6439 """GetMinWidth(self) -> int"""
54f9ee45 6440 return _core_.Window_GetMinWidth(*args, **kwargs)
e811c8ce
RD
6441
6442 def GetMinHeight(*args, **kwargs):
a95a7133 6443 """GetMinHeight(self) -> int"""
54f9ee45 6444 return _core_.Window_GetMinHeight(*args, **kwargs)
e811c8ce
RD
6445
6446 def GetMaxWidth(*args, **kwargs):
a95a7133 6447 """GetMaxWidth(self) -> int"""
54f9ee45 6448 return _core_.Window_GetMaxWidth(*args, **kwargs)
e811c8ce
RD
6449
6450 def GetMaxHeight(*args, **kwargs):
a95a7133 6451 """GetMaxHeight(self) -> int"""
54f9ee45 6452 return _core_.Window_GetMaxHeight(*args, **kwargs)
e811c8ce 6453
e811c8ce 6454 def SetVirtualSize(*args, **kwargs):
0df68c9f 6455 """
a95a7133 6456 SetVirtualSize(self, Size size)
e811c8ce 6457
15afbcd0
RD
6458 Set the the virtual size of a window in pixels. For most windows this
6459 is just the client area of the window, but for some like scrolled
6460 windows it is more or less independent of the screen window size.
0df68c9f 6461 """
54f9ee45 6462 return _core_.Window_SetVirtualSize(*args, **kwargs)
e811c8ce
RD
6463
6464 def SetVirtualSizeWH(*args, **kwargs):
0df68c9f 6465 """
a95a7133 6466 SetVirtualSizeWH(self, int w, int h)
e811c8ce 6467
15afbcd0
RD
6468 Set the the virtual size of a window in pixels. For most windows this
6469 is just the client area of the window, but for some like scrolled
6470 windows it is more or less independent of the screen window size.
0df68c9f 6471 """
54f9ee45 6472 return _core_.Window_SetVirtualSizeWH(*args, **kwargs)
e811c8ce
RD
6473
6474 def GetVirtualSize(*args, **kwargs):
0df68c9f 6475 """
a95a7133 6476 GetVirtualSize(self) -> Size
e811c8ce 6477
15afbcd0
RD
6478 Get the the virtual size of the window in pixels. For most windows
6479 this is just the client area of the window, but for some like scrolled
6480 windows it is more or less independent of the screen window size.
0df68c9f 6481 """
54f9ee45 6482 return _core_.Window_GetVirtualSize(*args, **kwargs)
e811c8ce
RD
6483
6484 def GetVirtualSizeTuple(*args, **kwargs):
0df68c9f
RD
6485 """
6486 GetVirtualSizeTuple() -> (width, height)
e811c8ce 6487
15afbcd0
RD
6488 Get the the virtual size of the window in pixels. For most windows
6489 this is just the client area of the window, but for some like scrolled
6490 windows it is more or less independent of the screen window size.
0df68c9f 6491 """
54f9ee45 6492 return _core_.Window_GetVirtualSizeTuple(*args, **kwargs)
e811c8ce
RD
6493
6494 def GetBestVirtualSize(*args, **kwargs):
15afbcd0 6495 """
a95a7133 6496 GetBestVirtualSize(self) -> Size
15afbcd0
RD
6497
6498 Return the largest of ClientSize and BestSize (as determined by a
6499 sizer, interior children, or other means)
6500 """
54f9ee45 6501 return _core_.Window_GetBestVirtualSize(*args, **kwargs)
e811c8ce
RD
6502
6503 def Show(*args, **kwargs):
15afbcd0 6504 """
a95a7133 6505 Show(self, bool show=True) -> bool
15afbcd0
RD
6506
6507 Shows or hides the window. You may need to call Raise for a top level
6508 window if you want to bring it to top, although this is not needed if
6509 Show is called immediately after the frame creation. Returns True if
6510 the window has been shown or hidden or False if nothing was done
6511 because it already was in the requested state.
6512 """
54f9ee45 6513 return _core_.Window_Show(*args, **kwargs)
e811c8ce
RD
6514
6515 def Hide(*args, **kwargs):
15afbcd0 6516 """
a95a7133 6517 Hide(self) -> bool
15afbcd0
RD
6518
6519 Equivalent to calling Show(False).
6520 """
54f9ee45 6521 return _core_.Window_Hide(*args, **kwargs)
e811c8ce
RD
6522
6523 def Enable(*args, **kwargs):
15afbcd0 6524 """
a95a7133 6525 Enable(self, bool enable=True) -> bool
15afbcd0
RD
6526
6527 Enable or disable the window for user input. Note that when a parent
6528 window is disabled, all of its children are disabled as well and they
6529 are reenabled again when the parent is. Returns true if the window
6530 has been enabled or disabled, false if nothing was done, i.e. if the
6531 window had already been in the specified state.
6532 """
54f9ee45 6533 return _core_.Window_Enable(*args, **kwargs)
e811c8ce
RD
6534
6535 def Disable(*args, **kwargs):
15afbcd0 6536 """
a95a7133 6537 Disable(self) -> bool
15afbcd0
RD
6538
6539 Disables the window, same as Enable(false).
6540 """
54f9ee45 6541 return _core_.Window_Disable(*args, **kwargs)
e811c8ce
RD
6542
6543 def IsShown(*args, **kwargs):
15afbcd0 6544 """
a95a7133 6545 IsShown(self) -> bool
15afbcd0
RD
6546
6547 Returns true if the window is shown, false if it has been hidden.
6548 """
54f9ee45 6549 return _core_.Window_IsShown(*args, **kwargs)
e811c8ce
RD
6550
6551 def IsEnabled(*args, **kwargs):
15afbcd0 6552 """
a95a7133 6553 IsEnabled(self) -> bool
15afbcd0
RD
6554
6555 Returns true if the window is enabled for input, false otherwise.
6556 """
54f9ee45 6557 return _core_.Window_IsEnabled(*args, **kwargs)
e811c8ce
RD
6558
6559 def SetWindowStyleFlag(*args, **kwargs):
15afbcd0 6560 """
a95a7133 6561 SetWindowStyleFlag(self, long style)
15afbcd0 6562
41e2b43e
RD
6563 Sets the style of the window. Please note that some styles cannot be
6564 changed after the window creation and that Refresh() might need to be
6565 called after changing the others for the change to take place
6566 immediately.
15afbcd0 6567 """
54f9ee45 6568 return _core_.Window_SetWindowStyleFlag(*args, **kwargs)
e811c8ce
RD
6569
6570 def GetWindowStyleFlag(*args, **kwargs):
15afbcd0 6571 """
a95a7133 6572 GetWindowStyleFlag(self) -> long
e811c8ce 6573
15afbcd0
RD
6574 Gets the window style that was passed to the constructor or Create
6575 method.
6576 """
54f9ee45 6577 return _core_.Window_GetWindowStyleFlag(*args, **kwargs)
e811c8ce 6578
15afbcd0 6579 SetWindowStyle = SetWindowStyleFlag; GetWindowStyle = GetWindowStyleFlag
e811c8ce 6580 def HasFlag(*args, **kwargs):
15afbcd0 6581 """
a95a7133 6582 HasFlag(self, int flag) -> bool
15afbcd0
RD
6583
6584 Test if the given style is set for this window.
6585 """
54f9ee45 6586 return _core_.Window_HasFlag(*args, **kwargs)
e811c8ce
RD
6587
6588 def IsRetained(*args, **kwargs):
15afbcd0 6589 """
a95a7133 6590 IsRetained(self) -> bool
15afbcd0
RD
6591
6592 Returns true if the window is retained, false otherwise. Retained
6593 windows are only available on X platforms.
6594 """
54f9ee45 6595 return _core_.Window_IsRetained(*args, **kwargs)
e811c8ce
RD
6596
6597 def SetExtraStyle(*args, **kwargs):
15afbcd0 6598 """
a95a7133 6599 SetExtraStyle(self, long exStyle)
15afbcd0
RD
6600
6601 Sets the extra style bits for the window. Extra styles are the less
6602 often used style bits which can't be set with the constructor or with
6603 SetWindowStyleFlag()
6604 """
54f9ee45 6605 return _core_.Window_SetExtraStyle(*args, **kwargs)
e811c8ce
RD
6606
6607 def GetExtraStyle(*args, **kwargs):
15afbcd0 6608 """
a95a7133 6609 GetExtraStyle(self) -> long
15afbcd0
RD
6610
6611 Returns the extra style bits for the window.
6612 """
54f9ee45 6613 return _core_.Window_GetExtraStyle(*args, **kwargs)
e811c8ce
RD
6614
6615 def MakeModal(*args, **kwargs):
15afbcd0 6616 """
a95a7133 6617 MakeModal(self, bool modal=True)
15afbcd0
RD
6618
6619 Disables all other windows in the application so that the user can
6620 only interact with this window. Passing False will reverse this
6621 effect.
6622 """
54f9ee45 6623 return _core_.Window_MakeModal(*args, **kwargs)
e811c8ce
RD
6624
6625 def SetThemeEnabled(*args, **kwargs):
15afbcd0 6626 """
a95a7133 6627 SetThemeEnabled(self, bool enableTheme)
15afbcd0
RD
6628
6629 This function tells a window if it should use the system's "theme"
6630 code to draw the windows' background instead if its own background
6631 drawing code. This will only have an effect on platforms that support
6632 the notion of themes in user defined windows. One such platform is
6633 GTK+ where windows can have (very colourful) backgrounds defined by a
6634 user's selected theme.
6635
6636 Dialogs, notebook pages and the status bar have this flag set to true
6637 by default so that the default look and feel is simulated best.
6638 """
54f9ee45 6639 return _core_.Window_SetThemeEnabled(*args, **kwargs)
e811c8ce
RD
6640
6641 def GetThemeEnabled(*args, **kwargs):
15afbcd0 6642 """
a95a7133 6643 GetThemeEnabled(self) -> bool
e811c8ce 6644
15afbcd0
RD
6645 Return the themeEnabled flag.
6646 """
54f9ee45 6647 return _core_.Window_GetThemeEnabled(*args, **kwargs)
e811c8ce
RD
6648
6649 def SetFocus(*args, **kwargs):
15afbcd0 6650 """
a95a7133 6651 SetFocus(self)
15afbcd0
RD
6652
6653 Set's the focus to this window, allowing it to receive keyboard input.
6654 """
54f9ee45 6655 return _core_.Window_SetFocus(*args, **kwargs)
e811c8ce
RD
6656
6657 def SetFocusFromKbd(*args, **kwargs):
15afbcd0 6658 """
a95a7133 6659 SetFocusFromKbd(self)
15afbcd0
RD
6660
6661 Set focus to this window as the result of a keyboard action. Normally
6662 only called internally.
6663 """
54f9ee45 6664 return _core_.Window_SetFocusFromKbd(*args, **kwargs)
e811c8ce
RD
6665
6666 def FindFocus(*args, **kwargs):
15afbcd0 6667 """
66c033b4 6668 FindFocus() -> Window
15afbcd0
RD
6669
6670 Returns the window or control that currently has the keyboard focus,
6671 or None.
6672 """
54f9ee45 6673 return _core_.Window_FindFocus(*args, **kwargs)
e811c8ce
RD
6674
6675 FindFocus = staticmethod(FindFocus)
6676 def AcceptsFocus(*args, **kwargs):
15afbcd0 6677 """
a95a7133 6678 AcceptsFocus(self) -> bool
15afbcd0
RD
6679
6680 Can this window have focus?
6681 """
54f9ee45 6682 return _core_.Window_AcceptsFocus(*args, **kwargs)
e811c8ce
RD
6683
6684 def AcceptsFocusFromKeyboard(*args, **kwargs):
15afbcd0 6685 """
a95a7133 6686 AcceptsFocusFromKeyboard(self) -> bool
15afbcd0
RD
6687
6688 Can this window be given focus by keyboard navigation? if not, the
6689 only way to give it focus (provided it accepts it at all) is to click
6690 it.
6691 """
54f9ee45 6692 return _core_.Window_AcceptsFocusFromKeyboard(*args, **kwargs)
e811c8ce
RD
6693
6694 def GetDefaultItem(*args, **kwargs):
15afbcd0 6695 """
a95a7133 6696 GetDefaultItem(self) -> Window
15afbcd0
RD
6697
6698 Get the default child of this parent, i.e. the one which is activated
6699 by pressing <Enter> such as the OK button on a wx.Dialog.
6700 """
54f9ee45 6701 return _core_.Window_GetDefaultItem(*args, **kwargs)
e811c8ce
RD
6702
6703 def SetDefaultItem(*args, **kwargs):
15afbcd0 6704 """
a95a7133 6705 SetDefaultItem(self, Window child) -> Window
15afbcd0
RD
6706
6707 Set this child as default, return the old default.
6708 """
54f9ee45 6709 return _core_.Window_SetDefaultItem(*args, **kwargs)
e811c8ce
RD
6710
6711 def SetTmpDefaultItem(*args, **kwargs):
15afbcd0 6712 """
a95a7133 6713 SetTmpDefaultItem(self, Window win)
15afbcd0
RD
6714
6715 Set this child as temporary default
6716 """
54f9ee45 6717 return _core_.Window_SetTmpDefaultItem(*args, **kwargs)
e811c8ce 6718
908b74cd
RD
6719 def Navigate(*args, **kwargs):
6720 """
6721 Navigate(self, int flags=NavigationKeyEvent.IsForward) -> bool
6722
fd2dc343
RD
6723 Does keyboard navigation from this window to another, by sending a
6724 `wx.NavigationKeyEvent`.
908b74cd
RD
6725 """
6726 return _core_.Window_Navigate(*args, **kwargs)
6727
7f98d120
RD
6728 def MoveAfterInTabOrder(*args, **kwargs):
6729 """
6730 MoveAfterInTabOrder(self, Window win)
6731
6732 Moves this window in the tab navigation order after the specified
6733 sibling window. This means that when the user presses the TAB key on
6734 that other window, the focus switches to this window.
6735
6736 The default tab order is the same as creation order. This function
6737 and `MoveBeforeInTabOrder` allow to change it after creating all the
6738 windows.
6739
6740 """
6741 return _core_.Window_MoveAfterInTabOrder(*args, **kwargs)
6742
6743 def MoveBeforeInTabOrder(*args, **kwargs):
6744 """
6745 MoveBeforeInTabOrder(self, Window win)
6746
6747 Same as `MoveAfterInTabOrder` except that it inserts this window just
6748 before win instead of putting it right after it.
6749 """
6750 return _core_.Window_MoveBeforeInTabOrder(*args, **kwargs)
6751
e811c8ce 6752 def GetChildren(*args, **kwargs):
15afbcd0 6753 """
a95a7133 6754 GetChildren(self) -> PyObject
15afbcd0
RD
6755
6756 Returns a list of the window's children. NOTE: Currently this is a
6757 copy of the child window list maintained by the window, so the return
6758 value of this function is only valid as long as the window's children
6759 do not change.
6760 """
54f9ee45 6761 return _core_.Window_GetChildren(*args, **kwargs)
e811c8ce
RD
6762
6763 def GetParent(*args, **kwargs):
15afbcd0 6764 """
a95a7133 6765 GetParent(self) -> Window
15afbcd0
RD
6766
6767 Returns the parent window of this window, or None if there isn't one.
6768 """
54f9ee45 6769 return _core_.Window_GetParent(*args, **kwargs)
e811c8ce
RD
6770
6771 def GetGrandParent(*args, **kwargs):
15afbcd0 6772 """
a95a7133 6773 GetGrandParent(self) -> Window
15afbcd0 6774
41e2b43e
RD
6775 Returns the parent of the parent of this window, or None if there
6776 isn't one.
15afbcd0 6777 """
54f9ee45 6778 return _core_.Window_GetGrandParent(*args, **kwargs)
e811c8ce
RD
6779
6780 def IsTopLevel(*args, **kwargs):
15afbcd0 6781 """
a95a7133 6782 IsTopLevel(self) -> bool
15afbcd0
RD
6783
6784 Returns true if the given window is a top-level one. Currently all
6785 frames and dialogs are always considered to be top-level windows (even
6786 if they have a parent window).
6787 """
54f9ee45 6788 return _core_.Window_IsTopLevel(*args, **kwargs)
e811c8ce
RD
6789
6790 def Reparent(*args, **kwargs):
15afbcd0 6791 """
a95a7133 6792 Reparent(self, Window newParent) -> bool
15afbcd0
RD
6793
6794 Reparents the window, i.e the window will be removed from its current
6795 parent window (e.g. a non-standard toolbar in a wxFrame) and then
6796 re-inserted into another. Available on Windows and GTK. Returns True
6797 if the parent was changed, False otherwise (error or newParent ==
6798 oldParent)
6799 """
54f9ee45 6800 return _core_.Window_Reparent(*args, **kwargs)
e811c8ce
RD
6801
6802 def AddChild(*args, **kwargs):
15afbcd0 6803 """
a95a7133 6804 AddChild(self, Window child)
15afbcd0
RD
6805
6806 Adds a child window. This is called automatically by window creation
6807 functions so should not be required by the application programmer.
6808 """
54f9ee45 6809 return _core_.Window_AddChild(*args, **kwargs)
e811c8ce
RD
6810
6811 def RemoveChild(*args, **kwargs):
15afbcd0 6812 """
a95a7133 6813 RemoveChild(self, Window child)
15afbcd0
RD
6814
6815 Removes a child window. This is called automatically by window
6816 deletion functions so should not be required by the application
6817 programmer.
6818 """
54f9ee45 6819 return _core_.Window_RemoveChild(*args, **kwargs)
e811c8ce
RD
6820
6821 def FindWindowById(*args, **kwargs):
15afbcd0 6822 """
a95a7133 6823 FindWindowById(self, long winid) -> Window
15afbcd0
RD
6824
6825 Find a chld of this window by window ID
6826 """
54f9ee45 6827 return _core_.Window_FindWindowById(*args, **kwargs)
e811c8ce
RD
6828
6829 def FindWindowByName(*args, **kwargs):
15afbcd0 6830 """
a95a7133 6831 FindWindowByName(self, String name) -> Window
15afbcd0
RD
6832
6833 Find a child of this window by name
6834 """
54f9ee45 6835 return _core_.Window_FindWindowByName(*args, **kwargs)
e811c8ce
RD
6836
6837 def GetEventHandler(*args, **kwargs):
15afbcd0 6838 """
a95a7133 6839 GetEventHandler(self) -> EvtHandler
15afbcd0
RD
6840
6841 Returns the event handler for this window. By default, the window is
6842 its own event handler.
6843 """
54f9ee45 6844 return _core_.Window_GetEventHandler(*args, **kwargs)
e811c8ce
RD
6845
6846 def SetEventHandler(*args, **kwargs):
15afbcd0 6847 """
a95a7133 6848 SetEventHandler(self, EvtHandler handler)
15afbcd0
RD
6849
6850 Sets the event handler for this window. An event handler is an object
6851 that is capable of processing the events sent to a window. By default,
6852 the window is its own event handler, but an application may wish to
6853 substitute another, for example to allow central implementation of
6854 event-handling for a variety of different window classes.
6855
41e2b43e 6856 It is usually better to use `wx.Window.PushEventHandler` since this sets
15afbcd0
RD
6857 up a chain of event handlers, where an event not handled by one event
6858 handler is handed to the next one in the chain.
6859 """
54f9ee45 6860 return _core_.Window_SetEventHandler(*args, **kwargs)
e811c8ce
RD
6861
6862 def PushEventHandler(*args, **kwargs):
15afbcd0 6863 """
a95a7133 6864 PushEventHandler(self, EvtHandler handler)
15afbcd0
RD
6865
6866 Pushes this event handler onto the event handler stack for the window.
6867 An event handler is an object that is capable of processing the events
6868 sent to a window. By default, the window is its own event handler, but
6869 an application may wish to substitute another, for example to allow
6870 central implementation of event-handling for a variety of different
6871 window classes.
6872
6873 wx.Window.PushEventHandler allows an application to set up a chain of
6874 event handlers, where an event not handled by one event handler is
41e2b43e 6875 handed to the next one in the chain. Use `wx.Window.PopEventHandler` to
15afbcd0
RD
6876 remove the event handler.
6877 """
54f9ee45 6878 return _core_.Window_PushEventHandler(*args, **kwargs)
e811c8ce
RD
6879
6880 def PopEventHandler(*args, **kwargs):
15afbcd0 6881 """
a95a7133 6882 PopEventHandler(self, bool deleteHandler=False) -> EvtHandler
15afbcd0
RD
6883
6884 Removes and returns the top-most event handler on the event handler
6885 stack. If deleteHandler is True then the wx.EvtHandler object will be
6886 destroyed after it is popped.
6887 """
54f9ee45 6888 return _core_.Window_PopEventHandler(*args, **kwargs)
e811c8ce
RD
6889
6890 def RemoveEventHandler(*args, **kwargs):
15afbcd0 6891 """
a95a7133 6892 RemoveEventHandler(self, EvtHandler handler) -> bool
15afbcd0 6893
41e2b43e
RD
6894 Find the given handler in the event handler chain and remove (but not
6895 delete) it from the event handler chain, return True if it was found
6896 and False otherwise (this also results in an assert failure so this
6897 function should only be called when the handler is supposed to be
6898 there.)
15afbcd0 6899 """
54f9ee45 6900 return _core_.Window_RemoveEventHandler(*args, **kwargs)
e811c8ce
RD
6901
6902 def SetValidator(*args, **kwargs):
15afbcd0 6903 """
a95a7133 6904 SetValidator(self, Validator validator)
15afbcd0
RD
6905
6906 Deletes the current validator (if any) and sets the window validator,
6907 having called wx.Validator.Clone to create a new validator of this
6908 type.
6909 """
54f9ee45 6910 return _core_.Window_SetValidator(*args, **kwargs)
e811c8ce
RD
6911
6912 def GetValidator(*args, **kwargs):
15afbcd0 6913 """
a95a7133 6914 GetValidator(self) -> Validator
15afbcd0
RD
6915
6916 Returns a pointer to the current validator for the window, or None if
6917 there is none.
6918 """
54f9ee45 6919 return _core_.Window_GetValidator(*args, **kwargs)
e811c8ce 6920
74a57fcd
RD
6921 def Validate(*args, **kwargs):
6922 """
a95a7133 6923 Validate(self) -> bool
74a57fcd
RD
6924
6925 Validates the current values of the child controls using their
41e2b43e
RD
6926 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
6927 style flag set, the method will also call Validate() of all child
6928 windows. Returns false if any of the validations failed.
74a57fcd 6929 """
54f9ee45 6930 return _core_.Window_Validate(*args, **kwargs)
74a57fcd
RD
6931
6932 def TransferDataToWindow(*args, **kwargs):
6933 """
a95a7133 6934 TransferDataToWindow(self) -> bool
74a57fcd 6935
41e2b43e
RD
6936 Transfers values to child controls from data areas specified by their
6937 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
6938 style flag set, the method will also call TransferDataToWindow() of
6939 all child windows.
74a57fcd 6940 """
54f9ee45 6941 return _core_.Window_TransferDataToWindow(*args, **kwargs)
74a57fcd
RD
6942
6943 def TransferDataFromWindow(*args, **kwargs):
6944 """
a95a7133 6945 TransferDataFromWindow(self) -> bool
74a57fcd 6946
41e2b43e
RD
6947 Transfers values from child controls to data areas specified by their
6948 validators. Returns false if a transfer failed. If the window has
6949 wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will
6950 also call TransferDataFromWindow() of all child windows.
74a57fcd 6951 """
54f9ee45 6952 return _core_.Window_TransferDataFromWindow(*args, **kwargs)
74a57fcd
RD
6953
6954 def InitDialog(*args, **kwargs):
6955 """
a95a7133 6956 InitDialog(self)
74a57fcd 6957
41e2b43e
RD
6958 Sends an EVT_INIT_DIALOG event, whose handler usually transfers data
6959 to the dialog via validators.
74a57fcd 6960 """
54f9ee45 6961 return _core_.Window_InitDialog(*args, **kwargs)
74a57fcd 6962
e811c8ce 6963 def SetAcceleratorTable(*args, **kwargs):
15afbcd0 6964 """
a95a7133 6965 SetAcceleratorTable(self, AcceleratorTable accel)
15afbcd0
RD
6966
6967 Sets the accelerator table for this window.
6968 """
54f9ee45 6969 return _core_.Window_SetAcceleratorTable(*args, **kwargs)
e811c8ce
RD
6970
6971 def GetAcceleratorTable(*args, **kwargs):
15afbcd0 6972 """
a95a7133 6973 GetAcceleratorTable(self) -> AcceleratorTable
15afbcd0
RD
6974
6975 Gets the accelerator table for this window.
6976 """
54f9ee45 6977 return _core_.Window_GetAcceleratorTable(*args, **kwargs)
e811c8ce
RD
6978
6979 def RegisterHotKey(*args, **kwargs):
15afbcd0 6980 """
a95a7133 6981 RegisterHotKey(self, int hotkeyId, int modifiers, int keycode) -> bool
15afbcd0
RD
6982
6983 Registers a system wide hotkey. Every time the user presses the hotkey
6984 registered here, this window will receive a hotkey event. It will
6985 receive the event even if the application is in the background and
6986 does not have the input focus because the user is working with some
6987 other application. To bind an event handler function to this hotkey
6988 use EVT_HOTKEY with an id equal to hotkeyId. Returns True if the
6989 hotkey was registered successfully.
6990 """
54f9ee45 6991 return _core_.Window_RegisterHotKey(*args, **kwargs)
e811c8ce
RD
6992
6993 def UnregisterHotKey(*args, **kwargs):
15afbcd0 6994 """
a95a7133 6995 UnregisterHotKey(self, int hotkeyId) -> bool
15afbcd0
RD
6996
6997 Unregisters a system wide hotkey.
6998 """
54f9ee45 6999 return _core_.Window_UnregisterHotKey(*args, **kwargs)
e811c8ce
RD
7000
7001 def ConvertDialogPointToPixels(*args, **kwargs):
15afbcd0 7002 """
a95a7133 7003 ConvertDialogPointToPixels(self, Point pt) -> Point
15afbcd0
RD
7004
7005 Converts a point or size from dialog units to pixels. Dialog units
7006 are used for maintaining a dialog's proportions even if the font
7007 changes. For the x dimension, the dialog units are multiplied by the
7008 average character width and then divided by 4. For the y dimension,
7009 the dialog units are multiplied by the average character height and
7010 then divided by 8.
7011 """
54f9ee45 7012 return _core_.Window_ConvertDialogPointToPixels(*args, **kwargs)
e811c8ce
RD
7013
7014 def ConvertDialogSizeToPixels(*args, **kwargs):
15afbcd0 7015 """
a95a7133 7016 ConvertDialogSizeToPixels(self, Size sz) -> Size
15afbcd0
RD
7017
7018 Converts a point or size from dialog units to pixels. Dialog units
7019 are used for maintaining a dialog's proportions even if the font
7020 changes. For the x dimension, the dialog units are multiplied by the
7021 average character width and then divided by 4. For the y dimension,
7022 the dialog units are multiplied by the average character height and
7023 then divided by 8.
7024 """
54f9ee45 7025 return _core_.Window_ConvertDialogSizeToPixels(*args, **kwargs)
e811c8ce
RD
7026
7027 def DLG_PNT(*args, **kwargs):
15afbcd0 7028 """
a95a7133 7029 DLG_PNT(self, Point pt) -> Point
15afbcd0
RD
7030
7031 Converts a point or size from dialog units to pixels. Dialog units
7032 are used for maintaining a dialog's proportions even if the font
7033 changes. For the x dimension, the dialog units are multiplied by the
7034 average character width and then divided by 4. For the y dimension,
7035 the dialog units are multiplied by the average character height and
7036 then divided by 8.
7037 """
54f9ee45 7038 return _core_.Window_DLG_PNT(*args, **kwargs)
e811c8ce
RD
7039
7040 def DLG_SZE(*args, **kwargs):
15afbcd0 7041 """
a95a7133 7042 DLG_SZE(self, Size sz) -> Size
15afbcd0
RD
7043
7044 Converts a point or size from dialog units to pixels. Dialog units
7045 are used for maintaining a dialog's proportions even if the font
7046 changes. For the x dimension, the dialog units are multiplied by the
7047 average character width and then divided by 4. For the y dimension,
7048 the dialog units are multiplied by the average character height and
7049 then divided by 8.
7050 """
54f9ee45 7051 return _core_.Window_DLG_SZE(*args, **kwargs)
e811c8ce
RD
7052
7053 def ConvertPixelPointToDialog(*args, **kwargs):
a95a7133 7054 """ConvertPixelPointToDialog(self, Point pt) -> Point"""
54f9ee45 7055 return _core_.Window_ConvertPixelPointToDialog(*args, **kwargs)
e811c8ce
RD
7056
7057 def ConvertPixelSizeToDialog(*args, **kwargs):
a95a7133 7058 """ConvertPixelSizeToDialog(self, Size sz) -> Size"""
54f9ee45 7059 return _core_.Window_ConvertPixelSizeToDialog(*args, **kwargs)
e811c8ce
RD
7060
7061 def WarpPointer(*args, **kwargs):
15afbcd0 7062 """
a95a7133 7063 WarpPointer(self, int x, int y)
15afbcd0
RD
7064
7065 Moves the pointer to the given position on the window.
7066
7067 NOTE: This function is not supported under Mac because Apple Human
7068 Interface Guidelines forbid moving the mouse cursor programmatically.
7069 """
54f9ee45 7070 return _core_.Window_WarpPointer(*args, **kwargs)
e811c8ce
RD
7071
7072 def CaptureMouse(*args, **kwargs):
15afbcd0 7073 """
a95a7133 7074 CaptureMouse(self)
15afbcd0
RD
7075
7076 Directs all mouse input to this window. Call wx.Window.ReleaseMouse to
7077 release the capture.
7078
7079 Note that wxWindows maintains the stack of windows having captured the
7080 mouse and when the mouse is released the capture returns to the window
7081 which had had captured it previously and it is only really released if
7082 there were no previous window. In particular, this means that you must
7083 release the mouse as many times as you capture it.
7084 """
54f9ee45 7085 return _core_.Window_CaptureMouse(*args, **kwargs)
e811c8ce
RD
7086
7087 def ReleaseMouse(*args, **kwargs):
15afbcd0 7088 """
a95a7133 7089 ReleaseMouse(self)
15afbcd0
RD
7090
7091 Releases mouse input captured with wx.Window.CaptureMouse.
7092 """
54f9ee45 7093 return _core_.Window_ReleaseMouse(*args, **kwargs)
e811c8ce
RD
7094
7095 def GetCapture(*args, **kwargs):
15afbcd0 7096 """
66c033b4 7097 GetCapture() -> Window
15afbcd0
RD
7098
7099 Returns the window which currently captures the mouse or None
7100 """
54f9ee45 7101 return _core_.Window_GetCapture(*args, **kwargs)
e811c8ce
RD
7102
7103 GetCapture = staticmethod(GetCapture)
7104 def HasCapture(*args, **kwargs):
15afbcd0 7105 """
a95a7133 7106 HasCapture(self) -> bool
15afbcd0
RD
7107
7108 Returns true if this window has the current mouse capture.
7109 """
54f9ee45 7110 return _core_.Window_HasCapture(*args, **kwargs)
e811c8ce
RD
7111
7112 def Refresh(*args, **kwargs):
15afbcd0 7113 """
a95a7133 7114 Refresh(self, bool eraseBackground=True, Rect rect=None)
15afbcd0
RD
7115
7116 Mark the specified rectangle (or the whole window) as "dirty" so it
7117 will be repainted. Causes an EVT_PAINT event to be generated and sent
7118 to the window.
7119 """
54f9ee45 7120 return _core_.Window_Refresh(*args, **kwargs)
e811c8ce
RD
7121
7122 def RefreshRect(*args, **kwargs):
15afbcd0 7123 """
fef4c27a 7124 RefreshRect(self, Rect rect, bool eraseBackground=True)
15afbcd0
RD
7125
7126 Redraws the contents of the given rectangle: the area inside it will
7127 be repainted. This is the same as Refresh but has a nicer syntax.
7128 """
54f9ee45 7129 return _core_.Window_RefreshRect(*args, **kwargs)
e811c8ce
RD
7130
7131 def Update(*args, **kwargs):
15afbcd0 7132 """
a95a7133 7133 Update(self)
15afbcd0
RD
7134
7135 Calling this method immediately repaints the invalidated area of the
7136 window instead of waiting for the EVT_PAINT event to happen, (normally
7137 this would usually only happen when the flow of control returns to the
7138 event loop.) Notice that this function doesn't refresh the window and
7139 does nothing if the window has been already repainted. Use Refresh
7140 first if you want to immediately redraw the window (or some portion of
7141 it) unconditionally.
7142 """
54f9ee45 7143 return _core_.Window_Update(*args, **kwargs)
e811c8ce
RD
7144
7145 def ClearBackground(*args, **kwargs):
15afbcd0 7146 """
a95a7133 7147 ClearBackground(self)
15afbcd0
RD
7148
7149 Clears the window by filling it with the current background
7150 colour. Does not cause an erase background event to be generated.
7151 """
54f9ee45 7152 return _core_.Window_ClearBackground(*args, **kwargs)
e811c8ce
RD
7153
7154 def Freeze(*args, **kwargs):
15afbcd0 7155 """
a95a7133 7156 Freeze(self)
15afbcd0 7157
41e2b43e
RD
7158 Freezes the window or, in other words, prevents any updates from
7159 taking place on screen, the window is not redrawn at all. Thaw must be
7160 called to reenable window redrawing. Calls to Freeze/Thaw may be
7161 nested, with the actual Thaw being delayed until all the nesting has
7162 been undone.
15afbcd0
RD
7163
7164 This method is useful for visual appearance optimization (for example,
7165 it is a good idea to use it before inserting large amount of text into
7166 a wxTextCtrl under wxGTK) but is not implemented on all platforms nor
7167 for all controls so it is mostly just a hint to wxWindows and not a
7168 mandatory directive.
7169 """
54f9ee45 7170 return _core_.Window_Freeze(*args, **kwargs)
e811c8ce
RD
7171
7172 def Thaw(*args, **kwargs):
15afbcd0 7173 """
a95a7133 7174 Thaw(self)
15afbcd0 7175
4276dc52 7176 Reenables window updating after a previous call to Freeze. Calls to
41e2b43e
RD
7177 Freeze/Thaw may be nested, so Thaw must be called the same number of
7178 times that Freeze was before the window will be updated.
15afbcd0 7179 """
54f9ee45 7180 return _core_.Window_Thaw(*args, **kwargs)
e811c8ce
RD
7181
7182 def PrepareDC(*args, **kwargs):
15afbcd0 7183 """
a95a7133 7184 PrepareDC(self, DC dc)
15afbcd0
RD
7185
7186 Call this function to prepare the device context for drawing a
7187 scrolled image. It sets the device origin according to the current
7188 scroll position.
7189 """
54f9ee45 7190 return _core_.Window_PrepareDC(*args, **kwargs)
e811c8ce
RD
7191
7192 def GetUpdateRegion(*args, **kwargs):
15afbcd0 7193 """
a95a7133 7194 GetUpdateRegion(self) -> Region
15afbcd0
RD
7195
7196 Returns the region specifying which parts of the window have been
7197 damaged. Should only be called within an EVT_PAINT handler.
7198 """
54f9ee45 7199 return _core_.Window_GetUpdateRegion(*args, **kwargs)
e811c8ce
RD
7200
7201 def GetUpdateClientRect(*args, **kwargs):
15afbcd0 7202 """
a95a7133 7203 GetUpdateClientRect(self) -> Rect
15afbcd0
RD
7204
7205 Get the update rectangle region bounding box in client coords.
7206 """
54f9ee45 7207 return _core_.Window_GetUpdateClientRect(*args, **kwargs)
e811c8ce
RD
7208
7209 def IsExposed(*args, **kwargs):
15afbcd0 7210 """
a95a7133 7211 IsExposed(self, int x, int y, int w=1, int h=1) -> bool
15afbcd0
RD
7212
7213 Returns true if the given point or rectangle area has been exposed
7214 since the last repaint. Call this in an paint event handler to
7215 optimize redrawing by only redrawing those areas, which have been
7216 exposed.
7217 """
54f9ee45 7218 return _core_.Window_IsExposed(*args, **kwargs)
e811c8ce
RD
7219
7220 def IsExposedPoint(*args, **kwargs):
15afbcd0 7221 """
a95a7133 7222 IsExposedPoint(self, Point pt) -> bool
15afbcd0
RD
7223
7224 Returns true if the given point or rectangle area has been exposed
7225 since the last repaint. Call this in an paint event handler to
7226 optimize redrawing by only redrawing those areas, which have been
7227 exposed.
7228 """
54f9ee45 7229 return _core_.Window_IsExposedPoint(*args, **kwargs)
e811c8ce 7230
4276dc52 7231 def IsExposedRect(*args, **kwargs):
15afbcd0 7232 """
a95a7133 7233 IsExposedRect(self, Rect rect) -> bool
15afbcd0
RD
7234
7235 Returns true if the given point or rectangle area has been exposed
7236 since the last repaint. Call this in an paint event handler to
7237 optimize redrawing by only redrawing those areas, which have been
7238 exposed.
7239 """
54f9ee45 7240 return _core_.Window_IsExposedRect(*args, **kwargs)
e811c8ce 7241
74a57fcd
RD
7242 def GetDefaultAttributes(*args, **kwargs):
7243 """
a95a7133 7244 GetDefaultAttributes(self) -> VisualAttributes
74a57fcd 7245
41e2b43e
RD
7246 Get the default attributes for an instance of this class. This is
7247 useful if you want to use the same font or colour in your own control
7248 as in a standard control -- which is a much better idea than hard
7249 coding specific colours or fonts which might look completely out of
db3e571a 7250 place on the user's system, especially if it uses themes.
74a57fcd 7251 """
54f9ee45 7252 return _core_.Window_GetDefaultAttributes(*args, **kwargs)
74a57fcd
RD
7253
7254 def GetClassDefaultAttributes(*args, **kwargs):
7255 """
66c033b4 7256 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
74a57fcd 7257
41e2b43e
RD
7258 Get the default attributes for this class. This is useful if you want
7259 to use the same font or colour in your own control as in a standard
7260 control -- which is a much better idea than hard coding specific
db3e571a
RD
7261 colours or fonts which might look completely out of place on the
7262 user's system, especially if it uses themes.
74a57fcd
RD
7263
7264 The variant parameter is only relevant under Mac currently and is
41e2b43e 7265 ignore under other platforms. Under Mac, it will change the size of
db3e571a
RD
7266 the returned font. See `wx.Window.SetWindowVariant` for more about
7267 this.
74a57fcd 7268 """
54f9ee45 7269 return _core_.Window_GetClassDefaultAttributes(*args, **kwargs)
74a57fcd
RD
7270
7271 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
e811c8ce 7272 def SetBackgroundColour(*args, **kwargs):
15afbcd0 7273 """
a95a7133 7274 SetBackgroundColour(self, Colour colour) -> bool
15afbcd0
RD
7275
7276 Sets the background colour of the window. Returns True if the colour
7277 was changed. The background colour is usually painted by the default
7278 EVT_ERASE_BACKGROUND event handler function under Windows and
f8167d6e
RD
7279 automatically under GTK. Using `wx.NullColour` will reset the window
7280 to the default background colour.
15afbcd0 7281
db3e571a 7282 Note that setting the background colour may not cause an immediate
f8167d6e 7283 refresh, so you may wish to call `ClearBackground` or `Refresh` after
15afbcd0
RD
7284 calling this function.
7285
f8167d6e
RD
7286 Using this function will disable attempts to use themes for this
7287 window, if the system supports them. Use with care since usually the
7288 themes represent the appearance chosen by the user to be used for all
7289 applications on the system.
15afbcd0 7290 """
54f9ee45 7291 return _core_.Window_SetBackgroundColour(*args, **kwargs)
e811c8ce 7292
412d302d
RD
7293 def SetOwnBackgroundColour(*args, **kwargs):
7294 """SetOwnBackgroundColour(self, Colour colour)"""
7295 return _core_.Window_SetOwnBackgroundColour(*args, **kwargs)
b2df227b 7296
e811c8ce 7297 def SetForegroundColour(*args, **kwargs):
15afbcd0 7298 """
a95a7133 7299 SetForegroundColour(self, Colour colour) -> bool
15afbcd0
RD
7300
7301 Sets the foreground colour of the window. Returns True is the colour
7302 was changed. The interpretation of foreground colour is dependent on
7303 the window class; it may be the text colour or other colour, or it may
7304 not be used at all.
7305 """
54f9ee45 7306 return _core_.Window_SetForegroundColour(*args, **kwargs)
e811c8ce 7307
fa47d7a7
VS
7308 def SetOwnForegroundColour(*args, **kwargs):
7309 """SetOwnForegroundColour(self, Colour colour)"""
7310 return _core_.Window_SetOwnForegroundColour(*args, **kwargs)
b2df227b 7311
e811c8ce 7312 def GetBackgroundColour(*args, **kwargs):
15afbcd0 7313 """
a95a7133 7314 GetBackgroundColour(self) -> Colour
15afbcd0
RD
7315
7316 Returns the background colour of the window.
7317 """
54f9ee45 7318 return _core_.Window_GetBackgroundColour(*args, **kwargs)
e811c8ce
RD
7319
7320 def GetForegroundColour(*args, **kwargs):
15afbcd0 7321 """
a95a7133 7322 GetForegroundColour(self) -> Colour
15afbcd0
RD
7323
7324 Returns the foreground colour of the window. The interpretation of
7325 foreground colour is dependent on the window class; it may be the text
7326 colour or other colour, or it may not be used at all.
7327 """
54f9ee45 7328 return _core_.Window_GetForegroundColour(*args, **kwargs)
e811c8ce 7329
7bc1e663
RD
7330 def SetBackgroundStyle(*args, **kwargs):
7331 """
7332 SetBackgroundStyle(self, int style) -> bool
7333
7334 Returns the background style of the window. The background style
7335 indicates how the background of the window is drawn.
7336
7337 ====================== ========================================
7338 wx.BG_STYLE_SYSTEM The background colour or pattern should
7339 be determined by the system
7340 wx.BG_STYLE_COLOUR The background should be a solid colour
7341 wx.BG_STYLE_CUSTOM The background will be implemented by the
7342 application.
7343 ====================== ========================================
7344
7345 On GTK+, use of wx.BG_STYLE_CUSTOM allows the flicker-free drawing of
7346 a custom background, such as a tiled bitmap. Currently the style has
7347 no effect on other platforms.
7348
7349 :see: `GetBackgroundStyle`, `SetBackgroundColour`
7350 """
7351 return _core_.Window_SetBackgroundStyle(*args, **kwargs)
7352
7353 def GetBackgroundStyle(*args, **kwargs):
7354 """
7355 GetBackgroundStyle(self) -> int
7356
7357 Returns the background style of the window.
7358
7359 :see: `SetBackgroundStyle`
7360 """
7361 return _core_.Window_GetBackgroundStyle(*args, **kwargs)
7362
51b83b37
RD
7363 def HasTransparentBackground(*args, **kwargs):
7364 """
7365 HasTransparentBackground(self) -> bool
7366
7367 Returns True if this window's background is transparent (as, for
7368 example, for `wx.StaticText`) and should show the parent window's
7369 background.
7370
7371 This method is mostly used internally by the library itself and you
7372 normally shouldn't have to call it. You may, however, have to override
7373 it in your custom control classes to ensure that background is painted
7374 correctly.
7375 """
7376 return _core_.Window_HasTransparentBackground(*args, **kwargs)
7377
e811c8ce 7378 def SetCursor(*args, **kwargs):
15afbcd0 7379 """
a95a7133 7380 SetCursor(self, Cursor cursor) -> bool
15afbcd0
RD
7381
7382 Sets the window's cursor. Notice that the window cursor also sets it
7383 for the children of the window implicitly.
7384
7385 The cursor may be wx.NullCursor in which case the window cursor will
7386 be reset back to default.
7387 """
54f9ee45 7388 return _core_.Window_SetCursor(*args, **kwargs)
e811c8ce
RD
7389
7390 def GetCursor(*args, **kwargs):
15afbcd0 7391 """
a95a7133 7392 GetCursor(self) -> Cursor
15afbcd0
RD
7393
7394 Return the cursor associated with this window.
7395 """
54f9ee45 7396 return _core_.Window_GetCursor(*args, **kwargs)
e811c8ce
RD
7397
7398 def SetFont(*args, **kwargs):
15afbcd0 7399 """
a95a7133 7400 SetFont(self, Font font) -> bool
15afbcd0
RD
7401
7402 Sets the font for this window.
7403 """
54f9ee45 7404 return _core_.Window_SetFont(*args, **kwargs)
e811c8ce 7405
fa47d7a7
VS
7406 def SetOwnFont(*args, **kwargs):
7407 """SetOwnFont(self, Font font)"""
7408 return _core_.Window_SetOwnFont(*args, **kwargs)
b2df227b 7409
e811c8ce 7410 def GetFont(*args, **kwargs):
15afbcd0 7411 """
a95a7133 7412 GetFont(self) -> Font
15afbcd0 7413
4276dc52 7414 Returns the default font used for this window.
15afbcd0 7415 """
54f9ee45 7416 return _core_.Window_GetFont(*args, **kwargs)
e811c8ce
RD
7417
7418 def SetCaret(*args, **kwargs):
15afbcd0 7419 """
a95a7133 7420 SetCaret(self, Caret caret)
15afbcd0
RD
7421
7422 Sets the caret associated with the window.
7423 """
54f9ee45 7424 return _core_.Window_SetCaret(*args, **kwargs)
e811c8ce
RD
7425
7426 def GetCaret(*args, **kwargs):
15afbcd0 7427 """
a95a7133 7428 GetCaret(self) -> Caret
15afbcd0
RD
7429
7430 Returns the caret associated with the window.
7431 """
54f9ee45 7432 return _core_.Window_GetCaret(*args, **kwargs)
e811c8ce
RD
7433
7434 def GetCharHeight(*args, **kwargs):
15afbcd0 7435 """
a95a7133 7436 GetCharHeight(self) -> int
15afbcd0
RD
7437
7438 Get the (average) character size for the current font.
7439 """
54f9ee45 7440 return _core_.Window_GetCharHeight(*args, **kwargs)
e811c8ce
RD
7441
7442 def GetCharWidth(*args, **kwargs):
15afbcd0 7443 """
a95a7133 7444 GetCharWidth(self) -> int
15afbcd0
RD
7445
7446 Get the (average) character size for the current font.
7447 """
54f9ee45 7448 return _core_.Window_GetCharWidth(*args, **kwargs)
e811c8ce
RD
7449
7450 def GetTextExtent(*args, **kwargs):
fd2dc343
RD
7451 """
7452 GetTextExtent(String string) -> (width, height)
7453
7454 Get the width and height of the text using the current font.
7455 """
54f9ee45 7456 return _core_.Window_GetTextExtent(*args, **kwargs)
e811c8ce
RD
7457
7458 def GetFullTextExtent(*args, **kwargs):
0df68c9f 7459 """
196addbf 7460 GetFullTextExtent(String string, Font font=None) ->
0df68c9f 7461 (width, height, descent, externalLeading)
e811c8ce 7462
15afbcd0
RD
7463 Get the width, height, decent and leading of the text using the
7464 current or specified font.
0df68c9f 7465 """
54f9ee45 7466 return _core_.Window_GetFullTextExtent(*args, **kwargs)
e811c8ce
RD
7467
7468 def ClientToScreenXY(*args, **kwargs):
15afbcd0
RD
7469 """
7470 ClientToScreenXY(int x, int y) -> (x,y)
7471
7472 Converts to screen coordinates from coordinates relative to this window.
7473 """
54f9ee45 7474 return _core_.Window_ClientToScreenXY(*args, **kwargs)
e811c8ce
RD
7475
7476 def ScreenToClientXY(*args, **kwargs):
15afbcd0
RD
7477 """
7478 ScreenToClientXY(int x, int y) -> (x,y)
7479
7480 Converts from screen to client window coordinates.
7481 """
54f9ee45 7482 return _core_.Window_ScreenToClientXY(*args, **kwargs)
e811c8ce
RD
7483
7484 def ClientToScreen(*args, **kwargs):
15afbcd0 7485 """
a95a7133 7486 ClientToScreen(self, Point pt) -> Point
15afbcd0
RD
7487
7488 Converts to screen coordinates from coordinates relative to this window.
7489 """
54f9ee45 7490 return _core_.Window_ClientToScreen(*args, **kwargs)
e811c8ce
RD
7491
7492 def ScreenToClient(*args, **kwargs):
15afbcd0 7493 """
a95a7133 7494 ScreenToClient(self, Point pt) -> Point
15afbcd0
RD
7495
7496 Converts from screen to client window coordinates.
7497 """
54f9ee45 7498 return _core_.Window_ScreenToClient(*args, **kwargs)
e811c8ce
RD
7499
7500 def HitTestXY(*args, **kwargs):
15afbcd0 7501 """
a95a7133 7502 HitTestXY(self, int x, int y) -> int
15afbcd0
RD
7503
7504 Test where the given (in client coords) point lies
7505 """
54f9ee45 7506 return _core_.Window_HitTestXY(*args, **kwargs)
e811c8ce
RD
7507
7508 def HitTest(*args, **kwargs):
15afbcd0 7509 """
a95a7133 7510 HitTest(self, Point pt) -> int
15afbcd0
RD
7511
7512 Test where the given (in client coords) point lies
7513 """
54f9ee45 7514 return _core_.Window_HitTest(*args, **kwargs)
e811c8ce 7515
15afbcd0
RD
7516 def GetBorder(*args):
7517 """
a95a7133
RD
7518 GetBorder(self, long flags) -> int
7519 GetBorder(self) -> int
e811c8ce 7520
15afbcd0
RD
7521 Get border for the flags of this window
7522 """
54f9ee45 7523 return _core_.Window_GetBorder(*args)
e811c8ce
RD
7524
7525 def UpdateWindowUI(*args, **kwargs):
15afbcd0 7526 """
a95a7133 7527 UpdateWindowUI(self, long flags=UPDATE_UI_NONE)
15afbcd0
RD
7528
7529 This function sends EVT_UPDATE_UI events to the window. The particular
7530 implementation depends on the window; for example a wx.ToolBar will
7531 send an update UI event for each toolbar button, and a wx.Frame will
7532 send an update UI event for each menubar menu item. You can call this
7533 function from your application to ensure that your UI is up-to-date at
7534 a particular point in time (as far as your EVT_UPDATE_UI handlers are
7535 concerned). This may be necessary if you have called
7536 wx.UpdateUIEvent.SetMode or wx.UpdateUIEvent.SetUpdateInterval to
7537 limit the overhead that wxWindows incurs by sending update UI events
7538 in idle time.
15afbcd0 7539 """
54f9ee45 7540 return _core_.Window_UpdateWindowUI(*args, **kwargs)
e811c8ce
RD
7541
7542 def PopupMenuXY(*args, **kwargs):
15afbcd0 7543 """
b0503257 7544 PopupMenuXY(self, Menu menu, int x=-1, int y=-1) -> bool
15afbcd0 7545
b0503257
RD
7546 Pops up the given menu at the specified coordinates, relative to this window,
7547 and returns control when the user has dismissed the menu. If a menu item is
7548 selected, the corresponding menu event is generated and will be processed as
7549 usual. If the default position is given then the current position of the
7550 mouse cursor will be used.
15afbcd0 7551 """
54f9ee45 7552 return _core_.Window_PopupMenuXY(*args, **kwargs)
e811c8ce 7553
15afbcd0
RD
7554 def PopupMenu(*args, **kwargs):
7555 """
b0503257 7556 PopupMenu(self, Menu menu, Point pos=DefaultPosition) -> bool
15afbcd0 7557
b0503257
RD
7558 Pops up the given menu at the specified coordinates, relative to this window,
7559 and returns control when the user has dismissed the menu. If a menu item is
7560 selected, the corresponding menu event is generated and will be processed as
7561 usual. If the default position is given then the current position of the
7562 mouse cursor will be used.
15afbcd0 7563 """
54f9ee45 7564 return _core_.Window_PopupMenu(*args, **kwargs)
15afbcd0
RD
7565
7566 def GetHandle(*args, **kwargs):
7567 """
a95a7133 7568 GetHandle(self) -> long
15afbcd0
RD
7569
7570 Returns the platform-specific handle (as a long integer) of the
7571 physical window. Currently on wxMac it returns the handle of the
7572 toplevel parent of the window.
7573 """
54f9ee45 7574 return _core_.Window_GetHandle(*args, **kwargs)
15afbcd0 7575
7e63a440
RD
7576 def AssociateHandle(*args, **kwargs):
7577 """
7578 AssociateHandle(self, long handle)
7579
7580 Associate the window with a new native handle
7581 """
7582 return _core_.Window_AssociateHandle(*args, **kwargs)
7583
7584 def DissociateHandle(*args, **kwargs):
7585 """
7586 DissociateHandle(self)
7587
7588 Dissociate the current native handle from the window
7589 """
7590 return _core_.Window_DissociateHandle(*args, **kwargs)
7591
15afbcd0
RD
7592 def HasScrollbar(*args, **kwargs):
7593 """
a95a7133 7594 HasScrollbar(self, int orient) -> bool
15afbcd0
RD
7595
7596 Does the window have the scrollbar for this orientation?
7597 """
54f9ee45 7598 return _core_.Window_HasScrollbar(*args, **kwargs)
15afbcd0
RD
7599
7600 def SetScrollbar(*args, **kwargs):
7601 """
41e2b43e 7602 SetScrollbar(self, int orientation, int position, int thumbSize, int range,
15afbcd0
RD
7603 bool refresh=True)
7604
7605 Sets the scrollbar properties of a built-in scrollbar.
15afbcd0 7606 """
54f9ee45 7607 return _core_.Window_SetScrollbar(*args, **kwargs)
e811c8ce
RD
7608
7609 def SetScrollPos(*args, **kwargs):
15afbcd0 7610 """
a95a7133 7611 SetScrollPos(self, int orientation, int pos, bool refresh=True)
15afbcd0
RD
7612
7613 Sets the position of one of the built-in scrollbars.
7614 """
54f9ee45 7615 return _core_.Window_SetScrollPos(*args, **kwargs)
e811c8ce
RD
7616
7617 def GetScrollPos(*args, **kwargs):
15afbcd0 7618 """
a95a7133 7619 GetScrollPos(self, int orientation) -> int
15afbcd0
RD
7620
7621 Returns the built-in scrollbar position.
7622 """
54f9ee45 7623 return _core_.Window_GetScrollPos(*args, **kwargs)
e811c8ce
RD
7624
7625 def GetScrollThumb(*args, **kwargs):
15afbcd0 7626 """
a95a7133 7627 GetScrollThumb(self, int orientation) -> int
15afbcd0
RD
7628
7629 Returns the built-in scrollbar thumb size.
7630 """
54f9ee45 7631 return _core_.Window_GetScrollThumb(*args, **kwargs)
e811c8ce
RD
7632
7633 def GetScrollRange(*args, **kwargs):
15afbcd0 7634 """
a95a7133 7635 GetScrollRange(self, int orientation) -> int
15afbcd0
RD
7636
7637 Returns the built-in scrollbar range.
7638 """
54f9ee45 7639 return _core_.Window_GetScrollRange(*args, **kwargs)
e811c8ce
RD
7640
7641 def ScrollWindow(*args, **kwargs):
15afbcd0 7642 """
a95a7133 7643 ScrollWindow(self, int dx, int dy, Rect rect=None)
15afbcd0
RD
7644
7645 Physically scrolls the pixels in the window and move child windows
7646 accordingly. Use this function to optimise your scrolling
7647 implementations, to minimise the area that must be redrawn. Note that
7648 it is rarely required to call this function from a user program.
15afbcd0 7649 """
54f9ee45 7650 return _core_.Window_ScrollWindow(*args, **kwargs)
e811c8ce
RD
7651
7652 def ScrollLines(*args, **kwargs):
15afbcd0 7653 """
a95a7133 7654 ScrollLines(self, int lines) -> bool
15afbcd0
RD
7655
7656 If the platform and window class supports it, scrolls the window by
7657 the given number of lines down, if lines is positive, or up if lines
7658 is negative. Returns True if the window was scrolled, False if it was
7659 already on top/bottom and nothing was done.
7660 """
54f9ee45 7661 return _core_.Window_ScrollLines(*args, **kwargs)
e811c8ce
RD
7662
7663 def ScrollPages(*args, **kwargs):
15afbcd0 7664 """
a95a7133 7665 ScrollPages(self, int pages) -> bool
15afbcd0 7666
41e2b43e 7667 If the platform and window class supports it, scrolls the window by
15afbcd0
RD
7668 the given number of pages down, if pages is positive, or up if pages
7669 is negative. Returns True if the window was scrolled, False if it was
7670 already on top/bottom and nothing was done.
7671 """
54f9ee45 7672 return _core_.Window_ScrollPages(*args, **kwargs)
e811c8ce
RD
7673
7674 def LineUp(*args, **kwargs):
15afbcd0 7675 """
a95a7133 7676 LineUp(self) -> bool
15afbcd0
RD
7677
7678 This is just a wrapper for ScrollLines(-1).
7679 """
54f9ee45 7680 return _core_.Window_LineUp(*args, **kwargs)
e811c8ce
RD
7681
7682 def LineDown(*args, **kwargs):
15afbcd0 7683 """
a95a7133 7684 LineDown(self) -> bool
15afbcd0
RD
7685
7686 This is just a wrapper for ScrollLines(1).
7687 """
54f9ee45 7688 return _core_.Window_LineDown(*args, **kwargs)
e811c8ce
RD
7689
7690 def PageUp(*args, **kwargs):
15afbcd0 7691 """
a95a7133 7692 PageUp(self) -> bool
15afbcd0
RD
7693
7694 This is just a wrapper for ScrollPages(-1).
7695 """
54f9ee45 7696 return _core_.Window_PageUp(*args, **kwargs)
e811c8ce
RD
7697
7698 def PageDown(*args, **kwargs):
15afbcd0 7699 """
a95a7133 7700 PageDown(self) -> bool
15afbcd0
RD
7701
7702 This is just a wrapper for ScrollPages(1).
7703 """
54f9ee45 7704 return _core_.Window_PageDown(*args, **kwargs)
e811c8ce
RD
7705
7706 def SetHelpText(*args, **kwargs):
15afbcd0 7707 """
a95a7133 7708 SetHelpText(self, String text)
15afbcd0
RD
7709
7710 Sets the help text to be used as context-sensitive help for this
7711 window. Note that the text is actually stored by the current
7712 wxHelpProvider implementation, and not in the window object itself.
7713 """
54f9ee45 7714 return _core_.Window_SetHelpText(*args, **kwargs)
e811c8ce
RD
7715
7716 def SetHelpTextForId(*args, **kwargs):
15afbcd0 7717 """
a95a7133 7718 SetHelpTextForId(self, String text)
15afbcd0
RD
7719
7720 Associate this help text with all windows with the same id as this
7721 one.
7722 """
54f9ee45 7723 return _core_.Window_SetHelpTextForId(*args, **kwargs)
e811c8ce
RD
7724
7725 def GetHelpText(*args, **kwargs):
15afbcd0 7726 """
a95a7133 7727 GetHelpText(self) -> String
15afbcd0
RD
7728
7729 Gets the help text to be used as context-sensitive help for this
7730 window. Note that the text is actually stored by the current
7731 wxHelpProvider implementation, and not in the window object itself.
7732 """
54f9ee45 7733 return _core_.Window_GetHelpText(*args, **kwargs)
e811c8ce
RD
7734
7735 def SetToolTipString(*args, **kwargs):
15afbcd0 7736 """
a95a7133 7737 SetToolTipString(self, String tip)
15afbcd0
RD
7738
7739 Attach a tooltip to the window.
7740 """
54f9ee45 7741 return _core_.Window_SetToolTipString(*args, **kwargs)
e811c8ce
RD
7742
7743 def SetToolTip(*args, **kwargs):
15afbcd0 7744 """
a95a7133 7745 SetToolTip(self, ToolTip tip)
15afbcd0
RD
7746
7747 Attach a tooltip to the window.
7748 """
54f9ee45 7749 return _core_.Window_SetToolTip(*args, **kwargs)
e811c8ce
RD
7750
7751 def GetToolTip(*args, **kwargs):
15afbcd0 7752 """
a95a7133 7753 GetToolTip(self) -> ToolTip
15afbcd0
RD
7754
7755 get the associated tooltip or None if none
7756 """
54f9ee45 7757 return _core_.Window_GetToolTip(*args, **kwargs)
e811c8ce
RD
7758
7759 def SetDropTarget(*args, **kwargs):
15afbcd0 7760 """
a95a7133 7761 SetDropTarget(self, DropTarget dropTarget)
15afbcd0
RD
7762
7763 Associates a drop target with this window. If the window already has
7764 a drop target, it is deleted.
7765 """
54f9ee45 7766 return _core_.Window_SetDropTarget(*args, **kwargs)
e811c8ce
RD
7767
7768 def GetDropTarget(*args, **kwargs):
15afbcd0 7769 """
a95a7133 7770 GetDropTarget(self) -> DropTarget
15afbcd0
RD
7771
7772 Returns the associated drop target, which may be None.
7773 """
54f9ee45 7774 return _core_.Window_GetDropTarget(*args, **kwargs)
e811c8ce
RD
7775
7776 def SetConstraints(*args, **kwargs):
15afbcd0 7777 """
a95a7133 7778 SetConstraints(self, LayoutConstraints constraints)
15afbcd0
RD
7779
7780 Sets the window to have the given layout constraints. If an existing
7781 layout constraints object is already owned by the window, it will be
7782 deleted. Pass None to disassociate and delete the window's current
7783 constraints.
7784
7785 You must call SetAutoLayout to tell a window to use the constraints
7786 automatically in its default EVT_SIZE handler; otherwise, you must
7787 handle EVT_SIZE yourself and call Layout() explicitly. When setting
7788 both a wx.LayoutConstraints and a wx.Sizer, only the sizer will have
7789 effect.
7790 """
54f9ee45 7791 return _core_.Window_SetConstraints(*args, **kwargs)
e811c8ce
RD
7792
7793 def GetConstraints(*args, **kwargs):
15afbcd0 7794 """
a95a7133 7795 GetConstraints(self) -> LayoutConstraints
15afbcd0
RD
7796
7797 Returns a pointer to the window's layout constraints, or None if there
7798 are none.
7799 """
54f9ee45 7800 return _core_.Window_GetConstraints(*args, **kwargs)
e811c8ce
RD
7801
7802 def SetAutoLayout(*args, **kwargs):
15afbcd0 7803 """
a95a7133 7804 SetAutoLayout(self, bool autoLayout)
15afbcd0
RD
7805
7806 Determines whether the Layout function will be called automatically
7807 when the window is resized. It is called implicitly by SetSizer but
7808 if you use SetConstraints you should call it manually or otherwise the
7809 window layout won't be correctly updated when its size changes.
7810 """
54f9ee45 7811 return _core_.Window_SetAutoLayout(*args, **kwargs)
e811c8ce
RD
7812
7813 def GetAutoLayout(*args, **kwargs):
15afbcd0 7814 """
a95a7133 7815 GetAutoLayout(self) -> bool
15afbcd0
RD
7816
7817 Returns the current autoLayout setting
7818 """
54f9ee45 7819 return _core_.Window_GetAutoLayout(*args, **kwargs)
e811c8ce
RD
7820
7821 def Layout(*args, **kwargs):
15afbcd0 7822 """
a95a7133 7823 Layout(self) -> bool
15afbcd0
RD
7824
7825 Invokes the constraint-based layout algorithm or the sizer-based
7826 algorithm for this window. See SetAutoLayout: when auto layout is on,
7827 this function gets called automatically by the default EVT_SIZE
7828 handler when the window is resized.
7829 """
54f9ee45 7830 return _core_.Window_Layout(*args, **kwargs)
e811c8ce
RD
7831
7832 def SetSizer(*args, **kwargs):
15afbcd0 7833 """
a95a7133 7834 SetSizer(self, Sizer sizer, bool deleteOld=True)
15afbcd0
RD
7835
7836 Sets the window to have the given layout sizer. The window will then
7837 own the object, and will take care of its deletion. If an existing
7838 layout sizer object is already owned by the window, it will be deleted
7839 if the deleteOld parameter is true. Note that this function will also
7840 call SetAutoLayout implicitly with a True parameter if the sizer is
ae8162c8 7841 non-None, and False otherwise.
15afbcd0 7842 """
54f9ee45 7843 return _core_.Window_SetSizer(*args, **kwargs)
e811c8ce
RD
7844
7845 def SetSizerAndFit(*args, **kwargs):
15afbcd0 7846 """
a95a7133 7847 SetSizerAndFit(self, Sizer sizer, bool deleteOld=True)
15afbcd0
RD
7848
7849 The same as SetSizer, except it also sets the size hints for the
7850 window based on the sizer's minimum size.
7851 """
54f9ee45 7852 return _core_.Window_SetSizerAndFit(*args, **kwargs)
e811c8ce
RD
7853
7854 def GetSizer(*args, **kwargs):
15afbcd0 7855 """
a95a7133 7856 GetSizer(self) -> Sizer
15afbcd0
RD
7857
7858 Return the sizer associated with the window by a previous call to
7859 SetSizer or None if there isn't one.
7860 """
54f9ee45 7861 return _core_.Window_GetSizer(*args, **kwargs)
e811c8ce
RD
7862
7863 def SetContainingSizer(*args, **kwargs):
15afbcd0 7864 """
a95a7133 7865 SetContainingSizer(self, Sizer sizer)
15afbcd0
RD
7866
7867 This normally does not need to be called by application code. It is
7868 called internally when a window is added to a sizer, and is used so
7869 the window can remove itself from the sizer when it is destroyed.
7870 """
54f9ee45 7871 return _core_.Window_SetContainingSizer(*args, **kwargs)
e811c8ce
RD
7872
7873 def GetContainingSizer(*args, **kwargs):
15afbcd0 7874 """
a95a7133 7875 GetContainingSizer(self) -> Sizer
15afbcd0
RD
7876
7877 Return the sizer that this window is a member of, if any, otherwise None.
7878 """
54f9ee45 7879 return _core_.Window_GetContainingSizer(*args, **kwargs)
e811c8ce 7880
a95a7133
RD
7881 def InheritAttributes(*args, **kwargs):
7882 """
7883 InheritAttributes(self)
7884
41e2b43e
RD
7885 This function is (or should be, in case of custom controls) called
7886 during window creation to intelligently set up the window visual
7887 attributes, that is the font and the foreground and background
7888 colours.
7889
7890 By 'intelligently' the following is meant: by default, all windows use
7891 their own default attributes. However if some of the parent's
7892 attributes are explicitly changed (that is, using SetFont and not
fa47d7a7 7893 SetOwnFont) and if the corresponding attribute hadn't been
41e2b43e
RD
7894 explicitly set for this window itself, then this window takes the same
7895 value as used by the parent. In addition, if the window overrides
7896 ShouldInheritColours to return false, the colours will not be changed
7897 no matter what and only the font might.
7898
34621cc5 7899 This rather complicated logic is necessary in order to accommodate the
ec9b55ca 7900 different usage scenarios. The most common one is when all default
41e2b43e
RD
7901 attributes are used and in this case, nothing should be inherited as
7902 in modern GUIs different controls use different fonts (and colours)
7903 than their siblings so they can't inherit the same value from the
7904 parent. However it was also deemed desirable to allow to simply change
7905 the attributes of all children at once by just changing the font or
7906 colour of their common parent, hence in this case we do inherit the
7907 parents attributes.
7908
a95a7133 7909 """
54f9ee45 7910 return _core_.Window_InheritAttributes(*args, **kwargs)
a95a7133
RD
7911
7912 def ShouldInheritColours(*args, **kwargs):
7913 """
7914 ShouldInheritColours(self) -> bool
7915
7916 Return true from here to allow the colours of this window to be
41e2b43e
RD
7917 changed by InheritAttributes, returning false forbids inheriting them
7918 from the parent window.
a95a7133 7919
41e2b43e
RD
7920 The base class version returns false, but this method is overridden in
7921 wxControl where it returns true.
a95a7133 7922 """
54f9ee45 7923 return _core_.Window_ShouldInheritColours(*args, **kwargs)
a95a7133 7924
e811c8ce 7925 def PostCreate(self, pre):
15afbcd0
RD
7926 """
7927 Phase 3 of the 2-phase create <wink!>
7928 Call this method after precreating the window with the 2-phase create method.
7929 """
e811c8ce
RD
7930 self.this = pre.this
7931 self.thisown = pre.thisown
7932 pre.thisown = 0
7933 if hasattr(self, '_setOORInfo'):
7934 self._setOORInfo(self)
7935 if hasattr(self, '_setCallbackInfo'):
7936 self._setCallbackInfo(self, self.__class__)
7937
7938
7939class WindowPtr(Window):
7940 def __init__(self, this):
7941 self.this = this
7942 if not hasattr(self,"thisown"): self.thisown = 0
7943 self.__class__ = Window
54f9ee45 7944_core_.Window_swigregister(WindowPtr)
e811c8ce
RD
7945
7946def PreWindow(*args, **kwargs):
15afbcd0
RD
7947 """
7948 PreWindow() -> Window
7949
7950 Precreate a Window for 2-phase creation.
7951 """
54f9ee45 7952 val = _core_.new_PreWindow(*args, **kwargs)
e811c8ce
RD
7953 val.thisown = 1
7954 return val
7955
7956def Window_NewControlId(*args, **kwargs):
15afbcd0
RD
7957 """
7958 Window_NewControlId() -> int
7959
7960 Generate a control id for the controls which were not given one.
7961 """
54f9ee45 7962 return _core_.Window_NewControlId(*args, **kwargs)
e811c8ce
RD
7963
7964def Window_NextControlId(*args, **kwargs):
15afbcd0
RD
7965 """
7966 Window_NextControlId(int winid) -> int
7967
7968 Get the id of the control following the one with the given
41e2b43e 7969 autogenerated) id
15afbcd0 7970 """
54f9ee45 7971 return _core_.Window_NextControlId(*args, **kwargs)
e811c8ce
RD
7972
7973def Window_PrevControlId(*args, **kwargs):
15afbcd0
RD
7974 """
7975 Window_PrevControlId(int winid) -> int
7976
7977 Get the id of the control preceding the one with the given
41e2b43e 7978 autogenerated) id
15afbcd0 7979 """
54f9ee45 7980 return _core_.Window_PrevControlId(*args, **kwargs)
e811c8ce
RD
7981
7982def Window_FindFocus(*args, **kwargs):
15afbcd0
RD
7983 """
7984 Window_FindFocus() -> Window
7985
7986 Returns the window or control that currently has the keyboard focus,
7987 or None.
7988 """
54f9ee45 7989 return _core_.Window_FindFocus(*args, **kwargs)
e811c8ce
RD
7990
7991def Window_GetCapture(*args, **kwargs):
15afbcd0
RD
7992 """
7993 Window_GetCapture() -> Window
7994
7995 Returns the window which currently captures the mouse or None
7996 """
54f9ee45 7997 return _core_.Window_GetCapture(*args, **kwargs)
e811c8ce 7998
74a57fcd
RD
7999def Window_GetClassDefaultAttributes(*args, **kwargs):
8000 """
8001 Window_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
8002
41e2b43e
RD
8003 Get the default attributes for this class. This is useful if you want
8004 to use the same font or colour in your own control as in a standard
8005 control -- which is a much better idea than hard coding specific
db3e571a
RD
8006 colours or fonts which might look completely out of place on the
8007 user's system, especially if it uses themes.
74a57fcd
RD
8008
8009 The variant parameter is only relevant under Mac currently and is
41e2b43e 8010 ignore under other platforms. Under Mac, it will change the size of
db3e571a
RD
8011 the returned font. See `wx.Window.SetWindowVariant` for more about
8012 this.
74a57fcd 8013 """
54f9ee45 8014 return _core_.Window_GetClassDefaultAttributes(*args, **kwargs)
74a57fcd 8015
e811c8ce 8016def DLG_PNT(win, point_or_x, y=None):
15afbcd0
RD
8017 """
8018 Convenience function for converting a Point or (x,y) in
8019 dialog units to pixel units.
8020 """
e811c8ce
RD
8021 if y is None:
8022 return win.ConvertDialogPointToPixels(point_or_x)
8023 else:
fd3f2efe 8024 return win.ConvertDialogPointToPixels(wx.Point(point_or_x, y))
e811c8ce
RD
8025
8026def DLG_SZE(win, size_width, height=None):
15afbcd0
RD
8027 """
8028 Convenience function for converting a Size or (w,h) in
8029 dialog units to pixel units.
8030 """
e811c8ce
RD
8031 if height is None:
8032 return win.ConvertDialogSizeToPixels(size_width)
8033 else:
fd3f2efe 8034 return win.ConvertDialogSizeToPixels(wx.Size(size_width, height))
e811c8ce
RD
8035
8036
8037def FindWindowById(*args, **kwargs):
15afbcd0
RD
8038 """
8039 FindWindowById(long id, Window parent=None) -> Window
8040
8041 Find the first window in the application with the given id. If parent
8042 is None, the search will start from all top-level frames and dialog
8043 boxes; if non-None, the search will be limited to the given window
8044 hierarchy. The search is recursive in both cases.
8045 """
54f9ee45 8046 return _core_.FindWindowById(*args, **kwargs)
e811c8ce
RD
8047
8048def FindWindowByName(*args, **kwargs):
15afbcd0
RD
8049 """
8050 FindWindowByName(String name, Window parent=None) -> Window
8051
8052 Find a window by its name (as given in a window constructor or Create
8053 function call). If parent is None, the search will start from all
8054 top-level frames and dialog boxes; if non-None, the search will be
8055 limited to the given window hierarchy. The search is recursive in both
8056 cases.
8057
8058 If no window with such name is found, wx.FindWindowByLabel is called.
8059 """
54f9ee45 8060 return _core_.FindWindowByName(*args, **kwargs)
e811c8ce
RD
8061
8062def FindWindowByLabel(*args, **kwargs):
15afbcd0
RD
8063 """
8064 FindWindowByLabel(String label, Window parent=None) -> Window
8065
8066 Find a window by its label. Depending on the type of window, the label
8067 may be a window title or panel item label. If parent is None, the
8068 search will start from all top-level frames and dialog boxes; if
8069 non-None, the search will be limited to the given window
8070 hierarchy. The search is recursive in both cases.
8071 """
54f9ee45 8072 return _core_.FindWindowByLabel(*args, **kwargs)
e811c8ce
RD
8073
8074def Window_FromHWND(*args, **kwargs):
4276dc52 8075 """Window_FromHWND(Window parent, unsigned long _hWnd) -> Window"""
54f9ee45 8076 return _core_.Window_FromHWND(*args, **kwargs)
e811c8ce
RD
8077#---------------------------------------------------------------------------
8078
8079class Validator(EvtHandler):
093d3ff1 8080 """Proxy of C++ Validator class"""
e811c8ce
RD
8081 def __repr__(self):
8082 return "<%s.%s; proxy of C++ wxValidator instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
8083 def __init__(self, *args, **kwargs):
a95a7133 8084 """__init__(self) -> Validator"""
54f9ee45 8085 newobj = _core_.new_Validator(*args, **kwargs)
d14a1e28
RD
8086 self.this = newobj.this
8087 self.thisown = 1
8088 del newobj.thisown
8089 self._setOORInfo(self)
e811c8ce
RD
8090
8091 def Clone(*args, **kwargs):
a95a7133 8092 """Clone(self) -> Validator"""
54f9ee45 8093 return _core_.Validator_Clone(*args, **kwargs)
e811c8ce
RD
8094
8095 def Validate(*args, **kwargs):
a95a7133 8096 """Validate(self, Window parent) -> bool"""
54f9ee45 8097 return _core_.Validator_Validate(*args, **kwargs)
e811c8ce
RD
8098
8099 def TransferToWindow(*args, **kwargs):
a95a7133 8100 """TransferToWindow(self) -> bool"""
54f9ee45 8101 return _core_.Validator_TransferToWindow(*args, **kwargs)
e811c8ce
RD
8102
8103 def TransferFromWindow(*args, **kwargs):
a95a7133 8104 """TransferFromWindow(self) -> bool"""
54f9ee45 8105 return _core_.Validator_TransferFromWindow(*args, **kwargs)
e811c8ce
RD
8106
8107 def GetWindow(*args, **kwargs):
a95a7133 8108 """GetWindow(self) -> Window"""
54f9ee45 8109 return _core_.Validator_GetWindow(*args, **kwargs)
e811c8ce
RD
8110
8111 def SetWindow(*args, **kwargs):
a95a7133 8112 """SetWindow(self, Window window)"""
54f9ee45 8113 return _core_.Validator_SetWindow(*args, **kwargs)
e811c8ce
RD
8114
8115 def IsSilent(*args, **kwargs):
66c033b4 8116 """IsSilent() -> bool"""
54f9ee45 8117 return _core_.Validator_IsSilent(*args, **kwargs)
e811c8ce
RD
8118
8119 IsSilent = staticmethod(IsSilent)
8120 def SetBellOnError(*args, **kwargs):
66c033b4 8121 """SetBellOnError(int doIt=True)"""
54f9ee45 8122 return _core_.Validator_SetBellOnError(*args, **kwargs)
e811c8ce
RD
8123
8124 SetBellOnError = staticmethod(SetBellOnError)
8125
8126class ValidatorPtr(Validator):
8127 def __init__(self, this):
8128 self.this = this
8129 if not hasattr(self,"thisown"): self.thisown = 0
8130 self.__class__ = Validator
54f9ee45 8131_core_.Validator_swigregister(ValidatorPtr)
e811c8ce
RD
8132
8133def Validator_IsSilent(*args, **kwargs):
8134 """Validator_IsSilent() -> bool"""
54f9ee45 8135 return _core_.Validator_IsSilent(*args, **kwargs)
e811c8ce
RD
8136
8137def Validator_SetBellOnError(*args, **kwargs):
8138 """Validator_SetBellOnError(int doIt=True)"""
54f9ee45 8139 return _core_.Validator_SetBellOnError(*args, **kwargs)
e811c8ce
RD
8140
8141class PyValidator(Validator):
093d3ff1 8142 """Proxy of C++ PyValidator class"""
e811c8ce
RD
8143 def __repr__(self):
8144 return "<%s.%s; proxy of C++ wxPyValidator instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
8145 def __init__(self, *args, **kwargs):
a95a7133 8146 """__init__(self) -> PyValidator"""
54f9ee45 8147 newobj = _core_.new_PyValidator(*args, **kwargs)
e811c8ce
RD
8148 self.this = newobj.this
8149 self.thisown = 1
8150 del newobj.thisown
8151
8152 self._setCallbackInfo(self, PyValidator, 1)
8153 self._setOORInfo(self)
8154
8155 def _setCallbackInfo(*args, **kwargs):
a95a7133 8156 """_setCallbackInfo(self, PyObject self, PyObject _class, int incref=True)"""
54f9ee45 8157 return _core_.PyValidator__setCallbackInfo(*args, **kwargs)
e811c8ce
RD
8158
8159
8160class PyValidatorPtr(PyValidator):
8161 def __init__(self, this):
8162 self.this = this
8163 if not hasattr(self,"thisown"): self.thisown = 0
8164 self.__class__ = PyValidator
54f9ee45 8165_core_.PyValidator_swigregister(PyValidatorPtr)
e811c8ce
RD
8166
8167#---------------------------------------------------------------------------
8168
8169class Menu(EvtHandler):
093d3ff1 8170 """Proxy of C++ Menu class"""
d14a1e28
RD
8171 def __repr__(self):
8172 return "<%s.%s; proxy of C++ wxMenu instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
e811c8ce 8173 def __init__(self, *args, **kwargs):
a95a7133 8174 """__init__(self, String title=EmptyString, long style=0) -> Menu"""
54f9ee45 8175 newobj = _core_.new_Menu(*args, **kwargs)
e811c8ce
RD
8176 self.this = newobj.this
8177 self.thisown = 1
8178 del newobj.thisown
8179 self._setOORInfo(self)
8180
8181 def Append(*args, **kwargs):
a95a7133 8182 """Append(self, int id, String text, String help=EmptyString, int kind=ITEM_NORMAL) -> MenuItem"""
54f9ee45 8183 return _core_.Menu_Append(*args, **kwargs)
e811c8ce
RD
8184
8185 def AppendSeparator(*args, **kwargs):
a95a7133 8186 """AppendSeparator(self) -> MenuItem"""
54f9ee45 8187 return _core_.Menu_AppendSeparator(*args, **kwargs)
e811c8ce
RD
8188
8189 def AppendCheckItem(*args, **kwargs):
a95a7133 8190 """AppendCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
54f9ee45 8191 return _core_.Menu_AppendCheckItem(*args, **kwargs)
e811c8ce
RD
8192
8193 def AppendRadioItem(*args, **kwargs):
a95a7133 8194 """AppendRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
54f9ee45 8195 return _core_.Menu_AppendRadioItem(*args, **kwargs)
e811c8ce
RD
8196
8197 def AppendMenu(*args, **kwargs):
a95a7133 8198 """AppendMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
54f9ee45 8199 return _core_.Menu_AppendMenu(*args, **kwargs)
e811c8ce
RD
8200
8201 def AppendItem(*args, **kwargs):
a95a7133 8202 """AppendItem(self, MenuItem item) -> MenuItem"""
54f9ee45 8203 return _core_.Menu_AppendItem(*args, **kwargs)
e811c8ce
RD
8204
8205 def Break(*args, **kwargs):
a95a7133 8206 """Break(self)"""
54f9ee45 8207 return _core_.Menu_Break(*args, **kwargs)
e811c8ce
RD
8208
8209 def InsertItem(*args, **kwargs):
a95a7133 8210 """InsertItem(self, size_t pos, MenuItem item) -> MenuItem"""
54f9ee45 8211 return _core_.Menu_InsertItem(*args, **kwargs)
e811c8ce
RD
8212
8213 def Insert(*args, **kwargs):
0df68c9f 8214 """
a95a7133 8215 Insert(self, size_t pos, int id, String text, String help=EmptyString,
a41e16b6 8216 int kind=ITEM_NORMAL) -> MenuItem
0df68c9f 8217 """
54f9ee45 8218 return _core_.Menu_Insert(*args, **kwargs)
e811c8ce
RD
8219
8220 def InsertSeparator(*args, **kwargs):
a95a7133 8221 """InsertSeparator(self, size_t pos) -> MenuItem"""
54f9ee45 8222 return _core_.Menu_InsertSeparator(*args, **kwargs)
e811c8ce
RD
8223
8224 def InsertCheckItem(*args, **kwargs):
a95a7133 8225 """InsertCheckItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
54f9ee45 8226 return _core_.Menu_InsertCheckItem(*args, **kwargs)
e811c8ce
RD
8227
8228 def InsertRadioItem(*args, **kwargs):
a95a7133 8229 """InsertRadioItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
54f9ee45 8230 return _core_.Menu_InsertRadioItem(*args, **kwargs)
e811c8ce
RD
8231
8232 def InsertMenu(*args, **kwargs):
a95a7133 8233 """InsertMenu(self, size_t pos, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
54f9ee45 8234 return _core_.Menu_InsertMenu(*args, **kwargs)
e811c8ce
RD
8235
8236 def PrependItem(*args, **kwargs):
a95a7133 8237 """PrependItem(self, MenuItem item) -> MenuItem"""
54f9ee45 8238 return _core_.Menu_PrependItem(*args, **kwargs)
e811c8ce
RD
8239
8240 def Prepend(*args, **kwargs):
a95a7133 8241 """Prepend(self, int id, String text, String help=EmptyString, int kind=ITEM_NORMAL) -> MenuItem"""
54f9ee45 8242 return _core_.Menu_Prepend(*args, **kwargs)
e811c8ce
RD
8243
8244 def PrependSeparator(*args, **kwargs):
a95a7133 8245 """PrependSeparator(self) -> MenuItem"""
54f9ee45 8246 return _core_.Menu_PrependSeparator(*args, **kwargs)
e811c8ce
RD
8247
8248 def PrependCheckItem(*args, **kwargs):
a95a7133 8249 """PrependCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
54f9ee45 8250 return _core_.Menu_PrependCheckItem(*args, **kwargs)
e811c8ce
RD
8251
8252 def PrependRadioItem(*args, **kwargs):
a95a7133 8253 """PrependRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
54f9ee45 8254 return _core_.Menu_PrependRadioItem(*args, **kwargs)
e811c8ce
RD
8255
8256 def PrependMenu(*args, **kwargs):
a95a7133 8257 """PrependMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
54f9ee45 8258 return _core_.Menu_PrependMenu(*args, **kwargs)
e811c8ce
RD
8259
8260 def Remove(*args, **kwargs):
a95a7133 8261 """Remove(self, int id) -> MenuItem"""
54f9ee45 8262 return _core_.Menu_Remove(*args, **kwargs)
e811c8ce
RD
8263
8264 def RemoveItem(*args, **kwargs):
a95a7133 8265 """RemoveItem(self, MenuItem item) -> MenuItem"""
54f9ee45 8266 return _core_.Menu_RemoveItem(*args, **kwargs)
e811c8ce
RD
8267
8268 def Delete(*args, **kwargs):
a95a7133 8269 """Delete(self, int id) -> bool"""
54f9ee45 8270 return _core_.Menu_Delete(*args, **kwargs)
e811c8ce
RD
8271
8272 def DeleteItem(*args, **kwargs):
a95a7133 8273 """DeleteItem(self, MenuItem item) -> bool"""
54f9ee45 8274 return _core_.Menu_DeleteItem(*args, **kwargs)
e811c8ce
RD
8275
8276 def Destroy(*args, **kwargs):
0df68c9f 8277 """
a95a7133 8278 Destroy(self)
e811c8ce 8279
0df68c9f
RD
8280 Deletes the C++ object this Python object is a proxy for.
8281 """
54f9ee45 8282 return _core_.Menu_Destroy(*args, **kwargs)
e811c8ce
RD
8283
8284 def DestroyId(*args, **kwargs):
0df68c9f 8285 """
a95a7133 8286 DestroyId(self, int id) -> bool
e811c8ce 8287
0df68c9f
RD
8288 Deletes the C++ object this Python object is a proxy for.
8289 """
54f9ee45 8290 return _core_.Menu_DestroyId(*args, **kwargs)
e811c8ce
RD
8291
8292 def DestroyItem(*args, **kwargs):
0df68c9f 8293 """
a95a7133 8294 DestroyItem(self, MenuItem item) -> bool
e811c8ce 8295
0df68c9f
RD
8296 Deletes the C++ object this Python object is a proxy for.
8297 """
54f9ee45 8298 return _core_.Menu_DestroyItem(*args, **kwargs)
e811c8ce
RD
8299
8300 def GetMenuItemCount(*args, **kwargs):
a95a7133 8301 """GetMenuItemCount(self) -> size_t"""
54f9ee45 8302 return _core_.Menu_GetMenuItemCount(*args, **kwargs)
e811c8ce
RD
8303
8304 def GetMenuItems(*args, **kwargs):
a95a7133 8305 """GetMenuItems(self) -> PyObject"""
54f9ee45 8306 return _core_.Menu_GetMenuItems(*args, **kwargs)
e811c8ce
RD
8307
8308 def FindItem(*args, **kwargs):
a95a7133 8309 """FindItem(self, String item) -> int"""
54f9ee45 8310 return _core_.Menu_FindItem(*args, **kwargs)
e811c8ce
RD
8311
8312 def FindItemById(*args, **kwargs):
a95a7133 8313 """FindItemById(self, int id) -> MenuItem"""
54f9ee45 8314 return _core_.Menu_FindItemById(*args, **kwargs)
e811c8ce
RD
8315
8316 def FindItemByPosition(*args, **kwargs):
a95a7133 8317 """FindItemByPosition(self, size_t position) -> MenuItem"""
54f9ee45 8318 return _core_.Menu_FindItemByPosition(*args, **kwargs)
e811c8ce
RD
8319
8320 def Enable(*args, **kwargs):
a95a7133 8321 """Enable(self, int id, bool enable)"""
54f9ee45 8322 return _core_.Menu_Enable(*args, **kwargs)
e811c8ce
RD
8323
8324 def IsEnabled(*args, **kwargs):
a95a7133 8325 """IsEnabled(self, int id) -> bool"""
54f9ee45 8326 return _core_.Menu_IsEnabled(*args, **kwargs)
e811c8ce
RD
8327
8328 def Check(*args, **kwargs):
a95a7133 8329 """Check(self, int id, bool check)"""
54f9ee45 8330 return _core_.Menu_Check(*args, **kwargs)
e811c8ce
RD
8331
8332 def IsChecked(*args, **kwargs):
a95a7133 8333 """IsChecked(self, int id) -> bool"""
54f9ee45 8334 return _core_.Menu_IsChecked(*args, **kwargs)
e811c8ce
RD
8335
8336 def SetLabel(*args, **kwargs):
a95a7133 8337 """SetLabel(self, int id, String label)"""
54f9ee45 8338 return _core_.Menu_SetLabel(*args, **kwargs)
e811c8ce
RD
8339
8340 def GetLabel(*args, **kwargs):
a95a7133 8341 """GetLabel(self, int id) -> String"""
54f9ee45 8342 return _core_.Menu_GetLabel(*args, **kwargs)
e811c8ce
RD
8343
8344 def SetHelpString(*args, **kwargs):
a95a7133 8345 """SetHelpString(self, int id, String helpString)"""
54f9ee45 8346 return _core_.Menu_SetHelpString(*args, **kwargs)
e811c8ce
RD
8347
8348 def GetHelpString(*args, **kwargs):
a95a7133 8349 """GetHelpString(self, int id) -> String"""
54f9ee45 8350 return _core_.Menu_GetHelpString(*args, **kwargs)
e811c8ce
RD
8351
8352 def SetTitle(*args, **kwargs):
a95a7133 8353 """SetTitle(self, String title)"""
54f9ee45 8354 return _core_.Menu_SetTitle(*args, **kwargs)
e811c8ce
RD
8355
8356 def GetTitle(*args, **kwargs):
a95a7133 8357 """GetTitle(self) -> String"""
54f9ee45 8358 return _core_.Menu_GetTitle(*args, **kwargs)
e811c8ce
RD
8359
8360 def SetEventHandler(*args, **kwargs):
a95a7133 8361 """SetEventHandler(self, EvtHandler handler)"""
54f9ee45 8362 return _core_.Menu_SetEventHandler(*args, **kwargs)
e811c8ce
RD
8363
8364 def GetEventHandler(*args, **kwargs):
a95a7133 8365 """GetEventHandler(self) -> EvtHandler"""
54f9ee45 8366 return _core_.Menu_GetEventHandler(*args, **kwargs)
e811c8ce
RD
8367
8368 def SetInvokingWindow(*args, **kwargs):
a95a7133 8369 """SetInvokingWindow(self, Window win)"""
54f9ee45 8370 return _core_.Menu_SetInvokingWindow(*args, **kwargs)
e811c8ce
RD
8371
8372 def GetInvokingWindow(*args, **kwargs):
a95a7133 8373 """GetInvokingWindow(self) -> Window"""
54f9ee45 8374 return _core_.Menu_GetInvokingWindow(*args, **kwargs)
e811c8ce
RD
8375
8376 def GetStyle(*args, **kwargs):
a95a7133 8377 """GetStyle(self) -> long"""
54f9ee45 8378 return _core_.Menu_GetStyle(*args, **kwargs)
e811c8ce
RD
8379
8380 def UpdateUI(*args, **kwargs):
a95a7133 8381 """UpdateUI(self, EvtHandler source=None)"""
54f9ee45 8382 return _core_.Menu_UpdateUI(*args, **kwargs)
e811c8ce
RD
8383
8384 def GetMenuBar(*args, **kwargs):
a95a7133 8385 """GetMenuBar(self) -> MenuBar"""
54f9ee45 8386 return _core_.Menu_GetMenuBar(*args, **kwargs)
e811c8ce
RD
8387
8388 def Attach(*args, **kwargs):
a95a7133 8389 """Attach(self, wxMenuBarBase menubar)"""
54f9ee45 8390 return _core_.Menu_Attach(*args, **kwargs)
e811c8ce
RD
8391
8392 def Detach(*args, **kwargs):
a95a7133 8393 """Detach(self)"""
54f9ee45 8394 return _core_.Menu_Detach(*args, **kwargs)
e811c8ce
RD
8395
8396 def IsAttached(*args, **kwargs):
a95a7133 8397 """IsAttached(self) -> bool"""
54f9ee45 8398 return _core_.Menu_IsAttached(*args, **kwargs)
e811c8ce
RD
8399
8400 def SetParent(*args, **kwargs):
a95a7133 8401 """SetParent(self, Menu parent)"""
54f9ee45 8402 return _core_.Menu_SetParent(*args, **kwargs)
e811c8ce
RD
8403
8404 def GetParent(*args, **kwargs):
a95a7133 8405 """GetParent(self) -> Menu"""
54f9ee45 8406 return _core_.Menu_GetParent(*args, **kwargs)
e811c8ce 8407
d14a1e28
RD
8408
8409class MenuPtr(Menu):
8410 def __init__(self, this):
8411 self.this = this
8412 if not hasattr(self,"thisown"): self.thisown = 0
8413 self.__class__ = Menu
54f9ee45 8414_core_.Menu_swigregister(MenuPtr)
d14a1e28
RD
8415DefaultValidator = cvar.DefaultValidator
8416
8417#---------------------------------------------------------------------------
8418
8419class MenuBar(Window):
093d3ff1 8420 """Proxy of C++ MenuBar class"""
e811c8ce
RD
8421 def __repr__(self):
8422 return "<%s.%s; proxy of C++ wxMenuBar instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 8423 def __init__(self, *args, **kwargs):
a95a7133 8424 """__init__(self, long style=0) -> MenuBar"""
54f9ee45 8425 newobj = _core_.new_MenuBar(*args, **kwargs)
d14a1e28
RD
8426 self.this = newobj.this
8427 self.thisown = 1
8428 del newobj.thisown
8429 self._setOORInfo(self)
e811c8ce
RD
8430
8431 def Append(*args, **kwargs):
a95a7133 8432 """Append(self, Menu menu, String title) -> bool"""
54f9ee45 8433 return _core_.MenuBar_Append(*args, **kwargs)
e811c8ce
RD
8434
8435 def Insert(*args, **kwargs):
a95a7133 8436 """Insert(self, size_t pos, Menu menu, String title) -> bool"""
54f9ee45 8437 return _core_.MenuBar_Insert(*args, **kwargs)
e811c8ce
RD
8438
8439 def GetMenuCount(*args, **kwargs):
a95a7133 8440 """GetMenuCount(self) -> size_t"""
54f9ee45 8441 return _core_.MenuBar_GetMenuCount(*args, **kwargs)
e811c8ce
RD
8442
8443 def GetMenu(*args, **kwargs):
a95a7133 8444 """GetMenu(self, size_t pos) -> Menu"""
54f9ee45 8445 return _core_.MenuBar_GetMenu(*args, **kwargs)
e811c8ce
RD
8446
8447 def Replace(*args, **kwargs):
a95a7133 8448 """Replace(self, size_t pos, Menu menu, String title) -> Menu"""
54f9ee45 8449 return _core_.MenuBar_Replace(*args, **kwargs)
e811c8ce
RD
8450
8451 def Remove(*args, **kwargs):
a95a7133 8452 """Remove(self, size_t pos) -> Menu"""
54f9ee45 8453 return _core_.MenuBar_Remove(*args, **kwargs)
e811c8ce
RD
8454
8455 def EnableTop(*args, **kwargs):
a95a7133 8456 """EnableTop(self, size_t pos, bool enable)"""
54f9ee45 8457 return _core_.MenuBar_EnableTop(*args, **kwargs)
e811c8ce
RD
8458
8459 def IsEnabledTop(*args, **kwargs):
a95a7133 8460 """IsEnabledTop(self, size_t pos) -> bool"""
54f9ee45 8461 return _core_.MenuBar_IsEnabledTop(*args, **kwargs)
e811c8ce
RD
8462
8463 def SetLabelTop(*args, **kwargs):
a95a7133 8464 """SetLabelTop(self, size_t pos, String label)"""
54f9ee45 8465 return _core_.MenuBar_SetLabelTop(*args, **kwargs)
e811c8ce
RD
8466
8467 def GetLabelTop(*args, **kwargs):
a95a7133 8468 """GetLabelTop(self, size_t pos) -> String"""
54f9ee45 8469 return _core_.MenuBar_GetLabelTop(*args, **kwargs)
e811c8ce
RD
8470
8471 def FindMenuItem(*args, **kwargs):
a95a7133 8472 """FindMenuItem(self, String menu, String item) -> int"""
54f9ee45 8473 return _core_.MenuBar_FindMenuItem(*args, **kwargs)
e811c8ce
RD
8474
8475 def FindItemById(*args, **kwargs):
a95a7133 8476 """FindItemById(self, int id) -> MenuItem"""
54f9ee45 8477 return _core_.MenuBar_FindItemById(*args, **kwargs)
e811c8ce
RD
8478
8479 def FindMenu(*args, **kwargs):
a95a7133 8480 """FindMenu(self, String title) -> int"""
54f9ee45 8481 return _core_.MenuBar_FindMenu(*args, **kwargs)
e811c8ce
RD
8482
8483 def Enable(*args, **kwargs):
a95a7133 8484 """Enable(self, int id, bool enable)"""
54f9ee45 8485 return _core_.MenuBar_Enable(*args, **kwargs)
e811c8ce
RD
8486
8487 def Check(*args, **kwargs):
a95a7133 8488 """Check(self, int id, bool check)"""
54f9ee45 8489 return _core_.MenuBar_Check(*args, **kwargs)
e811c8ce
RD
8490
8491 def IsChecked(*args, **kwargs):
a95a7133 8492 """IsChecked(self, int id) -> bool"""
54f9ee45 8493 return _core_.MenuBar_IsChecked(*args, **kwargs)
e811c8ce
RD
8494
8495 def IsEnabled(*args, **kwargs):
a95a7133 8496 """IsEnabled(self, int id) -> bool"""
54f9ee45 8497 return _core_.MenuBar_IsEnabled(*args, **kwargs)
e811c8ce
RD
8498
8499 def SetLabel(*args, **kwargs):
a95a7133 8500 """SetLabel(self, int id, String label)"""
54f9ee45 8501 return _core_.MenuBar_SetLabel(*args, **kwargs)
e811c8ce
RD
8502
8503 def GetLabel(*args, **kwargs):
a95a7133 8504 """GetLabel(self, int id) -> String"""
54f9ee45 8505 return _core_.MenuBar_GetLabel(*args, **kwargs)
e811c8ce
RD
8506
8507 def SetHelpString(*args, **kwargs):
a95a7133 8508 """SetHelpString(self, int id, String helpString)"""
54f9ee45 8509 return _core_.MenuBar_SetHelpString(*args, **kwargs)
e811c8ce
RD
8510
8511 def GetHelpString(*args, **kwargs):
a95a7133 8512 """GetHelpString(self, int id) -> String"""
54f9ee45 8513 return _core_.MenuBar_GetHelpString(*args, **kwargs)
e811c8ce
RD
8514
8515 def GetFrame(*args, **kwargs):
a95a7133 8516 """GetFrame(self) -> wxFrame"""
54f9ee45 8517 return _core_.MenuBar_GetFrame(*args, **kwargs)
e811c8ce
RD
8518
8519 def IsAttached(*args, **kwargs):
a95a7133 8520 """IsAttached(self) -> bool"""
54f9ee45 8521 return _core_.MenuBar_IsAttached(*args, **kwargs)
e811c8ce
RD
8522
8523 def Attach(*args, **kwargs):
a95a7133 8524 """Attach(self, wxFrame frame)"""
54f9ee45 8525 return _core_.MenuBar_Attach(*args, **kwargs)
e811c8ce
RD
8526
8527 def Detach(*args, **kwargs):
a95a7133 8528 """Detach(self)"""
54f9ee45 8529 return _core_.MenuBar_Detach(*args, **kwargs)
e811c8ce 8530
d14a1e28
RD
8531
8532class MenuBarPtr(MenuBar):
8533 def __init__(self, this):
8534 self.this = this
8535 if not hasattr(self,"thisown"): self.thisown = 0
8536 self.__class__ = MenuBar
54f9ee45 8537_core_.MenuBar_swigregister(MenuBarPtr)
d14a1e28
RD
8538
8539#---------------------------------------------------------------------------
8540
8541class MenuItem(Object):
093d3ff1 8542 """Proxy of C++ MenuItem class"""
e811c8ce
RD
8543 def __repr__(self):
8544 return "<%s.%s; proxy of C++ wxMenuItem instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 8545 def __init__(self, *args, **kwargs):
0df68c9f 8546 """
a95a7133 8547 __init__(self, Menu parentMenu=None, int id=ID_ANY, String text=EmptyString,
196addbf
RD
8548 String help=EmptyString, int kind=ITEM_NORMAL,
8549 Menu subMenu=None) -> MenuItem
0df68c9f 8550 """
54f9ee45 8551 newobj = _core_.new_MenuItem(*args, **kwargs)
d14a1e28
RD
8552 self.this = newobj.this
8553 self.thisown = 1
8554 del newobj.thisown
e811c8ce 8555 def GetMenu(*args, **kwargs):
a95a7133 8556 """GetMenu(self) -> Menu"""
54f9ee45 8557 return _core_.MenuItem_GetMenu(*args, **kwargs)
e811c8ce
RD
8558
8559 def SetMenu(*args, **kwargs):
a95a7133 8560 """SetMenu(self, Menu menu)"""
54f9ee45 8561 return _core_.MenuItem_SetMenu(*args, **kwargs)
e811c8ce
RD
8562
8563 def SetId(*args, **kwargs):
a95a7133 8564 """SetId(self, int id)"""
54f9ee45 8565 return _core_.MenuItem_SetId(*args, **kwargs)
e811c8ce
RD
8566
8567 def GetId(*args, **kwargs):
a95a7133 8568 """GetId(self) -> int"""
54f9ee45 8569 return _core_.MenuItem_GetId(*args, **kwargs)
e811c8ce
RD
8570
8571 def IsSeparator(*args, **kwargs):
a95a7133 8572 """IsSeparator(self) -> bool"""
54f9ee45 8573 return _core_.MenuItem_IsSeparator(*args, **kwargs)
e811c8ce
RD
8574
8575 def SetText(*args, **kwargs):
a95a7133 8576 """SetText(self, String str)"""
54f9ee45 8577 return _core_.MenuItem_SetText(*args, **kwargs)
e811c8ce
RD
8578
8579 def GetLabel(*args, **kwargs):
a95a7133 8580 """GetLabel(self) -> String"""
54f9ee45 8581 return _core_.MenuItem_GetLabel(*args, **kwargs)
e811c8ce
RD
8582
8583 def GetText(*args, **kwargs):
a95a7133 8584 """GetText(self) -> String"""
54f9ee45 8585 return _core_.MenuItem_GetText(*args, **kwargs)
e811c8ce
RD
8586
8587 def GetLabelFromText(*args, **kwargs):
66c033b4 8588 """GetLabelFromText(String text) -> String"""
54f9ee45 8589 return _core_.MenuItem_GetLabelFromText(*args, **kwargs)
e811c8ce
RD
8590
8591 GetLabelFromText = staticmethod(GetLabelFromText)
8592 def GetKind(*args, **kwargs):
a95a7133 8593 """GetKind(self) -> int"""
54f9ee45 8594 return _core_.MenuItem_GetKind(*args, **kwargs)
e811c8ce 8595
a95a7133
RD
8596 def SetKind(*args, **kwargs):
8597 """SetKind(self, int kind)"""
54f9ee45 8598 return _core_.MenuItem_SetKind(*args, **kwargs)
a95a7133 8599
e811c8ce 8600 def SetCheckable(*args, **kwargs):
a95a7133 8601 """SetCheckable(self, bool checkable)"""
54f9ee45 8602 return _core_.MenuItem_SetCheckable(*args, **kwargs)
e811c8ce
RD
8603
8604 def IsCheckable(*args, **kwargs):
a95a7133 8605 """IsCheckable(self) -> bool"""
54f9ee45 8606 return _core_.MenuItem_IsCheckable(*args, **kwargs)
e811c8ce
RD
8607
8608 def IsSubMenu(*args, **kwargs):
a95a7133 8609 """IsSubMenu(self) -> bool"""
54f9ee45 8610 return _core_.MenuItem_IsSubMenu(*args, **kwargs)
e811c8ce
RD
8611
8612 def SetSubMenu(*args, **kwargs):
a95a7133 8613 """SetSubMenu(self, Menu menu)"""
54f9ee45 8614 return _core_.MenuItem_SetSubMenu(*args, **kwargs)
e811c8ce
RD
8615
8616 def GetSubMenu(*args, **kwargs):
a95a7133 8617 """GetSubMenu(self) -> Menu"""
54f9ee45 8618 return _core_.MenuItem_GetSubMenu(*args, **kwargs)
e811c8ce
RD
8619
8620 def Enable(*args, **kwargs):
a95a7133 8621 """Enable(self, bool enable=True)"""
54f9ee45 8622 return _core_.MenuItem_Enable(*args, **kwargs)
e811c8ce
RD
8623
8624 def IsEnabled(*args, **kwargs):
a95a7133 8625 """IsEnabled(self) -> bool"""
54f9ee45 8626 return _core_.MenuItem_IsEnabled(*args, **kwargs)
e811c8ce
RD
8627
8628 def Check(*args, **kwargs):
a95a7133 8629 """Check(self, bool check=True)"""
54f9ee45 8630 return _core_.MenuItem_Check(*args, **kwargs)
e811c8ce
RD
8631
8632 def IsChecked(*args, **kwargs):
a95a7133 8633 """IsChecked(self) -> bool"""
54f9ee45 8634 return _core_.MenuItem_IsChecked(*args, **kwargs)
e811c8ce
RD
8635
8636 def Toggle(*args, **kwargs):
a95a7133 8637 """Toggle(self)"""
54f9ee45 8638 return _core_.MenuItem_Toggle(*args, **kwargs)
e811c8ce
RD
8639
8640 def SetHelp(*args, **kwargs):
a95a7133 8641 """SetHelp(self, String str)"""
54f9ee45 8642 return _core_.MenuItem_SetHelp(*args, **kwargs)
e811c8ce
RD
8643
8644 def GetHelp(*args, **kwargs):
a95a7133 8645 """GetHelp(self) -> String"""
54f9ee45 8646 return _core_.MenuItem_GetHelp(*args, **kwargs)
e811c8ce
RD
8647
8648 def GetAccel(*args, **kwargs):
a95a7133 8649 """GetAccel(self) -> AcceleratorEntry"""
54f9ee45 8650 return _core_.MenuItem_GetAccel(*args, **kwargs)
e811c8ce
RD
8651
8652 def SetAccel(*args, **kwargs):
a95a7133 8653 """SetAccel(self, AcceleratorEntry accel)"""
54f9ee45 8654 return _core_.MenuItem_SetAccel(*args, **kwargs)
e811c8ce
RD
8655
8656 def GetDefaultMarginWidth(*args, **kwargs):
66c033b4 8657 """GetDefaultMarginWidth() -> int"""
54f9ee45 8658 return _core_.MenuItem_GetDefaultMarginWidth(*args, **kwargs)
e811c8ce
RD
8659
8660 GetDefaultMarginWidth = staticmethod(GetDefaultMarginWidth)
8661 def SetBitmap(*args, **kwargs):
a95a7133 8662 """SetBitmap(self, Bitmap bitmap)"""
54f9ee45 8663 return _core_.MenuItem_SetBitmap(*args, **kwargs)
e811c8ce
RD
8664
8665 def GetBitmap(*args, **kwargs):
a95a7133 8666 """GetBitmap(self) -> Bitmap"""
54f9ee45 8667 return _core_.MenuItem_GetBitmap(*args, **kwargs)
e811c8ce 8668
d14a1e28
RD
8669
8670class MenuItemPtr(MenuItem):
8671 def __init__(self, this):
8672 self.this = this
8673 if not hasattr(self,"thisown"): self.thisown = 0
8674 self.__class__ = MenuItem
54f9ee45 8675_core_.MenuItem_swigregister(MenuItemPtr)
d14a1e28 8676
e811c8ce 8677def MenuItem_GetLabelFromText(*args, **kwargs):
196addbf 8678 """MenuItem_GetLabelFromText(String text) -> String"""
54f9ee45 8679 return _core_.MenuItem_GetLabelFromText(*args, **kwargs)
d14a1e28 8680
e811c8ce
RD
8681def MenuItem_GetDefaultMarginWidth(*args, **kwargs):
8682 """MenuItem_GetDefaultMarginWidth() -> int"""
54f9ee45 8683 return _core_.MenuItem_GetDefaultMarginWidth(*args, **kwargs)
d14a1e28
RD
8684
8685#---------------------------------------------------------------------------
8686
8687class Control(Window):
15afbcd0
RD
8688 """
8689 This is the base class for a control or 'widget'.
8690
41e2b43e
RD
8691 A control is generally a small window which processes user input
8692 and/or displays one or more item of data.
15afbcd0 8693 """
e811c8ce
RD
8694 def __repr__(self):
8695 return "<%s.%s; proxy of C++ wxControl instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 8696 def __init__(self, *args, **kwargs):
0df68c9f 8697 """
248ed943
RD
8698 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
8699 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
b2dc1044 8700 String name=ControlNameStr) -> Control
15afbcd0 8701
41e2b43e
RD
8702 Create a Control. Normally you should only call this from a subclass'
8703 __init__ as a plain old wx.Control is not very useful.
0df68c9f 8704 """
54f9ee45 8705 newobj = _core_.new_Control(*args, **kwargs)
d14a1e28
RD
8706 self.this = newobj.this
8707 self.thisown = 1
8708 del newobj.thisown
8709 self._setOORInfo(self)
e811c8ce
RD
8710
8711 def Create(*args, **kwargs):
0df68c9f 8712 """
248ed943
RD
8713 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
8714 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
b2dc1044 8715 String name=ControlNameStr) -> bool
15afbcd0
RD
8716
8717 Do the 2nd phase and create the GUI control.
0df68c9f 8718 """
54f9ee45 8719 return _core_.Control_Create(*args, **kwargs)
e811c8ce
RD
8720
8721 def Command(*args, **kwargs):
15afbcd0 8722 """
a95a7133 8723 Command(self, CommandEvent event)
15afbcd0 8724
41e2b43e
RD
8725 Simulates the effect of the user issuing a command to the item.
8726
8727 :see: `wx.CommandEvent`
8728
15afbcd0 8729 """
54f9ee45 8730 return _core_.Control_Command(*args, **kwargs)
e811c8ce
RD
8731
8732 def GetLabel(*args, **kwargs):
15afbcd0 8733 """
a95a7133 8734 GetLabel(self) -> String
15afbcd0
RD
8735
8736 Return a control's text.
8737 """
54f9ee45 8738 return _core_.Control_GetLabel(*args, **kwargs)
e811c8ce
RD
8739
8740 def SetLabel(*args, **kwargs):
15afbcd0 8741 """
a95a7133 8742 SetLabel(self, String label)
15afbcd0
RD
8743
8744 Sets the item's text.
8745 """
54f9ee45 8746 return _core_.Control_SetLabel(*args, **kwargs)
e811c8ce 8747
74a57fcd 8748 def GetClassDefaultAttributes(*args, **kwargs):
110da5b0
RD
8749 """
8750 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
8751
8752 Get the default attributes for this class. This is useful if you want
8753 to use the same font or colour in your own control as in a standard
8754 control -- which is a much better idea than hard coding specific
8755 colours or fonts which might look completely out of place on the
8756 user's system, especially if it uses themes.
8757
8758 The variant parameter is only relevant under Mac currently and is
8759 ignore under other platforms. Under Mac, it will change the size of
8760 the returned font. See `wx.Window.SetWindowVariant` for more about
8761 this.
8762 """
54f9ee45 8763 return _core_.Control_GetClassDefaultAttributes(*args, **kwargs)
74a57fcd
RD
8764
8765 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
d14a1e28
RD
8766
8767class ControlPtr(Control):
8768 def __init__(self, this):
8769 self.this = this
8770 if not hasattr(self,"thisown"): self.thisown = 0
8771 self.__class__ = Control
54f9ee45 8772_core_.Control_swigregister(ControlPtr)
b2dc1044 8773ControlNameStr = cvar.ControlNameStr
d14a1e28
RD
8774
8775def PreControl(*args, **kwargs):
15afbcd0
RD
8776 """
8777 PreControl() -> Control
8778
8779 Precreate a Control control for 2-phase creation
8780 """
54f9ee45 8781 val = _core_.new_PreControl(*args, **kwargs)
d14a1e28
RD
8782 val.thisown = 1
8783 return val
8784
74a57fcd 8785def Control_GetClassDefaultAttributes(*args, **kwargs):
110da5b0
RD
8786 """
8787 Control_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
8788
8789 Get the default attributes for this class. This is useful if you want
8790 to use the same font or colour in your own control as in a standard
8791 control -- which is a much better idea than hard coding specific
8792 colours or fonts which might look completely out of place on the
8793 user's system, especially if it uses themes.
8794
8795 The variant parameter is only relevant under Mac currently and is
8796 ignore under other platforms. Under Mac, it will change the size of
8797 the returned font. See `wx.Window.SetWindowVariant` for more about
8798 this.
8799 """
54f9ee45 8800 return _core_.Control_GetClassDefaultAttributes(*args, **kwargs)
74a57fcd 8801
d14a1e28
RD
8802#---------------------------------------------------------------------------
8803
8804class ItemContainer(object):
15afbcd0
RD
8805 """
8806 wx.ItemContainer defines an interface which is implemented by all
41e2b43e
RD
8807 controls which have string subitems, each of which may be selected,
8808 such as `wx.ListBox`, `wx.CheckListBox`, `wx.Choice` as well as
8809 `wx.ComboBox` which implements an extended interface deriving from
8810 this one.
15afbcd0 8811
41e2b43e
RD
8812 It defines the methods for accessing the control's items and although
8813 each of the derived classes implements them differently, they still
8814 all conform to the same interface.
15afbcd0 8815
41e2b43e
RD
8816 The items in a wx.ItemContainer have (non empty) string labels and,
8817 optionally, client data associated with them.
15afbcd0
RD
8818
8819 """
d14a1e28
RD
8820 def __init__(self): raise RuntimeError, "No constructor defined"
8821 def __repr__(self):
8822 return "<%s.%s; proxy of C++ wxItemContainer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
e811c8ce 8823 def Append(*args, **kwargs):
15afbcd0 8824 """
a95a7133 8825 Append(self, String item, PyObject clientData=None) -> int
15afbcd0 8826
41e2b43e
RD
8827 Adds the item to the control, associating the given data with the item
8828 if not None. The return value is the index of the newly added item
8829 which may be different from the last one if the control is sorted (e.g.
8830 has wx.LB_SORT or wx.CB_SORT style).
15afbcd0 8831 """
54f9ee45 8832 return _core_.ItemContainer_Append(*args, **kwargs)
e811c8ce
RD
8833
8834 def AppendItems(*args, **kwargs):
15afbcd0 8835 """
f5b96ee1 8836 AppendItems(self, List strings)
15afbcd0 8837
41e2b43e
RD
8838 Apend several items at once to the control. Notice that calling this
8839 method may be much faster than appending the items one by one if you
8840 need to add a lot of items.
15afbcd0 8841 """
54f9ee45 8842 return _core_.ItemContainer_AppendItems(*args, **kwargs)
e811c8ce
RD
8843
8844 def Insert(*args, **kwargs):
15afbcd0 8845 """
a95a7133 8846 Insert(self, String item, int pos, PyObject clientData=None) -> int
15afbcd0 8847
41e2b43e 8848 Insert an item into the control before the item at the ``pos`` index,
15afbcd0
RD
8849 optionally associating some data object with the item.
8850 """
54f9ee45 8851 return _core_.ItemContainer_Insert(*args, **kwargs)
e811c8ce
RD
8852
8853 def Clear(*args, **kwargs):
15afbcd0 8854 """
a95a7133 8855 Clear(self)
15afbcd0
RD
8856
8857 Removes all items from the control.
8858 """
54f9ee45 8859 return _core_.ItemContainer_Clear(*args, **kwargs)
e811c8ce
RD
8860
8861 def Delete(*args, **kwargs):
15afbcd0 8862 """
a95a7133 8863 Delete(self, int n)
15afbcd0 8864
41e2b43e
RD
8865 Deletes the item at the zero-based index 'n' from the control. Note
8866 that it is an error (signalled by a `wx.PyAssertionError` exception if
8867 enabled) to remove an item with the index negative or greater or equal
8868 than the number of items in the control.
15afbcd0 8869 """
54f9ee45 8870 return _core_.ItemContainer_Delete(*args, **kwargs)
e811c8ce
RD
8871
8872 def GetCount(*args, **kwargs):
15afbcd0 8873 """
a95a7133 8874 GetCount(self) -> int
15afbcd0
RD
8875
8876 Returns the number of items in the control.
8877 """
54f9ee45 8878 return _core_.ItemContainer_GetCount(*args, **kwargs)
e811c8ce
RD
8879
8880 def IsEmpty(*args, **kwargs):
15afbcd0 8881 """
a95a7133 8882 IsEmpty(self) -> bool
15afbcd0
RD
8883
8884 Returns True if the control is empty or False if it has some items.
8885 """
54f9ee45 8886 return _core_.ItemContainer_IsEmpty(*args, **kwargs)
e811c8ce
RD
8887
8888 def GetString(*args, **kwargs):
15afbcd0 8889 """
a95a7133 8890 GetString(self, int n) -> String
15afbcd0
RD
8891
8892 Returns the label of the item with the given index.
8893 """
54f9ee45 8894 return _core_.ItemContainer_GetString(*args, **kwargs)
e811c8ce
RD
8895
8896 def GetStrings(*args, **kwargs):
a95a7133 8897 """GetStrings(self) -> wxArrayString"""
54f9ee45 8898 return _core_.ItemContainer_GetStrings(*args, **kwargs)
e811c8ce
RD
8899
8900 def SetString(*args, **kwargs):
15afbcd0 8901 """
a95a7133 8902 SetString(self, int n, String s)
15afbcd0
RD
8903
8904 Sets the label for the given item.
8905 """
54f9ee45 8906 return _core_.ItemContainer_SetString(*args, **kwargs)
e811c8ce
RD
8907
8908 def FindString(*args, **kwargs):
15afbcd0 8909 """
a95a7133 8910 FindString(self, String s) -> int
15afbcd0
RD
8911
8912 Finds an item whose label matches the given string. Returns the
41e2b43e
RD
8913 zero-based position of the item, or ``wx.NOT_FOUND`` if the string was not
8914 found.
15afbcd0 8915 """
54f9ee45 8916 return _core_.ItemContainer_FindString(*args, **kwargs)
e811c8ce
RD
8917
8918 def Select(*args, **kwargs):
15afbcd0 8919 """
a95a7133 8920 Select(self, int n)
15afbcd0
RD
8921
8922 Sets the item at index 'n' to be the selected item.
8923 """
54f9ee45 8924 return _core_.ItemContainer_Select(*args, **kwargs)
e811c8ce 8925
15afbcd0 8926 SetSelection = Select
e811c8ce 8927 def GetSelection(*args, **kwargs):
15afbcd0 8928 """
a95a7133 8929 GetSelection(self) -> int
15afbcd0 8930
41e2b43e
RD
8931 Returns the index of the selected item or ``wx.NOT_FOUND`` if no item
8932 is selected.
15afbcd0 8933 """
54f9ee45 8934 return _core_.ItemContainer_GetSelection(*args, **kwargs)
e811c8ce
RD
8935
8936 def GetStringSelection(*args, **kwargs):
15afbcd0 8937 """
a95a7133 8938 GetStringSelection(self) -> String
15afbcd0 8939
41e2b43e
RD
8940 Returns the label of the selected item or an empty string if no item
8941 is selected.
15afbcd0 8942 """
54f9ee45 8943 return _core_.ItemContainer_GetStringSelection(*args, **kwargs)
e811c8ce
RD
8944
8945 def GetClientData(*args, **kwargs):
15afbcd0 8946 """
a95a7133 8947 GetClientData(self, int n) -> PyObject
15afbcd0
RD
8948
8949 Returns the client data associated with the given item, (if any.)
8950 """
54f9ee45 8951 return _core_.ItemContainer_GetClientData(*args, **kwargs)
e811c8ce
RD
8952
8953 def SetClientData(*args, **kwargs):
15afbcd0 8954 """
a95a7133 8955 SetClientData(self, int n, PyObject clientData)
15afbcd0
RD
8956
8957 Associate the given client data with the item at position n.
8958 """
54f9ee45 8959 return _core_.ItemContainer_SetClientData(*args, **kwargs)
e811c8ce 8960
d14a1e28
RD
8961
8962class ItemContainerPtr(ItemContainer):
8963 def __init__(self, this):
8964 self.this = this
8965 if not hasattr(self,"thisown"): self.thisown = 0
8966 self.__class__ = ItemContainer
54f9ee45 8967_core_.ItemContainer_swigregister(ItemContainerPtr)
d14a1e28
RD
8968
8969#---------------------------------------------------------------------------
8970
8971class ControlWithItems(Control,ItemContainer):
15afbcd0 8972 """
41e2b43e
RD
8973 wx.ControlWithItems combines the ``wx.ItemContainer`` class with the
8974 wx.Control class, and is used for the base class of various controls
8975 that have items.
15afbcd0 8976 """
d14a1e28
RD
8977 def __init__(self): raise RuntimeError, "No constructor defined"
8978 def __repr__(self):
8979 return "<%s.%s; proxy of C++ wxControlWithItems instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
8980
8981class ControlWithItemsPtr(ControlWithItems):
8982 def __init__(self, this):
8983 self.this = this
8984 if not hasattr(self,"thisown"): self.thisown = 0
8985 self.__class__ = ControlWithItems
54f9ee45 8986_core_.ControlWithItems_swigregister(ControlWithItemsPtr)
d14a1e28
RD
8987
8988#---------------------------------------------------------------------------
8989
8990class SizerItem(Object):
248ed943
RD
8991 """
8992 The wx.SizerItem class is used to track the position, size and other
8993 attributes of each item managed by a `wx.Sizer`. In normal usage user
8994 code should never need to deal directly with a wx.SizerItem, but
8995 custom classes derived from `wx.PySizer` will probably need to use the
8996 collection of wx.SizerItems held by wx.Sizer when calculating layout.
8997
8998 :see: `wx.Sizer`, `wx.GBSizerItem`
8999 """
e811c8ce
RD
9000 def __repr__(self):
9001 return "<%s.%s; proxy of C++ wxSizerItem instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 9002 def __init__(self, *args, **kwargs):
248ed943
RD
9003 """
9004 __init__(self) -> SizerItem
9005
9006 Constructs an empty wx.SizerItem. Either a window, sizer or spacer
9007 size will need to be set before this item can be used in a Sizer.
9008
9009 You will probably never need to create a wx.SizerItem directly as they
9010 are created automatically when the sizer's Add, Insert or Prepend
9011 methods are called.
9012
9013 :see: `wx.SizerItemSpacer`, `wx.SizerItemWindow`, `wx.SizerItemSizer`
9014 """
54f9ee45 9015 newobj = _core_.new_SizerItem(*args, **kwargs)
d14a1e28
RD
9016 self.this = newobj.this
9017 self.thisown = 1
9018 del newobj.thisown
e811c8ce 9019 def DeleteWindows(*args, **kwargs):
248ed943
RD
9020 """
9021 DeleteWindows(self)
9022
9023 Destroy the window or the windows in a subsizer, depending on the type
9024 of item.
9025 """
54f9ee45 9026 return _core_.SizerItem_DeleteWindows(*args, **kwargs)
e811c8ce
RD
9027
9028 def DetachSizer(*args, **kwargs):
248ed943
RD
9029 """
9030 DetachSizer(self)
9031
9032 Enable deleting the SizerItem without destroying the contained sizer.
9033 """
54f9ee45 9034 return _core_.SizerItem_DetachSizer(*args, **kwargs)
e811c8ce
RD
9035
9036 def GetSize(*args, **kwargs):
248ed943
RD
9037 """
9038 GetSize(self) -> Size
9039
9040 Get the current size of the item, as set in the last Layout.
9041 """
54f9ee45 9042 return _core_.SizerItem_GetSize(*args, **kwargs)
e811c8ce
RD
9043
9044 def CalcMin(*args, **kwargs):
248ed943
RD
9045 """
9046 CalcMin(self) -> Size
9047
9048 Calculates the minimum desired size for the item, including any space
9049 needed by borders.
9050 """
54f9ee45 9051 return _core_.SizerItem_CalcMin(*args, **kwargs)
e811c8ce
RD
9052
9053 def SetDimension(*args, **kwargs):
248ed943
RD
9054 """
9055 SetDimension(self, Point pos, Size size)
9056
9057 Set the position and size of the space allocated for this item by the
9058 sizer, and adjust the position and size of the item (window or
9059 subsizer) to be within that space taking alignment and borders into
9060 account.
9061 """
54f9ee45 9062 return _core_.SizerItem_SetDimension(*args, **kwargs)
e811c8ce
RD
9063
9064 def GetMinSize(*args, **kwargs):
248ed943
RD
9065 """
9066 GetMinSize(self) -> Size
9067
9068 Get the minimum size needed for the item.
9069 """
54f9ee45 9070 return _core_.SizerItem_GetMinSize(*args, **kwargs)
e811c8ce 9071
dfbb5885
RD
9072 def GetMinSizeWithBorder(*args, **kwargs):
9073 """
9074 GetMinSizeWithBorder(self) -> Size
9075
9076 Get the minimum size needed for the item with space for the borders
9077 added, if needed.
9078 """
9079 return _core_.SizerItem_GetMinSizeWithBorder(*args, **kwargs)
9080
e811c8ce 9081 def SetInitSize(*args, **kwargs):
a95a7133 9082 """SetInitSize(self, int x, int y)"""
54f9ee45 9083 return _core_.SizerItem_SetInitSize(*args, **kwargs)
e811c8ce
RD
9084
9085 def SetRatioWH(*args, **kwargs):
248ed943
RD
9086 """
9087 SetRatioWH(self, int width, int height)
9088
9089 Set the ratio item attribute.
9090 """
54f9ee45 9091 return _core_.SizerItem_SetRatioWH(*args, **kwargs)
e811c8ce
RD
9092
9093 def SetRatioSize(*args, **kwargs):
248ed943
RD
9094 """
9095 SetRatioSize(self, Size size)
9096
9097 Set the ratio item attribute.
9098 """
54f9ee45 9099 return _core_.SizerItem_SetRatioSize(*args, **kwargs)
e811c8ce
RD
9100
9101 def SetRatio(*args, **kwargs):
248ed943
RD
9102 """
9103 SetRatio(self, float ratio)
9104
9105 Set the ratio item attribute.
9106 """
54f9ee45 9107 return _core_.SizerItem_SetRatio(*args, **kwargs)
e811c8ce
RD
9108
9109 def GetRatio(*args, **kwargs):
248ed943
RD
9110 """
9111 GetRatio(self) -> float
9112
9113 Set the ratio item attribute.
9114 """
54f9ee45 9115 return _core_.SizerItem_GetRatio(*args, **kwargs)
e811c8ce 9116
d3b6e4ff
RD
9117 def GetRect(*args, **kwargs):
9118 """
9119 GetRect(self) -> Rect
9120
9121 Returns the rectangle that the sizer item should occupy
9122 """
9123 return _core_.SizerItem_GetRect(*args, **kwargs)
9124
e811c8ce 9125 def IsWindow(*args, **kwargs):
248ed943
RD
9126 """
9127 IsWindow(self) -> bool
9128
9129 Is this sizer item a window?
9130 """
54f9ee45 9131 return _core_.SizerItem_IsWindow(*args, **kwargs)
e811c8ce
RD
9132
9133 def IsSizer(*args, **kwargs):
248ed943
RD
9134 """
9135 IsSizer(self) -> bool
9136
9137 Is this sizer item a subsizer?
9138 """
54f9ee45 9139 return _core_.SizerItem_IsSizer(*args, **kwargs)
e811c8ce
RD
9140
9141 def IsSpacer(*args, **kwargs):
248ed943
RD
9142 """
9143 IsSpacer(self) -> bool
9144
9145 Is this sizer item a spacer?
9146 """
54f9ee45 9147 return _core_.SizerItem_IsSpacer(*args, **kwargs)
e811c8ce
RD
9148
9149 def SetProportion(*args, **kwargs):
248ed943
RD
9150 """
9151 SetProportion(self, int proportion)
9152
9153 Set the proportion value for this item.
9154 """
54f9ee45 9155 return _core_.SizerItem_SetProportion(*args, **kwargs)
e811c8ce
RD
9156
9157 def GetProportion(*args, **kwargs):
248ed943
RD
9158 """
9159 GetProportion(self) -> int
9160
9161 Get the proportion value for this item.
9162 """
54f9ee45 9163 return _core_.SizerItem_GetProportion(*args, **kwargs)
e811c8ce 9164
248ed943
RD
9165 SetOption = wx._deprecated(SetProportion, "Please use `SetProportion` instead.")
9166 GetOption = wx._deprecated(GetProportion, "Please use `GetProportion` instead.")
e811c8ce 9167 def SetFlag(*args, **kwargs):
248ed943
RD
9168 """
9169 SetFlag(self, int flag)
9170
9171 Set the flag value for this item.
9172 """
54f9ee45 9173 return _core_.SizerItem_SetFlag(*args, **kwargs)
e811c8ce
RD
9174
9175 def GetFlag(*args, **kwargs):
248ed943
RD
9176 """
9177 GetFlag(self) -> int
9178
9179 Get the flag value for this item.
9180 """
54f9ee45 9181 return _core_.SizerItem_GetFlag(*args, **kwargs)
e811c8ce
RD
9182
9183 def SetBorder(*args, **kwargs):
248ed943
RD
9184 """
9185 SetBorder(self, int border)
9186
9187 Set the border value for this item.
9188 """
54f9ee45 9189 return _core_.SizerItem_SetBorder(*args, **kwargs)
e811c8ce
RD
9190
9191 def GetBorder(*args, **kwargs):
248ed943
RD
9192 """
9193 GetBorder(self) -> int
9194
9195 Get the border value for this item.
9196 """
54f9ee45 9197 return _core_.SizerItem_GetBorder(*args, **kwargs)
e811c8ce
RD
9198
9199 def GetWindow(*args, **kwargs):
248ed943
RD
9200 """
9201 GetWindow(self) -> Window
9202
9203 Get the window (if any) that is managed by this sizer item.
9204 """
54f9ee45 9205 return _core_.SizerItem_GetWindow(*args, **kwargs)
e811c8ce
RD
9206
9207 def SetWindow(*args, **kwargs):
248ed943
RD
9208 """
9209 SetWindow(self, Window window)
9210
9211 Set the window to be managed by this sizer item.
9212 """
54f9ee45 9213 return _core_.SizerItem_SetWindow(*args, **kwargs)
e811c8ce
RD
9214
9215 def GetSizer(*args, **kwargs):
248ed943
RD
9216 """
9217 GetSizer(self) -> Sizer
9218
9219 Get the subsizer (if any) that is managed by this sizer item.
9220 """
54f9ee45 9221 return _core_.SizerItem_GetSizer(*args, **kwargs)
e811c8ce
RD
9222
9223 def SetSizer(*args, **kwargs):
248ed943
RD
9224 """
9225 SetSizer(self, Sizer sizer)
9226
9227 Set the subsizer to be managed by this sizer item.
9228 """
54f9ee45 9229 return _core_.SizerItem_SetSizer(*args, **kwargs)
e811c8ce
RD
9230
9231 def GetSpacer(*args, **kwargs):
248ed943
RD
9232 """
9233 GetSpacer(self) -> Size
9234
9235 Get the size of the spacer managed by this sizer item.
9236 """
54f9ee45 9237 return _core_.SizerItem_GetSpacer(*args, **kwargs)
e811c8ce
RD
9238
9239 def SetSpacer(*args, **kwargs):
248ed943
RD
9240 """
9241 SetSpacer(self, Size size)
9242
9243 Set the size of the spacer to be managed by this sizer item.
9244 """
54f9ee45 9245 return _core_.SizerItem_SetSpacer(*args, **kwargs)
e811c8ce
RD
9246
9247 def Show(*args, **kwargs):
248ed943
RD
9248 """
9249 Show(self, bool show)
9250
9251 Set the show item attribute, which sizers use to determine if the item
9252 is to be made part of the layout or not. If the item is tracking a
9253 window then it is shown or hidden as needed.
9254 """
54f9ee45 9255 return _core_.SizerItem_Show(*args, **kwargs)
e811c8ce
RD
9256
9257 def IsShown(*args, **kwargs):
248ed943
RD
9258 """
9259 IsShown(self) -> bool
9260
9261 Is the item to be shown in the layout?
9262 """
54f9ee45 9263 return _core_.SizerItem_IsShown(*args, **kwargs)
e811c8ce
RD
9264
9265 def GetPosition(*args, **kwargs):
248ed943
RD
9266 """
9267 GetPosition(self) -> Point
9268
9269 Returns the current position of the item, as set in the last Layout.
9270 """
54f9ee45 9271 return _core_.SizerItem_GetPosition(*args, **kwargs)
e811c8ce
RD
9272
9273 def GetUserData(*args, **kwargs):
248ed943
RD
9274 """
9275 GetUserData(self) -> PyObject
9276
9277 Returns the userData associated with this sizer item, or None if there
9278 isn't any.
9279 """
54f9ee45 9280 return _core_.SizerItem_GetUserData(*args, **kwargs)
e811c8ce 9281
d14a1e28
RD
9282
9283class SizerItemPtr(SizerItem):
9284 def __init__(self, this):
9285 self.this = this
9286 if not hasattr(self,"thisown"): self.thisown = 0
9287 self.__class__ = SizerItem
54f9ee45 9288_core_.SizerItem_swigregister(SizerItemPtr)
d14a1e28 9289
248ed943 9290def SizerItemWindow(*args, **kwargs):
0df68c9f 9291 """
248ed943
RD
9292 SizerItemWindow(Window window, int proportion, int flag, int border,
9293 PyObject userData=None) -> SizerItem
9294
9295 Constructs a `wx.SizerItem` for tracking a window.
0df68c9f 9296 """
248ed943 9297 val = _core_.new_SizerItemWindow(*args, **kwargs)
d14a1e28
RD
9298 val.thisown = 1
9299 return val
9300
248ed943 9301def SizerItemSpacer(*args, **kwargs):
0df68c9f 9302 """
248ed943
RD
9303 SizerItemSpacer(int width, int height, int proportion, int flag, int border,
9304 PyObject userData=None) -> SizerItem
9305
9306 Constructs a `wx.SizerItem` for tracking a spacer.
0df68c9f 9307 """
248ed943 9308 val = _core_.new_SizerItemSpacer(*args, **kwargs)
d14a1e28
RD
9309 val.thisown = 1
9310 return val
9311
9312def SizerItemSizer(*args, **kwargs):
0df68c9f
RD
9313 """
9314 SizerItemSizer(Sizer sizer, int proportion, int flag, int border,
248ed943
RD
9315 PyObject userData=None) -> SizerItem
9316
9317 Constructs a `wx.SizerItem` for tracking a subsizer
0df68c9f 9318 """
54f9ee45 9319 val = _core_.new_SizerItemSizer(*args, **kwargs)
d14a1e28
RD
9320 val.thisown = 1
9321 return val
9322
9323class Sizer(Object):
248ed943
RD
9324 """
9325 wx.Sizer is the abstract base class used for laying out subwindows in
9326 a window. You cannot use wx.Sizer directly; instead, you will have to
9327 use one of the sizer classes derived from it such as `wx.BoxSizer`,
9328 `wx.StaticBoxSizer`, `wx.NotebookSizer`, `wx.GridSizer`, `wx.FlexGridSizer`
9329 and `wx.GridBagSizer`.
9330
9331 The concept implemented by sizers in wxWidgets is closely related to
9332 layout tools in other GUI toolkits, such as Java's AWT, the GTK
9333 toolkit or the Qt toolkit. It is based upon the idea of the individual
9334 subwindows reporting their minimal required size and their ability to
9335 get stretched if the size of the parent window has changed. This will
9336 most often mean that the programmer does not set the original size of
9337 a dialog in the beginning, rather the dialog will assigned a sizer and
9338 this sizer will be queried about the recommended size. The sizer in
9339 turn will query its children, which can be normal windows or contorls,
9340 empty space or other sizers, so that a hierarchy of sizers can be
9341 constructed. Note that wxSizer does not derive from wxWindow and thus
9342 do not interfere with tab ordering and requires very little resources
9343 compared to a real window on screen.
9344
9345 What makes sizers so well fitted for use in wxWidgets is the fact that
9346 every control reports its own minimal size and the algorithm can
9347 handle differences in font sizes or different window (dialog item)
9348 sizes on different platforms without problems. If for example the
9349 standard font as well as the overall design of Mac widgets requires
9350 more space than on Windows, then the initial size of a dialog using a
9351 sizer will automatically be bigger on Mac than on Windows.
9352 """
e811c8ce
RD
9353 def __init__(self): raise RuntimeError, "No constructor defined"
9354 def __repr__(self):
9355 return "<%s.%s; proxy of C++ wxSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
9356 def _setOORInfo(*args, **kwargs):
a95a7133 9357 """_setOORInfo(self, PyObject _self)"""
54f9ee45 9358 return _core_.Sizer__setOORInfo(*args, **kwargs)
e811c8ce
RD
9359
9360 def Add(*args, **kwargs):
0df68c9f 9361 """
248ed943 9362 Add(self, item, int proportion=0, int flag=0, int border=0,
d3b6e4ff 9363 PyObject userData=None) -> wx.SizerItem
248ed943
RD
9364
9365 Appends a child item to the sizer.
0df68c9f 9366 """
54f9ee45 9367 return _core_.Sizer_Add(*args, **kwargs)
e811c8ce
RD
9368
9369 def Insert(*args, **kwargs):
0df68c9f 9370 """
248ed943 9371 Insert(self, int before, item, int proportion=0, int flag=0, int border=0,
d3b6e4ff 9372 PyObject userData=None) -> wx.SizerItem
248ed943
RD
9373
9374 Inserts a new item into the list of items managed by this sizer before
9375 the item at index *before*. See `Add` for a description of the parameters.
0df68c9f 9376 """
54f9ee45 9377 return _core_.Sizer_Insert(*args, **kwargs)
e811c8ce
RD
9378
9379 def Prepend(*args, **kwargs):
0df68c9f 9380 """
248ed943 9381 Prepend(self, item, int proportion=0, int flag=0, int border=0,
d3b6e4ff 9382 PyObject userData=None) -> wx.SizerItem
248ed943
RD
9383
9384 Adds a new item to the begining of the list of sizer items managed by
9385 this sizer. See `Add` for a description of the parameters.
0df68c9f 9386 """
54f9ee45 9387 return _core_.Sizer_Prepend(*args, **kwargs)
e811c8ce
RD
9388
9389 def Remove(*args, **kwargs):
248ed943
RD
9390 """
9391 Remove(self, item) -> bool
9392
9393 Removes an item from the sizer and destroys it. This method does not
9394 cause any layout or resizing to take place, call `Layout` to update
9395 the layout on screen after removing a child from the sizer. The
9396 *item* parameter can be either a window, a sizer, or the zero-based
9397 index of an item to remove. Returns True if the child item was found
9398 and removed.
9399 """
54f9ee45 9400 return _core_.Sizer_Remove(*args, **kwargs)
e811c8ce 9401
1c0f361b 9402 def Detach(*args, **kwargs):
248ed943
RD
9403 """
9404 Detach(self, item) -> bool
9405
9406 Detaches an item from the sizer without destroying it. This method
9407 does not cause any layout or resizing to take place, call `Layout` to
9408 do so. The *item* parameter can be either a window, a sizer, or the
9409 zero-based index of the item to be detached. Returns True if the child item
9410 was found and detached.
9411 """
1c0f361b
RD
9412 return _core_.Sizer_Detach(*args, **kwargs)
9413
d3b6e4ff
RD
9414 def GetItem(*args, **kwargs):
9415 """
9416 GetItem(self, item) -> wx.SizerItem
9417
9418 Returns the `wx.SizerItem` which holds the *item* given. The *item*
9419 parameter can be either a window, a sizer, or the zero-based index of
9420 the item to be detached.
9421 """
9422 return _core_.Sizer_GetItem(*args, **kwargs)
9423
e811c8ce 9424 def _SetItemMinSize(*args, **kwargs):
a95a7133 9425 """_SetItemMinSize(self, PyObject item, Size size)"""
54f9ee45 9426 return _core_.Sizer__SetItemMinSize(*args, **kwargs)
e811c8ce 9427
248ed943
RD
9428 def SetItemMinSize(self, item, *args):
9429 """
9430 SetItemMinSize(self, item, Size size)
9431
9432 Sets the minimum size that will be allocated for an item in the sizer.
9433 The *item* parameter can be either a window, a sizer, or the
9434 zero-based index of the item. If a window or sizer is given then it
9435 will be searched for recursivly in subsizers if neccessary.
9436 """
9437 if len(args) == 2:
9438 # for backward compatibility accept separate width,height args too
9439 return self._SetItemMinSize(item, args)
9440 else:
9441 return self._SetItemMinSize(item, args[0])
9442
e811c8ce 9443 def AddItem(*args, **kwargs):
248ed943
RD
9444 """
9445 AddItem(self, SizerItem item)
9446
9447 Adds a `wx.SizerItem` to the sizer.
9448 """
54f9ee45 9449 return _core_.Sizer_AddItem(*args, **kwargs)
e811c8ce
RD
9450
9451 def InsertItem(*args, **kwargs):
248ed943
RD
9452 """
9453 InsertItem(self, int index, SizerItem item)
9454
9455 Inserts a `wx.SizerItem` to the sizer at the position given by *index*.
9456 """
54f9ee45 9457 return _core_.Sizer_InsertItem(*args, **kwargs)
e811c8ce
RD
9458
9459 def PrependItem(*args, **kwargs):
248ed943
RD
9460 """
9461 PrependItem(self, SizerItem item)
9462
9463 Prepends a `wx.SizerItem` to the sizer.
9464 """
54f9ee45 9465 return _core_.Sizer_PrependItem(*args, **kwargs)
e811c8ce 9466
248ed943 9467 def AddMany(self, items):
66c033b4
RD
9468 """
9469 AddMany is a convenience method for adding several items
9470 to a sizer at one time. Simply pass it a list of tuples,
9471 where each tuple consists of the parameters that you
9472 would normally pass to the `Add` method.
9473 """
248ed943
RD
9474 for item in items:
9475 if type(item) != type(()) or (len(item) == 2 and type(item[0]) == type(1)):
9476 item = (item, )
9477 self.Add(*item)
d14a1e28 9478
74e96f3d 9479 # for backwards compatibility only, please do not use in new code
66c033b4
RD
9480 AddWindow = wx._deprecated(Add, "AddWindow is deprecated, use `Add` instead.")
9481 AddSizer = wx._deprecated(Add, "AddSizer is deprecated, use `Add` instead.")
9482 AddSpacer = wx._deprecated(Add, "AddSpacer is deprecated, use `Add` instead.")
9483 PrependWindow = wx._deprecated(Prepend, "PrependWindow is deprecated, use `Prepend` instead.")
9484 PrependSizer = wx._deprecated(Prepend, "PrependSizer is deprecated, use `Prepend` instead.")
9485 PrependSpacer = wx._deprecated(Prepend, "PrependSpacer is deprecated, use `Prepend` instead.")
9486 InsertWindow = wx._deprecated(Insert, "InsertWindow is deprecated, use `Insert` instead.")
9487 InsertSizer = wx._deprecated(Insert, "InsertSizer is deprecated, use `Insert` instead.")
9488 InsertSpacer = wx._deprecated(Insert, "InsertSpacer is deprecated, use `Insert` instead.")
9489 RemoveWindow = wx._deprecated(Remove, "RemoveWindow is deprecated, use `Remove` instead.")
9490 RemoveSizer = wx._deprecated(Remove, "RemoveSizer is deprecated, use `Remove` instead.")
9491 RemovePos = wx._deprecated(Remove, "RemovePos is deprecated, use `Remove` instead.")
d14a1e28
RD
9492
9493
e811c8ce 9494 def SetDimension(*args, **kwargs):
248ed943
RD
9495 """
9496 SetDimension(self, int x, int y, int width, int height)
9497
9498 Call this to force the sizer to take the given dimension and thus
9499 force the items owned by the sizer to resize themselves according to
9500 the rules defined by the parameter in the `Add`, `Insert` or `Prepend`
9501 methods.
9502 """
54f9ee45 9503 return _core_.Sizer_SetDimension(*args, **kwargs)
e811c8ce
RD
9504
9505 def SetMinSize(*args, **kwargs):
248ed943
RD
9506 """
9507 SetMinSize(self, Size size)
9508
9509 Call this to give the sizer a minimal size. Normally, the sizer will
9510 calculate its minimal size based purely on how much space its children
9511 need. After calling this method `GetMinSize` will return either the
9512 minimal size as requested by its children or the minimal size set
9513 here, depending on which is bigger.
9514 """
54f9ee45 9515 return _core_.Sizer_SetMinSize(*args, **kwargs)
e811c8ce
RD
9516
9517 def GetSize(*args, **kwargs):
248ed943
RD
9518 """
9519 GetSize(self) -> Size
9520
9521 Returns the current size of the space managed by the sizer.
9522 """
54f9ee45 9523 return _core_.Sizer_GetSize(*args, **kwargs)
e811c8ce
RD
9524
9525 def GetPosition(*args, **kwargs):
248ed943
RD
9526 """
9527 GetPosition(self) -> Point
9528
9529 Returns the current position of the sizer's managed space.
9530 """
54f9ee45 9531 return _core_.Sizer_GetPosition(*args, **kwargs)
e811c8ce
RD
9532
9533 def GetMinSize(*args, **kwargs):
248ed943
RD
9534 """
9535 GetMinSize(self) -> Size
9536
9537 Returns the minimal size of the sizer. This is either the combined
9538 minimal size of all the children and their borders or the minimal size
9539 set by SetMinSize, depending on which is bigger.
9540 """
54f9ee45 9541 return _core_.Sizer_GetMinSize(*args, **kwargs)
e811c8ce 9542
d14a1e28 9543 def GetSizeTuple(self):
1c0f361b 9544 return self.GetSize().Get()
d14a1e28 9545 def GetPositionTuple(self):
1c0f361b 9546 return self.GetPosition().Get()
d14a1e28 9547 def GetMinSizeTuple(self):
1c0f361b 9548 return self.GetMinSize().Get()
d14a1e28 9549
e811c8ce 9550 def RecalcSizes(*args, **kwargs):
248ed943
RD
9551 """
9552 RecalcSizes(self)
9553
9554 Using the sizes calculated by `CalcMin` reposition and resize all the
9555 items managed by this sizer. You should not need to call this directly as
9556 it is called by `Layout`.
9557 """
54f9ee45 9558 return _core_.Sizer_RecalcSizes(*args, **kwargs)
e811c8ce
RD
9559
9560 def CalcMin(*args, **kwargs):
248ed943
RD
9561 """
9562 CalcMin(self) -> Size
9563
9564 This method is where the sizer will do the actual calculation of its
9565 children's minimal sizes. You should not need to call this directly as
9566 it is called by `Layout`.
9567 """
54f9ee45 9568 return _core_.Sizer_CalcMin(*args, **kwargs)
e811c8ce
RD
9569
9570 def Layout(*args, **kwargs):
248ed943
RD
9571 """
9572 Layout(self)
9573
9574 This method will force the recalculation and layout of the items
9575 controlled by the sizer using the current space allocated to the
9576 sizer. Normally this is called automatically from the owning window's
9577 EVT_SIZE handler, but it is also useful to call it from user code when
9578 one of the items in a sizer change size, or items are added or
9579 removed.
9580 """
54f9ee45 9581 return _core_.Sizer_Layout(*args, **kwargs)
e811c8ce
RD
9582
9583 def Fit(*args, **kwargs):
248ed943
RD
9584 """
9585 Fit(self, Window window) -> Size
9586
9587 Tell the sizer to resize the *window* to match the sizer's minimal
9588 size. This is commonly done in the constructor of the window itself in
9589 order to set its initial size to match the needs of the children as
9590 determined by the sizer. Returns the new size.
9591
9592 For a top level window this is the total window size, not the client size.
9593 """
54f9ee45 9594 return _core_.Sizer_Fit(*args, **kwargs)
e811c8ce
RD
9595
9596 def FitInside(*args, **kwargs):
248ed943
RD
9597 """
9598 FitInside(self, Window window)
9599
9600 Tell the sizer to resize the *virtual size* of the *window* to match the
9601 sizer's minimal size. This will not alter the on screen size of the
9602 window, but may cause the addition/removal/alteration of scrollbars
9603 required to view the virtual area in windows which manage it.
9604
9605 :see: `wx.ScrolledWindow.SetScrollbars`, `SetVirtualSizeHints`
9606
9607 """
54f9ee45 9608 return _core_.Sizer_FitInside(*args, **kwargs)
e811c8ce
RD
9609
9610 def SetSizeHints(*args, **kwargs):
248ed943
RD
9611 """
9612 SetSizeHints(self, Window window)
9613
9614 Tell the sizer to set (and `Fit`) the minimal size of the *window* to
9615 match the sizer's minimal size. This is commonly done in the
9616 constructor of the window itself if the window is resizable (as are
9617 many dialogs under Unix and frames on probably all platforms) in order
9618 to prevent the window from being sized smaller than the minimal size
9619 required by the sizer.
9620 """
54f9ee45 9621 return _core_.Sizer_SetSizeHints(*args, **kwargs)
e811c8ce
RD
9622
9623 def SetVirtualSizeHints(*args, **kwargs):
248ed943
RD
9624 """
9625 SetVirtualSizeHints(self, Window window)
9626
9627 Tell the sizer to set the minimal size of the window virtual area to
9628 match the sizer's minimal size. For windows with managed scrollbars
9629 this will set them appropriately.
9630
9631 :see: `wx.ScrolledWindow.SetScrollbars`
9632
9633 """
54f9ee45 9634 return _core_.Sizer_SetVirtualSizeHints(*args, **kwargs)
e811c8ce
RD
9635
9636 def Clear(*args, **kwargs):
248ed943
RD
9637 """
9638 Clear(self, bool deleteWindows=False)
9639
9640 Clear all items from the sizer, optionally destroying the window items
9641 as well.
9642 """
54f9ee45 9643 return _core_.Sizer_Clear(*args, **kwargs)
e811c8ce
RD
9644
9645 def DeleteWindows(*args, **kwargs):
248ed943
RD
9646 """
9647 DeleteWindows(self)
9648
9649 Destroy all windows managed by the sizer.
9650 """
54f9ee45 9651 return _core_.Sizer_DeleteWindows(*args, **kwargs)
e811c8ce
RD
9652
9653 def GetChildren(*args, **kwargs):
248ed943 9654 """
51b83b37 9655 GetChildren(self) -> list
248ed943
RD
9656
9657 Returns a list of all the `wx.SizerItem` objects managed by the sizer.
9658 """
54f9ee45 9659 return _core_.Sizer_GetChildren(*args, **kwargs)
e811c8ce
RD
9660
9661 def Show(*args, **kwargs):
248ed943 9662 """
ae8162c8 9663 Show(self, item, bool show=True, bool recursive=false) -> bool
e811c8ce 9664
248ed943
RD
9665 Shows or hides an item managed by the sizer. To make a sizer item
9666 disappear or reappear, use Show followed by `Layout`. The *item*
9667 parameter can be either a window, a sizer, or the zero-based index of
7e63a440
RD
9668 the item. Use the recursive parameter to show or hide an item in a
9669 subsizer. Returns True if the item was found.
248ed943
RD
9670 """
9671 return _core_.Sizer_Show(*args, **kwargs)
e811c8ce
RD
9672
9673 def IsShown(*args, **kwargs):
248ed943
RD
9674 """
9675 IsShown(self, item)
9676
9677 Determines if the item is currently shown. sizer. To make a sizer
9678 item disappear or reappear, use Show followed by `Layout`. The *item*
9679 parameter can be either a window, a sizer, or the zero-based index of
9680 the item.
9681 """
54f9ee45 9682 return _core_.Sizer_IsShown(*args, **kwargs)
e811c8ce 9683
7e63a440 9684 def Hide(self, item, recursive=False):
248ed943 9685 """
7e63a440 9686 A convenience method for Show(item, False, recursive).
248ed943 9687 """
06759a38 9688 return self.Show(item, False, recursive)
248ed943 9689
e811c8ce 9690 def ShowItems(*args, **kwargs):
248ed943
RD
9691 """
9692 ShowItems(self, bool show)
9693
84f85550 9694 Recursively call `wx.SizerItem.Show` on all sizer items.
248ed943 9695 """
54f9ee45 9696 return _core_.Sizer_ShowItems(*args, **kwargs)
e811c8ce 9697
d14a1e28
RD
9698
9699class SizerPtr(Sizer):
9700 def __init__(self, this):
9701 self.this = this
9702 if not hasattr(self,"thisown"): self.thisown = 0
9703 self.__class__ = Sizer
54f9ee45 9704_core_.Sizer_swigregister(SizerPtr)
d14a1e28
RD
9705
9706class PySizer(Sizer):
248ed943
RD
9707 """
9708 wx.PySizer is a special version of `wx.Sizer` that has been
9709 instrumented to allow the C++ virtual methods to be overloaded in
9710 Python derived classes. You would derive from this class if you are
9711 wanting to implement a custom sizer in Python code. Simply implement
9712 `CalcMin` and `RecalcSizes` in the derived class and you're all set.
9713 For example::
9714
9715 class MySizer(wx.PySizer):
9716 def __init__(self):
9717 wx.PySizer.__init__(self)
9718
9719 def CalcMin(self):
9720 for item in self.GetChildren():
9721 # calculate the total minimum width and height needed
9722 # by all items in the sizer according to this sizer's
9723 # layout algorithm.
9724 ...
9725 return wx.Size(width, height)
9726
9727 def RecalcSizes(self):
9728 # find the space allotted to this sizer
9729 pos = self.GetPosition()
9730 size = self.GetSize()
9731 for item in self.GetChildren():
9732 # Recalculate (if necessary) the position and size of
9733 # each item and then call item.SetDimension to do the
9734 # actual positioning and sizing of the items within the
9735 # space alloted to this sizer.
9736 ...
9737 item.SetDimension(itemPos, itemSize)
9738
9739
9740 When `Layout` is called it first calls `CalcMin` followed by
9741 `RecalcSizes` so you can optimize a bit by saving the results of
e505d15e 9742 `CalcMin` and reusing them in `RecalcSizes`.
248ed943
RD
9743
9744 :see: `wx.SizerItem`, `wx.Sizer.GetChildren`
9745
9746
9747 """
e811c8ce
RD
9748 def __repr__(self):
9749 return "<%s.%s; proxy of C++ wxPySizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 9750 def __init__(self, *args, **kwargs):
248ed943
RD
9751 """
9752 __init__(self) -> PySizer
9753
9754 Creates a wx.PySizer. Must be called from the __init__ in the derived
9755 class.
9756 """
54f9ee45 9757 newobj = _core_.new_PySizer(*args, **kwargs)
d14a1e28
RD
9758 self.this = newobj.this
9759 self.thisown = 1
9760 del newobj.thisown
9761 self._setCallbackInfo(self, PySizer);self._setOORInfo(self)
e811c8ce
RD
9762
9763 def _setCallbackInfo(*args, **kwargs):
a95a7133 9764 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
54f9ee45 9765 return _core_.PySizer__setCallbackInfo(*args, **kwargs)
e811c8ce 9766
d14a1e28
RD
9767
9768class PySizerPtr(PySizer):
9769 def __init__(self, this):
9770 self.this = this
9771 if not hasattr(self,"thisown"): self.thisown = 0
9772 self.__class__ = PySizer
54f9ee45 9773_core_.PySizer_swigregister(PySizerPtr)
d14a1e28
RD
9774
9775#---------------------------------------------------------------------------
9776
9777class BoxSizer(Sizer):
248ed943
RD
9778 """
9779 The basic idea behind a box sizer is that windows will most often be
9780 laid out in rather simple basic geometry, typically in a row or a
9781 column or nested hierarchies of either. A wx.BoxSizer will lay out
9782 its items in a simple row or column, depending on the orientation
9783 parameter passed to the constructor.
9784 """
e811c8ce
RD
9785 def __repr__(self):
9786 return "<%s.%s; proxy of C++ wxBoxSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 9787 def __init__(self, *args, **kwargs):
248ed943
RD
9788 """
9789 __init__(self, int orient=HORIZONTAL) -> BoxSizer
9790
9791 Constructor for a wx.BoxSizer. *orient* may be one of ``wx.VERTICAL``
9792 or ``wx.HORIZONTAL`` for creating either a column sizer or a row
9793 sizer.
9794 """
54f9ee45 9795 newobj = _core_.new_BoxSizer(*args, **kwargs)
d14a1e28
RD
9796 self.this = newobj.this
9797 self.thisown = 1
9798 del newobj.thisown
9799 self._setOORInfo(self)
e811c8ce
RD
9800
9801 def GetOrientation(*args, **kwargs):
248ed943
RD
9802 """
9803 GetOrientation(self) -> int
9804
9805 Returns the current orientation of the sizer.
9806 """
54f9ee45 9807 return _core_.BoxSizer_GetOrientation(*args, **kwargs)
e811c8ce
RD
9808
9809 def SetOrientation(*args, **kwargs):
248ed943
RD
9810 """
9811 SetOrientation(self, int orient)
e811c8ce 9812
248ed943
RD
9813 Resets the orientation of the sizer.
9814 """
9815 return _core_.BoxSizer_SetOrientation(*args, **kwargs)
e811c8ce 9816
d14a1e28
RD
9817
9818class BoxSizerPtr(BoxSizer):
9819 def __init__(self, this):
9820 self.this = this
9821 if not hasattr(self,"thisown"): self.thisown = 0
9822 self.__class__ = BoxSizer
54f9ee45 9823_core_.BoxSizer_swigregister(BoxSizerPtr)
d14a1e28
RD
9824
9825#---------------------------------------------------------------------------
9826
9827class StaticBoxSizer(BoxSizer):
248ed943
RD
9828 """
9829 wx.StaticBoxSizer derives from and functions identically to the
9830 `wx.BoxSizer` and adds a `wx.StaticBox` around the items that the sizer
9831 manages. Note that this static box must be created separately and
9832 passed to the sizer constructor.
9833 """
e811c8ce
RD
9834 def __repr__(self):
9835 return "<%s.%s; proxy of C++ wxStaticBoxSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 9836 def __init__(self, *args, **kwargs):
248ed943
RD
9837 """
9838 __init__(self, StaticBox box, int orient=HORIZONTAL) -> StaticBoxSizer
9839
9840 Constructor. It takes an associated static box and the orientation
9841 *orient* as parameters - orient can be either of ``wx.VERTICAL`` or
9842 ``wx.HORIZONTAL``.
9843 """
54f9ee45 9844 newobj = _core_.new_StaticBoxSizer(*args, **kwargs)
d14a1e28
RD
9845 self.this = newobj.this
9846 self.thisown = 1
9847 del newobj.thisown
9848 self._setOORInfo(self)
e811c8ce
RD
9849
9850 def GetStaticBox(*args, **kwargs):
248ed943
RD
9851 """
9852 GetStaticBox(self) -> StaticBox
e811c8ce 9853
248ed943
RD
9854 Returns the static box associated with this sizer.
9855 """
9856 return _core_.StaticBoxSizer_GetStaticBox(*args, **kwargs)
e811c8ce 9857
d14a1e28
RD
9858
9859class StaticBoxSizerPtr(StaticBoxSizer):
9860 def __init__(self, this):
9861 self.this = this
9862 if not hasattr(self,"thisown"): self.thisown = 0
9863 self.__class__ = StaticBoxSizer
54f9ee45 9864_core_.StaticBoxSizer_swigregister(StaticBoxSizerPtr)
d14a1e28
RD
9865
9866#---------------------------------------------------------------------------
9867
9868class GridSizer(Sizer):
248ed943
RD
9869 """
9870 A grid sizer is a sizer which lays out its children in a
9871 two-dimensional table with all cells having the same size. In other
9872 words, the width of each cell within the grid is the width of the
9873 widest item added to the sizer and the height of each grid cell is the
9874 height of the tallest item. An optional vertical and/or horizontal
9875 gap between items can also be specified (in pixels.)
9876
9877 Items are placed in the cells of the grid in the order they are added,
9878 in row-major order. In other words, the first row is filled first,
9879 then the second, and so on until all items have been added. (If
9880 neccessary, additional rows will be added as items are added.) If you
9881 need to have greater control over the cells that items are placed in
9882 then use the `wx.GridBagSizer`.
9883
9884 """
e811c8ce
RD
9885 def __repr__(self):
9886 return "<%s.%s; proxy of C++ wxGridSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 9887 def __init__(self, *args, **kwargs):
248ed943
RD
9888 """
9889 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> GridSizer
9890
9891 Constructor for a wx.GridSizer. *rows* and *cols* determine the number
9892 of columns and rows in the sizer - if either of the parameters is
9893 zero, it will be calculated to from the total number of children in
9894 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
9895 define extra space between all children.
9896 """
54f9ee45 9897 newobj = _core_.new_GridSizer(*args, **kwargs)
d14a1e28
RD
9898 self.this = newobj.this
9899 self.thisown = 1
9900 del newobj.thisown
9901 self._setOORInfo(self)
e811c8ce 9902
e811c8ce 9903 def SetCols(*args, **kwargs):
248ed943
RD
9904 """
9905 SetCols(self, int cols)
9906
9907 Sets the number of columns in the sizer.
9908 """
54f9ee45 9909 return _core_.GridSizer_SetCols(*args, **kwargs)
e811c8ce
RD
9910
9911 def SetRows(*args, **kwargs):
248ed943
RD
9912 """
9913 SetRows(self, int rows)
9914
9915 Sets the number of rows in the sizer.
9916 """
54f9ee45 9917 return _core_.GridSizer_SetRows(*args, **kwargs)
e811c8ce
RD
9918
9919 def SetVGap(*args, **kwargs):
248ed943
RD
9920 """
9921 SetVGap(self, int gap)
9922
9923 Sets the vertical gap (in pixels) between the cells in the sizer.
9924 """
54f9ee45 9925 return _core_.GridSizer_SetVGap(*args, **kwargs)
e811c8ce
RD
9926
9927 def SetHGap(*args, **kwargs):
248ed943
RD
9928 """
9929 SetHGap(self, int gap)
9930
9931 Sets the horizontal gap (in pixels) between cells in the sizer
9932 """
54f9ee45 9933 return _core_.GridSizer_SetHGap(*args, **kwargs)
e811c8ce
RD
9934
9935 def GetCols(*args, **kwargs):
248ed943
RD
9936 """
9937 GetCols(self) -> int
9938
9939 Returns the number of columns in the sizer.
9940 """
54f9ee45 9941 return _core_.GridSizer_GetCols(*args, **kwargs)
e811c8ce
RD
9942
9943 def GetRows(*args, **kwargs):
248ed943
RD
9944 """
9945 GetRows(self) -> int
9946
9947 Returns the number of rows in the sizer.
9948 """
54f9ee45 9949 return _core_.GridSizer_GetRows(*args, **kwargs)
e811c8ce
RD
9950
9951 def GetVGap(*args, **kwargs):
248ed943
RD
9952 """
9953 GetVGap(self) -> int
9954
9955 Returns the vertical gap (in pixels) between the cells in the sizer.
9956 """
54f9ee45 9957 return _core_.GridSizer_GetVGap(*args, **kwargs)
e811c8ce
RD
9958
9959 def GetHGap(*args, **kwargs):
248ed943
RD
9960 """
9961 GetHGap(self) -> int
9962
9963 Returns the horizontal gap (in pixels) between cells in the sizer.
9964 """
54f9ee45 9965 return _core_.GridSizer_GetHGap(*args, **kwargs)
e811c8ce 9966
d14a1e28
RD
9967
9968class GridSizerPtr(GridSizer):
9969 def __init__(self, this):
9970 self.this = this
9971 if not hasattr(self,"thisown"): self.thisown = 0
9972 self.__class__ = GridSizer
54f9ee45 9973_core_.GridSizer_swigregister(GridSizerPtr)
d14a1e28
RD
9974
9975#---------------------------------------------------------------------------
9976
54f9ee45
RD
9977FLEX_GROWMODE_NONE = _core_.FLEX_GROWMODE_NONE
9978FLEX_GROWMODE_SPECIFIED = _core_.FLEX_GROWMODE_SPECIFIED
9979FLEX_GROWMODE_ALL = _core_.FLEX_GROWMODE_ALL
d14a1e28 9980class FlexGridSizer(GridSizer):
248ed943
RD
9981 """
9982 A flex grid sizer is a sizer which lays out its children in a
9983 two-dimensional table with all table cells in one row having the same
9984 height and all cells in one column having the same width, but all
9985 rows or all columns are not necessarily the same height or width as in
9986 the `wx.GridSizer`.
9987
9988 wx.FlexGridSizer can also size items equally in one direction but
9989 unequally ("flexibly") in the other. If the sizer is only flexible
9990 in one direction (this can be changed using `SetFlexibleDirection`), it
9991 needs to be decided how the sizer should grow in the other ("non
9992 flexible") direction in order to fill the available space. The
9993 `SetNonFlexibleGrowMode` method serves this purpose.
9994
9995
9996 """
e811c8ce
RD
9997 def __repr__(self):
9998 return "<%s.%s; proxy of C++ wxFlexGridSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 9999 def __init__(self, *args, **kwargs):
248ed943
RD
10000 """
10001 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> FlexGridSizer
10002
10003 Constructor for a wx.FlexGridSizer. *rows* and *cols* determine the
10004 number of columns and rows in the sizer - if either of the parameters
10005 is zero, it will be calculated to from the total number of children in
10006 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
10007 define extra space between all children.
10008 """
54f9ee45 10009 newobj = _core_.new_FlexGridSizer(*args, **kwargs)
d14a1e28
RD
10010 self.this = newobj.this
10011 self.thisown = 1
10012 del newobj.thisown
10013 self._setOORInfo(self)
e811c8ce 10014
248ed943
RD
10015 def AddGrowableRow(*args, **kwargs):
10016 """
10017 AddGrowableRow(self, size_t idx, int proportion=0)
e811c8ce 10018
248ed943
RD
10019 Specifies that row *idx* (starting from zero) should be grown if there
10020 is extra space available to the sizer.
e811c8ce 10021
248ed943
RD
10022 The *proportion* parameter has the same meaning as the stretch factor
10023 for the box sizers except that if all proportions are 0, then all
10024 columns are resized equally (instead of not being resized at all).
10025 """
54f9ee45 10026 return _core_.FlexGridSizer_AddGrowableRow(*args, **kwargs)
e811c8ce
RD
10027
10028 def RemoveGrowableRow(*args, **kwargs):
248ed943
RD
10029 """
10030 RemoveGrowableRow(self, size_t idx)
10031
10032 Specifies that row *idx* is no longer growable.
10033 """
54f9ee45 10034 return _core_.FlexGridSizer_RemoveGrowableRow(*args, **kwargs)
e811c8ce
RD
10035
10036 def AddGrowableCol(*args, **kwargs):
248ed943
RD
10037 """
10038 AddGrowableCol(self, size_t idx, int proportion=0)
10039
10040 Specifies that column *idx* (starting from zero) should be grown if
10041 there is extra space available to the sizer.
10042
10043 The *proportion* parameter has the same meaning as the stretch factor
10044 for the box sizers except that if all proportions are 0, then all
10045 columns are resized equally (instead of not being resized at all).
10046 """
54f9ee45 10047 return _core_.FlexGridSizer_AddGrowableCol(*args, **kwargs)
e811c8ce
RD
10048
10049 def RemoveGrowableCol(*args, **kwargs):
248ed943
RD
10050 """
10051 RemoveGrowableCol(self, size_t idx)
10052
10053 Specifies that column *idx* is no longer growable.
10054 """
54f9ee45 10055 return _core_.FlexGridSizer_RemoveGrowableCol(*args, **kwargs)
e811c8ce
RD
10056
10057 def SetFlexibleDirection(*args, **kwargs):
248ed943
RD
10058 """
10059 SetFlexibleDirection(self, int direction)
10060
10061 Specifies whether the sizer should flexibly resize its columns, rows,
10062 or both. Argument *direction* can be one of the following values. Any
10063 other value is ignored.
10064
10065 ============== =======================================
10066 wx.VERTICAL Rows are flexibly sized.
10067 wx.HORIZONTAL Columns are flexibly sized.
10068 wx.BOTH Both rows and columns are flexibly sized
10069 (this is the default value).
10070 ============== =======================================
10071
10072 Note that this method does not trigger relayout.
10073
10074 """
54f9ee45 10075 return _core_.FlexGridSizer_SetFlexibleDirection(*args, **kwargs)
e811c8ce
RD
10076
10077 def GetFlexibleDirection(*args, **kwargs):
248ed943
RD
10078 """
10079 GetFlexibleDirection(self) -> int
10080
10081 Returns a value that specifies whether the sizer
10082 flexibly resizes its columns, rows, or both (default).
10083
10084 :see: `SetFlexibleDirection`
10085 """
54f9ee45 10086 return _core_.FlexGridSizer_GetFlexibleDirection(*args, **kwargs)
e811c8ce
RD
10087
10088 def SetNonFlexibleGrowMode(*args, **kwargs):
248ed943
RD
10089 """
10090 SetNonFlexibleGrowMode(self, int mode)
10091
10092 Specifies how the sizer should grow in the non-flexible direction if
10093 there is one (so `SetFlexibleDirection` must have been called
10094 previously). Argument *mode* can be one of the following values:
10095
10096 ========================== =================================================
10097 wx.FLEX_GROWMODE_NONE Sizer doesn't grow in the non flexible direction.
10098 wx.FLEX_GROWMODE_SPECIFIED Sizer honors growable columns/rows set with
10099 `AddGrowableCol` and `AddGrowableRow`. In this
10100 case equal sizing applies to minimum sizes of
10101 columns or rows (this is the default value).
10102 wx.FLEX_GROWMODE_ALL Sizer equally stretches all columns or rows in
10103 the non flexible direction, whether they are
10104 growable or not in the flexbile direction.
10105 ========================== =================================================
10106
10107 Note that this method does not trigger relayout.
10108
10109
10110 """
54f9ee45 10111 return _core_.FlexGridSizer_SetNonFlexibleGrowMode(*args, **kwargs)
e811c8ce
RD
10112
10113 def GetNonFlexibleGrowMode(*args, **kwargs):
248ed943
RD
10114 """
10115 GetNonFlexibleGrowMode(self) -> int
10116
10117 Returns the value that specifies how the sizer grows in the
10118 non-flexible direction if there is one.
10119
10120 :see: `SetNonFlexibleGrowMode`
10121 """
54f9ee45 10122 return _core_.FlexGridSizer_GetNonFlexibleGrowMode(*args, **kwargs)
e811c8ce
RD
10123
10124 def GetRowHeights(*args, **kwargs):
fd2dc343
RD
10125 """
10126 GetRowHeights(self) -> list
10127
10128 Returns a list of integers representing the heights of each of the
10129 rows in the sizer.
10130 """
54f9ee45 10131 return _core_.FlexGridSizer_GetRowHeights(*args, **kwargs)
e811c8ce
RD
10132
10133 def GetColWidths(*args, **kwargs):
fd2dc343
RD
10134 """
10135 GetColWidths(self) -> list
10136
10137 Returns a list of integers representing the widths of each of the
10138 columns in the sizer.
10139 """
54f9ee45 10140 return _core_.FlexGridSizer_GetColWidths(*args, **kwargs)
e811c8ce 10141
d14a1e28
RD
10142
10143class FlexGridSizerPtr(FlexGridSizer):
10144 def __init__(self, this):
10145 self.this = this
10146 if not hasattr(self,"thisown"): self.thisown = 0
10147 self.__class__ = FlexGridSizer
54f9ee45 10148_core_.FlexGridSizer_swigregister(FlexGridSizerPtr)
d14a1e28 10149
e505d15e
RD
10150class StdDialogButtonSizer(BoxSizer):
10151 """
10152 A special sizer that knows how to order and position standard buttons
10153 in order to conform to the current platform's standards. You simply
10154 need to add each `wx.Button` to the sizer, and be sure to create the
10155 buttons using the standard ID's. Then call `Finalize` and the sizer
10156 will take care of the rest.
10157
10158 """
10159 def __repr__(self):
10160 return "<%s.%s; proxy of C++ wxStdDialogButtonSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
10161 def __init__(self, *args, **kwargs):
10162 """__init__(self) -> StdDialogButtonSizer"""
10163 newobj = _core_.new_StdDialogButtonSizer(*args, **kwargs)
10164 self.this = newobj.this
10165 self.thisown = 1
10166 del newobj.thisown
10167 def AddButton(*args, **kwargs):
10168 """
10169 AddButton(self, wxButton button)
10170
10171 Use this to add the buttons to this sizer. Do not use the `Add`
10172 method in the base class.
10173 """
10174 return _core_.StdDialogButtonSizer_AddButton(*args, **kwargs)
10175
10176 def Finalise(*args, **kwargs):
10177 """
10178 Finalise(self)
10179
10180 This funciton needs to be called after all the buttons have been added
10181 to the sizer. It will reorder them and position them in a platform
10182 specifc manner.
10183 """
10184 return _core_.StdDialogButtonSizer_Finalise(*args, **kwargs)
51b83b37
RD
10185
10186 def SetAffirmativeButton(*args, **kwargs):
10187 """SetAffirmativeButton(self, wxButton button)"""
10188 return _core_.StdDialogButtonSizer_SetAffirmativeButton(*args, **kwargs)
10189
10190 def SetNegativeButton(*args, **kwargs):
10191 """SetNegativeButton(self, wxButton button)"""
10192 return _core_.StdDialogButtonSizer_SetNegativeButton(*args, **kwargs)
10193
10194 def SetCancelButton(*args, **kwargs):
10195 """SetCancelButton(self, wxButton button)"""
10196 return _core_.StdDialogButtonSizer_SetCancelButton(*args, **kwargs)
e505d15e
RD
10197
10198 def GetAffirmativeButton(*args, **kwargs):
10199 """GetAffirmativeButton(self) -> wxButton"""
10200 return _core_.StdDialogButtonSizer_GetAffirmativeButton(*args, **kwargs)
10201
10202 def GetApplyButton(*args, **kwargs):
10203 """GetApplyButton(self) -> wxButton"""
10204 return _core_.StdDialogButtonSizer_GetApplyButton(*args, **kwargs)
10205
10206 def GetNegativeButton(*args, **kwargs):
10207 """GetNegativeButton(self) -> wxButton"""
10208 return _core_.StdDialogButtonSizer_GetNegativeButton(*args, **kwargs)
10209
10210 def GetCancelButton(*args, **kwargs):
10211 """GetCancelButton(self) -> wxButton"""
10212 return _core_.StdDialogButtonSizer_GetCancelButton(*args, **kwargs)
10213
10214 def GetHelpButton(*args, **kwargs):
10215 """GetHelpButton(self) -> wxButton"""
10216 return _core_.StdDialogButtonSizer_GetHelpButton(*args, **kwargs)
10217
10218
10219class StdDialogButtonSizerPtr(StdDialogButtonSizer):
10220 def __init__(self, this):
10221 self.this = this
10222 if not hasattr(self,"thisown"): self.thisown = 0
10223 self.__class__ = StdDialogButtonSizer
10224_core_.StdDialogButtonSizer_swigregister(StdDialogButtonSizerPtr)
10225
d14a1e28
RD
10226#---------------------------------------------------------------------------
10227
10228class GBPosition(object):
248ed943
RD
10229 """
10230 This class represents the position of an item in a virtual grid of
10231 rows and columns managed by a `wx.GridBagSizer`. wxPython has
10232 typemaps that will automatically convert from a 2-element sequence of
10233 integers to a wx.GBPosition, so you can use the more pythonic
10234 representation of the position nearly transparently in Python code.
10235 """
e811c8ce
RD
10236 def __repr__(self):
10237 return "<%s.%s; proxy of C++ wxGBPosition instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 10238 def __init__(self, *args, **kwargs):
248ed943
RD
10239 """
10240 __init__(self, int row=0, int col=0) -> GBPosition
10241
10242 This class represents the position of an item in a virtual grid of
10243 rows and columns managed by a `wx.GridBagSizer`. wxPython has
10244 typemaps that will automatically convert from a 2-element sequence of
10245 integers to a wx.GBPosition, so you can use the more pythonic
10246 representation of the position nearly transparently in Python code.
10247 """
54f9ee45 10248 newobj = _core_.new_GBPosition(*args, **kwargs)
d14a1e28
RD
10249 self.this = newobj.this
10250 self.thisown = 1
10251 del newobj.thisown
e811c8ce 10252 def GetRow(*args, **kwargs):
a95a7133 10253 """GetRow(self) -> int"""
54f9ee45 10254 return _core_.GBPosition_GetRow(*args, **kwargs)
e811c8ce
RD
10255
10256 def GetCol(*args, **kwargs):
a95a7133 10257 """GetCol(self) -> int"""
54f9ee45 10258 return _core_.GBPosition_GetCol(*args, **kwargs)
e811c8ce
RD
10259
10260 def SetRow(*args, **kwargs):
a95a7133 10261 """SetRow(self, int row)"""
54f9ee45 10262 return _core_.GBPosition_SetRow(*args, **kwargs)
e811c8ce
RD
10263
10264 def SetCol(*args, **kwargs):
a95a7133 10265 """SetCol(self, int col)"""
54f9ee45 10266 return _core_.GBPosition_SetCol(*args, **kwargs)
e811c8ce
RD
10267
10268 def __eq__(*args, **kwargs):
a95a7133 10269 """__eq__(self, GBPosition other) -> bool"""
54f9ee45 10270 return _core_.GBPosition___eq__(*args, **kwargs)
e811c8ce
RD
10271
10272 def __ne__(*args, **kwargs):
a95a7133 10273 """__ne__(self, GBPosition other) -> bool"""
54f9ee45 10274 return _core_.GBPosition___ne__(*args, **kwargs)
e811c8ce
RD
10275
10276 def Set(*args, **kwargs):
a95a7133 10277 """Set(self, int row=0, int col=0)"""
54f9ee45 10278 return _core_.GBPosition_Set(*args, **kwargs)
e811c8ce
RD
10279
10280 def Get(*args, **kwargs):
a95a7133 10281 """Get(self) -> PyObject"""
54f9ee45 10282 return _core_.GBPosition_Get(*args, **kwargs)
e811c8ce 10283
41e2b43e 10284 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
e811c8ce
RD
10285 def __str__(self): return str(self.Get())
10286 def __repr__(self): return 'wx.GBPosition'+str(self.Get())
10287 def __len__(self): return len(self.Get())
10288 def __getitem__(self, index): return self.Get()[index]
d14a1e28
RD
10289 def __setitem__(self, index, val):
10290 if index == 0: self.SetRow(val)
10291 elif index == 1: self.SetCol(val)
10292 else: raise IndexError
e811c8ce 10293 def __nonzero__(self): return self.Get() != (0,0)
74e96f3d
RD
10294 __safe_for_unpickling__ = True
10295 def __reduce__(self): return (wx.GBPosition, self.Get())
d14a1e28
RD
10296
10297 row = property(GetRow, SetRow)
10298 col = property(GetCol, SetCol)
10299
10300
10301class GBPositionPtr(GBPosition):
10302 def __init__(self, this):
10303 self.this = this
10304 if not hasattr(self,"thisown"): self.thisown = 0
10305 self.__class__ = GBPosition
54f9ee45 10306_core_.GBPosition_swigregister(GBPositionPtr)
d14a1e28
RD
10307
10308class GBSpan(object):
248ed943
RD
10309 """
10310 This class is used to hold the row and column spanning attributes of
10311 items in a `wx.GridBagSizer`. wxPython has typemaps that will
10312 automatically convert from a 2-element sequence of integers to a
10313 wx.GBSpan, so you can use the more pythonic representation of the span
10314 nearly transparently in Python code.
10315
10316 """
e811c8ce
RD
10317 def __repr__(self):
10318 return "<%s.%s; proxy of C++ wxGBSpan instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 10319 def __init__(self, *args, **kwargs):
248ed943
RD
10320 """
10321 __init__(self, int rowspan=1, int colspan=1) -> GBSpan
10322
10323 Construct a new wxGBSpan, optionally setting the rowspan and
10324 colspan. The default is (1,1). (Meaning that the item occupies one
10325 cell in each direction.
10326 """
54f9ee45 10327 newobj = _core_.new_GBSpan(*args, **kwargs)
d14a1e28
RD
10328 self.this = newobj.this
10329 self.thisown = 1
10330 del newobj.thisown
e811c8ce 10331 def GetRowspan(*args, **kwargs):
a95a7133 10332 """GetRowspan(self) -> int"""
54f9ee45 10333 return _core_.GBSpan_GetRowspan(*args, **kwargs)
e811c8ce
RD
10334
10335 def GetColspan(*args, **kwargs):
a95a7133 10336 """GetColspan(self) -> int"""
54f9ee45 10337 return _core_.GBSpan_GetColspan(*args, **kwargs)
e811c8ce
RD
10338
10339 def SetRowspan(*args, **kwargs):
a95a7133 10340 """SetRowspan(self, int rowspan)"""
54f9ee45 10341 return _core_.GBSpan_SetRowspan(*args, **kwargs)
e811c8ce
RD
10342
10343 def SetColspan(*args, **kwargs):
a95a7133 10344 """SetColspan(self, int colspan)"""
54f9ee45 10345 return _core_.GBSpan_SetColspan(*args, **kwargs)
e811c8ce
RD
10346
10347 def __eq__(*args, **kwargs):
a95a7133 10348 """__eq__(self, GBSpan other) -> bool"""
54f9ee45 10349 return _core_.GBSpan___eq__(*args, **kwargs)
e811c8ce
RD
10350
10351 def __ne__(*args, **kwargs):
a95a7133 10352 """__ne__(self, GBSpan other) -> bool"""
54f9ee45 10353 return _core_.GBSpan___ne__(*args, **kwargs)
e811c8ce
RD
10354
10355 def Set(*args, **kwargs):
a95a7133 10356 """Set(self, int rowspan=1, int colspan=1)"""
54f9ee45 10357 return _core_.GBSpan_Set(*args, **kwargs)
e811c8ce
RD
10358
10359 def Get(*args, **kwargs):
a95a7133 10360 """Get(self) -> PyObject"""
54f9ee45 10361 return _core_.GBSpan_Get(*args, **kwargs)
e811c8ce 10362
41e2b43e 10363 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
e811c8ce
RD
10364 def __str__(self): return str(self.Get())
10365 def __repr__(self): return 'wx.GBSpan'+str(self.Get())
10366 def __len__(self): return len(self.Get())
10367 def __getitem__(self, index): return self.Get()[index]
d14a1e28
RD
10368 def __setitem__(self, index, val):
10369 if index == 0: self.SetRowspan(val)
10370 elif index == 1: self.SetColspan(val)
10371 else: raise IndexError
e811c8ce 10372 def __nonzero__(self): return self.Get() != (0,0)
74e96f3d
RD
10373 __safe_for_unpickling__ = True
10374 def __reduce__(self): return (wx.GBSpan, self.Get())
d14a1e28
RD
10375
10376 rowspan = property(GetRowspan, SetRowspan)
10377 colspan = property(GetColspan, SetColspan)
10378
10379
10380class GBSpanPtr(GBSpan):
10381 def __init__(self, this):
10382 self.this = this
10383 if not hasattr(self,"thisown"): self.thisown = 0
10384 self.__class__ = GBSpan
54f9ee45 10385_core_.GBSpan_swigregister(GBSpanPtr)
d14a1e28
RD
10386
10387class GBSizerItem(SizerItem):
248ed943
RD
10388 """
10389 The wx.GBSizerItem class is used to track the additional data about
10390 items in a `wx.GridBagSizer` such as the item's position in the grid
10391 and how many rows or columns it spans.
10392
10393 """
e811c8ce
RD
10394 def __repr__(self):
10395 return "<%s.%s; proxy of C++ wxGBSizerItem instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 10396 def __init__(self, *args, **kwargs):
248ed943
RD
10397 """
10398 __init__(self) -> GBSizerItem
10399
10400 Constructs an empty wx.GBSizerItem. Either a window, sizer or spacer
10401 size will need to be set, as well as a position and span before this
10402 item can be used in a Sizer.
10403
10404 You will probably never need to create a wx.GBSizerItem directly as they
10405 are created automatically when the sizer's Add method is called.
10406 """
54f9ee45 10407 newobj = _core_.new_GBSizerItem(*args, **kwargs)
d14a1e28
RD
10408 self.this = newobj.this
10409 self.thisown = 1
10410 del newobj.thisown
e811c8ce 10411 def GetPos(*args, **kwargs):
248ed943
RD
10412 """
10413 GetPos(self) -> GBPosition
10414
10415 Get the grid position of the item
10416 """
54f9ee45 10417 return _core_.GBSizerItem_GetPos(*args, **kwargs)
e811c8ce
RD
10418
10419 def GetPosTuple(self): return self.GetPos().Get()
10420 def GetSpan(*args, **kwargs):
248ed943
RD
10421 """
10422 GetSpan(self) -> GBSpan
10423
10424 Get the row and column spanning of the item
10425 """
54f9ee45 10426 return _core_.GBSizerItem_GetSpan(*args, **kwargs)
e811c8ce
RD
10427
10428 def GetSpanTuple(self): return self.GetSpan().Get()
10429 def SetPos(*args, **kwargs):
248ed943
RD
10430 """
10431 SetPos(self, GBPosition pos) -> bool
10432
10433 If the item is already a member of a sizer then first ensure that
10434 there is no other item that would intersect with this one at the new
10435 position, then set the new position. Returns True if the change is
10436 successful and after the next Layout() the item will be moved.
10437 """
54f9ee45 10438 return _core_.GBSizerItem_SetPos(*args, **kwargs)
e811c8ce
RD
10439
10440 def SetSpan(*args, **kwargs):
248ed943
RD
10441 """
10442 SetSpan(self, GBSpan span) -> bool
10443
10444 If the item is already a member of a sizer then first ensure that
10445 there is no other item that would intersect with this one with its new
10446 spanning size, then set the new spanning. Returns True if the change
10447 is successful and after the next Layout() the item will be resized.
10448
10449 """
54f9ee45 10450 return _core_.GBSizerItem_SetSpan(*args, **kwargs)
e811c8ce 10451
248ed943 10452 def Intersects(*args, **kwargs):
0df68c9f 10453 """
a95a7133 10454 Intersects(self, GBSizerItem other) -> bool
248ed943
RD
10455
10456 Returns True if this item and the other item instersect.
0df68c9f 10457 """
248ed943
RD
10458 return _core_.GBSizerItem_Intersects(*args, **kwargs)
10459
10460 def IntersectsPos(*args, **kwargs):
10461 """
10462 IntersectsPos(self, GBPosition pos, GBSpan span) -> bool
10463
10464 Returns True if the given pos/span would intersect with this item.
10465 """
10466 return _core_.GBSizerItem_IntersectsPos(*args, **kwargs)
e811c8ce
RD
10467
10468 def GetEndPos(*args, **kwargs):
248ed943
RD
10469 """
10470 GetEndPos(self) -> GBPosition
10471
10472 Get the row and column of the endpoint of this item.
10473 """
54f9ee45 10474 return _core_.GBSizerItem_GetEndPos(*args, **kwargs)
e811c8ce
RD
10475
10476 def GetGBSizer(*args, **kwargs):
248ed943
RD
10477 """
10478 GetGBSizer(self) -> GridBagSizer
10479
10480 Get the sizer this item is a member of.
10481 """
54f9ee45 10482 return _core_.GBSizerItem_GetGBSizer(*args, **kwargs)
e811c8ce
RD
10483
10484 def SetGBSizer(*args, **kwargs):
248ed943
RD
10485 """
10486 SetGBSizer(self, GridBagSizer sizer)
10487
10488 Set the sizer this item is a member of.
10489 """
54f9ee45 10490 return _core_.GBSizerItem_SetGBSizer(*args, **kwargs)
e811c8ce 10491
d14a1e28
RD
10492
10493class GBSizerItemPtr(GBSizerItem):
10494 def __init__(self, this):
10495 self.this = this
10496 if not hasattr(self,"thisown"): self.thisown = 0
10497 self.__class__ = GBSizerItem
54f9ee45 10498_core_.GBSizerItem_swigregister(GBSizerItemPtr)
d14a1e28
RD
10499DefaultSpan = cvar.DefaultSpan
10500
10501def GBSizerItemWindow(*args, **kwargs):
0df68c9f
RD
10502 """
10503 GBSizerItemWindow(Window window, GBPosition pos, GBSpan span, int flag,
248ed943
RD
10504 int border, PyObject userData=None) -> GBSizerItem
10505
10506 Construct a `wx.GBSizerItem` for a window.
0df68c9f 10507 """
54f9ee45 10508 val = _core_.new_GBSizerItemWindow(*args, **kwargs)
d14a1e28
RD
10509 val.thisown = 1
10510 return val
10511
10512def GBSizerItemSizer(*args, **kwargs):
0df68c9f
RD
10513 """
10514 GBSizerItemSizer(Sizer sizer, GBPosition pos, GBSpan span, int flag,
248ed943
RD
10515 int border, PyObject userData=None) -> GBSizerItem
10516
10517 Construct a `wx.GBSizerItem` for a sizer
0df68c9f 10518 """
54f9ee45 10519 val = _core_.new_GBSizerItemSizer(*args, **kwargs)
d14a1e28
RD
10520 val.thisown = 1
10521 return val
10522
10523def GBSizerItemSpacer(*args, **kwargs):
0df68c9f
RD
10524 """
10525 GBSizerItemSpacer(int width, int height, GBPosition pos, GBSpan span,
248ed943
RD
10526 int flag, int border, PyObject userData=None) -> GBSizerItem
10527
10528 Construct a `wx.GBSizerItem` for a spacer.
0df68c9f 10529 """
54f9ee45 10530 val = _core_.new_GBSizerItemSpacer(*args, **kwargs)
d14a1e28
RD
10531 val.thisown = 1
10532 return val
10533
10534class GridBagSizer(FlexGridSizer):
248ed943
RD
10535 """
10536 A `wx.Sizer` that can lay out items in a virtual grid like a
10537 `wx.FlexGridSizer` but in this case explicit positioning of the items
10538 is allowed using `wx.GBPosition`, and items can optionally span more
10539 than one row and/or column using `wx.GBSpan`. The total size of the
10540 virtual grid is determined by the largest row and column that items are
10541 positioned at, adjusted for spanning.
10542
10543 """
e811c8ce
RD
10544 def __repr__(self):
10545 return "<%s.%s; proxy of C++ wxGridBagSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 10546 def __init__(self, *args, **kwargs):
248ed943
RD
10547 """
10548 __init__(self, int vgap=0, int hgap=0) -> GridBagSizer
10549
10550 Constructor, with optional parameters to specify the gap between the
10551 rows and columns.
10552 """
54f9ee45 10553 newobj = _core_.new_GridBagSizer(*args, **kwargs)
d14a1e28
RD
10554 self.this = newobj.this
10555 self.thisown = 1
10556 del newobj.thisown
1823fbb4
RD
10557 self._setOORInfo(self)
10558
e811c8ce 10559 def Add(*args, **kwargs):
0df68c9f 10560 """
248ed943 10561 Add(self, item, GBPosition pos, GBSpan span=DefaultSpan, int flag=0,
d3b6e4ff 10562 int border=0, userData=None) -> wx.GBSizerItem
248ed943
RD
10563
10564 Adds an item to the sizer at the grid cell *pos*, optionally spanning
10565 more than one row or column as specified with *span*. The remaining
10566 args behave similarly to `wx.Sizer.Add`.
10567
10568 Returns True if the item was successfully placed at the given cell
10569 position, False if something was already there.
10570
0df68c9f 10571 """
54f9ee45 10572 return _core_.GridBagSizer_Add(*args, **kwargs)
e811c8ce
RD
10573
10574 def AddItem(*args, **kwargs):
248ed943 10575 """
d3b6e4ff 10576 Add(self, GBSizerItem item) -> wx.GBSizerItem
248ed943
RD
10577
10578 Add an item to the sizer using a `wx.GBSizerItem`. Returns True if
10579 the item was successfully placed at its given cell position, False if
10580 something was already there.
10581 """
54f9ee45 10582 return _core_.GridBagSizer_AddItem(*args, **kwargs)
e811c8ce 10583
84f85550
RD
10584 def GetCellSize(*args, **kwargs):
10585 """
10586 GetCellSize(self, int row, int col) -> Size
10587
10588 Get the size of the specified cell, including hgap and
10589 vgap. Only valid after a Layout.
10590 """
10591 return _core_.GridBagSizer_GetCellSize(*args, **kwargs)
10592
e811c8ce 10593 def GetEmptyCellSize(*args, **kwargs):
248ed943
RD
10594 """
10595 GetEmptyCellSize(self) -> Size
10596
10597 Get the size used for cells in the grid with no item.
10598 """
54f9ee45 10599 return _core_.GridBagSizer_GetEmptyCellSize(*args, **kwargs)
e811c8ce
RD
10600
10601 def SetEmptyCellSize(*args, **kwargs):
248ed943
RD
10602 """
10603 SetEmptyCellSize(self, Size sz)
10604
10605 Set the size used for cells in the grid with no item.
10606 """
54f9ee45 10607 return _core_.GridBagSizer_SetEmptyCellSize(*args, **kwargs)
e811c8ce
RD
10608
10609 def GetItemPosition(*args):
0df68c9f 10610 """
248ed943
RD
10611 GetItemPosition(self, item) -> GBPosition
10612
10613 Get the grid position of the specified *item* where *item* is either a
10614 window or subsizer that is a member of this sizer, or a zero-based
10615 index of an item.
0df68c9f 10616 """
54f9ee45 10617 return _core_.GridBagSizer_GetItemPosition(*args)
e811c8ce
RD
10618
10619 def SetItemPosition(*args):
0df68c9f 10620 """
248ed943
RD
10621 SetItemPosition(self, item, GBPosition pos) -> bool
10622
10623 Set the grid position of the specified *item* where *item* is either a
10624 window or subsizer that is a member of this sizer, or a zero-based
10625 index of an item. Returns True on success. If the move is not
10626 allowed (because an item is already there) then False is returned.
10627
0df68c9f 10628 """
54f9ee45 10629 return _core_.GridBagSizer_SetItemPosition(*args)
e811c8ce
RD
10630
10631 def GetItemSpan(*args):
0df68c9f 10632 """
248ed943
RD
10633 GetItemSpan(self, item) -> GBSpan
10634
10635 Get the row/col spanning of the specified *item* where *item* is
10636 either a window or subsizer that is a member of this sizer, or a
10637 zero-based index of an item.
0df68c9f 10638 """
54f9ee45 10639 return _core_.GridBagSizer_GetItemSpan(*args)
e811c8ce
RD
10640
10641 def SetItemSpan(*args):
0df68c9f 10642 """
248ed943
RD
10643 SetItemSpan(self, item, GBSpan span) -> bool
10644
10645 Set the row/col spanning of the specified *item* where *item* is
10646 either a window or subsizer that is a member of this sizer, or a
10647 zero-based index of an item. Returns True on success. If the move is
10648 not allowed (because an item is already there) then False is returned.
0df68c9f 10649 """
54f9ee45 10650 return _core_.GridBagSizer_SetItemSpan(*args)
e811c8ce
RD
10651
10652 def FindItem(*args):
0df68c9f 10653 """
248ed943
RD
10654 FindItem(self, item) -> GBSizerItem
10655
10656 Find the sizer item for the given window or subsizer, returns None if
10657 not found. (non-recursive)
0df68c9f 10658 """
54f9ee45 10659 return _core_.GridBagSizer_FindItem(*args)
e811c8ce
RD
10660
10661 def FindItemAtPosition(*args, **kwargs):
248ed943
RD
10662 """
10663 FindItemAtPosition(self, GBPosition pos) -> GBSizerItem
10664
10665 Return the sizer item for the given grid cell, or None if there is no
10666 item at that position. (non-recursive)
10667 """
54f9ee45 10668 return _core_.GridBagSizer_FindItemAtPosition(*args, **kwargs)
e811c8ce
RD
10669
10670 def FindItemAtPoint(*args, **kwargs):
248ed943
RD
10671 """
10672 FindItemAtPoint(self, Point pt) -> GBSizerItem
10673
10674 Return the sizer item located at the point given in *pt*, or None if
10675 there is no item at that point. The (x,y) coordinates in pt correspond
10676 to the client coordinates of the window using the sizer for
10677 layout. (non-recursive)
10678 """
54f9ee45 10679 return _core_.GridBagSizer_FindItemAtPoint(*args, **kwargs)
e811c8ce 10680
248ed943
RD
10681 def CheckForIntersection(*args, **kwargs):
10682 """
10683 CheckForIntersection(self, GBSizerItem item, GBSizerItem excludeItem=None) -> bool
e811c8ce 10684
248ed943
RD
10685 Look at all items and see if any intersect (or would overlap) the
10686 given *item*. Returns True if so, False if there would be no overlap.
10687 If an *excludeItem* is given then it will not be checked for
10688 intersection, for example it may be the item we are checking the
10689 position of.
e811c8ce 10690
248ed943
RD
10691 """
10692 return _core_.GridBagSizer_CheckForIntersection(*args, **kwargs)
e811c8ce 10693
248ed943 10694 def CheckForIntersectionPos(*args, **kwargs):
0df68c9f 10695 """
248ed943
RD
10696 CheckForIntersectionPos(self, GBPosition pos, GBSpan span, GBSizerItem excludeItem=None) -> bool
10697
10698 Look at all items and see if any intersect (or would overlap) the
10699 given position and span. Returns True if so, False if there would be
10700 no overlap. If an *excludeItem* is given then it will not be checked
10701 for intersection, for example it may be the item we are checking the
10702 position of.
0df68c9f 10703 """
248ed943 10704 return _core_.GridBagSizer_CheckForIntersectionPos(*args, **kwargs)
e811c8ce 10705
d14a1e28
RD
10706
10707class GridBagSizerPtr(GridBagSizer):
10708 def __init__(self, this):
10709 self.this = this
10710 if not hasattr(self,"thisown"): self.thisown = 0
10711 self.__class__ = GridBagSizer
54f9ee45 10712_core_.GridBagSizer_swigregister(GridBagSizerPtr)
d14a1e28
RD
10713
10714#---------------------------------------------------------------------------
10715
54f9ee45
RD
10716Left = _core_.Left
10717Top = _core_.Top
10718Right = _core_.Right
10719Bottom = _core_.Bottom
10720Width = _core_.Width
10721Height = _core_.Height
10722Centre = _core_.Centre
10723Center = _core_.Center
10724CentreX = _core_.CentreX
10725CentreY = _core_.CentreY
10726Unconstrained = _core_.Unconstrained
10727AsIs = _core_.AsIs
10728PercentOf = _core_.PercentOf
10729Above = _core_.Above
10730Below = _core_.Below
10731LeftOf = _core_.LeftOf
10732RightOf = _core_.RightOf
10733SameAs = _core_.SameAs
10734Absolute = _core_.Absolute
d14a1e28 10735class IndividualLayoutConstraint(Object):
15afbcd0 10736 """
41e2b43e
RD
10737 Objects of this class are stored in the `wx.LayoutConstraints` class as
10738 one of eight possible constraints that a window can be involved in.
10739 You will never need to create an instance of
10740 wx.IndividualLayoutConstraint, rather you should create a
10741 `wx.LayoutConstraints` instance and use the individual contstraints
15afbcd0 10742 that it contains.
15afbcd0 10743 """
d14a1e28
RD
10744 def __init__(self): raise RuntimeError, "No constructor defined"
10745 def __repr__(self):
10746 return "<%s.%s; proxy of C++ wxIndividualLayoutConstraint instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
e811c8ce 10747 def Set(*args, **kwargs):
41e2b43e
RD
10748 """
10749 Set(self, int rel, Window otherW, int otherE, int val=0, int marg=wxLAYOUT_DEFAULT_MARGIN)
10750
10751 Sets the properties of the constraint. Normally called by one of the
10752 convenience functions such as Above, RightOf, SameAs.
10753 """
54f9ee45 10754 return _core_.IndividualLayoutConstraint_Set(*args, **kwargs)
e811c8ce
RD
10755
10756 def LeftOf(*args, **kwargs):
15afbcd0 10757 """
a95a7133 10758 LeftOf(self, Window sibling, int marg=0)
15afbcd0 10759
41e2b43e
RD
10760 Constrains this edge to be to the left of the given window, with an
10761 optional margin. Implicitly, this is relative to the left edge of the
10762 other window.
15afbcd0 10763 """
54f9ee45 10764 return _core_.IndividualLayoutConstraint_LeftOf(*args, **kwargs)
e811c8ce
RD
10765
10766 def RightOf(*args, **kwargs):
15afbcd0 10767 """
a95a7133 10768 RightOf(self, Window sibling, int marg=0)
15afbcd0 10769
41e2b43e
RD
10770 Constrains this edge to be to the right of the given window, with an
10771 optional margin. Implicitly, this is relative to the right edge of the
10772 other window.
15afbcd0 10773 """
54f9ee45 10774 return _core_.IndividualLayoutConstraint_RightOf(*args, **kwargs)
e811c8ce
RD
10775
10776 def Above(*args, **kwargs):
15afbcd0 10777 """
a95a7133 10778 Above(self, Window sibling, int marg=0)
15afbcd0 10779
41e2b43e
RD
10780 Constrains this edge to be above the given window, with an optional
10781 margin. Implicitly, this is relative to the top edge of the other
10782 window.
15afbcd0 10783 """
54f9ee45 10784 return _core_.IndividualLayoutConstraint_Above(*args, **kwargs)
e811c8ce
RD
10785
10786 def Below(*args, **kwargs):
15afbcd0 10787 """
a95a7133 10788 Below(self, Window sibling, int marg=0)
15afbcd0 10789
41e2b43e
RD
10790 Constrains this edge to be below the given window, with an optional
10791 margin. Implicitly, this is relative to the bottom edge of the other
10792 window.
15afbcd0 10793 """
54f9ee45 10794 return _core_.IndividualLayoutConstraint_Below(*args, **kwargs)
e811c8ce
RD
10795
10796 def SameAs(*args, **kwargs):
15afbcd0 10797 """
a95a7133 10798 SameAs(self, Window otherW, int edge, int marg=0)
15afbcd0 10799
41e2b43e
RD
10800 Constrains this edge or dimension to be to the same as the edge of the
10801 given window, with an optional margin.
15afbcd0 10802 """
54f9ee45 10803 return _core_.IndividualLayoutConstraint_SameAs(*args, **kwargs)
e811c8ce
RD
10804
10805 def PercentOf(*args, **kwargs):
15afbcd0 10806 """
a95a7133 10807 PercentOf(self, Window otherW, int wh, int per)
15afbcd0 10808
41e2b43e
RD
10809 Constrains this edge or dimension to be to a percentage of the given
10810 window, with an optional margin.
15afbcd0 10811 """
54f9ee45 10812 return _core_.IndividualLayoutConstraint_PercentOf(*args, **kwargs)
e811c8ce
RD
10813
10814 def Absolute(*args, **kwargs):
15afbcd0 10815 """
a95a7133 10816 Absolute(self, int val)
15afbcd0 10817
41e2b43e 10818 Constrains this edge or dimension to be the given absolute value.
15afbcd0 10819 """
54f9ee45 10820 return _core_.IndividualLayoutConstraint_Absolute(*args, **kwargs)
e811c8ce
RD
10821
10822 def Unconstrained(*args, **kwargs):
15afbcd0 10823 """
a95a7133 10824 Unconstrained(self)
15afbcd0 10825
41e2b43e
RD
10826 Sets this edge or dimension to be unconstrained, that is, dependent on
10827 other edges and dimensions from which this value can be deduced.
15afbcd0 10828 """
54f9ee45 10829 return _core_.IndividualLayoutConstraint_Unconstrained(*args, **kwargs)
e811c8ce
RD
10830
10831 def AsIs(*args, **kwargs):
15afbcd0 10832 """
a95a7133 10833 AsIs(self)
15afbcd0 10834
41e2b43e
RD
10835 Sets this edge or constraint to be whatever the window's value is at
10836 the moment. If either of the width and height constraints are *as is*,
10837 the window will not be resized, but moved instead. This is important
10838 when considering panel items which are intended to have a default
10839 size, such as a button, which may take its size from the size of the
10840 button label.
15afbcd0 10841 """
54f9ee45 10842 return _core_.IndividualLayoutConstraint_AsIs(*args, **kwargs)
e811c8ce
RD
10843
10844 def GetOtherWindow(*args, **kwargs):
a95a7133 10845 """GetOtherWindow(self) -> Window"""
54f9ee45 10846 return _core_.IndividualLayoutConstraint_GetOtherWindow(*args, **kwargs)
e811c8ce
RD
10847
10848 def GetMyEdge(*args, **kwargs):
a95a7133 10849 """GetMyEdge(self) -> int"""
54f9ee45 10850 return _core_.IndividualLayoutConstraint_GetMyEdge(*args, **kwargs)
e811c8ce
RD
10851
10852 def SetEdge(*args, **kwargs):
a95a7133 10853 """SetEdge(self, int which)"""
54f9ee45 10854 return _core_.IndividualLayoutConstraint_SetEdge(*args, **kwargs)
e811c8ce
RD
10855
10856 def SetValue(*args, **kwargs):
a95a7133 10857 """SetValue(self, int v)"""
54f9ee45 10858 return _core_.IndividualLayoutConstraint_SetValue(*args, **kwargs)
e811c8ce
RD
10859
10860 def GetMargin(*args, **kwargs):
a95a7133 10861 """GetMargin(self) -> int"""
54f9ee45 10862 return _core_.IndividualLayoutConstraint_GetMargin(*args, **kwargs)
e811c8ce
RD
10863
10864 def SetMargin(*args, **kwargs):
a95a7133 10865 """SetMargin(self, int m)"""
54f9ee45 10866 return _core_.IndividualLayoutConstraint_SetMargin(*args, **kwargs)
e811c8ce
RD
10867
10868 def GetValue(*args, **kwargs):
a95a7133 10869 """GetValue(self) -> int"""
54f9ee45 10870 return _core_.IndividualLayoutConstraint_GetValue(*args, **kwargs)
e811c8ce
RD
10871
10872 def GetPercent(*args, **kwargs):
a95a7133 10873 """GetPercent(self) -> int"""
54f9ee45 10874 return _core_.IndividualLayoutConstraint_GetPercent(*args, **kwargs)
e811c8ce
RD
10875
10876 def GetOtherEdge(*args, **kwargs):
a95a7133 10877 """GetOtherEdge(self) -> int"""
54f9ee45 10878 return _core_.IndividualLayoutConstraint_GetOtherEdge(*args, **kwargs)
e811c8ce
RD
10879
10880 def GetDone(*args, **kwargs):
a95a7133 10881 """GetDone(self) -> bool"""
54f9ee45 10882 return _core_.IndividualLayoutConstraint_GetDone(*args, **kwargs)
e811c8ce
RD
10883
10884 def SetDone(*args, **kwargs):
a95a7133 10885 """SetDone(self, bool d)"""
54f9ee45 10886 return _core_.IndividualLayoutConstraint_SetDone(*args, **kwargs)
e811c8ce
RD
10887
10888 def GetRelationship(*args, **kwargs):
a95a7133 10889 """GetRelationship(self) -> int"""
54f9ee45 10890 return _core_.IndividualLayoutConstraint_GetRelationship(*args, **kwargs)
e811c8ce
RD
10891
10892 def SetRelationship(*args, **kwargs):
a95a7133 10893 """SetRelationship(self, int r)"""
54f9ee45 10894 return _core_.IndividualLayoutConstraint_SetRelationship(*args, **kwargs)
e811c8ce
RD
10895
10896 def ResetIfWin(*args, **kwargs):
15afbcd0 10897 """
a95a7133 10898 ResetIfWin(self, Window otherW) -> bool
15afbcd0
RD
10899
10900 Reset constraint if it mentions otherWin
10901 """
54f9ee45 10902 return _core_.IndividualLayoutConstraint_ResetIfWin(*args, **kwargs)
e811c8ce
RD
10903
10904 def SatisfyConstraint(*args, **kwargs):
15afbcd0 10905 """
a95a7133 10906 SatisfyConstraint(self, LayoutConstraints constraints, Window win) -> bool
15afbcd0
RD
10907
10908 Try to satisfy constraint
10909 """
54f9ee45 10910 return _core_.IndividualLayoutConstraint_SatisfyConstraint(*args, **kwargs)
e811c8ce
RD
10911
10912 def GetEdge(*args, **kwargs):
15afbcd0 10913 """
a95a7133 10914 GetEdge(self, int which, Window thisWin, Window other) -> int
15afbcd0
RD
10915
10916 Get the value of this edge or dimension, or if this
10917 is not determinable, -1.
10918 """
54f9ee45 10919 return _core_.IndividualLayoutConstraint_GetEdge(*args, **kwargs)
e811c8ce 10920
d14a1e28
RD
10921
10922class IndividualLayoutConstraintPtr(IndividualLayoutConstraint):
10923 def __init__(self, this):
10924 self.this = this
10925 if not hasattr(self,"thisown"): self.thisown = 0
10926 self.__class__ = IndividualLayoutConstraint
54f9ee45 10927_core_.IndividualLayoutConstraint_swigregister(IndividualLayoutConstraintPtr)
d14a1e28
RD
10928
10929class LayoutConstraints(Object):
15afbcd0 10930 """
41e2b43e
RD
10931 **Note:** constraints are now deprecated and you should use sizers
10932 instead.
15afbcd0 10933
41e2b43e
RD
10934 Objects of this class can be associated with a window to define its
10935 layout constraints, with respect to siblings or its parent.
15afbcd0
RD
10936
10937 The class consists of the following eight constraints of class
10938 wx.IndividualLayoutConstraint, some or all of which should be accessed
10939 directly to set the appropriate constraints.
10940
10941 * left: represents the left hand edge of the window
10942 * right: represents the right hand edge of the window
10943 * top: represents the top edge of the window
10944 * bottom: represents the bottom edge of the window
10945 * width: represents the width of the window
10946 * height: represents the height of the window
10947 * centreX: represents the horizontal centre point of the window
10948 * centreY: represents the vertical centre point of the window
10949
41e2b43e
RD
10950 Most constraints are initially set to have the relationship
10951 wxUnconstrained, which means that their values should be calculated by
10952 looking at known constraints. The exceptions are width and height,
10953 which are set to wxAsIs to ensure that if the user does not specify a
10954 constraint, the existing width and height will be used, to be
10955 compatible with panel items which often have take a default size. If
10956 the constraint is ``wx.AsIs``, the dimension will not be changed.
10957
10958 :see: `wx.IndividualLayoutConstraint`, `wx.Window.SetConstraints`
15afbcd0
RD
10959
10960 """
e811c8ce
RD
10961 def __repr__(self):
10962 return "<%s.%s; proxy of C++ wxLayoutConstraints instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
54f9ee45
RD
10963 left = property(_core_.LayoutConstraints_left_get)
10964 top = property(_core_.LayoutConstraints_top_get)
10965 right = property(_core_.LayoutConstraints_right_get)
10966 bottom = property(_core_.LayoutConstraints_bottom_get)
10967 width = property(_core_.LayoutConstraints_width_get)
10968 height = property(_core_.LayoutConstraints_height_get)
10969 centreX = property(_core_.LayoutConstraints_centreX_get)
10970 centreY = property(_core_.LayoutConstraints_centreY_get)
d14a1e28 10971 def __init__(self, *args, **kwargs):
a95a7133 10972 """__init__(self) -> LayoutConstraints"""
54f9ee45 10973 newobj = _core_.new_LayoutConstraints(*args, **kwargs)
d14a1e28
RD
10974 self.this = newobj.this
10975 self.thisown = 1
10976 del newobj.thisown
e811c8ce 10977 def SatisfyConstraints(*args, **kwargs):
6c3b4aae 10978 """SatisfyConstraints(Window win) -> (areSatisfied, noChanges)"""
54f9ee45 10979 return _core_.LayoutConstraints_SatisfyConstraints(*args, **kwargs)
e811c8ce
RD
10980
10981 def AreSatisfied(*args, **kwargs):
a95a7133 10982 """AreSatisfied(self) -> bool"""
54f9ee45 10983 return _core_.LayoutConstraints_AreSatisfied(*args, **kwargs)
e811c8ce 10984
d14a1e28
RD
10985
10986class LayoutConstraintsPtr(LayoutConstraints):
10987 def __init__(self, this):
10988 self.this = this
10989 if not hasattr(self,"thisown"): self.thisown = 0
10990 self.__class__ = LayoutConstraints
54f9ee45 10991_core_.LayoutConstraints_swigregister(LayoutConstraintsPtr)
d14a1e28
RD
10992
10993#----------------------------------------------------------------------------
10994
322913ce 10995# Use Python's bool constants if available, make some if not
d14a1e28
RD
10996try:
10997 True
10998except NameError:
322913ce
RD
10999 __builtins__.True = 1==1
11000 __builtins__.False = 1==0
4f89f6a3
RD
11001 def bool(value): return not not value
11002 __builtins__.bool = bool
d14a1e28 11003
d14a1e28
RD
11004
11005
11006# workarounds for bad wxRTTI names
11007__wxPyPtrTypeMap['wxGauge95'] = 'wxGauge'
11008__wxPyPtrTypeMap['wxSlider95'] = 'wxSlider'
11009__wxPyPtrTypeMap['wxStatusBar95'] = 'wxStatusBar'
11010
11011
11012#----------------------------------------------------------------------------
11013# Load version numbers from __version__... Ensure that major and minor
7bc1e663 11014# versions are the same for both wxPython and wxWidgets.
d14a1e28
RD
11015
11016from __version__ import *
11017__version__ = VERSION_STRING
11018
7bc1e663
RD
11019assert MAJOR_VERSION == _core_.MAJOR_VERSION, "wxPython/wxWidgets version mismatch"
11020assert MINOR_VERSION == _core_.MINOR_VERSION, "wxPython/wxWidgets version mismatch"
54f9ee45 11021if RELEASE_VERSION != _core_.RELEASE_VERSION:
d14a1e28 11022 import warnings
7bc1e663 11023 warnings.warn("wxPython/wxWidgets release number mismatch")
d14a1e28
RD
11024
11025#----------------------------------------------------------------------------
11026
e505d15e
RD
11027# Set the default string<-->unicode conversion encoding from the
11028# locale. This encoding is used when string or unicode objects need
11029# to be converted in order to pass them to wxWidgets. Please be aware
11030# that the default encoding within the same locale may be slightly
11031# different on different platforms. For example, please see
11032# http://www.alanwood.net/demos/charsetdiffs.html for differences
11033# between the common latin/roman encodings.
5cbf236d
RD
11034import locale
11035default = locale.getdefaultlocale()[1]
11036if default:
11037 wx.SetDefaultPyEncoding(default)
11038del default
11039del locale
11040
11041#----------------------------------------------------------------------------
11042
d14a1e28
RD
11043class PyDeadObjectError(AttributeError):
11044 pass
11045
d14a1e28
RD
11046class _wxPyDeadObject(object):
11047 """
11048 Instances of wx objects that are OOR capable will have their __class__
11049 changed to this class when the C++ object is deleted. This should help
11050 prevent crashes due to referencing a bogus C++ pointer.
11051 """
11052 reprStr = "wxPython wrapper for DELETED %s object! (The C++ object no longer exists.)"
11053 attrStr = "The C++ part of the %s object has been deleted, attribute access no longer allowed."
11054
3a04f143 11055 def __repr__(self):
d14a1e28
RD
11056 if not hasattr(self, "_name"):
11057 self._name = "[unknown]"
11058 return self.reprStr % self._name
11059
3a04f143 11060 def __getattr__(self, *args):
d14a1e28
RD
11061 if not hasattr(self, "_name"):
11062 self._name = "[unknown]"
3a04f143
RD
11063 raise PyDeadObjectError(self.attrStr % self._name)
11064
11065 def __nonzero__(self):
11066 return 0
11067
11068
11069
11070class PyUnbornObjectError(AttributeError):
11071 pass
11072
11073class _wxPyUnbornObject(object):
11074 """
54f9ee45 11075 Some stock objects are created when the wx._core module is
3a04f143
RD
11076 imported, but their C++ instance is not created until the wx.App
11077 object is created and initialized. These object instances will
11078 temporarily have their __class__ changed to this class so an
11079 exception will be raised if they are used before the C++ instance
11080 is ready.
11081 """
11082
11083 reprStr = "wxPython wrapper for UNBORN object! (The C++ object is not initialized yet.)"
11084 attrStr = "The C++ part of this object has not been initialized, attribute access not allowed."
11085
11086 def __repr__(self):
11087 #if not hasattr(self, "_name"):
11088 # self._name = "[unknown]"
11089 return self.reprStr #% self._name
11090
11091 def __getattr__(self, *args):
11092 #if not hasattr(self, "_name"):
11093 # self._name = "[unknown]"
11094 raise PyUnbornObjectError(self.attrStr) # % self._name )
d14a1e28
RD
11095
11096 def __nonzero__(self):
11097 return 0
11098
11099
11100#----------------------------------------------------------------------------
d14a1e28
RD
11101
11102def CallAfter(callable, *args, **kw):
11103 """
11104 Call the specified function after the current and pending event
11105 handlers have been completed. This is also good for making GUI
61863841
RD
11106 method calls from non-GUI threads. Any extra positional or
11107 keyword args are passed on to the callable when it is called.
11108
11109 :see: `wx.FutureCall`
d14a1e28
RD
11110 """
11111 app = wx.GetApp()
dfbb5885 11112 assert app is not None, 'No wx.App created yet'
d14a1e28 11113
148275d3
RD
11114 if not hasattr(app, "_CallAfterId"):
11115 app._CallAfterId = wx.NewEventType()
11116 app.Connect(-1, -1, app._CallAfterId,
11117 lambda event: event.callable(*event.args, **event.kw) )
d14a1e28 11118 evt = wx.PyEvent()
148275d3 11119 evt.SetEventType(app._CallAfterId)
d14a1e28
RD
11120 evt.callable = callable
11121 evt.args = args
11122 evt.kw = kw
11123 wx.PostEvent(app, evt)
11124
d14a1e28
RD
11125#----------------------------------------------------------------------------
11126
11127
11128class FutureCall:
11129 """
8ac8dba0 11130 A convenience class for `wx.Timer`, that calls the given callable
d14a1e28
RD
11131 object once after the given amount of milliseconds, passing any
11132 positional or keyword args. The return value of the callable is
61863841 11133 availbale after it has been run with the `GetResult` method.
d14a1e28
RD
11134
11135 If you don't need to get the return value or restart the timer
11136 then there is no need to hold a reference to this object. It will
11137 hold a reference to itself while the timer is running (the timer
11138 has a reference to self.Notify) but the cycle will be broken when
11139 the timer completes, automatically cleaning up the wx.FutureCall
11140 object.
61863841
RD
11141
11142 :see: `wx.CallAfter`
d14a1e28
RD
11143 """
11144 def __init__(self, millis, callable, *args, **kwargs):
11145 self.millis = millis
11146 self.callable = callable
11147 self.SetArgs(*args, **kwargs)
11148 self.runCount = 0
4276dc52 11149 self.running = False
d14a1e28
RD
11150 self.hasRun = False
11151 self.result = None
11152 self.timer = None
11153 self.Start()
11154
11155 def __del__(self):
11156 self.Stop()
11157
11158
11159 def Start(self, millis=None, *args, **kwargs):
11160 """
11161 (Re)start the timer
11162 """
11163 self.hasRun = False
11164 if millis is not None:
11165 self.millis = millis
11166 if args or kwargs:
11167 self.SetArgs(*args, **kwargs)
11168 self.Stop()
11169 self.timer = wx.PyTimer(self.Notify)
11170 self.timer.Start(self.millis, wx.TIMER_ONE_SHOT)
4276dc52 11171 self.running = True
d14a1e28
RD
11172 Restart = Start
11173
11174
11175 def Stop(self):
11176 """
11177 Stop and destroy the timer.
11178 """
11179 if self.timer is not None:
11180 self.timer.Stop()
11181 self.timer = None
11182
11183
11184 def GetInterval(self):
11185 if self.timer is not None:
11186 return self.timer.GetInterval()
11187 else:
11188 return 0
11189
11190
11191 def IsRunning(self):
11192 return self.timer is not None and self.timer.IsRunning()
11193
11194
11195 def SetArgs(self, *args, **kwargs):
11196 """
11197 (Re)set the args passed to the callable object. This is
11198 useful in conjunction with Restart if you want to schedule a
11199 new call to the same callable object but with different
11200 parameters.
11201 """
11202 self.args = args
11203 self.kwargs = kwargs
11204
11205
11206 def HasRun(self):
11207 return self.hasRun
11208
11209 def GetResult(self):
11210 return self.result
11211
11212 def Notify(self):
11213 """
11214 The timer has expired so call the callable.
11215 """
11216 if self.callable and getattr(self.callable, 'im_self', True):
11217 self.runCount += 1
4276dc52 11218 self.running = False
d14a1e28
RD
11219 self.result = self.callable(*self.args, **self.kwargs)
11220 self.hasRun = True
4276dc52
RD
11221 if not self.running:
11222 # if it wasn't restarted, then cleanup
11223 wx.CallAfter(self.Stop)
d14a1e28
RD
11224
11225
a95a7133
RD
11226
11227#----------------------------------------------------------------------------
11228# Control which items in this module should be documented by epydoc.
11229# We allow only classes and functions, which will help reduce the size
11230# of the docs by filtering out the zillions of constants, EVT objects,
11231# and etc that don't make much sense by themselves, but are instead
11232# documented (or will be) as part of the classes/functions/methods
11233# where they should be used.
11234
66c033b4
RD
11235class __DocFilter:
11236 """
11237 A filter for epydoc that only allows non-Ptr classes and
11238 fucntions, in order to reduce the clutter in the API docs.
11239 """
11240 def __init__(self, globals):
11241 self._globals = globals
11242
11243 def __call__(self, name):
11244 import types
11245 obj = self._globals.get(name, None)
11246 if type(obj) not in [type, types.ClassType, types.FunctionType, types.BuiltinFunctionType]:
11247 return False
11248 if name.startswith('_') or name.endswith('Ptr') or name.startswith('EVT'):
11249 return False
11250 return True
a95a7133 11251
d14a1e28
RD
11252#----------------------------------------------------------------------------
11253#----------------------------------------------------------------------------
11254
11255# Import other modules in this package that should show up in the
11256# "core" wx namespace
54f9ee45
RD
11257from _gdi import *
11258from _windows import *
11259from _controls import *
11260from _misc import *
d14a1e28 11261
3a04f143
RD
11262
11263# Fixup the stock objects since they can't be used yet. (They will be
11264# restored in wx.PyApp.OnInit.)
54f9ee45 11265_core_._wxPyFixStockObjects()
3a04f143 11266
d14a1e28
RD
11267#----------------------------------------------------------------------------
11268#----------------------------------------------------------------------------
11269
11270